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 #include <sys/types.h>
20 #include <sys/ioctl.h>
38 * Each window is attached to a number of panes, each of which is a pty. This
39 * file contains code to handle them.
41 * A pane has two buffers attached, these are filled and emptied by the main
42 * server poll loop. Output data is received from pty's in screen format,
43 * translated and returned as a series of escape sequences and strings via
44 * input_parse (in input.c). Input data is received as key codes and written
45 * directly via input_key.
47 * Each pane also has a "virtual" screen (screen.c) which contains the current
48 * state and is redisplayed when the window is reattached to a client.
50 * Windows are stored directly on a global array and wrapped in any number of
51 * winlink structs to be linked onto local session RB trees. A reference count
52 * is maintained and a window removed from the global list and destroyed when
56 /* Global window list. */
57 struct windows windows
;
59 /* Global panes tree. */
60 struct window_pane_tree all_window_panes
;
61 u_int next_window_pane
;
63 void window_pane_read_callback(struct bufferevent
*, void *);
64 void window_pane_error_callback(struct bufferevent
*, short, void *);
66 RB_GENERATE(winlinks
, winlink
, entry
, winlink_cmp
);
69 winlink_cmp(struct winlink
*wl1
, struct winlink
*wl2
)
71 return (wl1
->idx
- wl2
->idx
);
74 RB_GENERATE(window_pane_tree
, window_pane
, tree_entry
, window_pane_cmp
);
77 window_pane_cmp(struct window_pane
*wp1
, struct window_pane
*wp2
)
79 return (wp1
->id
- wp2
->id
);
83 winlink_find_by_window(struct winlinks
*wwl
, struct window
*w
)
87 RB_FOREACH(wl
, winlinks
, wwl
) {
96 winlink_find_by_index(struct winlinks
*wwl
, int idx
)
104 return (RB_FIND(winlinks
, wwl
, &wl
));
108 winlink_next_index(struct winlinks
*wwl
, int idx
)
114 if (winlink_find_by_index(wwl
, i
) == NULL
)
125 winlink_count(struct winlinks
*wwl
)
131 RB_FOREACH(wl
, winlinks
, wwl
)
138 winlink_add(struct winlinks
*wwl
, int idx
)
143 if ((idx
= winlink_next_index(wwl
, -idx
- 1)) == -1)
145 } else if (winlink_find_by_index(wwl
, idx
) != NULL
)
148 wl
= xcalloc(1, sizeof *wl
);
150 RB_INSERT(winlinks
, wwl
, wl
);
156 winlink_set_window(struct winlink
*wl
, struct window
*w
)
163 winlink_remove(struct winlinks
*wwl
, struct winlink
*wl
)
165 struct window
*w
= wl
->window
;
167 RB_REMOVE(winlinks
, wwl
, wl
);
168 if (wl
->status_text
!= NULL
)
169 xfree(wl
->status_text
);
173 if (w
->references
== 0)
174 fatal("bad reference count");
176 if (w
->references
== 0)
182 winlink_next(struct winlink
*wl
)
184 return (RB_NEXT(winlinks
, wwl
, wl
));
188 winlink_previous(struct winlink
*wl
)
190 return (RB_PREV(winlinks
, wwl
, wl
));
194 winlink_next_by_number(struct winlink
*wl
, struct session
*s
, int n
)
197 if ((wl
= RB_NEXT(winlinks
, wwl
, wl
)) == NULL
)
198 wl
= RB_MIN(winlinks
, &s
->windows
);
205 winlink_previous_by_number(struct winlink
*wl
, struct session
*s
, int n
)
208 if ((wl
= RB_PREV(winlinks
, wwl
, wl
)) == NULL
)
209 wl
= RB_MAX(winlinks
, &s
->windows
);
216 winlink_stack_push(struct winlink_stack
*stack
, struct winlink
*wl
)
221 winlink_stack_remove(stack
, wl
);
222 TAILQ_INSERT_HEAD(stack
, wl
, sentry
);
226 winlink_stack_remove(struct winlink_stack
*stack
, struct winlink
*wl
)
233 TAILQ_FOREACH(wl2
, stack
, sentry
) {
235 TAILQ_REMOVE(stack
, wl
, sentry
);
242 window_index(struct window
*s
, u_int
*i
)
244 for (*i
= 0; *i
< ARRAY_LENGTH(&windows
); (*i
)++) {
245 if (s
== ARRAY_ITEM(&windows
, *i
))
252 window_create1(u_int sx
, u_int sy
)
257 w
= xcalloc(1, sizeof *w
);
261 TAILQ_INIT(&w
->panes
);
265 w
->layout_root
= NULL
;
270 queue_window_name(w
);
272 options_init(&w
->options
, &global_w_options
);
274 for (i
= 0; i
< ARRAY_LENGTH(&windows
); i
++) {
275 if (ARRAY_ITEM(&windows
, i
) == NULL
) {
276 ARRAY_SET(&windows
, i
, w
);
280 if (i
== ARRAY_LENGTH(&windows
))
281 ARRAY_ADD(&windows
, w
);
288 window_create(const char *name
, const char *cmd
, const char *shell
,
289 const char *cwd
, struct environ
*env
, struct termios
*tio
,
290 u_int sx
, u_int sy
, u_int hlimit
,char **cause
)
293 struct window_pane
*wp
;
295 w
= window_create1(sx
, sy
);
296 wp
= window_add_pane(w
, hlimit
);
298 if (window_pane_spawn(wp
, cmd
, shell
, cwd
, env
, tio
, cause
) != 0) {
302 w
->active
= TAILQ_FIRST(&w
->panes
);
304 w
->name
= xstrdup(name
);
305 options_set_number(&w
->options
, "automatic-rename", 0);
307 w
->name
= default_window_name(w
);
312 window_destroy(struct window
*w
)
316 if (window_index(w
, &i
) != 0)
317 fatalx("index not found");
318 ARRAY_SET(&windows
, i
, NULL
);
319 while (!ARRAY_EMPTY(&windows
) && ARRAY_LAST(&windows
) == NULL
)
320 ARRAY_TRUNC(&windows
, 1);
322 if (w
->layout_root
!= NULL
)
325 evtimer_del(&w
->name_timer
);
327 options_free(&w
->options
);
329 window_destroy_panes(w
);
337 window_resize(struct window
*w
, u_int sx
, u_int sy
)
344 window_set_active_pane(struct window
*w
, struct window_pane
*wp
)
350 while (!window_pane_visible(w
->active
)) {
351 w
->active
= TAILQ_PREV(w
->active
, window_panes
, entry
);
352 if (w
->active
== NULL
)
353 w
->active
= TAILQ_LAST(&w
->panes
, window_panes
);
360 window_set_active_at(struct window
*w
, u_int x
, u_int y
)
362 struct window_pane
*wp
;
364 TAILQ_FOREACH(wp
, &w
->panes
, entry
) {
365 if (wp
== w
->active
|| !window_pane_visible(wp
))
367 if (x
< wp
->xoff
|| x
>= wp
->xoff
+ wp
->sx
)
369 if (y
< wp
->yoff
|| y
>= wp
->yoff
+ wp
->sy
)
371 window_set_active_pane(w
, wp
);
377 window_add_pane(struct window
*w
, u_int hlimit
)
379 struct window_pane
*wp
;
381 wp
= window_pane_create(w
, w
->sx
, w
->sy
, hlimit
);
382 if (TAILQ_EMPTY(&w
->panes
))
383 TAILQ_INSERT_HEAD(&w
->panes
, wp
, entry
);
385 TAILQ_INSERT_AFTER(&w
->panes
, w
->active
, wp
, entry
);
390 window_remove_pane(struct window
*w
, struct window_pane
*wp
)
392 if (wp
== w
->active
) {
395 if (w
->active
== NULL
) {
396 w
->active
= TAILQ_PREV(wp
, window_panes
, entry
);
397 if (w
->active
== NULL
)
398 w
->active
= TAILQ_NEXT(wp
, entry
);
400 } else if (wp
== w
->last
)
403 TAILQ_REMOVE(&w
->panes
, wp
, entry
);
404 window_pane_destroy(wp
);
408 window_pane_at_index(struct window
*w
, u_int idx
)
410 struct window_pane
*wp
;
414 TAILQ_FOREACH(wp
, &w
->panes
, entry
) {
423 window_pane_next_by_number(struct window
*w
, struct window_pane
*wp
, u_int n
)
426 if ((wp
= TAILQ_NEXT(wp
, entry
)) == NULL
)
427 wp
= TAILQ_FIRST(&w
->panes
);
434 window_pane_previous_by_number(struct window
*w
, struct window_pane
*wp
,
438 if ((wp
= TAILQ_PREV(wp
, window_panes
, entry
)) == NULL
)
439 wp
= TAILQ_LAST(&w
->panes
, window_panes
);
446 window_pane_index(struct window
*w
, struct window_pane
*wp
)
448 struct window_pane
*wq
;
452 TAILQ_FOREACH(wq
, &w
->panes
, entry
) {
461 window_count_panes(struct window
*w
)
463 struct window_pane
*wp
;
467 TAILQ_FOREACH(wp
, &w
->panes
, entry
)
473 window_destroy_panes(struct window
*w
)
475 struct window_pane
*wp
;
477 while (!TAILQ_EMPTY(&w
->panes
)) {
478 wp
= TAILQ_FIRST(&w
->panes
);
479 TAILQ_REMOVE(&w
->panes
, wp
, entry
);
480 window_pane_destroy(wp
);
484 /* Return list of printable window flag symbols. No flags is just a space. */
486 window_printable_flags(struct session
*s
, struct winlink
*wl
)
492 if (wl
->flags
& WINLINK_ACTIVITY
)
494 if (wl
->flags
& WINLINK_BELL
)
496 if (wl
->flags
& WINLINK_CONTENT
)
498 if (wl
->flags
& WINLINK_SILENCE
)
502 if (wl
== TAILQ_FIRST(&s
->lastw
))
507 return (xstrdup(flags
));
510 /* Find pane in global tree by id. */
512 window_pane_find_by_id(u_int id
)
514 struct window_pane wp
;
517 return (RB_FIND(window_pane_tree
, &all_window_panes
, &wp
));
521 window_pane_create(struct window
*w
, u_int sx
, u_int sy
, u_int hlimit
)
523 struct window_pane
*wp
;
525 wp
= xcalloc(1, sizeof *wp
);
528 wp
->id
= next_window_pane
++;
529 RB_INSERT(window_pane_tree
, &all_window_panes
, wp
);
540 wp
->layout_cell
= NULL
;
550 wp
->pipe_event
= NULL
;
552 wp
->saved_grid
= NULL
;
554 screen_init(&wp
->base
, sx
, sy
, hlimit
);
555 wp
->screen
= &wp
->base
;
563 window_pane_destroy(struct window_pane
*wp
)
565 window_pane_reset_mode(wp
);
569 bufferevent_free(wp
->event
);
574 screen_free(&wp
->base
);
575 if (wp
->saved_grid
!= NULL
)
576 grid_destroy(wp
->saved_grid
);
578 if (wp
->pipe_fd
!= -1) {
580 bufferevent_free(wp
->pipe_event
);
583 RB_REMOVE(window_pane_tree
, &all_window_panes
, wp
);
587 if (wp
->shell
!= NULL
)
595 window_pane_spawn(struct window_pane
*wp
, const char *cmd
, const char *shell
,
596 const char *cwd
, struct environ
*env
, struct termios
*tio
, char **cause
)
599 char *argv0
, paneid
[16];
605 bufferevent_free(wp
->event
);
610 wp
->cmd
= xstrdup(cmd
);
613 if (wp
->shell
!= NULL
)
615 wp
->shell
= xstrdup(shell
);
620 wp
->cwd
= xstrdup(cwd
);
623 memset(&ws
, 0, sizeof ws
);
624 ws
.ws_col
= screen_size_x(&wp
->base
);
625 ws
.ws_row
= screen_size_y(&wp
->base
);
627 switch (wp
->pid
= forkpty(&wp
->fd
, wp
->tty
, NULL
, &ws
)) {
630 xasprintf(cause
, "%s: %s", cmd
, strerror(errno
));
633 if (chdir(wp
->cwd
) != 0)
636 if (tcgetattr(STDIN_FILENO
, &tio2
) != 0)
637 fatal("tcgetattr failed");
639 memcpy(tio2
.c_cc
, tio
->c_cc
, sizeof tio2
.c_cc
);
640 tio2
.c_cc
[VERASE
] = '\177';
641 if (tcsetattr(STDIN_FILENO
, TCSANOW
, &tio2
) != 0)
642 fatal("tcgetattr failed");
644 closefrom(STDERR_FILENO
+ 1);
646 xsnprintf(paneid
, sizeof paneid
, "%%%u", wp
->id
);
647 environ_set(env
, "TMUX_PANE", paneid
);
653 if (*wp
->cmd
!= '\0') {
654 /* Set SHELL but only if it is currently not useful. */
655 shell
= getenv("SHELL");
656 if (shell
== NULL
|| *shell
== '\0' || areshell(shell
))
657 setenv("SHELL", wp
->shell
, 1);
659 execl(_PATH_BSHELL
, "sh", "-c", wp
->cmd
, (char *) NULL
);
660 fatal("execl failed");
663 /* No command; fork a login shell. */
664 ptr
= strrchr(wp
->shell
, '/');
665 if (ptr
!= NULL
&& *(ptr
+ 1) != '\0')
666 xasprintf(&argv0
, "-%s", ptr
+ 1);
668 xasprintf(&argv0
, "-%s", wp
->shell
);
669 setenv("SHELL", wp
->shell
, 1);
670 execl(wp
->shell
, argv0
, (char *) NULL
);
671 fatal("execl failed");
674 setblocking(wp
->fd
, 0);
676 wp
->event
= bufferevent_new(wp
->fd
,
677 window_pane_read_callback
, NULL
, window_pane_error_callback
, wp
);
678 bufferevent_enable(wp
->event
, EV_READ
|EV_WRITE
);
685 window_pane_read_callback(unused
struct bufferevent
*bufev
, void *data
)
687 struct window_pane
*wp
= data
;
691 new_size
= EVBUFFER_LENGTH(wp
->event
->input
) - wp
->pipe_off
;
692 if (wp
->pipe_fd
!= -1 && new_size
> 0) {
693 new_data
= EVBUFFER_DATA(wp
->event
->input
);
694 bufferevent_write(wp
->pipe_event
, new_data
, new_size
);
699 wp
->pipe_off
= EVBUFFER_LENGTH(wp
->event
->input
);
702 * If we get here, we're not outputting anymore, so set the silence
703 * flag on the window.
705 wp
->window
->flags
|= WINDOW_SILENCE
;
706 if (gettimeofday(&wp
->window
->silence_timer
, NULL
) != 0)
707 fatal("gettimeofday failed.");
712 window_pane_error_callback(
713 unused
struct bufferevent
*bufev
, unused
short what
, void *data
)
715 struct window_pane
*wp
= data
;
717 server_destroy_pane(wp
);
721 window_pane_resize(struct window_pane
*wp
, u_int sx
, u_int sy
)
725 if (sx
== wp
->sx
&& sy
== wp
->sy
)
730 memset(&ws
, 0, sizeof ws
);
734 screen_resize(&wp
->base
, sx
, sy
);
735 if (wp
->mode
!= NULL
)
736 wp
->mode
->resize(wp
, sx
, sy
);
738 if (wp
->fd
!= -1 && ioctl(wp
->fd
, TIOCSWINSZ
, &ws
) == -1)
739 fatal("ioctl failed");
743 * Enter alternative screen mode. A copy of the visible screen is saved and the
744 * history is not updated
747 window_pane_alternate_on(struct window_pane
*wp
, struct grid_cell
*gc
)
749 struct screen
*s
= &wp
->base
;
752 if (wp
->saved_grid
!= NULL
)
754 if (!options_get_number(&wp
->window
->options
, "alternate-screen"))
756 sx
= screen_size_x(s
);
757 sy
= screen_size_y(s
);
759 wp
->saved_grid
= grid_create(sx
, sy
, 0);
760 grid_duplicate_lines(wp
->saved_grid
, 0, s
->grid
, screen_hsize(s
), sy
);
761 wp
->saved_cx
= s
->cx
;
762 wp
->saved_cy
= s
->cy
;
763 memcpy(&wp
->saved_cell
, gc
, sizeof wp
->saved_cell
);
765 grid_view_clear(s
->grid
, 0, 0, sx
, sy
);
767 wp
->base
.grid
->flags
&= ~GRID_HISTORY
;
769 wp
->flags
|= PANE_REDRAW
;
772 /* Exit alternate screen mode and restore the copied grid. */
774 window_pane_alternate_off(struct window_pane
*wp
, struct grid_cell
*gc
)
776 struct screen
*s
= &wp
->base
;
779 if (wp
->saved_grid
== NULL
)
781 if (!options_get_number(&wp
->window
->options
, "alternate-screen"))
783 sx
= screen_size_x(s
);
784 sy
= screen_size_y(s
);
787 * If the current size is bigger, temporarily resize to the old size
788 * before copying back.
790 if (sy
> wp
->saved_grid
->sy
)
791 screen_resize(s
, sx
, wp
->saved_grid
->sy
);
793 /* Restore the grid, cursor position and cell. */
794 grid_duplicate_lines(s
->grid
, screen_hsize(s
), wp
->saved_grid
, 0, sy
);
795 s
->cx
= wp
->saved_cx
;
796 if (s
->cx
> screen_size_x(s
) - 1)
797 s
->cx
= screen_size_x(s
) - 1;
798 s
->cy
= wp
->saved_cy
;
799 if (s
->cy
> screen_size_y(s
) - 1)
800 s
->cy
= screen_size_y(s
) - 1;
801 memcpy(gc
, &wp
->saved_cell
, sizeof *gc
);
804 * Turn history back on (so resize can use it) and then resize back to
807 wp
->base
.grid
->flags
|= GRID_HISTORY
;
808 if (sy
> wp
->saved_grid
->sy
)
809 screen_resize(s
, sx
, sy
);
811 grid_destroy(wp
->saved_grid
);
812 wp
->saved_grid
= NULL
;
814 wp
->flags
|= PANE_REDRAW
;
818 window_pane_set_mode(struct window_pane
*wp
, const struct window_mode
*mode
)
822 if (wp
->mode
!= NULL
)
826 if ((s
= wp
->mode
->init(wp
)) != NULL
)
828 wp
->flags
|= PANE_REDRAW
;
833 window_pane_reset_mode(struct window_pane
*wp
)
835 if (wp
->mode
== NULL
)
841 wp
->screen
= &wp
->base
;
842 wp
->flags
|= PANE_REDRAW
;
846 window_pane_key(struct window_pane
*wp
, struct session
*sess
, int key
)
848 struct window_pane
*wp2
;
850 if (!window_pane_visible(wp
))
853 if (wp
->mode
!= NULL
) {
854 if (wp
->mode
->key
!= NULL
)
855 wp
->mode
->key(wp
, sess
, key
);
862 if (options_get_number(&wp
->window
->options
, "synchronize-panes")) {
863 TAILQ_FOREACH(wp2
, &wp
->window
->panes
, entry
) {
864 if (wp2
== wp
|| wp2
->mode
!= NULL
)
866 if (wp2
->fd
!= -1 && window_pane_visible(wp2
))
874 struct window_pane
*wp
, struct session
*sess
, struct mouse_event
*m
)
876 if (!window_pane_visible(wp
))
879 if (m
->x
< wp
->xoff
|| m
->x
>= wp
->xoff
+ wp
->sx
)
881 if (m
->y
< wp
->yoff
|| m
->y
>= wp
->yoff
+ wp
->sy
)
886 if (wp
->mode
!= NULL
) {
887 if (wp
->mode
->mouse
!= NULL
&&
888 options_get_number(&wp
->window
->options
, "mode-mouse"))
889 wp
->mode
->mouse(wp
, sess
, m
);
890 } else if (wp
->fd
!= -1)
895 window_pane_visible(struct window_pane
*wp
)
897 struct window
*w
= wp
->window
;
899 if (wp
->xoff
>= w
->sx
|| wp
->yoff
>= w
->sy
)
901 if (wp
->xoff
+ wp
->sx
> w
->sx
|| wp
->yoff
+ wp
->sy
> w
->sy
)
907 window_pane_search(struct window_pane
*wp
, const char *searchstr
, u_int
*lineno
)
909 struct screen
*s
= &wp
->base
;
910 char *newsearchstr
, *line
, *msg
;
914 xasprintf(&newsearchstr
, "*%s*", searchstr
);
916 for (i
= 0; i
< screen_size_y(s
); i
++) {
917 line
= grid_view_string_cells(s
->grid
, 0, i
, screen_size_x(s
));
918 if (fnmatch(newsearchstr
, line
, 0) == 0) {
931 /* Find the pane directly above another. */
933 window_pane_find_up(struct window_pane
*wp
)
935 struct window_pane
*wp2
;
938 if (wp
== NULL
|| !window_pane_visible(wp
))
943 top
= wp
->window
->sy
+ 1;
946 TAILQ_FOREACH(wp2
, &wp
->window
->panes
, entry
) {
947 if (!window_pane_visible(wp2
))
949 if (wp2
->yoff
+ wp2
->sy
+ 1 != top
)
951 if (left
>= wp2
->xoff
&& left
<= wp2
->xoff
+ wp2
->sx
)
957 /* Find the pane directly below another. */
959 window_pane_find_down(struct window_pane
*wp
)
961 struct window_pane
*wp2
;
964 if (wp
== NULL
|| !window_pane_visible(wp
))
967 bottom
= wp
->yoff
+ wp
->sy
+ 1;
968 if (bottom
>= wp
->window
->sy
)
972 TAILQ_FOREACH(wp2
, &wp
->window
->panes
, entry
) {
973 if (!window_pane_visible(wp2
))
975 if (wp2
->yoff
!= bottom
)
977 if (left
>= wp2
->xoff
&& left
<= wp2
->xoff
+ wp2
->sx
)
984 * Find the pane directly to the left of another, adjacent to the left side and
985 * containing the top edge.
988 window_pane_find_left(struct window_pane
*wp
)
990 struct window_pane
*wp2
;
993 if (wp
== NULL
|| !window_pane_visible(wp
))
998 left
= wp
->window
->sx
+ 1;
1001 TAILQ_FOREACH(wp2
, &wp
->window
->panes
, entry
) {
1002 if (!window_pane_visible(wp2
))
1004 if (wp2
->xoff
+ wp2
->sx
+ 1 != left
)
1006 if (top
>= wp2
->yoff
&& top
<= wp2
->yoff
+ wp2
->sy
)
1013 * Find the pane directly to the right of another, that is adjacent to the
1014 * right edge and including the top edge.
1016 struct window_pane
*
1017 window_pane_find_right(struct window_pane
*wp
)
1019 struct window_pane
*wp2
;
1022 if (wp
== NULL
|| !window_pane_visible(wp
))
1025 right
= wp
->xoff
+ wp
->sx
+ 1;
1026 if (right
>= wp
->window
->sx
)
1030 TAILQ_FOREACH(wp2
, &wp
->window
->panes
, entry
) {
1031 if (!window_pane_visible(wp2
))
1033 if (wp2
->xoff
!= right
)
1035 if (top
>= wp2
->yoff
&& top
<= wp2
->yoff
+ wp2
->sy
)