view.c 11 KB

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