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
23 # define BUILTIN_GLYPHS 1
25 # define ENABLE_MINIMAL 1
30 #include <X11/cursorfont.h>
31 #include <X11/keysym.h>
32 #include <X11/keysymdef.h>
33 #include <X11/Xatom.h>
41 #include "rxvttoolkit.h"
44 #include "libptytty.h"
48 // try to avoid some macros to decrease code size, on some systems
50 # define strcmp(a,b) (strcmp)(a,b)
51 # define strlen(a) (strlen)(a)
52 # define strcpy(a,b) (strcpy)(a,b)
53 # define memset(a,c,l) (memset)(a,c,l)
54 # define memcpy(a,b,l) (memcpy)(a,b,l)
58 *****************************************************************************
60 *****************************************************************************
62 /* Consistent defines - please report on the necessity
63 * @ Unixware: defines (__svr4__)
65 #if defined (SVR4) && !defined (__svr4__)
68 #if defined (sun) && !defined (__sun__)
73 typedef char *XPointer;
77 typedef struct termios ttymode_t;
79 #include "background.h"
82 # define STDIN_FILENO 0
83 # define STDOUT_FILENO 1
84 # define STDERR_FILENO 2
87 /****************************************************************************/
89 // exception thrown on fatal (per-instance) errors
90 class rxvt_failure_exception { };
92 // exception thrown when the command parser runs out of input data
93 class out_of_input { };
96 *****************************************************************************
98 *****************************************************************************
101 void * rxvt_malloc (size_t size);
102 void * rxvt_calloc (size_t number, size_t size);
103 void * rxvt_realloc (void *ptr, size_t size);
106 char * rxvt_wcstombs (const wchar_t *str, int len = -1);
107 wchar_t * rxvt_mbstowcs (const char *str, int len = -1);
108 char * rxvt_wcstoutf8 (const wchar_t *str, int len = -1);
109 wchar_t * rxvt_utf8towcs (const char *str, int len = -1);
111 char * rxvt_basename (const char *str) NOTHROW;
112 void rxvt_vlog (const char *fmt, va_list arg_ptr) NOTHROW;
113 void rxvt_log (const char *fmt,...) NOTHROW;
114 void rxvt_warn (const char *fmt,...) NOTHROW;
115 void rxvt_fatal (const char *fmt, ...) THROW ((class rxvt_failure_exception)) NORETURN;
116 void rxvt_exit_failure () THROW ((class rxvt_failure_exception)) NORETURN;
118 char * rxvt_strtrim (char *str) NOTHROW;
119 char ** rxvt_splitcommastring (const char *cs) NOTHROW;
120 void rxvt_freecommastring (char **cs) NOTHROW;
122 /////////////////////////////////////////////////////////////////////////////
124 // temporarily replace the process environment
125 extern char **environ;
126 extern char **rxvt_environ; // the original environ pointer
128 static inline void set_environ (stringvec *envv)
135 environ = (char **)envv->begin ();
138 static inline void set_environ (char **envv)
149 *****************************************************************************
150 * STRUCTURES AND TYPEDEFS
151 *****************************************************************************
155 /* If we're using either the rxvt scrollbar, keep the
156 * scrollColor resource.
158 #if defined(RXVT_SCROLLBAR) || defined(NEXT_SCROLLBAR) || defined(PLAIN_SCROLLBAR)
159 # define KEEP_SCROLLCOLOR 1
161 # undef KEEP_SCROLLCOLOR
165 * the 'essential' information for reporting Mouse Events
166 * pared down from XButtonEvent
170 Time time; /* milliseconds */
171 unsigned int state; /* key or button mask */
172 unsigned int button; /* detail */
176 typedef struct _mwmhints {
187 # define XEMBED_EMBEDDED_NOTIFY 0
188 # define XEMBED_WINDOW_ACTIVATE 1
189 # define XEMBED_WINDOW_DEACTIVATE 2
190 # define XEMBED_REQUEST_FOCUS 3
191 # define XEMBED_FOCUS_IN 4
192 # define XEMBED_FOCUS_OUT 5
193 # define XEMBED_FOCUS_NEXT 6
194 # define XEMBED_FOCUS_PREV 7
196 # define XEMBED_MODALITY_ON 10
197 # define XEMBED_MODALITY_OFF 11
198 # define XEMBED_REGISTER_ACCELERATOR 12
199 # define XEMBED_UNREGISTER_ACCELERATOR 13
200 # define XEMBED_ACTIVATE_ACCELERATOR 14
202 // XEMBED detail code
203 # define XEMBED_FOCUS_CURRENT 0
204 # define XEMBED_FOCUS_FIRST 1
205 # define XEMBED_FOCUS_LAST 2
207 # define XEMBED_MAPPED (1 << 0)
211 *****************************************************************************
213 *****************************************************************************
216 /* COLORTERM, TERM environment variables */
217 #define COLORTERMENV "rxvt"
218 #ifdef BG_IMAGE_FROM_FILE
219 # define COLORTERMENVFULL COLORTERMENV "-xpm"
221 # define COLORTERMENVFULL COLORTERMENV
224 # define TERMENV "rxvt-unicode"
227 #if defined (NO_MOUSE_REPORT) && !defined (NO_MOUSE_REPORT_SCROLLBAR)
228 # define NO_MOUSE_REPORT_SCROLLBAR 1
231 /* now look for other badly set stuff */
233 #if !defined (EACCESS) && defined(EAGAIN)
234 # define EACCESS EAGAIN
237 #ifndef EXIT_SUCCESS /* missing from <stdlib.h> */
238 # define EXIT_SUCCESS 0 /* exit function success */
239 # define EXIT_FAILURE 1 /* exit function failure */
242 #define scrollBar_esc 30
244 #if defined(RXVT_SCROLLBAR) || defined(NEXT_SCROLLBAR) || defined(XTERM_SCROLLBAR) || defined(PLAIN_SCROLLBAR)
245 # define HAVE_SCROLLBARS 1
248 #define R_SB_ALIGN_CENTRE 0
249 #define R_SB_ALIGN_TOP 1
250 #define R_SB_ALIGN_BOTTOM 2
257 #define SB_WIDTH_NEXT 19
258 #define SB_WIDTH_XTERM 15
259 #define SB_WIDTH_PLAIN 7
260 #ifndef SB_WIDTH_RXVT
261 # define SB_WIDTH_RXVT 10
265 * NeXT scrollbar defines
268 #define SB_BORDER_WIDTH 1
269 #define SB_BEVEL_WIDTH_UPPER_LEFT 1
270 #define SB_BEVEL_WIDTH_LOWER_RIGHT 2
271 #define SB_LEFT_PADDING (SB_PADDING + SB_BORDER_WIDTH)
272 #define SB_MARGIN_SPACE (SB_PADDING * 2)
273 #define SB_BUTTON_WIDTH (SB_WIDTH_NEXT - SB_MARGIN_SPACE - SB_BORDER_WIDTH)
274 #define SB_BUTTON_HEIGHT (SB_BUTTON_WIDTH)
275 #define SB_BUTTON_SINGLE_HEIGHT (SB_BUTTON_HEIGHT + SB_PADDING)
276 #define SB_BUTTON_BOTH_HEIGHT (SB_BUTTON_SINGLE_HEIGHT * 2)
277 #define SB_BUTTON_TOTAL_HEIGHT (SB_BUTTON_BOTH_HEIGHT + SB_PADDING)
278 #define SB_BUTTON_BEVEL_X (SB_LEFT_PADDING)
279 #define SB_BUTTON_FACE_X (SB_BUTTON_BEVEL_X + SB_BEVEL_WIDTH_UPPER_LEFT)
280 #define SB_THUMB_MIN_HEIGHT (SB_BUTTON_WIDTH - (SB_PADDING * 2))
283 * | | <---< SB_PADDING
287 * ,,,,,,,,,,,,,,,,,
290 * | +---------------< SB_BEVEL_WIDTH_UPPER_LEFT
292 * | V :::: vv-------< SB_BEVEL_WIDTH_LOWER_RIGHT
299 * | +---------+ | <.........................
300 * | | <---< SB_PADDING :
301 * | +---------+ | <-+.......... :---< SB_BUTTON_TOTAL_HEIGHT
302 * | | ......%%| | | : :
303 * | | ../\..%%| | |---< SB_BUTTON_HEIGHT :
304 * | | %%%%%%%%| | | : :
305 * | +---------+ | <-+ : :
307 * | +---------+ | <-+ :---< SB_BUTTON_BOTH_HEIGHT
308 * | | ......%%| | | : :
309 * | | ..\/..%%| | | : :
310 * | | %%%%%%%%| | |---< SB_BUTTON_SINGLE_HEIGHT
311 * | +---------+ | | : :
313 * +-------------+ <-+.........:............:
316 * || +---< SB_BUTTON_WIDTH
318 * |+------< SB_PADDING
320 * +----< SB_BORDER_WIDTH
324 * +---< SB_WIDTH_NEXT
328 NO_REFRESH = 0, /* Window not visible at all! */
329 FAST_REFRESH = 1, /* Fully exposed window */
330 SLOW_REFRESH = 2, /* Partially exposed window */
333 #ifdef NO_SECONDARY_SCREEN
339 /* special (internal) prefix for font commands */
344 /* flags for rxvt_scr_gotorc () */
346 C_RELATIVE = 1, /* col movement is relative */
347 R_RELATIVE = 2, /* row movement is relative */
348 RELATIVE = C_RELATIVE | R_RELATIVE,
351 /* modes for rxvt_scr_insdel_chars (), rxvt_scr_insdel_lines () */
353 INSERT = -1, /* don't change these values */
358 /* modes for rxvt_scr_page () - scroll page. used by scrollbar window */
365 /* arguments for rxvt_scr_change_screen () */
373 #define RS_fgMask 0x0000007fUL // 128 colors
374 #define RS_bgMask 0x00003f80UL // 128 colors
377 #define RS_Bold 0x00004000UL // value 1
378 #define RS_Italic 0x00008000UL // value 2
381 #define RS_Blink 0x00010000UL // blink
382 #define RS_RVid 0x00020000UL // reverse video
383 #define RS_Uline 0x00040000UL // underline
385 // toggle this to force redraw, must be != RS_Careful
386 #define RS_redraw 0x01000000UL
388 // 5 custom bits for extensions
389 #define RS_customCount 32
390 #define RS_customMask 0x00f80000UL
391 #define RS_customShift 19
394 #define RS_Careful 0x80000000UL /* be careful when drawing these */
396 #define RS_styleCount 4
397 #define RS_styleMask (RS_Bold | RS_Italic)
398 #define RS_styleShift 14
400 #define RS_baseattrMask (RS_Italic | RS_Bold | RS_Blink | RS_RVid | RS_Uline)
401 #define RS_attrMask (RS_baseattrMask | RS_fontMask)
403 #define RS_fontCount 127 // not 127 or 256, see rxvtfont.h
404 #define RS_fontMask 0xff000000UL // plenty(?) of fonts, includes RS_Careful
405 #define RS_fontShift 24
407 #define DEFAULT_RSTYLE (RS_None | Color_fg | (Color_bg << Color_Bits))
408 #define OVERLAY_RSTYLE (RS_None | Color_Black | (Color_Yellow << Color_Bits))
410 #define Sel_none 0 /* Not waiting */
411 #define Sel_normal 0x01 /* normal selection */
412 #define Sel_incr 0x02 /* incremental selection */
413 #define Sel_direct 0x00
414 #define Sel_Primary 0x01
415 #define Sel_Secondary 0x02
416 #define Sel_Clipboard 0x03
417 #define Sel_whereMask 0x0f
418 #define Sel_CompoundText 0x10 /* last request was COMPOUND_TEXT */
419 #define Sel_UTF8String 0x20 /* last request was UTF8_STRING */
423 C0_SOH, C0_STX, C0_ETX, C0_EOT, C0_ENQ, C0_ACK, C0_BEL,
424 C0_BS , C0_HT , C0_LF , C0_VT , C0_FF , C0_CR , C0_SO , C0_SI ,
425 C0_DLE, C0_DC1, C0_DC2, D0_DC3, C0_DC4, C0_NAK, C0_SYN, C0_ETB,
426 C0_CAN, C0_EM , C0_SUB, C0_ESC, C0_IS4, C0_IS3, C0_IS2, C0_IS1,
428 #define CHAR_ST 0x9c /* 0234 */
431 * XTerm Operating System Commands: ESC ] Ps;Pt (ST|BEL)
432 * colour extensions by Christian W. Zuckschwerdt <zany@triq.net>
438 XTerm_property = 3, // change X property
439 XTerm_Color = 4, // change colors
440 XTerm_Color00 = 10, // not implemented, CLASH!
441 XTerm_Color01 = 11, // not implemented
442 XTerm_Color_cursor = 12, // change actual 'Cursor' color
443 XTerm_Color_pointer_fg = 13, // change actual 'Pointer' fg color
444 XTerm_Color_pointer_bg = 14, // change actual 'Pointer' bg color
445 XTerm_Color05 = 15, // not implemented (tektronix fg)
446 XTerm_Color06 = 16, // not implemented (tektronix bg)
447 XTerm_Color_RV = 17, // change actual 'Highlight' color
448 XTerm_logfile = 46, // not implemented
451 XTerm_konsole30 = 30, // reserved for konsole
452 XTerm_konsole31 = 31, // reserved for konsole
453 XTerm_emacs51 = 51, // reserved for emacs shell
455 * rxvt extensions of XTerm OSCs: ESC ] Ps;Pt (ST|BEL)
456 * at least Rxvt_Color_BD and Rxvt_Color_UL clash with xterm
458 Rxvt_Color_BD = 18, // change actual 'Bold' color
459 Rxvt_Color_UL = 19, // change actual 'Underline' color
460 Rxvt_Pixmap = 20, // new bg pixmap
461 Rxvt_restoreFG = 39, // change default fg color
462 Rxvt_restoreBG = 49, // change default bg color
463 Rxvt_dumpscreen = 55, // dump scrollback and all of screen
465 URxvt_locale = 701, // change locale
466 URxvt_version = 702, // request version
468 URxvt_Color_IT = 704, // change actual 'Italic' colour
469 URxvt_Color_tint = 705, // change actual tint colour
470 URxvt_Color_BD = 706,
471 URxvt_Color_UL = 707,
474 URxvt_boldFont = 711,
475 URxvt_italicFont = 712,
476 URxvt_boldItalicFont = 713,
479 URxvt_view_down = 721,
484 /* Words starting with `Color_' are colours. Others are counts */
486 * The PixColor and rendition colour usage should probably be decoupled
487 * on the unnecessary items, e.g. Color_pointer, but won't bother
488 * until we need to. Also, be aware of usage in pixcolor_set
493 Color_transparent = -1,
497 Color_Black = minCOLOR,
504 maxCOLOR, /* minCOLOR + 7 */
505 #ifndef NO_BRIGHTCOLOR
506 Color_AntiqueWhite = maxCOLOR,
507 minBrightCOLOR, /* maxCOLOR + 1 */
508 Color_Grey25 = minBrightCOLOR,
515 maxBrightCOLOR, /* minBrightCOLOR + 7 */
516 Color_White = maxBrightCOLOR,
518 Color_White = maxCOLOR,
520 minTermCOLOR = Color_White + 1,
521 maxTermCOLOR = Color_White + 72,
522 #ifndef NO_CURSORCOLOR
529 #ifndef NO_BOLD_UNDERLINE_REVERSE
541 #ifdef KEEP_SCROLLCOLOR
545 #if ENABLE_TRANSPARENCY
552 #ifdef KEEP_SCROLLCOLOR
553 Color_topShadow = NRS_COLORS,
557 TOTAL_COLORS = NRS_COLORS
561 #define Color_Bits 7 // 0 .. maxTermCOLOR
567 # define def(name) Rs_ ## name,
568 # define reserve(name,count) Rs_ ## name ## _ = Rs_ ## name + (count) - 1,
575 /* DEC private modes */
576 #define PrivMode_132 (1UL<<0)
577 #define PrivMode_132OK (1UL<<1)
578 #define PrivMode_rVideo (1UL<<2)
579 #define PrivMode_relOrigin (1UL<<3)
580 #define PrivMode_Screen (1UL<<4)
581 #define PrivMode_Autowrap (1UL<<5)
582 #define PrivMode_aplCUR (1UL<<6)
583 #define PrivMode_aplKP (1UL<<7)
584 #define PrivMode_HaveBackSpace (1UL<<8)
585 #define PrivMode_BackSpace (1UL<<9)
586 #define PrivMode_ShiftKeys (1UL<<10)
587 #define PrivMode_VisibleCursor (1UL<<11)
588 #define PrivMode_MouseX10 (1UL<<12)
589 #define PrivMode_MouseX11 (1UL<<13)
590 #define PrivMode_scrollBar (1UL<<14)
591 #define PrivMode_TtyOutputInh (1UL<<15)
592 #define PrivMode_Keypress (1UL<<16)
593 #define PrivMode_smoothScroll (1UL<<17)
594 #define PrivMode_vt52 (1UL<<18)
595 #define PrivMode_LFNL (1UL<<19)
596 #define PrivMode_MouseBtnEvent (1UL<<20)
597 #define PrivMode_MouseAnyEvent (1UL<<21)
598 /* too annoying to implement X11 highlight tracking */
599 /* #define PrivMode_MouseX11Track (1LU<<20) */
601 #define PrivMode_mouse_report (PrivMode_MouseX10|PrivMode_MouseX11|PrivMode_MouseBtnEvent|PrivMode_MouseAnyEvent)
603 #ifdef ALLOW_132_MODE
604 # define PrivMode_Default (PrivMode_Autowrap|PrivMode_ShiftKeys|PrivMode_VisibleCursor|PrivMode_132OK)
606 # define PrivMode_Default (PrivMode_Autowrap|PrivMode_ShiftKeys|PrivMode_VisibleCursor)
609 // do not change these constants lightly, there are many interdependencies
610 #define IMBUFSIZ 128 // input modifier buffer sizes
611 #define KBUFSZ 512 // size of keyboard mapping buffer
612 #define CBUFSIZ 2048 // size of command buffer
613 #define UBUFSIZ 2048 // character buffer
616 # define PATH_MAX 16384
619 /* Motif window hints */
620 #define MWM_HINTS_FUNCTIONS (1L << 0)
621 #define MWM_HINTS_DECORATIONS (1L << 1)
622 #define MWM_HINTS_INPUT_MODE (1L << 2)
623 #define MWM_HINTS_STATUS (1L << 3)
624 /* bit definitions for MwmHints.functions */
625 #define MWM_FUNC_ALL (1L << 0)
626 #define MWM_FUNC_RESIZE (1L << 1)
627 #define MWM_FUNC_MOVE (1L << 2)
628 #define MWM_FUNC_MINIMIZE (1L << 3)
629 #define MWM_FUNC_MAXIMIZE (1L << 4)
630 #define MWM_FUNC_CLOSE (1L << 5)
631 /* bit definitions for MwmHints.decorations */
632 #define MWM_DECOR_ALL (1L << 0)
633 #define MWM_DECOR_BORDER (1L << 1)
634 #define MWM_DECOR_RESIZEH (1L << 2)
635 #define MWM_DECOR_TITLE (1L << 3)
636 #define MWM_DECOR_MENU (1L << 4)
637 #define MWM_DECOR_MINIMIZE (1L << 5)
638 #define MWM_DECOR_MAXIMIZE (1L << 6)
639 /* bit definitions for MwmHints.inputMode */
640 #define MWM_INPUT_MODELESS 0
641 #define MWM_INPUT_PRIMARY_APPLICATION_MODAL 1
642 #define MWM_INPUT_SYSTEM_MODAL 2
643 #define MWM_INPUT_FULL_APPLICATION_MODAL 3
644 #define PROP_MWM_HINTS_ELEMENTS 5
647 *****************************************************************************
649 *****************************************************************************
651 #define dLocal(type,name) type const name = this->name
653 // for speed reasons, we assume that all codepoints 32 to 126 are
655 #define WCWIDTH(c) (IN_RANGE_INC (c, 0x20, 0x7e) ? 1 : wcwidth (c))
657 /* convert pixel dimensions to row/column values. Everything as int32_t */
658 #define Pixel2Col(x) Pixel2Width((int32_t)(x))
659 #define Pixel2Row(y) Pixel2Height((int32_t)(y))
660 #define Pixel2Width(x) ((int32_t)(x) / (int32_t)fwidth)
661 #define Pixel2Height(y) ((int32_t)(y) / (int32_t)fheight)
662 #define Col2Pixel(col) ((int32_t)Width2Pixel(col))
663 #define Row2Pixel(row) ((int32_t)Height2Pixel(row))
664 #define Width2Pixel(n) ((int32_t)(n) * (int32_t)fwidth)
665 #define Height2Pixel(n) ((int32_t)(n) * (int32_t)fheight)
667 // for m >= -n, ensure remainder lies between 0..n-1
668 #define MOD(m,n) (((m) + (n)) % (n))
670 #define LINENO(n) MOD (term_start + int(n), total_rows)
671 #define ROW(n) row_buf [LINENO (n)]
673 /* how to build & extract colors and attributes */
674 #define GET_BASEFG(x) (((x) & RS_fgMask))
675 #define GET_BASEBG(x) (((x) & RS_bgMask)>>Color_Bits)
677 #define GET_FONT(x) (((x) & RS_fontMask) >> RS_fontShift)
678 #define SET_FONT(x,fid) (((x) & ~RS_fontMask) | ((fid) << RS_fontShift))
680 #define GET_STYLE(x) (((x) & RS_styleMask) >> RS_styleShift)
681 #define SET_STYLE(x,style) (((x) & ~RS_styleMask) | ((style) << RS_styleShift))
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))
692 #define RS_SAME(a,b) (!(((a) ^ (b)) & ~RS_Careful))
694 #define PIXCOLOR_NAME(idx) rs[Rs_color + (idx)]
695 #define ISSET_PIXCOLOR(idx) (!!rs[Rs_color + (idx)])
698 # define FONTSET(style) fontset[GET_STYLE (style)]
700 # define FONTSET(style) fontset[0]
703 #ifdef HAVE_SCROLLBARS
704 # define scrollbar_TotalWidth() (scrollBar.width + sb_shadow * 2)
706 # define scrollbar_TotalWidth() (0)
708 #define scrollbar_isMotion() (scrollBar.state == 'm')
709 #define scrollbar_isUp() (scrollBar.state == 'U')
710 #define scrollbar_isDn() (scrollBar.state == 'D')
711 #define scrollbar_isUpDn() isupper (scrollBar.state)
712 #define isScrollbarWindow(w) (scrollBar.state && (w) == scrollBar.win)
714 #define scrollbarnext_dnval() (scrollBar.end + (scrollBar.width + 1))
715 #define scrollbarnext_upButton(y) ((y) > scrollBar.end \
716 && (y) <= scrollbarnext_dnval ())
717 #define scrollbarnext_dnButton(y) ((y) > scrollbarnext_dnval())
718 #define SCROLLNEXT_MINHEIGHT SB_THUMB_MIN_HEIGHT
719 #define scrollbarrxvt_upButton(y) ((y) < scrollBar.beg)
720 #define scrollbarrxvt_dnButton(y) ((y) > scrollBar.end)
721 #define SCROLLRXVT_MINHEIGHT 10
722 #define SCROLLXTERM_MINHEIGHT 10
724 #define scrollbar_minheight() (scrollBar.style == R_SB_NEXT \
725 ? SCROLLNEXT_MINHEIGHT \
726 : SCROLLRXVT_MINHEIGHT)
727 #define scrollbar_above_slider(y) ((y) < scrollBar.top)
728 #define scrollbar_below_slider(y) ((y) > scrollBar.bot)
729 #define scrollbar_position(y) ((y) - scrollBar.beg)
730 #define scrollbar_size() (scrollBar.end - scrollBar.beg \
731 - scrollbar_minheight ())
733 typedef callback<void (const char *)> log_callback;
734 typedef callback<int (int)> getfd_callback;
736 #define SET_LOCALE(locale) rxvt_set_locale (locale)
737 extern bool rxvt_set_locale (const char *locale) NOTHROW;
738 extern void rxvt_push_locale (const char *locale) NOTHROW;
739 extern void rxvt_pop_locale () NOTHROW;
741 /****************************************************************************/
743 #define LINE_LONGER 0x0001 // line is continued on the next row
744 #define LINE_FILTERED 0x0002 // line has been filtered
745 #define LINE_COMPRESSED 0x0004 // line has been compressed (NYI)
746 #define LINE_FILTER 0x0008 // line needs to be filtered before display (NYI)
747 #define LINE_BIDI 0x0010 // line needs bidi (NYI)
750 text_t *t; // terminal the text
751 rend_t *r; // rendition, uses RS_ flags
752 tlen_t_ l; // length of each text line, LINE_CONT == continued on next line
757 return f & LINE_LONGER;
760 void is_longer (int set)
776 void touch () // call whenever a line is changed/touched/updated
790 /****************************************************************************/
792 // primitive wrapper around mbstate_t to ensure initialisation
796 operator mbstate_t *() { return &mbs; }
797 void reset () { memset (&mbs, 0, sizeof (mbs)); }
798 mbstate () { reset (); }
801 /****************************************************************************/
803 #define UNICODE_MASK 0x1fffffUL
806 # define COMPOSE_LO 0x40000000UL
807 # define COMPOSE_HI 0x400fffffUL
808 # define IS_COMPOSE(n) ((int32_t)(n) >= COMPOSE_LO)
811 # define COMPOSE_LO 0xe000UL // our _own_ functions don't like (illegal) surrogates
812 # define COMPOSE_HI 0xf8ffUL // in utf-8, so use private use area only
814 # define COMPOSE_LO 0xd800UL
815 # define COMPOSE_HI 0xf8ffUL
817 # define IS_COMPOSE(n) IN_RANGE_INC ((n), COMPOSE_LO, COMPOSE_HI)
821 // compose chars are used to represent composite characters
822 // that are not representable in unicode, as well as characters
823 // not fitting in the BMP.
824 struct compose_char {
825 unicode_t c1, c2; // any chars != NOCHAR are valid
826 compose_char (unicode_t c1, unicode_t c2)
831 class rxvt_composite_vec {
832 vector<compose_char> v;
834 text_t compose (unicode_t c1, unicode_t c2 = NOCHAR);
835 int expand (unicode_t c, wchar_t *r);
836 compose_char *operator [](text_t c)
838 return c >= COMPOSE_LO && c < COMPOSE_LO + v.size ()
844 extern class rxvt_composite_vec rxvt_composite;
847 /****************************************************************************/
849 #ifdef KEYSYM_RESOURCE
850 class keyboard_manager;
853 struct rxvt_term : zero_initialized, rxvt_vars, rxvt_screen {
855 // special markers with magic addresses
856 static const char resval_undef []; // options specifically unset
857 static const char resval_on []; // boolean options switched on
858 static const char resval_off []; // or off
860 log_callback *log_hook; // log error messages through this hook, if != 0
861 getfd_callback *getfd_hook; // convert remote to local fd, if != 0
865 struct mbstate mbstate; // current input multibyte state
867 unsigned char want_refresh:1,
868 current_screen:1, /* primary or secondary */
880 enc_utf8:1, /* wether locale uses utf-8 */
881 seen_input:1, /* wether we have seen some program output yet */
882 seen_resize:1, /* wether we had a resize event */
885 unsigned char refresh_type,
887 meta_char, /* Alt-key prefix */
893 bool rvideo_state, rvideo_mode;
897 int num_scr; /* screen: number lines scrolled */
898 int prev_ncol, /* screen: previous number of columns */
899 prev_nrow; /* screen: previous number of rows */
903 #ifdef SELECTION_SCROLLING
904 int scroll_selection_lines;
905 enum page_dirn scroll_selection_dir;
906 int selection_save_x,
908 selection_save_state;
911 int csrO, /* Hops - csr offset in thumb/slider to */
912 /* give proper Scroll behaviour */
913 #if defined(MOUSE_WHEEL) && defined(MOUSE_SLIP_WHEELING)
914 mouse_slip_wheel_speed,
917 last_bot, /* scrollbar last bottom position */
918 last_top, /* scrollbar last top position */
919 last_state, /* scrollbar last state */
926 # ifdef POINTER_BLANK
931 unsigned int ModLevel3Mask,
934 int old_width, /* last used width in screen resize */
935 old_height; /* last used height in screen resize */
936 unsigned long priv_modes,
941 #ifdef RXVT_SCROLLBAR
946 #ifdef XTERM_SCROLLBAR
950 #ifdef PLAIN_SCROLLBAR
953 #ifdef NEXT_SCROLLBAR
967 selection_request_time;
968 pid_t cmd_pid; /* process id of child */
970 size_t incr_buf_size, incr_buf_fill;
972 Cursor leftptr_cursor;
974 struct mouse_event MEvent;
975 XComposeStatus compose;
978 #ifdef HAVE_BG_PIXMAP
981 #ifdef HAVE_AFTERIMAGE
983 ASImageManager *asimman;
987 int ov_x, ov_y, ov_w, ov_h; // overlay dimensions
991 void scr_swap_overlay () NOTHROW;
992 void scr_overlay_new (int x, int y, int w, int h) NOTHROW;
993 void scr_overlay_off () NOTHROW;
994 void scr_overlay_set (int x, int y,
996 rend_t rend = OVERLAY_RSTYLE) NOTHROW;
997 void scr_overlay_set (int x, int y, const char *s) NOTHROW;
998 void scr_overlay_set (int x, int y, const wchar_t *s) NOTHROW;
1001 vector<void *> allocated; // free these memory blocks with free()
1003 char env_windowid[21]; /* environmental variable WINDOWID */
1004 char env_colorfgbg[sizeof ("COLORFGBG=default;default;bg") + 1];
1005 char *env_display; /* environmental variable DISPLAY */
1006 char *env_term; /* environmental variable TERM */
1010 char *v_buffer; /* pointer to physical buffer */
1011 unsigned int v_buflen; /* size of area to write */
1012 stringvec *argv, *envv; /* if != 0, will be freed at destroy time */
1014 #ifdef KEYSYM_RESOURCE
1015 keyboard_manager *keyboard;
1017 #ifndef NO_RESOURCES
1018 XrmDatabase option_db;
1021 const char *rs[NUM_RESOURCES];
1022 /* command input buffering */
1023 char *cmdbuf_ptr, *cmdbuf_endp;
1024 char cmdbuf_base[CBUFSIZ];
1028 rxvt_salloc *talloc; // text line allocator
1029 rxvt_salloc *ralloc; // rend line allocator
1031 static vector<rxvt_term *> termlist; // a vector of all running rxvt_term's
1033 #if ENABLE_FRILLS || ISO_14755
1034 // ISO 14755 entry support
1035 unicode_t iso14755buf;
1036 void commit_iso14755 ();
1037 int hex_keyval (XKeyEvent &ev);
1039 void iso14755_51 (unicode_t ch, rend_t r = DEFAULT_RSTYLE, int x = 0, int y = -1);
1040 void iso14755_54 (int x, int y);
1044 long vt_emask, vt_emask_perl, vt_emask_xim, vt_emask_mouse;
1046 void vt_select_input () const NOTHROW
1048 XSelectInput (dpy, vt, vt_emask | vt_emask_perl | vt_emask_xim | vt_emask_mouse);
1051 #if ENABLE_TRANSPARENCY || ENABLE_PERL
1052 void rootwin_cb (XEvent &xev);
1053 xevent_watcher rootwin_ev;
1055 #ifdef HAVE_BG_PIXMAP
1056 int update_background ();
1058 int trace_update_background (const char *file, int line);
1059 # define update_background() trace_update_background (__FILE__, __LINE__)
1061 void update_background_cb (ev::timer &w, int revents);
1062 ev::timer update_background_ev;
1065 void x_cb (XEvent &xev);
1066 xevent_watcher termwin_ev;
1067 xevent_watcher vt_ev;
1068 #ifdef HAVE_SCROLLBARS
1069 xevent_watcher scrollbar_ev;
1072 void child_cb (ev::child &w, int revents); ev::child child_ev;
1073 void prepare_cb (ev::prepare &w, int revents); ev::prepare prepare_ev;
1074 void destroy_cb (ev::idle &w, int revents); ev::idle destroy_ev;
1076 void flush_cb (ev::timer &w, int revents); ev::timer flush_ev;
1078 void pty_cb (ev::io &w, int revents); ev::io pty_ev;
1079 void incr_cb (ev::timer &w, int revents) NOTHROW; ev::timer incr_ev;
1082 void cursor_blink_cb (ev::timer &w, int revents); ev::timer cursor_blink_ev;
1085 void text_blink_cb (ev::timer &w, int revents); ev::timer text_blink_ev;
1088 void bell_cb (ev::timer &w, int revents); ev::timer bell_ev;
1091 #ifndef NO_SCROLLBAR_BUTTON_CONTINUAL_SCROLLING
1092 void cont_scroll_cb (ev::timer &w, int revents); ev::timer cont_scroll_ev;
1094 #ifdef SELECTION_SCROLLING
1095 void sel_scroll_cb (ev::timer &w, int revents); ev::timer sel_scroll_ev;
1097 #if defined(MOUSE_WHEEL) && defined(MOUSE_SLIP_WHEELING)
1098 void slip_wheel_cb (ev::timer &w, int revents); ev::timer slip_wheel_ev;
1101 #ifdef POINTER_BLANK
1102 void pointer_cb (ev::timer &w, int revents); ev::timer pointer_ev;
1103 void pointer_blank ();
1105 void pointer_unblank ();
1107 void tt_printf (const char *fmt,...);
1108 void tt_write (const char *data, unsigned int len);
1111 bool init (stringvec *argv, stringvec *envv)
1114 return init (argv->size (), argv->begin (), envv);
1117 void make_current () const // make this the "currently active" urxvt instance
1121 rxvt_set_locale (locale);
1125 rxvt_xim *input_method;
1127 XIMStyle input_style;
1128 XPoint spot; // most recently sent spot position
1131 void im_cb (); im_watcher im_ev;
1132 void im_set_size (XRectangle &size);
1133 void im_set_position (XPoint &pos) NOTHROW;
1134 void im_set_color (unsigned long &fg, unsigned long &bg);
1135 void im_set_preedit_area (XRectangle &preedit_rect, XRectangle &status_rect, const XRectangle &needed_rect);
1137 bool IMisRunning ();
1139 bool IM_get_IC (const char *modifiers);
1140 void IMSetPosition ();
1144 void key_press (XKeyEvent &ev);
1145 void key_release (XKeyEvent &ev);
1146 unsigned int cmd_write (const char *str, unsigned int count);
1148 wchar_t next_char () NOTHROW;
1149 wchar_t cmd_getc () THROW ((class out_of_input));
1150 uint32_t next_octet () NOTHROW;
1151 uint32_t cmd_get8 () THROW ((class out_of_input));
1154 void mouse_report (XButtonEvent &ev);
1155 void button_press (XButtonEvent &ev);
1156 void button_release (XButtonEvent &ev);
1159 void update_fade_color (unsigned int idx);
1161 FILE *popen_printer ();
1162 int pclose_printer (FILE *stream);
1164 void process_print_pipe ();
1165 void process_nonprinting (unicode_t ch);
1166 void process_escape_vt52 (unicode_t ch);
1167 void process_escape_seq ();
1168 void process_csi_seq ();
1169 void process_window_ops (const int *args, unsigned int nargs);
1170 char *get_to_st (unicode_t &ends_how);
1171 void process_dcs_seq ();
1172 void process_osc_seq ();
1173 void process_color_seq (int report, int color, const char *str, char resp);
1174 void process_xterm_seq (int op, const char *str, char resp);
1175 int privcases (int mode, unsigned long bit);
1176 void process_terminal_mode (int mode, int priv, unsigned int nargs, const int *arg);
1177 void process_sgr_mode (unsigned int nargs, const int *arg);
1178 void process_graphics ();
1181 void init_secondary ();
1182 const char **init_resources (int argc, const char *const *argv);
1184 void set_locale (const char *locale);
1185 void init_xlocale ();
1186 void init_command (const char *const *argv);
1187 void run_command (const char *const *argv);
1188 int run_child (const char *const *argv);
1189 void color_aliases (int idx);
1190 void create_windows (int argc, const char *const *argv);
1191 void Get_Colours ();
1192 void get_ourmods ();
1198 void emergency_cleanup ();
1199 bool init (int argc, const char *const *argv, stringvec *envv);
1200 void recolour_cursor ();
1201 void resize_all_windows (unsigned int newwidth, unsigned int newheight, int ignoreparent);
1202 void window_calc (unsigned int newwidth, unsigned int newheight);
1204 void set_string_property (Atom prop, const char *str, int len = -1);
1205 void set_utf8_property (Atom prop, const char *str, int len = -1);
1206 void set_title (const char *str);
1207 void set_icon_name (const char *str);
1208 void set_window_color (int idx, const char *color);
1209 void set_colorfgbg ();
1210 bool set_color (rxvt_color &color, const char *name);
1211 void alias_color (int dst, int src);
1212 void set_widthheight (unsigned int newwidth, unsigned int newheight);
1213 void get_window_origin (int &x, int &y);
1214 Pixmap get_pixmap_property (int prop_id);
1218 void lalloc (line_t &l) const
1220 l.t = (text_t *)talloc->alloc ();
1221 l.r = (rend_t *)ralloc->alloc ();
1225 void lfree (line_t &l)
1232 void lresize (line_t &l) const
1237 l.t = (text_t *)talloc->alloc (l.t, prev_ncol * sizeof (text_t));
1238 l.r = (rend_t *)ralloc->alloc (l.r, prev_ncol * sizeof (rend_t));
1240 l.l = min (l.l, ncol);
1242 if (ncol > prev_ncol)
1243 scr_blank_line (l, prev_ncol, ncol - prev_ncol, DEFAULT_RSTYLE);
1246 int fgcolor_of (rend_t r) const NOTHROW
1248 int base = GET_BASEFG (r);
1249 #ifndef NO_BRIGHTCOLOR
1252 && option (Opt_intensityStyles)
1254 && IN_RANGE_INC (base, minCOLOR, minBrightCOLOR))
1255 base += minBrightCOLOR - minCOLOR;
1260 int bgcolor_of (rend_t r) const NOTHROW
1262 int base = GET_BASEBG (r);
1263 #ifndef NO_BRIGHTCOLOR
1266 && option (Opt_intensityStyles)
1268 && IN_RANGE_INC (base, minCOLOR, minBrightCOLOR))
1269 base += minBrightCOLOR - minCOLOR;
1274 bool option (uint8_t opt) const NOTHROW
1280 return options[opt >> 3] & (1 << (opt & 7));
1283 void set_option (uint8_t opt, bool set = true) NOTHROW
1290 options[opt >> 3] |= (1 << (opt & 7));
1292 options[opt >> 3] &= ~(1 << (opt & 7));
1295 void PrivMode (int set, unsigned bit) NOTHROW
1303 // modifies first argument(!)
1304 void paste (char *data, unsigned int len) NOTHROW;
1305 void scr_blank_line (line_t &l, unsigned int col, unsigned int width, rend_t efs) const NOTHROW;
1306 void scr_blank_screen_mem (line_t &l, rend_t efs) const NOTHROW;
1307 int scr_scroll_text (int row1, int row2, int count) NOTHROW;
1309 void scr_release () NOTHROW;
1310 void scr_clear (bool really = false) NOTHROW;
1311 void scr_refresh () NOTHROW;
1312 bool scr_refresh_rend (rend_t mask, rend_t value) NOTHROW;
1313 void scr_erase_screen (int mode) NOTHROW;
1315 void scr_erase_savelines () NOTHROW;
1316 void scr_backindex () NOTHROW;
1317 void scr_forwardindex () NOTHROW;
1319 void scr_touch (bool refresh) NOTHROW;
1320 void scr_expose (int x, int y, int width, int height, bool refresh) NOTHROW;
1321 void scr_recolour () NOTHROW;
1322 void scr_remap_chars () NOTHROW;
1323 void scr_remap_chars (line_t &l) NOTHROW;
1325 enum cursor_mode { SAVE, RESTORE };
1327 void scr_poweron ();
1328 void scr_cursor (cursor_mode mode) NOTHROW;
1329 void scr_do_wrap () NOTHROW;
1330 void scr_swap_screen () NOTHROW;
1331 void scr_change_screen (int scrn);
1332 void scr_color (unsigned int color, int fgbg) NOTHROW;
1333 void scr_rendition (int set, int style) NOTHROW;
1334 void scr_add_lines (const wchar_t *str, int len, int minlines = 0) NOTHROW;
1335 void scr_backspace () NOTHROW;
1336 void scr_tab (int count, bool ht = false) NOTHROW;
1337 void scr_gotorc (int row, int col, int relative) NOTHROW;
1338 void scr_index (enum page_dirn direction) NOTHROW;
1339 void scr_erase_line (int mode) NOTHROW;
1340 void scr_E () NOTHROW;
1341 void scr_insdel_lines (int count, int insdel) NOTHROW;
1342 void scr_insdel_chars (int count, int insdel) NOTHROW;
1343 void scr_scroll_region (int top, int bot) NOTHROW;
1344 void scr_cursor_visible (int mode) NOTHROW;
1345 void scr_autowrap (int mode) NOTHROW;
1346 void scr_relative_origin (int mode) NOTHROW;
1347 void scr_insert_mode (int mode) NOTHROW;
1348 void scr_set_tab (int mode) NOTHROW;
1349 void scr_rvideo_mode (bool on) NOTHROW;
1350 void scr_report_position () NOTHROW;
1351 void set_font_style () NOTHROW;
1352 void scr_charset_choose (int set) NOTHROW;
1353 void scr_charset_set (int set, unsigned int ch) NOTHROW;
1354 void scr_move_to (int y, int len) NOTHROW;
1355 bool scr_page (enum page_dirn direction, int nlines) NOTHROW;
1356 bool scr_changeview (int new_view_start) NOTHROW;
1357 void scr_bell () NOTHROW;
1358 void scr_printscreen (int fullhist) NOTHROW;
1359 void scr_xor_rect (int beg_row, int beg_col, int end_row, int end_col, rend_t rstyle1, rend_t rstyle2) NOTHROW;
1360 void scr_xor_span (int beg_row, int beg_col, int end_row, int end_col, rend_t rstyle) NOTHROW;
1361 void scr_reverse_selection () NOTHROW;
1362 void scr_dump (int fd) NOTHROW;
1364 void selection_check (int check_more) NOTHROW;
1365 void selection_paste (Window win, Atom prop, bool delete_prop) NOTHROW;
1366 void selection_property (Window win, Atom prop) NOTHROW;
1367 void selection_request (Time tm, int selnum = Sel_Primary) NOTHROW;
1368 int selection_request_other (Atom target, int selnum) NOTHROW;
1369 void selection_clear () NOTHROW;
1370 void selection_make (Time tm);
1371 bool selection_grab (Time tm) NOTHROW;
1372 void selection_start_colrow (int col, int row) NOTHROW;
1373 void selection_delimit_word (enum page_dirn dirn, const row_col_t *mark, row_col_t *ret) NOTHROW;
1374 void selection_extend_colrow (int32_t col, int32_t row, int button3, int buttonpress, int clickchange) NOTHROW;
1375 void selection_remove_trailing_spaces () NOTHROW;
1376 void selection_send (const XSelectionRequestEvent &rq) NOTHROW;
1377 void selection_click (int clicks, int x, int y) NOTHROW;
1378 void selection_extend (int x, int y, int flag) NOTHROW;
1379 void selection_rotate (int x, int y) NOTHROW;
1381 #if defined(NEXT_SCROLLBAR)
1383 Pixmap renderPixmap (const char *const *data, int width, int height);
1384 void init_scrollbar_stuff ();
1385 void drawBevel (Drawable d, int x1, int y1, int w, int h);
1386 int scrollbar_show_next (int update, int last_top, int last_bot, int scrollbar_len);
1389 #if defined(RXVT_SCROLLBAR)
1391 int scrollbar_show_rxvt (int update, int last_top, int last_bot, int scrollbar_len);
1394 #if defined(XTERM_SCROLLBAR)
1395 // scrollbar-xterm.C
1396 int scrollbar_show_xterm (int update, int last_top, int last_bot, int scrollbar_len);
1399 #if defined(PLAIN_SCROLLBAR)
1400 // scrollbar-plain.C
1401 int scrollbar_show_plain (int update, int last_top, int last_bot, int scrollbar_len);
1405 void resize_scrollbar ();
1406 int scrollbar_mapping (int map);
1407 int scrollbar_show (int update);
1408 void setup_scrollbar (const char *scrollalign, const char *scrollstyle, const char *thickness);
1411 void get_options (int argc, const char *const *argv);
1412 int parse_keysym (const char *str, const char *arg);
1413 const char *x_resource (const char *name);
1414 void extract_resources ();
1417 #endif /* _RXVT_H_ */