Coverage Report

Created: 2026-08-14 06:41

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