lib/widget/input.h

   1
   2 /** \file input.h
   3  *  \brief Header: WInput widget
   4  */
   5
   6 #ifndef MC__WIDGET_INPUT_H
   7 #define MC__WIDGET_INPUT_H
   8
   9 #include "lib/keybind.h"        /* global_keymap_t */
  10
  11 /*** typedefs(not structures) and defined constants **********************************************/
  12
  13 #define INPUT(x) ((WInput *)(x))
  14
  15 /* For history load-save functions */
  16 #define INPUT_LAST_TEXT ((char *) 2)
  17
  18 /*** enums ***************************************************************************************/
  19
  20 typedef enum
  21 {
  22     WINPUTC_MAIN,               /* color used */
  23     WINPUTC_MARK,               /* color for marked text */
  24     WINPUTC_UNCHANGED,          /* color for inactive text (Is first keystroke) */
  25     WINPUTC_HISTORY,            /* color for history list */
  26     WINPUTC_COUNT_COLORS        /* count of used colors */
  27 } input_colors_enum_t;
  28
  29 /* completion flags */
  30 typedef enum
  31 {
  32     INPUT_COMPLETE_NONE = 0,
  33     INPUT_COMPLETE_FILENAMES = 1 << 0,
  34     INPUT_COMPLETE_HOSTNAMES = 1 << 1,
  35     INPUT_COMPLETE_COMMANDS = 1 << 2,
  36     INPUT_COMPLETE_VARIABLES = 1 << 3,
  37     INPUT_COMPLETE_USERNAMES = 1 << 4,
  38     INPUT_COMPLETE_CD = 1 << 5,
  39     INPUT_COMPLETE_SHELL_ESC = 1 << 6,
  40 } input_complete_t;
  41
  42 /*** structures declarations (and typedefs of structures)*****************************************/
  43
  44 typedef int input_colors_t[WINPUTC_COUNT_COLORS];
  45
  46 typedef struct
  47 {
  48     Widget widget;
  49     const int *color;
  50     int point;                  /* cursor position in the input line in characters */
  51     int mark;                   /* the mark position in characters; negative value means no marked text */
  52     int term_first_shown;       /* column of the first shown character */
  53     size_t current_max_size;    /* maximum length of input line (bytes) */
  54     gboolean first;             /* is first keystroke? */
  55     int disable_update;         /* do we want to skip updates? */
  56     gboolean is_password;       /* is this a password input line? */
  57     gboolean init_from_history; /* init text will be get from history */
  58     char *buffer;               /* pointer to editing buffer */
  59     gboolean need_push;         /* need to push the current Input on hist? */
  60     gboolean strip_password;    /* need to strip password before placing string to history */
  61     char **completions;         /* possible completions array */
  62     input_complete_t completion_flags;
  63     char charbuf[MB_LEN_MAX];   /* buffer for multibytes characters */
  64     size_t charpoint;           /* point to end of mulibyte sequence in charbuf */
  65     WLabel *label;              /* label associated with this input line */
  66     struct input_history_t
  67     {
  68         char *name;             /* name of history for loading and saving */
  69         GList *list;            /* the history */
  70         GList *current;         /* current history item */
  71         gboolean changed;       /* the history has changed */
  72     } history;
  73 } WInput;
  74
  75 /*** global variables defined in .c file *********************************************************/
  76
  77 extern int quote;
  78
  79 extern const global_keymap_t *input_map;
  80
  81 /* Color styles for normal and command line input widgets */
  82 extern input_colors_t input_colors;
  83
  84 /*** declarations of public functions ************************************************************/
  85
  86 WInput *input_new (int y, int x, const int *colors,
  87                    int len, const char *text, const char *histname,
  88                    input_complete_t completion_flags);
  89 /* callbac is public; needed for command line */
  90 cb_ret_t input_callback (Widget * w, Widget * sender, widget_msg_t msg, int parm, void *data);
  91 void input_set_default_colors (void);
  92 cb_ret_t input_handle_char (WInput * in, int key);
  93 int input_key_is_in_map (WInput * in, int key);
  94 void input_assign_text (WInput * in, const char *text);
  95 gboolean input_is_empty (const WInput * in);
  96 void input_insert (WInput * in, const char *text, gboolean insert_extra_space);
  97 void input_set_point (WInput * in, int pos);
  98 void input_update (WInput * in, gboolean clear_first);
  99 void input_enable_update (WInput * in);
 100 void input_disable_update (WInput * in);
 101 void input_clean (WInput * in);
 102 void input_free_completions (WInput * in);
 103
 104 /*** inline functions ****************************************************************************/
 105
 106 #endif /* MC__WIDGET_INPUT_H */