tinyrl.c 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407
  1. /*
  2. * tinyrl.c
  3. */
  4. /* make sure we can get fileno() */
  5. #undef __STRICT_ANSI__
  6. /* LIBC HEADERS */
  7. #include <assert.h>
  8. #include <stdio.h>
  9. #include <stdlib.h>
  10. #include <string.h>
  11. #include <ctype.h>
  12. /* POSIX HEADERS */
  13. #include <unistd.h>
  14. #include "lub/string.h"
  15. #include "private.h"
  16. /*----------------------------------------------------------------------- */
  17. static void
  18. tty_set_raw_mode(tinyrl_t *this)
  19. {
  20. struct termios new_termios;
  21. int fd = fileno(tinyrl_vt100__get_istream(this->term));
  22. int status;
  23. status = tcgetattr(fd,&this->default_termios);
  24. if(-1 != status)
  25. {
  26. status = tcgetattr(fd,&new_termios);
  27. assert(-1 != status);
  28. new_termios.c_iflag = 0;
  29. new_termios.c_oflag = OPOST | ONLCR;
  30. new_termios.c_lflag = 0;
  31. new_termios.c_cc[VMIN] = 1;
  32. new_termios.c_cc[VTIME] = 0;
  33. /* Do the mode switch */
  34. status = tcsetattr(fd,TCSAFLUSH,&new_termios);
  35. assert(-1 != status);
  36. }
  37. }
  38. /*----------------------------------------------------------------------- */
  39. static void
  40. tty_restore_mode(const tinyrl_t *this)
  41. {
  42. int fd = fileno(tinyrl_vt100__get_istream(this->term));
  43. /* Do the mode switch */
  44. (void)tcsetattr(fd,TCSAFLUSH,&this->default_termios);
  45. }
  46. /*----------------------------------------------------------------------- */
  47. /*
  48. This is called whenever a line is edited in any way.
  49. It signals that if we are currently viewing a history line we should transfer it
  50. to the current buffer
  51. */
  52. static void
  53. changed_line(tinyrl_t *this)
  54. {
  55. /* if the current line is not our buffer then make it so */
  56. if(this->line != this->buffer)
  57. {
  58. /* replace the current buffer with the new details */
  59. free(this->buffer);
  60. this->line = this->buffer = lub_string_dup(this->line);
  61. this->buffer_size = strlen(this->buffer);
  62. assert(this->line);
  63. }
  64. }
  65. /*----------------------------------------------------------------------- */
  66. static bool_t
  67. tinyrl_key_default(tinyrl_t *this,
  68. int key)
  69. {
  70. bool_t result = BOOL_FALSE;
  71. if(key > 31)
  72. {
  73. char tmp[2];
  74. tmp[0] = (key & 0xFF),
  75. tmp[1] = '\0';
  76. /* inject this text into the buffer */
  77. result = tinyrl_insert_text(this,tmp);
  78. }
  79. else
  80. {
  81. char tmp[10];
  82. sprintf(tmp,"~%d",key);
  83. /* inject control characters as ~N where N is the ASCII code */
  84. result = tinyrl_insert_text(this,tmp);
  85. }
  86. return result;
  87. }
  88. /*-------------------------------------------------------- */
  89. static bool_t
  90. tinyrl_key_interrupt(tinyrl_t *this,
  91. int key)
  92. {
  93. tinyrl_delete_text(this,0,this->end);
  94. this->done = BOOL_TRUE;
  95. /* keep the compiler happy */
  96. key = key;
  97. return BOOL_TRUE;
  98. }
  99. /*-------------------------------------------------------- */
  100. static bool_t
  101. tinyrl_key_start_of_line(tinyrl_t *this,
  102. int key)
  103. {
  104. /* set the insertion point to the start of the line */
  105. this->point = 0;
  106. /* keep the compiler happy */
  107. key = key;
  108. return BOOL_TRUE;
  109. }
  110. /*-------------------------------------------------------- */
  111. static bool_t
  112. tinyrl_key_end_of_line(tinyrl_t *this,
  113. int key)
  114. {
  115. /* set the insertion point to the end of the line */
  116. this->point = this->end;
  117. /* keep the compiler happy */
  118. key = key;
  119. return BOOL_TRUE;
  120. }
  121. /*-------------------------------------------------------- */
  122. static bool_t
  123. tinyrl_key_kill(tinyrl_t *this,
  124. int key)
  125. {
  126. /* release any old kill string */
  127. lub_string_free(this->kill_string);
  128. /* store the killed string */
  129. this->kill_string = lub_string_dup(&this->buffer[this->point]);
  130. /* delete the text to the end of the line */
  131. tinyrl_delete_text(this,this->point,this->end);
  132. /* keep the compiler happy */
  133. key = key;
  134. return BOOL_TRUE;
  135. }
  136. /*-------------------------------------------------------- */
  137. static bool_t
  138. tinyrl_key_yank(tinyrl_t *this,
  139. int key)
  140. {
  141. bool_t result = BOOL_FALSE;
  142. if(this->kill_string)
  143. {
  144. /* insert the kill string at the current insertion point */
  145. result = tinyrl_insert_text(this,this->kill_string);
  146. }
  147. /* keep the compiler happy */
  148. key = key;
  149. return result;
  150. }
  151. /*-------------------------------------------------------- */
  152. static bool_t
  153. tinyrl_key_crlf(tinyrl_t *this,
  154. int key)
  155. {
  156. tinyrl_crlf(this);
  157. this->done = BOOL_TRUE;
  158. /* keep the compiler happy */
  159. key = key;
  160. return BOOL_TRUE;
  161. }
  162. /*-------------------------------------------------------- */
  163. static bool_t
  164. tinyrl_key_up(tinyrl_t *this,
  165. int key)
  166. {
  167. bool_t result = BOOL_FALSE;
  168. tinyrl_history_entry_t *entry = NULL;
  169. if(this->line == this->buffer)
  170. {
  171. /* go to the last history entry */
  172. entry = tinyrl_history_getlast(this->history,
  173. &this->hist_iter);
  174. }
  175. else
  176. {
  177. /* already traversing the history list so get previous */
  178. entry = tinyrl_history_getprevious(&this->hist_iter);
  179. }
  180. if(NULL != entry)
  181. {
  182. /* display the entry moving the insertion point
  183. * to the end of the line
  184. */
  185. this->line = tinyrl_history_entry__get_line(entry);
  186. this->point = this->end = strlen(this->line);
  187. result = BOOL_TRUE;
  188. }
  189. /* keep the compiler happy */
  190. key = key;
  191. return result;
  192. }
  193. /*-------------------------------------------------------- */
  194. static bool_t
  195. tinyrl_key_down(tinyrl_t *this,
  196. int key)
  197. {
  198. bool_t result = BOOL_FALSE;
  199. if(this->line != this->buffer)
  200. {
  201. /* we are not already at the bottom */
  202. /* the iterator will have been set up by the key_up() function */
  203. tinyrl_history_entry_t *entry = tinyrl_history_getnext(&this->hist_iter);
  204. if(NULL == entry)
  205. {
  206. /* nothing more in the history list */
  207. this->line = this->buffer;
  208. }
  209. else
  210. {
  211. this->line = tinyrl_history_entry__get_line(entry);
  212. }
  213. /* display the entry moving the insertion point
  214. * to the end of the line
  215. */
  216. this->point = this->end = strlen(this->line);
  217. result = BOOL_TRUE;
  218. }
  219. /* keep the compiler happy */
  220. key = key;
  221. return result;
  222. }
  223. /*-------------------------------------------------------- */
  224. static bool_t
  225. tinyrl_key_left(tinyrl_t *this,
  226. int key)
  227. {
  228. bool_t result = BOOL_FALSE;
  229. if(this->point > 0)
  230. {
  231. this->point--;
  232. result = BOOL_TRUE;
  233. }
  234. /* keep the compiler happy */
  235. key = key;
  236. return result;
  237. }
  238. /*-------------------------------------------------------- */
  239. static bool_t
  240. tinyrl_key_right(tinyrl_t *this,
  241. int key)
  242. {
  243. bool_t result = BOOL_FALSE;
  244. if(this->point < this->end)
  245. {
  246. this->point++;
  247. result = BOOL_TRUE;
  248. }
  249. /* keep the compiler happy */
  250. key = key;
  251. return result;
  252. }
  253. /*-------------------------------------------------------- */
  254. static bool_t
  255. tinyrl_key_backspace(tinyrl_t *this,
  256. int key)
  257. {
  258. bool_t result = BOOL_FALSE;
  259. if(this->point)
  260. {
  261. this->point--;
  262. tinyrl_delete_text(this,this->point,this->point);
  263. result = BOOL_TRUE;
  264. }
  265. /* keep the compiler happy */
  266. key = key;
  267. return result;
  268. }
  269. /*-------------------------------------------------------- */
  270. static bool_t
  271. tinyrl_key_delete(tinyrl_t *this,
  272. int key)
  273. {
  274. bool_t result = BOOL_FALSE;
  275. if(this->point < this->end)
  276. {
  277. tinyrl_delete_text(this,this->point,this->point);
  278. result = BOOL_TRUE;
  279. }
  280. /* keep the compiler happy */
  281. key = key;
  282. return result;
  283. }
  284. /*-------------------------------------------------------- */
  285. static bool_t
  286. tinyrl_key_clear_screen(tinyrl_t *this,
  287. int key)
  288. {
  289. tinyrl_vt100_clear_screen(this->term);
  290. tinyrl_vt100_cursor_home(this->term);
  291. tinyrl_reset_line_state(this);
  292. /* keep the compiler happy */
  293. key = key;
  294. this = this;
  295. return BOOL_TRUE;
  296. }
  297. /*-------------------------------------------------------- */
  298. static bool_t
  299. tinyrl_key_erase_line(tinyrl_t *this, int key)
  300. {
  301. tinyrl_delete_text(this,0,this->point);
  302. this->point = 0;
  303. /* keep the compiler happy */
  304. key = key;
  305. this = this;
  306. return BOOL_TRUE;
  307. }/*-------------------------------------------------------- */
  308. static bool_t
  309. tinyrl_key_escape(tinyrl_t *this,
  310. int key)
  311. {
  312. bool_t result= BOOL_FALSE;
  313. switch(tinyrl_vt100_escape_decode(this->term))
  314. {
  315. case tinyrl_vt100_CURSOR_UP:
  316. result = tinyrl_key_up(this,key);
  317. break;
  318. case tinyrl_vt100_CURSOR_DOWN:
  319. result = tinyrl_key_down(this,key);
  320. break;
  321. case tinyrl_vt100_CURSOR_LEFT:
  322. result = tinyrl_key_left(this,key);
  323. break;
  324. case tinyrl_vt100_CURSOR_RIGHT:
  325. result = tinyrl_key_right(this,key);
  326. break;
  327. case tinyrl_vt100_UNKNOWN:
  328. break;
  329. }
  330. return result;
  331. }
  332. /*-------------------------------------------------------- */
  333. static bool_t
  334. tinyrl_key_tab(tinyrl_t *this,
  335. int key)
  336. {
  337. bool_t result = BOOL_FALSE;
  338. tinyrl_match_e status = tinyrl_complete_with_extensions(this);
  339. switch(status)
  340. {
  341. case TINYRL_COMPLETED_MATCH:
  342. case TINYRL_MATCH:
  343. {
  344. /* everything is OK with the world... */
  345. result = tinyrl_insert_text(this," ");
  346. break;
  347. }
  348. case TINYRL_NO_MATCH:
  349. case TINYRL_MATCH_WITH_EXTENSIONS:
  350. case TINYRL_AMBIGUOUS:
  351. case TINYRL_COMPLETED_AMBIGUOUS:
  352. {
  353. /* oops don't change the result and let the bell ring */
  354. break;
  355. }
  356. }
  357. /* keep the compiler happy */
  358. key = key;
  359. return result;
  360. }
  361. /*-------------------------------------------------------- */
  362. static void
  363. tinyrl_fini(tinyrl_t *this)
  364. {
  365. /* delete the history session */
  366. tinyrl_history_delete(this->history);
  367. /* delete the terminal session */
  368. tinyrl_vt100_delete(this->term);
  369. /* free up any dynamic strings */
  370. lub_string_free(this->buffer);
  371. this->buffer = NULL;
  372. lub_string_free(this->kill_string);
  373. this->kill_string = NULL;
  374. lub_string_free(this->last_buffer);
  375. this->last_buffer = NULL;
  376. }
  377. /*-------------------------------------------------------- */
  378. static void
  379. tinyrl_init(tinyrl_t *this,
  380. FILE *instream,
  381. FILE *outstream,
  382. unsigned stifle,
  383. tinyrl_completion_func_t *complete_fn)
  384. {
  385. int i;
  386. for(i = 0;i < NUM_HANDLERS; i++)
  387. {
  388. this->handlers[i] = tinyrl_key_default;
  389. }
  390. /* default handlers */
  391. this->handlers[KEY_CR] = tinyrl_key_crlf;
  392. this->handlers[KEY_LF] = tinyrl_key_crlf;
  393. this->handlers[KEY_ETX] = tinyrl_key_interrupt;
  394. this->handlers[KEY_DEL] = tinyrl_key_backspace;
  395. this->handlers[KEY_BS] = tinyrl_key_backspace;
  396. this->handlers[KEY_EOT] = tinyrl_key_delete;
  397. this->handlers[KEY_ESC] = tinyrl_key_escape;
  398. this->handlers[KEY_FF] = tinyrl_key_clear_screen;
  399. this->handlers[KEY_NAK] = tinyrl_key_erase_line;
  400. this->handlers[KEY_SOH] = tinyrl_key_start_of_line;
  401. this->handlers[KEY_ENQ] = tinyrl_key_end_of_line;
  402. this->handlers[KEY_VT] = tinyrl_key_kill;
  403. this->handlers[KEY_EM] = tinyrl_key_yank;
  404. this->handlers[KEY_HT] = tinyrl_key_tab;
  405. this->line = NULL;
  406. this->max_line_length = 0;
  407. this->prompt = NULL;
  408. this->prompt_size = 0;
  409. this->buffer = NULL;
  410. this->buffer_size = 0;
  411. this->done = BOOL_FALSE;
  412. this->completion_over = BOOL_FALSE;
  413. this->point = 0;
  414. this->end = 0;
  415. this->attempted_completion_function = complete_fn;
  416. this->state = 0;
  417. this->kill_string = NULL;
  418. this->echo_char = '\0';
  419. this->echo_enabled = BOOL_TRUE;
  420. this->isatty = isatty(fileno(instream)) ? BOOL_TRUE : BOOL_FALSE;
  421. this->last_buffer = NULL;
  422. this->last_point = 0;
  423. /* create the vt100 terminal */
  424. this->term = tinyrl_vt100_new(instream,outstream);
  425. /* create the history */
  426. this->history = tinyrl_history_new(stifle);
  427. }
  428. /*-------------------------------------------------------- */
  429. int
  430. tinyrl_printf(const tinyrl_t *this,
  431. const char *fmt,
  432. ...)
  433. {
  434. va_list args;
  435. int len;
  436. va_start(args, fmt);
  437. len = tinyrl_vt100_vprintf(this->term, fmt, args);
  438. va_end(args);
  439. return len;
  440. }
  441. /*-------------------------------------------------------- */
  442. void
  443. tinyrl_delete(tinyrl_t *this)
  444. {
  445. assert(this);
  446. if(this)
  447. {
  448. /* let the object tidy itself up */
  449. tinyrl_fini(this);
  450. /* release the memory associate with this instance */
  451. free(this);
  452. }
  453. }
  454. /*-------------------------------------------------------- */
  455. /*#####################################
  456. * EXPORTED INTERFACE
  457. *##################################### */
  458. /*----------------------------------------------------------------------- */
  459. int
  460. tinyrl_getchar(const tinyrl_t *this)
  461. {
  462. return tinyrl_vt100_getchar(this->term);
  463. }
  464. /*----------------------------------------------------------------------- */
  465. static void
  466. tinyrl_internal_print(const tinyrl_t *this,
  467. const char *text)
  468. {
  469. if(BOOL_TRUE == this->echo_enabled)
  470. {
  471. /* simply echo the line */
  472. tinyrl_vt100_printf(this->term,"%s",text);
  473. }
  474. else
  475. {
  476. /* replace the line with echo char if defined */
  477. if(this->echo_char)
  478. {
  479. unsigned i = strlen(text);
  480. while(i--)
  481. {
  482. tinyrl_vt100_printf(this->term,"%c",this->echo_char);
  483. }
  484. }
  485. }
  486. }
  487. /*----------------------------------------------------------------------- */
  488. void
  489. tinyrl_redisplay(tinyrl_t *this)
  490. {
  491. int delta;
  492. unsigned line_len, last_line_len,count;
  493. line_len = strlen(this->line);
  494. last_line_len = (this->last_buffer ? strlen(this->last_buffer) : 0);
  495. do
  496. {
  497. if(this->last_buffer)
  498. {
  499. delta = (int)(line_len - last_line_len);
  500. if(delta > 0)
  501. {
  502. count = (unsigned)delta;
  503. /* is the current line simply an extension of the previous one? */
  504. if(0 == strncmp(this->line,this->last_buffer,last_line_len))
  505. {
  506. /* output the line accounting for the echo behaviour */
  507. tinyrl_internal_print(this,&this->line[line_len - count]);
  508. break;
  509. }
  510. }
  511. else if(delta < 0)
  512. {
  513. /* is the current line simply a deletion of some characters from the end? */
  514. if(0 == strncmp(this->line,this->last_buffer,line_len))
  515. {
  516. if(this->echo_enabled || this->echo_char)
  517. {
  518. int shift = (int)(this->last_point - this->point);
  519. /* just get the terminal to delete the characters */
  520. if(shift > 0)
  521. {
  522. count = (unsigned)shift;
  523. /* we've moved the cursor backwards */
  524. tinyrl_vt100_cursor_back(this->term,count);
  525. }
  526. else if(shift < 0)
  527. {
  528. count = (unsigned)-shift;
  529. /* we've moved the cursor forwards */
  530. tinyrl_vt100_cursor_forward(this->term,count);
  531. }
  532. /* now delete the characters */
  533. count = (unsigned)-delta;
  534. tinyrl_vt100_erase(this->term,count);
  535. }
  536. break;
  537. }
  538. }
  539. else
  540. {
  541. /* are the lines are the same content? */
  542. if(0 == strcmp(this->line,this->last_buffer))
  543. {
  544. if(this->echo_enabled || this->echo_char)
  545. {
  546. delta = (int)(this->point - this->last_point);
  547. if(delta > 0)
  548. {
  549. count = (unsigned)delta;
  550. /* move the point forwards */
  551. tinyrl_vt100_cursor_forward(this->term,count);
  552. }
  553. else if(delta < 0)
  554. {
  555. count = (unsigned)-delta;
  556. /* move the cursor backwards */
  557. tinyrl_vt100_cursor_back(this->term,count);
  558. }
  559. }
  560. /* done for now */
  561. break;
  562. }
  563. }
  564. }
  565. else
  566. {
  567. /* simply display the prompt and the line */
  568. tinyrl_vt100_printf(this->term,"%s",this->prompt);
  569. tinyrl_internal_print(this,this->line);
  570. if(this->point < line_len)
  571. {
  572. /* move the cursor to the insertion point */
  573. tinyrl_vt100_cursor_back(this->term,line_len-this->point);
  574. }
  575. break;
  576. }
  577. /*
  578. * to have got this far we must have edited the middle of a line.
  579. */
  580. if(this->last_point)
  581. {
  582. /* move to just after the prompt of the line */
  583. tinyrl_vt100_cursor_back(this->term,this->last_point);
  584. }
  585. /* erase the previous line */
  586. tinyrl_vt100_erase(this->term,strlen(this->last_buffer));
  587. /* output the line accounting for the echo behaviour */
  588. tinyrl_internal_print(this,this->line);
  589. delta = (int)(line_len - this->point);
  590. if(delta)
  591. {
  592. /* move the cursor back to the insertion point */
  593. tinyrl_vt100_cursor_back(this->term,
  594. (strlen(this->line) - this->point));
  595. }
  596. } /*lint -e717 */ while(0) /*lint +e717 */;
  597. /* update the display */
  598. (void)tinyrl_vt100_oflush(this->term);
  599. /* set up the last line buffer */
  600. lub_string_free(this->last_buffer);
  601. this->last_buffer = lub_string_dup(this->line);
  602. this->last_point = this->point;
  603. }
  604. /*----------------------------------------------------------------------- */
  605. tinyrl_t *
  606. tinyrl_new(FILE *instream,
  607. FILE *outstream,
  608. unsigned stifle,
  609. tinyrl_completion_func_t *complete_fn)
  610. {
  611. tinyrl_t *this=NULL;
  612. this = malloc(sizeof(tinyrl_t));
  613. if(NULL != this)
  614. {
  615. tinyrl_init(this,instream,outstream,stifle,complete_fn);
  616. }
  617. return this;
  618. }
  619. /*----------------------------------------------------------------------- */
  620. char *
  621. tinyrl_readline(tinyrl_t *this,
  622. const char *prompt,
  623. void *context)
  624. {
  625. FILE *istream = tinyrl_vt100__get_istream(this->term);
  626. /* initialise for reading a line */
  627. this->done = BOOL_FALSE;
  628. this->point = 0;
  629. this->end = 0;
  630. this->buffer = lub_string_dup("");
  631. this->buffer_size = strlen(this->buffer);
  632. this->line = this->buffer;
  633. this->prompt = prompt;
  634. this->prompt_size = strlen(prompt);
  635. this->context = context;
  636. if(BOOL_TRUE == this->isatty)
  637. {
  638. /* set the terminal into raw input mode */
  639. tty_set_raw_mode(this);
  640. tinyrl_reset_line_state(this);
  641. while(!this->done)
  642. {
  643. int key;
  644. /* update the display */
  645. tinyrl_redisplay(this);
  646. /* get a key */
  647. key = tinyrl_getchar(this);
  648. /* has the input stream terminated? */
  649. if(EOF != key)
  650. {
  651. /* call the handler for this key */
  652. if(BOOL_FALSE == this->handlers[key](this,key))
  653. {
  654. /* an issue has occured */
  655. tinyrl_ding(this);
  656. }
  657. if (BOOL_TRUE == this->done)
  658. {
  659. /*
  660. * If the last character in the line (other than
  661. * the null) is a space remove it.
  662. */
  663. if (this->end && isspace(this->line[this->end-1]))
  664. {
  665. tinyrl_delete_text(this,this->end-1,this->end);
  666. }
  667. }
  668. }
  669. else
  670. {
  671. /* time to finish the session */
  672. this->done = BOOL_TRUE;
  673. this->line = NULL;
  674. }
  675. }
  676. /* restores the terminal mode */
  677. tty_restore_mode(this);
  678. }
  679. else
  680. {
  681. /* This is a non-interactive set of commands */
  682. char *s = 0, buffer[80];
  683. size_t len = sizeof(buffer);
  684. /* manually reset the line state without redisplaying */
  685. lub_string_free(this->last_buffer);
  686. this->last_buffer = NULL;
  687. while((sizeof(buffer) == len) &&
  688. (s = fgets(buffer,sizeof(buffer),istream)))
  689. {
  690. char *p;
  691. /* strip any spurious '\r' or '\n' */
  692. p = strchr(buffer,'\r');
  693. if(NULL == p)
  694. {
  695. p = strchr(buffer,'\n');
  696. }
  697. if (NULL != p)
  698. {
  699. *p = '\0';
  700. }
  701. /* skip any whitespace at the beginning of the line */
  702. if(0 == this->point)
  703. {
  704. while(*s && isspace(*s))
  705. {
  706. s++;
  707. }
  708. }
  709. if(*s)
  710. {
  711. /* append this string to the input buffer */
  712. (void) tinyrl_insert_text(this,s);
  713. /* echo the command to the output stream */
  714. tinyrl_redisplay(this);
  715. }
  716. len = strlen(buffer) + 1; /* account for the '\0' */
  717. }
  718. /*
  719. * check against fgets returning null as either error or end of file.
  720. * This is a measure to stop potential task spin on encountering an
  721. * error from fgets.
  722. */
  723. if( s == NULL || (this->line[0] == '\0' && feof(istream)) )
  724. {
  725. /* time to finish the session */
  726. this->line = NULL;
  727. }
  728. else
  729. {
  730. /* call the handler for the newline key */
  731. if(BOOL_FALSE == this->handlers[KEY_LF](this,KEY_LF))
  732. {
  733. /* an issue has occured */
  734. tinyrl_ding(this);
  735. this->line = NULL;
  736. }
  737. }
  738. }
  739. /*
  740. * duplicate the string for return to the client
  741. * we have to duplicate as we may be referencing a
  742. * history entry or our internal buffer
  743. */
  744. {
  745. char *result = this->line ? lub_string_dup(this->line) : NULL;
  746. /* free our internal buffer */
  747. free(this->buffer);
  748. this->buffer = NULL;
  749. if((NULL == result) || '\0' == *result)
  750. {
  751. /* make sure we're not left on a prompt line */
  752. tinyrl_crlf(this);
  753. }
  754. return result;
  755. }
  756. }
  757. /*----------------------------------------------------------------------- */
  758. /*
  759. * Ensure that buffer has enough space to hold len characters,
  760. * possibly reallocating it if necessary. The function returns BOOL_TRUE
  761. * if the line is successfully extended, BOOL_FALSE if not.
  762. */
  763. bool_t
  764. tinyrl_extend_line_buffer(tinyrl_t *this,
  765. unsigned len)
  766. {
  767. bool_t result = BOOL_TRUE;
  768. if(this->buffer_size < len)
  769. {
  770. char * new_buffer;
  771. size_t new_len = len;
  772. /*
  773. * What we do depends on whether we are limited by
  774. * memory or a user imposed limit.
  775. */
  776. if (this->max_line_length == 0)
  777. {
  778. if(new_len < this->buffer_size + 10)
  779. {
  780. /* make sure we don't realloc too often */
  781. new_len = this->buffer_size + 10;
  782. }
  783. /* leave space for terminator */
  784. new_buffer = realloc(this->buffer,new_len+1);
  785. if(NULL == new_buffer)
  786. {
  787. tinyrl_ding(this);
  788. result = BOOL_FALSE;
  789. }
  790. else
  791. {
  792. this->buffer_size = new_len;
  793. this->line = this->buffer = new_buffer;
  794. }
  795. }
  796. else
  797. {
  798. if(new_len < this->max_line_length)
  799. {
  800. /* Just reallocate once to the max size */
  801. new_buffer = realloc(this->buffer,this->max_line_length);
  802. if(NULL == new_buffer)
  803. {
  804. tinyrl_ding(this);
  805. result = BOOL_FALSE;
  806. }
  807. else
  808. {
  809. this->buffer_size = this->max_line_length - 1;
  810. this->line = this->buffer = new_buffer;
  811. }
  812. }
  813. else
  814. {
  815. tinyrl_ding(this);
  816. result = BOOL_FALSE;
  817. }
  818. }
  819. }
  820. return result;
  821. }
  822. /*----------------------------------------------------------------------- */
  823. /*
  824. * Insert text into the line at the current cursor position.
  825. */
  826. bool_t
  827. tinyrl_insert_text(tinyrl_t *this,
  828. const char *text)
  829. {
  830. unsigned delta = strlen(text);
  831. /*
  832. * If the client wants to change the line ensure that the line and buffer
  833. * references are in sync
  834. */
  835. changed_line(this);
  836. if((delta + this->end) > (this->buffer_size))
  837. {
  838. /* extend the current buffer */
  839. if (BOOL_FALSE == tinyrl_extend_line_buffer(this,this->end + delta))
  840. {
  841. return BOOL_FALSE;
  842. }
  843. }
  844. if(this->point < this->end)
  845. {
  846. /* move the current text to the right (including the terminator) */
  847. memmove(&this->buffer[this->point+delta],
  848. &this->buffer[this->point],
  849. (this->end - this->point) + 1);
  850. }
  851. else
  852. {
  853. /* terminate the string */
  854. this->buffer[this->end+delta] = '\0';
  855. }
  856. /* insert the new text */
  857. strncpy(&this->buffer[this->point],text,delta);
  858. /* now update the indexes */
  859. this->point += delta;
  860. this->end += delta;
  861. return BOOL_TRUE;
  862. }
  863. /*----------------------------------------------------------------------- */
  864. /*
  865. * A convenience function for displaying a list of strings in columnar
  866. * format on Readline's output stream. matches is the list of strings,
  867. * in argv format, such as a list of completion matches. len is the number
  868. * of strings in matches, and max is the length of the longest string in matches.
  869. * This function uses the setting of print-completions-horizontally to select
  870. * how the matches are displayed
  871. */
  872. void
  873. tinyrl_display_matches(const tinyrl_t *this,
  874. char *const *matches,
  875. unsigned len,
  876. size_t max)
  877. {
  878. unsigned r,c;
  879. unsigned width = tinyrl_vt100__get_width(this->term);
  880. unsigned cols = width/(max+1); /* allow for a space between words */
  881. unsigned rows = len/cols + 1;
  882. assert(matches);
  883. if(matches)
  884. {
  885. len--,matches++; /* skip the subtitution string */
  886. /* print out a table of completions */
  887. for(r=0; r<rows && len; r++)
  888. {
  889. for(c=0; c<cols && len; c++)
  890. {
  891. const char *match = *matches++;
  892. len--;
  893. tinyrl_vt100_printf(this->term,"%-*s ",max,match);
  894. }
  895. tinyrl_crlf(this);
  896. }
  897. }
  898. }
  899. /*----------------------------------------------------------------------- */
  900. /*
  901. * Delete the text between start and end in the current line. (inclusive)
  902. * This adjusts the rl_point and rl_end indexes appropriately.
  903. */
  904. void
  905. tinyrl_delete_text(tinyrl_t *this,
  906. unsigned start,
  907. unsigned end)
  908. {
  909. unsigned delta;
  910. /*
  911. * If the client wants to change the line ensure that the line and buffer
  912. * references are in sync
  913. */
  914. changed_line(this);
  915. /* make sure we play it safe */
  916. if(start > end)
  917. {
  918. unsigned tmp = end;
  919. start = end;
  920. end = tmp;
  921. }
  922. if(end > this->end)
  923. {
  924. end = this->end;
  925. }
  926. delta = (end - start) + 1;
  927. /* move any text which is left */
  928. memmove(&this->buffer[start],
  929. &this->buffer[start+delta],
  930. this->end - end);
  931. /* now adjust the indexs */
  932. if(this->point >= start)
  933. {
  934. if(this->point > end)
  935. {
  936. /* move the insertion point back appropriately */
  937. this->point -= delta;
  938. }
  939. else
  940. {
  941. /* move the insertion point to the start */
  942. this->point = start;
  943. }
  944. }
  945. if(this->end > end)
  946. {
  947. this->end -= delta;
  948. }
  949. else
  950. {
  951. this->end = start;
  952. }
  953. /* put a terminator at the end of the buffer */
  954. this->buffer[this->end] ='\0';
  955. }
  956. /*----------------------------------------------------------------------- */
  957. bool_t
  958. tinyrl_bind_key(tinyrl_t *this,
  959. int key,
  960. tinyrl_key_func_t *fn)
  961. {
  962. bool_t result = BOOL_FALSE;
  963. if((key >= 0) && (key < 256))
  964. {
  965. /* set the key handling function */
  966. this->handlers[key] = fn;
  967. result = BOOL_TRUE;
  968. }
  969. return result;
  970. }
  971. /*-------------------------------------------------------- */
  972. /*
  973. * Returns an array of strings which is a list of completions for text.
  974. * If there are no completions, returns NULL. The first entry in the
  975. * returned array is the substitution for text. The remaining entries
  976. * are the possible completions. The array is terminated with a NULL pointer.
  977. *
  978. * entry_func is a function of two args, and returns a char *.
  979. * The first argument is text. The second is a state argument;
  980. * it is zero on the first call, and non-zero on subsequent calls.
  981. * entry_func returns a NULL pointer to the caller when there are no
  982. * more matches.
  983. */
  984. char **
  985. tinyrl_completion(tinyrl_t *this,
  986. const char *line,
  987. unsigned start,
  988. unsigned end,
  989. tinyrl_compentry_func_t *entry_func)
  990. {
  991. unsigned state = 0;
  992. size_t size = 1;
  993. unsigned offset = 1; /* need at least one entry for the substitution */
  994. char **matches = NULL;
  995. char *match;
  996. /* duplicate the string upto the insertion point */
  997. char *text = lub_string_dupn(line,end);
  998. /* now try and find possible completions */
  999. while( (match = entry_func(this,text,start,state++)) )
  1000. {
  1001. if(size == offset)
  1002. {
  1003. /* resize the buffer if needed - the +1 is for the NULL terminator */
  1004. size += 10;
  1005. matches = realloc(matches,(sizeof(char *) * (size + 1)));
  1006. }
  1007. if (NULL == matches)
  1008. {
  1009. /* not much we can do... */
  1010. break;
  1011. }
  1012. matches[offset] = match;
  1013. /*
  1014. * augment the substitute string with this entry
  1015. */
  1016. if(1 == offset)
  1017. {
  1018. /* let's be optimistic */
  1019. matches[0] = lub_string_dup(match);
  1020. }
  1021. else
  1022. {
  1023. char *p = matches[0];
  1024. size_t match_len = strlen(p);
  1025. /* identify the common prefix */
  1026. while((tolower(*p) == tolower(*match)) && match_len--)
  1027. {
  1028. p++,match++;
  1029. }
  1030. /* terminate the prefix string */
  1031. *p = '\0';
  1032. }
  1033. offset++;
  1034. }
  1035. /* be a good memory citizen */
  1036. lub_string_free(text);
  1037. if(matches)
  1038. {
  1039. matches[offset] = NULL;
  1040. }
  1041. return matches;
  1042. }
  1043. /*-------------------------------------------------------- */
  1044. void
  1045. tinyrl_delete_matches(char **this)
  1046. {
  1047. char **matches = this;
  1048. while(*matches)
  1049. {
  1050. /* release the memory for each contained string */
  1051. free(*matches++);
  1052. }
  1053. /* release the memory for the array */
  1054. free(this);
  1055. }
  1056. /*-------------------------------------------------------- */
  1057. void
  1058. tinyrl_crlf(const tinyrl_t *this)
  1059. {
  1060. tinyrl_vt100_printf(this->term,"\n");
  1061. }
  1062. /*-------------------------------------------------------- */
  1063. /*
  1064. * Ring the terminal bell, obeying the setting of bell-style.
  1065. */
  1066. void
  1067. tinyrl_ding(const tinyrl_t *this)
  1068. {
  1069. tinyrl_vt100_ding(this->term);
  1070. }
  1071. /*-------------------------------------------------------- */
  1072. void
  1073. tinyrl_reset_line_state(tinyrl_t *this)
  1074. {
  1075. /* start from scratch */
  1076. lub_string_free(this->last_buffer);
  1077. this->last_buffer = NULL;
  1078. tinyrl_redisplay(this);
  1079. }
  1080. /*-------------------------------------------------------- */
  1081. void
  1082. tinyrl_replace_line(tinyrl_t *this,
  1083. const char *text,
  1084. int clear_undo)
  1085. {
  1086. size_t new_len = strlen(text);
  1087. /* ignored for now */
  1088. clear_undo = clear_undo;
  1089. /* ensure there is sufficient space */
  1090. if (BOOL_TRUE == tinyrl_extend_line_buffer(this,new_len))
  1091. {
  1092. /* overwrite the current contents of the buffer */
  1093. strcpy(this->buffer,text);
  1094. /* set the insert point and end point */
  1095. this->point = this->end = new_len;
  1096. }
  1097. tinyrl_redisplay(this);
  1098. }
  1099. /*-------------------------------------------------------- */
  1100. static tinyrl_match_e
  1101. tinyrl_do_complete(tinyrl_t *this,
  1102. bool_t with_extensions)
  1103. {
  1104. tinyrl_match_e result = TINYRL_NO_MATCH;
  1105. char **matches = NULL;
  1106. unsigned start,end;
  1107. bool_t completion = BOOL_FALSE;
  1108. bool_t prefix = BOOL_FALSE;
  1109. /* find the start and end of the current word */
  1110. start = end = this->point;
  1111. while(start && !isspace(this->line[start-1]))
  1112. {
  1113. start--;
  1114. }
  1115. if(this->attempted_completion_function)
  1116. {
  1117. this->completion_over = BOOL_FALSE;
  1118. this->completion_error_over = BOOL_FALSE;
  1119. /* try and complete the current line buffer */
  1120. matches = this->attempted_completion_function(this,
  1121. this->line,
  1122. start,
  1123. end);
  1124. }
  1125. if((NULL == matches)
  1126. && (BOOL_FALSE == this->completion_over))
  1127. {
  1128. /* insert default completion call here... */
  1129. }
  1130. if(matches)
  1131. {
  1132. /* identify and insert a common prefix if there is one */
  1133. if(0 != strncmp(matches[0],&this->line[start],strlen(matches[0])))
  1134. {
  1135. /*
  1136. * delete the original text not including
  1137. * the current insertion point character
  1138. */
  1139. if(this->end != end)
  1140. {
  1141. end--;
  1142. }
  1143. tinyrl_delete_text(this,start,end);
  1144. if (BOOL_FALSE == tinyrl_insert_text(this,matches[0]))
  1145. {
  1146. return TINYRL_NO_MATCH;
  1147. }
  1148. completion = BOOL_TRUE;
  1149. }
  1150. if(0 == lub_string_nocasecmp(matches[0],matches[1]))
  1151. {
  1152. /* this is just a prefix string */
  1153. prefix = BOOL_TRUE;
  1154. }
  1155. /* is there more than one completion? */
  1156. if(matches[2] != NULL)
  1157. {
  1158. char **tmp = matches;
  1159. unsigned max,len;
  1160. max = len = 0;
  1161. while(*tmp)
  1162. {
  1163. size_t size = strlen(*tmp++);
  1164. len++;
  1165. if(size > max)
  1166. {
  1167. max = size;
  1168. }
  1169. }
  1170. if(BOOL_TRUE == completion)
  1171. {
  1172. result = TINYRL_COMPLETED_AMBIGUOUS;
  1173. }
  1174. else if(BOOL_TRUE == prefix)
  1175. {
  1176. result = TINYRL_MATCH_WITH_EXTENSIONS;
  1177. }
  1178. else
  1179. {
  1180. result = TINYRL_AMBIGUOUS;
  1181. }
  1182. if((BOOL_TRUE == with_extensions)
  1183. || (BOOL_FALSE == prefix))
  1184. {
  1185. /* Either we always want to show extensions or
  1186. * we haven't been able to complete the current line
  1187. * and there is just a prefix, so let the user see the options
  1188. */
  1189. tinyrl_crlf(this);
  1190. tinyrl_display_matches(this,matches,len,max);
  1191. tinyrl_reset_line_state(this);
  1192. }
  1193. }
  1194. else
  1195. {
  1196. result = completion ? TINYRL_COMPLETED_MATCH : TINYRL_MATCH;
  1197. }
  1198. /* free the memory */
  1199. tinyrl_delete_matches(matches);
  1200. /* redisplay the line */
  1201. tinyrl_redisplay(this);
  1202. }
  1203. return result;
  1204. }
  1205. /*-------------------------------------------------------- */
  1206. tinyrl_match_e
  1207. tinyrl_complete_with_extensions(tinyrl_t *this)
  1208. {
  1209. return tinyrl_do_complete(this,BOOL_TRUE);
  1210. }
  1211. /*-------------------------------------------------------- */
  1212. tinyrl_match_e
  1213. tinyrl_complete(tinyrl_t *this)
  1214. {
  1215. return tinyrl_do_complete(this,BOOL_FALSE);
  1216. }
  1217. /*-------------------------------------------------------- */
  1218. void *
  1219. tinyrl__get_context(const tinyrl_t *this)
  1220. {
  1221. return this->context;
  1222. }
  1223. /*--------------------------------------------------------- */
  1224. const char *
  1225. tinyrl__get_line(const tinyrl_t *this)
  1226. {
  1227. return this->line;
  1228. }
  1229. /*--------------------------------------------------------- */
  1230. tinyrl_history_t *
  1231. tinyrl__get_history(const tinyrl_t *this)
  1232. {
  1233. return this->history;
  1234. }
  1235. /*--------------------------------------------------------- */
  1236. void
  1237. tinyrl_completion_over(tinyrl_t *this)
  1238. {
  1239. this->completion_over = BOOL_TRUE;
  1240. }
  1241. /*--------------------------------------------------------- */
  1242. void
  1243. tinyrl_completion_error_over(tinyrl_t *this)
  1244. {
  1245. this->completion_error_over = BOOL_TRUE;
  1246. }
  1247. /*--------------------------------------------------------- */
  1248. bool_t
  1249. tinyrl_is_completion_error_over(const tinyrl_t *this)
  1250. {
  1251. return this->completion_error_over;
  1252. }
  1253. /*--------------------------------------------------------- */
  1254. void
  1255. tinyrl_done(tinyrl_t *this)
  1256. {
  1257. this->done = BOOL_TRUE;
  1258. }
  1259. /*--------------------------------------------------------- */
  1260. void
  1261. tinyrl_enable_echo(tinyrl_t *this)
  1262. {
  1263. this->echo_enabled = BOOL_TRUE;
  1264. }
  1265. /*--------------------------------------------------------- */
  1266. void
  1267. tinyrl_disable_echo(tinyrl_t *this,
  1268. char echo_char)
  1269. {
  1270. this->echo_enabled = BOOL_FALSE;
  1271. this->echo_char = echo_char;
  1272. }
  1273. /*--------------------------------------------------------- */
  1274. void
  1275. tinyrl__set_istream(tinyrl_t *this,
  1276. FILE *istream)
  1277. {
  1278. tinyrl_vt100__set_istream(this->term,istream);
  1279. this->isatty = isatty(fileno(istream)) ? BOOL_TRUE : BOOL_FALSE;
  1280. }
  1281. /*-------------------------------------------------------- */
  1282. bool_t
  1283. tinyrl__get_isatty(const tinyrl_t *this)
  1284. {
  1285. return this->isatty;
  1286. }
  1287. /*-------------------------------------------------------- */
  1288. FILE *
  1289. tinyrl__get_istream(const tinyrl_t *this)
  1290. {
  1291. return tinyrl_vt100__get_istream(this->term);
  1292. }
  1293. /*-------------------------------------------------------- */
  1294. FILE *
  1295. tinyrl__get_ostream(const tinyrl_t *this)
  1296. {
  1297. return tinyrl_vt100__get_ostream(this->term);
  1298. }
  1299. /*-------------------------------------------------------- */
  1300. const char *
  1301. tinyrl__get_prompt(const tinyrl_t *this)
  1302. {
  1303. return this->prompt;
  1304. }
  1305. /*-------------------------------------------------------- */
  1306. bool_t
  1307. tinyrl_is_quoting(const tinyrl_t *this)
  1308. {
  1309. bool_t result = BOOL_FALSE;
  1310. /* count the quotes upto the current insertion point */
  1311. unsigned i = 0;
  1312. while(i < this->point)
  1313. {
  1314. if(this->line[i++] == '"')
  1315. {
  1316. result = result ? BOOL_FALSE : BOOL_TRUE;
  1317. }
  1318. }
  1319. return result;
  1320. }
  1321. /*--------------------------------------------------------- */
  1322. void
  1323. tinyrl_limit_line_length(tinyrl_t *this, unsigned length)
  1324. {
  1325. this->max_line_length = length;
  1326. }
  1327. /*--------------------------------------------------------- */