Move qdoc into qtbase and bootstrap it

We need qdoc in qtbase to be able to properly
modularize our documentation and build it
when building the different Qt modules.

qdoc does contain a copy of the qml parser from
qmldevtools, but this is the lesser evil compared
to how we are currently forced to genereate our
docs (and the fact that no developer can run
qdoc and check the docs for their module).

Change-Id: I9f748459382a11cf5d5153d1ee611d7a5d3f4ac1
Reviewed-by: Casper van Donderen <[email protected]>
Reviewed-by: Martin Smith <[email protected]>

1 files changed, 182 insertions, 0 deletions

diff --git a/src/tools/qdoc/tokenizer.h b/src/tools/qdoc/tokenizer.h
new file mode 100644
index 00000000000..b6d6e1d9ca2
--- /dev/null
+++ b/src/tools/qdoc/tokenizer.h
@@ -0,0 +1,182 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the tools applications of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** GNU Lesser General Public License Usage
+** 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.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU General
+** Public License version 3.0 as published by the Free Software Foundation
+** and appearing in the file LICENSE.GPL included in the packaging of this
+** file. Please review the following information to ensure the GNU General
+** Public License version 3.0 requirements will be met:
+** http://www.gnu.org/copyleft/gpl.html.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*
+  tokenizer.h
+*/
+
+#ifndef TOKENIZER_H
+#define TOKENIZER_H
+
+#include <qfile.h>
+#include <qstack.h>
+#include <qstring.h>
+
+#include "location.h"
+
+QT_BEGIN_NAMESPACE
+
+/*
+  Here come the C++ tokens we support.  The first part contains
+  all-purpose tokens; then come keywords.
+
+  If you add a keyword, make sure to modify the keyword array in
+  tokenizer.cpp as well, and possibly adjust Tok_FirstKeyword and
+  Tok_LastKeyword.
+*/
+enum { Tok_Eoi, Tok_Ampersand, Tok_Aster, Tok_Caret, Tok_LeftParen,
+       Tok_RightParen, Tok_LeftParenAster, Tok_Equal, Tok_LeftBrace,
+       Tok_RightBrace, Tok_Semicolon, Tok_Colon, Tok_LeftAngle,
+       Tok_RightAngle, Tok_Comma, Tok_Ellipsis, Tok_Gulbrandsen,
+       Tok_LeftBracket, Tok_RightBracket, Tok_Tilde, Tok_SomeOperator,
+       Tok_Number, Tok_String, Tok_Doc, Tok_Comment, Tok_Ident, Tok_At,
+       Tok_char, Tok_class, Tok_const, Tok_double, Tok_enum,
+       Tok_explicit, Tok_friend, Tok_inline, Tok_int, Tok_long,
+       Tok_namespace, Tok_operator, Tok_private, Tok_protected,
+       Tok_public, Tok_short, Tok_signals, Tok_signed, Tok_slots,
+       Tok_static, Tok_struct, Tok_template, Tok_typedef,
+       Tok_typename, Tok_union, Tok_unsigned, Tok_using, Tok_virtual,
+       Tok_void, Tok_volatile, Tok_int64, Tok_Q_OBJECT, Tok_Q_OVERRIDE,
+       Tok_Q_PROPERTY, Tok_Q_PRIVATE_PROPERTY, Tok_Q_DECLARE_SEQUENTIAL_ITERATOR,
+       Tok_Q_DECLARE_MUTABLE_SEQUENTIAL_ITERATOR,
+       Tok_Q_DECLARE_ASSOCIATIVE_ITERATOR,
+       Tok_Q_DECLARE_MUTABLE_ASSOCIATIVE_ITERATOR,
+       Tok_Q_DECLARE_FLAGS, Tok_Q_SIGNALS, Tok_Q_SLOTS, Tok_QT_COMPAT,
+       Tok_QT_COMPAT_CONSTRUCTOR, Tok_QT_DEPRECATED, Tok_QT_MOC_COMPAT,
+       Tok_QT_MODULE, Tok_QT3_SUPPORT, Tok_QT3_SUPPORT_CONSTRUCTOR,
+       Tok_QT3_MOC_SUPPORT, Tok_QDOC_PROPERTY,
+       Tok_FirstKeyword = Tok_char, Tok_LastKeyword = Tok_QDOC_PROPERTY };
+
+/*
+  The Tokenizer class implements lexical analysis of C++ source
+  files.
+
+  Not every operator or keyword of C++ is recognized; only those
+  that are interesting to us. Some Qt keywords or macros are also
+  recognized.
+*/
+
+class Tokenizer
+{
+public:
+    Tokenizer(const Location& loc, const QByteArray &in);
+    Tokenizer(const Location& loc, QFile &file);
+
+    ~Tokenizer();
+
+    int getToken();
+    void setParsingFnOrMacro(bool macro) { parsingMacro = macro; }
+    bool parsingFnOrMacro() const { return parsingMacro; }
+
+    const Location &location() const { return yyTokLoc; }
+    QString previousLexeme() const;
+    QString lexeme() const;
+    QString version() const { return yyVersion; }
+    int braceDepth() const { return yyBraceDepth; }
+    int parenDepth() const { return yyParenDepth; }
+    int bracketDepth() const { return yyBracketDepth; }
+
+    static void initialize(const Config &config);
+    static void terminate();
+    static bool isTrue(const QString &condition);
+
+private:
+    void init();
+    void start(const Location& loc);
+    /*
+      This limit on the length of a lexeme seems fairly high, but a
+      doc comment can be arbitrarily long. The previous 65,536 limit
+      was reached by Mark Summerfield.
+    */
+    enum { yyLexBufSize = 524288 };
+
+    int getch()
+    {
+        return yyPos == yyIn.size() ? EOF : yyIn[yyPos++];
+    }
+
+    inline int getChar()
+    {
+        if (yyCh == EOF)
+            return EOF;
+        if (yyLexLen < yyLexBufSize - 1) {
+            yyLex[yyLexLen++] = (char) yyCh;
+            yyLex[yyLexLen] = '\0';
+        }
+        yyCurLoc.advance(yyCh);
+        int ch = getch();
+        if (ch == EOF)
+            return EOF;
+        // cast explicitly to make sure the value of ch
+        // is in range [0..255] to avoid assert messages
+        // when using debug CRT that checks its input.
+        return int(uint(uchar(ch)));
+    }
+
+    int getTokenAfterPreprocessor();
+    void pushSkipping(bool skip);
+    bool popSkipping();
+
+    Location yyTokLoc;
+    Location yyCurLoc;
+    char *yyLexBuf1;
+    char *yyLexBuf2;
+    char *yyPrevLex;
+    char *yyLex;
+    size_t yyLexLen;
+    QStack<bool> yyPreprocessorSkipping;
+    int yyNumPreprocessorSkipping;
+    int yyBraceDepth;
+    int yyParenDepth;
+    int yyBracketDepth;
+    int yyCh;
+
+    QString yyVersion;
+    bool parsingMacro;
+
+protected:
+    QByteArray yyIn;
+    int yyPos;
+};
+
+QT_END_NAMESPACE
+
+#endif