aboutsummaryrefslogtreecommitdiffstats
path: root/sources/shiboken6/ApiExtractor/optionsparser.cpp
blob: f2e64c7e423c3062ed0e1cf207fc6d8f50eaf35c (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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

#include "optionsparser.h"
#include "messages.h"
#include "exception.h"

#include <QtCore/QDir>
#include <QtCore/QTextStream>

using namespace Qt::StringLiterals;

template <class Stream> void formatBoolOption(Stream &s, const BoolOption &bo)
{
    switch (bo.source) {
    case OptionSource::CommandLine:
        s << "--";
        break;
    case OptionSource::CommandLineSingleDash:
        s << '-';
        break;
    default:
        break;
    }
    s << bo.option;
    if (bo.source == OptionSource::ProjectFile)
        s << " (project)";
}

template <class Stream> void formatOptionValue(Stream &s, const OptionValue &ov)
{
    switch (ov.source) {
    case OptionSource::CommandLine:
        s << "--";
        break;
    case OptionSource::CommandLineSingleDash:
        s << '-';
        break;
    default:
        break;
    }
    s << ov.option << '=' << ov.value;
    if (ov.source == OptionSource::ProjectFile)
        s << " (project)";
}

QTextStream &operator<<(QTextStream &s, const BoolOption &bo)
{
    formatBoolOption(s, bo);
    return s;
}

QTextStream &operator<<(QTextStream &s, const OptionValue &ov)
{
    formatOptionValue(s, ov);
    return s;
}

QDebug operator<<(QDebug debug, const BoolOption &bo)
{
    QDebugStateSaver saver(debug);
    debug.noquote();
    debug.nospace();
    formatBoolOption(debug, bo);
    return debug;
}

QDebug operator<<(QDebug debug, const OptionValue &v)
{
    QDebugStateSaver saver(debug);
    debug.noquote();
    debug.nospace();
    formatOptionValue(debug, v);
    return debug;
}

QDebug operator<<(QDebug debug, const Options &v)
{
    QDebugStateSaver saver(debug);
    debug.noquote();
    debug.nospace();
    debug << "Options(";
    if (!v.boolOptions.isEmpty())
        debug << "bools=" << v.boolOptions;
    if (!v.valueOptions.isEmpty())
        debug << ", option values=" << v.valueOptions;
    if (!v.positionalArguments.isEmpty())
        debug << ", pos=" << v.positionalArguments;
    debug << ')';
    return debug;
}

QTextStream &operator<<(QTextStream &s, const OptionDescription &od)
{
    if (!od.name.startsWith(u'-'))
        s << "--";
    s << od.name;
    if (od.description.isEmpty()) { // For formatting {{"-s", ""}, {"--short", "descr"}}
        s << ", ";
    } else {
        s << '\n';
        const auto lines = QStringView{od.description}.split(u'\n');
        for (const auto &line : lines)
            s << "        " << line << '\n';
        s << '\n';
    }
    return s;
}

QTextStream &operator<<(QTextStream &s, const OptionDescriptions &options)
{
    s.setFieldAlignment(QTextStream::AlignLeft);
    for (const auto &od : options)
        s << od;
    return s;
}

OptionsParser::OptionsParser() noexcept = default;
OptionsParser::~OptionsParser() = default;

const QString &OptionsParser::pathSyntax()
{
    static const QString result =
        u"<path>["_s + QDir::listSeparator() + u"<path>"_s
        + QDir::listSeparator() + u"...]"_s;
    return result;
}

bool OptionsParser::handleBoolOption(const QString &, OptionSource)
{
    return false;
}

bool OptionsParser::handleOption(const QString &, const QString &, OptionSource)
{
    return false;
}

void OptionsParser::process(Options *o)
{
    for (auto i = o->boolOptions.size() - 1; i >= 0; --i) {
        const auto &opt = o->boolOptions.at(i);
        if (handleBoolOption(opt.option, opt.source))
            o->boolOptions.removeAt(i);
    }
    for (auto i = o->valueOptions.size() - 1; i >= 0; --i) {
        const auto &opt = o->valueOptions.at(i);
        if (handleOption(opt.option, opt.value, opt.source))
            o->valueOptions.removeAt(i);
    }
}

bool OptionsParserList::handleBoolOption(const QString &key, OptionSource source)
{
    for (const auto &p : std::as_const(m_parsers)) {
        if (p->handleBoolOption(key, source))
            return true;
    }
    return false;
}

bool OptionsParserList::handleOption(const QString &key, const QString &value, OptionSource source)
{
    for (const auto &p : std::as_const(m_parsers)) {
        if (p->handleOption(key, value, source))
            return true;
    }
    return false;
}

static void processOption(const QString &o, OptionSource source,
                          BoolOptions *bools, OptionValues *values)
{
    const auto equals = o.indexOf(u'=');
    if (equals == -1) {
        bools->append({o.trimmed(), source});
    } else {
        QString key = o.left(equals).trimmed();
        QString value = o.mid(equals + 1).trimmed();
        if (!value.isEmpty())
            values->append({key, value, source});
    }
}

static void readProjectFile(const QString &name, Options *o)
{
    const auto startMarker = "[generator-project]"_ba;

    QFile file(name);
    if (!file.open(QIODevice::ReadOnly | QIODevice::Text))
        throw Exception(msgCannotOpenForReading(file));

    if (file.atEnd() || file.readLine().trimmed() != startMarker)
        throw Exception(msgMissingProjectFileMarker(name, startMarker));

    while (!file.atEnd()) {
        const QByteArray lineB = file.readLine().trimmed();
        if (!lineB.isEmpty() && !lineB.startsWith('#')) {
            processOption(QString::fromUtf8(lineB), OptionSource::ProjectFile,
                          &o->boolOptions, &o->valueOptions);
        }
    }
}

void Options::setOptions(const QStringList &argv)
{
    const auto projectFileOption = "--project-file="_L1;
    for (const auto &o : argv) {
        if (o.startsWith(projectFileOption)) {
            readProjectFile(o.sliced(projectFileOption.size()), this);
        } else if (o.startsWith(u"--")) {
            processOption(o.sliced(2), OptionSource::CommandLine,
                          &boolOptions, &valueOptions);
        } else if (o.startsWith(u'-')) {
            processOption(o.sliced(1), OptionSource::CommandLineSingleDash,
                          &boolOptions, &valueOptions);
        } else {
            positionalArguments.append(o);
        }
    }
}

QString Options::msgUnprocessedOptions() const
{
    QString result;
    QTextStream str(&result);
    for (const auto &b : boolOptions)
        str << b << ' ';
    for (const auto &v : valueOptions)
        str << v << ' ';
    return result.trimmed();
}