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 */
244 double invalid_since;
247 unsigned int pmap_width, pmap_height;
248 unsigned int pmap_depth;
250 bool window_size_sensitive ();
251 bool need_client_side_rendering ();
255 if (!(flags & isInvalid))
263 # undef HAVE_BG_PIXMAP
267 * the 'essential' information for reporting Mouse Events
268 * pared down from XButtonEvent
272 Time time; /* milliseconds */
273 unsigned int state; /* key or button mask */
274 unsigned int button; /* detail */
278 typedef struct _mwmhints {
289 # define XEMBED_EMBEDDED_NOTIFY 0
290 # define XEMBED_WINDOW_ACTIVATE 1
291 # define XEMBED_WINDOW_DEACTIVATE 2
292 # define XEMBED_REQUEST_FOCUS 3
293 # define XEMBED_FOCUS_IN 4
294 # define XEMBED_FOCUS_OUT 5
295 # define XEMBED_FOCUS_NEXT 6
296 # define XEMBED_FOCUS_PREV 7
298 # define XEMBED_MODALITY_ON 10
299 # define XEMBED_MODALITY_OFF 11
300 # define XEMBED_REGISTER_ACCELERATOR 12
301 # define XEMBED_UNREGISTER_ACCELERATOR 13
302 # define XEMBED_ACTIVATE_ACCELERATOR 14
304 // XEMBED detail code
305 # define XEMBED_FOCUS_CURRENT 0
306 # define XEMBED_FOCUS_FIRST 1
307 # define XEMBED_FOCUS_LAST 2
309 # define XEMBED_MAPPED (1 << 0)
313 *****************************************************************************
315 *****************************************************************************
318 /* COLORTERM, TERM environment variables */
319 #define COLORTERMENV "rxvt"
320 #ifdef XPM_BACKGROUND
321 # define COLORTERMENVFULL COLORTERMENV "-xpm"
323 # define COLORTERMENVFULL COLORTERMENV
326 # define TERMENV "rxvt-unicode"
329 #if defined (NO_MOUSE_REPORT) && !defined (NO_MOUSE_REPORT_SCROLLBAR)
330 # define NO_MOUSE_REPORT_SCROLLBAR 1
333 /* now look for other badly set stuff */
335 #if !defined (EACCESS) && defined(EAGAIN)
336 # define EACCESS EAGAIN
339 #ifndef EXIT_SUCCESS /* missing from <stdlib.h> */
340 # define EXIT_SUCCESS 0 /* exit function success */
341 # define EXIT_FAILURE 1 /* exit function failure */
344 #define scrollBar_esc 30
346 #if defined(RXVT_SCROLLBAR) || defined(NEXT_SCROLLBAR) || defined(XTERM_SCROLLBAR) || defined(PLAIN_SCROLLBAR)
347 # define HAVE_SCROLLBARS 1
350 #define R_SB_ALIGN_CENTRE 0
351 #define R_SB_ALIGN_TOP 1
352 #define R_SB_ALIGN_BOTTOM 2
359 #define SB_WIDTH_NEXT 19
360 #define SB_WIDTH_XTERM 15
361 #define SB_WIDTH_PLAIN 7
362 #ifndef SB_WIDTH_RXVT
363 # define SB_WIDTH_RXVT 10
367 * NeXT scrollbar defines
370 #define SB_BORDER_WIDTH 1
371 #define SB_BEVEL_WIDTH_UPPER_LEFT 1
372 #define SB_BEVEL_WIDTH_LOWER_RIGHT 2
373 #define SB_LEFT_PADDING (SB_PADDING + SB_BORDER_WIDTH)
374 #define SB_MARGIN_SPACE (SB_PADDING * 2)
375 #define SB_BUTTON_WIDTH (SB_WIDTH_NEXT - SB_MARGIN_SPACE - SB_BORDER_WIDTH)
376 #define SB_BUTTON_HEIGHT (SB_BUTTON_WIDTH)
377 #define SB_BUTTON_SINGLE_HEIGHT (SB_BUTTON_HEIGHT + SB_PADDING)
378 #define SB_BUTTON_BOTH_HEIGHT (SB_BUTTON_SINGLE_HEIGHT * 2)
379 #define SB_BUTTON_TOTAL_HEIGHT (SB_BUTTON_BOTH_HEIGHT + SB_PADDING)
380 #define SB_BUTTON_BEVEL_X (SB_LEFT_PADDING)
381 #define SB_BUTTON_FACE_X (SB_BUTTON_BEVEL_X + SB_BEVEL_WIDTH_UPPER_LEFT)
382 #define SB_THUMB_MIN_HEIGHT (SB_BUTTON_WIDTH - (SB_PADDING * 2))
385 * | | <---< SB_PADDING
389 * ,,,,,,,,,,,,,,,,,
392 * | +---------------< SB_BEVEL_WIDTH_UPPER_LEFT
394 * | V :::: vv-------< SB_BEVEL_WIDTH_LOWER_RIGHT
401 * | +---------+ | <.........................
402 * | | <---< SB_PADDING :
403 * | +---------+ | <-+.......... :---< SB_BUTTON_TOTAL_HEIGHT
404 * | | ......%%| | | : :
405 * | | ../\..%%| | |---< SB_BUTTON_HEIGHT :
406 * | | %%%%%%%%| | | : :
407 * | +---------+ | <-+ : :
409 * | +---------+ | <-+ :---< SB_BUTTON_BOTH_HEIGHT
410 * | | ......%%| | | : :
411 * | | ..\/..%%| | | : :
412 * | | %%%%%%%%| | |---< SB_BUTTON_SINGLE_HEIGHT
413 * | +---------+ | | : :
415 * +-------------+ <-+.........:............:
418 * || +---< SB_BUTTON_WIDTH
420 * |+------< SB_PADDING
422 * +----< SB_BORDER_WIDTH
426 * +---< SB_WIDTH_NEXT
430 NO_REFRESH = 0, /* Window not visible at all! */
431 FAST_REFRESH = 1, /* Fully exposed window */
432 SLOW_REFRESH = 2, /* Partially exposed window */
435 #ifdef NO_SECONDARY_SCREEN
441 /* special (internal) prefix for font commands */
446 /* flags for rxvt_scr_gotorc () */
448 C_RELATIVE = 1, /* col movement is relative */
449 R_RELATIVE = 2, /* row movement is relative */
450 RELATIVE = C_RELATIVE | R_RELATIVE,
453 /* modes for rxvt_scr_insdel_chars (), rxvt_scr_insdel_lines () */
455 INSERT = -1, /* don't change these values */
460 /* modes for rxvt_scr_page () - scroll page. used by scrollbar window */
467 /* arguments for rxvt_scr_change_screen () */
475 #define RS_fgMask 0x0000007fUL // 128 colors
476 #define RS_bgMask 0x00003f80UL // 128 colors
479 #define RS_Bold 0x00004000UL // value 1
480 #define RS_Italic 0x00008000UL // value 2
483 #define RS_Blink 0x00010000UL // blink
484 #define RS_RVid 0x00020000UL // reverse video
485 #define RS_Uline 0x00040000UL // underline
487 // toggle this to force redraw, must be != RS_Careful
488 #define RS_redraw 0x01000000UL
490 // 5 custom bits for extensions
491 #define RS_customCount 32
492 #define RS_customMask 0x00f80000UL
493 #define RS_customShift 19
496 #define RS_Careful 0x80000000UL /* be careful when drawing these */
498 #define RS_styleCount 4
499 #define RS_styleMask (RS_Bold | RS_Italic)
500 #define RS_styleShift 14
502 #define RS_baseattrMask (RS_Italic | RS_Bold | RS_Blink | RS_RVid | RS_Uline)
503 #define RS_attrMask (RS_baseattrMask | RS_fontMask)
505 #define RS_fontCount 127 // not 127 or 256, see rxvtfont.h
506 #define RS_fontMask 0xff000000UL // plenty(?) of fonts, includes RS_Careful
507 #define RS_fontShift 24
509 #define DEFAULT_RSTYLE (RS_None | Color_fg | (Color_bg << Color_Bits))
510 #define OVERLAY_RSTYLE (RS_None | Color_Black | (Color_Yellow << Color_Bits))
512 #define Sel_none 0 /* Not waiting */
513 #define Sel_normal 0x01 /* normal selection */
514 #define Sel_incr 0x02 /* incremental selection */
515 #define Sel_direct 0x00
516 #define Sel_Primary 0x01
517 #define Sel_Secondary 0x02
518 #define Sel_Clipboard 0x03
519 #define Sel_whereMask 0x0f
520 #define Sel_CompoundText 0x10 /* last request was COMPOUND_TEXT */
521 #define Sel_UTF8String 0x20 /* last request was UTF8_STRING */
525 C0_SOH, C0_STX, C0_ETX, C0_EOT, C0_ENQ, C0_ACK, C0_BEL,
526 C0_BS , C0_HT , C0_LF , C0_VT , C0_FF , C0_CR , C0_SO , C0_SI ,
527 C0_DLE, C0_DC1, C0_DC2, D0_DC3, C0_DC4, C0_NAK, C0_SYN, C0_ETB,
528 C0_CAN, C0_EM , C0_SUB, C0_ESC, C0_IS4, C0_IS3, C0_IS2, C0_IS1,
530 #define CHAR_ST 0x9c /* 0234 */
533 * XTerm Operating System Commands: ESC ] Ps;Pt (ST|BEL)
534 * colour extensions by Christian W. Zuckschwerdt <zany@triq.net>
540 XTerm_property = 3, // change X property
541 XTerm_Color = 4, // change colors
542 XTerm_Color00 = 10, // not implemented, CLASH!
543 XTerm_Color01 = 11, // not implemented
544 XTerm_Color_cursor = 12, // change actual 'Cursor' color
545 XTerm_Color_pointer_fg = 13, // change actual 'Pointer' fg color
546 XTerm_Color_pointer_bg = 14, // change actual 'Pointer' bg color
547 XTerm_Color05 = 15, // not implemented (tektronix fg)
548 XTerm_Color06 = 16, // not implemented (tektronix bg)
549 XTerm_Color_RV = 17, // change actual 'Highlight' color
550 XTerm_logfile = 46, // not implemented
553 XTerm_konsole30 = 30, // reserved for konsole
554 XTerm_konsole31 = 31, // reserved for konsole
555 XTerm_emacs51 = 51, // reserved for emacs shell
557 * rxvt extensions of XTerm OSCs: ESC ] Ps;Pt (ST|BEL)
558 * at least Rxvt_Color_BD and Rxvt_Color_UL clash with xterm
560 Rxvt_Color_BD = 18, // change actual 'Bold' color
561 Rxvt_Color_UL = 19, // change actual 'Underline' color
562 Rxvt_Pixmap = 20, // new bg pixmap
563 Rxvt_restoreFG = 39, // change default fg color
564 Rxvt_restoreBG = 49, // change default bg color
565 Rxvt_dumpscreen = 55, // dump scrollback and all of screen
567 URxvt_locale = 701, // change locale
568 URxvt_version = 702, // request version
570 URxvt_Color_IT = 704, // change actual 'Italic' colour
571 URxvt_Color_tint = 705, // change actual tint colour
572 URxvt_Color_BD = 706,
573 URxvt_Color_UL = 707,
576 URxvt_boldFont = 711,
577 URxvt_italicFont = 712,
578 URxvt_boldItalicFont = 713,
581 URxvt_view_down = 721,
586 /* Words starting with `Color_' are colours. Others are counts */
588 * The PixColor and rendition colour usage should probably be decoupled
589 * on the unnecessary items, e.g. Color_pointer, but won't bother
590 * until we need to. Also, be aware of usage in pixcolor_set
595 Color_transparent = -1,
599 Color_Black = minCOLOR,
606 maxCOLOR, /* minCOLOR + 7 */
607 #ifndef NO_BRIGHTCOLOR
608 Color_AntiqueWhite = maxCOLOR,
609 minBrightCOLOR, /* maxCOLOR + 1 */
610 Color_Grey25 = minBrightCOLOR,
617 maxBrightCOLOR, /* minBrightCOLOR + 7 */
618 Color_White = maxBrightCOLOR,
620 Color_White = maxCOLOR,
622 minTermCOLOR = Color_White + 1,
623 maxTermCOLOR = Color_White + 72,
624 #ifndef NO_CURSORCOLOR
631 #ifndef NO_BOLD_UNDERLINE_REVERSE
643 #ifdef KEEP_SCROLLCOLOR
647 #if ENABLE_TRANSPARENCY
654 #ifdef KEEP_SCROLLCOLOR
655 Color_topShadow = NRS_COLORS,
659 TOTAL_COLORS = NRS_COLORS
663 #define Color_Bits 7 // 0 .. maxTermCOLOR
669 # define def(name) Rs_ ## name,
670 # define reserve(name,count) Rs_ ## name ## _ = Rs_ ## name + (count) - 1,
677 /* DEC private modes */
678 #define PrivMode_132 (1UL<<0)
679 #define PrivMode_132OK (1UL<<1)
680 #define PrivMode_rVideo (1UL<<2)
681 #define PrivMode_relOrigin (1UL<<3)
682 #define PrivMode_Screen (1UL<<4)
683 #define PrivMode_Autowrap (1UL<<5)
684 #define PrivMode_aplCUR (1UL<<6)
685 #define PrivMode_aplKP (1UL<<7)
686 #define PrivMode_HaveBackSpace (1UL<<8)
687 #define PrivMode_BackSpace (1UL<<9)
688 #define PrivMode_ShiftKeys (1UL<<10)
689 #define PrivMode_VisibleCursor (1UL<<11)
690 #define PrivMode_MouseX10 (1UL<<12)
691 #define PrivMode_MouseX11 (1UL<<13)
692 #define PrivMode_scrollBar (1UL<<14)
693 #define PrivMode_TtyOutputInh (1UL<<15)
694 #define PrivMode_Keypress (1UL<<16)
695 #define PrivMode_smoothScroll (1UL<<17)
696 #define PrivMode_vt52 (1UL<<18)
697 #define PrivMode_LFNL (1UL<<19)
698 /* too annoying to implement X11 highlight tracking */
699 /* #define PrivMode_MouseX11Track (1LU<<20) */
701 #define PrivMode_mouse_report (PrivMode_MouseX10|PrivMode_MouseX11)
702 #define PrivMode(test,bit) \
704 priv_modes |= (bit); \
708 #ifdef ALLOW_132_MODE
709 # define PrivMode_Default (PrivMode_Autowrap|PrivMode_ShiftKeys|PrivMode_VisibleCursor|PrivMode_132OK)
711 # define PrivMode_Default (PrivMode_Autowrap|PrivMode_ShiftKeys|PrivMode_VisibleCursor)
714 // do not change these constants lightly, there are many interdependencies
715 #define IMBUFSIZ 128 // input modifier buffer sizes
716 #define KBUFSZ 512 // size of keyboard mapping buffer
717 #define CBUFSIZ 2048 // size of command buffer
718 #define UBUFSIZ 2048 // character buffer
721 # define PATH_MAX 16384
724 /* Motif window hints */
725 #define MWM_HINTS_FUNCTIONS (1L << 0)
726 #define MWM_HINTS_DECORATIONS (1L << 1)
727 #define MWM_HINTS_INPUT_MODE (1L << 2)
728 #define MWM_HINTS_STATUS (1L << 3)
729 /* bit definitions for MwmHints.functions */
730 #define MWM_FUNC_ALL (1L << 0)
731 #define MWM_FUNC_RESIZE (1L << 1)
732 #define MWM_FUNC_MOVE (1L << 2)
733 #define MWM_FUNC_MINIMIZE (1L << 3)
734 #define MWM_FUNC_MAXIMIZE (1L << 4)
735 #define MWM_FUNC_CLOSE (1L << 5)
736 /* bit definitions for MwmHints.decorations */
737 #define MWM_DECOR_ALL (1L << 0)
738 #define MWM_DECOR_BORDER (1L << 1)
739 #define MWM_DECOR_RESIZEH (1L << 2)
740 #define MWM_DECOR_TITLE (1L << 3)
741 #define MWM_DECOR_MENU (1L << 4)
742 #define MWM_DECOR_MINIMIZE (1L << 5)
743 #define MWM_DECOR_MAXIMIZE (1L << 6)
744 /* bit definitions for MwmHints.inputMode */
745 #define MWM_INPUT_MODELESS 0
746 #define MWM_INPUT_PRIMARY_APPLICATION_MODAL 1
747 #define MWM_INPUT_SYSTEM_MODAL 2
748 #define MWM_INPUT_FULL_APPLICATION_MODAL 3
749 #define PROP_MWM_HINTS_ELEMENTS 5
752 *****************************************************************************
754 *****************************************************************************
756 #define dLocal(type,name) type const name = this->name
758 // for speed reasons, we assume that all codepoints 32 to 126 are
760 #define WCWIDTH(c) (IN_RANGE_INC (c, 0x20, 0x7e) ? 1 : wcwidth (c))
762 /* convert pixel dimensions to row/column values. Everything as int32_t */
763 #define Pixel2Col(x) Pixel2Width((int32_t)(x))
764 #define Pixel2Row(y) Pixel2Height((int32_t)(y))
765 #define Pixel2Width(x) ((int32_t)(x) / (int32_t)fwidth)
766 #define Pixel2Height(y) ((int32_t)(y) / (int32_t)fheight)
767 #define Col2Pixel(col) ((int32_t)Width2Pixel(col))
768 #define Row2Pixel(row) ((int32_t)Height2Pixel(row))
769 #define Width2Pixel(n) ((int32_t)(n) * (int32_t)fwidth)
770 #define Height2Pixel(n) ((int32_t)(n) * (int32_t)fheight)
772 // for m >= -n, ensure remainder lies between 0..n-1
773 #define MOD(m,n) (((m) + (n)) % (n))
775 #define LINENO(n) MOD (term_start + int(n), total_rows)
776 #define ROW(n) row_buf [LINENO (n)]
778 /* how to build & extract colors and attributes */
779 #define GET_BASEFG(x) (((x) & RS_fgMask))
780 #define GET_BASEBG(x) (((x) & RS_bgMask)>>Color_Bits)
782 #define GET_FONT(x) (((x) & RS_fontMask) >> RS_fontShift)
783 #define SET_FONT(x,fid) (((x) & ~RS_fontMask) | ((fid) << RS_fontShift))
785 #define GET_STYLE(x) (((x) & RS_styleMask) >> RS_styleShift)
786 #define SET_STYLE(x,style) (((x) & ~RS_styleMask) | ((style) << RS_styleShift))
788 #define GET_ATTR(x) (((x) & RS_attrMask))
789 #define GET_BGATTR(x) \
790 (((x) & RS_RVid) ? (((x) & (RS_attrMask & ~RS_RVid)) \
791 | (((x) & RS_fgMask)<<Color_Bits)) \
792 : ((x) & (RS_attrMask | RS_bgMask)))
793 #define SET_FGCOLOR(x,fg) (((x) & ~RS_fgMask) | (fg))
794 #define SET_BGCOLOR(x,bg) (((x) & ~RS_bgMask) | ((bg)<<Color_Bits))
795 #define SET_ATTR(x,a) (((x) & ~RS_attrMask) | (a))
797 #define RS_SAME(a,b) (!(((a) ^ (b)) & ~RS_Careful))
799 #define PIXCOLOR_NAME(idx) rs[Rs_color + (idx)]
800 #define ISSET_PIXCOLOR(idx) (!!rs[Rs_color + (idx)])
803 # define FONTSET(style) fontset[GET_STYLE (style)]
805 # define FONTSET(style) fontset[0]
808 #ifdef HAVE_SCROLLBARS
809 # define scrollbar_TotalWidth() (scrollBar.width + sb_shadow * 2)
811 # define scrollbar_TotalWidth() (0)
813 #define scrollbar_isMotion() (scrollBar.state == 'm')
814 #define scrollbar_isUp() (scrollBar.state == 'U')
815 #define scrollbar_isDn() (scrollBar.state == 'D')
816 #define scrollbar_isUpDn() isupper (scrollBar.state)
817 #define isScrollbarWindow(w) (scrollBar.state && (w) == scrollBar.win)
819 #define scrollbarnext_dnval() (scrollBar.end + (scrollBar.width + 1))
820 #define scrollbarnext_upButton(y) ((y) > scrollBar.end \
821 && (y) <= scrollbarnext_dnval ())
822 #define scrollbarnext_dnButton(y) ((y) > scrollbarnext_dnval())
823 #define SCROLLNEXT_MINHEIGHT SB_THUMB_MIN_HEIGHT
824 #define scrollbarrxvt_upButton(y) ((y) < scrollBar.beg)
825 #define scrollbarrxvt_dnButton(y) ((y) > scrollBar.end)
826 #define SCROLLRXVT_MINHEIGHT 10
827 #define SCROLLXTERM_MINHEIGHT 10
829 #define scrollbar_minheight() (scrollBar.style == R_SB_NEXT \
830 ? SCROLLNEXT_MINHEIGHT \
831 : SCROLLRXVT_MINHEIGHT)
832 #define scrollbar_above_slider(y) ((y) < scrollBar.top)
833 #define scrollbar_below_slider(y) ((y) > scrollBar.bot)
834 #define scrollbar_position(y) ((y) - scrollBar.beg)
835 #define scrollbar_size() (scrollBar.end - scrollBar.beg \
836 - scrollbar_minheight ())
838 typedef callback<void (const char *)> log_callback;
839 typedef callback<int (int)> getfd_callback;
841 #define SET_LOCALE(locale) rxvt_set_locale (locale)
842 extern bool rxvt_set_locale (const char *locale) NOTHROW;
843 extern void rxvt_push_locale (const char *locale) NOTHROW;
844 extern void rxvt_pop_locale () NOTHROW;
846 /****************************************************************************/
848 #define LINE_LONGER 0x0001 // line is continued on the next row
849 #define LINE_FILTERED 0x0002 // line has been filtered
850 #define LINE_COMPRESSED 0x0004 // line has been compressed (NYI)
851 #define LINE_FILTER 0x0008 // line needs to be filtered before display (NYI)
852 #define LINE_BIDI 0x0010 // line needs bidi (NYI)
855 text_t *t; // terminal the text
856 rend_t *r; // rendition, uses RS_ flags
857 tlen_t_ l; // length of each text line, LINE_CONT == continued on next line
862 return f & LINE_LONGER;
865 void is_longer (int set)
881 void touch () // call whenever a line is changed/touched/updated
895 /****************************************************************************/
897 // primivite wrapper around mbstate_t to ensure initialisation
901 operator mbstate_t *() { return &mbs; }
902 void reset () { memset (&mbs, 0, sizeof (mbs)); }
903 mbstate () { reset (); }
906 /****************************************************************************/
908 #define UNICODE_MASK 0x1fffffUL
911 # define COMPOSE_LO 0x40000000UL
912 # define COMPOSE_HI 0x400fffffUL
913 # define IS_COMPOSE(n) ((int32_t)(n) >= COMPOSE_LO)
916 # define COMPOSE_LO 0xe000UL // our _own_ functions don't like (illegal) surrogates
917 # define COMPOSE_HI 0xf8ffUL // in utf-8, so use private use area only
919 # define COMPOSE_LO 0xd800UL
920 # define COMPOSE_HI 0xf8ffUL
922 # define IS_COMPOSE(n) IN_RANGE_INC ((n), COMPOSE_LO, COMPOSE_HI)
926 // compose chars are used to represent composite characters
927 // that are not representable in unicode, as well as characters
928 // not fitting in the BMP.
929 struct compose_char {
930 unicode_t c1, c2; // any chars != NOCHAR are valid
931 compose_char (unicode_t c1, unicode_t c2)
936 class rxvt_composite_vec {
937 vector<compose_char> v;
939 text_t compose (unicode_t c1, unicode_t c2 = NOCHAR);
940 int expand (unicode_t c, wchar_t *r);
941 compose_char *operator [](text_t c)
943 return c >= COMPOSE_LO && c < COMPOSE_LO + v.size ()
949 extern class rxvt_composite_vec rxvt_composite;
952 /****************************************************************************/
954 #ifdef KEYSYM_RESOURCE
955 class keyboard_manager;
958 struct rxvt_term : zero_initialized, rxvt_vars, rxvt_screen {
960 // special markers with magic addresses
961 static const char resval_undef []; // options specifically unset
962 static const char resval_on []; // boolean options switched on
963 static const char resval_off []; // or off
965 log_callback *log_hook; // log error messages through this hook, if != 0
966 getfd_callback *getfd_hook; // convert remote to local fd, if != 0
970 struct mbstate mbstate; // current input multibyte state
972 unsigned char want_refresh:1,
973 #ifdef ENABLE_TRANSPARENCY
974 want_full_refresh:1, /* awaiting full screen refresh */
975 am_transparent:1, /* is a transparent term */
976 am_pixmap_trans:1, /* transparency w/known root pixmap */
978 current_screen:1, /* primary or secondary */
990 enc_utf8:1, /* wether locale uses utf-8 */
991 seen_input:1, /* wether we have seen some program output yet */
992 seen_resize:1, /* wether we had a resize event */
995 unsigned char refresh_type,
997 meta_char, /* Alt-key prefix */
1003 bool rvideo_state, rvideo_mode;
1007 int num_scr; /* screen: number lines scrolled */
1008 int prev_ncol, /* screen: previous number of columns */
1009 prev_nrow; /* screen: previous number of rows */
1013 #ifdef SELECTION_SCROLLING
1014 int scroll_selection_lines;
1015 enum page_dirn scroll_selection_dir;
1016 int selection_save_x,
1018 selection_save_state;
1021 int csrO, /* Hops - csr offset in thumb/slider to */
1022 /* give proper Scroll behaviour */
1023 #if defined(MOUSE_WHEEL) && defined(MOUSE_SLIP_WHEELING)
1024 mouse_slip_wheel_speed,
1027 last_bot, /* scrollbar last bottom position */
1028 last_top, /* scrollbar last top position */
1029 last_state, /* scrollbar last state */
1034 # ifdef POINTER_BLANK
1039 unsigned int ModLevel3Mask,
1042 int old_width, /* last used width in screen resize */
1043 old_height; /* last used height in screen resize */
1044 unsigned long priv_modes,
1049 #ifdef RXVT_SCROLLBAR
1054 #ifdef XTERM_SCROLLBAR
1058 #ifdef PLAIN_SCROLLBAR
1061 #ifdef NEXT_SCROLLBAR
1074 Time selection_time,
1075 selection_request_time;
1076 pid_t cmd_pid; /* process id of child */
1078 size_t incr_buf_size, incr_buf_fill;
1080 Cursor leftptr_cursor;
1082 #ifndef NO_BACKSPACE_KEY
1083 const char *key_backspace;
1085 #ifndef NO_DELETE_KEY
1086 const char *key_delete;
1088 struct mouse_event MEvent;
1089 XComposeStatus compose;
1091 row_col_t oldcursor;
1092 #ifdef HAVE_BG_PIXMAP
1093 bgPixmap_t bgPixmap;
1095 #ifdef HAVE_AFTERIMAGE
1097 ASImageManager *asimman;
1101 int ov_x, ov_y, ov_w, ov_h; // overlay dimensions
1105 void scr_swap_overlay () NOTHROW;
1106 void scr_overlay_new (int x, int y, int w, int h) NOTHROW;
1107 void scr_overlay_off () NOTHROW;
1108 void scr_overlay_set (int x, int y,
1110 rend_t rend = OVERLAY_RSTYLE) NOTHROW;
1111 void scr_overlay_set (int x, int y, const char *s) NOTHROW;
1112 void scr_overlay_set (int x, int y, const wchar_t *s) NOTHROW;
1115 vector<void *> allocated; // free these memory blocks with free()
1117 char env_windowid[21]; /* environmental variable WINDOWID */
1118 char env_colorfgbg[sizeof ("COLORFGBG=default;default;bg") + 1];
1119 char *env_display; /* environmental variable DISPLAY */
1120 char *env_term; /* environmental variable TERM */
1124 char *v_buffer; /* pointer to physical buffer */
1125 unsigned int v_buflen; /* size of area to write */
1126 stringvec *argv, *envv; /* if != 0, will be freed at destroy time */
1128 #ifdef KEYSYM_RESOURCE
1129 keyboard_manager *keyboard;
1132 const char *rs[NUM_RESOURCES];
1133 /* command input buffering */
1134 char *cmdbuf_ptr, *cmdbuf_endp;
1135 char cmdbuf_base[CBUFSIZ];
1139 rxvt_salloc *talloc; // text line allocator
1140 rxvt_salloc *ralloc; // rend line allocator
1142 static vector<rxvt_term *> termlist; // a vector of all running rxvt_term's
1144 #if ENABLE_FRILLS || ISO_14755
1145 // ISO 14755 entry support
1146 unicode_t iso14755buf;
1147 void commit_iso14755 ();
1148 int hex_keyval (XKeyEvent &ev);
1150 void iso14755_51 (unicode_t ch, rend_t r = DEFAULT_RSTYLE, int x = 0, int y = -1);
1151 void iso14755_54 (int x, int y);
1155 // modifies first argument(!)
1156 void paste (char *data, unsigned int len) NOTHROW;
1158 long vt_emask, vt_emask_perl, vt_emask_xim;
1160 void vt_select_input () const NOTHROW
1162 XSelectInput (dpy, vt, vt_emask | vt_emask_perl | vt_emask_xim);
1165 #if ENABLE_TRANSPARENCY || ENABLE_PERL
1166 void rootwin_cb (XEvent &xev);
1167 xevent_watcher rootwin_ev;
1169 #ifdef HAVE_BG_PIXMAP
1170 int update_background ();
1171 void update_background_cb (time_watcher &w);
1172 time_watcher update_background_ev;
1175 void x_cb (XEvent &xev);
1177 xevent_watcher termwin_ev;
1178 xevent_watcher vt_ev;
1179 #ifdef HAVE_SCROLLBARS
1180 xevent_watcher scrollbar_ev;
1183 void child_cb (child_watcher &w, int status); child_watcher child_ev;
1184 void check_cb (check_watcher &w); check_watcher check_ev;
1185 void destroy_cb (time_watcher &w); time_watcher destroy_ev;
1186 void flush_cb (time_watcher &w); time_watcher flush_ev;
1187 void pty_cb (io_watcher &w, short revents); io_watcher pty_ev;
1188 void incr_cb (time_watcher &w) NOTHROW; time_watcher incr_ev;
1191 void cursor_blink_cb (time_watcher &w); time_watcher cursor_blink_ev;
1194 void text_blink_cb (time_watcher &w); time_watcher text_blink_ev;
1197 void bell_cb (time_watcher &w); time_watcher bell_ev;
1200 #ifndef NO_SCROLLBAR_BUTTON_CONTINUAL_SCROLLING
1201 void cont_scroll_cb (time_watcher &w); time_watcher cont_scroll_ev;
1203 #ifdef SELECTION_SCROLLING
1204 void sel_scroll_cb (time_watcher &w); time_watcher sel_scroll_ev;
1206 #if defined(MOUSE_WHEEL) && defined(MOUSE_SLIP_WHEELING)
1207 void slip_wheel_cb (time_watcher &w); time_watcher slip_wheel_ev;
1210 #ifdef POINTER_BLANK
1211 void pointer_cb (time_watcher &w); time_watcher pointer_ev;
1212 void pointer_blank ();
1214 void pointer_unblank ();
1216 void tt_printf (const char *fmt,...);
1217 void tt_write (const char *data, unsigned int len);
1225 void emergency_cleanup ();
1227 bool init (int argc, const char *const *argv, stringvec *envv);
1229 bool init (stringvec *argv, stringvec *envv)
1232 return init (argv->size (), argv->begin (), envv);
1239 void make_current () const // make this the "currently active" urxvt instance
1243 rxvt_set_locale (locale);
1246 void init_secondary ();
1247 const char **init_resources (int argc, const char *const *argv);
1248 const char *x_resource (const char *name);
1250 void set_locale (const char *locale);
1251 void init_xlocale ();
1252 void init_command (const char *const *argv);
1253 void run_command (const char *const *argv);
1254 int run_child (const char *const *argv);
1256 void color_aliases (int idx);
1257 void recolour_cursor ();
1258 void create_windows (int argc, const char *const *argv);
1259 void resize_all_windows (unsigned int newwidth, unsigned int newheight, int ignoreparent);
1260 void window_calc (unsigned int newwidth, unsigned int newheight);
1263 rxvt_xim *input_method;
1265 XIMStyle input_style;
1266 XPoint spot; // most recently sent spot position
1269 void im_cb (); im_watcher im_ev;
1270 void im_set_size (XRectangle &size);
1271 void im_set_position (XPoint &pos) NOTHROW;
1272 void im_set_color (unsigned long &fg, unsigned long &bg);
1273 void im_set_preedit_area (XRectangle &preedit_rect, XRectangle &status_rect, const XRectangle &needed_rect);
1275 bool IMisRunning ();
1277 bool IM_get_IC (const char *modifiers);
1278 void IMSetPosition ();
1281 void resize_scrollbar ();
1284 void key_press (XKeyEvent &ev);
1285 void key_release (XKeyEvent &ev);
1286 unsigned int cmd_write (const char *str, unsigned int count);
1288 wchar_t next_char () NOTHROW;
1289 wchar_t cmd_getc () THROW ((class out_of_input));
1290 uint32_t next_octet () NOTHROW;
1291 uint32_t cmd_get8 () THROW ((class out_of_input));
1294 void mouse_report (XButtonEvent &ev);
1295 void button_press (XButtonEvent &ev);
1296 void button_release (XButtonEvent &ev);
1299 void update_fade_color (unsigned int idx);
1301 FILE *popen_printer ();
1302 int pclose_printer (FILE *stream);
1304 void process_print_pipe ();
1305 void process_nonprinting (unicode_t ch);
1306 void process_escape_vt52 (unicode_t ch);
1307 void process_escape_seq ();
1308 void process_csi_seq ();
1309 void process_window_ops (const int *args, unsigned int nargs);
1310 char *get_to_st (unicode_t &ends_how);
1311 void process_dcs_seq ();
1312 void process_osc_seq ();
1313 void process_color_seq (int report, int color, const char *str, char resp);
1314 void process_xterm_seq (int op, const char *str, char resp);
1315 int privcases (int mode, unsigned long bit);
1316 void process_terminal_mode (int mode, int priv, unsigned int nargs, const int *arg);
1317 void process_sgr_mode (unsigned int nargs, const int *arg);
1318 void process_graphics ();
1320 void Get_Colours ();
1321 void get_ourmods ();
1324 void set_string_property (Atom prop, const char *str, int len = -1);
1325 void set_utf8_property (Atom prop, const char *str, int len = -1);
1326 void set_title (const char *str);
1327 void set_icon_name (const char *str);
1328 void set_window_color (int idx, const char *color);
1329 void set_colorfgbg ();
1330 bool set_color (rxvt_color &color, const char *name);
1331 void alias_color (int dst, int src);
1332 void set_widthheight (unsigned int newwidth, unsigned int newheight);
1336 void lalloc (line_t &l) const
1338 l.t = (text_t *)talloc->alloc ();
1339 l.r = (rend_t *)ralloc->alloc ();
1343 void lfree (line_t &l)
1350 void lresize (line_t &l) const
1355 l.t = (text_t *)talloc->alloc (l.t, prev_ncol * sizeof (text_t));
1356 l.r = (rend_t *)ralloc->alloc (l.r, prev_ncol * sizeof (rend_t));
1358 l.l = min (l.l, ncol);
1360 if (ncol > prev_ncol)
1361 scr_blank_line (l, prev_ncol, ncol - prev_ncol, DEFAULT_RSTYLE);
1364 int fgcolor_of (rend_t r) const NOTHROW
1366 int base = GET_BASEFG (r);
1367 #ifndef NO_BRIGHTCOLOR
1370 && option (Opt_intensityStyles)
1372 && IN_RANGE_INC (base, minCOLOR, minBrightCOLOR))
1373 base += minBrightCOLOR - minCOLOR;
1378 int bgcolor_of (rend_t r) const NOTHROW
1380 int base = GET_BASEBG (r);
1381 #ifndef NO_BRIGHTCOLOR
1384 && option (Opt_intensityStyles)
1386 && IN_RANGE_INC (base, minCOLOR, minBrightCOLOR))
1387 base += minBrightCOLOR - minCOLOR;
1392 bool option (uint8_t opt) const NOTHROW
1394 return options[opt >> 3] & (1 << (opt & 7));
1397 void set_option (uint8_t opt, bool set = true) NOTHROW
1400 options[opt >> 3] |= (1 << (opt & 7));
1402 options[opt >> 3] &= ~(1 << (opt & 7));
1405 void scr_blank_line (line_t &l, unsigned int col, unsigned int width, rend_t efs) const NOTHROW;
1406 void scr_blank_screen_mem (line_t &l, rend_t efs) const NOTHROW;
1407 int scr_scroll_text (int row1, int row2, int count) NOTHROW;
1409 void scr_release () NOTHROW;
1410 void scr_clear (bool really = false) NOTHROW;
1411 void scr_refresh () NOTHROW;
1412 bool scr_refresh_rend (rend_t mask, rend_t value) NOTHROW;
1413 void scr_erase_screen (int mode) NOTHROW;
1415 void scr_erase_savelines () NOTHROW;
1416 void scr_backindex () NOTHROW;
1417 void scr_forwardindex () NOTHROW;
1419 void scr_touch (bool refresh) NOTHROW;
1420 void scr_expose (int x, int y, int width, int height, bool refresh) NOTHROW;
1421 rxvt_fontset *scr_find_fontset (rend_t r = DEFAULT_RSTYLE);
1422 void scr_recolour () NOTHROW;
1423 void scr_remap_chars () NOTHROW;
1424 void scr_remap_chars (line_t &l) NOTHROW;
1426 enum cursor_mode { SAVE, RESTORE };
1428 void scr_poweron ();
1429 void scr_cursor (cursor_mode mode) NOTHROW;
1430 void scr_do_wrap () NOTHROW;
1431 void scr_swap_screen () NOTHROW;
1432 void scr_change_screen (int scrn);
1433 void scr_color (unsigned int color, int fgbg) NOTHROW;
1434 void scr_rendition (int set, int style) NOTHROW;
1435 void scr_add_lines (const wchar_t *str, int len, int minlines = 0) NOTHROW;
1436 void scr_backspace () NOTHROW;
1437 void scr_tab (int count, bool ht = false) NOTHROW;
1438 void scr_gotorc (int row, int col, int relative) NOTHROW;
1439 void scr_index (enum page_dirn direction) NOTHROW;
1440 void scr_erase_line (int mode) NOTHROW;
1441 void scr_E () NOTHROW;
1442 void scr_insdel_lines (int count, int insdel) NOTHROW;
1443 void scr_insdel_chars (int count, int insdel) NOTHROW;
1444 void scr_scroll_region (int top, int bot) NOTHROW;
1445 void scr_cursor_visible (int mode) NOTHROW;
1446 void scr_autowrap (int mode) NOTHROW;
1447 void scr_relative_origin (int mode) NOTHROW;
1448 void scr_insert_mode (int mode) NOTHROW;
1449 void scr_set_tab (int mode) NOTHROW;
1450 void scr_rvideo_mode (bool on) NOTHROW;
1451 void scr_report_position () NOTHROW;
1452 void set_font_style () NOTHROW;
1453 void scr_charset_choose (int set) NOTHROW;
1454 void scr_charset_set (int set, unsigned int ch) NOTHROW;
1455 void scr_move_to (int y, int len) NOTHROW;
1456 bool scr_page (enum page_dirn direction, int nlines) NOTHROW;
1457 bool scr_changeview (int new_view_start) NOTHROW;
1458 void scr_bell () NOTHROW;
1459 void scr_printscreen (int fullhist) NOTHROW;
1460 void scr_xor_rect (int beg_row, int beg_col, int end_row, int end_col, rend_t rstyle1, rend_t rstyle2) NOTHROW;
1461 void scr_xor_span (int beg_row, int beg_col, int end_row, int end_col, rend_t rstyle) NOTHROW;
1462 void scr_reverse_selection () NOTHROW;
1463 void scr_dump (int fd) NOTHROW;
1465 void selection_check (int check_more) NOTHROW;
1466 void selection_paste (Window win, Atom prop, bool delete_prop) NOTHROW;
1467 void selection_property (Window win, Atom prop) NOTHROW;
1468 void selection_request (Time tm, int selnum = Sel_Primary) NOTHROW;
1469 int selection_request_other (Atom target, int selnum) NOTHROW;
1470 void selection_clear () NOTHROW;
1471 void selection_make (Time tm);
1472 bool selection_grab (Time tm) NOTHROW;
1473 void selection_start_colrow (int col, int row) NOTHROW;
1474 void selection_delimit_word (enum page_dirn dirn, const row_col_t *mark, row_col_t *ret) NOTHROW;
1475 void selection_extend_colrow (int32_t col, int32_t row, int button3, int buttonpress, int clickchange) NOTHROW;
1476 void selection_remove_trailing_spaces () NOTHROW;
1477 void selection_send (const XSelectionRequestEvent &rq) NOTHROW;
1478 void selection_click (int clicks, int x, int y) NOTHROW;
1479 void selection_extend (int x, int y, int flag) NOTHROW;
1480 void selection_rotate (int x, int y) NOTHROW;
1482 void pixel_position (int *x, int *y) NOTHROW;
1484 #if defined(NEXT_SCROLLBAR)
1486 Pixmap renderPixmap (const char *const *data, int width, int height);
1487 void init_scrollbar_stuff ();
1488 void drawBevel (Drawable d, int x1, int y1, int w, int h);
1489 int scrollbar_show_next (int update, int last_top, int last_bot, int scrollbar_len);
1492 #if defined(RXVT_SCROLLBAR)
1494 int scrollbar_show_rxvt (int update, int last_top, int last_bot, int scrollbar_len);
1497 #if defined(XTERM_SCROLLBAR)
1498 // scrollbar-xterm.C
1499 int scrollbar_show_xterm (int update, int last_top, int last_bot, int scrollbar_len);
1502 #if defined(PLAIN_SCROLLBAR)
1503 // scrollbar-plain.C
1504 int scrollbar_show_plain (int update, int last_top, int last_bot, int scrollbar_len);
1508 int scrollbar_mapping (int map);
1509 int scrollbar_show (int update);
1510 void setup_scrollbar (const char *scrollalign, const char *scrollstyle, const char *thickness);
1513 void get_options (int argc, const char *const *argv);
1514 int parse_keysym (const char *str, const char *arg);
1515 void get_xdefaults (FILE *stream, const char *name);
1516 void extract_resources ();
1518 void get_window_origin (int &x, int &y);
1519 Pixmap get_pixmap_property (int prop_id);
1523 *****************************************************************************
1525 *****************************************************************************
1528 # define __PROTO(p) p
1530 # define __PROTO(p) ()
1533 #endif /* _RXVT_H_ */