source: cmd.c @ e3c8332

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