Coverage Report

Created: 2025-08-25 06:58

/src/WasmEdge/lib/po/argument_parser.cpp
Line
Count
Source (jump to first uncovered line)
1
// SPDX-License-Identifier: Apache-2.0
2
// SPDX-FileCopyrightText: 2019-2024 Second State INC
3
4
#include "po/argument_parser.h"
5
#include "common/defines.h"
6
#include "common/spdlog.h"
7
#include "system/winapi.h"
8
#include <cstdio>
9
10
namespace WasmEdge {
11
namespace PO {
12
13
cxx20::expected<bool, Error> ArgumentParser::SubCommandDescriptor::parse(
14
    std::FILE *Out, Span<const char *> ProgramNamePrefix, int Argc,
15
1.95k
    const char *Argv[], int ArgP, const bool &VersionOpt) noexcept {
16
1.95k
  ProgramNames.reserve(ProgramNamePrefix.size() + 1);
17
1.95k
  ProgramNames.assign(ProgramNamePrefix.begin(), ProgramNamePrefix.end());
18
1.95k
  if (ArgP < Argc) {
19
1.95k
    ProgramNames.push_back(Argv[ArgP]);
20
1.95k
  }
21
1.95k
  ArgumentDescriptor *CurrentDesc = nullptr;
22
1.95k
  bool FirstNonOption = true;
23
1.95k
  bool Escaped = false;
24
1.95k
  auto PositionalIter = PositionalList.cbegin();
25
2.80M
  for (int ArgI = ArgP + 1; ArgI < Argc; ++ArgI) {
26
2.80M
    std::string_view Arg = Argv[ArgI];
27
2.80M
    if (!Escaped && Arg.size() >= 2 && Arg[0] == '-') {
28
232k
      if (Arg[1] == '-') {
29
229k
        if (Arg.size() == 2) {
30
97
          Escaped = true;
31
229k
        } else {
32
          // long option
33
229k
          if (CurrentDesc && CurrentDesc->nargs() == 0) {
34
2.21k
            CurrentDesc->default_value();
35
2.21k
          }
36
229k
          if (auto Res = consume_long_option_with_argument(Arg); !Res) {
37
339
            return cxx20::unexpected(Res.error());
38
229k
          } else {
39
229k
            CurrentDesc = *Res;
40
229k
          }
41
229k
        }
42
229k
      } else {
43
        // short options
44
2.69k
        if (CurrentDesc && CurrentDesc->nargs() == 0) {
45
294
          CurrentDesc->default_value();
46
294
        }
47
2.69k
        if (auto Res = consume_short_options(Arg); !Res) {
48
34
          return cxx20::unexpected(Res.error());
49
2.66k
        } else {
50
2.66k
          CurrentDesc = *Res;
51
2.66k
        }
52
2.69k
      }
53
2.57M
    } else if (!Escaped && CurrentDesc) {
54
2.43k
      consume_argument(*CurrentDesc, Arg);
55
2.43k
      CurrentDesc = nullptr;
56
2.56M
    } else {
57
      // no more options
58
2.56M
      if (FirstNonOption) {
59
798
        FirstNonOption = false;
60
798
        if (!SubCommandMap.empty()) {
61
0
          if (auto Iter = SubCommandMap.find(Arg);
62
0
              Iter != SubCommandMap.end()) {
63
0
            auto &Child = this[Iter->second];
64
0
            Child.SC->select();
65
0
            return Child.parse(Out, ProgramNames, Argc, Argv, ArgI, VersionOpt);
66
0
          }
67
0
        }
68
798
      }
69
2.56M
      Escaped = true;
70
2.56M
      if (CurrentDesc) {
71
2.56M
        if (auto Res = consume_argument(*CurrentDesc, Arg); !Res) {
72
2
          return cxx20::unexpected(Res.error());
73
2.56M
        } else {
74
2.56M
          CurrentDesc = *Res;
75
2.56M
        }
76
2.56M
      } else {
77
1.18k
        if (PositionalIter == PositionalList.cend()) {
78
0
          return cxx20::unexpected<Error>(
79
0
              std::in_place, ErrCode::InvalidArgument,
80
0
              "positional argument exceeds maximum consuming."s);
81
0
        }
82
1.18k
        if (auto Res =
83
1.18k
                consume_argument(ArgumentDescriptors[*PositionalIter], Arg);
84
1.18k
            !Res) {
85
0
          return cxx20::unexpected(Res.error());
86
1.18k
        } else {
87
1.18k
          CurrentDesc = *Res;
88
1.18k
        }
89
1.18k
        ++PositionalIter;
90
1.18k
      }
91
2.56M
    }
92
2.80M
  }
93
1.58k
  if (CurrentDesc && CurrentDesc->nargs() == 0) {
94
32
    CurrentDesc->default_value();
95
32
  }
96
97
1.58k
  if (VersionOpt) {
98
330
    return true;
99
330
  }
100
1.25k
  if (!HelpOpt->value()) {
101
19.7k
    for (const auto &Desc : ArgumentDescriptors) {
102
19.7k
      if (Desc.nargs() < Desc.min_nargs()) {
103
505
        help(Out);
104
505
        return false;
105
505
      }
106
19.7k
    }
107
1.17k
  } else {
108
71
    help(Out);
109
71
    return true;
110
71
  }
111
674
  return true;
112
1.25k
}
113
114
void ArgumentParser::SubCommandDescriptor::usage(
115
576
    std::FILE *Out) const noexcept {
116
576
  fmt::print(Out, "{}USAGE{}\n"sv, YELLOW_COLOR, RESET_COLOR);
117
576
  for (const char *Part : ProgramNames) {
118
576
    fmt::print(Out, "\t{}"sv, Part);
119
576
  }
120
576
  if (!SubCommandList.empty()) {
121
0
    fmt::print(Out, " [SUBCOMMANDS]"sv);
122
0
  }
123
576
  if (!NonpositionalList.empty()) {
124
576
    fmt::print(Out, " [OPTIONS]"sv);
125
576
  }
126
576
  bool First = true;
127
1.15k
  for (const auto &Index : PositionalList) {
128
1.15k
    const auto &Desc = ArgumentDescriptors[Index];
129
1.15k
    if (Desc.hidden()) {
130
0
      continue;
131
0
    }
132
133
1.15k
    if (First) {
134
576
      fmt::print(Out, " [--]"sv);
135
576
      First = false;
136
576
    }
137
138
1.15k
    const bool Optional = (Desc.min_nargs() == 0);
139
1.15k
    fmt::print(Out, " "sv);
140
1.15k
    if (Optional) {
141
576
      fmt::print(Out, "["sv);
142
576
    }
143
1.15k
    switch (ArgumentDescriptors[Index].max_nargs()) {
144
0
    case 0:
145
0
      break;
146
576
    case 1:
147
576
      fmt::print(Out, "{}"sv, Desc.meta());
148
576
      break;
149
576
    default:
150
576
      fmt::print(Out, "{} ..."sv, Desc.meta());
151
576
      break;
152
1.15k
    }
153
1.15k
    if (Optional) {
154
576
      fmt::print(Out, "]"sv);
155
576
    }
156
1.15k
  }
157
576
  fmt::print(Out, "\n"sv);
158
576
}
159
160
576
void ArgumentParser::SubCommandDescriptor::help(std::FILE *Out) const noexcept {
161
// For enabling Windows PowerShell color support.
162
#if WASMEDGE_OS_WINDOWS && WINAPI_PARTITION_DESKTOP
163
  winapi::HANDLE_ OutputHandler =
164
      winapi::GetStdHandle(winapi::STD_OUTPUT_HANDLE_);
165
  if (OutputHandler != winapi::INVALID_HANDLE_VALUE_) {
166
    winapi::DWORD_ ConsoleMode = 0;
167
    if (winapi::GetConsoleMode(OutputHandler, &ConsoleMode)) {
168
      ConsoleMode |= winapi::ENABLE_VIRTUAL_TERMINAL_PROCESSING_;
169
      winapi::SetConsoleMode(OutputHandler, ConsoleMode);
170
    }
171
  }
172
#endif
173
174
576
  usage(Out);
175
576
  const constexpr std::string_view kIndent = "\t"sv;
176
177
576
  fmt::print(Out, "\n"sv);
178
576
  if (!SubCommandList.empty()) {
179
0
    fmt::print(Out, "{}SUBCOMMANDS{}\n"sv, YELLOW_COLOR, RESET_COLOR);
180
0
    for (const auto Offset : SubCommandList) {
181
0
      fmt::print(Out, "{}{}"sv, kIndent, GREEN_COLOR);
182
0
      bool First = true;
183
0
      for (const auto &Name : this[Offset].SubCommandNames) {
184
0
        if (!First) {
185
0
          fmt::print(Out, "|"sv);
186
0
        }
187
0
        fmt::print(Out, "{}"sv, Name);
188
0
        First = false;
189
0
      }
190
0
      fmt::print(Out, "{}\n"sv, RESET_COLOR);
191
0
      indent_output(Out, kIndent, 2, 80, this[Offset].SC->description());
192
0
      fmt::print(Out, "\n"sv);
193
0
    }
194
0
    fmt::print(Out, "\n"sv);
195
0
  }
196
197
576
  fmt::print(Out, "{}OPTIONS{}\n"sv, YELLOW_COLOR, RESET_COLOR);
198
14.4k
  for (const auto &Index : NonpositionalList) {
199
14.4k
    const auto &Desc = ArgumentDescriptors[Index];
200
14.4k
    if (Desc.hidden()) {
201
0
      continue;
202
0
    }
203
204
14.4k
    fmt::print(Out, "{}{}\n"sv, kIndent, GREEN_COLOR);
205
14.4k
    bool First = true;
206
15.5k
    for (const auto &Option : Desc.options()) {
207
15.5k
      if (!First) {
208
1.15k
        fmt::print(Out, "|"sv);
209
1.15k
      }
210
15.5k
      if (Option.size() == 1) {
211
1.15k
        fmt::print(Out, "-{}"sv, Option);
212
14.4k
      } else {
213
14.4k
        fmt::print(Out, "--{}"sv, Option);
214
14.4k
      }
215
15.5k
      First = false;
216
15.5k
    }
217
14.4k
    fmt::print(Out, "{}\n"sv, RESET_COLOR);
218
14.4k
    indent_output(Out, kIndent, 2, 80, Desc.description());
219
14.4k
    fmt::print(Out, "\n"sv);
220
14.4k
  }
221
576
}
222
223
void ArgumentParser::SubCommandDescriptor::indent_output(
224
    std::FILE *Out, const std::string_view kIndent, std::size_t IndentCount,
225
14.4k
    std::size_t ScreenWidth, std::string_view Desc) const noexcept {
226
14.4k
  const std::size_t Width = ScreenWidth - kIndent.size() * IndentCount;
227
17.8k
  while (Desc.size() > Width) {
228
3.45k
    const std::size_t SpacePos = Desc.find_last_of(' ', Width);
229
3.45k
    if (SpacePos != std::string_view::npos) {
230
10.3k
      for (std::size_t I = 0; I < IndentCount; ++I) {
231
6.91k
        fmt::print(Out, "{}"sv, kIndent);
232
6.91k
      }
233
3.45k
      fmt::print(Out, "{}\n"sv, Desc.substr(0, SpacePos));
234
3.45k
      const std::size_t WordPos = Desc.find_first_not_of(' ', SpacePos);
235
3.45k
      if (WordPos != std::string_view::npos) {
236
3.45k
        Desc = Desc.substr(WordPos);
237
3.45k
      } else {
238
0
        Desc = {};
239
0
      }
240
3.45k
    }
241
3.45k
  }
242
14.4k
  if (!Desc.empty()) {
243
43.2k
    for (std::size_t I = 0; I < IndentCount; ++I) {
244
28.8k
      fmt::print(Out, "{}"sv, kIndent);
245
28.8k
    }
246
14.4k
    fmt::print(Out, "{}"sv, Desc);
247
14.4k
  }
248
14.4k
}
249
250
cxx20::expected<ArgumentParser::ArgumentDescriptor *, Error>
251
ArgumentParser::SubCommandDescriptor::consume_short_options(
252
2.69k
    std::string_view Arg) noexcept {
253
2.69k
  ArgumentDescriptor *CurrentDesc = nullptr;
254
187k
  for (std::size_t I = 1; I < Arg.size(); ++I) {
255
185k
    if (CurrentDesc && CurrentDesc->nargs() == 0) {
256
0
      CurrentDesc->default_value();
257
0
    }
258
185k
    std::string_view Option = Arg.substr(I, 1);
259
185k
    if (auto Res = consume_short_option(Option); !Res) {
260
34
      return cxx20::unexpected(Res.error());
261
185k
    } else {
262
185k
      CurrentDesc = *Res;
263
185k
    }
264
185k
  }
265
2.66k
  return CurrentDesc;
266
2.69k
}
267
268
cxx20::expected<ArgumentParser::ArgumentDescriptor *, Error>
269
ArgumentParser::SubCommandDescriptor::consume_long_option_with_argument(
270
229k
    std::string_view Arg) noexcept {
271
229k
  if (auto Pos = Arg.find('=', 2); Pos != std::string_view::npos) {
272
    // long option with argument
273
218k
    std::string_view Option = Arg.substr(2, Pos - 2);
274
218k
    std::string_view Argument = Arg.substr(Pos + 1);
275
218k
    if (auto Res = consume_long_option(Option); !Res) {
276
57
      return cxx20::unexpected<Error>(Res.error());
277
218k
    } else if (ArgumentDescriptor *CurrentDesc = *Res; !CurrentDesc) {
278
13
      return cxx20::unexpected<Error>(std::in_place, ErrCode::InvalidArgument,
279
13
                                      "option "s + std::string(Option) +
280
13
                                          "doesn't need arguments."s);
281
218k
    } else {
282
218k
      consume_argument(*CurrentDesc, Argument);
283
218k
      return nullptr;
284
218k
    }
285
218k
  } else {
286
    // long option without argument
287
10.9k
    std::string_view Option = Arg.substr(2);
288
10.9k
    return consume_long_option(Option);
289
10.9k
  }
290
229k
}
291
292
cxx20::expected<ArgumentParser::ArgumentDescriptor *, Error>
293
ArgumentParser::SubCommandDescriptor::consume_short_option(
294
185k
    std::string_view Option) noexcept {
295
185k
  auto Iter = ArgumentMap.find(Option);
296
185k
  if (Iter == ArgumentMap.end()) {
297
34
    return cxx20::unexpected<Error>(std::in_place, ErrCode::InvalidArgument,
298
34
                                    "unknown option: "s + std::string(Option));
299
34
  }
300
185k
  ArgumentDescriptor &CurrentDesc = ArgumentDescriptors[Iter->second];
301
185k
  if (CurrentDesc.max_nargs() == 0) {
302
185k
    CurrentDesc.default_value();
303
185k
    return nullptr;
304
185k
  }
305
0
  return &CurrentDesc;
306
185k
}
307
308
cxx20::expected<ArgumentParser::ArgumentDescriptor *, Error>
309
ArgumentParser::SubCommandDescriptor::consume_long_option(
310
229k
    std::string_view Option) noexcept {
311
229k
  auto Iter = ArgumentMap.find(Option);
312
229k
  if (Iter == ArgumentMap.end()) {
313
326
    return cxx20::unexpected<Error>(std::in_place, ErrCode::InvalidArgument,
314
326
                                    "unknown option: "s + std::string(Option));
315
326
  }
316
229k
  ArgumentDescriptor &CurrentDesc = ArgumentDescriptors[Iter->second];
317
229k
  if (CurrentDesc.max_nargs() == 0) {
318
2.07k
    CurrentDesc.default_value();
319
2.07k
    return nullptr;
320
2.07k
  }
321
227k
  return &CurrentDesc;
322
229k
}
323
324
cxx20::expected<ArgumentParser::ArgumentDescriptor *, Error>
325
ArgumentParser::SubCommandDescriptor::consume_argument(
326
2.78M
    ArgumentDescriptor &CurrentDesc, std::string_view Argument) noexcept {
327
2.78M
  if (auto Res = CurrentDesc.argument(std::string(Argument)); !Res) {
328
3.21k
    return cxx20::unexpected(Res.error());
329
3.21k
  }
330
2.78M
  if (++CurrentDesc.nargs() >= CurrentDesc.max_nargs()) {
331
67.6k
    return nullptr;
332
67.6k
  }
333
2.71M
  return &CurrentDesc;
334
2.78M
}
335
336
bool ArgumentParser::parse(std::FILE *Out, int Argc,
337
1.95k
                           const char *Argv[]) noexcept {
338
1.95k
  if (auto Res = SubCommandDescriptors.front().parse(Out, {}, Argc, Argv, 0,
339
1.95k
                                                     VerOpt.value());
340
1.95k
      !Res) {
341
375
    fmt::print(Out, "{}\n"sv, Res.error().message());
342
375
    return false;
343
1.58k
  } else {
344
1.58k
    return *Res || VerOpt.value();
345
1.58k
  }
346
1.95k
}
347
348
} // namespace PO
349
} // namespace WasmEdge