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
|
/******************************************************************************
*
*
*
* Copyright (C) 1997-2015 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 <set>
#include "index.h"
#include "definition.h"
#include "memberlist.h"
#include "containers.h"
#include "classlist.h"
class MemberList;
class FileDef;
class FileList;
class ClassDef;
class MemberDef;
class OutputList;
class NamespaceDef;
class NamespaceLinkedRefMap;
class PackageDef;
class DirDef;
class FTextStream;
class ClangTUParser;
// --- Set of files
using FileDefSet = std::set<const FileDef*>;
/** Class representing the data associated with a \#include statement. */
struct IncludeInfo
{
IncludeInfo() {}
IncludeInfo(const FileDef *fd,const QCString &in,bool loc,bool imp)
: fileDef(fd), includeName(in), local(loc), imported(imp) {}
const FileDef *fileDef = 0;
QCString includeName;
bool local = false;
bool imported = false;
};
class IncludeInfoList : public std::vector<IncludeInfo>
{
};
bool compareFileDefs(const FileDef *fd1, const FileDef *fd2);
/** A model of a file symbol.
*
* 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 DefinitionMutable, public Definition
{
public:
~FileDef() {}
// ----------------------------------------------------------------------
virtual DefType definitionType() const = 0;
/*! Returns the unique file name (this may include part of the path). */
virtual QCString name() const = 0;
virtual QCString displayName(bool=TRUE) const = 0;
virtual QCString fileName() const = 0;
virtual QCString getOutputFileBase() const = 0;
virtual QCString anchor() const = 0;
virtual QCString getSourceFileBase() const = 0;
/*! Returns the name of the verbatim copy of this file (if any). */
virtual QCString includeName() const = 0;
virtual QCString includeDependencyGraphFileName() const = 0;
virtual QCString includedByDependencyGraphFileName() const = 0;
/*! Returns the absolute path including the file name. */
virtual QCString absFilePath() const = 0;
/*! Returns the name as it is used in the documentation */
virtual const QCString &docName() const = 0;
/*! Returns TRUE if this file is a source file. */
virtual bool isSource() const = 0;
virtual bool isDocumentationFile() const = 0;
virtual const Definition *getSourceDefinition(int lineNr) const = 0;
virtual const MemberDef *getSourceMember(int lineNr) const = 0;
/*! Returns the absolute path of this file. */
virtual QCString getPath() const = 0;
/*! Returns version of this file. */
virtual QCString getVersion() const = 0;
virtual bool isLinkableInProject() const = 0;
virtual bool isLinkable() const = 0;
virtual bool isIncluded(const QCString &name) const = 0;
virtual PackageDef *packageDef() const = 0;
virtual DirDef *getDirDef() const = 0;
virtual LinkedRefMap<const NamespaceDef> getUsedNamespaces() const = 0;
virtual LinkedRefMap<const ClassDef> getUsedClasses() const = 0;
virtual const IncludeInfoList &includeFileList() const = 0;
virtual const IncludeInfoList &includedByFileList() const = 0;
virtual void getAllIncludeFilesRecursively(StringVector &incFiles) const = 0;
virtual MemberList *getMemberList(MemberListType lt) const = 0;
virtual const MemberLists &getMemberLists() const = 0;
/* user defined member groups */
virtual const MemberGroupList &getMemberGroups() const = 0;
virtual NamespaceLinkedRefMap getNamespaces() const = 0;
virtual ClassLinkedRefMap getClasses() const = 0;
virtual QCString title() const = 0;
virtual bool hasDetailedDescription() const = 0;
virtual QCString fileVersion() const = 0;
virtual bool subGrouping() const = 0;
virtual void countMembers() = 0;
virtual int numDocMembers() const = 0;
virtual int numDecMembers() const = 0;
//---------------------------------
virtual void addSourceRef(int line,const Definition *d,const MemberDef *md) = 0;
virtual void writeDocumentation(OutputList &ol) = 0;
virtual void writeMemberPages(OutputList &ol) = 0;
virtual void writeQuickMemberLinks(OutputList &ol,const MemberDef *currentMd) const = 0;
virtual void writeSummaryLinks(OutputList &ol) const = 0;
virtual void writeTagFile(FTextStream &t) = 0;
virtual void writeSourceHeader(OutputList &ol) = 0;
virtual void writeSourceBody(OutputList &ol,ClangTUParser *clangParser) = 0;
virtual void writeSourceFooter(OutputList &ol) = 0;
virtual void parseSource(ClangTUParser *clangParser) = 0;
virtual void setDiskName(const QCString &name) = 0;
virtual void insertMember(MemberDef *md) = 0;
virtual void insertClass(const ClassDef *cd) = 0;
virtual void insertNamespace(const NamespaceDef *nd) = 0;
virtual void computeAnchors() = 0;
virtual void setPackageDef(PackageDef *pd) = 0;
virtual void setDirDef(DirDef *dd) = 0;
virtual void addUsingDirective(const NamespaceDef *nd) = 0;
virtual void addUsingDeclaration(const ClassDef *cd) = 0;
virtual void combineUsingRelations() = 0;
virtual bool generateSourceFile() const = 0;
virtual void sortMemberLists() = 0;
virtual void addIncludeDependency(const FileDef *fd,const char *incName,bool local,bool imported) = 0;
virtual void addIncludedByDependency(const FileDef *fd,const char *incName,bool local,bool imported) = 0;
virtual void addMembersToMemberGroup() = 0;
virtual void distributeMemberGroupDocumentation() = 0;
virtual void findSectionsInDocumentation() = 0;
virtual void addIncludedUsingDirectives(FileDefSet &visitedFiles) = 0;
virtual void addListReferences() = 0;
};
FileDef *createFileDef(const char *p,const char *n,const char *ref=0,const char *dn=0);
// --- Cast functions
FileDef *toFileDef(Definition *d);
const FileDef *toFileDef(const Definition *d);
// ------------------
class FileList : public std::vector<const FileDef *>
{
};
struct FilesInDir
{
FilesInDir(const QCString &p) : path(p) {}
QCString path;
std::vector<const FileDef *> files;
};
#endif
|
