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 void window_pane_read_callback(struct bufferevent
*, void *);
60 void window_pane_error_callback(struct bufferevent
*, short, void *);
62 RB_GENERATE(winlinks
, winlink
, entry
, winlink_cmp
);
65 winlink_cmp(struct winlink
*wl1
, struct winlink
*wl2
)
67 return (wl1
->idx
- wl2
->idx
);
71 winlink_find_by_window(struct winlinks
*wwl
, struct window
*w
)
75 RB_FOREACH(wl
, winlinks
, wwl
) {
84 winlink_find_by_index(struct winlinks
*wwl
, int idx
)
92 return (RB_FIND(winlinks
, wwl
, &wl
));
96 winlink_next_index(struct winlinks
*wwl
, int idx
)
102 if (winlink_find_by_index(wwl
, i
) == NULL
)
113 winlink_count(struct winlinks
*wwl
)
119 RB_FOREACH(wl
, winlinks
, wwl
)
126 winlink_add(struct winlinks
*wwl
, struct window
*w
, int idx
)
131 if ((idx
= winlink_next_index(wwl
, -idx
- 1)) == -1)
133 } else if (winlink_find_by_index(wwl
, idx
) != NULL
)
136 wl
= xcalloc(1, sizeof *wl
);
139 RB_INSERT(winlinks
, wwl
, wl
);
147 winlink_remove(struct winlinks
*wwl
, struct winlink
*wl
)
149 struct window
*w
= wl
->window
;
151 RB_REMOVE(winlinks
, wwl
, wl
);
152 if (wl
->status_text
!= NULL
)
153 xfree(wl
->status_text
);
156 if (w
->references
== 0)
157 fatal("bad reference count");
159 if (w
->references
== 0)
164 winlink_next(struct winlink
*wl
)
166 return (RB_NEXT(winlinks
, wwl
, wl
));
170 winlink_previous(struct winlink
*wl
)
172 return (RB_PREV(winlinks
, wwl
, wl
));
176 winlink_next_by_number(struct winlink
*wl
, struct session
*s
, int n
)
179 if ((wl
= RB_NEXT(winlinks
, wwl
, wl
)) == NULL
)
180 wl
= RB_MIN(winlinks
, &s
->windows
);
187 winlink_previous_by_number(struct winlink
*wl
, struct session
*s
, int n
)
190 if ((wl
= RB_PREV(winlinks
, wwl
, wl
)) == NULL
)
191 wl
= RB_MAX(winlinks
, &s
->windows
);
198 winlink_stack_push(struct winlink_stack
*stack
, struct winlink
*wl
)
203 winlink_stack_remove(stack
, wl
);
204 TAILQ_INSERT_HEAD(stack
, wl
, sentry
);
208 winlink_stack_remove(struct winlink_stack
*stack
, struct winlink
*wl
)
215 TAILQ_FOREACH(wl2
, stack
, sentry
) {
217 TAILQ_REMOVE(stack
, wl
, sentry
);
224 window_index(struct window
*s
, u_int
*i
)
226 for (*i
= 0; *i
< ARRAY_LENGTH(&windows
); (*i
)++) {
227 if (s
== ARRAY_ITEM(&windows
, *i
))
234 window_create1(u_int sx
, u_int sy
)
239 w
= xcalloc(1, sizeof *w
);
243 TAILQ_INIT(&w
->panes
);
247 w
->layout_root
= NULL
;
252 queue_window_name(w
);
254 options_init(&w
->options
, &global_w_options
);
256 for (i
= 0; i
< ARRAY_LENGTH(&windows
); i
++) {
257 if (ARRAY_ITEM(&windows
, i
) == NULL
) {
258 ARRAY_SET(&windows
, i
, w
);
262 if (i
== ARRAY_LENGTH(&windows
))
263 ARRAY_ADD(&windows
, w
);
270 window_create(const char *name
, const char *cmd
, const char *shell
,
271 const char *cwd
, struct environ
*env
, struct termios
*tio
,
272 u_int sx
, u_int sy
, u_int hlimit
,char **cause
)
275 struct window_pane
*wp
;
277 w
= window_create1(sx
, sy
);
278 wp
= window_add_pane(w
, hlimit
);
280 if (window_pane_spawn(wp
, cmd
, shell
, cwd
, env
, tio
, cause
) != 0) {
284 w
->active
= TAILQ_FIRST(&w
->panes
);
286 w
->name
= xstrdup(name
);
287 options_set_number(&w
->options
, "automatic-rename", 0);
289 w
->name
= default_window_name(w
);
294 window_destroy(struct window
*w
)
298 if (window_index(w
, &i
) != 0)
299 fatalx("index not found");
300 ARRAY_SET(&windows
, i
, NULL
);
301 while (!ARRAY_EMPTY(&windows
) && ARRAY_LAST(&windows
) == NULL
)
302 ARRAY_TRUNC(&windows
, 1);
304 if (w
->layout_root
!= NULL
)
307 evtimer_del(&w
->name_timer
);
309 options_free(&w
->options
);
311 window_destroy_panes(w
);
319 window_resize(struct window
*w
, u_int sx
, u_int sy
)
326 window_set_active_pane(struct window
*w
, struct window_pane
*wp
)
329 while (!window_pane_visible(w
->active
)) {
330 w
->active
= TAILQ_PREV(w
->active
, window_panes
, entry
);
331 if (w
->active
== NULL
)
332 w
->active
= TAILQ_LAST(&w
->panes
, window_panes
);
339 window_set_active_at(struct window
*w
, u_int x
, u_int y
)
341 struct window_pane
*wp
;
343 TAILQ_FOREACH(wp
, &w
->panes
, entry
) {
344 if (!window_pane_visible(wp
))
346 if (x
< wp
->xoff
|| x
>= wp
->xoff
+ wp
->sx
)
348 if (y
< wp
->yoff
|| y
>= wp
->yoff
+ wp
->sy
)
350 window_set_active_pane(w
, wp
);
356 window_add_pane(struct window
*w
, u_int hlimit
)
358 struct window_pane
*wp
;
360 wp
= window_pane_create(w
, w
->sx
, w
->sy
, hlimit
);
361 if (TAILQ_EMPTY(&w
->panes
))
362 TAILQ_INSERT_HEAD(&w
->panes
, wp
, entry
);
364 TAILQ_INSERT_AFTER(&w
->panes
, w
->active
, wp
, entry
);
369 window_remove_pane(struct window
*w
, struct window_pane
*wp
)
371 if (wp
== w
->active
) {
372 w
->active
= TAILQ_PREV(wp
, window_panes
, entry
);
373 if (w
->active
== NULL
)
374 w
->active
= TAILQ_NEXT(wp
, entry
);
377 TAILQ_REMOVE(&w
->panes
, wp
, entry
);
378 window_pane_destroy(wp
);
382 window_pane_at_index(struct window
*w
, u_int idx
)
384 struct window_pane
*wp
;
388 TAILQ_FOREACH(wp
, &w
->panes
, entry
) {
397 window_pane_next_by_number(struct window
*w
, struct window_pane
*wp
, u_int n
)
400 if ((wp
= TAILQ_NEXT(wp
, entry
)) == NULL
)
401 wp
= TAILQ_FIRST(&w
->panes
);
408 window_pane_previous_by_number(struct window
*w
, struct window_pane
*wp
,
412 if ((wp
= TAILQ_PREV(wp
, window_panes
, entry
)) == NULL
)
413 wp
= TAILQ_LAST(&w
->panes
, window_panes
);
420 window_pane_index(struct window
*w
, struct window_pane
*wp
)
422 struct window_pane
*wq
;
426 TAILQ_FOREACH(wq
, &w
->panes
, entry
) {
435 window_count_panes(struct window
*w
)
437 struct window_pane
*wp
;
441 TAILQ_FOREACH(wp
, &w
->panes
, entry
)
447 window_destroy_panes(struct window
*w
)
449 struct window_pane
*wp
;
451 while (!TAILQ_EMPTY(&w
->panes
)) {
452 wp
= TAILQ_FIRST(&w
->panes
);
453 TAILQ_REMOVE(&w
->panes
, wp
, entry
);
454 window_pane_destroy(wp
);
459 window_pane_create(struct window
*w
, u_int sx
, u_int sy
, u_int hlimit
)
461 struct window_pane
*wp
;
463 wp
= xcalloc(1, sizeof *wp
);
475 wp
->layout_cell
= NULL
;
485 wp
->pipe_event
= NULL
;
487 wp
->saved_grid
= NULL
;
489 screen_init(&wp
->base
, sx
, sy
, hlimit
);
490 wp
->screen
= &wp
->base
;
498 window_pane_destroy(struct window_pane
*wp
)
500 window_pane_reset_mode(wp
);
504 bufferevent_free(wp
->event
);
509 screen_free(&wp
->base
);
510 if (wp
->saved_grid
!= NULL
)
511 grid_destroy(wp
->saved_grid
);
513 if (wp
->pipe_fd
!= -1) {
515 bufferevent_free(wp
->pipe_event
);
520 if (wp
->shell
!= NULL
)
528 window_pane_spawn(struct window_pane
*wp
, const char *cmd
, const char *shell
,
529 const char *cwd
, struct environ
*env
, struct termios
*tio
, char **cause
)
539 bufferevent_free(wp
->event
);
544 wp
->cmd
= xstrdup(cmd
);
547 if (wp
->shell
!= NULL
)
549 wp
->shell
= xstrdup(shell
);
554 wp
->cwd
= xstrdup(cwd
);
557 memset(&ws
, 0, sizeof ws
);
558 ws
.ws_col
= screen_size_x(&wp
->base
);
559 ws
.ws_row
= screen_size_y(&wp
->base
);
561 switch (wp
->pid
= forkpty(&wp
->fd
, wp
->tty
, NULL
, &ws
)) {
564 xasprintf(cause
, "%s: %s", cmd
, strerror(errno
));
567 if (chdir(wp
->cwd
) != 0)
570 if (tcgetattr(STDIN_FILENO
, &tio2
) != 0)
571 fatal("tcgetattr failed");
573 memcpy(tio2
.c_cc
, tio
->c_cc
, sizeof tio2
.c_cc
);
574 tio2
.c_cc
[VERASE
] = '\177';
575 if (tcsetattr(STDIN_FILENO
, TCSANOW
, &tio2
) != 0)
576 fatal("tcgetattr failed");
578 closefrom(STDERR_FILENO
+ 1);
585 if (*wp
->cmd
!= '\0') {
586 /* Set SHELL but only if it is currently not useful. */
587 shell
= getenv("SHELL");
588 if (shell
== NULL
|| *shell
== '\0' || areshell(shell
))
589 setenv("SHELL", wp
->shell
, 1);
591 execl(_PATH_BSHELL
, "sh", "-c", wp
->cmd
, (char *) NULL
);
592 fatal("execl failed");
595 /* No command; fork a login shell. */
596 ptr
= strrchr(wp
->shell
, '/');
597 if (ptr
!= NULL
&& *(ptr
+ 1) != '\0')
598 xasprintf(&argv0
, "-%s", ptr
+ 1);
600 xasprintf(&argv0
, "-%s", wp
->shell
);
601 setenv("SHELL", wp
->shell
, 1);
602 execl(wp
->shell
, argv0
, (char *) NULL
);
603 fatal("execl failed");
606 if ((mode
= fcntl(wp
->fd
, F_GETFL
)) == -1)
607 fatal("fcntl failed");
608 if (fcntl(wp
->fd
, F_SETFL
, mode
|O_NONBLOCK
) == -1)
609 fatal("fcntl failed");
610 wp
->event
= bufferevent_new(wp
->fd
,
611 window_pane_read_callback
, NULL
, window_pane_error_callback
, wp
);
612 bufferevent_enable(wp
->event
, EV_READ
|EV_WRITE
);
619 window_pane_read_callback(unused
struct bufferevent
*bufev
, void *data
)
621 struct window_pane
*wp
= data
;
625 new_size
= EVBUFFER_LENGTH(wp
->event
->input
) - wp
->pipe_off
;
626 if (wp
->pipe_fd
!= -1 && new_size
> 0) {
627 new_data
= EVBUFFER_DATA(wp
->event
->input
);
628 bufferevent_write(wp
->pipe_event
, new_data
, new_size
);
633 wp
->pipe_off
= EVBUFFER_LENGTH(wp
->event
->input
);
638 window_pane_error_callback(
639 unused
struct bufferevent
*bufev
, unused
short what
, void *data
)
641 struct window_pane
*wp
= data
;
643 server_destroy_pane(wp
);
647 window_pane_resize(struct window_pane
*wp
, u_int sx
, u_int sy
)
651 if (sx
== wp
->sx
&& sy
== wp
->sy
)
656 memset(&ws
, 0, sizeof ws
);
660 screen_resize(&wp
->base
, sx
, sy
);
661 if (wp
->mode
!= NULL
)
662 wp
->mode
->resize(wp
, sx
, sy
);
664 if (wp
->fd
!= -1 && ioctl(wp
->fd
, TIOCSWINSZ
, &ws
) == -1)
665 fatal("ioctl failed");
669 * Enter alternative screen mode. A copy of the visible screen is saved and the
670 * history is not updated
673 window_pane_alternate_on(struct window_pane
*wp
, struct grid_cell
*gc
)
675 struct screen
*s
= &wp
->base
;
678 if (wp
->saved_grid
!= NULL
)
680 if (!options_get_number(&wp
->window
->options
, "alternate-screen"))
682 sx
= screen_size_x(s
);
683 sy
= screen_size_y(s
);
685 wp
->saved_grid
= grid_create(sx
, sy
, 0);
686 grid_duplicate_lines(wp
->saved_grid
, 0, s
->grid
, screen_hsize(s
), sy
);
687 wp
->saved_cx
= s
->cx
;
688 wp
->saved_cy
= s
->cy
;
689 memcpy(&wp
->saved_cell
, gc
, sizeof wp
->saved_cell
);
691 grid_view_clear(s
->grid
, 0, 0, sx
, sy
);
693 wp
->base
.grid
->flags
&= ~GRID_HISTORY
;
695 wp
->flags
|= PANE_REDRAW
;
698 /* Exit alternate screen mode and restore the copied grid. */
700 window_pane_alternate_off(struct window_pane
*wp
, struct grid_cell
*gc
)
702 struct screen
*s
= &wp
->base
;
705 if (wp
->saved_grid
== NULL
)
707 if (!options_get_number(&wp
->window
->options
, "alternate-screen"))
709 sx
= screen_size_x(s
);
710 sy
= screen_size_y(s
);
713 * If the current size is bigger, temporarily resize to the old size
714 * before copying back.
716 if (sy
> wp
->saved_grid
->sy
)
717 screen_resize(s
, sx
, wp
->saved_grid
->sy
);
719 /* Restore the grid, cursor position and cell. */
720 grid_duplicate_lines(s
->grid
, screen_hsize(s
), wp
->saved_grid
, 0, sy
);
721 s
->cx
= wp
->saved_cx
;
722 if (s
->cx
> screen_size_x(s
) - 1)
723 s
->cx
= screen_size_x(s
) - 1;
724 s
->cy
= wp
->saved_cy
;
725 if (s
->cy
> screen_size_y(s
) - 1)
726 s
->cy
= screen_size_y(s
) - 1;
727 memcpy(gc
, &wp
->saved_cell
, sizeof *gc
);
730 * Turn history back on (so resize can use it) and then resize back to
733 wp
->base
.grid
->flags
|= GRID_HISTORY
;
734 if (sy
> wp
->saved_grid
->sy
)
735 screen_resize(s
, sx
, sy
);
737 grid_destroy(wp
->saved_grid
);
738 wp
->saved_grid
= NULL
;
740 wp
->flags
|= PANE_REDRAW
;
744 window_pane_set_mode(struct window_pane
*wp
, const struct window_mode
*mode
)
748 if (wp
->mode
!= NULL
)
752 if ((s
= wp
->mode
->init(wp
)) != NULL
)
754 wp
->flags
|= PANE_REDRAW
;
759 window_pane_reset_mode(struct window_pane
*wp
)
761 if (wp
->mode
== NULL
)
767 wp
->screen
= &wp
->base
;
768 wp
->flags
|= PANE_REDRAW
;
772 window_pane_key(struct window_pane
*wp
, struct session
*sess
, int key
)
774 struct window_pane
*wp2
;
776 if (!window_pane_visible(wp
))
779 if (wp
->mode
!= NULL
) {
780 if (wp
->mode
->key
!= NULL
)
781 wp
->mode
->key(wp
, sess
, key
);
788 if (options_get_number(&wp
->window
->options
, "synchronize-panes")) {
789 TAILQ_FOREACH(wp2
, &wp
->window
->panes
, entry
) {
790 if (wp2
== wp
|| wp2
->mode
!= NULL
)
792 if (wp2
->fd
!= -1 && window_pane_visible(wp2
))
800 struct window_pane
*wp
, struct session
*sess
, struct mouse_event
*m
)
802 if (!window_pane_visible(wp
))
805 if (m
->x
< wp
->xoff
|| m
->x
>= wp
->xoff
+ wp
->sx
)
807 if (m
->y
< wp
->yoff
|| m
->y
>= wp
->yoff
+ wp
->sy
)
812 if (wp
->mode
!= NULL
) {
813 if (wp
->mode
->mouse
!= NULL
)
814 wp
->mode
->mouse(wp
, sess
, m
);
815 } else if (wp
->fd
!= -1)
820 window_pane_visible(struct window_pane
*wp
)
822 struct window
*w
= wp
->window
;
824 if (wp
->xoff
>= w
->sx
|| wp
->yoff
>= w
->sy
)
826 if (wp
->xoff
+ wp
->sx
> w
->sx
|| wp
->yoff
+ wp
->sy
> w
->sy
)
832 window_pane_search(struct window_pane
*wp
, const char *searchstr
, u_int
*lineno
)
834 struct screen
*s
= &wp
->base
;
835 char *newsearchstr
, *line
, *msg
;
839 xasprintf(&newsearchstr
, "*%s*", searchstr
);
841 for (i
= 0; i
< screen_size_y(s
); i
++) {
842 line
= grid_view_string_cells(s
->grid
, 0, i
, screen_size_x(s
));
843 if (fnmatch(newsearchstr
, line
, 0) == 0) {
856 /* Find the pane directly above another. */
858 window_pane_find_up(struct window_pane
*wp
)
860 struct window_pane
*wp2
;
863 if (wp
== NULL
|| !window_pane_visible(wp
))
868 top
= wp
->window
->sy
+ 1;
871 TAILQ_FOREACH(wp2
, &wp
->window
->panes
, entry
) {
872 if (!window_pane_visible(wp2
))
874 if (wp2
->yoff
+ wp2
->sy
+ 1 != top
)
876 if (left
>= wp2
->xoff
&& left
<= wp2
->xoff
+ wp2
->sx
)
882 /* Find the pane directly below another. */
884 window_pane_find_down(struct window_pane
*wp
)
886 struct window_pane
*wp2
;
889 if (wp
== NULL
|| !window_pane_visible(wp
))
892 bottom
= wp
->yoff
+ wp
->sy
+ 1;
893 if (bottom
>= wp
->window
->sy
)
897 TAILQ_FOREACH(wp2
, &wp
->window
->panes
, entry
) {
898 if (!window_pane_visible(wp2
))
900 if (wp2
->yoff
!= bottom
)
902 if (left
>= wp2
->xoff
&& left
<= wp2
->xoff
+ wp2
->sx
)
909 * Find the pane directly to the left of another, adjacent to the left side and
910 * containing the top edge.
913 window_pane_find_left(struct window_pane
*wp
)
915 struct window_pane
*wp2
;
918 if (wp
== NULL
|| !window_pane_visible(wp
))
923 left
= wp
->window
->sx
+ 1;
926 TAILQ_FOREACH(wp2
, &wp
->window
->panes
, entry
) {
927 if (!window_pane_visible(wp2
))
929 if (wp2
->xoff
+ wp2
->sx
+ 1 != left
)
931 if (top
>= wp2
->yoff
&& top
<= wp2
->yoff
+ wp2
->sy
)
938 * Find the pane directly to the right of another, that is adjacent to the
939 * right edge and including the top edge.
942 window_pane_find_right(struct window_pane
*wp
)
944 struct window_pane
*wp2
;
947 if (wp
== NULL
|| !window_pane_visible(wp
))
950 right
= wp
->xoff
+ wp
->sx
+ 1;
951 if (right
>= wp
->window
->sx
)
955 TAILQ_FOREACH(wp2
, &wp
->window
->panes
, entry
) {
956 if (!window_pane_visible(wp2
))
958 if (wp2
->xoff
!= right
)
960 if (top
>= wp2
->yoff
&& top
<= wp2
->yoff
+ wp2
->sy
)