1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
/******************************************************************************
*
*
*
* Copyright (C) 1997-2003 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 FILEDEF_H
#define FILEDEF_H
#include "index.h"
#include <qlist.h>
#include <qintdict.h>
#include <qdict.h>
#include "config.h"
#include "definition.h"
#include "memberlist.h"
#include "util.h"
class FileDef;
class FileList;
class ClassSDict;
class ClassDef;
class ClassList;
class MemberDef;
class OutputList;
class NamespaceDef;
class NamespaceSDict;
class MemberGroupSDict;
class PackageDef;
struct IncludeInfo
{
IncludeInfo() { fileDef=0; local=FALSE; }
~IncludeInfo() {}
FileDef *fileDef;
QCString includeName;
bool local;
};
/*! \class FileDef filedef.h
\brief A File definition.
An object of this class contains all file information that is gathered.
This includes the members and compounds defined in the file.
The member writeDocumentation() can be used to generate the page of
documentation to HTML and LaTeX.
*/
class FileDef : public Definition
{
friend class FileName;
public:
//enum FileType { Source, Header, Unknown };
FileDef(const char *p,const char *n,const char *ref=0,const char *dn=0);
~FileDef();
DefType definitionType() { return TypeFile; }
/*! Returns the unique file name (this may include part of the path). */
QCString name() const
{
if (Config_getBool("FULL_PATH_NAMES"))
return filename;
else
return Definition::name();
}
QCString getOutputFileBase() const
{ return convertNameToFile(diskname); }
QCString getFileBase() const
{ return diskname; }
QCString getSourceFileBase() const
{ return convertNameToFile(diskname+"-source"); }
/*! Returns the name of the verbatim copy of this file (if any). */
QCString includeName() const
{ return convertNameToFile(diskname+"-source"); }
/*! Returns the absolute path including the file name. */
QCString absFilePath() const { return filepath; }
/*! Returns the name as it is used in the documentation */
QCString docName() const { return docname; }
void addSourceRef(int line,Definition *d,MemberDef *md);
Definition *getSourceDefinition(int lineNr);
MemberDef *getSourceMember(int lineNr);
/* Sets the name of the include file to \a n. */
//void setIncludeName(const char *n_) { incName=n_; }
/*! Returns the absolute path of this file. */
QCString getPath() const { return path; }
bool isLinkableInProject() const
{
return hasDocumentation() && !isReference();
}
bool isLinkable() const
{
return isLinkableInProject() || isReference();
}
bool isIncluded(const QCString &name) const;
void writeDetailedDocumentation(OutputList &ol);
void writeDocumentation(OutputList &ol);
void writeSource(OutputList &ol);
friend void generatedFileNames();
void insertMember(MemberDef *md);
void insertClass(ClassDef *cd);
void insertNamespace(NamespaceDef *nd);
void computeAnchors();
void setPackageDef(PackageDef *pd) { package=pd; }
PackageDef *packageDef() const { return package; }
void addUsingDirective(NamespaceDef *nd);
NamespaceList *getUsedNamespaces() const { return usingDirList; }
void addUsingDeclaration(ClassDef *cd);
ClassList *getUsedClasses() const { return usingDeclList; }
bool generateSourceFile() const;
void addIncludeDependency(FileDef *fd,const char *incName,bool local);
void addIncludedByDependency(FileDef *fd,const char *incName,bool local);
QList<IncludeInfo> *includeFileList() const { return includeList; }
QList<IncludeInfo> *includedByFileList() const { return includedByList; }
void addMembersToMemberGroup();
void distributeMemberGroupDocumentation();
void findSectionsInDocumentation();
void addListReferences();
//void generateXML(QTextStream &t);
//void generateXMLSection(QTextStream &t,MemberList *ml,const char *type);
MemberList allMemberList;
// members in the declaration part of the documentation
MemberList decDefineMembers;
MemberList decProtoMembers;
MemberList decTypedefMembers;
MemberList decEnumMembers;
MemberList decFuncMembers;
MemberList decVarMembers;
// members in the documentation part of the documentation
MemberList docDefineMembers;
MemberList docProtoMembers;
MemberList docTypedefMembers;
MemberList docEnumMembers;
MemberList docFuncMembers;
MemberList docVarMembers;
/* user defined member groups */
MemberGroupSDict *memberGroupSDict;
NamespaceSDict *namespaceSDict;
ClassSDict *classSDict;
private:
QDict<IncludeInfo> *includeDict;
QList<IncludeInfo> *includeList;
QDict<IncludeInfo> *includedByDict;
QList<IncludeInfo> *includedByList;
NamespaceList *usingDirList;
ClassList *usingDeclList;
//DefineList *defineList;
QCString path;
QCString filepath;
QCString diskname;
QCString filename;
QCString docname;
//QCString incName;
QIntDict<Definition> *srcDefDict;
QIntDict<MemberDef> *srcMemberDict;
bool isSource;
PackageDef *package;
};
class FileList : public QList<FileDef>
{
public:
FileList() : m_pathName("tmp") {}
FileList(const char *path) : QList<FileDef>(), m_pathName(path) {}
~FileList() {}
QCString path() const { return m_pathName; }
int compareItems(GCI item1,GCI item2)
{
FileDef *md1 = (FileDef *)item1;
FileDef *md2 = (FileDef *)item2;
return stricmp(md1->name(),md2->name());
}
private:
QCString m_pathName;
};
class OutputNameList : public QList<FileList>
{
public:
OutputNameList() : QList<FileList>() {}
~OutputNameList() {}
int compareItems(GCI item1,GCI item2)
{
FileList *fl1 = (FileList *)item1;
FileList *fl2 = (FileList *)item2;
return stricmp(fl1->path(),fl2->path());
}
};
class OutputNameDict : public QDict<FileList>
{
public:
OutputNameDict(int size) : QDict<FileList>(size) {}
~OutputNameDict() {}
};
#endif
|
