FireSTARR
Loading...
Searching...
No Matches
ArgumentParser.h
1/* SPDX-License-Identifier: AGPL-3.0-or-later */
2#ifndef FS_ARGUMENT_PARSER_H
3#define FS_ARGUMENT_PARSER_H
4#include "stdafx.h"
5#include "Settings.h"
6namespace fs::settings
7{
8struct Usage
9{
10 string description{};
11 string positional_arg_summary{};
12};
13enum class PositionalArgumentsRequired
14{
15 Required,
16 NotRequired
17};
19{
20private:
21 vector<string> positional_args_{};
22 size_t cur_positional_{0};
23 PositionalArgumentsRequired require_positional_{};
24 bool help_requested_{false};
25
26public:
27 virtual ~ArgumentParser() = default;
29 const vector<Usage> usages,
30 const vector<string> arguments,
31 const PositionalArgumentsRequired require_positional
32 );
34 const vector<Usage> usages,
35 const vector<string> arguments,
36 const string binary_directory,
37 const string binary_name,
38 const PositionalArgumentsRequired require_positional
39 );
41 const Usage usage,
42 const int argc,
43 const char* const argv[],
44 const PositionalArgumentsRequired require_positional = PositionalArgumentsRequired::Required
45 );
47 const vector<Usage> usages,
48 const int argc,
49 const char* const argv[],
50 const PositionalArgumentsRequired require_positional = PositionalArgumentsRequired::Required
51 );
52 // HACK: copying is breaking current argument tracking
53 ArgumentParser(const ArgumentParser& rhs) = delete;
54 ArgumentParser(ArgumentParser& rhs) = delete;
55 ArgumentParser& operator=(const ArgumentParser& rhs) = delete;
56 ArgumentParser& operator=(ArgumentParser& rhs) = delete;
61 virtual Settings& parse_args();
62
63protected:
65 const vector<Usage> usages,
66 const vector<string> arguments,
67 const pair<string, string> binary,
68 const PositionalArgumentsRequired require_positional
69 )
70 : ArgumentParser(usages, arguments, binary.first, binary.second, require_positional)
71 { }
75 bool has_positional() const;
79 string get_positional();
80 void done_positional();
81
82public:
86 string cur_arg();
87 string get_args();
88 string get_arg() noexcept;
89 bool help_requested() { return help_requested_; }
90 void mark_parsed(const string arg);
91 bool was_parsed(const string arg);
92 string format_args();
93 void show_args();
94 void log_args();
95 void show_usage_and_exit(int exit_code);
96 void show_usage_and_exit();
97 void show_help_and_exit();
98 size_t argc() const { return arguments_.size(); }
99
100protected:
101 size_t cur_arg_{0};
102 size_t skipped_args_{0};
103 vector<string> arguments_{};
104 vector<string> arguments_expanded_{};
105 string binary_directory_{};
106 string binary_name_{};
107 vector<string>& args_expanded();
108};
110{
111public:
112 using ArgumentParser::ArgumentParser;
113 Settings& parse_args() override;
114};
116{
117public:
118 MainArgumentParser(const int argc, const char* const argv[]);
119 Settings& parse_args() override;
120};
121}
122#endif
Definition ArgumentParser.h:19
string cur_arg()
Indicate positional arguments should all be used by now and error if not.
Definition ArgumentParser.cpp:694
virtual Settings & parse_args()
Parse arguments that were given to constructor.
Definition ArgumentParser.cpp:337
string get_positional()
Get next positional argument.
Definition ArgumentParser.cpp:408
bool has_positional() const
If any more positional arguments are available.
Definition ArgumentParser.cpp:407
Definition ArgumentParser.h:116
Settings & parse_args() override
Parse arguments that were given to constructor.
Definition ArgumentParser.cpp:605
Definition ArgumentParser.h:110
Settings & parse_args() override
Parse arguments that were given to constructor.
Definition ArgumentParser.cpp:444
Reads and provides access to settings for the simulation.
Definition Settings.h:69
Definition ArgumentParser.h:9