1*122157a0Snicm /* $OpenBSD: cmd-capture-pane.c,v 1.60 2023/09/01 16:40:38 nicm Exp $ */
23373972cSnicm
33373972cSnicm /*
43373972cSnicm * Copyright (c) 2009 Jonathan Alvarado <radobobo@users.sourceforge.net>
53373972cSnicm *
63373972cSnicm * Permission to use, copy, modify, and distribute this software for any
73373972cSnicm * purpose with or without fee is hereby granted, provided that the above
83373972cSnicm * copyright notice and this permission notice appear in all copies.
93373972cSnicm *
103373972cSnicm * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
113373972cSnicm * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
123373972cSnicm * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
133373972cSnicm * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
143373972cSnicm * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
153373972cSnicm * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
163373972cSnicm * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
173373972cSnicm */
183373972cSnicm
193373972cSnicm #include <sys/types.h>
203373972cSnicm
21eca05f1fSnicm #include <stdlib.h>
223373972cSnicm #include <string.h>
233373972cSnicm
243373972cSnicm #include "tmux.h"
253373972cSnicm
263373972cSnicm /*
27e5d62d67Snicm * Write the entire contents of a pane to a buffer or stdout.
283373972cSnicm */
293373972cSnicm
3068e0a7f2Snicm static enum cmd_retval cmd_capture_pane_exec(struct cmd *, struct cmdq_item *);
313373972cSnicm
3268e0a7f2Snicm static char *cmd_capture_pane_append(char *, size_t *, char *, size_t);
3368e0a7f2Snicm static char *cmd_capture_pane_pending(struct args *, struct window_pane *,
3468e0a7f2Snicm size_t *);
3568e0a7f2Snicm static char *cmd_capture_pane_history(struct args *, struct cmdq_item *,
366bf4c3b2Snicm struct window_pane *, size_t *);
376bf4c3b2Snicm
383373972cSnicm const struct cmd_entry cmd_capture_pane_entry = {
39c057646bSnicm .name = "capture-pane",
40c057646bSnicm .alias = "capturep",
41c057646bSnicm
42*122157a0Snicm .args = { "ab:CeE:JNpPqS:Tt:", 0, 0, NULL },
4332b2c715Snicm .usage = "[-aCeJNpPqT] " CMD_BUFFER_USAGE " [-E end-line] "
44c057646bSnicm "[-S start-line] " CMD_TARGET_PANE_USAGE,
45c057646bSnicm
46bf0d297eSnicm .target = { 't', CMD_FIND_PANE, 0 },
478d471e80Snicm
487a61a8ddSnicm .flags = CMD_AFTERHOOK,
49c057646bSnicm .exec = cmd_capture_pane_exec
503373972cSnicm };
513373972cSnicm
52f5f24c95Snicm const struct cmd_entry cmd_clear_history_entry = {
53f5f24c95Snicm .name = "clear-history",
54f5f24c95Snicm .alias = "clearhist",
55f5f24c95Snicm
562df6775cSnicm .args = { "Ht:", 0, 0, NULL },
572df6775cSnicm .usage = "[-H] " CMD_TARGET_PANE_USAGE,
58f5f24c95Snicm
59bf0d297eSnicm .target = { 't', CMD_FIND_PANE, 0 },
60f5f24c95Snicm
61f5f24c95Snicm .flags = CMD_AFTERHOOK,
62f5f24c95Snicm .exec = cmd_capture_pane_exec
63f5f24c95Snicm };
64f5f24c95Snicm
65dc1f0f5fSnicm static char *
cmd_capture_pane_append(char * buf,size_t * len,char * line,size_t linelen)666bf4c3b2Snicm cmd_capture_pane_append(char *buf, size_t *len, char *line, size_t linelen)
673373972cSnicm {
6864cf113cSnicm buf = xrealloc(buf, *len + linelen + 1);
696bf4c3b2Snicm memcpy(buf + *len, line, linelen);
706bf4c3b2Snicm *len += linelen;
716bf4c3b2Snicm return (buf);
7258f59f1fSnicm }
736bf4c3b2Snicm
74dc1f0f5fSnicm static char *
cmd_capture_pane_pending(struct args * args,struct window_pane * wp,size_t * len)756bf4c3b2Snicm cmd_capture_pane_pending(struct args *args, struct window_pane *wp,
766bf4c3b2Snicm size_t *len)
776bf4c3b2Snicm {
786c01012eSnicm struct evbuffer *pending;
796bf4c3b2Snicm char *buf, *line, tmp[5];
806bf4c3b2Snicm size_t linelen;
816bf4c3b2Snicm u_int i;
826bf4c3b2Snicm
8329ebed37Snicm pending = input_pending(wp->ictx);
846c01012eSnicm if (pending == NULL)
856bf4c3b2Snicm return (xstrdup(""));
866bf4c3b2Snicm
876c01012eSnicm line = EVBUFFER_DATA(pending);
886c01012eSnicm linelen = EVBUFFER_LENGTH(pending);
893373972cSnicm
90b43f3fe1Snicm buf = xstrdup("");
916bf4c3b2Snicm if (args_has(args, 'C')) {
926bf4c3b2Snicm for (i = 0; i < linelen; i++) {
93aaf5d87bSnicm if (line[i] >= ' ' && line[i] != '\\') {
946bf4c3b2Snicm tmp[0] = line[i];
956bf4c3b2Snicm tmp[1] = '\0';
966bf4c3b2Snicm } else
97e5f4d2afSnicm xsnprintf(tmp, sizeof tmp, "\\%03hho", line[i]);
986bf4c3b2Snicm buf = cmd_capture_pane_append(buf, len, tmp,
996bf4c3b2Snicm strlen(tmp));
1006bf4c3b2Snicm }
1016bf4c3b2Snicm } else
1026bf4c3b2Snicm buf = cmd_capture_pane_append(buf, len, line, linelen);
1036bf4c3b2Snicm return (buf);
1046bf4c3b2Snicm }
1053373972cSnicm
106dc1f0f5fSnicm static char *
cmd_capture_pane_history(struct args * args,struct cmdq_item * item,struct window_pane * wp,size_t * len)10768e0a7f2Snicm cmd_capture_pane_history(struct args *args, struct cmdq_item *item,
1086bf4c3b2Snicm struct window_pane *wp, size_t *len)
1096bf4c3b2Snicm {
1106bf4c3b2Snicm struct grid *gd;
1116bf4c3b2Snicm const struct grid_line *gl;
1126bf4c3b2Snicm struct grid_cell *gc = NULL;
11332b2c715Snicm int n, join_lines, flags = 0;
1146bf4c3b2Snicm u_int i, sx, top, bottom, tmp;
1156bf4c3b2Snicm char *cause, *buf, *line;
116c1b85bb4Snicm const char *Sflag, *Eflag;
1176bf4c3b2Snicm size_t linelen;
1186bf4c3b2Snicm
1196bf4c3b2Snicm sx = screen_size_x(&wp->base);
1206bf4c3b2Snicm if (args_has(args, 'a')) {
121af550f8bSnicm gd = wp->base.saved_grid;
1226bf4c3b2Snicm if (gd == NULL) {
1236bf4c3b2Snicm if (!args_has(args, 'q')) {
12468e0a7f2Snicm cmdq_error(item, "no alternate screen");
1256bf4c3b2Snicm return (NULL);
1266bf4c3b2Snicm }
1276bf4c3b2Snicm return (xstrdup(""));
1286bf4c3b2Snicm }
1296bf4c3b2Snicm } else
1306bf4c3b2Snicm gd = wp->base.grid;
1316bf4c3b2Snicm
132c1b85bb4Snicm Sflag = args_get(args, 'S');
133c1b85bb4Snicm if (Sflag != NULL && strcmp(Sflag, "-") == 0)
134c1b85bb4Snicm top = 0;
135c1b85bb4Snicm else {
136113211eaSnicm n = args_strtonum_and_expand(args, 'S', INT_MIN, SHRT_MAX,
137113211eaSnicm item, &cause);
138a068d83bSnicm if (cause != NULL) {
1395eb896d2Snicm top = gd->hsize;
1407d053cf9Snicm free(cause);
141a068d83bSnicm } else if (n < 0 && (u_int) -n > gd->hsize)
1425eb896d2Snicm top = 0;
1435eb896d2Snicm else
1445eb896d2Snicm top = gd->hsize + n;
1455eb896d2Snicm if (top > gd->hsize + gd->sy - 1)
1465eb896d2Snicm top = gd->hsize + gd->sy - 1;
147c1b85bb4Snicm }
1485eb896d2Snicm
149c1b85bb4Snicm Eflag = args_get(args, 'E');
150c1b85bb4Snicm if (Eflag != NULL && strcmp(Eflag, "-") == 0)
151c1b85bb4Snicm bottom = gd->hsize + gd->sy - 1;
152c1b85bb4Snicm else {
153113211eaSnicm n = args_strtonum_and_expand(args, 'E', INT_MIN, SHRT_MAX,
154113211eaSnicm item, &cause);
155a068d83bSnicm if (cause != NULL) {
1565eb896d2Snicm bottom = gd->hsize + gd->sy - 1;
1577d053cf9Snicm free(cause);
158a068d83bSnicm } else if (n < 0 && (u_int) -n > gd->hsize)
1595eb896d2Snicm bottom = 0;
1605eb896d2Snicm else
1615eb896d2Snicm bottom = gd->hsize + n;
1625eb896d2Snicm if (bottom > gd->hsize + gd->sy - 1)
1635eb896d2Snicm bottom = gd->hsize + gd->sy - 1;
164c1b85bb4Snicm }
1655eb896d2Snicm
1665eb896d2Snicm if (bottom < top) {
1675eb896d2Snicm tmp = bottom;
1685eb896d2Snicm bottom = top;
1695eb896d2Snicm top = tmp;
1705eb896d2Snicm }
1715eb896d2Snicm
172e5d24057Snicm join_lines = args_has(args, 'J');
17332b2c715Snicm if (args_has(args, 'e'))
17432b2c715Snicm flags |= GRID_STRING_WITH_SEQUENCES;
17532b2c715Snicm if (args_has(args, 'C'))
17632b2c715Snicm flags |= GRID_STRING_ESCAPE_SEQUENCES;
17732b2c715Snicm if (!join_lines && !args_has(args, 'T'))
17832b2c715Snicm flags |= GRID_STRING_EMPTY_CELLS;
17932b2c715Snicm if (!join_lines && !args_has(args, 'N'))
18032b2c715Snicm flags |= GRID_STRING_TRIM_SPACES;
181e5d24057Snicm
1826bf4c3b2Snicm buf = NULL;
1835eb896d2Snicm for (i = top; i <= bottom; i++) {
18432b2c715Snicm line = grid_string_cells(gd, 0, i, sx, &gc, flags, wp->screen);
1853373972cSnicm linelen = strlen(line);
1863373972cSnicm
1876bf4c3b2Snicm buf = cmd_capture_pane_append(buf, len, line, linelen);
188e5d24057Snicm
18958f59f1fSnicm gl = grid_peek_line(gd, i);
190e5d24057Snicm if (!join_lines || !(gl->flags & GRID_LINE_WRAPPED))
1916bf4c3b2Snicm buf[(*len)++] = '\n';
1923bc087d8Snicm
1937d053cf9Snicm free(line);
1943373972cSnicm }
1956bf4c3b2Snicm return (buf);
1966bf4c3b2Snicm }
1976bf4c3b2Snicm
198dc1f0f5fSnicm static enum cmd_retval
cmd_capture_pane_exec(struct cmd * self,struct cmdq_item * item)19968e0a7f2Snicm cmd_capture_pane_exec(struct cmd *self, struct cmdq_item *item)
2006bf4c3b2Snicm {
20190d7ba38Snicm struct args *args = cmd_get_args(self);
202040343aeSnicm struct client *c = cmdq_get_client(item);
203040343aeSnicm struct window_pane *wp = cmdq_get_target(item)->wp;
2046bf4c3b2Snicm char *buf, *cause;
205a41fa27aSnicm const char *bufname;
2066bf4c3b2Snicm size_t len;
2076bf4c3b2Snicm
20890d7ba38Snicm if (cmd_get_entry(self) == &cmd_clear_history_entry) {
2092c8678f7Snicm window_pane_reset_mode_all(wp);
210f5f24c95Snicm grid_clear_history(wp->base.grid);
2112df6775cSnicm if (args_has(args, 'H'))
2122df6775cSnicm screen_reset_hyperlinks(wp->screen);
213f5f24c95Snicm return (CMD_RETURN_NORMAL);
214f5f24c95Snicm }
215f5f24c95Snicm
2166bf4c3b2Snicm len = 0;
2176bf4c3b2Snicm if (args_has(args, 'P'))
2186bf4c3b2Snicm buf = cmd_capture_pane_pending(args, wp, &len);
2196bf4c3b2Snicm else
22068e0a7f2Snicm buf = cmd_capture_pane_history(args, item, wp, &len);
2216bf4c3b2Snicm if (buf == NULL)
2226bf4c3b2Snicm return (CMD_RETURN_ERROR);
2233373972cSnicm
224e5d62d67Snicm if (args_has(args, 'p')) {
225a34cf9c8Snicm if (len > 0 && buf[len - 1] == '\n')
226a34cf9c8Snicm len--;
227a34cf9c8Snicm if (c->flags & CLIENT_CONTROL)
228a34cf9c8Snicm control_write(c, "%.*s", (int)len, buf);
229a34cf9c8Snicm else {
230f4bc7c7aSnicm if (!file_can_print(c)) {
231a34cf9c8Snicm cmdq_error(item, "can't write to client");
232ea4ee0e0Snicm free(buf);
233e5d62d67Snicm return (CMD_RETURN_ERROR);
234e5d62d67Snicm }
235f4bc7c7aSnicm file_print_buffer(c, buf, len);
236f4bc7c7aSnicm file_print(c, "\n");
237f4bc7c7aSnicm free(buf);
238a34cf9c8Snicm }
239e5d62d67Snicm } else {
240a41fa27aSnicm bufname = NULL;
241a41fa27aSnicm if (args_has(args, 'b'))
242a41fa27aSnicm bufname = args_get(args, 'b');
243a41fa27aSnicm
244a41fa27aSnicm if (paste_set(buf, len, bufname, &cause) != 0) {
24568e0a7f2Snicm cmdq_error(item, "%s", cause);
2467d053cf9Snicm free(cause);
247ea4ee0e0Snicm free(buf);
248a224d0d3Snicm return (CMD_RETURN_ERROR);
249ca7befccSnicm }
250e5d62d67Snicm }
251ca7befccSnicm
252a224d0d3Snicm return (CMD_RETURN_NORMAL);
2533373972cSnicm }
254