From 6091b051fbf0a19ee9108b235b37265461727a41 Mon Sep 17 00:00:00 2001 From: Tiago Cunha Date: Mon, 12 Oct 2009 00:35:08 +0000 Subject: [PATCH] Sync OpenBSD patchset 387: Add a pipe-pane command to allow a pane to be piped to a shell command, for example: pipe-pane 'cat >~/out' No arguments stops outputing and closes the pipe; the -o flag toggles a pipe and on and off (useful for key bindings). Suggested by espie@. --- cmd-pipe-pane.c | 127 ++++++++++++++++++++++++++++++++++++++++++++++++ cmd.c | 3 +- server.c | 19 +++++++- tmux.1 | 26 +++++++++- tmux.h | 7 ++- window.c | 19 +++++++- 6 files changed, 196 insertions(+), 5 deletions(-) create mode 100644 cmd-pipe-pane.c diff --git a/cmd-pipe-pane.c b/cmd-pipe-pane.c new file mode 100644 index 00000000..d92dce95 --- /dev/null +++ b/cmd-pipe-pane.c @@ -0,0 +1,127 @@ +/* $Id: cmd-pipe-pane.c,v 1.1 2009-10-12 00:35:08 tcunha Exp $ */ + +/* + * Copyright (c) 2009 Nicholas Marriott + * + * Permission to use, copy, modify, and distribute this software for any + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. + * + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER + * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING + * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + */ + +#include + +#include +#include +#include +#include +#include + +#include "tmux.h" + +/* + * Open pipe to redirect pane output. If already open, close first. + */ + +int cmd_pipe_pane_exec(struct cmd *, struct cmd_ctx *); + +const struct cmd_entry cmd_pipe_pane_entry = { + "pipe-pane", "pipep", + CMD_TARGET_PANE_USAGE "[-o] [command]", + CMD_ARG01, CMD_CHFLAG('o'), + cmd_target_init, + cmd_target_parse, + cmd_pipe_pane_exec, + cmd_target_free, + cmd_target_print +}; + +int +cmd_pipe_pane_exec(struct cmd *self, struct cmd_ctx *ctx) +{ + struct cmd_target_data *data = self->data; + struct winlink *wl; + struct window_pane *wp; + int old_fd, pipe_fd[2], null_fd, mode; + + if ((wl = cmd_find_pane(ctx, data->target, NULL, &wp)) == NULL) + return (-1); + + /* Destroy the old pipe. */ + old_fd = wp->pipe_fd; + if (wp->pipe_fd != -1) { + buffer_destroy(wp->pipe_buf); + close(wp->pipe_fd); + wp->pipe_fd = -1; + } + + /* If no pipe command, that is enough. */ + if (data->arg == NULL || *data->arg == '\0') + return (0); + + /* + * With -o, only open the new pipe if there was no previous one. This + * allows a pipe to be toggled with a single key, for example: + * + * bind ^p pipep -o 'cat >>~/output' + */ + if (data->chflags & CMD_CHFLAG('o') && old_fd != -1) + return (0); + + /* Open the new pipe. */ + if (pipe(pipe_fd) != 0) { + ctx->error(ctx, "pipe error: %s", strerror(errno)); + return (-1); + } + + /* Fork the child. */ + switch (fork()) { + case -1: + ctx->error(ctx, "fork error: %s", strerror(errno)); + return (-1); + case 0: + /* Child process. */ + close(pipe_fd[0]); + sigreset(); + + if (dup2(pipe_fd[1], STDIN_FILENO) == -1) + _exit(1); + if (pipe_fd[1] != STDIN_FILENO) + close(pipe_fd[1]); + + null_fd = open(_PATH_DEVNULL, O_WRONLY, 0); + if (dup2(null_fd, STDOUT_FILENO) == -1) + _exit(1); + if (dup2(null_fd, STDERR_FILENO) == -1) + _exit(1); + if (null_fd != STDOUT_FILENO && null_fd != STDERR_FILENO) + close(null_fd); + + execl(_PATH_BSHELL, "sh", "-c", data->arg, (char *) NULL); + _exit(1); + default: + /* Parent process. */ + close(pipe_fd[1]); + + wp->pipe_fd = pipe_fd[0]; + wp->pipe_buf = buffer_create(BUFSIZ); + wp->pipe_off = BUFFER_USED(wp->in); + + if ((mode = fcntl(wp->pipe_fd, F_GETFL)) == -1) + fatal("fcntl failed"); + if (fcntl(wp->pipe_fd, F_SETFL, mode|O_NONBLOCK) == -1) + fatal("fcntl failed"); + if (fcntl(wp->pipe_fd, F_SETFD, FD_CLOEXEC) == -1) + fatal("fcntl failed"); + return (0); + } + + return (0); +} diff --git a/cmd.c b/cmd.c index 3d970ee1..a97e64d7 100644 --- a/cmd.c +++ b/cmd.c @@ -1,4 +1,4 @@ -/* $Id: cmd.c,v 1.122 2009-10-12 00:08:12 tcunha Exp $ */ +/* $Id: cmd.c,v 1.123 2009-10-12 00:35:08 tcunha Exp $ */ /* * Copyright (c) 2007 Nicholas Marriott @@ -70,6 +70,7 @@ const struct cmd_entry *cmd_table[] = { &cmd_next_layout_entry, &cmd_next_window_entry, &cmd_paste_buffer_entry, + &cmd_pipe_pane_entry, &cmd_previous_layout_entry, &cmd_previous_window_entry, &cmd_refresh_client_entry, diff --git a/server.c b/server.c index 27ad3d34..0f9a0f4d 100644 --- a/server.c +++ b/server.c @@ -1,4 +1,4 @@ -/* $Id: server.c,v 1.205 2009-10-12 00:25:25 tcunha Exp $ */ +/* $Id: server.c,v 1.206 2009-10-12 00:35:08 tcunha Exp $ */ /* * Copyright (c) 2007 Nicholas Marriott @@ -575,6 +575,13 @@ server_fill_windows(void) if (BUFFER_USED(wp->out) > 0) events |= POLLOUT; server_poll_add(wp->fd, events); + + if (wp->pipe_fd == -1) + continue; + events = 0; + if (BUFFER_USED(wp->pipe_buf) > 0) + events |= POLLOUT; + server_poll_add(wp->pipe_fd, events); } } } @@ -603,6 +610,16 @@ server_handle_windows(void) wp->fd = -1; } else server_handle_window(w, wp); + + if (wp->pipe_fd == -1) + continue; + if ((pfd = server_poll_lookup(wp->pipe_fd)) == NULL) + continue; + if (buffer_poll(pfd, NULL, wp->pipe_buf) != 0) { + buffer_destroy(wp->pipe_buf); + close(wp->pipe_fd); + wp->pipe_fd = -1; + } } server_check_window(w); diff --git a/tmux.1 b/tmux.1 index 60450e9a..eeda97d4 100644 --- a/tmux.1 +++ b/tmux.1 @@ -1,4 +1,4 @@ -.\" $Id: tmux.1,v 1.188 2009-10-12 00:25:25 tcunha Exp $ +.\" $Id: tmux.1,v 1.189 2009-10-12 00:35:08 tcunha Exp $ .\" .\" Copyright (c) 2007 Nicholas Marriott .\" @@ -840,6 +840,30 @@ Move to the next window in the session. If .Fl a is used, move to the next window with a bell, activity or content alert. +.It Xo Ic pipe-pane +.Op Fl o +.Op Fl t Ar target-pane +.Op Ar command +.Xc +.D1 (alias: Ic pipep ) +Pipe any output sent by the program in +.Ar target-pane +to a shell command. +A pane may only be piped to one command at a time, any existing pipe is +closed before +.Ar command +is executed. +If no +.Ar command +is given, the current pipe (if any) is closed. +.Pp +The +.Fl o +option only opens a new pipe if no previous pipe exists, allowing a pipe to +be toggled with a single key, for example: +.Bd -literal -offset indent +bind-key C-p pipe-pane -o 'cat >>~/output' +.Ed .It Xo Ic previous-window .Op Fl a .Op Fl t Ar target-session diff --git a/tmux.h b/tmux.h index 276c2808..dbd84849 100644 --- a/tmux.h +++ b/tmux.h @@ -1,4 +1,4 @@ -/* $Id: tmux.h,v 1.468 2009-10-12 00:21:08 tcunha Exp $ */ +/* $Id: tmux.h,v 1.469 2009-10-12 00:35:08 tcunha Exp $ */ /* * Copyright (c) 2007 Nicholas Marriott @@ -713,6 +713,10 @@ struct window_pane { struct input_ctx ictx; + int pipe_fd; + struct buffer *pipe_buf; + size_t pipe_off; + struct screen *screen; struct screen base; @@ -1392,6 +1396,7 @@ extern const struct cmd_entry cmd_new_window_entry; extern const struct cmd_entry cmd_next_layout_entry; extern const struct cmd_entry cmd_next_window_entry; extern const struct cmd_entry cmd_paste_buffer_entry; +extern const struct cmd_entry cmd_pipe_pane_entry; extern const struct cmd_entry cmd_previous_layout_entry; extern const struct cmd_entry cmd_previous_window_entry; extern const struct cmd_entry cmd_refresh_client_entry; diff --git a/window.c b/window.c index 29960994..02a3ea21 100644 --- a/window.c +++ b/window.c @@ -1,4 +1,4 @@ -/* $Id: window.c,v 1.114 2009-10-12 00:18:19 tcunha Exp $ */ +/* $Id: window.c,v 1.115 2009-10-12 00:35:08 tcunha Exp $ */ /* * Copyright (c) 2007 Nicholas Marriott @@ -423,6 +423,10 @@ window_pane_create(struct window *w, u_int sx, u_int sy, u_int hlimit) wp->sx = sx; wp->sy = sy; + wp->pipe_fd = -1; + wp->pipe_buf = NULL; + wp->pipe_off = 0; + wp->saved_grid = NULL; screen_init(&wp->base, sx, sy, hlimit); @@ -446,6 +450,11 @@ window_pane_destroy(struct window_pane *wp) if (wp->saved_grid != NULL) grid_destroy(wp->saved_grid); + if (wp->pipe_fd != -1) { + buffer_destroy(wp->pipe_buf); + close(wp->pipe_fd); + } + buffer_destroy(wp->in); buffer_destroy(wp->out); @@ -628,7 +637,15 @@ window_pane_reset_mode(struct window_pane *wp) void window_pane_parse(struct window_pane *wp) { + size_t new_size; + + new_size = BUFFER_USED(wp->in) - wp->pipe_off; + if (wp->pipe_fd != -1 && new_size > 0) + buffer_write(wp->pipe_buf, BUFFER_OUT(wp->in), new_size); + input_parse(wp); + + wp->pipe_off = BUFFER_USED(wp->in); } void