Remove now unused cmd_get_default_path.
[tmux-openbsd.git] / tmux.h
blobe281790d0c9dc781d1b6ceb8d97be33eec9e4c63
1 /* $OpenBSD$ */
3 /*
4 * Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net>
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 #define PROTOCOL_VERSION 8
24 #include <sys/param.h>
25 #include <sys/time.h>
26 #include <sys/queue.h>
27 #include <sys/tree.h>
28 #include <sys/uio.h>
30 #include <bitstring.h>
31 #include <event.h>
32 #include <getopt.h>
33 #include <imsg.h>
34 #include <limits.h>
35 #include <signal.h>
36 #include <stdarg.h>
37 #include <stdint.h>
38 #include <stdio.h>
39 #include <termios.h>
41 #include "array.h"
43 extern char *__progname;
44 extern char **environ;
46 /* Default global configuration file. */
47 #define TMUX_CONF "/etc/tmux.conf"
49 /* Default prompt history length. */
50 #define PROMPT_HISTORY 100
53 * Minimum layout cell size, NOT including separator line. The scroll region
54 * cannot be one line in height so this must be at least two.
56 #define PANE_MINIMUM 2
58 /* Automatic name refresh interval, in milliseconds. */
59 #define NAME_INTERVAL 500
62 * UTF-8 data size. This must be big enough to hold combined characters as well
63 * as single.
65 #define UTF8_SIZE 9
67 /* Fatal errors. */
68 #define fatal(msg) log_fatal("%s: %s", __func__, msg);
69 #define fatalx(msg) log_fatalx("%s: %s", __func__, msg);
71 /* Definition to shut gcc up about unused arguments. */
72 #define unused __attribute__ ((unused))
74 /* Attribute to make gcc check printf-like arguments. */
75 #define printflike1 __attribute__ ((format (printf, 1, 2)))
76 #define printflike2 __attribute__ ((format (printf, 2, 3)))
77 #define printflike3 __attribute__ ((format (printf, 3, 4)))
78 #define printflike4 __attribute__ ((format (printf, 4, 5)))
79 #define printflike5 __attribute__ ((format (printf, 5, 6)))
81 /* Number of items in array. */
82 #ifndef nitems
83 #define nitems(_a) (sizeof((_a)) / sizeof((_a)[0]))
84 #endif
86 /* Default template for choose-buffer. */
87 #define CHOOSE_BUFFER_TEMPLATE \
88 "#{line}: #{buffer_size} bytes: \"#{buffer_sample}\""
90 /* Default template for choose-client. */
91 #define CHOOSE_CLIENT_TEMPLATE \
92 "#{client_tty}: #{session_name} " \
93 "[#{client_width}x#{client_height} #{client_termname}]" \
94 "#{?client_utf8, (utf8),}#{?client_readonly, (ro),} " \
95 "(last used #{client_activity_string})"
97 /* Default templates for choose-tree. */
98 #define CHOOSE_TREE_SESSION_TEMPLATE \
99 "#{session_name}: #{session_windows} windows" \
100 "#{?session_grouped, (group ,}" \
101 "#{session_group}#{?session_grouped,),}" \
102 "#{?session_attached, (attached),}"
103 #define CHOOSE_TREE_WINDOW_TEMPLATE \
104 "#{window_index}: #{window_name}#{window_flags} " \
105 "\"#{pane_title}\""
107 /* Default template for display-message. */
108 #define DISPLAY_MESSAGE_TEMPLATE \
109 "[#{session_name}] #{window_index}:" \
110 "#{window_name}, current pane #{pane_index} " \
111 "- (%H:%M %d-%b-%y)"
113 /* Default template for find-window. */
114 #define FIND_WINDOW_TEMPLATE \
115 "#{window_index}: #{window_name} " \
116 "[#{window_width}x#{window_height}] " \
117 "(#{window_panes} panes) #{window_find_matches}"
119 /* Default template for list-buffers. */
120 #define LIST_BUFFERS_TEMPLATE \
121 "#{line}: #{buffer_size} bytes: \"#{buffer_sample}\""
123 /* Default template for list-clients. */
124 #define LIST_CLIENTS_TEMPLATE \
125 "#{client_tty}: #{session_name} " \
126 "[#{client_width}x#{client_height} #{client_termname}]" \
127 "#{?client_utf8, (utf8),} #{?client_readonly, (ro),}"
129 /* Default template for list-sessions. */
130 #define LIST_SESSIONS_TEMPLATE \
131 "#{session_name}: #{session_windows} windows " \
132 "(created #{session_created_string}) " \
133 "[#{session_width}x#{session_height}]" \
134 "#{?session_grouped, (group ,}" \
135 "#{session_group}#{?session_grouped,),}" \
136 "#{?session_attached, (attached),}"
138 /* Default templates for list-windows. */
139 #define LIST_WINDOWS_TEMPLATE \
140 "#{window_index}: #{window_name}#{window_flags} " \
141 "(#{window_panes} panes) " \
142 "[#{window_width}x#{window_height}] " \
143 "[layout #{window_layout}] #{window_id}" \
144 "#{?window_active, (active),}";
145 #define LIST_WINDOWS_WITH_SESSION_TEMPLATE \
146 "#{session_name}:" \
147 "#{window_index}: #{window_name}#{window_flags} " \
148 "(#{window_panes} panes) " \
149 "[#{window_width}x#{window_height}] "
151 /* Default templates for break-pane, new-window and split-window. */
152 #define BREAK_PANE_TEMPLATE "#{session_name}:#{window_index}.#{pane_index}"
153 #define NEW_SESSION_TEMPLATE "#{session_name}:"
154 #define NEW_WINDOW_TEMPLATE BREAK_PANE_TEMPLATE
155 #define SPLIT_WINDOW_TEMPLATE BREAK_PANE_TEMPLATE
157 /* Bell option values. */
158 #define BELL_NONE 0
159 #define BELL_ANY 1
160 #define BELL_CURRENT 2
162 /* Special key codes. */
163 #define KEYC_NONE 0xfff
164 #define KEYC_BASE 0x1000
166 /* Key modifier bits. */
167 #define KEYC_ESCAPE 0x2000
168 #define KEYC_CTRL 0x4000
169 #define KEYC_SHIFT 0x8000
170 #define KEYC_PREFIX 0x10000
172 /* Mask to obtain key w/o modifiers. */
173 #define KEYC_MASK_MOD (KEYC_ESCAPE|KEYC_CTRL|KEYC_SHIFT|KEYC_PREFIX)
174 #define KEYC_MASK_KEY (~KEYC_MASK_MOD)
176 /* Other key codes. */
177 enum key_code {
178 /* Mouse key. */
179 KEYC_MOUSE = KEYC_BASE,
181 /* Backspace key. */
182 KEYC_BSPACE,
184 /* Function keys. */
185 KEYC_F1,
186 KEYC_F2,
187 KEYC_F3,
188 KEYC_F4,
189 KEYC_F5,
190 KEYC_F6,
191 KEYC_F7,
192 KEYC_F8,
193 KEYC_F9,
194 KEYC_F10,
195 KEYC_F11,
196 KEYC_F12,
197 KEYC_F13,
198 KEYC_F14,
199 KEYC_F15,
200 KEYC_F16,
201 KEYC_F17,
202 KEYC_F18,
203 KEYC_F19,
204 KEYC_F20,
205 KEYC_IC,
206 KEYC_DC,
207 KEYC_HOME,
208 KEYC_END,
209 KEYC_NPAGE,
210 KEYC_PPAGE,
211 KEYC_BTAB,
213 /* Arrow keys. */
214 KEYC_UP,
215 KEYC_DOWN,
216 KEYC_LEFT,
217 KEYC_RIGHT,
219 /* Numeric keypad. */
220 KEYC_KP_SLASH,
221 KEYC_KP_STAR,
222 KEYC_KP_MINUS,
223 KEYC_KP_SEVEN,
224 KEYC_KP_EIGHT,
225 KEYC_KP_NINE,
226 KEYC_KP_PLUS,
227 KEYC_KP_FOUR,
228 KEYC_KP_FIVE,
229 KEYC_KP_SIX,
230 KEYC_KP_ONE,
231 KEYC_KP_TWO,
232 KEYC_KP_THREE,
233 KEYC_KP_ENTER,
234 KEYC_KP_ZERO,
235 KEYC_KP_PERIOD,
237 KEYC_FOCUS_IN,
238 KEYC_FOCUS_OUT,
241 /* Termcap codes. */
242 enum tty_code_code {
243 TTYC_AX = 0,
244 TTYC_ACSC, /* acs_chars, ac */
245 TTYC_BEL, /* bell, bl */
246 TTYC_BLINK, /* enter_blink_mode, mb */
247 TTYC_BOLD, /* enter_bold_mode, md */
248 TTYC_CIVIS, /* cursor_invisible, vi */
249 TTYC_CLEAR, /* clear_screen, cl */
250 TTYC_CNORM, /* cursor_normal, ve */
251 TTYC_COLORS, /* max_colors, Co */
252 TTYC_CR, /* restore cursor colour, Cr */
253 TTYC_CS, /* set cursor colour, Cs */
254 TTYC_CSR, /* change_scroll_region, cs */
255 TTYC_CUB, /* parm_left_cursor, LE */
256 TTYC_CUB1, /* cursor_left, le */
257 TTYC_CUD, /* parm_down_cursor, DO */
258 TTYC_CUD1, /* cursor_down, do */
259 TTYC_CUF, /* parm_right_cursor, RI */
260 TTYC_CUF1, /* cursor_right, nd */
261 TTYC_CUP, /* cursor_address, cm */
262 TTYC_CUU, /* parm_up_cursor, UP */
263 TTYC_CUU1, /* cursor_up, up */
264 TTYC_DCH, /* parm_dch, DC */
265 TTYC_DCH1, /* delete_character, dc */
266 TTYC_DIM, /* enter_dim_mode, mh */
267 TTYC_DL, /* parm_delete_line, DL */
268 TTYC_DL1, /* delete_line, dl */
269 TTYC_E3,
270 TTYC_ECH, /* erase_chars, ec */
271 TTYC_EL, /* clr_eol, ce */
272 TTYC_EL1, /* clr_bol, cb */
273 TTYC_ENACS, /* ena_acs, eA */
274 TTYC_FSL, /* from_status_line, fsl */
275 TTYC_HOME, /* cursor_home, ho */
276 TTYC_HPA, /* column_address, ch */
277 TTYC_ICH, /* parm_ich, IC */
278 TTYC_ICH1, /* insert_character, ic */
279 TTYC_IL, /* parm_insert_line, IL */
280 TTYC_IL1, /* insert_line, il */
281 TTYC_INVIS, /* enter_secure_mode, mk */
282 TTYC_IS1, /* init_1string, i1 */
283 TTYC_IS2, /* init_2string, i2 */
284 TTYC_IS3, /* init_3string, i3 */
285 TTYC_KCBT, /* key_btab, kB */
286 TTYC_KCUB1, /* key_left, kl */
287 TTYC_KCUD1, /* key_down, kd */
288 TTYC_KCUF1, /* key_right, kr */
289 TTYC_KCUU1, /* key_up, ku */
290 TTYC_KDC2,
291 TTYC_KDC3,
292 TTYC_KDC4,
293 TTYC_KDC5,
294 TTYC_KDC6,
295 TTYC_KDC7,
296 TTYC_KDCH1, /* key_dc, kD */
297 TTYC_KDN2,
298 TTYC_KDN3,
299 TTYC_KDN4,
300 TTYC_KDN5,
301 TTYC_KDN6,
302 TTYC_KDN7,
303 TTYC_KEND, /* key_end, ke */
304 TTYC_KEND2,
305 TTYC_KEND3,
306 TTYC_KEND4,
307 TTYC_KEND5,
308 TTYC_KEND6,
309 TTYC_KEND7,
310 TTYC_KF1, /* key_f1, k1 */
311 TTYC_KF10, /* key_f10, k; */
312 TTYC_KF11, /* key_f11, F1 */
313 TTYC_KF12, /* key_f12, F2 */
314 TTYC_KF13, /* key_f13, F3 */
315 TTYC_KF14, /* key_f14, F4 */
316 TTYC_KF15, /* key_f15, F5 */
317 TTYC_KF16, /* key_f16, F6 */
318 TTYC_KF17, /* key_f17, F7 */
319 TTYC_KF18, /* key_f18, F8 */
320 TTYC_KF19, /* key_f19, F9 */
321 TTYC_KF2, /* key_f2, k2 */
322 TTYC_KF20, /* key_f20, F10 */
323 TTYC_KF3, /* key_f3, k3 */
324 TTYC_KF4, /* key_f4, k4 */
325 TTYC_KF5, /* key_f5, k5 */
326 TTYC_KF6, /* key_f6, k6 */
327 TTYC_KF7, /* key_f7, k7 */
328 TTYC_KF8, /* key_f8, k8 */
329 TTYC_KF9, /* key_f9, k9 */
330 TTYC_KHOM2,
331 TTYC_KHOM3,
332 TTYC_KHOM4,
333 TTYC_KHOM5,
334 TTYC_KHOM6,
335 TTYC_KHOM7,
336 TTYC_KHOME, /* key_home, kh */
337 TTYC_KIC2,
338 TTYC_KIC3,
339 TTYC_KIC4,
340 TTYC_KIC5,
341 TTYC_KIC6,
342 TTYC_KIC7,
343 TTYC_KICH1, /* key_ic, kI */
344 TTYC_KLFT2,
345 TTYC_KLFT3,
346 TTYC_KLFT4,
347 TTYC_KLFT5,
348 TTYC_KLFT6,
349 TTYC_KLFT7,
350 TTYC_KMOUS, /* key_mouse, Km */
351 TTYC_KNP, /* key_npage, kN */
352 TTYC_KNXT2,
353 TTYC_KNXT3,
354 TTYC_KNXT4,
355 TTYC_KNXT5,
356 TTYC_KNXT6,
357 TTYC_KNXT7,
358 TTYC_KPP, /* key_ppage, kP */
359 TTYC_KPRV2,
360 TTYC_KPRV3,
361 TTYC_KPRV4,
362 TTYC_KPRV5,
363 TTYC_KPRV6,
364 TTYC_KPRV7,
365 TTYC_KRIT2,
366 TTYC_KRIT3,
367 TTYC_KRIT4,
368 TTYC_KRIT5,
369 TTYC_KRIT6,
370 TTYC_KRIT7,
371 TTYC_KUP2,
372 TTYC_KUP3,
373 TTYC_KUP4,
374 TTYC_KUP5,
375 TTYC_KUP6,
376 TTYC_KUP7,
377 TTYC_MS, /* modify xterm(1) selection */
378 TTYC_OP, /* orig_pair, op */
379 TTYC_REV, /* enter_reverse_mode, mr */
380 TTYC_RI, /* scroll_reverse, sr */
381 TTYC_RMACS, /* exit_alt_charset_mode */
382 TTYC_RMCUP, /* exit_ca_mode, te */
383 TTYC_RMKX, /* keypad_local, ke */
384 TTYC_SE, /* reset cursor style, Se */
385 TTYC_SETAB, /* set_a_background, AB */
386 TTYC_SETAF, /* set_a_foreground, AF */
387 TTYC_SGR0, /* exit_attribute_mode, me */
388 TTYC_SITM, /* enter_italics_mode, it */
389 TTYC_SMACS, /* enter_alt_charset_mode, as */
390 TTYC_SMCUP, /* enter_ca_mode, ti */
391 TTYC_SMKX, /* keypad_xmit, ks */
392 TTYC_SMSO, /* enter_standout_mode, so */
393 TTYC_SMUL, /* enter_underline_mode, us */
394 TTYC_SS, /* set cursor style, Ss */
395 TTYC_TSL, /* to_status_line, tsl */
396 TTYC_VPA, /* row_address, cv */
397 TTYC_XENL, /* eat_newline_glitch, xn */
398 TTYC_XT, /* xterm(1)-compatible title, XT */
400 #define NTTYCODE (TTYC_XT + 1)
402 /* Termcap types. */
403 enum tty_code_type {
404 TTYCODE_NONE = 0,
405 TTYCODE_STRING,
406 TTYCODE_NUMBER,
407 TTYCODE_FLAG,
410 /* Termcap code. */
411 struct tty_code {
412 enum tty_code_type type;
413 union {
414 char *string;
415 int number;
416 int flag;
417 } value;
420 /* Entry in terminal code table. */
421 struct tty_term_code_entry {
422 enum tty_code_code code;
423 enum tty_code_type type;
424 const char *name;
427 /* List of error causes. */
428 ARRAY_DECL(causelist, char *);
430 /* Message codes. */
431 enum msgtype {
432 MSG_VERSION = 12,
434 MSG_IDENTIFY_FLAGS = 100,
435 MSG_IDENTIFY_TERM,
436 MSG_IDENTIFY_TTYNAME,
437 MSG_IDENTIFY_CWD,
438 MSG_IDENTIFY_STDIN,
439 MSG_IDENTIFY_ENVIRON,
440 MSG_IDENTIFY_DONE,
442 MSG_COMMAND = 200,
443 MSG_DETACH,
444 MSG_DETACHKILL,
445 MSG_EXIT,
446 MSG_EXITED,
447 MSG_EXITING,
448 MSG_LOCK,
449 MSG_READY,
450 MSG_RESIZE,
451 MSG_SHELL,
452 MSG_SHUTDOWN,
453 MSG_STDERR,
454 MSG_STDIN,
455 MSG_STDOUT,
456 MSG_SUSPEND,
457 MSG_UNLOCK,
458 MSG_WAKEUP,
462 * Message data.
464 * Don't forget to bump PROTOCOL_VERSION if any of these change!
466 struct msg_command_data {
467 pid_t pid; /* from $TMUX or -1 */
468 int session_id; /* from $TMUX or -1 */
470 int argc;
471 }; /* followed by packed argv */
473 struct msg_stdin_data {
474 ssize_t size;
475 char data[BUFSIZ];
478 struct msg_stdout_data {
479 ssize_t size;
480 char data[BUFSIZ];
483 struct msg_stderr_data {
484 ssize_t size;
485 char data[BUFSIZ];
488 /* Mode key commands. */
489 enum mode_key_cmd {
490 MODEKEY_NONE,
491 MODEKEY_OTHER,
493 /* Editing keys. */
494 MODEKEYEDIT_BACKSPACE,
495 MODEKEYEDIT_CANCEL,
496 MODEKEYEDIT_COMPLETE,
497 MODEKEYEDIT_CURSORLEFT,
498 MODEKEYEDIT_CURSORRIGHT,
499 MODEKEYEDIT_DELETE,
500 MODEKEYEDIT_DELETELINE,
501 MODEKEYEDIT_DELETETOENDOFLINE,
502 MODEKEYEDIT_DELETEWORD,
503 MODEKEYEDIT_ENDOFLINE,
504 MODEKEYEDIT_ENTER,
505 MODEKEYEDIT_HISTORYDOWN,
506 MODEKEYEDIT_HISTORYUP,
507 MODEKEYEDIT_NEXTSPACE,
508 MODEKEYEDIT_NEXTSPACEEND,
509 MODEKEYEDIT_NEXTWORD,
510 MODEKEYEDIT_NEXTWORDEND,
511 MODEKEYEDIT_PASTE,
512 MODEKEYEDIT_PREVIOUSSPACE,
513 MODEKEYEDIT_PREVIOUSWORD,
514 MODEKEYEDIT_STARTOFLINE,
515 MODEKEYEDIT_SWITCHMODE,
516 MODEKEYEDIT_SWITCHMODEAPPEND,
517 MODEKEYEDIT_SWITCHMODEAPPENDLINE,
518 MODEKEYEDIT_SWITCHMODEBEGINLINE,
519 MODEKEYEDIT_SWITCHMODECHANGELINE,
520 MODEKEYEDIT_SWITCHMODESUBSTITUTE,
521 MODEKEYEDIT_SWITCHMODESUBSTITUTELINE,
522 MODEKEYEDIT_TRANSPOSECHARS,
524 /* Menu (choice) keys. */
525 MODEKEYCHOICE_BACKSPACE,
526 MODEKEYCHOICE_CANCEL,
527 MODEKEYCHOICE_CHOOSE,
528 MODEKEYCHOICE_DOWN,
529 MODEKEYCHOICE_PAGEDOWN,
530 MODEKEYCHOICE_PAGEUP,
531 MODEKEYCHOICE_SCROLLDOWN,
532 MODEKEYCHOICE_SCROLLUP,
533 MODEKEYCHOICE_STARTNUMBERPREFIX,
534 MODEKEYCHOICE_TREE_COLLAPSE,
535 MODEKEYCHOICE_TREE_COLLAPSE_ALL,
536 MODEKEYCHOICE_TREE_EXPAND,
537 MODEKEYCHOICE_TREE_EXPAND_ALL,
538 MODEKEYCHOICE_TREE_TOGGLE,
539 MODEKEYCHOICE_UP,
541 /* Copy keys. */
542 MODEKEYCOPY_BACKTOINDENTATION,
543 MODEKEYCOPY_BOTTOMLINE,
544 MODEKEYCOPY_CANCEL,
545 MODEKEYCOPY_CLEARSELECTION,
546 MODEKEYCOPY_COPYPIPE,
547 MODEKEYCOPY_COPYLINE,
548 MODEKEYCOPY_COPYENDOFLINE,
549 MODEKEYCOPY_COPYSELECTION,
550 MODEKEYCOPY_DOWN,
551 MODEKEYCOPY_ENDOFLINE,
552 MODEKEYCOPY_GOTOLINE,
553 MODEKEYCOPY_HALFPAGEDOWN,
554 MODEKEYCOPY_HALFPAGEUP,
555 MODEKEYCOPY_HISTORYBOTTOM,
556 MODEKEYCOPY_HISTORYTOP,
557 MODEKEYCOPY_JUMP,
558 MODEKEYCOPY_JUMPAGAIN,
559 MODEKEYCOPY_JUMPREVERSE,
560 MODEKEYCOPY_JUMPBACK,
561 MODEKEYCOPY_JUMPTO,
562 MODEKEYCOPY_JUMPTOBACK,
563 MODEKEYCOPY_LEFT,
564 MODEKEYCOPY_MIDDLELINE,
565 MODEKEYCOPY_NEXTPAGE,
566 MODEKEYCOPY_NEXTSPACE,
567 MODEKEYCOPY_NEXTSPACEEND,
568 MODEKEYCOPY_NEXTWORD,
569 MODEKEYCOPY_NEXTWORDEND,
570 MODEKEYCOPY_PREVIOUSPAGE,
571 MODEKEYCOPY_PREVIOUSSPACE,
572 MODEKEYCOPY_PREVIOUSWORD,
573 MODEKEYCOPY_RECTANGLETOGGLE,
574 MODEKEYCOPY_RIGHT,
575 MODEKEYCOPY_SCROLLDOWN,
576 MODEKEYCOPY_SCROLLUP,
577 MODEKEYCOPY_SEARCHAGAIN,
578 MODEKEYCOPY_SEARCHDOWN,
579 MODEKEYCOPY_SEARCHREVERSE,
580 MODEKEYCOPY_SEARCHUP,
581 MODEKEYCOPY_SELECTLINE,
582 MODEKEYCOPY_STARTNUMBERPREFIX,
583 MODEKEYCOPY_STARTOFLINE,
584 MODEKEYCOPY_STARTSELECTION,
585 MODEKEYCOPY_TOPLINE,
586 MODEKEYCOPY_UP,
589 /* Entry in the default mode key tables. */
590 struct mode_key_entry {
591 int key;
594 * Editing mode for vi: 0 is edit mode, keys not in the table are
595 * returned as MODEKEY_OTHER; 1 is command mode, keys not in the table
596 * are returned as MODEKEY_NONE. This is also matched on, allowing some
597 * keys to be bound in edit mode.
599 int mode;
600 enum mode_key_cmd cmd;
603 /* Data required while mode keys are in use. */
604 struct mode_key_data {
605 struct mode_key_tree *tree;
606 int mode;
608 #define MODEKEY_EMACS 0
609 #define MODEKEY_VI 1
611 /* Binding between a key and a command. */
612 struct mode_key_binding {
613 int key;
615 int mode;
616 enum mode_key_cmd cmd;
617 const char *arg;
619 RB_ENTRY(mode_key_binding) entry;
621 RB_HEAD(mode_key_tree, mode_key_binding);
623 /* Command to string mapping. */
624 struct mode_key_cmdstr {
625 enum mode_key_cmd cmd;
626 const char *name;
629 /* Named mode key table description. */
630 struct mode_key_table {
631 const char *name;
632 const struct mode_key_cmdstr *cmdstr;
633 struct mode_key_tree *tree;
634 const struct mode_key_entry *table; /* default entries */
637 /* Modes. */
638 #define MODE_CURSOR 0x1
639 #define MODE_INSERT 0x2
640 #define MODE_KCURSOR 0x4
641 #define MODE_KKEYPAD 0x8 /* set = application, clear = number */
642 #define MODE_WRAP 0x10 /* whether lines wrap */
643 #define MODE_MOUSE_STANDARD 0x20
644 #define MODE_MOUSE_BUTTON 0x40
645 #define MODE_MOUSE_ANY 0x80
646 #define MODE_MOUSE_UTF8 0x100
647 #define MODE_MOUSE_SGR 0x200
648 #define MODE_BRACKETPASTE 0x400
649 #define MODE_FOCUSON 0x800
651 #define ALL_MOUSE_MODES (MODE_MOUSE_STANDARD|MODE_MOUSE_BUTTON|MODE_MOUSE_ANY)
653 /* A single UTF-8 character. */
654 struct utf8_data {
655 u_char data[UTF8_SIZE];
657 size_t have;
658 size_t size;
660 u_int width;
663 /* Grid output. */
664 #if defined(DEBUG) && \
665 ((defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || \
666 (defined(__GNUC__) && __GNUC__ >= 3))
667 #define GRID_DEBUG(gd, fmt, ...) log_debug2("%s: (sx=%u, sy=%u, hsize=%u) " \
668 fmt, __func__, (gd)->sx, (gd)->sy, (gd)->hsize, ## __VA_ARGS__)
669 #else
670 #define GRID_DEBUG(...)
671 #endif
673 /* Grid attributes. */
674 #define GRID_ATTR_BRIGHT 0x1
675 #define GRID_ATTR_DIM 0x2
676 #define GRID_ATTR_UNDERSCORE 0x4
677 #define GRID_ATTR_BLINK 0x8
678 #define GRID_ATTR_REVERSE 0x10
679 #define GRID_ATTR_HIDDEN 0x20
680 #define GRID_ATTR_ITALICS 0x40
681 #define GRID_ATTR_CHARSET 0x80 /* alternative character set */
683 /* Grid flags. */
684 #define GRID_FLAG_FG256 0x1
685 #define GRID_FLAG_BG256 0x2
686 #define GRID_FLAG_PADDING 0x4
688 /* Grid line flags. */
689 #define GRID_LINE_WRAPPED 0x1
691 /* Grid cell data. */
692 struct grid_cell {
693 u_char attr;
694 u_char flags;
695 u_char fg;
696 u_char bg;
698 u_char xstate; /* top 4 bits width, bottom 4 bits size */
699 u_char xdata[UTF8_SIZE];
700 } __packed;
702 /* Grid line. */
703 struct grid_line {
704 u_int cellsize;
705 struct grid_cell *celldata;
707 int flags;
708 } __packed;
710 /* Entire grid of cells. */
711 struct grid {
712 int flags;
713 #define GRID_HISTORY 0x1 /* scroll lines into history */
715 u_int sx;
716 u_int sy;
718 u_int hsize;
719 u_int hlimit;
721 struct grid_line *linedata;
724 /* Option data structures. */
725 struct options_entry {
726 char *name;
728 enum {
729 OPTIONS_STRING,
730 OPTIONS_NUMBER,
731 OPTIONS_DATA,
732 } type;
734 char *str;
735 long long num;
737 RB_ENTRY(options_entry) entry;
740 struct options {
741 RB_HEAD(options_tree, options_entry) tree;
742 struct options *parent;
745 /* Scheduled job. */
746 struct job {
747 char *cmd;
748 pid_t pid;
749 int status;
751 int fd;
752 struct bufferevent *event;
754 void (*callbackfn)(struct job *);
755 void (*freefn)(void *);
756 void *data;
758 LIST_ENTRY(job) lentry;
760 LIST_HEAD(joblist, job);
762 /* Screen selection. */
763 struct screen_sel {
764 int flag;
765 int rectflag;
767 u_int sx;
768 u_int sy;
770 u_int ex;
771 u_int ey;
773 struct grid_cell cell;
776 /* Virtual screen. */
777 struct screen {
778 char *title;
780 struct grid *grid; /* grid data */
782 u_int cx; /* cursor x */
783 u_int cy; /* cursor y */
785 u_int cstyle; /* cursor style */
786 char *ccolour; /* cursor colour string */
788 u_int rupper; /* scroll region top */
789 u_int rlower; /* scroll region bottom */
791 int mode;
793 bitstr_t *tabs;
795 struct screen_sel sel;
798 /* Screen write context. */
799 struct screen_write_ctx {
800 struct window_pane *wp;
801 struct screen *s;
804 /* Screen size. */
805 #define screen_size_x(s) ((s)->grid->sx)
806 #define screen_size_y(s) ((s)->grid->sy)
807 #define screen_hsize(s) ((s)->grid->hsize)
808 #define screen_hlimit(s) ((s)->grid->hlimit)
810 /* Input parser context. */
811 struct input_ctx {
812 struct window_pane *wp;
813 struct screen_write_ctx ctx;
815 struct grid_cell cell;
817 struct grid_cell old_cell;
818 u_int old_cx;
819 u_int old_cy;
821 u_char interm_buf[4];
822 size_t interm_len;
824 u_char param_buf[64];
825 size_t param_len;
827 u_char input_buf[256];
828 size_t input_len;
830 int param_list[24]; /* -1 not present */
831 u_int param_list_len;
833 struct utf8_data utf8data;
835 int ch;
836 int flags;
837 #define INPUT_DISCARD 0x1
839 const struct input_state *state;
842 * All input received since we were last in the ground state. Sent to
843 * control clients on connection.
845 struct evbuffer *since_ground;
849 * Window mode. Windows can be in several modes and this is used to call the
850 * right function to handle input and output.
852 struct session;
853 struct window;
854 struct mouse_event;
855 struct window_mode {
856 struct screen *(*init)(struct window_pane *);
857 void (*free)(struct window_pane *);
858 void (*resize)(struct window_pane *, u_int, u_int);
859 void (*key)(struct window_pane *, struct session *, int);
860 void (*mouse)(struct window_pane *,
861 struct session *, struct mouse_event *);
862 void (*timer)(struct window_pane *);
865 /* Structures for choose mode. */
866 struct window_choose_data {
867 struct client *start_client;
868 struct session *start_session;
870 u_int idx;
871 int type;
872 #define TREE_OTHER 0x0
873 #define TREE_WINDOW 0x1
874 #define TREE_SESSION 0x2
876 struct session *tree_session; /* session of items in tree */
878 struct winlink *wl;
879 int pane_id;
881 char *ft_template;
882 struct format_tree *ft;
884 char *command;
887 struct window_choose_mode_item {
888 struct window_choose_data *wcd;
889 char *name;
890 int pos;
891 int state;
892 #define TREE_EXPANDED 0x1
895 /* Child window structure. */
896 struct window_pane {
897 u_int id;
899 struct window *window;
901 struct layout_cell *layout_cell;
902 struct layout_cell *saved_layout_cell;
904 u_int sx;
905 u_int sy;
907 u_int xoff;
908 u_int yoff;
910 int flags;
911 #define PANE_REDRAW 0x1
912 #define PANE_DROP 0x2
913 #define PANE_FOCUSED 0x4
914 #define PANE_RESIZE 0x8
915 #define PANE_FOCUSPUSH 0x10
917 char *cmd;
918 char *shell;
919 int cwd;
921 pid_t pid;
922 char tty[TTY_NAME_MAX];
924 u_int changes;
925 struct event changes_timer;
926 u_int changes_redraw;
928 int fd;
929 struct bufferevent *event;
931 struct input_ctx ictx;
933 int pipe_fd;
934 struct bufferevent *pipe_event;
935 size_t pipe_off;
937 struct screen *screen;
938 struct screen base;
940 /* Saved in alternative screen mode. */
941 u_int saved_cx;
942 u_int saved_cy;
943 struct grid *saved_grid;
944 struct grid_cell saved_cell;
946 const struct window_mode *mode;
947 void *modedata;
949 TAILQ_ENTRY(window_pane) entry;
950 RB_ENTRY(window_pane) tree_entry;
952 TAILQ_HEAD(window_panes, window_pane);
953 RB_HEAD(window_pane_tree, window_pane);
955 /* Window structure. */
956 struct window {
957 u_int id;
958 char *name;
959 struct event name_timer;
960 struct timeval silence_timer;
962 struct window_pane *active;
963 struct window_pane *last;
964 struct window_panes panes;
966 int lastlayout;
967 struct layout_cell *layout_root;
968 struct layout_cell *saved_layout_root;
970 u_int sx;
971 u_int sy;
973 int flags;
974 #define WINDOW_BELL 0x1
975 #define WINDOW_ACTIVITY 0x2
976 #define WINDOW_REDRAW 0x4
977 #define WINDOW_SILENCE 0x8
978 #define WINDOW_ZOOMED 0x10
979 #define WINDOW_ALERTFLAGS (WINDOW_BELL|WINDOW_ACTIVITY|WINDOW_SILENCE)
981 struct options options;
983 u_int references;
985 ARRAY_DECL(windows, struct window *);
987 /* Entry on local window list. */
988 struct winlink {
989 int idx;
990 struct window *window;
992 size_t status_width;
993 struct grid_cell status_cell;
994 char *status_text;
996 int flags;
997 #define WINLINK_BELL 0x1
998 #define WINLINK_ACTIVITY 0x2
999 #define WINLINK_CONTENT 0x4
1000 #define WINLINK_SILENCE 0x8
1001 #define WINLINK_ALERTFLAGS \
1002 (WINLINK_BELL|WINLINK_ACTIVITY|WINLINK_CONTENT|WINLINK_SILENCE)
1004 RB_ENTRY(winlink) entry;
1005 TAILQ_ENTRY(winlink) sentry;
1007 RB_HEAD(winlinks, winlink);
1008 TAILQ_HEAD(winlink_stack, winlink);
1010 /* Layout direction. */
1011 enum layout_type {
1012 LAYOUT_LEFTRIGHT,
1013 LAYOUT_TOPBOTTOM,
1014 LAYOUT_WINDOWPANE
1017 /* Layout cells queue. */
1018 TAILQ_HEAD(layout_cells, layout_cell);
1020 /* Layout cell. */
1021 struct layout_cell {
1022 enum layout_type type;
1024 struct layout_cell *parent;
1026 u_int sx;
1027 u_int sy;
1029 u_int xoff;
1030 u_int yoff;
1032 struct window_pane *wp;
1033 struct layout_cells cells;
1035 TAILQ_ENTRY(layout_cell) entry;
1038 /* Paste buffer. */
1039 struct paste_buffer {
1040 char *data;
1041 size_t size;
1043 ARRAY_DECL(paste_stack, struct paste_buffer *);
1045 /* Environment variable. */
1046 struct environ_entry {
1047 char *name;
1048 char *value;
1050 RB_ENTRY(environ_entry) entry;
1052 RB_HEAD(environ, environ_entry);
1054 /* Client session. */
1055 struct session_group {
1056 TAILQ_HEAD(, session) sessions;
1058 TAILQ_ENTRY(session_group) entry;
1060 TAILQ_HEAD(session_groups, session_group);
1062 struct session {
1063 u_int id;
1065 char *name;
1066 int cwd;
1068 struct timeval creation_time;
1069 struct timeval activity_time;
1070 struct timeval last_activity_time;
1072 u_int sx;
1073 u_int sy;
1075 struct winlink *curw;
1076 struct winlink_stack lastw;
1077 struct winlinks windows;
1079 struct options options;
1081 #define SESSION_UNATTACHED 0x1 /* not attached to any clients */
1082 int flags;
1084 struct termios *tio;
1086 struct environ environ;
1088 int references;
1090 TAILQ_ENTRY(session) gentry;
1091 RB_ENTRY(session) entry;
1093 RB_HEAD(sessions, session);
1094 ARRAY_DECL(sessionslist, struct session *);
1096 /* TTY information. */
1097 struct tty_key {
1098 char ch;
1099 int key;
1101 struct tty_key *left;
1102 struct tty_key *right;
1104 struct tty_key *next;
1107 struct tty_term {
1108 char *name;
1109 u_int references;
1111 char acs[UCHAR_MAX + 1][2];
1113 struct tty_code codes[NTTYCODE];
1115 #define TERM_256COLOURS 0x1
1116 #define TERM_EARLYWRAP 0x2
1117 int flags;
1119 LIST_ENTRY(tty_term) entry;
1121 LIST_HEAD(tty_terms, tty_term);
1123 /* Mouse wheel states. */
1124 #define MOUSE_WHEEL_UP 0
1125 #define MOUSE_WHEEL_DOWN 1
1127 /* Mouse events. */
1128 #define MOUSE_EVENT_DOWN (1 << 0)
1129 #define MOUSE_EVENT_DRAG (1 << 1)
1130 #define MOUSE_EVENT_UP (1 << 2)
1131 #define MOUSE_EVENT_CLICK (1 << 3)
1132 #define MOUSE_EVENT_WHEEL (1 << 4)
1134 /* Mouse flags. */
1135 #define MOUSE_RESIZE_PANE (1 << 0)
1138 * Mouse input. When sent by xterm:
1140 * - buttons are in the bottom two bits: 0 = b1; 1 = b2; 2 = b3; 3 = released
1141 * - bits 3, 4 and 5 are for keys
1142 * - bit 6 is set for dragging
1143 * - bit 7 for buttons 4 and 5
1145 * With the SGR 1006 extension the released button becomes known. Store these
1146 * in separate fields and store the value converted to the old format in xb.
1148 struct mouse_event {
1149 u_int xb;
1151 u_int x;
1152 u_int lx;
1153 u_int sx;
1155 u_int y;
1156 u_int ly;
1157 u_int sy;
1159 u_int sgr; /* whether the input arrived in SGR format */
1160 u_int sgr_xb; /* only for SGR: the unmangled button */
1161 u_int sgr_rel; /* only for SGR: if it is a release event */
1163 u_int button;
1164 u_int clicks;
1166 int wheel;
1167 int event;
1168 int flags;
1171 struct tty {
1172 struct client *client;
1174 char *path;
1175 u_int class;
1177 u_int sx;
1178 u_int sy;
1180 u_int cx;
1181 u_int cy;
1182 u_int cstyle;
1183 char *ccolour;
1185 int mode;
1187 u_int rlower;
1188 u_int rupper;
1190 char *termname;
1191 struct tty_term *term;
1193 int fd;
1194 struct bufferevent *event;
1196 int log_fd;
1198 struct termios tio;
1200 struct grid_cell cell;
1202 #define TTY_NOCURSOR 0x1
1203 #define TTY_FREEZE 0x2
1204 #define TTY_TIMER 0x4
1205 #define TTY_UTF8 0x8
1206 #define TTY_STARTED 0x10
1207 #define TTY_OPENED 0x20
1208 #define TTY_FOCUS 0x40
1209 int flags;
1211 int term_flags;
1213 struct mouse_event mouse;
1215 struct event key_timer;
1216 struct tty_key *key_tree;
1219 /* TTY command context and function pointer. */
1220 struct tty_ctx {
1221 struct window_pane *wp;
1223 const struct grid_cell *cell;
1225 u_int num;
1226 void *ptr;
1229 * Cursor and region position before the screen was updated - this is
1230 * where the command should be applied; the values in the screen have
1231 * already been updated.
1233 u_int ocx;
1234 u_int ocy;
1236 u_int orupper;
1237 u_int orlower;
1239 u_int xoff;
1240 u_int yoff;
1242 /* Saved last cell on line. */
1243 struct grid_cell last_cell;
1244 u_int last_width;
1247 /* Saved message entry. */
1248 struct message_entry {
1249 char *msg;
1250 time_t msg_time;
1253 /* Status output data from a job. */
1254 struct status_out {
1255 char *cmd;
1256 char *out;
1258 RB_ENTRY(status_out) entry;
1260 RB_HEAD(status_out_tree, status_out);
1262 /* Client connection. */
1263 struct client {
1264 struct imsgbuf ibuf;
1266 int fd;
1267 struct event event;
1268 int retval;
1270 struct timeval creation_time;
1271 struct timeval activity_time;
1273 struct environ environ;
1275 char *title;
1276 int cwd;
1278 char *term;
1279 char *ttyname;
1280 struct tty tty;
1282 void (*stdin_callback)(struct client *, int, void *);
1283 void *stdin_callback_data;
1284 struct evbuffer *stdin_data;
1285 int stdin_closed;
1286 struct evbuffer *stdout_data;
1287 struct evbuffer *stderr_data;
1289 struct event repeat_timer;
1291 struct status_out_tree status_old;
1292 struct status_out_tree status_new;
1293 struct timeval status_timer;
1294 struct screen status;
1296 #define CLIENT_TERMINAL 0x1
1297 #define CLIENT_PREFIX 0x2
1298 #define CLIENT_EXIT 0x4
1299 #define CLIENT_REDRAW 0x8
1300 #define CLIENT_STATUS 0x10
1301 #define CLIENT_REPEAT 0x20
1302 #define CLIENT_SUSPENDED 0x40
1303 #define CLIENT_BAD 0x80
1304 #define CLIENT_IDENTIFY 0x100
1305 #define CLIENT_DEAD 0x200
1306 #define CLIENT_BORDERS 0x400
1307 #define CLIENT_READONLY 0x800
1308 #define CLIENT_REDRAWWINDOW 0x1000
1309 #define CLIENT_CONTROL 0x2000
1310 #define CLIENT_CONTROLCONTROL 0x4000
1311 #define CLIENT_FOCUSED 0x8000
1312 #define CLIENT_UTF8 0x10000
1313 #define CLIENT_256COLOURS 0x20000
1314 #define CLIENT_IDENTIFIED 0x40000
1315 int flags;
1317 struct event identify_timer;
1319 char *message_string;
1320 struct event message_timer;
1321 ARRAY_DECL(, struct message_entry) message_log;
1323 char *prompt_string;
1324 char *prompt_buffer;
1325 size_t prompt_index;
1326 int (*prompt_callbackfn)(void *, const char *);
1327 void (*prompt_freefn)(void *);
1328 void *prompt_data;
1329 u_int prompt_hindex;
1331 #define PROMPT_SINGLE 0x1
1332 int prompt_flags;
1334 struct mode_key_data prompt_mdata;
1336 struct session *session;
1337 struct session *last_session;
1339 int wlmouse;
1341 struct cmd_q *cmdq;
1342 int references;
1344 ARRAY_DECL(clients, struct client *);
1346 /* Parsed arguments structures. */
1347 struct args_entry {
1348 u_char flag;
1349 char *value;
1350 RB_ENTRY(args_entry) entry;
1352 RB_HEAD(args_tree, args_entry);
1354 struct args {
1355 struct args_tree tree;
1356 int argc;
1357 char **argv;
1360 /* Command and list of commands. */
1361 struct cmd {
1362 const struct cmd_entry *entry;
1363 struct args *args;
1365 char *file;
1366 u_int line;
1368 #define CMD_CONTROL 0x1
1369 int flags;
1371 TAILQ_ENTRY(cmd) qentry;
1373 struct cmd_list {
1374 int references;
1375 TAILQ_HEAD(, cmd) list;
1378 /* Command return values. */
1379 enum cmd_retval {
1380 CMD_RETURN_ERROR = -1,
1381 CMD_RETURN_NORMAL = 0,
1382 CMD_RETURN_WAIT,
1383 CMD_RETURN_STOP
1386 /* Command queue entry. */
1387 struct cmd_q_item {
1388 struct cmd_list *cmdlist;
1389 TAILQ_ENTRY(cmd_q_item) qentry;
1391 TAILQ_HEAD(cmd_q_items, cmd_q_item);
1393 /* Command queue. */
1394 struct cmd_q {
1395 int references;
1396 int dead;
1398 struct client *client;
1399 int client_exit;
1401 struct cmd_q_items queue;
1402 struct cmd_q_item *item;
1403 struct cmd *cmd;
1405 time_t time;
1406 u_int number;
1408 void (*emptyfn)(struct cmd_q *);
1409 void *data;
1411 struct msg_command_data *msgdata;
1413 TAILQ_ENTRY(cmd_q) waitentry;
1416 /* Command definition. */
1417 struct cmd_entry {
1418 const char *name;
1419 const char *alias;
1421 const char *args_template;
1422 int args_lower;
1423 int args_upper;
1425 const char *usage;
1427 #define CMD_STARTSERVER 0x1
1428 #define CMD_CANTNEST 0x2
1429 #define CMD_READONLY 0x4
1430 int flags;
1432 void (*key_binding)(struct cmd *, int);
1433 enum cmd_retval (*exec)(struct cmd *, struct cmd_q *);
1436 /* Key binding. */
1437 struct key_binding {
1438 int key;
1439 struct cmd_list *cmdlist;
1440 int can_repeat;
1442 RB_ENTRY(key_binding) entry;
1444 RB_HEAD(key_bindings, key_binding);
1447 * Option table entries. The option table is the user-visible part of the
1448 * option, as opposed to the internal options (struct option) which are just
1449 * number or string.
1451 enum options_table_type {
1452 OPTIONS_TABLE_STRING,
1453 OPTIONS_TABLE_NUMBER,
1454 OPTIONS_TABLE_KEY,
1455 OPTIONS_TABLE_COLOUR,
1456 OPTIONS_TABLE_ATTRIBUTES,
1457 OPTIONS_TABLE_FLAG,
1458 OPTIONS_TABLE_CHOICE
1461 struct options_table_entry {
1462 const char *name;
1463 enum options_table_type type;
1465 u_int minimum;
1466 u_int maximum;
1467 const char **choices;
1469 const char *default_str;
1470 long long default_num;
1473 /* Tree of format entries. */
1474 struct format_entry {
1475 char *key;
1476 char *value;
1478 RB_ENTRY(format_entry) entry;
1480 RB_HEAD(format_tree, format_entry);
1482 /* Common command usages. */
1483 #define CMD_TARGET_PANE_USAGE "[-t target-pane]"
1484 #define CMD_TARGET_WINDOW_USAGE "[-t target-window]"
1485 #define CMD_TARGET_SESSION_USAGE "[-t target-session]"
1486 #define CMD_TARGET_CLIENT_USAGE "[-t target-client]"
1487 #define CMD_SRCDST_PANE_USAGE "[-s src-pane] [-t dst-pane]"
1488 #define CMD_SRCDST_WINDOW_USAGE "[-s src-window] [-t dst-window]"
1489 #define CMD_SRCDST_SESSION_USAGE "[-s src-session] [-t dst-session]"
1490 #define CMD_SRCDST_CLIENT_USAGE "[-s src-client] [-t dst-client]"
1491 #define CMD_BUFFER_USAGE "[-b buffer-index]"
1493 /* tmux.c */
1494 extern struct options global_options;
1495 extern struct options global_s_options;
1496 extern struct options global_w_options;
1497 extern struct environ global_environ;
1498 extern struct event_base *ev_base;
1499 extern char *cfg_file;
1500 extern char *shell_cmd;
1501 extern int debug_level;
1502 extern time_t start_time;
1503 extern char socket_path[MAXPATHLEN];
1504 extern int login_shell;
1505 extern char *environ_path;
1506 extern pid_t environ_pid;
1507 extern int environ_session_id;
1508 void logfile(const char *);
1509 const char *getshell(void);
1510 int checkshell(const char *);
1511 int areshell(const char *);
1512 void setblocking(int, int);
1513 __dead void shell_exec(const char *, const char *);
1515 /* cfg.c */
1516 extern struct cmd_q *cfg_cmd_q;
1517 extern int cfg_finished;
1518 extern int cfg_references;
1519 extern struct causelist cfg_causes;
1520 int load_cfg(const char *, struct cmd_q *, char **);
1521 void cfg_default_done(struct cmd_q *);
1522 void cfg_show_causes(struct session *);
1524 /* format.c */
1525 int format_cmp(struct format_entry *, struct format_entry *);
1526 RB_PROTOTYPE(format_tree, format_entry, entry, format_cmp);
1527 struct format_tree *format_create(void);
1528 void format_free(struct format_tree *);
1529 void printflike3 format_add(struct format_tree *, const char *, const char *,
1530 ...);
1531 const char *format_find(struct format_tree *, const char *);
1532 char *format_expand(struct format_tree *, const char *);
1533 void format_session(struct format_tree *, struct session *);
1534 void format_client(struct format_tree *, struct client *);
1535 void format_window(struct format_tree *, struct window *);
1536 void format_winlink(struct format_tree *, struct session *,
1537 struct winlink *);
1538 void format_window_pane(struct format_tree *,
1539 struct window_pane *);
1540 void format_paste_buffer(struct format_tree *,
1541 struct paste_buffer *);
1543 /* mode-key.c */
1544 extern const struct mode_key_table mode_key_tables[];
1545 extern struct mode_key_tree mode_key_tree_vi_edit;
1546 extern struct mode_key_tree mode_key_tree_vi_choice;
1547 extern struct mode_key_tree mode_key_tree_vi_copy;
1548 extern struct mode_key_tree mode_key_tree_emacs_edit;
1549 extern struct mode_key_tree mode_key_tree_emacs_choice;
1550 extern struct mode_key_tree mode_key_tree_emacs_copy;
1551 int mode_key_cmp(struct mode_key_binding *, struct mode_key_binding *);
1552 RB_PROTOTYPE(mode_key_tree, mode_key_binding, entry, mode_key_cmp);
1553 const char *mode_key_tostring(const struct mode_key_cmdstr *,
1554 enum mode_key_cmd);
1555 enum mode_key_cmd mode_key_fromstring(const struct mode_key_cmdstr *,
1556 const char *);
1557 const struct mode_key_table *mode_key_findtable(const char *);
1558 void mode_key_init_trees(void);
1559 void mode_key_init(struct mode_key_data *, struct mode_key_tree *);
1560 enum mode_key_cmd mode_key_lookup(struct mode_key_data *, int, const char **);
1562 /* notify.c */
1563 void notify_enable(void);
1564 void notify_disable(void);
1565 void notify_input(struct window_pane *, struct evbuffer *);
1566 void notify_window_layout_changed(struct window *);
1567 void notify_window_unlinked(struct session *, struct window *);
1568 void notify_window_linked(struct session *, struct window *);
1569 void notify_window_renamed(struct window *);
1570 void notify_attached_session_changed(struct client *);
1571 void notify_session_renamed(struct session *);
1572 void notify_session_created(struct session *);
1573 void notify_session_closed(struct session *);
1575 /* options.c */
1576 int options_cmp(struct options_entry *, struct options_entry *);
1577 RB_PROTOTYPE(options_tree, options_entry, entry, options_cmp);
1578 void options_init(struct options *, struct options *);
1579 void options_free(struct options *);
1580 struct options_entry *options_find1(struct options *, const char *);
1581 struct options_entry *options_find(struct options *, const char *);
1582 void options_remove(struct options *, const char *);
1583 struct options_entry *printflike3 options_set_string(
1584 struct options *, const char *, const char *, ...);
1585 char *options_get_string(struct options *, const char *);
1586 struct options_entry *options_set_number(
1587 struct options *, const char *, long long);
1588 long long options_get_number(struct options *, const char *);
1590 /* options-table.c */
1591 extern const struct options_table_entry server_options_table[];
1592 extern const struct options_table_entry session_options_table[];
1593 extern const struct options_table_entry window_options_table[];
1594 void options_table_populate_tree(const struct options_table_entry *,
1595 struct options *);
1596 const char *options_table_print_entry(const struct options_table_entry *,
1597 struct options_entry *, int);
1598 int options_table_find(const char *, const struct options_table_entry **,
1599 const struct options_table_entry **);
1601 /* job.c */
1602 extern struct joblist all_jobs;
1603 struct job *job_run(const char *, struct session *,
1604 void (*)(struct job *), void (*)(void *), void *);
1605 void job_free(struct job *);
1606 void job_died(struct job *, int);
1608 /* environ.c */
1609 int environ_cmp(struct environ_entry *, struct environ_entry *);
1610 RB_PROTOTYPE(environ, environ_entry, entry, environ_cmp);
1611 void environ_init(struct environ *);
1612 void environ_free(struct environ *);
1613 void environ_copy(struct environ *, struct environ *);
1614 struct environ_entry *environ_find(struct environ *, const char *);
1615 void environ_set(struct environ *, const char *, const char *);
1616 void environ_put(struct environ *, const char *);
1617 void environ_unset(struct environ *, const char *);
1618 void environ_update(const char *, struct environ *, struct environ *);
1619 void environ_push(struct environ *);
1621 /* tty.c */
1622 void tty_init_termios(int, struct termios *, struct bufferevent *);
1623 void tty_raw(struct tty *, const char *);
1624 void tty_attributes(struct tty *, const struct grid_cell *);
1625 void tty_reset(struct tty *);
1626 void tty_region_pane(struct tty *, const struct tty_ctx *, u_int, u_int);
1627 void tty_region(struct tty *, u_int, u_int);
1628 void tty_cursor_pane(struct tty *, const struct tty_ctx *, u_int, u_int);
1629 void tty_cursor(struct tty *, u_int, u_int);
1630 void tty_putcode(struct tty *, enum tty_code_code);
1631 void tty_putcode1(struct tty *, enum tty_code_code, int);
1632 void tty_putcode2(struct tty *, enum tty_code_code, int, int);
1633 void tty_putcode_ptr1(struct tty *, enum tty_code_code, const void *);
1634 void tty_putcode_ptr2(struct tty *, enum tty_code_code, const void *,
1635 const void *);
1636 void tty_puts(struct tty *, const char *);
1637 void tty_putc(struct tty *, u_char);
1638 void tty_putn(struct tty *, const void *, size_t, u_int);
1639 void tty_init(struct tty *, struct client *, int, char *);
1640 int tty_resize(struct tty *);
1641 int tty_set_size(struct tty *, u_int, u_int);
1642 void tty_set_class(struct tty *, u_int);
1643 void tty_start_tty(struct tty *);
1644 void tty_stop_tty(struct tty *);
1645 void tty_set_title(struct tty *, const char *);
1646 void tty_update_mode(struct tty *, int, struct screen *);
1647 void tty_force_cursor_colour(struct tty *, const char *);
1648 void tty_draw_line(struct tty *, struct screen *, u_int, u_int, u_int);
1649 int tty_open(struct tty *, const char *, char **);
1650 void tty_close(struct tty *);
1651 void tty_free(struct tty *);
1652 void tty_write(
1653 void (*)(struct tty *, const struct tty_ctx *), struct tty_ctx *);
1654 void tty_cmd_alignmenttest(struct tty *, const struct tty_ctx *);
1655 void tty_cmd_cell(struct tty *, const struct tty_ctx *);
1656 void tty_cmd_clearendofline(struct tty *, const struct tty_ctx *);
1657 void tty_cmd_clearendofscreen(struct tty *, const struct tty_ctx *);
1658 void tty_cmd_clearline(struct tty *, const struct tty_ctx *);
1659 void tty_cmd_clearscreen(struct tty *, const struct tty_ctx *);
1660 void tty_cmd_clearstartofline(struct tty *, const struct tty_ctx *);
1661 void tty_cmd_clearstartofscreen(struct tty *, const struct tty_ctx *);
1662 void tty_cmd_deletecharacter(struct tty *, const struct tty_ctx *);
1663 void tty_cmd_clearcharacter(struct tty *, const struct tty_ctx *);
1664 void tty_cmd_deleteline(struct tty *, const struct tty_ctx *);
1665 void tty_cmd_erasecharacter(struct tty *, const struct tty_ctx *);
1666 void tty_cmd_insertcharacter(struct tty *, const struct tty_ctx *);
1667 void tty_cmd_insertline(struct tty *, const struct tty_ctx *);
1668 void tty_cmd_linefeed(struct tty *, const struct tty_ctx *);
1669 void tty_cmd_utf8character(struct tty *, const struct tty_ctx *);
1670 void tty_cmd_reverseindex(struct tty *, const struct tty_ctx *);
1671 void tty_cmd_setselection(struct tty *, const struct tty_ctx *);
1672 void tty_cmd_rawstring(struct tty *, const struct tty_ctx *);
1673 void tty_bell(struct tty *);
1675 /* tty-term.c */
1676 extern struct tty_terms tty_terms;
1677 extern const struct tty_term_code_entry tty_term_codes[NTTYCODE];
1678 struct tty_term *tty_term_find(char *, int, const char *, char **);
1679 void tty_term_free(struct tty_term *);
1680 int tty_term_has(struct tty_term *, enum tty_code_code);
1681 const char *tty_term_string(struct tty_term *, enum tty_code_code);
1682 const char *tty_term_string1(struct tty_term *, enum tty_code_code, int);
1683 const char *tty_term_string2(
1684 struct tty_term *, enum tty_code_code, int, int);
1685 const char *tty_term_ptr1(
1686 struct tty_term *, enum tty_code_code, const void *);
1687 const char *tty_term_ptr2(struct tty_term *, enum tty_code_code,
1688 const void *, const void *);
1689 int tty_term_number(struct tty_term *, enum tty_code_code);
1690 int tty_term_flag(struct tty_term *, enum tty_code_code);
1692 /* tty-acs.c */
1693 const char *tty_acs_get(struct tty *, u_char);
1695 /* tty-keys.c */
1696 void tty_keys_build(struct tty *);
1697 void tty_keys_free(struct tty *);
1698 int tty_keys_next(struct tty *);
1700 /* paste.c */
1701 struct paste_buffer *paste_walk_stack(struct paste_stack *, u_int *);
1702 struct paste_buffer *paste_get_top(struct paste_stack *);
1703 struct paste_buffer *paste_get_index(struct paste_stack *, u_int);
1704 int paste_free_top(struct paste_stack *);
1705 int paste_free_index(struct paste_stack *, u_int);
1706 void paste_add(struct paste_stack *, char *, size_t, u_int);
1707 int paste_replace(struct paste_stack *, u_int, char *, size_t);
1708 char *paste_print(struct paste_buffer *, size_t);
1709 void paste_send_pane(struct paste_buffer *, struct window_pane *,
1710 const char *, int);
1712 /* clock.c */
1713 extern const char clock_table[14][5][5];
1714 void clock_draw(struct screen_write_ctx *, int, int);
1716 /* arguments.c */
1717 int args_cmp(struct args_entry *, struct args_entry *);
1718 RB_PROTOTYPE(args_tree, args_entry, entry, args_cmp);
1719 struct args *args_create(int, ...);
1720 struct args *args_parse(const char *, int, char **);
1721 void args_free(struct args *);
1722 size_t args_print(struct args *, char *, size_t);
1723 int args_has(struct args *, u_char);
1724 void args_set(struct args *, u_char, const char *);
1725 const char *args_get(struct args *, u_char);
1726 long long args_strtonum(
1727 struct args *, u_char, long long, long long, char **);
1729 /* cmd.c */
1730 int cmd_pack_argv(int, char **, char *, size_t);
1731 int cmd_unpack_argv(char *, size_t, int, char ***);
1732 char **cmd_copy_argv(int, char *const *);
1733 void cmd_free_argv(int, char **);
1734 struct cmd *cmd_parse(int, char **, const char *, u_int, char **);
1735 size_t cmd_print(struct cmd *, char *, size_t);
1736 struct session *cmd_current_session(struct cmd_q *, int);
1737 struct client *cmd_current_client(struct cmd_q *);
1738 struct client *cmd_find_client(struct cmd_q *, const char *, int);
1739 struct session *cmd_find_session(struct cmd_q *, const char *, int);
1740 struct winlink *cmd_find_window(struct cmd_q *, const char *,
1741 struct session **);
1742 int cmd_find_index(struct cmd_q *, const char *,
1743 struct session **);
1744 struct winlink *cmd_find_pane(struct cmd_q *, const char *, struct session **,
1745 struct window_pane **);
1746 char *cmd_template_replace(const char *, const char *, int);
1747 extern const struct cmd_entry *cmd_table[];
1748 extern const struct cmd_entry cmd_attach_session_entry;
1749 extern const struct cmd_entry cmd_bind_key_entry;
1750 extern const struct cmd_entry cmd_break_pane_entry;
1751 extern const struct cmd_entry cmd_capture_pane_entry;
1752 extern const struct cmd_entry cmd_choose_buffer_entry;
1753 extern const struct cmd_entry cmd_choose_client_entry;
1754 extern const struct cmd_entry cmd_choose_list_entry;
1755 extern const struct cmd_entry cmd_choose_session_entry;
1756 extern const struct cmd_entry cmd_choose_tree_entry;
1757 extern const struct cmd_entry cmd_choose_window_entry;
1758 extern const struct cmd_entry cmd_clear_history_entry;
1759 extern const struct cmd_entry cmd_clock_mode_entry;
1760 extern const struct cmd_entry cmd_command_prompt_entry;
1761 extern const struct cmd_entry cmd_confirm_before_entry;
1762 extern const struct cmd_entry cmd_copy_mode_entry;
1763 extern const struct cmd_entry cmd_delete_buffer_entry;
1764 extern const struct cmd_entry cmd_detach_client_entry;
1765 extern const struct cmd_entry cmd_display_message_entry;
1766 extern const struct cmd_entry cmd_display_panes_entry;
1767 extern const struct cmd_entry cmd_down_pane_entry;
1768 extern const struct cmd_entry cmd_find_window_entry;
1769 extern const struct cmd_entry cmd_has_session_entry;
1770 extern const struct cmd_entry cmd_if_shell_entry;
1771 extern const struct cmd_entry cmd_join_pane_entry;
1772 extern const struct cmd_entry cmd_kill_pane_entry;
1773 extern const struct cmd_entry cmd_kill_server_entry;
1774 extern const struct cmd_entry cmd_kill_session_entry;
1775 extern const struct cmd_entry cmd_kill_window_entry;
1776 extern const struct cmd_entry cmd_last_pane_entry;
1777 extern const struct cmd_entry cmd_last_window_entry;
1778 extern const struct cmd_entry cmd_link_window_entry;
1779 extern const struct cmd_entry cmd_list_buffers_entry;
1780 extern const struct cmd_entry cmd_list_clients_entry;
1781 extern const struct cmd_entry cmd_list_commands_entry;
1782 extern const struct cmd_entry cmd_list_keys_entry;
1783 extern const struct cmd_entry cmd_list_panes_entry;
1784 extern const struct cmd_entry cmd_list_sessions_entry;
1785 extern const struct cmd_entry cmd_list_windows_entry;
1786 extern const struct cmd_entry cmd_load_buffer_entry;
1787 extern const struct cmd_entry cmd_lock_client_entry;
1788 extern const struct cmd_entry cmd_lock_server_entry;
1789 extern const struct cmd_entry cmd_lock_session_entry;
1790 extern const struct cmd_entry cmd_move_pane_entry;
1791 extern const struct cmd_entry cmd_move_window_entry;
1792 extern const struct cmd_entry cmd_new_session_entry;
1793 extern const struct cmd_entry cmd_new_window_entry;
1794 extern const struct cmd_entry cmd_next_layout_entry;
1795 extern const struct cmd_entry cmd_next_window_entry;
1796 extern const struct cmd_entry cmd_paste_buffer_entry;
1797 extern const struct cmd_entry cmd_pipe_pane_entry;
1798 extern const struct cmd_entry cmd_previous_layout_entry;
1799 extern const struct cmd_entry cmd_previous_window_entry;
1800 extern const struct cmd_entry cmd_refresh_client_entry;
1801 extern const struct cmd_entry cmd_rename_session_entry;
1802 extern const struct cmd_entry cmd_rename_window_entry;
1803 extern const struct cmd_entry cmd_resize_pane_entry;
1804 extern const struct cmd_entry cmd_respawn_pane_entry;
1805 extern const struct cmd_entry cmd_respawn_window_entry;
1806 extern const struct cmd_entry cmd_rotate_window_entry;
1807 extern const struct cmd_entry cmd_run_shell_entry;
1808 extern const struct cmd_entry cmd_save_buffer_entry;
1809 extern const struct cmd_entry cmd_select_layout_entry;
1810 extern const struct cmd_entry cmd_select_pane_entry;
1811 extern const struct cmd_entry cmd_select_window_entry;
1812 extern const struct cmd_entry cmd_send_keys_entry;
1813 extern const struct cmd_entry cmd_send_prefix_entry;
1814 extern const struct cmd_entry cmd_server_info_entry;
1815 extern const struct cmd_entry cmd_set_buffer_entry;
1816 extern const struct cmd_entry cmd_set_environment_entry;
1817 extern const struct cmd_entry cmd_set_option_entry;
1818 extern const struct cmd_entry cmd_set_window_option_entry;
1819 extern const struct cmd_entry cmd_show_buffer_entry;
1820 extern const struct cmd_entry cmd_show_environment_entry;
1821 extern const struct cmd_entry cmd_show_messages_entry;
1822 extern const struct cmd_entry cmd_show_options_entry;
1823 extern const struct cmd_entry cmd_show_window_options_entry;
1824 extern const struct cmd_entry cmd_source_file_entry;
1825 extern const struct cmd_entry cmd_split_window_entry;
1826 extern const struct cmd_entry cmd_start_server_entry;
1827 extern const struct cmd_entry cmd_suspend_client_entry;
1828 extern const struct cmd_entry cmd_swap_pane_entry;
1829 extern const struct cmd_entry cmd_swap_window_entry;
1830 extern const struct cmd_entry cmd_switch_client_entry;
1831 extern const struct cmd_entry cmd_unbind_key_entry;
1832 extern const struct cmd_entry cmd_unlink_window_entry;
1833 extern const struct cmd_entry cmd_up_pane_entry;
1834 extern const struct cmd_entry cmd_wait_for_entry;
1836 /* cmd-attach-session.c */
1837 enum cmd_retval cmd_attach_session(struct cmd_q *, const char *, int, int,
1838 const char *);
1840 /* cmd-list.c */
1841 struct cmd_list *cmd_list_parse(int, char **, const char *, u_int, char **);
1842 void cmd_list_free(struct cmd_list *);
1843 size_t cmd_list_print(struct cmd_list *, char *, size_t);
1845 /* cmd-queue.c */
1846 struct cmd_q *cmdq_new(struct client *);
1847 int cmdq_free(struct cmd_q *);
1848 void printflike2 cmdq_print(struct cmd_q *, const char *, ...);
1849 void printflike2 cmdq_info(struct cmd_q *, const char *, ...);
1850 void printflike2 cmdq_error(struct cmd_q *, const char *, ...);
1851 int cmdq_guard(struct cmd_q *, const char *, int);
1852 void cmdq_run(struct cmd_q *, struct cmd_list *);
1853 void cmdq_append(struct cmd_q *, struct cmd_list *);
1854 int cmdq_continue(struct cmd_q *);
1855 void cmdq_flush(struct cmd_q *);
1857 /* cmd-string.c */
1858 int cmd_string_parse(const char *, struct cmd_list **, const char *,
1859 u_int, char **);
1861 /* client.c */
1862 int client_main(int, char **, int);
1864 /* key-bindings.c */
1865 extern struct key_bindings key_bindings;
1866 int key_bindings_cmp(struct key_binding *, struct key_binding *);
1867 RB_PROTOTYPE(key_bindings, key_binding, entry, key_bindings_cmp);
1868 struct key_binding *key_bindings_lookup(int);
1869 void key_bindings_add(int, int, struct cmd_list *);
1870 void key_bindings_remove(int);
1871 void key_bindings_clean(void);
1872 void key_bindings_init(void);
1873 void key_bindings_dispatch(struct key_binding *, struct client *);
1875 /* key-string.c */
1876 int key_string_lookup_string(const char *);
1877 const char *key_string_lookup_key(int);
1879 /* server.c */
1880 extern struct clients clients;
1881 extern struct clients dead_clients;
1882 extern struct paste_stack global_buffers;
1883 int server_start(int, char *);
1884 void server_update_socket(void);
1885 void server_add_accept(int);
1887 /* server-client.c */
1888 void server_client_handle_key(struct client *, int);
1889 void server_client_create(int);
1890 int server_client_open(struct client *, struct session *, char **);
1891 void server_client_lost(struct client *);
1892 void server_client_callback(int, short, void *);
1893 void server_client_status_timer(void);
1894 void server_client_loop(void);
1896 /* server-window.c */
1897 void server_window_loop(void);
1899 /* server-fn.c */
1900 void server_fill_environ(struct session *, struct environ *);
1901 void server_write_ready(struct client *);
1902 int server_write_client(struct client *, enum msgtype, const void *,
1903 size_t);
1904 void server_write_session(struct session *, enum msgtype, const void *,
1905 size_t);
1906 void server_redraw_client(struct client *);
1907 void server_status_client(struct client *);
1908 void server_redraw_session(struct session *);
1909 void server_redraw_session_group(struct session *);
1910 void server_status_session(struct session *);
1911 void server_status_session_group(struct session *);
1912 void server_redraw_window(struct window *);
1913 void server_redraw_window_borders(struct window *);
1914 void server_status_window(struct window *);
1915 void server_lock(void);
1916 void server_lock_session(struct session *);
1917 void server_lock_client(struct client *);
1918 int server_unlock(const char *);
1919 void server_kill_window(struct window *);
1920 int server_link_window(struct session *,
1921 struct winlink *, struct session *, int, int, int, char **);
1922 void server_unlink_window(struct session *, struct winlink *);
1923 void server_destroy_pane(struct window_pane *);
1924 void server_destroy_session_group(struct session *);
1925 void server_destroy_session(struct session *);
1926 void server_check_unattached(void);
1927 void server_set_identify(struct client *);
1928 void server_clear_identify(struct client *);
1929 void server_update_event(struct client *);
1930 void server_push_stdout(struct client *);
1931 void server_push_stderr(struct client *);
1932 int server_set_stdin_callback(struct client *, void (*)(struct client *,
1933 int, void *), void *, char **);
1934 void server_unzoom_window(struct window *);
1936 /* status.c */
1937 int status_out_cmp(struct status_out *, struct status_out *);
1938 RB_PROTOTYPE(status_out_tree, status_out, entry, status_out_cmp);
1939 int status_at_line(struct client *);
1940 void status_free_jobs(struct status_out_tree *);
1941 void status_update_jobs(struct client *);
1942 void status_set_window_at(struct client *, u_int);
1943 int status_redraw(struct client *);
1944 char *status_replace(struct client *, struct session *,
1945 struct winlink *, struct window_pane *, const char *, time_t, int);
1946 void printflike2 status_message_set(struct client *, const char *, ...);
1947 void status_message_clear(struct client *);
1948 int status_message_redraw(struct client *);
1949 void status_prompt_set(struct client *, const char *, const char *,
1950 int (*)(void *, const char *), void (*)(void *), void *, int);
1951 void status_prompt_clear(struct client *);
1952 int status_prompt_redraw(struct client *);
1953 void status_prompt_key(struct client *, int);
1954 void status_prompt_update(struct client *, const char *, const char *);
1956 /* resize.c */
1957 void recalculate_sizes(void);
1959 /* input.c */
1960 void input_init(struct window_pane *);
1961 void input_free(struct window_pane *);
1962 void input_parse(struct window_pane *);
1964 /* input-key.c */
1965 void input_key(struct window_pane *, int);
1966 void input_mouse(struct window_pane *, struct session *,
1967 struct mouse_event *);
1969 /* xterm-keys.c */
1970 char *xterm_keys_lookup(int);
1971 int xterm_keys_find(const char *, size_t, size_t *, int *);
1973 /* colour.c */
1974 void colour_set_fg(struct grid_cell *, int);
1975 void colour_set_bg(struct grid_cell *, int);
1976 const char *colour_tostring(int);
1977 int colour_fromstring(const char *);
1978 u_char colour_256to16(u_char);
1980 /* attributes.c */
1981 const char *attributes_tostring(u_char);
1982 int attributes_fromstring(const char *);
1984 /* grid.c */
1985 extern const struct grid_cell grid_default_cell;
1986 extern const struct grid_cell grid_marker_cell;
1987 struct grid *grid_create(u_int, u_int, u_int);
1988 void grid_destroy(struct grid *);
1989 int grid_compare(struct grid *, struct grid *);
1990 void grid_collect_history(struct grid *);
1991 void grid_scroll_history(struct grid *);
1992 void grid_scroll_history_region(struct grid *, u_int, u_int);
1993 void grid_expand_line(struct grid *, u_int, u_int);
1994 const struct grid_cell *grid_peek_cell(struct grid *, u_int, u_int);
1995 const struct grid_line *grid_peek_line(struct grid *, u_int);
1996 struct grid_cell *grid_get_cell(struct grid *, u_int, u_int);
1997 void grid_set_cell(struct grid *, u_int, u_int, const struct grid_cell *);
1998 void grid_clear(struct grid *, u_int, u_int, u_int, u_int);
1999 void grid_clear_lines(struct grid *, u_int, u_int);
2000 void grid_move_lines(struct grid *, u_int, u_int, u_int);
2001 void grid_move_cells(struct grid *, u_int, u_int, u_int, u_int);
2002 char *grid_string_cells(struct grid *, u_int, u_int, u_int,
2003 struct grid_cell **, int, int, int);
2004 void grid_duplicate_lines(
2005 struct grid *, u_int, struct grid *, u_int, u_int);
2006 u_int grid_reflow(struct grid *, struct grid *, u_int);
2008 /* grid-cell.c */
2009 u_int grid_cell_width(const struct grid_cell *);
2010 void grid_cell_get(const struct grid_cell *, struct utf8_data *);
2011 void grid_cell_set(struct grid_cell *, const struct utf8_data *);
2012 void grid_cell_one(struct grid_cell *, u_char);
2014 /* grid-view.c */
2015 const struct grid_cell *grid_view_peek_cell(struct grid *, u_int, u_int);
2016 struct grid_cell *grid_view_get_cell(struct grid *, u_int, u_int);
2017 void grid_view_set_cell(
2018 struct grid *, u_int, u_int, const struct grid_cell *);
2019 void grid_view_clear_history(struct grid *);
2020 void grid_view_clear(struct grid *, u_int, u_int, u_int, u_int);
2021 void grid_view_scroll_region_up(struct grid *, u_int, u_int);
2022 void grid_view_scroll_region_down(struct grid *, u_int, u_int);
2023 void grid_view_insert_lines(struct grid *, u_int, u_int);
2024 void grid_view_insert_lines_region(struct grid *, u_int, u_int, u_int);
2025 void grid_view_delete_lines(struct grid *, u_int, u_int);
2026 void grid_view_delete_lines_region(struct grid *, u_int, u_int, u_int);
2027 void grid_view_insert_cells(struct grid *, u_int, u_int, u_int);
2028 void grid_view_delete_cells(struct grid *, u_int, u_int, u_int);
2029 char *grid_view_string_cells(struct grid *, u_int, u_int, u_int);
2031 /* screen-write.c */
2032 void screen_write_start(
2033 struct screen_write_ctx *, struct window_pane *, struct screen *);
2034 void screen_write_stop(struct screen_write_ctx *);
2035 void screen_write_reset(struct screen_write_ctx *);
2036 size_t printflike2 screen_write_cstrlen(int, const char *, ...);
2037 void printflike5 screen_write_cnputs(struct screen_write_ctx *,
2038 ssize_t, struct grid_cell *, int, const char *, ...);
2039 size_t printflike2 screen_write_strlen(int, const char *, ...);
2040 void printflike3 screen_write_puts(struct screen_write_ctx *,
2041 struct grid_cell *, const char *, ...);
2042 void printflike5 screen_write_nputs(struct screen_write_ctx *,
2043 ssize_t, struct grid_cell *, int, const char *, ...);
2044 void screen_write_vnputs(struct screen_write_ctx *,
2045 ssize_t, struct grid_cell *, int, const char *, va_list);
2046 void screen_write_parsestyle(
2047 struct grid_cell *, struct grid_cell *, const char *);
2048 void screen_write_putc(
2049 struct screen_write_ctx *, struct grid_cell *, u_char);
2050 void screen_write_copy(struct screen_write_ctx *,
2051 struct screen *, u_int, u_int, u_int, u_int);
2052 void screen_write_backspace(struct screen_write_ctx *);
2053 void screen_write_mode_set(struct screen_write_ctx *, int);
2054 void screen_write_mode_clear(struct screen_write_ctx *, int);
2055 void screen_write_cursorup(struct screen_write_ctx *, u_int);
2056 void screen_write_cursordown(struct screen_write_ctx *, u_int);
2057 void screen_write_cursorright(struct screen_write_ctx *, u_int);
2058 void screen_write_cursorleft(struct screen_write_ctx *, u_int);
2059 void screen_write_alignmenttest(struct screen_write_ctx *);
2060 void screen_write_insertcharacter(struct screen_write_ctx *, u_int);
2061 void screen_write_deletecharacter(struct screen_write_ctx *, u_int);
2062 void screen_write_clearcharacter(struct screen_write_ctx *, u_int);
2063 void screen_write_insertline(struct screen_write_ctx *, u_int);
2064 void screen_write_deleteline(struct screen_write_ctx *, u_int);
2065 void screen_write_clearline(struct screen_write_ctx *);
2066 void screen_write_clearendofline(struct screen_write_ctx *);
2067 void screen_write_clearstartofline(struct screen_write_ctx *);
2068 void screen_write_cursormove(struct screen_write_ctx *, u_int, u_int);
2069 void screen_write_reverseindex(struct screen_write_ctx *);
2070 void screen_write_scrollregion(struct screen_write_ctx *, u_int, u_int);
2071 void screen_write_linefeed(struct screen_write_ctx *, int);
2072 void screen_write_linefeedscreen(struct screen_write_ctx *, int);
2073 void screen_write_carriagereturn(struct screen_write_ctx *);
2074 void screen_write_clearendofscreen(struct screen_write_ctx *);
2075 void screen_write_clearstartofscreen(struct screen_write_ctx *);
2076 void screen_write_clearscreen(struct screen_write_ctx *);
2077 void screen_write_clearhistory(struct screen_write_ctx *);
2078 void screen_write_cell(struct screen_write_ctx *, const struct grid_cell *);
2079 void screen_write_setselection(struct screen_write_ctx *, u_char *, u_int);
2080 void screen_write_rawstring(struct screen_write_ctx *, u_char *, u_int);
2082 /* screen-redraw.c */
2083 void screen_redraw_screen(struct client *, int, int);
2084 void screen_redraw_pane(struct client *, struct window_pane *);
2086 /* screen.c */
2087 void screen_init(struct screen *, u_int, u_int, u_int);
2088 void screen_reinit(struct screen *);
2089 void screen_free(struct screen *);
2090 void screen_reset_tabs(struct screen *);
2091 void screen_set_cursor_style(struct screen *, u_int);
2092 void screen_set_cursor_colour(struct screen *, const char *);
2093 void screen_set_title(struct screen *, const char *);
2094 void screen_resize(struct screen *, u_int, u_int, int);
2095 void screen_set_selection(struct screen *,
2096 u_int, u_int, u_int, u_int, u_int, struct grid_cell *);
2097 void screen_clear_selection(struct screen *);
2098 int screen_check_selection(struct screen *, u_int, u_int);
2099 void screen_reflow(struct screen *, u_int);
2101 /* window.c */
2102 extern struct windows windows;
2103 extern struct window_pane_tree all_window_panes;
2104 int winlink_cmp(struct winlink *, struct winlink *);
2105 RB_PROTOTYPE(winlinks, winlink, entry, winlink_cmp);
2106 int window_pane_cmp(struct window_pane *, struct window_pane *);
2107 RB_PROTOTYPE(window_pane_tree, window_pane, tree_entry, window_pane_cmp);
2108 struct winlink *winlink_find_by_index(struct winlinks *, int);
2109 struct winlink *winlink_find_by_window(struct winlinks *, struct window *);
2110 struct winlink *winlink_find_by_window_id(struct winlinks *, u_int);
2111 int winlink_next_index(struct winlinks *, int);
2112 u_int winlink_count(struct winlinks *);
2113 struct winlink *winlink_add(struct winlinks *, int);
2114 void winlink_set_window(struct winlink *, struct window *);
2115 void winlink_remove(struct winlinks *, struct winlink *);
2116 struct winlink *winlink_next(struct winlink *);
2117 struct winlink *winlink_previous(struct winlink *);
2118 struct winlink *winlink_next_by_number(struct winlink *, struct session *,
2119 int);
2120 struct winlink *winlink_previous_by_number(struct winlink *, struct session *,
2121 int);
2122 void winlink_stack_push(struct winlink_stack *, struct winlink *);
2123 void winlink_stack_remove(struct winlink_stack *, struct winlink *);
2124 int window_index(struct window *, u_int *);
2125 struct window *window_find_by_id(u_int);
2126 struct window *window_create1(u_int, u_int);
2127 struct window *window_create(const char *, const char *, const char *, int,
2128 struct environ *, struct termios *, u_int, u_int, u_int,
2129 char **);
2130 void window_destroy(struct window *);
2131 struct window_pane *window_get_active_at(struct window *, u_int, u_int);
2132 void window_set_active_at(struct window *, u_int, u_int);
2133 struct window_pane *window_find_string(struct window *, const char *);
2134 void window_set_active_pane(struct window *, struct window_pane *);
2135 struct window_pane *window_add_pane(struct window *, u_int);
2136 void window_resize(struct window *, u_int, u_int);
2137 int window_zoom(struct window_pane *);
2138 int window_unzoom(struct window *);
2139 void window_remove_pane(struct window *, struct window_pane *);
2140 struct window_pane *window_pane_at_index(struct window *, u_int);
2141 struct window_pane *window_pane_next_by_number(struct window *,
2142 struct window_pane *, u_int);
2143 struct window_pane *window_pane_previous_by_number(struct window *,
2144 struct window_pane *, u_int);
2145 int window_pane_index(struct window_pane *, u_int *);
2146 u_int window_count_panes(struct window *);
2147 void window_destroy_panes(struct window *);
2148 struct window_pane *window_pane_find_by_id(u_int);
2149 struct window_pane *window_pane_create(struct window *, u_int, u_int, u_int);
2150 void window_pane_destroy(struct window_pane *);
2151 void window_pane_timer_start(struct window_pane *);
2152 int window_pane_spawn(struct window_pane *, const char *,
2153 const char *, int, struct environ *, struct termios *,
2154 char **);
2155 void window_pane_resize(struct window_pane *, u_int, u_int);
2156 void window_pane_alternate_on(struct window_pane *,
2157 struct grid_cell *, int);
2158 void window_pane_alternate_off(struct window_pane *,
2159 struct grid_cell *, int);
2160 int window_pane_set_mode(
2161 struct window_pane *, const struct window_mode *);
2162 void window_pane_reset_mode(struct window_pane *);
2163 void window_pane_key(struct window_pane *, struct session *, int);
2164 void window_pane_mouse(struct window_pane *,
2165 struct session *, struct mouse_event *);
2166 int window_pane_visible(struct window_pane *);
2167 char *window_pane_search(
2168 struct window_pane *, const char *, u_int *);
2169 char *window_printable_flags(struct session *, struct winlink *);
2170 struct window_pane *window_pane_find_up(struct window_pane *);
2171 struct window_pane *window_pane_find_down(struct window_pane *);
2172 struct window_pane *window_pane_find_left(struct window_pane *);
2173 struct window_pane *window_pane_find_right(struct window_pane *);
2174 void window_set_name(struct window *, const char *);
2175 void window_remove_ref(struct window *);
2176 void winlink_clear_flags(struct winlink *);
2177 void window_mode_attrs(struct grid_cell *, struct options *);
2179 /* layout.c */
2180 u_int layout_count_cells(struct layout_cell *);
2181 struct layout_cell *layout_create_cell(struct layout_cell *);
2182 void layout_free_cell(struct layout_cell *);
2183 void layout_print_cell(struct layout_cell *, const char *, u_int);
2184 void layout_destroy_cell(struct layout_cell *, struct layout_cell **);
2185 void layout_set_size(
2186 struct layout_cell *, u_int, u_int, u_int, u_int);
2187 void layout_make_leaf(
2188 struct layout_cell *, struct window_pane *);
2189 void layout_make_node(struct layout_cell *, enum layout_type);
2190 void layout_fix_offsets(struct layout_cell *);
2191 void layout_fix_panes(struct window *, u_int, u_int);
2192 u_int layout_resize_check(struct layout_cell *, enum layout_type);
2193 void layout_resize_adjust(
2194 struct layout_cell *, enum layout_type, int);
2195 void layout_init(struct window *, struct window_pane *);
2196 void layout_free(struct window *);
2197 void layout_resize(struct window *, u_int, u_int);
2198 void layout_resize_pane(struct window_pane *, enum layout_type,
2199 int);
2200 void layout_resize_pane_to(struct window_pane *, enum layout_type,
2201 u_int);
2202 void layout_resize_pane_mouse(struct client *);
2203 void layout_assign_pane(struct layout_cell *, struct window_pane *);
2204 struct layout_cell *layout_split_pane(
2205 struct window_pane *, enum layout_type, int, int);
2206 void layout_close_pane(struct window_pane *);
2208 /* layout-custom.c */
2209 char *layout_dump(struct window *);
2210 int layout_parse(struct window *, const char *);
2212 /* layout-set.c */
2213 const char *layout_set_name(u_int);
2214 int layout_set_lookup(const char *);
2215 u_int layout_set_select(struct window *, u_int);
2216 u_int layout_set_next(struct window *);
2217 u_int layout_set_previous(struct window *);
2218 void layout_set_active_changed(struct window *);
2220 /* window-clock.c */
2221 extern const struct window_mode window_clock_mode;
2223 /* window-copy.c */
2224 extern const struct window_mode window_copy_mode;
2225 void window_copy_init_from_pane(struct window_pane *);
2226 void window_copy_init_for_output(struct window_pane *);
2227 void printflike2 window_copy_add(struct window_pane *, const char *, ...);
2228 void window_copy_vadd(struct window_pane *, const char *, va_list);
2229 void window_copy_pageup(struct window_pane *);
2231 /* window-choose.c */
2232 extern const struct window_mode window_choose_mode;
2233 void window_choose_add(struct window_pane *,
2234 struct window_choose_data *);
2235 void window_choose_ready(struct window_pane *,
2236 u_int, void (*)(struct window_choose_data *));
2237 struct window_choose_data *window_choose_data_create (int,
2238 struct client *, struct session *);
2239 void window_choose_data_free(struct window_choose_data *);
2240 void window_choose_data_run(struct window_choose_data *);
2241 struct window_choose_data *window_choose_add_window(struct window_pane *,
2242 struct client *, struct session *, struct winlink *,
2243 const char *, const char *, u_int);
2244 struct window_choose_data *window_choose_add_session(struct window_pane *,
2245 struct client *, struct session *, const char *,
2246 const char *, u_int);
2247 struct window_choose_data *window_choose_add_item(struct window_pane *,
2248 struct client *, struct winlink *, const char *,
2249 const char *, u_int);
2250 void window_choose_expand_all(struct window_pane *);
2251 void window_choose_collapse_all(struct window_pane *);
2252 void window_choose_set_current(struct window_pane *, u_int);
2254 /* names.c */
2255 void queue_window_name(struct window *);
2256 char *default_window_name(struct window *);
2257 char *format_window_name(struct window *);
2258 char *parse_window_name(const char *);
2260 /* signal.c */
2261 void set_signals(void(*)(int, short, void *));
2262 void clear_signals(int);
2264 /* control.c */
2265 void control_callback(struct client *, int, void*);
2266 void printflike2 control_write(struct client *, const char *, ...);
2267 void control_write_buffer(struct client *, struct evbuffer *);
2269 /* control-notify.c */
2270 void control_notify_input(struct client *, struct window_pane *,
2271 struct evbuffer *);
2272 void control_notify_window_layout_changed(struct window *);
2273 void control_notify_window_unlinked(struct session *, struct window *);
2274 void control_notify_window_linked(struct session *, struct window *);
2275 void control_notify_window_renamed(struct window *);
2276 void control_notify_attached_session_changed(struct client *);
2277 void control_notify_session_renamed(struct session *);
2278 void control_notify_session_created(struct session *);
2279 void control_notify_session_close(struct session *);
2281 /* session.c */
2282 extern struct sessions sessions;
2283 extern struct sessions dead_sessions;
2284 extern struct session_groups session_groups;
2285 int session_cmp(struct session *, struct session *);
2286 RB_PROTOTYPE(sessions, session, entry, session_cmp);
2287 int session_alive(struct session *);
2288 struct session *session_find(const char *);
2289 struct session *session_find_by_id(u_int);
2290 struct session *session_create(const char *, const char *, int,
2291 struct environ *, struct termios *, int, u_int, u_int,
2292 char **);
2293 void session_destroy(struct session *);
2294 int session_check_name(const char *);
2295 void session_update_activity(struct session *);
2296 struct session *session_next_session(struct session *);
2297 struct session *session_previous_session(struct session *);
2298 struct winlink *session_new(struct session *, const char *, const char *, int,
2299 int, char **);
2300 struct winlink *session_attach(
2301 struct session *, struct window *, int, char **);
2302 int session_detach(struct session *, struct winlink *);
2303 struct winlink* session_has(struct session *, struct window *);
2304 int session_next(struct session *, int);
2305 int session_previous(struct session *, int);
2306 int session_select(struct session *, int);
2307 int session_last(struct session *);
2308 int session_set_current(struct session *, struct winlink *);
2309 struct session_group *session_group_find(struct session *);
2310 u_int session_group_index(struct session_group *);
2311 void session_group_add(struct session *, struct session *);
2312 void session_group_remove(struct session *);
2313 void session_group_synchronize_to(struct session *);
2314 void session_group_synchronize_from(struct session *);
2315 void session_group_synchronize1(struct session *, struct session *);
2316 void session_renumber_windows(struct session *);
2318 /* utf8.c */
2319 void utf8_build(void);
2320 int utf8_open(struct utf8_data *, u_char);
2321 int utf8_append(struct utf8_data *, u_char);
2322 u_int utf8_combine(const struct utf8_data *);
2323 u_int utf8_split2(u_int, u_char *);
2325 /* procname.c */
2326 char *get_proc_name(int, char *);
2327 char *get_proc_cwd(int);
2329 /* log.c */
2330 void log_open(int, const char *);
2331 void log_close(void);
2332 void printflike1 log_warn(const char *, ...);
2333 void printflike1 log_warnx(const char *, ...);
2334 void printflike1 log_info(const char *, ...);
2335 void printflike1 log_debug(const char *, ...);
2336 void printflike1 log_debug2(const char *, ...);
2337 __dead void printflike1 log_fatal(const char *, ...);
2338 __dead void printflike1 log_fatalx(const char *, ...);
2340 /* xmalloc.c */
2341 char *xstrdup(const char *);
2342 void *xcalloc(size_t, size_t);
2343 void *xmalloc(size_t);
2344 void *xrealloc(void *, size_t, size_t);
2345 int printflike2 xasprintf(char **, const char *, ...);
2346 int xvasprintf(char **, const char *, va_list);
2347 int printflike3 xsnprintf(char *, size_t, const char *, ...);
2348 int xvsnprintf(char *, size_t, const char *, va_list);
2350 #endif /* TMUX_H */