Doxygen
Loading...
Searching...
No Matches
index.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * Copyright (C) 1997-2021 by Dimitri van Heesch.
4 *
5 * Permission to use, copy, modify, and distribute this software and its
6 * documentation under the terms of the GNU General Public License is hereby
7 * granted. No representations are made about the suitability of this software
8 * for any purpose. It is provided "as is" without express or implied warranty.
9 * See the GNU General Public License for more details.
10 *
11 * Documents produced by Doxygen are derivative works derived from the
12 * input used in their production; they are not affected by this license.
13 *
14 */
15
16#ifndef INDEX_H
17#define INDEX_H
18
19#include <map>
20#include <memory>
21#include <vector>
22
23#include "dstring.h"
24#include "construct.h"
25
26class OutputList;
28class MemberDef;
29
56
98
99// Note: we can't use enum class for the enums below as they are also used as an array index,
100// so we wrap them in a namespace instead
101
103{
117} // namespace ClassMemberHighlight
118
120{
134} // namespace FileMemberHighlight
135
137{
150} // namespace NamespaceMemberHighlight
151
153{
164} // namespace ModuleMemberHighlight
165
166class Index
167{
168 public:
169 using MemberIndexList = std::vector<const MemberDef *>;
170 using MemberIndexMap = std::map<std::string,MemberIndexList>;
171
172 static Index &instance();
173
174 void countDataStructures();
175 void addClassMemberNameToIndex(const MemberDef *md);
176 void addFileMemberNameToIndex(const MemberDef *md);
180
181 // ---- getters
182 int numAnnotatedClasses() const;
183 int numAnnotatedClassesPrinted() const;
184 int numHierarchyClasses() const;
185 int numAnnotatedInterfaces() const;
187 int numHierarchyInterfaces() const;
188 int numAnnotatedStructs() const;
189 int numAnnotatedStructsPrinted() const;
190 int numAnnotatedRecords() const;
191 int numAnnotatedRecordsPrinted() const;
192 int numAnnotatedExceptions() const;
194 int numHierarchyExceptions() const;
195 int numDocumentedGroups() const;
196 int numDocumentedNamespaces() const;
197 int numDocumentedConcepts() const;
198 int numDocumentedModules() const;
199 int numIndexedPages() const;
200 int numDocumentedFiles() const;
201 int numDocumentedPages() const;
202 int numDocumentedDirs() const;
211
212 private:
213 void resetDocumentedClassMembers(int i);
214 void resetDocumentedFileMembers(int i);
217 void incrementDocumentedClassMembers(int i,const std::string &letter,const MemberDef *md);
218 void incrementDocumentedFileMembers(int i,const std::string &letter,const MemberDef *md);
219 void incrementDocumentedNamespaceMembers(int i,const std::string &letter,const MemberDef *md);
220 void incrementDocumentedModuleMembers(int i,const std::string &letter,const MemberDef *md);
221 Index();
224 struct Private;
225 std::unique_ptr<Private> p;
226};
227
228void writeGraphInfo(OutputList &ol);
230void startTitle(OutputList &ol,const DString &fileName,const DefinitionMutable *def=nullptr);
231void endTitle(OutputList &ol,const DString &fileName,const DString &name);
232void startFile(OutputList &ol,const DString &name,bool isSource,const DString &manName,
234 bool additionalIndices=false,const DString &altSidebarName=DString(), int hierarchyLevel=0,
235 const DString &allMembersFile=DString());
236void endFile(OutputList &ol,bool skipNavIndex=false,bool skipEndContents=false,
237 const DString &navPath=DString());
238void endFileWithNavPath(OutputList &ol,const DefinitionMutable *d,bool showPageNavigation=true);
239
240#endif
A String class for use with Doxygen wrapping std::string and adding some additional functionality off...
Definition dstring.h:84
void incrementDocumentedNamespaceMembers(int i, const std::string &letter, const MemberDef *md)
Definition index.cpp:213
int numAnnotatedInterfacesPrinted() const
Definition index.cpp:122
void addClassMemberNameToIndex(const MemberDef *md)
Definition index.cpp:2924
std::vector< const MemberDef * > MemberIndexList
Definition index.h:169
void resetDocumentedNamespaceMembers(int i)
Definition index.cpp:176
int numDocumentedFiles() const
Definition index.cpp:136
int numAnnotatedRecords() const
Definition index.cpp:125
int numDocumentedNamespaces() const
Definition index.cpp:132
int numIndexedPages() const
Definition index.cpp:135
int numAnnotatedClassesPrinted() const
Definition index.cpp:119
int numDocumentedGroups() const
Definition index.cpp:131
void resetDocumentedModuleMembers(int i)
Definition index.cpp:182
int numDocumentedModules() const
Definition index.cpp:134
void incrementDocumentedFileMembers(int i, const std::string &letter, const MemberDef *md)
Definition index.cpp:207
int numAnnotatedStructs() const
Definition index.cpp:124
int numDocumentedConcepts() const
Definition index.cpp:133
void addNamespaceMemberNameToIndex(const MemberDef *md)
Definition index.cpp:2985
void resetDocumentedClassMembers(int i)
Definition index.cpp:164
int numAnnotatedStructsPrinted() const
Definition index.cpp:126
void incrementDocumentedClassMembers(int i, const std::string &letter, const MemberDef *md)
Definition index.cpp:201
MemberIndexMap isClassIndexLetterUsed(ClassMemberHighlight::Enum e) const
Definition index.cpp:144
void addFileMemberNameToIndex(const MemberDef *md)
Definition index.cpp:3033
void incrementDocumentedModuleMembers(int i, const std::string &letter, const MemberDef *md)
Definition index.cpp:219
int numHierarchyInterfaces() const
Definition index.cpp:123
int numDocumentedClassMembers(ClassMemberHighlight::Enum e) const
Definition index.cpp:139
int numDocumentedModuleMembers(ModuleMemberHighlight::Enum e) const
Definition index.cpp:142
void addModuleMemberNameToIndex(const MemberDef *md)
Definition index.cpp:3085
int numDocumentedNamespaceMembers(NamespaceMemberHighlight::Enum e) const
Definition index.cpp:141
int numDocumentedPages() const
Definition index.cpp:137
int numHierarchyExceptions() const
Definition index.cpp:130
int numAnnotatedExceptionsPrinted() const
Definition index.cpp:129
int numDocumentedFileMembers(FileMemberHighlight::Enum e) const
Definition index.cpp:140
int numAnnotatedExceptions() const
Definition index.cpp:128
MemberIndexMap isFileIndexLetterUsed(FileMemberHighlight::Enum e) const
Definition index.cpp:149
void sortMemberIndexLists()
Definition index.cpp:226
std::map< std::string, MemberIndexList > MemberIndexMap
Definition index.h:170
static Index & instance()
Definition index.cpp:112
void countDataStructures()
Definition index.cpp:270
int numHierarchyClasses() const
Definition index.cpp:120
MemberIndexMap isModuleIndexLetterUsed(ModuleMemberHighlight::Enum e) const
Definition index.cpp:159
void resetDocumentedFileMembers(int i)
Definition index.cpp:170
int numDocumentedDirs() const
Definition index.cpp:138
int numAnnotatedInterfaces() const
Definition index.cpp:121
Index()
Definition index.cpp:106
std::unique_ptr< Private > p
Definition index.h:225
int numAnnotatedRecordsPrinted() const
Definition index.cpp:127
int numAnnotatedClasses() const
Definition index.cpp:118
MemberIndexMap isNamespaceIndexLetterUsed(NamespaceMemberHighlight::Enum e) const
Definition index.cpp:154
A model of a class/file/namespace member symbol.
Definition memberdef.h:45
Class representing a list of output generators that are written to in parallel.
Definition outputlist.h:311
#define NON_COPYABLE(cls)
Macro to help implementing the rule of 5 for a non-copyable & movable class.
Definition construct.h:37
void writeGraphInfo(OutputList &ol)
Definition index.cpp:4150
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 index.cpp:411
void endTitle(OutputList &ol, const DString &fileName, const DString &name)
Definition index.cpp:404
HighlightedItem
Definition index.h:58
@ AnnotatedExceptions
Definition index.h:77
@ InterfaceVisible
Definition index.h:90
@ InterfaceHierarchy
Definition index.h:65
@ AnnotatedInterfaces
Definition index.h:74
@ NamespaceMembers
Definition index.h:79
@ AnnotatedClasses
Definition index.h:73
@ AnnotatedStructs
Definition index.h:75
@ ExceptionVisible
Definition index.h:93
@ NamespaceVisible
Definition index.h:94
@ ExceptionHierarchy
Definition index.h:66
@ AnnotatedRecords
Definition index.h:76
void endFile(OutputList &ol, bool skipNavIndex=false, bool skipEndContents=false, const DString &navPath=DString())
Definition index.cpp:437
void writeIndexHierarchy(OutputList &ol)
Definition index.cpp:5902
IndexSection
Definition index.h:31
@ isMainPage
Definition index.h:34
@ isTitlePageAuthor
Definition index.h:33
@ isFileIndex
Definition index.h:42
@ isFileDocumentation
Definition index.h:50
@ isPageDocumentation
Definition index.h:52
@ isDirDocumentation
Definition index.h:46
@ isModuleDocumentation
Definition index.h:44
@ isClassHierarchyIndex
Definition index.h:40
@ isModuleIndex
Definition index.h:35
@ isTopicIndex
Definition index.h:36
@ isConceptIndex
Definition index.h:39
@ isExampleDocumentation
Definition index.h:51
@ isClassDocumentation
Definition index.h:48
@ isPageIndex
Definition index.h:43
@ isCompoundIndex
Definition index.h:41
@ isEndIndex
Definition index.h:54
@ isConceptDocumentation
Definition index.h:49
@ isDirIndex
Definition index.h:37
@ isNamespaceIndex
Definition index.h:38
@ isNamespaceDocumentation
Definition index.h:47
@ isTitlePageStart
Definition index.h:32
@ isTopicDocumentation
Definition index.h:45
@ isPageDocumentation2
Definition index.h:53
void startTitle(OutputList &ol, const DString &fileName, const DefinitionMutable *def=nullptr)
Definition index.cpp:394
void endFileWithNavPath(OutputList &ol, const DefinitionMutable *d, bool showPageNavigation=true)
Definition index.cpp:458