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

    44 */

    45 

    46 #ifndef CPPCODEMARKER_H

    47 #define CPPCODEMARKER_H

    48 

    49 #include "codemarker.h"

    50 

    51 QT_BEGIN_NAMESPACE

    52 

    53 class CppCodeMarker : public CodeMarker

    54 {

    55  public:

    56     CppCodeMarker();

    57     ~CppCodeMarker();

    58 

    59     bool recognizeCode(const QString& code);

    60     bool recognizeExtension(const QString& ext);

    61     bool recognizeLanguage(const QString& lang);

    62     QString plainName(const Node *node);

    63     QString plainFullName(const Node *node, const Node *relative);

    64     QString markedUpCode(const QString& code, 

    65                          const Node *relative, 

    66                          const QString& dirPath);

    67     QString markedUpSynopsis(const Node *node, 

    68                              const Node *relative,

    69                              SynopsisStyle style);

    70 #ifdef QDOC_QML

    71     QString markedUpQmlItem(const Node *node, bool summary);

    72 #endif

    73     QString markedUpName(const Node *node);

    74     QString markedUpFullName(const Node *node, const Node *relative);

    75     QString markedUpEnumValue(const QString &enumValue, const Node *relative);

    76     QString markedUpIncludes(const QStringList& includes);

    77     QString functionBeginRegExp(const QString& funcName);

    78     QString functionEndRegExp(const QString& funcName);

    79     QList<Section> sections(const InnerNode *innerNode, 

    80                             SynopsisStyle style, 

    81                             Status status);

    82     QList<Section> qmlSections(const QmlClassNode* qmlClassNode,

    83                                SynopsisStyle style);

    84     const Node *resolveTarget(const QString& target, 

    85                               const Tree *tree, 

    86                               const Node *relative);

    87 

    88 private:

    89     QString addMarkUp(const QString& protectedCode, 

    90                       const Node *relative, 

    91                       const QString& dirPath);

    92 };

    93 

    94 QT_END_NAMESPACE

    95 

    96 #endif