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