src/libs/utils/environment.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 UTILS_ENVIRONMENT_H
  34 #define UTILS_ENVIRONMENT_H
  35
  36 #include "utils_global.h"
  37
  38 #include <QtCore/QString>
  39 #include <QtCore/QStringList>
  40 #include <QtCore/QMap>
  41 #include <QtCore/QList>
  42
  43 namespace Utils {
  44
  45 class QTCREATOR_UTILS_EXPORT EnvironmentItem
  46 {
  47 public:
  48     EnvironmentItem(QString n, QString v)
  49             : name(n), value(v), unset(false)
  50     {}
  51
  52     QString name;
  53     QString value;
  54     bool unset;
  55
  56     bool operator==(const EnvironmentItem &other) const
  57     {
  58         return (unset == other.unset) && (name == other.name) && (value == other.value);
  59     }
  60
  61     static QList<EnvironmentItem> fromStringList(QStringList list);
  62     static QStringList toStringList(QList<EnvironmentItem> list);
  63 };
  64
  65 class QTCREATOR_UTILS_EXPORT Environment {
  66 public:
  67     typedef QMap<QString, QString>::const_iterator const_iterator;
  68
  69     Environment();
  70     explicit Environment(QStringList env);
  71     static Environment systemEnvironment();
  72
  73     QStringList toStringList() const;
  74     QString value(const QString &key) const;
  75     void set(const QString &key, const QString &value);
  76     void unset(const QString &key);
  77     void modify(const QList<EnvironmentItem> & list);
  78     /// Return the Environment changes necessary to modify this into the other environment.
  79     QList<EnvironmentItem> diff(const Environment &other) const;
  80     bool hasKey(const QString &key);
  81
  82     void appendOrSet(const QString &key, const QString &value, const QString &sep = QString());
  83     void prependOrSet(const QString &key, const QString &value, const QString &sep = QString());
  84
  85     void appendOrSetPath(const QString &value);
  86     void prependOrSetPath(const QString &value);
  87
  88     void clear();
  89     int size() const;
  90
  91     QString key(Environment::const_iterator it) const;
  92     QString value(Environment::const_iterator it) const;
  93
  94     Environment::const_iterator constBegin() const;
  95     Environment::const_iterator constEnd() const;
  96     Environment::const_iterator constFind(const QString &name) const;
  97
  98     QString searchInPath(const QString &executable,
  99                          const QStringList & additionalDirs = QStringList()) const;
 100     QStringList path() const;
 101
 102     QString expandVariables(const QString &) const;
 103     QStringList expandVariables(const QStringList &) const;
 104
 105     bool operator!=(const Environment &other) const;
 106     bool operator==(const Environment &other) const;
 107 private:
 108     QString searchInPath(const QStringList &executables,
 109                          const QStringList & additionalDirs = QStringList()) const;
 110     QMap<QString, QString> m_values;
 111 };
 112
 113 } // namespace Utils
 114
 115 #endif // UTILS_ENVIRONMENT_H