1
0

view.c 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365
  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. /* Be a good binary tree citizen */
  44. lub_bintree_node_init(&this->bt_node);
  45. /* initialise the tree of commands for this view */
  46. lub_bintree_init(&this->tree,
  47. clish_command_bt_offset(),
  48. clish_command_bt_compare, clish_command_bt_getkey);
  49. /* set up the defaults */
  50. clish_view__set_prompt(this, prompt);
  51. }
  52. /*--------------------------------------------------------- */
  53. static void clish_view_fini(clish_view_t * this)
  54. {
  55. clish_command_t *cmd;
  56. unsigned i;
  57. /* delete each command held by this view */
  58. while ((cmd = lub_bintree_findfirst(&this->tree))) {
  59. /* remove the command from the tree */
  60. lub_bintree_remove(&this->tree, cmd);
  61. /* release the instance */
  62. clish_command_delete(cmd);
  63. }
  64. /* free our memory */
  65. lub_string_free(this->name);
  66. this->name = NULL;
  67. lub_string_free(this->prompt);
  68. this->prompt = NULL;
  69. /* finalize each of the namespace instances */
  70. for (i = 0; i < this->nspacec; i++) {
  71. clish_nspace_delete(this->nspacev[i]);
  72. }
  73. /* free the namespace vector */
  74. free(this->nspacev);
  75. this->nspacec = 0;
  76. this->nspacev = NULL;
  77. }
  78. /*---------------------------------------------------------
  79. * PUBLIC META FUNCTIONS
  80. *--------------------------------------------------------- */
  81. size_t clish_view_bt_offset(void)
  82. {
  83. return offsetof(clish_view_t, bt_node);
  84. }
  85. /*--------------------------------------------------------- */
  86. clish_view_t *clish_view_new(const char *name, const char *prompt)
  87. {
  88. clish_view_t *this = malloc(sizeof(clish_view_t));
  89. if (this) {
  90. clish_view_init(this, name, prompt);
  91. }
  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. if (NULL == cmd) {
  144. /* job done */
  145. break;
  146. }
  147. result = cmd;
  148. /* ready for the next word */
  149. lub_string_cat(&buffer, " ");
  150. }
  151. /* free up our dynamic storage */
  152. lub_string_free(buffer);
  153. lub_argv_delete(argv);
  154. return result;
  155. }
  156. /*--------------------------------------------------------- */
  157. clish_command_t *clish_view_resolve_command(clish_view_t * this,
  158. const char *line, bool_t inherit)
  159. {
  160. clish_command_t *result = clish_view_resolve_prefix(this, line, inherit);
  161. if (NULL != result) {
  162. char *action = clish_command__get_action(result, NULL, NULL);
  163. if ((NULL == action) &&
  164. (NULL == clish_command__get_builtin(result)) &&
  165. (CLISH_CONFIG_NONE == clish_command__get_cfg_op(result)) &&
  166. (NULL == clish_command__get_view(result))) {
  167. /* if this doesn't do anything we've
  168. * not resolved a command
  169. */
  170. result = NULL;
  171. }
  172. /* cleanup */
  173. lub_string_free(action);
  174. }
  175. return result;
  176. }
  177. /*--------------------------------------------------------- */
  178. clish_command_t *clish_view_find_command(clish_view_t * this, const char *name, bool_t inherit)
  179. {
  180. clish_command_t *cmd, *result;
  181. clish_nspace_t *nspace;
  182. clish_view_t *view;
  183. unsigned cnt = clish_view__get_nspace_count(this);
  184. int i;
  185. /* Search the current view */
  186. result = lub_bintree_find(&this->tree, name);
  187. if (!inherit)
  188. return result;
  189. for (i = cnt - 1; i >= 0; i--) {
  190. nspace = clish_view__get_nspace(this, i);
  191. cmd = clish_nspace_find_command(nspace, name);
  192. /* choose the longest match */
  193. result = clish_command_choose_longest(result, cmd);
  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. if (!*line || lub_ctype_isspace(line[strlen(line) - 1])) {
  209. /* account for trailing space */
  210. words++;
  211. }
  212. if (NULL != iter_cmd) {
  213. name = iter_cmd;
  214. }
  215. while ((cmd = lub_bintree_findnext(&this->tree, name))) {
  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. if (lub_string_nocasestr(name, line) == name) {
  220. /* this is a completion */
  221. break;
  222. }
  223. }
  224. }
  225. /* clean up the dynamic memory */
  226. lub_argv_delete(largv);
  227. return cmd;
  228. }
  229. /*--------------------------------------------------------- */
  230. const clish_command_t *clish_view_find_next_completion(clish_view_t * this,
  231. const char *iter_cmd, const char *line, clish_nspace_visibility_t field, bool_t inherit)
  232. {
  233. const clish_command_t *result, *cmd;
  234. clish_nspace_t *nspace;
  235. clish_view_t *view;
  236. unsigned cnt = clish_view__get_nspace_count(this);
  237. int i;
  238. /* ask local view for next command */
  239. result = find_next_completion(this, iter_cmd, line);
  240. if (!inherit)
  241. return result;
  242. /* ask the imported namespaces for next command */
  243. for (i = cnt - 1; i >= 0; i--) {
  244. nspace = clish_view__get_nspace(this, i);
  245. if (!clish_nspace__get_visibility(nspace, field))
  246. continue;
  247. cmd = clish_nspace_find_next_completion(nspace,
  248. iter_cmd, line, field);
  249. if (clish_command_diff(result, cmd) > 0)
  250. result = cmd;
  251. }
  252. return result;
  253. }
  254. /*--------------------------------------------------------- */
  255. void clish_view_insert_nspace(clish_view_t * this, clish_nspace_t * nspace)
  256. {
  257. size_t new_size = ((this->nspacec + 1) * sizeof(clish_nspace_t *));
  258. clish_nspace_t **tmp;
  259. /* resize the namespace vector */
  260. tmp = realloc(this->nspacev, new_size);
  261. assert(tmp);
  262. this->nspacev = tmp;
  263. /* insert reference to the namespace */
  264. this->nspacev[this->nspacec++] = nspace;
  265. }
  266. /*---------------------------------------------------------
  267. * PUBLIC ATTRIBUTES
  268. *--------------------------------------------------------- */
  269. const char *clish_view__get_name(const clish_view_t * this)
  270. {
  271. return this->name;
  272. }
  273. /*--------------------------------------------------------- */
  274. void clish_view__set_prompt(clish_view_t * this, const char *prompt)
  275. {
  276. assert(NULL == this->prompt);
  277. this->prompt = lub_string_dup(prompt);
  278. }
  279. /*--------------------------------------------------------- */
  280. char *clish_view__get_prompt(const clish_view_t * this, const char *viewid)
  281. {
  282. return clish_variable_expand(this->prompt, viewid, NULL, NULL);
  283. }
  284. /*--------------------------------------------------------- */
  285. clish_nspace_t *clish_view__get_nspace(const clish_view_t * this,
  286. unsigned index)
  287. {
  288. clish_nspace_t *result = NULL;
  289. if (index < this->nspacec) {
  290. result = this->nspacev[index];
  291. }
  292. return result;
  293. }
  294. /*--------------------------------------------------------- */
  295. const unsigned clish_view__get_nspace_count(const clish_view_t * this)
  296. {
  297. return this->nspacec;
  298. }
  299. /*--------------------------------------------------------- */
  300. void clish_view__set_depth(clish_view_t * this, unsigned depth)
  301. {
  302. this->depth = depth;
  303. }
  304. /*--------------------------------------------------------- */
  305. unsigned clish_view__get_depth(const clish_view_t * this)
  306. {
  307. return this->depth;
  308. }
  309. /*--------------------------------------------------------- */