2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
7 * This public header defines the different constants and message types to use
8 * for the IPC interface to i3 (see docs/ipc for more information).
15 typedef struct i3_ipc_header {
16 /* 6 = strlen(I3_IPC_MAGIC) */
20 } __attribute__((packed)) i3_ipc_header_t;
23 * Messages from clients to i3
27 /** Never change this, only on major IPC breakage (don’t do that) */
28 #define I3_IPC_MAGIC "i3-ipc"
30 /** The payload of the message will be interpreted as a command */
31 #define I3_IPC_MESSAGE_TYPE_COMMAND 0
33 /** Requests the current workspaces from i3 */
34 #define I3_IPC_MESSAGE_TYPE_GET_WORKSPACES 1
36 /** Subscribe to the specified events */
37 #define I3_IPC_MESSAGE_TYPE_SUBSCRIBE 2
39 /** Requests the current outputs from i3 */
40 #define I3_IPC_MESSAGE_TYPE_GET_OUTPUTS 3
42 /** Requests the tree layout from i3 */
43 #define I3_IPC_MESSAGE_TYPE_GET_TREE 4
45 /** Request the current defined marks from i3 */
46 #define I3_IPC_MESSAGE_TYPE_GET_MARKS 5
48 /** Request the configuration for a specific 'bar' */
49 #define I3_IPC_MESSAGE_TYPE_GET_BAR_CONFIG 6
51 /** Request the i3 version */
52 #define I3_IPC_MESSAGE_TYPE_GET_VERSION 7
54 /** Request a list of configured binding modes. */
55 #define I3_IPC_MESSAGE_TYPE_GET_BINDING_MODES 8
58 * Messages from i3 to clients
61 #define I3_IPC_REPLY_TYPE_COMMAND 0
62 #define I3_IPC_REPLY_TYPE_WORKSPACES 1
63 #define I3_IPC_REPLY_TYPE_SUBSCRIBE 2
64 #define I3_IPC_REPLY_TYPE_OUTPUTS 3
65 #define I3_IPC_REPLY_TYPE_TREE 4
66 #define I3_IPC_REPLY_TYPE_MARKS 5
67 #define I3_IPC_REPLY_TYPE_BAR_CONFIG 6
68 #define I3_IPC_REPLY_TYPE_VERSION 7
69 #define I3_IPC_REPLY_TYPE_BINDING_MODES 8
72 * Events from i3 to clients. Events have the first bit set high.
75 #define I3_IPC_EVENT_MASK (1 << 31)
77 /* The workspace event will be triggered upon changes in the workspace list */
78 #define I3_IPC_EVENT_WORKSPACE (I3_IPC_EVENT_MASK | 0)
80 /* The output event will be triggered upon changes in the output list */
81 #define I3_IPC_EVENT_OUTPUT (I3_IPC_EVENT_MASK | 1)
83 /* The output event will be triggered upon mode changes */
84 #define I3_IPC_EVENT_MODE (I3_IPC_EVENT_MASK | 2)
86 /* The window event will be triggered upon window changes */
87 #define I3_IPC_EVENT_WINDOW (I3_IPC_EVENT_MASK | 3)
89 /** Bar config update will be triggered to update the bar config */
90 #define I3_IPC_EVENT_BARCONFIG_UPDATE (I3_IPC_EVENT_MASK | 4)
92 /** The binding event will be triggered when bindings run */
93 #define I3_IPC_EVENT_BINDING (I3_IPC_EVENT_MASK | 5)