source: cmd.c @ 205e164

release-1.7release-1.8release-1.9
Last change on this file since 205e164 was d296c9a, checked in by David Benjamin <davidben@mit.edu>, 11 years ago
Merge branch 'owl_window' Conflicts: global.c
  • 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  char *buff, *ptr;
113  int len = 0, i;
114  char *retval = NULL;
115
116  for(i = 0; i < argc; i++) {
117    len += strlen(argv[i]) + 1;
118  }
119
120  ptr = buff = owl_malloc(len);
121
122  for(i = 0; i < argc; i++) {
123    strcpy(ptr, argv[i]);
124    ptr += strlen(argv[i]);
125    *(ptr++) = ' ';
126  }
127  *(ptr - 1) = 0;
128
129  retval = _owl_cmddict_execute(cd, ctx, argv, argc, buff);
130
131  owl_free(buff);
132  return retval;
133}
134
135/*********************************************************************/
136/***************************** COMMAND *******************************/
137/*********************************************************************/
138
139/* sets up a new command based on a template, copying strings */
140int owl_cmd_create_from_template(owl_cmd *cmd, const owl_cmd *templ) {
141  *cmd = *templ;
142  if (!templ->name) return(-1);
143  cmd->name = owl_strdup(templ->name);
144  if (templ->summary)     cmd->summary     = owl_strdup(templ->summary);
145  if (templ->usage)       cmd->usage       = owl_strdup(templ->usage);
146  if (templ->description) cmd->description = owl_strdup(templ->description);
147  if (templ->cmd_aliased_to) cmd->cmd_aliased_to = owl_strdup(templ->cmd_aliased_to);
148  return(0);
149}
150
151int owl_cmd_create_alias(owl_cmd *cmd, const char *name, const char *aliased_to) {
152  memset(cmd, 0, sizeof(owl_cmd));
153  cmd->name = owl_strdup(name);
154  cmd->cmd_aliased_to = owl_strdup(aliased_to);
155  cmd->summary = owl_sprintf("%s%s", OWL_CMD_ALIAS_SUMMARY_PREFIX, aliased_to);
156  return(0);
157}
158
159void owl_cmd_cleanup(owl_cmd *cmd)
160{
161  if (cmd->name) owl_free(cmd->name);
162  if (cmd->summary) owl_free(cmd->summary);
163  if (cmd->usage) owl_free(cmd->usage);
164  if (cmd->description) owl_free(cmd->description);
165  if (cmd->cmd_aliased_to) owl_free(cmd->cmd_aliased_to);
166  if (cmd->cmd_perl) owl_perlconfig_cmd_cleanup(cmd);
167}
168
169void owl_cmd_delete(owl_cmd *cmd)
170{
171  owl_cmd_cleanup(cmd);
172  owl_free(cmd);
173}
174
175int owl_cmd_is_context_valid(const owl_cmd *cmd, const owl_context *ctx) { 
176  if (owl_context_matches(ctx, cmd->validctx)) return 1;
177  else return 0;
178}
179
180char *owl_cmd_execute(const owl_cmd *cmd, const owl_cmddict *cd, const owl_context *ctx, int argc, const char *const *argv, const char *cmdbuff) {
181  static int alias_recurse_depth = 0;
182  int ival=0;
183  const char *cmdbuffargs;
184  char *newcmd, *rv=NULL;
185
186  if (argc < 1) return(NULL);
187
188  /* Recurse if this is an alias */
189  if (cmd->cmd_aliased_to) {
190    if (alias_recurse_depth++ > 50) {
191      owl_function_makemsg("Alias loop detected for '%s'.", cmdbuff);
192    } else {
193      cmdbuffargs = skiptokens(cmdbuff, 1);
194      newcmd = owl_sprintf("%s %s", cmd->cmd_aliased_to, cmdbuffargs);
195      rv = owl_function_command(newcmd);
196      owl_free(newcmd);
197    } 
198    alias_recurse_depth--;
199    return rv;
200  }
201
202  /* Do validation and conversions */
203  if (cmd->cmd_ctxargs_fn || cmd->cmd_ctxv_fn || cmd->cmd_ctxi_fn) {
204    if (!owl_cmd_is_context_valid(cmd, ctx)) {
205      owl_function_makemsg("Invalid context for command '%s'.", cmdbuff);
206      return NULL;
207    }
208  }
209
210  if ((argc != 1) && (cmd->cmd_v_fn || cmd->cmd_ctxv_fn)) {
211    owl_function_makemsg("Wrong number of arguments for %s command.", argv[0]);
212    return NULL;
213  }
214
215  if (cmd->cmd_i_fn || cmd->cmd_ctxi_fn) {
216      char *ep;
217      if (argc != 2) {
218        owl_function_makemsg("Wrong number of arguments for %s command.", argv[0]);
219        return NULL;
220      }
221      ival = strtol(argv[1], &ep, 10);
222      if (*ep || ep==argv[1]) {
223        owl_function_makemsg("Invalid argument '%s' for %s command.", argv[1], argv[0]);
224        return(NULL);
225      }
226  }
227
228  if (cmd->cmd_args_fn) {
229    return cmd->cmd_args_fn(argc, argv, cmdbuff);
230  } else if (cmd->cmd_v_fn) {   
231    cmd->cmd_v_fn();
232  } else if (cmd->cmd_i_fn) {
233    cmd->cmd_i_fn(ival);
234  } else if (cmd->cmd_ctxargs_fn) {
235    return cmd->cmd_ctxargs_fn(owl_context_get_data(ctx), argc, argv, cmdbuff);
236  } else if (cmd->cmd_ctxv_fn) {   
237    cmd->cmd_ctxv_fn(owl_context_get_data(ctx));
238  } else if (cmd->cmd_ctxi_fn) {
239    cmd->cmd_ctxi_fn(owl_context_get_data(ctx), ival);
240  } else if (cmd->cmd_perl) {
241    return owl_perlconfig_perlcmd(cmd, argc, argv);
242  }
243
244  return NULL;
245}
246
247/* returns a reference */
248const char *owl_cmd_get_summary(const owl_cmd *cmd) {
249  return cmd->summary;
250}
251
252/* returns a summary line describing this keymap.  the caller must free. */
253char *owl_cmd_describe(const owl_cmd *cmd) {
254  if (!cmd || !cmd->name || !cmd->summary) return NULL;
255  return owl_sprintf("%-25s - %s", cmd->name, cmd->summary);
256}
257
258
259
260void owl_cmd_get_help(const owl_cmddict *d, const char *name, owl_fmtext *fm) {
261  const char *s;
262  char *indent;
263  owl_cmd *cmd;
264
265  if (!name || (cmd = owl_dict_find_element(d, name)) == NULL) {
266    owl_fmtext_append_bold(fm, "OWL HELP\n\n");
267    owl_fmtext_append_normal(fm, "No such command...\n");
268    return;
269  }
270
271  owl_fmtext_append_bold(fm, "OWL HELP\n\n");
272  owl_fmtext_append_bold(fm, "NAME\n\n");
273  owl_fmtext_append_normal(fm, OWL_TABSTR);
274  owl_fmtext_append_normal(fm, cmd->name);
275
276  if (cmd->summary && *cmd->summary) {
277    owl_fmtext_append_normal(fm, " - ");
278    owl_fmtext_append_normal(fm, cmd->summary);
279  }
280  owl_fmtext_append_normal(fm, "\n");
281
282  if (cmd->usage && *cmd->usage) {
283    s = cmd->usage;
284    indent = owl_malloc(strlen(s)+(owl_text_num_lines(s)+3)*OWL_TAB+1);
285    owl_text_indent(indent, s, OWL_TAB);
286    owl_fmtext_append_bold(fm, "\nSYNOPSIS\n");
287    owl_fmtext_append_normal(fm, indent);
288    owl_fmtext_append_normal(fm, "\n");
289    owl_free(indent);
290  } else {
291    owl_fmtext_append_bold(fm, "\nSYNOPSIS\n");
292    owl_fmtext_append_normal(fm, OWL_TABSTR);
293    owl_fmtext_append_normal(fm, cmd->name);
294    owl_fmtext_append_normal(fm, "\n");
295  }
296
297  if (cmd->description && *cmd->description) {
298    s = cmd->description;
299    indent = owl_malloc(strlen(s)+(owl_text_num_lines(s)+3)*OWL_TAB+1);
300    owl_text_indent(indent, s, OWL_TAB);
301    owl_fmtext_append_bold(fm, "\nDESCRIPTION\n");
302    owl_fmtext_append_normal(fm, indent);
303    owl_fmtext_append_normal(fm, "\n");
304    owl_free(indent);
305  }
306
307  owl_fmtext_append_normal(fm, "\n\n"); 
308}
Note: See TracBrowser for help on using the repository browser.