namespacedef.h 6.03 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
 *
Dimitri van Heesch's avatar
Dimitri van Heesch committed
5
 * Copyright (C) 1997-2013 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 21 22
 *
 */

#ifndef NAMESPACEDEF_H
#define NAMESPACEDEF_H

#include <qstrlist.h>
#include <qdict.h>
Dimitri van Heesch's avatar
Dimitri van Heesch committed
23
#include "sortdict.h"
Dimitri van Heesch's avatar
Dimitri van Heesch committed
24 25
#include "definition.h"

26
class MemberList;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
27 28
class ClassDef;
class ClassList;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
29 30
class OutputList;
class ClassSDict;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
31
class MemberDef;
32
class NamespaceList;
33
class MemberGroupSDict;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
34
class NamespaceSDict;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
35

Dimitri van Heesch's avatar
Dimitri van Heesch committed
36
/** A model of a namespace symbol. */
Dimitri van Heesch's avatar
Dimitri van Heesch committed
37 38 39
class NamespaceDef : public Definition
{
  public:
40
    NamespaceDef(const char *defFileName,int defLine,int defColumn,
Dimitri van Heesch's avatar
Dimitri van Heesch committed
41
                 const char *name,const char *ref=0,
42 43
                 const char *refFile=0,const char*type=0,
                 bool isPublished=false);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
44
   ~NamespaceDef();
45
    DefType definitionType() const { return TypeNamespace; }
46
    QCString getOutputFileBase() const;
47
    QCString anchor() const { return QCString(); }
Dimitri van Heesch's avatar
Dimitri van Heesch committed
48
    void insertUsedFile(const char *fname);
49
    
Dimitri van Heesch's avatar
Dimitri van Heesch committed
50
    void writeDocumentation(OutputList &ol);
51 52
    void writeMemberPages(OutputList &ol);
    void writeQuickMemberLinks(OutputList &ol,MemberDef *currentMd) const;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
53

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

Dimitri van Heesch's avatar
Dimitri van Heesch committed
58
    void computeAnchors();
59
    int countMembers();
60
    void addUsingDirective(NamespaceDef *nd);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
61
    NamespaceSDict *getUsedNamespaces() const;
62 63
    void addUsingDeclaration(Definition *def);
    SDict<Definition> *getUsedClasses() const { return usingDeclList; }
64
    void combineUsingRelations();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
65
    QCString displayName(bool=TRUE) const;
66
    QCString localName() const;
67 68 69 70

    bool isConstantGroup() const { return CONSTANT_GROUP == m_type; }
    bool isModule()        const { return MODULE == m_type; }

71 72
    bool isLinkableInProject() const;
    bool isLinkable() const;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
73
    void addMembersToMemberGroup();
74
    void distributeMemberGroupDocumentation();
75
    void findSectionsInDocumentation();
76
    void sortMemberLists();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
77 78 79

    virtual Definition *findInnerCompound(const char *name);
    void addInnerCompound(Definition *d);
80
    void addListReferences();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
81
    
82
    MemberList *getMemberList(MemberListType lt) const;
83
    const QList<MemberList> &getMemberLists() const { return m_memberLists; }
84
    MemberDef    *getMemberByName(const QCString &) const;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
85

86 87
    /*! Returns the user defined member groups */
    MemberGroupSDict *getMemberGroupSDict() const { return memberGroupSDict; }
88

89 90
    /*! Returns the classes contained in this namespace */
    ClassSDict *getClassSDict() const { return classSDict; }
91

92 93
    /*! Returns the namespaces contained in this namespace */
    NamespaceSDict *getNamespaceSDict() const { return namespaceSDict; }
94

95
    bool visited;
96

97
  private:
98 99 100 101
    MemberList *createMemberList(MemberListType lt);
    void addMemberToList(MemberListType lt,MemberDef *md);
    void writeMemberDeclarations(OutputList &ol,MemberListType lt,const QCString &title);
    void writeMemberDocumentation(OutputList &ol,MemberListType lt,const QCString &title);
102 103 104 105 106
    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);
107
    void writeInlineClasses(OutputList &ol);
108 109
    void writeNamespaceDeclarations(OutputList &ol,const QCString &title,
            bool isConstantGroup=false);
110 111 112 113
    void writeMemberGroups(OutputList &ol);
    void writeAuthorSection(OutputList &ol);
    void startMemberDocumentation(OutputList &ol);
    void endMemberDocumentation(OutputList &ol);
114
    void writeSummaryLinks(OutputList &ol);
115
    void addNamespaceAttributes(OutputList &ol);
116 117 118 119 120 121 122 123

    QCString              fileName;
    QStrList              files;

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

124
    MemberSDict          *m_allMembersDict;
125 126 127 128
    QList<MemberList>     m_memberLists;
    MemberGroupSDict     *memberGroupSDict;
    ClassSDict           *classSDict;
    NamespaceSDict       *namespaceSDict;
129
    bool                  m_subGrouping;
130 131
    enum { NAMESPACE, MODULE, CONSTANT_GROUP } m_type;
    bool m_isPublished;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
132 133
};

Dimitri van Heesch's avatar
Dimitri van Heesch committed
134
/** A list of NamespaceDef objects. */
Dimitri van Heesch's avatar
Dimitri van Heesch committed
135 136 137
class NamespaceList : public QList<NamespaceDef>
{ 
  public:
138
   ~NamespaceList() {}
139
    int compareItems(QCollection::Item item1,QCollection::Item item2)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
140
    {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
141
      return qstricmp(((NamespaceDef *)item1)->name(),
Dimitri van Heesch's avatar
Dimitri van Heesch committed
142 143 144 145 146
                    ((NamespaceDef *)item2)->name()
                   );
    }
};

Dimitri van Heesch's avatar
Dimitri van Heesch committed
147
/** An iterator for NamespaceDef objects in a NamespaceList. */
Dimitri van Heesch's avatar
Dimitri van Heesch committed
148 149 150 151 152 153 154
class NamespaceListIterator : public QListIterator<NamespaceDef>
{
  public:
    NamespaceListIterator(const NamespaceList &l) : 
      QListIterator<NamespaceDef>(l) {}
};

Dimitri van Heesch's avatar
Dimitri van Heesch committed
155
/** An unsorted dictionary of NamespaceDef objects. */
156 157 158 159
class NamespaceDict : public QDict<NamespaceDef>
{
  public:
    NamespaceDict(int size) : QDict<NamespaceDef>(size) {}
160
   ~NamespaceDict() {}
161
};
Dimitri van Heesch's avatar
Dimitri van Heesch committed
162

Dimitri van Heesch's avatar
Dimitri van Heesch committed
163
/** A sorted dictionary of NamespaceDef objects. */
Dimitri van Heesch's avatar
Dimitri van Heesch committed
164 165 166
class NamespaceSDict : public SDict<NamespaceDef>
{
  public:
167
    NamespaceSDict(int size=17) : SDict<NamespaceDef>(size) {}
Dimitri van Heesch's avatar
Dimitri van Heesch committed
168
   ~NamespaceSDict() {}
169
    int compareItems(QCollection::Item item1,QCollection::Item item2)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
170
    {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
171
      return qstricmp(((NamespaceDef *)item1)->name(),
Dimitri van Heesch's avatar
Dimitri van Heesch committed
172 173 174
                    ((NamespaceDef *)item2)->name()
                   );
    }
175 176
    void writeDeclaration(OutputList &ol,const char *title,
            bool isConstantGroup=false, bool localName=FALSE);
177
    bool declVisible() const;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
178 179 180 181
};



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