Portable tmux needs to check ENABLE_SIXEL.
[tmux.git] / tmux.h
blobf7a7c578f6f927b846440095781afa93bb3cd1ec
1 /* $OpenBSD$ */
3 /*
4 * Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
15 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
16 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19 #ifndef TMUX_H
20 #define TMUX_H
22 #include <sys/time.h>
23 #include <sys/uio.h>
25 #include <limits.h>
26 #include <stdarg.h>
27 #include <stdio.h>
28 #include <termios.h>
29 #include <wchar.h>
31 #ifdef HAVE_UTEMPTER
32 #include <utempter.h>
33 #endif
35 #include "compat.h"
36 #include "tmux-protocol.h"
37 #include "xmalloc.h"
39 extern char **environ;
41 struct args;
42 struct args_command_state;
43 struct client;
44 struct cmd;
45 struct cmd_find_state;
46 struct cmdq_item;
47 struct cmdq_list;
48 struct cmdq_state;
49 struct cmds;
50 struct control_state;
51 struct environ;
52 struct format_job_tree;
53 struct format_tree;
54 struct hyperlinks_uri;
55 struct hyperlinks;
56 struct input_ctx;
57 struct job;
58 struct menu_data;
59 struct mode_tree_data;
60 struct mouse_event;
61 struct options;
62 struct options_array_item;
63 struct options_entry;
64 struct screen_write_citem;
65 struct screen_write_cline;
66 struct screen_write_ctx;
67 struct session;
69 #ifdef ENABLE_SIXEL
70 struct sixel_image;
71 #endif
73 struct tty_ctx;
74 struct tty_code;
75 struct tty_key;
76 struct tmuxpeer;
77 struct tmuxproc;
78 struct winlink;
80 /* Default configuration files and socket paths. */
81 #ifndef TMUX_CONF
82 #define TMUX_CONF "/etc/tmux.conf:~/.tmux.conf"
83 #endif
84 #ifndef TMUX_SOCK
85 #define TMUX_SOCK "$TMUX_TMPDIR:" _PATH_TMP
86 #endif
87 #ifndef TMUX_SOCK_PERM
88 #define TMUX_SOCK_PERM (7 /* o+rwx */)
89 #endif
90 #ifndef TMUX_TERM
91 #define TMUX_TERM "screen"
92 #endif
93 #ifndef TMUX_LOCK_CMD
94 #define TMUX_LOCK_CMD "lock -np"
95 #endif
97 /* Minimum layout cell size, NOT including border lines. */
98 #define PANE_MINIMUM 1
100 /* Minimum and maximum window size. */
101 #define WINDOW_MINIMUM PANE_MINIMUM
102 #define WINDOW_MAXIMUM 10000
104 /* Automatic name refresh interval, in microseconds. Must be < 1 second. */
105 #define NAME_INTERVAL 500000
107 /* Default pixel cell sizes. */
108 #define DEFAULT_XPIXEL 16
109 #define DEFAULT_YPIXEL 32
111 /* Attribute to make GCC check printf-like arguments. */
112 #define printflike(a, b) __attribute__ ((format (printf, a, b)))
114 /* Number of items in array. */
115 #ifndef nitems
116 #define nitems(_a) (sizeof((_a)) / sizeof((_a)[0]))
117 #endif
119 /* Alert option values. */
120 #define ALERT_NONE 0
121 #define ALERT_ANY 1
122 #define ALERT_CURRENT 2
123 #define ALERT_OTHER 3
125 /* Visual option values. */
126 #define VISUAL_OFF 0
127 #define VISUAL_ON 1
128 #define VISUAL_BOTH 2
130 /* No key or unknown key. */
131 #define KEYC_NONE 0x000ff000000000ULL
132 #define KEYC_UNKNOWN 0x000fe000000000ULL
135 * Base for special (that is, not Unicode) keys. An enum must be at most a
136 * signed int, so these are based in the highest Unicode PUA.
138 #define KEYC_BASE 0x0000000010e000ULL
139 #define KEYC_USER 0x0000000010f000ULL
140 #define KEYC_USER_END (KEYC_USER + KEYC_NUSER)
142 /* Key modifier bits. */
143 #define KEYC_META 0x00100000000000ULL
144 #define KEYC_CTRL 0x00200000000000ULL
145 #define KEYC_SHIFT 0x00400000000000ULL
147 /* Key flag bits. */
148 #define KEYC_LITERAL 0x01000000000000ULL
149 #define KEYC_KEYPAD 0x02000000000000ULL
150 #define KEYC_CURSOR 0x04000000000000ULL
151 #define KEYC_IMPLIED_META 0x08000000000000ULL
152 #define KEYC_BUILD_MODIFIERS 0x10000000000000ULL
153 #define KEYC_VI 0x20000000000000ULL
154 #define KEYC_SENT 0x40000000000000ULL
156 /* Masks for key bits. */
157 #define KEYC_MASK_MODIFIERS 0x00f00000000000ULL
158 #define KEYC_MASK_FLAGS 0xff000000000000ULL
159 #define KEYC_MASK_KEY 0x000fffffffffffULL
161 /* Available user keys. */
162 #define KEYC_NUSER 1000
164 /* Is this a mouse key? */
165 #define KEYC_IS_MOUSE(key) \
166 (((key) & KEYC_MASK_KEY) >= KEYC_MOUSE && \
167 ((key) & KEYC_MASK_KEY) < KEYC_BSPACE)
169 /* Is this a Unicode key? */
170 #define KEYC_IS_UNICODE(key) \
171 (((key) & KEYC_MASK_KEY) > 0x7f && \
172 (((key) & KEYC_MASK_KEY) < KEYC_BASE || \
173 ((key) & KEYC_MASK_KEY) >= KEYC_BASE_END) && \
174 (((key) & KEYC_MASK_KEY) < KEYC_USER || \
175 ((key) & KEYC_MASK_KEY) >= KEYC_USER_END))
177 /* Multiple click timeout. */
178 #define KEYC_CLICK_TIMEOUT 300
180 /* Mouse key codes. */
181 #define KEYC_MOUSE_KEY(name) \
182 KEYC_ ## name ## _PANE, \
183 KEYC_ ## name ## _STATUS, \
184 KEYC_ ## name ## _STATUS_LEFT, \
185 KEYC_ ## name ## _STATUS_RIGHT, \
186 KEYC_ ## name ## _STATUS_DEFAULT, \
187 KEYC_ ## name ## _BORDER
188 #define KEYC_MOUSE_STRING(name, s) \
189 { #s "Pane", KEYC_ ## name ## _PANE }, \
190 { #s "Status", KEYC_ ## name ## _STATUS }, \
191 { #s "StatusLeft", KEYC_ ## name ## _STATUS_LEFT }, \
192 { #s "StatusRight", KEYC_ ## name ## _STATUS_RIGHT }, \
193 { #s "StatusDefault", KEYC_ ## name ## _STATUS_DEFAULT }, \
194 { #s "Border", KEYC_ ## name ## _BORDER }
197 * A single key. This can be ASCII or Unicode or one of the keys between
198 * KEYC_BASE and KEYC_BASE_END.
200 typedef unsigned long long key_code;
202 /* C0 control characters */
203 enum {
204 C0_NUL,
205 C0_SOH,
206 C0_STX,
207 C0_ETX,
208 C0_EOT,
209 C0_ENQ,
210 C0_ASC,
211 C0_BEL,
212 C0_BS,
213 C0_HT,
214 C0_LF,
215 C0_VT,
216 C0_FF,
217 C0_CR,
218 C0_SO,
219 C0_SI,
220 C0_DLE,
221 C0_DC1,
222 C0_DC2,
223 C0_DC3,
224 C0_DC4,
225 C0_NAK,
226 C0_SYN,
227 C0_ETB,
228 C0_CAN,
229 C0_EM,
230 C0_SUB,
231 C0_ESC,
232 C0_FS,
233 C0_GS,
234 C0_RS,
235 C0_US
238 /* Special key codes. */
239 enum {
240 /* Focus events. */
241 KEYC_FOCUS_IN = KEYC_BASE,
242 KEYC_FOCUS_OUT,
244 /* "Any" key, used if not found in key table. */
245 KEYC_ANY,
247 /* Paste brackets. */
248 KEYC_PASTE_START,
249 KEYC_PASTE_END,
251 /* Mouse keys. */
252 KEYC_MOUSE, /* unclassified mouse event */
253 KEYC_DRAGGING, /* dragging in progress */
254 KEYC_DOUBLECLICK, /* double click complete */
255 KEYC_MOUSE_KEY(MOUSEMOVE),
256 KEYC_MOUSE_KEY(MOUSEDOWN1),
257 KEYC_MOUSE_KEY(MOUSEDOWN2),
258 KEYC_MOUSE_KEY(MOUSEDOWN3),
259 KEYC_MOUSE_KEY(MOUSEDOWN6),
260 KEYC_MOUSE_KEY(MOUSEDOWN7),
261 KEYC_MOUSE_KEY(MOUSEDOWN8),
262 KEYC_MOUSE_KEY(MOUSEDOWN9),
263 KEYC_MOUSE_KEY(MOUSEDOWN10),
264 KEYC_MOUSE_KEY(MOUSEDOWN11),
265 KEYC_MOUSE_KEY(MOUSEUP1),
266 KEYC_MOUSE_KEY(MOUSEUP2),
267 KEYC_MOUSE_KEY(MOUSEUP3),
268 KEYC_MOUSE_KEY(MOUSEUP6),
269 KEYC_MOUSE_KEY(MOUSEUP7),
270 KEYC_MOUSE_KEY(MOUSEUP8),
271 KEYC_MOUSE_KEY(MOUSEUP9),
272 KEYC_MOUSE_KEY(MOUSEUP10),
273 KEYC_MOUSE_KEY(MOUSEUP11),
274 KEYC_MOUSE_KEY(MOUSEDRAG1),
275 KEYC_MOUSE_KEY(MOUSEDRAG2),
276 KEYC_MOUSE_KEY(MOUSEDRAG3),
277 KEYC_MOUSE_KEY(MOUSEDRAG6),
278 KEYC_MOUSE_KEY(MOUSEDRAG7),
279 KEYC_MOUSE_KEY(MOUSEDRAG8),
280 KEYC_MOUSE_KEY(MOUSEDRAG9),
281 KEYC_MOUSE_KEY(MOUSEDRAG10),
282 KEYC_MOUSE_KEY(MOUSEDRAG11),
283 KEYC_MOUSE_KEY(MOUSEDRAGEND1),
284 KEYC_MOUSE_KEY(MOUSEDRAGEND2),
285 KEYC_MOUSE_KEY(MOUSEDRAGEND3),
286 KEYC_MOUSE_KEY(MOUSEDRAGEND6),
287 KEYC_MOUSE_KEY(MOUSEDRAGEND7),
288 KEYC_MOUSE_KEY(MOUSEDRAGEND8),
289 KEYC_MOUSE_KEY(MOUSEDRAGEND9),
290 KEYC_MOUSE_KEY(MOUSEDRAGEND10),
291 KEYC_MOUSE_KEY(MOUSEDRAGEND11),
292 KEYC_MOUSE_KEY(WHEELUP),
293 KEYC_MOUSE_KEY(WHEELDOWN),
294 KEYC_MOUSE_KEY(SECONDCLICK1),
295 KEYC_MOUSE_KEY(SECONDCLICK2),
296 KEYC_MOUSE_KEY(SECONDCLICK3),
297 KEYC_MOUSE_KEY(SECONDCLICK6),
298 KEYC_MOUSE_KEY(SECONDCLICK7),
299 KEYC_MOUSE_KEY(SECONDCLICK8),
300 KEYC_MOUSE_KEY(SECONDCLICK9),
301 KEYC_MOUSE_KEY(SECONDCLICK10),
302 KEYC_MOUSE_KEY(SECONDCLICK11),
303 KEYC_MOUSE_KEY(DOUBLECLICK1),
304 KEYC_MOUSE_KEY(DOUBLECLICK2),
305 KEYC_MOUSE_KEY(DOUBLECLICK3),
306 KEYC_MOUSE_KEY(DOUBLECLICK6),
307 KEYC_MOUSE_KEY(DOUBLECLICK7),
308 KEYC_MOUSE_KEY(DOUBLECLICK8),
309 KEYC_MOUSE_KEY(DOUBLECLICK9),
310 KEYC_MOUSE_KEY(DOUBLECLICK10),
311 KEYC_MOUSE_KEY(DOUBLECLICK11),
312 KEYC_MOUSE_KEY(TRIPLECLICK1),
313 KEYC_MOUSE_KEY(TRIPLECLICK2),
314 KEYC_MOUSE_KEY(TRIPLECLICK3),
315 KEYC_MOUSE_KEY(TRIPLECLICK6),
316 KEYC_MOUSE_KEY(TRIPLECLICK7),
317 KEYC_MOUSE_KEY(TRIPLECLICK8),
318 KEYC_MOUSE_KEY(TRIPLECLICK9),
319 KEYC_MOUSE_KEY(TRIPLECLICK10),
320 KEYC_MOUSE_KEY(TRIPLECLICK11),
322 /* Backspace key. */
323 KEYC_BSPACE,
325 /* Function keys. */
326 KEYC_F1,
327 KEYC_F2,
328 KEYC_F3,
329 KEYC_F4,
330 KEYC_F5,
331 KEYC_F6,
332 KEYC_F7,
333 KEYC_F8,
334 KEYC_F9,
335 KEYC_F10,
336 KEYC_F11,
337 KEYC_F12,
338 KEYC_IC,
339 KEYC_DC,
340 KEYC_HOME,
341 KEYC_END,
342 KEYC_NPAGE,
343 KEYC_PPAGE,
344 KEYC_BTAB,
346 /* Arrow keys. */
347 KEYC_UP,
348 KEYC_DOWN,
349 KEYC_LEFT,
350 KEYC_RIGHT,
352 /* Numeric keypad. */
353 KEYC_KP_SLASH,
354 KEYC_KP_STAR,
355 KEYC_KP_MINUS,
356 KEYC_KP_SEVEN,
357 KEYC_KP_EIGHT,
358 KEYC_KP_NINE,
359 KEYC_KP_PLUS,
360 KEYC_KP_FOUR,
361 KEYC_KP_FIVE,
362 KEYC_KP_SIX,
363 KEYC_KP_ONE,
364 KEYC_KP_TWO,
365 KEYC_KP_THREE,
366 KEYC_KP_ENTER,
367 KEYC_KP_ZERO,
368 KEYC_KP_PERIOD,
370 /* End of special keys. */
371 KEYC_BASE_END
374 /* Termcap codes. */
375 enum tty_code_code {
376 TTYC_ACSC,
377 TTYC_AM,
378 TTYC_AX,
379 TTYC_BCE,
380 TTYC_BEL,
381 TTYC_BIDI,
382 TTYC_BLINK,
383 TTYC_BOLD,
384 TTYC_CIVIS,
385 TTYC_CLEAR,
386 TTYC_CLMG,
387 TTYC_CMG,
388 TTYC_CNORM,
389 TTYC_COLORS,
390 TTYC_CR,
391 TTYC_CS,
392 TTYC_CSR,
393 TTYC_CUB,
394 TTYC_CUB1,
395 TTYC_CUD,
396 TTYC_CUD1,
397 TTYC_CUF,
398 TTYC_CUF1,
399 TTYC_CUP,
400 TTYC_CUU,
401 TTYC_CUU1,
402 TTYC_CVVIS,
403 TTYC_DCH,
404 TTYC_DCH1,
405 TTYC_DIM,
406 TTYC_DL,
407 TTYC_DL1,
408 TTYC_DSBP,
409 TTYC_DSEKS,
410 TTYC_DSFCS,
411 TTYC_DSMG,
412 TTYC_E3,
413 TTYC_ECH,
414 TTYC_ED,
415 TTYC_EL,
416 TTYC_EL1,
417 TTYC_ENACS,
418 TTYC_ENBP,
419 TTYC_ENEKS,
420 TTYC_ENFCS,
421 TTYC_ENMG,
422 TTYC_FSL,
423 TTYC_HLS,
424 TTYC_HOME,
425 TTYC_HPA,
426 TTYC_ICH,
427 TTYC_ICH1,
428 TTYC_IL,
429 TTYC_IL1,
430 TTYC_INDN,
431 TTYC_INVIS,
432 TTYC_KCBT,
433 TTYC_KCUB1,
434 TTYC_KCUD1,
435 TTYC_KCUF1,
436 TTYC_KCUU1,
437 TTYC_KDC2,
438 TTYC_KDC3,
439 TTYC_KDC4,
440 TTYC_KDC5,
441 TTYC_KDC6,
442 TTYC_KDC7,
443 TTYC_KDCH1,
444 TTYC_KDN2,
445 TTYC_KDN3,
446 TTYC_KDN4,
447 TTYC_KDN5,
448 TTYC_KDN6,
449 TTYC_KDN7,
450 TTYC_KEND,
451 TTYC_KEND2,
452 TTYC_KEND3,
453 TTYC_KEND4,
454 TTYC_KEND5,
455 TTYC_KEND6,
456 TTYC_KEND7,
457 TTYC_KF1,
458 TTYC_KF10,
459 TTYC_KF11,
460 TTYC_KF12,
461 TTYC_KF13,
462 TTYC_KF14,
463 TTYC_KF15,
464 TTYC_KF16,
465 TTYC_KF17,
466 TTYC_KF18,
467 TTYC_KF19,
468 TTYC_KF2,
469 TTYC_KF20,
470 TTYC_KF21,
471 TTYC_KF22,
472 TTYC_KF23,
473 TTYC_KF24,
474 TTYC_KF25,
475 TTYC_KF26,
476 TTYC_KF27,
477 TTYC_KF28,
478 TTYC_KF29,
479 TTYC_KF3,
480 TTYC_KF30,
481 TTYC_KF31,
482 TTYC_KF32,
483 TTYC_KF33,
484 TTYC_KF34,
485 TTYC_KF35,
486 TTYC_KF36,
487 TTYC_KF37,
488 TTYC_KF38,
489 TTYC_KF39,
490 TTYC_KF4,
491 TTYC_KF40,
492 TTYC_KF41,
493 TTYC_KF42,
494 TTYC_KF43,
495 TTYC_KF44,
496 TTYC_KF45,
497 TTYC_KF46,
498 TTYC_KF47,
499 TTYC_KF48,
500 TTYC_KF49,
501 TTYC_KF5,
502 TTYC_KF50,
503 TTYC_KF51,
504 TTYC_KF52,
505 TTYC_KF53,
506 TTYC_KF54,
507 TTYC_KF55,
508 TTYC_KF56,
509 TTYC_KF57,
510 TTYC_KF58,
511 TTYC_KF59,
512 TTYC_KF6,
513 TTYC_KF60,
514 TTYC_KF61,
515 TTYC_KF62,
516 TTYC_KF63,
517 TTYC_KF7,
518 TTYC_KF8,
519 TTYC_KF9,
520 TTYC_KHOM2,
521 TTYC_KHOM3,
522 TTYC_KHOM4,
523 TTYC_KHOM5,
524 TTYC_KHOM6,
525 TTYC_KHOM7,
526 TTYC_KHOME,
527 TTYC_KIC2,
528 TTYC_KIC3,
529 TTYC_KIC4,
530 TTYC_KIC5,
531 TTYC_KIC6,
532 TTYC_KIC7,
533 TTYC_KICH1,
534 TTYC_KIND,
535 TTYC_KLFT2,
536 TTYC_KLFT3,
537 TTYC_KLFT4,
538 TTYC_KLFT5,
539 TTYC_KLFT6,
540 TTYC_KLFT7,
541 TTYC_KMOUS,
542 TTYC_KNP,
543 TTYC_KNXT2,
544 TTYC_KNXT3,
545 TTYC_KNXT4,
546 TTYC_KNXT5,
547 TTYC_KNXT6,
548 TTYC_KNXT7,
549 TTYC_KPP,
550 TTYC_KPRV2,
551 TTYC_KPRV3,
552 TTYC_KPRV4,
553 TTYC_KPRV5,
554 TTYC_KPRV6,
555 TTYC_KPRV7,
556 TTYC_KRI,
557 TTYC_KRIT2,
558 TTYC_KRIT3,
559 TTYC_KRIT4,
560 TTYC_KRIT5,
561 TTYC_KRIT6,
562 TTYC_KRIT7,
563 TTYC_KUP2,
564 TTYC_KUP3,
565 TTYC_KUP4,
566 TTYC_KUP5,
567 TTYC_KUP6,
568 TTYC_KUP7,
569 TTYC_MS,
570 TTYC_NOBR,
571 TTYC_OL,
572 TTYC_OP,
573 TTYC_RECT,
574 TTYC_REV,
575 TTYC_RGB,
576 TTYC_RI,
577 TTYC_RIN,
578 TTYC_RMACS,
579 TTYC_RMCUP,
580 TTYC_RMKX,
581 TTYC_SE,
582 TTYC_SETAB,
583 TTYC_SETAF,
584 TTYC_SETAL,
585 TTYC_SETRGBB,
586 TTYC_SETRGBF,
587 TTYC_SETULC,
588 TTYC_SETULC1,
589 TTYC_SGR0,
590 TTYC_SITM,
591 TTYC_SMACS,
592 TTYC_SMCUP,
593 TTYC_SMKX,
594 TTYC_SMOL,
595 TTYC_SMSO,
596 TTYC_SMUL,
597 TTYC_SMULX,
598 TTYC_SMXX,
599 TTYC_SXL,
600 TTYC_SS,
601 TTYC_SWD,
602 TTYC_SYNC,
603 TTYC_TC,
604 TTYC_TSL,
605 TTYC_U8,
606 TTYC_VPA,
607 TTYC_XT
610 /* Character classes. */
611 #define WHITESPACE " "
613 /* Mode keys. */
614 #define MODEKEY_EMACS 0
615 #define MODEKEY_VI 1
617 /* Modes. */
618 #define MODE_CURSOR 0x1
619 #define MODE_INSERT 0x2
620 #define MODE_KCURSOR 0x4
621 #define MODE_KKEYPAD 0x8
622 #define MODE_WRAP 0x10
623 #define MODE_MOUSE_STANDARD 0x20
624 #define MODE_MOUSE_BUTTON 0x40
625 #define MODE_CURSOR_BLINKING 0x80
626 #define MODE_MOUSE_UTF8 0x100
627 #define MODE_MOUSE_SGR 0x200
628 #define MODE_BRACKETPASTE 0x400
629 #define MODE_FOCUSON 0x800
630 #define MODE_MOUSE_ALL 0x1000
631 #define MODE_ORIGIN 0x2000
632 #define MODE_CRLF 0x4000
633 #define MODE_KEYS_EXTENDED 0x8000
634 #define MODE_CURSOR_VERY_VISIBLE 0x10000
635 #define MODE_CURSOR_BLINKING_SET 0x20000
636 #define MODE_KEYS_EXTENDED_2 0x40000
638 #define ALL_MODES 0xffffff
639 #define ALL_MOUSE_MODES (MODE_MOUSE_STANDARD|MODE_MOUSE_BUTTON|MODE_MOUSE_ALL)
640 #define MOTION_MOUSE_MODES (MODE_MOUSE_BUTTON|MODE_MOUSE_ALL)
641 #define CURSOR_MODES (MODE_CURSOR|MODE_CURSOR_BLINKING|MODE_CURSOR_VERY_VISIBLE)
642 #define EXTENDED_KEY_MODES (MODE_KEYS_EXTENDED|MODE_KEYS_EXTENDED_2)
644 /* Mouse protocol constants. */
645 #define MOUSE_PARAM_MAX 0xff
646 #define MOUSE_PARAM_UTF8_MAX 0x7ff
647 #define MOUSE_PARAM_BTN_OFF 0x20
648 #define MOUSE_PARAM_POS_OFF 0x21
650 /* A single UTF-8 character. */
651 typedef u_int utf8_char;
654 * An expanded UTF-8 character. UTF8_SIZE must be big enough to hold combining
655 * characters as well. It can't be more than 32 bytes without changes to how
656 * characters are stored.
658 #define UTF8_SIZE 21
659 struct utf8_data {
660 u_char data[UTF8_SIZE];
662 u_char have;
663 u_char size;
665 u_char width; /* 0xff if invalid */
667 enum utf8_state {
668 UTF8_MORE,
669 UTF8_DONE,
670 UTF8_ERROR
673 /* Colour flags. */
674 #define COLOUR_FLAG_256 0x01000000
675 #define COLOUR_FLAG_RGB 0x02000000
677 /* Special colours. */
678 #define COLOUR_DEFAULT(c) ((c) == 8 || (c) == 9)
680 /* Replacement palette. */
681 struct colour_palette {
682 int fg;
683 int bg;
685 int *palette;
686 int *default_palette;
689 /* Grid attributes. Anything above 0xff is stored in an extended cell. */
690 #define GRID_ATTR_BRIGHT 0x1
691 #define GRID_ATTR_DIM 0x2
692 #define GRID_ATTR_UNDERSCORE 0x4
693 #define GRID_ATTR_BLINK 0x8
694 #define GRID_ATTR_REVERSE 0x10
695 #define GRID_ATTR_HIDDEN 0x20
696 #define GRID_ATTR_ITALICS 0x40
697 #define GRID_ATTR_CHARSET 0x80 /* alternative character set */
698 #define GRID_ATTR_STRIKETHROUGH 0x100
699 #define GRID_ATTR_UNDERSCORE_2 0x200
700 #define GRID_ATTR_UNDERSCORE_3 0x400
701 #define GRID_ATTR_UNDERSCORE_4 0x800
702 #define GRID_ATTR_UNDERSCORE_5 0x1000
703 #define GRID_ATTR_OVERLINE 0x2000
705 /* All underscore attributes. */
706 #define GRID_ATTR_ALL_UNDERSCORE \
707 (GRID_ATTR_UNDERSCORE| \
708 GRID_ATTR_UNDERSCORE_2| \
709 GRID_ATTR_UNDERSCORE_3| \
710 GRID_ATTR_UNDERSCORE_4| \
711 GRID_ATTR_UNDERSCORE_5)
713 /* Grid flags. */
714 #define GRID_FLAG_FG256 0x1
715 #define GRID_FLAG_BG256 0x2
716 #define GRID_FLAG_PADDING 0x4
717 #define GRID_FLAG_EXTENDED 0x8
718 #define GRID_FLAG_SELECTED 0x10
719 #define GRID_FLAG_NOPALETTE 0x20
720 #define GRID_FLAG_CLEARED 0x40
722 /* Grid line flags. */
723 #define GRID_LINE_WRAPPED 0x1
724 #define GRID_LINE_EXTENDED 0x2
725 #define GRID_LINE_DEAD 0x4
726 #define GRID_LINE_START_PROMPT 0x8
727 #define GRID_LINE_START_OUTPUT 0x10
729 /* Grid string flags. */
730 #define GRID_STRING_WITH_SEQUENCES 0x1
731 #define GRID_STRING_ESCAPE_SEQUENCES 0x2
732 #define GRID_STRING_TRIM_SPACES 0x4
733 #define GRID_STRING_USED_ONLY 0x8
734 #define GRID_STRING_EMPTY_CELLS 0x10
736 /* Cell positions. */
737 #define CELL_INSIDE 0
738 #define CELL_TOPBOTTOM 1
739 #define CELL_LEFTRIGHT 2
740 #define CELL_TOPLEFT 3
741 #define CELL_TOPRIGHT 4
742 #define CELL_BOTTOMLEFT 5
743 #define CELL_BOTTOMRIGHT 6
744 #define CELL_TOPJOIN 7
745 #define CELL_BOTTOMJOIN 8
746 #define CELL_LEFTJOIN 9
747 #define CELL_RIGHTJOIN 10
748 #define CELL_JOIN 11
749 #define CELL_OUTSIDE 12
751 /* Cell borders. */
752 #define CELL_BORDERS " xqlkmjwvtun~"
753 #define SIMPLE_BORDERS " |-+++++++++."
754 #define PADDED_BORDERS " "
756 /* Grid cell data. */
757 struct grid_cell {
758 struct utf8_data data;
759 u_short attr;
760 u_char flags;
761 int fg;
762 int bg;
763 int us;
764 u_int link;
767 /* Grid extended cell entry. */
768 struct grid_extd_entry {
769 utf8_char data;
770 u_short attr;
771 u_char flags;
772 int fg;
773 int bg;
774 int us;
775 u_int link;
776 } __packed;
778 /* Grid cell entry. */
779 struct grid_cell_entry {
780 union {
781 u_int offset;
782 struct {
783 u_char attr;
784 u_char fg;
785 u_char bg;
786 u_char data;
787 } data;
789 u_char flags;
790 } __packed;
792 /* Grid line. */
793 struct grid_line {
794 struct grid_cell_entry *celldata;
795 u_int cellused;
796 u_int cellsize;
798 struct grid_extd_entry *extddata;
799 u_int extdsize;
801 int flags;
802 time_t time;
805 /* Entire grid of cells. */
806 struct grid {
807 int flags;
808 #define GRID_HISTORY 0x1 /* scroll lines into history */
810 u_int sx;
811 u_int sy;
813 u_int hscrolled;
814 u_int hsize;
815 u_int hlimit;
817 struct grid_line *linedata;
820 /* Virtual cursor in a grid. */
821 struct grid_reader {
822 struct grid *gd;
823 u_int cx;
824 u_int cy;
827 /* Style alignment. */
828 enum style_align {
829 STYLE_ALIGN_DEFAULT,
830 STYLE_ALIGN_LEFT,
831 STYLE_ALIGN_CENTRE,
832 STYLE_ALIGN_RIGHT,
833 STYLE_ALIGN_ABSOLUTE_CENTRE
836 /* Style list. */
837 enum style_list {
838 STYLE_LIST_OFF,
839 STYLE_LIST_ON,
840 STYLE_LIST_FOCUS,
841 STYLE_LIST_LEFT_MARKER,
842 STYLE_LIST_RIGHT_MARKER,
845 /* Style range. */
846 enum style_range_type {
847 STYLE_RANGE_NONE,
848 STYLE_RANGE_LEFT,
849 STYLE_RANGE_RIGHT,
850 STYLE_RANGE_PANE,
851 STYLE_RANGE_WINDOW,
852 STYLE_RANGE_SESSION,
853 STYLE_RANGE_USER
855 struct style_range {
856 enum style_range_type type;
857 u_int argument;
858 char string[16];
860 u_int start;
861 u_int end; /* not included */
863 TAILQ_ENTRY(style_range) entry;
865 TAILQ_HEAD(style_ranges, style_range);
867 /* Style default. */
868 enum style_default_type {
869 STYLE_DEFAULT_BASE,
870 STYLE_DEFAULT_PUSH,
871 STYLE_DEFAULT_POP
874 /* Style option. */
875 struct style {
876 struct grid_cell gc;
877 int ignore;
879 int fill;
880 enum style_align align;
881 enum style_list list;
883 enum style_range_type range_type;
884 u_int range_argument;
885 char range_string[16];
887 enum style_default_type default_type;
890 #ifdef ENABLE_SIXEL
891 /* Image. */
892 struct image {
893 struct screen *s;
894 struct sixel_image *data;
895 char *fallback;
897 u_int px;
898 u_int py;
899 u_int sx;
900 u_int sy;
902 TAILQ_ENTRY (image) all_entry;
903 TAILQ_ENTRY (image) entry;
905 TAILQ_HEAD(images, image);
906 #endif
908 /* Cursor style. */
909 enum screen_cursor_style {
910 SCREEN_CURSOR_DEFAULT,
911 SCREEN_CURSOR_BLOCK,
912 SCREEN_CURSOR_UNDERLINE,
913 SCREEN_CURSOR_BAR
916 /* Virtual screen. */
917 struct screen_sel;
918 struct screen_titles;
919 struct screen {
920 char *title;
921 char *path;
922 struct screen_titles *titles;
924 struct grid *grid; /* grid data */
926 u_int cx; /* cursor x */
927 u_int cy; /* cursor y */
929 enum screen_cursor_style cstyle; /* cursor style */
930 enum screen_cursor_style default_cstyle;
931 int ccolour; /* cursor colour */
932 int default_ccolour;
934 u_int rupper; /* scroll region top */
935 u_int rlower; /* scroll region bottom */
937 int mode;
938 int default_mode;
940 u_int saved_cx;
941 u_int saved_cy;
942 struct grid *saved_grid;
943 struct grid_cell saved_cell;
944 int saved_flags;
946 bitstr_t *tabs;
947 struct screen_sel *sel;
949 #ifdef ENABLE_SIXEL
950 struct images images;
951 #endif
953 struct screen_write_cline *write_list;
955 struct hyperlinks *hyperlinks;
958 /* Screen write context. */
959 typedef void (*screen_write_init_ctx_cb)(struct screen_write_ctx *,
960 struct tty_ctx *);
961 struct screen_write_ctx {
962 struct window_pane *wp;
963 struct screen *s;
965 int flags;
966 #define SCREEN_WRITE_SYNC 0x1
968 screen_write_init_ctx_cb init_ctx_cb;
969 void *arg;
971 struct screen_write_citem *item;
972 u_int scrolled;
973 u_int bg;
976 /* Box border lines option. */
977 enum box_lines {
978 BOX_LINES_DEFAULT = -1,
979 BOX_LINES_SINGLE,
980 BOX_LINES_DOUBLE,
981 BOX_LINES_HEAVY,
982 BOX_LINES_SIMPLE,
983 BOX_LINES_ROUNDED,
984 BOX_LINES_PADDED,
985 BOX_LINES_NONE
988 /* Pane border lines option. */
989 enum pane_lines {
990 PANE_LINES_SINGLE,
991 PANE_LINES_DOUBLE,
992 PANE_LINES_HEAVY,
993 PANE_LINES_SIMPLE,
994 PANE_LINES_NUMBER
997 /* Pane border indicator option. */
998 #define PANE_BORDER_OFF 0
999 #define PANE_BORDER_COLOUR 1
1000 #define PANE_BORDER_ARROWS 2
1001 #define PANE_BORDER_BOTH 3
1003 /* Mode returned by window_pane_mode function. */
1004 #define WINDOW_PANE_NO_MODE 0
1005 #define WINDOW_PANE_COPY_MODE 1
1006 #define WINDOW_PANE_VIEW_MODE 2
1008 /* Screen redraw context. */
1009 struct screen_redraw_ctx {
1010 struct client *c;
1012 u_int statuslines;
1013 int statustop;
1015 int pane_status;
1016 enum pane_lines pane_lines;
1018 struct grid_cell no_pane_gc;
1019 int no_pane_gc_set;
1021 u_int sx;
1022 u_int sy;
1023 u_int ox;
1024 u_int oy;
1027 /* Screen size. */
1028 #define screen_size_x(s) ((s)->grid->sx)
1029 #define screen_size_y(s) ((s)->grid->sy)
1030 #define screen_hsize(s) ((s)->grid->hsize)
1031 #define screen_hlimit(s) ((s)->grid->hlimit)
1033 /* Menu. */
1034 struct menu_item {
1035 const char *name;
1036 key_code key;
1037 const char *command;
1039 struct menu {
1040 const char *title;
1041 struct menu_item *items;
1042 u_int count;
1043 u_int width;
1045 typedef void (*menu_choice_cb)(struct menu *, u_int, key_code, void *);
1048 * Window mode. Windows can be in several modes and this is used to call the
1049 * right function to handle input and output.
1051 struct window_mode_entry;
1052 struct window_mode {
1053 const char *name;
1054 const char *default_format;
1056 struct screen *(*init)(struct window_mode_entry *,
1057 struct cmd_find_state *, struct args *);
1058 void (*free)(struct window_mode_entry *);
1059 void (*resize)(struct window_mode_entry *, u_int, u_int);
1060 void (*update)(struct window_mode_entry *);
1061 void (*key)(struct window_mode_entry *, struct client *,
1062 struct session *, struct winlink *, key_code,
1063 struct mouse_event *);
1065 const char *(*key_table)(struct window_mode_entry *);
1066 void (*command)(struct window_mode_entry *, struct client *,
1067 struct session *, struct winlink *, struct args *,
1068 struct mouse_event *);
1069 void (*formats)(struct window_mode_entry *,
1070 struct format_tree *);
1073 /* Active window mode. */
1074 struct window_mode_entry {
1075 struct window_pane *wp;
1076 struct window_pane *swp;
1078 const struct window_mode *mode;
1079 void *data;
1081 struct screen *screen;
1082 u_int prefix;
1084 TAILQ_ENTRY(window_mode_entry) entry;
1087 /* Offsets into pane buffer. */
1088 struct window_pane_offset {
1089 size_t used;
1092 /* Queued pane resize. */
1093 struct window_pane_resize {
1094 u_int sx;
1095 u_int sy;
1097 u_int osx;
1098 u_int osy;
1100 TAILQ_ENTRY(window_pane_resize) entry;
1102 TAILQ_HEAD(window_pane_resizes, window_pane_resize);
1104 /* Child window structure. */
1105 struct window_pane {
1106 u_int id;
1107 u_int active_point;
1109 struct window *window;
1110 struct options *options;
1112 struct layout_cell *layout_cell;
1113 struct layout_cell *saved_layout_cell;
1115 u_int sx;
1116 u_int sy;
1118 u_int xoff;
1119 u_int yoff;
1121 int flags;
1122 #define PANE_REDRAW 0x1
1123 #define PANE_DROP 0x2
1124 #define PANE_FOCUSED 0x4
1125 #define PANE_VISITED 0x8
1126 /* 0x10 unused */
1127 /* 0x20 unused */
1128 #define PANE_INPUTOFF 0x40
1129 #define PANE_CHANGED 0x80
1130 #define PANE_EXITED 0x100
1131 #define PANE_STATUSREADY 0x200
1132 #define PANE_STATUSDRAWN 0x400
1133 #define PANE_EMPTY 0x800
1134 #define PANE_STYLECHANGED 0x1000
1135 #define PANE_UNSEENCHANGES 0x2000
1137 int argc;
1138 char **argv;
1139 char *shell;
1140 char *cwd;
1142 pid_t pid;
1143 char tty[TTY_NAME_MAX];
1144 int status;
1145 struct timeval dead_time;
1147 int fd;
1148 struct bufferevent *event;
1150 struct window_pane_offset offset;
1151 size_t base_offset;
1153 struct window_pane_resizes resize_queue;
1154 struct event resize_timer;
1156 struct input_ctx *ictx;
1158 struct grid_cell cached_gc;
1159 struct grid_cell cached_active_gc;
1160 struct colour_palette palette;
1162 int pipe_fd;
1163 struct bufferevent *pipe_event;
1164 struct window_pane_offset pipe_offset;
1166 struct screen *screen;
1167 struct screen base;
1169 struct screen status_screen;
1170 size_t status_size;
1172 TAILQ_HEAD(, window_mode_entry) modes;
1174 char *searchstr;
1175 int searchregex;
1177 int border_gc_set;
1178 struct grid_cell border_gc;
1180 int control_bg;
1181 int control_fg;
1183 TAILQ_ENTRY(window_pane) entry; /* link in list of all panes */
1184 TAILQ_ENTRY(window_pane) sentry; /* link in list of last visited */
1185 RB_ENTRY(window_pane) tree_entry;
1187 TAILQ_HEAD(window_panes, window_pane);
1188 RB_HEAD(window_pane_tree, window_pane);
1190 /* Window structure. */
1191 struct window {
1192 u_int id;
1193 void *latest;
1195 char *name;
1196 struct event name_event;
1197 struct timeval name_time;
1199 struct event alerts_timer;
1200 struct event offset_timer;
1202 struct timeval activity_time;
1204 struct window_pane *active;
1205 struct window_panes last_panes;
1206 struct window_panes panes;
1208 int lastlayout;
1209 struct layout_cell *layout_root;
1210 struct layout_cell *saved_layout_root;
1211 char *old_layout;
1213 u_int sx;
1214 u_int sy;
1215 u_int manual_sx;
1216 u_int manual_sy;
1217 u_int xpixel;
1218 u_int ypixel;
1220 u_int new_sx;
1221 u_int new_sy;
1222 u_int new_xpixel;
1223 u_int new_ypixel;
1225 struct utf8_data *fill_character;
1226 int flags;
1227 #define WINDOW_BELL 0x1
1228 #define WINDOW_ACTIVITY 0x2
1229 #define WINDOW_SILENCE 0x4
1230 #define WINDOW_ZOOMED 0x8
1231 #define WINDOW_WASZOOMED 0x10
1232 #define WINDOW_RESIZE 0x20
1233 #define WINDOW_ALERTFLAGS (WINDOW_BELL|WINDOW_ACTIVITY|WINDOW_SILENCE)
1235 int alerts_queued;
1236 TAILQ_ENTRY(window) alerts_entry;
1238 struct options *options;
1240 u_int references;
1241 TAILQ_HEAD(, winlink) winlinks;
1243 RB_ENTRY(window) entry;
1245 RB_HEAD(windows, window);
1247 /* Entry on local window list. */
1248 struct winlink {
1249 int idx;
1250 struct session *session;
1251 struct window *window;
1253 int flags;
1254 #define WINLINK_BELL 0x1
1255 #define WINLINK_ACTIVITY 0x2
1256 #define WINLINK_SILENCE 0x4
1257 #define WINLINK_ALERTFLAGS (WINLINK_BELL|WINLINK_ACTIVITY|WINLINK_SILENCE)
1258 #define WINLINK_VISITED 0x8
1260 RB_ENTRY(winlink) entry;
1261 TAILQ_ENTRY(winlink) wentry;
1262 TAILQ_ENTRY(winlink) sentry;
1264 RB_HEAD(winlinks, winlink);
1265 TAILQ_HEAD(winlink_stack, winlink);
1267 /* Window size option. */
1268 #define WINDOW_SIZE_LARGEST 0
1269 #define WINDOW_SIZE_SMALLEST 1
1270 #define WINDOW_SIZE_MANUAL 2
1271 #define WINDOW_SIZE_LATEST 3
1273 /* Pane border status option. */
1274 #define PANE_STATUS_OFF 0
1275 #define PANE_STATUS_TOP 1
1276 #define PANE_STATUS_BOTTOM 2
1278 /* Layout direction. */
1279 enum layout_type {
1280 LAYOUT_LEFTRIGHT,
1281 LAYOUT_TOPBOTTOM,
1282 LAYOUT_WINDOWPANE
1285 /* Layout cells queue. */
1286 TAILQ_HEAD(layout_cells, layout_cell);
1288 /* Layout cell. */
1289 struct layout_cell {
1290 enum layout_type type;
1292 struct layout_cell *parent;
1294 u_int sx;
1295 u_int sy;
1297 u_int xoff;
1298 u_int yoff;
1300 struct window_pane *wp;
1301 struct layout_cells cells;
1303 TAILQ_ENTRY(layout_cell) entry;
1306 /* Environment variable. */
1307 struct environ_entry {
1308 char *name;
1309 char *value;
1311 int flags;
1312 #define ENVIRON_HIDDEN 0x1
1314 RB_ENTRY(environ_entry) entry;
1317 /* Client session. */
1318 struct session_group {
1319 const char *name;
1320 TAILQ_HEAD(, session) sessions;
1322 RB_ENTRY(session_group) entry;
1324 RB_HEAD(session_groups, session_group);
1326 struct session {
1327 u_int id;
1329 char *name;
1330 const char *cwd;
1332 struct timeval creation_time;
1333 struct timeval last_attached_time;
1334 struct timeval activity_time;
1335 struct timeval last_activity_time;
1337 struct event lock_timer;
1339 struct winlink *curw;
1340 struct winlink_stack lastw;
1341 struct winlinks windows;
1343 int statusat;
1344 u_int statuslines;
1346 struct options *options;
1348 #define SESSION_ALERTED 0x1
1349 int flags;
1351 u_int attached;
1353 struct termios *tio;
1355 struct environ *environ;
1357 int references;
1359 TAILQ_ENTRY(session) gentry;
1360 RB_ENTRY(session) entry;
1362 RB_HEAD(sessions, session);
1364 /* Mouse button masks. */
1365 #define MOUSE_MASK_BUTTONS 195
1366 #define MOUSE_MASK_SHIFT 4
1367 #define MOUSE_MASK_META 8
1368 #define MOUSE_MASK_CTRL 16
1369 #define MOUSE_MASK_DRAG 32
1370 #define MOUSE_MASK_MODIFIERS (MOUSE_MASK_SHIFT|MOUSE_MASK_META|MOUSE_MASK_CTRL)
1372 /* Mouse wheel type. */
1373 #define MOUSE_WHEEL_UP 64
1374 #define MOUSE_WHEEL_DOWN 65
1376 /* Mouse button type. */
1377 #define MOUSE_BUTTON_1 0
1378 #define MOUSE_BUTTON_2 1
1379 #define MOUSE_BUTTON_3 2
1380 #define MOUSE_BUTTON_6 66
1381 #define MOUSE_BUTTON_7 67
1382 #define MOUSE_BUTTON_8 128
1383 #define MOUSE_BUTTON_9 129
1384 #define MOUSE_BUTTON_10 130
1385 #define MOUSE_BUTTON_11 131
1387 /* Mouse helpers. */
1388 #define MOUSE_BUTTONS(b) ((b) & MOUSE_MASK_BUTTONS)
1389 #define MOUSE_WHEEL(b) \
1390 (((b) & MOUSE_MASK_BUTTONS) == MOUSE_WHEEL_UP || \
1391 ((b) & MOUSE_MASK_BUTTONS) == MOUSE_WHEEL_DOWN)
1392 #define MOUSE_DRAG(b) ((b) & MOUSE_MASK_DRAG)
1393 #define MOUSE_RELEASE(b) (((b) & MOUSE_MASK_BUTTONS) == 3)
1395 /* Mouse input. */
1396 struct mouse_event {
1397 int valid;
1398 int ignore;
1400 key_code key;
1402 int statusat;
1403 u_int statuslines;
1405 u_int x;
1406 u_int y;
1407 u_int b;
1409 u_int lx;
1410 u_int ly;
1411 u_int lb;
1413 u_int ox;
1414 u_int oy;
1416 int s;
1417 int w;
1418 int wp;
1420 u_int sgr_type;
1421 u_int sgr_b;
1424 /* Key event. */
1425 struct key_event {
1426 key_code key;
1427 struct mouse_event m;
1429 char *buf;
1430 size_t len;
1433 /* Terminal definition. */
1434 struct tty_term {
1435 char *name;
1436 struct tty *tty;
1437 int features;
1439 char acs[UCHAR_MAX + 1][2];
1441 struct tty_code *codes;
1443 #define TERM_256COLOURS 0x1
1444 #define TERM_NOAM 0x2
1445 #define TERM_DECSLRM 0x4
1446 #define TERM_DECFRA 0x8
1447 #define TERM_RGBCOLOURS 0x10
1448 #define TERM_VT100LIKE 0x20
1449 #define TERM_SIXEL 0x40
1450 int flags;
1452 LIST_ENTRY(tty_term) entry;
1454 LIST_HEAD(tty_terms, tty_term);
1456 /* Client terminal. */
1457 struct tty {
1458 struct client *client;
1459 struct event start_timer;
1460 struct event clipboard_timer;
1461 time_t last_requests;
1463 u_int sx;
1464 u_int sy;
1465 /* Cell size in pixels. */
1466 u_int xpixel;
1467 u_int ypixel;
1469 u_int cx;
1470 u_int cy;
1471 enum screen_cursor_style cstyle;
1472 int ccolour;
1474 /* Properties of the area being drawn on. */
1475 /* When true, the drawing area is bigger than the terminal. */
1476 int oflag;
1477 u_int oox;
1478 u_int ooy;
1479 u_int osx;
1480 u_int osy;
1482 int mode;
1483 int fg;
1484 int bg;
1486 u_int rlower;
1487 u_int rupper;
1489 u_int rleft;
1490 u_int rright;
1492 struct event event_in;
1493 struct evbuffer *in;
1494 struct event event_out;
1495 struct evbuffer *out;
1496 struct event timer;
1497 size_t discarded;
1499 struct termios tio;
1501 struct grid_cell cell;
1502 struct grid_cell last_cell;
1504 #define TTY_NOCURSOR 0x1
1505 #define TTY_FREEZE 0x2
1506 #define TTY_TIMER 0x4
1507 #define TTY_NOBLOCK 0x8
1508 #define TTY_STARTED 0x10
1509 #define TTY_OPENED 0x20
1510 #define TTY_OSC52QUERY 0x40
1511 #define TTY_BLOCK 0x80
1512 #define TTY_HAVEDA 0x100 /* Primary DA. */
1513 #define TTY_HAVEXDA 0x200
1514 #define TTY_SYNCING 0x400
1515 #define TTY_HAVEDA2 0x800 /* Secondary DA. */
1516 #define TTY_WINSIZEQUERY 0x1000
1517 #define TTY_ALL_REQUEST_FLAGS \
1518 (TTY_HAVEDA|TTY_HAVEDA2|TTY_HAVEXDA)
1519 int flags;
1521 struct tty_term *term;
1523 u_int mouse_last_x;
1524 u_int mouse_last_y;
1525 u_int mouse_last_b;
1526 int mouse_drag_flag;
1527 void (*mouse_drag_update)(struct client *,
1528 struct mouse_event *);
1529 void (*mouse_drag_release)(struct client *,
1530 struct mouse_event *);
1532 struct event key_timer;
1533 struct tty_key *key_tree;
1536 /* Terminal command context. */
1537 typedef void (*tty_ctx_redraw_cb)(const struct tty_ctx *);
1538 typedef int (*tty_ctx_set_client_cb)(struct tty_ctx *, struct client *);
1539 struct tty_ctx {
1540 struct screen *s;
1542 tty_ctx_redraw_cb redraw_cb;
1543 tty_ctx_set_client_cb set_client_cb;
1544 void *arg;
1546 const struct grid_cell *cell;
1547 int wrapped;
1549 u_int num;
1550 void *ptr;
1551 void *ptr2;
1554 * Whether this command should be sent even when the pane is not
1555 * visible (used for a passthrough sequence when allow-passthrough is
1556 * "all").
1558 int allow_invisible_panes;
1561 * Cursor and region position before the screen was updated - this is
1562 * where the command should be applied; the values in the screen have
1563 * already been updated.
1565 u_int ocx;
1566 u_int ocy;
1568 u_int orupper;
1569 u_int orlower;
1571 /* Target region (usually pane) offset and size. */
1572 u_int xoff;
1573 u_int yoff;
1574 u_int rxoff;
1575 u_int ryoff;
1576 u_int sx;
1577 u_int sy;
1579 /* The background colour used for clearing (erasing). */
1580 u_int bg;
1582 /* The default colours and palette. */
1583 struct grid_cell defaults;
1584 struct colour_palette *palette;
1586 /* Containing region (usually window) offset and size. */
1587 int bigger;
1588 u_int wox;
1589 u_int woy;
1590 u_int wsx;
1591 u_int wsy;
1594 /* Saved message entry. */
1595 struct message_entry {
1596 char *msg;
1597 u_int msg_num;
1598 struct timeval msg_time;
1600 TAILQ_ENTRY(message_entry) entry;
1602 TAILQ_HEAD(message_list, message_entry);
1604 /* Argument type. */
1605 enum args_type {
1606 ARGS_NONE,
1607 ARGS_STRING,
1608 ARGS_COMMANDS
1611 /* Argument value. */
1612 struct args_value {
1613 enum args_type type;
1614 union {
1615 char *string;
1616 struct cmd_list *cmdlist;
1618 char *cached;
1619 TAILQ_ENTRY(args_value) entry;
1622 /* Arguments set. */
1623 struct args_entry;
1624 RB_HEAD(args_tree, args_entry);
1626 /* Arguments parsing type. */
1627 enum args_parse_type {
1628 ARGS_PARSE_INVALID,
1629 ARGS_PARSE_STRING,
1630 ARGS_PARSE_COMMANDS_OR_STRING,
1631 ARGS_PARSE_COMMANDS
1634 /* Arguments parsing state. */
1635 typedef enum args_parse_type (*args_parse_cb)(struct args *, u_int, char **);
1636 struct args_parse {
1637 const char *template;
1638 int lower;
1639 int upper;
1640 args_parse_cb cb;
1643 /* Command find structures. */
1644 enum cmd_find_type {
1645 CMD_FIND_PANE,
1646 CMD_FIND_WINDOW,
1647 CMD_FIND_SESSION,
1649 struct cmd_find_state {
1650 int flags;
1651 struct cmd_find_state *current;
1653 struct session *s;
1654 struct winlink *wl;
1655 struct window *w;
1656 struct window_pane *wp;
1657 int idx;
1660 /* Command find flags. */
1661 #define CMD_FIND_PREFER_UNATTACHED 0x1
1662 #define CMD_FIND_QUIET 0x2
1663 #define CMD_FIND_WINDOW_INDEX 0x4
1664 #define CMD_FIND_DEFAULT_MARKED 0x8
1665 #define CMD_FIND_EXACT_SESSION 0x10
1666 #define CMD_FIND_EXACT_WINDOW 0x20
1667 #define CMD_FIND_CANFAIL 0x40
1669 /* List of commands. */
1670 struct cmd_list {
1671 int references;
1672 u_int group;
1673 struct cmds *list;
1676 /* Command return values. */
1677 enum cmd_retval {
1678 CMD_RETURN_ERROR = -1,
1679 CMD_RETURN_NORMAL = 0,
1680 CMD_RETURN_WAIT,
1681 CMD_RETURN_STOP
1684 /* Command parse result. */
1685 enum cmd_parse_status {
1686 CMD_PARSE_ERROR,
1687 CMD_PARSE_SUCCESS
1689 struct cmd_parse_result {
1690 enum cmd_parse_status status;
1691 struct cmd_list *cmdlist;
1692 char *error;
1694 struct cmd_parse_input {
1695 int flags;
1696 #define CMD_PARSE_QUIET 0x1
1697 #define CMD_PARSE_PARSEONLY 0x2
1698 #define CMD_PARSE_NOALIAS 0x4
1699 #define CMD_PARSE_VERBOSE 0x8
1700 #define CMD_PARSE_ONEGROUP 0x10
1702 const char *file;
1703 u_int line;
1705 struct cmdq_item *item;
1706 struct client *c;
1707 struct cmd_find_state fs;
1710 /* Command queue flags. */
1711 #define CMDQ_STATE_REPEAT 0x1
1712 #define CMDQ_STATE_CONTROL 0x2
1713 #define CMDQ_STATE_NOHOOKS 0x4
1715 /* Command queue callback. */
1716 typedef enum cmd_retval (*cmdq_cb) (struct cmdq_item *, void *);
1718 /* Command definition flag. */
1719 struct cmd_entry_flag {
1720 char flag;
1721 enum cmd_find_type type;
1722 int flags;
1725 /* Command definition. */
1726 struct cmd_entry {
1727 const char *name;
1728 const char *alias;
1730 struct args_parse args;
1731 const char *usage;
1733 struct cmd_entry_flag source;
1734 struct cmd_entry_flag target;
1736 #define CMD_STARTSERVER 0x1
1737 #define CMD_READONLY 0x2
1738 #define CMD_AFTERHOOK 0x4
1739 #define CMD_CLIENT_CFLAG 0x8
1740 #define CMD_CLIENT_TFLAG 0x10
1741 #define CMD_CLIENT_CANFAIL 0x20
1742 int flags;
1744 enum cmd_retval (*exec)(struct cmd *, struct cmdq_item *);
1747 /* Status line. */
1748 #define STATUS_LINES_LIMIT 5
1749 struct status_line_entry {
1750 char *expanded;
1751 struct style_ranges ranges;
1753 struct status_line {
1754 struct event timer;
1756 struct screen screen;
1757 struct screen *active;
1758 int references;
1760 struct grid_cell style;
1761 struct status_line_entry entries[STATUS_LINES_LIMIT];
1764 /* Prompt type. */
1765 #define PROMPT_NTYPES 4
1766 enum prompt_type {
1767 PROMPT_TYPE_COMMAND,
1768 PROMPT_TYPE_SEARCH,
1769 PROMPT_TYPE_TARGET,
1770 PROMPT_TYPE_WINDOW_TARGET,
1771 PROMPT_TYPE_INVALID = 0xff
1774 /* File in client. */
1775 typedef void (*client_file_cb) (struct client *, const char *, int, int,
1776 struct evbuffer *, void *);
1777 struct client_file {
1778 struct client *c;
1779 struct tmuxpeer *peer;
1780 struct client_files *tree;
1781 int references;
1782 int stream;
1784 char *path;
1785 struct evbuffer *buffer;
1786 struct bufferevent *event;
1788 int fd;
1789 int error;
1790 int closed;
1792 client_file_cb cb;
1793 void *data;
1795 RB_ENTRY(client_file) entry;
1797 RB_HEAD(client_files, client_file);
1799 /* Client window. */
1800 struct client_window {
1801 u_int window;
1802 struct window_pane *pane;
1804 u_int sx;
1805 u_int sy;
1807 RB_ENTRY(client_window) entry;
1809 RB_HEAD(client_windows, client_window);
1811 /* Visible areas not obstructed by overlays. */
1812 #define OVERLAY_MAX_RANGES 3
1813 struct overlay_ranges {
1814 u_int px[OVERLAY_MAX_RANGES];
1815 u_int nx[OVERLAY_MAX_RANGES];
1818 /* Client connection. */
1819 typedef int (*prompt_input_cb)(struct client *, void *, const char *, int);
1820 typedef void (*prompt_free_cb)(void *);
1821 typedef void (*overlay_check_cb)(struct client*, void *, u_int, u_int, u_int,
1822 struct overlay_ranges *);
1823 typedef struct screen *(*overlay_mode_cb)(struct client *, void *, u_int *,
1824 u_int *);
1825 typedef void (*overlay_draw_cb)(struct client *, void *,
1826 struct screen_redraw_ctx *);
1827 typedef int (*overlay_key_cb)(struct client *, void *, struct key_event *);
1828 typedef void (*overlay_free_cb)(struct client *, void *);
1829 typedef void (*overlay_resize_cb)(struct client *, void *);
1830 struct client {
1831 const char *name;
1832 struct tmuxpeer *peer;
1833 struct cmdq_list *queue;
1835 struct client_windows windows;
1837 struct control_state *control_state;
1838 u_int pause_age;
1840 pid_t pid;
1841 int fd;
1842 int out_fd;
1843 struct event event;
1844 int retval;
1846 struct timeval creation_time;
1847 struct timeval activity_time;
1848 struct timeval last_activity_time;
1850 struct environ *environ;
1851 struct format_job_tree *jobs;
1853 char *title;
1854 char *path;
1855 const char *cwd;
1857 char *term_name;
1858 int term_features;
1859 char *term_type;
1860 char **term_caps;
1861 u_int term_ncaps;
1863 char *ttyname;
1864 struct tty tty;
1866 size_t written;
1867 size_t discarded;
1868 size_t redraw;
1870 struct event repeat_timer;
1872 struct event click_timer;
1873 u_int click_button;
1874 struct mouse_event click_event;
1876 struct status_line status;
1878 #define CLIENT_TERMINAL 0x1
1879 #define CLIENT_LOGIN 0x2
1880 #define CLIENT_EXIT 0x4
1881 #define CLIENT_REDRAWWINDOW 0x8
1882 #define CLIENT_REDRAWSTATUS 0x10
1883 #define CLIENT_REPEAT 0x20
1884 #define CLIENT_SUSPENDED 0x40
1885 #define CLIENT_ATTACHED 0x80
1886 #define CLIENT_EXITED 0x100
1887 #define CLIENT_DEAD 0x200
1888 #define CLIENT_REDRAWBORDERS 0x400
1889 #define CLIENT_READONLY 0x800
1890 #define CLIENT_NOSTARTSERVER 0x1000
1891 #define CLIENT_CONTROL 0x2000
1892 #define CLIENT_CONTROLCONTROL 0x4000
1893 #define CLIENT_FOCUSED 0x8000
1894 #define CLIENT_UTF8 0x10000
1895 #define CLIENT_IGNORESIZE 0x20000
1896 #define CLIENT_IDENTIFIED 0x40000
1897 #define CLIENT_STATUSFORCE 0x80000
1898 #define CLIENT_DOUBLECLICK 0x100000
1899 #define CLIENT_TRIPLECLICK 0x200000
1900 #define CLIENT_SIZECHANGED 0x400000
1901 #define CLIENT_STATUSOFF 0x800000
1902 #define CLIENT_REDRAWSTATUSALWAYS 0x1000000
1903 #define CLIENT_REDRAWOVERLAY 0x2000000
1904 #define CLIENT_CONTROL_NOOUTPUT 0x4000000
1905 #define CLIENT_DEFAULTSOCKET 0x8000000
1906 #define CLIENT_STARTSERVER 0x10000000
1907 #define CLIENT_REDRAWPANES 0x20000000
1908 #define CLIENT_NOFORK 0x40000000
1909 #define CLIENT_ACTIVEPANE 0x80000000ULL
1910 #define CLIENT_CONTROL_PAUSEAFTER 0x100000000ULL
1911 #define CLIENT_CONTROL_WAITEXIT 0x200000000ULL
1912 #define CLIENT_WINDOWSIZECHANGED 0x400000000ULL
1913 #define CLIENT_CLIPBOARDBUFFER 0x800000000ULL
1914 #define CLIENT_BRACKETPASTING 0x1000000000ULL
1915 #define CLIENT_ASSUMEPASTING 0x2000000000ULL
1916 #define CLIENT_ALLREDRAWFLAGS \
1917 (CLIENT_REDRAWWINDOW| \
1918 CLIENT_REDRAWSTATUS| \
1919 CLIENT_REDRAWSTATUSALWAYS| \
1920 CLIENT_REDRAWBORDERS| \
1921 CLIENT_REDRAWOVERLAY| \
1922 CLIENT_REDRAWPANES)
1923 #define CLIENT_UNATTACHEDFLAGS \
1924 (CLIENT_DEAD| \
1925 CLIENT_SUSPENDED| \
1926 CLIENT_EXIT)
1927 #define CLIENT_NODETACHFLAGS \
1928 (CLIENT_DEAD| \
1929 CLIENT_EXIT)
1930 #define CLIENT_NOSIZEFLAGS \
1931 (CLIENT_DEAD| \
1932 CLIENT_SUSPENDED| \
1933 CLIENT_EXIT)
1934 uint64_t flags;
1936 enum {
1937 CLIENT_EXIT_RETURN,
1938 CLIENT_EXIT_SHUTDOWN,
1939 CLIENT_EXIT_DETACH
1940 } exit_type;
1941 enum msgtype exit_msgtype;
1942 char *exit_session;
1943 char *exit_message;
1945 struct key_table *keytable;
1946 key_code last_key;
1948 uint64_t redraw_panes;
1950 int message_ignore_keys;
1951 int message_ignore_styles;
1952 char *message_string;
1953 struct event message_timer;
1955 char *prompt_string;
1956 struct utf8_data *prompt_buffer;
1957 char *prompt_last;
1958 size_t prompt_index;
1959 prompt_input_cb prompt_inputcb;
1960 prompt_free_cb prompt_freecb;
1961 void *prompt_data;
1962 u_int prompt_hindex[PROMPT_NTYPES];
1963 enum {
1964 PROMPT_ENTRY,
1965 PROMPT_COMMAND
1966 } prompt_mode;
1967 struct utf8_data *prompt_saved;
1968 #define PROMPT_SINGLE 0x1
1969 #define PROMPT_NUMERIC 0x2
1970 #define PROMPT_INCREMENTAL 0x4
1971 #define PROMPT_NOFORMAT 0x8
1972 #define PROMPT_KEY 0x10
1973 #define PROMPT_ACCEPT 0x20
1974 int prompt_flags;
1975 enum prompt_type prompt_type;
1976 int prompt_cursor;
1978 struct session *session;
1979 struct session *last_session;
1981 int references;
1983 void *pan_window;
1984 u_int pan_ox;
1985 u_int pan_oy;
1987 overlay_check_cb overlay_check;
1988 overlay_mode_cb overlay_mode;
1989 overlay_draw_cb overlay_draw;
1990 overlay_key_cb overlay_key;
1991 overlay_free_cb overlay_free;
1992 overlay_resize_cb overlay_resize;
1993 void *overlay_data;
1994 struct event overlay_timer;
1996 struct client_files files;
1998 u_int *clipboard_panes;
1999 u_int clipboard_npanes;
2001 TAILQ_ENTRY(client) entry;
2003 TAILQ_HEAD(clients, client);
2005 /* Control mode subscription type. */
2006 enum control_sub_type {
2007 CONTROL_SUB_SESSION,
2008 CONTROL_SUB_PANE,
2009 CONTROL_SUB_ALL_PANES,
2010 CONTROL_SUB_WINDOW,
2011 CONTROL_SUB_ALL_WINDOWS
2014 /* Key binding and key table. */
2015 struct key_binding {
2016 key_code key;
2017 struct cmd_list *cmdlist;
2018 const char *note;
2020 int flags;
2021 #define KEY_BINDING_REPEAT 0x1
2023 RB_ENTRY(key_binding) entry;
2025 RB_HEAD(key_bindings, key_binding);
2027 struct key_table {
2028 const char *name;
2029 struct timeval activity_time;
2030 struct key_bindings key_bindings;
2031 struct key_bindings default_key_bindings;
2033 u_int references;
2035 RB_ENTRY(key_table) entry;
2037 RB_HEAD(key_tables, key_table);
2039 /* Option data. */
2040 RB_HEAD(options_array, options_array_item);
2041 union options_value {
2042 char *string;
2043 long long number;
2044 struct style style;
2045 struct options_array array;
2046 struct cmd_list *cmdlist;
2049 /* Option table entries. */
2050 enum options_table_type {
2051 OPTIONS_TABLE_STRING,
2052 OPTIONS_TABLE_NUMBER,
2053 OPTIONS_TABLE_KEY,
2054 OPTIONS_TABLE_COLOUR,
2055 OPTIONS_TABLE_FLAG,
2056 OPTIONS_TABLE_CHOICE,
2057 OPTIONS_TABLE_COMMAND
2060 #define OPTIONS_TABLE_NONE 0
2061 #define OPTIONS_TABLE_SERVER 0x1
2062 #define OPTIONS_TABLE_SESSION 0x2
2063 #define OPTIONS_TABLE_WINDOW 0x4
2064 #define OPTIONS_TABLE_PANE 0x8
2066 #define OPTIONS_TABLE_IS_ARRAY 0x1
2067 #define OPTIONS_TABLE_IS_HOOK 0x2
2068 #define OPTIONS_TABLE_IS_STYLE 0x4
2070 struct options_table_entry {
2071 const char *name;
2072 const char *alternative_name;
2073 enum options_table_type type;
2074 int scope;
2075 int flags;
2077 u_int minimum;
2078 u_int maximum;
2079 const char **choices;
2081 const char *default_str;
2082 long long default_num;
2083 const char **default_arr;
2085 const char *separator;
2086 const char *pattern;
2088 const char *text;
2089 const char *unit;
2092 struct options_name_map {
2093 const char *from;
2094 const char *to;
2097 /* Common command usages. */
2098 #define CMD_TARGET_PANE_USAGE "[-t target-pane]"
2099 #define CMD_TARGET_WINDOW_USAGE "[-t target-window]"
2100 #define CMD_TARGET_SESSION_USAGE "[-t target-session]"
2101 #define CMD_TARGET_CLIENT_USAGE "[-t target-client]"
2102 #define CMD_SRCDST_PANE_USAGE "[-s src-pane] [-t dst-pane]"
2103 #define CMD_SRCDST_WINDOW_USAGE "[-s src-window] [-t dst-window]"
2104 #define CMD_SRCDST_SESSION_USAGE "[-s src-session] [-t dst-session]"
2105 #define CMD_SRCDST_CLIENT_USAGE "[-s src-client] [-t dst-client]"
2106 #define CMD_BUFFER_USAGE "[-b buffer-name]"
2108 /* Spawn common context. */
2109 struct spawn_context {
2110 struct cmdq_item *item;
2112 struct session *s;
2113 struct winlink *wl;
2114 struct client *tc;
2116 struct window_pane *wp0;
2117 struct layout_cell *lc;
2119 const char *name;
2120 char **argv;
2121 int argc;
2122 struct environ *environ;
2124 int idx;
2125 const char *cwd;
2127 int flags;
2128 #define SPAWN_KILL 0x1
2129 #define SPAWN_DETACHED 0x2
2130 #define SPAWN_RESPAWN 0x4
2131 #define SPAWN_BEFORE 0x8
2132 #define SPAWN_NONOTIFY 0x10
2133 #define SPAWN_FULLSIZE 0x20
2134 #define SPAWN_EMPTY 0x40
2135 #define SPAWN_ZOOM 0x80
2138 /* Mode tree sort order. */
2139 struct mode_tree_sort_criteria {
2140 u_int field;
2141 int reversed;
2144 /* tmux.c */
2145 extern struct options *global_options;
2146 extern struct options *global_s_options;
2147 extern struct options *global_w_options;
2148 extern struct environ *global_environ;
2149 extern struct timeval start_time;
2150 extern const char *socket_path;
2151 extern const char *shell_command;
2152 extern int ptm_fd;
2153 extern const char *shell_command;
2154 int checkshell(const char *);
2155 void setblocking(int, int);
2156 char *shell_argv0(const char *, int);
2157 uint64_t get_timer(void);
2158 const char *sig2name(int);
2159 const char *find_cwd(void);
2160 const char *find_home(void);
2161 const char *getversion(void);
2163 /* proc.c */
2164 struct imsg;
2165 int proc_send(struct tmuxpeer *, enum msgtype, int, const void *, size_t);
2166 struct tmuxproc *proc_start(const char *);
2167 void proc_loop(struct tmuxproc *, int (*)(void));
2168 void proc_exit(struct tmuxproc *);
2169 void proc_set_signals(struct tmuxproc *, void(*)(int));
2170 void proc_clear_signals(struct tmuxproc *, int);
2171 struct tmuxpeer *proc_add_peer(struct tmuxproc *, int,
2172 void (*)(struct imsg *, void *), void *);
2173 void proc_remove_peer(struct tmuxpeer *);
2174 void proc_kill_peer(struct tmuxpeer *);
2175 void proc_flush_peer(struct tmuxpeer *);
2176 void proc_toggle_log(struct tmuxproc *);
2177 pid_t proc_fork_and_daemon(int *);
2178 uid_t proc_get_peer_uid(struct tmuxpeer *);
2180 /* cfg.c */
2181 extern int cfg_finished;
2182 extern struct client *cfg_client;
2183 extern char **cfg_files;
2184 extern u_int cfg_nfiles;
2185 extern int cfg_quiet;
2186 void start_cfg(void);
2187 int load_cfg(const char *, struct client *, struct cmdq_item *,
2188 struct cmd_find_state *, int, struct cmdq_item **);
2189 int load_cfg_from_buffer(const void *, size_t, const char *,
2190 struct client *, struct cmdq_item *, struct cmd_find_state *,
2191 int, struct cmdq_item **);
2192 void printflike(1, 2) cfg_add_cause(const char *, ...);
2193 void cfg_print_causes(struct cmdq_item *);
2194 void cfg_show_causes(struct session *);
2196 /* paste.c */
2197 struct paste_buffer;
2198 const char *paste_buffer_name(struct paste_buffer *);
2199 u_int paste_buffer_order(struct paste_buffer *);
2200 time_t paste_buffer_created(struct paste_buffer *);
2201 const char *paste_buffer_data(struct paste_buffer *, size_t *);
2202 struct paste_buffer *paste_walk(struct paste_buffer *);
2203 int paste_is_empty(void);
2204 struct paste_buffer *paste_get_top(const char **);
2205 struct paste_buffer *paste_get_name(const char *);
2206 void paste_free(struct paste_buffer *);
2207 void paste_add(const char *, char *, size_t);
2208 int paste_rename(const char *, const char *, char **);
2209 int paste_set(char *, size_t, const char *, char **);
2210 void paste_replace(struct paste_buffer *, char *, size_t);
2211 char *paste_make_sample(struct paste_buffer *);
2213 /* format.c */
2214 #define FORMAT_STATUS 0x1
2215 #define FORMAT_FORCE 0x2
2216 #define FORMAT_NOJOBS 0x4
2217 #define FORMAT_VERBOSE 0x8
2218 #define FORMAT_NONE 0
2219 #define FORMAT_PANE 0x80000000U
2220 #define FORMAT_WINDOW 0x40000000U
2221 struct format_tree;
2222 struct format_modifier;
2223 typedef void *(*format_cb)(struct format_tree *);
2224 void format_tidy_jobs(void);
2225 const char *format_skip(const char *, const char *);
2226 int format_true(const char *);
2227 struct format_tree *format_create(struct client *, struct cmdq_item *, int,
2228 int);
2229 void format_free(struct format_tree *);
2230 void format_merge(struct format_tree *, struct format_tree *);
2231 struct window_pane *format_get_pane(struct format_tree *);
2232 void printflike(3, 4) format_add(struct format_tree *, const char *,
2233 const char *, ...);
2234 void format_add_tv(struct format_tree *, const char *,
2235 struct timeval *);
2236 void format_add_cb(struct format_tree *, const char *, format_cb);
2237 void format_log_debug(struct format_tree *, const char *);
2238 void format_each(struct format_tree *, void (*)(const char *,
2239 const char *, void *), void *);
2240 char *format_pretty_time(time_t, int);
2241 char *format_expand_time(struct format_tree *, const char *);
2242 char *format_expand(struct format_tree *, const char *);
2243 char *format_single(struct cmdq_item *, const char *,
2244 struct client *, struct session *, struct winlink *,
2245 struct window_pane *);
2246 char *format_single_from_state(struct cmdq_item *, const char *,
2247 struct client *, struct cmd_find_state *);
2248 char *format_single_from_target(struct cmdq_item *, const char *);
2249 struct format_tree *format_create_defaults(struct cmdq_item *, struct client *,
2250 struct session *, struct winlink *, struct window_pane *);
2251 struct format_tree *format_create_from_state(struct cmdq_item *,
2252 struct client *, struct cmd_find_state *);
2253 struct format_tree *format_create_from_target(struct cmdq_item *);
2254 void format_defaults(struct format_tree *, struct client *,
2255 struct session *, struct winlink *, struct window_pane *);
2256 void format_defaults_window(struct format_tree *, struct window *);
2257 void format_defaults_pane(struct format_tree *,
2258 struct window_pane *);
2259 void format_defaults_paste_buffer(struct format_tree *,
2260 struct paste_buffer *);
2261 void format_lost_client(struct client *);
2262 char *format_grid_word(struct grid *, u_int, u_int);
2263 char *format_grid_hyperlink(struct grid *, u_int, u_int,
2264 struct screen *);
2265 char *format_grid_line(struct grid *, u_int);
2267 /* format-draw.c */
2268 void format_draw(struct screen_write_ctx *,
2269 const struct grid_cell *, u_int, const char *,
2270 struct style_ranges *, int);
2271 u_int format_width(const char *);
2272 char *format_trim_left(const char *, u_int);
2273 char *format_trim_right(const char *, u_int);
2275 /* notify.c */
2276 void notify_hook(struct cmdq_item *, const char *);
2277 void notify_client(const char *, struct client *);
2278 void notify_session(const char *, struct session *);
2279 void notify_winlink(const char *, struct winlink *);
2280 void notify_session_window(const char *, struct session *, struct window *);
2281 void notify_window(const char *, struct window *);
2282 void notify_pane(const char *, struct window_pane *);
2283 void notify_paste_buffer(const char *, int);
2285 /* options.c */
2286 struct options *options_create(struct options *);
2287 void options_free(struct options *);
2288 struct options *options_get_parent(struct options *);
2289 void options_set_parent(struct options *, struct options *);
2290 struct options_entry *options_first(struct options *);
2291 struct options_entry *options_next(struct options_entry *);
2292 struct options_entry *options_empty(struct options *,
2293 const struct options_table_entry *);
2294 struct options_entry *options_default(struct options *,
2295 const struct options_table_entry *);
2296 char *options_default_to_string(const struct options_table_entry *);
2297 const char *options_name(struct options_entry *);
2298 struct options *options_owner(struct options_entry *);
2299 const struct options_table_entry *options_table_entry(struct options_entry *);
2300 struct options_entry *options_get_only(struct options *, const char *);
2301 struct options_entry *options_get(struct options *, const char *);
2302 void options_array_clear(struct options_entry *);
2303 union options_value *options_array_get(struct options_entry *, u_int);
2304 int options_array_set(struct options_entry *, u_int, const char *,
2305 int, char **);
2306 int options_array_assign(struct options_entry *, const char *,
2307 char **);
2308 struct options_array_item *options_array_first(struct options_entry *);
2309 struct options_array_item *options_array_next(struct options_array_item *);
2310 u_int options_array_item_index(struct options_array_item *);
2311 union options_value *options_array_item_value(struct options_array_item *);
2312 int options_is_array(struct options_entry *);
2313 int options_is_string(struct options_entry *);
2314 char *options_to_string(struct options_entry *, int, int);
2315 char *options_parse(const char *, int *);
2316 struct options_entry *options_parse_get(struct options *, const char *, int *,
2317 int);
2318 char *options_match(const char *, int *, int *);
2319 struct options_entry *options_match_get(struct options *, const char *, int *,
2320 int, int *);
2321 const char *options_get_string(struct options *, const char *);
2322 long long options_get_number(struct options *, const char *);
2323 struct options_entry * printflike(4, 5) options_set_string(struct options *,
2324 const char *, int, const char *, ...);
2325 struct options_entry *options_set_number(struct options *, const char *,
2326 long long);
2327 int options_scope_from_name(struct args *, int,
2328 const char *, struct cmd_find_state *, struct options **,
2329 char **);
2330 int options_scope_from_flags(struct args *, int,
2331 struct cmd_find_state *, struct options **, char **);
2332 struct style *options_string_to_style(struct options *, const char *,
2333 struct format_tree *);
2334 int options_from_string(struct options *,
2335 const struct options_table_entry *, const char *,
2336 const char *, int, char **);
2337 int options_find_choice(const struct options_table_entry *,
2338 const char *, char **);
2339 void options_push_changes(const char *);
2340 int options_remove_or_default(struct options_entry *, int,
2341 char **);
2343 /* options-table.c */
2344 extern const struct options_table_entry options_table[];
2345 extern const struct options_name_map options_other_names[];
2347 /* job.c */
2348 typedef void (*job_update_cb) (struct job *);
2349 typedef void (*job_complete_cb) (struct job *);
2350 typedef void (*job_free_cb) (void *);
2351 #define JOB_NOWAIT 0x1
2352 #define JOB_KEEPWRITE 0x2
2353 #define JOB_PTY 0x4
2354 #define JOB_DEFAULTSHELL 0x8
2355 struct job *job_run(const char *, int, char **, struct environ *,
2356 struct session *, const char *, job_update_cb,
2357 job_complete_cb, job_free_cb, void *, int, int, int);
2358 void job_free(struct job *);
2359 int job_transfer(struct job *, pid_t *, char *, size_t);
2360 void job_resize(struct job *, u_int, u_int);
2361 void job_check_died(pid_t, int);
2362 int job_get_status(struct job *);
2363 void *job_get_data(struct job *);
2364 struct bufferevent *job_get_event(struct job *);
2365 void job_kill_all(void);
2366 int job_still_running(void);
2367 void job_print_summary(struct cmdq_item *, int);
2369 /* environ.c */
2370 struct environ *environ_create(void);
2371 void environ_free(struct environ *);
2372 struct environ_entry *environ_first(struct environ *);
2373 struct environ_entry *environ_next(struct environ_entry *);
2374 void environ_copy(struct environ *, struct environ *);
2375 struct environ_entry *environ_find(struct environ *, const char *);
2376 void printflike(4, 5) environ_set(struct environ *, const char *, int,
2377 const char *, ...);
2378 void environ_clear(struct environ *, const char *);
2379 void environ_put(struct environ *, const char *, int);
2380 void environ_unset(struct environ *, const char *);
2381 void environ_update(struct options *, struct environ *, struct environ *);
2382 void environ_push(struct environ *);
2383 void printflike(2, 3) environ_log(struct environ *, const char *, ...);
2384 struct environ *environ_for_session(struct session *, int);
2386 /* tty.c */
2387 void tty_create_log(void);
2388 int tty_window_bigger(struct tty *);
2389 int tty_window_offset(struct tty *, u_int *, u_int *, u_int *, u_int *);
2390 void tty_update_window_offset(struct window *);
2391 void tty_update_client_offset(struct client *);
2392 void tty_raw(struct tty *, const char *);
2393 void tty_attributes(struct tty *, const struct grid_cell *,
2394 const struct grid_cell *, struct colour_palette *,
2395 struct hyperlinks *);
2396 void tty_reset(struct tty *);
2397 void tty_region_off(struct tty *);
2398 void tty_margin_off(struct tty *);
2399 void tty_cursor(struct tty *, u_int, u_int);
2400 void tty_clipboard_query(struct tty *);
2401 void tty_putcode(struct tty *, enum tty_code_code);
2402 void tty_putcode_i(struct tty *, enum tty_code_code, int);
2403 void tty_putcode_ii(struct tty *, enum tty_code_code, int, int);
2404 void tty_putcode_iii(struct tty *, enum tty_code_code, int, int, int);
2405 void tty_putcode_s(struct tty *, enum tty_code_code, const char *);
2406 void tty_putcode_ss(struct tty *, enum tty_code_code, const char *,
2407 const char *);
2408 void tty_puts(struct tty *, const char *);
2409 void tty_putc(struct tty *, u_char);
2410 void tty_putn(struct tty *, const void *, size_t, u_int);
2411 void tty_cell(struct tty *, const struct grid_cell *,
2412 const struct grid_cell *, struct colour_palette *,
2413 struct hyperlinks *);
2414 int tty_init(struct tty *, struct client *);
2415 void tty_resize(struct tty *);
2416 void tty_set_size(struct tty *, u_int, u_int, u_int, u_int);
2417 void tty_invalidate(struct tty *);
2418 void tty_start_tty(struct tty *);
2419 void tty_send_requests(struct tty *);
2420 void tty_repeat_requests(struct tty *);
2421 void tty_stop_tty(struct tty *);
2422 void tty_set_title(struct tty *, const char *);
2423 void tty_set_path(struct tty *, const char *);
2424 void tty_update_mode(struct tty *, int, struct screen *);
2425 void tty_draw_line(struct tty *, struct screen *, u_int, u_int, u_int,
2426 u_int, u_int, const struct grid_cell *, struct colour_palette *);
2428 #ifdef ENABLE_SIXEL
2429 void tty_draw_images(struct client *, struct window_pane *, struct screen *);
2430 #endif
2432 void tty_sync_start(struct tty *);
2433 void tty_sync_end(struct tty *);
2434 int tty_open(struct tty *, char **);
2435 void tty_close(struct tty *);
2436 void tty_free(struct tty *);
2437 void tty_update_features(struct tty *);
2438 void tty_set_selection(struct tty *, const char *, const char *, size_t);
2439 void tty_write(void (*)(struct tty *, const struct tty_ctx *),
2440 struct tty_ctx *);
2441 void tty_cmd_alignmenttest(struct tty *, const struct tty_ctx *);
2442 void tty_cmd_cell(struct tty *, const struct tty_ctx *);
2443 void tty_cmd_cells(struct tty *, const struct tty_ctx *);
2444 void tty_cmd_clearendofline(struct tty *, const struct tty_ctx *);
2445 void tty_cmd_clearendofscreen(struct tty *, const struct tty_ctx *);
2446 void tty_cmd_clearline(struct tty *, const struct tty_ctx *);
2447 void tty_cmd_clearscreen(struct tty *, const struct tty_ctx *);
2448 void tty_cmd_clearstartofline(struct tty *, const struct tty_ctx *);
2449 void tty_cmd_clearstartofscreen(struct tty *, const struct tty_ctx *);
2450 void tty_cmd_deletecharacter(struct tty *, const struct tty_ctx *);
2451 void tty_cmd_clearcharacter(struct tty *, const struct tty_ctx *);
2452 void tty_cmd_deleteline(struct tty *, const struct tty_ctx *);
2453 void tty_cmd_insertcharacter(struct tty *, const struct tty_ctx *);
2454 void tty_cmd_insertline(struct tty *, const struct tty_ctx *);
2455 void tty_cmd_linefeed(struct tty *, const struct tty_ctx *);
2456 void tty_cmd_scrollup(struct tty *, const struct tty_ctx *);
2457 void tty_cmd_scrolldown(struct tty *, const struct tty_ctx *);
2458 void tty_cmd_reverseindex(struct tty *, const struct tty_ctx *);
2459 void tty_cmd_setselection(struct tty *, const struct tty_ctx *);
2460 void tty_cmd_rawstring(struct tty *, const struct tty_ctx *);
2462 #ifdef ENABLE_SIXEL
2463 void tty_cmd_sixelimage(struct tty *, const struct tty_ctx *);
2464 #endif
2466 void tty_cmd_syncstart(struct tty *, const struct tty_ctx *);
2467 void tty_default_colours(struct grid_cell *, struct window_pane *);
2469 /* tty-term.c */
2470 extern struct tty_terms tty_terms;
2471 u_int tty_term_ncodes(void);
2472 void tty_term_apply(struct tty_term *, const char *, int);
2473 void tty_term_apply_overrides(struct tty_term *);
2474 struct tty_term *tty_term_create(struct tty *, char *, char **, u_int, int *,
2475 char **);
2476 void tty_term_free(struct tty_term *);
2477 int tty_term_read_list(const char *, int, char ***, u_int *,
2478 char **);
2479 void tty_term_free_list(char **, u_int);
2480 int tty_term_has(struct tty_term *, enum tty_code_code);
2481 const char *tty_term_string(struct tty_term *, enum tty_code_code);
2482 const char *tty_term_string_i(struct tty_term *, enum tty_code_code, int);
2483 const char *tty_term_string_ii(struct tty_term *, enum tty_code_code, int,
2484 int);
2485 const char *tty_term_string_iii(struct tty_term *, enum tty_code_code, int,
2486 int, int);
2487 const char *tty_term_string_s(struct tty_term *, enum tty_code_code,
2488 const char *);
2489 const char *tty_term_string_ss(struct tty_term *, enum tty_code_code,
2490 const char *, const char *);
2491 int tty_term_number(struct tty_term *, enum tty_code_code);
2492 int tty_term_flag(struct tty_term *, enum tty_code_code);
2493 const char *tty_term_describe(struct tty_term *, enum tty_code_code);
2495 /* tty-features.c */
2496 void tty_add_features(int *, const char *, const char *);
2497 const char *tty_get_features(int);
2498 int tty_apply_features(struct tty_term *, int);
2499 void tty_default_features(int *, const char *, u_int);
2501 /* tty-acs.c */
2502 int tty_acs_needed(struct tty *);
2503 const char *tty_acs_get(struct tty *, u_char);
2504 int tty_acs_reverse_get(struct tty *, const char *, size_t);
2505 const struct utf8_data *tty_acs_double_borders(int);
2506 const struct utf8_data *tty_acs_heavy_borders(int);
2507 const struct utf8_data *tty_acs_rounded_borders(int);
2509 /* tty-keys.c */
2510 void tty_keys_build(struct tty *);
2511 void tty_keys_free(struct tty *);
2512 int tty_keys_next(struct tty *);
2513 int tty_keys_colours(struct tty *, const char *, size_t, size_t *,
2514 int *, int *);
2516 /* arguments.c */
2517 void args_set(struct args *, u_char, struct args_value *, int);
2518 struct args *args_create(void);
2519 struct args *args_parse(const struct args_parse *, struct args_value *,
2520 u_int, char **);
2521 struct args *args_copy(struct args *, int, char **);
2522 void args_to_vector(struct args *, int *, char ***);
2523 struct args_value *args_from_vector(int, char **);
2524 void args_free_value(struct args_value *);
2525 void args_free_values(struct args_value *, u_int);
2526 void args_free(struct args *);
2527 char *args_print(struct args *);
2528 char *args_escape(const char *);
2529 int args_has(struct args *, u_char);
2530 const char *args_get(struct args *, u_char);
2531 u_char args_first(struct args *, struct args_entry **);
2532 u_char args_next(struct args_entry **);
2533 u_int args_count(struct args *);
2534 struct args_value *args_values(struct args *);
2535 struct args_value *args_value(struct args *, u_int);
2536 const char *args_string(struct args *, u_int);
2537 struct cmd_list *args_make_commands_now(struct cmd *, struct cmdq_item *,
2538 u_int, int);
2539 struct args_command_state *args_make_commands_prepare(struct cmd *,
2540 struct cmdq_item *, u_int, const char *, int, int);
2541 struct cmd_list *args_make_commands(struct args_command_state *, int, char **,
2542 char **);
2543 void args_make_commands_free(struct args_command_state *);
2544 char *args_make_commands_get_command(struct args_command_state *);
2545 struct args_value *args_first_value(struct args *, u_char);
2546 struct args_value *args_next_value(struct args_value *);
2547 long long args_strtonum(struct args *, u_char, long long, long long,
2548 char **);
2549 long long args_strtonum_and_expand(struct args *, u_char, long long,
2550 long long, struct cmdq_item *, char **);
2551 long long args_percentage(struct args *, u_char, long long,
2552 long long, long long, char **);
2553 long long args_string_percentage(const char *, long long, long long,
2554 long long, char **);
2555 long long args_percentage_and_expand(struct args *, u_char, long long,
2556 long long, long long, struct cmdq_item *, char **);
2557 long long args_string_percentage_and_expand(const char *, long long,
2558 long long, long long, struct cmdq_item *, char **);
2560 /* cmd-find.c */
2561 int cmd_find_target(struct cmd_find_state *, struct cmdq_item *,
2562 const char *, enum cmd_find_type, int);
2563 struct client *cmd_find_best_client(struct session *);
2564 struct client *cmd_find_client(struct cmdq_item *, const char *, int);
2565 void cmd_find_clear_state(struct cmd_find_state *, int);
2566 int cmd_find_empty_state(struct cmd_find_state *);
2567 int cmd_find_valid_state(struct cmd_find_state *);
2568 void cmd_find_copy_state(struct cmd_find_state *,
2569 struct cmd_find_state *);
2570 void cmd_find_from_session(struct cmd_find_state *,
2571 struct session *, int);
2572 void cmd_find_from_winlink(struct cmd_find_state *,
2573 struct winlink *, int);
2574 int cmd_find_from_session_window(struct cmd_find_state *,
2575 struct session *, struct window *, int);
2576 int cmd_find_from_window(struct cmd_find_state *, struct window *,
2577 int);
2578 void cmd_find_from_winlink_pane(struct cmd_find_state *,
2579 struct winlink *, struct window_pane *, int);
2580 int cmd_find_from_pane(struct cmd_find_state *,
2581 struct window_pane *, int);
2582 int cmd_find_from_client(struct cmd_find_state *, struct client *,
2583 int);
2584 int cmd_find_from_mouse(struct cmd_find_state *,
2585 struct mouse_event *, int);
2586 int cmd_find_from_nothing(struct cmd_find_state *, int);
2588 /* cmd.c */
2589 extern const struct cmd_entry *cmd_table[];
2590 void printflike(3, 4) cmd_log_argv(int, char **, const char *, ...);
2591 void cmd_prepend_argv(int *, char ***, const char *);
2592 void cmd_append_argv(int *, char ***, const char *);
2593 int cmd_pack_argv(int, char **, char *, size_t);
2594 int cmd_unpack_argv(char *, size_t, int, char ***);
2595 char **cmd_copy_argv(int, char **);
2596 void cmd_free_argv(int, char **);
2597 char *cmd_stringify_argv(int, char **);
2598 char *cmd_get_alias(const char *);
2599 const struct cmd_entry *cmd_get_entry(struct cmd *);
2600 struct args *cmd_get_args(struct cmd *);
2601 u_int cmd_get_group(struct cmd *);
2602 void cmd_get_source(struct cmd *, const char **, u_int *);
2603 struct cmd *cmd_parse(struct args_value *, u_int, const char *, u_int,
2604 char **);
2605 struct cmd *cmd_copy(struct cmd *, int, char **);
2606 void cmd_free(struct cmd *);
2607 char *cmd_print(struct cmd *);
2608 struct cmd_list *cmd_list_new(void);
2609 struct cmd_list *cmd_list_copy(struct cmd_list *, int, char **);
2610 void cmd_list_append(struct cmd_list *, struct cmd *);
2611 void cmd_list_append_all(struct cmd_list *, struct cmd_list *);
2612 void cmd_list_move(struct cmd_list *, struct cmd_list *);
2613 void cmd_list_free(struct cmd_list *);
2614 char *cmd_list_print(struct cmd_list *, int);
2615 struct cmd *cmd_list_first(struct cmd_list *);
2616 struct cmd *cmd_list_next(struct cmd *);
2617 int cmd_list_all_have(struct cmd_list *, int);
2618 int cmd_list_any_have(struct cmd_list *, int);
2619 int cmd_mouse_at(struct window_pane *, struct mouse_event *,
2620 u_int *, u_int *, int);
2621 struct winlink *cmd_mouse_window(struct mouse_event *, struct session **);
2622 struct window_pane *cmd_mouse_pane(struct mouse_event *, struct session **,
2623 struct winlink **);
2624 char *cmd_template_replace(const char *, const char *, int);
2626 /* cmd-attach-session.c */
2627 enum cmd_retval cmd_attach_session(struct cmdq_item *, const char *, int, int,
2628 int, const char *, int, const char *);
2630 /* cmd-parse.c */
2631 struct cmd_parse_result *cmd_parse_from_file(FILE *, struct cmd_parse_input *);
2632 struct cmd_parse_result *cmd_parse_from_string(const char *,
2633 struct cmd_parse_input *);
2634 enum cmd_parse_status cmd_parse_and_insert(const char *,
2635 struct cmd_parse_input *, struct cmdq_item *,
2636 struct cmdq_state *, char **);
2637 enum cmd_parse_status cmd_parse_and_append(const char *,
2638 struct cmd_parse_input *, struct client *,
2639 struct cmdq_state *, char **);
2640 struct cmd_parse_result *cmd_parse_from_buffer(const void *, size_t,
2641 struct cmd_parse_input *);
2642 struct cmd_parse_result *cmd_parse_from_arguments(struct args_value *, u_int,
2643 struct cmd_parse_input *);
2645 /* cmd-queue.c */
2646 struct cmdq_state *cmdq_new_state(struct cmd_find_state *, struct key_event *,
2647 int);
2648 struct cmdq_state *cmdq_link_state(struct cmdq_state *);
2649 struct cmdq_state *cmdq_copy_state(struct cmdq_state *,
2650 struct cmd_find_state *);
2651 void cmdq_free_state(struct cmdq_state *);
2652 void printflike(3, 4) cmdq_add_format(struct cmdq_state *, const char *,
2653 const char *, ...);
2654 void cmdq_add_formats(struct cmdq_state *, struct format_tree *);
2655 void cmdq_merge_formats(struct cmdq_item *, struct format_tree *);
2656 struct cmdq_list *cmdq_new(void);
2657 void cmdq_free(struct cmdq_list *);
2658 const char *cmdq_get_name(struct cmdq_item *);
2659 struct client *cmdq_get_client(struct cmdq_item *);
2660 struct client *cmdq_get_target_client(struct cmdq_item *);
2661 struct cmdq_state *cmdq_get_state(struct cmdq_item *);
2662 struct cmd_find_state *cmdq_get_target(struct cmdq_item *);
2663 struct cmd_find_state *cmdq_get_source(struct cmdq_item *);
2664 struct key_event *cmdq_get_event(struct cmdq_item *);
2665 struct cmd_find_state *cmdq_get_current(struct cmdq_item *);
2666 int cmdq_get_flags(struct cmdq_item *);
2667 struct cmdq_item *cmdq_get_command(struct cmd_list *, struct cmdq_state *);
2668 #define cmdq_get_callback(cb, data) cmdq_get_callback1(#cb, cb, data)
2669 struct cmdq_item *cmdq_get_callback1(const char *, cmdq_cb, void *);
2670 struct cmdq_item *cmdq_get_error(const char *);
2671 struct cmdq_item *cmdq_insert_after(struct cmdq_item *, struct cmdq_item *);
2672 struct cmdq_item *cmdq_append(struct client *, struct cmdq_item *);
2673 void printflike(4, 5) cmdq_insert_hook(struct session *, struct cmdq_item *,
2674 struct cmd_find_state *, const char *, ...);
2675 void cmdq_continue(struct cmdq_item *);
2676 u_int cmdq_next(struct client *);
2677 struct cmdq_item *cmdq_running(struct client *);
2678 void cmdq_guard(struct cmdq_item *, const char *, int);
2679 void printflike(2, 3) cmdq_print(struct cmdq_item *, const char *, ...);
2680 void cmdq_print_data(struct cmdq_item *, int, struct evbuffer *);
2681 void printflike(2, 3) cmdq_error(struct cmdq_item *, const char *, ...);
2683 /* cmd-wait-for.c */
2684 void cmd_wait_for_flush(void);
2686 /* client.c */
2687 int client_main(struct event_base *, int, char **, uint64_t, int);
2689 /* key-bindings.c */
2690 struct key_table *key_bindings_get_table(const char *, int);
2691 struct key_table *key_bindings_first_table(void);
2692 struct key_table *key_bindings_next_table(struct key_table *);
2693 void key_bindings_unref_table(struct key_table *);
2694 struct key_binding *key_bindings_get(struct key_table *, key_code);
2695 struct key_binding *key_bindings_get_default(struct key_table *, key_code);
2696 struct key_binding *key_bindings_first(struct key_table *);
2697 struct key_binding *key_bindings_next(struct key_table *, struct key_binding *);
2698 void key_bindings_add(const char *, key_code, const char *, int,
2699 struct cmd_list *);
2700 void key_bindings_remove(const char *, key_code);
2701 void key_bindings_reset(const char *, key_code);
2702 void key_bindings_remove_table(const char *);
2703 void key_bindings_reset_table(const char *);
2704 void key_bindings_init(void);
2705 struct cmdq_item *key_bindings_dispatch(struct key_binding *,
2706 struct cmdq_item *, struct client *, struct key_event *,
2707 struct cmd_find_state *);
2709 /* key-string.c */
2710 key_code key_string_lookup_string(const char *);
2711 const char *key_string_lookup_key(key_code, int);
2713 /* alerts.c */
2714 void alerts_reset_all(void);
2715 void alerts_queue(struct window *, int);
2716 void alerts_check_session(struct session *);
2718 /* file.c */
2719 int file_cmp(struct client_file *, struct client_file *);
2720 RB_PROTOTYPE(client_files, client_file, entry, file_cmp);
2721 struct client_file *file_create_with_peer(struct tmuxpeer *,
2722 struct client_files *, int, client_file_cb, void *);
2723 struct client_file *file_create_with_client(struct client *, int,
2724 client_file_cb, void *);
2725 void file_free(struct client_file *);
2726 void file_fire_done(struct client_file *);
2727 void file_fire_read(struct client_file *);
2728 int file_can_print(struct client *);
2729 void printflike(2, 3) file_print(struct client *, const char *, ...);
2730 void printflike(2, 0) file_vprint(struct client *, const char *, va_list);
2731 void file_print_buffer(struct client *, void *, size_t);
2732 void printflike(2, 3) file_error(struct client *, const char *, ...);
2733 void file_write(struct client *, const char *, int, const void *, size_t,
2734 client_file_cb, void *);
2735 struct client_file *file_read(struct client *, const char *, client_file_cb,
2736 void *);
2737 void file_cancel(struct client_file *);
2738 void file_push(struct client_file *);
2739 int file_write_left(struct client_files *);
2740 void file_write_open(struct client_files *, struct tmuxpeer *,
2741 struct imsg *, int, int, client_file_cb, void *);
2742 void file_write_data(struct client_files *, struct imsg *);
2743 void file_write_close(struct client_files *, struct imsg *);
2744 void file_read_open(struct client_files *, struct tmuxpeer *, struct imsg *,
2745 int, int, client_file_cb, void *);
2746 void file_write_ready(struct client_files *, struct imsg *);
2747 void file_read_data(struct client_files *, struct imsg *);
2748 void file_read_done(struct client_files *, struct imsg *);
2749 void file_read_cancel(struct client_files *, struct imsg *);
2751 /* server.c */
2752 extern struct tmuxproc *server_proc;
2753 extern struct clients clients;
2754 extern struct cmd_find_state marked_pane;
2755 extern struct message_list message_log;
2756 extern time_t current_time;
2757 void server_set_marked(struct session *, struct winlink *,
2758 struct window_pane *);
2759 void server_clear_marked(void);
2760 int server_is_marked(struct session *, struct winlink *,
2761 struct window_pane *);
2762 int server_check_marked(void);
2763 int server_start(struct tmuxproc *, uint64_t, struct event_base *, int,
2764 char *);
2765 void server_update_socket(void);
2766 void server_add_accept(int);
2767 void printflike(1, 2) server_add_message(const char *, ...);
2768 int server_create_socket(uint64_t, char **);
2770 /* server-client.c */
2771 RB_PROTOTYPE(client_windows, client_window, entry, server_client_window_cmp);
2772 u_int server_client_how_many(void);
2773 void server_client_set_overlay(struct client *, u_int, overlay_check_cb,
2774 overlay_mode_cb, overlay_draw_cb, overlay_key_cb,
2775 overlay_free_cb, overlay_resize_cb, void *);
2776 void server_client_clear_overlay(struct client *);
2777 void server_client_overlay_range(u_int, u_int, u_int, u_int, u_int, u_int,
2778 u_int, struct overlay_ranges *);
2779 void server_client_set_key_table(struct client *, const char *);
2780 const char *server_client_get_key_table(struct client *);
2781 int server_client_check_nested(struct client *);
2782 int server_client_handle_key(struct client *, struct key_event *);
2783 struct client *server_client_create(int);
2784 int server_client_open(struct client *, char **);
2785 void server_client_unref(struct client *);
2786 void server_client_set_session(struct client *, struct session *);
2787 void server_client_lost(struct client *);
2788 void server_client_suspend(struct client *);
2789 void server_client_detach(struct client *, enum msgtype);
2790 void server_client_exec(struct client *, const char *);
2791 void server_client_loop(void);
2792 const char *server_client_get_cwd(struct client *, struct session *);
2793 void server_client_set_flags(struct client *, const char *);
2794 const char *server_client_get_flags(struct client *);
2795 struct client_window *server_client_get_client_window(struct client *, u_int);
2796 struct client_window *server_client_add_client_window(struct client *, u_int);
2797 struct window_pane *server_client_get_pane(struct client *);
2798 void server_client_set_pane(struct client *, struct window_pane *);
2799 void server_client_remove_pane(struct window_pane *);
2800 void server_client_print(struct client *, int, struct evbuffer *);
2802 /* server-fn.c */
2803 void server_redraw_client(struct client *);
2804 void server_status_client(struct client *);
2805 void server_redraw_session(struct session *);
2806 void server_redraw_session_group(struct session *);
2807 void server_status_session(struct session *);
2808 void server_status_session_group(struct session *);
2809 void server_redraw_window(struct window *);
2810 void server_redraw_window_borders(struct window *);
2811 void server_status_window(struct window *);
2812 void server_lock(void);
2813 void server_lock_session(struct session *);
2814 void server_lock_client(struct client *);
2815 void server_kill_pane(struct window_pane *);
2816 void server_kill_window(struct window *, int);
2817 void server_renumber_session(struct session *);
2818 void server_renumber_all(void);
2819 int server_link_window(struct session *,
2820 struct winlink *, struct session *, int, int, int, char **);
2821 void server_unlink_window(struct session *, struct winlink *);
2822 void server_destroy_pane(struct window_pane *, int);
2823 void server_destroy_session(struct session *);
2824 void server_check_unattached(void);
2825 void server_unzoom_window(struct window *);
2827 /* status.c */
2828 extern char **status_prompt_hlist[];
2829 extern u_int status_prompt_hsize[];
2830 void status_timer_start(struct client *);
2831 void status_timer_start_all(void);
2832 void status_update_cache(struct session *);
2833 int status_at_line(struct client *);
2834 u_int status_line_size(struct client *);
2835 struct style_range *status_get_range(struct client *, u_int, u_int);
2836 void status_init(struct client *);
2837 void status_free(struct client *);
2838 int status_redraw(struct client *);
2839 void printflike(5, 6) status_message_set(struct client *, int, int, int,
2840 const char *, ...);
2841 void status_message_clear(struct client *);
2842 int status_message_redraw(struct client *);
2843 void status_prompt_set(struct client *, struct cmd_find_state *,
2844 const char *, const char *, prompt_input_cb, prompt_free_cb,
2845 void *, int, enum prompt_type);
2846 void status_prompt_clear(struct client *);
2847 int status_prompt_redraw(struct client *);
2848 int status_prompt_key(struct client *, key_code);
2849 void status_prompt_update(struct client *, const char *, const char *);
2850 void status_prompt_load_history(void);
2851 void status_prompt_save_history(void);
2852 const char *status_prompt_type_string(u_int);
2853 enum prompt_type status_prompt_type(const char *type);
2855 /* resize.c */
2856 void resize_window(struct window *, u_int, u_int, int, int);
2857 void default_window_size(struct client *, struct session *, struct window *,
2858 u_int *, u_int *, u_int *, u_int *, int);
2859 void recalculate_size(struct window *, int);
2860 void recalculate_sizes(void);
2861 void recalculate_sizes_now(int);
2863 /* input.c */
2864 struct input_ctx *input_init(struct window_pane *, struct bufferevent *,
2865 struct colour_palette *);
2866 void input_free(struct input_ctx *);
2867 void input_reset(struct input_ctx *, int);
2868 struct evbuffer *input_pending(struct input_ctx *);
2869 void input_parse_pane(struct window_pane *);
2870 void input_parse_buffer(struct window_pane *, u_char *, size_t);
2871 void input_parse_screen(struct input_ctx *, struct screen *,
2872 screen_write_init_ctx_cb, void *, u_char *, size_t);
2873 void input_reply_clipboard(struct bufferevent *, const char *, size_t,
2874 const char *);
2876 /* input-key.c */
2877 void input_key_build(void);
2878 int input_key_pane(struct window_pane *, key_code, struct mouse_event *);
2879 int input_key(struct screen *, struct bufferevent *, key_code);
2880 int input_key_get_mouse(struct screen *, struct mouse_event *, u_int,
2881 u_int, const char **, size_t *);
2883 /* colour.c */
2884 int colour_find_rgb(u_char, u_char, u_char);
2885 int colour_join_rgb(u_char, u_char, u_char);
2886 void colour_split_rgb(int, u_char *, u_char *, u_char *);
2887 int colour_force_rgb(int);
2888 const char *colour_tostring(int);
2889 int colour_fromstring(const char *s);
2890 int colour_256toRGB(int);
2891 int colour_256to16(int);
2892 int colour_byname(const char *);
2893 int colour_parseX11(const char *);
2894 void colour_palette_init(struct colour_palette *);
2895 void colour_palette_clear(struct colour_palette *);
2896 void colour_palette_free(struct colour_palette *);
2897 int colour_palette_get(struct colour_palette *, int);
2898 int colour_palette_set(struct colour_palette *, int, int);
2899 void colour_palette_from_option(struct colour_palette *, struct options *);
2901 /* attributes.c */
2902 const char *attributes_tostring(int);
2903 int attributes_fromstring(const char *);
2905 /* grid.c */
2906 extern const struct grid_cell grid_default_cell;
2907 void grid_empty_line(struct grid *, u_int, u_int);
2908 int grid_cells_equal(const struct grid_cell *, const struct grid_cell *);
2909 int grid_cells_look_equal(const struct grid_cell *,
2910 const struct grid_cell *);
2911 struct grid *grid_create(u_int, u_int, u_int);
2912 void grid_destroy(struct grid *);
2913 int grid_compare(struct grid *, struct grid *);
2914 void grid_collect_history(struct grid *);
2915 void grid_remove_history(struct grid *, u_int );
2916 void grid_scroll_history(struct grid *, u_int);
2917 void grid_scroll_history_region(struct grid *, u_int, u_int, u_int);
2918 void grid_clear_history(struct grid *);
2919 const struct grid_line *grid_peek_line(struct grid *, u_int);
2920 void grid_get_cell(struct grid *, u_int, u_int, struct grid_cell *);
2921 void grid_set_cell(struct grid *, u_int, u_int, const struct grid_cell *);
2922 void grid_set_padding(struct grid *, u_int, u_int);
2923 void grid_set_cells(struct grid *, u_int, u_int, const struct grid_cell *,
2924 const char *, size_t);
2925 struct grid_line *grid_get_line(struct grid *, u_int);
2926 void grid_adjust_lines(struct grid *, u_int);
2927 void grid_clear(struct grid *, u_int, u_int, u_int, u_int, u_int);
2928 void grid_clear_lines(struct grid *, u_int, u_int, u_int);
2929 void grid_move_lines(struct grid *, u_int, u_int, u_int, u_int);
2930 void grid_move_cells(struct grid *, u_int, u_int, u_int, u_int, u_int);
2931 char *grid_string_cells(struct grid *, u_int, u_int, u_int,
2932 struct grid_cell **, int, struct screen *);
2933 void grid_duplicate_lines(struct grid *, u_int, struct grid *, u_int,
2934 u_int);
2935 void grid_reflow(struct grid *, u_int);
2936 void grid_wrap_position(struct grid *, u_int, u_int, u_int *, u_int *);
2937 void grid_unwrap_position(struct grid *, u_int *, u_int *, u_int, u_int);
2938 u_int grid_line_length(struct grid *, u_int);
2940 /* grid-reader.c */
2941 void grid_reader_start(struct grid_reader *, struct grid *, u_int, u_int);
2942 void grid_reader_get_cursor(struct grid_reader *, u_int *, u_int *);
2943 u_int grid_reader_line_length(struct grid_reader *);
2944 int grid_reader_in_set(struct grid_reader *, const char *);
2945 void grid_reader_cursor_right(struct grid_reader *, int, int);
2946 void grid_reader_cursor_left(struct grid_reader *, int);
2947 void grid_reader_cursor_down(struct grid_reader *);
2948 void grid_reader_cursor_up(struct grid_reader *);
2949 void grid_reader_cursor_start_of_line(struct grid_reader *, int);
2950 void grid_reader_cursor_end_of_line(struct grid_reader *, int, int);
2951 void grid_reader_cursor_next_word(struct grid_reader *, const char *);
2952 void grid_reader_cursor_next_word_end(struct grid_reader *, const char *);
2953 void grid_reader_cursor_previous_word(struct grid_reader *, const char *,
2954 int, int);
2955 int grid_reader_cursor_jump(struct grid_reader *,
2956 const struct utf8_data *);
2957 int grid_reader_cursor_jump_back(struct grid_reader *,
2958 const struct utf8_data *);
2959 void grid_reader_cursor_back_to_indentation(struct grid_reader *);
2961 /* grid-view.c */
2962 void grid_view_get_cell(struct grid *, u_int, u_int, struct grid_cell *);
2963 void grid_view_set_cell(struct grid *, u_int, u_int,
2964 const struct grid_cell *);
2965 void grid_view_set_padding(struct grid *, u_int, u_int);
2966 void grid_view_set_cells(struct grid *, u_int, u_int,
2967 const struct grid_cell *, const char *, size_t);
2968 void grid_view_clear_history(struct grid *, u_int);
2969 void grid_view_clear(struct grid *, u_int, u_int, u_int, u_int, u_int);
2970 void grid_view_scroll_region_up(struct grid *, u_int, u_int, u_int);
2971 void grid_view_scroll_region_down(struct grid *, u_int, u_int, u_int);
2972 void grid_view_insert_lines(struct grid *, u_int, u_int, u_int);
2973 void grid_view_insert_lines_region(struct grid *, u_int, u_int, u_int,
2974 u_int);
2975 void grid_view_delete_lines(struct grid *, u_int, u_int, u_int);
2976 void grid_view_delete_lines_region(struct grid *, u_int, u_int, u_int,
2977 u_int);
2978 void grid_view_insert_cells(struct grid *, u_int, u_int, u_int, u_int);
2979 void grid_view_delete_cells(struct grid *, u_int, u_int, u_int, u_int);
2980 char *grid_view_string_cells(struct grid *, u_int, u_int, u_int);
2982 /* screen-write.c */
2983 void screen_write_make_list(struct screen *);
2984 void screen_write_free_list(struct screen *);
2985 void screen_write_start_pane(struct screen_write_ctx *,
2986 struct window_pane *, struct screen *);
2987 void screen_write_start(struct screen_write_ctx *, struct screen *);
2988 void screen_write_start_callback(struct screen_write_ctx *, struct screen *,
2989 screen_write_init_ctx_cb, void *);
2990 void screen_write_stop(struct screen_write_ctx *);
2991 void screen_write_reset(struct screen_write_ctx *);
2992 size_t printflike(1, 2) screen_write_strlen(const char *, ...);
2993 int printflike(7, 8) screen_write_text(struct screen_write_ctx *, u_int, u_int,
2994 u_int, int, const struct grid_cell *, const char *, ...);
2995 void printflike(3, 4) screen_write_puts(struct screen_write_ctx *,
2996 const struct grid_cell *, const char *, ...);
2997 void printflike(4, 5) screen_write_nputs(struct screen_write_ctx *,
2998 ssize_t, const struct grid_cell *, const char *, ...);
2999 void printflike(4, 0) screen_write_vnputs(struct screen_write_ctx *, ssize_t,
3000 const struct grid_cell *, const char *, va_list);
3001 void screen_write_putc(struct screen_write_ctx *, const struct grid_cell *,
3002 u_char);
3003 void screen_write_fast_copy(struct screen_write_ctx *, struct screen *,
3004 u_int, u_int, u_int, u_int);
3005 void screen_write_hline(struct screen_write_ctx *, u_int, int, int,
3006 enum box_lines, const struct grid_cell *);
3007 void screen_write_vline(struct screen_write_ctx *, u_int, int, int);
3008 void screen_write_menu(struct screen_write_ctx *, struct menu *, int,
3009 enum box_lines, const struct grid_cell *, const struct grid_cell *,
3010 const struct grid_cell *);
3011 void screen_write_box(struct screen_write_ctx *, u_int, u_int,
3012 enum box_lines, const struct grid_cell *, const char *);
3013 void screen_write_preview(struct screen_write_ctx *, struct screen *, u_int,
3014 u_int);
3015 void screen_write_backspace(struct screen_write_ctx *);
3016 void screen_write_mode_set(struct screen_write_ctx *, int);
3017 void screen_write_mode_clear(struct screen_write_ctx *, int);
3018 void screen_write_cursorup(struct screen_write_ctx *, u_int);
3019 void screen_write_cursordown(struct screen_write_ctx *, u_int);
3020 void screen_write_cursorright(struct screen_write_ctx *, u_int);
3021 void screen_write_cursorleft(struct screen_write_ctx *, u_int);
3022 void screen_write_alignmenttest(struct screen_write_ctx *);
3023 void screen_write_insertcharacter(struct screen_write_ctx *, u_int, u_int);
3024 void screen_write_deletecharacter(struct screen_write_ctx *, u_int, u_int);
3025 void screen_write_clearcharacter(struct screen_write_ctx *, u_int, u_int);
3026 void screen_write_insertline(struct screen_write_ctx *, u_int, u_int);
3027 void screen_write_deleteline(struct screen_write_ctx *, u_int, u_int);
3028 void screen_write_clearline(struct screen_write_ctx *, u_int);
3029 void screen_write_clearendofline(struct screen_write_ctx *, u_int);
3030 void screen_write_clearstartofline(struct screen_write_ctx *, u_int);
3031 void screen_write_cursormove(struct screen_write_ctx *, int, int, int);
3032 void screen_write_reverseindex(struct screen_write_ctx *, u_int);
3033 void screen_write_scrollregion(struct screen_write_ctx *, u_int, u_int);
3034 void screen_write_linefeed(struct screen_write_ctx *, int, u_int);
3035 void screen_write_scrollup(struct screen_write_ctx *, u_int, u_int);
3036 void screen_write_scrolldown(struct screen_write_ctx *, u_int, u_int);
3037 void screen_write_carriagereturn(struct screen_write_ctx *);
3038 void screen_write_clearendofscreen(struct screen_write_ctx *, u_int);
3039 void screen_write_clearstartofscreen(struct screen_write_ctx *, u_int);
3040 void screen_write_clearscreen(struct screen_write_ctx *, u_int);
3041 void screen_write_clearhistory(struct screen_write_ctx *);
3042 void screen_write_fullredraw(struct screen_write_ctx *);
3043 void screen_write_collect_end(struct screen_write_ctx *);
3044 void screen_write_collect_add(struct screen_write_ctx *,
3045 const struct grid_cell *);
3046 void screen_write_cell(struct screen_write_ctx *, const struct grid_cell *);
3047 void screen_write_setselection(struct screen_write_ctx *, const char *,
3048 u_char *, u_int);
3049 void screen_write_rawstring(struct screen_write_ctx *, u_char *, u_int,
3050 int);
3051 #ifdef ENABLE_SIXEL
3052 void screen_write_sixelimage(struct screen_write_ctx *,
3053 struct sixel_image *, u_int);
3054 #endif
3055 void screen_write_alternateon(struct screen_write_ctx *,
3056 struct grid_cell *, int);
3057 void screen_write_alternateoff(struct screen_write_ctx *,
3058 struct grid_cell *, int);
3060 /* screen-redraw.c */
3061 void screen_redraw_screen(struct client *);
3062 void screen_redraw_pane(struct client *, struct window_pane *);
3064 /* screen.c */
3065 void screen_init(struct screen *, u_int, u_int, u_int);
3066 void screen_reinit(struct screen *);
3067 void screen_free(struct screen *);
3068 void screen_reset_tabs(struct screen *);
3069 void screen_reset_hyperlinks(struct screen *);
3070 void screen_set_default_cursor(struct screen *, struct options *);
3071 void screen_set_cursor_style(u_int, enum screen_cursor_style *, int *);
3072 void screen_set_cursor_colour(struct screen *, int);
3073 int screen_set_title(struct screen *, const char *);
3074 void screen_set_path(struct screen *, const char *);
3075 void screen_push_title(struct screen *);
3076 void screen_pop_title(struct screen *);
3077 void screen_resize(struct screen *, u_int, u_int, int);
3078 void screen_resize_cursor(struct screen *, u_int, u_int, int, int, int);
3079 void screen_set_selection(struct screen *, u_int, u_int, u_int, u_int,
3080 u_int, int, struct grid_cell *);
3081 void screen_clear_selection(struct screen *);
3082 void screen_hide_selection(struct screen *);
3083 int screen_check_selection(struct screen *, u_int, u_int);
3084 void screen_select_cell(struct screen *, struct grid_cell *,
3085 const struct grid_cell *);
3086 void screen_alternate_on(struct screen *, struct grid_cell *, int);
3087 void screen_alternate_off(struct screen *, struct grid_cell *, int);
3088 const char *screen_mode_to_string(int);
3090 /* window.c */
3091 extern struct windows windows;
3092 extern struct window_pane_tree all_window_panes;
3093 int window_cmp(struct window *, struct window *);
3094 RB_PROTOTYPE(windows, window, entry, window_cmp);
3095 int winlink_cmp(struct winlink *, struct winlink *);
3096 RB_PROTOTYPE(winlinks, winlink, entry, winlink_cmp);
3097 int window_pane_cmp(struct window_pane *, struct window_pane *);
3098 RB_PROTOTYPE(window_pane_tree, window_pane, tree_entry, window_pane_cmp);
3099 struct winlink *winlink_find_by_index(struct winlinks *, int);
3100 struct winlink *winlink_find_by_window(struct winlinks *, struct window *);
3101 struct winlink *winlink_find_by_window_id(struct winlinks *, u_int);
3102 u_int winlink_count(struct winlinks *);
3103 struct winlink *winlink_add(struct winlinks *, int);
3104 void winlink_set_window(struct winlink *, struct window *);
3105 void winlink_remove(struct winlinks *, struct winlink *);
3106 struct winlink *winlink_next(struct winlink *);
3107 struct winlink *winlink_previous(struct winlink *);
3108 struct winlink *winlink_next_by_number(struct winlink *, struct session *,
3109 int);
3110 struct winlink *winlink_previous_by_number(struct winlink *, struct session *,
3111 int);
3112 void winlink_stack_push(struct winlink_stack *, struct winlink *);
3113 void winlink_stack_remove(struct winlink_stack *, struct winlink *);
3114 struct window *window_find_by_id_str(const char *);
3115 struct window *window_find_by_id(u_int);
3116 void window_update_activity(struct window *);
3117 struct window *window_create(u_int, u_int, u_int, u_int);
3118 void window_pane_set_event(struct window_pane *);
3119 struct window_pane *window_get_active_at(struct window *, u_int, u_int);
3120 struct window_pane *window_find_string(struct window *, const char *);
3121 int window_has_pane(struct window *, struct window_pane *);
3122 int window_set_active_pane(struct window *, struct window_pane *,
3123 int);
3124 void window_update_focus(struct window *);
3125 void window_pane_update_focus(struct window_pane *);
3126 void window_redraw_active_switch(struct window *,
3127 struct window_pane *);
3128 struct window_pane *window_add_pane(struct window *, struct window_pane *,
3129 u_int, int);
3130 void window_resize(struct window *, u_int, u_int, int, int);
3131 void window_pane_send_resize(struct window_pane *, u_int, u_int);
3132 int window_zoom(struct window_pane *);
3133 int window_unzoom(struct window *, int);
3134 int window_push_zoom(struct window *, int, int);
3135 int window_pop_zoom(struct window *);
3136 void window_lost_pane(struct window *, struct window_pane *);
3137 void window_remove_pane(struct window *, struct window_pane *);
3138 struct window_pane *window_pane_at_index(struct window *, u_int);
3139 struct window_pane *window_pane_next_by_number(struct window *,
3140 struct window_pane *, u_int);
3141 struct window_pane *window_pane_previous_by_number(struct window *,
3142 struct window_pane *, u_int);
3143 int window_pane_index(struct window_pane *, u_int *);
3144 u_int window_count_panes(struct window *);
3145 void window_destroy_panes(struct window *);
3146 struct window_pane *window_pane_find_by_id_str(const char *);
3147 struct window_pane *window_pane_find_by_id(u_int);
3148 int window_pane_destroy_ready(struct window_pane *);
3149 void window_pane_resize(struct window_pane *, u_int, u_int);
3150 int window_pane_set_mode(struct window_pane *,
3151 struct window_pane *, const struct window_mode *,
3152 struct cmd_find_state *, struct args *);
3153 void window_pane_reset_mode(struct window_pane *);
3154 void window_pane_reset_mode_all(struct window_pane *);
3155 int window_pane_key(struct window_pane *, struct client *,
3156 struct session *, struct winlink *, key_code,
3157 struct mouse_event *);
3158 void window_pane_paste(struct window_pane *, char *, size_t);
3159 int window_pane_visible(struct window_pane *);
3160 int window_pane_exited(struct window_pane *);
3161 u_int window_pane_search(struct window_pane *, const char *, int,
3162 int);
3163 const char *window_printable_flags(struct winlink *, int);
3164 struct window_pane *window_pane_find_up(struct window_pane *);
3165 struct window_pane *window_pane_find_down(struct window_pane *);
3166 struct window_pane *window_pane_find_left(struct window_pane *);
3167 struct window_pane *window_pane_find_right(struct window_pane *);
3168 void window_pane_stack_push(struct window_panes *,
3169 struct window_pane *);
3170 void window_pane_stack_remove(struct window_panes *,
3171 struct window_pane *);
3172 void window_set_name(struct window *, const char *);
3173 void window_add_ref(struct window *, const char *);
3174 void window_remove_ref(struct window *, const char *);
3175 void winlink_clear_flags(struct winlink *);
3176 int winlink_shuffle_up(struct session *, struct winlink *, int);
3177 int window_pane_start_input(struct window_pane *,
3178 struct cmdq_item *, char **);
3179 void *window_pane_get_new_data(struct window_pane *,
3180 struct window_pane_offset *, size_t *);
3181 void window_pane_update_used_data(struct window_pane *,
3182 struct window_pane_offset *, size_t);
3183 void window_set_fill_character(struct window *);
3184 void window_pane_default_cursor(struct window_pane *);
3185 int window_pane_mode(struct window_pane *);
3187 /* layout.c */
3188 u_int layout_count_cells(struct layout_cell *);
3189 struct layout_cell *layout_create_cell(struct layout_cell *);
3190 void layout_free_cell(struct layout_cell *);
3191 void layout_print_cell(struct layout_cell *, const char *, u_int);
3192 void layout_destroy_cell(struct window *, struct layout_cell *,
3193 struct layout_cell **);
3194 void layout_resize_layout(struct window *, struct layout_cell *,
3195 enum layout_type, int, int);
3196 struct layout_cell *layout_search_by_border(struct layout_cell *, u_int, u_int);
3197 void layout_set_size(struct layout_cell *, u_int, u_int, u_int,
3198 u_int);
3199 void layout_make_leaf(struct layout_cell *, struct window_pane *);
3200 void layout_make_node(struct layout_cell *, enum layout_type);
3201 void layout_fix_offsets(struct window *);
3202 void layout_fix_panes(struct window *, struct window_pane *);
3203 void layout_resize_adjust(struct window *, struct layout_cell *,
3204 enum layout_type, int);
3205 void layout_init(struct window *, struct window_pane *);
3206 void layout_free(struct window *);
3207 void layout_resize(struct window *, u_int, u_int);
3208 void layout_resize_pane(struct window_pane *, enum layout_type,
3209 int, int);
3210 void layout_resize_pane_to(struct window_pane *, enum layout_type,
3211 u_int);
3212 void layout_assign_pane(struct layout_cell *, struct window_pane *,
3213 int);
3214 struct layout_cell *layout_split_pane(struct window_pane *, enum layout_type,
3215 int, int);
3216 void layout_close_pane(struct window_pane *);
3217 int layout_spread_cell(struct window *, struct layout_cell *);
3218 void layout_spread_out(struct window_pane *);
3220 /* layout-custom.c */
3221 char *layout_dump(struct layout_cell *);
3222 int layout_parse(struct window *, const char *, char **);
3224 /* layout-set.c */
3225 int layout_set_lookup(const char *);
3226 u_int layout_set_select(struct window *, u_int);
3227 u_int layout_set_next(struct window *);
3228 u_int layout_set_previous(struct window *);
3230 /* mode-tree.c */
3231 typedef void (*mode_tree_build_cb)(void *, struct mode_tree_sort_criteria *,
3232 uint64_t *, const char *);
3233 typedef void (*mode_tree_draw_cb)(void *, void *, struct screen_write_ctx *,
3234 u_int, u_int);
3235 typedef int (*mode_tree_search_cb)(void *, void *, const char *);
3236 typedef void (*mode_tree_menu_cb)(void *, struct client *, key_code);
3237 typedef u_int (*mode_tree_height_cb)(void *, u_int);
3238 typedef key_code (*mode_tree_key_cb)(void *, void *, u_int);
3239 typedef void (*mode_tree_each_cb)(void *, void *, struct client *, key_code);
3240 u_int mode_tree_count_tagged(struct mode_tree_data *);
3241 void *mode_tree_get_current(struct mode_tree_data *);
3242 const char *mode_tree_get_current_name(struct mode_tree_data *);
3243 void mode_tree_expand_current(struct mode_tree_data *);
3244 void mode_tree_collapse_current(struct mode_tree_data *);
3245 void mode_tree_expand(struct mode_tree_data *, uint64_t);
3246 int mode_tree_set_current(struct mode_tree_data *, uint64_t);
3247 void mode_tree_each_tagged(struct mode_tree_data *, mode_tree_each_cb,
3248 struct client *, key_code, int);
3249 void mode_tree_up(struct mode_tree_data *, int);
3250 int mode_tree_down(struct mode_tree_data *, int);
3251 struct mode_tree_data *mode_tree_start(struct window_pane *, struct args *,
3252 mode_tree_build_cb, mode_tree_draw_cb, mode_tree_search_cb,
3253 mode_tree_menu_cb, mode_tree_height_cb, mode_tree_key_cb, void *,
3254 const struct menu_item *, const char **, u_int, struct screen **);
3255 void mode_tree_zoom(struct mode_tree_data *, struct args *);
3256 void mode_tree_build(struct mode_tree_data *);
3257 void mode_tree_free(struct mode_tree_data *);
3258 void mode_tree_resize(struct mode_tree_data *, u_int, u_int);
3259 struct mode_tree_item *mode_tree_add(struct mode_tree_data *,
3260 struct mode_tree_item *, void *, uint64_t, const char *,
3261 const char *, int);
3262 void mode_tree_draw_as_parent(struct mode_tree_item *);
3263 void mode_tree_no_tag(struct mode_tree_item *);
3264 void mode_tree_remove(struct mode_tree_data *, struct mode_tree_item *);
3265 void mode_tree_draw(struct mode_tree_data *);
3266 int mode_tree_key(struct mode_tree_data *, struct client *, key_code *,
3267 struct mouse_event *, u_int *, u_int *);
3268 void mode_tree_run_command(struct client *, struct cmd_find_state *,
3269 const char *, const char *);
3271 /* window-buffer.c */
3272 extern const struct window_mode window_buffer_mode;
3274 /* window-tree.c */
3275 extern const struct window_mode window_tree_mode;
3277 /* window-clock.c */
3278 extern const struct window_mode window_clock_mode;
3279 extern const char window_clock_table[14][5][5];
3281 /* window-client.c */
3282 extern const struct window_mode window_client_mode;
3284 /* window-copy.c */
3285 extern const struct window_mode window_copy_mode;
3286 extern const struct window_mode window_view_mode;
3287 void printflike(3, 4) window_copy_add(struct window_pane *, int, const char *,
3288 ...);
3289 void printflike(3, 0) window_copy_vadd(struct window_pane *, int, const char *,
3290 va_list);
3291 void window_copy_pageup(struct window_pane *, int);
3292 void window_copy_pagedown(struct window_pane *, int, int);
3293 void window_copy_start_drag(struct client *, struct mouse_event *);
3294 char *window_copy_get_word(struct window_pane *, u_int, u_int);
3295 char *window_copy_get_line(struct window_pane *, u_int);
3297 /* window-option.c */
3298 extern const struct window_mode window_customize_mode;
3300 /* names.c */
3301 void check_window_name(struct window *);
3302 char *default_window_name(struct window *);
3303 char *parse_window_name(const char *);
3305 /* control.c */
3306 void control_discard(struct client *);
3307 void control_start(struct client *);
3308 void control_ready(struct client *);
3309 void control_stop(struct client *);
3310 void control_set_pane_on(struct client *, struct window_pane *);
3311 void control_set_pane_off(struct client *, struct window_pane *);
3312 void control_continue_pane(struct client *, struct window_pane *);
3313 void control_pause_pane(struct client *, struct window_pane *);
3314 struct window_pane_offset *control_pane_offset(struct client *,
3315 struct window_pane *, int *);
3316 void control_reset_offsets(struct client *);
3317 void printflike(2, 3) control_write(struct client *, const char *, ...);
3318 void control_write_output(struct client *, struct window_pane *);
3319 int control_all_done(struct client *);
3320 void control_add_sub(struct client *, const char *, enum control_sub_type,
3321 int, const char *);
3322 void control_remove_sub(struct client *, const char *);
3324 /* control-notify.c */
3325 void control_notify_pane_mode_changed(int);
3326 void control_notify_window_layout_changed(struct window *);
3327 void control_notify_window_pane_changed(struct window *);
3328 void control_notify_window_unlinked(struct session *, struct window *);
3329 void control_notify_window_linked(struct session *, struct window *);
3330 void control_notify_window_renamed(struct window *);
3331 void control_notify_client_session_changed(struct client *);
3332 void control_notify_client_detached(struct client *);
3333 void control_notify_session_renamed(struct session *);
3334 void control_notify_session_created(struct session *);
3335 void control_notify_session_closed(struct session *);
3336 void control_notify_session_window_changed(struct session *);
3337 void control_notify_paste_buffer_changed(const char *);
3338 void control_notify_paste_buffer_deleted(const char *);
3340 /* session.c */
3341 extern struct sessions sessions;
3342 extern u_int next_session_id;
3343 int session_cmp(struct session *, struct session *);
3344 RB_PROTOTYPE(sessions, session, entry, session_cmp);
3345 int session_alive(struct session *);
3346 struct session *session_find(const char *);
3347 struct session *session_find_by_id_str(const char *);
3348 struct session *session_find_by_id(u_int);
3349 struct session *session_create(const char *, const char *, const char *,
3350 struct environ *, struct options *, struct termios *);
3351 void session_destroy(struct session *, int, const char *);
3352 void session_add_ref(struct session *, const char *);
3353 void session_remove_ref(struct session *, const char *);
3354 char *session_check_name(const char *);
3355 void session_update_activity(struct session *, struct timeval *);
3356 struct session *session_next_session(struct session *);
3357 struct session *session_previous_session(struct session *);
3358 struct winlink *session_attach(struct session *, struct window *, int,
3359 char **);
3360 int session_detach(struct session *, struct winlink *);
3361 int session_has(struct session *, struct window *);
3362 int session_is_linked(struct session *, struct window *);
3363 int session_next(struct session *, int);
3364 int session_previous(struct session *, int);
3365 int session_select(struct session *, int);
3366 int session_last(struct session *);
3367 int session_set_current(struct session *, struct winlink *);
3368 struct session_group *session_group_contains(struct session *);
3369 struct session_group *session_group_find(const char *);
3370 struct session_group *session_group_new(const char *);
3371 void session_group_add(struct session_group *, struct session *);
3372 void session_group_synchronize_to(struct session *);
3373 void session_group_synchronize_from(struct session *);
3374 u_int session_group_count(struct session_group *);
3375 u_int session_group_attached_count(struct session_group *);
3376 void session_renumber_windows(struct session *);
3378 /* utf8.c */
3379 enum utf8_state utf8_towc (const struct utf8_data *, wchar_t *);
3380 enum utf8_state utf8_fromwc(wchar_t wc, struct utf8_data *);
3381 int utf8_in_table(wchar_t, const wchar_t *, u_int);
3382 utf8_char utf8_build_one(u_char);
3383 enum utf8_state utf8_from_data(const struct utf8_data *, utf8_char *);
3384 void utf8_to_data(utf8_char, struct utf8_data *);
3385 void utf8_set(struct utf8_data *, u_char);
3386 void utf8_copy(struct utf8_data *, const struct utf8_data *);
3387 enum utf8_state utf8_open(struct utf8_data *, u_char);
3388 enum utf8_state utf8_append(struct utf8_data *, u_char);
3389 int utf8_isvalid(const char *);
3390 int utf8_strvis(char *, const char *, size_t, int);
3391 int utf8_stravis(char **, const char *, int);
3392 int utf8_stravisx(char **, const char *, size_t, int);
3393 char *utf8_sanitize(const char *);
3394 size_t utf8_strlen(const struct utf8_data *);
3395 u_int utf8_strwidth(const struct utf8_data *, ssize_t);
3396 struct utf8_data *utf8_fromcstr(const char *);
3397 char *utf8_tocstr(struct utf8_data *);
3398 u_int utf8_cstrwidth(const char *);
3399 char *utf8_padcstr(const char *, u_int);
3400 char *utf8_rpadcstr(const char *, u_int);
3401 int utf8_cstrhas(const char *, const struct utf8_data *);
3403 /* osdep-*.c */
3404 char *osdep_get_name(int, char *);
3405 char *osdep_get_cwd(int);
3406 struct event_base *osdep_event_init(void);
3408 /* utf8-combined.c */
3409 int utf8_has_zwj(const struct utf8_data *);
3410 int utf8_is_zwj(const struct utf8_data *);
3411 int utf8_is_vs(const struct utf8_data *);
3412 int utf8_is_modifier(const struct utf8_data *);
3414 /* procname.c */
3415 char *get_proc_name(int, char *);
3416 char *get_proc_cwd(int);
3418 /* log.c */
3419 void log_add_level(void);
3420 int log_get_level(void);
3421 void log_open(const char *);
3422 void log_toggle(const char *);
3423 void log_close(void);
3424 void printflike(1, 2) log_debug(const char *, ...);
3425 __dead void printflike(1, 2) fatal(const char *, ...);
3426 __dead void printflike(1, 2) fatalx(const char *, ...);
3428 /* menu.c */
3429 #define MENU_NOMOUSE 0x1
3430 #define MENU_TAB 0x2
3431 #define MENU_STAYOPEN 0x4
3432 struct menu *menu_create(const char *);
3433 void menu_add_items(struct menu *, const struct menu_item *,
3434 struct cmdq_item *, struct client *,
3435 struct cmd_find_state *);
3436 void menu_add_item(struct menu *, const struct menu_item *,
3437 struct cmdq_item *, struct client *,
3438 struct cmd_find_state *);
3439 void menu_free(struct menu *);
3440 struct menu_data *menu_prepare(struct menu *, int, int, struct cmdq_item *,
3441 u_int, u_int, struct client *, enum box_lines, const char *,
3442 const char *, const char *, struct cmd_find_state *,
3443 menu_choice_cb, void *);
3444 int menu_display(struct menu *, int, int, struct cmdq_item *,
3445 u_int, u_int, struct client *, enum box_lines, const char *,
3446 const char *, const char *, struct cmd_find_state *,
3447 menu_choice_cb, void *);
3448 struct screen *menu_mode_cb(struct client *, void *, u_int *, u_int *);
3449 void menu_check_cb(struct client *, void *, u_int, u_int, u_int,
3450 struct overlay_ranges *);
3451 void menu_draw_cb(struct client *, void *,
3452 struct screen_redraw_ctx *);
3453 void menu_free_cb(struct client *, void *);
3454 int menu_key_cb(struct client *, void *, struct key_event *);
3456 /* popup.c */
3457 #define POPUP_CLOSEEXIT 0x1
3458 #define POPUP_CLOSEEXITZERO 0x2
3459 #define POPUP_INTERNAL 0x4
3460 typedef void (*popup_close_cb)(int, void *);
3461 typedef void (*popup_finish_edit_cb)(char *, size_t, void *);
3462 int popup_display(int, enum box_lines, struct cmdq_item *, u_int,
3463 u_int, u_int, u_int, struct environ *, const char *, int,
3464 char **, const char *, const char *, struct client *,
3465 struct session *, const char *, const char *,
3466 popup_close_cb, void *);
3467 int popup_editor(struct client *, const char *, size_t,
3468 popup_finish_edit_cb, void *);
3470 /* style.c */
3471 int style_parse(struct style *,const struct grid_cell *,
3472 const char *);
3473 const char *style_tostring(struct style *);
3474 void style_add(struct grid_cell *, struct options *,
3475 const char *, struct format_tree *);
3476 void style_apply(struct grid_cell *, struct options *,
3477 const char *, struct format_tree *);
3478 void style_set(struct style *, const struct grid_cell *);
3479 void style_copy(struct style *, struct style *);
3481 /* spawn.c */
3482 struct winlink *spawn_window(struct spawn_context *, char **);
3483 struct window_pane *spawn_pane(struct spawn_context *, char **);
3485 /* regsub.c */
3486 char *regsub(const char *, const char *, const char *, int);
3488 #ifdef ENABLE_SIXEL
3489 /* image.c */
3490 int image_free_all(struct screen *);
3491 struct image *image_store(struct screen *, struct sixel_image *);
3492 int image_check_line(struct screen *, u_int, u_int);
3493 int image_check_area(struct screen *, u_int, u_int, u_int, u_int);
3494 int image_scroll_up(struct screen *, u_int);
3496 /* image-sixel.c */
3497 #define SIXEL_COLOUR_REGISTERS 1024
3498 struct sixel_image *sixel_parse(const char *, size_t, u_int, u_int, u_int);
3499 void sixel_free(struct sixel_image *);
3500 void sixel_log(struct sixel_image *);
3501 void sixel_size_in_cells(struct sixel_image *, u_int *, u_int *);
3502 struct sixel_image *sixel_scale(struct sixel_image *, u_int, u_int, u_int,
3503 u_int, u_int, u_int, int);
3504 char *sixel_print(struct sixel_image *, struct sixel_image *,
3505 size_t *);
3506 struct screen *sixel_to_screen(struct sixel_image *);
3507 #endif
3509 /* server-acl.c */
3510 void server_acl_init(void);
3511 struct server_acl_user *server_acl_user_find(uid_t);
3512 void server_acl_display(struct cmdq_item *);
3513 void server_acl_user_allow(uid_t);
3514 void server_acl_user_deny(uid_t);
3515 void server_acl_user_allow_write(uid_t);
3516 void server_acl_user_deny_write(uid_t);
3517 int server_acl_join(struct client *);
3518 uid_t server_acl_get_uid(struct server_acl_user *);
3520 /* hyperlink.c */
3521 u_int hyperlinks_put(struct hyperlinks *, const char *,
3522 const char *);
3523 int hyperlinks_get(struct hyperlinks *, u_int,
3524 const char **, const char **, const char **);
3525 struct hyperlinks *hyperlinks_init(void);
3526 struct hyperlinks *hyperlinks_copy(struct hyperlinks *);
3527 void hyperlinks_reset(struct hyperlinks *);
3528 void hyperlinks_free(struct hyperlinks *);
3530 #endif /* TMUX_H */