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");
68 SLIST_FOREACH(o_walk, outputs, slist) {
69 destroy_window(o_walk);
71 FREE_SLIST(outputs, i3_output);
73 DLOG("Parsing outputs JSON...\n");
74 parse_outputs_json(reply);
75 DLOG("Reconfiguring windows...\n");
76 reconfig_windows(false);
78 SLIST_FOREACH(o_walk, outputs, slist) {
79 kick_tray_clients(o_walk);
86 * Called when we get the configuration for our bar instance
89 void got_bar_config(char *reply) {
90 DLOG("Received bar config \"%s\"\n", reply);
91 /* We initiate the main function by requesting infos about the outputs and
92 * workspaces. Everything else (creating the bars, showing the right workspace-
93 * buttons and more) is taken care of by the event-drivenness of the code */
94 i3_send_msg(I3_IPC_MESSAGE_TYPE_GET_OUTPUTS, NULL);
96 free_colors(&(config.colors));
97 parse_config_json(reply);
99 /* Now we can actually use 'config', so let's subscribe to the appropriate
100 * events and request the workspaces if necessary. */
102 if (!config.disable_ws)
103 i3_send_msg(I3_IPC_MESSAGE_TYPE_GET_WORKSPACES, NULL);
105 /* Initialize the rest of XCB */
106 init_xcb_late(config.fontname);
108 /* Resolve color strings to colorpixels and save them, then free the strings. */
109 init_colors(&(config.colors));
111 start_child(config.command);
112 FREE(config.command);
115 /* Data structure to easily call the reply handlers later */
116 handler_t reply_handlers[] = {
118 &got_workspace_reply,
119 &got_subscribe_reply,
127 * Called, when a workspace event arrives (i.e. the user changed the workspace)
130 void got_workspace_event(char *event) {
131 DLOG("Got workspace event!\n");
132 i3_send_msg(I3_IPC_MESSAGE_TYPE_GET_WORKSPACES, NULL);
136 * Called, when an output event arrives (i.e. the screen configuration changed)
139 void got_output_event(char *event) {
140 DLOG("Got output event!\n");
141 i3_send_msg(I3_IPC_MESSAGE_TYPE_GET_OUTPUTS, NULL);
142 if (!config.disable_ws) {
143 i3_send_msg(I3_IPC_MESSAGE_TYPE_GET_WORKSPACES, NULL);
148 * Called, when a mode event arrives (i3 changed binding mode).
151 void got_mode_event(char *event) {
152 DLOG("Got mode event!\n");
153 parse_mode_json(event);
158 * Called, when a barconfig_update event arrives (i.e. i3 changed the bar hidden_state or mode)
161 void got_bar_config_update(char *event) {
162 /* check whether this affect this bar instance by checking the bar_id */
164 sasprintf(&expected_id, "\"id\":\"%s\"", config.bar_id);
165 char *found_id = strstr(event, expected_id);
167 if (found_id == NULL)
170 /* reconfigure the bar based on the current outputs */
171 i3_send_msg(I3_IPC_MESSAGE_TYPE_GET_OUTPUTS, NULL);
173 free_colors(&(config.colors));
175 /* update the configuration with the received settings */
176 DLOG("Received bar config update \"%s\"\n", event);
177 bar_display_mode_t old_mode = config.hide_on_modifier;
178 parse_config_json(event);
179 if (old_mode != config.hide_on_modifier) {
180 reconfig_windows(true);
183 /* update fonts and colors */
184 init_xcb_late(config.fontname);
185 init_colors(&(config.colors));
187 /* restart status command process */
189 start_child(config.command);
190 FREE(config.command);
195 /* Data structure to easily call the event handlers later */
196 handler_t event_handlers[] = {
197 &got_workspace_event,
201 &got_bar_config_update,
205 * Called, when we get a message from i3
208 void got_data(struct ev_loop *loop, ev_io *watcher, int events) {
210 int fd = watcher->fd;
212 /* First we only read the header, because we know its length */
213 uint32_t header_len = strlen(I3_IPC_MAGIC) + sizeof(uint32_t) * 2;
214 char *header = smalloc(header_len);
216 /* We first parse the fixed-length IPC header, to know, how much data
217 * we have to expect */
219 while (rec < header_len) {
220 int n = read(fd, header + rec, header_len - rec);
222 ELOG("read() failed: %s\n", strerror(errno));
226 /* EOF received. Since i3 will restart i3bar instances as appropriate,
228 DLOG("EOF received, exiting...\n");
229 #ifdef I3_ASAN_ENABLED
230 __lsan_do_leak_check();
238 if (strncmp(header, I3_IPC_MAGIC, strlen(I3_IPC_MAGIC))) {
239 ELOG("Wrong magic code: %.*s\n Expected: %s\n",
240 (int)strlen(I3_IPC_MAGIC),
246 char *walk = header + strlen(I3_IPC_MAGIC);
248 memcpy(&size, (uint32_t *)walk, sizeof(uint32_t));
249 walk += sizeof(uint32_t);
251 memcpy(&type, (uint32_t *)walk, sizeof(uint32_t));
253 /* Now that we know, what to expect, we can start read()ing the rest
255 char *buffer = smalloc(size + 1);
259 int n = read(fd, buffer + rec, size - rec);
261 ELOG("read() failed: %s\n", strerror(errno));
265 ELOG("Nothing to read!\n");
272 /* And call the callback (indexed by the type) */
273 if (type & (1 << 31)) {
275 event_handlers[type](buffer);
277 if (reply_handlers[type])
278 reply_handlers[type](buffer);
286 * Sends a message to i3.
287 * type must be a valid I3_IPC_MESSAGE_TYPE (see i3/ipc.h for further information)
290 int i3_send_msg(uint32_t type, const char *payload) {
292 if (payload != NULL) {
293 len = strlen(payload);
296 /* We are a wellbehaved client and send a proper header first */
297 uint32_t to_write = strlen(I3_IPC_MAGIC) + sizeof(uint32_t) * 2 + len;
298 /* TODO: I'm not entirely sure if this buffer really has to contain more
299 * than the pure header (why not just write() the payload from *payload?),
300 * but we leave it for now */
301 char *buffer = smalloc(to_write);
304 strncpy(buffer, I3_IPC_MAGIC, strlen(I3_IPC_MAGIC));
305 walk += strlen(I3_IPC_MAGIC);
306 memcpy(walk, &len, sizeof(uint32_t));
307 walk += sizeof(uint32_t);
308 memcpy(walk, &type, sizeof(uint32_t));
309 walk += sizeof(uint32_t);
312 strncpy(walk, payload, len);
314 swrite(i3_connection->fd, buffer, to_write);
322 * Initiate a connection to i3.
323 * socket_path must be a valid path to the ipc_socket of i3
326 int init_connection(const char *socket_path) {
327 sock_path = socket_path;
328 int sockfd = ipc_connect(socket_path);
329 i3_connection = smalloc(sizeof(ev_io));
330 ev_io_init(i3_connection, &got_data, sockfd, EV_READ);
331 ev_io_start(main_loop, i3_connection);
336 * Destroy the connection to i3.
338 void destroy_connection(void) {
339 close(i3_connection->fd);
340 ev_io_stop(main_loop, i3_connection);
344 * Subscribe to all the i3-events, we need
347 void subscribe_events(void) {
348 if (config.disable_ws) {
349 i3_send_msg(I3_IPC_MESSAGE_TYPE_SUBSCRIBE, "[ \"output\", \"mode\", \"barconfig_update\" ]");
351 i3_send_msg(I3_IPC_MESSAGE_TYPE_SUBSCRIBE, "[ \"workspace\", \"output\", \"mode\", \"barconfig_update\" ]");