src/plugins/coreplugin/variablemanager.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 (info@qt.nokia.com)
   8 **
   9 **
  10 ** GNU Lesser General Public License Usage
  11 **
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this file.
  15 ** Please review the following information to ensure the GNU Lesser General
  16 ** Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** Other Usage
  24 **
  25 ** Alternatively, this file may be used in accordance with the terms and
  26 ** conditions contained in a signed written agreement between you and Nokia.
  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 #ifndef VARIABLEMANAGER_H
  34 #define VARIABLEMANAGER_H
  35
  36 #include "core_global.h"
  37
  38 #include <QtCore/QObject>
  39 #include <QtCore/QScopedPointer>
  40 #include <QtCore/QString>
  41
  42 QT_BEGIN_NAMESPACE
  43 class QFileInfo;
  44 QT_END_NAMESPACE
  45
  46 namespace Utils {
  47 class AbstractMacroExpander;
  48 }
  49
  50 namespace Core {
  51 class VariableManagerPrivate;
  52
  53 class CORE_EXPORT VariableManager : public QObject
  54 {
  55     Q_OBJECT
  56     Q_DISABLE_COPY(VariableManager)
  57 public:
  58     VariableManager();
  59     ~VariableManager();
  60
  61     static VariableManager* instance();
  62
  63     void insert(const QString &variable, const QString &value);
  64     bool remove(const QString &variable);
  65     QString value(const QString &variable, bool *found = 0);
  66     QString value(const QString &variable, const QString &defaultValue);
  67     Utils::AbstractMacroExpander *macroExpander();
  68
  69     void registerVariable(const QString &variable,
  70                           const QString &description);
  71     QList<QString> variables() const;
  72     QString variableDescription(const QString &variable) const;
  73
  74 signals:
  75     void variableUpdateRequested(const QString &variable);
  76
  77 private:
  78     QScopedPointer<VariableManagerPrivate> d;
  79 };
  80
  81 } // namespace Core
  82
  83 #endif // VARIABLEMANAGER_H