command.c 13 KB

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