1
0

private.h 5.0 KB

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