view.c 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386
  1. /*
  2. * view.c
  3. *
  4. * This file provides the implementation of a view class
  5. */
  6. #include "private.h"
  7. #include "clish/variable.h"
  8. #include "lub/argv.h"
  9. #include "lub/string.h"
  10. #include "lub/ctype.h"
  11. #include <assert.h>
  12. #include <stdlib.h>
  13. #include <string.h>
  14. #include <stdio.h>
  15. /*---------------------------------------------------------
  16. * PRIVATE META FUNCTIONS
  17. *--------------------------------------------------------- */
  18. int clish_view_bt_compare(const void *clientnode, const void *clientkey)
  19. {
  20. const clish_view_t *this = clientnode;
  21. const char *key = clientkey;
  22. return strcmp(this->name, key);
  23. }
  24. /*-------------------------------------------------------- */
  25. void clish_view_bt_getkey(const void *clientnode, lub_bintree_key_t * key)
  26. {
  27. const clish_view_t *this = clientnode;
  28. /* fill out the opaque key */
  29. strcpy((char *)key, this->name);
  30. }
  31. /*---------------------------------------------------------
  32. * PRIVATE METHODS
  33. *--------------------------------------------------------- */
  34. static void
  35. clish_view_init(clish_view_t * this, const char *name, const char *prompt)
  36. {
  37. /* set up defaults */
  38. this->name = lub_string_dup(name);
  39. this->prompt = NULL;
  40. this->nspacec = 0;
  41. this->nspacev = NULL;
  42. this->depth = 0;
  43. this->restore = CLISH_RESTORE_NONE;
  44. /* Be a good binary tree citizen */
  45. lub_bintree_node_init(&this->bt_node);
  46. /* initialise the tree of commands for this view */
  47. lub_bintree_init(&this->tree,
  48. clish_command_bt_offset(),
  49. clish_command_bt_compare, clish_command_bt_getkey);
  50. /* set up the defaults */
  51. clish_view__set_prompt(this, prompt);
  52. }
  53. /*--------------------------------------------------------- */
  54. static void clish_view_fini(clish_view_t * this)
  55. {
  56. clish_command_t *cmd;
  57. unsigned i;
  58. /* delete each command held by this view */
  59. while ((cmd = lub_bintree_findfirst(&this->tree))) {
  60. /* remove the command from the tree */
  61. lub_bintree_remove(&this->tree, cmd);
  62. /* release the instance */
  63. clish_command_delete(cmd);
  64. }
  65. /* free our memory */
  66. lub_string_free(this->name);
  67. this->name = NULL;
  68. lub_string_free(this->prompt);
  69. this->prompt = NULL;
  70. /* finalize each of the namespace instances */
  71. for (i = 0; i < this->nspacec; i++) {
  72. clish_nspace_delete(this->nspacev[i]);
  73. }
  74. /* free the namespace vector */
  75. free(this->nspacev);
  76. this->nspacec = 0;
  77. this->nspacev = NULL;
  78. }
  79. /*---------------------------------------------------------
  80. * PUBLIC META FUNCTIONS
  81. *--------------------------------------------------------- */
  82. size_t clish_view_bt_offset(void)
  83. {
  84. return offsetof(clish_view_t, bt_node);
  85. }
  86. /*--------------------------------------------------------- */
  87. clish_view_t *clish_view_new(const char *name, const char *prompt)
  88. {
  89. clish_view_t *this = malloc(sizeof(clish_view_t));
  90. if (this)
  91. clish_view_init(this, name, prompt);
  92. return this;
  93. }
  94. /*---------------------------------------------------------
  95. * PUBLIC METHODS
  96. *--------------------------------------------------------- */
  97. void clish_view_delete(clish_view_t * this)
  98. {
  99. clish_view_fini(this);
  100. free(this);
  101. }
  102. /*--------------------------------------------------------- */
  103. clish_command_t *clish_view_new_command(clish_view_t * this,
  104. const char *name, const char *help)
  105. {
  106. /* allocate the memory for a new parameter definition */
  107. clish_command_t *cmd = clish_command_new(name, help);
  108. assert(cmd);
  109. /* if this is a command other than the startup command... */
  110. if (NULL != help) {
  111. /* ...insert it into the binary tree for this view */
  112. if (-1 == lub_bintree_insert(&this->tree, cmd)) {
  113. /* inserting a duplicate command is bad */
  114. clish_command_delete(cmd);
  115. cmd = NULL;
  116. }
  117. }
  118. return cmd;
  119. }
  120. /*--------------------------------------------------------- */
  121. /* This method identifies the command (if any) which provides
  122. * the longest match with the specified line of text.
  123. *
  124. * NB this comparison is case insensitive.
  125. *
  126. * this - the view instance upon which to operate
  127. * line - the command line to analyse
  128. */
  129. clish_command_t *clish_view_resolve_prefix(clish_view_t * this,
  130. const char *line, bool_t inherit)
  131. {
  132. clish_command_t *result = NULL, *cmd;
  133. char *buffer = NULL;
  134. lub_argv_t *argv;
  135. unsigned i;
  136. /* create a vector of arguments */
  137. argv = lub_argv_new(line, 0);
  138. for (i = 0; i < lub_argv__get_count(argv); i++) {
  139. /* set our buffer to be that of the first "i" arguments */
  140. lub_string_cat(&buffer, lub_argv__get_arg(argv, i));
  141. /* set the result to the longest match */
  142. cmd = clish_view_find_command(this, buffer, inherit);
  143. /* job done */
  144. if (!cmd)
  145. break;
  146. result = cmd;
  147. /* ready for the next word */
  148. lub_string_cat(&buffer, " ");
  149. }
  150. /* free up our dynamic storage */
  151. lub_string_free(buffer);
  152. lub_argv_delete(argv);
  153. return result;
  154. }
  155. /*--------------------------------------------------------- */
  156. clish_command_t *clish_view_resolve_command(clish_view_t * this,
  157. const char *line, bool_t inherit)
  158. {
  159. clish_command_t *result = clish_view_resolve_prefix(this, line, inherit);
  160. if (result) {
  161. char *action = clish_command__get_action(result, NULL, NULL);
  162. if (!action && (NULL == clish_command__get_builtin(result)) &&
  163. (CLISH_CONFIG_NONE == clish_command__get_cfg_op(result)) &&
  164. (NULL == clish_command__get_view(result))) {
  165. /* if this doesn't do anything we've
  166. * not resolved a command
  167. */
  168. result = NULL;
  169. }
  170. /* cleanup */
  171. lub_string_free(action);
  172. }
  173. return result;
  174. }
  175. /*--------------------------------------------------------- */
  176. clish_command_t *clish_view_find_command(clish_view_t * this,
  177. const char *name, bool_t inherit)
  178. {
  179. clish_command_t *cmd, *result = NULL;
  180. clish_nspace_t *nspace;
  181. unsigned cnt = clish_view__get_nspace_count(this);
  182. int i;
  183. /* Search the current view */
  184. result = lub_bintree_find(&this->tree, name);
  185. /* Make command link from command alias */
  186. result = clish_command_alias_to_link(result);
  187. if (inherit) {
  188. for (i = cnt - 1; i >= 0; i--) {
  189. nspace = clish_view__get_nspace(this, i);
  190. cmd = clish_nspace_find_command(nspace, name);
  191. /* choose the longest match */
  192. result = clish_command_choose_longest(result, cmd);
  193. }
  194. }
  195. return result;
  196. }
  197. /*--------------------------------------------------------- */
  198. static const clish_command_t *find_next_completion(clish_view_t * this,
  199. const char *iter_cmd, const char *line)
  200. {
  201. clish_command_t *cmd;
  202. const char *name = "";
  203. lub_argv_t *largv;
  204. unsigned words;
  205. /* build an argument vector for the line */
  206. largv = lub_argv_new(line, 0);
  207. words = lub_argv__get_count(largv);
  208. /* account for trailing space */
  209. if (!*line || lub_ctype_isspace(line[strlen(line) - 1]))
  210. words++;
  211. if (iter_cmd)
  212. name = iter_cmd;
  213. while ((cmd = lub_bintree_findnext(&this->tree, name))) {
  214. /* Make command link from command alias */
  215. cmd = clish_command_alias_to_link(cmd);
  216. name = clish_command__get_name(cmd);
  217. if (words == lub_argv_wordcount(name)) {
  218. /* only bother with commands of which this line is a prefix */
  219. /* this is a completion */
  220. if (lub_string_nocasestr(name, line) == name)
  221. break;
  222. }
  223. }
  224. /* clean up the dynamic memory */
  225. lub_argv_delete(largv);
  226. return cmd;
  227. }
  228. /*--------------------------------------------------------- */
  229. const clish_command_t *clish_view_find_next_completion(clish_view_t * this,
  230. const char *iter_cmd, const char *line,
  231. clish_nspace_visibility_t field, bool_t inherit)
  232. {
  233. const clish_command_t *result, *cmd;
  234. clish_nspace_t *nspace;
  235. unsigned cnt = clish_view__get_nspace_count(this);
  236. int i;
  237. /* ask local view for next command */
  238. result = find_next_completion(this, iter_cmd, line);
  239. if (!inherit)
  240. return result;
  241. /* ask the imported namespaces for next command */
  242. for (i = cnt - 1; i >= 0; i--) {
  243. nspace = clish_view__get_nspace(this, i);
  244. if (!clish_nspace__get_visibility(nspace, field))
  245. continue;
  246. cmd = clish_nspace_find_next_completion(nspace,
  247. iter_cmd, line, field);
  248. if (clish_command_diff(result, cmd) > 0)
  249. result = cmd;
  250. }
  251. return result;
  252. }
  253. /*--------------------------------------------------------- */
  254. void clish_view_insert_nspace(clish_view_t * this, clish_nspace_t * nspace)
  255. {
  256. size_t new_size = ((this->nspacec + 1) * sizeof(clish_nspace_t *));
  257. clish_nspace_t **tmp;
  258. /* resize the namespace vector */
  259. tmp = realloc(this->nspacev, new_size);
  260. assert(tmp);
  261. this->nspacev = tmp;
  262. /* insert reference to the namespace */
  263. this->nspacev[this->nspacec++] = nspace;
  264. }
  265. /*--------------------------------------------------------- */
  266. void clish_view_clean_proxy(clish_view_t * this)
  267. {
  268. int i;
  269. /* Iterate namespace instances */
  270. for (i = 0; i < this->nspacec; i++) {
  271. clish_nspace_clean_proxy(this->nspacev[i]);
  272. }
  273. }
  274. /*---------------------------------------------------------
  275. * PUBLIC ATTRIBUTES
  276. *--------------------------------------------------------- */
  277. const char *clish_view__get_name(const clish_view_t * this)
  278. {
  279. return this->name;
  280. }
  281. /*--------------------------------------------------------- */
  282. void clish_view__set_prompt(clish_view_t * this, const char *prompt)
  283. {
  284. assert(!this->prompt);
  285. this->prompt = lub_string_dup(prompt);
  286. }
  287. /*--------------------------------------------------------- */
  288. char *clish_view__get_prompt(const clish_view_t * this, const char *viewid)
  289. {
  290. return clish_variable_expand(this->prompt, viewid, NULL, NULL);
  291. }
  292. /*--------------------------------------------------------- */
  293. clish_nspace_t *clish_view__get_nspace(const clish_view_t * this,
  294. unsigned index)
  295. {
  296. clish_nspace_t *result = NULL;
  297. if (index < this->nspacec) {
  298. result = this->nspacev[index];
  299. }
  300. return result;
  301. }
  302. /*--------------------------------------------------------- */
  303. const unsigned clish_view__get_nspace_count(const clish_view_t * this)
  304. {
  305. return this->nspacec;
  306. }
  307. /*--------------------------------------------------------- */
  308. void clish_view__set_depth(clish_view_t * this, unsigned depth)
  309. {
  310. this->depth = depth;
  311. }
  312. /*--------------------------------------------------------- */
  313. unsigned clish_view__get_depth(const clish_view_t * this)
  314. {
  315. return this->depth;
  316. }
  317. /*--------------------------------------------------------- */
  318. void clish_view__set_restore(clish_view_t * this,
  319. clish_view_restore_t restore)
  320. {
  321. this->restore = restore;
  322. }
  323. /*--------------------------------------------------------- */
  324. clish_view_restore_t clish_view__get_restore(const clish_view_t * this)
  325. {
  326. return this->restore;
  327. }
  328. /*--------------------------------------------------------- */