1
0

command.c 13 KB

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