src/libs/utils/abstractprocess.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 ABSTRACTPROCESS_H
  35 #define ABSTRACTPROCESS_H
  36
  37 #include "utils_global.h"
  38
  39 #include "environment.h"
  40
  41 #include <QtCore/QStringList>
  42
  43 namespace Utils {
  44
  45 class QTCREATOR_UTILS_EXPORT AbstractProcess
  46 {
  47 public:
  48     AbstractProcess() {}
  49     virtual ~AbstractProcess() {}
  50
  51     QString workingDirectory() const { return m_workingDir; }
  52     void setWorkingDirectory(const QString &dir) { m_workingDir = dir; }
  53
  54     void setEnvironment(const Environment &env) { m_environment = env; }
  55     Environment environment() const { return m_environment; }
  56
  57     virtual bool start(const QString &program, const QString &args) = 0;
  58     virtual void stop() = 0;
  59
  60     virtual bool isRunning() const = 0;
  61     virtual qint64 applicationPID() const = 0;
  62     virtual int exitCode() const = 0;
  63
  64 //signals:
  65     virtual void processMessage(const QString &error, bool isError) = 0;
  66
  67 #ifdef Q_OS_WIN
  68     // Add PATH and SystemRoot environment variables in case they are missing
  69     static QStringList fixWinEnvironment(const QStringList &env);
  70     // Quote a Windows command line correctly for the "CreateProcess" API
  71     static QString createWinCommandline(const QString &program, const QStringList &args);
  72     static QString createWinCommandline(const QString &program, const QString &args);
  73     // Create a bytearray suitable to be passed on as environment
  74     // to the "CreateProcess" API (0-terminated UTF 16 strings).
  75     static QByteArray createWinEnvironment(const QStringList &env);
  76 #endif
  77
  78 protected:
  79     QString m_workingDir;
  80     Environment m_environment;
  81 };
  82
  83 } //namespace Utils
  84
  85 #endif // ABSTRACTPROCESS_H
  86