source: trunk/tools/qdoc3/generator.h@ 1054

Last change on this file since 1054 was 846, checked in by Dmitry A. Kuminov, 14 years ago

trunk: Merged in qt 4.7.2 sources from branches/vendor/nokia/qt.
File size: 7.7 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4** All rights reserved.
5** Contact: Nokia Corporation ([email protected])
6**
7** This file is part of the tools applications of the Qt Toolkit.
8**
9** $QT_BEGIN_LICENSE:LGPL$
10** Commercial Usage
11** Licensees holding valid Qt Commercial licenses may use this file in
12** accordance with the Qt Commercial License Agreement provided with the
13** Software or, alternatively, in accordance with the terms contained in
14** a written agreement between you and Nokia.
15**
16** GNU Lesser General Public License Usage
17** Alternatively, this file may be used under the terms of the GNU Lesser
18** General Public License version 2.1 as published by the Free Software
19** Foundation and appearing in the file LICENSE.LGPL included in the
20** packaging of this file. Please review the following information to
21** ensure the GNU Lesser General Public License version 2.1 requirements
22** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
23**
24** In addition, as a special exception, Nokia gives you certain additional
25** rights. These rights are described in the Nokia Qt LGPL Exception
26** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file. Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you have questions regarding the use of this file, please contact
37** Nokia at [email protected].
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42/*
43 generator.h
44*/
45
46#ifndef GENERATOR_H
47#define GENERATOR_H
48
49#include <qlist.h>
50#include <qmap.h>
51#include <qregexp.h>
52#include <qstring.h>
53#include <qstringlist.h>
54
55#include "node.h"
56#include "text.h"
57
58QT_BEGIN_NAMESPACE
59
60class ClassNode;
61class Config;
62class CodeMarker;
63class FakeNode;
64class FunctionNode;
65class InnerNode;
66class Location;
67class NamespaceNode;
68class Node;
69class Tree;
70
71class Generator
72{
73 public:
74 Generator();
75 virtual ~Generator();
76
77 virtual void initializeGenerator(const Config &config);
78 virtual void terminateGenerator();
79 virtual QString format() = 0;
80 virtual bool canHandleFormat(const QString &format) { return format == this->format(); }
81 virtual void generateTree(const Tree *tree, CodeMarker *marker) = 0;
82
83 static void initialize(const Config& config);
84 static void terminate();
85 static Generator *generatorForFormat(const QString& format);
86
87 protected:
88 virtual void startText(const Node *relative, CodeMarker *marker);
89 virtual void endText(const Node *relative, CodeMarker *marker);
90 virtual int generateAtom(const Atom *atom,
91 const Node *relative,
92 CodeMarker *marker);
93 virtual void generateClassLikeNode(const InnerNode *inner, CodeMarker *marker);
94 virtual void generateFakeNode(const FakeNode *fake, CodeMarker *marker);
95
96 virtual bool generateText(const Text& text,
97 const Node *relative,
98 CodeMarker *marker);
99#ifdef QDOC_QML
100 virtual bool generateQmlText(const Text& text,
101 const Node *relative,
102 CodeMarker *marker,
103 const QString& qmlName);
104 virtual void generateQmlInherits(const QmlClassNode* cn,
105 CodeMarker* marker);
106#endif
107 virtual void generateBody(const Node *node, CodeMarker *marker);
108 virtual void generateAlsoList(const Node *node, CodeMarker *marker);
109 virtual void generateInherits(const ClassNode *classe,
110 CodeMarker *marker);
111 virtual void generateInheritedBy(const ClassNode *classe,
112 CodeMarker *marker);
113
114 void generateThreadSafeness(const Node *node, CodeMarker *marker);
115 void generateSince(const Node *node, CodeMarker *marker);
116 void generateStatus(const Node *node, CodeMarker *marker);
117 const Atom *generateAtomList(const Atom *atom,
118 const Node *relative,
119 CodeMarker *marker,
120 bool generate,
121 int& numGeneratedAtoms);
122 void generateFileList(const FakeNode* fake,
123 CodeMarker* marker,
124 Node::SubType subtype,
125 const QString& tag);
126 void generateExampleFiles(const FakeNode *fake, CodeMarker *marker);
127
128 virtual int skipAtoms(const Atom *atom, Atom::Type type) const;
129 virtual QString fullName(const Node *node,
130 const Node *relative,
131 CodeMarker *marker) const;
132
133 const QString& outputDir() { return outDir; }
134 QString indent(int level, const QString& markedCode);
135 QString plainCode(const QString& markedCode);
136 virtual QString typeString(const Node *node);
137 virtual QString imageFileName(const Node *relative, const QString& fileBase);
138 void setImageFileExtensions(const QStringList& extensions);
139 void unknownAtom(const Atom *atom);
140 QMap<QString, QString> &formattingLeftMap();
141 QMap<QString, QString> &formattingRightMap();
142
143 QMap<QString, QStringList> editionModuleMap;
144 QMap<QString, QStringList> editionGroupMap;
145
146 static QString trimmedTrailing(const QString &string);
147 static bool matchAhead(const Atom *atom, Atom::Type expectedAtomType);
148 static void supplementAlsoList(const Node *node, QList<Text> &alsoList);
149
150 private:
151 void generateOverload(const Node *node, CodeMarker *marker);
152 void generateReimplementedFrom(const FunctionNode *func,
153 CodeMarker *marker);
154 void appendFullName(Text& text,
155 const Node *apparentNode,
156 const Node *relative,
157 CodeMarker *marker,
158 const Node *actualNode = 0);
159 void appendFullName(Text& text,
160 const Node *apparentNode,
161 const QString& fullName,
162 const Node *actualNode);
163 void appendFullNames(Text& text,
164 const NodeList& nodes,
165 const Node* relative,
166 CodeMarker* marker);
167 void appendSortedNames(Text& text,
168 const ClassNode *classe,
169 const QList<RelatedClass> &classes,
170 CodeMarker *marker);
171
172 protected:
173 void appendSortedQmlNames(Text& text,
174 const Node* base,
175 const NodeList& subs,
176 CodeMarker *marker);
177
178 private:
179 QString amp;
180 QString lt;
181 QString gt;
182 QString quot;
183 QRegExp tag;
184
185 static QList<Generator *> generators;
186 static QMap<QString, QMap<QString, QString> > fmtLeftMaps;
187 static QMap<QString, QMap<QString, QString> > fmtRightMaps;
188 static QMap<QString, QStringList> imgFileExts;
189 static QSet<QString> outputFormats;
190 static QStringList imageFiles;
191 static QStringList imageDirs;
192 static QStringList exampleDirs;
193 static QStringList exampleImgExts;
194 static QStringList scriptFiles;
195 static QStringList scriptDirs;
196 static QStringList styleFiles;
197 static QStringList styleDirs;
198 static QString outDir;
199 static QString project;
200};
201
202QT_END_NAMESPACE
203
204#endif
Note: See TracBrowser for help on using the repository browser.