aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/corelib/tools/shellutils.h
blob: 6f1d82afb91c45208045038bb66a73c244e5c09c (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
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Copyright (C) 2015 Petroules Corporation.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qbs.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QBS_SHELLUTILS_H
#define QBS_SHELLUTILS_H

#include "qbs_export.h"
#include "hostosinfo.h"
#include <QtCore/qstring.h>

#include <vector>

namespace qbs {
namespace Internal {

QBS_EXPORT QString shellInterpreter(const QString &filePath);
QBS_EXPORT std::string shellQuote(const std::string &arg, HostOsInfo::HostOs os = HostOsInfo::hostOs());
QBS_EXPORT QString shellQuote(const QString &arg, HostOsInfo::HostOs os = HostOsInfo::hostOs());
QBS_EXPORT QString shellQuote(const QStringList &args,
                              HostOsInfo::HostOs os = HostOsInfo::hostOs());
QBS_EXPORT std::string shellQuote(const std::vector<std::string> &args,
                                  HostOsInfo::HostOs os = HostOsInfo::hostOs());
QBS_EXPORT QString shellQuote(const QString &program, const QStringList &args,
                              HostOsInfo::HostOs os = HostOsInfo::hostOs());

class QBS_EXPORT CommandLine
{
public:
    void setProgram(const QString &program, bool raw = false);
    void setProgram(const std::string &program, bool raw = false);
    void appendArgument(const QString &value);
    void appendArgument(const std::string &value);
    void appendArguments(const QList<QString> &args);
    void appendRawArgument(const QString &value);
    void appendRawArgument(const std::string &value);
    void appendPathArgument(const QString &value);
    void clearArguments();
    QString toCommandLine(HostOsInfo::HostOs os = HostOsInfo::hostOs()) const;

private:
    struct Argument
    {
        Argument(const QString &value = QString()) : value(value) { }
        QString value;
        bool isFilePath = false;
        bool shouldQuote = true;
    };

    bool m_isRawProgram = false;
    QString m_program;
    std::vector<Argument> m_arguments;
};

} // namespace Internal
} // namespace qbs

#endif // QBS_SHELLUTILS_H