command.c 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550
  1. /*
  2. * command.c
  3. *
  4. * This file provides the implementation of a command definition
  5. */
  6. #include "private.h"
  7. #include "clish/variable.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->paramv = clish_paramv_new();
  28. this->viewid = NULL;
  29. this->view = NULL;
  30. this->action = NULL;
  31. this->detail = NULL;
  32. this->builtin = NULL;
  33. this->escape_chars = NULL;
  34. this->args = NULL;
  35. this->pview = NULL;
  36. /* CONFIG params */
  37. this->cfg_op = CLISH_CONFIG_NONE;
  38. this->priority = 0; /* medium priority by default */
  39. this->pattern = NULL;
  40. this->file = NULL;
  41. this->splitter = BOOL_TRUE;
  42. this->seq = NULL;
  43. this->unique = BOOL_TRUE;
  44. }
  45. /*--------------------------------------------------------- */
  46. static void clish_command_fini(clish_command_t * this)
  47. {
  48. unsigned i;
  49. lub_string_free(this->name);
  50. this->name = NULL;
  51. /* Link need not full cleanup */
  52. if (this->link)
  53. return;
  54. /* finalize each of the parameter instances */
  55. clish_paramv_delete(this->paramv);
  56. lub_string_free(this->viewid);
  57. this->viewid = NULL;
  58. lub_string_free(this->action);
  59. this->action = NULL;
  60. lub_string_free(this->text);
  61. this->text = NULL;
  62. lub_string_free(this->detail);
  63. this->detail = NULL;
  64. lub_string_free(this->builtin);
  65. this->builtin = NULL;
  66. lub_string_free(this->escape_chars);
  67. this->escape_chars = NULL;
  68. if (NULL != this->args) {
  69. clish_param_delete(this->args);
  70. this->args = NULL;
  71. }
  72. this->pview = NULL;
  73. lub_string_free(this->pattern);
  74. this->pattern = NULL;
  75. lub_string_free(this->file);
  76. this->file = NULL;
  77. lub_string_free(this->seq);
  78. this->seq = NULL;
  79. }
  80. /*---------------------------------------------------------
  81. * PUBLIC META FUNCTIONS
  82. *--------------------------------------------------------- */
  83. size_t clish_command_bt_offset(void)
  84. {
  85. return offsetof(clish_command_t, bt_node);
  86. }
  87. /*--------------------------------------------------------- */
  88. int clish_command_bt_compare(const void *clientnode, const void *clientkey)
  89. {
  90. const clish_command_t *this = clientnode;
  91. const char *key = clientkey;
  92. return lub_string_nocasecmp(this->name, key);
  93. }
  94. /*--------------------------------------------------------- */
  95. void clish_command_bt_getkey(const void *clientnode, lub_bintree_key_t * key)
  96. {
  97. const clish_command_t *this = clientnode;
  98. /* fill out the opaque key */
  99. strcpy((char *)key, this->name);
  100. }
  101. /*--------------------------------------------------------- */
  102. clish_command_t *clish_command_new(const char *name, const char *text)
  103. {
  104. clish_command_t *this = malloc(sizeof(clish_command_t));
  105. if (this) {
  106. clish_command_init(this, name, text);
  107. }
  108. return this;
  109. }
  110. /*--------------------------------------------------------- */
  111. clish_command_t *clish_command_new_link(const char *name,
  112. const clish_command_t * ref)
  113. {
  114. if (!ref)
  115. return NULL;
  116. clish_command_t *this = malloc(sizeof(clish_command_t));
  117. assert(this);
  118. /* Copy all fields to the new command-link */
  119. *this = *ref;
  120. /* Initialise the name (other than original name) */
  121. this->name = lub_string_dup(name);
  122. /* Be a good binary tree citizen */
  123. lub_bintree_node_init(&this->bt_node);
  124. /* It a link to command so set the link flag */
  125. this->link = ref;
  126. return this;
  127. }
  128. /*---------------------------------------------------------
  129. * PUBLIC METHODS
  130. *--------------------------------------------------------- */
  131. void clish_command_delete(clish_command_t * this)
  132. {
  133. clish_command_fini(this);
  134. free(this);
  135. }
  136. /*--------------------------------------------------------- */
  137. void clish_command_insert_param(clish_command_t * this, clish_param_t * param)
  138. {
  139. clish_paramv_insert(this->paramv, param);
  140. }
  141. /*--------------------------------------------------------- */
  142. void clish_command_help(const clish_command_t * this, const char *line)
  143. {
  144. const char *name = clish_command__get_name(this);
  145. unsigned index = lub_argv_wordcount(line);
  146. const clish_param_t *param;
  147. unsigned idx = lub_argv_wordcount(name);
  148. lub_argv_t *argv;
  149. clish_pargv_t *last, *pargv;
  150. unsigned i;
  151. unsigned cnt = 0;
  152. unsigned longest = 0;
  153. if (0 == index)
  154. return;
  155. /* Line has no any parameters */
  156. if (strlen(line) <= strlen(name)) {
  157. fprintf(stderr, "%s %s\n", name,
  158. clish_command__get_text(this));
  159. return;
  160. }
  161. if (line[strlen(line) - 1] != ' ')
  162. index--;
  163. argv = lub_argv_new(line, 0);
  164. /* get the parameter definition */
  165. last = clish_pargv_create();
  166. pargv = clish_pargv_create();
  167. clish_pargv_parse(pargv, this, this->paramv,
  168. argv, &idx, last, index);
  169. clish_pargv_delete(pargv);
  170. cnt = clish_pargv__get_count(last);
  171. /* Calculate the longest name */
  172. for (i = 0; i < cnt; i++) {
  173. const clish_param_t *param;
  174. const char *name;
  175. unsigned clen = 0;
  176. param = clish_pargv__get_param(last, i);
  177. if (CLISH_PARAM_SUBCOMMAND == clish_param__get_mode(param))
  178. name = clish_param__get_value(param);
  179. else
  180. name = clish_ptype__get_text(clish_param__get_ptype(param));
  181. if (name)
  182. clen = strlen(name);
  183. if (clen > longest)
  184. longest = clen;
  185. }
  186. for (i = 0; i < cnt; i++)
  187. clish_param_help(clish_pargv__get_param(last, i), longest + 1);
  188. clish_pargv_delete(last);
  189. lub_argv_delete(argv);
  190. }
  191. /*--------------------------------------------------------- */
  192. clish_command_t *clish_command_choose_longest(clish_command_t * cmd1,
  193. clish_command_t * cmd2)
  194. {
  195. unsigned len1 = (cmd1 ? strlen(clish_command__get_name(cmd1)) : 0);
  196. unsigned len2 = (cmd2 ? strlen(clish_command__get_name(cmd2)) : 0);
  197. if (len2 < len1) {
  198. return cmd1;
  199. } else if (len1 < len2) {
  200. return cmd2;
  201. } else {
  202. /* let local view override */
  203. return cmd1;
  204. }
  205. }
  206. /*--------------------------------------------------------- */
  207. int
  208. clish_command_diff(const clish_command_t * cmd1, const clish_command_t * cmd2)
  209. {
  210. if (NULL == cmd1) {
  211. if (NULL != cmd2) {
  212. return 1;
  213. } else {
  214. return 0;
  215. }
  216. }
  217. if (NULL == cmd2) {
  218. return -1;
  219. }
  220. return lub_string_nocasecmp(clish_command__get_name(cmd1),
  221. clish_command__get_name(cmd2));
  222. }
  223. /*---------------------------------------------------------
  224. * PUBLIC ATTRIBUTES
  225. *--------------------------------------------------------- */
  226. const char *clish_command__get_name(const clish_command_t * this)
  227. {
  228. return this->name;
  229. }
  230. /*--------------------------------------------------------- */
  231. const char *clish_command__get_text(const clish_command_t * this)
  232. {
  233. return this->text;
  234. }
  235. /*--------------------------------------------------------- */
  236. void clish_command__set_action(clish_command_t * this, const char *action)
  237. {
  238. assert(NULL == this->action);
  239. this->action = lub_string_dup(action);
  240. }
  241. /*--------------------------------------------------------- */
  242. const char *clish_command__get_detail(const clish_command_t * this)
  243. {
  244. return this->detail;
  245. }
  246. /*--------------------------------------------------------- */
  247. void clish_command__set_detail(clish_command_t * this, const char *detail)
  248. {
  249. assert(NULL == this->detail);
  250. this->detail = lub_string_dup(detail);
  251. }
  252. /*--------------------------------------------------------- */
  253. char *clish_command__get_action(const clish_command_t * this,
  254. const char *viewid, clish_pargv_t * pargv)
  255. {
  256. return clish_variable_expand(this->action, viewid, this, pargv);
  257. }
  258. /*--------------------------------------------------------- */
  259. void clish_command__set_view(clish_command_t * this, clish_view_t * view)
  260. {
  261. assert(NULL == this->view);
  262. this->view = view;
  263. }
  264. /*--------------------------------------------------------- */
  265. clish_view_t *clish_command__get_view(const clish_command_t * this)
  266. {
  267. return this->view;
  268. }
  269. /*--------------------------------------------------------- */
  270. void clish_command__set_viewid(clish_command_t * this, const char *viewid)
  271. {
  272. assert(NULL == this->viewid);
  273. this->viewid = lub_string_dup(viewid);
  274. }
  275. /*--------------------------------------------------------- */
  276. char *clish_command__get_viewid(const clish_command_t * this,
  277. const char *viewid, clish_pargv_t * pargv)
  278. {
  279. return clish_variable_expand(this->viewid, viewid, this, pargv);
  280. }
  281. /*--------------------------------------------------------- */
  282. const clish_param_t *clish_command__get_param(const clish_command_t * this,
  283. unsigned index)
  284. {
  285. return clish_paramv__get_param(this->paramv, index);
  286. }
  287. /*--------------------------------------------------------- */
  288. const char *clish_command__get_suffix(const clish_command_t * this)
  289. {
  290. return lub_string_suffix(this->name);
  291. }
  292. /*--------------------------------------------------------- */
  293. void clish_command__set_builtin(clish_command_t * this, const char *builtin)
  294. {
  295. assert(NULL == this->builtin);
  296. this->builtin = lub_string_dup(builtin);
  297. }
  298. /*--------------------------------------------------------- */
  299. const char *clish_command__get_builtin(const clish_command_t * this)
  300. {
  301. return this->builtin;
  302. }
  303. /*--------------------------------------------------------- */
  304. void
  305. clish_command__set_escape_chars(clish_command_t * this,
  306. const char *escape_chars)
  307. {
  308. assert(NULL == this->escape_chars);
  309. this->escape_chars = lub_string_dup(escape_chars);
  310. }
  311. /*--------------------------------------------------------- */
  312. const char *clish_command__get_escape_chars(const clish_command_t * this)
  313. {
  314. return this->escape_chars;
  315. }
  316. /*--------------------------------------------------------- */
  317. void clish_command__set_args(clish_command_t * this, clish_param_t * args)
  318. {
  319. assert(NULL == this->args);
  320. this->args = args;
  321. }
  322. /*--------------------------------------------------------- */
  323. const clish_param_t *clish_command__get_args(const clish_command_t * this)
  324. {
  325. return this->args;
  326. }
  327. /*--------------------------------------------------------- */
  328. const unsigned clish_command__get_param_count(const clish_command_t * this)
  329. {
  330. return clish_paramv__get_count(this->paramv);
  331. }
  332. /*--------------------------------------------------------- */
  333. clish_paramv_t *clish_command__get_paramv(const clish_command_t * this)
  334. {
  335. return this->paramv;
  336. }
  337. /*--------------------------------------------------------- */
  338. void clish_command__set_pview(clish_command_t * this, clish_view_t * view)
  339. {
  340. this->pview = view;
  341. }
  342. /*--------------------------------------------------------- */
  343. clish_view_t *clish_command__get_pview(const clish_command_t * this)
  344. {
  345. return this->pview;
  346. }
  347. /*--------------------------------------------------------- */
  348. unsigned clish_command__get_depth(const clish_command_t * this)
  349. {
  350. if (!this->pview)
  351. return 0;
  352. return clish_view__get_depth(this->pview);
  353. }
  354. /*--------------------------------------------------------- */
  355. void
  356. clish_command__set_cfg_op(clish_command_t * this,
  357. clish_config_operation_t operation)
  358. {
  359. this->cfg_op = operation;
  360. }
  361. /*--------------------------------------------------------- */
  362. clish_config_operation_t clish_command__get_cfg_op(const clish_command_t * this)
  363. {
  364. return this->cfg_op;
  365. }
  366. /*--------------------------------------------------------- */
  367. void clish_command__set_priority(clish_command_t * this, unsigned short priority)
  368. {
  369. this->priority = priority;
  370. }
  371. /*--------------------------------------------------------- */
  372. unsigned short clish_command__get_priority(const clish_command_t * this)
  373. {
  374. return this->priority;
  375. }
  376. /*--------------------------------------------------------- */
  377. void clish_command__set_pattern(clish_command_t * this, const char *pattern)
  378. {
  379. assert(NULL == this->pattern);
  380. this->pattern = lub_string_dup(pattern);
  381. }
  382. /*--------------------------------------------------------- */
  383. char *clish_command__get_pattern(const clish_command_t * this,
  384. const char *viewid, clish_pargv_t * pargv)
  385. {
  386. return clish_variable_expand(this->pattern, viewid, this, pargv);
  387. }
  388. /*--------------------------------------------------------- */
  389. void clish_command__set_file(clish_command_t * this, const char *file)
  390. {
  391. assert(NULL == this->file);
  392. this->file = lub_string_dup(file);
  393. }
  394. /*--------------------------------------------------------- */
  395. char *clish_command__get_file(const clish_command_t * this,
  396. const char *viewid, clish_pargv_t * pargv)
  397. {
  398. return clish_variable_expand(this->file, viewid, this, pargv);
  399. }
  400. /*--------------------------------------------------------- */
  401. bool_t clish_command__get_splitter(const clish_command_t * this)
  402. {
  403. return this->splitter;
  404. }
  405. /*--------------------------------------------------------- */
  406. void clish_command__set_splitter(clish_command_t * this, bool_t splitter)
  407. {
  408. this->splitter = splitter;
  409. }
  410. /*--------------------------------------------------------- */
  411. void clish_command__set_seq(clish_command_t * this, const char * seq)
  412. {
  413. assert(NULL == this->file);
  414. this->seq = lub_string_dup(seq);
  415. }
  416. /*--------------------------------------------------------- */
  417. unsigned short clish_command__get_seq(const clish_command_t * this,
  418. const char *viewid, clish_pargv_t * pargv)
  419. {
  420. unsigned short num = 0;
  421. char *str;
  422. if (!this->seq)
  423. return 0;
  424. str = clish_variable_expand(this->seq, viewid, this, pargv);
  425. if ((str != NULL) && (*str != '\0')) {
  426. long val = 0;
  427. char *endptr;
  428. val = strtol(str, &endptr, 0);
  429. if (endptr == str)
  430. num = 0;
  431. else if (val > 0xffff)
  432. num = 0xffff;
  433. else if (val < 0)
  434. num = 0;
  435. else
  436. num = (unsigned short)val;
  437. }
  438. lub_string_free(str);
  439. return num;
  440. }
  441. /*--------------------------------------------------------- */
  442. const char * clish_command__is_seq(const clish_command_t * this)
  443. {
  444. return this->seq;
  445. }
  446. /*--------------------------------------------------------- */
  447. clish_view_restore_t clish_command__get_restore(const clish_command_t * this)
  448. {
  449. if (!this->pview)
  450. return CLISH_RESTORE_NONE;
  451. return clish_view__get_restore(this->pview);
  452. }
  453. /*--------------------------------------------------------- */
  454. bool_t clish_command__get_unique(const clish_command_t * this)
  455. {
  456. return this->unique;
  457. }
  458. /*--------------------------------------------------------- */
  459. void clish_command__set_unique(clish_command_t * this, bool_t unique)
  460. {
  461. this->unique = unique;
  462. }
  463. /*--------------------------------------------------------- */
  464. const clish_command_t * clish_command__get_orig(const clish_command_t * this)
  465. {
  466. if (this->link)
  467. return clish_command__get_orig(this->link);
  468. return this;
  469. }