tests/manual/plain-cplusplus/Preprocessor.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  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 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33 #ifndef CPLUSPLUS_PREPROCESSOR_H
  34 #define CPLUSPLUS_PREPROCESSOR_H
  35
  36 #include <CPlusPlusForwardDeclarations.h>
  37 #include <iosfwd>
  38 #include <vector>
  39 #include <map>
  40 #include <cstring>
  41
  42 namespace CPlusPlus {
  43
  44 class Lexer;
  45 class Token;
  46
  47 class CPLUSPLUS_EXPORT StringRef
  48 {
  49     const char *_text;
  50     unsigned _size;
  51
  52 public:
  53     typedef const char *iterator;
  54     typedef const char *const_iterator;
  55
  56     StringRef()
  57         : _text(0), _size(0) {}
  58
  59     StringRef(const char *text, unsigned size)
  60         : _text(text), _size(size) {}
  61
  62     StringRef(const char *text)
  63         : _text(text), _size(std::strlen(text)) {}
  64
  65     inline const char *text() const { return _text; }
  66     inline unsigned size() const { return _size; }
  67
  68     inline const_iterator begin() const { return _text; }
  69     inline const_iterator end() const { return _text + _size; }
  70
  71     bool operator == (const StringRef &other) const
  72     {
  73         if (_size == other._size)
  74             return _text == other._text || ! std::strncmp(_text, other._text, _size);
  75
  76         return false;
  77     }
  78
  79     bool operator != (const StringRef &other) const
  80     { return ! operator == (other); }
  81
  82     bool operator < (const StringRef &other) const
  83     { return std::lexicographical_compare(begin(), end(), other.begin(), other.end()); }
  84 };
  85
  86 class CPLUSPLUS_EXPORT Preprocessor
  87 {
  88 public:
  89     Preprocessor(std::ostream &out);
  90
  91     void operator()(const char *source, unsigned size, const StringRef &currentFileName);
  92
  93 private:
  94     struct Macro
  95     {
  96         Macro(): isFunctionLike(false), isVariadic(false) {}
  97
  98         std::vector<StringRef> formals;
  99         std::vector<Token> body;
 100         bool isFunctionLike: 1;
 101         bool isVariadic: 1;
 102     };
 103
 104     void run(const char *source, unsigned size);
 105
 106     Lexer *switchLexer(Lexer *lex);
 107     StringRef switchSource(const StringRef &source);
 108
 109     const Macro *resolveMacro(const StringRef &name) const;
 110
 111     StringRef asStringRef(const Token &tk) const;
 112     void lex(Token *tk);
 113     bool isValidToken(const Token &tk) const;
 114
 115     void handlePreprocessorDirective(Token *tk);
 116     void handleDefineDirective(Token *tk);
 117     void skipPreprocesorDirective(Token *tk);
 118
 119     void collectActualArguments(Token *tk, std::vector<std::vector<Token> > *actuals);
 120     void scanActualArgument(Token *tk, std::vector<Token> *tokens);
 121
 122 private:
 123     struct TokenBuffer;
 124
 125     std::ostream &out;
 126     StringRef _currentFileName;
 127     Lexer *_lexer;
 128     StringRef _source;
 129     TokenBuffer *_tokenBuffer;
 130     bool inPreprocessorDirective: 1;
 131     std::map<StringRef, Macro> macros;
 132 };
 133
 134 } // end of namespace CPlusPlus
 135
 136 CPLUSPLUS_EXPORT std::ostream &operator << (std::ostream &out, const CPlusPlus::StringRef &s);
 137
 138 #endif // CPLUSPLUS_PREPROCESSOR_H
 139