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
|
/******************************************************************************
*
* Copyright (C) 1997-2021 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 CONCEPTDEF_H
#define CONCEPTDEF_H
#include "definition.h"
#include "filedef.h"
class ConceptDef : public Definition
{
public:
virtual DefType definitionType() const = 0;
virtual QCString getOutputFileBase() const = 0;
virtual bool hasDetailedDescription() const = 0;
virtual QCString displayName(bool includeScope=true) const = 0;
virtual const IncludeInfo *includeInfo() const = 0;
virtual ArgumentList getTemplateParameterList() const = 0;
virtual QCString anchor() const = 0;
virtual bool isLinkableInProject() const = 0;
virtual bool isLinkable() const = 0;
virtual QCString initializer() const = 0;
virtual void writeDeclarationLink(OutputList &ol,bool &found,
const QCString &header,bool localNames) const = 0;
virtual const NamespaceDef *getNamespaceDef() const = 0;
virtual const FileDef *getFileDef() const = 0;
virtual QCString title() const = 0;
};
class ConceptDefMutable : public DefinitionMutable, public ConceptDef
{
public:
virtual void setIncludeFile(FileDef *fd,const QCString &incName,bool local,bool force) = 0;
virtual void setTemplateArguments(const ArgumentList &al) = 0;
virtual void setNamespace(NamespaceDef *nd) = 0;
virtual void setFileDef(FileDef *fd) = 0;
virtual void writeTagFile(TextStream &) = 0;
virtual void writeDocumentation(OutputList &ol) = 0;
virtual void setInitializer(const QCString &init) = 0;
virtual void findSectionsInDocumentation() = 0;
};
ConceptDefMutable *createConceptDef(
const QCString &fileName,int startLine,int startColumn,const QCString &name,
const QCString &tagRef=QCString(),const QCString &tagFile=QCString());
ConceptDef *createConceptDefAlias(const Definition *newScope,const ConceptDef *cd);
// ---- Map
class ConceptLinkedMap : public LinkedMap<ConceptDef>
{
};
class ConceptLinkedRefMap : public LinkedRefMap<const ConceptDef>
{
public:
bool declVisible() const;
void writeDeclaration(OutputList &ol,const QCString &header,bool localNames) const;
void writeDocumentation(OutputList &ol,const Definition * container=0) const;
};
// ---- Cast functions
ConceptDef *toConceptDef(Definition *d);
ConceptDef *toConceptDef(DefinitionMutable *d);
const ConceptDef *toConceptDef(const Definition *d);
ConceptDefMutable *toConceptDefMutable(Definition *d);
ConceptDefMutable *toConceptDefMutable(const Definition *d);
// --- Helpers
ConceptDef *getConcept(const QCString &key);
inline ConceptDefMutable *getConceptMutable(const QCString &key)
{
return toConceptDefMutable(getConcept(key));
}
ConceptDef *getResolvedConcept(const Definition *scope,const QCString &name);
#endif
|
