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