2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009-2013 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).
16 typedef struct i3_ipc_header {
17 /* 6 = strlen(I3_IPC_MAGIC) */
21 } __attribute__ ((packed)) i3_ipc_header_t;
24 * Messages from clients to i3
28 /** Never change this, only on major IPC breakage (don’t do that) */
29 #define I3_IPC_MAGIC "i3-ipc"
31 /** The payload of the message will be interpreted as a command */
32 #define I3_IPC_MESSAGE_TYPE_COMMAND 0
34 /** Requests the current workspaces from i3 */
35 #define I3_IPC_MESSAGE_TYPE_GET_WORKSPACES 1
37 /** Subscribe to the specified events */
38 #define I3_IPC_MESSAGE_TYPE_SUBSCRIBE 2
40 /** Requests the current outputs from i3 */
41 #define I3_IPC_MESSAGE_TYPE_GET_OUTPUTS 3
43 /** Requests the tree layout from i3 */
44 #define I3_IPC_MESSAGE_TYPE_GET_TREE 4
46 /** Request the current defined marks from i3 */
47 #define I3_IPC_MESSAGE_TYPE_GET_MARKS 5
49 /** Request the configuration for a specific 'bar' */
50 #define I3_IPC_MESSAGE_TYPE_GET_BAR_CONFIG 6
52 /** Request the i3 version */
53 #define I3_IPC_MESSAGE_TYPE_GET_VERSION 7
56 * Messages from i3 to clients
60 /** Command reply type */
61 #define I3_IPC_REPLY_TYPE_COMMAND 0
63 /** Workspaces reply type */
64 #define I3_IPC_REPLY_TYPE_WORKSPACES 1
66 /** Subscription reply type */
67 #define I3_IPC_REPLY_TYPE_SUBSCRIBE 2
69 /** Outputs reply type */
70 #define I3_IPC_REPLY_TYPE_OUTPUTS 3
72 /** Tree reply type */
73 #define I3_IPC_REPLY_TYPE_TREE 4
75 /** Marks reply type */
76 #define I3_IPC_REPLY_TYPE_MARKS 5
78 /** Bar config reply type */
79 #define I3_IPC_REPLY_TYPE_BAR_CONFIG 6
81 /** i3 version reply type */
82 #define I3_IPC_REPLY_TYPE_VERSION 7
85 * Events from i3 to clients. Events have the first bit set high.
88 #define I3_IPC_EVENT_MASK (1 << 31)
90 /* The workspace event will be triggered upon changes in the workspace list */
91 #define I3_IPC_EVENT_WORKSPACE (I3_IPC_EVENT_MASK | 0)
93 /* The output event will be triggered upon changes in the output list */
94 #define I3_IPC_EVENT_OUTPUT (I3_IPC_EVENT_MASK | 1)
96 /* The output event will be triggered upon mode changes */
97 #define I3_IPC_EVENT_MODE (I3_IPC_EVENT_MASK | 2)