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   qscodeparser.h

    44 */

    45 

    46 #ifndef QSCODEPARSER_H

    47 #define QSCODEPARSER_H

    48 

    49 #include "cppcodeparser.h"

    50 #include "cpptoqsconverter.h"

    51 

    52 QT_BEGIN_NAMESPACE

    53 

    54 class QsCodeParser : public CppCodeParser

    55 {

    56  public:

    57     QsCodeParser(Tree *cppTree);

    58     ~QsCodeParser();

    59 

    60     virtual void initializeParser(const Config& config);

    61     virtual void terminateParser();

    62     virtual QString language();

    63     virtual QString headerFileNameFilter();

    64     virtual QString sourceFileNameFilter();

    65     virtual void parseHeaderFile(const Location& location,

    66                                  const QString& filePath, Tree *tree);

    67     virtual void parseSourceFile(const Location& location,

    68                                  const QString& filePath, Tree *tree);

    69     virtual void doneParsingHeaderFiles(Tree *tree);

    70     virtual void doneParsingSourceFiles(Tree *tree);

    71 

    72     FunctionNode *findFunctionNode(const QString& synopsis, Tree *tree);

    73 

    74  protected:

    75     virtual QSet<QString> topicCommands();

    76     virtual Node *processTopicCommand(const Doc& doc, const QString& command,

    77                                       const QString& arg);

    78     virtual QSet<QString> otherMetaCommands();

    79     virtual void processOtherMetaCommand(const Doc& doc,

    80                                          const QString& command,

    81                                          const QString& arg, Node *node);

    82 

    83  private:

    84     ClassNode *tryClass(const QString& className);

    85     FunctionNode *findKernelFunction(const QStringList& parentPath,

    86                                      const QString& name);

    87     void extractRegExp(const QRegExp& regExp, QString& source,

    88                        const Doc& doc);

    89     void extractTarget(const QString& target, QString& source,

    90                        const Doc& doc);

    91     void renameParameters(QString& source, const Doc& doc,

    92                           const QStringList& qtNames,

    93                           const QStringList& quickNames);

    94     void applyReplacementList(QString& source, const Doc& doc);

    95     void quickifyClass(ClassNode *quickClass);

    96     void quickifyEnum(ClassNode *quickClass, EnumNode *enume);

    97     void quickifyFunction(ClassNode *quickClass, ClassNode *qtClass,

    98                           FunctionNode *func, bool onBlackList);

    99     void quickifyProperty(ClassNode *quickClass, ClassNode *qtClass,

   100                           PropertyNode *property);

   101     QString quickifiedDoc(const QString& source);

   102     void setQtDoc(Node *quickNode, const Doc& doc);

   103     void setQuickDoc(Node *quickNode, const Doc& doc,

   104                      const QStringList& qtParams = QStringList(),

   105                      const QStringList& quickParams = QStringList());

   106     bool makeFunctionNode(const QString& synopsis, QStringList *parentPathPtr,

   107                           FunctionNode **funcPtr);

   108 

   109     static bool isWord(QChar ch);

   110     static bool leftWordBoundary(const QString& str, int pos);

   111     static bool rightWordBoundary(const QString& str, int pos);

   112 

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

   114     QMap<QString,Node*>         classesWithNoQuickDoc;

   115     QList<QRegExp>              replaceBefores;

   116     QStringList                 replaceAfters;

   117     QSet<QString>               classesWithNoQ;

   118     Tree*                       cppTre;

   119     Tree*                       qsTre;

   120     QRegExp                     replaceRegExp;

   121     CppToQsConverter            cpp2qs;

   122 

   123     static int                  tabSize;

   124 };

   125 

   126 QT_END_NAMESPACE

   127 

   128 #endif