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 # ifdef USE_256_COLORS
253 # define TERMENV "rxvt-unicode-256color"
255 # define TERMENV "rxvt-unicode"
259 #if defined (NO_MOUSE_REPORT) && !defined (NO_MOUSE_REPORT_SCROLLBAR)
260 # define NO_MOUSE_REPORT_SCROLLBAR 1
263 #define scrollBar_esc 30
265 #if !defined (RXVT_SCROLLBAR) && !defined (NEXT_SCROLLBAR)
266 # define NO_SCROLLBAR_BUTTON_CONTINUAL_SCROLLING 1
270 NO_REFRESH = 0, /* Window not visible at all! */
271 FAST_REFRESH = 1, /* Fully exposed window */
272 SLOW_REFRESH = 2, /* Partially exposed window */
275 #ifdef NO_SECONDARY_SCREEN
281 /* special (internal) prefix for font commands */
286 /* flags for rxvt_scr_gotorc () */
288 C_RELATIVE = 1, /* col movement is relative */
289 R_RELATIVE = 2, /* row movement is relative */
290 RELATIVE = C_RELATIVE | R_RELATIVE,
293 /* modes for rxvt_scr_insdel_chars (), rxvt_scr_insdel_lines () */
295 INSERT = -1, /* don't change these values */
300 /* modes for rxvt_scr_page () - scroll page. used by scrollbar window */
307 /* arguments for rxvt_scr_change_screen () */
313 // define various rendition bits and masks. the rendition word
314 // is 32 bits in size, and we should use it as efficiently as possible
318 // GET_BGATTR depends on RS_fgShift > RS_bgShift
319 #define RS_colorMask ((1UL << Color_Bits) - 1UL)
321 #define RS_fgShift (RS_bgShift + Color_Bits)
322 #define RS_bgMask (RS_colorMask << RS_bgShift)
323 #define RS_fgMask (RS_colorMask << RS_fgShift)
325 // must have space for rxvt_fontset::fontCount * 2 + 2 values
326 #define RS_fontShift (RS_fgShift + Color_Bits)
327 #define RS_Careful (1UL << RS_fontShift) /* be careful when drawing these */
328 #define RS_fontMask ((rxvt_fontset::fontCount << (RS_fontShift + 1)) | RS_Careful) // includes RS_Careful
330 // toggle this to force redraw, must be != RS_Careful and otherwise "pretty neutral"
331 #define RS_redraw (2UL << RS_fontShift)
333 // 5 custom bits for extensions
334 #define RS_customCount 16UL
335 #define RS_customShift 23
336 #define RS_customMask ((RS_customCount - 1UL) << RS_customShift)
339 #define RS_Bold (1UL << RS_styleShift)
340 #define RS_Italic (2UL << RS_styleShift)
342 #define RS_styleCount 4
343 #define RS_styleShift 27
344 #define RS_styleMask (RS_Bold | RS_Italic)
347 #define RS_Blink (1UL << 29)
348 #define RS_RVid (1UL << 30) // reverse video
349 #define RS_Uline (1UL << 31) // underline
351 #define RS_baseattrMask (RS_Italic | RS_Bold | RS_Blink | RS_RVid | RS_Uline)
352 #define RS_attrMask (RS_baseattrMask | RS_fontMask)
354 #define DEFAULT_RSTYLE (RS_None | (Color_fg << RS_fgShift) | (Color_bg << RS_bgShift))
355 #define OVERLAY_RSTYLE (RS_None | (Color_Black << RS_fgShift) | (Color_Yellow << RS_bgShift))
357 #define Sel_none 0 /* Not waiting */
358 #define Sel_normal 0x01 /* normal selection */
359 #define Sel_incr 0x02 /* incremental selection */
360 #define Sel_direct 0x00
361 #define Sel_Primary 0x01
362 #define Sel_Secondary 0x02
363 #define Sel_Clipboard 0x03
364 #define Sel_whereMask 0x0f
365 #define Sel_CompoundText 0x10 /* last request was COMPOUND_TEXT */
366 #define Sel_UTF8String 0x20 /* last request was UTF8_STRING */
370 C0_SOH, C0_STX, C0_ETX, C0_EOT, C0_ENQ, C0_ACK, C0_BEL,
371 C0_BS , C0_HT , C0_LF , C0_VT , C0_FF , C0_CR , C0_SO , C0_SI ,
372 C0_DLE, C0_DC1, C0_DC2, D0_DC3, C0_DC4, C0_NAK, C0_SYN, C0_ETB,
373 C0_CAN, C0_EM , C0_SUB, C0_ESC, C0_IS4, C0_IS3, C0_IS2, C0_IS1,
375 #define CHAR_ST 0x9c /* 0234 */
378 * XTerm Operating System Commands: ESC ] Ps;Pt (ST|BEL)
379 * colour extensions by Christian W. Zuckschwerdt <zany@triq.net>
385 XTerm_property = 3, // change X property
386 XTerm_Color = 4, // change colors
387 XTerm_Color00 = 10, // change fg color
388 XTerm_Color01 = 11, // change bg color
389 XTerm_Color_cursor = 12, // change actual 'Cursor' color
390 XTerm_Color_pointer_fg = 13, // change actual 'Pointer' fg color
391 XTerm_Color_pointer_bg = 14, // change actual 'Pointer' bg color
392 XTerm_Color05 = 15, // not implemented (tektronix fg)
393 XTerm_Color06 = 16, // not implemented (tektronix bg)
394 XTerm_Color_RV = 17, // change actual 'Highlight' color
395 XTerm_logfile = 46, // not implemented
398 XTerm_konsole30 = 30, // reserved for konsole
399 XTerm_konsole31 = 31, // reserved for konsole
400 XTerm_emacs51 = 51, // reserved for emacs shell
402 * rxvt extensions of XTerm OSCs: ESC ] Ps;Pt (ST|BEL)
411 Rxvt_Pixmap = 20, // new bg pixmap
412 Rxvt_dumpscreen = 55, // dump scrollback and all of screen
414 URxvt_locale = 701, // change locale
415 URxvt_version = 702, // request version
417 URxvt_Color_IT = 704, // change actual 'Italic' colour
418 URxvt_Color_tint = 705, // change actual tint colour
419 URxvt_Color_BD = 706, // change actual 'Bold' color
420 URxvt_Color_UL = 707, // change actual 'Underline' color
421 URxvt_Color_border = 708,
424 URxvt_boldFont = 711,
425 URxvt_italicFont = 712,
426 URxvt_boldItalicFont = 713,
429 URxvt_view_down = 721,
431 URxvt_perl = 777, // for use by perl extensions, starts with "extension-name;"
434 /* Words starting with `Color_' are colours. Others are counts */
436 * The PixColor and rendition colour usage should probably be decoupled
437 * on the unnecessary items, e.g. Color_pointer, but won't bother
438 * until we need to. Also, be aware of usage in pixcolor_set
443 Color_transparent = -1,
447 Color_Black = minCOLOR,
454 maxCOLOR, /* minCOLOR + 7 */
455 #ifndef NO_BRIGHTCOLOR
456 Color_AntiqueWhite = maxCOLOR,
457 minBrightCOLOR, /* maxCOLOR + 1 */
458 Color_Grey25 = minBrightCOLOR,
465 maxBrightCOLOR, /* minBrightCOLOR + 7 */
466 Color_White = maxBrightCOLOR,
468 Color_White = maxCOLOR,
470 minTermCOLOR = Color_White + 1,
471 #ifndef USE_256_COLORS
472 maxTermCOLOR = Color_White + 72,
474 maxTermCOLOR = Color_White + 240,
476 #ifndef NO_CURSORCOLOR
483 #ifndef NO_BOLD_UNDERLINE_REVERSE
496 #ifdef RXVT_SCROLLBAR
499 #if ENABLE_TRANSPARENCY
506 #ifdef RXVT_SCROLLBAR
507 Color_topShadow = NRS_COLORS,
511 TOTAL_COLORS = NRS_COLORS
515 #ifndef USE_256_COLORS
516 #define Color_Bits 7 // 0 .. maxTermCOLOR
518 #define Color_Bits 9 // 0 .. maxTermCOLOR
525 # define def(name) Rs_ ## name,
526 # define reserve(name,count) Rs_ ## name ## _ = Rs_ ## name + (count) - 1,
533 /* DEC private modes */
534 #define PrivMode_132 (1UL<<0)
535 #define PrivMode_132OK (1UL<<1)
536 #define PrivMode_rVideo (1UL<<2)
537 #define PrivMode_relOrigin (1UL<<3)
538 #define PrivMode_Screen (1UL<<4)
539 #define PrivMode_Autowrap (1UL<<5)
540 #define PrivMode_aplCUR (1UL<<6)
541 #define PrivMode_aplKP (1UL<<7)
542 #define PrivMode_HaveBackSpace (1UL<<8)
543 #define PrivMode_BackSpace (1UL<<9)
544 #define PrivMode_ShiftKeys (1UL<<10)
545 #define PrivMode_VisibleCursor (1UL<<11)
546 #define PrivMode_MouseX10 (1UL<<12)
547 #define PrivMode_MouseX11 (1UL<<13)
548 #define PrivMode_scrollBar (1UL<<14)
549 #define PrivMode_TtyOutputInh (1UL<<15)
550 #define PrivMode_Keypress (1UL<<16)
551 #define PrivMode_smoothScroll (1UL<<17)
552 #define PrivMode_vt52 (1UL<<18)
553 #define PrivMode_LFNL (1UL<<19)
554 #define PrivMode_MouseBtnEvent (1UL<<20)
555 #define PrivMode_MouseAnyEvent (1UL<<21)
556 #define PrivMode_BracketPaste (1UL<<22)
558 #define PrivMode_mouse_report (PrivMode_MouseX10|PrivMode_MouseX11|PrivMode_MouseBtnEvent|PrivMode_MouseAnyEvent)
560 #ifdef ALLOW_132_MODE
561 # define PrivMode_Default (PrivMode_Autowrap|PrivMode_ShiftKeys|PrivMode_VisibleCursor|PrivMode_132OK)
563 # define PrivMode_Default (PrivMode_Autowrap|PrivMode_ShiftKeys|PrivMode_VisibleCursor)
566 // do not change these constants lightly, there are many interdependencies
567 #define IMBUFSIZ 128 // input modifier buffer sizes
568 #define KBUFSZ 512 // size of keyboard mapping buffer
569 #define CBUFSIZ 2048 // size of command buffer
570 #define CBUFCNT 8 // never call pty_fill/cmd_parse more than this often in a row
571 #define UBUFSIZ 2048 // character buffer
574 # include <X11/Xmd.h>
575 typedef struct _mwmhints
585 /* Motif window hints */
586 #define MWM_HINTS_FUNCTIONS (1L << 0)
587 #define MWM_HINTS_DECORATIONS (1L << 1)
588 #define MWM_HINTS_INPUT_MODE (1L << 2)
589 #define MWM_HINTS_STATUS (1L << 3)
590 /* bit definitions for MwmHints.functions */
591 #define MWM_FUNC_ALL (1L << 0)
592 #define MWM_FUNC_RESIZE (1L << 1)
593 #define MWM_FUNC_MOVE (1L << 2)
594 #define MWM_FUNC_MINIMIZE (1L << 3)
595 #define MWM_FUNC_MAXIMIZE (1L << 4)
596 #define MWM_FUNC_CLOSE (1L << 5)
597 /* bit definitions for MwmHints.decorations */
598 #define MWM_DECOR_ALL (1L << 0)
599 #define MWM_DECOR_BORDER (1L << 1)
600 #define MWM_DECOR_RESIZEH (1L << 2)
601 #define MWM_DECOR_TITLE (1L << 3)
602 #define MWM_DECOR_MENU (1L << 4)
603 #define MWM_DECOR_MINIMIZE (1L << 5)
604 #define MWM_DECOR_MAXIMIZE (1L << 6)
605 /* bit definitions for MwmHints.inputMode */
606 #define MWM_INPUT_MODELESS 0
607 #define MWM_INPUT_PRIMARY_APPLICATION_MODAL 1
608 #define MWM_INPUT_SYSTEM_MODAL 2
609 #define MWM_INPUT_FULL_APPLICATION_MODAL 3
610 #define PROP_MWM_HINTS_ELEMENTS 5
613 *****************************************************************************
615 *****************************************************************************
617 #define dLocal(type,name) type const name = this->name
619 // for speed reasons, we assume that all codepoints 32 to 126 are
621 #define WCWIDTH(c) (IN_RANGE_INC (c, 0x20, 0x7e) ? 1 : wcwidth (c))
623 /* convert pixel dimensions to row/column values. Everything as int32_t */
624 #define Pixel2Col(x) Pixel2Width((int32_t)(x))
625 #define Pixel2Row(y) Pixel2Height((int32_t)(y))
626 #define Pixel2Width(x) ((int32_t)(x) / (int32_t)fwidth)
627 #define Pixel2Height(y) ((int32_t)(y) / (int32_t)fheight)
628 #define Col2Pixel(col) ((int32_t)Width2Pixel(col))
629 #define Row2Pixel(row) ((int32_t)Height2Pixel(row))
630 #define Width2Pixel(n) ((int32_t)(n) * (int32_t)fwidth)
631 #define Height2Pixel(n) ((int32_t)(n) * (int32_t)fheight)
633 #define LINENO_of(t,n) MOD ((t)->term_start + int(n), (t)->total_rows)
634 #define ROW_of(t,n) (t)->row_buf [LINENO_of ((t), n)]
636 #define LINENO(n) LINENO_of (this, n)
637 #define ROW(n) ROW_of (this, n)
639 /* how to build & extract colors and attributes */
640 #define GET_BASEFG(x) (((x) & RS_fgMask) >> RS_fgShift)
641 #define GET_BASEBG(x) (((x) & RS_bgMask) >> RS_bgShift)
643 #define GET_FONT(x) (((x) & RS_fontMask) >> RS_fontShift)
644 #define SET_FONT(x,fid) (((x) & ~RS_fontMask) | ((fid) << RS_fontShift))
646 #define GET_STYLE(x) (((x) & RS_styleMask) >> RS_styleShift)
647 #define SET_STYLE(x,style) (((x) & ~RS_styleMask) | ((style) << RS_styleShift))
649 #define GET_ATTR(x) (((x) & RS_attrMask))
650 // return attributes defining the background, encoding doesn't matter
651 // depends on RS_fgShift > RS_bgShift
652 #define GET_BGATTR(x) \
653 (expect_false ((x) & RS_RVid) \
654 ? (((x) & (RS_attrMask & ~RS_RVid)) \
655 | (((x) & RS_fgMask) >> (RS_fgShift - RS_bgShift))) \
656 : ((x) & (RS_attrMask | RS_bgMask)))
657 #define SET_FGCOLOR(x,fg) (((x) & ~RS_fgMask) | ((fg) << RS_fgShift))
658 #define SET_BGCOLOR(x,bg) (((x) & ~RS_bgMask) | ((bg) << RS_bgShift))
659 #define SET_ATTR(x,a) (((x) & ~RS_attrMask) | (a))
661 #define RS_SAME(a,b) (!(((a) ^ (b)) & ~RS_Careful))
663 #define PIXCOLOR_NAME(idx) rs[Rs_color + (idx)]
664 #define ISSET_PIXCOLOR(idx) (!!rs[Rs_color + (idx)])
667 # define FONTSET_of(t,style) (t)->fontset[GET_STYLE (style)]
669 # define FONTSET_of(t,style) (t)->fontset[0]
672 #define FONTSET(style) FONTSET_of (this, style)
674 typedef callback<void (const char *)> log_callback;
675 typedef callback<int (int)> getfd_callback;
677 /****************************************************************************/
679 #define LINE_LONGER 0x0001 // line is continued on the next row
680 #define LINE_FILTERED 0x0002 // line has been filtered
681 #define LINE_COMPRESSED 0x0004 // line has been compressed (NYI)
682 #define LINE_FILTER 0x0008 // line needs to be filtered before display (NYI)
683 #define LINE_BIDI 0x0010 // line needs bidi (NYI)
687 text_t *t; // terminal the text
688 rend_t *r; // rendition, uses RS_ flags
689 tlen_t_ l; // length of each text line
694 return f & LINE_LONGER;
697 void is_longer (int set)
713 void touch () // call whenever a line is changed/touched/updated
727 /****************************************************************************/
729 // primitive wrapper around mbstate_t to ensure initialisation
734 operator mbstate_t *() { return &mbs; }
735 void reset () { memset (&mbs, 0, sizeof (mbs)); }
736 mbstate () { reset (); }
739 /****************************************************************************/
741 #define UNICODE_MASK 0x1fffffUL
744 # define COMPOSE_LO 0x40000000UL
745 # define COMPOSE_HI 0x400fffffUL
746 # define IS_COMPOSE(n) ((int32_t)(n) >= COMPOSE_LO)
749 # define COMPOSE_LO 0xe000UL // our _own_ functions don't like (illegal) surrogates
750 # define COMPOSE_HI 0xf8ffUL // in utf-8, so use private use area only
752 # define COMPOSE_LO 0xd800UL
753 # define COMPOSE_HI 0xf8ffUL
755 # define IS_COMPOSE(n) IN_RANGE_INC ((n), COMPOSE_LO, COMPOSE_HI)
759 // compose chars are used to represent composite characters
760 // that are not representable in unicode, as well as characters
761 // not fitting in the BMP.
764 unicode_t c1, c2; // any chars != NOCHAR are valid
765 compose_char (unicode_t c1, unicode_t c2)
770 class rxvt_composite_vec
772 vector<compose_char> v;
774 text_t compose (unicode_t c1, unicode_t c2 = NOCHAR);
775 int expand (unicode_t c, wchar_t *r);
776 compose_char *operator [](text_t c)
778 return c >= COMPOSE_LO && c < COMPOSE_LO + v.size ()
784 extern class rxvt_composite_vec rxvt_composite;
787 /****************************************************************************/
789 #ifdef KEYSYM_RESOURCE
790 class keyboard_manager;
793 typedef struct rxvt_term *rxvt_t;
795 extern rxvt_t rxvt_current_term;
797 #define SET_R(r) rxvt_current_term = const_cast<rxvt_term *>(r)
798 #define GET_R rxvt_current_term
800 /* ------------------------------------------------------------------------- */
803 int x, y, w, h; // overlay dimensions
807 // while tempting to add swap() etc. here, it effetcively only increases code size
810 /* ------------------------------------------------------------------------- */
822 * height : 1 <= height
823 * ncol : 1 <= ncol <= MAX(tlen_t)
824 * nrow : 1 <= nrow <= MAX(int)
825 * saveLines : 0 <= saveLines <= MAX(int)
826 * term_start : 0 <= term_start < saveLines
827 * total_rows : nrow + saveLines
829 * top_row : -saveLines <= top_row <= 0
830 * view_start : top_row <= view_start <= 0
832 * | most coordinates are stored relative to term_start,
833 * ROW_BUF | which is the first line of the terminal screen
834 * |························= row_buf[0]
835 * |························= row_buf[1]
836 * |························= row_buf[2] etc.
838 * +------------+···········= term_start + top_row
840 * | scrollback +---------+·= term_start + view_start
841 * | scrollback | display |
842 * | scrollback | display |
843 * +------------+·display·+·= term_start
844 * | terminal | display |
845 * | terminal +---------+
848 * +------------+···········= term_start + nrow - 1
851 * END······················= total_rows
856 int width; /* window width [pixels] */
857 int height; /* window height [pixels] */
858 int fwidth; /* font width [pixels] */
859 int fheight; /* font height [pixels] */
860 int fbase; /* font ascent (baseline) [pixels] */
861 int ncol; /* window columns [characters] */
862 int nrow; /* window rows [characters] */
863 int focus; /* window has focus */
864 int mapped; /* window state mapped? */
865 int int_bwidth; /* internal border width */
866 int ext_bwidth; /* external border width */
867 int lineSpace; /* number of extra pixels between rows */
868 int letterSpace; /* number of extra pixels between columns */
869 int saveLines; /* number of lines that fit in scrollback */
870 int total_rows; /* total number of rows in this terminal */
871 int term_start; /* term lines start here */
872 int view_start; /* scrollback view starts here */
873 int top_row; /* topmost row index of scrollback */
874 Window parent[6]; /* parent identifiers - we're parent[0] */
875 Window vt; /* vt100 window */
876 GC gc; /* GC for drawing */
878 rxvt_drawable *drawable;
879 rxvt_fontset *fontset[4];
885 * row: Cursor row position : 0 <= row < nrow
886 * col: Cursor column position : 0 <= col < ncol
887 * tscroll: Scrolling region top row inclusive : 0 <= row < nrow
888 * bscroll: Scrolling region bottom row inclusive : 0 <= row < nrow
890 * selection_t elements
891 * clicks: 1, 2 or 3 clicks - 4 indicates a special condition of 1 where
892 * nothing is selected
893 * beg: row/column of beginning of selection : never past mark
894 * mark: row/column of initial click : never past end
895 * end: row/column of one character past end of selection
896 * * Note: top_row <= beg.row <= mark.row <= end.row < nrow
897 * * Note: col == -1 ==> we're left of screen
902 row_col_t cur; /* cursor position on the screen */
903 int tscroll; /* top of settable scroll region */
904 int bscroll; /* bottom of settable scroll region */
905 unsigned int charset; /* character set number [0..3] */
906 unsigned int flags; /* see below */
907 row_col_t s_cur; /* saved cursor position */
908 unsigned int s_charset; /* saved character set number [0..3] */
910 rend_t s_rstyle; /* saved rendition style */
915 SELECTION_CLEAR = 0, /* nothing selected */
916 SELECTION_INIT, /* marked a point */
917 SELECTION_BEGIN, /* started a selection */
918 SELECTION_CONT, /* continued selection */
919 SELECTION_DONE /* selection put in CUT_BUFFER0 */
924 wchar_t *text; /* selected text */
925 unsigned int len; /* length of selected text */
926 unsigned int screen; /* screen being used */
927 unsigned int clicks; /* number of clicks */
928 selection_op_t op; /* current operation */
929 bool rect; /* rectangular selection? */
930 row_col_t beg; /* beginning of selection <= mark */
931 row_col_t mark; /* point of initial click <= end */
932 row_col_t end; /* one character past end point */
933 wchar_t *clip_text; /* text copied to the clipboard */
934 unsigned int clip_len; /* length of clipboard text */
937 /* ------------------------------------------------------------------------- */
940 #define Screen_Relative (1<<0) /* relative origin mode flag */
941 #define Screen_VisibleCursor (1<<1) /* cursor visible? */
942 #define Screen_Autowrap (1<<2) /* auto-wrap flag */
943 #define Screen_Insert (1<<3) /* insert mode (vs. overstrike) */
944 #define Screen_WrapNext (1<<4) /* need to wrap for next char? */
945 #define Screen_DefaultFlags (Screen_VisibleCursor | Screen_Autowrap)
947 /* rxvt_vars.options */
949 # define def(name,idx) Opt_ ## name = idx,
950 # define nodef(name) Opt_ ## name = 0,
957 /* ------------------------------------------------------------------------- */
959 struct rxvt_vars : TermWin_t
961 scrollBar_t scrollBar;
962 uint8_t options[(Opt_count + 7) >> 3];
964 rxvt_color *pix_colors;
965 Cursor TermWin_cursor; /* cursor for vt window */
967 line_t *row_buf; // all lines, scrollback + terminal, circular, followed by temp_buf
968 line_t *drawn_buf; // text on screen
969 line_t *swap_buf; // lines for swap buffer
970 char *tabs; /* per location: 1 == tab-stop */
973 selection_t selection;
974 rxvt_color pix_colors_focused[TOTAL_COLORS];
975 #ifdef OFF_FOCUS_FADING
976 rxvt_color pix_colors_unfocused[TOTAL_COLORS];
980 struct rxvt_term : zero_initialized, rxvt_vars, rxvt_screen
983 // special markers with magic addresses
984 static const char resval_undef []; // options specifically unset
985 static const char resval_on []; // boolean options switched on
986 static const char resval_off []; // or off
988 log_callback *log_hook; // log error messages through this hook, if != 0
989 getfd_callback *getfd_hook; // convert remote to local fd, if != 0
993 struct mbstate mbstate; // current input multibyte state
995 unsigned char want_refresh:1,
996 current_screen:1, /* primary or secondary */
1011 enc_utf8:1, /* whether locale uses utf-8 */
1012 seen_input:1, /* whether we have seen some program output yet */
1013 seen_resize:1, /* whether we had a resize event */
1016 unsigned char refresh_type,
1018 meta_char, /* Alt-key prefix */
1023 bool rvideo_state, rvideo_mode;
1027 int num_scr; /* screen: number of lines scrolled */
1028 int prev_ncol, /* screen: previous number of columns */
1029 prev_nrow; /* screen: previous number of rows */
1033 #ifdef SELECTION_SCROLLING
1034 int scroll_selection_lines;
1035 enum page_dirn scroll_selection_dir;
1036 int selection_save_x,
1038 selection_save_state;
1041 int csrO, /* Hops - csr offset in thumb/slider to */
1042 /* give proper Scroll behaviour */
1043 #if defined(MOUSE_WHEEL) && defined(MOUSE_SLIP_WHEELING)
1044 mouse_slip_wheel_speed,
1051 # ifdef POINTER_BLANK
1056 unsigned int ModLevel3Mask,
1059 int old_width, /* last used width in screen resize */
1060 old_height; /* last used height in screen resize */
1061 unsigned long priv_modes,
1066 Time selection_time,
1067 selection_request_time,
1069 pid_t cmd_pid; /* process id of child */
1071 size_t incr_buf_size, incr_buf_fill;
1073 struct mouse_event MEvent;
1074 XComposeStatus compose;
1076 row_col_t oldcursor;
1077 #ifdef HAVE_BG_PIXMAP
1078 bgPixmap_t bgPixmap;
1080 #ifdef HAVE_AFTERIMAGE
1082 ASImageManager *asimman;
1087 asv = create_asvisual_for_id (dpy, display->screen, depth, XVisualIDFromVisual (visual), cmap, NULL);
1094 void scr_swap_overlay () NOTHROW;
1095 void scr_overlay_new (int x, int y, int w, int h) NOTHROW;
1096 void scr_overlay_off () NOTHROW;
1097 void scr_overlay_set (int x, int y,
1099 rend_t rend = OVERLAY_RSTYLE) NOTHROW;
1100 void scr_overlay_set (int x, int y, const char *s) NOTHROW;
1101 void scr_overlay_set (int x, int y, const wchar_t *s) NOTHROW;
1104 vector<void *> allocated; // free these memory blocks with free()
1106 char env_windowid[21]; /* environmental variable WINDOWID */
1107 char env_colorfgbg[sizeof ("COLORFGBG=default;default;bg") + 1];
1108 char *env_display; /* environmental variable DISPLAY */
1109 char *env_term; /* environmental variable TERM */
1113 char *v_buffer; /* pointer to physical buffer */
1114 unsigned int v_buflen; /* size of area to write */
1115 stringvec *argv, *envv; /* if != 0, will be freed at destroy time */
1117 #ifdef KEYSYM_RESOURCE
1118 keyboard_manager *keyboard;
1120 #ifndef NO_RESOURCES
1121 XrmDatabase option_db;
1124 const char *rs[NUM_RESOURCES];
1125 /* command input buffering */
1126 char *cmdbuf_ptr, *cmdbuf_endp;
1127 char cmdbuf_base[CBUFSIZ];
1131 rxvt_salloc *talloc; // text line allocator
1132 rxvt_salloc *ralloc; // rend line allocator
1134 static vector<rxvt_term *> termlist; // a vector of all running rxvt_term's
1136 #if ENABLE_FRILLS || ISO_14755
1137 // ISO 14755 entry support
1138 unicode_t iso14755buf;
1139 void commit_iso14755 ();
1141 void iso14755_51 (unicode_t ch, rend_t r = DEFAULT_RSTYLE, int x = 0, int y = -1);
1142 void iso14755_54 (int x, int y);
1146 long vt_emask, vt_emask_perl, vt_emask_xim, vt_emask_mouse;
1148 void vt_select_input () const NOTHROW
1150 XSelectInput (dpy, vt, vt_emask | vt_emask_perl | vt_emask_xim | vt_emask_mouse);
1153 #if ENABLE_TRANSPARENCY || ENABLE_PERL
1154 void rootwin_cb (XEvent &xev);
1155 xevent_watcher rootwin_ev;
1157 #ifdef HAVE_BG_PIXMAP
1158 void update_background ();
1160 void trace_update_background (const char *file, int line);
1161 # define update_background() trace_update_background (__FILE__, __LINE__)
1163 void update_background_cb (ev::timer &w, int revents);
1164 ev::timer update_background_ev;
1167 void x_cb (XEvent &xev);
1168 xevent_watcher termwin_ev;
1169 xevent_watcher vt_ev;
1170 xevent_watcher scrollbar_ev;
1172 void child_cb (ev::child &w, int revents); ev::child child_ev;
1173 void destroy_cb (ev::idle &w, int revents); ev::idle destroy_ev;
1174 void refresh_check ();
1176 void flush_cb (ev::timer &w, int revents); ev::timer flush_ev;
1178 void pty_cb (ev::io &w, int revents); ev::io pty_ev;
1179 void incr_cb (ev::timer &w, int revents) NOTHROW; ev::timer incr_ev;
1182 void cursor_blink_cb (ev::timer &w, int revents); ev::timer cursor_blink_ev;
1185 void text_blink_cb (ev::timer &w, int revents); ev::timer text_blink_ev;
1188 void bell_cb (ev::timer &w, int revents); ev::timer bell_ev;
1191 #ifndef NO_SCROLLBAR_BUTTON_CONTINUAL_SCROLLING
1192 void cont_scroll_cb (ev::timer &w, int revents); ev::timer cont_scroll_ev;
1194 #ifdef SELECTION_SCROLLING
1195 void sel_scroll_cb (ev::timer &w, int revents); ev::timer sel_scroll_ev;
1197 #if defined(MOUSE_WHEEL) && defined(MOUSE_SLIP_WHEELING)
1198 void slip_wheel_cb (ev::timer &w, int revents); ev::timer slip_wheel_ev;
1201 #ifdef POINTER_BLANK
1202 void pointer_cb (ev::timer &w, int revents); ev::timer pointer_ev;
1203 void pointer_blank ();
1205 void pointer_unblank ();
1207 void tt_printf (const char *fmt,...);
1208 void tt_write (const char *data, unsigned int len);
1211 void init (stringvec *argv, stringvec *envv)
1214 init (argv->size (), argv->begin (), envv);
1217 void make_current () const // make this the "currently active" urxvt instance
1221 rxvt_set_locale (locale);
1225 rxvt_xim *input_method;
1227 XIMStyle input_style;
1228 XPoint spot; // most recently sent spot position
1231 void im_cb (); im_watcher im_ev;
1232 void im_set_size (XRectangle &size);
1233 void im_set_position (XPoint &pos) NOTHROW;
1234 void im_set_color (unsigned long &fg, unsigned long &bg);
1235 void im_set_preedit_area (XRectangle &preedit_rect, XRectangle &status_rect, const XRectangle &needed_rect);
1237 bool IMisRunning ();
1239 bool IM_get_IC (const char *modifiers);
1240 void IMSetPosition ();
1244 void key_press (XKeyEvent &ev);
1245 void key_release (XKeyEvent &ev);
1246 unsigned int cmd_write (const char *str, unsigned int count);
1248 wchar_t next_char () NOTHROW;
1249 wchar_t cmd_getc () THROW ((class out_of_input));
1250 uint32_t next_octet () NOTHROW;
1251 uint32_t cmd_get8 () THROW ((class out_of_input));
1254 void mouse_report (XButtonEvent &ev);
1255 void button_press (XButtonEvent &ev);
1256 void button_release (XButtonEvent &ev);
1260 void set_urgency (bool enable);
1262 void set_urgency (bool enable) { }
1264 void update_fade_color (unsigned int idx);
1266 FILE *popen_printer ();
1267 int pclose_printer (FILE *stream);
1269 void process_print_pipe ();
1270 void process_nonprinting (unicode_t ch);
1271 void process_escape_vt52 (unicode_t ch);
1272 void process_escape_seq ();
1273 void process_csi_seq ();
1274 void process_window_ops (const int *args, unsigned int nargs);
1275 char *get_to_st (unicode_t &ends_how);
1276 void process_dcs_seq ();
1277 void process_osc_seq ();
1278 void process_color_seq (int report, int color, const char *str, char resp);
1279 void process_xterm_seq (int op, char *str, char resp);
1280 int privcases (int mode, unsigned long bit);
1281 void process_terminal_mode (int mode, int priv, unsigned int nargs, const int *arg);
1282 void process_sgr_mode (unsigned int nargs, const int *arg);
1283 void process_graphics ();
1286 const char **init_resources (int argc, const char *const *argv);
1287 void init (int argc, const char *const *argv, stringvec *envv);
1289 void set_locale (const char *locale);
1290 void init_xlocale ();
1291 void init_command (const char *const *argv);
1292 void run_command (const char *const *argv);
1293 int run_child (const char *const *argv);
1294 void color_aliases (int idx);
1295 void create_windows (int argc, const char *const *argv);
1296 void get_colours ();
1297 void get_ourmods ();
1303 void emergency_cleanup ();
1304 void recolour_cursor ();
1305 void resize_all_windows (unsigned int newwidth, unsigned int newheight, int ignoreparent);
1306 void window_calc (unsigned int newwidth, unsigned int newheight);
1308 void set_string_property (Atom prop, const char *str, int len = -1);
1309 void set_utf8_property (Atom prop, const char *str, int len = -1);
1310 void set_title (const char *str);
1311 void set_icon_name (const char *str);
1312 void set_window_color (int idx, const char *color);
1313 void set_colorfgbg ();
1314 bool set_color (rxvt_color &color, const char *name);
1315 void alias_color (int dst, int src);
1316 void set_widthheight (unsigned int newwidth, unsigned int newheight);
1317 void get_window_origin (int &x, int &y);
1318 Pixmap get_pixmap_property (int prop_id);
1322 void lalloc (line_t &l) const
1324 l.t = (text_t *)talloc->alloc ();
1325 l.r = (rend_t *)ralloc->alloc ();
1329 void lfree (line_t &l)
1336 void lresize (line_t &l) const
1341 l.t = (text_t *)talloc->alloc (l.t, prev_ncol * sizeof (text_t));
1342 l.r = (rend_t *)ralloc->alloc (l.r, prev_ncol * sizeof (rend_t));
1344 l.l = min (l.l, ncol);
1346 if (ncol > prev_ncol)
1347 scr_blank_line (l, prev_ncol, ncol - prev_ncol, DEFAULT_RSTYLE);
1350 int fgcolor_of (rend_t r) const NOTHROW
1352 int base = GET_BASEFG (r);
1353 #ifndef NO_BRIGHTCOLOR
1356 && option (Opt_intensityStyles)
1358 && IN_RANGE_INC (base, minCOLOR, minBrightCOLOR))
1359 base += minBrightCOLOR - minCOLOR;
1364 int bgcolor_of (rend_t r) const NOTHROW
1366 int base = GET_BASEBG (r);
1367 #ifndef NO_BRIGHTCOLOR
1370 && option (Opt_intensityStyles)
1372 && IN_RANGE_INC (base, minCOLOR, minBrightCOLOR))
1373 base += minBrightCOLOR - minCOLOR;
1378 bool option (uint8_t opt) const NOTHROW
1384 return options[opt >> 3] & (1 << (opt & 7));
1387 void set_option (uint8_t opt, bool set = true) NOTHROW
1394 options[opt >> 3] |= (1 << (opt & 7));
1396 options[opt >> 3] &= ~(1 << (opt & 7));
1399 void set_privmode (unsigned bit, int set) NOTHROW
1407 // modifies first argument(!)
1408 void paste (char *data, unsigned int len) NOTHROW;
1409 void scr_blank_line (line_t &l, unsigned int col, unsigned int width, rend_t efs) const NOTHROW;
1410 void scr_blank_screen_mem (line_t &l, rend_t efs) const NOTHROW;
1411 void scr_kill_char (line_t &l, int col) const NOTHROW;
1412 int scr_scroll_text (int row1, int row2, int count) NOTHROW;
1414 void scr_release () NOTHROW;
1415 void scr_clear (bool really = false) NOTHROW;
1416 void scr_refresh () NOTHROW;
1417 bool scr_refresh_rend (rend_t mask, rend_t value) NOTHROW;
1418 void scr_erase_screen (int mode) NOTHROW;
1420 void scr_erase_savelines () NOTHROW;
1421 void scr_backindex () NOTHROW;
1422 void scr_forwardindex () NOTHROW;
1424 void scr_touch (bool refresh) NOTHROW;
1425 void scr_expose (int x, int y, int width, int height, bool refresh) NOTHROW;
1426 void scr_recolour () NOTHROW;
1427 void scr_remap_chars () NOTHROW;
1428 void scr_remap_chars (line_t &l) NOTHROW;
1430 enum cursor_mode { SAVE, RESTORE };
1432 void scr_poweron ();
1433 void scr_soft_reset () NOTHROW;
1434 void scr_cursor (cursor_mode mode) NOTHROW;
1435 void scr_do_wrap () NOTHROW;
1436 void scr_swap_screen () NOTHROW;
1437 void scr_change_screen (int scrn);
1438 void scr_color (unsigned int color, int fgbg) NOTHROW;
1439 void scr_rendition (int set, int style) NOTHROW;
1440 void scr_add_lines (const wchar_t *str, int len, int minlines = 0) NOTHROW;
1441 void scr_backspace () NOTHROW;
1442 void scr_tab (int count, bool ht = false) NOTHROW;
1443 void scr_gotorc (int row, int col, int relative) NOTHROW;
1444 void scr_index (enum page_dirn direction) NOTHROW;
1445 void scr_erase_line (int mode) NOTHROW;
1446 void scr_E () NOTHROW;
1447 void scr_insdel_lines (int count, int insdel) NOTHROW;
1448 void scr_insdel_chars (int count, int insdel) NOTHROW;
1449 void scr_scroll_region (int top, int bot) NOTHROW;
1450 void scr_cursor_visible (int mode) NOTHROW;
1451 void scr_autowrap (int mode) NOTHROW;
1452 void scr_relative_origin (int mode) NOTHROW;
1453 void scr_insert_mode (int mode) NOTHROW;
1454 void scr_set_tab (int mode) NOTHROW;
1455 void scr_rvideo_mode (bool on) NOTHROW;
1456 void scr_report_position () NOTHROW;
1457 void set_font_style () NOTHROW;
1458 void scr_charset_choose (int set) NOTHROW;
1459 void scr_charset_set (int set, unsigned int ch) NOTHROW;
1460 void scr_move_to (int y, int len) NOTHROW;
1461 bool scr_page (enum page_dirn direction, int nlines) NOTHROW;
1462 bool scr_changeview (int new_view_start) NOTHROW;
1463 void scr_bell () NOTHROW;
1464 void scr_printscreen (int fullhist) NOTHROW;
1465 void scr_xor_rect (int beg_row, int beg_col, int end_row, int end_col, rend_t rstyle1, rend_t rstyle2) NOTHROW;
1466 void scr_xor_span (int beg_row, int beg_col, int end_row, int end_col, rend_t rstyle) NOTHROW;
1467 void scr_reverse_selection () NOTHROW;
1468 void scr_dump (int fd) NOTHROW;
1470 void selection_check (int check_more) NOTHROW;
1471 void selection_paste (Window win, Atom prop, bool delete_prop) NOTHROW;
1472 void selection_property (Window win, Atom prop) NOTHROW;
1473 void selection_request (Time tm, int selnum = Sel_Primary) NOTHROW;
1474 int selection_request_other (Atom target, int selnum) NOTHROW;
1475 void selection_clear (bool clipboard = false) NOTHROW;
1476 void clipboard_copy (Time tm);
1477 void selection_make (Time tm);
1478 bool selection_grab (Time tm, bool clipboard = false) NOTHROW;
1479 void selection_start_colrow (int col, int row) NOTHROW;
1480 void selection_delimit_word (enum page_dirn dirn, const row_col_t *mark, row_col_t *ret) NOTHROW;
1481 void selection_extend_colrow (int32_t col, int32_t row, int button3, int buttonpress, int clickchange) NOTHROW;
1482 void selection_remove_trailing_spaces () NOTHROW;
1483 void selection_send (const XSelectionRequestEvent &rq) NOTHROW;
1484 void selection_click (int clicks, int x, int y) NOTHROW;
1485 void selection_extend (int x, int y, int flag) NOTHROW;
1486 void selection_rotate (int x, int y) NOTHROW;
1489 void get_options (int argc, const char *const *argv);
1490 int parse_keysym (const char *str, const char *arg);
1491 const char *x_resource (const char *name);
1492 void extract_resources ();
1495 #endif /* _RXVT_H_ */