1 #ifndef RXVT_H_ /* include once only */
8 #if defined (ISO_14755) || defined (ENABLE_PERL)
9 # define ENABLE_OVERLAY 1
13 # define ENABLE_FRILLS 1
14 # define ENABLE_COMBINING 1
18 # define ENABLE_XEMBED 1
19 # define ENABLE_EWMH 1
20 # define ENABLE_XIM_ONTHESPOT 1
21 # define CURSOR_BLINK 1
24 # define ENABLE_MINIMAL 1
29 #include <X11/cursorfont.h>
30 #include <X11/keysym.h>
31 #include <X11/keysymdef.h>
32 #include <X11/Xatom.h>
40 #include "rxvttoolkit.h"
43 #include "libptytty.h"
47 // try to avoid some macros to decrease code size, on some systems
49 # define strcmp(a,b) (strcmp)(a,b)
50 # define strlen(a) (strlen)(a)
51 # define strcpy(a,b) (strcpy)(a,b)
52 # define memset(a,c,l) (memset)(a,c,l)
53 # define memcpy(a,b,l) (memcpy)(a,b,l)
57 *****************************************************************************
59 *****************************************************************************
61 /* Consistent defines - please report on the necessity
62 * @ Unixware: defines (__svr4__)
64 #if defined (SVR4) && !defined (__svr4__)
67 #if defined (sun) && !defined (__sun__)
72 typedef char *XPointer;
76 typedef struct termios ttymode_t;
78 #ifdef HAVE_AFTERIMAGE
79 # include <afterimage.h>
85 # define STDIN_FILENO 0
86 # define STDOUT_FILENO 1
87 # define STDERR_FILENO 2
90 /****************************************************************************/
92 // exception thrown on fatal (per-instance) errors
93 class rxvt_failure_exception { };
95 // exception thrown when the command parser runs out of input data
96 class out_of_input { };
99 *****************************************************************************
101 *****************************************************************************
104 RETSIGTYPE rxvt_Child_signal (int sig) NOTHROW;
105 RETSIGTYPE rxvt_Exit_signal (int sig) NOTHROW;
106 void rxvt_clean_exit () NOTHROW;
107 void * rxvt_malloc (size_t size);
108 void * rxvt_calloc (size_t number, size_t size);
109 void * rxvt_realloc (void *ptr, size_t size);
112 char * rxvt_wcstombs (const wchar_t *str, int len = -1);
113 wchar_t * rxvt_mbstowcs (const char *str, int len = -1);
114 char * rxvt_wcstoutf8 (const wchar_t *str, int len = -1);
115 wchar_t * rxvt_utf8towcs (const char *str, int len = -1);
117 #define rxvt_strdup(s) ((s) ? strdup(s) : 0)
119 char * rxvt_r_basename (const char *str) NOTHROW;
120 void rxvt_vlog (const char *fmt, va_list arg_ptr) NOTHROW;
121 void rxvt_log (const char *fmt,...) NOTHROW;
122 void rxvt_warn (const char *fmt,...) NOTHROW;
123 void rxvt_fatal (const char *fmt, ...) THROW ((class rxvt_failure_exception)) NORETURN;
124 void rxvt_exit_failure () THROW ((class rxvt_failure_exception)) NORETURN;
126 int rxvt_Str_match (const char *s1, const char *s2) NOTHROW;
127 const char * rxvt_Str_skip_space (const char *str) NOTHROW;
128 char * rxvt_Str_trim (char *str) NOTHROW;
129 int rxvt_Str_escaped (char *str) NOTHROW;
130 char ** rxvt_splitcommastring (const char *cs) NOTHROW;
131 void rxvt_freecommastring (char **cs) NOTHROW;
133 /////////////////////////////////////////////////////////////////////////////
135 // temporarily replace the process environment
136 extern char **environ;
137 extern char **rxvt_environ; // the original environ pointer
139 inline void set_environ (stringvec *envv)
146 environ = (char **)envv->begin ();
149 inline void set_environ (char **envv)
160 *****************************************************************************
161 * STRUCTURES AND TYPEDEFS
162 *****************************************************************************
166 /* If we're using either the rxvt scrollbar, keep the
167 * scrollColor resource.
169 #if defined(RXVT_SCROLLBAR) || defined(NEXT_SCROLLBAR) || defined(PLAIN_SCROLLBAR)
170 # define KEEP_SCROLLCOLOR 1
172 # undef KEEP_SCROLLCOLOR
175 #if defined(XPM_BACKGROUND) || defined(ENABLE_TRANSPARENCY)
176 # define HAVE_BG_PIXMAP 1/* to simplify further usage */
180 geometrySet = (1UL<<0),
181 propScale = (1UL<<1),
182 geometryFlags = (geometrySet|propScale),
185 tintNeeded = (1UL<<9),
186 tintServerSide = (1UL<<10),
187 tintFlags = (tintSet|tintServerSide|tintNeeded),
188 blurNeeded = (1UL<<11),
190 isTransparent = (1UL<<16),
191 isInvalid = (1UL<<17)
196 # ifdef XPM_BACKGROUND
197 # ifdef HAVE_AFTERIMAGE
198 ASImage *original_asim;
199 bool render_asim (ASImage *background, ARGB32 background_tint);
202 enum { defaultScale = 100, defaultAlign = 50 };
204 unsigned int h_scale, v_scale;/* percents of the window size */
205 int h_align, v_align; /* percents of the window size:
206 0 - left align, 50 - center, 100 - right */
207 void unset_geometry () { flags = flags & ~geometryFlags; };
208 bool set_geometry (const char *geom);
209 void set_defaultGeometry ()
211 h_scale = v_scale = defaultScale;
212 h_align = v_align = defaultAlign;
213 flags |= geometrySet;
216 bool set_file (const char *file);
217 # endif /* XPM_BACKGROUND */
220 bool set_target (rxvt_term *new_target);
222 # ifdef ENABLE_TRANSPARENCY
223 int root_depth; /* obtained when target is set */
224 Pixmap root_pixmap; /* current root pixmap set */
227 int h_blurRadius, v_blurRadius;
229 bool set_transparent ();
230 bool set_blur_radius (const char *geom);
231 bool set_tint (rxvt_color &new_tint);
233 bool set_shade (const char *shade_str);
234 bool set_root_pixmap ();
237 transpPmapTiled = (1UL<<0),
238 transpPmapTinted = tintNeeded,
239 transpPmapBlured = blurNeeded,
240 transpTransformations = (tintNeeded|blurNeeded)
242 unsigned long make_transparency_pixmap ();/* returns combination of the above flags */
246 unsigned int pmap_width, pmap_height;
247 unsigned int pmap_depth;
249 bool window_size_sensitive ();
252 void invalidate () { flags |= isInvalid; };
255 # undef HAVE_BG_PIXMAP
259 * the 'essential' information for reporting Mouse Events
260 * pared down from XButtonEvent
264 Time time; /* milliseconds */
265 unsigned int state; /* key or button mask */
266 unsigned int button; /* detail */
270 typedef struct _mwmhints {
281 # define XEMBED_EMBEDDED_NOTIFY 0
282 # define XEMBED_WINDOW_ACTIVATE 1
283 # define XEMBED_WINDOW_DEACTIVATE 2
284 # define XEMBED_REQUEST_FOCUS 3
285 # define XEMBED_FOCUS_IN 4
286 # define XEMBED_FOCUS_OUT 5
287 # define XEMBED_FOCUS_NEXT 6
288 # define XEMBED_FOCUS_PREV 7
290 # define XEMBED_MODALITY_ON 10
291 # define XEMBED_MODALITY_OFF 11
292 # define XEMBED_REGISTER_ACCELERATOR 12
293 # define XEMBED_UNREGISTER_ACCELERATOR 13
294 # define XEMBED_ACTIVATE_ACCELERATOR 14
296 // XEMBED detail code
297 # define XEMBED_FOCUS_CURRENT 0
298 # define XEMBED_FOCUS_FIRST 1
299 # define XEMBED_FOCUS_LAST 2
301 # define XEMBED_MAPPED (1 << 0)
305 *****************************************************************************
307 *****************************************************************************
310 /* COLORTERM, TERM environment variables */
311 #define COLORTERMENV "rxvt"
312 #ifdef XPM_BACKGROUND
313 # define COLORTERMENVFULL COLORTERMENV "-xpm"
315 # define COLORTERMENVFULL COLORTERMENV
318 # define TERMENV "rxvt-unicode"
321 #if defined (NO_MOUSE_REPORT) && !defined (NO_MOUSE_REPORT_SCROLLBAR)
322 # define NO_MOUSE_REPORT_SCROLLBAR 1
325 /* now look for other badly set stuff */
327 #if !defined (EACCESS) && defined(EAGAIN)
328 # define EACCESS EAGAIN
331 #ifndef EXIT_SUCCESS /* missing from <stdlib.h> */
332 # define EXIT_SUCCESS 0 /* exit function success */
333 # define EXIT_FAILURE 1 /* exit function failure */
336 #define scrollBar_esc 30
338 #if defined(RXVT_SCROLLBAR) || defined(NEXT_SCROLLBAR) || defined(XTERM_SCROLLBAR) || defined(PLAIN_SCROLLBAR)
339 # define HAVE_SCROLLBARS 1
342 #define R_SB_ALIGN_CENTRE 0
343 #define R_SB_ALIGN_TOP 1
344 #define R_SB_ALIGN_BOTTOM 2
351 #define SB_WIDTH_NEXT 19
352 #define SB_WIDTH_XTERM 15
353 #define SB_WIDTH_PLAIN 7
354 #ifndef SB_WIDTH_RXVT
355 # define SB_WIDTH_RXVT 10
359 * NeXT scrollbar defines
362 #define SB_BORDER_WIDTH 1
363 #define SB_BEVEL_WIDTH_UPPER_LEFT 1
364 #define SB_BEVEL_WIDTH_LOWER_RIGHT 2
365 #define SB_LEFT_PADDING (SB_PADDING + SB_BORDER_WIDTH)
366 #define SB_MARGIN_SPACE (SB_PADDING * 2)
367 #define SB_BUTTON_WIDTH (SB_WIDTH_NEXT - SB_MARGIN_SPACE - SB_BORDER_WIDTH)
368 #define SB_BUTTON_HEIGHT (SB_BUTTON_WIDTH)
369 #define SB_BUTTON_SINGLE_HEIGHT (SB_BUTTON_HEIGHT + SB_PADDING)
370 #define SB_BUTTON_BOTH_HEIGHT (SB_BUTTON_SINGLE_HEIGHT * 2)
371 #define SB_BUTTON_TOTAL_HEIGHT (SB_BUTTON_BOTH_HEIGHT + SB_PADDING)
372 #define SB_BUTTON_BEVEL_X (SB_LEFT_PADDING)
373 #define SB_BUTTON_FACE_X (SB_BUTTON_BEVEL_X + SB_BEVEL_WIDTH_UPPER_LEFT)
374 #define SB_THUMB_MIN_HEIGHT (SB_BUTTON_WIDTH - (SB_PADDING * 2))
377 * | | <---< SB_PADDING
381 * ,,,,,,,,,,,,,,,,,
384 * | +---------------< SB_BEVEL_WIDTH_UPPER_LEFT
386 * | V :::: vv-------< SB_BEVEL_WIDTH_LOWER_RIGHT
393 * | +---------+ | <.........................
394 * | | <---< SB_PADDING :
395 * | +---------+ | <-+.......... :---< SB_BUTTON_TOTAL_HEIGHT
396 * | | ......%%| | | : :
397 * | | ../\..%%| | |---< SB_BUTTON_HEIGHT :
398 * | | %%%%%%%%| | | : :
399 * | +---------+ | <-+ : :
401 * | +---------+ | <-+ :---< SB_BUTTON_BOTH_HEIGHT
402 * | | ......%%| | | : :
403 * | | ..\/..%%| | | : :
404 * | | %%%%%%%%| | |---< SB_BUTTON_SINGLE_HEIGHT
405 * | +---------+ | | : :
407 * +-------------+ <-+.........:............:
410 * || +---< SB_BUTTON_WIDTH
412 * |+------< SB_PADDING
414 * +----< SB_BORDER_WIDTH
418 * +---< SB_WIDTH_NEXT
422 NO_REFRESH = 0, /* Window not visible at all! */
423 FAST_REFRESH = 1, /* Fully exposed window */
424 SLOW_REFRESH = 2, /* Partially exposed window */
427 #ifdef NO_SECONDARY_SCREEN
433 /* special (internal) prefix for font commands */
438 /* flags for rxvt_scr_gotorc () */
440 C_RELATIVE = 1, /* col movement is relative */
441 R_RELATIVE = 2, /* row movement is relative */
442 RELATIVE = C_RELATIVE | R_RELATIVE,
445 /* modes for rxvt_scr_insdel_chars (), rxvt_scr_insdel_lines () */
447 INSERT = -1, /* don't change these values */
452 /* modes for rxvt_scr_page () - scroll page. used by scrollbar window */
459 /* arguments for rxvt_scr_change_screen () */
467 #define RS_fgMask 0x0000007fUL // 128 colors
468 #define RS_bgMask 0x00003f80UL // 128 colors
471 #define RS_Bold 0x00004000UL // value 1
472 #define RS_Italic 0x00008000UL // value 2
475 #define RS_Blink 0x00010000UL // blink
476 #define RS_RVid 0x00020000UL // reverse video
477 #define RS_Uline 0x00040000UL // underline
479 // toggle this to force redraw, must be != RS_Careful
480 #define RS_redraw 0x01000000UL
482 // 5 custom bits for extensions
483 #define RS_customCount 32
484 #define RS_customMask 0x00f80000UL
485 #define RS_customShift 19
488 #define RS_Careful 0x80000000UL /* be careful when drawing these */
490 #define RS_styleCount 4
491 #define RS_styleMask (RS_Bold | RS_Italic)
492 #define RS_styleShift 14
494 #define RS_baseattrMask (RS_Italic | RS_Bold | RS_Blink | RS_RVid | RS_Uline)
495 #define RS_attrMask (RS_baseattrMask | RS_fontMask)
497 #define RS_fontCount 127 // not 127 or 256, see rxvtfont.h
498 #define RS_fontMask 0xff000000UL // plenty(?) of fonts, includes RS_Careful
499 #define RS_fontShift 24
501 #define DEFAULT_RSTYLE (RS_None | Color_fg | (Color_bg << Color_Bits))
502 #define OVERLAY_RSTYLE (RS_None | Color_Black | (Color_Yellow << Color_Bits))
504 #define Sel_none 0 /* Not waiting */
505 #define Sel_normal 0x01 /* normal selection */
506 #define Sel_incr 0x02 /* incremental selection */
507 #define Sel_direct 0x00
508 #define Sel_Primary 0x01
509 #define Sel_Secondary 0x02
510 #define Sel_Clipboard 0x03
511 #define Sel_whereMask 0x0f
512 #define Sel_CompoundText 0x10 /* last request was COMPOUND_TEXT */
513 #define Sel_UTF8String 0x20 /* last request was UTF8_STRING */
517 C0_SOH, C0_STX, C0_ETX, C0_EOT, C0_ENQ, C0_ACK, C0_BEL,
518 C0_BS , C0_HT , C0_LF , C0_VT , C0_FF , C0_CR , C0_SO , C0_SI ,
519 C0_DLE, C0_DC1, C0_DC2, D0_DC3, C0_DC4, C0_NAK, C0_SYN, C0_ETB,
520 C0_CAN, C0_EM , C0_SUB, C0_ESC, C0_IS4, C0_IS3, C0_IS2, C0_IS1,
522 #define CHAR_ST 0x9c /* 0234 */
525 * XTerm Operating System Commands: ESC ] Ps;Pt (ST|BEL)
526 * colour extensions by Christian W. Zuckschwerdt <zany@triq.net>
532 XTerm_property = 3, // change X property
533 XTerm_Color = 4, // change colors
534 XTerm_Color00 = 10, // not implemented, CLASH!
535 XTerm_Color01 = 11, // not implemented
536 XTerm_Color_cursor = 12, // change actual 'Cursor' color
537 XTerm_Color_pointer_fg = 13, // change actual 'Pointer' fg color
538 XTerm_Color_pointer_bg = 14, // change actual 'Pointer' bg color
539 XTerm_Color05 = 15, // not implemented (tektronix fg)
540 XTerm_Color06 = 16, // not implemented (tektronix bg)
541 XTerm_Color_RV = 17, // change actual 'Highlight' color
542 XTerm_logfile = 46, // not implemented
545 XTerm_konsole30 = 30, // reserved for konsole
546 XTerm_konsole31 = 31, // reserved for konsole
547 XTerm_emacs51 = 51, // reserved for emacs shell
549 * rxvt extensions of XTerm OSCs: ESC ] Ps;Pt (ST|BEL)
550 * at least Rxvt_Color_BD and Rxvt_Color_UL clash with xterm
552 Rxvt_Color_BD = 18, // change actual 'Bold' color
553 Rxvt_Color_UL = 19, // change actual 'Underline' color
554 Rxvt_Pixmap = 20, // new bg pixmap
555 Rxvt_restoreFG = 39, // change default fg color
556 Rxvt_restoreBG = 49, // change default bg color
557 Rxvt_dumpscreen = 55, // dump scrollback and all of screen
559 URxvt_locale = 701, // change locale
560 URxvt_version = 702, // request version
562 URxvt_Color_IT = 704, // change actual 'Italic' colour
563 URxvt_Color_tint = 705, // change actual tint colour
564 URxvt_Color_BD = 706,
565 URxvt_Color_UL = 707,
568 URxvt_boldFont = 711,
569 URxvt_italicFont = 712,
570 URxvt_boldItalicFont = 713,
573 URxvt_view_down = 721,
578 /* Words starting with `Color_' are colours. Others are counts */
580 * The PixColor and rendition colour usage should probably be decoupled
581 * on the unnecessary items, e.g. Color_pointer, but won't bother
582 * until we need to. Also, be aware of usage in pixcolor_set
587 Color_transparent = -1,
591 Color_Black = minCOLOR,
598 maxCOLOR, /* minCOLOR + 7 */
599 #ifndef NO_BRIGHTCOLOR
600 Color_AntiqueWhite = maxCOLOR,
601 minBrightCOLOR, /* maxCOLOR + 1 */
602 Color_Grey25 = minBrightCOLOR,
609 maxBrightCOLOR, /* minBrightCOLOR + 7 */
610 Color_White = maxBrightCOLOR,
612 Color_White = maxCOLOR,
614 minTermCOLOR = Color_White + 1,
615 maxTermCOLOR = Color_White + 72,
616 #ifndef NO_CURSORCOLOR
623 #ifndef NO_BOLD_UNDERLINE_REVERSE
635 #ifdef KEEP_SCROLLCOLOR
639 #if ENABLE_TRANSPARENCY
646 #ifdef KEEP_SCROLLCOLOR
647 Color_topShadow = NRS_COLORS,
651 TOTAL_COLORS = NRS_COLORS
655 #define Color_Bits 7 // 0 .. maxTermCOLOR
661 # define def(name) Rs_ ## name,
662 # define reserve(name,count) Rs_ ## name ## _ = Rs_ ## name + (count) - 1,
669 /* DEC private modes */
670 #define PrivMode_132 (1UL<<0)
671 #define PrivMode_132OK (1UL<<1)
672 #define PrivMode_rVideo (1UL<<2)
673 #define PrivMode_relOrigin (1UL<<3)
674 #define PrivMode_Screen (1UL<<4)
675 #define PrivMode_Autowrap (1UL<<5)
676 #define PrivMode_aplCUR (1UL<<6)
677 #define PrivMode_aplKP (1UL<<7)
678 #define PrivMode_HaveBackSpace (1UL<<8)
679 #define PrivMode_BackSpace (1UL<<9)
680 #define PrivMode_ShiftKeys (1UL<<10)
681 #define PrivMode_VisibleCursor (1UL<<11)
682 #define PrivMode_MouseX10 (1UL<<12)
683 #define PrivMode_MouseX11 (1UL<<13)
684 #define PrivMode_scrollBar (1UL<<14)
685 #define PrivMode_TtyOutputInh (1UL<<15)
686 #define PrivMode_Keypress (1UL<<16)
687 #define PrivMode_smoothScroll (1UL<<17)
688 #define PrivMode_vt52 (1UL<<18)
689 #define PrivMode_LFNL (1UL<<19)
690 /* too annoying to implement X11 highlight tracking */
691 /* #define PrivMode_MouseX11Track (1LU<<20) */
693 #define PrivMode_mouse_report (PrivMode_MouseX10|PrivMode_MouseX11)
694 #define PrivMode(test,bit) \
696 priv_modes |= (bit); \
700 #ifdef ALLOW_132_MODE
701 # define PrivMode_Default (PrivMode_Autowrap|PrivMode_ShiftKeys|PrivMode_VisibleCursor|PrivMode_132OK)
703 # define PrivMode_Default (PrivMode_Autowrap|PrivMode_ShiftKeys|PrivMode_VisibleCursor)
706 // do not change these constants lightly, there are many interdependencies
707 #define IMBUFSIZ 128 // input modifier buffer sizes
708 #define KBUFSZ 512 // size of keyboard mapping buffer
709 #define CBUFSIZ 2048 // size of command buffer
710 #define UBUFSIZ 2048 // character buffer
713 # define PATH_MAX 16384
716 /* Motif window hints */
717 #define MWM_HINTS_FUNCTIONS (1L << 0)
718 #define MWM_HINTS_DECORATIONS (1L << 1)
719 #define MWM_HINTS_INPUT_MODE (1L << 2)
720 #define MWM_HINTS_STATUS (1L << 3)
721 /* bit definitions for MwmHints.functions */
722 #define MWM_FUNC_ALL (1L << 0)
723 #define MWM_FUNC_RESIZE (1L << 1)
724 #define MWM_FUNC_MOVE (1L << 2)
725 #define MWM_FUNC_MINIMIZE (1L << 3)
726 #define MWM_FUNC_MAXIMIZE (1L << 4)
727 #define MWM_FUNC_CLOSE (1L << 5)
728 /* bit definitions for MwmHints.decorations */
729 #define MWM_DECOR_ALL (1L << 0)
730 #define MWM_DECOR_BORDER (1L << 1)
731 #define MWM_DECOR_RESIZEH (1L << 2)
732 #define MWM_DECOR_TITLE (1L << 3)
733 #define MWM_DECOR_MENU (1L << 4)
734 #define MWM_DECOR_MINIMIZE (1L << 5)
735 #define MWM_DECOR_MAXIMIZE (1L << 6)
736 /* bit definitions for MwmHints.inputMode */
737 #define MWM_INPUT_MODELESS 0
738 #define MWM_INPUT_PRIMARY_APPLICATION_MODAL 1
739 #define MWM_INPUT_SYSTEM_MODAL 2
740 #define MWM_INPUT_FULL_APPLICATION_MODAL 3
741 #define PROP_MWM_HINTS_ELEMENTS 5
744 *****************************************************************************
746 *****************************************************************************
748 #define dLocal(type,name) type const name = this->name
750 // for speed reasons, we assume that all codepoints 32 to 126 are
752 #define WCWIDTH(c) (IN_RANGE_INC (c, 0x20, 0x7e) ? 1 : wcwidth (c))
754 /* convert pixel dimensions to row/column values. Everything as int32_t */
755 #define Pixel2Col(x) Pixel2Width((int32_t)(x))
756 #define Pixel2Row(y) Pixel2Height((int32_t)(y))
757 #define Pixel2Width(x) ((int32_t)(x) / (int32_t)fwidth)
758 #define Pixel2Height(y) ((int32_t)(y) / (int32_t)fheight)
759 #define Col2Pixel(col) ((int32_t)Width2Pixel(col))
760 #define Row2Pixel(row) ((int32_t)Height2Pixel(row))
761 #define Width2Pixel(n) ((int32_t)(n) * (int32_t)fwidth)
762 #define Height2Pixel(n) ((int32_t)(n) * (int32_t)fheight)
764 // for m >= -n, ensure remainder lies between 0..n-1
765 #define MOD(m,n) (((m) + (n)) % (n))
767 #define LINENO(n) MOD (term_start + int(n), total_rows)
768 #define ROW(n) row_buf [LINENO (n)]
770 /* how to build & extract colors and attributes */
771 #define GET_BASEFG(x) (((x) & RS_fgMask))
772 #define GET_BASEBG(x) (((x) & RS_bgMask)>>Color_Bits)
774 #define GET_FONT(x) (((x) & RS_fontMask) >> RS_fontShift)
775 #define SET_FONT(x,fid) (((x) & ~RS_fontMask) | ((fid) << RS_fontShift))
777 #define GET_STYLE(x) (((x) & RS_styleMask) >> RS_styleShift)
778 #define SET_STYLE(x,style) (((x) & ~RS_styleMask) | ((style) << RS_styleShift))
780 #define GET_ATTR(x) (((x) & RS_attrMask))
781 #define GET_BGATTR(x) \
782 (((x) & RS_RVid) ? (((x) & (RS_attrMask & ~RS_RVid)) \
783 | (((x) & RS_fgMask)<<Color_Bits)) \
784 : ((x) & (RS_attrMask | RS_bgMask)))
785 #define SET_FGCOLOR(x,fg) (((x) & ~RS_fgMask) | (fg))
786 #define SET_BGCOLOR(x,bg) (((x) & ~RS_bgMask) | ((bg)<<Color_Bits))
787 #define SET_ATTR(x,a) (((x) & ~RS_attrMask) | (a))
789 #define RS_SAME(a,b) (!(((a) ^ (b)) & ~RS_Careful))
791 #define PIXCOLOR_NAME(idx) rs[Rs_color + (idx)]
792 #define ISSET_PIXCOLOR(idx) (!!rs[Rs_color + (idx)])
795 # define FONTSET(style) fontset[GET_STYLE (style)]
797 # define FONTSET(style) fontset[0]
800 #ifdef HAVE_SCROLLBARS
801 # define scrollbar_TotalWidth() (scrollBar.width + sb_shadow * 2)
803 # define scrollbar_TotalWidth() (0)
805 #define scrollbar_isMotion() (scrollBar.state == 'm')
806 #define scrollbar_isUp() (scrollBar.state == 'U')
807 #define scrollbar_isDn() (scrollBar.state == 'D')
808 #define scrollbar_isUpDn() isupper (scrollBar.state)
809 #define isScrollbarWindow(w) (scrollBar.state && (w) == scrollBar.win)
811 #define scrollbarnext_dnval() (scrollBar.end + (scrollBar.width + 1))
812 #define scrollbarnext_upButton(y) ((y) > scrollBar.end \
813 && (y) <= scrollbarnext_dnval ())
814 #define scrollbarnext_dnButton(y) ((y) > scrollbarnext_dnval())
815 #define SCROLLNEXT_MINHEIGHT SB_THUMB_MIN_HEIGHT
816 #define scrollbarrxvt_upButton(y) ((y) < scrollBar.beg)
817 #define scrollbarrxvt_dnButton(y) ((y) > scrollBar.end)
818 #define SCROLLRXVT_MINHEIGHT 10
819 #define SCROLLXTERM_MINHEIGHT 10
821 #define scrollbar_minheight() (scrollBar.style == R_SB_NEXT \
822 ? SCROLLNEXT_MINHEIGHT \
823 : SCROLLRXVT_MINHEIGHT)
824 #define scrollbar_above_slider(y) ((y) < scrollBar.top)
825 #define scrollbar_below_slider(y) ((y) > scrollBar.bot)
826 #define scrollbar_position(y) ((y) - scrollBar.beg)
827 #define scrollbar_size() (scrollBar.end - scrollBar.beg \
828 - scrollbar_minheight ())
830 typedef callback<void (const char *)> log_callback;
831 typedef callback<int (int)> getfd_callback;
833 #define SET_LOCALE(locale) rxvt_set_locale (locale)
834 extern bool rxvt_set_locale (const char *locale) NOTHROW;
835 extern void rxvt_push_locale (const char *locale) NOTHROW;
836 extern void rxvt_pop_locale () NOTHROW;
838 /****************************************************************************/
840 #define LINE_LONGER 0x0001 // line is continued on the next row
841 #define LINE_FILTERED 0x0002 // line has been filtered
842 #define LINE_COMPRESSED 0x0004 // line has been compressed (NYI)
843 #define LINE_FILTER 0x0008 // line needs to be filtered before display (NYI)
844 #define LINE_BIDI 0x0010 // line needs bidi (NYI)
847 text_t *t; // terminal the text
848 rend_t *r; // rendition, uses RS_ flags
849 tlen_t_ l; // length of each text line, LINE_CONT == continued on next line
854 return f & LINE_LONGER;
857 void is_longer (int set)
873 void touch () // call whenever a line is changed/touched/updated
887 /****************************************************************************/
889 // primivite wrapper around mbstate_t to ensure initialisation
893 operator mbstate_t *() { return &mbs; }
894 void reset () { memset (&mbs, 0, sizeof (mbs)); }
895 mbstate () { reset (); }
898 /****************************************************************************/
900 #define UNICODE_MASK 0x1fffffUL
903 # define COMPOSE_LO 0x40000000UL
904 # define COMPOSE_HI 0x400fffffUL
905 # define IS_COMPOSE(n) ((int32_t)(n) >= COMPOSE_LO)
908 # define COMPOSE_LO 0xe000UL // our _own_ functions don't like (illegal) surrogates
909 # define COMPOSE_HI 0xf8ffUL // in utf-8, so use private use area only
911 # define COMPOSE_LO 0xd800UL
912 # define COMPOSE_HI 0xf8ffUL
914 # define IS_COMPOSE(n) IN_RANGE_INC ((n), COMPOSE_LO, COMPOSE_HI)
918 // compose chars are used to represent composite characters
919 // that are not representable in unicode, as well as characters
920 // not fitting in the BMP.
921 struct compose_char {
922 unicode_t c1, c2; // any chars != NOCHAR are valid
923 compose_char (unicode_t c1, unicode_t c2)
928 class rxvt_composite_vec {
929 vector<compose_char> v;
931 text_t compose (unicode_t c1, unicode_t c2 = NOCHAR);
932 int expand (unicode_t c, wchar_t *r);
933 compose_char *operator [](text_t c)
935 return c >= COMPOSE_LO && c < COMPOSE_LO + v.size ()
941 extern class rxvt_composite_vec rxvt_composite;
944 /****************************************************************************/
946 #ifdef KEYSYM_RESOURCE
947 class keyboard_manager;
950 struct rxvt_term : zero_initialized, rxvt_vars, rxvt_screen {
952 // special markers with magic addresses
953 static const char resval_undef []; // options specifically unset
954 static const char resval_on []; // boolean options switched on
955 static const char resval_off []; // or off
957 log_callback *log_hook; // log error messages through this hook, if != 0
958 getfd_callback *getfd_hook; // convert remote to local fd, if != 0
962 struct mbstate mbstate; // current input multibyte state
964 unsigned char want_refresh:1,
965 #ifdef ENABLE_TRANSPARENCY
966 want_full_refresh:1, /* awaiting full screen refresh */
967 am_transparent:1, /* is a transparent term */
968 am_pixmap_trans:1, /* transparency w/known root pixmap */
970 current_screen:1, /* primary or secondary */
982 enc_utf8:1, /* wether locale uses utf-8 */
983 seen_input:1, /* wether we have seen some program output yet */
984 seen_resize:1, /* wether we had a resize event */
987 unsigned char refresh_type,
989 meta_char, /* Alt-key prefix */
995 bool rvideo_state, rvideo_mode;
999 int num_scr; /* screen: number lines scrolled */
1000 int prev_ncol, /* screen: previous number of columns */
1001 prev_nrow; /* screen: previous number of rows */
1005 #ifdef SELECTION_SCROLLING
1006 int scroll_selection_lines;
1007 enum page_dirn scroll_selection_dir;
1008 int selection_save_x,
1010 selection_save_state;
1013 int csrO, /* Hops - csr offset in thumb/slider to */
1014 /* give proper Scroll behaviour */
1015 #if defined(MOUSE_WHEEL) && defined(MOUSE_SLIP_WHEELING)
1016 mouse_slip_wheel_speed,
1019 last_bot, /* scrollbar last bottom position */
1020 last_top, /* scrollbar last top position */
1021 last_state, /* scrollbar last state */
1026 # ifdef POINTER_BLANK
1031 unsigned int ModLevel3Mask,
1034 int old_width, /* last used width in screen resize */
1035 old_height; /* last used height in screen resize */
1036 unsigned long priv_modes,
1041 #ifdef RXVT_SCROLLBAR
1046 #ifdef XTERM_SCROLLBAR
1050 #ifdef PLAIN_SCROLLBAR
1053 #ifdef NEXT_SCROLLBAR
1066 Time selection_time,
1067 selection_request_time;
1068 pid_t cmd_pid; /* process id of child */
1070 size_t incr_buf_size, incr_buf_fill;
1072 Cursor leftptr_cursor;
1074 #ifndef NO_BACKSPACE_KEY
1075 const char *key_backspace;
1077 #ifndef NO_DELETE_KEY
1078 const char *key_delete;
1080 struct mouse_event MEvent;
1081 XComposeStatus compose;
1083 row_col_t oldcursor;
1084 #ifdef HAVE_BG_PIXMAP
1085 bgPixmap_t bgPixmap;
1087 #ifdef HAVE_AFTERIMAGE
1089 ASImageManager *asimman;
1093 int ov_x, ov_y, ov_w, ov_h; // overlay dimensions
1097 void scr_swap_overlay () NOTHROW;
1098 void scr_overlay_new (int x, int y, int w, int h) NOTHROW;
1099 void scr_overlay_off () NOTHROW;
1100 void scr_overlay_set (int x, int y,
1102 rend_t rend = OVERLAY_RSTYLE) NOTHROW;
1103 void scr_overlay_set (int x, int y, const char *s) NOTHROW;
1104 void scr_overlay_set (int x, int y, const wchar_t *s) NOTHROW;
1107 vector<void *> allocated; // free these memory blocks with free()
1109 char env_windowid[21]; /* environmental variable WINDOWID */
1110 char env_colorfgbg[sizeof ("COLORFGBG=default;default;bg") + 1];
1111 char *env_display; /* environmental variable DISPLAY */
1112 char *env_term; /* environmental variable TERM */
1116 char *v_buffer; /* pointer to physical buffer */
1117 unsigned int v_buflen; /* size of area to write */
1118 stringvec *argv, *envv; /* if != 0, will be freed at destroy time */
1120 #ifdef KEYSYM_RESOURCE
1121 keyboard_manager *keyboard;
1124 const char *rs[NUM_RESOURCES];
1125 /* command input buffering */
1126 char *cmdbuf_ptr, *cmdbuf_endp;
1127 char cmdbuf_base[CBUFSIZ];
1131 rxvt_salloc *talloc; // text line allocator
1132 rxvt_salloc *ralloc; // rend line allocator
1134 static vector<rxvt_term *> termlist; // a vector of all running rxvt_term's
1136 #if ENABLE_FRILLS || ISO_14755
1137 // ISO 14755 entry support
1138 unicode_t iso14755buf;
1139 void commit_iso14755 ();
1140 int hex_keyval (XKeyEvent &ev);
1142 void iso14755_51 (unicode_t ch, rend_t r = DEFAULT_RSTYLE, int x = 0, int y = -1);
1143 void iso14755_54 (int x, int y);
1147 // modifies first argument(!)
1148 void paste (char *data, unsigned int len) NOTHROW;
1150 long vt_emask, vt_emask_perl, vt_emask_xim;
1152 void vt_select_input () const NOTHROW
1154 XSelectInput (dpy, vt, vt_emask | vt_emask_perl | vt_emask_xim);
1157 #if ENABLE_TRANSPARENCY || ENABLE_PERL
1158 void rootwin_cb (XEvent &xev);
1159 xevent_watcher rootwin_ev;
1161 #if ENABLE_TRANSPARENCY
1162 int check_our_parents ();
1163 void check_our_parents_cb (time_watcher &w);
1164 time_watcher check_our_parents_ev;
1167 void x_cb (XEvent &xev);
1169 xevent_watcher termwin_ev;
1170 xevent_watcher vt_ev;
1171 #ifdef HAVE_SCROLLBARS
1172 xevent_watcher scrollbar_ev;
1175 void child_cb (child_watcher &w, int status); child_watcher child_ev;
1176 void check_cb (check_watcher &w); check_watcher check_ev;
1177 void destroy_cb (time_watcher &w); time_watcher destroy_ev;
1178 void flush_cb (time_watcher &w); time_watcher flush_ev;
1179 void pty_cb (io_watcher &w, short revents); io_watcher pty_ev;
1180 void incr_cb (time_watcher &w) NOTHROW; time_watcher incr_ev;
1183 void cursor_blink_cb (time_watcher &w); time_watcher cursor_blink_ev;
1186 void text_blink_cb (time_watcher &w); time_watcher text_blink_ev;
1189 void bell_cb (time_watcher &w); time_watcher bell_ev;
1192 #ifndef NO_SCROLLBAR_BUTTON_CONTINUAL_SCROLLING
1193 void cont_scroll_cb (time_watcher &w); time_watcher cont_scroll_ev;
1195 #ifdef SELECTION_SCROLLING
1196 void sel_scroll_cb (time_watcher &w); time_watcher sel_scroll_ev;
1198 #if defined(MOUSE_WHEEL) && defined(MOUSE_SLIP_WHEELING)
1199 void slip_wheel_cb (time_watcher &w); time_watcher slip_wheel_ev;
1202 #ifdef POINTER_BLANK
1203 void pointer_cb (time_watcher &w); time_watcher pointer_ev;
1204 void pointer_blank ();
1206 void pointer_unblank ();
1208 void tt_printf (const char *fmt,...);
1209 void tt_write (const char *data, unsigned int len);
1217 void emergency_cleanup ();
1219 bool init (int argc, const char *const *argv, stringvec *envv);
1221 bool init (stringvec *argv, stringvec *envv)
1224 return init (argv->size (), argv->begin (), envv);
1231 void make_current () const // make this the "currently active" urxvt instance
1235 rxvt_set_locale (locale);
1238 void init_secondary ();
1239 const char **init_resources (int argc, const char *const *argv);
1240 const char *x_resource (const char *name);
1242 void set_locale (const char *locale);
1243 void init_xlocale ();
1244 void init_command (const char *const *argv);
1245 void run_command (const char *const *argv);
1246 int run_child (const char *const *argv);
1248 void color_aliases (int idx);
1249 void recolour_cursor ();
1250 void create_windows (int argc, const char *const *argv);
1251 void resize_all_windows (unsigned int newwidth, unsigned int newheight, int ignoreparent);
1252 void window_calc (unsigned int newwidth, unsigned int newheight);
1255 rxvt_xim *input_method;
1257 XIMStyle input_style;
1258 XPoint spot; // most recently sent spot position
1261 void im_cb (); im_watcher im_ev;
1262 void im_set_size (XRectangle &size);
1263 void im_set_position (XPoint &pos) NOTHROW;
1264 void im_set_color (unsigned long &fg, unsigned long &bg);
1265 void im_set_preedit_area (XRectangle &preedit_rect, XRectangle &status_rect, const XRectangle &needed_rect);
1267 bool IMisRunning ();
1269 bool IM_get_IC (const char *modifiers);
1270 void IMSetPosition ();
1273 void resize_scrollbar ();
1276 void key_press (XKeyEvent &ev);
1277 void key_release (XKeyEvent &ev);
1278 unsigned int cmd_write (const char *str, unsigned int count);
1280 wchar_t next_char () NOTHROW;
1281 wchar_t cmd_getc () THROW ((class out_of_input));
1282 uint32_t next_octet () NOTHROW;
1283 uint32_t cmd_get8 () THROW ((class out_of_input));
1286 void mouse_report (XButtonEvent &ev);
1287 void button_press (XButtonEvent &ev);
1288 void button_release (XButtonEvent &ev);
1291 void update_fade_color (unsigned int idx);
1293 FILE *popen_printer ();
1294 int pclose_printer (FILE *stream);
1296 void process_print_pipe ();
1297 void process_nonprinting (unicode_t ch);
1298 void process_escape_vt52 (unicode_t ch);
1299 void process_escape_seq ();
1300 void process_csi_seq ();
1301 void process_window_ops (const int *args, unsigned int nargs);
1302 char *get_to_st (unicode_t &ends_how);
1303 void process_dcs_seq ();
1304 void process_osc_seq ();
1305 void process_color_seq (int report, int color, const char *str, char resp);
1306 void process_xterm_seq (int op, const char *str, char resp);
1307 int privcases (int mode, unsigned long bit);
1308 void process_terminal_mode (int mode, int priv, unsigned int nargs, const int *arg);
1309 void process_sgr_mode (unsigned int nargs, const int *arg);
1310 void process_graphics ();
1312 void Get_Colours ();
1313 void get_ourmods ();
1316 void set_string_property (Atom prop, const char *str, int len = -1);
1317 void set_utf8_property (Atom prop, const char *str, int len = -1);
1318 void set_title (const char *str);
1319 void set_icon_name (const char *str);
1320 void set_window_color (int idx, const char *color);
1321 void set_colorfgbg ();
1322 bool set_color (rxvt_color &color, const char *name);
1323 void alias_color (int dst, int src);
1324 void set_widthheight (unsigned int newwidth, unsigned int newheight);
1328 void lalloc (line_t &l) const
1330 l.t = (text_t *)talloc->alloc ();
1331 l.r = (rend_t *)ralloc->alloc ();
1335 void lfree (line_t &l)
1342 void lresize (line_t &l) const
1347 l.t = (text_t *)talloc->alloc (l.t, prev_ncol * sizeof (text_t));
1348 l.r = (rend_t *)ralloc->alloc (l.r, prev_ncol * sizeof (rend_t));
1350 l.l = min (l.l, ncol);
1352 if (ncol > prev_ncol)
1353 scr_blank_line (l, prev_ncol, ncol - prev_ncol, DEFAULT_RSTYLE);
1356 int fgcolor_of (rend_t r) const NOTHROW
1358 int base = GET_BASEFG (r);
1359 #ifndef NO_BRIGHTCOLOR
1362 && option (Opt_intensityStyles)
1364 && IN_RANGE_INC (base, minCOLOR, minBrightCOLOR))
1365 base += minBrightCOLOR - minCOLOR;
1370 int bgcolor_of (rend_t r) const NOTHROW
1372 int base = GET_BASEBG (r);
1373 #ifndef NO_BRIGHTCOLOR
1376 && option (Opt_intensityStyles)
1378 && IN_RANGE_INC (base, minCOLOR, minBrightCOLOR))
1379 base += minBrightCOLOR - minCOLOR;
1384 bool option (uint8_t opt) const NOTHROW
1386 return options[opt >> 3] & (1 << (opt & 7));
1389 void set_option (uint8_t opt, bool set = true) NOTHROW
1392 options[opt >> 3] |= (1 << (opt & 7));
1394 options[opt >> 3] &= ~(1 << (opt & 7));
1397 void scr_blank_line (line_t &l, unsigned int col, unsigned int width, rend_t efs) const NOTHROW;
1398 void scr_blank_screen_mem (line_t &l, rend_t efs) const NOTHROW;
1399 int scr_scroll_text (int row1, int row2, int count) NOTHROW;
1401 void scr_release () NOTHROW;
1402 void scr_clear (bool really = false) NOTHROW;
1403 void scr_refresh () NOTHROW;
1404 bool scr_refresh_rend (rend_t mask, rend_t value) NOTHROW;
1405 void scr_erase_screen (int mode) NOTHROW;
1407 void scr_erase_savelines () NOTHROW;
1408 void scr_backindex () NOTHROW;
1409 void scr_forwardindex () NOTHROW;
1411 void scr_touch (bool refresh) NOTHROW;
1412 void scr_expose (int x, int y, int width, int height, bool refresh) NOTHROW;
1413 rxvt_fontset *scr_find_fontset (rend_t r = DEFAULT_RSTYLE);
1414 void scr_recolour () NOTHROW;
1415 void scr_remap_chars () NOTHROW;
1416 void scr_remap_chars (line_t &l) NOTHROW;
1418 enum cursor_mode { SAVE, RESTORE };
1420 void scr_poweron ();
1421 void scr_cursor (cursor_mode mode) NOTHROW;
1422 void scr_do_wrap () NOTHROW;
1423 void scr_swap_screen () NOTHROW;
1424 void scr_change_screen (int scrn);
1425 void scr_color (unsigned int color, int fgbg) NOTHROW;
1426 void scr_rendition (int set, int style) NOTHROW;
1427 void scr_add_lines (const wchar_t *str, int len, int minlines = 0) NOTHROW;
1428 void scr_backspace () NOTHROW;
1429 void scr_tab (int count, bool ht = false) NOTHROW;
1430 void scr_gotorc (int row, int col, int relative) NOTHROW;
1431 void scr_index (enum page_dirn direction) NOTHROW;
1432 void scr_erase_line (int mode) NOTHROW;
1433 void scr_E () NOTHROW;
1434 void scr_insdel_lines (int count, int insdel) NOTHROW;
1435 void scr_insdel_chars (int count, int insdel) NOTHROW;
1436 void scr_scroll_region (int top, int bot) NOTHROW;
1437 void scr_cursor_visible (int mode) NOTHROW;
1438 void scr_autowrap (int mode) NOTHROW;
1439 void scr_relative_origin (int mode) NOTHROW;
1440 void scr_insert_mode (int mode) NOTHROW;
1441 void scr_set_tab (int mode) NOTHROW;
1442 void scr_rvideo_mode (bool on) NOTHROW;
1443 void scr_report_position () NOTHROW;
1444 void set_font_style () NOTHROW;
1445 void scr_charset_choose (int set) NOTHROW;
1446 void scr_charset_set (int set, unsigned int ch) NOTHROW;
1447 void scr_move_to (int y, int len) NOTHROW;
1448 bool scr_page (enum page_dirn direction, int nlines) NOTHROW;
1449 bool scr_changeview (int new_view_start) NOTHROW;
1450 void scr_bell () NOTHROW;
1451 void scr_printscreen (int fullhist) NOTHROW;
1452 void scr_xor_rect (int beg_row, int beg_col, int end_row, int end_col, rend_t rstyle1, rend_t rstyle2) NOTHROW;
1453 void scr_xor_span (int beg_row, int beg_col, int end_row, int end_col, rend_t rstyle) NOTHROW;
1454 void scr_reverse_selection () NOTHROW;
1455 void scr_dump (int fd) NOTHROW;
1457 void selection_check (int check_more) NOTHROW;
1458 void selection_paste (Window win, Atom prop, bool delete_prop) NOTHROW;
1459 void selection_property (Window win, Atom prop) NOTHROW;
1460 void selection_request (Time tm, int selnum = Sel_Primary) NOTHROW;
1461 int selection_request_other (Atom target, int selnum) NOTHROW;
1462 void selection_clear () NOTHROW;
1463 void selection_make (Time tm);
1464 bool selection_grab (Time tm) NOTHROW;
1465 void selection_start_colrow (int col, int row) NOTHROW;
1466 void selection_delimit_word (enum page_dirn dirn, const row_col_t *mark, row_col_t *ret) NOTHROW;
1467 void selection_extend_colrow (int32_t col, int32_t row, int button3, int buttonpress, int clickchange) NOTHROW;
1468 void selection_remove_trailing_spaces () NOTHROW;
1469 void selection_send (const XSelectionRequestEvent &rq) NOTHROW;
1470 void selection_click (int clicks, int x, int y) NOTHROW;
1471 void selection_extend (int x, int y, int flag) NOTHROW;
1472 void selection_rotate (int x, int y) NOTHROW;
1474 void pixel_position (int *x, int *y) NOTHROW;
1476 #if defined(NEXT_SCROLLBAR)
1478 Pixmap renderPixmap (const char *const *data, int width, int height);
1479 void init_scrollbar_stuff ();
1480 void drawBevel (Drawable d, int x1, int y1, int w, int h);
1481 int scrollbar_show_next (int update, int last_top, int last_bot, int scrollbar_len);
1484 #if defined(RXVT_SCROLLBAR)
1486 int scrollbar_show_rxvt (int update, int last_top, int last_bot, int scrollbar_len);
1489 #if defined(XTERM_SCROLLBAR)
1490 // scrollbar-xterm.C
1491 int scrollbar_show_xterm (int update, int last_top, int last_bot, int scrollbar_len);
1494 #if defined(PLAIN_SCROLLBAR)
1495 // scrollbar-plain.C
1496 int scrollbar_show_plain (int update, int last_top, int last_bot, int scrollbar_len);
1500 int scrollbar_mapping (int map);
1501 int scrollbar_show (int update);
1502 void setup_scrollbar (const char *scrollalign, const char *scrollstyle, const char *thickness);
1505 void get_options (int argc, const char *const *argv);
1506 int parse_keysym (const char *str, const char *arg);
1507 void get_xdefaults (FILE *stream, const char *name);
1508 void extract_resources ();
1510 void get_window_origin (int &x, int &y);
1511 Pixmap get_pixmap_property (int prop_id);
1515 *****************************************************************************
1517 *****************************************************************************
1520 # define __PROTO(p) p
1522 # define __PROTO(p) ()
1525 #endif /* _RXVT_H_ */