src/terminal/terminal.h

   1 #ifndef EL__TERMINAL_TERMINAL_H
   2 #define EL__TERMINAL_TERMINAL_H
   3
   4 #include "config/options.h"
   5 #include "terminal/event.h"
   6 #include "util/lists.h"
   7
   8 struct option;
   9 struct terminal_screen;
  10 struct terminal_interlink;
  11
  12
  13 /* The terminal type, meaningful for frames (lines) drawing. */
  14 enum term_mode_type {
  15         TERM_DUMB = 0,
  16         TERM_VT100,
  17         TERM_LINUX,
  18         TERM_KOI8,
  19         TERM_FREEBSD,
  20 };
  21
  22 /* This is a bitmask describing the environment we are living in,
  23  * terminal-wise. We can then conditionally use various features available
  24  * in such an environment. */
  25 enum term_env_type {
  26         /* This basically means that we can use the text i/o :). Always set. */
  27         ENV_CONSOLE = 1,
  28         /* We are running in a xterm-compatible box in some windowing
  29          * environment. */
  30         ENV_XWIN = 2,
  31         /* We are running under a screen. */
  32         ENV_SCREEN = 4,
  33         /* We are running in a OS/2 VIO terminal. */
  34         ENV_OS2VIO = 8,
  35         /* BeOS text terminal. */
  36         ENV_BE = 16,
  37         /* We live in a TWIN text-mode windowing environment. */
  38         ENV_TWIN = 32,
  39         /* Microsoft Windows cmdline thing. */
  40         ENV_WIN32 = 64,
  41         /* Match all terminal environments */
  42         ENV_ANY = ~0,
  43 };
  44
  45 enum term_redrawing_state {
  46         TREDRAW_READY = 0,      /* Can redraw */
  47         TREDRAW_BUSY = 1,       /* Redrawing already in progress */
  48         TREDRAW_DELAYED = 2,    /* Do not redraw for now */
  49 };
  50
  51 /* This is one of the axis of ELinks' user interaction. {struct terminal}
  52  * defines the terminal ELinks is running on --- each ELinks instance has
  53  * one. It contains the basic terminal attributes, the settings associated
  54  * with this terminal, screen content (and more abstract description of what
  55  * is currently displayed on it) etc. It also maintains some runtime
  56  * information about the actual ELinks instance owning this terminal. */
  57 /* TODO: Regroup the following into logical chunks. --pasky */
  58 struct terminal {
  59         LIST_HEAD(struct terminal); /* {terminals} */
  60
  61         /* This is (at least partially) a stack of all the windows living in
  62          * this terminal. A window can be wide range of stuff, from a menu box
  63          * through classical dialog window to a tab. See terminal/window.h for
  64          * more on windows.
  65          *
  66          * Tabs are special windows, though, and you never want to display them
  67          * all, but only one of them. ALWAYS check {inactive_tab} during
  68          * iterations through this list (unless it is really useless or you
  69          * are sure what are you doing) to make sure that you don't distribute
  70          * events etc to inactive tabs.
  71          *
  72          * The stack is top-down, thus .next is the stack's top, the current
  73          * window. .prev is the first tab.
  74          *
  75          * FIXME: Tabs violate the stack nature of this list, they appear there
  76          * randomly but always in the order in which they were inserted there.
  77          * Eventually, they should all live at the stack bottom, with the
  78          * actual tab living on the VERY bottom. --pasky */
  79         struct list_head windows; /* {struct window} */
  80
  81         /* The specification of terminal in terms of terminal options. */
  82         struct option *spec;
  83
  84         /* This is the terminal's current title, as perhaps displayed somewhere
  85          * in the X window frame or so. */
  86         unsigned char *title;
  87
  88         /* This is the screen. See terminal/screen.h */
  89         struct terminal_screen *screen;
  90
  91         /* These are pipes for communication with the ELinks instance owning
  92          * this terminal. */
  93         int fdin, fdout;
  94
  95         /* This indicates that the terminal is blocked, that is nothing should
  96          * be drawn on it etc. Typically an external program is running on it
  97          * right now. This is a file descriptor. */
  98         int blocked;
  99
 100         /* Terminal dimensions. */
 101         int width, height;
 102
 103         /* Indicates whether we are currently in the process of redrawing the
 104          * stuff being displayed on the terminal. It is typically used to
 105          * prevent redrawing inside of redrawing. */
 106         enum term_redrawing_state redrawing;
 107
 108         /* Indicates the master terminal, that is the terminal under
 109          * supervision of the master ELinks instance (the one doing all the
 110          * work and even maintaining these structures ;-). */
 111         unsigned int master:1;
 112
 113         /* The current tab number. */
 114         int current_tab;
 115
 116 #ifdef CONFIG_LEDS
 117         /* Current length of leds part of status bar. */
 118         int leds_length;
 119 #endif
 120
 121         /* The type of environment this terminal lives in. */
 122         enum term_env_type environment;
 123
 124         /* The current working directory for this terminal / ELinks instance. */
 125         unsigned char cwd[MAX_CWD_LEN];
 126
 127         /* For communication between instances */
 128         struct terminal_interlink *interlink;
 129
 130         struct term_event_mouse prev_mouse_event;
 131 };
 132
 133 #define do_not_ignore_next_mouse_event(term) \
 134         memset(&(term)->prev_mouse_event, 0, sizeof((term)->prev_mouse_event))
 135
 136 /* We keep track about all the terminals in this list. */
 137 extern struct list_head terminals;
 138
 139
 140 extern unsigned char frame_dumb[];
 141
 142 struct terminal *init_term(int, int);
 143 void destroy_terminal(struct terminal *);
 144 void redraw_terminal(struct terminal *term);
 145 void redraw_terminal_cls(struct terminal *term);
 146 void cls_redraw_all_terminals(void);
 147
 148 void redraw_all_terminals(void);
 149 void destroy_all_terminals(void);
 150 void exec_thread(unsigned char *, int);
 151 void close_handle(void *);
 152
 153 #define TERM_FN_TITLE   1
 154 #define TERM_FN_RESIZE  2
 155
 156 void exec_on_terminal(struct terminal *, unsigned char *, unsigned char *, int);
 157 void exec_shell(struct terminal *term);
 158
 159 void set_terminal_title(struct terminal *, unsigned char *);
 160 void do_terminal_function(struct terminal *, unsigned char, unsigned char *);
 161
 162 int check_terminal_pipes(void);
 163 void close_terminal_pipes(void);
 164 struct terminal *attach_terminal(int in, int out, int ctl, void *info, int len);
 165
 166 #endif /* EL__TERMINAL_TERMINAL_H */