private.h 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155
  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_e 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_pargv_t *pargv; /* Saved pargv structure */
  38. char *cmd; /* Command name without prefix */
  39. char *prefix; /* Prefix string if exists */
  40. } clish_shell_pwd_t;
  41. /* Context structure */
  42. struct clish_context_s {
  43. clish_shell_t *shell;
  44. const clish_command_t *cmd;
  45. clish_pargv_t *pargv;
  46. const clish_action_t *action;
  47. };
  48. /* Shell structure */
  49. struct clish_shell_s {
  50. lub_bintree_t view_tree; /* Tree of views */
  51. lub_bintree_t ptype_tree; /* Tree of ptypes */
  52. lub_bintree_t var_tree; /* Tree of global variables */
  53. /* Hooks */
  54. clish_sym_t *hooks[CLISH_SYM_TYPE_MAX]; /* Callback hooks */
  55. bool_t hooks_use[CLISH_SYM_TYPE_MAX]; /* Is hook defined */
  56. clish_view_t *global; /* Reference to the global view. */
  57. clish_command_t *startup; /* This is the startup command */
  58. unsigned int idle_timeout; /* This is the idle timeout */
  59. /* Watchdog */
  60. clish_command_t *wdog; /* Watchdog command */
  61. unsigned int wdog_timeout; /* Watchdog timeout */
  62. bool_t wdog_active; /* If watchdog is active now */
  63. clish_shell_state_e state; /* The current state */
  64. char *overview; /* Overview text for this shell */
  65. tinyrl_t *tinyrl; /* Tiny readline instance */
  66. clish_shell_file_t *current_file; /* file currently in use for input */
  67. clish_shell_pwd_t **pwdv; /* Levels for the config file structure */
  68. unsigned int pwdc;
  69. int depth;
  70. konf_client_t *client;
  71. char *lockfile;
  72. char *default_shebang;
  73. char *fifo_name; /* The name of temporary fifo file. */
  74. struct passwd *user; /* Current user information */
  75. /* Boolean flags */
  76. bool_t interactive; /* Is shell interactive. */
  77. bool_t log; /* If command logging is enabled */
  78. int log_facility; /* Syslog facility */
  79. bool_t dryrun; /* Is this a dry-running */
  80. bool_t default_plugin; /* Use or not default plugin */
  81. /* Plugins and symbols */
  82. lub_list_t *plugins; /* List of plugins */
  83. lub_list_t *syms; /* List of all used symbols. Must be resolved. */
  84. /* Userdata list holder */
  85. lub_list_t *udata;
  86. };
  87. /**
  88. * Initialise a command iterator structure
  89. */
  90. void
  91. clish_shell_iterator_init(clish_shell_iterator_t * iter,
  92. clish_nspace_visibility_e field);
  93. /**
  94. * get the next command which is an extension of the specified line
  95. */
  96. const clish_command_t *clish_shell_find_next_completion(const clish_shell_t *
  97. instance, const char *line, clish_shell_iterator_t * iter);
  98. /**
  99. * Pop the current file handle from the stack of file handles, shutting
  100. * the file down and freeing any associated memory. The next file handle
  101. * in the stack becomes associated with the input stream for this shell.
  102. *
  103. * \return
  104. * BOOL_TRUE - the current file handle has been replaced.
  105. * BOOL_FALSE - there is only one handle on the stack which cannot be replaced.
  106. */
  107. int clish_shell_pop_file(clish_shell_t * instance);
  108. clish_view_t *clish_shell_find_view(clish_shell_t * instance, const char *name);
  109. void clish_shell_insert_view(clish_shell_t * instance, clish_view_t * view);
  110. clish_pargv_status_e clish_shell_parse(clish_shell_t * instance,
  111. const char *line, const clish_command_t ** cmd, clish_pargv_t ** pargv);
  112. clish_pargv_status_e clish_shell_parse_pargv(clish_pargv_t *pargv,
  113. const clish_command_t *cmd,
  114. void *context,
  115. clish_paramv_t *paramv,
  116. const lub_argv_t *argv,
  117. unsigned *idx, clish_pargv_t *last, unsigned need_index);
  118. char *clish_shell_word_generator(clish_shell_t * instance,
  119. const char *line, unsigned offset, unsigned state);
  120. const clish_command_t *clish_shell_resolve_command(const clish_shell_t *
  121. instance, const char *line);
  122. const clish_command_t *clish_shell_resolve_prefix(const clish_shell_t *
  123. instance, const char *line);
  124. void clish_shell_insert_ptype(clish_shell_t * instance, clish_ptype_t * ptype);
  125. void clish_shell_tinyrl_history(clish_shell_t * instance, unsigned int *limit);
  126. tinyrl_t *clish_shell_tinyrl_new(FILE * instream,
  127. FILE * outstream, unsigned stifle);
  128. void clish_shell_tinyrl_delete(tinyrl_t * instance);
  129. void clish_shell_param_generator(clish_shell_t * instance, lub_argv_t *matches,
  130. const clish_command_t * cmd, const char *line, unsigned offset);
  131. char **clish_shell_tinyrl_completion(tinyrl_t * tinyrl,
  132. const char *line, unsigned start, unsigned end);
  133. void clish_shell__expand_viewid(const char *viewid, lub_bintree_t *tree,
  134. clish_context_t *context);
  135. void clish_shell__init_pwd(clish_shell_pwd_t *pwd);
  136. void clish_shell__fini_pwd(clish_shell_pwd_t *pwd);
  137. int clish_shell_timeout_fn(tinyrl_t *tinyrl);
  138. int clish_shell_keypress_fn(tinyrl_t *tinyrl, int key);