index.h File Reference

#include <map>
#include <memory>
#include <vector>
#include "dstring.h"
#include "construct.h"

Include dependency graph for index.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	Index

Namespaces
namespace	ClassMemberHighlight
namespace	FileMemberHighlight
namespace	NamespaceMemberHighlight
namespace	ModuleMemberHighlight

Enumerations
enum class	IndexSection {   isTitlePageStart , isTitlePageAuthor , isMainPage , isModuleIndex ,   isTopicIndex , isDirIndex , isNamespaceIndex , isConceptIndex ,   isClassHierarchyIndex , isCompoundIndex , isFileIndex , isPageIndex ,   isModuleDocumentation , isTopicDocumentation , isDirDocumentation , isNamespaceDocumentation ,   isClassDocumentation , isConceptDocumentation , isFileDocumentation , isExampleDocumentation ,   isPageDocumentation , isPageDocumentation2 , isEndIndex }
enum class	HighlightedItem {   None =0 , Main , Modules , Namespaces ,   Topics , ClassHierarchy , InterfaceHierarchy , ExceptionHierarchy ,   Classes , Concepts , Interfaces , Structs ,   Exceptions , AnnotatedClasses , AnnotatedInterfaces , AnnotatedStructs ,   AnnotatedExceptions , Files , NamespaceMembers , ModuleMembers ,   Functions , Globals , Pages , Examples ,   Search , UserGroup , ClassVisible , ConceptVisible ,   InterfaceVisible , StructVisible , ExceptionVisible , NamespaceVisible ,   FileVisible , ModuleVisible }
enum	ClassMemberHighlight::Enum : int {   ClassMemberHighlight::All = 0 , ClassMemberHighlight::Functions , ClassMemberHighlight::Variables , ClassMemberHighlight::Typedefs ,   ClassMemberHighlight::Enums , ClassMemberHighlight::EnumValues , ClassMemberHighlight::Properties , ClassMemberHighlight::Events ,   ClassMemberHighlight::Related , ClassMemberHighlight::Total }
enum	FileMemberHighlight::Enum : int {   FileMemberHighlight::All = 0 , FileMemberHighlight::Functions , FileMemberHighlight::Variables , FileMemberHighlight::Typedefs ,   FileMemberHighlight::Sequences , FileMemberHighlight::Dictionaries , FileMemberHighlight::Enums , FileMemberHighlight::EnumValues ,   FileMemberHighlight::Defines , FileMemberHighlight::Total }
enum	NamespaceMemberHighlight::Enum : int {   NamespaceMemberHighlight::All = 0 , NamespaceMemberHighlight::Functions , NamespaceMemberHighlight::Variables , NamespaceMemberHighlight::Typedefs ,   NamespaceMemberHighlight::Sequences , NamespaceMemberHighlight::Dictionaries , NamespaceMemberHighlight::Enums , NamespaceMemberHighlight::EnumValues ,   NamespaceMemberHighlight::Total }
enum	ModuleMemberHighlight::Enum : int {   ModuleMemberHighlight::All = 0 , ModuleMemberHighlight::Functions , ModuleMemberHighlight::Variables , ModuleMemberHighlight::Typedefs ,   ModuleMemberHighlight::Enums , ModuleMemberHighlight::EnumValues , ModuleMemberHighlight::Total }

Functions
void	writeGraphInfo (OutputList &ol)
void	writeIndexHierarchy (OutputList &ol)
void	startTitle (OutputList &ol, const DString &fileName, const DefinitionMutable *def=nullptr)
void	endTitle (OutputList &ol, const DString &fileName, const DString &name)
void	startFile (OutputList &ol, const DString &name, bool isSource, const DString &manName, const DString &title, HighlightedItem hli=HighlightedItem::None, bool additionalIndices=false, const DString &altSidebarName=DString(), int hierarchyLevel=0, const DString &allMembersFile=DString())
void	endFile (OutputList &ol, bool skipNavIndex=false, bool skipEndContents=false, const DString &navPath=DString())
void	endFileWithNavPath (OutputList &ol, const DefinitionMutable *d, bool showPageNavigation=true)

Enumeration Type Documentation

HighlightedItem

enum class HighlightedItem

strong

Enumerator
None
Main
Modules
Namespaces
Topics
ClassHierarchy
InterfaceHierarchy
ExceptionHierarchy
Classes
Concepts
Interfaces
Structs
Exceptions
AnnotatedClasses
AnnotatedInterfaces
AnnotatedStructs
AnnotatedExceptions
Files
NamespaceMembers
ModuleMembers
Functions
Globals
Pages
Examples
Search
UserGroup
ClassVisible
ConceptVisible
InterfaceVisible
StructVisible
ExceptionVisible
NamespaceVisible
FileVisible
ModuleVisible

Definition at line 57 of file index.h.

{
  None=0,
  Main,
  Modules,
  Namespaces,
  Topics,
  ClassHierarchy,
  InterfaceHierarchy,
  ExceptionHierarchy,
  Classes,
  Concepts,
  Interfaces,
  Structs,
  Exceptions,
  AnnotatedClasses,
  AnnotatedInterfaces,
  AnnotatedStructs,
  AnnotatedExceptions,
  Files,
  NamespaceMembers,
  ModuleMembers,
  Functions,
  Globals,
  Pages,
  Examples,
  Search,
  UserGroup,
 
  ClassVisible,
  ConceptVisible,
  InterfaceVisible,
  StructVisible,
  ExceptionVisible,
  NamespaceVisible,
  FileVisible,
  ModuleVisible
};

IndexSection

enum class IndexSection

strong

Enumerator
isTitlePageStart
isTitlePageAuthor
isMainPage
isModuleIndex
isTopicIndex
isDirIndex
isNamespaceIndex
isConceptIndex
isClassHierarchyIndex
isCompoundIndex
isFileIndex
isPageIndex
isModuleDocumentation
isTopicDocumentation
isDirDocumentation
isNamespaceDocumentation
isClassDocumentation
isConceptDocumentation
isFileDocumentation
isExampleDocumentation
isPageDocumentation
isPageDocumentation2
isEndIndex

Definition at line 30 of file index.h.

{
  isTitlePageStart,
  isTitlePageAuthor,
  isMainPage,
  isModuleIndex,
  isTopicIndex,
  isDirIndex,
  isNamespaceIndex,
  isConceptIndex,
  isClassHierarchyIndex,
  isCompoundIndex,
  isFileIndex,
  isPageIndex,
  isModuleDocumentation,
  isTopicDocumentation,
  isDirDocumentation,
  isNamespaceDocumentation,
  isClassDocumentation,
  isConceptDocumentation,
  isFileDocumentation,
  isExampleDocumentation,
  isPageDocumentation,
  isPageDocumentation2,
  isEndIndex
};

Function Documentation

endFile()

void endFile	(	OutputList &	ol,
		bool	skipNavIndex = false,
		bool	skipEndContents = false,
		const DString &	navPath = DString() )

Definition at line 431 of file index.cpp.

{
  bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
  ol.pushGeneratorState();
  ol.disableAllBut(OutputType::Html);
  if (!skipNavIndex)
  {
    if (!skipEndContents) ol.endContents();
    if (generateTreeView)
    {
      ol.writeString("</div><!-- doc-content -->\n");
      ol.writeString("</div><!-- container -->\n");
    }
  }
 
  ol.writeFooter(navPath); // write the footer
  ol.popGeneratorState();
  ol.endFile();
}

References Config_getBool, OutputList::disableAllBut(), OutputList::endContents(), OutputList::endFile(), Html, OutputList::popGeneratorState(), OutputList::pushGeneratorState(), OutputList::writeFooter(), and OutputList::writeString().

Referenced by endFileWithNavPath(), generateExampleDocs(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), writeDirIndex(), GroupDefImpl::writeDocumentation(), ModuleDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), MemberList::writeDocumentationPage(), writeFileIndex(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), ClassDefImpl::writeMemberList(), and writeNamespaceIndex().

endFileWithNavPath()

void endFileWithNavPath	(	OutputList &	ol,
		const DefinitionMutable *	d,
		bool	showPageNavigation = true )

Definition at line 452 of file index.cpp.

{
  bool generateTreeview = Config_getBool(GENERATE_TREEVIEW);
  bool generateOutlinePanel = Config_getBool(PAGE_OUTLINE_PANEL);
  DString navPath;
  if (generateTreeview)
  {
    ol.pushGeneratorState();
    ol.disableAllBut(OutputType::Html);
    ol.writeString("</div><!-- doc-content -->\n");
    if (generateOutlinePanel && showPageNavigation) d->writePageNavigation(ol);
    ol.writeString("</div><!-- container -->\n");
    ol.popGeneratorState();
    navPath = toDefinition(const_cast<DefinitionMutable*>(d))->navigationPathAsString();
  }
  endFile(ol,generateTreeview,true,navPath);
}

References Config_getBool, OutputList::disableAllBut(), endFile(), Html, Definition::navigationPathAsString(), OutputList::popGeneratorState(), OutputList::pushGeneratorState(), toDefinition(), DefinitionMutable::writePageNavigation(), and OutputList::writeString().

Referenced by ClassDefImpl::writeDocumentation(), ConceptDefImpl::writeDocumentation(), DirDefImpl::writeDocumentation(), DirRelation::writeDocumentation(), FileDefImpl::writeDocumentation(), NamespaceDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), MemberList::writeDocumentationPage(), and FileDefImpl::writeSourceFooter().

endTitle()

void endTitle	(	OutputList &	ol,
		const DString &	fileName,
		const DString &	name )

Definition at line 398 of file index.cpp.

{
  ol.popGeneratorState();
  ol.endTitleHead(fileName,name);
  ol.endHeaderSection();
}

References OutputList::endHeaderSection(), OutputList::endTitleHead(), and OutputList::popGeneratorState().

Referenced by generateExampleDocs(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), writeDirIndex(), ClassDefImpl::writeDocumentation(), ConceptDefImpl::writeDocumentation(), DirDefImpl::writeDocumentation(), FileDefImpl::writeDocumentation(), NamespaceDefImpl::writeDocumentation(), writeFileIndex(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), ClassDefImpl::writeMemberList(), writeNamespaceIndex(), and FileDefImpl::writeSourceHeader().

startFile()

void startFile	(	OutputList &	ol,
		const DString &	name,
		bool	isSource,
		const DString &	manName,
		const DString &	title,
		HighlightedItem	hli = HighlightedItem::None,
		bool	additionalIndices = false,
		const DString &	altSidebarName = DString(),
		int	hierarchyLevel = 0,
		const DString &	allMembersFile = DString() )

Definition at line 405 of file index.cpp.

{
  bool disableIndex     = Config_getBool(DISABLE_INDEX);
  bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
  bool fullSidebar      = Config_getBool(FULL_SIDEBAR);
  bool quickLinksAfterSplitbar = !disableIndex && generateTreeView && fullSidebar;
  ol.startFile(name,isSource,manName,title,hierarchyLevel);
  ol.startQuickIndices();
  if (!disableIndex && !quickLinksAfterSplitbar)
  {
    ol.writeQuickLinks(hli,name);
  }
  if (!additionalIndices)
  {
    ol.endQuickIndices();
  }
  ol.writeSplitBar(!altSidebarName.empty() ? altSidebarName : name, allMembersFile);
  if (quickLinksAfterSplitbar)
  {
    ol.writeQuickLinks(hli,name);
  }
  ol.writeSearchInfo();
}

References Config_getBool, DString::empty(), OutputList::endQuickIndices(), OutputList::startFile(), OutputList::startQuickIndices(), OutputList::writeQuickLinks(), OutputList::writeSearchInfo(), and OutputList::writeSplitBar().

Referenced by generateExampleDocs(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), writeDirIndex(), ClassDefImpl::writeDocumentation(), ConceptDefImpl::writeDocumentation(), DirDefImpl::writeDocumentation(), DirRelation::writeDocumentation(), FileDefImpl::writeDocumentation(), GroupDefImpl::writeDocumentation(), ModuleDefImpl::writeDocumentation(), NamespaceDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), MemberList::writeDocumentationPage(), writeFileIndex(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), ClassDefImpl::writeMemberList(), writeNamespaceIndex(), and FileDefImpl::writeSourceHeader().

startTitle()

void startTitle	(	OutputList &	ol,
		const DString &	fileName,
		const DefinitionMutable *	def = nullptr )

Definition at line 388 of file index.cpp.

{
  bool generateOutlinePanel = Config_getBool(GENERATE_TREEVIEW) && Config_getBool(PAGE_OUTLINE_PANEL);
  ol.startHeaderSection();
  if (!generateOutlinePanel && def) def->writeSummaryLinks(ol);
  ol.startTitleHead(fileName);
  ol.pushGeneratorState();
  ol.disable(OutputType::Man);
}

References Config_getBool, OutputList::disable(), Man, OutputList::pushGeneratorState(), OutputList::startHeaderSection(), OutputList::startTitleHead(), and DefinitionMutable::writeSummaryLinks().

Referenced by generateExampleDocs(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), writeDirIndex(), ClassDefImpl::writeDocumentation(), ConceptDefImpl::writeDocumentation(), DirDefImpl::writeDocumentation(), FileDefImpl::writeDocumentation(), NamespaceDefImpl::writeDocumentation(), writeFileIndex(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), ClassDefImpl::writeMemberList(), writeNamespaceIndex(), and FileDefImpl::writeSourceHeader().

writeGraphInfo()

void writeGraphInfo

(

OutputList &

ol

)

Definition at line 4097 of file index.cpp.

{
  int count=0;
  for (const auto &dd : *Doxygen::dirLinkedMap)
  {
    if (dd->isLinkableInProject())
    {
      count++;
    }
  }
  return count;
}
 
 
//----------------------------------------------------------------------------
 
void writeGraphInfo(OutputList &ol)
{
  if (!Config_getBool(HAVE_DOT) || !Config_getBool(GENERATE_HTML)) return;
  ol.pushGeneratorState();
  ol.disableAllBut(OutputType::Html);
 
  DotLegendGraph gd;
  gd.writeGraph(Config_getString(HTML_OUTPUT));
 
  bool oldStripCommentsState = Config_getBool(STRIP_CODE_COMMENTS);
  bool oldCreateSubdirs = Config_getBool(CREATE_SUBDIRS);
  // temporarily disable the stripping of comments for our own code example!
  Config_updateBool(STRIP_CODE_COMMENTS,false);
  // temporarily disable create subdirs for linking to our example
  Config_updateBool(CREATE_SUBDIRS,false);
 
  startFile(ol,"graph_legend",false,DString(),theTranslator->trLegendTitle());
  startTitle(ol,DString());

Referenced by generateOutput().

writeIndexHierarchy()

void writeIndexHierarchy

(

OutputList &

ol

)

Definition at line 5811 of file index.cpp.

Referenced by generateOutput().