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