summaryrefslogtreecommitdiff
path: root/src/index.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/index.h')
-rw-r--r--src/index.h288
1 files changed, 288 insertions, 0 deletions
diff --git a/src/index.h b/src/index.h
new file mode 100644
index 0000000..fc17fa7
--- /dev/null
+++ b/src/index.h
@@ -0,0 +1,288 @@
+/******************************************************************************
+ *
+ * $Id: index.h,v 1.28 2001/03/19 19:27:40 root Exp $
+ *
+ * Copyright (C) 1997-2012 by Dimitri van Heesch.
+ *
+ * Permission to use, copy, modify, and distribute this software and its
+ * documentation under the terms of the GNU General Public License is hereby
+ * granted. No representations are made about the suitability of this software
+ * for any purpose. It is provided "as is" without express or implied warranty.
+ * See the GNU General Public License for more details.
+ *
+ * Documents produced by Doxygen are derivative works derived from the
+ * input used in their production; they are not affected by this license.
+ *
+ */
+
+#ifndef INDEX_H
+#define INDEX_H
+
+#include "qtbc.h"
+#include <qfile.h>
+#include <qlist.h>
+
+class Definition;
+class MemberDef;
+class OutputList;
+class FTextStream;
+
+/** \brief Abstract interface for index generators. */
+class IndexIntf
+{
+ public:
+ virtual ~IndexIntf() {}
+ virtual void initialize() = 0;
+ virtual void finalize() = 0;
+ virtual void incContentsDepth() = 0;
+ virtual void decContentsDepth() = 0;
+ virtual void addContentsItem(bool isDir, const char *name, const char *ref,
+ const char *file, const char *anchor, bool separateIndex,
+ bool addToNavIndex,Definition *def) = 0;
+ virtual void addIndexItem(Definition *context,MemberDef *md,const char *title) = 0;
+ virtual void addIndexFile(const char *name) = 0;
+ virtual void addImageFile(const char *name) = 0;
+ virtual void addStyleSheetFile(const char *name) = 0;
+};
+
+/** \brief A list of index interfaces.
+ *
+ * This class itself implements all methods of IndexIntf and
+ * just forwards the calls to all items in the list.
+ */
+class IndexList : public IndexIntf
+{
+ private:
+ QList<IndexIntf> m_intfs;
+
+ // --- foreach implementations for various number of arguments
+
+ void foreach(void (IndexIntf::*methodPtr)())
+ {
+ QListIterator<IndexIntf> li(m_intfs);
+ for (li.toFirst();li.current();++li) (li.current()->*methodPtr)();
+ }
+
+ template<typename A1>
+ void foreach(void (IndexIntf::*methodPtr)(A1),A1 a1)
+ {
+ QListIterator<IndexIntf> li(m_intfs);
+ for (li.toFirst();li.current();++li) (li.current()->*methodPtr)(a1);
+ }
+
+ template<typename A1,typename A2,typename A3>
+ void foreach(void (IndexIntf::*methodPtr)(A1,A2,A3),A1 a1,A2 a2,A3 a3)
+ {
+ QListIterator<IndexIntf> li(m_intfs);
+ for (li.toFirst();li.current();++li) (li.current()->*methodPtr)(a1,a2,a3);
+ }
+
+ template<typename A1,typename A2,typename A3,typename A4>
+ void foreach(void (IndexIntf::*methodPtr)(A1,A2,A3,A4),A1 a1,A2 a2,A3 a3,A4 a4)
+ {
+ QListIterator<IndexIntf> li(m_intfs);
+ for (li.toFirst();li.current();++li) (li.current()->*methodPtr)(a1,a2,a3,a4);
+ }
+
+ template<typename A1,typename A2,typename A3,typename A4,typename A5>
+ void foreach(void (IndexIntf::*methodPtr)(A1,A2,A3,A4,A5),A1 a1,A2 a2,A3 a3,A4 a4,A5 a5)
+ {
+ QListIterator<IndexIntf> li(m_intfs);
+ for (li.toFirst();li.current();++li) (li.current()->*methodPtr)(a1,a2,a3,a4,a5);
+ }
+
+ template<typename A1,typename A2,typename A3,typename A4,typename A5,typename A6>
+ void foreach(void (IndexIntf::*methodPtr)(A1,A2,A3,A4,A5,A6),A1 a1,A2 a2,A3 a3,A4 a4,A5 a5,A6 a6)
+ {
+ QListIterator<IndexIntf> li(m_intfs);
+ for (li.toFirst();li.current();++li) (li.current()->*methodPtr)(a1,a2,a3,a4,a5,a6);
+ }
+
+ template<typename A1,typename A2,typename A3,typename A4,typename A5,typename A6,typename A7,typename A8>
+ void foreach(void (IndexIntf::*methodPtr)(A1,A2,A3,A4,A5,A6,A7,A8),A1 a1,A2 a2,A3 a3,A4 a4,A5 a5,A6 a6,A7 a7,A8 a8)
+ {
+ QListIterator<IndexIntf> li(m_intfs);
+ for (li.toFirst();li.current();++li) (li.current()->*methodPtr)(a1,a2,a3,a4,a5,a6,a7,a8);
+ }
+
+ template<typename A1,typename A2,typename A3,typename A4,typename A5,typename A6,typename A7,typename A8,typename A9>
+ void foreach(void (IndexIntf::*methodPtr)(A1,A2,A3,A4,A5,A6,A7,A8,A9),A1 a1,A2 a2,A3 a3,A4 a4,A5 a5,A6 a6,A7 a7,A8 a8,A9 a9)
+ {
+ QListIterator<IndexIntf> li(m_intfs);
+ for (li.toFirst();li.current();++li) (li.current()->*methodPtr)(a1,a2,a3,a4,a5,a6,a7,a8,a9);
+ }
+
+ public:
+ /** Creates a list of indexes */
+ IndexList() { m_intfs.setAutoDelete(TRUE); m_enabled=TRUE; }
+ /** Add an index generator to the list */
+ void addIndex(IndexIntf *intf)
+ { m_intfs.append(intf); }
+ void disable()
+ { m_enabled = FALSE; }
+ void enable()
+ { m_enabled = TRUE; }
+ bool isEnabled() const
+ { return m_enabled; }
+
+ // IndexIntf implementation
+ void initialize()
+ { foreach(&IndexIntf::initialize); }
+ void finalize()
+ { foreach(&IndexIntf::finalize); }
+ void incContentsDepth()
+ { if (m_enabled) foreach(&IndexIntf::incContentsDepth); }
+ void decContentsDepth()
+ { if (m_enabled) foreach(&IndexIntf::decContentsDepth); }
+ void addContentsItem(bool isDir, const char *name, const char *ref,
+ const char *file, const char *anchor,bool separateIndex=FALSE,bool addToNavIndex=FALSE,
+ Definition *def=0)
+ { if (m_enabled) foreach<bool,const char *,const char *,const char *,const char*,bool,bool,Definition *>
+ (&IndexIntf::addContentsItem,isDir,name,ref,file,anchor,separateIndex,addToNavIndex,def); }
+ void addIndexItem(Definition *context,MemberDef *md,const char *title=0)
+ { if (m_enabled) foreach<Definition *,MemberDef *>
+ (&IndexIntf::addIndexItem,context,md,title); }
+ void addIndexFile(const char *name)
+ { if (m_enabled) foreach<const char *>(&IndexIntf::addIndexFile,name); }
+ void addImageFile(const char *name)
+ { if (m_enabled) foreach<const char *>(&IndexIntf::addImageFile,name); }
+ void addStyleSheetFile(const char *name)
+ { if (m_enabled) foreach<const char *>(&IndexIntf::addStyleSheetFile,name); }
+
+ private:
+ bool m_enabled;
+};
+
+
+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_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 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
+};
+
+void writeGraphInfo(OutputList &ol);
+void writeIndexHierarchy(OutputList &ol);
+
+void countDataStructures();
+
+extern int annotatedClasses;
+extern int hierarchyClasses;
+extern int documentedFiles;
+extern int documentedGroups;
+extern int documentedNamespaces;
+extern int indexedPages;
+extern int documentedClassMembers[CMHL_Total];
+extern int documentedFileMembers[FMHL_Total];
+extern int documentedNamespaceMembers[NMHL_Total];
+extern int documentedDirs;
+extern int documentedHtmlFiles;
+extern int documentedPages;
+
+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);
+
+#endif
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-24 12:48:26 +0000