private.h 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  1. /*
  2. * shell.h - private interface to the shell class
  3. */
  4. #include "lub/bintree.h"
  5. #include "tinyrl/tinyrl.h"
  6. #include "clish/shell.h"
  7. #include "clish/pargv.h"
  8. #include "clish/var.h"
  9. #include "clish/action.h"
  10. /*-------------------------------------
  11. * PRIVATE TYPES
  12. *------------------------------------- */
  13. /*-------------------------------------------------------- */
  14. /*
  15. * iterate around commands
  16. */
  17. typedef struct {
  18. const char *last_cmd;
  19. clish_nspace_visibility_t field;
  20. } clish_shell_iterator_t;
  21. /* this is used to maintain a stack of file handles */
  22. typedef struct clish_shell_file_s clish_shell_file_t;
  23. struct clish_shell_file_s {
  24. clish_shell_file_t *next;
  25. FILE *file;
  26. bool_t stop_on_error; /* stop on error for file input */
  27. };
  28. typedef struct {
  29. char *line;
  30. clish_view_t *view;
  31. lub_bintree_t viewid;
  32. } clish_shell_pwd_t;
  33. struct clish_shell_s {
  34. lub_bintree_t view_tree; /* Maintain a tree of views */
  35. lub_bintree_t ptype_tree; /* Maintain a tree of ptypes */
  36. lub_bintree_t var_tree; /* Maintain a tree of global variables */
  37. const clish_shell_hooks_t *client_hooks; /* Client callback hooks */
  38. void *client_cookie; /* Client callback cookie */
  39. clish_view_t *global; /* Reference to the global view. */
  40. clish_command_t *startup; /* This is the startup command */
  41. unsigned int idle_timeout; /* This is the idle timeout */
  42. clish_command_t *wdog; /* This is the watchdog command */
  43. unsigned int wdog_timeout; /* This is the watchdog timeout */
  44. bool_t wdog_active; /* If watchdog is active now */
  45. clish_shell_state_t state; /* The current state */
  46. char *overview; /* Overview text for this shell */
  47. tinyrl_t *tinyrl; /* Tiny readline instance */
  48. clish_shell_file_t *current_file; /* file currently in use for input */
  49. clish_shell_pwd_t **pwdv; /* Levels for the config file structure */
  50. unsigned int pwdc;
  51. int depth;
  52. konf_client_t *client;
  53. char *lockfile;
  54. pthread_t pthread;
  55. char *default_shebang;
  56. char *fifo_name; /* The name of temporary fifo file. */
  57. bool_t interactive; /* Is shell interactive. */
  58. bool_t log; /* If command logging is enabled */
  59. /* Static params for var expanding. The refactoring is needed. */
  60. clish_param_t *param_depth;
  61. clish_param_t *param_pwd;
  62. };
  63. /**
  64. * Initialise a command iterator structure
  65. */
  66. void
  67. clish_shell_iterator_init(clish_shell_iterator_t * iter,
  68. clish_nspace_visibility_t field);
  69. /**
  70. * get the next command which is an extension of the specified line
  71. */
  72. const clish_command_t *clish_shell_find_next_completion(const clish_shell_t *
  73. instance, const char *line, clish_shell_iterator_t * iter);
  74. /**
  75. * Pop the current file handle from the stack of file handles, shutting
  76. * the file down and freeing any associated memory. The next file handle
  77. * in the stack becomes associated with the input stream for this shell.
  78. *
  79. * \return
  80. * BOOL_TRUE - the current file handle has been replaced.
  81. * BOOL_FALSE - there is only one handle on the stack which cannot be replaced.
  82. */
  83. int clish_shell_pop_file(clish_shell_t * instance);
  84. clish_view_t *clish_shell_find_view(clish_shell_t * instance, const char *name);
  85. void clish_shell_insert_view(clish_shell_t * instance, clish_view_t * view);
  86. clish_pargv_status_t clish_shell_parse(clish_shell_t * instance,
  87. const char *line, const clish_command_t ** cmd, clish_pargv_t ** pargv);
  88. clish_pargv_status_t clish_shell_parse_pargv(clish_pargv_t *pargv,
  89. const clish_command_t *cmd,
  90. void *context,
  91. clish_paramv_t *paramv,
  92. const lub_argv_t *argv,
  93. unsigned *idx, clish_pargv_t *last, unsigned need_index);
  94. char *clish_shell_word_generator(clish_shell_t * instance,
  95. const char *line, unsigned offset, unsigned state);
  96. const clish_command_t *clish_shell_resolve_command(const clish_shell_t *
  97. instance, const char *line);
  98. const clish_command_t *clish_shell_resolve_prefix(const clish_shell_t *
  99. instance, const char *line);
  100. void clish_shell_insert_ptype(clish_shell_t * instance, clish_ptype_t * ptype);
  101. void clish_shell_tinyrl_history(clish_shell_t * instance, unsigned int *limit);
  102. tinyrl_t *clish_shell_tinyrl_new(FILE * instream,
  103. FILE * outstream, unsigned stifle);
  104. void clish_shell_tinyrl_delete(tinyrl_t * instance);
  105. void clish_shell_param_generator(clish_shell_t * instance, lub_argv_t *matches,
  106. const clish_command_t * cmd, const char *line, unsigned offset);
  107. char **clish_shell_tinyrl_completion(tinyrl_t * tinyrl,
  108. const char *line, unsigned start, unsigned end);
  109. void clish_shell__expand_viewid(const char *viewid, lub_bintree_t *tree,
  110. clish_context_t *context);
  111. void clish_shell__init_pwd(clish_shell_pwd_t *pwd);
  112. void clish_shell__fini_pwd(clish_shell_pwd_t *pwd);
  113. int clish_shell_timeout_fn(tinyrl_t *tinyrl);
  114. int clish_shell_keypress_fn(tinyrl_t *tinyrl, int key);