xref: /netbsd-src/external/bsd/tmux/dist/tmux.h (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1 /* $OpenBSD$ */
2 
3 /*
4  * Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
5  *
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.
9  *
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.
17  */
18 
19 #ifndef TMUX_H
20 #define TMUX_H
21 
22 #define PROTOCOL_VERSION 8
23 
24 #include <sys/time.h>
25 #include <sys/uio.h>
26 
27 #include <event.h>
28 #include <limits.h>
29 #include <stdarg.h>
30 #include <stdio.h>
31 #include <termios.h>
32 #include <wchar.h>
33 
34 #ifdef HAVE_UTEMPTER
35 #include <utempter.h>
36 #endif
37 
38 #include "compat.h"
39 #include "xmalloc.h"
40 
41 extern char   **environ;
42 
43 struct args;
44 struct client;
45 struct cmd_find_state;
46 struct cmdq_item;
47 struct cmdq_list;
48 struct environ;
49 struct format_job_tree;
50 struct input_ctx;
51 struct mode_tree_data;
52 struct mouse_event;
53 struct options;
54 struct options_entry;
55 struct session;
56 struct tmuxpeer;
57 struct tmuxproc;
58 
59 /* Default global configuration file. */
60 #ifndef TMUX_CONF
61 #define TMUX_CONF "/etc/tmux.conf"
62 #endif
63 
64 /*
65  * Minimum layout cell size, NOT including separator line. The scroll region
66  * cannot be one line in height so this must be at least two.
67  */
68 #define PANE_MINIMUM 2
69 
70 /* Automatic name refresh interval, in microseconds. Must be < 1 second. */
71 #define NAME_INTERVAL 500000
72 
73 /* Maximum size of data to hold from a pane. */
74 #define READ_SIZE 4096
75 
76 /* Attribute to make GCC check printf-like arguments. */
77 #define printflike(a, b) __attribute__ ((format (printf, a, b)))
78 
79 /* Number of items in array. */
80 #ifndef nitems
81 #define nitems(_a) (sizeof((_a)) / sizeof((_a)[0]))
82 #endif
83 
84 /* Alert option values. */
85 #define ALERT_NONE 0
86 #define ALERT_ANY 1
87 #define ALERT_CURRENT 2
88 #define ALERT_OTHER 3
89 
90 /* Visual option values. */
91 #define VISUAL_OFF 0
92 #define VISUAL_ON 1
93 #define VISUAL_BOTH 2
94 
95 /* Special key codes. */
96 #define KEYC_NONE 0xffff00000000ULL
97 #define KEYC_UNKNOWN 0xfffe00000000ULL
98 #define KEYC_BASE 0x000010000000ULL
99 #define KEYC_USER 0x000020000000ULL
100 
101 /* Available user keys. */
102 #define KEYC_NUSER 1000
103 
104 /* Key modifier bits. */
105 #define KEYC_ESCAPE 0x200000000000ULL
106 #define KEYC_CTRL 0x400000000000ULL
107 #define KEYC_SHIFT 0x800000000000ULL
108 #define KEYC_XTERM 0x1000000000000ULL
109 
110 /* Mask to obtain key w/o modifiers. */
111 #define KEYC_MASK_MOD (KEYC_ESCAPE|KEYC_CTRL|KEYC_SHIFT|KEYC_XTERM)
112 #define KEYC_MASK_KEY (~KEYC_MASK_MOD)
113 
114 /* Is this a mouse key? */
115 #define KEYC_IS_MOUSE(key) (((key) & KEYC_MASK_KEY) >= KEYC_MOUSE &&	\
116     ((key) & KEYC_MASK_KEY) < KEYC_BSPACE)
117 
118 /* Multiple click timeout. */
119 #define KEYC_CLICK_TIMEOUT 300
120 
121 /* Mouse key codes. */
122 #define KEYC_MOUSE_KEY(name)				\
123 	KEYC_ ## name ## _PANE,				\
124 	KEYC_ ## name ## _STATUS,			\
125 	KEYC_ ## name ## _BORDER
126 #define KEYC_MOUSE_STRING(name, s)			\
127 	{ #s "Pane", KEYC_ ## name ## _PANE },		\
128 	{ #s "Status", KEYC_ ## name ## _STATUS },	\
129 	{ #s "Border", KEYC_ ## name ## _BORDER }
130 
131 /*
132  * A single key. This can be ASCII or Unicode or one of the keys starting at
133  * KEYC_BASE.
134  */
135 typedef unsigned long long key_code;
136 
137 /* Special key codes. */
138 enum {
139 	/* Focus events. */
140 	KEYC_FOCUS_IN = KEYC_BASE,
141 	KEYC_FOCUS_OUT,
142 
143 	/* Paste brackets. */
144 	KEYC_PASTE_START,
145 	KEYC_PASTE_END,
146 
147 	/* Mouse keys. */
148 	KEYC_MOUSE, /* unclassified mouse event */
149 	KEYC_DRAGGING, /* dragging in progress */
150 	KEYC_MOUSE_KEY(MOUSEMOVE),
151 	KEYC_MOUSE_KEY(MOUSEDOWN1),
152 	KEYC_MOUSE_KEY(MOUSEDOWN2),
153 	KEYC_MOUSE_KEY(MOUSEDOWN3),
154 	KEYC_MOUSE_KEY(MOUSEUP1),
155 	KEYC_MOUSE_KEY(MOUSEUP2),
156 	KEYC_MOUSE_KEY(MOUSEUP3),
157 	KEYC_MOUSE_KEY(MOUSEDRAG1),
158 	KEYC_MOUSE_KEY(MOUSEDRAG2),
159 	KEYC_MOUSE_KEY(MOUSEDRAG3),
160 	KEYC_MOUSE_KEY(MOUSEDRAGEND1),
161 	KEYC_MOUSE_KEY(MOUSEDRAGEND2),
162 	KEYC_MOUSE_KEY(MOUSEDRAGEND3),
163 	KEYC_MOUSE_KEY(WHEELUP),
164 	KEYC_MOUSE_KEY(WHEELDOWN),
165 	KEYC_MOUSE_KEY(DOUBLECLICK1),
166 	KEYC_MOUSE_KEY(DOUBLECLICK2),
167 	KEYC_MOUSE_KEY(DOUBLECLICK3),
168 	KEYC_MOUSE_KEY(TRIPLECLICK1),
169 	KEYC_MOUSE_KEY(TRIPLECLICK2),
170 	KEYC_MOUSE_KEY(TRIPLECLICK3),
171 
172 	/* Backspace key. */
173 	KEYC_BSPACE,
174 
175 	/* Function keys. */
176 	KEYC_F1,
177 	KEYC_F2,
178 	KEYC_F3,
179 	KEYC_F4,
180 	KEYC_F5,
181 	KEYC_F6,
182 	KEYC_F7,
183 	KEYC_F8,
184 	KEYC_F9,
185 	KEYC_F10,
186 	KEYC_F11,
187 	KEYC_F12,
188 	KEYC_IC,
189 	KEYC_DC,
190 	KEYC_HOME,
191 	KEYC_END,
192 	KEYC_NPAGE,
193 	KEYC_PPAGE,
194 	KEYC_BTAB,
195 
196 	/* Arrow keys. */
197 	KEYC_UP,
198 	KEYC_DOWN,
199 	KEYC_LEFT,
200 	KEYC_RIGHT,
201 
202 	/* Numeric keypad. */
203 	KEYC_KP_SLASH,
204 	KEYC_KP_STAR,
205 	KEYC_KP_MINUS,
206 	KEYC_KP_SEVEN,
207 	KEYC_KP_EIGHT,
208 	KEYC_KP_NINE,
209 	KEYC_KP_PLUS,
210 	KEYC_KP_FOUR,
211 	KEYC_KP_FIVE,
212 	KEYC_KP_SIX,
213 	KEYC_KP_ONE,
214 	KEYC_KP_TWO,
215 	KEYC_KP_THREE,
216 	KEYC_KP_ENTER,
217 	KEYC_KP_ZERO,
218 	KEYC_KP_PERIOD,
219 };
220 
221 /* Termcap codes. */
222 enum tty_code_code {
223 	TTYC_AX = 0,
224 	TTYC_ACSC,
225 	TTYC_BCE,
226 	TTYC_BEL,
227 	TTYC_BLINK,
228 	TTYC_BOLD,
229 	TTYC_CIVIS,
230 	TTYC_CLEAR,
231 	TTYC_CNORM,
232 	TTYC_COLORS,
233 	TTYC_CR,
234 	TTYC_CS,
235 	TTYC_CSR,
236 	TTYC_CUB,
237 	TTYC_CUB1,
238 	TTYC_CUD,
239 	TTYC_CUD1,
240 	TTYC_CUF,
241 	TTYC_CUF1,
242 	TTYC_CUP,
243 	TTYC_CUU,
244 	TTYC_CUU1,
245 	TTYC_CVVIS,
246 	TTYC_DCH,
247 	TTYC_DCH1,
248 	TTYC_DIM,
249 	TTYC_DL,
250 	TTYC_DL1,
251 	TTYC_E3,
252 	TTYC_ECH,
253 	TTYC_ED,
254 	TTYC_EL,
255 	TTYC_EL1,
256 	TTYC_ENACS,
257 	TTYC_FSL,
258 	TTYC_HOME,
259 	TTYC_HPA,
260 	TTYC_ICH,
261 	TTYC_ICH1,
262 	TTYC_IL,
263 	TTYC_IL1,
264 	TTYC_INDN,
265 	TTYC_INVIS,
266 	TTYC_KCBT,
267 	TTYC_KCUB1,
268 	TTYC_KCUD1,
269 	TTYC_KCUF1,
270 	TTYC_KCUU1,
271 	TTYC_KDC2,
272 	TTYC_KDC3,
273 	TTYC_KDC4,
274 	TTYC_KDC5,
275 	TTYC_KDC6,
276 	TTYC_KDC7,
277 	TTYC_KDCH1,
278 	TTYC_KDN2,
279 	TTYC_KDN3,
280 	TTYC_KDN4,
281 	TTYC_KDN5,
282 	TTYC_KDN6,
283 	TTYC_KDN7,
284 	TTYC_KEND,
285 	TTYC_KEND2,
286 	TTYC_KEND3,
287 	TTYC_KEND4,
288 	TTYC_KEND5,
289 	TTYC_KEND6,
290 	TTYC_KEND7,
291 	TTYC_KF1,
292 	TTYC_KF10,
293 	TTYC_KF11,
294 	TTYC_KF12,
295 	TTYC_KF13,
296 	TTYC_KF14,
297 	TTYC_KF15,
298 	TTYC_KF16,
299 	TTYC_KF17,
300 	TTYC_KF18,
301 	TTYC_KF19,
302 	TTYC_KF2,
303 	TTYC_KF20,
304 	TTYC_KF21,
305 	TTYC_KF22,
306 	TTYC_KF23,
307 	TTYC_KF24,
308 	TTYC_KF25,
309 	TTYC_KF26,
310 	TTYC_KF27,
311 	TTYC_KF28,
312 	TTYC_KF29,
313 	TTYC_KF3,
314 	TTYC_KF30,
315 	TTYC_KF31,
316 	TTYC_KF32,
317 	TTYC_KF33,
318 	TTYC_KF34,
319 	TTYC_KF35,
320 	TTYC_KF36,
321 	TTYC_KF37,
322 	TTYC_KF38,
323 	TTYC_KF39,
324 	TTYC_KF4,
325 	TTYC_KF40,
326 	TTYC_KF41,
327 	TTYC_KF42,
328 	TTYC_KF43,
329 	TTYC_KF44,
330 	TTYC_KF45,
331 	TTYC_KF46,
332 	TTYC_KF47,
333 	TTYC_KF48,
334 	TTYC_KF49,
335 	TTYC_KF5,
336 	TTYC_KF50,
337 	TTYC_KF51,
338 	TTYC_KF52,
339 	TTYC_KF53,
340 	TTYC_KF54,
341 	TTYC_KF55,
342 	TTYC_KF56,
343 	TTYC_KF57,
344 	TTYC_KF58,
345 	TTYC_KF59,
346 	TTYC_KF6,
347 	TTYC_KF60,
348 	TTYC_KF61,
349 	TTYC_KF62,
350 	TTYC_KF63,
351 	TTYC_KF7,
352 	TTYC_KF8,
353 	TTYC_KF9,
354 	TTYC_KHOM2,
355 	TTYC_KHOM3,
356 	TTYC_KHOM4,
357 	TTYC_KHOM5,
358 	TTYC_KHOM6,
359 	TTYC_KHOM7,
360 	TTYC_KHOME,
361 	TTYC_KIC2,
362 	TTYC_KIC3,
363 	TTYC_KIC4,
364 	TTYC_KIC5,
365 	TTYC_KIC6,
366 	TTYC_KIC7,
367 	TTYC_KICH1,
368 	TTYC_KIND,
369 	TTYC_KLFT2,
370 	TTYC_KLFT3,
371 	TTYC_KLFT4,
372 	TTYC_KLFT5,
373 	TTYC_KLFT6,
374 	TTYC_KLFT7,
375 	TTYC_KMOUS,
376 	TTYC_KNP,
377 	TTYC_KNXT2,
378 	TTYC_KNXT3,
379 	TTYC_KNXT4,
380 	TTYC_KNXT5,
381 	TTYC_KNXT6,
382 	TTYC_KNXT7,
383 	TTYC_KPP,
384 	TTYC_KPRV2,
385 	TTYC_KPRV3,
386 	TTYC_KPRV4,
387 	TTYC_KPRV5,
388 	TTYC_KPRV6,
389 	TTYC_KPRV7,
390 	TTYC_KRI,
391 	TTYC_KRIT2,
392 	TTYC_KRIT3,
393 	TTYC_KRIT4,
394 	TTYC_KRIT5,
395 	TTYC_KRIT6,
396 	TTYC_KRIT7,
397 	TTYC_KUP2,
398 	TTYC_KUP3,
399 	TTYC_KUP4,
400 	TTYC_KUP5,
401 	TTYC_KUP6,
402 	TTYC_KUP7,
403 	TTYC_MS,
404 	TTYC_OP,
405 	TTYC_REV,
406 	TTYC_RI,
407 	TTYC_RMACS,
408 	TTYC_RMCUP,
409 	TTYC_RMKX,
410 	TTYC_SE,
411 	TTYC_SETAB,
412 	TTYC_SETAF,
413 	TTYC_SETRGBB,
414 	TTYC_SETRGBF,
415 	TTYC_SGR0,
416 	TTYC_SITM,
417 	TTYC_SMACS,
418 	TTYC_SMCUP,
419 	TTYC_SMKX,
420 	TTYC_SMSO,
421 	TTYC_SMUL,
422 	TTYC_SMXX,
423 	TTYC_SS,
424 	TTYC_TC,
425 	TTYC_TSL,
426 	TTYC_U8,
427 	TTYC_VPA,
428 	TTYC_XENL,
429 	TTYC_XT,
430 };
431 
432 /* Message codes. */
433 enum msgtype {
434 	MSG_VERSION = 12,
435 
436 	MSG_IDENTIFY_FLAGS = 100,
437 	MSG_IDENTIFY_TERM,
438 	MSG_IDENTIFY_TTYNAME,
439 	MSG_IDENTIFY_OLDCWD, /* unused */
440 	MSG_IDENTIFY_STDIN,
441 	MSG_IDENTIFY_ENVIRON,
442 	MSG_IDENTIFY_DONE,
443 	MSG_IDENTIFY_CLIENTPID,
444 	MSG_IDENTIFY_CWD,
445 
446 	MSG_COMMAND = 200,
447 	MSG_DETACH,
448 	MSG_DETACHKILL,
449 	MSG_EXIT,
450 	MSG_EXITED,
451 	MSG_EXITING,
452 	MSG_LOCK,
453 	MSG_READY,
454 	MSG_RESIZE,
455 	MSG_SHELL,
456 	MSG_SHUTDOWN,
457 	MSG_STDERR,
458 	MSG_STDIN,
459 	MSG_STDOUT,
460 	MSG_SUSPEND,
461 	MSG_UNLOCK,
462 	MSG_WAKEUP,
463 	MSG_EXEC,
464 };
465 
466 /*
467  * Message data.
468  *
469  * Don't forget to bump PROTOCOL_VERSION if any of these change!
470  */
471 struct msg_command_data {
472 	int	argc;
473 }; /* followed by packed argv */
474 
475 struct msg_stdin_data {
476 	ssize_t	size;
477 	char	data[BUFSIZ];
478 };
479 
480 struct msg_stdout_data {
481 	ssize_t	size;
482 	char	data[BUFSIZ];
483 };
484 
485 struct msg_stderr_data {
486 	ssize_t	size;
487 	char	data[BUFSIZ];
488 };
489 
490 /* Mode keys. */
491 #define MODEKEY_EMACS 0
492 #define MODEKEY_VI 1
493 
494 /* Modes. */
495 #define MODE_CURSOR 0x1
496 #define MODE_INSERT 0x2
497 #define MODE_KCURSOR 0x4
498 #define MODE_KKEYPAD 0x8	/* set = application, clear = number */
499 #define MODE_WRAP 0x10		/* whether lines wrap */
500 #define MODE_MOUSE_STANDARD 0x20
501 #define MODE_MOUSE_BUTTON 0x40
502 #define MODE_BLINKING 0x80
503 #define MODE_MOUSE_UTF8 0x100
504 #define MODE_MOUSE_SGR 0x200
505 #define MODE_BRACKETPASTE 0x400
506 #define MODE_FOCUSON 0x800
507 #define MODE_MOUSE_ALL 0x1000
508 
509 #define ALL_MODES 0xffffff
510 #define ALL_MOUSE_MODES (MODE_MOUSE_STANDARD|MODE_MOUSE_BUTTON|MODE_MOUSE_ALL)
511 
512 /*
513  * A single UTF-8 character. UTF8_SIZE must be big enough to hold at least one
514  * combining character as well.
515 */
516 #define UTF8_SIZE 9
517 struct utf8_data {
518 	u_char	data[UTF8_SIZE];
519 
520 	u_char	have;
521 	u_char	size;
522 
523 	u_char	width;	/* 0xff if invalid */
524 } __packed;
525 enum utf8_state {
526 	UTF8_MORE,
527 	UTF8_DONE,
528 	UTF8_ERROR
529 };
530 
531 /* Colour flags. */
532 #define COLOUR_FLAG_256 0x01000000
533 #define COLOUR_FLAG_RGB 0x02000000
534 
535 /* Grid attributes. Anything above 0xff is stored in an extended cell. */
536 #define GRID_ATTR_BRIGHT 0x1
537 #define GRID_ATTR_DIM 0x2
538 #define GRID_ATTR_UNDERSCORE 0x4
539 #define GRID_ATTR_BLINK 0x8
540 #define GRID_ATTR_REVERSE 0x10
541 #define GRID_ATTR_HIDDEN 0x20
542 #define GRID_ATTR_ITALICS 0x40
543 #define GRID_ATTR_CHARSET 0x80	/* alternative character set */
544 #define GRID_ATTR_STRIKETHROUGH 0x100
545 
546 /* Grid flags. */
547 #define GRID_FLAG_FG256 0x1
548 #define GRID_FLAG_BG256 0x2
549 #define GRID_FLAG_PADDING 0x4
550 #define GRID_FLAG_EXTENDED 0x8
551 #define GRID_FLAG_SELECTED 0x10
552 #define GRID_FLAG_NOPALETTE 0x20
553 
554 /* Grid line flags. */
555 #define GRID_LINE_WRAPPED 0x1
556 #define GRID_LINE_EXTENDED 0x2
557 
558 /* Grid cell data. */
559 struct grid_cell {
560 	u_char			flags;
561 	u_short			attr;
562 	int			fg;
563 	int			bg;
564 	struct utf8_data	data;
565 };
566 struct grid_cell_entry {
567 	u_char			flags;
568 	union {
569 		u_int		offset;
570 		struct {
571 			u_char	attr;
572 			u_char	fg;
573 			u_char	bg;
574 			u_char	data;
575 		} data;
576 	};
577 } __packed;
578 
579 /* Grid line. */
580 struct grid_line {
581 	u_int			 cellused;
582 	u_int			 cellsize;
583 	struct grid_cell_entry	*celldata;
584 
585 	u_int			 extdsize;
586 	struct grid_cell	*extddata;
587 
588 	int			 flags;
589 } __packed;
590 
591 /* Entire grid of cells. */
592 struct grid {
593 	int			 flags;
594 #define GRID_HISTORY 0x1 /* scroll lines into history */
595 
596 	u_int			 sx;
597 	u_int			 sy;
598 
599 	u_int			 hscrolled;
600 	u_int			 hsize;
601 	u_int			 hlimit;
602 
603 	struct grid_line	*linedata;
604 };
605 
606 /* Hook data structures. */
607 struct hook {
608 	const char	*name;
609 
610 	struct cmd_list	*cmdlist;
611 
612 	RB_ENTRY(hook)	 entry;
613 };
614 
615 /* Scheduled job. */
616 struct job;
617 typedef void (*job_update_cb) (struct job *);
618 typedef void (*job_complete_cb) (struct job *);
619 typedef void (*job_free_cb) (void *);
620 struct job {
621 	enum {
622 		JOB_RUNNING,
623 		JOB_DEAD,
624 		JOB_CLOSED
625 	} state;
626 
627 	char			*cmd;
628 	pid_t			 pid;
629 	int			 status;
630 
631 	int			 fd;
632 	struct bufferevent	*event;
633 
634 	job_update_cb		 updatecb;
635 	job_complete_cb		 completecb;
636 	job_free_cb		 freecb;
637 	void			*data;
638 
639 	LIST_ENTRY(job)		 entry;
640 };
641 LIST_HEAD(joblist, job);
642 
643 /* Screen selection. */
644 struct screen_sel {
645 	int		 flag;
646 	int		 hidden;
647 
648 	int		 rectflag;
649 	enum {
650 		LINE_SEL_NONE,
651 		LINE_SEL_LEFT_RIGHT,
652 		LINE_SEL_RIGHT_LEFT,
653 	} lineflag;
654 
655 	int		 modekeys;
656 
657 	u_int		 sx;
658 	u_int		 sy;
659 
660 	u_int		 ex;
661 	u_int		 ey;
662 
663 	struct grid_cell cell;
664 };
665 
666 /* Virtual screen. */
667 struct screen {
668 	char			*title;
669 
670 	struct grid		*grid;		/* grid data */
671 
672 	u_int			 cx;		/* cursor x */
673 	u_int			 cy;		/* cursor y */
674 
675 	u_int			 cstyle;	/* cursor style */
676 	char			*ccolour;	/* cursor colour string */
677 
678 	u_int			 rupper;	/* scroll region top */
679 	u_int			 rlower;	/* scroll region bottom */
680 
681 	int			 mode;
682 
683 	bitstr_t		*tabs;
684 
685 	struct screen_sel	 sel;
686 };
687 
688 /* Screen write context. */
689 struct screen_write_collect_item;
690 struct screen_write_collect_line;
691 struct screen_write_ctx {
692 	struct window_pane	*wp;
693 	struct screen		*s;
694 
695 	struct screen_write_collect_item *item;
696 	struct screen_write_collect_line *list;
697 	u_int			 scrolled;
698 	u_int			 bg;
699 
700 	u_int			 cells;
701 	u_int			 written;
702 	u_int			 skipped;
703 };
704 
705 /* Screen size. */
706 #define screen_size_x(s) ((s)->grid->sx)
707 #define screen_size_y(s) ((s)->grid->sy)
708 #define screen_hsize(s) ((s)->grid->hsize)
709 #define screen_hlimit(s) ((s)->grid->hlimit)
710 
711 /*
712  * Window mode. Windows can be in several modes and this is used to call the
713  * right function to handle input and output.
714  */
715 struct window_mode {
716 	const char	*name;
717 
718 	struct screen	*(*init)(struct window_pane *, struct cmd_find_state *,
719 			     struct args *);
720 	void		 (*free)(struct window_pane *);
721 	void		 (*resize)(struct window_pane *, u_int, u_int);
722 	void		 (*key)(struct window_pane *, struct client *,
723 			     struct session *, key_code, struct mouse_event *);
724 
725 	const char	*(*key_table)(struct window_pane *);
726 	void		 (*command)(struct window_pane *, struct client *,
727 			     struct session *, struct args *,
728 			     struct mouse_event *);
729 };
730 #define WINDOW_MODE_TIMEOUT 180
731 
732 /* Structures for choose mode. */
733 struct window_choose_data {
734 	struct client		*start_client;
735 	struct session		*start_session;
736 
737 	u_int			 idx;
738 	int			 type;
739 #define TREE_OTHER 0x0
740 #define TREE_WINDOW 0x1
741 #define TREE_SESSION 0x2
742 
743 	struct session		*tree_session; /* session of items in tree */
744 
745 	struct winlink		*wl;
746 	int			 pane_id;
747 
748 	char			*ft_template;
749 	struct format_tree	*ft;
750 
751 	char			*command;
752 };
753 
754 /* Child window structure. */
755 struct window_pane {
756 	u_int		 id;
757 	u_int		 active_point;
758 
759 	struct window	*window;
760 
761 	struct layout_cell *layout_cell;
762 	struct layout_cell *saved_layout_cell;
763 
764 	u_int		 sx;
765 	u_int		 sy;
766 
767 	u_int		 osx;
768 	u_int		 osy;
769 
770 	u_int		 xoff;
771 	u_int		 yoff;
772 
773 	int		 flags;
774 #define PANE_REDRAW 0x1
775 #define PANE_DROP 0x2
776 #define PANE_FOCUSED 0x4
777 #define PANE_RESIZE 0x8
778 #define PANE_RESIZEFORCE 0x10
779 #define PANE_FOCUSPUSH 0x20
780 #define PANE_INPUTOFF 0x40
781 #define PANE_CHANGED 0x80
782 #define PANE_EXITED 0x100
783 
784 	int		 argc;
785 	char	       **argv;
786 	char		*shell;
787 	const char	*cwd;
788 
789 	pid_t		 pid;
790 	char		 tty[TTY_NAME_MAX];
791 	int		 status;
792 
793 	int		 fd;
794 	struct bufferevent *event;
795 
796 	struct event	 resize_timer;
797 
798 	struct input_ctx *ictx;
799 
800 	struct grid_cell colgc;
801 
802 	int		*palette;
803 
804 	int		 pipe_fd;
805 	struct bufferevent *pipe_event;
806 	size_t		 pipe_off;
807 
808 	struct screen	*screen;
809 	struct screen	 base;
810 
811 	struct screen	 status_screen;
812 	size_t		 status_size;
813 
814 	/* Saved in alternative screen mode. */
815 	u_int		 saved_cx;
816 	u_int		 saved_cy;
817 	struct grid	*saved_grid;
818 	struct grid_cell saved_cell;
819 
820 	const struct window_mode *mode;
821 	void		*modedata;
822 	struct event	 modetimer;
823 	time_t		 modelast;
824 	u_int		 modeprefix;
825 	char		*searchstr;
826 
827 	TAILQ_ENTRY(window_pane) entry;
828 	RB_ENTRY(window_pane) tree_entry;
829 };
830 TAILQ_HEAD(window_panes, window_pane);
831 RB_HEAD(window_pane_tree, window_pane);
832 
833 /* Window structure. */
834 struct window {
835 	u_int		 id;
836 
837 	char		*name;
838 	struct event	 name_event;
839 	struct timeval	 name_time;
840 
841 	struct event	 alerts_timer;
842 
843 	struct timeval	 activity_time;
844 
845 	struct window_pane *active;
846 	struct window_pane *last;
847 	struct window_panes panes;
848 
849 	int		 lastlayout;
850 	struct layout_cell *layout_root;
851 	struct layout_cell *saved_layout_root;
852 	char		*old_layout;
853 
854 	u_int		 sx;
855 	u_int		 sy;
856 
857 	int		 flags;
858 #define WINDOW_BELL 0x1
859 #define WINDOW_ACTIVITY 0x2
860 /* 0x4 unused */
861 #define WINDOW_SILENCE 0x8
862 #define WINDOW_ZOOMED 0x1000
863 #define WINDOW_FORCEWIDTH 0x2000
864 #define WINDOW_FORCEHEIGHT 0x4000
865 #define WINDOW_STYLECHANGED 0x8000
866 #define WINDOW_ALERTFLAGS (WINDOW_BELL|WINDOW_ACTIVITY|WINDOW_SILENCE)
867 
868 	int		 alerts_queued;
869 	TAILQ_ENTRY(window) alerts_entry;
870 
871 	struct options	*options;
872 
873 	struct grid_cell style;
874 	struct grid_cell active_style;
875 
876 	u_int		 references;
877 	TAILQ_HEAD(, winlink) winlinks;
878 
879 	RB_ENTRY(window) entry;
880 };
881 RB_HEAD(windows, window);
882 
883 /* Entry on local window list. */
884 struct winlink {
885 	int		 idx;
886 	struct session	*session;
887 	struct window	*window;
888 
889 	size_t		 status_width;
890 	struct grid_cell status_cell;
891 	char		*status_text;
892 
893 	int		 flags;
894 #define WINLINK_BELL 0x1
895 #define WINLINK_ACTIVITY 0x2
896 #define WINLINK_SILENCE 0x4
897 #define WINLINK_ALERTFLAGS (WINLINK_BELL|WINLINK_ACTIVITY|WINLINK_SILENCE)
898 
899 	RB_ENTRY(winlink) entry;
900 	TAILQ_ENTRY(winlink) wentry;
901 	TAILQ_ENTRY(winlink) sentry;
902 };
903 RB_HEAD(winlinks, winlink);
904 TAILQ_HEAD(winlink_stack, winlink);
905 
906 /* Layout direction. */
907 enum layout_type {
908 	LAYOUT_LEFTRIGHT,
909 	LAYOUT_TOPBOTTOM,
910 	LAYOUT_WINDOWPANE
911 };
912 
913 /* Layout cells queue. */
914 TAILQ_HEAD(layout_cells, layout_cell);
915 
916 /* Layout cell. */
917 struct layout_cell {
918 	enum layout_type type;
919 
920 	struct layout_cell *parent;
921 
922 	u_int		 sx;
923 	u_int		 sy;
924 
925 	u_int		 xoff;
926 	u_int		 yoff;
927 
928 	struct window_pane *wp;
929 	struct layout_cells cells;
930 
931 	TAILQ_ENTRY(layout_cell) entry;
932 };
933 
934 /* Environment variable. */
935 struct environ_entry {
936 	char		*name;
937 	char		*value;
938 
939 	RB_ENTRY(environ_entry) entry;
940 };
941 
942 /* Client session. */
943 struct session_group {
944 	const char		*name;
945 	TAILQ_HEAD(, session)	 sessions;
946 
947 	RB_ENTRY(session_group)	 entry;
948 };
949 RB_HEAD(session_groups, session_group);
950 
951 struct session {
952 	u_int		 id;
953 
954 	char		*name;
955 	const char	*cwd;
956 
957 	struct timeval	 creation_time;
958 	struct timeval	 last_attached_time;
959 	struct timeval	 activity_time;
960 	struct timeval	 last_activity_time;
961 
962 	struct event	 lock_timer;
963 
964 	u_int		 sx;
965 	u_int		 sy;
966 
967 	struct winlink	*curw;
968 	struct winlink_stack lastw;
969 	struct winlinks	 windows;
970 
971 	int		 statusat;
972 
973 	struct hooks	*hooks;
974 	struct options	*options;
975 
976 #define SESSION_UNATTACHED 0x1	/* not attached to any clients */
977 #define SESSION_PASTING 0x2
978 #define SESSION_ALERTED 0x4
979 	int		 flags;
980 
981 	u_int		 attached;
982 
983 	struct termios	*tio;
984 
985 	struct environ	*environ;
986 
987 	int		 references;
988 
989 	TAILQ_ENTRY(session) gentry;
990 	RB_ENTRY(session)    entry;
991 };
992 RB_HEAD(sessions, session);
993 
994 /* Mouse button masks. */
995 #define MOUSE_MASK_BUTTONS 3
996 #define MOUSE_MASK_SHIFT 4
997 #define MOUSE_MASK_META 8
998 #define MOUSE_MASK_CTRL 16
999 #define MOUSE_MASK_DRAG 32
1000 #define MOUSE_MASK_WHEEL 64
1001 
1002 /* Mouse wheel states. */
1003 #define MOUSE_WHEEL_UP 0
1004 #define MOUSE_WHEEL_DOWN 64
1005 
1006 /* Mouse helpers. */
1007 #define MOUSE_BUTTONS(b) ((b) & MOUSE_MASK_BUTTONS)
1008 #define MOUSE_WHEEL(b) ((b) & MOUSE_MASK_WHEEL)
1009 #define MOUSE_DRAG(b) ((b) & MOUSE_MASK_DRAG)
1010 #define MOUSE_RELEASE(b) (((b) & MOUSE_MASK_BUTTONS) == 3)
1011 
1012 /* Mouse input. */
1013 struct mouse_event {
1014 	int		valid;
1015 
1016 	key_code	key;
1017 	int		statusat;
1018 
1019 	u_int		x;
1020 	u_int		y;
1021 	u_int		b;
1022 
1023 	u_int		lx;
1024 	u_int		ly;
1025 	u_int		lb;
1026 
1027 	int		s;
1028 	int		w;
1029 	int		wp;
1030 
1031 	u_int		sgr_type;
1032 	u_int		sgr_b;
1033 };
1034 
1035 /* TTY information. */
1036 struct tty_key {
1037 	char		 ch;
1038 	key_code	 key;
1039 
1040 	struct tty_key	*left;
1041 	struct tty_key	*right;
1042 
1043 	struct tty_key	*next;
1044 };
1045 
1046 struct tty_code;
1047 struct tty_term {
1048 	char		*name;
1049 	u_int		 references;
1050 
1051 	char		 acs[UCHAR_MAX + 1][2];
1052 
1053 	struct tty_code	*codes;
1054 
1055 #define TERM_256COLOURS 0x1
1056 #define TERM_EARLYWRAP 0x2
1057 	int		 flags;
1058 
1059 	LIST_ENTRY(tty_term) entry;
1060 };
1061 LIST_HEAD(tty_terms, tty_term);
1062 
1063 struct tty {
1064 	struct client	*client;
1065 
1066 	u_int		 sx;
1067 	u_int		 sy;
1068 
1069 	u_int		 cx;
1070 	u_int		 cy;
1071 	u_int		 cstyle;
1072 	char		*ccolour;
1073 
1074 	int		 mode;
1075 
1076 	u_int		 rlower;
1077 	u_int		 rupper;
1078 
1079 	u_int		 rleft;
1080 	u_int		 rright;
1081 
1082 	int		 fd;
1083 	struct event	 event_in;
1084 	struct evbuffer	*in;
1085 	struct event	 event_out;
1086 	struct evbuffer	*out;
1087 	struct event	 timer;
1088 	size_t		 discarded;
1089 
1090 	struct termios	 tio;
1091 
1092 	struct grid_cell cell;
1093 
1094 	int		 last_wp;
1095 	struct grid_cell last_cell;
1096 
1097 #define TTY_NOCURSOR 0x1
1098 #define TTY_FREEZE 0x2
1099 #define TTY_TIMER 0x4
1100 #define TTY_UTF8 0x8
1101 #define TTY_STARTED 0x10
1102 #define TTY_OPENED 0x20
1103 #define TTY_FOCUS 0x40
1104 #define TTY_BLOCK 0x80
1105 	int		 flags;
1106 
1107 	struct tty_term	*term;
1108 	char		*term_name;
1109 	int		 term_flags;
1110 	enum {
1111 		TTY_VT100,
1112 		TTY_VT101,
1113 		TTY_VT102,
1114 		TTY_VT220,
1115 		TTY_VT320,
1116 		TTY_VT420,
1117 		TTY_UNKNOWN
1118 	} term_type;
1119 
1120 	struct mouse_event mouse;
1121 	int		 mouse_drag_flag;
1122 	void		(*mouse_drag_update)(struct client *,
1123 			    struct mouse_event *);
1124 	void		(*mouse_drag_release)(struct client *,
1125 			    struct mouse_event *);
1126 
1127 	struct event	 key_timer;
1128 	struct tty_key	*key_tree;
1129 };
1130 #define TTY_TYPES \
1131 	{ "VT100", "VT101", "VT102", "VT220", "VT320", "VT420", "Unknown" }
1132 
1133 /* TTY command context. */
1134 struct tty_ctx {
1135 	struct window_pane	*wp;
1136 
1137 	const struct grid_cell	*cell;
1138 	int			 wrapped;
1139 
1140 	u_int		 num;
1141 	void		*ptr;
1142 
1143 	/*
1144 	 * Cursor and region position before the screen was updated - this is
1145 	 * where the command should be applied; the values in the screen have
1146 	 * already been updated.
1147 	 */
1148 	u_int		 ocx;
1149 	u_int		 ocy;
1150 
1151 	u_int		 orupper;
1152 	u_int		 orlower;
1153 
1154 	u_int		 xoff;
1155 	u_int		 yoff;
1156 
1157 	/* The background colour used for clearing (erasing). */
1158 	u_int		 bg;
1159 };
1160 
1161 /* Saved message entry. */
1162 struct message_entry {
1163 	char	*msg;
1164 	u_int	 msg_num;
1165 	time_t	 msg_time;
1166 	TAILQ_ENTRY(message_entry) entry;
1167 };
1168 
1169 /* Parsed arguments structures. */
1170 struct args_entry;
1171 RB_HEAD(args_tree, args_entry);
1172 struct args {
1173 	struct args_tree	  tree;
1174 	int			  argc;
1175 	char			**argv;
1176 };
1177 
1178 /* Command find structures. */
1179 enum cmd_find_type {
1180 	CMD_FIND_PANE,
1181 	CMD_FIND_WINDOW,
1182 	CMD_FIND_SESSION,
1183 };
1184 struct cmd_find_state {
1185 	int			 flags;
1186 	struct cmd_find_state	*current;
1187 
1188 	struct session		*s;
1189 	struct winlink		*wl;
1190 	struct window		*w;
1191 	struct window_pane	*wp;
1192 	int			 idx;
1193 };
1194 
1195 /* Command find flags. */
1196 #define CMD_FIND_PREFER_UNATTACHED 0x1
1197 #define CMD_FIND_QUIET 0x2
1198 #define CMD_FIND_WINDOW_INDEX 0x4
1199 #define CMD_FIND_DEFAULT_MARKED 0x8
1200 #define CMD_FIND_EXACT_SESSION 0x10
1201 #define CMD_FIND_EXACT_WINDOW 0x20
1202 #define CMD_FIND_CANFAIL 0x40
1203 
1204 /* Command and list of commands. */
1205 struct cmd {
1206 	const struct cmd_entry	*entry;
1207 	struct args		*args;
1208 
1209 	char			*file;
1210 	u_int			 line;
1211 
1212 #define CMD_CONTROL 0x1
1213 	int			 flags;
1214 
1215 	TAILQ_ENTRY(cmd)	 qentry;
1216 };
1217 
1218 struct cmd_list {
1219 	int			 references;
1220 	TAILQ_HEAD(, cmd)	 list;
1221 };
1222 
1223 /* Command return values. */
1224 enum cmd_retval {
1225 	CMD_RETURN_ERROR = -1,
1226 	CMD_RETURN_NORMAL = 0,
1227 	CMD_RETURN_WAIT,
1228 	CMD_RETURN_STOP
1229 };
1230 
1231 /* Command queue item type. */
1232 enum cmdq_type {
1233 	CMDQ_COMMAND,
1234 	CMDQ_CALLBACK,
1235 };
1236 
1237 /* Command queue item shared state. */
1238 struct cmdq_shared {
1239 	int			 references;
1240 
1241 	int			 flags;
1242 #define CMDQ_SHARED_REPEAT 0x1
1243 
1244 	struct format_tree	*formats;
1245 
1246 	struct mouse_event	 mouse;
1247 	struct cmd_find_state	 current;
1248 };
1249 
1250 /* Command queue item. */
1251 typedef enum cmd_retval (*cmdq_cb) (struct cmdq_item *, void *);
1252 struct cmdq_item {
1253 	const char		*name;
1254 	struct cmdq_list	*queue;
1255 	struct cmdq_item	*next;
1256 
1257 	struct client		*client;
1258 
1259 	enum cmdq_type		 type;
1260 	u_int			 group;
1261 
1262 	u_int			 number;
1263 	time_t			 time;
1264 
1265 	int			 flags;
1266 #define CMDQ_FIRED 0x1
1267 #define CMDQ_WAITING 0x2
1268 #define CMDQ_NOHOOKS 0x4
1269 
1270 	struct cmdq_shared	*shared;
1271 	struct cmd_find_state	 source;
1272 	struct cmd_find_state	 target;
1273 
1274 	struct cmd_list		*cmdlist;
1275 	struct cmd		*cmd;
1276 
1277 	cmdq_cb			 cb;
1278 	void			*data;
1279 
1280 	TAILQ_ENTRY(cmdq_item)	 entry;
1281 };
1282 TAILQ_HEAD(cmdq_list, cmdq_item);
1283 
1284 /* Command definition flag. */
1285 struct cmd_entry_flag {
1286 	char			 flag;
1287 	enum cmd_find_type	 type;
1288 	int			 flags;
1289 };
1290 
1291 /* Command definition. */
1292 struct cmd_entry {
1293 	const char		*name;
1294 	const char		*alias;
1295 
1296 	struct {
1297 		const char	*template;
1298 		int		 lower;
1299 		int		 upper;
1300 	} args;
1301 	const char		*usage;
1302 
1303 	struct cmd_entry_flag	 source;
1304 	struct cmd_entry_flag	 target;
1305 
1306 #define CMD_STARTSERVER 0x1
1307 #define CMD_READONLY 0x2
1308 #define CMD_AFTERHOOK 0x4
1309 	int		 flags;
1310 
1311 	enum cmd_retval	 (*exec)(struct cmd *, struct cmdq_item *);
1312 };
1313 
1314 /* Client connection. */
1315 typedef int (*prompt_input_cb)(struct client *, void *, const char *, int);
1316 typedef void (*prompt_free_cb)(void *);
1317 struct client {
1318 	const char	*name;
1319 	struct tmuxpeer	*peer;
1320 	struct cmdq_list queue;
1321 
1322 	pid_t		 pid;
1323 	int		 fd;
1324 	struct event	 event;
1325 	int		 retval;
1326 
1327 	struct timeval	 creation_time;
1328 	struct timeval	 activity_time;
1329 
1330 	struct environ	*environ;
1331 	struct format_job_tree	*jobs;
1332 
1333 	char		*title;
1334 	const char	*cwd;
1335 
1336 	char		*term;
1337 	char		*ttyname;
1338 	struct tty	 tty;
1339 
1340 	size_t		 written;
1341 	size_t		 discarded;
1342 	size_t		 redraw;
1343 
1344 	void		(*stdin_callback)(struct client *, int, void *);
1345 	void		*stdin_callback_data;
1346 	struct evbuffer	*stdin_data;
1347 	int		 stdin_closed;
1348 	struct evbuffer	*stdout_data;
1349 	struct evbuffer	*stderr_data;
1350 
1351 	struct event	 repeat_timer;
1352 
1353 	struct event	 click_timer;
1354 	u_int		 click_button;
1355 
1356 	struct event	 status_timer;
1357 	struct screen	 status;
1358 
1359 	struct screen	*old_status;
1360 
1361 #define CLIENT_TERMINAL 0x1
1362 #define CLIENT_LOGIN 0x2
1363 #define CLIENT_EXIT 0x4
1364 #define CLIENT_REDRAW 0x8
1365 #define CLIENT_STATUS 0x10
1366 #define CLIENT_REPEAT 0x20
1367 #define CLIENT_SUSPENDED 0x40
1368 #define CLIENT_ATTACHED 0x80
1369 #define CLIENT_IDENTIFY 0x100
1370 #define CLIENT_DEAD 0x200
1371 #define CLIENT_BORDERS 0x400
1372 #define CLIENT_READONLY 0x800
1373 #define CLIENT_DETACHING 0x1000
1374 #define CLIENT_CONTROL 0x2000
1375 #define CLIENT_CONTROLCONTROL 0x4000
1376 #define CLIENT_FOCUSED 0x8000
1377 #define CLIENT_UTF8 0x10000
1378 #define CLIENT_256COLOURS 0x20000
1379 #define CLIENT_IDENTIFIED 0x40000
1380 #define CLIENT_STATUSFORCE 0x80000
1381 #define CLIENT_DOUBLECLICK 0x100000
1382 #define CLIENT_TRIPLECLICK 0x200000
1383 #define CLIENT_SIZECHANGED 0x400000
1384 	int		 flags;
1385 	struct key_table *keytable;
1386 
1387 	struct event	 identify_timer;
1388 	void		(*identify_callback)(struct client *,
1389 			     struct window_pane *);
1390 	void		*identify_callback_data;
1391 
1392 	char		*message_string;
1393 	struct event	 message_timer;
1394 	u_int		 message_next;
1395 	TAILQ_HEAD(, message_entry) message_log;
1396 
1397 	char		*prompt_string;
1398 	struct utf8_data *prompt_buffer;
1399 	size_t		 prompt_index;
1400 	prompt_input_cb	 prompt_inputcb;
1401 	prompt_free_cb	 prompt_freecb;
1402 	void		*prompt_data;
1403 	u_int		 prompt_hindex;
1404 	enum { PROMPT_ENTRY, PROMPT_COMMAND } prompt_mode;
1405 
1406 #define PROMPT_SINGLE 0x1
1407 #define PROMPT_NUMERIC 0x2
1408 #define PROMPT_INCREMENTAL 0x4
1409 #define PROMPT_NOFORMAT 0x8
1410 	int		 prompt_flags;
1411 
1412 	struct session	*session;
1413 	struct session	*last_session;
1414 
1415 	int		 wlmouse;
1416 
1417 	int		 references;
1418 
1419 	TAILQ_ENTRY(client) entry;
1420 };
1421 TAILQ_HEAD(clients, client);
1422 
1423 /* Key binding and key table. */
1424 struct key_binding {
1425 	key_code		 key;
1426 	struct cmd_list		*cmdlist;
1427 
1428 	int			 flags;
1429 #define KEY_BINDING_REPEAT 0x1
1430 
1431 	RB_ENTRY(key_binding)	 entry;
1432 };
1433 RB_HEAD(key_bindings, key_binding);
1434 
1435 struct key_table {
1436 	const char		 *name;
1437 	struct key_bindings	 key_bindings;
1438 
1439 	u_int			 references;
1440 
1441 	RB_ENTRY(key_table)	 entry;
1442 };
1443 RB_HEAD(key_tables, key_table);
1444 
1445 /* Option table entries. */
1446 enum options_table_type {
1447 	OPTIONS_TABLE_STRING,
1448 	OPTIONS_TABLE_NUMBER,
1449 	OPTIONS_TABLE_KEY,
1450 	OPTIONS_TABLE_COLOUR,
1451 	OPTIONS_TABLE_ATTRIBUTES,
1452 	OPTIONS_TABLE_FLAG,
1453 	OPTIONS_TABLE_CHOICE,
1454 	OPTIONS_TABLE_STYLE,
1455 	OPTIONS_TABLE_ARRAY,
1456 };
1457 enum options_table_scope {
1458 	OPTIONS_TABLE_NONE,
1459 	OPTIONS_TABLE_SERVER,
1460 	OPTIONS_TABLE_SESSION,
1461 	OPTIONS_TABLE_WINDOW,
1462 };
1463 
1464 struct options_table_entry {
1465 	const char		 *name;
1466 	enum options_table_type	  type;
1467 	enum options_table_scope  scope;
1468 
1469 	u_int			  minimum;
1470 	u_int			  maximum;
1471 	const char		**choices;
1472 
1473 	const char		 *default_str;
1474 	long long		  default_num;
1475 
1476 	const char		 *separator;
1477 	const char		 *style;
1478 };
1479 
1480 /* Common command usages. */
1481 #define CMD_TARGET_PANE_USAGE "[-t target-pane]"
1482 #define CMD_TARGET_WINDOW_USAGE "[-t target-window]"
1483 #define CMD_TARGET_SESSION_USAGE "[-t target-session]"
1484 #define CMD_TARGET_CLIENT_USAGE "[-t target-client]"
1485 #define CMD_SRCDST_PANE_USAGE "[-s src-pane] [-t dst-pane]"
1486 #define CMD_SRCDST_WINDOW_USAGE "[-s src-window] [-t dst-window]"
1487 #define CMD_SRCDST_SESSION_USAGE "[-s src-session] [-t dst-session]"
1488 #define CMD_SRCDST_CLIENT_USAGE "[-s src-client] [-t dst-client]"
1489 #define CMD_BUFFER_USAGE "[-b buffer-name]"
1490 
1491 /* tmux.c */
1492 extern struct hooks	*global_hooks;
1493 extern struct options	*global_options;
1494 extern struct options	*global_s_options;
1495 extern struct options	*global_w_options;
1496 extern struct environ	*global_environ;
1497 extern struct timeval	 start_time;
1498 extern const char	*socket_path;
1499 extern const char	*shell_command;
1500 extern int		 ptm_fd;
1501 extern const char	*shell_command;
1502 int		 areshell(const char *);
1503 void		 setblocking(int, int);
1504 const char	*find_home(void);
1505 
1506 /* proc.c */
1507 struct imsg;
1508 int	proc_send(struct tmuxpeer *, enum msgtype, int, const void *, size_t);
1509 struct tmuxproc *proc_start(const char *);
1510 void	proc_loop(struct tmuxproc *, int (*)(void));
1511 void	proc_exit(struct tmuxproc *);
1512 void	proc_set_signals(struct tmuxproc *, void(*)(int));
1513 void	proc_clear_signals(struct tmuxproc *, int);
1514 struct tmuxpeer *proc_add_peer(struct tmuxproc *, int,
1515 	    void (*)(struct imsg *, void *), void *);
1516 void	proc_remove_peer(struct tmuxpeer *);
1517 void	proc_kill_peer(struct tmuxpeer *);
1518 void	proc_toggle_log(struct tmuxproc *);
1519 
1520 /* cfg.c */
1521 extern int cfg_finished;
1522 void	start_cfg(void);
1523 int	load_cfg(const char *, struct client *, struct cmdq_item *, int);
1524 void	set_cfg_file(const char *);
1525 void printflike(1, 2) cfg_add_cause(const char *, ...);
1526 void	cfg_print_causes(struct cmdq_item *);
1527 void	cfg_show_causes(struct session *);
1528 
1529 /* paste.c */
1530 struct paste_buffer;
1531 const char	*paste_buffer_name(struct paste_buffer *);
1532 u_int		 paste_buffer_order(struct paste_buffer *);
1533 time_t		 paste_buffer_created(struct paste_buffer *);
1534 const char	*paste_buffer_data(struct paste_buffer *, size_t *);
1535 struct paste_buffer *paste_walk(struct paste_buffer *);
1536 struct paste_buffer *paste_get_top(const char **);
1537 struct paste_buffer *paste_get_name(const char *);
1538 void		 paste_free(struct paste_buffer *);
1539 void		 paste_add(char *, size_t);
1540 int		 paste_rename(const char *, const char *, char **);
1541 int		 paste_set(char *, size_t, const char *, char **);
1542 char		*paste_make_sample(struct paste_buffer *);
1543 
1544 /* format.c */
1545 #define FORMAT_STATUS 0x1
1546 #define FORMAT_FORCE 0x2
1547 #define FORMAT_NOJOBS 0x4
1548 #define FORMAT_NONE 0
1549 #define FORMAT_PANE 0x80000000U
1550 #define FORMAT_WINDOW 0x40000000U
1551 struct format_tree;
1552 int		 format_true(const char *);
1553 struct format_tree *format_create(struct client *, struct cmdq_item *, int,
1554 		     int);
1555 void		 format_free(struct format_tree *);
1556 void printflike(3, 4) format_add(struct format_tree *, const char *,
1557 		     const char *, ...);
1558 char		*format_expand_time(struct format_tree *, const char *, time_t);
1559 char		*format_expand(struct format_tree *, const char *);
1560 char		*format_single(struct cmdq_item *, const char *,
1561 		     struct client *, struct session *, struct winlink *,
1562 		     struct window_pane *);
1563 void		 format_defaults(struct format_tree *, struct client *,
1564 		     struct session *, struct winlink *, struct window_pane *);
1565 void		 format_defaults_window(struct format_tree *, struct window *);
1566 void		 format_defaults_pane(struct format_tree *,
1567 		     struct window_pane *);
1568 void		 format_defaults_paste_buffer(struct format_tree *,
1569 		     struct paste_buffer *);
1570 void		 format_lost_client(struct client *);
1571 
1572 /* hooks.c */
1573 struct hook;
1574 struct hooks	*hooks_get(struct session *);
1575 struct hooks	*hooks_create(struct hooks *);
1576 void		 hooks_free(struct hooks *);
1577 struct hook	*hooks_first(struct hooks *);
1578 struct hook	*hooks_next(struct hook *);
1579 void		 hooks_add(struct hooks *, const char *, struct cmd_list *);
1580 void		 hooks_copy(struct hooks *, struct hooks *);
1581 void		 hooks_remove(struct hooks *, const char *);
1582 struct hook	*hooks_find(struct hooks *, const char *);
1583 void printflike(4, 5) hooks_run(struct hooks *, struct client *,
1584 		    struct cmd_find_state *, const char *, ...);
1585 void printflike(4, 5) hooks_insert(struct hooks *, struct cmdq_item *,
1586 		    struct cmd_find_state *, const char *, ...);
1587 
1588 /* notify.c */
1589 void	notify_input(struct window_pane *, struct evbuffer *);
1590 void	notify_client(const char *, struct client *);
1591 void	notify_session(const char *, struct session *);
1592 void	notify_winlink(const char *, struct winlink *);
1593 void	notify_session_window(const char *, struct session *, struct window *);
1594 void	notify_window(const char *, struct window *);
1595 void	notify_pane(const char *, struct window_pane *);
1596 
1597 /* options.c */
1598 struct options	*options_create(struct options *);
1599 void		 options_free(struct options *);
1600 struct options_entry *options_first(struct options *);
1601 struct options_entry *options_next(struct options_entry *);
1602 struct options_entry *options_empty(struct options *,
1603 		     const struct options_table_entry *);
1604 struct options_entry *options_default(struct options *,
1605 		     const struct options_table_entry *);
1606 const char	*options_name(struct options_entry *);
1607 const struct options_table_entry *options_table_entry(struct options_entry *);
1608 struct options_entry *options_get_only(struct options *, const char *);
1609 struct options_entry *options_get(struct options *, const char *);
1610 void		 options_remove(struct options_entry *);
1611 void		 options_array_clear(struct options_entry *);
1612 const char	*options_array_get(struct options_entry *, u_int);
1613 int		 options_array_set(struct options_entry *, u_int, const char *,
1614 		     int);
1615 int		 options_array_size(struct options_entry *, u_int *);
1616 void		 options_array_assign(struct options_entry *, const char *);
1617 int		 options_isstring(struct options_entry *);
1618 const char	*options_tostring(struct options_entry *, int, int);
1619 char		*options_parse(const char *, int *);
1620 struct options_entry *options_parse_get(struct options *, const char *, int *,
1621 		     int);
1622 char		*options_match(const char *, int *, int *);
1623 struct options_entry *options_match_get(struct options *, const char *, int *,
1624 		     int, int *);
1625 const char	*options_get_string(struct options *, const char *);
1626 long long	 options_get_number(struct options *, const char *);
1627 const struct grid_cell *options_get_style(struct options *, const char *);
1628 struct options_entry * printflike(4, 5) options_set_string(struct options *,
1629 		     const char *, int, const char *, ...);
1630 struct options_entry *options_set_number(struct options *, const char *,
1631 		     long long);
1632 struct options_entry *options_set_style(struct options *, const char *, int,
1633 		     const char *);
1634 enum options_table_scope options_scope_from_flags(struct args *, int,
1635 		     struct cmd_find_state *, struct options **, char **);
1636 void		 options_style_update_new(struct options *,
1637 		     struct options_entry *);
1638 void		 options_style_update_old(struct options *,
1639 		     struct options_entry *);
1640 
1641 /* options-table.c */
1642 extern const struct options_table_entry options_table[];
1643 
1644 /* job.c */
1645 extern struct joblist all_jobs;
1646 struct job	*job_run(const char *, struct session *, const char *,
1647 		     job_update_cb, job_complete_cb, job_free_cb, void *);
1648 void		 job_free(struct job *);
1649 void		 job_died(struct job *, int);
1650 
1651 /* environ.c */
1652 struct environ *environ_create(void);
1653 void	environ_free(struct environ *);
1654 struct environ_entry *environ_first(struct environ *);
1655 struct environ_entry *environ_next(struct environ_entry *);
1656 void	environ_copy(struct environ *, struct environ *);
1657 struct environ_entry *environ_find(struct environ *, const char *);
1658 void printflike(3, 4) environ_set(struct environ *, const char *, const char *,
1659 	    ...);
1660 void	environ_clear(struct environ *, const char *);
1661 void	environ_put(struct environ *, const char *);
1662 void	environ_unset(struct environ *, const char *);
1663 void	environ_update(struct options *, struct environ *, struct environ *);
1664 void	environ_push(struct environ *);
1665 void printflike(2, 3) environ_log(struct environ *, const char *, ...);
1666 struct environ *environ_for_session(struct session *, int);
1667 
1668 /* tty.c */
1669 void	tty_create_log(void);
1670 void	tty_raw(struct tty *, const char *);
1671 void	tty_attributes(struct tty *, const struct grid_cell *,
1672 	    const struct window_pane *);
1673 void	tty_reset(struct tty *);
1674 void	tty_region_off(struct tty *);
1675 void	tty_margin_off(struct tty *);
1676 void	tty_cursor(struct tty *, u_int, u_int);
1677 void	tty_putcode(struct tty *, enum tty_code_code);
1678 void	tty_putcode1(struct tty *, enum tty_code_code, int);
1679 void	tty_putcode2(struct tty *, enum tty_code_code, int, int);
1680 void	tty_putcode3(struct tty *, enum tty_code_code, int, int, int);
1681 void	tty_putcode_ptr1(struct tty *, enum tty_code_code, const void *);
1682 void	tty_putcode_ptr2(struct tty *, enum tty_code_code, const void *,
1683 	    const void *);
1684 void	tty_puts(struct tty *, const char *);
1685 void	tty_putc(struct tty *, u_char);
1686 void	tty_putn(struct tty *, const void *, size_t, u_int);
1687 int	tty_init(struct tty *, struct client *, int, char *);
1688 void	tty_resize(struct tty *);
1689 void	tty_set_size(struct tty *, u_int, u_int);
1690 void	tty_start_tty(struct tty *);
1691 void	tty_stop_tty(struct tty *);
1692 void	tty_set_title(struct tty *, const char *);
1693 void	tty_update_mode(struct tty *, int, struct screen *);
1694 void	tty_draw_pane(struct tty *, const struct window_pane *, u_int, u_int,
1695 	    u_int);
1696 void	tty_draw_line(struct tty *, const struct window_pane *, struct screen *,
1697 	    u_int, u_int, u_int);
1698 int	tty_open(struct tty *, char **);
1699 void	tty_close(struct tty *);
1700 void	tty_free(struct tty *);
1701 void	tty_set_type(struct tty *, int);
1702 void	tty_write(void (*)(struct tty *, const struct tty_ctx *),
1703 	    struct tty_ctx *);
1704 void	tty_cmd_alignmenttest(struct tty *, const struct tty_ctx *);
1705 void	tty_cmd_cell(struct tty *, const struct tty_ctx *);
1706 void	tty_cmd_cells(struct tty *, const struct tty_ctx *);
1707 void	tty_cmd_clearendofline(struct tty *, const struct tty_ctx *);
1708 void	tty_cmd_clearendofscreen(struct tty *, const struct tty_ctx *);
1709 void	tty_cmd_clearline(struct tty *, const struct tty_ctx *);
1710 void	tty_cmd_clearscreen(struct tty *, const struct tty_ctx *);
1711 void	tty_cmd_clearstartofline(struct tty *, const struct tty_ctx *);
1712 void	tty_cmd_clearstartofscreen(struct tty *, const struct tty_ctx *);
1713 void	tty_cmd_deletecharacter(struct tty *, const struct tty_ctx *);
1714 void	tty_cmd_clearcharacter(struct tty *, const struct tty_ctx *);
1715 void	tty_cmd_deleteline(struct tty *, const struct tty_ctx *);
1716 void	tty_cmd_erasecharacter(struct tty *, const struct tty_ctx *);
1717 void	tty_cmd_insertcharacter(struct tty *, const struct tty_ctx *);
1718 void	tty_cmd_insertline(struct tty *, const struct tty_ctx *);
1719 void	tty_cmd_linefeed(struct tty *, const struct tty_ctx *);
1720 void	tty_cmd_scrollup(struct tty *, const struct tty_ctx *);
1721 void	tty_cmd_reverseindex(struct tty *, const struct tty_ctx *);
1722 void	tty_cmd_setselection(struct tty *, const struct tty_ctx *);
1723 void	tty_cmd_rawstring(struct tty *, const struct tty_ctx *);
1724 
1725 /* tty-term.c */
1726 extern struct tty_terms tty_terms;
1727 u_int		 tty_term_ncodes(void);
1728 struct tty_term *tty_term_find(char *, int, char **);
1729 void		 tty_term_free(struct tty_term *);
1730 int		 tty_term_has(struct tty_term *, enum tty_code_code);
1731 const char	*tty_term_string(struct tty_term *, enum tty_code_code);
1732 const char	*tty_term_string1(struct tty_term *, enum tty_code_code, int);
1733 const char	*tty_term_string2(struct tty_term *, enum tty_code_code, int,
1734 		     int);
1735 const char	*tty_term_string3(struct tty_term *, enum tty_code_code, int,
1736 		     int, int);
1737 const char	*tty_term_ptr1(struct tty_term *, enum tty_code_code,
1738 		     const void *);
1739 const char	*tty_term_ptr2(struct tty_term *, enum tty_code_code,
1740 		     const void *, const void *);
1741 int		 tty_term_number(struct tty_term *, enum tty_code_code);
1742 int		 tty_term_flag(struct tty_term *, enum tty_code_code);
1743 const char	*tty_term_describe(struct tty_term *, enum tty_code_code);
1744 
1745 /* tty-acs.c */
1746 int		 tty_acs_needed(struct tty *);
1747 const char	*tty_acs_get(struct tty *, u_char);
1748 
1749 /* tty-keys.c */
1750 void		tty_keys_build(struct tty *);
1751 void		tty_keys_free(struct tty *);
1752 key_code	tty_keys_next(struct tty *);
1753 
1754 /* arguments.c */
1755 void		 args_set(struct args *, u_char, const char *);
1756 struct args	*args_parse(const char *, int, char **);
1757 void		 args_free(struct args *);
1758 char		*args_print(struct args *);
1759 int		 args_has(struct args *, u_char);
1760 const char	*args_get(struct args *, u_char);
1761 long long	 args_strtonum(struct args *, u_char, long long, long long,
1762 		     char **);
1763 
1764 /* cmd-find.c */
1765 int		 cmd_find_target(struct cmd_find_state *, struct cmdq_item *,
1766 		     const char *, enum cmd_find_type, int);
1767 struct client	*cmd_find_client(struct cmdq_item *, const char *, int);
1768 void		 cmd_find_clear_state(struct cmd_find_state *, int);
1769 int		 cmd_find_empty_state(struct cmd_find_state *);
1770 int		 cmd_find_valid_state(struct cmd_find_state *);
1771 void		 cmd_find_copy_state(struct cmd_find_state *,
1772 		     struct cmd_find_state *);
1773 void		 cmd_find_log_state(const char *, struct cmd_find_state *);
1774 void		 cmd_find_from_session(struct cmd_find_state *,
1775 		     struct session *, int);
1776 void		 cmd_find_from_winlink(struct cmd_find_state *,
1777 		     struct winlink *, int);
1778 int		 cmd_find_from_session_window(struct cmd_find_state *,
1779 		     struct session *, struct window *, int);
1780 int		 cmd_find_from_window(struct cmd_find_state *, struct window *,
1781 		     int);
1782 void		 cmd_find_from_winlink_pane(struct cmd_find_state *,
1783 		     struct winlink *, struct window_pane *, int);
1784 int		 cmd_find_from_pane(struct cmd_find_state *,
1785 		     struct window_pane *, int);
1786 int		 cmd_find_from_client(struct cmd_find_state *, struct client *,
1787 		     int);
1788 int		 cmd_find_from_mouse(struct cmd_find_state *,
1789 		     struct mouse_event *, int);
1790 int		 cmd_find_from_nothing(struct cmd_find_state *, int);
1791 
1792 /* cmd.c */
1793 int		 cmd_pack_argv(int, char **, char *, size_t);
1794 int		 cmd_unpack_argv(char *, size_t, int, char ***);
1795 char	       **cmd_copy_argv(int, char **);
1796 void		 cmd_free_argv(int, char **);
1797 char		*cmd_stringify_argv(int, char **);
1798 struct cmd	*cmd_parse(int, char **, const char *, u_int, char **);
1799 char		*cmd_print(struct cmd *);
1800 int		 cmd_mouse_at(struct window_pane *, struct mouse_event *,
1801 		     u_int *, u_int *, int);
1802 struct winlink	*cmd_mouse_window(struct mouse_event *, struct session **);
1803 struct window_pane *cmd_mouse_pane(struct mouse_event *, struct session **,
1804 		     struct winlink **);
1805 char		*cmd_template_replace(const char *, const char *, int);
1806 extern const struct cmd_entry *cmd_table[];
1807 
1808 /* cmd-attach-session.c */
1809 enum cmd_retval	 cmd_attach_session(struct cmdq_item *, const char *, int, int,
1810 		     const char *, int);
1811 
1812 /* cmd-list.c */
1813 struct cmd_list	*cmd_list_parse(int, char **, const char *, u_int, char **);
1814 void		 cmd_list_free(struct cmd_list *);
1815 char		*cmd_list_print(struct cmd_list *);
1816 
1817 /* cmd-queue.c */
1818 struct cmdq_item *cmdq_get_command(struct cmd_list *, struct cmd_find_state *,
1819 		     struct mouse_event *, int);
1820 #define cmdq_get_callback(cb, data) cmdq_get_callback1(#cb, cb, data)
1821 struct cmdq_item *cmdq_get_callback1(const char *, cmdq_cb, void *);
1822 void		 cmdq_insert_after(struct cmdq_item *, struct cmdq_item *);
1823 void		 cmdq_append(struct client *, struct cmdq_item *);
1824 void printflike(3, 4) cmdq_format(struct cmdq_item *, const char *,
1825 		     const char *, ...);
1826 u_int		 cmdq_next(struct client *);
1827 void		 cmdq_guard(struct cmdq_item *, const char *, int);
1828 void printflike(2, 3) cmdq_print(struct cmdq_item *, const char *, ...);
1829 void printflike(2, 3) cmdq_error(struct cmdq_item *, const char *, ...);
1830 
1831 /* cmd-string.c */
1832 int		 cmd_string_split(const char *, int *, char ***);
1833 struct cmd_list	*cmd_string_parse(const char *, const char *, u_int, char **);
1834 
1835 /* cmd-wait-for.c */
1836 void	cmd_wait_for_flush(void);
1837 
1838 /* client.c */
1839 int	client_main(struct event_base *, int, char **, int);
1840 
1841 /* key-bindings.c */
1842 RB_PROTOTYPE(key_bindings, key_binding, entry, key_bindings_cmp);
1843 RB_PROTOTYPE(key_tables, key_table, entry, key_table_cmp);
1844 extern struct key_tables key_tables;
1845 int	 key_table_cmp(struct key_table *, struct key_table *);
1846 int	 key_bindings_cmp(struct key_binding *, struct key_binding *);
1847 struct key_table *key_bindings_get_table(const char *, int);
1848 void	 key_bindings_unref_table(struct key_table *);
1849 void	 key_bindings_add(const char *, key_code, int, struct cmd_list *);
1850 void	 key_bindings_remove(const char *, key_code);
1851 void	 key_bindings_remove_table(const char *);
1852 void	 key_bindings_init(void);
1853 void	 key_bindings_dispatch(struct key_binding *, struct cmdq_item *,
1854 	     struct client *, struct mouse_event *, struct cmd_find_state *);
1855 
1856 /* key-string.c */
1857 key_code	 key_string_lookup_string(const char *);
1858 const char	*key_string_lookup_key(key_code);
1859 
1860 /* alerts.c */
1861 void	alerts_reset_all(void);
1862 void	alerts_queue(struct window *, int);
1863 void	alerts_check_session(struct session *);
1864 
1865 /* server.c */
1866 extern struct tmuxproc *server_proc;
1867 extern struct clients clients;
1868 extern struct cmd_find_state marked_pane;
1869 void	 server_set_marked(struct session *, struct winlink *,
1870 	     struct window_pane *);
1871 void	 server_clear_marked(void);
1872 int	 server_is_marked(struct session *, struct winlink *,
1873 	     struct window_pane *);
1874 int	 server_check_marked(void);
1875 int	 server_start(struct tmuxproc *, struct event_base *, int, char *);
1876 void	 server_update_socket(void);
1877 void	 server_add_accept(int);
1878 
1879 /* server-client.c */
1880 u_int	 server_client_how_many(void);
1881 void	 server_client_set_identify(struct client *, u_int);
1882 void	 server_client_clear_identify(struct client *, struct window_pane *);
1883 void	 server_client_set_key_table(struct client *, const char *);
1884 const char *server_client_get_key_table(struct client *);
1885 int	 server_client_check_nested(struct client *);
1886 void	 server_client_handle_key(struct client *, key_code);
1887 void	 server_client_create(int);
1888 int	 server_client_open(struct client *, char **);
1889 void	 server_client_unref(struct client *);
1890 void	 server_client_lost(struct client *);
1891 void	 server_client_suspend(struct client *);
1892 void	 server_client_detach(struct client *, enum msgtype);
1893 void	 server_client_exec(struct client *, const char *);
1894 void	 server_client_loop(void);
1895 void	 server_client_push_stdout(struct client *);
1896 void	 server_client_push_stderr(struct client *);
1897 void printflike(2, 3) server_client_add_message(struct client *, const char *,
1898 	     ...);
1899 char	*server_client_get_path(struct client *, const char *);
1900 const char *server_client_get_cwd(struct client *);
1901 
1902 /* server-fn.c */
1903 void	 server_redraw_client(struct client *);
1904 void	 server_status_client(struct client *);
1905 void	 server_redraw_session(struct session *);
1906 void	 server_redraw_session_group(struct session *);
1907 void	 server_status_session(struct session *);
1908 void	 server_status_session_group(struct session *);
1909 void	 server_redraw_window(struct window *);
1910 void	 server_redraw_window_borders(struct window *);
1911 void	 server_status_window(struct window *);
1912 void	 server_lock(void);
1913 void	 server_lock_session(struct session *);
1914 void	 server_lock_client(struct client *);
1915 void	 server_kill_window(struct window *);
1916 int	 server_link_window(struct session *,
1917 	     struct winlink *, struct session *, int, int, int, char **);
1918 void	 server_unlink_window(struct session *, struct winlink *);
1919 void	 server_destroy_pane(struct window_pane *, int);
1920 void	 server_destroy_session(struct session *);
1921 void	 server_check_unattached(void);
1922 int	 server_set_stdin_callback(struct client *, void (*)(struct client *,
1923 	     int, void *), void *, char **);
1924 void	 server_unzoom_window(struct window *);
1925 
1926 /* status.c */
1927 void	 status_timer_start(struct client *);
1928 void	 status_timer_start_all(void);
1929 void	 status_update_saved(struct session *s);
1930 int	 status_at_line(struct client *);
1931 struct window *status_get_window_at(struct client *, u_int);
1932 int	 status_redraw(struct client *);
1933 void printflike(2, 3) status_message_set(struct client *, const char *, ...);
1934 void	 status_message_clear(struct client *);
1935 int	 status_message_redraw(struct client *);
1936 void	 status_prompt_set(struct client *, const char *, const char *,
1937 	     prompt_input_cb, prompt_free_cb, void *, int);
1938 void	 status_prompt_clear(struct client *);
1939 int	 status_prompt_redraw(struct client *);
1940 int	 status_prompt_key(struct client *, key_code);
1941 void	 status_prompt_update(struct client *, const char *, const char *);
1942 void	 status_prompt_load_history(void);
1943 void	 status_prompt_save_history(void);
1944 
1945 /* resize.c */
1946 void	 recalculate_sizes(void);
1947 
1948 /* input.c */
1949 void	 input_init(struct window_pane *);
1950 void	 input_free(struct window_pane *);
1951 void	 input_reset(struct window_pane *, int);
1952 struct evbuffer *input_pending(struct window_pane *);
1953 void	 input_parse(struct window_pane *);
1954 
1955 /* input-key.c */
1956 void	 input_key(struct window_pane *, key_code, struct mouse_event *);
1957 
1958 /* xterm-keys.c */
1959 char	*xterm_keys_lookup(key_code);
1960 int	 xterm_keys_find(const char *, size_t, size_t *, key_code *);
1961 
1962 /* colour.c */
1963 int	 colour_find_rgb(u_char, u_char, u_char);
1964 int	 colour_join_rgb(u_char, u_char, u_char);
1965 void	 colour_split_rgb(int, u_char *, u_char *, u_char *);
1966 const char *colour_tostring(int);
1967 int	 colour_fromstring(const char *s);
1968 u_char	 colour_256to16(u_char);
1969 
1970 /* attributes.c */
1971 const char *attributes_tostring(int);
1972 int	 attributes_fromstring(const char *);
1973 
1974 /* grid.c */
1975 extern const struct grid_cell grid_default_cell;
1976 int	 grid_cells_equal(const struct grid_cell *, const struct grid_cell *);
1977 struct grid *grid_create(u_int, u_int, u_int);
1978 void	 grid_destroy(struct grid *);
1979 int	 grid_compare(struct grid *, struct grid *);
1980 void	 grid_collect_history(struct grid *);
1981 void	 grid_scroll_history(struct grid *, u_int);
1982 void	 grid_scroll_history_region(struct grid *, u_int, u_int, u_int);
1983 void	 grid_clear_history(struct grid *);
1984 const struct grid_line *grid_peek_line(struct grid *, u_int);
1985 void	 grid_get_cell(struct grid *, u_int, u_int, struct grid_cell *);
1986 void	 grid_set_cell(struct grid *, u_int, u_int, const struct grid_cell *);
1987 void	 grid_set_cells(struct grid *, u_int, u_int, const struct grid_cell *,
1988 	     const char *, size_t);
1989 void	 grid_clear(struct grid *, u_int, u_int, u_int, u_int, u_int);
1990 void	 grid_clear_lines(struct grid *, u_int, u_int, u_int);
1991 void	 grid_move_lines(struct grid *, u_int, u_int, u_int, u_int);
1992 void	 grid_move_cells(struct grid *, u_int, u_int, u_int, u_int, u_int);
1993 char	*grid_string_cells(struct grid *, u_int, u_int, u_int,
1994 	     struct grid_cell **, int, int, int);
1995 void	 grid_duplicate_lines(struct grid *, u_int, struct grid *, u_int,
1996 	     u_int);
1997 u_int	 grid_reflow(struct grid *, struct grid *, u_int);
1998 
1999 /* grid-view.c */
2000 void	 grid_view_get_cell(struct grid *, u_int, u_int, struct grid_cell *);
2001 void	 grid_view_set_cell(struct grid *, u_int, u_int,
2002 	     const struct grid_cell *);
2003 void	 grid_view_set_cells(struct grid *, u_int, u_int,
2004 	     const struct grid_cell *, const char *, size_t);
2005 void	 grid_view_clear_history(struct grid *, u_int);
2006 void	 grid_view_clear(struct grid *, u_int, u_int, u_int, u_int, u_int);
2007 void	 grid_view_scroll_region_up(struct grid *, u_int, u_int, u_int);
2008 void	 grid_view_scroll_region_down(struct grid *, u_int, u_int, u_int);
2009 void	 grid_view_insert_lines(struct grid *, u_int, u_int, u_int);
2010 void	 grid_view_insert_lines_region(struct grid *, u_int, u_int, u_int,
2011 	u_int);
2012 void	 grid_view_delete_lines(struct grid *, u_int, u_int, u_int);
2013 void	 grid_view_delete_lines_region(struct grid *, u_int, u_int, u_int,
2014 	u_int);
2015 void	 grid_view_insert_cells(struct grid *, u_int, u_int, u_int, u_int);
2016 void	 grid_view_delete_cells(struct grid *, u_int, u_int, u_int, u_int);
2017 char	*grid_view_string_cells(struct grid *, u_int, u_int, u_int);
2018 
2019 /* screen-write.c */
2020 void	 screen_write_start(struct screen_write_ctx *, struct window_pane *,
2021 	     struct screen *);
2022 void	 screen_write_stop(struct screen_write_ctx *);
2023 void	 screen_write_reset(struct screen_write_ctx *);
2024 size_t printflike(1, 2) screen_write_cstrlen(const char *, ...);
2025 void printflike(4, 5) screen_write_cnputs(struct screen_write_ctx *,
2026 	     ssize_t, const struct grid_cell *, const char *, ...);
2027 size_t printflike(1, 2) screen_write_strlen(const char *, ...);
2028 void printflike(3, 4) screen_write_puts(struct screen_write_ctx *,
2029 	     const struct grid_cell *, const char *, ...);
2030 void printflike(4, 5) screen_write_nputs(struct screen_write_ctx *,
2031 	     ssize_t, const struct grid_cell *, const char *, ...);
2032 void printflike(4, 0) screen_write_vnputs(struct screen_write_ctx *, ssize_t,
2033 	     const struct grid_cell *, const char *, va_list);
2034 void	 screen_write_putc(struct screen_write_ctx *, const struct grid_cell *,
2035 	     u_char);
2036 void	 screen_write_copy(struct screen_write_ctx *, struct screen *, u_int,
2037 	     u_int, u_int, u_int, bitstr_t *, const struct grid_cell *);
2038 void	 screen_write_hline(struct screen_write_ctx *, u_int, int, int);
2039 void	 screen_write_vline(struct screen_write_ctx *, u_int, int, int);
2040 void	 screen_write_box(struct screen_write_ctx *, u_int, u_int);
2041 void	 screen_write_preview(struct screen_write_ctx *, struct screen *, u_int,
2042 	     u_int);
2043 void	 screen_write_backspace(struct screen_write_ctx *);
2044 void	 screen_write_mode_set(struct screen_write_ctx *, int);
2045 void	 screen_write_mode_clear(struct screen_write_ctx *, int);
2046 void	 screen_write_cursorup(struct screen_write_ctx *, u_int);
2047 void	 screen_write_cursordown(struct screen_write_ctx *, u_int);
2048 void	 screen_write_cursorright(struct screen_write_ctx *, u_int);
2049 void	 screen_write_cursorleft(struct screen_write_ctx *, u_int);
2050 void	 screen_write_alignmenttest(struct screen_write_ctx *);
2051 void	 screen_write_insertcharacter(struct screen_write_ctx *, u_int, u_int);
2052 void	 screen_write_deletecharacter(struct screen_write_ctx *, u_int, u_int);
2053 void	 screen_write_clearcharacter(struct screen_write_ctx *, u_int, u_int);
2054 void	 screen_write_insertline(struct screen_write_ctx *, u_int, u_int);
2055 void	 screen_write_deleteline(struct screen_write_ctx *, u_int, u_int);
2056 void	 screen_write_clearline(struct screen_write_ctx *, u_int);
2057 void	 screen_write_clearendofline(struct screen_write_ctx *, u_int);
2058 void	 screen_write_clearstartofline(struct screen_write_ctx *, u_int);
2059 void	 screen_write_cursormove(struct screen_write_ctx *, u_int, u_int);
2060 void	 screen_write_reverseindex(struct screen_write_ctx *, u_int);
2061 void	 screen_write_scrollregion(struct screen_write_ctx *, u_int, u_int);
2062 void	 screen_write_linefeed(struct screen_write_ctx *, int, u_int);
2063 void	 screen_write_scrollup(struct screen_write_ctx *, u_int, u_int);
2064 void	 screen_write_carriagereturn(struct screen_write_ctx *);
2065 void	 screen_write_clearendofscreen(struct screen_write_ctx *, u_int);
2066 void	 screen_write_clearstartofscreen(struct screen_write_ctx *, u_int);
2067 void	 screen_write_clearscreen(struct screen_write_ctx *, u_int);
2068 void	 screen_write_clearhistory(struct screen_write_ctx *);
2069 void	 screen_write_collect_end(struct screen_write_ctx *);
2070 void	 screen_write_collect_add(struct screen_write_ctx *,
2071 	     const struct grid_cell *);
2072 void	 screen_write_cell(struct screen_write_ctx *, const struct grid_cell *);
2073 void	 screen_write_setselection(struct screen_write_ctx *, u_char *, u_int);
2074 void	 screen_write_rawstring(struct screen_write_ctx *, u_char *, u_int);
2075 
2076 /* screen-redraw.c */
2077 void	 screen_redraw_update(struct client *);
2078 void	 screen_redraw_screen(struct client *, int, int, int);
2079 void	 screen_redraw_pane(struct client *, struct window_pane *);
2080 
2081 /* screen.c */
2082 void	 screen_init(struct screen *, u_int, u_int, u_int);
2083 void	 screen_reinit(struct screen *);
2084 void	 screen_free(struct screen *);
2085 void	 screen_reset_tabs(struct screen *);
2086 void	 screen_set_cursor_style(struct screen *, u_int);
2087 void	 screen_set_cursor_colour(struct screen *, const char *);
2088 void	 screen_set_title(struct screen *, const char *);
2089 void	 screen_resize(struct screen *, u_int, u_int, int);
2090 void	 screen_set_selection(struct screen *,
2091 	     u_int, u_int, u_int, u_int, u_int, struct grid_cell *);
2092 void	 screen_clear_selection(struct screen *);
2093 void	 screen_hide_selection(struct screen *);
2094 int	 screen_check_selection(struct screen *, u_int, u_int);
2095 void	 screen_select_cell(struct screen *, struct grid_cell *,
2096 	     const struct grid_cell *);
2097 
2098 /* window.c */
2099 extern struct windows windows;
2100 extern struct window_pane_tree all_window_panes;
2101 int		 window_cmp(struct window *, struct window *);
2102 RB_PROTOTYPE(windows, window, entry, window_cmp);
2103 int		 winlink_cmp(struct winlink *, struct winlink *);
2104 RB_PROTOTYPE(winlinks, winlink, entry, winlink_cmp);
2105 int		 window_pane_cmp(struct window_pane *, struct window_pane *);
2106 RB_PROTOTYPE(window_pane_tree, window_pane, tree_entry, window_pane_cmp);
2107 struct winlink	*winlink_find_by_index(struct winlinks *, int);
2108 struct winlink	*winlink_find_by_window(struct winlinks *, struct window *);
2109 struct winlink	*winlink_find_by_window_id(struct winlinks *, u_int);
2110 u_int		 winlink_count(struct winlinks *);
2111 struct winlink	*winlink_add(struct winlinks *, int);
2112 void		 winlink_set_window(struct winlink *, struct window *);
2113 void		 winlink_remove(struct winlinks *, struct winlink *);
2114 struct winlink	*winlink_next(struct winlink *);
2115 struct winlink	*winlink_previous(struct winlink *);
2116 struct winlink	*winlink_next_by_number(struct winlink *, struct session *,
2117 		     int);
2118 struct winlink	*winlink_previous_by_number(struct winlink *, struct session *,
2119 		     int);
2120 void		 winlink_stack_push(struct winlink_stack *, struct winlink *);
2121 void		 winlink_stack_remove(struct winlink_stack *, struct winlink *);
2122 struct window	*window_find_by_id_str(const char *);
2123 struct window	*window_find_by_id(u_int);
2124 void		 window_update_activity(struct window *);
2125 struct window	*window_create(u_int, u_int);
2126 struct window	*window_create_spawn(const char *, int, char **, const char *,
2127 		     const char *, const char *, struct environ *,
2128 		     struct termios *, u_int, u_int, u_int, char **);
2129 struct window_pane *window_get_active_at(struct window *, u_int, u_int);
2130 struct window_pane *window_find_string(struct window *, const char *);
2131 int		 window_has_pane(struct window *, struct window_pane *);
2132 int		 window_set_active_pane(struct window *, struct window_pane *);
2133 void		 window_redraw_active_switch(struct window *,
2134 		     struct window_pane *);
2135 struct window_pane *window_add_pane(struct window *, struct window_pane *,
2136 		     int, u_int);
2137 void		 window_resize(struct window *, u_int, u_int);
2138 int		 window_zoom(struct window_pane *);
2139 int		 window_unzoom(struct window *);
2140 void		 window_lost_pane(struct window *, struct window_pane *);
2141 void		 window_remove_pane(struct window *, struct window_pane *);
2142 struct window_pane *window_pane_at_index(struct window *, u_int);
2143 struct window_pane *window_pane_next_by_number(struct window *,
2144 			struct window_pane *, u_int);
2145 struct window_pane *window_pane_previous_by_number(struct window *,
2146 			struct window_pane *, u_int);
2147 int		 window_pane_index(struct window_pane *, u_int *);
2148 u_int		 window_count_panes(struct window *);
2149 void		 window_destroy_panes(struct window *);
2150 struct window_pane *window_pane_find_by_id_str(const char *);
2151 struct window_pane *window_pane_find_by_id(u_int);
2152 int		 window_pane_destroy_ready(struct window_pane *);
2153 int		 window_pane_spawn(struct window_pane *, int, char **,
2154 		     const char *, const char *, const char *, struct environ *,
2155 		     struct termios *, char **);
2156 void		 window_pane_resize(struct window_pane *, u_int, u_int);
2157 void		 window_pane_alternate_on(struct window_pane *,
2158 		     struct grid_cell *, int);
2159 void		 window_pane_alternate_off(struct window_pane *,
2160 		     struct grid_cell *, int);
2161 void		 window_pane_set_palette(struct window_pane *, u_int, int);
2162 void		 window_pane_unset_palette(struct window_pane *, u_int);
2163 void		 window_pane_reset_palette(struct window_pane *);
2164 int		 window_pane_get_palette(const struct window_pane *, int);
2165 int		 window_pane_set_mode(struct window_pane *,
2166 		     const struct window_mode *, struct cmd_find_state *,
2167 		     struct args *);
2168 void		 window_pane_reset_mode(struct window_pane *);
2169 void		 window_pane_key(struct window_pane *, struct client *,
2170 		     struct session *, key_code, struct mouse_event *);
2171 int		 window_pane_visible(struct window_pane *);
2172 u_int		 window_pane_search(struct window_pane *, const char *);
2173 const char	*window_printable_flags(struct winlink *);
2174 struct window_pane *window_pane_find_up(struct window_pane *);
2175 struct window_pane *window_pane_find_down(struct window_pane *);
2176 struct window_pane *window_pane_find_left(struct window_pane *);
2177 struct window_pane *window_pane_find_right(struct window_pane *);
2178 void		 window_set_name(struct window *, const char *);
2179 void		 window_add_ref(struct window *, const char *);
2180 void		 window_remove_ref(struct window *, const char *);
2181 void		 winlink_clear_flags(struct winlink *);
2182 int		 winlink_shuffle_up(struct session *, struct winlink *);
2183 
2184 /* layout.c */
2185 u_int		 layout_count_cells(struct layout_cell *);
2186 struct layout_cell *layout_create_cell(struct layout_cell *);
2187 void		 layout_free_cell(struct layout_cell *);
2188 void		 layout_print_cell(struct layout_cell *, const char *, u_int);
2189 void		 layout_destroy_cell(struct window *, struct layout_cell *,
2190 		     struct layout_cell **);
2191 void		 layout_set_size(struct layout_cell *, u_int, u_int, u_int,
2192 		     u_int);
2193 void		 layout_make_leaf(struct layout_cell *, struct window_pane *);
2194 void		 layout_make_node(struct layout_cell *, enum layout_type);
2195 void		 layout_fix_offsets(struct layout_cell *);
2196 void		 layout_fix_panes(struct window *, u_int, u_int);
2197 void		 layout_resize_adjust(struct window *, struct layout_cell *,
2198 		     enum layout_type, int);
2199 void		 layout_init(struct window *, struct window_pane *);
2200 void		 layout_free(struct window *);
2201 void		 layout_resize(struct window *, u_int, u_int);
2202 void		 layout_resize_pane(struct window_pane *, enum layout_type,
2203 		     int, int);
2204 void		 layout_resize_pane_to(struct window_pane *, enum layout_type,
2205 		     u_int);
2206 void		 layout_assign_pane(struct layout_cell *, struct window_pane *);
2207 struct layout_cell *layout_split_pane(struct window_pane *, enum layout_type,
2208 		     int, int, int);
2209 void		 layout_close_pane(struct window_pane *);
2210 
2211 /* layout-custom.c */
2212 char		*layout_dump(struct layout_cell *);
2213 int		 layout_parse(struct window *, const char *);
2214 
2215 /* layout-set.c */
2216 int		 layout_set_lookup(const char *);
2217 u_int		 layout_set_select(struct window *, u_int);
2218 u_int		 layout_set_next(struct window *);
2219 u_int		 layout_set_previous(struct window *);
2220 
2221 /* mode-tree.c */
2222 u_int	 mode_tree_count_tagged(struct mode_tree_data *);
2223 void	*mode_tree_get_current(struct mode_tree_data *);
2224 void	 mode_tree_each_tagged(struct mode_tree_data *, void (*)(void *, void *,
2225 	     key_code), key_code, int);
2226 void	 mode_tree_up(struct mode_tree_data *, int);
2227 void	 mode_tree_down(struct mode_tree_data *, int);
2228 struct mode_tree_data *mode_tree_start(struct window_pane *, struct args *,
2229 	     void (*)(void *, u_int, uint64_t *, const char *),
2230 	     struct screen *(*)(void *, void *, u_int, u_int),
2231 	     int (*)(void *, void *, const char *), void *, const char **,
2232 	     u_int, struct screen **);
2233 void	 mode_tree_build(struct mode_tree_data *);
2234 void	 mode_tree_free(struct mode_tree_data *);
2235 void	 mode_tree_resize(struct mode_tree_data *, u_int, u_int);
2236 struct mode_tree_item *mode_tree_add(struct mode_tree_data *,
2237 	     struct mode_tree_item *, void *, uint64_t, const char *,
2238 	     const char *, int);
2239 void	 mode_tree_remove(struct mode_tree_data *, struct mode_tree_item *);
2240 void	 mode_tree_draw(struct mode_tree_data *);
2241 int	 mode_tree_key(struct mode_tree_data *, struct client *, key_code *,
2242 	     struct mouse_event *);
2243 void	 mode_tree_run_command(struct client *, struct cmd_find_state *,
2244 	     const char *, const char *);
2245 
2246 /* window-buffer.c */
2247 extern const struct window_mode window_buffer_mode;
2248 
2249 /* window-tree.c */
2250 extern const struct window_mode window_tree_mode;
2251 
2252 /* window-clock.c */
2253 extern const struct window_mode window_clock_mode;
2254 extern const char window_clock_table[14][5][5];
2255 
2256 /* window-client.c */
2257 extern const struct window_mode window_client_mode;
2258 
2259 /* window-copy.c */
2260 extern const struct window_mode window_copy_mode;
2261 void		 window_copy_init_from_pane(struct window_pane *, int);
2262 void		 window_copy_init_for_output(struct window_pane *);
2263 void printflike(2, 3) window_copy_add(struct window_pane *, const char *, ...);
2264 void printflike(2, 0) window_copy_vadd(struct window_pane *, const char *, va_list);
2265 void		 window_copy_pageup(struct window_pane *, int);
2266 void		 window_copy_start_drag(struct client *, struct mouse_event *);
2267 void		 window_copy_add_formats(struct window_pane *,
2268 		     struct format_tree *);
2269 
2270 /* names.c */
2271 void	 check_window_name(struct window *);
2272 char	*default_window_name(struct window *);
2273 char	*parse_window_name(const char *);
2274 
2275 /* control.c */
2276 void	control_callback(struct client *, int, void *);
2277 void printflike(2, 3) control_write(struct client *, const char *, ...);
2278 void	control_write_buffer(struct client *, struct evbuffer *);
2279 
2280 /* control-notify.c */
2281 void	control_notify_input(struct client *, struct window_pane *,
2282 	    struct evbuffer *);
2283 void	control_notify_pane_mode_changed(int);
2284 void	control_notify_window_layout_changed(struct window *);
2285 void	control_notify_window_pane_changed(struct window *);
2286 void	control_notify_window_unlinked(struct session *, struct window *);
2287 void	control_notify_window_linked(struct session *, struct window *);
2288 void	control_notify_window_renamed(struct window *);
2289 void	control_notify_client_session_changed(struct client *);
2290 void	control_notify_session_renamed(struct session *);
2291 void	control_notify_session_created(struct session *);
2292 void	control_notify_session_closed(struct session *);
2293 void	control_notify_session_window_changed(struct session *);
2294 
2295 /* session.c */
2296 extern struct sessions sessions;
2297 extern struct session_groups session_groups;
2298 int	session_cmp(struct session *, struct session *);
2299 RB_PROTOTYPE(sessions, session, entry, session_cmp);
2300 int	session_group_cmp(struct session_group *, struct session_group *);
2301 RB_PROTOTYPE(session_groups, session_group, entry, session_group_cmp);
2302 int		 session_alive(struct session *);
2303 struct session	*session_find(const char *);
2304 struct session	*session_find_by_id_str(const char *);
2305 struct session	*session_find_by_id(u_int);
2306 struct session	*session_create(const char *, const char *, int, char **,
2307 		     const char *, const char *, struct environ *,
2308 		     struct termios *, int, u_int, u_int, char **);
2309 void		 session_destroy(struct session *, const char *);
2310 void		 session_add_ref(struct session *, const char *);
2311 void		 session_remove_ref(struct session *, const char *);
2312 int		 session_check_name(const char *);
2313 void		 session_update_activity(struct session *, struct timeval *);
2314 struct session	*session_next_session(struct session *);
2315 struct session	*session_previous_session(struct session *);
2316 struct winlink	*session_new(struct session *, const char *, int, char **,
2317 		     const char *, const char *, int, char **);
2318 struct winlink	*session_attach(struct session *, struct window *, int,
2319 		     char **);
2320 int		 session_detach(struct session *, struct winlink *);
2321 int		 session_has(struct session *, struct window *);
2322 int		 session_is_linked(struct session *, struct window *);
2323 int		 session_next(struct session *, int);
2324 int		 session_previous(struct session *, int);
2325 int		 session_select(struct session *, int);
2326 int		 session_last(struct session *);
2327 int		 session_set_current(struct session *, struct winlink *);
2328 struct session_group *session_group_contains(struct session *);
2329 struct session_group *session_group_find(const char *);
2330 struct session_group *session_group_new(const char *);
2331 void		 session_group_add(struct session_group *, struct session *);
2332 void		 session_group_synchronize_to(struct session *);
2333 void		 session_group_synchronize_from(struct session *);
2334 void		 session_renumber_windows(struct session *);
2335 
2336 /* utf8.c */
2337 void		 utf8_set(struct utf8_data *, u_char);
2338 void		 utf8_copy(struct utf8_data *, const struct utf8_data *);
2339 enum utf8_state	 utf8_open(struct utf8_data *, u_char);
2340 enum utf8_state	 utf8_append(struct utf8_data *, u_char);
2341 enum utf8_state	 utf8_combine(const struct utf8_data *, wchar_t *);
2342 enum utf8_state	 utf8_split(wchar_t, struct utf8_data *);
2343 int		 utf8_isvalid(const char *);
2344 int		 utf8_strvis(char *, const char *, size_t, int);
2345 int		 utf8_stravis(char **, const char *, int);
2346 char		*utf8_sanitize(const char *);
2347 size_t		 utf8_strlen(const struct utf8_data *);
2348 u_int		 utf8_strwidth(const struct utf8_data *, ssize_t);
2349 struct utf8_data *utf8_fromcstr(const char *);
2350 char		*utf8_tocstr(struct utf8_data *);
2351 u_int		 utf8_cstrwidth(const char *);
2352 char		*utf8_rtrimcstr(const char *, u_int);
2353 char		*utf8_trimcstr(const char *, u_int);
2354 char		*utf8_padcstr(const char *, u_int);
2355 
2356 /* osdep-*.c */
2357 char		*osdep_get_name(int, char *);
2358 char		*osdep_get_cwd(int);
2359 struct event_base *osdep_event_init(void);
2360 
2361 /* log.c */
2362 void	log_add_level(void);
2363 int	log_get_level(void);
2364 void	log_open(const char *);
2365 void	log_toggle(const char *);
2366 void	log_close(void);
2367 void printflike(1, 2) log_debug(const char *, ...);
2368 __dead void printflike(1, 2) fatal(const char *, ...);
2369 __dead void printflike(1, 2) fatalx(const char *, ...);
2370 
2371 /* style.c */
2372 int		 style_parse(const struct grid_cell *,
2373 		     struct grid_cell *, const char *);
2374 const char	*style_tostring(struct grid_cell *);
2375 void		 style_apply(struct grid_cell *, struct options *,
2376 		     const char *);
2377 void		 style_apply_update(struct grid_cell *, struct options *,
2378 		     const char *);
2379 int		 style_equal(const struct grid_cell *,
2380 		     const struct grid_cell *);
2381 
2382 #endif /* TMUX_H */
2383