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