interfaces/irun.h

   1 /* This file is part of KDevelop
   2 Copyright 2007 Hamish Rodda <rodda@kde.org>
   3
   4 This library is free software; you can redistribute it and/or
   5 modify it under the terms of the GNU Library General Public
   6 License as published by the Free Software Foundation; either
   7 version 2 of the License, or (at your option) any later version.
   8
   9 This library is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 Library General Public License for more details.
  13
  14 You should have received a copy of the GNU Library General Public License
  15 along with this library; see the file COPYING.LIB.  If not, write to
  16 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17 Boston, MA 02110-1301, USA.
  18 */
  19
  20 #ifndef IRUN_H
  21 #define IRUN_H
  22
  23 #include <QtCore/QObject>
  24 #include <QtCore/QSharedDataPointer>
  25
  26 #include <KUrl>
  27
  28 #include "interfacesexport.h"
  29
  30 namespace KDevelop
  31 {
  32 class ProjectBaseItem;
  33
  34 /**
  35  * This class holds all properties which specify a run session.
  36  */
  37 class KDEVPLATFORMINTERFACES_EXPORT IRun
  38 {
  39 public:
  40     IRun();
  41     IRun(const IRun& rhs);
  42     IRun& operator=(const IRun& rhs);
  43     virtual ~IRun();
  44
  45     /**
  46      * The executable for this session.
  47      */
  48     KUrl executable() const;
  49
  50     /**
  51      * Set the \a executable to be run.
  52      */
  53     void setExecutable(const QString& executable);
  54
  55     /**
  56      * The working directory for this session.
  57      */
  58     KUrl workingDirectory() const;
  59
  60     /**
  61      * Set the \a workingDirectory for this run session.
  62      */
  63     void setWorkingDirectory(const QString& workingDirectory);
  64
  65     /**
  66      * The key which references the environment under which to run the executable.
  67      */
  68     QString environmentKey() const;
  69
  70     /**
  71      * Set the environment under which the executable should be run.
  72      */
  73     void setEnvironmentKey(const QString& environmentKey);
  74
  75     /**
  76      * The argument list to pass to the executable.
  77      */
  78     QStringList arguments() const;
  79
  80     /**
  81      * Add an argument to pass to the executable.
  82      */
  83     void addArgument(const QString& argument);
  84
  85     /**
  86      * Set the arguments which should be passed to the executable.
  87      */
  88     void setArguments(const QStringList& arguments);
  89
  90     /**
  91      * Clear all arguments.
  92      */
  93     void clearArguments();
  94
  95     /**
  96      * The requested instrumentor, usually one of 'default', 'gdb', 'memcheck' etc.
  97      */
  98     QString instrumentor() const;
  99
 100     /**
 101      * Set which instrumentor should be used to run the executable.
 102      */
 103     void setInstrumentor(const QString& instrumentor);
 104
 105     /**
 106      * The argument list to pass to the executable.
 107      */
 108     QStringList instrumentorArguments() const;
 109
 110     /**
 111      * Add an argument to pass to the executable.
 112      */
 113     void addInstrumentorArgument(const QString& argument);
 114
 115     /**
 116      * Set the arguments which should be passed to the executable.
 117      */
 118     void setInstrumentorArguments(const QStringList& arguments);
 119
 120     /**
 121      * Clear all arguments.
 122      */
 123     void clearInstrumentorArguments();
 124
 125     /**
 126      * Set the project items that should be compiled before executing
 127      */
 128     void setCompilationDependencies(const QList<ProjectBaseItem*>& c);
 129
 130     /**
 131      * Clear all compilation dependencies.
 132      */
 133     void clearCompilationDependencies();
 134
 135     /**
 136      * The requested compilation dependencies
 137      */
 138     QList<ProjectBaseItem*> compilationDependencies() const;
 139
 140
 141 private:
 142     class IRunPrivate;
 143     QSharedDataPointer<IRunPrivate> d;
 144 };
 145
 146 }
 147
 148 #endif