tools/qdoc3/codechunk.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   codechunk.h
  44 */
  45
  46 #ifndef CODECHUNK_H
  47 #define CODECHUNK_H
  48
  49 #include <qstring.h>
  50
  51 QT_BEGIN_NAMESPACE
  52
  53 // ### get rid of that class
  54
  55 /*
  56   The CodeChunk class represents a tiny piece of C++ code.
  57
  58   The class provides convertion between a list of lexemes and a string.  It adds
  59   spaces at the right place for consistent style.  The tiny pieces of code it
  60   represents are data types, enum values, and default parameter values.
  61
  62   Apart from the piece of code itself, there are two bits of metainformation
  63   stored in CodeChunk: the base and the hotspot.  The base is the part of the
  64   piece that may be a hypertext link.  The base of
  65
  66       QMap<QString, QString>
  67
  68   is QMap.
  69
  70   The hotspot is the place the variable name should be inserted in the case of a
  71   variable (or parameter) declaration.  The base of
  72
  73       char * []
  74
  75   is between '*' and '[]'.
  76 */
  77 class CodeChunk
  78 {
  79 public:
  80     CodeChunk();
  81     CodeChunk( const QString& str );
  82
  83     void append( const QString& lexeme );
  84     void appendHotspot();
  85
  86     bool isEmpty() const { return s.isEmpty(); }
  87     QString toString() const;
  88     QStringList toPath() const;
  89     QString left() const { return s.left(hotspot == -1 ? s.length() : hotspot); }
  90     QString right() const { return s.mid(hotspot == -1 ? s.length() : hotspot); }
  91
  92 private:
  93     QString s;
  94     int hotspot;
  95 };
  96
  97 inline bool operator==( const CodeChunk& c, const CodeChunk& d ) {
  98     return c.toString() == d.toString();
  99 }
 100
 101 inline bool operator!=( const CodeChunk& c, const CodeChunk& d ) {
 102     return !( c == d );
 103 }
 104
 105 inline bool operator<( const CodeChunk& c, const CodeChunk& d ) {
 106     return c.toString() < d.toString();
 107 }
 108
 109 inline bool operator>( const CodeChunk& c, const CodeChunk& d ) {
 110     return d < c;
 111 }
 112
 113 inline bool operator<=( const CodeChunk& c, const CodeChunk& d ) {
 114     return !( c > d );
 115 }
 116
 117 inline bool operator>=( const CodeChunk& c, const CodeChunk& d ) {
 118     return !( c < d );
 119 }
 120
 121 QT_END_NAMESPACE
 122
 123 #endif