123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729 |
- /*
- * command.c
- *
- * This file provides the implementation of a command definition
- */
- #include "private.h"
- #include "clish/variable.h"
- #include "lub/bintree.h"
- #include "lub/string.h"
- #include <assert.h>
- #include <stdlib.h>
- #include <string.h>
- #include <stdio.h>
- /*---------------------------------------------------------
- * PRIVATE METHODS
- *--------------------------------------------------------- */
- static void
- clish_command_init(clish_command_t * this, const char *name, const char *text)
- {
- /* initialise the node part */
- this->name = lub_string_dup(name);
- this->text = lub_string_dup(text);
- /* Be a good binary tree citizen */
- lub_bintree_node_init(&this->bt_node);
- /* set up defaults */
- this->link = NULL;
- this->alias = NULL;
- this->alias_view = NULL;
- this->paramv = clish_paramv_new();
- this->viewid = NULL;
- this->view = NULL;
- this->action = NULL;
- this->detail = NULL;
- this->escape_chars = NULL;
- this->args = NULL;
- this->pview = NULL;
- this->lock = BOOL_TRUE;
- this->interrupt = BOOL_FALSE;
- this->dynamic = BOOL_FALSE;
- /* ACTION params */
- this->builtin = NULL;
- this->shebang = NULL;
- /* CONFIG params */
- this->cfg_op = CLISH_CONFIG_NONE;
- this->priority = 0; /* medium priority by default */
- this->pattern = NULL;
- this->file = NULL;
- this->splitter = BOOL_TRUE;
- this->seq = NULL;
- this->unique = BOOL_TRUE;
- this->cfg_depth = NULL;
- }
- /*--------------------------------------------------------- */
- static void clish_command_fini(clish_command_t * this)
- {
- lub_string_free(this->name);
- this->name = NULL;
- lub_string_free(this->text);
- this->text = NULL;
- /* Link need not full cleanup */
- if (this->link)
- return;
- /* finalize each of the parameter instances */
- clish_paramv_delete(this->paramv);
- lub_string_free(this->alias);
- this->alias = NULL;
- lub_string_free(this->viewid);
- this->viewid = NULL;
- lub_string_free(this->action);
- this->action = NULL;
- lub_string_free(this->detail);
- this->detail = NULL;
- lub_string_free(this->builtin);
- this->builtin = NULL;
- lub_string_free(this->shebang);
- this->shebang = NULL;
- lub_string_free(this->escape_chars);
- this->escape_chars = NULL;
- if (NULL != this->args) {
- clish_param_delete(this->args);
- this->args = NULL;
- }
- this->pview = NULL;
- lub_string_free(this->pattern);
- this->pattern = NULL;
- lub_string_free(this->file);
- this->file = NULL;
- lub_string_free(this->seq);
- this->seq = NULL;
- lub_string_free(this->cfg_depth);
- this->cfg_depth = NULL;
- }
- /*---------------------------------------------------------
- * PUBLIC META FUNCTIONS
- *--------------------------------------------------------- */
- size_t clish_command_bt_offset(void)
- {
- return offsetof(clish_command_t, bt_node);
- }
- /*--------------------------------------------------------- */
- int clish_command_bt_compare(const void *clientnode, const void *clientkey)
- {
- const clish_command_t *this = clientnode;
- const char *key = clientkey;
- return lub_string_nocasecmp(this->name, key);
- }
- /*--------------------------------------------------------- */
- void clish_command_bt_getkey(const void *clientnode, lub_bintree_key_t * key)
- {
- const clish_command_t *this = clientnode;
- /* fill out the opaque key */
- strcpy((char *)key, this->name);
- }
- /*--------------------------------------------------------- */
- clish_command_t *clish_command_new(const char *name, const char *help)
- {
- clish_command_t *this = malloc(sizeof(clish_command_t));
- if (this) {
- clish_command_init(this, name, help);
- }
- return this;
- }
- /*--------------------------------------------------------- */
- clish_command_t *clish_command_new_link(const char *name,
- const char *help, const clish_command_t * ref)
- {
- if (!ref)
- return NULL;
- clish_command_t *this = malloc(sizeof(clish_command_t));
- assert(this);
- /* Copy all fields to the new command-link */
- *this = *ref;
- /* Initialise the name (other than original name) */
- this->name = lub_string_dup(name);
- /* Initialise the name (other than original name) */
- this->text = lub_string_dup(help);
- /* Be a good binary tree citizen */
- lub_bintree_node_init(&this->bt_node);
- /* It a link to command so set the link flag */
- this->link = ref;
- return this;
- }
- /*--------------------------------------------------------- */
- clish_command_t * clish_command_alias_to_link(clish_command_t * this)
- {
- clish_command_t * ref;
- clish_command_t tmp;
- if (!this || !this->alias)
- return this;
- assert(this->alias_view);
- ref = clish_view_find_command(this->alias_view, this->alias, BOOL_FALSE);
- if (!ref)
- return this;
- memcpy(&tmp, this, sizeof(tmp));
- *this = *ref;
- memcpy(&this->bt_node, &tmp.bt_node, sizeof(tmp.bt_node));
- this->name = lub_string_dup(tmp.name);
- this->text = lub_string_dup(tmp.text);
- this->link = ref;
- clish_command_fini(&tmp);
- return this;
- }
- /*---------------------------------------------------------
- * PUBLIC METHODS
- *--------------------------------------------------------- */
- void clish_command_delete(clish_command_t * this)
- {
- clish_command_fini(this);
- free(this);
- }
- /*--------------------------------------------------------- */
- void clish_command_insert_param(clish_command_t * this, clish_param_t * param)
- {
- clish_paramv_insert(this->paramv, param);
- }
- /*--------------------------------------------------------- */
- void clish_command_help(const clish_command_t * this, const char * viewid,
- const char * line)
- {
- const char *name = clish_command__get_name(this);
- unsigned index = lub_argv_wordcount(line);
- unsigned idx = lub_argv_wordcount(name);
- lub_argv_t *argv;
- clish_pargv_t *last, *pargv;
- unsigned i;
- unsigned cnt = 0;
- unsigned longest = 0;
- if (0 == index)
- return;
- /* Line has no any parameters */
- if (strlen(line) <= strlen(name)) {
- fprintf(stderr, "%s %s\n", name,
- clish_command__get_text(this));
- return;
- }
- if (line[strlen(line) - 1] != ' ')
- index--;
- argv = lub_argv_new(line, 0);
- /* get the parameter definition */
- last = clish_pargv_create();
- pargv = clish_pargv_create();
- clish_pargv_parse(pargv, this, viewid, this->paramv,
- argv, &idx, last, index);
- clish_pargv_delete(pargv);
- cnt = clish_pargv__get_count(last);
- /* Calculate the longest name */
- for (i = 0; i < cnt; i++) {
- const clish_param_t *param;
- const char *name;
- unsigned clen = 0;
- param = clish_pargv__get_param(last, i);
- if (CLISH_PARAM_SUBCOMMAND == clish_param__get_mode(param))
- name = clish_param__get_value(param);
- else
- name = clish_ptype__get_text(clish_param__get_ptype(param));
- if (name)
- clen = strlen(name);
- if (clen > longest)
- longest = clen;
- }
- for (i = 0; i < cnt; i++)
- clish_param_help(clish_pargv__get_param(last, i), longest + 1);
- clish_pargv_delete(last);
- lub_argv_delete(argv);
- }
- /*--------------------------------------------------------- */
- clish_command_t *clish_command_choose_longest(clish_command_t * cmd1,
- clish_command_t * cmd2)
- {
- unsigned len1 = (cmd1 ? strlen(clish_command__get_name(cmd1)) : 0);
- unsigned len2 = (cmd2 ? strlen(clish_command__get_name(cmd2)) : 0);
- if (len2 < len1) {
- return cmd1;
- } else if (len1 < len2) {
- return cmd2;
- } else {
- /* let local view override */
- return cmd1;
- }
- }
- /*--------------------------------------------------------- */
- int
- clish_command_diff(const clish_command_t * cmd1, const clish_command_t * cmd2)
- {
- if (NULL == cmd1) {
- if (NULL != cmd2) {
- return 1;
- } else {
- return 0;
- }
- }
- if (NULL == cmd2) {
- return -1;
- }
- return lub_string_nocasecmp(clish_command__get_name(cmd1),
- clish_command__get_name(cmd2));
- }
- /*---------------------------------------------------------
- * PUBLIC ATTRIBUTES
- *--------------------------------------------------------- */
- const char *clish_command__get_name(const clish_command_t * this)
- {
- if (!this)
- return NULL;
- return this->name;
- }
- /*--------------------------------------------------------- */
- const char *clish_command__get_text(const clish_command_t * this)
- {
- return this->text;
- }
- /*--------------------------------------------------------- */
- void clish_command__set_action(clish_command_t * this, const char *action)
- {
- assert(NULL == this->action);
- this->action = lub_string_dup(action);
- }
- /*--------------------------------------------------------- */
- const char *clish_command__get_detail(const clish_command_t * this)
- {
- return this->detail;
- }
- /*--------------------------------------------------------- */
- void clish_command__set_detail(clish_command_t * this, const char *detail)
- {
- assert(NULL == this->detail);
- this->detail = lub_string_dup(detail);
- }
- /*--------------------------------------------------------- */
- char *clish_command__get_action(const clish_command_t * this,
- const char *viewid, clish_pargv_t * pargv)
- {
- return clish_variable_expand(this->action, viewid, this, pargv);
- }
- /*--------------------------------------------------------- */
- void clish_command__set_view(clish_command_t * this, clish_view_t * view)
- {
- assert(NULL == this->view);
- clish_command__force_view(this, view);
- }
- /*--------------------------------------------------------- */
- void clish_command__force_view(clish_command_t * this, clish_view_t * view)
- {
- this->view = view;
- }
- /*--------------------------------------------------------- */
- clish_view_t *clish_command__get_view(const clish_command_t * this)
- {
- return this->view;
- }
- /*--------------------------------------------------------- */
- void clish_command__set_viewid(clish_command_t * this, const char *viewid)
- {
- assert(NULL == this->viewid);
- clish_command__force_viewid(this, viewid);
- }
- /*--------------------------------------------------------- */
- void clish_command__force_viewid(clish_command_t * this, const char *viewid)
- {
- this->viewid = lub_string_dup(viewid);
- }
- /*--------------------------------------------------------- */
- char *clish_command__get_viewid(const clish_command_t * this,
- const char *viewid, clish_pargv_t * pargv)
- {
- return clish_variable_expand(this->viewid, viewid, this, pargv);
- }
- /*--------------------------------------------------------- */
- const clish_param_t *clish_command__get_param(const clish_command_t * this,
- unsigned index)
- {
- return clish_paramv__get_param(this->paramv, index);
- }
- /*--------------------------------------------------------- */
- const char *clish_command__get_suffix(const clish_command_t * this)
- {
- return lub_string_suffix(this->name);
- }
- /*--------------------------------------------------------- */
- void clish_command__set_builtin(clish_command_t * this, const char *builtin)
- {
- assert(NULL == this->builtin);
- this->builtin = lub_string_dup(builtin);
- }
- /*--------------------------------------------------------- */
- const char *clish_command__get_builtin(const clish_command_t * this)
- {
- return this->builtin;
- }
- /*--------------------------------------------------------- */
- void
- clish_command__set_escape_chars(clish_command_t * this,
- const char *escape_chars)
- {
- assert(NULL == this->escape_chars);
- this->escape_chars = lub_string_dup(escape_chars);
- }
- /*--------------------------------------------------------- */
- const char *clish_command__get_escape_chars(const clish_command_t * this)
- {
- return this->escape_chars;
- }
- /*--------------------------------------------------------- */
- void clish_command__set_args(clish_command_t * this, clish_param_t * args)
- {
- assert(NULL == this->args);
- this->args = args;
- }
- /*--------------------------------------------------------- */
- const clish_param_t *clish_command__get_args(const clish_command_t * this)
- {
- return this->args;
- }
- /*--------------------------------------------------------- */
- const unsigned clish_command__get_param_count(const clish_command_t * this)
- {
- return clish_paramv__get_count(this->paramv);
- }
- /*--------------------------------------------------------- */
- clish_paramv_t *clish_command__get_paramv(const clish_command_t * this)
- {
- return this->paramv;
- }
- /*--------------------------------------------------------- */
- void clish_command__set_pview(clish_command_t * this, clish_view_t * view)
- {
- this->pview = view;
- }
- /*--------------------------------------------------------- */
- clish_view_t *clish_command__get_pview(const clish_command_t * this)
- {
- return this->pview;
- }
- /*--------------------------------------------------------- */
- unsigned clish_command__get_depth(const clish_command_t * this)
- {
- if (!this->pview)
- return 0;
- return clish_view__get_depth(this->pview);
- }
- /*--------------------------------------------------------- */
- void
- clish_command__set_cfg_op(clish_command_t * this,
- clish_config_operation_t operation)
- {
- this->cfg_op = operation;
- }
- /*--------------------------------------------------------- */
- clish_config_operation_t clish_command__get_cfg_op(const clish_command_t * this)
- {
- return this->cfg_op;
- }
- /*--------------------------------------------------------- */
- void clish_command__set_priority(clish_command_t * this, unsigned short priority)
- {
- this->priority = priority;
- }
- /*--------------------------------------------------------- */
- unsigned short clish_command__get_priority(const clish_command_t * this)
- {
- return this->priority;
- }
- /*--------------------------------------------------------- */
- void clish_command__set_pattern(clish_command_t * this, const char *pattern)
- {
- assert(NULL == this->pattern);
- this->pattern = lub_string_dup(pattern);
- }
- /*--------------------------------------------------------- */
- char *clish_command__get_pattern(const clish_command_t * this,
- const char *viewid, clish_pargv_t * pargv)
- {
- return clish_variable_expand(this->pattern, viewid, this, pargv);
- }
- /*--------------------------------------------------------- */
- void clish_command__set_file(clish_command_t * this, const char *file)
- {
- assert(NULL == this->file);
- this->file = lub_string_dup(file);
- }
- /*--------------------------------------------------------- */
- char *clish_command__get_file(const clish_command_t * this,
- const char *viewid, clish_pargv_t * pargv)
- {
- return clish_variable_expand(this->file, viewid, this, pargv);
- }
- /*--------------------------------------------------------- */
- bool_t clish_command__get_splitter(const clish_command_t * this)
- {
- return this->splitter;
- }
- /*--------------------------------------------------------- */
- void clish_command__set_splitter(clish_command_t * this, bool_t splitter)
- {
- this->splitter = splitter;
- }
- /*--------------------------------------------------------- */
- void clish_command__set_seq(clish_command_t * this, const char * seq)
- {
- assert(NULL == this->seq);
- this->seq = lub_string_dup(seq);
- }
- /*--------------------------------------------------------- */
- unsigned short clish_command__get_seq(const clish_command_t * this,
- const char *viewid, clish_pargv_t * pargv)
- {
- unsigned short num = 0;
- char *str;
- if (!this->seq)
- return 0;
- str = clish_variable_expand(this->seq, viewid, this, pargv);
- if ((str != NULL) && (*str != '\0')) {
- long val = 0;
- char *endptr;
- val = strtol(str, &endptr, 0);
- if (endptr == str)
- num = 0;
- else if (val > 0xffff)
- num = 0xffff;
- else if (val < 0)
- num = 0;
- else
- num = (unsigned short)val;
- }
- lub_string_free(str);
- return num;
- }
- /*--------------------------------------------------------- */
- const char * clish_command__is_seq(const clish_command_t * this)
- {
- return this->seq;
- }
- /*--------------------------------------------------------- */
- clish_view_restore_t clish_command__get_restore(const clish_command_t * this)
- {
- if (!this->pview)
- return CLISH_RESTORE_NONE;
- return clish_view__get_restore(this->pview);
- }
- /*--------------------------------------------------------- */
- bool_t clish_command__get_unique(const clish_command_t * this)
- {
- return this->unique;
- }
- /*--------------------------------------------------------- */
- void clish_command__set_unique(clish_command_t * this, bool_t unique)
- {
- this->unique = unique;
- }
- /*--------------------------------------------------------- */
- const clish_command_t * clish_command__get_orig(const clish_command_t * this)
- {
- if (this->link)
- return clish_command__get_orig(this->link);
- return this;
- }
- /*--------------------------------------------------------- */
- void clish_command__set_cfg_depth(clish_command_t * this, const char * cfg_depth)
- {
- assert(NULL == this->cfg_depth);
- this->cfg_depth = lub_string_dup(cfg_depth);
- }
- /*--------------------------------------------------------- */
- unsigned clish_command__get_cfg_depth(const clish_command_t * this,
- const char *viewid, clish_pargv_t * pargv)
- {
- unsigned num = 0;
- char *str;
- if (!this->cfg_depth)
- return clish_command__get_depth(this);
- str = clish_variable_expand(this->cfg_depth, viewid, this, pargv);
- if ((str != NULL) && (*str != '\0')) {
- long val = 0;
- char *endptr;
- val = strtol(str, &endptr, 0);
- if (endptr == str)
- num = 0;
- else if (val > 0xffff)
- num = 0xffff;
- else if (val < 0)
- num = 0;
- else
- num = (unsigned)val;
- }
- lub_string_free(str);
- return num;
- }
- /*--------------------------------------------------------- */
- bool_t clish_command__get_lock(const clish_command_t * this)
- {
- return this->lock;
- }
- /*--------------------------------------------------------- */
- void clish_command__set_lock(clish_command_t * this, bool_t lock)
- {
- this->lock = lock;
- }
- /*--------------------------------------------------------- */
- const char * clish_command__get_shebang(const clish_command_t * this)
- {
- return this->shebang;
- }
- /*--------------------------------------------------------- */
- void clish_command__set_shebang(clish_command_t * this, const char * shebang)
- {
- const char *prog = shebang;
- const char *prefix = "#!";
- assert(NULL == this->shebang);
- if (lub_string_nocasestr(shebang, prefix) == shebang)
- prog += strlen(prefix);
- this->shebang = lub_string_dup(prog);
- }
- /*--------------------------------------------------------- */
- void clish_command__set_alias(clish_command_t * this, const char * alias)
- {
- assert(NULL == this->alias);
- this->alias = lub_string_dup(alias);
- }
- /*--------------------------------------------------------- */
- const char * clish_command__get_alias(const clish_command_t * this)
- {
- return this->alias;
- }
- /*--------------------------------------------------------- */
- void clish_command__set_alias_view(clish_command_t * this,
- clish_view_t * alias_view)
- {
- this->alias_view = alias_view;
- }
- /*--------------------------------------------------------- */
- clish_view_t * clish_command__get_alias_view(const clish_command_t * this)
- {
- return this->alias_view;
- }
- /*--------------------------------------------------------- */
- void clish_command__set_dynamic(clish_command_t * this, bool_t dynamic)
- {
- this->dynamic = dynamic;
- }
- /*--------------------------------------------------------- */
- bool_t clish_command__get_dynamic(const clish_command_t * this)
- {
- return this->dynamic;
- }
- /*--------------------------------------------------------- */
- const clish_command_t * clish_command__get_cmd(const clish_command_t * this)
- {
- if (!this->dynamic)
- return this;
- if (this->link)
- return clish_command__get_cmd(this->link);
- return NULL;
- }
- /*--------------------------------------------------------- */
- bool_t clish_command__get_interrupt(const clish_command_t * this)
- {
- return this->interrupt;
- }
- /*--------------------------------------------------------- */
- void clish_command__set_interrupt(clish_command_t * this, bool_t interrupt)
- {
- this->interrupt = interrupt;
- }
|