blob: 3a08e2713a5da87b3f20f4e7d8dbc788fd129577 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** No Commercial Usage
**
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**************************************************************************/
#ifndef PROCESSPARAMETERS_H
#define PROCESSPARAMETERS_H
#include "projectexplorer_export.h"
#include <utils/environment.h>
namespace Utils {
class AbstractMacroExpander;
}
namespace ProjectExplorer {
/*!
ProcessParameters aggregates all parameters needed to start a process.
It offers a set of functions which expand macros and environment variables
inside the raw parameters to obtain final values for starting a process
or for display purposes.
*/
class PROJECTEXPLORER_EXPORT ProcessParameters
{
public:
ProcessParameters();
/// setCommand() sets the executable to run
void setCommand(const QString &cmd);
QString command() const { return m_command; }
/// sets the command line arguments used by the process
void setArguments(const QString &arguments);
QString arguments() const { return m_arguments; }
/// sets the workingDirectory for the process for a buildConfiguration
/// should be called from init()
void setWorkingDirectory(const QString &workingDirectory);
QString workingDirectory() const { return m_workingDirectory; }
/// Set the Environment for running the command
/// should be called from init()
void setEnvironment(const Utils::Environment &env) { m_environment = env; }
Utils::Environment environment() const { return m_environment; }
/// Set the macro expander to use on the command, arguments and working dir.
/// Note that the caller retains ownership of the object.
void setMacroExpander(Utils::AbstractMacroExpander *mx) { m_macroExpander = mx; }
Utils::AbstractMacroExpander *macroExpander() const { return m_macroExpander; }
/// Get the fully expanded working directory:
QString effectiveWorkingDirectory() const;
/// Get the fully expanded command name to run:
QString effectiveCommand() const;
/// Get the fully expanded arguments to use:
QString effectiveArguments() const;
/// True if effectiveCommand() would return only a fallback
bool commandMissing() const;
QString prettyCommand() const;
QString prettyArguments() const;
QString summary(const QString &displayName) const;
QString summaryInWorkdir(const QString &displayName) const;
private:
QString m_workingDirectory;
QString m_command;
QString m_arguments;
Utils::Environment m_environment;
Utils::AbstractMacroExpander *m_macroExpander;
mutable QString m_effectiveWorkingDirectory;
mutable QString m_effectiveCommand;
mutable QString m_effectiveArguments;
mutable bool m_commandMissing;
};
} // namespace ProjectExplorer
#endif // PROCESSPARAMETERS_H
|
