1
0

shell_tinyrl.c 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630
  1. /*
  2. * shell_tinyrl.c
  3. *
  4. * This is a specialisation of the tinyrl_t class which maps the readline
  5. * functionality to the CLISH environment.
  6. */
  7. #include "private.h"
  8. #include <stdio.h>
  9. #include <stdlib.h>
  10. #include <assert.h>
  11. #include <string.h>
  12. #include <errno.h>
  13. #include <ctype.h>
  14. #include "tinyrl/tinyrl.h"
  15. #include "tinyrl/history.h"
  16. #include "lub/string.h"
  17. /*-------------------------------------------------------- */
  18. static void clish_shell_renew_prompt(clish_shell_t *this)
  19. {
  20. clish_context_t prompt_context;
  21. char *prompt = NULL;
  22. const clish_view_t *view;
  23. char *str = NULL;
  24. /* Create appropriate context */
  25. memset(&prompt_context, 0, sizeof(prompt_context));
  26. prompt_context.shell = this;
  27. /* Obtain the prompt */
  28. view = clish_shell__get_view(this);
  29. assert(view);
  30. lub_string_cat(&str, "${_PROMPT_PREFIX}");
  31. lub_string_cat(&str, clish_view__get_prompt(view));
  32. lub_string_cat(&str, "${_PROMPT_SUFFIX}");
  33. prompt = clish_shell_expand(str, SHELL_VAR_NONE, &prompt_context);
  34. assert(prompt);
  35. lub_string_free(str);
  36. tinyrl__set_prompt(this->tinyrl, prompt);
  37. lub_string_free(prompt);
  38. }
  39. /*-------------------------------------------------------- */
  40. static bool_t clish_shell_tinyrl_key_help(tinyrl_t * this, int key)
  41. {
  42. bool_t result = BOOL_TRUE;
  43. if (tinyrl_is_quoting(this)) {
  44. /* if we are in the middle of a quote then simply enter a space */
  45. result = tinyrl_insert_text(this, "?");
  46. } else {
  47. /* get the context */
  48. clish_context_t *context = tinyrl__get_context(this);
  49. tinyrl_crlf(this);
  50. clish_shell_help(context->shell, tinyrl__get_line(this));
  51. tinyrl_crlf(this);
  52. tinyrl_reset_line_state(this);
  53. }
  54. /* keep the compiler happy */
  55. key = key;
  56. return result;
  57. }
  58. /*lint +e818 */
  59. /*-------------------------------------------------------- */
  60. /*
  61. * Expand the current line with any history substitutions
  62. */
  63. static clish_pargv_status_t clish_shell_tinyrl_expand(tinyrl_t * this)
  64. {
  65. clish_pargv_status_t status = CLISH_LINE_OK;
  66. #if 0
  67. int rtn;
  68. char *buffer;
  69. /* first of all perform any history substitutions */
  70. rtn = tinyrl_history_expand(tinyrl__get_history(this),
  71. tinyrl__get_line(this), &buffer);
  72. switch (rtn) {
  73. case -1:
  74. /* error in expansion */
  75. status = CLISH_BAD_HISTORY;
  76. break;
  77. case 0:
  78. /*no expansion */
  79. break;
  80. case 1:
  81. /* expansion occured correctly */
  82. tinyrl_replace_line(this, buffer, 1);
  83. break;
  84. case 2:
  85. /* just display line */
  86. tinyrl_printf(this, "\n%s", buffer);
  87. free(buffer);
  88. buffer = NULL;
  89. break;
  90. default:
  91. break;
  92. }
  93. free(buffer);
  94. #endif
  95. this = this;
  96. return status;
  97. }
  98. /*-------------------------------------------------------- */
  99. /*
  100. * This is a CLISH specific completion function.
  101. * If the current prefix is not a recognised prefix then
  102. * an error is flagged.
  103. * If it is a recognisable prefix then possible completions are displayed
  104. * or a unique completion is inserted.
  105. */
  106. static tinyrl_match_e clish_shell_tinyrl_complete(tinyrl_t * this)
  107. {
  108. /* context_t *context = tinyrl__get_context(this); */
  109. tinyrl_match_e status;
  110. /* first of all perform any history expansion */
  111. (void)clish_shell_tinyrl_expand(this);
  112. /* perform normal completion */
  113. status = tinyrl_complete(this);
  114. switch (status) {
  115. case TINYRL_NO_MATCH:
  116. if (BOOL_FALSE == tinyrl_is_completion_error_over(this)) {
  117. /* The user hasn't even entered a valid prefix! */
  118. /* tinyrl_crlf(this);
  119. clish_shell_help(context->shell,
  120. tinyrl__get_line(this));
  121. tinyrl_crlf(this);
  122. tinyrl_reset_line_state(this);
  123. */ }
  124. break;
  125. default:
  126. /* the default completion function will have prompted for completions as
  127. * necessary
  128. */
  129. break;
  130. }
  131. return status;
  132. }
  133. /*--------------------------------------------------------- */
  134. static bool_t clish_shell_tinyrl_key_space(tinyrl_t * this, int key)
  135. {
  136. bool_t result = BOOL_FALSE;
  137. tinyrl_match_e status;
  138. clish_context_t *context = tinyrl__get_context(this);
  139. const char *line = tinyrl__get_line(this);
  140. clish_pargv_status_t arg_status;
  141. const clish_command_t *cmd = NULL;
  142. clish_pargv_t *pargv = NULL;
  143. if(tinyrl_is_empty(this)) {
  144. /* ignore space at the begining of the line, don't display commands */
  145. return BOOL_TRUE;
  146. } else if (tinyrl_is_quoting(this)) {
  147. /* if we are in the middle of a quote then simply enter a space */
  148. result = BOOL_TRUE;
  149. } else {
  150. /* Find out if current line is legal. It can be
  151. * fully completed or partially completed.
  152. */
  153. arg_status = clish_shell_parse(context->shell,
  154. line, &cmd, &pargv);
  155. if (pargv)
  156. clish_pargv_delete(pargv);
  157. switch (arg_status) {
  158. case CLISH_LINE_OK:
  159. case CLISH_LINE_PARTIAL:
  160. if (' ' != line[strlen(line) - 1])
  161. result = BOOL_TRUE;
  162. break;
  163. default:
  164. break;
  165. }
  166. /* If current line is illegal try to make auto-comletion. */
  167. if (!result) {
  168. /* perform word completion */
  169. status = clish_shell_tinyrl_complete(this);
  170. switch (status) {
  171. case TINYRL_NO_MATCH:
  172. case TINYRL_AMBIGUOUS:
  173. /* ambiguous result signal an issue */
  174. break;
  175. case TINYRL_COMPLETED_AMBIGUOUS:
  176. /* perform word completion again in case we just did case
  177. modification the first time */
  178. status = clish_shell_tinyrl_complete(this);
  179. if (status == TINYRL_MATCH_WITH_EXTENSIONS) {
  180. /* all is well with the world just enter a space */
  181. result = BOOL_TRUE;
  182. }
  183. break;
  184. case TINYRL_MATCH:
  185. case TINYRL_MATCH_WITH_EXTENSIONS:
  186. case TINYRL_COMPLETED_MATCH:
  187. /* all is well with the world just enter a space */
  188. result = BOOL_TRUE;
  189. break;
  190. }
  191. }
  192. }
  193. if (result)
  194. result = tinyrl_insert_text(this, " ");
  195. /* keep compiler happy */
  196. key = key;
  197. return result;
  198. }
  199. /*-------------------------------------------------------- */
  200. static bool_t clish_shell_tinyrl_key_enter(tinyrl_t *this, int key)
  201. {
  202. clish_context_t *context = tinyrl__get_context(this);
  203. const clish_command_t *cmd = NULL;
  204. const char *line = tinyrl__get_line(this);
  205. bool_t result = BOOL_FALSE;
  206. char *errmsg = NULL;
  207. /* Inc line counter */
  208. if (context->shell->current_file)
  209. context->shell->current_file->line++;
  210. /* Renew prompt */
  211. clish_shell_renew_prompt(context->shell);
  212. /* nothing to pass simply move down the screen */
  213. if (!*line) {
  214. tinyrl_multi_crlf(this);
  215. tinyrl_done(this);
  216. return BOOL_TRUE;
  217. }
  218. /* try and parse the command */
  219. cmd = clish_shell_resolve_command(context->shell, line);
  220. if (!cmd) {
  221. tinyrl_match_e status = clish_shell_tinyrl_complete(this);
  222. switch (status) {
  223. case TINYRL_MATCH:
  224. case TINYRL_MATCH_WITH_EXTENSIONS:
  225. case TINYRL_COMPLETED_MATCH:
  226. /* re-fetch the line as it may have changed
  227. * due to auto-completion
  228. */
  229. line = tinyrl__get_line(this);
  230. /* get the command to parse? */
  231. cmd = clish_shell_resolve_command(context->shell, line);
  232. /*
  233. * We have had a match but it is not a command
  234. * so add a space so as not to confuse the user
  235. */
  236. if (!cmd)
  237. result = tinyrl_insert_text(this, " ");
  238. break;
  239. default:
  240. /* failed to get a unique match... */
  241. if (!tinyrl__get_isatty(this)) {
  242. /* batch mode */
  243. tinyrl_multi_crlf(this);
  244. errmsg = "Unknown command";
  245. }
  246. break;
  247. }
  248. }
  249. if (cmd) {
  250. clish_pargv_status_t arg_status;
  251. tinyrl_multi_crlf(this);
  252. /* we've got a command so check the syntax */
  253. arg_status = clish_shell_parse(context->shell,
  254. line, &context->cmd, &context->pargv);
  255. switch (arg_status) {
  256. case CLISH_LINE_OK:
  257. tinyrl_done(this);
  258. result = BOOL_TRUE;
  259. break;
  260. case CLISH_BAD_HISTORY:
  261. errmsg = "Bad history entry";
  262. break;
  263. case CLISH_BAD_CMD:
  264. errmsg = "Illegal command line";
  265. break;
  266. case CLISH_BAD_PARAM:
  267. errmsg = "Illegal parameter";
  268. break;
  269. case CLISH_LINE_PARTIAL:
  270. errmsg = "The command is not completed";
  271. break;
  272. default:
  273. errmsg = "Unknown problem";
  274. break;
  275. }
  276. }
  277. /* If error then print message */
  278. if (errmsg) {
  279. if (tinyrl__get_isatty(this) ||
  280. !context->shell->current_file) {
  281. fprintf(stderr, "Syntax error: %s\n", errmsg);
  282. tinyrl_reset_line_state(this);
  283. } else {
  284. char *fname = "stdin";
  285. if (context->shell->current_file->fname)
  286. fname = context->shell->current_file->fname;
  287. fprintf(stderr, "Syntax error on line %s:%u \"%s\": "
  288. "%s\n", fname, context->shell->current_file->line,
  289. line, errmsg);
  290. }
  291. }
  292. /* keep the compiler happy */
  293. key = key;
  294. return result;
  295. }
  296. /*-------------------------------------------------------- */
  297. static bool_t clish_shell_tinyrl_hotkey(tinyrl_t *this, int key)
  298. {
  299. clish_view_t *view;
  300. const char *cmd = NULL;
  301. clish_context_t *context = tinyrl__get_context(this);
  302. clish_shell_t *shell = context->shell;
  303. int i;
  304. char *tmp = NULL;
  305. i = clish_shell__get_depth(shell);
  306. while (i >= 0) {
  307. view = clish_shell__get_pwd_view(shell, i);
  308. cmd = clish_view_find_hotkey(view, key);
  309. if (cmd)
  310. break;
  311. i--;
  312. }
  313. /* Check the global view */
  314. if (i < 0) {
  315. view = shell->global;
  316. cmd = clish_view_find_hotkey(view, key);
  317. }
  318. if (!cmd)
  319. return BOOL_FALSE;
  320. tmp = clish_shell_expand(cmd, SHELL_VAR_NONE, context);
  321. tinyrl_replace_line(this, tmp, 0);
  322. lub_string_free(tmp);
  323. clish_shell_tinyrl_key_enter(this, 0);
  324. return BOOL_TRUE;
  325. }
  326. /*-------------------------------------------------------- */
  327. /* This is the completion function provided for CLISH */
  328. tinyrl_completion_func_t clish_shell_tinyrl_completion;
  329. char **clish_shell_tinyrl_completion(tinyrl_t * tinyrl,
  330. const char *line, unsigned start, unsigned end)
  331. {
  332. lub_argv_t *matches;
  333. clish_context_t *context = tinyrl__get_context(tinyrl);
  334. clish_shell_t *this = context->shell;
  335. clish_shell_iterator_t iter;
  336. const clish_command_t *cmd = NULL;
  337. char *text;
  338. char **result = NULL;
  339. if (tinyrl_is_quoting(tinyrl))
  340. return result;
  341. matches = lub_argv_new(NULL, 0);
  342. text = lub_string_dupn(line, end);
  343. /* Don't bother to resort to filename completion */
  344. tinyrl_completion_over(tinyrl);
  345. /* Search for COMMAND completions */
  346. clish_shell_iterator_init(&iter, CLISH_NSPACE_COMPLETION);
  347. while ((cmd = clish_shell_find_next_completion(this, text, &iter)))
  348. lub_argv_add(matches, clish_command__get_suffix(cmd));
  349. /* Try and resolve a command */
  350. cmd = clish_shell_resolve_command(this, text);
  351. /* Search for PARAM completion */
  352. if (cmd)
  353. clish_shell_param_generator(this, matches, cmd, text, start);
  354. lub_string_free(text);
  355. /* Matches were found */
  356. if (lub_argv__get_count(matches) > 0) {
  357. unsigned i;
  358. char *subst = lub_string_dup(lub_argv__get_arg(matches, 0));
  359. /* Find out substitution */
  360. for (i = 1; i < lub_argv__get_count(matches); i++) {
  361. char *p = subst;
  362. const char *match = lub_argv__get_arg(matches, i);
  363. size_t match_len = strlen(p);
  364. /* identify the common prefix */
  365. while ((tolower(*p) == tolower(*match)) && match_len--) {
  366. p++;
  367. match++;
  368. }
  369. /* Terminate the prefix string */
  370. *p = '\0';
  371. }
  372. result = lub_argv__get_argv(matches, subst);
  373. lub_string_free(subst);
  374. }
  375. lub_argv_delete(matches);
  376. return result;
  377. }
  378. /*-------------------------------------------------------- */
  379. static void clish_shell_tinyrl_init(tinyrl_t * this)
  380. {
  381. bool_t status;
  382. /* bind the '?' key to the help function */
  383. status = tinyrl_bind_key(this, '?', clish_shell_tinyrl_key_help);
  384. assert(status);
  385. /* bind the <RET> key to the help function */
  386. status = tinyrl_bind_key(this, '\r', clish_shell_tinyrl_key_enter);
  387. assert(status);
  388. status = tinyrl_bind_key(this, '\n', clish_shell_tinyrl_key_enter);
  389. assert(status);
  390. /* bind the <SPACE> key to auto-complete if necessary */
  391. status = tinyrl_bind_key(this, ' ', clish_shell_tinyrl_key_space);
  392. assert(status);
  393. /* Set external hotkey callback */
  394. tinyrl__set_hotkey_fn(this, clish_shell_tinyrl_hotkey);
  395. /* Assign timeout callback */
  396. tinyrl__set_timeout_fn(this, clish_shell_timeout_fn);
  397. /* Assign keypress callback */
  398. tinyrl__set_keypress_fn(this, clish_shell_keypress_fn);
  399. }
  400. /*-------------------------------------------------------- */
  401. /*
  402. * Create an instance of the specialised class
  403. */
  404. tinyrl_t *clish_shell_tinyrl_new(FILE * istream,
  405. FILE * ostream, unsigned stifle)
  406. {
  407. /* call the parent constructor */
  408. tinyrl_t *this = tinyrl_new(istream,
  409. ostream, stifle, clish_shell_tinyrl_completion);
  410. /* now call our own constructor */
  411. if (this)
  412. clish_shell_tinyrl_init(this);
  413. return this;
  414. }
  415. /*-------------------------------------------------------- */
  416. void clish_shell_tinyrl_fini(tinyrl_t * this)
  417. {
  418. /* nothing to do... yet */
  419. this = this;
  420. }
  421. /*-------------------------------------------------------- */
  422. void clish_shell_tinyrl_delete(tinyrl_t * this)
  423. {
  424. /* call our destructor */
  425. clish_shell_tinyrl_fini(this);
  426. /* and call the parent destructor */
  427. tinyrl_delete(this);
  428. }
  429. /*-------------------------------------------------------- */
  430. static int clish_shell_execline(clish_shell_t *this, const char *line, char **out)
  431. {
  432. char *str;
  433. clish_context_t context;
  434. tinyrl_history_t *history;
  435. int lerror = 0;
  436. assert(this);
  437. this->state = SHELL_STATE_OK;
  438. if (!line && !tinyrl__get_istream(this->tinyrl)) {
  439. this->state = SHELL_STATE_SYSTEM_ERROR;
  440. return -1;
  441. }
  442. /* Renew prompt */
  443. clish_shell_renew_prompt(this);
  444. /* Set up the context for tinyrl */
  445. context.cmd = NULL;
  446. context.pargv = NULL;
  447. context.shell = this;
  448. /* Push the specified line or interactive line */
  449. if (line)
  450. str = tinyrl_forceline(this->tinyrl, &context, line);
  451. else
  452. str = tinyrl_readline(this->tinyrl, &context);
  453. lerror = errno;
  454. if (!str) {
  455. switch (lerror) {
  456. case ENOENT:
  457. this->state = SHELL_STATE_EOF;
  458. break;
  459. case ENOEXEC:
  460. this->state = SHELL_STATE_SYNTAX_ERROR;
  461. break;
  462. default:
  463. this->state = SHELL_STATE_SYSTEM_ERROR;
  464. break;
  465. };
  466. return -1;
  467. }
  468. /* Deal with the history list */
  469. if (tinyrl__get_isatty(this->tinyrl)) {
  470. history = tinyrl__get_history(this->tinyrl);
  471. tinyrl_history_add(history, str);
  472. }
  473. /* Let the client know the command line has been entered */
  474. if (this->client_hooks->cmd_line_fn)
  475. this->client_hooks->cmd_line_fn(&context, str);
  476. free(str);
  477. /* Execute the provided command */
  478. if (context.cmd && context.pargv) {
  479. int res;
  480. if ((res = clish_shell_execute(&context, out))) {
  481. this->state = SHELL_STATE_SCRIPT_ERROR;
  482. if (context.pargv)
  483. clish_pargv_delete(context.pargv);
  484. return res;
  485. }
  486. }
  487. if (context.pargv)
  488. clish_pargv_delete(context.pargv);
  489. return 0;
  490. }
  491. /*-------------------------------------------------------- */
  492. int clish_shell_forceline(clish_shell_t *this, const char *line, char **out)
  493. {
  494. return clish_shell_execline(this, line, out);
  495. }
  496. /*-------------------------------------------------------- */
  497. int clish_shell_readline(clish_shell_t *this, char **out)
  498. {
  499. return clish_shell_execline(this, NULL, out);
  500. }
  501. /*-------------------------------------------------------- */
  502. FILE * clish_shell__get_istream(const clish_shell_t * this)
  503. {
  504. return tinyrl__get_istream(this->tinyrl);
  505. }
  506. /*-------------------------------------------------------- */
  507. FILE * clish_shell__get_ostream(const clish_shell_t * this)
  508. {
  509. return tinyrl__get_ostream(this->tinyrl);
  510. }
  511. /*-------------------------------------------------------- */
  512. void clish_shell__set_interactive(clish_shell_t * this, bool_t interactive)
  513. {
  514. assert(this);
  515. this->interactive = interactive;
  516. }
  517. /*-------------------------------------------------------- */
  518. bool_t clish_shell__get_interactive(const clish_shell_t * this)
  519. {
  520. assert(this);
  521. return this->interactive;
  522. }
  523. /*-------------------------------------------------------- */
  524. bool_t clish_shell__get_utf8(const clish_shell_t * this)
  525. {
  526. assert(this);
  527. return tinyrl__get_utf8(this->tinyrl);
  528. }
  529. /*-------------------------------------------------------- */
  530. void clish_shell__set_utf8(clish_shell_t * this, bool_t utf8)
  531. {
  532. assert(this);
  533. tinyrl__set_utf8(this->tinyrl, utf8);
  534. }
  535. /*-------------------------------------------------------- */
  536. void clish_shell__set_timeout(clish_shell_t *this, int timeout)
  537. {
  538. assert(this);
  539. this->idle_timeout = timeout;
  540. }
  541. /*--------------------------------------------------------- */
  542. tinyrl_t *clish_shell__get_tinyrl(const clish_shell_t * this)
  543. {
  544. return this->tinyrl;
  545. }
  546. /*----------------------------------------------------------*/
  547. int clish_shell__save_history(const clish_shell_t *this, const char *fname)
  548. {
  549. return tinyrl__save_history(this->tinyrl, fname);
  550. }
  551. /*----------------------------------------------------------*/
  552. int clish_shell__restore_history(clish_shell_t *this, const char *fname)
  553. {
  554. return tinyrl__restore_history(this->tinyrl, fname);
  555. }
  556. /*----------------------------------------------------------*/
  557. void clish_shell__stifle_history(clish_shell_t *this, unsigned int stifle)
  558. {
  559. tinyrl__stifle_history(this->tinyrl, stifle);
  560. }
  561. /*-------------------------------------------------------- */