src/shared/cplusplus/TranslationUnit.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 // Copyright (c) 2008 Roberto Raggi <roberto.raggi@gmail.com>
  34 //
  35 // Permission is hereby granted, free of charge, to any person obtaining a copy
  36 // of this software and associated documentation files (the "Software"), to deal
  37 // in the Software without restriction, including without limitation the rights
  38 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  39 // copies of the Software, and to permit persons to whom the Software is
  40 // furnished to do so, subject to the following conditions:
  41 //
  42 // The above copyright notice and this permission notice shall be included in
  43 // all copies or substantial portions of the Software.
  44 //
  45 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  46 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  47 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  48 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  49 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  50 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  51 // THE SOFTWARE.
  52
  53 #ifndef CPLUSPLUS_TRANSLATIONUNIT_H
  54 #define CPLUSPLUS_TRANSLATIONUNIT_H
  55
  56 #include "CPlusPlusForwardDeclarations.h"
  57 #include "ASTfwd.h"
  58 #include "Token.h"
  59 #include "DiagnosticClient.h"
  60 #include <cstdio>
  61 #include <vector>
  62
  63
  64 namespace CPlusPlus {
  65
  66 class CPLUSPLUS_EXPORT TranslationUnit
  67 {
  68     TranslationUnit(const TranslationUnit &other);
  69     void operator =(const TranslationUnit &other);
  70
  71 public:
  72     TranslationUnit(Control *control, const StringLiteral *fileId);
  73     ~TranslationUnit();
  74
  75     Control *control() const;
  76
  77     const StringLiteral *fileId() const;
  78     const char *fileName() const;
  79     unsigned fileNameLength() const;
  80
  81     const char *firstSourceChar() const;
  82     const char *lastSourceChar() const;
  83     unsigned sourceLength() const;
  84
  85     void setSource(const char *source, unsigned size);
  86
  87     unsigned tokenCount() const;
  88     const Token &tokenAt(unsigned index) const;
  89     int tokenKind(unsigned index) const;
  90     const char *spell(unsigned index) const;
  91
  92     unsigned matchingBrace(unsigned index) const;
  93     const Identifier *identifier(unsigned index) const;
  94     const Literal *literal(unsigned index) const;
  95     const StringLiteral *stringLiteral(unsigned index) const;
  96     const NumericLiteral *numericLiteral(unsigned index) const;
  97
  98     MemoryPool *memoryPool() const;
  99     AST *ast() const;
 100
 101     bool blockErrors() const { return f._blockErrors; }
 102     bool blockErrors(bool block);
 103
 104     bool qtMocRunEnabled() const;
 105     void setQtMocRunEnabled(bool onoff);
 106
 107     bool cxx0xEnabled() const;
 108     void setCxxOxEnabled(bool onoff);
 109
 110     bool objCEnabled() const;
 111     void setObjCEnabled(bool onoff);
 112
 113     void warning(unsigned index, const char *fmt, ...);
 114     void error(unsigned index, const char *fmt, ...);
 115     void fatal(unsigned index, const char *fmt, ...);
 116
 117     void message(DiagnosticClient::Level level, unsigned index,
 118                  const char *format, va_list ap);
 119
 120     bool isTokenized() const;
 121     void tokenize();
 122
 123     bool skipFunctionBody() const;
 124     void setSkipFunctionBody(bool skipFunctionBody);
 125
 126     bool isParsed() const;
 127
 128     enum ParseMode {
 129         ParseTranlationUnit,
 130         ParseDeclaration,
 131         ParseExpression,
 132         ParseDeclarator,
 133         ParseStatement
 134     };
 135
 136     bool parse(ParseMode mode = ParseTranlationUnit);
 137
 138     void resetAST();
 139     void release();
 140
 141     void getTokenStartPosition(unsigned index, unsigned *line,
 142                                unsigned *column = 0,
 143                                const StringLiteral **fileName = 0) const;
 144
 145     void getTokenEndPosition(unsigned index, unsigned *line,
 146                              unsigned *column = 0,
 147                              const StringLiteral **fileName = 0) const;
 148
 149     void getPosition(unsigned offset,
 150                      unsigned *line,
 151                      unsigned *column = 0,
 152                      const StringLiteral **fileName = 0) const;
 153
 154     void getTokenPosition(unsigned index,
 155                           unsigned *line,
 156                           unsigned *column = 0,
 157                           const StringLiteral **fileName = 0) const;
 158
 159     void pushLineOffset(unsigned offset);
 160     void pushPreprocessorLine(unsigned offset,
 161                               unsigned line,
 162                               const StringLiteral *fileName);
 163
 164     unsigned findPreviousLineOffset(unsigned tokenIndex) const;
 165
 166 public:
 167     struct PPLine {
 168         unsigned offset;
 169         unsigned line;
 170         const StringLiteral *fileName;
 171
 172         PPLine(unsigned offset = 0,
 173                unsigned line = 0,
 174                const StringLiteral *fileName = 0)
 175             : offset(offset), line(line), fileName(fileName)
 176         { }
 177
 178         bool operator == (const PPLine &other) const
 179         { return offset == other.offset; }
 180
 181         bool operator != (const PPLine &other) const
 182         { return offset != other.offset; }
 183
 184         bool operator < (const PPLine &other) const
 185         { return offset < other.offset; }
 186     };
 187
 188 private:
 189     unsigned findLineNumber(unsigned offset) const;
 190     unsigned findColumnNumber(unsigned offset, unsigned lineNumber) const;
 191     PPLine findPreprocessorLine(unsigned offset) const;
 192     void showErrorLine(unsigned index, unsigned column, FILE *out);
 193
 194     Control *_control;
 195     const StringLiteral *_fileId;
 196     const char *_firstSourceChar;
 197     const char *_lastSourceChar;
 198     std::vector<Token> *_tokens;
 199     std::vector<unsigned> _lineOffsets;
 200     std::vector<PPLine> _ppLines;
 201     MemoryPool *_pool;
 202     AST *_ast;
 203     TranslationUnit *_previousTranslationUnit;
 204     struct Flags {
 205         unsigned _tokenized: 1;
 206         unsigned _parsed: 1;
 207         unsigned _blockErrors: 1;
 208         unsigned _skipFunctionBody: 1;
 209         unsigned _qtMocRunEnabled: 1;
 210         unsigned _cxx0xEnabled: 1;
 211         unsigned _objCEnabled: 1;
 212     };
 213     union {
 214         unsigned _flags;
 215         Flags f;
 216     };
 217 };
 218
 219 } // namespace CPlusPlus
 220
 221
 222 #endif // CPLUSPLUS_TRANSLATIONUNIT_H