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