1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2019 Netflix, Inc 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 * 27 * $FreeBSD$ 28 */ 29 30 #ifndef COMND_H 31 #define COMND_H 32 33 #include <sys/queue.h> 34 #include <sys/linker_set.h> 35 36 /* 37 * Regularized parsing of simple arguments built on top of getopt_long. 38 */ 39 40 typedef enum arg_type { 41 arg_none = 0, 42 arg_uint8, 43 arg_uint16, 44 arg_uint32, 45 arg_uint64, 46 arg_size, 47 arg_string, 48 arg_path, 49 } arg_type; 50 51 // XXX need to change to offsetof for opts and args. 52 // we then need to allocate ctx and pass that into the cmd 53 // stuff. this will be a little tricky and we may need to expand 54 // arg_type stuff. 55 56 struct opts { 57 const char *long_arg; 58 int short_arg; 59 arg_type at; 60 void *ptr; // XXXX change to offset of 61 const char *descr; 62 }; 63 64 // XXX TDB: subcommand vs actual argument. maybe with subcmd? 65 // XXX TBD: do we need parsing callback functions? 66 struct args { 67 arg_type at; 68 void *ptr; // XXXX change to offset of 69 const char *descr; 70 }; 71 72 typedef void (cmd_load_cb_t)(void *, void *); 73 struct cmd; 74 typedef void (cmd_fn_t)(const struct cmd *nf, int argc, char *argv[]); 75 76 struct cmd { 77 SLIST_ENTRY(cmd) link; 78 const char *name; 79 cmd_fn_t *fn; 80 size_t ctx_size; 81 const struct opts *opts; 82 const struct args *args; 83 const char *descr; 84 SLIST_HEAD(,cmd) subcmd; 85 struct cmd *parent; 86 }; 87 88 void cmd_register(struct cmd *, struct cmd *); 89 #define CMD_COMMAND(c) \ 90 static void cmd_register_##c(void) __attribute__((constructor)); \ 91 static void cmd_register_##c(void) { cmd_register(NULL, &c); } 92 #define CMD_SUBCOMMAND(c,sc) \ 93 static void cmd_register_##c_##sc(void) __attribute__((constructor)); \ 94 static void cmd_register_##c_##sc(void) { cmd_register(&c, &sc); } 95 96 int arg_parse(int argc, char * const *argv, const struct cmd *f); 97 void arg_help(int argc, char * const *argv, const struct cmd *f); 98 void cmd_init(void); 99 void cmd_load_dir(const char *dir, cmd_load_cb_t *cb, void *argp); 100 int cmd_dispatch(int argc, char *argv[], const struct cmd *); 101 102 #endif /* COMND_H */ 103