tinyrl.h 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222
  1. #ifndef _tinyrl_tinyrl_h
  2. #define _tinyrl_tinyrl_h
  3. #include <stdio.h>
  4. #include <faux/faux.h>
  5. C_DECL_BEGIN
  6. typedef struct tinyrl_s tinyrl_t;
  7. typedef enum {
  8. /**
  9. * no possible completions were found
  10. */
  11. TINYRL_NO_MATCH = 0,
  12. /**
  13. * the provided string was already an exact match
  14. */
  15. TINYRL_MATCH,
  16. /**
  17. * the provided string was ambiguous and produced
  18. * more than one possible completion
  19. */
  20. TINYRL_AMBIGUOUS,
  21. /**
  22. * the provided string was unambiguous and a
  23. * completion was performed
  24. */
  25. TINYRL_COMPLETED_MATCH,
  26. /**
  27. * the provided string was ambiguous but a partial
  28. * completion was performed.
  29. */
  30. TINYRL_COMPLETED_AMBIGUOUS,
  31. /**
  32. * the provided string was an exact match for one
  33. * possible value but there are other exetensions
  34. * of the string available.
  35. */
  36. TINYRL_MATCH_WITH_EXTENSIONS
  37. } tinyrl_match_e;
  38. /* virtual methods */
  39. typedef char *tinyrl_compentry_func_t(tinyrl_t * instance,
  40. const char *text, unsigned offset, unsigned state);
  41. typedef int tinyrl_hook_func_t(tinyrl_t * instance);
  42. typedef char **tinyrl_completion_func_t(tinyrl_t * instance,
  43. const char *text, unsigned start, unsigned end);
  44. typedef int tinyrl_timeout_fn_t(tinyrl_t *instance);
  45. /**
  46. * \return
  47. * - BOOL_TRUE if the action associated with the key has
  48. * been performed successfully
  49. * - BOOL_FALSE if the action was not successful
  50. */
  51. typedef bool_t tinyrl_key_func_t(tinyrl_t * instance, int key);
  52. tinyrl_t *tinyrl_new(FILE *istream, FILE *ostream,
  53. const char *hist_fname, size_t hist_stifle);
  54. void tinyrl_free(tinyrl_t *tinyrl);
  55. bool_t tinyrl_bind_key(tinyrl_t *tinyrl, int key, tinyrl_key_func_t *fn);
  56. void tinyrl_set_istream(tinyrl_t *tinyrl, FILE *istream);
  57. FILE *tinyrl_istream(const tinyrl_t *tinyrl);
  58. void tinyrl_set_ostream(tinyrl_t *tinyrl, FILE *ostream);
  59. FILE *tinyrl_ostream(const tinyrl_t *tinyrl);
  60. void tinyrl_set_utf8(tinyrl_t *tinyrl, bool_t utf8);
  61. bool_t tinyrl_utf8(const tinyrl_t *tinyrl);
  62. bool_t tinyrl_hist_save(const tinyrl_t *tinyrl);
  63. bool_t tinyrl_hist_restore(tinyrl_t *tinyrl);
  64. void tty_raw_mode(tinyrl_t *tinyrl);
  65. void tty_restore_mode(tinyrl_t *tinyrl);
  66. int tinyrl_read(tinyrl_t *tinyrl);
  67. /*lint -esym(534,tinyrl_printf) Ignoring return value of function */
  68. extern int tinyrl_printf(const tinyrl_t * instance, const char *fmt, ...);
  69. extern const char *tinyrl__get_prompt(const tinyrl_t * instance);
  70. extern void tinyrl__set_prompt(tinyrl_t *instance, const char *prompt);
  71. extern void tinyrl_done(tinyrl_t * instance);
  72. extern void tinyrl_completion_over(tinyrl_t * instance);
  73. extern void tinyrl_completion_error_over(tinyrl_t * instance);
  74. extern bool_t tinyrl_is_completion_error_over(const tinyrl_t * instance);
  75. extern void *tinyrl__get_context(const tinyrl_t * instance);
  76. /**
  77. * This operation returns the current line in use by the tinyrl instance
  78. * NB. the pointer will become invalid after any further operation on the
  79. * instance.
  80. */
  81. extern const char *tinyrl__get_line(const tinyrl_t * instance);
  82. extern bool_t tinyrl__get_utf8(const tinyrl_t * instance);
  83. extern void tinyrl__set_utf8(tinyrl_t * instance, bool_t utf8);
  84. extern void tinyrl__set_hotkey_fn(tinyrl_t *instance,
  85. tinyrl_key_func_t *fn);
  86. extern char *tinyrl_readline(tinyrl_t *instance, void *context);
  87. extern char *tinyrl_forceline(tinyrl_t *instance,
  88. void *context, const char *line);
  89. extern void tinyrl_delete_matches(char **instance);
  90. extern char **tinyrl_completion(tinyrl_t *instance,
  91. const char *line, unsigned start, unsigned end,
  92. tinyrl_compentry_func_t *generator);
  93. extern void tinyrl_crlf(const tinyrl_t * instance);
  94. extern void tinyrl_multi_crlf(const tinyrl_t * instance);
  95. extern void tinyrl_ding(const tinyrl_t * instance);
  96. extern void tinyrl_reset_line_state(tinyrl_t * instance);
  97. extern bool_t tinyrl_insert_text(tinyrl_t * instance, const char *text);
  98. extern void
  99. tinyrl_delete_text(tinyrl_t * instance, unsigned start, unsigned end);
  100. extern void tinyrl_redisplay(tinyrl_t * instance);
  101. extern void
  102. tinyrl_replace_line(tinyrl_t * instance, const char *text, int clear_undo);
  103. /**
  104. * Complete the current word in the input buffer, displaying
  105. * a prompt to clarify any abiguity if necessary.
  106. *
  107. * \return
  108. * - the type of match performed.
  109. * \post
  110. * - If the current word is ambiguous then a list of
  111. * possible completions will be displayed.
  112. */
  113. extern tinyrl_match_e tinyrl_complete(tinyrl_t * instance);
  114. /**
  115. * Complete the current word in the input buffer, displaying
  116. * a prompt to clarify any abiguity or extra extensions if necessary.
  117. *
  118. * \return
  119. * - the type of match performed.
  120. * \post
  121. * - If the current word is ambiguous then a list of
  122. * possible completions will be displayed.
  123. * - If the current word is complete but there are extra
  124. * completions which are an extension of that word then
  125. * a list of these will be displayed.
  126. */
  127. extern tinyrl_match_e tinyrl_complete_with_extensions(tinyrl_t * instance);
  128. /**
  129. * Disable echoing of input characters when a line in input.
  130. *
  131. */
  132. extern void tinyrl_disable_echo(
  133. /**
  134. * The instance on which to operate
  135. */
  136. tinyrl_t * instance,
  137. /**
  138. * The character to display instead of a key press.
  139. *
  140. * If this has the special value '/0' then the insertion point will not
  141. * be moved when keys are pressed.
  142. */
  143. char echo_char);
  144. /**
  145. * Enable key echoing for this instance. (This is the default behaviour)
  146. */
  147. extern void tinyrl_enable_echo(
  148. /**
  149. * The instance on which to operate
  150. */
  151. tinyrl_t * instance);
  152. /**
  153. * Indicate whether the current insertion point is quoting or not
  154. */
  155. extern bool_t tinyrl_is_quoting(
  156. /**
  157. * The instance on which to operate
  158. */
  159. const tinyrl_t * instance);
  160. /**
  161. * Indicate whether the current insertion is empty or not
  162. */
  163. extern bool_t
  164. tinyrl_is_empty(
  165. /**
  166. * The instance on which to operate
  167. */
  168. const tinyrl_t *instance
  169. );
  170. /**
  171. * Limit maximum line length
  172. */
  173. extern void tinyrl_limit_line_length(
  174. /**
  175. * The instance on which to operate
  176. */
  177. tinyrl_t * instance,
  178. /**
  179. * The length to limit to (0) is unlimited
  180. */
  181. unsigned length);
  182. extern unsigned tinyrl__get_width(const tinyrl_t *instance);
  183. extern unsigned tinyrl__get_height(const tinyrl_t *instance);
  184. C_DECL_END
  185. #endif /* _tinyrl_tinyrl_h */