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

    44 */

    45 

    46 #ifndef DOC_H

    47 #define DOC_H

    48 

    49 #include <QSet>

    50 #include <QString>

    51 

    52 #include "location.h"

    53 

    54 QT_BEGIN_NAMESPACE

    55 

    56 class Atom;

    57 class CodeMarker;

    58 class Config;

    59 class DocPrivate;

    60 class Quoter;

    61 class Text;

    62 class FakeNode;

    63 

    64 typedef QMap<QString, QStringList> QCommandMap;

    65 typedef QMap<QString, QString> QStringMap;

    66 typedef QStringMap::const_iterator QStringMapEntry; 

    67 typedef QMultiMap<QString, QString> QStringMultiMap;

    68 

    69 class Doc

    70 {

    71  public:

    72     // the order is important

    73     enum SectioningUnit { 

    74         Book = -2, 

    75         Part, 

    76         Chapter, 

    77         Section1, 

    78         Section2, 

    79         Section3, 

    80         Section4 

    81     };

    82 

    83     Doc() : priv(0) {}

    84     Doc(const Location &start_loc,

    85         const Location &end_loc, 

    86         const QString &source, 

    87         const QSet<QString> &metaCommandSet);

    88     Doc(const Doc &doc);

    89     ~Doc();

    90 

    91     Doc& operator=( const Doc& doc );

    92 

    93     void renameParameters(const QStringList &oldNames, 

    94                           const QStringList &newNames);

    95     void simplifyEnumDoc();

    96     void setBody(const Text &body);

    97 

    98     const Location &location() const;

    99     bool isEmpty() const;

   100     const QString& source() const;

   101     const Text& body() const;

   102     Text briefText() const;

   103     Text trimmedBriefText(const QString &className) const;

   104     Text legaleseText() const;

   105     const QString& baseName() const;

   106     SectioningUnit granularity() const;

   107     const QSet<QString> &parameterNames() const;

   108     const QStringList &enumItemNames() const;

   109     const QStringList &omitEnumItemNames() const;

   110     const QSet<QString> &metaCommandsUsed() const;

   111     QStringList metaCommandArgs( const QString& metaCommand ) const;

   112     const QList<Text> &alsoList() const;

   113     bool hasTableOfContents() const;

   114     bool hasKeywords() const;

   115     bool hasTargets() const;

   116     const QList<Atom *> &tableOfContents() const;

   117     const QList<int> &tableOfContentsLevels() const;

   118     const QList<Atom *> &keywords() const;

   119     const QList<Atom *> &targets() const;

   120     const QStringMap &metaTagMap() const;

   121 

   122     static void initialize( const Config &config );

   123     static void terminate();

   124     static QString alias( const QString &english );

   125     static void trimCStyleComment( Location& location, QString& str );

   126     static CodeMarker *quoteFromFile(const Location &location, 

   127                                      Quoter &quoter,

   128                                      const QString &fileName);

   129     static QString canonicalTitle(const QString &title);

   130 

   131  private:

   132     void detach();

   133     DocPrivate *priv;

   134 };

   135 

   136 QT_END_NAMESPACE

   137 

   138 #endif