git.sur5r.net Git - i3/i3/blob - include/i3/ipc.h

   1 /*
   2  * vim:ts=8:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  *
   6  * © 2009-2010 Michael Stapelberg and contributors
   7  *
   8  * See file LICENSE for license information.
   9  *
  10  * This public header defines the different constants and message types to use
  11  * for the IPC interface to i3 (see docs/ipc for more information).
  12  *
  13  */
  14
  15 #ifndef _I3_IPC_H
  16 #define _I3_IPC_H
  17
  18 /*
  19  * Messages from clients to i3
  20  *
  21  */
  22
  23 /** Never change this, only on major IPC breakage (don’t do that) */
  24 #define I3_IPC_MAGIC                    "i3-ipc"
  25
  26 /** The payload of the message will be interpreted as a command */
  27 #define I3_IPC_MESSAGE_TYPE_COMMAND             0
  28
  29 /** Requests the current workspaces from i3 */
  30 #define I3_IPC_MESSAGE_TYPE_GET_WORKSPACES      1
  31
  32 /** Subscribe to the specified events */
  33 #define I3_IPC_MESSAGE_TYPE_SUBSCRIBE           2
  34
  35 /** Requests the current outputs from i3 */
  36 #define I3_IPC_MESSAGE_TYPE_GET_OUTPUTS         3
  37
  38 /** Requests the tree layout from i3 */
  39 #define I3_IPC_MESSAGE_TYPE_GET_TREE            4
  40
  41
  42 /*
  43  * Messages from i3 to clients
  44  *
  45  */
  46
  47 /** Command reply type */
  48 #define I3_IPC_REPLY_TYPE_COMMAND               0
  49
  50 /** Workspaces reply type */
  51 #define I3_IPC_REPLY_TYPE_WORKSPACES            1
  52
  53 /** Subscription reply type */
  54 #define I3_IPC_REPLY_TYPE_SUBSCRIBE             2
  55
  56 /** Outputs reply type */
  57 #define I3_IPC_REPLY_TYPE_OUTPUTS               3
  58
  59 /** Tree reply type */
  60 #define I3_IPC_REPLY_TYPE_TREE                  4
  61
  62
  63 /*
  64  * Events from i3 to clients. Events have the first bit set high.
  65  *
  66  */
  67 #define I3_IPC_EVENT_MASK                       (1 << 31)
  68
  69 /* The workspace event will be triggered upon changes in the workspace list */
  70 #define I3_IPC_EVENT_WORKSPACE                  (I3_IPC_EVENT_MASK | 0)
  71
  72 /* The output event will be triggered upon changes in the output list */
  73 #define I3_IPC_EVENT_OUTPUT                     (I3_IPC_EVENT_MASK | 1)
  74
  75 #endif