tools/qdoc3/codeparser.h

   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   codeparser.h
  44 */
  45
  46 #ifndef CODEPARSER_H
  47 #define CODEPARSER_H
  48
  49 #include <QSet>
  50
  51 #include "location.h"
  52
  53 QT_BEGIN_NAMESPACE
  54
  55 class Config;
  56 class Node;
  57 class QString;
  58 class Tree;
  59
  60 class CodeParser
  61 {
  62  public:
  63     CodeParser();
  64     virtual ~CodeParser();
  65
  66     virtual void initializeParser(const Config& config);
  67     virtual void terminateParser();
  68     virtual QString language() = 0;
  69     virtual QString headerFileNameFilter();
  70     virtual QString sourceFileNameFilter() = 0;
  71     virtual void parseHeaderFile(const Location& location,
  72                                  const QString& filePath, Tree *tree);
  73     virtual void parseSourceFile(const Location& location,
  74                                  const QString& filePath, Tree *tree) = 0;
  75     virtual void doneParsingHeaderFiles(Tree *tree);
  76     virtual void doneParsingSourceFiles(Tree *tree) = 0;
  77
  78     static void initialize(const Config& config);
  79     static void terminate();
  80     static CodeParser *parserForLanguage(const QString& language);
  81
  82  protected:
  83     QSet<QString> commonMetaCommands();
  84     void processCommonMetaCommand(const Location& location,
  85                                   const QString& command, const QString& arg,
  86                                   Node *node, Tree *tree);
  87
  88  private:
  89     static QList<CodeParser *> parsers;
  90     static bool showInternal;
  91 };
  92
  93 QT_END_NAMESPACE
  94
  95 #endif