1 #ifndef RXVT_H_ /* include once only */
12 #include <sys/types.h>
16 #ifdef HAVE_SYS_IOCTL_H
17 #include <sys/ioctl.h>
19 #ifdef HAVE_SYS_STRREDIR_H
20 #include <sys/strredir.h>
28 // stdlib.h might provide it
35 #include <X11/Xutil.h>
36 #include <X11/Xresource.h>
40 typedef uint32_t text_t;
42 typedef uint16_t text_t; // saves lots of memory
44 typedef uint32_t rend_t;
45 typedef int32_t tlen_t; // was int16_t, but this results in smaller code and memory use
46 typedef int32_t tlen_t_; // specifically for use in the line_t structure
50 #if defined (ISO_14755) || defined (ENABLE_PERL)
51 # define ENABLE_OVERLAY 1
55 # define ENABLE_FRILLS 1
56 # define ENABLE_COMBINING 1
60 # define ENABLE_XEMBED 1
61 # define ENABLE_EWMH 1
62 # define ENABLE_XIM_ONTHESPOT 1
63 # define CURSOR_BLINK 1
65 # define BUILTIN_GLYPHS 1
67 # define ENABLE_MINIMAL 1
72 #include <X11/cursorfont.h>
73 #include <X11/keysym.h>
74 #include <X11/keysymdef.h>
75 #include <X11/Xatom.h>
80 #include "rxvttoolkit.h"
81 #include "scrollbar.h"
84 #include "libptytty.h"
88 // try to avoid some macros to decrease code size, on some systems
90 # define strcmp(a,b) (strcmp)(a,b)
91 # define strlen(a) (strlen)(a)
92 # define strcpy(a,b) (strcpy)(a,b)
93 # define memset(a,c,l) (memset)(a,c,l)
94 # define memcpy(a,b,l) (memcpy)(a,b,l)
98 *****************************************************************************
100 *****************************************************************************
103 #ifndef HAVE_XPOINTER
104 typedef char *XPointer;
109 #include "background.h"
112 # define STDIN_FILENO 0
113 # define STDOUT_FILENO 1
114 # define STDERR_FILENO 2
117 #ifndef EXIT_SUCCESS /* missing from <stdlib.h> */
118 # define EXIT_SUCCESS 0 /* exit function success */
119 # define EXIT_FAILURE 1 /* exit function failure */
123 # define PATH_MAX 16384
126 /****************************************************************************/
128 // exception thrown on fatal (per-instance) errors
129 class rxvt_failure_exception { };
131 // exception thrown when the command parser runs out of input data
132 class out_of_input { };
135 *****************************************************************************
137 *****************************************************************************
140 #define SET_LOCALE(locale) rxvt_set_locale (locale)
141 extern bool rxvt_set_locale (const char *locale) NOTHROW;
142 extern void rxvt_push_locale (const char *locale) NOTHROW;
143 extern void rxvt_pop_locale () NOTHROW;
147 char * rxvt_wcstombs (const wchar_t *str, int len = -1);
148 wchar_t * rxvt_mbstowcs (const char *str, int len = -1);
149 char * rxvt_wcstoutf8 (const wchar_t *str, int len = -1);
150 wchar_t * rxvt_utf8towcs (const char *str, int len = -1);
152 const char * rxvt_basename (const char *str) NOTHROW;
153 void rxvt_vlog (const char *fmt, va_list arg_ptr) NOTHROW;
154 void rxvt_log (const char *fmt,...) NOTHROW;
155 void rxvt_warn (const char *fmt,...) NOTHROW;
156 void rxvt_fatal (const char *fmt, ...) THROW ((class rxvt_failure_exception)) NORETURN;
157 void rxvt_exit_failure () THROW ((class rxvt_failure_exception)) NORETURN;
159 char * rxvt_strtrim (char *str) NOTHROW;
160 char ** rxvt_splitcommastring (const char *cs) NOTHROW;
161 void rxvt_freecommastring (char **cs) NOTHROW;
163 void * rxvt_malloc (size_t size);
164 void * rxvt_calloc (size_t number, size_t size);
165 void * rxvt_realloc (void *ptr, size_t size);
167 /////////////////////////////////////////////////////////////////////////////
169 // temporarily replace the process environment
170 extern char **environ;
171 extern char **rxvt_environ; // the original environ pointer
174 set_environ (stringvec *envv)
181 environ = (char **)envv->begin ();
185 set_environ (char **envv)
196 *****************************************************************************
197 * STRUCTURES AND TYPEDEFS
198 *****************************************************************************
202 * the 'essential' information for reporting Mouse Events
203 * pared down from XButtonEvent
208 Time time; /* milliseconds */
209 unsigned int state; /* key or button mask */
210 unsigned int button; /* detail */
215 # define XEMBED_EMBEDDED_NOTIFY 0
216 # define XEMBED_WINDOW_ACTIVATE 1
217 # define XEMBED_WINDOW_DEACTIVATE 2
218 # define XEMBED_REQUEST_FOCUS 3
219 # define XEMBED_FOCUS_IN 4
220 # define XEMBED_FOCUS_OUT 5
221 # define XEMBED_FOCUS_NEXT 6
222 # define XEMBED_FOCUS_PREV 7
224 # define XEMBED_MODALITY_ON 10
225 # define XEMBED_MODALITY_OFF 11
226 # define XEMBED_REGISTER_ACCELERATOR 12
227 # define XEMBED_UNREGISTER_ACCELERATOR 13
228 # define XEMBED_ACTIVATE_ACCELERATOR 14
230 // XEMBED detail code
231 # define XEMBED_FOCUS_CURRENT 0
232 # define XEMBED_FOCUS_FIRST 1
233 # define XEMBED_FOCUS_LAST 2
235 # define XEMBED_MAPPED (1 << 0)
239 *****************************************************************************
241 *****************************************************************************
244 /* COLORTERM, TERM environment variables */
245 #define COLORTERMENV "rxvt"
246 #ifdef BG_IMAGE_FROM_FILE
247 # define COLORTERMENVFULL COLORTERMENV "-xpm"
249 # define COLORTERMENVFULL COLORTERMENV
252 # define TERMENV "rxvt-unicode"
255 #if defined (NO_MOUSE_REPORT) && !defined (NO_MOUSE_REPORT_SCROLLBAR)
256 # define NO_MOUSE_REPORT_SCROLLBAR 1
259 #define scrollBar_esc 30
261 #if !defined (RXVT_SCROLLBAR) && !defined (NEXT_SCROLLBAR)
262 # define NO_SCROLLBAR_BUTTON_CONTINUAL_SCROLLING 1
266 NO_REFRESH = 0, /* Window not visible at all! */
267 FAST_REFRESH = 1, /* Fully exposed window */
268 SLOW_REFRESH = 2, /* Partially exposed window */
271 #ifdef NO_SECONDARY_SCREEN
277 /* special (internal) prefix for font commands */
282 /* flags for rxvt_scr_gotorc () */
284 C_RELATIVE = 1, /* col movement is relative */
285 R_RELATIVE = 2, /* row movement is relative */
286 RELATIVE = C_RELATIVE | R_RELATIVE,
289 /* modes for rxvt_scr_insdel_chars (), rxvt_scr_insdel_lines () */
291 INSERT = -1, /* don't change these values */
296 /* modes for rxvt_scr_page () - scroll page. used by scrollbar window */
303 /* arguments for rxvt_scr_change_screen () */
309 // define various rendition bits and masks. the rendition word
310 // is 32 bits in size, and we should use it as efficiently as possible
314 // GET_BGATTR depends on RS_fgShift > RS_bgShift
315 #define RS_colorMask ((1UL << Color_Bits) - 1UL)
317 #define RS_fgShift (RS_bgShift + Color_Bits)
318 #define RS_bgMask (RS_colorMask << RS_bgShift)
319 #define RS_fgMask (RS_colorMask << RS_fgShift)
321 // must have space for rxvt_fontset::fontCount * 2 + 2 values
322 #define RS_fontShift (RS_fgShift + Color_Bits)
323 #define RS_Careful (1UL << RS_fontShift) /* be careful when drawing these */
324 #define RS_fontMask ((rxvt_fontset::fontCount << (RS_fontShift + 1)) | RS_Careful) // includes RS_Careful
326 // toggle this to force redraw, must be != RS_Careful and otherwise "pretty neutral"
327 #define RS_redraw (2UL << RS_fontShift)
329 // 5 custom bits for extensions
330 #define RS_customCount 16UL
331 #define RS_customShift 23
332 #define RS_customMask ((RS_customCount - 1UL) << RS_customShift)
335 #define RS_Bold (1UL << RS_styleShift)
336 #define RS_Italic (2UL << RS_styleShift)
338 #define RS_styleCount 4
339 #define RS_styleShift 27
340 #define RS_styleMask (RS_Bold | RS_Italic)
343 #define RS_Blink (1UL << 29)
344 #define RS_RVid (1UL << 30) // reverse video
345 #define RS_Uline (1UL << 31) // underline
347 #define RS_baseattrMask (RS_Italic | RS_Bold | RS_Blink | RS_RVid | RS_Uline)
348 #define RS_attrMask (RS_baseattrMask | RS_fontMask)
350 #define DEFAULT_RSTYLE (RS_None | (Color_fg << RS_fgShift) | (Color_bg << RS_bgShift))
351 #define OVERLAY_RSTYLE (RS_None | (Color_Black << RS_fgShift) | (Color_Yellow << RS_bgShift))
353 #define Sel_none 0 /* Not waiting */
354 #define Sel_normal 0x01 /* normal selection */
355 #define Sel_incr 0x02 /* incremental selection */
356 #define Sel_direct 0x00
357 #define Sel_Primary 0x01
358 #define Sel_Secondary 0x02
359 #define Sel_Clipboard 0x03
360 #define Sel_whereMask 0x0f
361 #define Sel_CompoundText 0x10 /* last request was COMPOUND_TEXT */
362 #define Sel_UTF8String 0x20 /* last request was UTF8_STRING */
366 C0_SOH, C0_STX, C0_ETX, C0_EOT, C0_ENQ, C0_ACK, C0_BEL,
367 C0_BS , C0_HT , C0_LF , C0_VT , C0_FF , C0_CR , C0_SO , C0_SI ,
368 C0_DLE, C0_DC1, C0_DC2, D0_DC3, C0_DC4, C0_NAK, C0_SYN, C0_ETB,
369 C0_CAN, C0_EM , C0_SUB, C0_ESC, C0_IS4, C0_IS3, C0_IS2, C0_IS1,
371 #define CHAR_ST 0x9c /* 0234 */
374 * XTerm Operating System Commands: ESC ] Ps;Pt (ST|BEL)
375 * colour extensions by Christian W. Zuckschwerdt <zany@triq.net>
381 XTerm_property = 3, // change X property
382 XTerm_Color = 4, // change colors
383 XTerm_Color00 = 10, // change fg color
384 XTerm_Color01 = 11, // change bg color
385 XTerm_Color_cursor = 12, // change actual 'Cursor' color
386 XTerm_Color_pointer_fg = 13, // change actual 'Pointer' fg color
387 XTerm_Color_pointer_bg = 14, // change actual 'Pointer' bg color
388 XTerm_Color05 = 15, // not implemented (tektronix fg)
389 XTerm_Color06 = 16, // not implemented (tektronix bg)
390 XTerm_Color_RV = 17, // change actual 'Highlight' color
391 XTerm_logfile = 46, // not implemented
394 XTerm_konsole30 = 30, // reserved for konsole
395 XTerm_konsole31 = 31, // reserved for konsole
396 XTerm_emacs51 = 51, // reserved for emacs shell
398 * rxvt extensions of XTerm OSCs: ESC ] Ps;Pt (ST|BEL)
407 Rxvt_Pixmap = 20, // new bg pixmap
408 Rxvt_dumpscreen = 55, // dump scrollback and all of screen
410 URxvt_locale = 701, // change locale
411 URxvt_version = 702, // request version
413 URxvt_Color_IT = 704, // change actual 'Italic' colour
414 URxvt_Color_tint = 705, // change actual tint colour
415 URxvt_Color_BD = 706, // change actual 'Bold' color
416 URxvt_Color_UL = 707, // change actual 'Underline' color
417 URxvt_Color_border = 708,
420 URxvt_boldFont = 711,
421 URxvt_italicFont = 712,
422 URxvt_boldItalicFont = 713,
425 URxvt_view_down = 721,
427 URxvt_perl = 777, // for use by perl extensions, starts with "extension-name;"
430 /* Words starting with `Color_' are colours. Others are counts */
432 * The PixColor and rendition colour usage should probably be decoupled
433 * on the unnecessary items, e.g. Color_pointer, but won't bother
434 * until we need to. Also, be aware of usage in pixcolor_set
439 Color_transparent = -1,
443 Color_Black = minCOLOR,
450 maxCOLOR, /* minCOLOR + 7 */
451 #ifndef NO_BRIGHTCOLOR
452 Color_AntiqueWhite = maxCOLOR,
453 minBrightCOLOR, /* maxCOLOR + 1 */
454 Color_Grey25 = minBrightCOLOR,
461 maxBrightCOLOR, /* minBrightCOLOR + 7 */
462 Color_White = maxBrightCOLOR,
464 Color_White = maxCOLOR,
466 minTermCOLOR = Color_White + 1,
467 #ifndef USE_256_COLORS
468 maxTermCOLOR = Color_White + 72,
470 maxTermCOLOR = Color_White + 240,
472 #ifndef NO_CURSORCOLOR
479 #ifndef NO_BOLD_UNDERLINE_REVERSE
492 #ifdef RXVT_SCROLLBAR
495 #if ENABLE_TRANSPARENCY
502 #ifdef RXVT_SCROLLBAR
503 Color_topShadow = NRS_COLORS,
507 TOTAL_COLORS = NRS_COLORS
511 #ifndef USE_256_COLORS
512 #define Color_Bits 7 // 0 .. maxTermCOLOR
514 #define Color_Bits 9 // 0 .. maxTermCOLOR
521 # define def(name) Rs_ ## name,
522 # define reserve(name,count) Rs_ ## name ## _ = Rs_ ## name + (count) - 1,
529 /* DEC private modes */
530 #define PrivMode_132 (1UL<<0)
531 #define PrivMode_132OK (1UL<<1)
532 #define PrivMode_rVideo (1UL<<2)
533 #define PrivMode_relOrigin (1UL<<3)
534 #define PrivMode_Screen (1UL<<4)
535 #define PrivMode_Autowrap (1UL<<5)
536 #define PrivMode_aplCUR (1UL<<6)
537 #define PrivMode_aplKP (1UL<<7)
538 #define PrivMode_HaveBackSpace (1UL<<8)
539 #define PrivMode_BackSpace (1UL<<9)
540 #define PrivMode_ShiftKeys (1UL<<10)
541 #define PrivMode_VisibleCursor (1UL<<11)
542 #define PrivMode_MouseX10 (1UL<<12)
543 #define PrivMode_MouseX11 (1UL<<13)
544 #define PrivMode_scrollBar (1UL<<14)
545 #define PrivMode_TtyOutputInh (1UL<<15)
546 #define PrivMode_Keypress (1UL<<16)
547 #define PrivMode_smoothScroll (1UL<<17)
548 #define PrivMode_vt52 (1UL<<18)
549 #define PrivMode_LFNL (1UL<<19)
550 #define PrivMode_MouseBtnEvent (1UL<<20)
551 #define PrivMode_MouseAnyEvent (1UL<<21)
552 #define PrivMode_BracketPaste (1UL<<22)
554 #define PrivMode_mouse_report (PrivMode_MouseX10|PrivMode_MouseX11|PrivMode_MouseBtnEvent|PrivMode_MouseAnyEvent)
556 #ifdef ALLOW_132_MODE
557 # define PrivMode_Default (PrivMode_Autowrap|PrivMode_ShiftKeys|PrivMode_VisibleCursor|PrivMode_132OK)
559 # define PrivMode_Default (PrivMode_Autowrap|PrivMode_ShiftKeys|PrivMode_VisibleCursor)
562 // do not change these constants lightly, there are many interdependencies
563 #define IMBUFSIZ 128 // input modifier buffer sizes
564 #define KBUFSZ 512 // size of keyboard mapping buffer
565 #define CBUFSIZ 2048 // size of command buffer
566 #define CBUFCNT 8 // never call pty_fill/cmd_parse more than this often in a row
567 #define UBUFSIZ 2048 // character buffer
570 # include <X11/Xmd.h>
571 typedef struct _mwmhints
581 /* Motif window hints */
582 #define MWM_HINTS_FUNCTIONS (1L << 0)
583 #define MWM_HINTS_DECORATIONS (1L << 1)
584 #define MWM_HINTS_INPUT_MODE (1L << 2)
585 #define MWM_HINTS_STATUS (1L << 3)
586 /* bit definitions for MwmHints.functions */
587 #define MWM_FUNC_ALL (1L << 0)
588 #define MWM_FUNC_RESIZE (1L << 1)
589 #define MWM_FUNC_MOVE (1L << 2)
590 #define MWM_FUNC_MINIMIZE (1L << 3)
591 #define MWM_FUNC_MAXIMIZE (1L << 4)
592 #define MWM_FUNC_CLOSE (1L << 5)
593 /* bit definitions for MwmHints.decorations */
594 #define MWM_DECOR_ALL (1L << 0)
595 #define MWM_DECOR_BORDER (1L << 1)
596 #define MWM_DECOR_RESIZEH (1L << 2)
597 #define MWM_DECOR_TITLE (1L << 3)
598 #define MWM_DECOR_MENU (1L << 4)
599 #define MWM_DECOR_MINIMIZE (1L << 5)
600 #define MWM_DECOR_MAXIMIZE (1L << 6)
601 /* bit definitions for MwmHints.inputMode */
602 #define MWM_INPUT_MODELESS 0
603 #define MWM_INPUT_PRIMARY_APPLICATION_MODAL 1
604 #define MWM_INPUT_SYSTEM_MODAL 2
605 #define MWM_INPUT_FULL_APPLICATION_MODAL 3
606 #define PROP_MWM_HINTS_ELEMENTS 5
609 *****************************************************************************
611 *****************************************************************************
613 #define dLocal(type,name) type const name = this->name
615 // for speed reasons, we assume that all codepoints 32 to 126 are
617 #define WCWIDTH(c) (IN_RANGE_INC (c, 0x20, 0x7e) ? 1 : wcwidth (c))
619 /* convert pixel dimensions to row/column values. Everything as int32_t */
620 #define Pixel2Col(x) Pixel2Width((int32_t)(x))
621 #define Pixel2Row(y) Pixel2Height((int32_t)(y))
622 #define Pixel2Width(x) ((int32_t)(x) / (int32_t)fwidth)
623 #define Pixel2Height(y) ((int32_t)(y) / (int32_t)fheight)
624 #define Col2Pixel(col) ((int32_t)Width2Pixel(col))
625 #define Row2Pixel(row) ((int32_t)Height2Pixel(row))
626 #define Width2Pixel(n) ((int32_t)(n) * (int32_t)fwidth)
627 #define Height2Pixel(n) ((int32_t)(n) * (int32_t)fheight)
629 #define LINENO_of(t,n) MOD ((t)->term_start + int(n), (t)->total_rows)
630 #define ROW_of(t,n) (t)->row_buf [LINENO_of ((t), n)]
632 #define LINENO(n) LINENO_of (this, n)
633 #define ROW(n) ROW_of (this, n)
635 /* how to build & extract colors and attributes */
636 #define GET_BASEFG(x) (((x) & RS_fgMask) >> RS_fgShift)
637 #define GET_BASEBG(x) (((x) & RS_bgMask) >> RS_bgShift)
639 #define GET_FONT(x) (((x) & RS_fontMask) >> RS_fontShift)
640 #define SET_FONT(x,fid) (((x) & ~RS_fontMask) | ((fid) << RS_fontShift))
642 #define GET_STYLE(x) (((x) & RS_styleMask) >> RS_styleShift)
643 #define SET_STYLE(x,style) (((x) & ~RS_styleMask) | ((style) << RS_styleShift))
645 #define GET_ATTR(x) (((x) & RS_attrMask))
646 // return attributes defining the background, encoding doesn't matter
647 // depends on RS_fgShift > RS_bgShift
648 #define GET_BGATTR(x) \
649 (expect_false ((x) & RS_RVid) \
650 ? (((x) & (RS_attrMask & ~RS_RVid)) \
651 | (((x) & RS_fgMask) >> (RS_fgShift - RS_bgShift))) \
652 : ((x) & (RS_attrMask | RS_bgMask)))
653 #define SET_FGCOLOR(x,fg) (((x) & ~RS_fgMask) | ((fg) << RS_fgShift))
654 #define SET_BGCOLOR(x,bg) (((x) & ~RS_bgMask) | ((bg) << RS_bgShift))
655 #define SET_ATTR(x,a) (((x) & ~RS_attrMask) | (a))
657 #define RS_SAME(a,b) (!(((a) ^ (b)) & ~RS_Careful))
659 #define PIXCOLOR_NAME(idx) rs[Rs_color + (idx)]
660 #define ISSET_PIXCOLOR(idx) (!!rs[Rs_color + (idx)])
663 # define FONTSET_of(t,style) (t)->fontset[GET_STYLE (style)]
665 # define FONTSET_of(t,style) (t)->fontset[0]
668 #define FONTSET(style) FONTSET_of (this, style)
670 typedef callback<void (const char *)> log_callback;
671 typedef callback<int (int)> getfd_callback;
673 /****************************************************************************/
675 #define LINE_LONGER 0x0001 // line is continued on the next row
676 #define LINE_FILTERED 0x0002 // line has been filtered
677 #define LINE_COMPRESSED 0x0004 // line has been compressed (NYI)
678 #define LINE_FILTER 0x0008 // line needs to be filtered before display (NYI)
679 #define LINE_BIDI 0x0010 // line needs bidi (NYI)
683 text_t *t; // terminal the text
684 rend_t *r; // rendition, uses RS_ flags
685 tlen_t_ l; // length of each text line
690 return f & LINE_LONGER;
693 void is_longer (int set)
709 void touch () // call whenever a line is changed/touched/updated
723 /****************************************************************************/
725 // primitive wrapper around mbstate_t to ensure initialisation
730 operator mbstate_t *() { return &mbs; }
731 void reset () { memset (&mbs, 0, sizeof (mbs)); }
732 mbstate () { reset (); }
735 /****************************************************************************/
737 #define UNICODE_MASK 0x1fffffUL
740 # define COMPOSE_LO 0x40000000UL
741 # define COMPOSE_HI 0x400fffffUL
742 # define IS_COMPOSE(n) ((int32_t)(n) >= COMPOSE_LO)
745 # define COMPOSE_LO 0xe000UL // our _own_ functions don't like (illegal) surrogates
746 # define COMPOSE_HI 0xf8ffUL // in utf-8, so use private use area only
748 # define COMPOSE_LO 0xd800UL
749 # define COMPOSE_HI 0xf8ffUL
751 # define IS_COMPOSE(n) IN_RANGE_INC ((n), COMPOSE_LO, COMPOSE_HI)
755 // compose chars are used to represent composite characters
756 // that are not representable in unicode, as well as characters
757 // not fitting in the BMP.
760 unicode_t c1, c2; // any chars != NOCHAR are valid
761 compose_char (unicode_t c1, unicode_t c2)
766 class rxvt_composite_vec
768 vector<compose_char> v;
770 text_t compose (unicode_t c1, unicode_t c2 = NOCHAR);
771 int expand (unicode_t c, wchar_t *r);
772 compose_char *operator [](text_t c)
774 return c >= COMPOSE_LO && c < COMPOSE_LO + v.size ()
780 extern class rxvt_composite_vec rxvt_composite;
783 /****************************************************************************/
785 #ifdef KEYSYM_RESOURCE
786 class keyboard_manager;
789 typedef struct rxvt_term *rxvt_t;
791 extern rxvt_t rxvt_current_term;
793 #define SET_R(r) rxvt_current_term = const_cast<rxvt_term *>(r)
794 #define GET_R rxvt_current_term
796 /* ------------------------------------------------------------------------- */
799 int x, y, w, h; // overlay dimensions
803 // while tempting to add swap() etc. here, it effetcively only increases code size
806 /* ------------------------------------------------------------------------- */
818 * height : 1 <= height
819 * ncol : 1 <= ncol <= MAX(tlen_t)
820 * nrow : 1 <= nrow <= MAX(int)
821 * saveLines : 0 <= saveLines <= MAX(int)
822 * term_start : 0 <= term_start < saveLines
823 * total_rows : nrow + saveLines
825 * top_row : -saveLines <= top_row <= 0
826 * view_start : top_row <= view_start <= 0
828 * | most coordinates are stored relative to term_start,
829 * ROW_BUF | which is the first line of the terminal screen
830 * |························= row_buf[0]
831 * |························= row_buf[1]
832 * |························= row_buf[2] etc.
834 * +------------+···········= term_start + top_row
836 * | scrollback +---------+·= term_start + view_start
837 * | scrollback | display |
838 * | scrollback | display |
839 * +------------+·display·+·= term_start
840 * | terminal | display |
841 * | terminal +---------+
844 * +------------+···········= term_start + nrow - 1
847 * END······················= total_rows
852 int width; /* window width [pixels] */
853 int height; /* window height [pixels] */
854 int fwidth; /* font width [pixels] */
855 int fheight; /* font height [pixels] */
856 int fbase; /* font ascent (baseline) [pixels] */
857 int ncol; /* window columns [characters] */
858 int nrow; /* window rows [characters] */
859 int focus; /* window has focus */
860 int mapped; /* window state mapped? */
861 int int_bwidth; /* internal border width */
862 int ext_bwidth; /* external border width */
863 int lineSpace; /* number of extra pixels between rows */
864 int letterSpace; /* number of extra pixels between columns */
865 int saveLines; /* number of lines that fit in scrollback */
866 int total_rows; /* total number of rows in this terminal */
867 int term_start; /* term lines start here */
868 int view_start; /* scrollback view starts here */
869 int top_row; /* topmost row index of scrollback */
870 Window parent[6]; /* parent identifiers - we're parent[0] */
871 Window vt; /* vt100 window */
872 GC gc; /* GC for drawing */
874 rxvt_drawable *drawable;
875 rxvt_fontset *fontset[4];
881 * row: Cursor row position : 0 <= row < nrow
882 * col: Cursor column position : 0 <= col < ncol
883 * tscroll: Scrolling region top row inclusive : 0 <= row < nrow
884 * bscroll: Scrolling region bottom row inclusive : 0 <= row < nrow
886 * selection_t elements
887 * clicks: 1, 2 or 3 clicks - 4 indicates a special condition of 1 where
888 * nothing is selected
889 * beg: row/column of beginning of selection : never past mark
890 * mark: row/column of initial click : never past end
891 * end: row/column of one character past end of selection
892 * * Note: top_row <= beg.row <= mark.row <= end.row < nrow
893 * * Note: col == -1 ==> we're left of screen
898 row_col_t cur; /* cursor position on the screen */
899 int tscroll; /* top of settable scroll region */
900 int bscroll; /* bottom of settable scroll region */
901 unsigned int charset; /* character set number [0..3] */
902 unsigned int flags; /* see below */
903 row_col_t s_cur; /* saved cursor position */
904 unsigned int s_charset; /* saved character set number [0..3] */
906 rend_t s_rstyle; /* saved rendition style */
911 SELECTION_CLEAR = 0, /* nothing selected */
912 SELECTION_INIT, /* marked a point */
913 SELECTION_BEGIN, /* started a selection */
914 SELECTION_CONT, /* continued selection */
915 SELECTION_DONE /* selection put in CUT_BUFFER0 */
920 wchar_t *text; /* selected text */
921 unsigned int len; /* length of selected text */
922 unsigned int screen; /* screen being used */
923 unsigned int clicks; /* number of clicks */
924 selection_op_t op; /* current operation */
925 bool rect; /* rectangular selection? */
926 row_col_t beg; /* beginning of selection <= mark */
927 row_col_t mark; /* point of initial click <= end */
928 row_col_t end; /* one character past end point */
929 wchar_t *clip_text; /* text copied to the clipboard */
930 unsigned int clip_len; /* length of clipboard text */
933 /* ------------------------------------------------------------------------- */
936 #define Screen_Relative (1<<0) /* relative origin mode flag */
937 #define Screen_VisibleCursor (1<<1) /* cursor visible? */
938 #define Screen_Autowrap (1<<2) /* auto-wrap flag */
939 #define Screen_Insert (1<<3) /* insert mode (vs. overstrike) */
940 #define Screen_WrapNext (1<<4) /* need to wrap for next char? */
941 #define Screen_DefaultFlags (Screen_VisibleCursor | Screen_Autowrap)
943 /* rxvt_vars.options */
945 # define def(name,idx) Opt_ ## name = idx,
946 # define nodef(name) Opt_ ## name = 0,
953 /* ------------------------------------------------------------------------- */
955 struct rxvt_vars : TermWin_t
957 scrollBar_t scrollBar;
958 uint8_t options[(Opt_count + 7) >> 3];
960 rxvt_color *pix_colors;
961 Cursor TermWin_cursor; /* cursor for vt window */
963 line_t *row_buf; // all lines, scrollback + terminal, circular, followed by temp_buf
964 line_t *drawn_buf; // text on screen
965 line_t *swap_buf; // lines for swap buffer
966 char *tabs; /* per location: 1 == tab-stop */
969 selection_t selection;
970 rxvt_color pix_colors_focused[TOTAL_COLORS];
971 #ifdef OFF_FOCUS_FADING
972 rxvt_color pix_colors_unfocused[TOTAL_COLORS];
976 struct rxvt_term : zero_initialized, rxvt_vars, rxvt_screen
979 // special markers with magic addresses
980 static const char resval_undef []; // options specifically unset
981 static const char resval_on []; // boolean options switched on
982 static const char resval_off []; // or off
984 log_callback *log_hook; // log error messages through this hook, if != 0
985 getfd_callback *getfd_hook; // convert remote to local fd, if != 0
989 struct mbstate mbstate; // current input multibyte state
991 unsigned char want_refresh:1,
992 current_screen:1, /* primary or secondary */
1007 enc_utf8:1, /* whether locale uses utf-8 */
1008 seen_input:1, /* whether we have seen some program output yet */
1009 seen_resize:1, /* whether we had a resize event */
1012 unsigned char refresh_type,
1014 meta_char, /* Alt-key prefix */
1019 bool rvideo_state, rvideo_mode;
1023 int num_scr; /* screen: number of lines scrolled */
1024 int prev_ncol, /* screen: previous number of columns */
1025 prev_nrow; /* screen: previous number of rows */
1029 #ifdef SELECTION_SCROLLING
1030 int scroll_selection_lines;
1031 enum page_dirn scroll_selection_dir;
1032 int selection_save_x,
1034 selection_save_state;
1037 int csrO, /* Hops - csr offset in thumb/slider to */
1038 /* give proper Scroll behaviour */
1039 #if defined(MOUSE_WHEEL) && defined(MOUSE_SLIP_WHEELING)
1040 mouse_slip_wheel_speed,
1047 # ifdef POINTER_BLANK
1052 unsigned int ModLevel3Mask,
1055 int old_width, /* last used width in screen resize */
1056 old_height; /* last used height in screen resize */
1057 unsigned long priv_modes,
1062 Time selection_time,
1063 selection_request_time,
1065 pid_t cmd_pid; /* process id of child */
1067 size_t incr_buf_size, incr_buf_fill;
1069 struct mouse_event MEvent;
1070 XComposeStatus compose;
1072 row_col_t oldcursor;
1073 #ifdef HAVE_BG_PIXMAP
1074 bgPixmap_t bgPixmap;
1076 #ifdef HAVE_AFTERIMAGE
1078 ASImageManager *asimman;
1083 asv = create_asvisual_for_id (dpy, display->screen, depth, XVisualIDFromVisual (visual), cmap, NULL);
1090 void scr_swap_overlay () NOTHROW;
1091 void scr_overlay_new (int x, int y, int w, int h) NOTHROW;
1092 void scr_overlay_off () NOTHROW;
1093 void scr_overlay_set (int x, int y,
1095 rend_t rend = OVERLAY_RSTYLE) NOTHROW;
1096 void scr_overlay_set (int x, int y, const char *s) NOTHROW;
1097 void scr_overlay_set (int x, int y, const wchar_t *s) NOTHROW;
1100 vector<void *> allocated; // free these memory blocks with free()
1102 char env_windowid[21]; /* environmental variable WINDOWID */
1103 char env_colorfgbg[sizeof ("COLORFGBG=default;default;bg") + 1];
1104 char *env_display; /* environmental variable DISPLAY */
1105 char *env_term; /* environmental variable TERM */
1109 char *v_buffer; /* pointer to physical buffer */
1110 unsigned int v_buflen; /* size of area to write */
1111 stringvec *argv, *envv; /* if != 0, will be freed at destroy time */
1113 #ifdef KEYSYM_RESOURCE
1114 keyboard_manager *keyboard;
1116 #ifndef NO_RESOURCES
1117 XrmDatabase option_db;
1120 const char *rs[NUM_RESOURCES];
1121 /* command input buffering */
1122 char *cmdbuf_ptr, *cmdbuf_endp;
1123 char cmdbuf_base[CBUFSIZ];
1127 rxvt_salloc *talloc; // text line allocator
1128 rxvt_salloc *ralloc; // rend line allocator
1130 static vector<rxvt_term *> termlist; // a vector of all running rxvt_term's
1132 #if ENABLE_FRILLS || ISO_14755
1133 // ISO 14755 entry support
1134 unicode_t iso14755buf;
1135 void commit_iso14755 ();
1137 void iso14755_51 (unicode_t ch, rend_t r = DEFAULT_RSTYLE, int x = 0, int y = -1);
1138 void iso14755_54 (int x, int y);
1142 long vt_emask, vt_emask_perl, vt_emask_xim, vt_emask_mouse;
1144 void vt_select_input () const NOTHROW
1146 XSelectInput (dpy, vt, vt_emask | vt_emask_perl | vt_emask_xim | vt_emask_mouse);
1149 #if ENABLE_TRANSPARENCY || ENABLE_PERL
1150 void rootwin_cb (XEvent &xev);
1151 xevent_watcher rootwin_ev;
1153 #ifdef HAVE_BG_PIXMAP
1154 void update_background ();
1156 void trace_update_background (const char *file, int line);
1157 # define update_background() trace_update_background (__FILE__, __LINE__)
1159 void update_background_cb (ev::timer &w, int revents);
1160 ev::timer update_background_ev;
1163 void x_cb (XEvent &xev);
1164 xevent_watcher termwin_ev;
1165 xevent_watcher vt_ev;
1166 xevent_watcher scrollbar_ev;
1168 void child_cb (ev::child &w, int revents); ev::child child_ev;
1169 void destroy_cb (ev::idle &w, int revents); ev::idle destroy_ev;
1170 void refresh_check ();
1172 void flush_cb (ev::timer &w, int revents); ev::timer flush_ev;
1174 void pty_cb (ev::io &w, int revents); ev::io pty_ev;
1175 void incr_cb (ev::timer &w, int revents) NOTHROW; ev::timer incr_ev;
1178 void cursor_blink_cb (ev::timer &w, int revents); ev::timer cursor_blink_ev;
1181 void text_blink_cb (ev::timer &w, int revents); ev::timer text_blink_ev;
1184 void bell_cb (ev::timer &w, int revents); ev::timer bell_ev;
1187 #ifndef NO_SCROLLBAR_BUTTON_CONTINUAL_SCROLLING
1188 void cont_scroll_cb (ev::timer &w, int revents); ev::timer cont_scroll_ev;
1190 #ifdef SELECTION_SCROLLING
1191 void sel_scroll_cb (ev::timer &w, int revents); ev::timer sel_scroll_ev;
1193 #if defined(MOUSE_WHEEL) && defined(MOUSE_SLIP_WHEELING)
1194 void slip_wheel_cb (ev::timer &w, int revents); ev::timer slip_wheel_ev;
1197 #ifdef POINTER_BLANK
1198 void pointer_cb (ev::timer &w, int revents); ev::timer pointer_ev;
1199 void pointer_blank ();
1201 void pointer_unblank ();
1203 void tt_printf (const char *fmt,...);
1204 void tt_write (const char *data, unsigned int len);
1207 void init (stringvec *argv, stringvec *envv)
1210 init (argv->size (), argv->begin (), envv);
1213 void make_current () const // make this the "currently active" urxvt instance
1217 rxvt_set_locale (locale);
1221 rxvt_xim *input_method;
1223 XIMStyle input_style;
1224 XPoint spot; // most recently sent spot position
1227 void im_cb (); im_watcher im_ev;
1228 void im_set_size (XRectangle &size);
1229 void im_set_position (XPoint &pos) NOTHROW;
1230 void im_set_color (unsigned long &fg, unsigned long &bg);
1231 void im_set_preedit_area (XRectangle &preedit_rect, XRectangle &status_rect, const XRectangle &needed_rect);
1233 bool IMisRunning ();
1235 bool IM_get_IC (const char *modifiers);
1236 void IMSetPosition ();
1240 void key_press (XKeyEvent &ev);
1241 void key_release (XKeyEvent &ev);
1242 unsigned int cmd_write (const char *str, unsigned int count);
1244 wchar_t next_char () NOTHROW;
1245 wchar_t cmd_getc () THROW ((class out_of_input));
1246 uint32_t next_octet () NOTHROW;
1247 uint32_t cmd_get8 () THROW ((class out_of_input));
1250 void mouse_report (XButtonEvent &ev);
1251 void button_press (XButtonEvent &ev);
1252 void button_release (XButtonEvent &ev);
1256 void set_urgency (bool enable);
1258 void set_urgency (bool enable) { }
1260 void update_fade_color (unsigned int idx);
1262 FILE *popen_printer ();
1263 int pclose_printer (FILE *stream);
1265 void process_print_pipe ();
1266 void process_nonprinting (unicode_t ch);
1267 void process_escape_vt52 (unicode_t ch);
1268 void process_escape_seq ();
1269 void process_csi_seq ();
1270 void process_window_ops (const int *args, unsigned int nargs);
1271 char *get_to_st (unicode_t &ends_how);
1272 void process_dcs_seq ();
1273 void process_osc_seq ();
1274 void process_color_seq (int report, int color, const char *str, char resp);
1275 void process_xterm_seq (int op, char *str, char resp);
1276 int privcases (int mode, unsigned long bit);
1277 void process_terminal_mode (int mode, int priv, unsigned int nargs, const int *arg);
1278 void process_sgr_mode (unsigned int nargs, const int *arg);
1279 void process_graphics ();
1282 const char **init_resources (int argc, const char *const *argv);
1283 void init (int argc, const char *const *argv, stringvec *envv);
1285 void set_locale (const char *locale);
1286 void init_xlocale ();
1287 void init_command (const char *const *argv);
1288 void run_command (const char *const *argv);
1289 int run_child (const char *const *argv);
1290 void color_aliases (int idx);
1291 void create_windows (int argc, const char *const *argv);
1292 void get_colours ();
1293 void get_ourmods ();
1299 void emergency_cleanup ();
1300 void recolour_cursor ();
1301 void resize_all_windows (unsigned int newwidth, unsigned int newheight, int ignoreparent);
1302 void window_calc (unsigned int newwidth, unsigned int newheight);
1304 void set_string_property (Atom prop, const char *str, int len = -1);
1305 void set_utf8_property (Atom prop, const char *str, int len = -1);
1306 void set_title (const char *str);
1307 void set_icon_name (const char *str);
1308 void set_window_color (int idx, const char *color);
1309 void set_colorfgbg ();
1310 bool set_color (rxvt_color &color, const char *name);
1311 void alias_color (int dst, int src);
1312 void set_widthheight (unsigned int newwidth, unsigned int newheight);
1313 void get_window_origin (int &x, int &y);
1314 Pixmap get_pixmap_property (int prop_id);
1318 void lalloc (line_t &l) const
1320 l.t = (text_t *)talloc->alloc ();
1321 l.r = (rend_t *)ralloc->alloc ();
1325 void lfree (line_t &l)
1332 void lresize (line_t &l) const
1337 l.t = (text_t *)talloc->alloc (l.t, prev_ncol * sizeof (text_t));
1338 l.r = (rend_t *)ralloc->alloc (l.r, prev_ncol * sizeof (rend_t));
1340 l.l = min (l.l, ncol);
1342 if (ncol > prev_ncol)
1343 scr_blank_line (l, prev_ncol, ncol - prev_ncol, DEFAULT_RSTYLE);
1346 int fgcolor_of (rend_t r) const NOTHROW
1348 int base = GET_BASEFG (r);
1349 #ifndef NO_BRIGHTCOLOR
1352 && option (Opt_intensityStyles)
1354 && IN_RANGE_INC (base, minCOLOR, minBrightCOLOR))
1355 base += minBrightCOLOR - minCOLOR;
1360 int bgcolor_of (rend_t r) const NOTHROW
1362 int base = GET_BASEBG (r);
1363 #ifndef NO_BRIGHTCOLOR
1366 && option (Opt_intensityStyles)
1368 && IN_RANGE_INC (base, minCOLOR, minBrightCOLOR))
1369 base += minBrightCOLOR - minCOLOR;
1374 bool option (uint8_t opt) const NOTHROW
1380 return options[opt >> 3] & (1 << (opt & 7));
1383 void set_option (uint8_t opt, bool set = true) NOTHROW
1390 options[opt >> 3] |= (1 << (opt & 7));
1392 options[opt >> 3] &= ~(1 << (opt & 7));
1395 void set_privmode (unsigned bit, int set) NOTHROW
1403 // modifies first argument(!)
1404 void paste (char *data, unsigned int len) NOTHROW;
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 void scr_kill_char (line_t &l, int col) const NOTHROW;
1408 int scr_scroll_text (int row1, int row2, int count) NOTHROW;
1410 void scr_release () NOTHROW;
1411 void scr_clear (bool really = false) NOTHROW;
1412 void scr_refresh () NOTHROW;
1413 bool scr_refresh_rend (rend_t mask, rend_t value) NOTHROW;
1414 void scr_erase_screen (int mode) NOTHROW;
1416 void scr_erase_savelines () NOTHROW;
1417 void scr_backindex () NOTHROW;
1418 void scr_forwardindex () NOTHROW;
1420 void scr_touch (bool refresh) NOTHROW;
1421 void scr_expose (int x, int y, int width, int height, bool refresh) NOTHROW;
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_soft_reset () NOTHROW;
1430 void scr_cursor (cursor_mode mode) NOTHROW;
1431 void scr_do_wrap () NOTHROW;
1432 void scr_swap_screen () NOTHROW;
1433 void scr_change_screen (int scrn);
1434 void scr_color (unsigned int color, int fgbg) NOTHROW;
1435 void scr_rendition (int set, int style) NOTHROW;
1436 void scr_add_lines (const wchar_t *str, int len, int minlines = 0) NOTHROW;
1437 void scr_backspace () NOTHROW;
1438 void scr_tab (int count, bool ht = false) NOTHROW;
1439 void scr_gotorc (int row, int col, int relative) NOTHROW;
1440 void scr_index (enum page_dirn direction) NOTHROW;
1441 void scr_erase_line (int mode) NOTHROW;
1442 void scr_E () NOTHROW;
1443 void scr_insdel_lines (int count, int insdel) NOTHROW;
1444 void scr_insdel_chars (int count, int insdel) NOTHROW;
1445 void scr_scroll_region (int top, int bot) NOTHROW;
1446 void scr_cursor_visible (int mode) NOTHROW;
1447 void scr_autowrap (int mode) NOTHROW;
1448 void scr_relative_origin (int mode) NOTHROW;
1449 void scr_insert_mode (int mode) NOTHROW;
1450 void scr_set_tab (int mode) NOTHROW;
1451 void scr_rvideo_mode (bool on) NOTHROW;
1452 void scr_report_position () NOTHROW;
1453 void set_font_style () NOTHROW;
1454 void scr_charset_choose (int set) NOTHROW;
1455 void scr_charset_set (int set, unsigned int ch) NOTHROW;
1456 void scr_move_to (int y, int len) NOTHROW;
1457 bool scr_page (enum page_dirn direction, int nlines) NOTHROW;
1458 bool scr_changeview (int new_view_start) NOTHROW;
1459 void scr_bell () NOTHROW;
1460 void scr_printscreen (int fullhist) NOTHROW;
1461 void scr_xor_rect (int beg_row, int beg_col, int end_row, int end_col, rend_t rstyle1, rend_t rstyle2) NOTHROW;
1462 void scr_xor_span (int beg_row, int beg_col, int end_row, int end_col, rend_t rstyle) NOTHROW;
1463 void scr_reverse_selection () NOTHROW;
1464 void scr_dump (int fd) NOTHROW;
1466 void selection_check (int check_more) NOTHROW;
1467 void selection_paste (Window win, Atom prop, bool delete_prop) NOTHROW;
1468 void selection_property (Window win, Atom prop) NOTHROW;
1469 void selection_request (Time tm, int selnum = Sel_Primary) NOTHROW;
1470 int selection_request_other (Atom target, int selnum) NOTHROW;
1471 void selection_clear (bool clipboard = false) NOTHROW;
1472 void clipboard_copy (Time tm);
1473 void selection_make (Time tm);
1474 bool selection_grab (Time tm, bool clipboard = false) NOTHROW;
1475 void selection_start_colrow (int col, int row) NOTHROW;
1476 void selection_delimit_word (enum page_dirn dirn, const row_col_t *mark, row_col_t *ret) NOTHROW;
1477 void selection_extend_colrow (int32_t col, int32_t row, int button3, int buttonpress, int clickchange) NOTHROW;
1478 void selection_remove_trailing_spaces () NOTHROW;
1479 void selection_send (const XSelectionRequestEvent &rq) NOTHROW;
1480 void selection_click (int clicks, int x, int y) NOTHROW;
1481 void selection_extend (int x, int y, int flag) NOTHROW;
1482 void selection_rotate (int x, int y) NOTHROW;
1485 void get_options (int argc, const char *const *argv);
1486 int parse_keysym (const char *str, const char *arg);
1487 const char *x_resource (const char *name);
1488 void extract_resources ();
1491 #endif /* _RXVT_H_ */