shell_tinyrl.c 16 KB

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