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