1
0

command.c 12 KB

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