*** empty log message ***
[dana/urxvt.git] / src / rxvt.h
1 /*
2  * $Id: rxvt.h,v 1.19 2003-12-19 09:41:09 pcg Exp $
3  */
4
5 #ifndef _RXVT_H_                /* include once only */
6 #define _RXVT_H_
7
8 #include "rxvtlib.h"
9
10 #include "feature.h"
11
12 #include <X11/cursorfont.h>
13 #include <X11/keysym.h>
14 #include <X11/keysymdef.h>
15 #include <X11/Xatom.h>
16
17 #include "defaultfont.h"
18 #include "rxvtcolor.h"
19 #include "iom.h"
20 #include "salloc.h"
21
22 #include <wchar.h>
23
24 /*
25  *****************************************************************************
26  * SYSTEM HACKS
27  *****************************************************************************
28  */
29 /* Consistent defines - please report on the necessity
30  * @ Unixware: defines (__svr4__)
31  */
32 #if defined (SVR4) && !defined (__svr4__)
33 # define __svr4__
34 #endif
35 #if defined (sun) && !defined (__sun__)
36 # define __sun__
37 #endif
38
39
40 #ifndef HAVE_XPOINTER
41 typedef char   *XPointer;
42 #endif
43
44 #ifdef HAVE_TERMIOS_H
45 # include <termios.h>
46 typedef struct termios ttymode_t;
47 #else
48 # include <sgtty.h>
49 typedef struct {
50   struct sgttyb   sg;
51   struct tchars   tc;
52   struct ltchars  lc;
53   int             line;
54   int             local;
55 } ttymode_t;
56 #endif
57
58 #ifdef GREEK_SUPPORT
59 # include "grkelot.h"
60 #endif
61 #ifdef XPM_BACKGROUND
62 # ifdef XPM_INC_X11
63 #  include <X11/xpm.h>
64 # else
65 #  include <xpm.h>
66 # endif
67 #endif
68
69 #ifndef STDIN_FILENO
70 # define STDIN_FILENO   0
71 # define STDOUT_FILENO  1
72 # define STDERR_FILENO  2
73 #endif
74
75 #if defined(HAVE_GRANTPT) && defined(HAVE_UNLOCKPT)
76 # if defined(PTYS_ARE_GETPT) || defined(PTYS_ARE_PTMX)
77 #  define NO_SETOWNER_TTYDEV
78 # endif
79 #endif
80 #if defined(__CYGWIN32__) || defined(PTYS_ARE_OPENPTY)
81 # define NO_SETOWNER_TTYDEV
82 #endif
83
84 /*
85  *****************************************************************************
86  * STRUCTURES AND TYPEDEFS
87  *****************************************************************************
88  */
89 struct grwin_t;
90
91 /* Sanitize menubar info */
92 #ifndef MENUBAR
93 # undef MENUBAR_MAX
94 #endif
95 #ifndef MENUBAR_MAX
96 # define MENUBAR_MAX    0
97 #endif
98
99 /* If we're using either the rxvt scrollbar or menu bars, keep the
100  * scrollColor resource.
101  */
102 #if defined(RXVT_SCROLLBAR) || defined(MENUBAR)
103 # define KEEP_SCROLLCOLOR 1
104 #else
105 # undef KEEP_SCROLLCOLOR
106 #endif
107
108 #ifdef XPM_BACKGROUND
109 typedef struct {
110   short           w, h, x, y;
111   Pixmap          pixmap;
112 } bgPixmap_t;
113 #endif
114
115 /*
116  * the 'essential' information for reporting Mouse Events
117  * pared down from XButtonEvent
118  */
119 struct mouse_event {
120   int             clicks;
121   Time            time;       /* milliseconds */
122   unsigned int    state;      /* key or button mask */
123   unsigned int    button;     /* detail */
124 };
125
126 #ifndef min
127 # define min(a,b)       (((a) < (b)) ? (a) : (b))
128 # define max(a,b)       (((a) > (b)) ? (a) : (b))
129 #endif
130
131 #define MAX_IT(current, other)  if ((other) > (current)) (current) = (other)
132 #define MIN_IT(current, other)  if ((other) < (current)) (current) = (other)
133 #define SWAP_IT(one, two, typeof)                                       \
134     do {                                                                \
135         typeof          swapittmp;                                      \
136         (swapittmp) = (one); (one) = (two); (two) = (swapittmp);        \
137     } while (/* CONSTCOND */ 0)
138 #define BOUND_POSITIVE_INT16(val)                       \
139     (int16_t)((val) <= 0                                \
140               ? 0                                       \
141               : min((val), (((uint16_t)-1)>>1)))
142
143 /*
144  *****************************************************************************
145  * NORMAL DEFINES
146  *****************************************************************************
147  */
148
149 #if defined (NO_OLD_SELECTION) && defined(NO_NEW_SELECTION)
150 # error if you disable both selection styles, how can you select, silly?
151 #endif
152
153 #define APL_CLASS       "XTerm" /* class name */
154 #define APL_SUBCLASS    "Rxvt"  /* also check resources under this name */
155 #define APL_NAME        "rxvt"  /* normal name */
156
157 /* COLORTERM, TERM environment variables */
158 #define COLORTERMENV    "rxvt"
159 #ifdef XPM_BACKGROUND
160 # define COLORTERMENVFULL COLORTERMENV "-xpm"
161 #else
162 # define COLORTERMENVFULL COLORTERMENV
163 #endif
164 #ifndef TERMENV
165 # define TERMENV        "xterm"
166 #endif
167
168 #if defined (NO_MOUSE_REPORT) && !defined (NO_MOUSE_REPORT_SCROLLBAR)
169 # define NO_MOUSE_REPORT_SCROLLBAR
170 #endif
171
172 #ifdef NO_RESOURCES
173 # undef USE_XGETDEFAULT
174 #endif
175
176 /* now look for other badly set stuff */
177
178 #if !defined (EACCESS) && defined(EAGAIN)
179 # define EACCESS EAGAIN
180 #endif
181
182 #ifndef EXIT_SUCCESS            /* missing from <stdlib.h> */
183 # define EXIT_SUCCESS           0       /* exit function success */
184 # define EXIT_FAILURE           1       /* exit function failure */
185 #endif
186
187 #define menuBar_esc             10
188 #define scrollBar_esc           30
189 #define menuBar_margin          2       /* margin below text */
190
191 #if defined(RXVT_SCROLLBAR) || defined(NEXT_SCROLLBAR) || defined(XTERM_SCROLLBAR)
192 # define HAVE_SCROLLBARS
193 #endif
194
195 /* width of scrollBar, menuBar shadow, must be 1 or 2 */
196 #ifdef HALFSHADOW
197 # define SHADOW 1
198 #else
199 # define SHADOW 2
200 #endif
201
202 #define R_SB_ALIGN_CENTRE       0
203 #define R_SB_ALIGN_TOP          1
204 #define R_SB_ALIGN_BOTTOM       2
205
206 #define R_SB_RXVT               0
207 #define R_SB_NEXT               1
208 #define R_SB_XTERM              2
209
210 #define SB_WIDTH_NEXT           19
211 #define SB_WIDTH_XTERM          7
212 #ifndef SB_WIDTH_RXVT
213 # define SB_WIDTH_RXVT          10
214 #endif
215
216 /*
217  * NeXT scrollbar defines
218  */
219 #define SB_PADDING              1
220 #define SB_BORDER_WIDTH         1
221 #define SB_BEVEL_WIDTH_UPPER_LEFT       1
222 #define SB_BEVEL_WIDTH_LOWER_RIGHT      2
223 #define SB_LEFT_PADDING         (SB_PADDING + SB_BORDER_WIDTH)
224 #define SB_MARGIN_SPACE         (SB_PADDING * 2)
225 #define SB_BUTTON_WIDTH         (SB_WIDTH_NEXT - SB_MARGIN_SPACE - SB_BORDER_WIDTH)
226 #define SB_BUTTON_HEIGHT        (SB_BUTTON_WIDTH)
227 #define SB_BUTTON_SINGLE_HEIGHT (SB_BUTTON_HEIGHT + SB_PADDING)
228 #define SB_BUTTON_BOTH_HEIGHT   (SB_BUTTON_SINGLE_HEIGHT * 2)
229 #define SB_BUTTON_TOTAL_HEIGHT  (SB_BUTTON_BOTH_HEIGHT + SB_PADDING)
230 #define SB_BUTTON_BEVEL_X       (SB_LEFT_PADDING)
231 #define SB_BUTTON_FACE_X        (SB_BUTTON_BEVEL_X + SB_BEVEL_WIDTH_UPPER_LEFT)
232 #define SB_THUMB_MIN_HEIGHT     (SB_BUTTON_WIDTH - (SB_PADDING * 2))
233  /*
234   *    +-------------+
235   *    |             | <---< SB_PADDING
236   *    | ::::::::::: |
237   *    | ::::::::::: |
238   *   '''''''''''''''''
239   *   ,,,,,,,,,,,,,,,,,
240   *    | ::::::::::: |
241   *    | ::::::::::: |
242   *    |  +---------------< SB_BEVEL_WIDTH_UPPER_LEFT
243   *    |  | :::::::: |
244   *    |  V :::: vv-------< SB_BEVEL_WIDTH_LOWER_RIGHT
245   *    | +---------+ |
246   *    | | ......%%| |
247   *    | | ......%%| |
248   *    | | ..()..%%| |
249   *    | | ......%%| |
250   *    | | %%%%%%%%| |
251   *    | +---------+ | <.........................
252   *    |             | <---< SB_PADDING         :
253   *    | +---------+ | <-+..........            :---< SB_BUTTON_TOTAL_HEIGHT
254   *    | | ......%%| |   |         :            :
255   *    | | ../\..%%| |   |---< SB_BUTTON_HEIGHT :
256   *    | | %%%%%%%%| |   |         :            :
257   *    | +---------+ | <-+         :            :
258   *    |             |             :            :
259   *    | +---------+ | <-+         :---< SB_BUTTON_BOTH_HEIGHT
260   *    | | ......%%| |   |         :            :
261   *    | | ..\/..%%| |   |         :            :
262   *    | | %%%%%%%%| |   |---< SB_BUTTON_SINGLE_HEIGHT
263   *    | +---------+ |   |         :            :
264   *    |             |   |         :            :
265   *    +-------------+ <-+.........:............:
266   *    ^^|_________| :
267   *    ||     |      :
268   *    ||     +---< SB_BUTTON_WIDTH
269   *    ||            :
270   *    |+------< SB_PADDING
271   *    |:            :
272   *    +----< SB_BORDER_WIDTH
273   *     :            :
274   *     :............:
275   *           |
276   *           +---< SB_WIDTH_NEXT
277   */
278
279 #define NO_REFRESH              0       /* Window not visible at all!        */
280 #define FAST_REFRESH            (1<<0)  /* Fully exposed window              */
281 #define SLOW_REFRESH            (1<<1)  /* Partially exposed window          */
282 #define SMOOTH_REFRESH          (1<<2)  /* Do sync'ing to make it smooth     */
283 #define REFRESH_BOUNDS          (1<<3)
284
285 #ifdef NO_SECONDARY_SCREEN
286 # define NSCREENS               0
287 #else
288 # define NSCREENS               1
289 #endif
290
291 #define IGNORE                  0
292 #define SAVE                    's'
293 #define RESTORE                 'r'
294
295 /* special (internal) prefix for font commands */
296 #define FONT_CMD                '#'
297 #define FONT_DN                 "#-"
298 #define FONT_UP                 "#+"
299
300 /* flags for rxvt_scr_gotorc() */
301 #define C_RELATIVE              1       /* col movement is relative */
302 #define R_RELATIVE              2       /* row movement is relative */
303 #define RELATIVE                (R_RELATIVE|C_RELATIVE)
304
305 /* modes for rxvt_scr_insdel_chars(), rxvt_scr_insdel_lines() */
306 #define INSERT                  -1      /* don't change these values */
307 #define DELETE                  +1
308 #define ERASE                   +2
309
310 /* modes for rxvt_scr_page() - scroll page. used by scrollbar window */
311 enum page_dirn {
312   UP,
313   DN,
314   NO_DIR
315 };
316
317 /* arguments for rxvt_scr_change_screen() */
318 enum {
319   PRIMARY = 0,
320   SECONDARY
321 };
322
323 enum {
324   SBYTE = 0,
325   WBYTE
326 };
327
328
329 #define RS_None                 0       /* Normal */
330
331 #define RS_fgMask               0x000001FFu     /* 512 colors */
332 #define RS_bgMask               0x0003FE00u     /* 512 colors */
333 #define RS_Bold                 0x00040000u     /* bold */
334 #define RS_Blink                0x00080000u     /* blink */
335 #define RS_RVid                 0x00100000u     /* reverse video */
336 #define RS_Uline                0x00200000u     /* underline */
337
338 #define RS_wide                 0x00400000u     /* only multibyte characters */
339 #define IS_WIDE(r)              ((r) & RS_wide)
340
341 #define RS_fontMask             0xff000000u     /* plenty(?) of fonts */
342 #define RS_fontShift            24
343
344 #define RS_baseattrMask         (RS_Bold|RS_Blink|RS_RVid|RS_Uline)
345 #define RS_attrMask             (RS_baseattrMask|RS_fontMask|RS_wide)
346
347 #define Sel_none                0       /* Not waiting */
348 #define Sel_normal              0x01    /* normal selection */
349 #define Sel_incr                0x02    /* incremental selection */
350 #define Sel_direct              0x00
351 #define Sel_Primary             0x01
352 #define Sel_Secondary           0x02
353 #define Sel_Clipboard           0x03
354 #define Sel_whereMask           0x0f
355 #define Sel_CompoundText        0x10    /* last request was Compound */
356
357 enum {
358   C0_NUL = 0x00,
359           C0_SOH, C0_STX, C0_ETX, C0_EOT, C0_ENQ, C0_ACK, C0_BEL,
360   C0_BS , C0_HT , C0_LF , C0_VT , C0_FF , C0_CR , C0_SO , C0_SI ,
361   C0_DLE, C0_DC1, C0_DC2, D0_DC3, C0_DC4, C0_NAK, C0_SYN, C0_ETB,
362   C0_CAN, C0_EM , C0_SUB, C0_ESC, C0_IS4, C0_IS3, C0_IS2, C0_IS1
363 }; 
364 #define CHAR_ST                 0x9c    /* 0234 */
365
366 /*
367  * XTerm Operating System Commands: ESC ] Ps;Pt (ST|BEL)
368  * colour extensions by Christian W. Zuckschwerdt <zany@triq.net>
369  */
370 #define XTerm_name              0
371 #define XTerm_iconName          1
372 #define XTerm_title             2
373 #define XTerm_Color             4       /* change colors */
374 #define XTerm_Color_cursor      12      /* change actual 'Cursor' color */
375 #define XTerm_Color_pointer     13      /* change actual 'Pointer' color */
376 #define XTerm_Color_RV          17      /* change actual 'Highlight' color */
377 #define XTerm_Color_BD          18      /* change actual 'Bold' color */
378 #define XTerm_Color_UL          19      /* change actual 'Underline' color */
379 #define XTerm_logfile           46      /* not implemented */
380 #define XTerm_font              50
381
382 /*
383  * rxvt extensions of XTerm OSCs: ESC ] Ps;Pt (ST|BEL)
384  */
385 #define XTerm_Menu              10      /* set menu item */
386 #define XTerm_Pixmap            20      /* new bg pixmap */
387 #define XTerm_restoreFG         39      /* change default fg color */
388 #define XTerm_restoreBG         49      /* change default bg color */
389 #define XTerm_dumpscreen        55      /* dump scrollback and all of screen */
390
391 /* Words starting with `Color_' are colours.  Others are counts */
392 /*
393  * The following comment is mostly obsolete since pixcolor_set was expanded:
394  * We're currently upto 29 colours.  Only 3 more available.  The
395  * PixColor and rendition colour usage should probably be decoupled
396  * on the unnecessary items, e.g. Color_pointer, but won't bother
397  * until we need to.  Also, be aware of usage in pixcolor_set
398  */
399
400 enum colour_list {
401   Color_fg = 0,
402   Color_bg,
403   minCOLOR,                   /* 2 */
404   Color_Black = minCOLOR,
405   Color_Red3,
406   Color_Green3,
407   Color_Yellow3,
408   Color_Blue3,
409   Color_Magenta3,
410   Color_Cyan3,
411   maxCOLOR,                   /* minCOLOR + 7 */
412 #ifndef NO_BRIGHTCOLOR
413   Color_AntiqueWhite = maxCOLOR,
414   minBrightCOLOR,             /* maxCOLOR + 1 */
415   Color_Grey25 = minBrightCOLOR,
416   Color_Red,
417   Color_Green,
418   Color_Yellow,
419   Color_Blue,
420   Color_Magenta,
421   Color_Cyan,
422   maxBrightCOLOR,             /* minBrightCOLOR + 7 */
423   Color_White = maxBrightCOLOR,
424 #else
425   Color_White = maxCOLOR,
426 #endif
427 #ifdef TTY_256COLOR
428   min256COLOR = Color_White + 1,
429   max256COLOR = minCOLOR + 255,
430 #endif
431 #ifndef NO_CURSORCOLOR
432   Color_cursor,
433   Color_cursor2,
434 #endif
435   Color_pointer,
436   Color_border,
437 #ifndef NO_BOLD_UNDERLINE_REVERSE
438   Color_BD,
439   Color_UL,
440   Color_RV,
441 #endif
442 #ifdef OPTION_HC
443   Color_HC,
444 #endif
445 #ifdef KEEP_SCROLLCOLOR
446   Color_scroll,
447   Color_trough,
448 #endif
449   NRS_COLORS,                 /* */
450 #ifdef KEEP_SCROLLCOLOR
451   Color_topShadow = NRS_COLORS,
452   Color_bottomShadow,
453   TOTAL_COLORS                /* upto 30 */
454 #else
455   TOTAL_COLORS = NRS_COLORS   /* */
456 #endif
457 };
458
459 #define Color_Bits      9
460 #define NPIXCLR_SETS    9       /* (256 + 14) bits / 32 bits */
461 #define NPIXCLR_BITS    32
462
463 #define DEFAULT_RSTYLE          (RS_None | (Color_fg) | (Color_bg<<Color_Bits))
464
465 /*
466  * Resource list
467  */
468 enum {
469   Rs_display_name = 0,
470   Rs_term_name,
471   Rs_iconName,
472   Rs_geometry,
473   Rs_reverseVideo,
474   Rs_color,
475   _Rs_color = Rs_color + NRS_COLORS - 1,
476   Rs_font,
477   Rs_name,
478   Rs_title,
479 #if defined (XPM_BACKGROUND) || (MENUBAR_MAX)
480   Rs_path,
481 #endif
482 #ifdef XPM_BACKGROUND
483   Rs_backgroundPixmap,
484 #endif
485 #if (MENUBAR_MAX)
486   Rs_menu,
487 #endif
488 #ifdef GREEK_SUPPORT
489   Rs_greek_keyboard,
490   Rs_greektoggle_key,
491 #endif
492   Rs_loginShell,
493   Rs_jumpScroll,
494 #ifdef HAVE_SCROLLBARS
495   Rs_scrollBar,
496   Rs_scrollBar_right,
497   Rs_scrollBar_floating,
498   Rs_scrollBar_align,
499 #endif
500   Rs_scrollstyle,     /* Rs_scrollBar_style */
501   Rs_scrollTtyOutput,
502   Rs_scrollTtyKeypress,
503   Rs_scrollWithBuffer,
504   Rs_saveLines,
505   Rs_utmpInhibit,
506   Rs_visualBell,
507 #if ! defined(NO_MAPALERT) && defined(MAPALERT_OPTION)
508   Rs_mapAlert,
509 #endif
510 #ifdef META8_OPTION
511   Rs_meta8,
512 #endif
513 #ifdef MOUSE_WHEEL
514   Rs_mouseWheelScrollPage,
515 #endif
516 #ifndef NO_BACKSPACE_KEY
517   Rs_backspace_key,
518 #endif
519 #ifndef NO_DELETE_KEY
520   Rs_delete_key,
521 #endif
522   Rs_selectstyle,
523 #ifdef PRINTPIPE
524   Rs_print_pipe,
525 #endif
526 #ifdef USE_XIM
527   Rs_preeditType,
528   Rs_inputMethod,
529 #endif
530 #if defined (HOTKEY_CTRL) || defined (HOTKEY_META)
531   Rs_bigfont_key,
532   Rs_smallfont_key,
533 #endif
534 #ifdef TRANSPARENT
535   Rs_transparent,
536   Rs_transparent_all,
537 #endif
538 #ifndef NO_FRILLS
539   Rs_ext_bwidth,
540   Rs_int_bwidth,
541 #endif
542   Rs_scrollBar_thickness,
543 #ifndef NO_LINESPACE
544   Rs_lineSpace,
545 #endif
546   Rs_cutchars,
547 #ifdef ACS_ASCII
548   Rs_acs_chars,
549 #endif
550   Rs_modifier,
551   Rs_answerbackstring,
552   Rs_tripleclickwords,
553   Rs_cursorBlink,
554   Rs_pointerBlank,
555   Rs_pointerBlankDelay,
556   Rs_imLocale,
557   NUM_RESOURCES
558 };
559
560 enum {
561   XA_COMPOUND_TEXT = 0,
562   XA_MULTIPLE,
563   XA_TARGETS,
564   XA_TEXT,
565   XA_TIMESTAMP,
566   XA_VT_SELECTION,
567   XA_INCR,
568   XA_WMDELETEWINDOW,
569 #ifdef TRANSPARENT
570   XA_XROOTPMAPID,
571 #endif
572 #ifdef OFFIX_DND                /* OffiX Dnd (drag 'n' drop) support */
573   XA_DNDPROTOCOL,
574   XA_DNDSELECTION,
575 #endif                          /* OFFIX_DND */
576   XA_CLIPBOARD,
577   NUM_XA
578 };
579
580 /*
581  * number of graphics points
582  * divisible by 2 (num lines)
583  * divisible by 4 (num rect)
584  */
585 #define NGRX_PTS        1000
586
587 /* DEC private modes */
588 #define PrivMode_132            (1LU<<0)
589 #define PrivMode_132OK          (1LU<<1)
590 #define PrivMode_rVideo         (1LU<<2)
591 #define PrivMode_relOrigin      (1LU<<3)
592 #define PrivMode_Screen         (1LU<<4)
593 #define PrivMode_Autowrap       (1LU<<5)
594 #define PrivMode_aplCUR         (1LU<<6)
595 #define PrivMode_aplKP          (1LU<<7)
596 #define PrivMode_HaveBackSpace  (1LU<<8)
597 #define PrivMode_BackSpace      (1LU<<9)
598 #define PrivMode_ShiftKeys      (1LU<<10)
599 #define PrivMode_VisibleCursor  (1LU<<11)
600 #define PrivMode_MouseX10       (1LU<<12)
601 #define PrivMode_MouseX11       (1LU<<13)
602 #define PrivMode_scrollBar      (1LU<<14)
603 #define PrivMode_menuBar        (1LU<<15)
604 #define PrivMode_TtyOutputInh   (1LU<<16)
605 #define PrivMode_Keypress       (1LU<<17)
606 #define PrivMode_smoothScroll   (1LU<<18)
607 #define PrivMode_vt52           (1LU<<19)
608 /* too annoying to implement X11 highlight tracking */
609 /* #define PrivMode_MouseX11Track       (1LU<<18) */
610
611 #define PrivMode_mouse_report   (PrivMode_MouseX10|PrivMode_MouseX11)
612 #define PrivMode(test,bit)              \
613     if (test)                           \
614         R->PrivateModes |= (bit);       \
615     else                                \
616         R->PrivateModes &= ~(bit)
617
618 #ifdef ALLOW_132_MODE
619 # define PrivMode_Default                                                \
620 (PrivMode_Autowrap|PrivMode_aplKP|PrivMode_ShiftKeys|PrivMode_VisibleCursor|PrivMode_132OK)
621 #else
622 # define PrivMode_Default                                                \
623 (PrivMode_Autowrap|PrivMode_aplKP|PrivMode_ShiftKeys|PrivMode_VisibleCursor)
624 #endif
625
626 #ifdef PREFER_24BIT
627 # define XDEPTH                 R->Xdepth
628 # define XCMAP                  R->Xcmap
629 # define XVISUAL                R->Xvisual
630 #else
631 # ifdef DEBUG_DEPTH
632 #  define XDEPTH                DEBUG_DEPTH
633 # else
634 #  define XDEPTH                DefaultDepth(R->Xdisplay,Xscreen)
635 #  define XCMAP                 DefaultColormap(R->Xdisplay,Xscreen)
636 #  define XVISUAL               DefaultVisual(R->Xdisplay,Xscreen)
637 # endif
638 #endif
639 #define IMBUFSIZ                128     /* input modifier buffer sizes */
640 #ifndef BUFSIZ
641 # define BUFSIZ                 4096
642 #endif
643 #define KBUFSZ                  512     /* size of keyboard mapping buffer */
644
645 /*
646  *****************************************************************************
647  * MACRO DEFINES
648  *****************************************************************************
649  */
650 #define MEMSET(x, y, z)         memset((x), (y), (size_t)(z))
651 #define MEMCPY(x, y, z)         memcpy((void *)(x), (const void *)(y), (z))
652 #define MEMMOVE(x, y, z)        memmove((void *)(x), (const void *)(y), (z))
653 #define STRCASECMP(x, y)        strcasecmp((x), (y))
654 #define STRNCASECMP(x, y, z)    strncasecmp((x), (y), (z))
655 #define STRCPY(x, y)            strcpy((char *)(x), (const char *)(y))
656 #define STRNCPY(x, y, z)        strncpy((char *)(x), (const char *)(y), (z))
657 #define STRCMP(x, y)            strcmp((const char *)(x), (const char *)(y))
658 #define STRNCMP(x, y, z)        strncmp((const char *)(x), (const char *)(y), (z))
659 #define STRCAT(x, y)            strcat((char *)(x), (const char *)(y))
660 #define STRNCAT(x, y, z)        strncat((char *)(x), (const char *)(y), (z))
661 #define STRDUP(x)               strdup((const char *)(x))
662 #define STRLEN(x)               strlen((const char *)(x))
663 #define STRCHR(x, y)            strchr((const char *)(x), (int)(y))
664 #define STRRCHR(x, y)           strrchr((const char *)(x), (int)(y))
665
666 /* convert pixel dimensions to row/column values.  Everything as int32_t */
667 #define Pixel2Col(x)            Pixel2Width((int32_t)(x) - (int32_t)TermWin.int_bwidth)
668 #define Pixel2Row(y)            Pixel2Height((int32_t)(y) - (int32_t)TermWin.int_bwidth)
669 #define Pixel2Width(x)          ((int32_t)(x) / (int32_t)TermWin.fwidth)
670 #define Pixel2Height(y)         ((int32_t)(y) / (int32_t)TermWin.fheight)
671 #define Col2Pixel(col)          ((int32_t)Width2Pixel(col) + (int32_t)TermWin.int_bwidth)
672 #define Row2Pixel(row)          ((int32_t)Height2Pixel(row) + (int32_t)TermWin.int_bwidth)
673 #define Width2Pixel(n)          ((int32_t)(n) * (int32_t)TermWin.fwidth)
674 #define Height2Pixel(n)         ((int32_t)(n) * (int32_t)TermWin.fheight)
675
676 #define TermWin_TotalWidth()    ((int32_t)TermWin.width  + 2 * (int32_t)TermWin.int_bwidth)
677 #define TermWin_TotalHeight()   ((int32_t)TermWin.height + 2 * (int32_t)TermWin.int_bwidth)
678
679 #define Xscreen                 DefaultScreen(R->Xdisplay)
680 #define Xroot                   DefaultRootWindow(R->Xdisplay)
681
682 /* how to build & extract colors and attributes */
683 #define GET_BASEFG(x)           (((x) & RS_fgMask))
684 #define GET_BASEBG(x)           (((x) & RS_bgMask)>>Color_Bits)
685 #ifndef NO_BRIGHTCOLOR
686 # define GET_FGCOLOR(x)                                         \
687     ((((x) & RS_Bold) == 0                                      \
688       || GET_BASEFG(x) < minCOLOR                               \
689       || GET_BASEFG(x) >= minBrightCOLOR)                       \
690      ? GET_BASEFG(x)                                            \
691      : (GET_BASEFG(x) + (minBrightCOLOR - minCOLOR)))
692 # define GET_BGCOLOR(x)                                         \
693     ((((x) & RS_Blink) == 0                                     \
694       || GET_BASEBG(x) < minCOLOR                               \
695       || GET_BASEBG(x) >= minBrightCOLOR)                       \
696      ? GET_BASEBG(x)                                            \
697      : (GET_BASEBG(x) + (minBrightCOLOR - minCOLOR)))
698 #else
699 # define GET_FGCOLOR(x)         GET_BASEFG(x)
700 # define GET_BGCOLOR(x)         GET_BASEBG(x)
701 #endif
702
703 #define GET_FONT(x)             (((x) & RS_fontMask) >> RS_fontShift)
704 #define SET_FONT(x,fid)         ((x) & ~RS_fontMask) | ((fid) << RS_fontShift)
705
706 #define GET_ATTR(x)             (((x) & RS_attrMask))
707 #define GET_BGATTR(x)                                                   \
708     (((x) & RS_RVid) ? (((x) & (RS_attrMask & ~RS_RVid))                \
709                         | (((x) & RS_fgMask)<<Color_Bits))              \
710                      : ((x) & (RS_attrMask | RS_bgMask)))
711 #define SET_FGCOLOR(x,fg)       (((x) & ~RS_fgMask)  | (fg))
712 #define SET_BGCOLOR(x,bg)       (((x) & ~RS_bgMask)  | ((bg)<<Color_Bits))
713 #define SET_ATTR(x,a)           (((x) & ~RS_attrMask)| (a))
714
715 #define SET_PIXCOLOR(h, x)      ((h)->pixcolor_set[(x) / NPIXCLR_BITS] |= (1 << ((x) % NPIXCLR_BITS)))
716 #define ISSET_PIXCOLOR(h, x)    ((h)->pixcolor_set[(x) / NPIXCLR_BITS] & (1 << ((x) % NPIXCLR_BITS)))
717
718 #ifdef HAVE_SCROLLBARS
719 # define scrollbar_TotalWidth() (scrollBar.width + sb_shadow * 2)
720 #else
721 # define scrollbar_TotalWidth() (0)
722 #endif
723 #define scrollbar_isMotion()    (R->scrollBar.state == 'm')
724 #define scrollbar_isUp()        (R->scrollBar.state == 'U')
725 #define scrollbar_isDn()        (R->scrollBar.state == 'D')
726 #define scrollbar_isUpDn()      isupper (R->scrollBar.state)
727 #define isScrollbarWindow(w)    (R->scrollBar.state && (w) == R->scrollBar.win)
728
729 #define scrollbarnext_dnval()   (R->scrollBar.end + (R->scrollBar.width + 1))
730 #define scrollbarnext_upButton(y)       ((y) > R->scrollBar.end \
731                                          && (y) <= scrollbarnext_dnval())
732 #define scrollbarnext_dnButton(y)       ((y) > scrollbarnext_dnval())
733 #define SCROLLNEXT_MINHEIGHT    SB_THUMB_MIN_HEIGHT
734 #define scrollbarrxvt_upButton(y)       ((y) < R->scrollBar.beg)
735 #define scrollbarrxvt_dnButton(y)       ((y) > R->scrollBar.end)
736 #define SCROLLRXVT_MINHEIGHT    10
737 #define SCROLLXTERM_MINHEIGHT   10
738
739 #define scrollbar_minheight()   (R->scrollBar.style == R_SB_NEXT        \
740                                  ? SCROLLNEXT_MINHEIGHT                 \
741                                  : SCROLLRXVT_MINHEIGHT)
742 #define scrollbar_above_slider(y)       ((y) < R->scrollBar.top)
743 #define scrollbar_below_slider(y)       ((y) > R->scrollBar.bot)
744 #define scrollbar_position(y)           ((y) - R->scrollBar.beg)
745 #define scrollbar_size()                (R->scrollBar.end - R->scrollBar.beg \
746                                          - scrollbar_minheight())
747
748 #if (MENUBAR_MAX > 1)
749 /* rendition style flags */
750 # define menuBar_height()       (TermWin.fheight + SHADOW)
751 # define menuBar_TotalHeight()  (menuBar_height() + SHADOW + menuBar_margin)
752 # define isMenuBarWindow(w)     ((w) == R->menuBar.win)
753 #else
754 # define menuBar_height()       (0)
755 # define menuBar_TotalHeight()  (0)
756 # define isMenuBarWindow(w)     (0)
757 #endif
758
759 #ifdef XPM_BACKGROUND
760 # define XPMClearArea(a, b, c, d, e, f, g)      XClearArea((a), (b), (c), (d), (e), (f), (g))
761 #else
762 # define XPMClearArea(a, b, c, d, e, f, g)
763 #endif
764
765 #ifndef STRICT_FONT_CHECKING
766 # define rxvt_get_fontwidest(font)      ((font)->max_bounds.width)
767 #endif
768
769 #define rxvt_Gr_ButtonPress(x,y)        rxvt_Gr_ButtonReport (R, 'P',(x),(y))
770 #define rxvt_Gr_ButtonRelease(x,y)      rxvt_Gr_ButtonReport (R, 'R',(x),(y))
771
772 #ifdef UTMP_SUPPORT
773 # if !defined(RXVT_UTMPX_FILE) || !defined(HAVE_STRUCT_UTMPX)
774 #  undef HAVE_UTMPX_H
775 #  undef HAVE_STRUCT_UTMPX
776 # endif
777 # if !defined(RXVT_UTMP_FILE) || !defined(HAVE_STRUCT_UTMP)
778 #  undef HAVE_UTMP_H
779 #  undef HAVE_STRUCT_UTMP
780 # endif
781
782 # ifdef HAVE_UTMPX_H
783 #  include <utmpx.h>
784 # endif
785 # ifdef HAVE_UTMP_H
786 #  include <utmp.h>
787 # endif
788 #endif
789
790 #ifdef DEBUG_CMD
791 # define D_CMD(x)               fprintf x ; fputc('\n', stderr)
792 #else
793 # define D_CMD(x)
794 #endif
795 #ifdef DEBUG_INIT
796 # define D_INIT(x)              fprintf x ; fputc('\n', stderr)
797 #else
798 # define D_INIT(x)
799 #endif
800 #ifdef DEBUG_MAIN
801 # define D_MAIN(x)              fprintf x ; fputc('\n', stderr)
802 #else
803 # define D_MAIN(x)
804 #endif
805 #ifdef DEBUG_SCREEN
806 # define D_SCREEN(x)            fprintf x ; fputc('\n', stderr)
807 #else
808 # define D_SCREEN(x)
809 #endif
810 #ifdef DEBUG_SELECT
811 # define D_SELECT(x)            fprintf x ; fputc('\n', stderr)
812 #else
813 # define D_SELECT(x)
814 #endif
815 #ifdef DEBUG_SIZE
816 # define D_SIZE(x)              fprintf x ; fputc('\n', stderr)
817 #else
818 # define D_SIZE(x)
819 #endif
820 #ifdef DEBUG_X
821 # define D_X(x)                 fprintf x ; fputc('\n', stderr)
822 #else
823 # define D_X(x)
824 #endif
825
826 /*
827  *****************************************************************************
828  * VARIABLES
829  *****************************************************************************
830  */
831 #ifdef MENUBAR
832 # include "menubar.h"
833 #endif
834
835 #define BLINK_INTERVAL 0.5
836
837 struct mbstate {
838   mbstate_t mbs;
839
840   mbstate ()
841   {
842     MEMSET (&mbs, 0, sizeof (mbs));
843   }
844 };
845
846 struct rxvt_term : rxvt_vars {
847   struct          mbstate mbstate;
848
849   unsigned char   want_refresh:1,
850 #ifdef TRANSPARENT
851                   want_full_refresh:1,  /* awaiting full screen refresh      */
852 #endif
853 #if defined(XPM_BACKGROUND) || defined(TRANSPARENT)
854                   am_transparent:1,     /* is a transparent term             */
855                   am_pixmap_trans:1,    /* transparency w/known root pixmap  */
856 #endif
857                   current_screen:1,     /* primary or secondary              */
858                   hate_those_clicks:1,  /* a.k.a. keep mark position         */
859                   num_scr_allow:1,
860                   bypass_keystate:1,
861 #ifdef CURSOR_BLINK
862                   hidden_cursor:1,
863 #endif
864 #ifdef POINTER_BLANK
865                   hidden_pointer:1,
866 #endif
867                   parsed_geometry:1,
868                   seen_input:1,         /* wether any input has been seen so far */
869                   enc_utf8:1;           /* wether terminal reads/writes utf-8 */
870
871   unsigned char   refresh_type,
872 #ifdef UTMP_SUPPORT
873                   next_utmp_action,
874 #endif
875 #ifndef NO_SETOWNER_TTYDEV
876                   next_tty_action,
877 #endif
878 #ifdef META8_OPTION
879                   meta_char,  /* Alt-key prefix                            */
880 #endif
881                   scrollbar_align,
882                   selection_wait,
883                   selection_type;
884 /* ---------- */
885 #ifdef GREEK_SUPPORT
886   short           greek_mode;         /* greek keyboard mode               */
887 #endif
888   short           rvideo;
889   int16_t         num_scr;    /* screen: number lines scrolled             */
890   uint16_t        prev_ncol,   /* screen: previous number of columns        */
891                   prev_nrow;  /* screen: previous number of rows           */
892 #ifdef RXVT_GRAPHICS
893   uint16_t        gr_prev_start;
894 #endif
895 /* ---------- */
896   rend_t          rstyle;
897 /* ---------- */
898   uint32_t        pixcolor_set[NPIXCLR_SETS];
899 /* ---------- */
900 #ifdef SELECTION_SCROLLING
901   int             scroll_selection_delay,
902                   scroll_selection_lines;
903   enum page_dirn  scroll_selection_dir;
904   int             selection_save_x,
905                   selection_save_y,
906                   selection_save_state,
907                   pending_scroll_selection;
908 #endif
909 /* ---------- */
910   int             csrO,       /* Hops - csr offset in thumb/slider to      */
911                               /*   give proper Scroll behaviour            */
912 #ifndef NO_SCROLLBAR_BUTTON_CONTINUAL_SCROLLING
913                   scroll_arrow_delay,
914 #endif
915 #if defined(MOUSE_WHEEL) && defined(MOUSE_SLIP_WHEELING)
916                   mouse_slip_wheel_delay,
917                   mouse_slip_wheel_speed,
918 #endif
919                   refresh_count,
920                   refresh_limit,
921                   fnum,       /* logical font number                       */
922                   last_bot,   /* scrollbar last bottom position            */
923                   last_top,   /* scrollbar last top position               */
924                   last_state, /* scrollbar last state                      */
925                   scrollbar_len,
926                   currmaxcol,
927 #ifdef MENUBAR
928                   menu_readonly,      /* okay to alter menu? */
929                   Arrows_x,
930 #endif
931 #if MENUBAR_MAX > 1
932                   Nbars,
933 #endif
934                   window_vt_x,
935                   window_vt_y,
936                   window_sb_x,
937 # ifdef POINTER_BLANK
938                   pointerBlankDelay,
939 # endif
940                   allowedxerror;
941 /* ---------- */
942   unsigned int    ModMetaMask,
943                   ModNumLockMask,
944                   old_width,  /* last used width in screen resize          */
945                   old_height, /* last used height in screen resize         */
946 #ifndef NO_BRIGHTCOLOR
947                   colorfgbg,
948 #endif
949                   ttymode;
950   unsigned long   PrivateModes,
951                   SavedModes;
952 /* ---------- */
953 #ifdef PREFER_24BIT
954   Visual         *Xvisual;
955 #endif
956 /* ---------- */
957   Atom            xa[NUM_XA];
958 /* ---------- */
959 #ifdef MENUBAR
960   GC              menubarGC;
961 #endif
962 #if defined(MENUBAR) || defined(RXVT_SCROLLBAR)
963   GC              scrollbarGC,
964                   topShadowGC,
965                   botShadowGC;
966 #endif
967 #ifdef XTERM_SCROLLBAR
968   GC              xscrollbarGC,
969                   ShadowGC;
970 #endif
971 #ifdef NEXT_SCROLLBAR
972   GC              blackGC,
973                   whiteGC,
974                   grayGC,
975                   darkGC,
976                   stippleGC;
977   Pixmap          dimple,
978                   upArrow,
979                   downArrow,
980                   upArrowHi,
981                   downArrowHi;
982 #endif
983 /* ---------- */
984   Time            selection_time,
985                   selection_request_time;
986   pid_t           cmd_pid;    /* process id of child */
987   gid_t           ttygid;
988 #if (defined(HAVE_SETEUID) || defined(HAVE_SETREUID)) && !defined(__CYGWIN32__)
989   uid_t           euid;
990   gid_t           egid;
991 #endif
992 /* ---------- */
993   Cursor          leftptr_cursor;
994 #ifdef POINTER_BLANK
995   Cursor          blank_cursor;
996 #endif
997 /* ---------- */
998   const char     *ttydev;     /* pty/tty name */
999 #ifndef NO_BACKSPACE_KEY
1000   const char     *key_backspace;
1001 #endif
1002 #ifndef NO_DELETE_KEY
1003   const char     *key_delete;
1004 #endif
1005 #if defined (HOTKEY_CTRL) || defined (HOTKEY_META)
1006   KeySym          ks_bigfont, ks_smallfont;
1007 #endif
1008 #ifdef GREEK_SUPPORT
1009   KeySym          ks_greekmodeswith;
1010 #endif
1011 #ifdef USE_XIM
1012   XIC             Input_Context;
1013   XIMStyle        input_style;
1014   int             event_type;
1015 #endif
1016   struct mouse_event MEvent;
1017   XComposeStatus  compose;
1018 #ifdef RXVT_GRAPHICS
1019   int             graphics_up;
1020   struct grwin_t *gr_root;
1021 #endif
1022   ttymode_t       tio;
1023 #ifdef UTMP_SUPPORT
1024 # ifdef HAVE_STRUCT_UTMP
1025   struct utmp     ut;
1026 # endif
1027 # ifdef HAVE_STRUCT_UTMPX
1028   struct utmpx    utx;
1029 # endif
1030 # if (defined(HAVE_STRUCT_UTMP) && defined(HAVE_UTMP_PID)) || defined(HAVE_STRUCT_UTMPX)
1031   char            ut_id[5];
1032 # endif
1033   int             utmp_pos;
1034 #endif
1035   row_col_t       oldcursor;
1036 #ifdef XPM_BACKGROUND
1037   bgPixmap_t      bgPixmap;
1038   XpmAttributes   xpmAttr;    /* originally loaded pixmap and its scaling */
1039 #endif
1040 #ifdef MULTICHAR_SET
1041   int             oldcursormulti;
1042   void            (*multichar_decode)(unsigned char *str, int len);
1043 #endif
1044 #ifndef RESET_TTY_TO_COMMON_DEFAULTS
1045   struct stat     ttyfd_stat; /* original status of our tty */
1046 #endif
1047 #ifdef MENUBAR
1048   menu_t         *ActiveMenu,         /* currently active menu */
1049                  *BuildMenu;          /* the menu currently being built */
1050   bar_t          *CurrentBar;
1051 # if !(MENUBAR_MAX > 1)
1052   bar_t           BarList;
1053 # endif                         /* (MENUBAR_MAX > 1) */
1054 #endif
1055 #ifdef RXVT_GRAPHICS
1056   Window          gr_last_id;
1057 #endif
1058 #ifdef CURSOR_BLINK
1059   struct timeval  lastcursorchange;
1060 #endif
1061 #ifdef POINTER_BLANK
1062   struct timeval  lastmotion;
1063 #endif
1064
1065 /* these three don't need to be kept but do so to placate some mem checkers */
1066   char           *env_windowid;       /* environmental variable WINDOWID */
1067   char           *env_display;        /* environmental variable DISPLAY  */
1068   char           *env_term;           /* environmental variable TERM     */
1069   char           *env_colorfgbg;
1070   char           *buffer;
1071   char           *locale;
1072   char           *codeset;
1073   char            charsets[4];
1074   unsigned char  *v_buffer;   /* pointer to physical buffer */
1075   unsigned int    v_buflen;   /* size of area to write */
1076   char           *newfont[MAX_NFONTS];
1077 #ifdef KEYSYM_RESOURCE
1078   const unsigned char *Keysym_map[256];
1079 #endif
1080   const char     *rs[NUM_RESOURCES];
1081 /* command input buffering */
1082   unsigned char  *cmdbuf_ptr, *cmdbuf_endp;
1083   unsigned char   cmdbuf_base[BUFSIZ];
1084
1085   rxvt_salloc *ralloc;
1086   rxvt_salloc *talloc;
1087
1088   void paste (const unsigned char *data, unsigned int len);
1089
1090   void flush ();
1091
1092   void check_cb   (check_watcher &w); check_watcher check_ev;
1093   void destroy_cb (time_watcher &w); time_watcher destroy_ev;
1094
1095   void pty_cb (io_watcher &w, short revents); io_watcher pty_ev;
1096   void x_cb   (io_watcher &w, short revents); io_watcher x_ev;
1097
1098   void incr_cb (time_watcher &w); time_watcher incr_ev;
1099
1100 #ifdef CURSOR_BLINK
1101   void blink_cb (time_watcher &w); time_watcher blink_ev;
1102 #endif
1103
1104 #ifdef POINTER_BLANK
1105   void pointer_cb (time_watcher &w); time_watcher pointer_ev;
1106   void pointer_blank ();
1107   void pointer_unblank ();
1108 #endif
1109
1110   void tt_printf (const char *fmt,...);
1111   void tt_write (const unsigned char *data, unsigned int len);
1112
1113   void tt_winch ();
1114
1115   rxvt_term ();
1116   ~rxvt_term ();
1117   void destroy ();
1118
1119   bool init (int argc, const char *const *argv);
1120   bool init_vars ();
1121
1122   uint32_t next_char ();
1123
1124   bool pty_fill ();
1125   void process_x_events ();
1126
1127   void *operator new (size_t s);
1128   void operator delete (void *p, size_t s);
1129
1130   void init_secondary ();
1131   const char **init_resources (int argc, const char *const *argv);
1132   void init_env ();
1133   void set_locale (const char *locale);
1134   void init_xlocale ();
1135   void init_command (const char *const *argv);
1136   int run_command (const char *const *argv);
1137   int run_child (const char *const *argv);
1138
1139   void color_aliases(int idx);
1140   void recolour_cursor ();
1141   void create_windows (int argc, const char *const *argv);
1142   void resize_all_windows (unsigned int width, unsigned int height, int ignoreparent);
1143   void window_calc (unsigned int width, unsigned int height);
1144   void set_preedit_area (XRectangle * preedit_rect, XRectangle * status_rect, XRectangle * needed_rect);
1145
1146 #if USE_XIM
1147   void set_size (XRectangle *size);
1148   void set_position (XPoint *pos);
1149   void set_color (unsigned long *fg, unsigned long *bg);
1150 #endif
1151
1152   void resize_scrollbar ();
1153
1154   void pixel_position (int *x, int *y);
1155
1156   void selection_click (int clicks, int x, int y);
1157   void selection_extend (int x, int y, int flag);
1158   void selection_rotate (int x, int y);
1159
1160   /* screen(!) */
1161   void scr_blank_line (text_t *et, rend_t *er, unsigned int width, rend_t efs);
1162   void scr_blank_screen_mem (text_t **tp, rend_t **rp, unsigned int row, rend_t efs);
1163   int scr_scroll_text (int row1, int row2, int count, int spec);
1164   void scr_reset ();
1165   void scr_reset_realloc ();
1166   void scr_release ();
1167   void scr_clear ();
1168   void scr_refresh (unsigned char refresh_type);
1169   void scr_erase_screen (int mode);
1170   void scr_touch (bool refresh);
1171   void scr_expose (int x, int y, int width, int height, bool refresh);
1172 };
1173
1174 #define SET_LOCALE(locale) rxvt_set_locale (locale)
1175 extern void rxvt_set_locale (const char *locale);
1176
1177 #ifndef __attribute__
1178 # ifdef __GNUC__
1179 #  if (__GNUC__ == 2 && __GNUC_MINOR__ < 5) || (__GNUC__ < 2)
1180 #   define __attribute__(x)
1181 #  endif
1182 # endif
1183 # define __attribute__(x)
1184 #endif
1185
1186 /*
1187  *****************************************************************************
1188  * PROTOTYPES
1189  *****************************************************************************
1190  */
1191 #ifdef PROTOTYPES
1192 # define __PROTO(p)     p
1193 #else
1194 # define __PROTO(p)     ()
1195 #endif
1196 #include "protos.h"
1197
1198 #ifdef DEBUG_malloc
1199 # include "dmalloc.h"           /* This comes last */
1200 #endif
1201
1202 #endif                          /* _RXVT_H_ */
1203