tools/qdoc3/quoter.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2010 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   quoter.h
  44 */
  45
  46 #ifndef QUOTER_H
  47 #define QUOTER_H
  48
  49 #include <qhash.h>
  50 #include <qstringlist.h>
  51
  52 #include "location.h"
  53
  54 QT_BEGIN_NAMESPACE
  55
  56 class Quoter
  57 {
  58 public:
  59     Quoter();
  60
  61     void reset();
  62     void quoteFromFile( const QString& userFriendlyFileName,
  63                         const QString& plainCode, const QString& markedCode );
  64     QString quoteLine( const Location& docLocation, const QString& command,
  65                        const QString& pattern );
  66     QString quoteTo( const Location& docLocation, const QString& command,
  67                      const QString& pattern );
  68     QString quoteUntil( const Location& docLocation, const QString& command,
  69                         const QString& pattern );
  70     QString quoteSnippet(const Location &docLocation, const QString &identifier);
  71
  72 private:
  73     QString getLine();
  74     void failedAtEnd( const Location& docLocation, const QString& command );
  75     bool match( const Location& docLocation, const QString& pattern,
  76                 const QString& line );
  77     QString commentForCode() const;
  78
  79     bool silent;
  80     bool validRegExp;
  81     QStringList plainLines;
  82     QStringList markedLines;
  83     Location codeLocation;
  84     QHash<QString,QString> commentHash;
  85 };
  86
  87 QT_END_NAMESPACE
  88
  89 #endif