arguments_impl.hpp 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341
  1. #pragma once
  2. #include <iostream>
  3. #include <utility>
  4. #include "arguments.h"
  5. #include "exception.h"
  6. #include "utilities.h"
  7. #ifndef PROGRAM_ARGS_NOEXIT_ON_HELP
  8. #define PROGRAM_ARGS_EXIT(X) std::exit(X)
  9. #else
  10. #define PROGRAM_ARGS_EXIT(X) (void)X
  11. #endif
  12. namespace program {
  13. template <typename Impl>
  14. template <typename T>
  15. Arguments<Impl>::Action::operator T() const {
  16. static_assert(std::is_base_of_v<Arguments<T>, T>,
  17. "Action can only bind to Arguments");
  18. if (!primed()) {
  19. self->actions.emplace(name, [](int argc, char const * const * argv) {
  20. return [action = T(argc, argv)](Impl const & args) {
  21. return typed_main(args, action);
  22. };
  23. });
  24. }
  25. return T();
  26. }
  27. template <typename Impl> Arguments<Impl>::Action::operator bool() const {
  28. return primed() && self->arguments.size() > 0;
  29. }
  30. template <typename Impl> bool Arguments<Impl>::Action::primed() const {
  31. if (self->primed_) { return true; }
  32. if (self->has_arguments()) { throw ArgumentMixingError(); }
  33. self->action_descriptions.emplace(name, description);
  34. return false;
  35. }
  36. }
  37. namespace program {
  38. template <typename Impl>
  39. template <typename T>
  40. Arguments<Impl>::Argument::operator T() const {
  41. if (!primed()) {
  42. return T();
  43. } else if (self->arguments.size() > index) {
  44. return convert<T>(name, self->arguments.at(index));
  45. }
  46. throw IllegalPositionError("No argument provided", index);
  47. }
  48. template <typename Impl> Arguments<Impl>::Argument::operator bool() const {
  49. return primed() && self->arguments.size() > index;
  50. }
  51. template <typename Impl>
  52. template <typename T>
  53. auto Arguments<Impl>::Argument::operator=(T && value) {
  54. is_optional = true;
  55. if (description.size()) {
  56. using ::program::to_string;
  57. description += "\n Default Value: " + to_string(value);
  58. }
  59. return WithDefault<Argument, T>{*this, std::forward<T>(value)};
  60. }
  61. template <typename Impl> bool Arguments<Impl>::Argument::primed() const {
  62. if (self->primed_) { return true; }
  63. if (self->has_actions()) { throw ArgumentMixingError(); }
  64. if (is_optional) {
  65. self->optional_from = std::min(self->optional_from, index);
  66. } else if (self->optional_from < index) {
  67. throw ArgumentStructureError{"Required positional after optional", name};
  68. }
  69. if (!self->argument_names.emplace(index, name).second) {
  70. throw IllegalPositionError("Duplicate positional", index);
  71. }
  72. self->argument_descriptions.emplace(name, description);
  73. return false;
  74. }
  75. }
  76. namespace program {
  77. template <typename Impl>
  78. template <typename T>
  79. Arguments<Impl>::Flag::operator T() const {
  80. return primed(false) ? static_cast<T>(self->flags.at(name)) : T();
  81. }
  82. template <typename Impl> Arguments<Impl>::Flag::operator bool() const {
  83. return primed(true) ? static_cast<bool>(self->flags.at(name)) : default_value;
  84. }
  85. template <typename Impl> auto Arguments<Impl>::Flag::operator=(bool && value) {
  86. if (description.size()) {
  87. description += "\n Default Value: ";
  88. description += (value ? "true" : "false");
  89. }
  90. default_value = value;
  91. return *this;
  92. }
  93. template <typename Impl> bool Arguments<Impl>::Flag::primed(bool inv) const {
  94. if (self->primed_) { return self->flags.count(name); }
  95. std::vector<std::string> aliases;
  96. if (name.size() > 1 && inv) { aliases.push_back("no-" + name); }
  97. self->add_options(name, abbrev, description, aliases);
  98. self->flag_names.emplace(name);
  99. return false;
  100. }
  101. }
  102. namespace program {
  103. template <typename Impl>
  104. template <typename T>
  105. Arguments<Impl>::Option::operator T() const {
  106. return (*this) ? convert<T>(name, self->options.at(name)) : T();
  107. }
  108. template <typename Impl> Arguments<Impl>::Option::operator bool() const {
  109. return primed() && self->options.count(name);
  110. }
  111. template <typename Impl>
  112. template <typename T>
  113. auto Arguments<Impl>::Option::operator=(T && value) {
  114. if (description.size()) {
  115. using ::program::to_string;
  116. description += "\n Default Value: " + to_string(value);
  117. }
  118. return WithDefault<Option, T>{*this, std::forward<T>(value)};
  119. }
  120. template <typename Impl>
  121. template <typename T>
  122. auto Arguments<Impl>::Option::operator=(std::initializer_list<T> value) {
  123. if (description.size()) {
  124. using ::program::to_string;
  125. description += "\n Default Value: " + to_string(value);
  126. }
  127. return WithDefault<Option, std::initializer_list<T>>{*this, value};
  128. }
  129. template <typename Impl> bool Arguments<Impl>::Option::primed() const {
  130. if (self->primed_) { return true; }
  131. self->add_options(name, abbrev, description);
  132. return false;
  133. }
  134. }
  135. namespace program {
  136. template <typename Impl>
  137. template <typename B, typename V>
  138. template <typename T>
  139. Arguments<Impl>::WithDefault<B, V>::operator T() const {
  140. if (impl) { return impl; }
  141. if constexpr (std::is_invocable_r<T, V>{}) {
  142. return T(default_value());
  143. } else {
  144. return T{default_value};
  145. }
  146. }
  147. }
  148. namespace program {
  149. template <typename Impl>
  150. Arguments<Impl>::Arguments(int argc, char const * const * const argv) {
  151. Impl generator;
  152. *this = static_cast<Arguments const &>(generator);
  153. if (argument_names.size() &&
  154. argument_names.rbegin()->first != argument_names.size() - 1) {
  155. throw IllegalPositionError("Higher positional than number recorded",
  156. argument_names.rbegin()->first);
  157. }
  158. primed_ = true;
  159. program = argv[0];
  160. for (size_t i = 1; i < argc; ++i) {
  161. std::string arg = argv[i];
  162. char const * const next = argv[i + 1];
  163. char abbrev = arg[1];
  164. if (arg == "--help") {
  165. usage();
  166. PROGRAM_ARGS_EXIT(0);
  167. } else if (arg == "--") {
  168. arguments.insert(arguments.end(), &next, &argv[argc]);
  169. break;
  170. } else if (auto hook = actions[arg]) {
  171. main_callback = hook(argc - i, argv + i);
  172. return;
  173. } else if (arg == "help" && next && actions[next]) {
  174. char const * const help[] = {next, "--help"};
  175. main_callback = actions[next](2, help);
  176. return;
  177. } else if (arg[0] != '-') {
  178. arguments.emplace_back(arg);
  179. } else if (is_flag(arg)) {
  180. if (arg.substr(0, 5) == "--no-") {
  181. flags[id(arg)] = 0;
  182. } else {
  183. ++flags[id(arg)];
  184. }
  185. } else if (is_option(arg)) {
  186. options[id(arg)].emplace_back(argv[++i]);
  187. } else if (is_flag(abbrev) && arg.find_last_not_of("0123456789") == 1) {
  188. flags[id(abbrev)] = std::stoi(arg.substr(2));
  189. } else if (is_flag(abbrev)) {
  190. for (auto c : arg.substr(1)) {
  191. if (!is_flag(c)) { throw NotAnArgumentError({'-', c}); }
  192. ++flags[id(c)];
  193. }
  194. } else if (is_option(abbrev)) {
  195. options[id(abbrev)].emplace_back(arg.substr(2));
  196. } else {
  197. throw NotAnArgumentError(arg);
  198. }
  199. }
  200. }
  201. template <typename Impl> void Arguments<Impl>::usage() const {
  202. std::cout << program << " [options...]";
  203. for (auto & [index, name] : argument_names) {
  204. std::cout << " " << (index == optional_from ? "[" : "") << name;
  205. }
  206. if (rest_name.size()) { std::cout << " [" << rest_name << "...]"; }
  207. if (optional_from != no_optional_args) { std::cout << "]"; }
  208. std::cout << "\nArgument Arguments:\n";
  209. for (auto & [name, desc] : argument_descriptions) {
  210. std::cout << " " << name << ": " << desc << "\n";
  211. }
  212. std::cout << "Options:\n";
  213. for (auto & [opt, desc] : option_descriptions) {
  214. std::cout << " " << opt << ": " << desc << "\n";
  215. }
  216. }
  217. template <typename Impl>
  218. void Arguments<Impl>::add_options(std::string const & name, char abbrev,
  219. std::string const & description,
  220. std::vector<std::string> aliases) {
  221. for (auto & str : aliases) {
  222. str = "--" + str;
  223. }
  224. if (name.size() > 1) { aliases.push_back("--" + name); }
  225. if (abbrev) { aliases.push_back(std::string{'-', abbrev}); }
  226. for (auto & str : aliases) {
  227. if (!option_names.emplace(str, name).second) {
  228. throw ArgumentStructureError("Duplicate option string", str);
  229. }
  230. }
  231. option_descriptions.emplace(join(",", aliases), description);
  232. }
  233. template <typename Impl>
  234. auto Arguments<Impl>::id(std::string const & arg) const -> option_id {
  235. if (!is_option(arg)) { throw NotAnArgumentError(arg); }
  236. return option_names.at(arg);
  237. }
  238. template <typename Impl>
  239. bool Arguments<Impl>::is_option(std::string const & arg) const {
  240. return option_names.count(arg);
  241. }
  242. template <typename Impl>
  243. bool Arguments<Impl>::is_flag(std::string const & arg) const {
  244. return is_option(arg) && flag_names.count(id(arg));
  245. }
  246. template <typename Impl>
  247. auto Arguments<Impl>::action(LongArg name, std::string const & description) {
  248. return Action{this, name, description};
  249. }
  250. template <typename Impl>
  251. auto Arguments<Impl>::argument(size_t index, LongArg name,
  252. std::string const & description) {
  253. return Argument{this, index, false, name, description};
  254. }
  255. template <typename Impl>
  256. std::vector<std::string>
  257. Arguments<Impl>::rest(LongArg name, std::string const & description) {
  258. if (has_actions()) { throw ArgumentMixingError(); }
  259. if (!rest_name.empty() && rest_name != name.str) {
  260. throw ArgumentStructureError("duplicate rest() parameter", name);
  261. }
  262. rest_name = name;
  263. argument_descriptions.emplace(name, description);
  264. size_t const i = std::min(arguments.size(), argument_names.size());
  265. return {arguments.begin() + i, arguments.end()};
  266. }
  267. template <typename Impl>
  268. auto Arguments<Impl>::flag(LongArg name, std::string const & description) {
  269. return Flag{this, name, 0, description, false};
  270. }
  271. template <typename Impl>
  272. auto Arguments<Impl>::flag(LongArg name, char abbrev,
  273. std::string const & description) {
  274. return Flag{this, name, abbrev, description, false};
  275. }
  276. template <typename Impl>
  277. auto Arguments<Impl>::flag(char abbrev, std::string const & description) {
  278. return Flag{this, {abbrev}, abbrev, description, false};
  279. }
  280. template <typename Impl>
  281. auto Arguments<Impl>::option(LongArg name, std::string const & description) {
  282. return Option{this, name, 0, description};
  283. }
  284. template <typename Impl>
  285. auto Arguments<Impl>::option(LongArg name, char abbrev,
  286. std::string const & description) {
  287. return Option{this, name, abbrev, description};
  288. }
  289. template <typename Impl>
  290. auto Arguments<Impl>::option(char abbrev, std::string const & description) {
  291. return Option{this, {abbrev}, abbrev, description};
  292. }
  293. }