1
0

command.c 15 KB

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