namespacedef.h 5.28 KB
Newer Older
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1 2
/******************************************************************************
 *
3
 * 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
4
 *
5
 * Copyright (C) 1997-2010 by Dimitri van Heesch.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
6 7 8 9 10 11 12
 *
 * 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.
 *
Dimitri van Heesch's avatar
Dimitri van Heesch committed
13 14
 * Documents produced by Doxygen are derivative works derived from the
 * input used in their production; they are not affected by this license.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
15 16 17 18 19 20
 *
 */

#ifndef NAMESPACEDEF_H
#define NAMESPACEDEF_H

21
#include "qtbc.h"
Dimitri van Heesch's avatar
Dimitri van Heesch committed
22 23
#include <qstrlist.h>
#include <qdict.h>
Dimitri van Heesch's avatar
Dimitri van Heesch committed
24
#include "sortdict.h"
Dimitri van Heesch's avatar
Dimitri van Heesch committed
25
#include "definition.h"
Dimitri van Heesch's avatar
Dimitri van Heesch committed
26
#include "memberlist.h"
Dimitri van Heesch's avatar
Dimitri van Heesch committed
27 28 29

class ClassDef;
class ClassList;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
30 31
class OutputList;
class ClassSDict;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
32
class MemberDef;
33
class NamespaceList;
34
class MemberGroupSDict;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
35
class NamespaceSDict;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
36 37 38 39

class NamespaceDef : public Definition
{
  public:
40
    NamespaceDef(const char *defFileName,int defLine,
Dimitri van Heesch's avatar
Dimitri van Heesch committed
41 42
                 const char *name,const char *ref=0,
                 const char *refFile=0);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
43
   ~NamespaceDef();
44
    DefType definitionType() const { return TypeNamespace; }
45
    QCString getOutputFileBase() const;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
46
    void insertUsedFile(const char *fname);
47
    
Dimitri van Heesch's avatar
Dimitri van Heesch committed
48
    void writeDocumentation(OutputList &ol);
49 50
    void writeMemberPages(OutputList &ol);
    void writeQuickMemberLinks(OutputList &ol,MemberDef *currentMd) const;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
51

Dimitri van Heesch's avatar
Dimitri van Heesch committed
52
    void insertClass(ClassDef *cd);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
53
    void insertNamespace(NamespaceDef *nd);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
54
    void insertMember(MemberDef *md);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
55

Dimitri van Heesch's avatar
Dimitri van Heesch committed
56
    void computeAnchors();
57
    int countMembers();
58
    void addUsingDirective(NamespaceDef *nd);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
59
    NamespaceSDict *getUsedNamespaces() const;
60 61
    void addUsingDeclaration(Definition *def);
    SDict<Definition> *getUsedClasses() const { return usingDeclList; }
62
    void combineUsingRelations();
63
    QCString displayName() const;
64
    
65 66
    bool isLinkableInProject() const;
    bool isLinkable() const;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
67
    void addMembersToMemberGroup();
68
    void distributeMemberGroupDocumentation();
69
    void findSectionsInDocumentation();
70
    void sortMemberLists();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
71 72 73

    virtual Definition *findInnerCompound(const char *name);
    void addInnerCompound(Definition *d);
74
    void addListReferences();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
75
    
76 77
    MemberList *getMemberList(MemberList::ListType lt) const;
    const QList<MemberList> &getMemberLists() const { return m_memberLists; }
78
    MemberDef    *getMemberByName(const QCString &) const;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
79

80 81
    /*! Returns the user defined member groups */
    MemberGroupSDict *getMemberGroupSDict() const { return memberGroupSDict; }
82

83 84
    /*! Returns the classes contained in this namespace */
    ClassSDict *getClassSDict() const { return classSDict; }
85

86 87
    /*! Returns the namespaces contained in this namespace */
    NamespaceSDict *getNamespaceSDict() const { return namespaceSDict; }
88

89
    bool visited;
90

91 92 93 94 95
  private:
    MemberList *createMemberList(MemberList::ListType lt);
    void addMemberToList(MemberList::ListType lt,MemberDef *md);
    void writeMemberDeclarations(OutputList &ol,MemberList::ListType lt,const QCString &title);
    void writeMemberDocumentation(OutputList &ol,MemberList::ListType lt,const QCString &title);
96 97 98 99 100 101 102 103 104 105
    void writeDetailedDescription(OutputList &ol,const QCString &title);
    void writeBriefDescription(OutputList &ol);
    void startMemberDeclarations(OutputList &ol);
    void endMemberDeclarations(OutputList &ol);
    void writeClassDeclarations(OutputList &ol,const QCString &title);
    void writeNamespaceDeclarations(OutputList &ol,const QCString &title);
    void writeMemberGroups(OutputList &ol);
    void writeAuthorSection(OutputList &ol);
    void startMemberDocumentation(OutputList &ol);
    void endMemberDocumentation(OutputList &ol);
106
    void writeSummaryLinks(OutputList &ol);
107 108 109 110 111 112 113 114

    QCString              fileName;
    QStrList              files;

    NamespaceSDict       *usingDirList;
    SDict<Definition>    *usingDeclList;
    SDict<Definition>    *m_innerCompounds;

115
    MemberSDict          *m_allMembersDict;
116 117 118 119
    QList<MemberList>     m_memberLists;
    MemberGroupSDict     *memberGroupSDict;
    ClassSDict           *classSDict;
    NamespaceSDict       *namespaceSDict;
120
    bool                  m_subGrouping;
121
    bool                  m_isCSharp;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
122 123 124 125 126
};

class NamespaceList : public QList<NamespaceDef>
{ 
  public:
127
   ~NamespaceList() {}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
128 129
    int compareItems(GCI item1,GCI item2)
    {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
130
      return stricmp(((NamespaceDef *)item1)->name(),
Dimitri van Heesch's avatar
Dimitri van Heesch committed
131 132 133 134 135 136 137 138 139 140 141 142
                    ((NamespaceDef *)item2)->name()
                   );
    }
};

class NamespaceListIterator : public QListIterator<NamespaceDef>
{
  public:
    NamespaceListIterator(const NamespaceList &l) : 
      QListIterator<NamespaceDef>(l) {}
};

143 144 145 146
class NamespaceDict : public QDict<NamespaceDef>
{
  public:
    NamespaceDict(int size) : QDict<NamespaceDef>(size) {}
147
   ~NamespaceDict() {}
148
};
Dimitri van Heesch's avatar
Dimitri van Heesch committed
149

Dimitri van Heesch's avatar
Dimitri van Heesch committed
150 151 152
class NamespaceSDict : public SDict<NamespaceDef>
{
  public:
153
    NamespaceSDict(int size=17) : SDict<NamespaceDef>(size) {}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
154 155 156 157 158 159 160
   ~NamespaceSDict() {}
    int compareItems(GCI item1,GCI item2)
    {
      return stricmp(((NamespaceDef *)item1)->name(),
                    ((NamespaceDef *)item2)->name()
                   );
    }
161
    void writeDeclaration(OutputList &ol,const char *title,bool localName=FALSE);
162
    bool declVisible() const;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
163 164 165 166
};



Dimitri van Heesch's avatar
Dimitri van Heesch committed
167
#endif