1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the tools applications of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    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 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    36 **

    37 **

    38 ** $QT_END_LICENSE$

    39 **

    40 ****************************************************************************/

    41 

    42 /*

    43   cppcodeparser.h

    44 */

    45 

    46 #ifndef CPPCODEPARSER_H

    47 #define CPPCODEPARSER_H

    48 

    49 #include <qregexp.h>

    50 

    51 #include "codeparser.h"

    52 #include "node.h"

    53 

    54 QT_BEGIN_NAMESPACE

    55 

    56 class ClassNode;

    57 class CodeChunk;

    58 class CppCodeParserPrivate;

    59 class FunctionNode;

    60 class InnerNode;

    61 class Tokenizer;

    62 

    63 class CppCodeParser : public CodeParser

    64 {

    65  public:

    66     CppCodeParser();

    67     ~CppCodeParser();

    68 

    69     virtual void initializeParser(const Config& config);

    70     virtual void terminateParser();

    71     virtual QString language();

    72     virtual QString headerFileNameFilter();

    73     virtual QString sourceFileNameFilter();

    74     virtual void parseHeaderFile(const Location& location,

    75                                  const QString& filePath, 

    76                                  Tree *tree);

    77     virtual void parseSourceFile(const Location& location,

    78                                  const QString& filePath, 

    79                                  Tree *tree);

    80     virtual void doneParsingHeaderFiles(Tree *tree);

    81     virtual void doneParsingSourceFiles(Tree *tree);

    82 

    83     const FunctionNode *findFunctionNode(const QString& synopsis, 

    84                                          Tree *tree, 

    85                                          Node *relative = 0, 

    86                                          bool fuzzy = false);

    87 

    88  protected:

    89     virtual QSet<QString> topicCommands();

    90     virtual Node *processTopicCommand(const Doc& doc, 

    91                                       const QString& command,

    92                                       const QString& arg);

    93 #ifdef QDOC_QML    

    94     // might need to implement this in QsCodeParser as well.

    95     virtual Node *processTopicCommandGroup(const Doc& doc,

    96                                            const QString& command,

    97                                            const QStringList& args);

    98     bool splitQmlPropertyArg(const Doc& doc,

    99                              const QString& arg,

   100                              QString& type,

   101                              QString& element,

   102                              QString& property);

   103     bool splitQmlArg(const Doc& doc,

   104                      const QString& arg,

   105                      QString& element,

   106                      QString& name);

   107 #endif

   108     virtual QSet<QString> otherMetaCommands();

   109     virtual void processOtherMetaCommand(const Doc& doc,

   110                                          const QString& command,

   111                                          const QString& arg,

   112                                          Node *node);

   113     void processOtherMetaCommands(const Doc& doc, Node *node);

   114 

   115  private:

   116     void reset(Tree *tree);

   117     void readToken();

   118     const Location& location();

   119     QString previousLexeme();

   120     QString lexeme();

   121     bool match(int target);

   122     bool matchCompat();

   123     bool matchTemplateAngles(CodeChunk *type = 0);

   124     bool matchTemplateHeader();

   125     bool matchDataType(CodeChunk *type, QString *var = 0);

   126     bool matchParameter(FunctionNode *func);

   127     bool matchFunctionDecl(InnerNode *parent, 

   128                            QStringList *parentPathPtr = 0,

   129                            FunctionNode **funcPtr = 0, 

   130                            const QString &templateStuff = QString());

   131     bool matchBaseSpecifier(ClassNode *classe, bool isClass);

   132     bool matchBaseList(ClassNode *classe, bool isClass);

   133     bool matchClassDecl(InnerNode *parent, 

   134                         const QString &templateStuff = QString());

   135     bool matchNamespaceDecl(InnerNode *parent);

   136     bool matchUsingDecl();

   137     bool matchEnumItem(InnerNode *parent, EnumNode *enume);

   138     bool matchEnumDecl(InnerNode *parent);

   139     bool matchTypedefDecl(InnerNode *parent);

   140     bool matchProperty(InnerNode *parent);

   141     bool matchDeclList(InnerNode *parent);

   142     bool matchDocsAndStuff();

   143     bool makeFunctionNode(const QString &synopsis, 

   144                           QStringList *parentPathPtr,

   145 			  FunctionNode **funcPtr, 

   146                           InnerNode *root = 0);

   147     void parseQiteratorDotH(const Location &location, const QString &filePath);

   148     void instantiateIteratorMacro(const QString &container, 

   149                                   const QString &includeFile,

   150 				  const QString &macroDef, 

   151                                   Tree *tree);

   152     void createExampleFileNodes(FakeNode *fake);

   153 

   154     QMap<QString, Node::Type> nodeTypeMap;

   155     Tree *tre;

   156     Tokenizer *tokenizer;

   157     int tok;

   158     Node::Access access;

   159     FunctionNode::Metaness metaness;

   160     QString moduleName;

   161     QStringList lastPath;

   162     QRegExp varComment;

   163     QRegExp sep;

   164 

   165     QString sequentialIteratorDefinition;

   166     QString mutableSequentialIteratorDefinition;

   167     QString associativeIteratorDefinition;

   168     QString mutableAssociativeIteratorDefinition;

   169     QSet<QString> usedNamespaces;

   170     QMap<QString, QString> sequentialIteratorClasses;

   171     QMap<QString, QString> mutableSequentialIteratorClasses;

   172     QMap<QString, QString> associativeIteratorClasses;

   173     QMap<QString, QString> mutableAssociativeIteratorClasses;

   174 

   175     static QStringList exampleFiles;

   176     static QStringList exampleDirs;

   177     QString exampleNameFilter;

   178 };

   179 

   180 QT_END_NAMESPACE

   181 

   182 #endif