index.h File Reference

#include <qlist.h>
#include <qcstring.h>

Go to the source code of this file.

Classes
class	IndexIntf
	Abstract interface for index generators. More...
class	IndexList
	A list of index interfaces. More...

Enumerations
enum	IndexSections {   isTitlePageStart, isTitlePageAuthor, isMainPage, isModuleIndex,   isDirIndex, isNamespaceIndex, isClassHierarchyIndex, isCompoundIndex,   isFileIndex, isPageIndex, isModuleDocumentation, isDirDocumentation,   isNamespaceDocumentation, isClassDocumentation, isFileDocumentation, isExampleDocumentation,   isPageDocumentation, isPageDocumentation2, isEndIndex }
enum	HighlightedItem {   HLI_None =0, HLI_Main, HLI_Modules, HLI_Namespaces,   HLI_Hierarchy, HLI_Classes, HLI_Annotated, HLI_Files,   HLI_NamespaceMembers, HLI_Functions, HLI_Globals, HLI_Pages,   HLI_Examples, HLI_Search, HLI_UserGroup, HLI_ClassVisible,   HLI_NamespaceVisible, HLI_FileVisible }
enum	ClassMemberHighlight {   CMHL_All = 0, CMHL_Functions, CMHL_Variables, CMHL_Typedefs,   CMHL_Enums, CMHL_EnumValues, CMHL_Properties, CMHL_Events,   CMHL_Related, CMHL_Total = CMHL_Related+1 }
enum	FileMemberHighlight {   FMHL_All = 0, FMHL_Functions, FMHL_Variables, FMHL_Typedefs,   FMHL_Enums, FMHL_EnumValues, FMHL_Defines, FMHL_Total = FMHL_Defines+1 }
enum	NamespaceMemberHighlight {   NMHL_All = 0, NMHL_Functions, NMHL_Variables, NMHL_Typedefs,   NMHL_Enums, NMHL_EnumValues, NMHL_Total = NMHL_EnumValues+1 }
enum	ClassHighlight {   CHL_All = 0, CHL_Classes, CHL_Structs, CHL_Unions,   CHL_Interfaces, CHL_Protocols, CHL_Categories, CHL_Exceptions,   CHL_Total = CHL_Exceptions+1 }

Functions
void	writeGraphInfo (OutputList &ol)
void	writeIndexHierarchy (OutputList &ol)
void	countDataStructures ()
void	startTitle (OutputList &ol, const char *fileName, Definition *def=0)
void	endTitle (OutputList &ol, const char *fileName, const char *name)
void	startFile (OutputList &ol, const char *name, const char *manName, const char *title, HighlightedItem hli=HLI_None, bool additionalIndices=FALSE, const char *altSidebarName=0)
void	endFile (OutputList &ol, bool skipNavIndex=FALSE, bool skipEndContents=FALSE, const QCString &navPath=QCString())
void	endFileWithNavPath (Definition *d, OutputList &ol)
void	initClassMemberIndices ()
void	initFileMemberIndices ()
void	initNamespaceMemberIndices ()
void	addClassMemberNameToIndex (MemberDef *md)
void	addFileMemberNameToIndex (MemberDef *md)
void	addNamespaceMemberNameToIndex (MemberDef *md)
QCString	fixSpaces (const QCString &s)

Variables
int	annotatedClasses
int	hierarchyClasses
int	documentedFiles
int	documentedGroups
int	documentedNamespaces
int	indexedPages
int	documentedClassMembers [CMHL_Total]
int	documentedFileMembers [FMHL_Total]
int	documentedNamespaceMembers [NMHL_Total]
int	documentedDirs
int	documentedHtmlFiles
int	documentedPages

Enumeration Type Documentation

enum ClassHighlight

Enumerator
CHL_All
CHL_Classes
CHL_Structs
CHL_Unions
CHL_Interfaces
CHL_Protocols
CHL_Categories
CHL_Exceptions
CHL_Total

Definition at line 241 of file index.h.

{
  CHL_All = 0,
  CHL_Classes,
  CHL_Structs,
  CHL_Unions,
  CHL_Interfaces,
  CHL_Protocols,
  CHL_Categories,
  CHL_Exceptions,
  CHL_Total = CHL_Exceptions+1
};

enum ClassMemberHighlight

Enumerator
CMHL_All
CMHL_Functions
CMHL_Variables
CMHL_Typedefs
CMHL_Enums
CMHL_EnumValues
CMHL_Properties
CMHL_Events
CMHL_Related
CMHL_Total

Definition at line 204 of file index.h.

{
  CMHL_All = 0,
  CMHL_Functions,
  CMHL_Variables,
  CMHL_Typedefs,
  CMHL_Enums,
  CMHL_EnumValues,
  CMHL_Properties,
  CMHL_Events,
  CMHL_Related,
  CMHL_Total = CMHL_Related+1
};

enum FileMemberHighlight

Enumerator
FMHL_All
FMHL_Functions
FMHL_Variables
FMHL_Typedefs
FMHL_Enums
FMHL_EnumValues
FMHL_Defines
FMHL_Total

Definition at line 218 of file index.h.

{
  FMHL_All = 0,
  FMHL_Functions,
  FMHL_Variables,
  FMHL_Typedefs,
  FMHL_Enums,
  FMHL_EnumValues,
  FMHL_Defines,
  FMHL_Total = FMHL_Defines+1
};

enum HighlightedItem

Enumerator
HLI_None
HLI_Main
HLI_Modules
HLI_Namespaces
HLI_Hierarchy
HLI_Classes
HLI_Annotated
HLI_Files
HLI_NamespaceMembers
HLI_Functions
HLI_Globals
HLI_Pages
HLI_Examples
HLI_Search
HLI_UserGroup
HLI_ClassVisible
HLI_NamespaceVisible
HLI_FileVisible

Definition at line 180 of file index.h.

{
  HLI_None=0,
  HLI_Main,
  HLI_Modules,
  //HLI_Directories,
  HLI_Namespaces,
  HLI_Hierarchy,
  HLI_Classes,
  HLI_Annotated,
  HLI_Files,
  HLI_NamespaceMembers,
  HLI_Functions,
  HLI_Globals,
  HLI_Pages,
  HLI_Examples,
  HLI_Search,
  HLI_UserGroup,

  HLI_ClassVisible,
  HLI_NamespaceVisible,
  HLI_FileVisible
};

enum IndexSections

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

Definition at line 157 of file index.h.

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

enum NamespaceMemberHighlight

Enumerator
NMHL_All
NMHL_Functions
NMHL_Variables
NMHL_Typedefs
NMHL_Enums
NMHL_EnumValues
NMHL_Total

Definition at line 230 of file index.h.

{
  NMHL_All = 0,
  NMHL_Functions,
  NMHL_Variables,
  NMHL_Typedefs,
  NMHL_Enums,
  NMHL_EnumValues,
  NMHL_Total = NMHL_EnumValues+1
};

Function Documentation

void addClassMemberNameToIndex

(

MemberDef *

md

)

Definition at line 2264 of file index.cpp.

{
  static bool hideFriendCompounds = Config_getBool("HIDE_FRIEND_COMPOUNDS");
  ClassDef *cd=0;

 
  
  if (md->isLinkableInProject() && 
      (cd=md->getClassDef())    && 
      cd->isLinkableInProject() &&
      cd->templateMaster()==0)
  {
    QCString n = md->name();
    int index = getPrefixIndex(n);
    uint letter = getUtf8CodeToLower(n,index);
    if (!n.isEmpty()) 
    {
      bool isFriendToHide = hideFriendCompounds &&
        (QCString(md->typeString())=="friend class" || 
         QCString(md->typeString())=="friend struct" ||
         QCString(md->typeString())=="friend union");
      if (!(md->isFriend() && isFriendToHide) &&
          (!md->isEnumValue() || (md->getEnumScope() && !md->getEnumScope()->isStrong()))
         )
      {
        g_memberIndexLetterUsed[CMHL_All].append(letter,md);
        documentedClassMembers[CMHL_All]++;
      }
      if (md->isFunction()  || md->isSlot() || md->isSignal())
      {
        g_memberIndexLetterUsed[CMHL_Functions].append(letter,md);
        documentedClassMembers[CMHL_Functions]++;
      }
      else if (md->isVariable())
      {
        g_memberIndexLetterUsed[CMHL_Variables].append(letter,md);
        documentedClassMembers[CMHL_Variables]++;
      }
      else if (md->isTypedef())
      {
        g_memberIndexLetterUsed[CMHL_Typedefs].append(letter,md);
        documentedClassMembers[CMHL_Typedefs]++;
      }
      else if (md->isEnumerate())
      {
        g_memberIndexLetterUsed[CMHL_Enums].append(letter,md);
        documentedClassMembers[CMHL_Enums]++;
      }
      else if (md->isEnumValue() && md->getEnumScope() && !md->getEnumScope()->isStrong())
      {
        g_memberIndexLetterUsed[CMHL_EnumValues].append(letter,md);
        documentedClassMembers[CMHL_EnumValues]++;
      }
      else if (md->isProperty())
      {
        g_memberIndexLetterUsed[CMHL_Properties].append(letter,md);
        documentedClassMembers[CMHL_Properties]++;
      }
      else if (md->isEvent())
      {
        g_memberIndexLetterUsed[CMHL_Events].append(letter,md);
        documentedClassMembers[CMHL_Events]++;
      }
      else if (md->isRelated() || md->isForeign() ||
               (md->isFriend() && !isFriendToHide))
      {
        g_memberIndexLetterUsed[CMHL_Related].append(letter,md);
        documentedClassMembers[CMHL_Related]++;
      }
    }
  }
}

void addFileMemberNameToIndex

(

MemberDef *

md

)

Definition at line 2406 of file index.cpp.

{
  FileDef *fd=md->getFileDef();
  if (fd && fd->isLinkableInProject() && md->isLinkableInProject())
  {
    QCString n = md->name();
    int index = getPrefixIndex(n);
    uint letter = getUtf8CodeToLower(n,index);
    if (!n.isEmpty()) 
    {
      if (!md->isEnumValue() || (md->getEnumScope() && !md->getEnumScope()->isStrong()))
      {
        g_fileIndexLetterUsed[FMHL_All].append(letter,md);
        documentedFileMembers[FMHL_All]++;
      }

      if (md->isFunction()) 
      {
        g_fileIndexLetterUsed[FMHL_Functions].append(letter,md);
        documentedFileMembers[FMHL_Functions]++;
      }
      else if (md->isVariable()) 
      {
        g_fileIndexLetterUsed[FMHL_Variables].append(letter,md);
        documentedFileMembers[FMHL_Variables]++;
      }
      else if (md->isTypedef())
      {
        g_fileIndexLetterUsed[FMHL_Typedefs].append(letter,md);
        documentedFileMembers[FMHL_Typedefs]++;
      }
      else if (md->isEnumerate())
      {
        g_fileIndexLetterUsed[FMHL_Enums].append(letter,md);
        documentedFileMembers[FMHL_Enums]++;
      }
      else if (md->isEnumValue() && md->getEnumScope() && !md->getEnumScope()->isStrong())
      {
        g_fileIndexLetterUsed[FMHL_EnumValues].append(letter,md);
        documentedFileMembers[FMHL_EnumValues]++;
      }
      else if (md->isDefine())
      {
        g_fileIndexLetterUsed[FMHL_Defines].append(letter,md);
        documentedFileMembers[FMHL_Defines]++;
      }
    }
  }
}

void addNamespaceMemberNameToIndex

(

MemberDef *

md

)

Definition at line 2349 of file index.cpp.

{
  NamespaceDef *nd=md->getNamespaceDef();
  if (nd && nd->isLinkableInProject() && md->isLinkableInProject())
  {
    QCString n = md->name();
    int index = getPrefixIndex(n);
    uint letter = getUtf8CodeToLower(n,index);
    if (!n.isEmpty())
    {
      if (!md->isEnumValue() || (md->getEnumScope() && !md->getEnumScope()->isStrong()))
      {
        g_namespaceIndexLetterUsed[NMHL_All].append(letter,md);
        documentedNamespaceMembers[NMHL_All]++;
      }

      if (md->isFunction()) 
      {
        g_namespaceIndexLetterUsed[NMHL_Functions].append(letter,md);
        documentedNamespaceMembers[NMHL_Functions]++;
      }
      else if (md->isVariable()) 
      {
        g_namespaceIndexLetterUsed[NMHL_Variables].append(letter,md);
        documentedNamespaceMembers[NMHL_Variables]++;
      }
      else if (md->isTypedef())
      {
        g_namespaceIndexLetterUsed[NMHL_Typedefs].append(letter,md);
        documentedNamespaceMembers[NMHL_Typedefs]++;
      }
      else if (md->isEnumerate())
      {
        g_namespaceIndexLetterUsed[NMHL_Enums].append(letter,md);
        documentedNamespaceMembers[NMHL_Enums]++;
      }
      else if (md->isEnumValue() && md->getEnumScope() && !md->getEnumScope()->isStrong())
      {
        g_namespaceIndexLetterUsed[NMHL_EnumValues].append(letter,md);
        documentedNamespaceMembers[NMHL_EnumValues]++;
      }
    }
  }
}

void countDataStructures

(

)

Definition at line 77 of file index.cpp.

{
  annotatedClasses           = countAnnotatedClasses(&annotatedClassesPrinted); // "classes" + "annotated"
  hierarchyClasses           = countClassHierarchy();   // "hierarchy"
  countFiles(documentedHtmlFiles,documentedFiles);      // "files"
  countRelatedPages(documentedPages,indexedPages);      // "pages"
  documentedGroups           = countGroups();           // "modules"
  documentedNamespaces       = countNamespaces();       // "namespaces"
  documentedDirs             = countDirs();             // "dirs"
  // "globals"
  // "namespacemembers"
  // "functions"
}

void endFile	(	OutputList &	ol,
		bool	skipNavIndex = FALSE,
		bool	skipEndContents = FALSE,
		const QCString &	navPath = QCString()
	)

Definition at line 263 of file index.cpp.

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

void endFileWithNavPath	(	Definition *	d,
		OutputList &	ol
	)

Definition at line 282 of file index.cpp.

{
  static bool generateTreeView = Config_getBool("GENERATE_TREEVIEW");
  QCString navPath;
  if (generateTreeView)
  {
    ol.pushGeneratorState();
    ol.disableAllBut(OutputGenerator::Html);
    ol.writeString("</div><!-- doc-content -->\n");
    ol.popGeneratorState();
    navPath = d->navigationPathAsString();
  }
  endFile(ol,generateTreeView,TRUE,navPath);
}

void endTitle	(	OutputList &	ol,
		const char *	fileName,
		const char *	name
	)

Definition at line 237 of file index.cpp.

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

QCString fixSpaces

(

const QCString &

s

)

Definition at line 223 of file index.cpp.

{
  return substitute(s," "," ");
}

void initClassMemberIndices

(

)

Definition at line 2254 of file index.cpp.

{
  int j=0;
  for (j=0;j<CMHL_Total;j++)
  {
    documentedClassMembers[j]=0;
    g_memberIndexLetterUsed[j].clear();
  }
}

void initFileMemberIndices

(

)

Definition at line 2396 of file index.cpp.

{
  int j=0;
  for (j=0;j<NMHL_Total;j++)
  {
    documentedFileMembers[j]=0;
    g_fileIndexLetterUsed[j].clear();
  }
}

void initNamespaceMemberIndices

(

)

Definition at line 2339 of file index.cpp.

{
  int j=0;
  for (j=0;j<NMHL_Total;j++)
  {
    documentedNamespaceMembers[j]=0;
    g_namespaceIndexLetterUsed[j].clear();
  }
}

void startFile	(	OutputList &	ol,
		const char *	name,
		const char *	manName,
		const char *	title,
		HighlightedItem	hli = HLI_None,
		bool	additionalIndices = FALSE,
		const char *	altSidebarName = 0
	)

Definition at line 244 of file index.cpp.

{
  static bool disableIndex     = Config_getBool("DISABLE_INDEX");
  ol.startFile(name,manName,title);
  ol.startQuickIndices();
  if (!disableIndex)
  {
    ol.writeQuickLinks(TRUE,hli,name);
  }
  if (!additionalIndices)
  {
    ol.endQuickIndices();
  }
  ol.writeSplitBar(altSidebarName ? altSidebarName : name);
  ol.writeSearchInfo();
}

void startTitle	(	OutputList &	ol,
		const char *	fileName,
		Definition *	def = 0
	)

Definition at line 228 of file index.cpp.

{
  ol.startHeaderSection();
  if (def) def->writeSummaryLinks(ol);
  ol.startTitleHead(fileName);
  ol.pushGeneratorState();
  ol.disable(OutputGenerator::Man);
}

void writeGraphInfo

(

OutputList &

ol

)

Definition at line 3245 of file index.cpp.

{
  if (!Config_getBool("HAVE_DOT") || !Config_getBool("GENERATE_HTML")) return;
  ol.pushGeneratorState();
  ol.disableAllBut(OutputGenerator::Html);
  generateGraphLegend(Config_getString("HTML_OUTPUT"));

  bool &stripCommentsStateRef = Config_getBool("STRIP_CODE_COMMENTS");
  bool oldStripCommentsState = stripCommentsStateRef;
  bool &createSubdirs = Config_getBool("CREATE_SUBDIRS");
  bool oldCreateSubdirs = createSubdirs;
  // temporarily disable the stripping of comments for our own code example!
  stripCommentsStateRef = FALSE;
  // temporarily disable create subdirs for linking to our example
  createSubdirs = FALSE;

  startFile(ol,"graph_legend",0,theTranslator->trLegendTitle().data());
  startTitle(ol,0);
  ol.parseText(theTranslator->trLegendTitle());
  endTitle(ol,0,0);
  ol.startContents();
  QCString legendDocs = theTranslator->trLegendDocs();
  int s = legendDocs.find("<center>");
  int e = legendDocs.find("</center>");
  QCString imgExt = getDotImageExtension();
  if (imgExt=="svg" && s!=-1 && e!=-1)
  {
    legendDocs = legendDocs.left(s+8) + "[!-- SVG 0 --]\n" + legendDocs.mid(e); 
    //printf("legendDocs=%s\n",legendDocs.data());
  }
  FileDef fd("","graph_legend");
  ol.generateDoc("graph_legend",1,&fd,0,legendDocs,FALSE,FALSE);

  // restore config settings
  stripCommentsStateRef = oldStripCommentsState;
  createSubdirs = oldCreateSubdirs;

  endFile(ol);
  ol.popGeneratorState();
}

void writeIndexHierarchy

(

OutputList &

ol

)

Definition at line 4279 of file index.cpp.

{
  LayoutNavEntry *lne = LayoutDocManager::instance().rootNavEntry();
  if (lne)
  {
    writeIndexHierarchyEntries(ol,lne->children());
  }
}

Variable Documentation

int annotatedClasses

Definition at line 55 of file index.cpp.

int documentedClassMembers[CMHL_Total]

Definition at line 62 of file index.cpp.

int documentedDirs

Definition at line 67 of file index.cpp.

int documentedFileMembers[FMHL_Total]

Definition at line 63 of file index.cpp.

int documentedFiles

Definition at line 58 of file index.cpp.

int documentedGroups

Definition at line 59 of file index.cpp.

int documentedHtmlFiles

Definition at line 65 of file index.cpp.

int documentedNamespaceMembers[NMHL_Total]

Definition at line 64 of file index.cpp.

int documentedNamespaces

Definition at line 60 of file index.cpp.

int documentedPages

Definition at line 66 of file index.cpp.

int hierarchyClasses

Definition at line 57 of file index.cpp.

int indexedPages

Definition at line 61 of file index.cpp.