command.c 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729
  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->alias = NULL;
  28. this->alias_view = NULL;
  29. this->paramv = clish_paramv_new();
  30. this->viewid = NULL;
  31. this->view = NULL;
  32. this->action = NULL;
  33. this->detail = NULL;
  34. this->escape_chars = NULL;
  35. this->args = NULL;
  36. this->pview = NULL;
  37. this->lock = BOOL_TRUE;
  38. this->interrupt = BOOL_FALSE;
  39. this->dynamic = BOOL_FALSE;
  40. /* ACTION params */
  41. this->builtin = NULL;
  42. this->shebang = NULL;
  43. /* CONFIG params */
  44. this->cfg_op = CLISH_CONFIG_NONE;
  45. this->priority = 0; /* medium priority by default */
  46. this->pattern = NULL;
  47. this->file = NULL;
  48. this->splitter = BOOL_TRUE;
  49. this->seq = NULL;
  50. this->unique = BOOL_TRUE;
  51. this->cfg_depth = NULL;
  52. }
  53. /*--------------------------------------------------------- */
  54. static void clish_command_fini(clish_command_t * this)
  55. {
  56. lub_string_free(this->name);
  57. this->name = NULL;
  58. lub_string_free(this->text);
  59. this->text = NULL;
  60. /* Link need not full cleanup */
  61. if (this->link)
  62. return;
  63. /* finalize each of the parameter instances */
  64. clish_paramv_delete(this->paramv);
  65. lub_string_free(this->alias);
  66. this->alias = NULL;
  67. lub_string_free(this->viewid);
  68. this->viewid = NULL;
  69. lub_string_free(this->action);
  70. this->action = NULL;
  71. lub_string_free(this->detail);
  72. this->detail = NULL;
  73. lub_string_free(this->builtin);
  74. this->builtin = NULL;
  75. lub_string_free(this->shebang);
  76. this->shebang = NULL;
  77. lub_string_free(this->escape_chars);
  78. this->escape_chars = NULL;
  79. if (NULL != this->args) {
  80. clish_param_delete(this->args);
  81. this->args = NULL;
  82. }
  83. this->pview = NULL;
  84. lub_string_free(this->pattern);
  85. this->pattern = NULL;
  86. lub_string_free(this->file);
  87. this->file = NULL;
  88. lub_string_free(this->seq);
  89. this->seq = NULL;
  90. lub_string_free(this->cfg_depth);
  91. this->cfg_depth = NULL;
  92. }
  93. /*---------------------------------------------------------
  94. * PUBLIC META FUNCTIONS
  95. *--------------------------------------------------------- */
  96. size_t clish_command_bt_offset(void)
  97. {
  98. return offsetof(clish_command_t, bt_node);
  99. }
  100. /*--------------------------------------------------------- */
  101. int clish_command_bt_compare(const void *clientnode, const void *clientkey)
  102. {
  103. const clish_command_t *this = clientnode;
  104. const char *key = clientkey;
  105. return lub_string_nocasecmp(this->name, key);
  106. }
  107. /*--------------------------------------------------------- */
  108. void clish_command_bt_getkey(const void *clientnode, lub_bintree_key_t * key)
  109. {
  110. const clish_command_t *this = clientnode;
  111. /* fill out the opaque key */
  112. strcpy((char *)key, this->name);
  113. }
  114. /*--------------------------------------------------------- */
  115. clish_command_t *clish_command_new(const char *name, const char *help)
  116. {
  117. clish_command_t *this = malloc(sizeof(clish_command_t));
  118. if (this) {
  119. clish_command_init(this, name, help);
  120. }
  121. return this;
  122. }
  123. /*--------------------------------------------------------- */
  124. clish_command_t *clish_command_new_link(const char *name,
  125. const char *help, const clish_command_t * ref)
  126. {
  127. if (!ref)
  128. return NULL;
  129. clish_command_t *this = malloc(sizeof(clish_command_t));
  130. assert(this);
  131. /* Copy all fields to the new command-link */
  132. *this = *ref;
  133. /* Initialise the name (other than original name) */
  134. this->name = lub_string_dup(name);
  135. /* Initialise the name (other than original name) */
  136. this->text = lub_string_dup(help);
  137. /* Be a good binary tree citizen */
  138. lub_bintree_node_init(&this->bt_node);
  139. /* It a link to command so set the link flag */
  140. this->link = ref;
  141. return this;
  142. }
  143. /*--------------------------------------------------------- */
  144. clish_command_t * clish_command_alias_to_link(clish_command_t * this)
  145. {
  146. clish_command_t * ref;
  147. clish_command_t tmp;
  148. if (!this || !this->alias)
  149. return this;
  150. assert(this->alias_view);
  151. ref = clish_view_find_command(this->alias_view, this->alias, BOOL_FALSE);
  152. if (!ref)
  153. return this;
  154. memcpy(&tmp, this, sizeof(tmp));
  155. *this = *ref;
  156. memcpy(&this->bt_node, &tmp.bt_node, sizeof(tmp.bt_node));
  157. this->name = lub_string_dup(tmp.name);
  158. this->text = lub_string_dup(tmp.text);
  159. this->link = ref;
  160. clish_command_fini(&tmp);
  161. return this;
  162. }
  163. /*---------------------------------------------------------
  164. * PUBLIC METHODS
  165. *--------------------------------------------------------- */
  166. void clish_command_delete(clish_command_t * this)
  167. {
  168. clish_command_fini(this);
  169. free(this);
  170. }
  171. /*--------------------------------------------------------- */
  172. void clish_command_insert_param(clish_command_t * this, clish_param_t * param)
  173. {
  174. clish_paramv_insert(this->paramv, param);
  175. }
  176. /*--------------------------------------------------------- */
  177. void clish_command_help(const clish_command_t * this, const char * viewid,
  178. const char * line)
  179. {
  180. const char *name = clish_command__get_name(this);
  181. unsigned index = lub_argv_wordcount(line);
  182. unsigned idx = lub_argv_wordcount(name);
  183. lub_argv_t *argv;
  184. clish_pargv_t *last, *pargv;
  185. unsigned i;
  186. unsigned cnt = 0;
  187. unsigned longest = 0;
  188. if (0 == index)
  189. return;
  190. /* Line has no any parameters */
  191. if (strlen(line) <= strlen(name)) {
  192. fprintf(stderr, " %s %s\n", name,
  193. clish_command__get_text(this));
  194. return;
  195. }
  196. if (line[strlen(line) - 1] != ' ')
  197. index--;
  198. argv = lub_argv_new(line, 0);
  199. /* get the parameter definition */
  200. last = clish_pargv_create();
  201. pargv = clish_pargv_create();
  202. clish_pargv_parse(pargv, this, viewid, this->paramv,
  203. argv, &idx, last, index);
  204. clish_pargv_delete(pargv);
  205. cnt = clish_pargv__get_count(last);
  206. /* Calculate the longest name */
  207. for (i = 0; i < cnt; i++) {
  208. const clish_param_t *param;
  209. const char *name;
  210. unsigned clen = 0;
  211. param = clish_pargv__get_param(last, i);
  212. if (CLISH_PARAM_SUBCOMMAND == clish_param__get_mode(param))
  213. name = clish_param__get_value(param);
  214. else
  215. name = clish_ptype__get_text(clish_param__get_ptype(param));
  216. if (name)
  217. clen = strlen(name);
  218. if (clen > longest)
  219. longest = clen;
  220. }
  221. for (i = 0; i < cnt; i++)
  222. clish_param_help(clish_pargv__get_param(last, i), longest + 1);
  223. clish_pargv_delete(last);
  224. lub_argv_delete(argv);
  225. }
  226. /*--------------------------------------------------------- */
  227. clish_command_t *clish_command_choose_longest(clish_command_t * cmd1,
  228. clish_command_t * cmd2)
  229. {
  230. unsigned len1 = (cmd1 ? strlen(clish_command__get_name(cmd1)) : 0);
  231. unsigned len2 = (cmd2 ? strlen(clish_command__get_name(cmd2)) : 0);
  232. if (len2 < len1) {
  233. return cmd1;
  234. } else if (len1 < len2) {
  235. return cmd2;
  236. } else {
  237. /* let local view override */
  238. return cmd1;
  239. }
  240. }
  241. /*--------------------------------------------------------- */
  242. int
  243. clish_command_diff(const clish_command_t * cmd1, const clish_command_t * cmd2)
  244. {
  245. if (NULL == cmd1) {
  246. if (NULL != cmd2) {
  247. return 1;
  248. } else {
  249. return 0;
  250. }
  251. }
  252. if (NULL == cmd2) {
  253. return -1;
  254. }
  255. return lub_string_nocasecmp(clish_command__get_name(cmd1),
  256. clish_command__get_name(cmd2));
  257. }
  258. /*---------------------------------------------------------
  259. * PUBLIC ATTRIBUTES
  260. *--------------------------------------------------------- */
  261. const char *clish_command__get_name(const clish_command_t * this)
  262. {
  263. if (!this)
  264. return NULL;
  265. return this->name;
  266. }
  267. /*--------------------------------------------------------- */
  268. const char *clish_command__get_text(const clish_command_t * this)
  269. {
  270. return this->text;
  271. }
  272. /*--------------------------------------------------------- */
  273. void clish_command__set_action(clish_command_t * this, const char *action)
  274. {
  275. assert(NULL == this->action);
  276. this->action = lub_string_dup(action);
  277. }
  278. /*--------------------------------------------------------- */
  279. const char *clish_command__get_detail(const clish_command_t * this)
  280. {
  281. return this->detail;
  282. }
  283. /*--------------------------------------------------------- */
  284. void clish_command__set_detail(clish_command_t * this, const char *detail)
  285. {
  286. assert(NULL == this->detail);
  287. this->detail = lub_string_dup(detail);
  288. }
  289. /*--------------------------------------------------------- */
  290. char *clish_command__get_action(const clish_command_t * this,
  291. const char *viewid, clish_pargv_t * pargv)
  292. {
  293. return clish_variable_expand(this->action, viewid, this, pargv);
  294. }
  295. /*--------------------------------------------------------- */
  296. void clish_command__set_view(clish_command_t * this, clish_view_t * view)
  297. {
  298. assert(NULL == this->view);
  299. clish_command__force_view(this, view);
  300. }
  301. /*--------------------------------------------------------- */
  302. void clish_command__force_view(clish_command_t * this, clish_view_t * view)
  303. {
  304. this->view = view;
  305. }
  306. /*--------------------------------------------------------- */
  307. clish_view_t *clish_command__get_view(const clish_command_t * this)
  308. {
  309. return this->view;
  310. }
  311. /*--------------------------------------------------------- */
  312. void clish_command__set_viewid(clish_command_t * this, const char *viewid)
  313. {
  314. assert(NULL == this->viewid);
  315. clish_command__force_viewid(this, viewid);
  316. }
  317. /*--------------------------------------------------------- */
  318. void clish_command__force_viewid(clish_command_t * this, const char *viewid)
  319. {
  320. this->viewid = lub_string_dup(viewid);
  321. }
  322. /*--------------------------------------------------------- */
  323. char *clish_command__get_viewid(const clish_command_t * this,
  324. const char *viewid, clish_pargv_t * pargv)
  325. {
  326. return clish_variable_expand(this->viewid, viewid, this, pargv);
  327. }
  328. /*--------------------------------------------------------- */
  329. const clish_param_t *clish_command__get_param(const clish_command_t * this,
  330. unsigned index)
  331. {
  332. return clish_paramv__get_param(this->paramv, index);
  333. }
  334. /*--------------------------------------------------------- */
  335. const char *clish_command__get_suffix(const clish_command_t * this)
  336. {
  337. return lub_string_suffix(this->name);
  338. }
  339. /*--------------------------------------------------------- */
  340. void clish_command__set_builtin(clish_command_t * this, const char *builtin)
  341. {
  342. assert(NULL == this->builtin);
  343. this->builtin = lub_string_dup(builtin);
  344. }
  345. /*--------------------------------------------------------- */
  346. const char *clish_command__get_builtin(const clish_command_t * this)
  347. {
  348. return this->builtin;
  349. }
  350. /*--------------------------------------------------------- */
  351. void
  352. clish_command__set_escape_chars(clish_command_t * this,
  353. const char *escape_chars)
  354. {
  355. assert(NULL == this->escape_chars);
  356. this->escape_chars = lub_string_dup(escape_chars);
  357. }
  358. /*--------------------------------------------------------- */
  359. const char *clish_command__get_escape_chars(const clish_command_t * this)
  360. {
  361. return this->escape_chars;
  362. }
  363. /*--------------------------------------------------------- */
  364. void clish_command__set_args(clish_command_t * this, clish_param_t * args)
  365. {
  366. assert(NULL == this->args);
  367. this->args = args;
  368. }
  369. /*--------------------------------------------------------- */
  370. const clish_param_t *clish_command__get_args(const clish_command_t * this)
  371. {
  372. return this->args;
  373. }
  374. /*--------------------------------------------------------- */
  375. const unsigned clish_command__get_param_count(const clish_command_t * this)
  376. {
  377. return clish_paramv__get_count(this->paramv);
  378. }
  379. /*--------------------------------------------------------- */
  380. clish_paramv_t *clish_command__get_paramv(const clish_command_t * this)
  381. {
  382. return this->paramv;
  383. }
  384. /*--------------------------------------------------------- */
  385. void clish_command__set_pview(clish_command_t * this, clish_view_t * view)
  386. {
  387. this->pview = view;
  388. }
  389. /*--------------------------------------------------------- */
  390. clish_view_t *clish_command__get_pview(const clish_command_t * this)
  391. {
  392. return this->pview;
  393. }
  394. /*--------------------------------------------------------- */
  395. unsigned clish_command__get_depth(const clish_command_t * this)
  396. {
  397. if (!this->pview)
  398. return 0;
  399. return clish_view__get_depth(this->pview);
  400. }
  401. /*--------------------------------------------------------- */
  402. void
  403. clish_command__set_cfg_op(clish_command_t * this,
  404. clish_config_operation_t operation)
  405. {
  406. this->cfg_op = operation;
  407. }
  408. /*--------------------------------------------------------- */
  409. clish_config_operation_t clish_command__get_cfg_op(const clish_command_t * this)
  410. {
  411. return this->cfg_op;
  412. }
  413. /*--------------------------------------------------------- */
  414. void clish_command__set_priority(clish_command_t * this, unsigned short priority)
  415. {
  416. this->priority = priority;
  417. }
  418. /*--------------------------------------------------------- */
  419. unsigned short clish_command__get_priority(const clish_command_t * this)
  420. {
  421. return this->priority;
  422. }
  423. /*--------------------------------------------------------- */
  424. void clish_command__set_pattern(clish_command_t * this, const char *pattern)
  425. {
  426. assert(NULL == this->pattern);
  427. this->pattern = lub_string_dup(pattern);
  428. }
  429. /*--------------------------------------------------------- */
  430. char *clish_command__get_pattern(const clish_command_t * this,
  431. const char *viewid, clish_pargv_t * pargv)
  432. {
  433. return clish_variable_expand(this->pattern, viewid, this, pargv);
  434. }
  435. /*--------------------------------------------------------- */
  436. void clish_command__set_file(clish_command_t * this, const char *file)
  437. {
  438. assert(NULL == this->file);
  439. this->file = lub_string_dup(file);
  440. }
  441. /*--------------------------------------------------------- */
  442. char *clish_command__get_file(const clish_command_t * this,
  443. const char *viewid, clish_pargv_t * pargv)
  444. {
  445. return clish_variable_expand(this->file, viewid, this, pargv);
  446. }
  447. /*--------------------------------------------------------- */
  448. bool_t clish_command__get_splitter(const clish_command_t * this)
  449. {
  450. return this->splitter;
  451. }
  452. /*--------------------------------------------------------- */
  453. void clish_command__set_splitter(clish_command_t * this, bool_t splitter)
  454. {
  455. this->splitter = splitter;
  456. }
  457. /*--------------------------------------------------------- */
  458. void clish_command__set_seq(clish_command_t * this, const char * seq)
  459. {
  460. assert(NULL == this->seq);
  461. this->seq = lub_string_dup(seq);
  462. }
  463. /*--------------------------------------------------------- */
  464. unsigned short clish_command__get_seq(const clish_command_t * this,
  465. const char *viewid, clish_pargv_t * pargv)
  466. {
  467. unsigned short num = 0;
  468. char *str;
  469. if (!this->seq)
  470. return 0;
  471. str = clish_variable_expand(this->seq, viewid, this, pargv);
  472. if ((str != NULL) && (*str != '\0')) {
  473. long val = 0;
  474. char *endptr;
  475. val = strtol(str, &endptr, 0);
  476. if (endptr == str)
  477. num = 0;
  478. else if (val > 0xffff)
  479. num = 0xffff;
  480. else if (val < 0)
  481. num = 0;
  482. else
  483. num = (unsigned short)val;
  484. }
  485. lub_string_free(str);
  486. return num;
  487. }
  488. /*--------------------------------------------------------- */
  489. const char * clish_command__is_seq(const clish_command_t * this)
  490. {
  491. return this->seq;
  492. }
  493. /*--------------------------------------------------------- */
  494. clish_view_restore_t clish_command__get_restore(const clish_command_t * this)
  495. {
  496. if (!this->pview)
  497. return CLISH_RESTORE_NONE;
  498. return clish_view__get_restore(this->pview);
  499. }
  500. /*--------------------------------------------------------- */
  501. bool_t clish_command__get_unique(const clish_command_t * this)
  502. {
  503. return this->unique;
  504. }
  505. /*--------------------------------------------------------- */
  506. void clish_command__set_unique(clish_command_t * this, bool_t unique)
  507. {
  508. this->unique = unique;
  509. }
  510. /*--------------------------------------------------------- */
  511. const clish_command_t * clish_command__get_orig(const clish_command_t * this)
  512. {
  513. if (this->link)
  514. return clish_command__get_orig(this->link);
  515. return this;
  516. }
  517. /*--------------------------------------------------------- */
  518. void clish_command__set_cfg_depth(clish_command_t * this, const char * cfg_depth)
  519. {
  520. assert(NULL == this->cfg_depth);
  521. this->cfg_depth = lub_string_dup(cfg_depth);
  522. }
  523. /*--------------------------------------------------------- */
  524. unsigned clish_command__get_cfg_depth(const clish_command_t * this,
  525. const char *viewid, clish_pargv_t * pargv)
  526. {
  527. unsigned num = 0;
  528. char *str;
  529. if (!this->cfg_depth)
  530. return clish_command__get_depth(this);
  531. str = clish_variable_expand(this->cfg_depth, viewid, this, pargv);
  532. if ((str != NULL) && (*str != '\0')) {
  533. long val = 0;
  534. char *endptr;
  535. val = strtol(str, &endptr, 0);
  536. if (endptr == str)
  537. num = 0;
  538. else if (val > 0xffff)
  539. num = 0xffff;
  540. else if (val < 0)
  541. num = 0;
  542. else
  543. num = (unsigned)val;
  544. }
  545. lub_string_free(str);
  546. return num;
  547. }
  548. /*--------------------------------------------------------- */
  549. bool_t clish_command__get_lock(const clish_command_t * this)
  550. {
  551. return this->lock;
  552. }
  553. /*--------------------------------------------------------- */
  554. void clish_command__set_lock(clish_command_t * this, bool_t lock)
  555. {
  556. this->lock = lock;
  557. }
  558. /*--------------------------------------------------------- */
  559. const char * clish_command__get_shebang(const clish_command_t * this)
  560. {
  561. return this->shebang;
  562. }
  563. /*--------------------------------------------------------- */
  564. void clish_command__set_shebang(clish_command_t * this, const char * shebang)
  565. {
  566. const char *prog = shebang;
  567. const char *prefix = "#!";
  568. assert(NULL == this->shebang);
  569. if (lub_string_nocasestr(shebang, prefix) == shebang)
  570. prog += strlen(prefix);
  571. this->shebang = lub_string_dup(prog);
  572. }
  573. /*--------------------------------------------------------- */
  574. void clish_command__set_alias(clish_command_t * this, const char * alias)
  575. {
  576. assert(NULL == this->alias);
  577. this->alias = lub_string_dup(alias);
  578. }
  579. /*--------------------------------------------------------- */
  580. const char * clish_command__get_alias(const clish_command_t * this)
  581. {
  582. return this->alias;
  583. }
  584. /*--------------------------------------------------------- */
  585. void clish_command__set_alias_view(clish_command_t * this,
  586. clish_view_t * alias_view)
  587. {
  588. this->alias_view = alias_view;
  589. }
  590. /*--------------------------------------------------------- */
  591. clish_view_t * clish_command__get_alias_view(const clish_command_t * this)
  592. {
  593. return this->alias_view;
  594. }
  595. /*--------------------------------------------------------- */
  596. void clish_command__set_dynamic(clish_command_t * this, bool_t dynamic)
  597. {
  598. this->dynamic = dynamic;
  599. }
  600. /*--------------------------------------------------------- */
  601. bool_t clish_command__get_dynamic(const clish_command_t * this)
  602. {
  603. return this->dynamic;
  604. }
  605. /*--------------------------------------------------------- */
  606. const clish_command_t * clish_command__get_cmd(const clish_command_t * this)
  607. {
  608. if (!this->dynamic)
  609. return this;
  610. if (this->link)
  611. return clish_command__get_cmd(this->link);
  612. return NULL;
  613. }
  614. /*--------------------------------------------------------- */
  615. bool_t clish_command__get_interrupt(const clish_command_t * this)
  616. {
  617. return this->interrupt;
  618. }
  619. /*--------------------------------------------------------- */
  620. void clish_command__set_interrupt(clish_command_t * this, bool_t interrupt)
  621. {
  622. this->interrupt = interrupt;
  623. }