src/libs/cplusplus/PreprocessorClient.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
  34 #ifndef CPLUSPLUS_PP_CLIENT_H
  35 #define CPLUSPLUS_PP_CLIENT_H
  36
  37 #include <CPlusPlusForwardDeclarations.h>
  38 #include <QVector>
  39
  40 QT_BEGIN_NAMESPACE
  41 class QByteArray;
  42 class QString;
  43 QT_END_NAMESPACE
  44
  45 namespace CPlusPlus {
  46
  47 class Macro;
  48
  49 class CPLUSPLUS_EXPORT MacroArgumentReference
  50 {
  51   unsigned _position;
  52   unsigned _length;
  53
  54 public:
  55   explicit MacroArgumentReference(unsigned position = 0, unsigned length = 0)
  56     : _position(position), _length(length)
  57   { }
  58
  59   unsigned position() const
  60   { return _position; }
  61
  62   unsigned length() const
  63   { return _length; }
  64 };
  65
  66 class CPLUSPLUS_EXPORT Client
  67 {
  68   Client(const Client &other);
  69   void operator=(const Client &other);
  70
  71 public:
  72   enum IncludeType {
  73     IncludeLocal,
  74     IncludeGlobal
  75   };
  76
  77 public:
  78   Client();
  79   virtual ~Client();
  80
  81   virtual void macroAdded(const Macro &macro) = 0;
  82
  83   virtual void passedMacroDefinitionCheck(unsigned offset, const Macro &macro) = 0;
  84   virtual void failedMacroDefinitionCheck(unsigned offset, const QByteArray &name) = 0;
  85
  86   virtual void startExpandingMacro(unsigned offset,
  87                                    const Macro &macro,
  88                                    const QByteArray &originalText,
  89                                    bool inCondition = false,
  90                                    const QVector<MacroArgumentReference> &actuals
  91                                             = QVector<MacroArgumentReference>()) = 0;
  92
  93   virtual void stopExpandingMacro(unsigned offset,
  94                                   const Macro &macro) = 0;
  95
  96   virtual void startSkippingBlocks(unsigned offset) = 0;
  97   virtual void stopSkippingBlocks(unsigned offset) = 0;
  98
  99   virtual void sourceNeeded(QString &fileName, IncludeType mode,
 100                             unsigned line) = 0; // ### FIX the signature.
 101 };
 102
 103 } // namespace CPlusPlus
 104
 105 #endif // CPLUSPLUS_PP_CLIENT_H