xref: /openbsd-src/usr.bin/tmux/cmd-list-clients.c (revision f84b1df5a16cdd762c93854218de246e79975d3b)
1 /* $OpenBSD: cmd-list-clients.c,v 1.39 2022/03/08 11:28:40 nicm Exp $ */
2 
3 /*
4  * Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
5  *
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.
9  *
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.
17  */
18 
19 #include <sys/types.h>
20 
21 #include <stdlib.h>
22 #include <string.h>
23 #include <time.h>
24 
25 #include "tmux.h"
26 
27 /*
28  * List all clients.
29  */
30 
31 #define LIST_CLIENTS_TEMPLATE						\
32 	"#{client_name}: #{session_name} "				\
33 	"[#{client_width}x#{client_height} #{client_termname}] "	\
34 	"#{?#{!=:#{client_uid},#{uid}},"				\
35 	"[user #{?client_user,#{client_user},#{client_uid},}] ,}"	\
36 	"#{?client_flags,(,}#{client_flags}#{?client_flags,),}"
37 
38 static enum cmd_retval	cmd_list_clients_exec(struct cmd *, struct cmdq_item *);
39 
40 const struct cmd_entry cmd_list_clients_entry = {
41 	.name = "list-clients",
42 	.alias = "lsc",
43 
44 	.args = { "F:t:", 0, 0, NULL },
45 	.usage = "[-F format] " CMD_TARGET_SESSION_USAGE,
46 
47 	.target = { 't', CMD_FIND_SESSION, 0 },
48 
49 	.flags = CMD_READONLY|CMD_AFTERHOOK,
50 	.exec = cmd_list_clients_exec
51 };
52 
53 static enum cmd_retval
54 cmd_list_clients_exec(struct cmd *self, struct cmdq_item *item)
55 {
56 	struct args 		*args = cmd_get_args(self);
57 	struct cmd_find_state	*target = cmdq_get_target(item);
58 	struct client		*c;
59 	struct session		*s;
60 	struct format_tree	*ft;
61 	const char		*template;
62 	u_int			 idx;
63 	char			*line;
64 
65 	if (args_has(args, 't'))
66 		s = target->s;
67 	else
68 		s = NULL;
69 
70 	if ((template = args_get(args, 'F')) == NULL)
71 		template = LIST_CLIENTS_TEMPLATE;
72 
73 	idx = 0;
74 	TAILQ_FOREACH(c, &clients, entry) {
75 		if (c->session == NULL || (s != NULL && s != c->session))
76 			continue;
77 
78 		ft = format_create(cmdq_get_client(item), item, FORMAT_NONE, 0);
79 		format_add(ft, "line", "%u", idx);
80 		format_defaults(ft, c, NULL, NULL, NULL);
81 
82 		line = format_expand(ft, template);
83 		cmdq_print(item, "%s", line);
84 		free(line);
85 
86 		format_free(ft);
87 
88 		idx++;
89 	}
90 
91 	return (CMD_RETURN_NORMAL);
92 }
93