aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/buildgraph/command.h
blob: 9e35319a6edb68c6719f4ed46b5e1a1d3234ddc8 (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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Build Suite.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** 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, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#ifndef COMMAND_H
#define COMMAND_H

#include <tools/codelocation.h>

#include <QStringList>
#include <QVariantMap>
#include <QScriptValue>

namespace qbs {
namespace Internal {

class AbstractCommand
{
public:
    virtual ~AbstractCommand();

    enum CommandType {
        ProcessCommandType,
        JavaScriptCommandType
    };

    static AbstractCommand *createByType(CommandType commandType);
    static QString defaultDescription() { return QString(); }
    static QString defaultHighLight() { return QString(); }
    static bool defaultIsSilent() { return true; }

    virtual CommandType type() const = 0;
    virtual void fillFromScriptValue(const QScriptValue *scriptValue, const CodeLocation &codeLocation);
    virtual void load(QDataStream &s);
    virtual void store(QDataStream &s);

    const QString description() const { return m_description; }
    void setDescription(const QString &str) { m_description = str; }

    const QString highlight() const { return m_highlight; }
    void setHighlight(const QString &str) { m_highlight = str; }

    bool isSilent() const { return m_silent; }
    void setSilent(bool b) { m_silent = b; }

protected:
    AbstractCommand();

private:
    QString m_description;
    QString m_highlight;
    bool m_silent;
};

class ProcessCommand : public AbstractCommand
{
public:
    static void setupForJavaScript(QScriptValue targetObject);

    ProcessCommand();

    CommandType type() const { return ProcessCommandType; }
    void fillFromScriptValue(const QScriptValue *scriptValue, const CodeLocation &codeLocation);
    void load(QDataStream &s);
    void store(QDataStream &s);

    const QString program() const { return m_program; }
    void setProgram(const QString &str) { m_program = str; }

    const QStringList arguments() const { return m_arguments; }
    void setArguments(const QStringList &l) { m_arguments = l; }

    const QString workingDir() const { return m_workingDir; }
    void setWorkingDir(const QString &str) { m_workingDir = str; }

    int maxExitCode() const { return m_maxExitCode; }
    void setMaxExitCode(int n) { m_maxExitCode = n; }

    QString stdoutFilterFunction() const { return m_stdoutFilterFunction; }
    void setStdoutFilterFunction(const QString &filter) { m_stdoutFilterFunction = filter; }

    QString stderrFilterFunction() const { return m_stderrFilterFunction; }
    void setStderrFilterFunction(const QString &filter) { m_stderrFilterFunction = filter; }

    int responseFileThreshold() const { return m_responseFileThreshold; }
    void setResponseFileThreshold(int n) { m_responseFileThreshold = n; }

    QString responseFileUsagePrefix() const { return m_responseFileUsagePrefix; }
    void setResponseFileUsagePrefix(const QString &function) { m_responseFileUsagePrefix = function; }

private:
    QString m_program;
    QStringList m_arguments;
    QString m_workingDir;
    int m_maxExitCode;
    QString m_stdoutFilterFunction;
    QString m_stderrFilterFunction;
    int m_responseFileThreshold; // When to use response files? In bytes of (program name + arguments).
    QString m_responseFileUsagePrefix;
};

class JavaScriptCommand : public AbstractCommand
{
public:
    static void setupForJavaScript(QScriptValue targetObject);

    JavaScriptCommand();

    virtual CommandType type() const { return JavaScriptCommandType; }
    void fillFromScriptValue(const QScriptValue *scriptValue, const CodeLocation &codeLocation);
    void load(QDataStream &s);
    void store(QDataStream &s);

    const QString &sourceCode() const { return m_sourceCode; }
    void setSourceCode(const QString &str) { m_sourceCode = str; }
    const CodeLocation &codeLocation() const { return m_codeLocation; }
    void setCodeLocation(const CodeLocation &loc) { m_codeLocation = loc; }
    const QVariantMap &properties() const { return m_properties; }

private:
    QString m_sourceCode;
    QVariantMap m_properties;
    CodeLocation m_codeLocation;
};

} // namespace Internal
} // namespace qbs

#endif // COMMAND_H