source: cmd.c @ e56303f

release-1.8release-1.9
Last change on this file since e56303f was e56303f, checked in by David Benjamin <davidben@mit.edu>, 12 years ago
Replace owl_parse_delete with g_strfreev Also cut the pointless g_strdup in owl_cmddict_execute and allow argc to be NULL if we don't care about the value.
  • Property mode set to 100644
File size: 8.7 KB
RevLine 
[7d4fbcd]1#include <stdio.h>
2#include <stdlib.h>
3#include <string.h>
4#include <unistd.h>
5#include "owl.h"
6
[0a0fb74]7extern const owl_cmd commands_to_init[];
[7d4fbcd]8
9/**************************************************************************/
10/***************************** COMMAND DICT *******************************/
11/**************************************************************************/
12
13int owl_cmddict_setup(owl_cmddict *cd) {
14  if (0 != owl_cmddict_init(cd)) return(-1);
15  if (0 != owl_cmddict_add_from_list(cd, commands_to_init)) return(-1);
16  return(0);
17}
18
19int owl_cmddict_init(owl_cmddict *cd) {
20  if (owl_dict_create(cd)) return(-1);
21  return(0);
22}
23
24/* for bulk initialization at startup */
[0a0fb74]25int owl_cmddict_add_from_list(owl_cmddict *cd, const owl_cmd *cmds) {
26  const owl_cmd *cur;
[eb6cedc]27  int ret = 0;
28  for (cur = cmds; cur->name != NULL; cur++) {
29    ret = owl_cmddict_add_cmd(cd, cur);
30    if (ret < 0) break;
[7d4fbcd]31  }
[eb6cedc]32  return ret;
[7d4fbcd]33}
34
[8d4b521]35/* free the list with owl_cmddict_namelist_cleanup */
[ff7e289]36void owl_cmddict_get_names(const owl_cmddict *d, owl_list *l) {
[7d4fbcd]37  owl_dict_get_keys(d, l);
38}
39
[0a0fb74]40const owl_cmd *owl_cmddict_find(const owl_cmddict *d, const char *name) {
[4d86e06]41  return owl_dict_find_element(d, name);
[7d4fbcd]42}
43
[8d4b521]44void owl_cmddict_namelist_cleanup(owl_list *l)
45{
[ddbbcffa]46  owl_list_cleanup(l, g_free);
[7d4fbcd]47}
48
49/* creates a new command alias */
[e19eb97]50int owl_cmddict_add_alias(owl_cmddict *cd, const char *alias_from, const char *alias_to) {
[7d4fbcd]51  owl_cmd *cmd;
[96828e4]52  cmd = g_new(owl_cmd, 1);
[7d4fbcd]53  owl_cmd_create_alias(cmd, alias_from, alias_to);
[1cc9b615]54  owl_perlconfig_new_command(cmd->name);
[b0da027]55  owl_dict_insert_element(cd, cmd->name, cmd, (void (*)(void *))owl_cmd_delete);
[7d4fbcd]56  return(0);
57}
58
[0a0fb74]59int owl_cmddict_add_cmd(owl_cmddict *cd, const owl_cmd * cmd) {
[96828e4]60  owl_cmd * newcmd = g_new(owl_cmd, 1);
[6922edd]61  if(owl_cmd_create_from_template(newcmd, cmd) < 0) {
[ddbbcffa]62    g_free(newcmd);
[6922edd]63    return -1;
64  }
[eb6cedc]65  owl_perlconfig_new_command(cmd->name);
[b0da027]66  return owl_dict_insert_element(cd, newcmd->name, newcmd, (void (*)(void *))owl_cmd_delete);
[6922edd]67}
68
[3f8514b]69char *_owl_cmddict_execute(const owl_cmddict *cd, const owl_context *ctx, const char *const *argv, int argc, const char *buff) {
[c4ba74d]70  char *retval = NULL;
[0a0fb74]71  const owl_cmd *cmd;
[c4ba74d]72
73  if (!strcmp(argv[0], "")) {
[4d86e06]74  } else if (NULL != (cmd = owl_dict_find_element(cd, argv[0]))) {
[c4ba74d]75    retval = owl_cmd_execute(cmd, cd, ctx, argc, argv, buff);
[044f19f]76    /* redraw the sepbar; TODO: don't violate layering */
77    owl_global_sepbar_dirty(&g);
[c4ba74d]78  } else {
79    owl_function_makemsg("Unknown command '%s'.", buff);
80  }
81  return retval;
82}
83
[3f8514b]84char *owl_cmddict_execute(const owl_cmddict *cd, const owl_context *ctx, const char *cmdbuff) {
[7d4fbcd]85  char **argv;
86  int argc;
87  char *retval = NULL;
88
[e56303f]89  argv = owl_parseline(cmdbuff, &argc);
90  if (argv == NULL) {
[7d4fbcd]91    owl_function_makemsg("Unbalanced quotes");
92    return NULL;
93  } 
94 
[62a000b]95  if (argc < 1) {
[e56303f]96    g_strfreev(argv);
[62a000b]97    return NULL;
98  }
[7d4fbcd]99
[c529ac8]100  retval = _owl_cmddict_execute(cd, ctx, strs(argv), argc, cmdbuff);
[c4ba74d]101
[e56303f]102  g_strfreev(argv);
[7d4fbcd]103  return retval;
104}
105
[3f8514b]106char *owl_cmddict_execute_argv(const owl_cmddict *cd, const owl_context *ctx, const char *const *argv, int argc) {
[e3c8332]107  GString *buf = g_string_new("");
108  int i;
109  char *retval;
[c4ba74d]110
[e3c8332]111  /* We weren't given a command line, so fabricate a valid one. */
[c4ba74d]112  for(i = 0; i < argc; i++) {
[e3c8332]113    if (i != 0)
114      g_string_append_c(buf, ' ');
115    owl_string_append_quoted_arg(buf, argv[i]);
[c4ba74d]116  }
117
[e3c8332]118  retval = _owl_cmddict_execute(cd, ctx, argv, argc, buf->str);
[c4ba74d]119
[e3c8332]120  g_string_free(buf, true);
[c4ba74d]121  return retval;
122}
123
[7d4fbcd]124/*********************************************************************/
125/***************************** COMMAND *******************************/
126/*********************************************************************/
127
128/* sets up a new command based on a template, copying strings */
[0a0fb74]129int owl_cmd_create_from_template(owl_cmd *cmd, const owl_cmd *templ) {
[7d4fbcd]130  *cmd = *templ;
131  if (!templ->name) return(-1);
[d4927a7]132  cmd->name = g_strdup(templ->name);
133  if (templ->summary)     cmd->summary     = g_strdup(templ->summary);
134  if (templ->usage)       cmd->usage       = g_strdup(templ->usage);
135  if (templ->description) cmd->description = g_strdup(templ->description);
136  if (templ->cmd_aliased_to) cmd->cmd_aliased_to = g_strdup(templ->cmd_aliased_to);
[7d4fbcd]137  return(0);
138}
139
[e19eb97]140int owl_cmd_create_alias(owl_cmd *cmd, const char *name, const char *aliased_to) {
[7d4fbcd]141  memset(cmd, 0, sizeof(owl_cmd));
[d4927a7]142  cmd->name = g_strdup(name);
143  cmd->cmd_aliased_to = g_strdup(aliased_to);
[3472845]144  cmd->summary = g_strdup_printf("%s%s", OWL_CMD_ALIAS_SUMMARY_PREFIX, aliased_to);
[7d4fbcd]145  return(0);
146}
147
[685e96f]148void owl_cmd_cleanup(owl_cmd *cmd)
149{
[ddbbcffa]150  if (cmd->name) g_free(cmd->name);
151  if (cmd->summary) g_free(cmd->summary);
152  if (cmd->usage) g_free(cmd->usage);
153  if (cmd->description) g_free(cmd->description);
154  if (cmd->cmd_aliased_to) g_free(cmd->cmd_aliased_to);
[8f2d9bf]155  if (cmd->cmd_perl) owl_perlconfig_cmd_cleanup(cmd);
[7d4fbcd]156}
157
[b0da027]158void owl_cmd_delete(owl_cmd *cmd)
159{
[685e96f]160  owl_cmd_cleanup(cmd);
[ddbbcffa]161  g_free(cmd);
[b0da027]162}
163
[0a0fb74]164int owl_cmd_is_context_valid(const owl_cmd *cmd, const owl_context *ctx) { 
[7d4fbcd]165  if (owl_context_matches(ctx, cmd->validctx)) return 1;
166  else return 0;
167}
168
[0a0fb74]169char *owl_cmd_execute(const owl_cmd *cmd, const owl_cmddict *cd, const owl_context *ctx, int argc, const char *const *argv, const char *cmdbuff) {
[7d4fbcd]170  static int alias_recurse_depth = 0;
171  int ival=0;
[e19eb97]172  const char *cmdbuffargs;
[65b2173]173  char *newcmd, *rv=NULL;
[7d4fbcd]174
175  if (argc < 1) return(NULL);
176
177  /* Recurse if this is an alias */
178  if (cmd->cmd_aliased_to) {
179    if (alias_recurse_depth++ > 50) {
180      owl_function_makemsg("Alias loop detected for '%s'.", cmdbuff);
181    } else {
182      cmdbuffargs = skiptokens(cmdbuff, 1);
[3472845]183      newcmd = g_strdup_printf("%s %s", cmd->cmd_aliased_to, cmdbuffargs);
[7d4fbcd]184      rv = owl_function_command(newcmd);
[ddbbcffa]185      g_free(newcmd);
[7d4fbcd]186    } 
187    alias_recurse_depth--;
188    return rv;
189  }
190
191  /* Do validation and conversions */
192  if (cmd->cmd_ctxargs_fn || cmd->cmd_ctxv_fn || cmd->cmd_ctxi_fn) {
193    if (!owl_cmd_is_context_valid(cmd, ctx)) {
194      owl_function_makemsg("Invalid context for command '%s'.", cmdbuff);
195      return NULL;
196    }
197  }
198
199  if ((argc != 1) && (cmd->cmd_v_fn || cmd->cmd_ctxv_fn)) {
200    owl_function_makemsg("Wrong number of arguments for %s command.", argv[0]);
201    return NULL;
202  }
203
204  if (cmd->cmd_i_fn || cmd->cmd_ctxi_fn) {
[99525be]205      char *ep;
[7d4fbcd]206      if (argc != 2) {
207        owl_function_makemsg("Wrong number of arguments for %s command.", argv[0]);
208        return NULL;
209      }
[99525be]210      ival = strtol(argv[1], &ep, 10);
[7d4fbcd]211      if (*ep || ep==argv[1]) {
212        owl_function_makemsg("Invalid argument '%s' for %s command.", argv[1], argv[0]);
213        return(NULL);
214      }
215  }
216
217  if (cmd->cmd_args_fn) {
218    return cmd->cmd_args_fn(argc, argv, cmdbuff);
219  } else if (cmd->cmd_v_fn) {   
220    cmd->cmd_v_fn();
221  } else if (cmd->cmd_i_fn) {
222    cmd->cmd_i_fn(ival);
223  } else if (cmd->cmd_ctxargs_fn) {
224    return cmd->cmd_ctxargs_fn(owl_context_get_data(ctx), argc, argv, cmdbuff);
225  } else if (cmd->cmd_ctxv_fn) {   
226    cmd->cmd_ctxv_fn(owl_context_get_data(ctx));
227  } else if (cmd->cmd_ctxi_fn) {
228    cmd->cmd_ctxi_fn(owl_context_get_data(ctx), ival);
[6922edd]229  } else if (cmd->cmd_perl) {
230    return owl_perlconfig_perlcmd(cmd, argc, argv);
[7d4fbcd]231  }
232
233  return NULL;
234}
235
236/* returns a reference */
[0a0fb74]237const char *owl_cmd_get_summary(const owl_cmd *cmd) {
[7d4fbcd]238  return cmd->summary;
239}
240
241/* returns a summary line describing this keymap.  the caller must free. */
[0a0fb74]242char *owl_cmd_describe(const owl_cmd *cmd) {
[7d4fbcd]243  if (!cmd || !cmd->name || !cmd->summary) return NULL;
[3472845]244  return g_strdup_printf("%-25s - %s", cmd->name, cmd->summary);
[7d4fbcd]245}
246
247
248
[ff7e289]249void owl_cmd_get_help(const owl_cmddict *d, const char *name, owl_fmtext *fm) {
[e19eb97]250  const char *s;
[65b2173]251  char *indent;
[7d4fbcd]252  owl_cmd *cmd;
253
254  if (!name || (cmd = owl_dict_find_element(d, name)) == NULL) {
255    owl_fmtext_append_bold(fm, "OWL HELP\n\n");
256    owl_fmtext_append_normal(fm, "No such command...\n");
257    return;
258  }
259
260  owl_fmtext_append_bold(fm, "OWL HELP\n\n");
261  owl_fmtext_append_bold(fm, "NAME\n\n");
262  owl_fmtext_append_normal(fm, OWL_TABSTR);
263  owl_fmtext_append_normal(fm, cmd->name);
264
265  if (cmd->summary && *cmd->summary) {
266    owl_fmtext_append_normal(fm, " - ");
267    owl_fmtext_append_normal(fm, cmd->summary);
268  }
269  owl_fmtext_append_normal(fm, "\n");
270
271  if (cmd->usage && *cmd->usage) {
272    s = cmd->usage;
[4d24650]273    indent = owl_text_indent(s, OWL_TAB);
[7d4fbcd]274    owl_fmtext_append_bold(fm, "\nSYNOPSIS\n");
275    owl_fmtext_append_normal(fm, indent);
276    owl_fmtext_append_normal(fm, "\n");
[ddbbcffa]277    g_free(indent);
[7d4fbcd]278  } else {
279    owl_fmtext_append_bold(fm, "\nSYNOPSIS\n");
280    owl_fmtext_append_normal(fm, OWL_TABSTR);
281    owl_fmtext_append_normal(fm, cmd->name);
282    owl_fmtext_append_normal(fm, "\n");
283  }
284
285  if (cmd->description && *cmd->description) {
286    s = cmd->description;
[4d24650]287    indent = owl_text_indent(s, OWL_TAB);
[7d4fbcd]288    owl_fmtext_append_bold(fm, "\nDESCRIPTION\n");
289    owl_fmtext_append_normal(fm, indent);
290    owl_fmtext_append_normal(fm, "\n");
[ddbbcffa]291    g_free(indent);
[7d4fbcd]292  }
293
294  owl_fmtext_append_normal(fm, "\n\n"); 
295}
Note: See TracBrowser for help on using the repository browser.