4 * Copyright (c) 2011 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>
33 * Build a list of key-value pairs and use them to expand #{key} entries in a
37 int format_replace(struct format_tree
*, const char *, size_t, char **,
39 char *format_get_command(struct window_pane
*);
40 void format_window_pane_tabs(struct format_tree
*, struct window_pane
*);
42 /* Format key-value replacement entry. */
43 RB_GENERATE(format_tree
, format_entry
, entry
, format_cmp
);
45 /* Format tree comparison function. */
47 format_cmp(struct format_entry
*fe1
, struct format_entry
*fe2
)
49 return (strcmp(fe1
->key
, fe2
->key
));
52 /* Single-character uppercase aliases. */
53 const char *format_upper
[] = {
59 "window_flags", /* F */
62 "window_index", /* I */
72 "session_name", /* S */
76 "window_name", /* W */
82 /* Single-character lowercase aliases. */
83 const char *format_lower
[] = {
112 /* Create a new tree. */
116 struct format_tree
*ft
;
117 char host
[MAXHOSTNAMELEN
], *ptr
;
119 ft
= xmalloc(sizeof *ft
);
122 if (gethostname(host
, sizeof host
) == 0) {
123 format_add(ft
, "host", "%s", host
);
124 if ((ptr
= strchr(host
, '.')) != NULL
)
126 format_add(ft
, "host_short", "%s", host
);
134 format_free(struct format_tree
*ft
)
136 struct format_entry
*fe
, *fe_next
;
138 fe_next
= RB_MIN(format_tree
, ft
);
139 while (fe_next
!= NULL
) {
141 fe_next
= RB_NEXT(format_tree
, ft
, fe
);
143 RB_REMOVE(format_tree
, ft
, fe
);
152 /* Add a key-value pair. */
154 format_add(struct format_tree
*ft
, const char *key
, const char *fmt
, ...)
156 struct format_entry
*fe
;
157 struct format_entry
*fe_now
;
160 fe
= xmalloc(sizeof *fe
);
161 fe
->key
= xstrdup(key
);
164 xvasprintf(&fe
->value
, fmt
, ap
);
167 fe_now
= RB_INSERT(format_tree
, ft
, fe
);
168 if (fe_now
!= NULL
) {
170 fe_now
->value
= fe
->value
;
176 /* Find a format entry. */
178 format_find(struct format_tree
*ft
, const char *key
)
180 struct format_entry
*fe
, fe_find
;
182 fe_find
.key
= (char *) key
;
183 fe
= RB_FIND(format_tree
, ft
, &fe_find
);
190 * Replace a key/value pair in buffer. #{blah} is expanded directly,
191 * #{?blah,a,b} is replace with a if blah exists and is nonzero else b.
194 format_replace(struct format_tree
*ft
, const char *key
, size_t keylen
,
195 char **buf
, size_t *len
, size_t *off
)
197 char *copy
, *copy0
, *endptr
, *ptr
, *saved
;
200 u_long limit
= ULONG_MAX
;
202 /* Make a copy of the key. */
203 copy0
= copy
= xmalloc(keylen
+ 1);
204 memcpy(copy
, key
, keylen
);
207 /* Is there a length limit or whatnot? */
208 if (!islower((u_char
) *copy
) && *copy
!= '?') {
209 while (*copy
!= ':' && *copy
!= '\0') {
213 limit
= strtoul(copy
+ 1, &endptr
, 10);
214 if (errno
== ERANGE
&& limit
== ULONG_MAX
)
229 * Is this a conditional? If so, check it exists and extract either the
230 * first or second element. If not, look up the key directly.
233 ptr
= strchr(copy
, ',');
238 value
= format_find(ft
, copy
+ 1);
239 if (value
!= NULL
&& (value
[0] != '0' || value
[1] != '\0')) {
241 ptr
= strchr(value
, ',');
246 ptr
= strchr(ptr
+ 1, ',');
251 saved
= format_expand(ft
, value
);
254 value
= format_find(ft
, copy
);
259 valuelen
= strlen(value
);
261 /* Truncate the value if needed. */
262 if (valuelen
> limit
)
265 /* Expand the buffer and copy in the value. */
266 while (*len
- *off
< valuelen
+ 1) {
267 *buf
= xrealloc(*buf
, 2, *len
);
270 memcpy(*buf
+ *off
, value
, valuelen
);
282 /* Expand keys in a template. */
284 format_expand(struct format_tree
*ft
, const char *fmt
)
295 while (*fmt
!= '\0') {
297 while (len
- off
< 2) {
298 buf
= xrealloc(buf
, 2, len
);
306 ch
= (u_char
) *fmt
++;
310 for (ptr
= fmt
; *ptr
!= '\0'; ptr
++) {
313 if (*ptr
== '}' && --brackets
== 0)
316 if (*ptr
!= '}' || brackets
!= 0)
320 if (format_replace(ft
, fmt
, n
, &buf
, &len
, &off
) != 0)
326 if (ch
>= 'A' && ch
<= 'Z')
327 s
= format_upper
[ch
- 'A'];
328 else if (ch
>= 'a' && ch
<= 'z')
329 s
= format_lower
[ch
- 'a'];
331 while (len
- off
< 3) {
332 buf
= xrealloc(buf
, 2, len
);
340 if (format_replace(ft
, s
, n
, &buf
, &len
, &off
) != 0)
352 /* Get command name for format. */
354 format_get_command(struct window_pane
*wp
)
358 cmd
= get_proc_name(wp
->fd
, wp
->tty
);
359 if (cmd
== NULL
|| *cmd
== '\0') {
361 if (cmd
== NULL
|| *cmd
== '\0')
364 out
= parse_window_name(cmd
);
369 /* Set default format keys for a session. */
371 format_session(struct format_tree
*ft
, struct session
*s
)
373 struct session_group
*sg
;
377 format_add(ft
, "session_name", "%s", s
->name
);
378 format_add(ft
, "session_windows", "%u", winlink_count(&s
->windows
));
379 format_add(ft
, "session_width", "%u", s
->sx
);
380 format_add(ft
, "session_height", "%u", s
->sy
);
381 format_add(ft
, "session_id", "$%u", s
->id
);
383 sg
= session_group_find(s
);
384 format_add(ft
, "session_grouped", "%d", sg
!= NULL
);
386 format_add(ft
, "session_group", "%u", session_group_index(sg
));
388 t
= s
->creation_time
.tv_sec
;
389 format_add(ft
, "session_created", "%lld", (long long) t
);
391 *strchr(tim
, '\n') = '\0';
392 format_add(ft
, "session_created_string", "%s", tim
);
394 if (s
->flags
& SESSION_UNATTACHED
)
395 format_add(ft
, "session_attached", "%d", 0);
397 format_add(ft
, "session_attached", "%d", 1);
400 /* Set default format keys for a client. */
402 format_client(struct format_tree
*ft
, struct client
*c
)
408 format_add(ft
, "client_height", "%u", c
->tty
.sy
);
409 format_add(ft
, "client_width", "%u", c
->tty
.sx
);
410 if (c
->tty
.path
!= NULL
)
411 format_add(ft
, "client_tty", "%s", c
->tty
.path
);
412 if (c
->tty
.termname
!= NULL
)
413 format_add(ft
, "client_termname", "%s", c
->tty
.termname
);
415 t
= c
->creation_time
.tv_sec
;
416 format_add(ft
, "client_created", "%lld", (long long) t
);
418 *strchr(tim
, '\n') = '\0';
419 format_add(ft
, "client_created_string", "%s", tim
);
421 t
= c
->activity_time
.tv_sec
;
422 format_add(ft
, "client_activity", "%lld", (long long) t
);
424 *strchr(tim
, '\n') = '\0';
425 format_add(ft
, "client_activity_string", "%s", tim
);
427 format_add(ft
, "client_prefix", "%d", !!(c
->flags
& CLIENT_PREFIX
));
429 if (c
->tty
.flags
& TTY_UTF8
)
430 format_add(ft
, "client_utf8", "%d", 1);
432 format_add(ft
, "client_utf8", "%d", 0);
434 if (c
->flags
& CLIENT_READONLY
)
435 format_add(ft
, "client_readonly", "%d", 1);
437 format_add(ft
, "client_readonly", "%d", 0);
441 format_add(ft
, "client_session", "%s", s
->name
);
443 if (s
!= NULL
&& session_alive(s
))
444 format_add(ft
, "client_last_session", "%s", s
->name
);
447 /* Set default format keys for a window. */
449 format_window(struct format_tree
*ft
, struct window
*w
)
453 layout
= layout_dump(w
);
455 format_add(ft
, "window_id", "@%u", w
->id
);
456 format_add(ft
, "window_name", "%s", w
->name
);
457 format_add(ft
, "window_width", "%u", w
->sx
);
458 format_add(ft
, "window_height", "%u", w
->sy
);
459 format_add(ft
, "window_layout", "%s", layout
);
460 format_add(ft
, "window_panes", "%u", window_count_panes(w
));
465 /* Set default format keys for a winlink. */
467 format_winlink(struct format_tree
*ft
, struct session
*s
, struct winlink
*wl
)
469 struct window
*w
= wl
->window
;
472 flags
= window_printable_flags(s
, wl
);
474 format_window(ft
, w
);
476 format_add(ft
, "window_index", "%d", wl
->idx
);
477 format_add(ft
, "window_flags", "%s", flags
);
478 format_add(ft
, "window_active", "%d", wl
== s
->curw
);
480 format_add(ft
, "window_bell_flag", "%u",
481 !!(wl
->flags
& WINLINK_BELL
));
482 format_add(ft
, "window_content_flag", "%u",
483 !!(wl
->flags
& WINLINK_CONTENT
));
484 format_add(ft
, "window_activity_flag", "%u",
485 !!(wl
->flags
& WINLINK_ACTIVITY
));
486 format_add(ft
, "window_silence_flag", "%u",
487 !!(wl
->flags
& WINLINK_SILENCE
));
493 /* Add window pane tabs. */
495 format_window_pane_tabs(struct format_tree
*ft
, struct window_pane
*wp
)
497 struct evbuffer
*buffer
;
500 buffer
= evbuffer_new();
501 for (i
= 0; i
< wp
->base
.grid
->sx
; i
++) {
502 if (!bit_test(wp
->base
.tabs
, i
))
505 if (EVBUFFER_LENGTH(buffer
) > 0)
506 evbuffer_add(buffer
, ",", 1);
507 evbuffer_add_printf(buffer
, "%d", i
);
510 format_add(ft
, "pane_tabs", "%.*s", (int) EVBUFFER_LENGTH(buffer
),
511 EVBUFFER_DATA(buffer
));
512 evbuffer_free(buffer
);
515 /* Set default format keys for a window pane. */
517 format_window_pane(struct format_tree
*ft
, struct window_pane
*wp
)
519 struct grid
*gd
= wp
->base
.grid
;
520 struct grid_line
*gl
;
521 unsigned long long size
;
526 for (i
= 0; i
< gd
->hsize
; i
++) {
527 gl
= &gd
->linedata
[i
];
528 size
+= gl
->cellsize
* sizeof *gl
->celldata
;
530 size
+= gd
->hsize
* sizeof *gd
->linedata
;
531 format_add(ft
, "history_size", "%u", gd
->hsize
);
532 format_add(ft
, "history_limit", "%u", gd
->hlimit
);
533 format_add(ft
, "history_bytes", "%llu", size
);
535 if (window_pane_index(wp
, &idx
) != 0)
536 fatalx("index not found");
537 format_add(ft
, "pane_index", "%u", idx
);
539 format_add(ft
, "pane_width", "%u", wp
->sx
);
540 format_add(ft
, "pane_height", "%u", wp
->sy
);
541 format_add(ft
, "pane_title", "%s", wp
->base
.title
);
542 format_add(ft
, "pane_id", "%%%u", wp
->id
);
543 format_add(ft
, "pane_active", "%d", wp
== wp
->window
->active
);
544 format_add(ft
, "pane_dead", "%d", wp
->fd
== -1);
546 format_add(ft
, "pane_in_mode", "%d", wp
->screen
!= &wp
->base
);
547 format_add(ft
, "pane_synchronized", "%d",
548 !!options_get_number(&wp
->window
->options
, "synchronize-panes"));
551 format_add(ft
, "pane_tty", "%s", wp
->tty
);
552 format_add(ft
, "pane_pid", "%ld", (long) wp
->pid
);
554 format_add(ft
, "pane_start_command", "%s", wp
->cmd
);
555 if ((cmd
= format_get_command(wp
)) != NULL
) {
556 format_add(ft
, "pane_current_command", "%s", cmd
);
560 format_add(ft
, "cursor_x", "%d", wp
->base
.cx
);
561 format_add(ft
, "cursor_y", "%d", wp
->base
.cy
);
562 format_add(ft
, "scroll_region_upper", "%d", wp
->base
.rupper
);
563 format_add(ft
, "scroll_region_lower", "%d", wp
->base
.rlower
);
564 format_add(ft
, "saved_cursor_x", "%d", wp
->ictx
.old_cx
);
565 format_add(ft
, "saved_cursor_y", "%d", wp
->ictx
.old_cy
);
567 format_add(ft
, "alternate_on", "%d", wp
->saved_grid
? 1 : 0);
568 format_add(ft
, "alternate_saved_x", "%d", wp
->saved_cx
);
569 format_add(ft
, "alternate_saved_y", "%d", wp
->saved_cy
);
571 format_add(ft
, "cursor_flag", "%d",
572 !!(wp
->base
.mode
& MODE_CURSOR
));
573 format_add(ft
, "insert_flag", "%d",
574 !!(wp
->base
.mode
& MODE_INSERT
));
575 format_add(ft
, "keypad_cursor_flag", "%d",
576 !!(wp
->base
.mode
& MODE_KCURSOR
));
577 format_add(ft
, "keypad_flag", "%d",
578 !!(wp
->base
.mode
& MODE_KKEYPAD
));
579 format_add(ft
, "wrap_flag", "%d",
580 !!(wp
->base
.mode
& MODE_WRAP
));
582 format_add(ft
, "mouse_standard_flag", "%d",
583 !!(wp
->base
.mode
& MODE_MOUSE_STANDARD
));
584 format_add(ft
, "mouse_button_flag", "%d",
585 !!(wp
->base
.mode
& MODE_MOUSE_BUTTON
));
586 format_add(ft
, "mouse_any_flag", "%d",
587 !!(wp
->base
.mode
& MODE_MOUSE_ANY
));
588 format_add(ft
, "mouse_utf8_flag", "%d",
589 !!(wp
->base
.mode
& MODE_MOUSE_UTF8
));
591 format_window_pane_tabs(ft
, wp
);
594 /* Set default format keys for paste buffer. */
596 format_paste_buffer(struct format_tree
*ft
, struct paste_buffer
*pb
)
598 char *pb_print
= paste_print(pb
, 50);
600 format_add(ft
, "buffer_size", "%zu", pb
->size
);
601 format_add(ft
, "buffer_sample", "%s", pb_print
);