1
0

view.c 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330
  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. int clish_view_compare(const void *clientnode, const void *clientkey)
  17. {
  18. const clish_view_t *this = clientnode;
  19. const char *key = clientkey;
  20. return strcmp(this->name, key);
  21. }
  22. /*-------------------------------------------------------- */
  23. static void clish_view_init(clish_view_t * this, const char *name, const char *prompt)
  24. {
  25. /* set up defaults */
  26. this->name = lub_string_dup(name);
  27. this->prompt = NULL;
  28. this->depth = 0;
  29. this->restore = CLISH_RESTORE_NONE;
  30. this->access = NULL;
  31. /* initialise the tree of commands for this view */
  32. lub_bintree_init(&this->tree,
  33. clish_command_bt_offset(),
  34. clish_command_bt_compare, clish_command_bt_getkey);
  35. /* Initialise the list of namespaces.
  36. * It's important to add new items to the
  37. * tail of list.
  38. */
  39. this->nspaces = lub_list_new(NULL, clish_nspace_delete);
  40. /* set up the defaults */
  41. clish_view__set_prompt(this, prompt);
  42. /* Initialize hotkey structures */
  43. this->hotkeys = clish_hotkeyv_new();
  44. }
  45. /*--------------------------------------------------------- */
  46. static void clish_view_fini(clish_view_t * this)
  47. {
  48. clish_command_t *cmd;
  49. lub_list_node_t *iter;
  50. clish_nspace_t *nspace;
  51. /* delete each command held by this view */
  52. while ((cmd = lub_bintree_findfirst(&this->tree))) {
  53. /* remove the command from the tree */
  54. lub_bintree_remove(&this->tree, cmd);
  55. /* release the instance */
  56. clish_command_delete(cmd);
  57. }
  58. /* Free namespaces list */
  59. lub_list_free_all(this->nspaces);
  60. /* Free hotkey structures */
  61. clish_hotkeyv_delete(this->hotkeys);
  62. /* free our memory */
  63. lub_string_free(this->name);
  64. lub_string_free(this->prompt);
  65. lub_string_free(this->access);
  66. }
  67. /*--------------------------------------------------------- */
  68. clish_view_t *clish_view_new(const char *name, const char *prompt)
  69. {
  70. clish_view_t *this = malloc(sizeof(clish_view_t));
  71. if (this)
  72. clish_view_init(this, name, prompt);
  73. return this;
  74. }
  75. /*-------------------------------------------------------- */
  76. void clish_view_delete(void *data)
  77. {
  78. clish_view_t this = (clish_view_t *)data;
  79. clish_view_fini(this);
  80. free(this);
  81. }
  82. /*--------------------------------------------------------- */
  83. clish_command_t *clish_view_new_command(clish_view_t * this,
  84. const char *name, const char *help)
  85. {
  86. /* allocate the memory for a new parameter definition */
  87. clish_command_t *cmd = clish_command_new(name, help);
  88. assert(cmd);
  89. /* if this is a command other than the startup command... */
  90. if (NULL != help) {
  91. /* ...insert it into the binary tree for this view */
  92. if (-1 == lub_bintree_insert(&this->tree, cmd)) {
  93. /* inserting a duplicate command is bad */
  94. clish_command_delete(cmd);
  95. cmd = NULL;
  96. }
  97. }
  98. return cmd;
  99. }
  100. /*--------------------------------------------------------- */
  101. /* This method identifies the command (if any) which provides
  102. * the longest match with the specified line of text.
  103. *
  104. * NB this comparison is case insensitive.
  105. *
  106. * this - the view instance upon which to operate
  107. * line - the command line to analyse
  108. */
  109. clish_command_t *clish_view_resolve_prefix(clish_view_t * this,
  110. const char *line, bool_t inherit)
  111. {
  112. clish_command_t *result = NULL, *cmd;
  113. char *buffer = NULL;
  114. lub_argv_t *argv;
  115. unsigned i;
  116. /* create a vector of arguments */
  117. argv = lub_argv_new(line, 0);
  118. for (i = 0; i < lub_argv__get_count(argv); i++) {
  119. /* set our buffer to be that of the first "i" arguments */
  120. lub_string_cat(&buffer, lub_argv__get_arg(argv, i));
  121. /* set the result to the longest match */
  122. cmd = clish_view_find_command(this, buffer, inherit);
  123. /* job done */
  124. if (!cmd)
  125. break;
  126. result = cmd;
  127. /* ready for the next word */
  128. lub_string_cat(&buffer, " ");
  129. }
  130. /* free up our dynamic storage */
  131. lub_string_free(buffer);
  132. lub_argv_delete(argv);
  133. return result;
  134. }
  135. /*--------------------------------------------------------- */
  136. clish_command_t *clish_view_resolve_command(clish_view_t *this,
  137. const char *line, bool_t inherit)
  138. {
  139. clish_command_t *result = clish_view_resolve_prefix(this, line, inherit);
  140. if (result) {
  141. clish_action_t *action = clish_command__get_action(result);
  142. clish_config_t *config = clish_command__get_config(result);
  143. if (!clish_action__get_script(action) &&
  144. (!clish_action__get_builtin(action)) &&
  145. (CLISH_CONFIG_NONE == clish_config__get_op(config)) &&
  146. (!clish_command__get_param_count(result)) &&
  147. (!clish_command__get_viewname(result))) {
  148. /* if this doesn't do anything we've
  149. * not resolved a command
  150. */
  151. result = NULL;
  152. }
  153. }
  154. return result;
  155. }
  156. /*--------------------------------------------------------- */
  157. clish_command_t *clish_view_find_command(clish_view_t * this,
  158. const char *name, bool_t inherit)
  159. {
  160. clish_command_t *result = NULL;
  161. /* Search the current view */
  162. result = lub_bintree_find(&this->tree, name);
  163. if (inherit) {
  164. lub_list_node_t *iter;
  165. clish_command_t *cmd;
  166. clish_nspace_t *nspace;
  167. /* Iterate elements. It's important to iterate
  168. * items starting from tail bacause the next
  169. * NAMESPACE has higher priority than previous one
  170. * in a case then the both NAMESPACEs have the
  171. * commands with the same name.
  172. */
  173. for(iter = lub_list__get_tail(this->nspaces);
  174. iter; iter = lub_list_node__get_prev(iter)) {
  175. nspace = (clish_nspace_t *)lub_list_node__get_data(iter);
  176. cmd = clish_nspace_find_command(nspace, name);
  177. /* Choose the longest match */
  178. result = clish_command_choose_longest(result, cmd);
  179. }
  180. }
  181. return result;
  182. }
  183. /*--------------------------------------------------------- */
  184. static const clish_command_t *find_next_completion(clish_view_t * this,
  185. const char *iter_cmd, const char *line)
  186. {
  187. clish_command_t *cmd;
  188. const char *name = "";
  189. lub_argv_t *largv;
  190. unsigned words;
  191. /* build an argument vector for the line */
  192. largv = lub_argv_new(line, 0);
  193. words = lub_argv__get_count(largv);
  194. /* account for trailing space */
  195. if (!*line || lub_ctype_isspace(line[strlen(line) - 1]))
  196. words++;
  197. if (iter_cmd)
  198. name = iter_cmd;
  199. while ((cmd = lub_bintree_findnext(&this->tree, name))) {
  200. name = clish_command__get_name(cmd);
  201. if (words == lub_string_wordcount(name)) {
  202. /* only bother with commands of which this line is a prefix */
  203. /* this is a completion */
  204. if (lub_string_nocasestr(name, line) == name)
  205. break;
  206. }
  207. }
  208. /* clean up the dynamic memory */
  209. lub_argv_delete(largv);
  210. return cmd;
  211. }
  212. /*--------------------------------------------------------- */
  213. const clish_command_t *clish_view_find_next_completion(clish_view_t * this,
  214. const char *iter_cmd, const char *line,
  215. clish_nspace_visibility_e field, bool_t inherit)
  216. {
  217. const clish_command_t *result, *cmd;
  218. clish_nspace_t *nspace;
  219. lub_list_node_t *iter;
  220. /* ask local view for next command */
  221. result = find_next_completion(this, iter_cmd, line);
  222. if (!inherit)
  223. return result;
  224. /* ask the imported namespaces for next command */
  225. /* Iterate elements */
  226. for(iter = lub_list__get_tail(this->nspaces);
  227. iter; iter = lub_list_node__get_prev(iter)) {
  228. nspace = (clish_nspace_t *)lub_list_node__get_data(iter);
  229. if (!clish_nspace__get_visibility(nspace, field))
  230. continue;
  231. cmd = clish_nspace_find_next_completion(nspace,
  232. iter_cmd, line, field);
  233. if (clish_command_diff(result, cmd) > 0)
  234. result = cmd;
  235. }
  236. return result;
  237. }
  238. /*--------------------------------------------------------- */
  239. void clish_view_insert_nspace(clish_view_t * this, clish_nspace_t * nspace)
  240. {
  241. lub_list_add(this->nspaces, nspace);
  242. }
  243. /*--------------------------------------------------------- */
  244. void clish_view_clean_proxy(clish_view_t * this)
  245. {
  246. lub_list_node_t *iter;
  247. /* Iterate elements */
  248. for(iter = lub_list__get_head(this->nspaces);
  249. iter; iter = lub_list_node__get_next(iter)) {
  250. clish_nspace_clean_proxy((clish_nspace_t *)lub_list_node__get_data(iter));
  251. }
  252. }
  253. /*--------------------------------------------------------- */
  254. int clish_view_insert_hotkey(const clish_view_t *this, const char *key, const char *cmd)
  255. {
  256. return clish_hotkeyv_insert(this->hotkeys, key, cmd);
  257. }
  258. /*--------------------------------------------------------- */
  259. const char *clish_view_find_hotkey(const clish_view_t *this, int code)
  260. {
  261. return clish_hotkeyv_cmd_by_code(this->hotkeys, code);
  262. }
  263. CLISH_GET(view, lub_list_t *, nspaces);
  264. CLISH_GET_STR(view, name);
  265. CLISH_SET_STR_ONCE(view, prompt);
  266. CLISH_GET_STR(view, prompt);
  267. CLISH_SET_STR(view, access);
  268. CLISH_GET_STR(view, access);
  269. CLISH_SET(view, unsigned int, depth);
  270. CLISH_GET(view, unsigned int, depth);
  271. CLISH_SET(view, clish_view_restore_e, restore);
  272. CLISH_GET(view, clish_view_restore_e, restore);
  273. /*-------------------------------------------------------- */
  274. lub_bintree_t * clish_view__get_tree(clish_view_t *inst)
  275. {
  276. assert(inst);
  277. return &inst->tree;
  278. }