summaryrefslogtreecommitdiff
path: root/tools/qdoc3/doc.h
blob: 7f8d5c7c02ca8e62062399d5fb8fc5a678fead8a (plain)
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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the tools applications of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

/*
  doc.h
*/

#ifndef DOC_H
#define DOC_H

#include <QSet>
#include <QString>

#include "location.h"

QT_BEGIN_NAMESPACE

class Atom;
class CodeMarker;
class Config;
class DocPrivate;
class Quoter;
class Text;
class FakeNode;

typedef QMap<QString, QStringList> QCommandMap;
typedef QMap<QString, QString> QStringMap;
typedef QStringMap::const_iterator QStringMapEntry; 
typedef QMultiMap<QString, QString> QStringMultiMap;

class Doc
{
 public:
    // the order is important
    enum SectioningUnit { 
        Book = -2, 
        Part, 
        Chapter, 
        Section1, 
        Section2, 
        Section3, 
        Section4 
    };

    Doc() : priv(0) {}
    Doc(const Location &start_loc,
        const Location &end_loc, 
        const QString &source, 
        const QSet<QString> &metaCommandSet);
    Doc(const Doc &doc);
    ~Doc();

    Doc& operator=( const Doc& doc );

    void renameParameters(const QStringList &oldNames, 
                          const QStringList &newNames);
    void simplifyEnumDoc();
    void setBody(const Text &body);

    const Location &location() const;
    bool isEmpty() const;
    const QString& source() const;
    const Text& body() const;
    Text briefText() const;
    Text trimmedBriefText(const QString &className) const;
    Text legaleseText() const;
    const QString& baseName() const;
    SectioningUnit granularity() const;
    const QSet<QString> &parameterNames() const;
    const QStringList &enumItemNames() const;
    const QStringList &omitEnumItemNames() const;
    const QSet<QString> &metaCommandsUsed() const;
    QStringList metaCommandArgs( const QString& metaCommand ) const;
    const QList<Text> &alsoList() const;
    bool hasTableOfContents() const;
    bool hasKeywords() const;
    bool hasTargets() const;
    const QList<Atom *> &tableOfContents() const;
    const QList<int> &tableOfContentsLevels() const;
    const QList<Atom *> &keywords() const;
    const QList<Atom *> &targets() const;
    const QStringMap &metaTagMap() const;

    static void initialize( const Config &config );
    static void terminate();
    static QString alias( const QString &english );
    static void trimCStyleComment( Location& location, QString& str );
    static CodeMarker *quoteFromFile(const Location &location, 
                                     Quoter &quoter,
                                     const QString &fileName);
    static QString canonicalTitle(const QString &title);

 private:
    void detach();
    DocPrivate *priv;
};

#ifdef QDOC2DOX

class DoxWriter
{
  public:
    DoxWriter(const QString& source, DocPrivate* docPrivate)
        : commentType(OtherComment),
          lineLength(0),
          lineCount(0),
          priv(docPrivate),
          oldText(source) {}
    ~DoxWriter() {}

    void pass1();
    void pass2();

    static void setDoxPass(int pass);
    static bool isDoxPass(int pass);
    static bool isDoxPass();
    static void insertTitle(FakeNode* node, const QString& title);
    static void writeTitles();
    static void readTitles();
    static void writeMembers();
    static void readMembers();
    static void writeAnchors();
    static void readAnchors();

  private:
    void indentLine();
    void newLine();
    void concatenate(QString text);
    void wrap(QString text);
    bool conversionRequired() const;
    void convertMetaCommands();
    void convertText();
    const Atom* link(const Atom* atom);
    void formattingLeft(const Atom* atom, const Atom* next);
    void formattingRight(const Atom* atom, const Atom* prev);
    void tt(const Atom* atom);
    void formatIf(const Atom* atom);
    void formatEndif();
    void formatElse();
    const Atom* sectionHeading(const Atom* atom);
    void unhandled(const Atom* atom);
    void code(const Atom* atom);
    const Atom* codeQuoteCommand(const Atom* atom);
    void writeCode(QString text);
    void writeCommand(QCommandMap::const_iterator cmd);

    static void insertAnchor(const QString& text);
    static bool isAnchor(const QString& text);

    static const QString* getPageFile(const QString& title);
    static const QString* getFile(const QString& title);
    static const QString* getExamplePath(const QString& title);
    static const QString* getHeaderFile(const QString& title);
    static const QString* getGroup(const QString& title);
    static const QString* getModule(const QString& title);
    static const QString* getExternalPage(const QString& title);
    static const QString* getPageTitle(const QString& text);
    static const QString* getFileTitle(const QString& text);
    static const QString* getExampleTitle(const QString& text);
    static const QString* getHeaderFileTitle(const QString& text);
    static const QString* getGroupTitle(const QString& text);
    static const QString* getModuleTitle(const QString& text);
    static const QString* getExternalPageTitle(const QString& text);
    
    static bool isProperty(const QString& title, QStringList& classes);
    static bool isVariable(const QString& title, QStringList& classes);
    static bool isEnum(const QString& title, QStringList& classes);

 private:
    static void writeMap(const QStringMap& map, const QString& name);
    static void readMap(QStringMap& map, 
                        QStringMap& inverseMap, 
                        const QString& name);
    static void writeMultiMap(const QStringMultiMap& map, const QString& name);
    static void readMultiMap(QStringMultiMap& map, const QString& name);

 public: // VS 6, SunCC need this to be public
    enum StructType { BulletList, NumericList, ValueList, Table };
 private:
    struct StructDesc {
        StructType      structType;
        int             count;
        bool            nested;
        bool            inTableHeader;
        bool            inTableRow;
        bool            inTableItem;
        bool            odd;

        StructDesc()
            : structType(BulletList),
              count(0),
              nested(false),
              inTableHeader(false),
              inTableRow(false),
              inTableItem(false),
              odd(true) { }

        StructDesc(StructType t, bool n)
            : structType(t),
              count(0),
              nested(n),
              inTableHeader(false),
              inTableRow(false),
              inTableItem(false),
              odd(true) { }
    };

    typedef QStack<StructDesc> StructStack;

    enum CommentType {
        ClassComment,
        EnumComment,
        ExampleComment,
        FnComment,
        GroupComment,
        HeaderFileComment,
        MacroComment,
        ModuleComment,
        PageComment,
        PropertyComment,
        ServiceComment,
        TypedefComment,
        VariableComment,
        OtherComment
    };

  private:
    CommentType         commentType;
    int                 lineLength;
    int                 lineCount;
    DocPrivate*         priv;
    QString             oldText;
    QString             newText;
    StructStack         structs;

    QString             currentPage;
    QString             currentFn;
    QString             currentTitle;
    QString             currentEnum;
    QString             currentProperty;
    QString             currentVariable;
    QString             currentExample;
    QString             currentGroup;
    QString             currentModule;
    QString             currentMacro;
    QString             currentService;
    QString             currentTypedef;
    QString             currentHeaderFile;
    static QString      currentClass;

    static int          doxPass;
    static QSet<QString> anchors;
    static QStringMap   exampleTitles;
    static QStringMap   headerFileTitles;
    static QStringMap   fileTitles;
    static QStringMap   groupTitles;
    static QStringMap   moduleTitles;
    static QStringMap   pageTitles;
    static QStringMap   externalPageTitles;
    static QStringMap   exampleTitlesInverse;
    static QStringMap   headerFileTitlesInverse;
    static QStringMap   fileTitlesInverse;
    static QStringMap   groupTitlesInverse;
    static QStringMap   moduleTitlesInverse;
    static QStringMap   pageTitlesInverse;
    static QStringMap   externalPageTitlesInverse;

    static QStringMultiMap variables;
    static QStringMultiMap properties;
    static QStringMultiMap enums;
};

#endif

QT_END_NAMESPACE

#endif