qdoc: Don't load index in -prepare phase
[qt:qtbase.git] / src / tools / qdoc / location.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the tools applications of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia.  For licensing terms and
14 ** conditions see http://qt.digia.com/licensing.  For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file.  Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights.  These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file.  Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 /*
43   location.h
44 */
45
46 #ifndef LOCATION_H
47 #define LOCATION_H
48
49 #include <qstack.h>
50
51 #include "tr.h"
52
53 QT_BEGIN_NAMESPACE
54
55 class Config;
56 class QRegExp;
57
58 class Location
59 {
60 public:
61     Location();
62     Location(const QString& filePath);
63     Location(const Location& other);
64     ~Location() { delete stk; }
65
66     Location& operator=(const Location& other);
67
68     void start();
69     void advance(QChar ch);
70     void advanceLines(int n) { stkTop->lineNo += n; stkTop->columnNo = 1; }
71
72     void push(const QString& filePath);
73     void pop();
74     void setEtc(bool etc) { etcetera = etc; }
75     void setLineNo(int no) { stkTop->lineNo = no; }
76     void setColumnNo(int no) { stkTop->columnNo = no; }
77
78     bool isEmpty() const { return stkDepth == 0; }
79     int depth() const { return stkDepth; }
80     const QString& filePath() const { return stkTop->filePath; }
81     QString fileName() const;
82     QString canonicalRelativePath(const QString &path) const;
83     int lineNo() const { return stkTop->lineNo; }
84     int columnNo() const { return stkTop->columnNo; }
85     bool etc() const { return etcetera; }
86     void warning(const QString& message,
87                  const QString& details = QString()) const;
88     void error(const QString& message,
89                const QString& details = QString()) const;
90     void fatal(const QString& message,
91                const QString& details = QString()) const;
92
93     QT_STATIC_CONST Location null;
94
95     static void initialize(const Config& config);
96     static void terminate();
97     static void information(const QString& message);
98     static void internalError(const QString& hint);
99     static void logToStdErr(const QString& message);
100
101 private:
102     enum MessageType { Warning, Error };
103
104     struct StackEntry
105     {
106         QString filePath;
107         int lineNo;
108         int columnNo;
109     };
110
111     void emitMessage(MessageType type,
112                      const QString& message,
113                      const QString& details) const;
114     QString toString() const;
115     QString top() const;
116
117 private:
118     StackEntry stkBottom;
119     QStack<StackEntry> *stk;
120     StackEntry *stkTop;
121     int stkDepth;
122     bool etcetera;
123
124     static int tabSize;
125     static QString programName;
126     static QRegExp *spuriousRegExp;
127 };
128
129 QT_END_NAMESPACE
130
131 #endif