src/rxvtlib.h.in

   1 #ifndef _RXVTLIB_H_             /* include once only */
   2 #define _RXVTLIB_H_
   3
   4 #include <cstdio>
   5 #include <cctype>
   6 #include <cerrno>
   7 @include_stdarg_h@
   8 @include_stdlib_h@
   9 @include_stdint_h@
  10 #include <sys/types.h>
  11 @include_unistd_h@
  12 @include_string_h@
  13 @include_fcntl_h@
  14 @include_util_h@
  15 @include_assert_h@
  16 @include_sys_ioctl_h@
  17 @include_sys_time_h@
  18 @include_time_h@
  19 @include_sys_select_h@
  20 @include_sys_strredir_h@
  21
  22 #include <sys/wait.h>
  23 #include <sys/stat.h>
  24
  25 #include <cwchar>
  26
  27 #include "ptytty.h"
  28
  29 extern "C" {
  30 #include <X11/Intrinsic.h>      /* Xlib, Xutil, Xresource, Xfuncproto */
  31 }
  32
  33 /*
  34  * If we haven't pulled in typedef's like  int16_t  then do them ourself
  35  * type of (normal and unsigned) basic sizes
  36  */
  37 @rxvt_int16_typedef@
  38 @rxvt_uint16_typedef@
  39 @rxvt_int32_typedef@
  40 @rxvt_uint32_typedef@
  41
  42 /* whatever normal size corresponds to a integer pointer */
  43 @rxvt_intp_define@
  44 /* whatever normal size corresponds to a unsigned integer pointer */
  45 @rxvt_u_intp_define@
  46
  47 struct rxvt_fontset;
  48 struct rxvt_color;
  49 struct rxvt_vars;               /* defined later on */
  50 struct rxvt_term;
  51 struct rxvt_display;
  52 struct rxvt_im;
  53 struct rxvt_drawable;
  54
  55 typedef struct rxvt_term *rxvt_t;
  56
  57 extern rxvt_t rxvt_current_term;
  58
  59 # define SET_R(r) rxvt_current_term = (r)
  60 # define GET_R rxvt_current_term
  61
  62 #define scrollbar_visible()    scrollBar.state
  63 #define menubar_visible()      menuBar.state
  64
  65 typedef struct {
  66   int32_t         row;
  67   int32_t         col;
  68 } row_col_t;
  69
  70 #if UNICODE_3
  71 typedef uint32_t text_t;
  72 #else
  73 typedef uint16_t text_t; // saves lots of memory
  74 #endif
  75 typedef uint32_t rend_t;
  76
  77 /*
  78  * TermWin elements limits
  79  *  width     : 1 <= width
  80  *  height    : 1 <= height
  81  *  ncol      : 1 <= ncol       <= MAX(int16_t)
  82  *  nrow      : 1 <= nrow       <= MAX(int16_t)
  83  *  saveLines : 0 <= saveLines  <= MAX(int16_t)
  84  *  nscrolled : 0 <= nscrolled  <= saveLines
  85  *  view_start: 0 <= view_start <= nscrolled
  86  */
  87
  88 typedef struct {
  89   uint16_t       width;         /* window width                    [pixels] */
  90   uint16_t       height;        /* window height                   [pixels] */
  91   uint16_t       fwidth;        /* font width                      [pixels] */
  92   uint16_t       fheight;       /* font height                     [pixels] */
  93   uint16_t       fbase;         /* font ascent (baseline)          [pixels] */
  94   uint16_t       propfont;      /* font proportional flags                  */
  95   uint16_t       ncol;          /* window columns              [characters] */
  96   uint16_t       nrow;          /* window rows                 [characters] */
  97   uint16_t       focus;         /* window has focus                         */
  98   uint16_t       mapped;        /* window state mapped?                     */
  99   uint16_t       int_bwidth;    /* internal border width                    */
 100   uint16_t       ext_bwidth;    /* external border width                    */
 101   uint16_t       lineSpace;     /* number of extra pixels between rows      */
 102   uint16_t       saveLines;     /* number of lines that fit in scrollback   */
 103   uint16_t       nscrolled;     /* number of line actually scrolled         */
 104   uint16_t       view_start;    /* scrollback view starts here              */
 105   Window         parent[6];     /* parent identifiers - we're parent[0]     */
 106   Window         vt;            /* vt100 window                             */
 107   GC             gc;            /* GC for drawing                           */
 108   Pixmap         pixmap;
 109   rxvt_fontset  *fontset;
 110   rxvt_drawable *drawable;
 111   uint16_t       ascii_map[0x7f - 0x20]; // map ascii chars to fonts for speed
 112 } TermWin_t;
 113
 114 /*
 115  * screen accounting:
 116  * screen_t elements
 117  *   text:      Contains all text information including the scrollback buffer.
 118  *              Each line is length TermWin.ncol
 119  *   tlen:      The length of the line or -1 for wrapped lines.
 120  *   rend:      Contains rendition information: font, bold, colour, etc.
 121  * * Note: Each line for both text and rend are only allocated on demand, and
 122  *         text[x] is allocated <=> rend[x] is allocated  for all x.
 123  *   row:       Cursor row position                   : 0 <= row < TermWin.nrow
 124  *   col:       Cursor column position                : 0 <= col < TermWin.ncol
 125  *   tscroll:   Scrolling region top row inclusive    : 0 <= row < TermWin.nrow
 126  *   bscroll:   Scrolling region bottom row inclusive : 0 <= row < TermWin.nrow
 127  *
 128  * selection_t elements
 129  *   clicks:    1, 2 or 3 clicks - 4 indicates a special condition of 1 where
 130  *              nothing is selected
 131  *   beg:       row/column of beginning of selection  : never past mark
 132  *   mark:      row/column of initial click           : never past end
 133  *   end:       row/column of one character past end of selection
 134  * * Note: -TermWin.nscrolled <= beg.row <= mark.row <= end.row < TermWin.nrow
 135  * * Note: col == -1 ==> we're left of screen
 136  *
 137  * Layout of text/rend information in the screen_t text/rend structures:
 138  *   Rows [0] ... [TermWin.saveLines - 1]
 139  *     scrollback region : we're only here if TermWin.view_start != 0
 140  *   Rows [TermWin.saveLines] ... [TermWin.saveLines + TermWin.nrow - 1]
 141  *     normal `unscrolled' screen region
 142  */
 143 typedef struct {
 144   int16_t        *tlen; /* length of each text line                  */
 145   text_t        **text; /* _all_ the text                            */
 146   rend_t        **rend; /* rendition, uses RS_ flags                 */
 147   row_col_t       cur;  /* cursor position on the screen             */
 148   uint16_t        tscroll;      /* top of settable scroll region             */
 149   uint16_t        bscroll;      /* bottom of settable scroll region          */
 150   uint16_t        charset;      /* character set number [0..3]               */
 151   unsigned int    flags;        /* see below                                 */
 152   row_col_t       s_cur;        /* saved cursor position                     */
 153   uint16_t        s_charset;    /* saved character set number [0..3]         */
 154   char            s_charset_char;
 155   rend_t          s_rstyle;     /* saved rendition style                     */
 156 } screen_t;
 157
 158 enum selection_op_t {
 159   SELECTION_CLEAR = 0,  /* nothing selected                          */
 160   SELECTION_INIT,       /* marked a point                            */
 161   SELECTION_BEGIN,      /* started a selection                       */
 162   SELECTION_CONT,       /* continued selection                       */
 163   SELECTION_DONE        /* selection put in CUT_BUFFER0              */
 164 };
 165
 166 typedef struct {
 167   wchar_t        *text;       /* selected text                             */
 168   uint32_t        len;        /* length of selected text                   */
 169   short           screen;     /* screen being used                         */
 170   short           clicks;     /* number of clicks                          */
 171   selection_op_t  op;         /* current operation                         */
 172   row_col_t       beg;        /* beginning of selection   <= mark          */
 173   row_col_t       mark;       /* point of initial click   <= end           */
 174   row_col_t       end;        /* one character past end point              */
 175 } selection_t;
 176
 177 /* ------------------------------------------------------------------------- */
 178
 179 /* screen_t flags */
 180 #define Screen_Relative         (1<<0)  /* relative origin mode flag         */
 181 #define Screen_VisibleCursor    (1<<1)  /* cursor visible?                   */
 182 #define Screen_Autowrap         (1<<2)  /* auto-wrap flag                    */
 183 #define Screen_Insert           (1<<3)  /* insert mode (vs. overstrike)      */
 184 #define Screen_WrapNext         (1<<4)  /* need to wrap for next char?       */
 185 #define Screen_DefaultFlags     (Screen_VisibleCursor|Screen_Autowrap)
 186
 187 /* rxvt_vars.options */
 188 #define Opt_console             (1UL<<0)
 189 #define Opt_loginShell          (1UL<<1)
 190 #define Opt_iconic              (1UL<<2)
 191 #define Opt_visualBell          (1UL<<3)
 192 #define Opt_mapAlert            (1UL<<4)
 193 #define Opt_reverseVideo        (1UL<<5)
 194 #define Opt_utmpInhibit         (1UL<<6)
 195 #define Opt_scrollBar           (1UL<<7)
 196 #define Opt_scrollBar_right     (1UL<<8)
 197 #define Opt_scrollBar_floating  (1UL<<9)
 198 #define Opt_meta8               (1UL<<10)
 199 #define Opt_scrollTtyOutput     (1UL<<11)
 200 #define Opt_scrollTtyKeypress   (1UL<<12)
 201 #define Opt_transparent         (1UL<<13)
 202 #define Opt_transparent_all     (1UL<<14)
 203 #define Opt_realBold            (1UL<<15)
 204 #define Opt_tripleclickwords    (1UL<<16)
 205 #define Opt_scrollWithBuffer    (1UL<<17)
 206 #define Opt_jumpScroll          (1UL<<18)
 207 #define Opt_mouseWheelScrollPage (1UL<<19)
 208 #define Opt_pointerBlank        (1UL<<20)
 209 #define Opt_cursorBlink         (1UL<<21)
 210 #define Opt_secondaryScreen     (1UL<<22)
 211 #define Opt_secondaryScroll     (1UL<<23)
 212 #if ENABLE_FRILLS
 213 # define Opt_insecure           (1UL<<24) // insecure esc sequences
 214 # define Opt_borderLess         (1UL<<25) // mem borderless hints
 215 #else
 216 # define Opt_insecure           0
 217 # define Opt_borderLess         0
 218 #endif
 219 /* place holder used for parsing command-line options */
 220 #define Opt_Reverse             (1UL<<30)
 221 #define Opt_Boolean             (1UL<<31)
 222
 223 #define DEFAULT_OPTIONS         (Opt_scrollBar | Opt_scrollTtyOutput | \
 224                                  Opt_jumpScroll | Opt_secondaryScreen)
 225
 226 /* ------------------------------------------------------------------------- */
 227
 228 typedef struct {
 229   short           state;
 230   Window          win;
 231   struct rxvt_drawable *drawable;
 232 } menuBar_t;
 233
 234 typedef struct {
 235   char            state;        /* scrollbar state                          */
 236   char            init;         /* scrollbar has been initialised           */
 237   short           beg;          /* slider sub-window begin height           */
 238   short           end;          /* slider sub-window end height             */
 239   short           top;          /* slider top position                      */
 240   short           bot;          /* slider bottom position                   */
 241   short           style;        /* style: rxvt, xterm, next                 */
 242   short           width;        /* scrollbar width                          */
 243   Window          win;
 244   int             (rxvt_term::*update)(int, int, int, int);
 245
 246   void setIdle()   { state =  1 ; }
 247   void setMotion() { state = 'm'; }
 248   void setUp()     { state = 'U'; }
 249   void setDn()     { state = 'D'; }
 250 } scrollBar_t;
 251
 252 struct rxvt_vars {
 253   TermWin_t       TermWin;
 254   scrollBar_t     scrollBar;
 255   menuBar_t       menuBar;
 256   unsigned long   options;
 257   XSizeHints      szHint;
 258   rxvt_display   *display;
 259   rxvt_color     *pix_colors;
 260   rxvt_color     *pix_colors_focused;
 261 #ifdef OFF_FOCUS_FADING
 262   rxvt_color     *pix_colors_unfocused;
 263 #endif
 264   short           numpix_colors;
 265   Cursor          TermWin_cursor;       /* cursor for vt window */
 266   int             sb_shadow;    /* scrollbar shadow width                    */
 267   rxvt_ptytty     pty;
 268   int             numlock_state;
 269   text_t        **drawn_text;   /* text drawn on screen (characters)         */
 270   rend_t        **drawn_rend;   /* text drawn on screen (rendition)          */
 271   text_t        **buf_text;
 272   rend_t        **buf_rend;
 273   char           *tabs;         /* per location: 1 == tab-stop               */
 274   screen_t        screen;
 275   screen_t        swap;
 276   selection_t     selection;
 277 };
 278
 279 void rxvt_init ();
 280
 281 #endif                          /* _RXVTLIB_H_ */
 282