2 * vim:ts=4:sw=4:expandtab
4 * i3bar - an xcb-based status- and ws-bar for i3
5 * © 2010 Axel Wagner and contributors (see also: LICENSE)
7 * ipc.c: Communicating with i3
18 #include <sys/socket.h>
22 #ifdef I3_ASAN_ENABLED
23 #include <sanitizer/lsan_interface.h>
28 const char *sock_path;
30 typedef void (*handler_t)(char *);
33 * Called, when we get a reply to a command from i3.
34 * Since i3 does not give us much feedback on commands, we do not much
37 void got_command_reply(char *reply) {
38 /* TODO: Error handling for command replies */
42 * Called, when we get a reply with workspaces data
45 void got_workspace_reply(char *reply) {
46 DLOG("Got workspace data!\n");
47 parse_workspaces_json(reply);
52 * Called, when we get a reply for a subscription.
53 * Since i3 does not give us much feedback on commands, we do not much
56 void got_subscribe_reply(char *reply) {
57 DLOG("Got subscribe reply: %s\n", reply);
58 /* TODO: Error handling for subscribe commands */
62 * Called, when we get a reply with outputs data
65 void got_output_reply(char *reply) {
66 DLOG("Clearing old output configuration...\n");
69 DLOG("Parsing outputs JSON...\n");
70 parse_outputs_json(reply);
71 DLOG("Reconfiguring windows...\n");
72 reconfig_windows(false);
75 SLIST_FOREACH(o_walk, outputs, slist) {
76 kick_tray_clients(o_walk);
79 if (!config.disable_ws) {
80 i3_send_msg(I3_IPC_MESSAGE_TYPE_GET_WORKSPACES, NULL);
87 * Called when we get the configuration for our bar instance
90 void got_bar_config(char *reply) {
91 DLOG("Received bar config \"%s\"\n", reply);
92 /* We initiate the main function by requesting infos about the outputs and
93 * workspaces. Everything else (creating the bars, showing the right workspace-
94 * buttons and more) is taken care of by the event-drivenness of the code */
95 i3_send_msg(I3_IPC_MESSAGE_TYPE_GET_OUTPUTS, NULL);
97 free_colors(&(config.colors));
98 parse_config_json(reply);
100 /* Now we can actually use 'config', so let's subscribe to the appropriate
101 * events and request the workspaces if necessary. */
103 if (!config.disable_ws)
104 i3_send_msg(I3_IPC_MESSAGE_TYPE_GET_WORKSPACES, NULL);
106 /* Initialize the rest of XCB */
107 init_xcb_late(config.fontname);
109 /* Resolve color strings to colorpixels and save them, then free the strings. */
110 init_colors(&(config.colors));
112 start_child(config.command);
115 /* Data structure to easily call the reply handlers later */
116 handler_t reply_handlers[] = {
117 &got_command_reply, /* I3_IPC_REPLY_TYPE_COMMAND */
118 &got_workspace_reply, /* I3_IPC_REPLY_TYPE_WORKSPACES */
119 &got_subscribe_reply, /* I3_IPC_REPLY_TYPE_SUBSCRIBE */
120 &got_output_reply, /* I3_IPC_REPLY_TYPE_OUTPUTS */
121 NULL, /* I3_IPC_REPLY_TYPE_TREE */
122 NULL, /* I3_IPC_REPLY_TYPE_MARKS */
123 &got_bar_config, /* I3_IPC_REPLY_TYPE_BAR_CONFIG */
124 NULL, /* I3_IPC_REPLY_TYPE_VERSION */
125 NULL, /* I3_IPC_REPLY_TYPE_BINDING_MODES */
126 NULL, /* I3_IPC_REPLY_TYPE_CONFIG */
127 NULL, /* I3_IPC_REPLY_TYPE_TICK */
128 NULL, /* I3_IPC_REPLY_TYPE_SYNC */
132 * Called, when a workspace event arrives (i.e. the user changed the workspace)
135 void got_workspace_event(char *event) {
136 DLOG("Got workspace event!\n");
137 i3_send_msg(I3_IPC_MESSAGE_TYPE_GET_WORKSPACES, NULL);
141 * Called, when an output event arrives (i.e. the screen configuration changed)
144 void got_output_event(char *event) {
145 DLOG("Got output event!\n");
146 i3_send_msg(I3_IPC_MESSAGE_TYPE_GET_OUTPUTS, NULL);
147 if (!config.disable_ws) {
148 i3_send_msg(I3_IPC_MESSAGE_TYPE_GET_WORKSPACES, NULL);
153 * Called, when a mode event arrives (i3 changed binding mode).
156 void got_mode_event(char *event) {
157 DLOG("Got mode event!\n");
158 parse_mode_json(event);
163 * Called, when a barconfig_update event arrives (i.e. i3 changed the bar hidden_state or mode)
166 void got_bar_config_update(char *event) {
167 /* check whether this affect this bar instance by checking the bar_id */
169 sasprintf(&expected_id, "\"id\":\"%s\"", config.bar_id);
170 char *found_id = strstr(event, expected_id);
172 if (found_id == NULL)
175 /* reconfigure the bar based on the current outputs */
176 i3_send_msg(I3_IPC_MESSAGE_TYPE_GET_OUTPUTS, NULL);
178 free_colors(&(config.colors));
180 /* update the configuration with the received settings */
181 DLOG("Received bar config update \"%s\"\n", event);
182 char *old_command = config.command ? sstrdup(config.command) : NULL;
183 bar_display_mode_t old_mode = config.hide_on_modifier;
184 parse_config_json(event);
185 if (old_mode != config.hide_on_modifier) {
186 reconfig_windows(true);
189 /* update fonts and colors */
190 init_xcb_late(config.fontname);
191 init_colors(&(config.colors));
193 /* restart status command process */
194 if (old_command && strcmp(old_command, config.command) != 0) {
196 start_child(config.command);
203 /* Data structure to easily call the event handlers later */
204 handler_t event_handlers[] = {
205 &got_workspace_event,
209 &got_bar_config_update,
213 * Called, when we get a message from i3
216 void got_data(struct ev_loop *loop, ev_io *watcher, int events) {
218 int fd = watcher->fd;
220 /* First we only read the header, because we know its length */
221 uint32_t header_len = strlen(I3_IPC_MAGIC) + sizeof(uint32_t) * 2;
222 char *header = smalloc(header_len);
224 /* We first parse the fixed-length IPC header, to know, how much data
225 * we have to expect */
227 while (rec < header_len) {
228 int n = read(fd, header + rec, header_len - rec);
230 ELOG("read() failed: %s\n", strerror(errno));
234 /* EOF received. Since i3 will restart i3bar instances as appropriate,
236 DLOG("EOF received, exiting...\n");
237 #ifdef I3_ASAN_ENABLED
238 __lsan_do_leak_check();
246 if (strncmp(header, I3_IPC_MAGIC, strlen(I3_IPC_MAGIC))) {
247 ELOG("Wrong magic code: %.*s\n Expected: %s\n",
248 (int)strlen(I3_IPC_MAGIC),
254 char *walk = header + strlen(I3_IPC_MAGIC);
256 memcpy(&size, (uint32_t *)walk, sizeof(uint32_t));
257 walk += sizeof(uint32_t);
259 memcpy(&type, (uint32_t *)walk, sizeof(uint32_t));
261 /* Now that we know, what to expect, we can start read()ing the rest
263 char *buffer = smalloc(size + 1);
267 int n = read(fd, buffer + rec, size - rec);
269 ELOG("read() failed: %s\n", strerror(errno));
273 ELOG("Nothing to read!\n");
280 /* And call the callback (indexed by the type) */
281 if (type & (1 << 31)) {
283 event_handlers[type](buffer);
285 if (reply_handlers[type])
286 reply_handlers[type](buffer);
294 * Sends a message to i3.
295 * type must be a valid I3_IPC_MESSAGE_TYPE (see i3/ipc.h for further information)
298 int i3_send_msg(uint32_t type, const char *payload) {
300 if (payload != NULL) {
301 len = strlen(payload);
304 /* We are a wellbehaved client and send a proper header first */
305 uint32_t to_write = strlen(I3_IPC_MAGIC) + sizeof(uint32_t) * 2 + len;
306 /* TODO: I'm not entirely sure if this buffer really has to contain more
307 * than the pure header (why not just write() the payload from *payload?),
308 * but we leave it for now */
309 char *buffer = smalloc(to_write);
312 strncpy(buffer, I3_IPC_MAGIC, strlen(I3_IPC_MAGIC));
313 walk += strlen(I3_IPC_MAGIC);
314 memcpy(walk, &len, sizeof(uint32_t));
315 walk += sizeof(uint32_t);
316 memcpy(walk, &type, sizeof(uint32_t));
317 walk += sizeof(uint32_t);
320 strncpy(walk, payload, len);
322 swrite(i3_connection->fd, buffer, to_write);
330 * Initiate a connection to i3.
331 * socket_path must be a valid path to the ipc_socket of i3
334 int init_connection(const char *socket_path) {
335 sock_path = socket_path;
336 int sockfd = ipc_connect(socket_path);
337 i3_connection = smalloc(sizeof(ev_io));
338 ev_io_init(i3_connection, &got_data, sockfd, EV_READ);
339 ev_io_start(main_loop, i3_connection);
344 * Destroy the connection to i3.
346 void destroy_connection(void) {
347 close(i3_connection->fd);
348 ev_io_stop(main_loop, i3_connection);
352 * Subscribe to all the i3-events, we need
355 void subscribe_events(void) {
356 if (config.disable_ws) {
357 i3_send_msg(I3_IPC_MESSAGE_TYPE_SUBSCRIBE, "[ \"output\", \"mode\", \"barconfig_update\" ]");
359 i3_send_msg(I3_IPC_MESSAGE_TYPE_SUBSCRIBE, "[ \"workspace\", \"output\", \"mode\", \"barconfig_update\" ]");