Index Class

Declaration

class Index { ... }

Included Headers

#include <src/index.h>

Public Member Typedefs Index

using	MemberIndexList = std::vector< const MemberDef * >
using	MemberIndexMap = std::map< std::string, MemberIndexList >

Private Constructors Index

	Index ()

Private Destructor Index

	~Index ()

Public Member Functions Index

void	countDataStructures ()
void	addClassMemberNameToIndex (const MemberDef *md)
void	addFileMemberNameToIndex (const MemberDef *md)
void	addNamespaceMemberNameToIndex (const MemberDef *md)
void	addModuleMemberNameToIndex (const MemberDef *md)
void	sortMemberIndexLists ()
int	numAnnotatedClasses () const
int	numAnnotatedClassesPrinted () const
int	numHierarchyClasses () const
int	numAnnotatedInterfaces () const
int	numAnnotatedInterfacesPrinted () const
int	numHierarchyInterfaces () const
int	numAnnotatedStructs () const
int	numAnnotatedStructsPrinted () const
int	numAnnotatedExceptions () const
int	numAnnotatedExceptionsPrinted () const
int	numHierarchyExceptions () const
int	numDocumentedGroups () const
int	numDocumentedNamespaces () const
int	numDocumentedConcepts () const
int	numDocumentedModules () const
int	numIndexedPages () const
int	numDocumentedFiles () const
int	numDocumentedPages () const
int	numDocumentedDirs () const
int	numDocumentedClassMembers (ClassMemberHighlight::Enum e) const
int	numDocumentedFileMembers (FileMemberHighlight::Enum e) const
int	numDocumentedNamespaceMembers (NamespaceMemberHighlight::Enum e) const
int	numDocumentedModuleMembers (ModuleMemberHighlight::Enum e) const
MemberIndexMap	isClassIndexLetterUsed (ClassMemberHighlight::Enum e) const
MemberIndexMap	isFileIndexLetterUsed (FileMemberHighlight::Enum e) const
MemberIndexMap	isNamespaceIndexLetterUsed (NamespaceMemberHighlight::Enum e) const
MemberIndexMap	isModuleIndexLetterUsed (ModuleMemberHighlight::Enum e) const

Private Member Functions Index

void	resetDocumentedClassMembers (int i)
void	resetDocumentedFileMembers (int i)
void	resetDocumentedNamespaceMembers (int i)
void	resetDocumentedModuleMembers (int i)
void	incrementDocumentedClassMembers (int i, const std::string &letter, const MemberDef *md)
void	incrementDocumentedFileMembers (int i, const std::string &letter, const MemberDef *md)
void	incrementDocumentedNamespaceMembers (int i, const std::string &letter, const MemberDef *md)
void	incrementDocumentedModuleMembers (int i, const std::string &letter, const MemberDef *md)

Private Member Attributes Index

std::unique_ptr< Private >	p

Public Static Functions Index

static Index &	instance ()

Definition at line 164 of file index.h.

Public Member Typedefs

MemberIndexList

using Index::MemberIndexList = std::vector<const MemberDef *>

Definition at line 167 of file index.h.

167 using MemberIndexList = std::vector<const MemberDef *>;

MemberIndexMap

using Index::MemberIndexMap = std::map<std::string,MemberIndexList>

Definition at line 168 of file index.h.

168 using MemberIndexMap = std::map<std::string,MemberIndexList>;

Private Constructors

Index()

Index::Index ()

Declaration at line 217 of file index.h, definition at line 100 of file index.cpp.

100Index::Index() : p(std::make_unique<Private>())

101{

102}

Reference p.

Referenced by instance and ~Index.

Private Destructor

~Index()

Index::~Index ()

Definition at line 218 of file index.h.

Reference Index.

Public Member Functions

addClassMemberNameToIndex()

void Index::addClassMemberNameToIndex (const MemberDef * md)

Declaration at line 173 of file index.h, definition at line 2842 of file index.cpp.

2842void Index::addClassMemberNameToIndex(const MemberDef *md)

2843{

2844 bool hideFriendCompounds = Config_getBool(HIDE_FRIEND_COMPOUNDS);

2845 const ClassDef *cd=nullptr;

2846

2847 if (md->isLinkableInProject() &&

2848 (cd=md->getClassDef()) &&

2849 cd->isLinkableInProject() &&

2850 !cd->isImplicitTemplateInstance())

2851 {

2852 QCString n = md->name();

2853 std::string letter = getUTF8CharAt(n.str(),getPrefixIndex(n));

2854 if (!letter.empty())

2855 {

2856 letter = convertUTF8ToLower(letter);

2857 bool isFriendToHide = hideFriendCompounds &&

2858 (QCString(md->typeString())=="friend class" ||

2859 QCString(md->typeString())=="friend struct" ||

2860 QCString(md->typeString())=="friend union");

2861 if (!(md->isFriend() && isFriendToHide) &&

2862 (!md->isEnumValue() || (md->getEnumScope() && !md->getEnumScope()->isStrong()))

2863 )

2864 {

2865 incrementDocumentedClassMembers(ClassMemberHighlight::All,letter,md);

2866 }

2867 if (md->isFunction() || md->isSlot() || md->isSignal())

2868 {

2869 incrementDocumentedClassMembers(ClassMemberHighlight::Functions,letter,md);

2870 }

2871 else if (md->isVariable())

2872 {

2873 incrementDocumentedClassMembers(ClassMemberHighlight::Variables,letter,md);

2874 }

2875 else if (md->isTypedef())

2876 {

2877 incrementDocumentedClassMembers(ClassMemberHighlight::Typedefs,letter,md);

2878 }

2879 else if (md->isEnumerate())

2880 {

2881 incrementDocumentedClassMembers(ClassMemberHighlight::Enums,letter,md);

2882 }

2883 else if (md->isEnumValue() && md->getEnumScope() && !md->getEnumScope()->isStrong())

2884 {

2885 incrementDocumentedClassMembers(ClassMemberHighlight::EnumValues,letter,md);

2886 }

2887 else if (md->isProperty())

2888 {

2889 incrementDocumentedClassMembers(ClassMemberHighlight::Properties,letter,md);

2890 }

2891 else if (md->isEvent())

2892 {

2893 incrementDocumentedClassMembers(ClassMemberHighlight::Events,letter,md);

2894 }

2895 else if (md->isRelated() || md->isForeign() ||

2896 (md->isFriend() && !isFriendToHide))

2897 {

2898 incrementDocumentedClassMembers(ClassMemberHighlight::Related,letter,md);

2899 }

2900 }

2901 }

2902}

References ClassMemberHighlight::All, Config_getBool, convertUTF8ToLower, ClassMemberHighlight::Enums, ClassMemberHighlight::EnumValues, ClassMemberHighlight::Events, ClassMemberHighlight::Functions, MemberDef::getClassDef, MemberDef::getEnumScope, getPrefixIndex, getUTF8CharAt, incrementDocumentedClassMembers, MemberDef::isEnumerate, MemberDef::isEnumValue, MemberDef::isEvent, MemberDef::isForeign, MemberDef::isFriend, MemberDef::isFunction, ClassDef::isImplicitTemplateInstance, Definition::isLinkableInProject, MemberDef::isProperty, MemberDef::isRelated, MemberDef::isSignal, MemberDef::isSlot, MemberDef::isStrong, MemberDef::isTypedef, MemberDef::isVariable, Definition::name, ClassMemberHighlight::Properties, ClassMemberHighlight::Related, QCString::str, ClassMemberHighlight::Typedefs, MemberDef::typeString and ClassMemberHighlight::Variables.

addFileMemberNameToIndex()

void Index::addFileMemberNameToIndex (const MemberDef * md)

Declaration at line 174 of file index.h, definition at line 2954 of file index.cpp.

2954void Index::addFileMemberNameToIndex(const MemberDef *md)

2955{

2956 const FileDef *fd=md->getFileDef();

2957 if (fd && fd->isLinkableInProject() && md->isLinkableInProject())

2958 {

2959 QCString n = md->name();

2960 std::string letter = getUTF8CharAt(n.str(),getPrefixIndex(n));

2961 if (!letter.empty())

2962 {

2963 letter = convertUTF8ToLower(letter);

2964 if (!md->isEnumValue() || (md->getEnumScope() && !md->getEnumScope()->isStrong()))

2965 {

2966 incrementDocumentedFileMembers(FileMemberHighlight::All,letter,md);

2967 }

2968 if (md->isFunction())

2969 {

2970 incrementDocumentedFileMembers(FileMemberHighlight::Functions,letter,md);

2971 }

2972 else if (md->isVariable())

2973 {

2974 incrementDocumentedFileMembers(FileMemberHighlight::Variables,letter,md);

2975 }

2976 else if (md->isTypedef())

2977 {

2978 incrementDocumentedFileMembers(FileMemberHighlight::Typedefs,letter,md);

2979 }

2980 else if (md->isSequence())

2981 {

2982 incrementDocumentedFileMembers(FileMemberHighlight::Sequences,letter,md);

2983 }

2984 else if (md->isDictionary())

2985 {

2986 incrementDocumentedFileMembers(FileMemberHighlight::Dictionaries,letter,md);

2987 }

2988 else if (md->isEnumerate())

2989 {

2990 incrementDocumentedFileMembers(FileMemberHighlight::Enums,letter,md);

2991 }

2992 else if (md->isEnumValue() && md->getEnumScope() && !md->getEnumScope()->isStrong())

2993 {

2994 incrementDocumentedFileMembers(FileMemberHighlight::EnumValues,letter,md);

2995 }

2996 else if (md->isDefine())

2997 {

2998 incrementDocumentedFileMembers(FileMemberHighlight::Defines,letter,md);

2999 }

3000 }

3001 }

3002}

References FileMemberHighlight::All, convertUTF8ToLower, FileMemberHighlight::Defines, FileMemberHighlight::Dictionaries, FileMemberHighlight::Enums, FileMemberHighlight::EnumValues, FileMemberHighlight::Functions, MemberDef::getEnumScope, MemberDef::getFileDef, getPrefixIndex, getUTF8CharAt, incrementDocumentedFileMembers, MemberDef::isDefine, MemberDef::isDictionary, MemberDef::isEnumerate, MemberDef::isEnumValue, MemberDef::isFunction, Definition::isLinkableInProject, MemberDef::isSequence, MemberDef::isStrong, MemberDef::isTypedef, MemberDef::isVariable, Definition::name, FileMemberHighlight::Sequences, QCString::str, FileMemberHighlight::Typedefs and FileMemberHighlight::Variables.

addModuleMemberNameToIndex()

void Index::addModuleMemberNameToIndex (const MemberDef * md)

Declaration at line 176 of file index.h, definition at line 3006 of file index.cpp.

3006void Index::addModuleMemberNameToIndex(const MemberDef *md)

3007{

3008 const ModuleDef *mod = md->getModuleDef();

3009 if (mod && mod->isPrimaryInterface() && mod->isLinkableInProject() && md->isLinkableInProject())

3010 {

3011 QCString n = md->name();

3012 std::string letter = getUTF8CharAt(n.str(),getPrefixIndex(n));

3013 if (!letter.empty())

3014 {

3015 letter = convertUTF8ToLower(letter);

3016 if (!md->isEnumValue() || (md->getEnumScope() && !md->getEnumScope()->isStrong()))

3017 {

3018 incrementDocumentedModuleMembers(ModuleMemberHighlight::All,letter,md);

3019 }

3020 if (md->isFunction())

3021 {

3022 incrementDocumentedModuleMembers(ModuleMemberHighlight::Functions,letter,md);

3023 }

3024 else if (md->isVariable())

3025 {

3026 incrementDocumentedModuleMembers(ModuleMemberHighlight::Variables,letter,md);

3027 }

3028 else if (md->isTypedef())

3029 {

3030 incrementDocumentedModuleMembers(ModuleMemberHighlight::Typedefs,letter,md);

3031 }

3032 else if (md->isEnumerate())

3033 {

3034 incrementDocumentedModuleMembers(ModuleMemberHighlight::Enums,letter,md);

3035 }

3036 else if (md->isEnumValue() && md->getEnumScope() && !md->getEnumScope()->isStrong())

3037 {

3038 incrementDocumentedModuleMembers(ModuleMemberHighlight::EnumValues,letter,md);

3039 }

3040 }

3041 }

3042}

References ModuleMemberHighlight::All, convertUTF8ToLower, ModuleMemberHighlight::Enums, ModuleMemberHighlight::EnumValues, ModuleMemberHighlight::Functions, MemberDef::getEnumScope, MemberDef::getModuleDef, getPrefixIndex, getUTF8CharAt, incrementDocumentedModuleMembers, MemberDef::isEnumerate, MemberDef::isEnumValue, MemberDef::isFunction, Definition::isLinkableInProject, ModuleDef::isPrimaryInterface, MemberDef::isStrong, MemberDef::isTypedef, MemberDef::isVariable, Definition::name, QCString::str, ModuleMemberHighlight::Typedefs and ModuleMemberHighlight::Variables.

addNamespaceMemberNameToIndex()

void Index::addNamespaceMemberNameToIndex (const MemberDef * md)

Declaration at line 175 of file index.h, definition at line 2906 of file index.cpp.

2906void Index::addNamespaceMemberNameToIndex(const MemberDef *md)

2907{

2908 const NamespaceDef *nd=md->getNamespaceDef();

2909 if (nd && nd->isLinkableInProject() && md->isLinkableInProject())

2910 {

2911 QCString n = md->name();

2912 std::string letter = getUTF8CharAt(n.str(),getPrefixIndex(n));

2913 if (!letter.empty())

2914 {

2915 letter = convertUTF8ToLower(letter);

2916 if (!md->isEnumValue() || (md->getEnumScope() && !md->getEnumScope()->isStrong()))

2917 {

2918 incrementDocumentedNamespaceMembers(NamespaceMemberHighlight::All,letter,md);

2919 }

2920 if (md->isFunction())

2921 {

2922 incrementDocumentedNamespaceMembers(NamespaceMemberHighlight::Functions,letter,md);

2923 }

2924 else if (md->isVariable())

2925 {

2926 incrementDocumentedNamespaceMembers(NamespaceMemberHighlight::Variables,letter,md);

2927 }

2928 else if (md->isTypedef())

2929 {

2930 incrementDocumentedNamespaceMembers(NamespaceMemberHighlight::Typedefs,letter,md);

2931 }

2932 else if (md->isSequence())

2933 {

2934 incrementDocumentedNamespaceMembers(NamespaceMemberHighlight::Sequences,letter,md);

2935 }

2936 else if (md->isDictionary())

2937 {

2938 incrementDocumentedNamespaceMembers(NamespaceMemberHighlight::Dictionaries,letter,md);

2939 }

2940 else if (md->isEnumerate())

2941 {

2942 incrementDocumentedNamespaceMembers(NamespaceMemberHighlight::Enums,letter,md);

2943 }

2944 else if (md->isEnumValue() && md->getEnumScope() && !md->getEnumScope()->isStrong())

2945 {

2946 incrementDocumentedNamespaceMembers(NamespaceMemberHighlight::EnumValues,letter,md);

2947 }

2948 }

2949 }

2950}

References NamespaceMemberHighlight::All, convertUTF8ToLower, NamespaceMemberHighlight::Dictionaries, NamespaceMemberHighlight::Enums, NamespaceMemberHighlight::EnumValues, NamespaceMemberHighlight::Functions, MemberDef::getEnumScope, MemberDef::getNamespaceDef, getPrefixIndex, getUTF8CharAt, incrementDocumentedNamespaceMembers, MemberDef::isDictionary, MemberDef::isEnumerate, MemberDef::isEnumValue, MemberDef::isFunction, Definition::isLinkableInProject, MemberDef::isSequence, MemberDef::isStrong, MemberDef::isTypedef, MemberDef::isVariable, Definition::name, NamespaceMemberHighlight::Sequences, QCString::str, NamespaceMemberHighlight::Typedefs and NamespaceMemberHighlight::Variables.

countDataStructures()

void Index::countDataStructures ()

Declaration at line 172 of file index.h, definition at line 262 of file index.cpp.

262void Index::countDataStructures()

263{

264 for (int j=0;j<ClassMemberHighlight::Total;j++)

265 {

266 resetDocumentedClassMembers(j);

267 }

268 for (int j=0;j<NamespaceMemberHighlight::Total;j++)

269 {

270 resetDocumentedNamespaceMembers(j);

271 }

272 for (int j=0;j<FileMemberHighlight::Total;j++)

273 {

274 resetDocumentedFileMembers(j);

275 }

276 for (int j=0;j<ModuleMemberHighlight::Total;j++)

277 {

278 resetDocumentedModuleMembers(j);

279 }

280

281 bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);

282 p->annotatedClasses = countAnnotatedClasses(&p->annotatedClassesPrinted, ClassDef::Class); // "classes" + "annotated"

283 p->hierarchyClasses = countClassHierarchy(ClassDef::Class); // "hierarchy"

284 // "interfaces" + "annotated"

285 p->annotatedInterfaces = sliceOpt ? countAnnotatedClasses(&p->annotatedInterfacesPrinted, ClassDef::Interface) : 0;

286 // "interfacehierarchy"

287 p->hierarchyInterfaces = sliceOpt ? countClassHierarchy(ClassDef::Interface) : 0;

288 // "structs" + "annotated"

289 p->annotatedStructs = sliceOpt ? countAnnotatedClasses(&p->annotatedStructsPrinted, ClassDef::Struct) : 0;

290 // "exceptions" + "annotated"

291 p->annotatedExceptions = sliceOpt ? countAnnotatedClasses(&p->annotatedExceptionsPrinted, ClassDef::Exception) : 0;

292 // "exceptionhierarchy"

293 p->hierarchyExceptions = sliceOpt ? countClassHierarchy(ClassDef::Exception) : 0;

294 countFiles(p->documentedFiles,p->documentedFiles); // "files"

295 countRelatedPages(p->documentedPages,p->indexedPages); // "pages"

296 p->documentedGroups = countGroups(); // "topics"

297 p->documentedNamespaces = countNamespaces(); // "namespaces"

298 p->documentedConcepts = countConcepts(); // "concepts"

299 p->documentedDirs = countDirs(); // "dirs"

300 p->documentedModules = ModuleManager::instance().numDocumentedModules();

301 // "globals"

302 // "namespacemembers"

303 // "functions"

304}

References ClassDef::Class, Config_getBool, countAnnotatedClasses, countClassHierarchy, countConcepts, countDirs, countFiles, countGroups, countNamespaces, countRelatedPages, ClassDef::Exception, ModuleManager::instance, ClassDef::Interface, ModuleManager::numDocumentedModules, p, resetDocumentedClassMembers, resetDocumentedFileMembers, resetDocumentedModuleMembers, resetDocumentedNamespaceMembers, ClassDef::Struct, ClassMemberHighlight::Total, FileMemberHighlight::Total, ModuleMemberHighlight::Total and NamespaceMemberHighlight::Total.

Referenced by parseInput.

isClassIndexLetterUsed()

Index::MemberIndexMap Index::isClassIndexLetterUsed (ClassMemberHighlight::Enum e)

Declaration at line 203 of file index.h, definition at line 136 of file index.cpp.

136Index::MemberIndexMap Index::isClassIndexLetterUsed(ClassMemberHighlight::Enum e) const

137{

138 return p->classIndexLetterUsed[static_cast<int>(e)];

139}

Reference p.

Referenced by renderQuickLinksAsJs.

isFileIndexLetterUsed()

Index::MemberIndexMap Index::isFileIndexLetterUsed (FileMemberHighlight::Enum e)

Declaration at line 204 of file index.h, definition at line 141 of file index.cpp.

141Index::MemberIndexMap Index::isFileIndexLetterUsed(FileMemberHighlight::Enum e) const

142{

143 return p->fileIndexLetterUsed[static_cast<int>(e)];

144}

Reference p.

Referenced by renderQuickLinksAsJs.

isModuleIndexLetterUsed()

Index::MemberIndexMap Index::isModuleIndexLetterUsed (ModuleMemberHighlight::Enum e)

Declaration at line 206 of file index.h, definition at line 151 of file index.cpp.

151Index::MemberIndexMap Index::isModuleIndexLetterUsed(ModuleMemberHighlight::Enum e) const

152{

153 return p->moduleIndexLetterUsed[static_cast<int>(e)];

154}

Reference p.

Referenced by renderQuickLinksAsJs.

isNamespaceIndexLetterUsed()

Index::MemberIndexMap Index::isNamespaceIndexLetterUsed (NamespaceMemberHighlight::Enum e)

Declaration at line 205 of file index.h, definition at line 146 of file index.cpp.

146Index::MemberIndexMap Index::isNamespaceIndexLetterUsed(NamespaceMemberHighlight::Enum e) const

147{

148 return p->namespaceIndexLetterUsed[static_cast<int>(e)];

149}

Reference p.

Referenced by renderQuickLinksAsJs.

numAnnotatedClasses()

int Index::numAnnotatedClasses ()

Declaration at line 180 of file index.h, definition at line 112 of file index.cpp.

112int Index::numAnnotatedClasses() const { return p->annotatedClasses; }

Reference p.

numAnnotatedClassesPrinted()

int Index::numAnnotatedClassesPrinted ()

Declaration at line 181 of file index.h, definition at line 113 of file index.cpp.

113int Index::numAnnotatedClassesPrinted() const { return p->annotatedClassesPrinted; }

Reference p.

numAnnotatedExceptions()

int Index::numAnnotatedExceptions ()

Declaration at line 188 of file index.h, definition at line 120 of file index.cpp.

120int Index::numAnnotatedExceptions() const { return p->annotatedExceptions; }

Reference p.

numAnnotatedExceptionsPrinted()

int Index::numAnnotatedExceptionsPrinted ()

Declaration at line 189 of file index.h, definition at line 121 of file index.cpp.

121int Index::numAnnotatedExceptionsPrinted() const { return p->annotatedExceptionsPrinted; }

Reference p.

numAnnotatedInterfaces()

int Index::numAnnotatedInterfaces ()

Declaration at line 183 of file index.h, definition at line 115 of file index.cpp.

115int Index::numAnnotatedInterfaces() const { return p->annotatedInterfaces; }

Reference p.

numAnnotatedInterfacesPrinted()

int Index::numAnnotatedInterfacesPrinted ()

Declaration at line 184 of file index.h, definition at line 116 of file index.cpp.

116int Index::numAnnotatedInterfacesPrinted() const { return p->annotatedInterfacesPrinted; }

Reference p.

numAnnotatedStructs()

int Index::numAnnotatedStructs ()

Declaration at line 186 of file index.h, definition at line 118 of file index.cpp.

118int Index::numAnnotatedStructs() const { return p->annotatedStructs; }

Reference p.

numAnnotatedStructsPrinted()

int Index::numAnnotatedStructsPrinted ()

Declaration at line 187 of file index.h, definition at line 119 of file index.cpp.

119int Index::numAnnotatedStructsPrinted() const { return p->annotatedStructsPrinted; }

Reference p.

numDocumentedClassMembers()

int Index::numDocumentedClassMembers (ClassMemberHighlight::Enum e)

Declaration at line 199 of file index.h, definition at line 131 of file index.cpp.

131int Index::numDocumentedClassMembers(ClassMemberHighlight::Enum e) const { return p->documentedClassMembers[e]; }

Reference p.

Referenced by renderQuickLinksAsJs.

numDocumentedConcepts()

int Index::numDocumentedConcepts ()

Declaration at line 193 of file index.h, definition at line 125 of file index.cpp.

125int Index::numDocumentedConcepts() const { return p->documentedConcepts; }

Reference p.

numDocumentedDirs()

int Index::numDocumentedDirs ()

Declaration at line 198 of file index.h, definition at line 130 of file index.cpp.

130int Index::numDocumentedDirs() const { return p->documentedDirs; }

Reference p.

numDocumentedFileMembers()

int Index::numDocumentedFileMembers (FileMemberHighlight::Enum e)

Declaration at line 200 of file index.h, definition at line 132 of file index.cpp.

132int Index::numDocumentedFileMembers(FileMemberHighlight::Enum e) const { return p->documentedFileMembers[e]; }

Reference p.

Referenced by renderQuickLinksAsJs.

numDocumentedFiles()

int Index::numDocumentedFiles ()

Declaration at line 196 of file index.h, definition at line 128 of file index.cpp.

128int Index::numDocumentedFiles() const { return p->documentedFiles; }

Reference p.

numDocumentedGroups()

int Index::numDocumentedGroups ()

Declaration at line 191 of file index.h, definition at line 123 of file index.cpp.

123int Index::numDocumentedGroups() const { return p->documentedGroups; }

Reference p.

numDocumentedModuleMembers()

int Index::numDocumentedModuleMembers (ModuleMemberHighlight::Enum e)

Declaration at line 202 of file index.h, definition at line 134 of file index.cpp.

134int Index::numDocumentedModuleMembers(ModuleMemberHighlight::Enum e) const { return p->documentedModuleMembers[e]; }

Reference p.

Referenced by renderQuickLinksAsJs.

numDocumentedModules()

int Index::numDocumentedModules ()

Declaration at line 194 of file index.h, definition at line 126 of file index.cpp.

126int Index::numDocumentedModules() const { return p->documentedModules; }

Reference p.

numDocumentedNamespaceMembers()

int Index::numDocumentedNamespaceMembers (NamespaceMemberHighlight::Enum e)

Declaration at line 201 of file index.h, definition at line 133 of file index.cpp.

133int Index::numDocumentedNamespaceMembers(NamespaceMemberHighlight::Enum e) const { return p->documentedNamespaceMembers[e]; }

Reference p.

Referenced by renderQuickLinksAsJs.

numDocumentedNamespaces()

int Index::numDocumentedNamespaces ()

Declaration at line 192 of file index.h, definition at line 124 of file index.cpp.

124int Index::numDocumentedNamespaces() const { return p->documentedNamespaces; }

Reference p.

numDocumentedPages()

int Index::numDocumentedPages ()

Declaration at line 197 of file index.h, definition at line 129 of file index.cpp.

129int Index::numDocumentedPages() const { return p->documentedPages; }

Reference p.

numHierarchyClasses()

int Index::numHierarchyClasses ()

Declaration at line 182 of file index.h, definition at line 114 of file index.cpp.

114int Index::numHierarchyClasses() const { return p->hierarchyClasses; }

Reference p.

numHierarchyExceptions()

int Index::numHierarchyExceptions ()

Declaration at line 190 of file index.h, definition at line 122 of file index.cpp.

122int Index::numHierarchyExceptions() const { return p->hierarchyExceptions; }

Reference p.

numHierarchyInterfaces()

int Index::numHierarchyInterfaces ()

Declaration at line 185 of file index.h, definition at line 117 of file index.cpp.

117int Index::numHierarchyInterfaces() const { return p->hierarchyInterfaces; }

Reference p.

numIndexedPages()

int Index::numIndexedPages ()

Declaration at line 195 of file index.h, definition at line 127 of file index.cpp.

127int Index::numIndexedPages() const { return p->indexedPages; }

Reference p.

sortMemberIndexLists()

void Index::sortMemberIndexLists ()

Declaration at line 177 of file index.h, definition at line 218 of file index.cpp.

218void Index::sortMemberIndexLists()

219{

220 auto sortMemberIndexList = [](MemberIndexMap &map)

221 {

222 for (auto &[name,list] : map)

223 {

224 std::stable_sort(list.begin(),list.end(),

225 [](const MemberDef *md1,const MemberDef *md2)

226 {

227 // consider candidates A::a, B::b, B::a, A::b, A::A, B::B,

228 // want after sorting: A::A, A::a, B::a, B::B, A::b, B::b

229 // so we can later group entries

230 // - A: A

231 // - a: A, B

232 // - B: B

233 // - b: A, B

234 int result = qstricmp_sort(md1->name(),md2->name());

235 if (result==0) // next compare with full scope

236 {

237 result = qstricmp_sort(md1->qualifiedName(),md2->qualifiedName());

238 }

239 return result<0;

240 });

241 }

242 };

243

244 for (auto &idx : p->classIndexLetterUsed)

245 {

246 sortMemberIndexList(idx);

247 }

248 for (auto &idx : p->fileIndexLetterUsed)

249 {

250 sortMemberIndexList(idx);

251 }

252 for (auto &idx : p->namespaceIndexLetterUsed)

253 {

254 sortMemberIndexList(idx);

255 }

256 for (auto &idx : p->moduleIndexLetterUsed)

257 {

258 sortMemberIndexList(idx);

259 }

260}

Private Member Functions

incrementDocumentedClassMembers()

void Index::incrementDocumentedClassMembers (int i, const std::string & letter, const MemberDef * md)

Declaration at line 213 of file index.h, definition at line 193 of file index.cpp.

193void Index::incrementDocumentedClassMembers(int i,const std::string &letter,const MemberDef *md)

194{

195 p->documentedClassMembers[i]++;

196 MemberIndexMap_add(p->classIndexLetterUsed[i],letter,md);

197}

References MemberIndexMap_add and p.

Referenced by addClassMemberNameToIndex.

incrementDocumentedFileMembers()

void Index::incrementDocumentedFileMembers (int i, const std::string & letter, const MemberDef * md)

Declaration at line 214 of file index.h, definition at line 199 of file index.cpp.

199void Index::incrementDocumentedFileMembers(int i,const std::string &letter,const MemberDef *md)

200{

201 p->documentedFileMembers[i]++;

202 MemberIndexMap_add(p->fileIndexLetterUsed[i],letter,md);

203}

References MemberIndexMap_add and p.

Referenced by addFileMemberNameToIndex.

incrementDocumentedModuleMembers()

void Index::incrementDocumentedModuleMembers (int i, const std::string & letter, const MemberDef * md)

Declaration at line 216 of file index.h, definition at line 211 of file index.cpp.

211void Index::incrementDocumentedModuleMembers(int i,const std::string &letter,const MemberDef *md)

212{

213 p->documentedModuleMembers[i]++;

214 MemberIndexMap_add(p->moduleIndexLetterUsed[i],letter,md);

215}

References MemberIndexMap_add and p.

Referenced by addModuleMemberNameToIndex.

incrementDocumentedNamespaceMembers()

void Index::incrementDocumentedNamespaceMembers (int i, const std::string & letter, const MemberDef * md)

Declaration at line 215 of file index.h, definition at line 205 of file index.cpp.

205void Index::incrementDocumentedNamespaceMembers(int i,const std::string &letter,const MemberDef *md)

206{

207 p->documentedNamespaceMembers[i]++;

208 MemberIndexMap_add(p->namespaceIndexLetterUsed[i],letter,md);

209}

References MemberIndexMap_add and p.

Referenced by addNamespaceMemberNameToIndex.

resetDocumentedClassMembers()

void Index::resetDocumentedClassMembers (int i)

Declaration at line 209 of file index.h, definition at line 156 of file index.cpp.

156void Index::resetDocumentedClassMembers(int i)

157{

158 p->documentedClassMembers[i]=0;

159 p->classIndexLetterUsed[i].clear();

160}

Reference p.

Referenced by countDataStructures.

resetDocumentedFileMembers()

void Index::resetDocumentedFileMembers (int i)

Declaration at line 210 of file index.h, definition at line 162 of file index.cpp.

162void Index::resetDocumentedFileMembers(int i)

163{

164 p->documentedFileMembers[i]=0;

165 p->fileIndexLetterUsed[i].clear();

166}

Reference p.

Referenced by countDataStructures.

resetDocumentedModuleMembers()

void Index::resetDocumentedModuleMembers (int i)

Declaration at line 212 of file index.h, definition at line 174 of file index.cpp.

174void Index::resetDocumentedModuleMembers(int i)

175{

176 p->documentedModuleMembers[i]=0;

177 p->moduleIndexLetterUsed[i].clear();

178}

Reference p.

Referenced by countDataStructures.

resetDocumentedNamespaceMembers()

void Index::resetDocumentedNamespaceMembers (int i)

Declaration at line 211 of file index.h, definition at line 168 of file index.cpp.

168void Index::resetDocumentedNamespaceMembers(int i)

169{

170 p->documentedNamespaceMembers[i]=0;

171 p->namespaceIndexLetterUsed[i].clear();

172}

Reference p.

Referenced by countDataStructures.

Private Member Attributes

p

std::unique_ptr<Private> Index::p

Definition at line 221 of file index.h.

221 std::unique_ptr<Private> p;

Referenced by countDataStructures, incrementDocumentedClassMembers, incrementDocumentedFileMembers, incrementDocumentedModuleMembers, incrementDocumentedNamespaceMembers, Index, isClassIndexLetterUsed, isFileIndexLetterUsed, isModuleIndexLetterUsed, isNamespaceIndexLetterUsed, numAnnotatedClasses, numAnnotatedClassesPrinted, numAnnotatedExceptions, numAnnotatedExceptionsPrinted, numAnnotatedInterfaces, numAnnotatedInterfacesPrinted, numAnnotatedStructs, numAnnotatedStructsPrinted, numDocumentedClassMembers, numDocumentedConcepts, numDocumentedDirs, numDocumentedFileMembers, numDocumentedFiles, numDocumentedGroups, numDocumentedModuleMembers, numDocumentedModules, numDocumentedNamespaceMembers, numDocumentedNamespaces, numDocumentedPages, numHierarchyClasses, numHierarchyExceptions, numHierarchyInterfaces, numIndexedPages, resetDocumentedClassMembers, resetDocumentedFileMembers, resetDocumentedModuleMembers and resetDocumentedNamespaceMembers.

Public Static Functions

instance()

Index & Index::instance ()

static

Declaration at line 170 of file index.h, definition at line 106 of file index.cpp.

106Index &Index::instance()

107{

108 static Index index;

109 return index;

110}

Reference Index.

Referenced by addMembersToIndex, generateFileDocs, generatePageDocs, parseInput, quickLinkVisible, quickLinkVisible, renderQuickLinksAsJs, writeAlphabeticalExceptionIndex, writeAlphabeticalIndex, writeAlphabeticalInterfaceIndex, writeAlphabeticalStructIndex, writeAnnotatedExceptionIndex, writeAnnotatedIndex, writeAnnotatedInterfaceIndex, writeAnnotatedStructIndex, writeClassMemberIndex, writeClassMemberIndexFiltered, writeConceptIndex, writeFileIndex, writeFileMemberIndex, writeFileMemberIndexFiltered, writeGraphicalClassHierarchy, writeGraphicalExceptionHierarchy, writeGraphicalInterfaceHierarchy, writeHierarchicalExceptionIndex, writeHierarchicalIndex, writeHierarchicalInterfaceIndex, writeIndex, writeIndexHierarchyEntries, writeModuleMemberIndex, writeModuleMemberIndexFiltered, writeNamespaceIndex, writeNamespaceMemberIndex, writeNamespaceMemberIndexFiltered, writePageIndex and writeTopicIndex.

---

The documentation for this class was generated from the following files:

• index.cpp
• index.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.14.0.