private.h 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152
  1. /*
  2. * shell/private.h - private interface to the shell class
  3. */
  4. #include "lub/bintree.h"
  5. #include "lub/list.h"
  6. #include "tinyrl/tinyrl.h"
  7. #include "clish/shell.h"
  8. #include "clish/pargv.h"
  9. #include "clish/var.h"
  10. #include "clish/action.h"
  11. #include "clish/plugin.h"
  12. #include "clish/udata.h"
  13. /*-------------------------------------
  14. * PRIVATE TYPES
  15. *------------------------------------- */
  16. /*-------------------------------------------------------- */
  17. /*
  18. * iterate around commands
  19. */
  20. typedef struct {
  21. const char *last_cmd;
  22. clish_nspace_visibility_t field;
  23. } clish_shell_iterator_t;
  24. /* this is used to maintain a stack of file handles */
  25. typedef struct clish_shell_file_s clish_shell_file_t;
  26. struct clish_shell_file_s {
  27. clish_shell_file_t *next;
  28. FILE *file;
  29. char *fname;
  30. unsigned int line;
  31. bool_t stop_on_error; /* stop on error for file input */
  32. };
  33. typedef struct {
  34. char *line;
  35. clish_view_t *view;
  36. lub_bintree_t viewid;
  37. } clish_shell_pwd_t;
  38. /* Context structure */
  39. struct clish_context_s {
  40. clish_shell_t *shell;
  41. const clish_command_t *cmd;
  42. clish_pargv_t *pargv;
  43. const clish_action_t *action;
  44. };
  45. /* Shell structure */
  46. struct clish_shell_s {
  47. lub_bintree_t view_tree; /* Tree of views */
  48. lub_bintree_t ptype_tree; /* Tree of ptypes */
  49. lub_bintree_t var_tree; /* Tree of global variables */
  50. /* Hooks */
  51. clish_sym_t *hooks[CLISH_SYM_TYPE_MAX]; /* Callback hooks */
  52. bool_t hooks_use[CLISH_SYM_TYPE_MAX]; /* Is hook defined */
  53. clish_view_t *global; /* Reference to the global view. */
  54. clish_command_t *startup; /* This is the startup command */
  55. unsigned int idle_timeout; /* This is the idle timeout */
  56. /* Watchdog */
  57. clish_command_t *wdog; /* Watchdog command */
  58. unsigned int wdog_timeout; /* Watchdog timeout */
  59. bool_t wdog_active; /* If watchdog is active now */
  60. clish_shell_state_t state; /* The current state */
  61. char *overview; /* Overview text for this shell */
  62. tinyrl_t *tinyrl; /* Tiny readline instance */
  63. clish_shell_file_t *current_file; /* file currently in use for input */
  64. clish_shell_pwd_t **pwdv; /* Levels for the config file structure */
  65. unsigned int pwdc;
  66. int depth;
  67. konf_client_t *client;
  68. char *lockfile;
  69. char *default_shebang;
  70. char *fifo_temp; /* The template of temporary FIFO file name */
  71. struct passwd *user; /* Current user information */
  72. /* Boolean flags */
  73. bool_t interactive; /* Is shell interactive. */
  74. bool_t log; /* If command logging is enabled */
  75. int log_facility; /* Syslog facility */
  76. bool_t dryrun; /* Is this a dry-running */
  77. bool_t default_plugin; /* Use or not default plugin */
  78. /* Plugins and symbols */
  79. lub_list_t *plugins; /* List of plugins */
  80. lub_list_t *syms; /* List of all used symbols. Must be resolved. */
  81. /* Userdata list holder */
  82. lub_list_t *udata;
  83. };
  84. /**
  85. * Initialise a command iterator structure
  86. */
  87. void
  88. clish_shell_iterator_init(clish_shell_iterator_t * iter,
  89. clish_nspace_visibility_t field);
  90. /**
  91. * get the next command which is an extension of the specified line
  92. */
  93. const clish_command_t *clish_shell_find_next_completion(const clish_shell_t *
  94. instance, const char *line, clish_shell_iterator_t * iter);
  95. /**
  96. * Pop the current file handle from the stack of file handles, shutting
  97. * the file down and freeing any associated memory. The next file handle
  98. * in the stack becomes associated with the input stream for this shell.
  99. *
  100. * \return
  101. * BOOL_TRUE - the current file handle has been replaced.
  102. * BOOL_FALSE - there is only one handle on the stack which cannot be replaced.
  103. */
  104. int clish_shell_pop_file(clish_shell_t * instance);
  105. clish_view_t *clish_shell_find_view(clish_shell_t * instance, const char *name);
  106. void clish_shell_insert_view(clish_shell_t * instance, clish_view_t * view);
  107. clish_pargv_status_t clish_shell_parse(clish_shell_t * instance,
  108. const char *line, const clish_command_t ** cmd, clish_pargv_t ** pargv);
  109. clish_pargv_status_t clish_shell_parse_pargv(clish_pargv_t *pargv,
  110. const clish_command_t *cmd,
  111. void *context,
  112. clish_paramv_t *paramv,
  113. const lub_argv_t *argv,
  114. unsigned *idx, clish_pargv_t *last, unsigned need_index);
  115. char *clish_shell_word_generator(clish_shell_t * instance,
  116. const char *line, unsigned offset, unsigned state);
  117. const clish_command_t *clish_shell_resolve_command(const clish_shell_t *
  118. instance, const char *line);
  119. const clish_command_t *clish_shell_resolve_prefix(const clish_shell_t *
  120. instance, const char *line);
  121. void clish_shell_insert_ptype(clish_shell_t * instance, clish_ptype_t * ptype);
  122. void clish_shell_tinyrl_history(clish_shell_t * instance, unsigned int *limit);
  123. tinyrl_t *clish_shell_tinyrl_new(FILE * instream,
  124. FILE * outstream, unsigned stifle);
  125. void clish_shell_tinyrl_delete(tinyrl_t * instance);
  126. void clish_shell_param_generator(clish_shell_t * instance, lub_argv_t *matches,
  127. const clish_command_t * cmd, const char *line, unsigned offset);
  128. char **clish_shell_tinyrl_completion(tinyrl_t * tinyrl,
  129. const char *line, unsigned start, unsigned end);
  130. void clish_shell__expand_viewid(const char *viewid, lub_bintree_t *tree,
  131. clish_context_t *context);
  132. void clish_shell__init_pwd(clish_shell_pwd_t *pwd);
  133. void clish_shell__fini_pwd(clish_shell_pwd_t *pwd);
  134. int clish_shell_timeout_fn(tinyrl_t *tinyrl);
  135. int clish_shell_keypress_fn(tinyrl_t *tinyrl, int key);