command.c 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468
  1. /*
  2. * command.c
  3. *
  4. * This file provides the implementation of a command definition
  5. */
  6. #include "private.h"
  7. #include "clish/types.h"
  8. #include "lub/bintree.h"
  9. #include "lub/string.h"
  10. #include <assert.h>
  11. #include <stdlib.h>
  12. #include <string.h>
  13. #include <stdio.h>
  14. /*---------------------------------------------------------
  15. * PRIVATE METHODS
  16. *--------------------------------------------------------- */
  17. static void
  18. clish_command_init(clish_command_t *this, const char *name, const char *text)
  19. {
  20. /* initialise the node part */
  21. this->name = lub_string_dup(name);
  22. this->text = lub_string_dup(text);
  23. /* Be a good binary tree citizen */
  24. lub_bintree_node_init(&this->bt_node);
  25. /* set up defaults */
  26. this->link = NULL;
  27. this->alias = NULL;
  28. this->alias_view = NULL;
  29. this->paramv = clish_paramv_new();
  30. this->viewid = NULL;
  31. this->viewname = NULL;
  32. this->action = clish_action_new();
  33. this->config = clish_config_new();
  34. this->detail = NULL;
  35. this->escape_chars = NULL;
  36. this->regex_chars = NULL;
  37. this->args = NULL;
  38. this->pview = NULL;
  39. this->lock = BOOL_TRUE;
  40. this->interrupt = BOOL_FALSE;
  41. this->dynamic = BOOL_FALSE;
  42. }
  43. /*--------------------------------------------------------- */
  44. static void clish_command_fini(clish_command_t * this)
  45. {
  46. lub_string_free(this->name);
  47. lub_string_free(this->text);
  48. /* Link need not full cleanup */
  49. if (this->link)
  50. return;
  51. /* finalize each of the parameter instances */
  52. clish_paramv_delete(this->paramv);
  53. clish_action_delete(this->action);
  54. clish_config_delete(this->config);
  55. lub_string_free(this->alias);
  56. lub_string_free(this->viewname);
  57. lub_string_free(this->viewid);
  58. lub_string_free(this->detail);
  59. lub_string_free(this->escape_chars);
  60. lub_string_free(this->regex_chars);
  61. if (this->args)
  62. clish_param_delete(this->args);
  63. }
  64. /*---------------------------------------------------------
  65. * PUBLIC META FUNCTIONS
  66. *--------------------------------------------------------- */
  67. size_t clish_command_bt_offset(void)
  68. {
  69. return offsetof(clish_command_t, bt_node);
  70. }
  71. /*--------------------------------------------------------- */
  72. int clish_command_bt_compare(const void *clientnode, const void *clientkey)
  73. {
  74. const clish_command_t *this = clientnode;
  75. const char *key = clientkey;
  76. return lub_string_nocasecmp(this->name, key);
  77. }
  78. /*--------------------------------------------------------- */
  79. void clish_command_bt_getkey(const void *clientnode, lub_bintree_key_t * key)
  80. {
  81. const clish_command_t *this = clientnode;
  82. /* fill out the opaque key */
  83. strcpy((char *)key, this->name);
  84. }
  85. /*--------------------------------------------------------- */
  86. clish_command_t *clish_command_new(const char *name, const char *help)
  87. {
  88. clish_command_t *this = malloc(sizeof(clish_command_t));
  89. if (this)
  90. clish_command_init(this, name, help);
  91. return this;
  92. }
  93. /*--------------------------------------------------------- */
  94. clish_command_t *clish_command_new_link(const char *name,
  95. const char *help, const clish_command_t * ref)
  96. {
  97. if (!ref)
  98. return NULL;
  99. clish_command_t *this = malloc(sizeof(clish_command_t));
  100. assert(this);
  101. /* Copy all fields to the new command-link */
  102. *this = *ref;
  103. /* Initialise the name (other than original name) */
  104. this->name = lub_string_dup(name);
  105. /* Initialise the name (other than original name) */
  106. this->text = lub_string_dup(help);
  107. /* Be a good binary tree citizen */
  108. lub_bintree_node_init(&this->bt_node);
  109. /* It a link to command so set the link flag */
  110. this->link = ref;
  111. return this;
  112. }
  113. /*--------------------------------------------------------- */
  114. clish_command_t * clish_command_alias_to_link(clish_command_t * this)
  115. {
  116. clish_command_t * ref;
  117. clish_command_t tmp;
  118. if (!this || !this->alias)
  119. return this;
  120. assert(this->alias_view);
  121. ref = clish_view_find_command(this->alias_view, this->alias, BOOL_FALSE);
  122. if (!ref)
  123. return this;
  124. memcpy(&tmp, this, sizeof(tmp));
  125. *this = *ref;
  126. memcpy(&this->bt_node, &tmp.bt_node, sizeof(tmp.bt_node));
  127. this->name = lub_string_dup(tmp.name);
  128. this->text = lub_string_dup(tmp.text);
  129. this->link = ref;
  130. clish_command_fini(&tmp);
  131. return this;
  132. }
  133. /*---------------------------------------------------------
  134. * PUBLIC METHODS
  135. *--------------------------------------------------------- */
  136. void clish_command_delete(clish_command_t * this)
  137. {
  138. clish_command_fini(this);
  139. free(this);
  140. }
  141. /*--------------------------------------------------------- */
  142. void clish_command_insert_param(clish_command_t * this, clish_param_t * param)
  143. {
  144. clish_paramv_insert(this->paramv, param);
  145. }
  146. /*--------------------------------------------------------- */
  147. int clish_command_help(const clish_command_t *this)
  148. {
  149. return 0;
  150. }
  151. /*--------------------------------------------------------- */
  152. clish_command_t *clish_command_choose_longest(clish_command_t * cmd1,
  153. clish_command_t * cmd2)
  154. {
  155. unsigned len1 = (cmd1 ? strlen(clish_command__get_name(cmd1)) : 0);
  156. unsigned len2 = (cmd2 ? strlen(clish_command__get_name(cmd2)) : 0);
  157. if (len2 < len1) {
  158. return cmd1;
  159. } else if (len1 < len2) {
  160. return cmd2;
  161. } else {
  162. /* let local view override */
  163. return cmd1;
  164. }
  165. }
  166. /*--------------------------------------------------------- */
  167. int clish_command_diff(const clish_command_t * cmd1,
  168. const clish_command_t * cmd2)
  169. {
  170. if (NULL == cmd1) {
  171. if (NULL != cmd2)
  172. return 1;
  173. else
  174. return 0;
  175. }
  176. if (NULL == cmd2)
  177. return -1;
  178. return lub_string_nocasecmp(clish_command__get_name(cmd1),
  179. clish_command__get_name(cmd2));
  180. }
  181. /*---------------------------------------------------------
  182. * PUBLIC ATTRIBUTES
  183. *--------------------------------------------------------- */
  184. const char *clish_command__get_name(const clish_command_t * this)
  185. {
  186. if (!this)
  187. return NULL;
  188. return this->name;
  189. }
  190. /*--------------------------------------------------------- */
  191. const char *clish_command__get_text(const clish_command_t * this)
  192. {
  193. return this->text;
  194. }
  195. /*--------------------------------------------------------- */
  196. const char *clish_command__get_detail(const clish_command_t * this)
  197. {
  198. return this->detail;
  199. }
  200. /*--------------------------------------------------------- */
  201. void clish_command__set_detail(clish_command_t * this, const char *detail)
  202. {
  203. assert(NULL == this->detail);
  204. this->detail = lub_string_dup(detail);
  205. }
  206. /*--------------------------------------------------------- */
  207. clish_action_t *clish_command__get_action(const clish_command_t *this)
  208. {
  209. return this->action;
  210. }
  211. /*--------------------------------------------------------- */
  212. clish_config_t *clish_command__get_config(const clish_command_t *this)
  213. {
  214. return this->config;
  215. }
  216. /*--------------------------------------------------------- */
  217. void clish_command__set_viewname(clish_command_t * this, const char *viewname)
  218. {
  219. assert(NULL == this->viewname);
  220. clish_command__force_viewname(this, viewname);
  221. }
  222. /*--------------------------------------------------------- */
  223. void clish_command__force_viewname(clish_command_t * this, const char *viewname)
  224. {
  225. if (this->viewname)
  226. lub_string_free(this->viewname);
  227. this->viewname = lub_string_dup(viewname);
  228. }
  229. /*--------------------------------------------------------- */
  230. char *clish_command__get_viewname(const clish_command_t * this)
  231. {
  232. return this->viewname;
  233. }
  234. /*--------------------------------------------------------- */
  235. void clish_command__set_viewid(clish_command_t * this, const char *viewid)
  236. {
  237. assert(NULL == this->viewid);
  238. clish_command__force_viewid(this, viewid);
  239. }
  240. /*--------------------------------------------------------- */
  241. void clish_command__force_viewid(clish_command_t * this, const char *viewid)
  242. {
  243. if (this->viewid)
  244. lub_string_free(this->viewid);
  245. this->viewid = lub_string_dup(viewid);
  246. }
  247. /*--------------------------------------------------------- */
  248. char *clish_command__get_viewid(const clish_command_t * this)
  249. {
  250. return this->viewid;
  251. }
  252. /*--------------------------------------------------------- */
  253. const clish_param_t *clish_command__get_param(const clish_command_t * this,
  254. unsigned index)
  255. {
  256. return clish_paramv__get_param(this->paramv, index);
  257. }
  258. /*--------------------------------------------------------- */
  259. const char *clish_command__get_suffix(const clish_command_t * this)
  260. {
  261. return lub_string_suffix(this->name);
  262. }
  263. /*--------------------------------------------------------- */
  264. void
  265. clish_command__set_escape_chars(clish_command_t * this,
  266. const char *escape_chars)
  267. {
  268. assert(!this->escape_chars);
  269. this->escape_chars = lub_string_dup(escape_chars);
  270. }
  271. /*--------------------------------------------------------- */
  272. const char *clish_command__get_escape_chars(const clish_command_t * this)
  273. {
  274. return this->escape_chars;
  275. }
  276. /*--------------------------------------------------------- */
  277. void clish_command__set_regex_chars(clish_command_t *this,
  278. const char *escape_chars)
  279. {
  280. assert(!this->regex_chars);
  281. this->regex_chars = lub_string_dup(escape_chars);
  282. }
  283. /*--------------------------------------------------------- */
  284. const char *clish_command__get_regex_chars(const clish_command_t *this)
  285. {
  286. return this->regex_chars;
  287. }
  288. /*--------------------------------------------------------- */
  289. void clish_command__set_args(clish_command_t * this, clish_param_t * args)
  290. {
  291. assert(NULL == this->args);
  292. this->args = args;
  293. }
  294. /*--------------------------------------------------------- */
  295. const clish_param_t *clish_command__get_args(const clish_command_t * this)
  296. {
  297. return this->args;
  298. }
  299. /*--------------------------------------------------------- */
  300. unsigned int clish_command__get_param_count(const clish_command_t * this)
  301. {
  302. return clish_paramv__get_count(this->paramv);
  303. }
  304. /*--------------------------------------------------------- */
  305. clish_paramv_t *clish_command__get_paramv(const clish_command_t * this)
  306. {
  307. return this->paramv;
  308. }
  309. /*--------------------------------------------------------- */
  310. void clish_command__set_pview(clish_command_t * this, clish_view_t * view)
  311. {
  312. this->pview = view;
  313. }
  314. /*--------------------------------------------------------- */
  315. clish_view_t *clish_command__get_pview(const clish_command_t * this)
  316. {
  317. return this->pview;
  318. }
  319. /*--------------------------------------------------------- */
  320. unsigned clish_command__get_depth(const clish_command_t * this)
  321. {
  322. if (!this->pview)
  323. return 0;
  324. return clish_view__get_depth(this->pview);
  325. }
  326. /*--------------------------------------------------------- */
  327. clish_view_restore_t clish_command__get_restore(const clish_command_t * this)
  328. {
  329. if (!this->pview)
  330. return CLISH_RESTORE_NONE;
  331. return clish_view__get_restore(this->pview);
  332. }
  333. /*--------------------------------------------------------- */
  334. const clish_command_t * clish_command__get_orig(const clish_command_t * this)
  335. {
  336. if (this->link)
  337. return clish_command__get_orig(this->link);
  338. return this;
  339. }
  340. /*--------------------------------------------------------- */
  341. bool_t clish_command__get_lock(const clish_command_t * this)
  342. {
  343. return this->lock;
  344. }
  345. /*--------------------------------------------------------- */
  346. void clish_command__set_lock(clish_command_t * this, bool_t lock)
  347. {
  348. this->lock = lock;
  349. }
  350. /*--------------------------------------------------------- */
  351. void clish_command__set_alias(clish_command_t * this, const char * alias)
  352. {
  353. assert(!this->alias);
  354. this->alias = lub_string_dup(alias);
  355. }
  356. /*--------------------------------------------------------- */
  357. const char * clish_command__get_alias(const clish_command_t * this)
  358. {
  359. return this->alias;
  360. }
  361. /*--------------------------------------------------------- */
  362. void clish_command__set_alias_view(clish_command_t * this,
  363. clish_view_t * alias_view)
  364. {
  365. this->alias_view = alias_view;
  366. }
  367. /*--------------------------------------------------------- */
  368. clish_view_t * clish_command__get_alias_view(const clish_command_t * this)
  369. {
  370. return this->alias_view;
  371. }
  372. /*--------------------------------------------------------- */
  373. void clish_command__set_dynamic(clish_command_t * this, bool_t dynamic)
  374. {
  375. this->dynamic = dynamic;
  376. }
  377. /*--------------------------------------------------------- */
  378. bool_t clish_command__get_dynamic(const clish_command_t * this)
  379. {
  380. return this->dynamic;
  381. }
  382. /*--------------------------------------------------------- */
  383. const clish_command_t * clish_command__get_cmd(const clish_command_t * this)
  384. {
  385. if (!this->dynamic)
  386. return this;
  387. if (this->link)
  388. return clish_command__get_cmd(this->link);
  389. return NULL;
  390. }
  391. /*--------------------------------------------------------- */
  392. bool_t clish_command__get_interrupt(const clish_command_t * this)
  393. {
  394. return this->interrupt;
  395. }
  396. /*--------------------------------------------------------- */
  397. void clish_command__set_interrupt(clish_command_t * this, bool_t interrupt)
  398. {
  399. this->interrupt = interrupt;
  400. }