// // // Copyright 2015 gRPC authors. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // // #include "test/core/test_util/cmdline.h" #include #include #include #include #include #include #include "absl/log/check.h" #include "absl/strings/str_cat.h" #include "absl/strings/str_format.h" #include "absl/strings/str_join.h" #include #include #include "src/core/lib/gprpp/memory.h" typedef enum { ARGTYPE_INT, ARGTYPE_BOOL, ARGTYPE_STRING } argtype; typedef struct arg { const char* name; const char* help; argtype type; void* value; struct arg* next; } arg; struct gpr_cmdline { const char* description; arg* args; const char* argv0; const char* extra_arg_name; const char* extra_arg_help; void (*extra_arg)(void* user_data, const char* arg); void* extra_arg_user_data; int (*state)(gpr_cmdline* cl, char* arg); arg* cur_arg; int survive_failure; }; static int normal_state(gpr_cmdline* cl, char* str); gpr_cmdline* gpr_cmdline_create(const char* description) { gpr_cmdline* cl = grpc_core::Zalloc(); cl->description = description; cl->state = normal_state; return cl; } void gpr_cmdline_set_survive_failure(gpr_cmdline* cl) { cl->survive_failure = 1; } void gpr_cmdline_destroy(gpr_cmdline* cl) { while (cl->args) { arg* a = cl->args; cl->args = a->next; gpr_free(a); } gpr_free(cl); } static void add_arg(gpr_cmdline* cl, const char* name, const char* help, argtype type, void* value) { arg* a; for (a = cl->args; a; a = a->next) { CHECK_NE(strcmp(a->name, name), 0); } a = static_cast(gpr_zalloc(sizeof(arg))); a->name = name; a->help = help; a->type = type; a->value = value; a->next = cl->args; cl->args = a; } void gpr_cmdline_add_int(gpr_cmdline* cl, const char* name, const char* help, int* value) { add_arg(cl, name, help, ARGTYPE_INT, value); } void gpr_cmdline_add_flag(gpr_cmdline* cl, const char* name, const char* help, int* value) { add_arg(cl, name, help, ARGTYPE_BOOL, value); } void gpr_cmdline_add_string(gpr_cmdline* cl, const char* name, const char* help, const char** value) { add_arg(cl, name, help, ARGTYPE_STRING, value); } void gpr_cmdline_on_extra_arg( gpr_cmdline* cl, const char* name, const char* help, void (*on_extra_arg)(void* user_data, const char* arg), void* user_data) { CHECK(!cl->extra_arg); CHECK(on_extra_arg); cl->extra_arg = on_extra_arg; cl->extra_arg_user_data = user_data; cl->extra_arg_name = name; cl->extra_arg_help = help; } // recursively descend argument list, adding the last element // to s first - so that arguments are added in the order they were // added to the list by api calls static void add_args_to_usage(arg* a, std::vector* s) { if (a == nullptr) return; add_args_to_usage(a->next, s); switch (a->type) { case ARGTYPE_BOOL: s->push_back(absl::StrFormat(" [--%s|--no-%s]", a->name, a->name)); break; case ARGTYPE_STRING: s->push_back(absl::StrFormat(" [--%s=string]", a->name)); break; case ARGTYPE_INT: s->push_back(absl::StrFormat(" [--%s=int]", a->name)); break; } } std::string gpr_cmdline_usage_string(gpr_cmdline* cl, const char* argv0) { const char* name = strrchr(argv0, '/'); if (name != nullptr) { name++; } else { name = argv0; } std::vector s; s.push_back(absl::StrCat("Usage: ", name)); add_args_to_usage(cl->args, &s); if (cl->extra_arg) { s.push_back(absl::StrFormat(" [%s...]", cl->extra_arg_name)); } s.push_back("\n"); return absl::StrJoin(s, ""); } static int print_usage_and_die(gpr_cmdline* cl) { fprintf(stderr, "%s", gpr_cmdline_usage_string(cl, cl->argv0).c_str()); if (!cl->survive_failure) { exit(1); } return 0; } static int extra_state(gpr_cmdline* cl, char* str) { if (!cl->extra_arg) { return print_usage_and_die(cl); } cl->extra_arg(cl->extra_arg_user_data, str); return 1; } static arg* find_arg(gpr_cmdline* cl, char* name) { arg* a; for (a = cl->args; a; a = a->next) { if (0 == strcmp(a->name, name)) { break; } } if (!a) { fprintf(stderr, "Unknown argument: %s\n", name); return nullptr; } return a; } static int value_state(gpr_cmdline* cl, char* str) { long intval; char* end; CHECK(cl->cur_arg); switch (cl->cur_arg->type) { case ARGTYPE_INT: intval = strtol(str, &end, 0); if (*end || intval < INT_MIN || intval > INT_MAX) { fprintf(stderr, "expected integer, got '%s' for %s\n", str, cl->cur_arg->name); return print_usage_and_die(cl); } *static_cast(cl->cur_arg->value) = static_cast(intval); break; case ARGTYPE_BOOL: if (0 == strcmp(str, "1") || 0 == strcmp(str, "true")) { *static_cast(cl->cur_arg->value) = 1; } else if (0 == strcmp(str, "0") || 0 == strcmp(str, "false")) { *static_cast(cl->cur_arg->value) = 0; } else { fprintf(stderr, "expected boolean, got '%s' for %s\n", str, cl->cur_arg->name); return print_usage_and_die(cl); } break; case ARGTYPE_STRING: *static_cast(cl->cur_arg->value) = str; break; } cl->state = normal_state; return 1; } static int normal_state(gpr_cmdline* cl, char* str) { char* eq = nullptr; char* tmp = nullptr; char* arg_name = nullptr; int r = 1; if (0 == strcmp(str, "-help") || 0 == strcmp(str, "--help") || 0 == strcmp(str, "-h")) { return print_usage_and_die(cl); } cl->cur_arg = nullptr; if (str[0] == '-') { if (str[1] == '-') { if (str[2] == 0) { // handle '--' to move to just extra args cl->state = extra_state; return 1; } str += 2; } else { str += 1; } // first byte of str is now past the leading '-' or '--' if (str[0] == 'n' && str[1] == 'o' && str[2] == '-') { // str is of the form '--no-foo' - it's a flag disable str += 3; cl->cur_arg = find_arg(cl, str); if (cl->cur_arg == nullptr) { return print_usage_and_die(cl); } if (cl->cur_arg->type != ARGTYPE_BOOL) { fprintf(stderr, "%s is not a flag argument\n", str); return print_usage_and_die(cl); } *static_cast(cl->cur_arg->value) = 0; return 1; // early out } eq = strchr(str, '='); if (eq != nullptr) { // copy the string into a temp buffer and extract the name tmp = arg_name = static_cast(gpr_malloc(static_cast(eq - str + 1))); memcpy(arg_name, str, static_cast(eq - str)); arg_name[eq - str] = 0; } else { arg_name = str; } cl->cur_arg = find_arg(cl, arg_name); if (cl->cur_arg == nullptr) { return print_usage_and_die(cl); } if (eq != nullptr) { // str was of the type --foo=value, parse the value r = value_state(cl, eq + 1); } else if (cl->cur_arg->type != ARGTYPE_BOOL) { // flag types don't have a '--foo value' variant, other types do cl->state = value_state; } else { // flag parameter: just set the value *static_cast(cl->cur_arg->value) = 1; } } else { r = extra_state(cl, str); } gpr_free(tmp); return r; } int gpr_cmdline_parse(gpr_cmdline* cl, int argc, char** argv) { int i; CHECK_GE(argc, 1); cl->argv0 = argv[0]; for (i = 1; i < argc; i++) { if (!cl->state(cl, argv[i])) { return 0; } } return 1; }