git.sur5r.net Git - i3/i3/blob - docs/ipc

   1 IPC interface (interprocess communication)
   2 ==========================================
   3 Michael Stapelberg <michael+i3@stapelberg.de>
   4 December 2011
   5
   6 This document describes how to interface with i3 from a separate process. This
   7 is useful for example to remote-control i3 (to write test cases for example) or
   8 to get various information like the current workspaces to implement an external
   9 workspace bar.
  10
  11 The method of choice for IPC in our case is a unix socket because it has very
  12 little overhead on both sides and is usually available without headaches in
  13 most languages. In the default configuration file, the ipc-socket gets created
  14 in +/tmp/i3-%u/ipc-socket.%p+ where +%u+ is your UNIX username and +%p+ is the
  15 PID of i3. You can get the socketpath from i3 by calling +i3 --get-socketpath+.
  16
  17 All i3 utilities, like +i3-msg+ and +i3-input+ will read the +I3_SOCKET_PATH+
  18 X11 property, stored on the X11 root window.
  19
  20 == Establishing a connection
  21
  22 To establish a connection, simply open the IPC socket. The following code
  23 snippet illustrates this in Perl:
  24
  25 -------------------------------------------------------------
  26 use IO::Socket::UNIX;
  27 chomp(my $path = qx(i3 --get-socketpath));
  28 my $sock = IO::Socket::UNIX->new(Peer => $path);
  29 -------------------------------------------------------------
  30
  31 == Sending messages to i3
  32
  33 To send a message to i3, you have to format in the binary message format which
  34 i3 expects. This format specifies a magic string in the beginning to ensure
  35 the integrity of messages (to prevent follow-up errors). Following the magic
  36 string comes the length of the payload of the message as 32-bit integer, and
  37 the type of the message as 32-bit integer (the integers are not converted, so
  38 they are in native byte order).
  39
  40 The magic string currently is "i3-ipc" and will only be changed when a change
  41 in the IPC API is done which breaks compatibility (we hope that we don’t need
  42 to do that).
  43
  44 Currently implemented message types are the following:
  45
  46 COMMAND (0)::
  47         The payload of the message is a command for i3 (like the commands you
  48         can bind to keys in the configuration file) and will be executed
  49         directly after receiving it.
  50 GET_WORKSPACES (1)::
  51         Gets the current workspaces. The reply will be a JSON-encoded list of
  52         workspaces (see the reply section).
  53 SUBSCRIBE (2)::
  54         Subscribes your connection to certain events. See <<events>> for a
  55         description of this message and the concept of events.
  56 GET_OUTPUTS (3)::
  57         Gets the current outputs. The reply will be a JSON-encoded list of outputs
  58         (see the reply section).
  59 GET_TREE (4)::
  60         Gets the layout tree. i3 uses a tree as data structure which includes
  61         every container. The reply will be the JSON-encoded tree (see the reply
  62         section).
  63 GET_MARKS (5)::
  64         Gets a list of marks (identifiers for containers to easily jump to them
  65         later). The reply will be a JSON-encoded list of window marks (see
  66         reply section).
  67 GET_BAR_CONFIG (6)::
  68         Gets the configuration (as JSON map) of the workspace bar with the
  69         given ID. If no ID is provided, an array with all configured bar IDs is
  70         returned instead.
  71 GET_LOG_MARKERS (7)::
  72         Gets the SHM log markers for the current position, the last wrap, the
  73         SHM segment name and segment size. This is necessary for tools like
  74         i3-dump-log which want to display the SHM log.
  75
  76 So, a typical message could look like this:
  77 --------------------------------------------------
  78 "i3-ipc" <message length> <message type> <payload>
  79 --------------------------------------------------
  80
  81 Or, as a hexdump:
  82 ------------------------------------------------------------------------------
  83 00000000  69 33 2d 69 70 63 04 00  00 00 00 00 00 00 65 78  |i3-ipc........ex|
  84 00000010  69 74 0a                                          |it.|
  85 ------------------------------------------------------------------------------
  86
  87 To generate and send such a message, you could use the following code in Perl:
  88 ------------------------------------------------------------
  89 sub format_ipc_command {
  90     my ($msg) = @_;
  91     my $len;
  92     # Get the real byte count (vs. amount of characters)
  93     { use bytes; $len = length($msg); }
  94     return "i3-ipc" . pack("LL", $len, 0) . $msg;
  95 }
  96
  97 $sock->write(format_ipc_command("exit"));
  98 ------------------------------------------------------------------------------
  99
 100 == Receiving replies from i3
 101
 102 Replies from i3 usually consist of a simple string (the length of the string
 103 is the message_length, so you can consider them length-prefixed) which in turn
 104 contain the JSON serialization of a data structure. For example, the
 105 GET_WORKSPACES message returns an array of workspaces (each workspace is a map
 106 with certain attributes).
 107
 108 === Reply format
 109
 110 The reply format is identical to the normal message format. There also is
 111 the magic string, then the message length, then the message type and the
 112 payload.
 113
 114 The following reply types are implemented:
 115
 116 COMMAND (0)::
 117         Confirmation/Error code for the COMMAND message.
 118 WORKSPACES (1)::
 119         Reply to the GET_WORKSPACES message.
 120 SUBSCRIBE (2)::
 121         Confirmation/Error code for the SUBSCRIBE message.
 122 OUTPUTS (3)::
 123         Reply to the GET_OUTPUTS message.
 124 TREE (4)::
 125         Reply to the GET_TREE message.
 126 MARKS (5)::
 127         Reply to the GET_MARKS message.
 128 BAR_CONFIG (6)::
 129         Reply to the GET_BAR_CONFIG message.
 130 LOG_MARKERS (7)::
 131         Reply to the GET_LOG_MARKERS message.
 132
 133 === COMMAND reply
 134
 135 The reply consists of a single serialized map. At the moment, the only
 136 property is +success (bool)+, but this will be expanded in future versions.
 137
 138 *Example:*
 139 -------------------
 140 { "success": true }
 141 -------------------
 142
 143 === WORKSPACES reply
 144
 145 The reply consists of a serialized list of workspaces. Each workspace has the
 146 following properties:
 147
 148 num (integer)::
 149         The logical number of the workspace. Corresponds to the command
 150         to switch to this workspace.
 151 name (string)::
 152         The name of this workspace (by default num+1), as changed by the
 153         user. Encoded in UTF-8.
 154 visible (boolean)::
 155         Whether this workspace is currently visible on an output (multiple
 156         workspaces can be visible at the same time).
 157 focused (boolean)::
 158         Whether this workspace currently has the focus (only one workspace
 159         can have the focus at the same time).
 160 urgent (boolean)::
 161         Whether a window on this workspace has the "urgent" flag set.
 162 rect (map)::
 163         The rectangle of this workspace (equals the rect of the output it
 164         is on), consists of x, y, width, height.
 165 output (string)::
 166         The video output this workspace is on (LVDS1, VGA1, …).
 167
 168 *Example:*
 169 -------------------
 170 [
 171  {
 172   "num": 0,
 173   "name": "1",
 174   "visible": true,
 175   "focused": true,
 176   "urgent": false,
 177   "rect": {
 178    "x": 0,
 179    "y": 0,
 180    "width": 1280,
 181    "height": 800
 182   },
 183   "output": "LVDS1"
 184  },
 185  {
 186   "num": 1,
 187   "name": "2",
 188   "visible": false,
 189   "focused": false,
 190   "urgent": false,
 191   "rect": {
 192    "x": 0,
 193    "y": 0,
 194    "width": 1280,
 195    "height": 800
 196   },
 197   "output": "LVDS1"
 198  }
 199 ]
 200 -------------------
 201
 202 === SUBSCRIBE reply
 203
 204 The reply consists of a single serialized map. The only property is
 205 +success (bool)+, indicating whether the subscription was successful (the
 206 default) or whether a JSON parse error occurred.
 207
 208 *Example:*
 209 -------------------
 210 { "success": true }
 211 -------------------
 212
 213 === GET_OUTPUTS reply
 214
 215 The reply consists of a serialized list of outputs. Each output has the
 216 following properties:
 217
 218 name (string)::
 219         The name of this output (as seen in +xrandr(1)+). Encoded in UTF-8.
 220 active (boolean)::
 221         Whether this output is currently active (has a valid mode).
 222 current_workspace (integer)::
 223         The current workspace which is visible on this output. +null+ if the
 224         output is not active.
 225 rect (map)::
 226         The rectangle of this output (equals the rect of the output it
 227         is on), consists of x, y, width, height.
 228
 229 *Example:*
 230 -------------------
 231 [
 232  {
 233   "name": "LVDS1",
 234   "active": true,
 235   "current_workspace": 4,
 236   "rect": {
 237    "x": 0,
 238    "y": 0,
 239    "width": 1280,
 240    "height": 800
 241   }
 242  },
 243  {
 244   "name": "VGA1",
 245   "active": true,
 246   "current_workspace": 1,
 247   "rect": {
 248    "x": 1280,
 249    "y": 0,
 250    "width": 1280,
 251    "height": 1024
 252   },
 253  }
 254 ]
 255 -------------------
 256
 257 === TREE reply
 258
 259 The reply consists of a serialized tree. Each node in the tree (representing
 260 one container) has at least the properties listed below. While the nodes might
 261 have more properties, please do not use any properties which are not documented
 262 here. They are not yet finalized and will probably change!
 263
 264 id (integer)::
 265         The internal ID (actually a C pointer value) of this container. Do not
 266         make any assumptions about it. You can use it to (re-)identify and
 267         address containers when talking to i3.
 268 name (string)::
 269         The internal name of this container. For all containers which are part
 270         of the tree structure down to the workspace contents, this is set to a
 271         nice human-readable name of the container.
 272         For all other containers, the content is not defined (yet).
 273 border (string)::
 274         Can be either "normal", "none" or "1pixel", dependending on the
 275         container’s border style.
 276 layout (string)::
 277         Can be either "default", "stacked", "tabbed", "dockarea" or "output".
 278         Other values might be possible in the future, should we add new
 279         layouts.
 280 orientation (string)::
 281         Can be either "none" (for non-split containers), "horizontal" or
 282         "vertical".
 283 percent (float)::
 284         The percentage which this container takes in its parent. A value of
 285         +null+ means that the percent property does not make sense for this
 286         container, for example for the root container.
 287 rect (map)::
 288         The absolute display coordinates for this container. Display
 289         coordinates means that when you have two 1600x1200 monitors on a single
 290         X11 Display (the standard way), the coordinates of the first window on
 291         the second monitor are +{ "x": 1600, "y": 0, "width": 1600, "height":
 292         1200 }+.
 293 window_rect (map)::
 294         The coordinates of the *actual client window* inside its container.
 295         These coordinates are relative to the container and do not include the
 296         window decoration (which is actually rendered on the parent container).
 297         So, when using the +default+ layout, you will have a 2 pixel border on
 298         each side, making the window_rect +{ "x": 2, "y": 0, "width": 632,
 299         "height": 366 }+ (for example).
 300 geometry (map)::
 301         The original geometry the window specified when i3 mapped it. Used when
 302         switching a window to floating mode, for example.
 303 urgent (bool)::
 304         Whether this container (window or workspace) has the urgency hint set.
 305 focused (bool)::
 306         Whether this container is currently focused.
 307
 308 Please note that in the following example, I have left out some keys/values
 309 which are not relevant for the type of the node. Otherwise, the example would
 310 be by far too long (it already is quite long, despite showing only 1 window and
 311 one dock window).
 312
 313 It is useful to have an overview of the structure before taking a look at the
 314 JSON dump:
 315
 316 * root
 317 ** LVDS1
 318 *** topdock
 319 *** content
 320 **** workspace 1
 321 ***** window 1
 322 *** bottomdock
 323 **** dock window 1
 324 ** VGA1
 325
 326 *Example:*
 327 -----------------------
 328 {
 329  "id": 6875648,
 330  "name": "root",
 331  "rect": {
 332    "x": 0,
 333    "y": 0,
 334    "width": 1280,
 335    "height": 800
 336  },
 337  "nodes": [
 338
 339    {
 340     "id": 6878320,
 341     "name": "LVDS1",
 342     "layout": "output",
 343     "rect": {
 344       "x": 0,
 345       "y": 0,
 346       "width": 1280,
 347       "height": 800
 348     },
 349     "nodes": [
 350
 351       {
 352        "id": 6878784,
 353        "name": "topdock",
 354        "layout": "dockarea",
 355        "orientation": "vertical",
 356        "rect": {
 357          "x": 0,
 358          "y": 0,
 359          "width": 1280,
 360          "height": 0
 361        },
 362       },
 363
 364       {
 365        "id": 6879344,
 366        "name": "content",
 367        "rect": {
 368          "x": 0,
 369          "y": 0,
 370          "width": 1280,
 371          "height": 782
 372        },
 373        "nodes": [
 374
 375          {
 376           "id": 6880464,
 377           "name": "1",
 378           "orientation": "horizontal",
 379           "rect": {
 380             "x": 0,
 381             "y": 0,
 382             "width": 1280,
 383             "height": 782
 384           },
 385           "floating_nodes": [],
 386           "nodes": [
 387
 388             {
 389              "id": 6929968,
 390              "name": "#aa0000",
 391              "border": "normal",
 392              "percent": 1,
 393              "rect": {
 394                "x": 0,
 395                "y": 18,
 396                "width": 1280,
 397                "height": 782
 398              }
 399             }
 400
 401           ]
 402          }
 403
 404        ]
 405       },
 406
 407       {
 408        "id": 6880208,
 409        "name": "bottomdock",
 410        "layout": "dockarea",
 411        "orientation": "vertical",
 412        "rect": {
 413          "x": 0,
 414          "y": 782,
 415          "width": 1280,
 416          "height": 18
 417        },
 418        "nodes": [
 419
 420          {
 421           "id": 6931312,
 422           "name": "#00aa00",
 423           "percent": 1,
 424           "rect": {
 425             "x": 0,
 426             "y": 782,
 427             "width": 1280,
 428             "height": 18
 429           }
 430          }
 431
 432        ]
 433       }
 434     ]
 435    }
 436  ]
 437 }
 438 ------------------------
 439
 440 === MARKS reply
 441
 442 The reply consists of a single array of strings for each container that has a
 443 mark. The order of that array is undefined. If more than one container has the
 444 same mark, it will be represented multiple times in the reply (the array
 445 contents are not unique).
 446
 447 If no window has a mark the response will be the empty array [].
 448
 449 === BAR_CONFIG reply
 450
 451 This can be used by third-party workspace bars (especially i3bar, but others
 452 are free to implement compatible alternatives) to get the +bar+ block
 453 configuration from i3.
 454
 455 Depending on the input, the reply is either:
 456
 457 empty input::
 458         An array of configured bar IDs
 459 Bar ID::
 460         A JSON map containing the configuration for the specified bar.
 461
 462 Each bar configuration has the following properties:
 463
 464 id (string)::
 465         The ID for this bar. Included in case you request multiple
 466         configurations and want to differentiate the different replies.
 467 mode (string)::
 468         Either +dock+ (the bar sets the dock window type) or +hide+ (the bar
 469         does not show unless a specific key is pressed).
 470 position (string)::
 471         Either +bottom+ or +top+ at the moment.
 472 status_command (string)::
 473         Command which will be run to generate a statusline. Each line on stdout
 474         of this command will be displayed in the bar. At the moment, no
 475         formatting is supported.
 476 font (string)::
 477         The font to use for text on the bar.
 478 workspace_buttons (boolean)::
 479         Display workspace buttons or not? Defaults to true.
 480 verbose (boolean)::
 481         Should the bar enable verbose output for debugging? Defaults to false.
 482 colors (map)::
 483         Contains key/value pairs of colors. Each value is a color code in hex,
 484         formatted #rrggbb (like in HTML).
 485
 486 The following colors can be configured at the moment:
 487
 488 background::
 489         Background color of the bar.
 490 statusline::
 491         Text color to be used for the statusline.
 492 focused_workspace_text/focused_workspace_bg::
 493         Text color/background color for a workspace button when the workspace
 494         has focus.
 495 active_workspace_text/active_workspace_bg::
 496         Text color/background color for a workspace button when the workspace
 497         is active (visible) on some output, but the focus is on another one.
 498         You can only tell this apart from the focused workspace when you are
 499         using multiple monitors.
 500 inactive_workspace_text/inactive_workspace_bg::
 501         Text color/background color for a workspace button when the workspace
 502         does not have focus and is not active (visible) on any output. This
 503         will be the case for most workspaces.
 504 urgent_workspace_text/urgent_workspace_bar::
 505         Text color/background color for workspaces which contain at least one
 506         window with the urgency hint set.
 507
 508
 509 *Example of configured bars:*
 510 --------------
 511 ["bar-bxuqzf"]
 512 --------------
 513
 514 *Example of bar configuration:*
 515 --------------
 516 {
 517  "id": "bar-bxuqzf",
 518  "mode": "dock",
 519  "position": "bottom",
 520  "status_command": "i3status",
 521  "font": "-misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1",
 522  "workspace_buttons": true,
 523  "verbose": false,
 524  "colors": {
 525    "background": "#c0c0c0",
 526    "statusline": "#00ff00",
 527    "focused_workspace_text": "#ffffff",
 528    "focused_workspace_bg": "#000000"
 529  }
 530 }
 531 --------------
 532
 533 === LOG_MARKERS reply
 534
 535 Gets the SHM log markers for the current position, the last wrap, the
 536 SHM segment name and segment size. This is necessary for tools like
 537 i3-dump-log which want to display the SHM log.
 538
 539 The reply is a JSON map with the following entries:
 540
 541 shmname (string)::
 542         The name of the SHM segment, will be of the format +/i3-log-<pid>+.
 543 size (integer)::
 544         The size (in bytes) of the SHM segment. If this is 0, SHM logging is
 545         disabled.
 546 offset_next_write (integer)::
 547         The offset in the SHM segment at which the next write will happen.
 548         Tools should start printing lines from here, since the bytes following
 549         this offset are the oldest log lines. However, the first line might be
 550         garbled, so it makes sense to skip all bytes until the first \0.
 551 offset_last_wrap (integer)::
 552         The offset in the SHM segment at which the last wrap occured. i3 only
 553         stores entire messages in the SHM log, so it might waste a few bytes at
 554         the end to be more efficient. Tools should not print content after the
 555         offset_last_wrap.
 556
 557 *Example*:
 558 -----------------------------
 559 {
 560   "offset_next_write":132839,
 561   "offset_last_wrap":26214400,
 562   "shmname":"/i3-log-3392",
 563   "size":26214400
 564 }
 565 -----------------------------
 566
 567 == Events
 568
 569 [[events]]
 570
 571 To get informed when certain things happen in i3, clients can subscribe to
 572 events. Events consist of a name (like "workspace") and an event reply type
 573 (like I3_IPC_EVENT_WORKSPACE). The events sent by i3 are in the same format
 574 as replies to specific commands. However, the highest bit of the message type
 575 is set to 1 to indicate that this is an event reply instead of a normal reply.
 576
 577 Caveat: As soon as you subscribe to an event, it is not guaranteed any longer
 578 that the requests to i3 are processed in order. This means, the following
 579 situation can happen: You send a GET_WORKSPACES request but you receive a
 580 "workspace" event before receiving the reply to GET_WORKSPACES. If your
 581 program does not want to cope which such kinds of race conditions (an
 582 event based library may not have a problem here), I suggest you create a
 583 separate connection to receive events.
 584
 585 === Subscribing to events
 586
 587 By sending a message of type SUBSCRIBE with a JSON-encoded array as payload
 588 you can register to an event.
 589
 590 *Example:*
 591 ---------------------------------
 592 type: SUBSCRIBE
 593 payload: [ "workspace", "focus" ]
 594 ---------------------------------
 595
 596
 597 === Available events
 598
 599 The numbers in parenthesis is the event type (keep in mind that you need to
 600 strip the highest bit first).
 601
 602 workspace (0)::
 603         Sent when the user switches to a different workspace, when a new
 604         workspace is initialized or when a workspace is removed (because the
 605         last client vanished).
 606 output (1)::
 607         Sent when RandR issues a change notification (of either screens,
 608         outputs, CRTCs or output properties).
 609
 610 *Example:*
 611 --------------------------------------------------------------------
 612 # the appropriate 4 bytes read from the socket are stored in $input
 613
 614 # unpack a 32-bit unsigned integer
 615 my $message_type = unpack("L", $input);
 616
 617 # check if the highest bit is 1
 618 my $is_event = (($message_type >> 31) == 1);
 619
 620 # use the other bits
 621 my $event_type = ($message_type & 0x7F);
 622
 623 if ($is_event) {
 624   say "Received event of type $event_type";
 625 }
 626 --------------------------------------------------------------------
 627
 628 === workspace event
 629
 630 This event consists of a single serialized map containing a property
 631 +change (string)+ which indicates the type of the change ("focus", "init",
 632 "empty", "urgent").
 633
 634 *Example:*
 635 ---------------------
 636 { "change": "focus" }
 637 ---------------------
 638
 639 === output event
 640
 641 This event consists of a single serialized map containing a property
 642 +change (string)+ which indicates the type of the change (currently only
 643 "unspecified").
 644
 645 *Example:*
 646 ---------------------------
 647 { "change": "unspecified" }
 648 ---------------------------
 649
 650 == See also
 651
 652 For some languages, libraries are available (so you don’t have to implement
 653 all this on your own). This list names some (if you wrote one, please let me
 654 know):
 655
 656 C::
 657         i3 includes a headerfile +i3/ipc.h+ which provides you all constants.
 658         However, there is no library yet.
 659 Ruby::
 660         http://github.com/badboy/i3-ipc
 661 Perl::
 662         http://search.cpan.org/search?query=AnyEvent::I3
 663 Python::
 664         http://github.com/thepub/i3ipc