src/rxvt.h

   1 #ifndef RXVT_H_                /* include once only */
   2 #define RXVT_H_
   3
   4 #include <cstdio>
   5 #include <cctype>
   6 #include <cerrno>
   7 #include <cstdarg>
   8 #include <cstdlib>
   9 #ifdef HAVE_STDINT_H
  10 #include <stdint.h>
  11 #endif
  12 #include <sys/types.h>
  13 #include <unistd.h>
  14 #include <cstring>
  15 #include <assert.h>
  16 #ifdef HAVE_SYS_IOCTL_H
  17 #include <sys/ioctl.h>
  18 #endif
  19 #ifdef HAVE_SYS_STRREDIR_H
  20 #include <sys/strredir.h>
  21 #endif
  22
  23 #if HAVE_CWCHAR
  24 # include <cwchar>
  25 #elif HAVE_WCHAR_H
  26 # include <wchar.h>
  27 #else
  28 // stdlib.h might provide it
  29 #endif
  30
  31 using namespace std;
  32
  33 extern "C" {
  34 #include <X11/Xlib.h>
  35 #include <X11/Xutil.h>
  36 #include <X11/Xresource.h>
  37 }
  38
  39 #if UNICODE_3
  40 typedef uint32_t text_t;
  41 #else
  42 typedef uint16_t text_t; // saves lots of memory
  43 #endif
  44 typedef uint32_t rend_t;
  45 typedef  int32_t tlen_t;  // was int16_t, but this results in smaller code and memory use
  46 typedef  int32_t tlen_t_; // specifically for use in the line_t structure
  47
  48 #include "feature.h"
  49
  50 #if defined (ISO_14755) || defined (ENABLE_PERL)
  51 # define ENABLE_OVERLAY 1
  52 #endif
  53
  54 #if ENABLE_PERL
  55 # define ENABLE_FRILLS    1
  56 # define ENABLE_COMBINING 1
  57 #endif
  58
  59 #if ENABLE_FRILLS
  60 # define ENABLE_XEMBED        1
  61 # define ENABLE_EWMH          1
  62 # define ENABLE_XIM_ONTHESPOT 1
  63 # define CURSOR_BLINK         1
  64 # define OPTION_HC            1
  65 # define BUILTIN_GLYPHS       1
  66 #else
  67 # define ENABLE_MINIMAL 1
  68 #endif
  69
  70 #include <limits.h>
  71
  72 #include <X11/cursorfont.h>
  73 #include <X11/keysym.h>
  74 #include <X11/keysymdef.h>
  75 #include <X11/Xatom.h>
  76
  77 #include "encoding.h"
  78 #include "rxvtutil.h"
  79 #include "rxvtfont.h"
  80 #include "rxvttoolkit.h"
  81 #include "scrollbar.h"
  82 #include "ev_cpp.h"
  83 #include "salloc.h"
  84 #include "libptytty.h"
  85
  86 #include "rxvtperl.h"
  87
  88 // try to avoid some macros to decrease code size, on some systems
  89 #if ENABLE_MINIMAL
  90 # define strcmp(a,b)   (strcmp)(a,b)
  91 # define strlen(a)     (strlen)(a)
  92 # define strcpy(a,b)   (strcpy)(a,b)
  93 # define memset(a,c,l) (memset)(a,c,l)
  94 # define memcpy(a,b,l) (memcpy)(a,b,l)
  95 #endif
  96
  97 /*
  98  *****************************************************************************
  99  * SYSTEM HACKS
 100  *****************************************************************************
 101  */
 102
 103 #ifndef HAVE_XPOINTER
 104 typedef char *XPointer;
 105 #endif
 106
 107 #include <termios.h>
 108
 109 #include "background.h"
 110
 111 #ifndef STDIN_FILENO
 112 # define STDIN_FILENO   0
 113 # define STDOUT_FILENO  1
 114 # define STDERR_FILENO  2
 115 #endif
 116
 117 #ifndef EXIT_SUCCESS            /* missing from <stdlib.h> */
 118 # define EXIT_SUCCESS           0       /* exit function success */
 119 # define EXIT_FAILURE           1       /* exit function failure */
 120 #endif
 121
 122 #ifndef PATH_MAX
 123 # define PATH_MAX 16384
 124 #endif
 125
 126 /****************************************************************************/
 127
 128 // exception thrown on fatal (per-instance) errors
 129 class rxvt_failure_exception { };
 130
 131 // exception thrown when the command parser runs out of input data
 132 class out_of_input { };
 133
 134 /*
 135  *****************************************************************************
 136  * PROTOTYPES
 137  *****************************************************************************
 138  */
 139 // main.C
 140 #define SET_LOCALE(locale) rxvt_set_locale (locale)
 141 extern bool rxvt_set_locale (const char *locale) NOTHROW;
 142 extern void rxvt_push_locale (const char *locale) NOTHROW;
 143 extern void rxvt_pop_locale () NOTHROW;
 144 void rxvt_init ();
 145
 146 // misc.C
 147 char *           rxvt_wcstombs                    (const wchar_t *str, int len = -1);
 148 wchar_t *        rxvt_mbstowcs                    (const char *str, int len = -1);
 149 char *           rxvt_wcstoutf8                   (const wchar_t *str, int len = -1);
 150 wchar_t *        rxvt_utf8towcs                   (const char *str, int len = -1);
 151
 152 const char *     rxvt_basename                    (const char *str) NOTHROW;
 153 void             rxvt_vlog                        (const char *fmt, va_list arg_ptr) NOTHROW;
 154 void             rxvt_log                         (const char *fmt,...) NOTHROW;
 155 void             rxvt_warn                        (const char *fmt,...) NOTHROW;
 156 void             rxvt_fatal                       (const char *fmt, ...) THROW ((class rxvt_failure_exception)) NORETURN;
 157 void             rxvt_exit_failure                () THROW ((class rxvt_failure_exception)) NORETURN;
 158
 159 char           * rxvt_strtrim                     (char *str) NOTHROW;
 160 char          ** rxvt_splitcommastring            (const char *cs) NOTHROW;
 161 void             rxvt_freecommastring             (char **cs) NOTHROW;
 162
 163 void           * rxvt_malloc                      (size_t size);
 164 void           * rxvt_calloc                      (size_t number, size_t size);
 165 void           * rxvt_realloc                     (void *ptr, size_t size);
 166
 167 /////////////////////////////////////////////////////////////////////////////
 168
 169 // temporarily replace the process environment
 170 extern char **environ;
 171 extern char **rxvt_environ; // the original environ pointer
 172
 173 static inline void
 174 set_environ (stringvec *envv)
 175 {
 176 #if ENABLE_PERL
 177   assert (envv);
 178 #else
 179   if (envv)
 180 #endif
 181     environ = (char **)envv->begin ();
 182 }
 183
 184 static inline void
 185 set_environ (char **envv)
 186 {
 187 #if ENABLE_PERL
 188   assert (envv);
 189 #else
 190   if (envv)
 191 #endif
 192     environ = envv;
 193 }
 194
 195 /*
 196  *****************************************************************************
 197  * STRUCTURES AND TYPEDEFS
 198  *****************************************************************************
 199  */
 200
 201 /*
 202  * the 'essential' information for reporting Mouse Events
 203  * pared down from XButtonEvent
 204  */
 205 struct mouse_event
 206 {
 207   int clicks;
 208   Time time;             /* milliseconds */
 209   unsigned int state;    /* key or button mask */
 210   unsigned int button;   /* detail */
 211 };
 212
 213 #if ENABLE_XEMBED
 214 // XEMBED messages
 215 # define XEMBED_EMBEDDED_NOTIFY          0
 216 # define XEMBED_WINDOW_ACTIVATE          1
 217 # define XEMBED_WINDOW_DEACTIVATE        2
 218 # define XEMBED_REQUEST_FOCUS            3
 219 # define XEMBED_FOCUS_IN                 4
 220 # define XEMBED_FOCUS_OUT                5
 221 # define XEMBED_FOCUS_NEXT               6
 222 # define XEMBED_FOCUS_PREV               7
 223
 224 # define XEMBED_MODALITY_ON              10
 225 # define XEMBED_MODALITY_OFF             11
 226 # define XEMBED_REGISTER_ACCELERATOR     12
 227 # define XEMBED_UNREGISTER_ACCELERATOR   13
 228 # define XEMBED_ACTIVATE_ACCELERATOR     14
 229
 230 // XEMBED detail code
 231 # define XEMBED_FOCUS_CURRENT            0
 232 # define XEMBED_FOCUS_FIRST              1
 233 # define XEMBED_FOCUS_LAST               2
 234
 235 # define XEMBED_MAPPED                  (1 << 0)
 236 #endif
 237
 238 /*
 239  *****************************************************************************
 240  * NORMAL DEFINES
 241  *****************************************************************************
 242  */
 243
 244 /* COLORTERM, TERM environment variables */
 245 #define COLORTERMENV    "rxvt"
 246 #ifdef BG_IMAGE_FROM_FILE
 247 # define COLORTERMENVFULL COLORTERMENV "-xpm"
 248 #else
 249 # define COLORTERMENVFULL COLORTERMENV
 250 #endif
 251 #ifndef TERMENV
 252 # define TERMENV        "rxvt-unicode"
 253 #endif
 254
 255 #if defined (NO_MOUSE_REPORT) && !defined (NO_MOUSE_REPORT_SCROLLBAR)
 256 # define NO_MOUSE_REPORT_SCROLLBAR 1
 257 #endif
 258
 259 #define scrollBar_esc           30
 260
 261 #if !defined (RXVT_SCROLLBAR) && !defined (NEXT_SCROLLBAR)
 262 # define NO_SCROLLBAR_BUTTON_CONTINUAL_SCROLLING 1
 263 #endif
 264
 265 enum {
 266   NO_REFRESH       = 0,  /* Window not visible at all!        */
 267   FAST_REFRESH     = 1,  /* Fully exposed window              */
 268   SLOW_REFRESH     = 2,  /* Partially exposed window          */
 269 };
 270
 271 #ifdef NO_SECONDARY_SCREEN
 272 # define NSCREENS               0
 273 #else
 274 # define NSCREENS               1
 275 #endif
 276
 277 /* special (internal) prefix for font commands */
 278 #define FONT_CMD                '#'
 279 #define FONT_DN                 "#-"
 280 #define FONT_UP                 "#+"
 281
 282 /* flags for rxvt_scr_gotorc () */
 283 enum {
 284   C_RELATIVE = 1,       /* col movement is relative */
 285   R_RELATIVE = 2,       /* row movement is relative */
 286   RELATIVE   = C_RELATIVE | R_RELATIVE,
 287 };
 288
 289 /* modes for rxvt_scr_insdel_chars (), rxvt_scr_insdel_lines () */
 290 enum {
 291   INSERT = -1,                          /* don't change these values */
 292   DELETE = +1,
 293   ERASE  = +2,
 294 };
 295
 296 /* modes for rxvt_scr_page () - scroll page. used by scrollbar window */
 297 enum page_dirn {
 298   UP,
 299   DN,
 300   NO_DIR,
 301 };
 302
 303 /* arguments for rxvt_scr_change_screen () */
 304 enum {
 305   PRIMARY = 0,
 306   SECONDARY,
 307 };
 308
 309 #define RS_None                 0
 310
 311 #define RS_colorMask            ((1UL << Color_Bits) - 1UL)
 312 #define RS_fgShift              Color_Bits
 313 #define RS_bgShift              0
 314 #define RS_fgMask               (RS_colorMask << RS_fgShift)
 315 #define RS_bgMask               (RS_colorMask << RS_bgShift)
 316
 317 // font styles
 318 #define RS_Bold                 0x08000000UL    // value 1
 319 #define RS_Italic               0x10000000UL    // value 2
 320
 321 // fake styles
 322 #define RS_Blink                0x20000000UL    // blink
 323 #define RS_RVid                 0x40000000UL    // reverse video
 324 #define RS_Uline                0x80000000UL    // underline
 325
 326 // 5 custom bits for extensions
 327 #define RS_customCount          16
 328 #define RS_customMask           0x07800000UL
 329 #define RS_customShift          23
 330
 331 // must have space for rxvt_fontset::fontCount * 2 + 2 values
 332 #define RS_fontMask             0x007c0000UL    // includes RS_Careful
 333 #define RS_fontShift            18
 334 #define RS_Careful              0x00010000UL    /* be careful when drawing these */
 335
 336 // toggle this to force redraw, must be != RS_Careful and otherwise "pretty neutral"
 337 #define RS_redraw               0x00020000UL
 338
 339 #define RS_styleCount           4
 340 #define RS_styleMask            (RS_Bold | RS_Italic)
 341 #define RS_styleShift           27
 342
 343 #define RS_baseattrMask         (RS_Italic | RS_Bold | RS_Blink | RS_RVid | RS_Uline)
 344 #define RS_attrMask             (RS_baseattrMask | RS_fontMask)
 345
 346 #define DEFAULT_RSTYLE  (RS_None | (Color_fg    << RS_fgShift) | (Color_bg     << RS_bgShift))
 347 #define OVERLAY_RSTYLE  (RS_None | (Color_Black << RS_fgShift) | (Color_Yellow << RS_bgShift))
 348
 349 #define Sel_none                0       /* Not waiting */
 350 #define Sel_normal              0x01    /* normal selection */
 351 #define Sel_incr                0x02    /* incremental selection */
 352 #define Sel_direct              0x00
 353 #define Sel_Primary             0x01
 354 #define Sel_Secondary           0x02
 355 #define Sel_Clipboard           0x03
 356 #define Sel_whereMask           0x0f
 357 #define Sel_CompoundText        0x10    /* last request was COMPOUND_TEXT */
 358 #define Sel_UTF8String          0x20    /* last request was UTF8_STRING */
 359
 360 enum {
 361   C0_NUL = 0x00,
 362           C0_SOH, C0_STX, C0_ETX, C0_EOT, C0_ENQ, C0_ACK, C0_BEL,
 363   C0_BS , C0_HT , C0_LF , C0_VT , C0_FF , C0_CR , C0_SO , C0_SI ,
 364   C0_DLE, C0_DC1, C0_DC2, D0_DC3, C0_DC4, C0_NAK, C0_SYN, C0_ETB,
 365   C0_CAN, C0_EM , C0_SUB, C0_ESC, C0_IS4, C0_IS3, C0_IS2, C0_IS1,
 366 };
 367 #define CHAR_ST                 0x9c    /* 0234 */
 368
 369 /*
 370  * XTerm Operating System Commands: ESC ] Ps;Pt (ST|BEL)
 371  * colour extensions by Christian W. Zuckschwerdt <zany@triq.net>
 372  */
 373 enum {
 374   XTerm_name             =  0,
 375   XTerm_iconName         =  1,
 376   XTerm_title            =  2,
 377   XTerm_property         =  3,      // change X property
 378   XTerm_Color            =  4,      // change colors
 379   XTerm_Color00          = 10,      // change fg color
 380   XTerm_Color01          = 11,      // change bg color
 381   XTerm_Color_cursor     = 12,      // change actual 'Cursor' color
 382   XTerm_Color_pointer_fg = 13,      // change actual 'Pointer' fg color
 383   XTerm_Color_pointer_bg = 14,      // change actual 'Pointer' bg color
 384   XTerm_Color05          = 15,      // not implemented (tektronix fg)
 385   XTerm_Color06          = 16,      // not implemented (tektronix bg)
 386   XTerm_Color_RV         = 17,      // change actual 'Highlight' color
 387   XTerm_logfile          = 46,      // not implemented
 388   XTerm_font             = 50,
 389
 390   XTerm_konsole30        = 30,      // reserved for konsole
 391   XTerm_konsole31        = 31,      // reserved for konsole
 392   XTerm_emacs51          = 51,      // reserved for emacs shell
 393   /*
 394    * rxvt extensions of XTerm OSCs: ESC ] Ps;Pt (ST|BEL)
 395    */
 396
 397   // deprecated
 398   Rxvt_Color_BD          = 18,
 399   Rxvt_Color_UL          = 19,
 400   Rxvt_restoreFG         = 39,
 401   Rxvt_restoreBG         = 49,
 402
 403   Rxvt_Pixmap            = 20,      // new bg pixmap
 404   Rxvt_dumpscreen        = 55,      // dump scrollback and all of screen
 405
 406   URxvt_locale           = 701,     // change locale
 407   URxvt_version          = 702,     // request version
 408
 409   URxvt_Color_IT         = 704,     // change actual 'Italic' colour
 410   URxvt_Color_tint       = 705,     // change actual tint colour
 411   URxvt_Color_BD         = 706,     // change actual 'Bold' color
 412   URxvt_Color_UL         = 707,     // change actual 'Underline' color
 413   URxvt_Color_border     = 708,
 414
 415   URxvt_font             = 710,
 416   URxvt_boldFont         = 711,
 417   URxvt_italicFont       = 712,
 418   URxvt_boldItalicFont   = 713,
 419
 420   URxvt_view_up          = 720,
 421   URxvt_view_down        = 721,
 422
 423   URxvt_perl             = 777,     // for use by perl extensions, starts with "extension-name;"
 424 };
 425
 426 /* Words starting with `Color_' are colours.  Others are counts */
 427 /*
 428  * The PixColor and rendition colour usage should probably be decoupled
 429  * on the unnecessary items, e.g. Color_pointer, but won't bother
 430  * until we need to.  Also, be aware of usage in pixcolor_set
 431  */
 432
 433 enum colour_list {
 434   Color_none = -2,
 435   Color_transparent = -1,
 436   Color_fg = 0,
 437   Color_bg,
 438   minCOLOR,                   /* 2 */
 439   Color_Black = minCOLOR,
 440   Color_Red3,
 441   Color_Green3,
 442   Color_Yellow3,
 443   Color_Blue3,
 444   Color_Magenta3,
 445   Color_Cyan3,
 446   maxCOLOR,                   /* minCOLOR + 7 */
 447 #ifndef NO_BRIGHTCOLOR
 448   Color_AntiqueWhite = maxCOLOR,
 449   minBrightCOLOR,             /* maxCOLOR + 1 */
 450   Color_Grey25 = minBrightCOLOR,
 451   Color_Red,
 452   Color_Green,
 453   Color_Yellow,
 454   Color_Blue,
 455   Color_Magenta,
 456   Color_Cyan,
 457   maxBrightCOLOR,             /* minBrightCOLOR + 7 */
 458   Color_White = maxBrightCOLOR,
 459 #else
 460   Color_White = maxCOLOR,
 461 #endif
 462   minTermCOLOR = Color_White + 1,
 463 #ifndef USE_256_COLORS
 464   maxTermCOLOR = Color_White + 72,
 465 #else
 466   maxTermCOLOR = Color_White + 240,
 467 #endif
 468 #ifndef NO_CURSORCOLOR
 469   Color_cursor,
 470   Color_cursor2,
 471 #endif
 472   Color_pointer_fg,
 473   Color_pointer_bg,
 474   Color_border,
 475 #ifndef NO_BOLD_UNDERLINE_REVERSE
 476   Color_BD,
 477   Color_IT,
 478   Color_UL,
 479   Color_RV,
 480 #endif
 481 #if ENABLE_FRILLS
 482   Color_underline,
 483 #endif
 484 #ifdef OPTION_HC
 485   Color_HC,
 486 #endif
 487   Color_scroll,
 488 #ifdef RXVT_SCROLLBAR
 489   Color_trough,
 490 #endif
 491 #if ENABLE_TRANSPARENCY
 492   Color_tint,
 493 #endif
 494 #if OFF_FOCUS_FADING
 495   Color_fade,
 496 #endif
 497   NRS_COLORS,                 /* */
 498 #ifdef RXVT_SCROLLBAR
 499   Color_topShadow = NRS_COLORS,
 500   Color_bottomShadow,
 501   TOTAL_COLORS
 502 #else
 503   TOTAL_COLORS = NRS_COLORS
 504 #endif
 505 };
 506
 507 #ifndef USE_256_COLORS
 508 #define Color_Bits      7 // 0 .. maxTermCOLOR
 509 #else
 510 #define Color_Bits      9 // 0 .. maxTermCOLOR
 511 #endif
 512
 513 /*
 514  * Resource list
 515  */
 516 enum {
 517 # define def(name) Rs_ ## name,
 518 # define reserve(name,count) Rs_ ## name ## _ = Rs_ ## name + (count) - 1,
 519 # include "rsinc.h"
 520 # undef def
 521 # undef reserve
 522   NUM_RESOURCES
 523 };
 524
 525 /* DEC private modes */
 526 #define PrivMode_132            (1UL<<0)
 527 #define PrivMode_132OK          (1UL<<1)
 528 #define PrivMode_rVideo         (1UL<<2)
 529 #define PrivMode_relOrigin      (1UL<<3)
 530 #define PrivMode_Screen         (1UL<<4)
 531 #define PrivMode_Autowrap       (1UL<<5)
 532 #define PrivMode_aplCUR         (1UL<<6)
 533 #define PrivMode_aplKP          (1UL<<7)
 534 #define PrivMode_HaveBackSpace  (1UL<<8)
 535 #define PrivMode_BackSpace      (1UL<<9)
 536 #define PrivMode_ShiftKeys      (1UL<<10)
 537 #define PrivMode_VisibleCursor  (1UL<<11)
 538 #define PrivMode_MouseX10       (1UL<<12)
 539 #define PrivMode_MouseX11       (1UL<<13)
 540 #define PrivMode_scrollBar      (1UL<<14)
 541 #define PrivMode_TtyOutputInh   (1UL<<15)
 542 #define PrivMode_Keypress       (1UL<<16)
 543 #define PrivMode_smoothScroll   (1UL<<17)
 544 #define PrivMode_vt52           (1UL<<18)
 545 #define PrivMode_LFNL           (1UL<<19)
 546 #define PrivMode_MouseBtnEvent  (1UL<<20)
 547 #define PrivMode_MouseAnyEvent  (1UL<<21)
 548 #define PrivMode_BracketPaste   (1UL<<22)
 549
 550 #define PrivMode_mouse_report   (PrivMode_MouseX10|PrivMode_MouseX11|PrivMode_MouseBtnEvent|PrivMode_MouseAnyEvent)
 551
 552 #ifdef ALLOW_132_MODE
 553 # define PrivMode_Default (PrivMode_Autowrap|PrivMode_ShiftKeys|PrivMode_VisibleCursor|PrivMode_132OK)
 554 #else
 555 # define PrivMode_Default (PrivMode_Autowrap|PrivMode_ShiftKeys|PrivMode_VisibleCursor)
 556 #endif
 557
 558 // do not change these constants lightly, there are many interdependencies
 559 #define IMBUFSIZ               128     // input modifier buffer sizes
 560 #define KBUFSZ                 512     // size of keyboard mapping buffer
 561 #define CBUFSIZ                2048    // size of command buffer
 562 #define CBUFCNT                8       // never call pty_fill/cmd_parse more than this often in a row
 563 #define UBUFSIZ                2048    // character buffer
 564
 565 #if ENABLE_FRILLS
 566 # include <X11/Xmd.h>
 567 typedef struct _mwmhints
 568 {
 569   CARD32 flags;
 570   CARD32 functions;
 571   CARD32 decorations;
 572   INT32  input_mode;
 573   CARD32 status;
 574 } MWMHints;
 575 #endif
 576
 577 /* Motif window hints */
 578 #define MWM_HINTS_FUNCTIONS     (1L << 0)
 579 #define MWM_HINTS_DECORATIONS   (1L << 1)
 580 #define MWM_HINTS_INPUT_MODE    (1L << 2)
 581 #define MWM_HINTS_STATUS        (1L << 3)
 582 /* bit definitions for MwmHints.functions */
 583 #define MWM_FUNC_ALL            (1L << 0)
 584 #define MWM_FUNC_RESIZE         (1L << 1)
 585 #define MWM_FUNC_MOVE           (1L << 2)
 586 #define MWM_FUNC_MINIMIZE       (1L << 3)
 587 #define MWM_FUNC_MAXIMIZE       (1L << 4)
 588 #define MWM_FUNC_CLOSE          (1L << 5)
 589 /* bit definitions for MwmHints.decorations */
 590 #define MWM_DECOR_ALL           (1L << 0)
 591 #define MWM_DECOR_BORDER        (1L << 1)
 592 #define MWM_DECOR_RESIZEH       (1L << 2)
 593 #define MWM_DECOR_TITLE         (1L << 3)
 594 #define MWM_DECOR_MENU          (1L << 4)
 595 #define MWM_DECOR_MINIMIZE      (1L << 5)
 596 #define MWM_DECOR_MAXIMIZE      (1L << 6)
 597 /* bit definitions for MwmHints.inputMode */
 598 #define MWM_INPUT_MODELESS                  0
 599 #define MWM_INPUT_PRIMARY_APPLICATION_MODAL 1
 600 #define MWM_INPUT_SYSTEM_MODAL              2
 601 #define MWM_INPUT_FULL_APPLICATION_MODAL    3
 602 #define PROP_MWM_HINTS_ELEMENTS             5
 603
 604 /*
 605  *****************************************************************************
 606  * MACRO DEFINES
 607  *****************************************************************************
 608  */
 609 #define dLocal(type,name)       type const name = this->name
 610
 611 // for speed reasons, we assume that all codepoints 32 to 126 are
 612 // single-width.
 613 #define WCWIDTH(c)              (IN_RANGE_INC (c, 0x20, 0x7e) ? 1 : wcwidth (c))
 614
 615 /* convert pixel dimensions to row/column values.  Everything as int32_t */
 616 #define Pixel2Col(x)            Pixel2Width((int32_t)(x))
 617 #define Pixel2Row(y)            Pixel2Height((int32_t)(y))
 618 #define Pixel2Width(x)          ((int32_t)(x) / (int32_t)fwidth)
 619 #define Pixel2Height(y)         ((int32_t)(y) / (int32_t)fheight)
 620 #define Col2Pixel(col)          ((int32_t)Width2Pixel(col))
 621 #define Row2Pixel(row)          ((int32_t)Height2Pixel(row))
 622 #define Width2Pixel(n)          ((int32_t)(n) * (int32_t)fwidth)
 623 #define Height2Pixel(n)         ((int32_t)(n) * (int32_t)fheight)
 624
 625 #define LINENO_of(t,n) MOD ((t)->term_start + int(n), (t)->total_rows)
 626 #define ROW_of(t,n) (t)->row_buf [LINENO_of ((t), n)]
 627
 628 #define LINENO(n) LINENO_of (this, n)
 629 #define ROW(n) ROW_of (this, n)
 630
 631 /* how to build & extract colors and attributes */
 632 #define GET_BASEFG(x)           (((x) & RS_fgMask) >> RS_fgShift)
 633 #define GET_BASEBG(x)           (((x) & RS_bgMask) >> RS_bgShift)
 634
 635 #define GET_FONT(x)             (((x) & RS_fontMask) >> RS_fontShift)
 636 #define SET_FONT(x,fid)         (((x) & ~RS_fontMask) | ((fid) << RS_fontShift))
 637
 638 #define GET_STYLE(x)            (((x) & RS_styleMask) >> RS_styleShift)
 639 #define SET_STYLE(x,style)      (((x) & ~RS_styleMask) | ((style) << RS_styleShift))
 640
 641 #define GET_ATTR(x)             (((x) & RS_attrMask))
 642 #define GET_BGATTR(x)                                                   \
 643     (((x) & RS_RVid) ? (((x) & (RS_attrMask & ~RS_RVid))                \
 644                         | (((x) & RS_colorMask) << RS_bgShift))              \
 645                      : ((x) & (RS_attrMask | RS_bgMask)))
 646 #define SET_FGCOLOR(x,fg)       (((x) & ~RS_fgMask)   | ((fg) << RS_fgShift))
 647 #define SET_BGCOLOR(x,bg)       (((x) & ~RS_bgMask)   | ((bg) << RS_bgShift))
 648 #define SET_ATTR(x,a)           (((x) & ~RS_attrMask) | (a))
 649
 650 #define RS_SAME(a,b)            (!(((a) ^ (b)) & ~RS_Careful))
 651
 652 #define PIXCOLOR_NAME(idx)      rs[Rs_color + (idx)]
 653 #define ISSET_PIXCOLOR(idx)     (!!rs[Rs_color + (idx)])
 654
 655 #if ENABLE_STYLES
 656 # define FONTSET_of(t,style) (t)->fontset[GET_STYLE (style)]
 657 #else
 658 # define FONTSET_of(t,style) (t)->fontset[0]
 659 #endif
 660
 661 #define FONTSET(style) FONTSET_of (this, style)
 662
 663 typedef callback<void (const char *)> log_callback;
 664 typedef callback<int (int)> getfd_callback;
 665
 666 /****************************************************************************/
 667
 668 #define LINE_LONGER     0x0001 // line is continued on the next row
 669 #define LINE_FILTERED   0x0002 // line has been filtered
 670 #define LINE_COMPRESSED 0x0004 // line has been compressed (NYI)
 671 #define LINE_FILTER     0x0008 // line needs to be filtered before display (NYI)
 672 #define LINE_BIDI       0x0010 // line needs bidi (NYI)
 673
 674 struct line_t
 675 {
 676    text_t *t; // terminal the text
 677    rend_t *r; // rendition, uses RS_ flags
 678    tlen_t_ l; // length of each text line
 679    uint32_t f; // flags
 680
 681    bool is_longer ()
 682    {
 683      return f & LINE_LONGER;
 684    }
 685
 686    void is_longer (int set)
 687    {
 688      if (set)
 689        f |= LINE_LONGER;
 690      else
 691        f &= ~LINE_LONGER;
 692    }
 693
 694    void clear ()
 695    {
 696      t = 0;
 697      r = 0;
 698      l = 0;
 699      f = 0;
 700    }
 701
 702    void touch () // call whenever a line is changed/touched/updated
 703    {
 704 #if ENABLE_PERL
 705      f &= ~LINE_FILTERED;
 706 #endif
 707    }
 708
 709    void touch (int col)
 710    {
 711      max_it (l, col);
 712      touch ();
 713    }
 714 };
 715
 716 /****************************************************************************/
 717
 718 // primitive wrapper around mbstate_t to ensure initialisation
 719 struct mbstate
 720 {
 721   mbstate_t mbs;
 722
 723   operator mbstate_t *() { return &mbs; }
 724   void reset () { memset (&mbs, 0, sizeof (mbs)); }
 725   mbstate () { reset (); }
 726 };
 727
 728 /****************************************************************************/
 729
 730 #define UNICODE_MASK 0x1fffffUL
 731
 732 #if UNICODE_3
 733 # define COMPOSE_LO 0x40000000UL
 734 # define COMPOSE_HI 0x400fffffUL
 735 # define IS_COMPOSE(n) ((int32_t)(n) >= COMPOSE_LO)
 736 #else
 737 # if ENABLE_PERL
 738 #  define COMPOSE_LO 0xe000UL // our _own_ functions don't like (illegal) surrogates
 739 #  define COMPOSE_HI 0xf8ffUL // in utf-8, so use private use area only
 740 # else
 741 #  define COMPOSE_LO 0xd800UL
 742 #  define COMPOSE_HI 0xf8ffUL
 743 # endif
 744 # define IS_COMPOSE(n) IN_RANGE_INC ((n), COMPOSE_LO, COMPOSE_HI)
 745 #endif
 746
 747 #if ENABLE_COMBINING
 748 // compose chars are used to represent composite characters
 749 // that are not representable in unicode, as well as characters
 750 // not fitting in the BMP.
 751 struct compose_char
 752 {
 753   unicode_t c1, c2; // any chars != NOCHAR are valid
 754   compose_char (unicode_t c1, unicode_t c2)
 755   : c1(c1), c2(c2)
 756   { }
 757 };
 758
 759 class rxvt_composite_vec
 760 {
 761   vector<compose_char> v;
 762 public:
 763   text_t compose (unicode_t c1, unicode_t c2 = NOCHAR);
 764   int expand (unicode_t c, wchar_t *r);
 765   compose_char *operator [](text_t c)
 766   {
 767     return c >= COMPOSE_LO && c < COMPOSE_LO + v.size ()
 768            ? &v[c - COMPOSE_LO]
 769            : 0;
 770   }
 771 };
 772
 773 extern class rxvt_composite_vec rxvt_composite;
 774 #endif
 775
 776 /****************************************************************************/
 777
 778 #ifdef KEYSYM_RESOURCE
 779 class keyboard_manager;
 780 #endif
 781
 782 typedef struct rxvt_term *rxvt_t;
 783
 784 extern rxvt_t rxvt_current_term;
 785
 786 #define SET_R(r) rxvt_current_term = const_cast<rxvt_term *>(r)
 787 #define GET_R rxvt_current_term
 788
 789 /* ------------------------------------------------------------------------- */
 790 struct overlay_base
 791 {
 792   int x, y, w, h; // overlay dimensions
 793   text_t **text;
 794   rend_t **rend;
 795
 796   // while tempting to add swap() etc. here, it effetcively only increases code size
 797 };
 798
 799 /* ------------------------------------------------------------------------- */
 800
 801 typedef struct
 802 {
 803   int row;
 804   int col;
 805 } row_col_t;
 806
 807 /*
 808  * terminal limits:
 809  *
 810  *  width      : 1 <= width
 811  *  height     : 1 <= height
 812  *  ncol       : 1 <= ncol       <= MAX(tlen_t)
 813  *  nrow       : 1 <= nrow       <= MAX(int)
 814  *  saveLines  : 0 <= saveLines  <= MAX(int)
 815  *  term_start : 0 <= term_start < saveLines
 816  *  total_rows : nrow + saveLines
 817  *
 818  *  top_row    : -saveLines <= top_row    <= 0
 819  *  view_start : top_row    <= view_start <= 0
 820  *
 821  *          | most coordinates are stored relative to term_start,
 822  *  ROW_BUF | which is the first line of the terminal screen
 823  *  |························= row_buf[0]
 824  *  |························= row_buf[1]
 825  *  |························= row_buf[2] etc.
 826  *  |
 827  *  +------------+···········= term_start + top_row
 828  *  | scrollback |
 829  *  | scrollback +---------+·= term_start + view_start
 830  *  | scrollback | display |
 831  *  | scrollback | display |
 832  *  +------------+·display·+·= term_start
 833  *  |  terminal  | display |
 834  *  |  terminal  +---------+
 835  *  |  terminal  |
 836  *  |  terminal  |
 837  *  +------------+···········= term_start + nrow - 1
 838  *  |
 839  *  |
 840  *  END······················= total_rows
 841  */
 842
 843 struct TermWin_t
 844 {
 845   int            width;         /* window width                    [pixels] */
 846   int            height;        /* window height                   [pixels] */
 847   int            fwidth;        /* font width                      [pixels] */
 848   int            fheight;       /* font height                     [pixels] */
 849   int            fbase;         /* font ascent (baseline)          [pixels] */
 850   int            ncol;          /* window columns              [characters] */
 851   int            nrow;          /* window rows                 [characters] */
 852   int            focus;         /* window has focus                         */
 853   int            mapped;        /* window state mapped?                     */
 854   int            int_bwidth;    /* internal border width                    */
 855   int            ext_bwidth;    /* external border width                    */
 856   int            lineSpace;     /* number of extra pixels between rows      */
 857   int            letterSpace;   /* number of extra pixels between columns   */
 858   int            saveLines;     /* number of lines that fit in scrollback   */
 859   int            total_rows;    /* total number of rows in this terminal    */
 860   int            term_start;    /* term lines start here                    */
 861   int            view_start;    /* scrollback view starts here              */
 862   int            top_row;       /* topmost row index of scrollback          */
 863   Window         parent[6];     /* parent identifiers - we're parent[0]     */
 864   Window         vt;            /* vt100 window                             */
 865   GC             gc;            /* GC for drawing                           */
 866   Pixmap         pixmap;
 867   rxvt_drawable *drawable;
 868   rxvt_fontset  *fontset[4];
 869 };
 870
 871 /*
 872  * screen accounting:
 873  * screen_t elements
 874  *   row:       Cursor row position                   : 0 <= row < nrow
 875  *   col:       Cursor column position                : 0 <= col < ncol
 876  *   tscroll:   Scrolling region top row inclusive    : 0 <= row < nrow
 877  *   bscroll:   Scrolling region bottom row inclusive : 0 <= row < nrow
 878  *
 879  * selection_t elements
 880  *   clicks:    1, 2 or 3 clicks - 4 indicates a special condition of 1 where
 881  *              nothing is selected
 882  *   beg:       row/column of beginning of selection  : never past mark
 883  *   mark:      row/column of initial click           : never past end
 884  *   end:       row/column of one character past end of selection
 885  * * Note: top_row <= beg.row <= mark.row <= end.row < nrow
 886  * * Note: col == -1 ==> we're left of screen
 887  *
 888  */
 889 struct screen_t
 890 {
 891   row_col_t       cur;          /* cursor position on the screen             */
 892   int             tscroll;      /* top of settable scroll region             */
 893   int             bscroll;      /* bottom of settable scroll region          */
 894   unsigned int    charset;      /* character set number [0..3]               */
 895   unsigned int    flags;        /* see below                                 */
 896   row_col_t       s_cur;        /* saved cursor position                     */
 897   unsigned int    s_charset;    /* saved character set number [0..3]         */
 898   char            s_charset_char;
 899   rend_t          s_rstyle;     /* saved rendition style                     */
 900 };
 901
 902 enum selection_op_t
 903 {
 904   SELECTION_CLEAR = 0,  /* nothing selected                          */
 905   SELECTION_INIT,       /* marked a point                            */
 906   SELECTION_BEGIN,      /* started a selection                       */
 907   SELECTION_CONT,       /* continued selection                       */
 908   SELECTION_DONE        /* selection put in CUT_BUFFER0              */
 909 };
 910
 911 struct selection_t
 912 {
 913   wchar_t          *text;       /* selected text                             */
 914   unsigned int      len;        /* length of selected text                   */
 915   unsigned int      screen;     /* screen being used                         */
 916   unsigned int      clicks;     /* number of clicks                          */
 917   selection_op_t    op;         /* current operation                         */
 918   bool              rect;       /* rectangular selection?                    */
 919   row_col_t         beg;        /* beginning of selection   <= mark          */
 920   row_col_t         mark;       /* point of initial click   <= end           */
 921   row_col_t         end;        /* one character past end point              */
 922   wchar_t          *clip_text;  /* text copied to the clipboard              */
 923   unsigned int      clip_len;   /* length of clipboard text                  */
 924 };
 925
 926 /* ------------------------------------------------------------------------- */
 927
 928 /* screen_t flags */
 929 #define Screen_Relative          (1<<0)  /* relative origin mode flag         */
 930 #define Screen_VisibleCursor     (1<<1)  /* cursor visible?                   */
 931 #define Screen_Autowrap          (1<<2)  /* auto-wrap flag                    */
 932 #define Screen_Insert            (1<<3)  /* insert mode (vs. overstrike)      */
 933 #define Screen_WrapNext          (1<<4)  /* need to wrap for next char?       */
 934 #define Screen_DefaultFlags      (Screen_VisibleCursor | Screen_Autowrap)
 935
 936 /* rxvt_vars.options */
 937 enum {
 938 # define def(name,idx) Opt_ ## name = idx,
 939 # define nodef(name)   Opt_ ## name = 0,
 940 # include "optinc.h"
 941 # undef nodef
 942 # undef def
 943 Opt_count
 944 };
 945
 946 /* ------------------------------------------------------------------------- */
 947
 948 struct rxvt_vars : TermWin_t
 949 {
 950   scrollBar_t     scrollBar;
 951   uint8_t         options[(Opt_count + 7) >> 3];
 952   XSizeHints      szHint;
 953   rxvt_color     *pix_colors;
 954   Cursor          TermWin_cursor;       /* cursor for vt window */
 955   int             numlock_state;
 956   line_t         *row_buf;      // all lines, scrollback + terminal, circular, followed by temp_buf
 957   line_t         *drawn_buf;    // text on screen
 958   line_t         *swap_buf;     // lines for swap buffer
 959   char           *tabs;         /* per location: 1 == tab-stop               */
 960   screen_t        screen;
 961   screen_t        swap;
 962   selection_t     selection;
 963   rxvt_color      pix_colors_focused[TOTAL_COLORS];
 964 #ifdef OFF_FOCUS_FADING
 965   rxvt_color      pix_colors_unfocused[TOTAL_COLORS];
 966 #endif
 967 };
 968
 969 struct rxvt_term : zero_initialized, rxvt_vars, rxvt_screen
 970 {
 971
 972   // special markers with magic addresses
 973   static const char resval_undef [];    // options specifically unset
 974   static const char resval_on [];       // boolean options switched on
 975   static const char resval_off [];      // or off
 976
 977   log_callback   *log_hook;             // log error messages through this hook, if != 0
 978   getfd_callback *getfd_hook;           // convert remote to local fd, if != 0
 979 #if ENABLE_PERL
 980   rxvt_perl_term  perl;
 981 #endif
 982   struct mbstate  mbstate;              // current input multibyte state
 983
 984   unsigned char   want_refresh:1,
 985                   current_screen:1,     /* primary or secondary              */
 986                   num_scr_allow:1,
 987                   bypass_keystate:1,
 988 #if ENABLE_FRILLS
 989                   urgency_hint:1,
 990 #endif
 991 #if CURSOR_BLINK
 992                   hidden_cursor:1,
 993 #endif
 994 #if TEXT_BLINK
 995                   hidden_text:1,
 996 #endif
 997 #if POINTER_BLANK
 998                   hidden_pointer:1,
 999 #endif
1000                   enc_utf8:1,           /* whether locale uses utf-8 */
1001                   seen_input:1,         /* whether we have seen some program output yet */
1002                   seen_resize:1,        /* whether we had a resize event */
1003                   parsed_geometry:1;
1004
1005   unsigned char   refresh_type,
1006 #ifdef META8_OPTION
1007                   meta_char,            /* Alt-key prefix */
1008 #endif
1009                   selection_wait,
1010                   selection_type;
1011 /* ---------- */
1012   bool            rvideo_state, rvideo_mode;
1013 #ifndef NO_BELL
1014   bool            rvideo_bell;
1015 #endif
1016   int             num_scr;              /* screen: number of lines scrolled */
1017   int             prev_ncol,            /* screen: previous number of columns */
1018                   prev_nrow;            /* screen: previous number of rows */
1019 /* ---------- */
1020   rend_t          rstyle;
1021 /* ---------- */
1022 #ifdef SELECTION_SCROLLING
1023   int             scroll_selection_lines;
1024   enum page_dirn  scroll_selection_dir;
1025   int             selection_save_x,
1026                   selection_save_y,
1027                   selection_save_state;
1028 #endif
1029 /* ---------- */
1030   int             csrO,       /* Hops - csr offset in thumb/slider to      */
1031                               /*   give proper Scroll behaviour            */
1032 #if defined(MOUSE_WHEEL) && defined(MOUSE_SLIP_WHEELING)
1033                   mouse_slip_wheel_speed,
1034 #endif
1035                   refresh_count,
1036                   window_vt_x,
1037                   window_vt_y,
1038                   mouse_row,
1039                   mouse_col,
1040 # ifdef POINTER_BLANK
1041                   pointerBlankDelay,
1042 # endif
1043                   allowedxerror;
1044 /* ---------- */
1045   unsigned int    ModLevel3Mask,
1046                   ModMetaMask,
1047                   ModNumLockMask;
1048   int             old_width,  /* last used width in screen resize          */
1049                   old_height; /* last used height in screen resize         */
1050   unsigned long   priv_modes,
1051                   SavedModes;
1052 /* ---------- */
1053   Atom            *xa;
1054 /* ---------- */
1055   Time            selection_time,
1056                   selection_request_time,
1057                   clipboard_time;
1058   pid_t           cmd_pid;    /* process id of child */
1059   char *          incr_buf;
1060   size_t          incr_buf_size, incr_buf_fill;
1061 /* ---------- */
1062   struct mouse_event MEvent;
1063   XComposeStatus  compose;
1064   struct termios  tio;
1065   row_col_t       oldcursor;
1066 #ifdef HAVE_BG_PIXMAP
1067   bgPixmap_t      bgPixmap;
1068 #endif
1069 #ifdef HAVE_AFTERIMAGE
1070   ASVisual       *asv;
1071   ASImageManager *asimman;
1072
1073   void init_asv ()
1074   {
1075     if (!asv)
1076       asv = create_asvisual_for_id (dpy, display->screen, depth, XVisualIDFromVisual (visual), cmap, NULL);
1077   }
1078 #endif
1079
1080 #if ENABLE_OVERLAY
1081   overlay_base ov;
1082
1083   void scr_swap_overlay () NOTHROW;
1084   void scr_overlay_new (int x, int y, int w, int h) NOTHROW;
1085   void scr_overlay_off () NOTHROW;
1086   void scr_overlay_set (int x, int y,
1087                         text_t text,
1088                         rend_t rend = OVERLAY_RSTYLE) NOTHROW;
1089   void scr_overlay_set (int x, int y, const char *s) NOTHROW;
1090   void scr_overlay_set (int x, int y, const wchar_t *s) NOTHROW;
1091 #endif
1092
1093   vector<void *> allocated;           // free these memory blocks with free()
1094
1095   char            env_windowid[21];   /* environmental variable WINDOWID */
1096   char            env_colorfgbg[sizeof ("COLORFGBG=default;default;bg") + 1];
1097   char           *env_display;        /* environmental variable DISPLAY  */
1098   char           *env_term;           /* environmental variable TERM     */
1099
1100   char           *locale;
1101   char            charsets[4];
1102   char           *v_buffer;           /* pointer to physical buffer */
1103   unsigned int    v_buflen;           /* size of area to write */
1104   stringvec      *argv, *envv;        /* if != 0, will be freed at destroy time */
1105
1106 #ifdef KEYSYM_RESOURCE
1107   keyboard_manager *keyboard;
1108 #endif
1109 #ifndef NO_RESOURCES
1110   XrmDatabase option_db;
1111 #endif
1112
1113   const char     *rs[NUM_RESOURCES];
1114   /* command input buffering */
1115   char           *cmdbuf_ptr, *cmdbuf_endp;
1116   char            cmdbuf_base[CBUFSIZ];
1117
1118   ptytty         *pty;
1119
1120   rxvt_salloc    *talloc;             // text line allocator
1121   rxvt_salloc    *ralloc;             // rend line allocator
1122
1123   static vector<rxvt_term *> termlist; // a vector of all running rxvt_term's
1124
1125 #if ENABLE_FRILLS || ISO_14755
1126   // ISO 14755 entry support
1127   unicode_t iso14755buf;
1128   void commit_iso14755 ();
1129 # if ISO_14755
1130   void iso14755_51 (unicode_t ch, rend_t r = DEFAULT_RSTYLE, int x = 0, int y = -1);
1131   void iso14755_54 (int x, int y);
1132 # endif
1133 #endif
1134
1135   long vt_emask, vt_emask_perl, vt_emask_xim, vt_emask_mouse;
1136
1137   void vt_select_input () const NOTHROW
1138   {
1139     XSelectInput (dpy, vt, vt_emask | vt_emask_perl | vt_emask_xim | vt_emask_mouse);
1140   }
1141
1142 #if ENABLE_TRANSPARENCY || ENABLE_PERL
1143   void rootwin_cb (XEvent &xev);
1144   xevent_watcher rootwin_ev;
1145 #endif
1146 #ifdef HAVE_BG_PIXMAP
1147   void update_background ();
1148 #if TRACE_PIXMAPS
1149   void trace_update_background (const char *file, int line);
1150 # define update_background() trace_update_background (__FILE__, __LINE__)
1151 #endif
1152   void update_background_cb (ev::timer &w, int revents);
1153   ev::timer update_background_ev;
1154 #endif
1155
1156   void x_cb (XEvent &xev);
1157   xevent_watcher termwin_ev;
1158   xevent_watcher vt_ev;
1159   xevent_watcher scrollbar_ev;
1160
1161   void child_cb (ev::child &w, int revents); ev::child child_ev;
1162   void destroy_cb (ev::idle &w, int revents); ev::idle destroy_ev;
1163   void refresh_check ();
1164   void flush ();
1165   void flush_cb (ev::timer &w, int revents); ev::timer flush_ev;
1166   bool pty_fill ();
1167   void pty_cb (ev::io &w, int revents); ev::io pty_ev;
1168   void incr_cb (ev::timer &w, int revents) NOTHROW; ev::timer incr_ev;
1169
1170 #ifdef CURSOR_BLINK
1171   void cursor_blink_cb (ev::timer &w, int revents); ev::timer cursor_blink_ev;
1172 #endif
1173 #ifdef TEXT_BLINK
1174   void text_blink_cb (ev::timer &w, int revents); ev::timer text_blink_ev;
1175 #endif
1176 #ifndef NO_BELL
1177   void bell_cb (ev::timer &w, int revents); ev::timer bell_ev;
1178 #endif
1179
1180 #ifndef NO_SCROLLBAR_BUTTON_CONTINUAL_SCROLLING
1181   void cont_scroll_cb (ev::timer &w, int revents); ev::timer cont_scroll_ev;
1182 #endif
1183 #ifdef SELECTION_SCROLLING
1184   void sel_scroll_cb (ev::timer &w, int revents); ev::timer sel_scroll_ev;
1185 #endif
1186 #if defined(MOUSE_WHEEL) && defined(MOUSE_SLIP_WHEELING)
1187   void slip_wheel_cb (ev::timer &w, int revents); ev::timer slip_wheel_ev;
1188 #endif
1189
1190 #ifdef POINTER_BLANK
1191   void pointer_cb (ev::timer &w, int revents); ev::timer pointer_ev;
1192   void pointer_blank ();
1193 #endif
1194   void pointer_unblank ();
1195
1196   void tt_printf (const char *fmt,...);
1197   void tt_write (const char *data, unsigned int len);
1198   void pty_write ();
1199
1200   void init (stringvec *argv, stringvec *envv)
1201   {
1202     this->argv = argv;
1203     init (argv->size (), argv->begin (), envv);
1204   }
1205
1206   void make_current () const // make this the "currently active" urxvt instance
1207   {
1208     SET_R (this);
1209     set_environ (envv);
1210     rxvt_set_locale (locale);
1211   }
1212
1213 #if USE_XIM
1214   rxvt_xim *input_method;
1215   XIC      Input_Context;
1216   XIMStyle input_style;
1217   XPoint   spot; // most recently sent spot position
1218
1219   void im_destroy ();
1220   void im_cb (); im_watcher im_ev;
1221   void im_set_size (XRectangle &size);
1222   void im_set_position (XPoint &pos) NOTHROW;
1223   void im_set_color (unsigned long &fg, unsigned long &bg);
1224   void im_set_preedit_area (XRectangle &preedit_rect, XRectangle &status_rect, const XRectangle &needed_rect);
1225
1226   bool IMisRunning ();
1227   void IMSendSpot ();
1228   bool IM_get_IC (const char *modifiers);
1229   void IMSetPosition ();
1230 #endif
1231
1232   // command.C
1233   void key_press (XKeyEvent &ev);
1234   void key_release (XKeyEvent &ev);
1235   unsigned int cmd_write (const char *str, unsigned int count);
1236
1237   wchar_t next_char () NOTHROW;
1238   wchar_t cmd_getc () THROW ((class out_of_input));
1239   uint32_t next_octet () NOTHROW;
1240   uint32_t cmd_get8 () THROW ((class out_of_input));
1241
1242   void cmd_parse ();
1243   void mouse_report (XButtonEvent &ev);
1244   void button_press (XButtonEvent &ev);
1245   void button_release (XButtonEvent &ev);
1246   void focus_in ();
1247   void focus_out ();
1248 #if ENABLE_FRILLS
1249   void set_urgency (bool enable);
1250 #else
1251   void set_urgency (bool enable) { }
1252 #endif
1253   void update_fade_color (unsigned int idx);
1254 #ifdef PRINTPIPE
1255   FILE *popen_printer ();
1256   int pclose_printer (FILE *stream);
1257 #endif
1258   void process_print_pipe ();
1259   void process_nonprinting (unicode_t ch);
1260   void process_escape_vt52 (unicode_t ch);
1261   void process_escape_seq ();
1262   void process_csi_seq ();
1263   void process_window_ops (const int *args, unsigned int nargs);
1264   char *get_to_st (unicode_t &ends_how);
1265   void process_dcs_seq ();
1266   void process_osc_seq ();
1267   void process_color_seq (int report, int color, const char *str, char resp);
1268   void process_xterm_seq (int op, char *str, char resp);
1269   int privcases (int mode, unsigned long bit);
1270   void process_terminal_mode (int mode, int priv, unsigned int nargs, const int *arg);
1271   void process_sgr_mode (unsigned int nargs, const int *arg);
1272   void process_graphics ();
1273   // init.C
1274   void init_vars ();
1275   const char **init_resources (int argc, const char *const *argv);
1276   void init (int argc, const char *const *argv, stringvec *envv);
1277   void init_env ();
1278   void set_locale (const char *locale);
1279   void init_xlocale ();
1280   void init_command (const char *const *argv);
1281   void run_command (const char *const *argv);
1282   int run_child (const char *const *argv);
1283   void color_aliases (int idx);
1284   void create_windows (int argc, const char *const *argv);
1285   void get_colours ();
1286   void get_ourmods ();
1287   // main.C
1288   void tt_winch ();
1289   rxvt_term ();
1290   ~rxvt_term ();
1291   void destroy ();
1292   void emergency_cleanup ();
1293   void recolour_cursor ();
1294   void resize_all_windows (unsigned int newwidth, unsigned int newheight, int ignoreparent);
1295   void window_calc (unsigned int newwidth, unsigned int newheight);
1296   bool set_fonts ();
1297   void set_string_property (Atom prop, const char *str, int len = -1);
1298   void set_utf8_property (Atom prop, const char *str, int len = -1);
1299   void set_title (const char *str);
1300   void set_icon_name (const char *str);
1301   void set_window_color (int idx, const char *color);
1302   void set_colorfgbg ();
1303   bool set_color (rxvt_color &color, const char *name);
1304   void alias_color (int dst, int src);
1305   void set_widthheight (unsigned int newwidth, unsigned int newheight);
1306   void get_window_origin (int &x, int &y);
1307   Pixmap get_pixmap_property (int prop_id);
1308
1309   // screen.C
1310
1311   void lalloc (line_t &l) const
1312   {
1313     l.t = (text_t *)talloc->alloc ();
1314     l.r = (rend_t *)ralloc->alloc ();
1315   }
1316
1317 #if 0
1318   void lfree (line_t &l)
1319   {
1320     talloc->free (l.t);
1321     ralloc->free (l.r);
1322   }
1323 #endif
1324
1325   void lresize (line_t &l) const
1326   {
1327     if (!l.t)
1328       return;
1329
1330     l.t = (text_t *)talloc->alloc (l.t, prev_ncol * sizeof (text_t));
1331     l.r = (rend_t *)ralloc->alloc (l.r, prev_ncol * sizeof (rend_t));
1332
1333     l.l = min (l.l, ncol);
1334
1335     if (ncol > prev_ncol)
1336       scr_blank_line (l, prev_ncol, ncol - prev_ncol, DEFAULT_RSTYLE);
1337   }
1338
1339   int fgcolor_of (rend_t r) const NOTHROW
1340   {
1341     int base = GET_BASEFG (r);
1342 #ifndef NO_BRIGHTCOLOR
1343     if (r & RS_Bold
1344 # if ENABLE_STYLES
1345         && option (Opt_intensityStyles)
1346 # endif
1347         && IN_RANGE_INC (base, minCOLOR, minBrightCOLOR))
1348       base += minBrightCOLOR - minCOLOR;
1349 #endif
1350     return base;
1351   }
1352
1353   int bgcolor_of (rend_t r) const NOTHROW
1354   {
1355     int base = GET_BASEBG (r);
1356 #ifndef NO_BRIGHTCOLOR
1357     if (r & RS_Blink
1358 # if ENABLE_STYLES
1359         && option (Opt_intensityStyles)
1360 # endif
1361         && IN_RANGE_INC (base, minCOLOR, minBrightCOLOR))
1362       base += minBrightCOLOR - minCOLOR;
1363 #endif
1364     return base;
1365   }
1366
1367   bool option (uint8_t opt) const NOTHROW
1368   {
1369     if (!opt)
1370       return 0;
1371
1372     --opt;
1373     return options[opt >> 3] & (1 << (opt & 7));
1374   }
1375
1376   void set_option (uint8_t opt, bool set = true) NOTHROW
1377   {
1378     if (!opt)
1379       return;
1380
1381     --opt;
1382     if (set)
1383       options[opt >> 3] |= (1 << (opt & 7));
1384     else
1385       options[opt >> 3] &= ~(1 << (opt & 7));
1386   }
1387
1388   void set_privmode (unsigned bit, int set) NOTHROW
1389   {
1390     if (set)
1391       priv_modes |= bit;
1392     else
1393       priv_modes &= ~bit;
1394   }
1395
1396   // modifies first argument(!)
1397   void paste (char *data, unsigned int len) NOTHROW;
1398   void scr_blank_line (line_t &l, unsigned int col, unsigned int width, rend_t efs) const NOTHROW;
1399   void scr_blank_screen_mem (line_t &l, rend_t efs) const NOTHROW;
1400   void scr_kill_char (line_t &l, int col) const NOTHROW;
1401   int scr_scroll_text (int row1, int row2, int count) NOTHROW;
1402   void scr_reset ();
1403   void scr_release () NOTHROW;
1404   void scr_clear (bool really = false) NOTHROW;
1405   void scr_refresh () NOTHROW;
1406   bool scr_refresh_rend (rend_t mask, rend_t value) NOTHROW;
1407   void scr_erase_screen (int mode) NOTHROW;
1408 #if ENABLE_FRILLS
1409   void scr_erase_savelines () NOTHROW;
1410   void scr_backindex () NOTHROW;
1411   void scr_forwardindex () NOTHROW;
1412 #endif
1413   void scr_touch (bool refresh) NOTHROW;
1414   void scr_expose (int x, int y, int width, int height, bool refresh) NOTHROW;
1415   void scr_recolour () NOTHROW;
1416   void scr_remap_chars () NOTHROW;
1417   void scr_remap_chars (line_t &l) NOTHROW;
1418
1419   enum cursor_mode { SAVE, RESTORE };
1420
1421   void scr_poweron ();
1422   void scr_soft_reset () NOTHROW;
1423   void scr_cursor (cursor_mode mode) NOTHROW;
1424   void scr_do_wrap () NOTHROW;
1425   void scr_swap_screen () NOTHROW;
1426   void scr_change_screen (int scrn);
1427   void scr_color (unsigned int color, int fgbg) NOTHROW;
1428   void scr_rendition (int set, int style) NOTHROW;
1429   void scr_add_lines (const wchar_t *str, int len, int minlines = 0) NOTHROW;
1430   void scr_backspace () NOTHROW;
1431   void scr_tab (int count, bool ht = false) NOTHROW;
1432   void scr_gotorc (int row, int col, int relative) NOTHROW;
1433   void scr_index (enum page_dirn direction) NOTHROW;
1434   void scr_erase_line (int mode) NOTHROW;
1435   void scr_E () NOTHROW;
1436   void scr_insdel_lines (int count, int insdel) NOTHROW;
1437   void scr_insdel_chars (int count, int insdel) NOTHROW;
1438   void scr_scroll_region (int top, int bot) NOTHROW;
1439   void scr_cursor_visible (int mode) NOTHROW;
1440   void scr_autowrap (int mode) NOTHROW;
1441   void scr_relative_origin (int mode) NOTHROW;
1442   void scr_insert_mode (int mode) NOTHROW;
1443   void scr_set_tab (int mode) NOTHROW;
1444   void scr_rvideo_mode (bool on) NOTHROW;
1445   void scr_report_position () NOTHROW;
1446   void set_font_style () NOTHROW;
1447   void scr_charset_choose (int set) NOTHROW;
1448   void scr_charset_set (int set, unsigned int ch) NOTHROW;
1449   void scr_move_to (int y, int len) NOTHROW;
1450   bool scr_page (enum page_dirn direction, int nlines) NOTHROW;
1451   bool scr_changeview (int new_view_start) NOTHROW;
1452   void scr_bell () NOTHROW;
1453   void scr_printscreen (int fullhist) NOTHROW;
1454   void scr_xor_rect (int beg_row, int beg_col, int end_row, int end_col, rend_t rstyle1, rend_t rstyle2) NOTHROW;
1455   void scr_xor_span (int beg_row, int beg_col, int end_row, int end_col, rend_t rstyle) NOTHROW;
1456   void scr_reverse_selection () NOTHROW;
1457   void scr_dump (int fd) NOTHROW;
1458
1459   void selection_check (int check_more) NOTHROW;
1460   void selection_paste (Window win, Atom prop, bool delete_prop) NOTHROW;
1461   void selection_property (Window win, Atom prop) NOTHROW;
1462   void selection_request (Time tm, int selnum = Sel_Primary) NOTHROW;
1463   int selection_request_other (Atom target, int selnum) NOTHROW;
1464   void selection_clear (bool clipboard = false) NOTHROW;
1465   void clipboard_copy (Time tm);
1466   void selection_make (Time tm);
1467   bool selection_grab (Time tm, bool clipboard = false) NOTHROW;
1468   void selection_start_colrow (int col, int row) NOTHROW;
1469   void selection_delimit_word (enum page_dirn dirn, const row_col_t *mark, row_col_t *ret) NOTHROW;
1470   void selection_extend_colrow (int32_t col, int32_t row, int button3, int buttonpress, int clickchange) NOTHROW;
1471   void selection_remove_trailing_spaces () NOTHROW;
1472   void selection_send (const XSelectionRequestEvent &rq) NOTHROW;
1473   void selection_click (int clicks, int x, int y) NOTHROW;
1474   void selection_extend (int x, int y, int flag) NOTHROW;
1475   void selection_rotate (int x, int y) NOTHROW;
1476
1477   // xdefaults.C
1478   void get_options (int argc, const char *const *argv);
1479   int parse_keysym (const char *str, const char *arg);
1480   const char *x_resource (const char *name);
1481   void extract_resources ();
1482 };
1483
1484 #endif /* _RXVT_H_ */
1485