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

   1 IPC interface (interprocess communication)
   2 ==========================================
   3 Michael Stapelberg <michael@i3wm.org>
   4 October 2014
   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.XXXXXX/ipc-socket.%p+ where +%u+ is your UNIX username, +%p+ is
  15 the PID of i3 and XXXXXX is a string of random characters from the portable
  16 filename character set (see mkdtemp(3)). You can get the socketpath from i3 by
  17 calling +i3 --get-socketpath+.
  18
  19 All i3 utilities, like +i3-msg+ and +i3-input+ will read the +I3_SOCKET_PATH+
  20 X11 property, stored on the X11 root window.
  21
  22 [WARNING]
  23 .Use an existing library!
  24 There are existing libraries for many languages. You can have a look at
  25 <<libraries>> or search the web if your language of choice is not mentioned.
  26 Usually, it is not necessary to implement low-level communication with i3
  27 directly.
  28
  29 == Establishing a connection
  30
  31 To establish a connection, simply open the IPC socket. The following code
  32 snippet illustrates this in Perl:
  33
  34 -------------------------------------------------------------
  35 use IO::Socket::UNIX;
  36 chomp(my $path = qx(i3 --get-socketpath));
  37 my $sock = IO::Socket::UNIX->new(Peer => $path);
  38 -------------------------------------------------------------
  39
  40 == Sending messages to i3
  41
  42 To send a message to i3, you have to format in the binary message format which
  43 i3 expects. This format specifies a magic string in the beginning to ensure
  44 the integrity of messages (to prevent follow-up errors). Following the magic
  45 string comes the length of the payload of the message as 32-bit integer, and
  46 the type of the message as 32-bit integer (the integers are not converted, so
  47 they are in native byte order).
  48
  49 The magic string currently is "i3-ipc" and will only be changed when a change
  50 in the IPC API is done which breaks compatibility (we hope that we don’t need
  51 to do that).
  52
  53 Currently implemented message types are the following:
  54
  55 COMMAND (0)::
  56         The payload of the message is a command for i3 (like the commands you
  57         can bind to keys in the configuration file) and will be executed
  58         directly after receiving it.
  59 GET_WORKSPACES (1)::
  60         Gets the current workspaces. The reply will be a JSON-encoded list of
  61         workspaces (see the reply section).
  62 SUBSCRIBE (2)::
  63         Subscribes your connection to certain events. See <<events>> for a
  64         description of this message and the concept of events.
  65 GET_OUTPUTS (3)::
  66         Gets the current outputs. The reply will be a JSON-encoded list of outputs
  67         (see the reply section).
  68 GET_TREE (4)::
  69         Gets the layout tree. i3 uses a tree as data structure which includes
  70         every container. The reply will be the JSON-encoded tree (see the reply
  71         section).
  72 GET_MARKS (5)::
  73         Gets a list of marks (identifiers for containers to easily jump to them
  74         later). The reply will be a JSON-encoded list of window marks (see
  75         reply section).
  76 GET_BAR_CONFIG (6)::
  77         Gets the configuration (as JSON map) of the workspace bar with the
  78         given ID. If no ID is provided, an array with all configured bar IDs is
  79         returned instead.
  80 GET_VERSION (7)::
  81         Gets the version of i3. The reply will be a JSON-encoded dictionary
  82         with the major, minor, patch and human-readable version.
  83
  84 So, a typical message could look like this:
  85 --------------------------------------------------
  86 "i3-ipc" <message length> <message type> <payload>
  87 --------------------------------------------------
  88
  89 Or, as a hexdump:
  90 ------------------------------------------------------------------------------
  91 00000000  69 33 2d 69 70 63 04 00  00 00 00 00 00 00 65 78  |i3-ipc........ex|
  92 00000010  69 74                                             |it|
  93 ------------------------------------------------------------------------------
  94
  95 To generate and send such a message, you could use the following code in Perl:
  96 ------------------------------------------------------------
  97 sub format_ipc_command {
  98     my ($msg) = @_;
  99     my $len;
 100     # Get the real byte count (vs. amount of characters)
 101     { use bytes; $len = length($msg); }
 102     return "i3-ipc" . pack("LL", $len, 0) . $msg;
 103 }
 104
 105 $sock->write(format_ipc_command("exit"));
 106 ------------------------------------------------------------------------------
 107
 108 == Receiving replies from i3
 109
 110 Replies from i3 usually consist of a simple string (the length of the string
 111 is the message_length, so you can consider them length-prefixed) which in turn
 112 contain the JSON serialization of a data structure. For example, the
 113 GET_WORKSPACES message returns an array of workspaces (each workspace is a map
 114 with certain attributes).
 115
 116 === Reply format
 117
 118 The reply format is identical to the normal message format. There also is
 119 the magic string, then the message length, then the message type and the
 120 payload.
 121
 122 The following reply types are implemented:
 123
 124 COMMAND (0)::
 125         Confirmation/Error code for the COMMAND message.
 126 WORKSPACES (1)::
 127         Reply to the GET_WORKSPACES message.
 128 SUBSCRIBE (2)::
 129         Confirmation/Error code for the SUBSCRIBE message.
 130 OUTPUTS (3)::
 131         Reply to the GET_OUTPUTS message.
 132 TREE (4)::
 133         Reply to the GET_TREE message.
 134 MARKS (5)::
 135         Reply to the GET_MARKS message.
 136 BAR_CONFIG (6)::
 137         Reply to the GET_BAR_CONFIG message.
 138 VERSION (7)::
 139         Reply to the GET_VERSION message.
 140
 141 === COMMAND reply
 142
 143 The reply consists of a list of serialized maps for each command that was
 144 parsed. Each has the property +success (bool)+ and may also include a
 145 human-readable error message in the property +error (string)+.
 146
 147 *Example:*
 148 -------------------
 149 [{ "success": true }]
 150 -------------------
 151
 152 === WORKSPACES reply
 153
 154 The reply consists of a serialized list of workspaces. Each workspace has the
 155 following properties:
 156
 157 num (integer)::
 158         The logical number of the workspace. Corresponds to the command
 159         to switch to this workspace. For named workspaces, this will be -1.
 160 name (string)::
 161         The name of this workspace (by default num+1), as changed by the
 162         user. Encoded in UTF-8.
 163 visible (boolean)::
 164         Whether this workspace is currently visible on an output (multiple
 165         workspaces can be visible at the same time).
 166 focused (boolean)::
 167         Whether this workspace currently has the focus (only one workspace
 168         can have the focus at the same time).
 169 urgent (boolean)::
 170         Whether a window on this workspace has the "urgent" flag set.
 171 rect (map)::
 172         The rectangle of this workspace (equals the rect of the output it
 173         is on), consists of x, y, width, height.
 174 output (string)::
 175         The video output this workspace is on (LVDS1, VGA1, …).
 176
 177 *Example:*
 178 -------------------
 179 [
 180  {
 181   "num": 0,
 182   "name": "1",
 183   "visible": true,
 184   "focused": true,
 185   "urgent": false,
 186   "rect": {
 187    "x": 0,
 188    "y": 0,
 189    "width": 1280,
 190    "height": 800
 191   },
 192   "output": "LVDS1"
 193  },
 194  {
 195   "num": 1,
 196   "name": "2",
 197   "visible": false,
 198   "focused": false,
 199   "urgent": false,
 200   "rect": {
 201    "x": 0,
 202    "y": 0,
 203    "width": 1280,
 204    "height": 800
 205   },
 206   "output": "LVDS1"
 207  }
 208 ]
 209 -------------------
 210
 211 === SUBSCRIBE reply
 212
 213 The reply consists of a single serialized map. The only property is
 214 +success (bool)+, indicating whether the subscription was successful (the
 215 default) or whether a JSON parse error occurred.
 216
 217 *Example:*
 218 -------------------
 219 { "success": true }
 220 -------------------
 221
 222 === OUTPUTS reply
 223
 224 The reply consists of a serialized list of outputs. Each output has the
 225 following properties:
 226
 227 name (string)::
 228         The name of this output (as seen in +xrandr(1)+). Encoded in UTF-8.
 229 active (boolean)::
 230         Whether this output is currently active (has a valid mode).
 231 current_workspace (string)::
 232         The name of the current workspace that is visible on this output. +null+ if
 233         the output is not active.
 234 rect (map)::
 235         The rectangle of this output (equals the rect of the output it
 236         is on), consists of x, y, width, height.
 237
 238 *Example:*
 239 -------------------
 240 [
 241  {
 242   "name": "LVDS1",
 243   "active": true,
 244   "current_workspace": "4",
 245   "rect": {
 246    "x": 0,
 247    "y": 0,
 248    "width": 1280,
 249    "height": 800
 250   }
 251  },
 252  {
 253   "name": "VGA1",
 254   "active": true,
 255   "current_workspace": "1",
 256   "rect": {
 257    "x": 1280,
 258    "y": 0,
 259    "width": 1280,
 260    "height": 1024
 261   },
 262  }
 263 ]
 264 -------------------
 265
 266 === TREE reply
 267
 268 The reply consists of a serialized tree. Each node in the tree (representing
 269 one container) has at least the properties listed below. While the nodes might
 270 have more properties, please do not use any properties which are not documented
 271 here. They are not yet finalized and will probably change!
 272
 273 id (integer)::
 274         The internal ID (actually a C pointer value) of this container. Do not
 275         make any assumptions about it. You can use it to (re-)identify and
 276         address containers when talking to i3.
 277 name (string)::
 278         The internal name of this container. For all containers which are part
 279         of the tree structure down to the workspace contents, this is set to a
 280         nice human-readable name of the container.
 281         For containers that have an X11 window, the content is the title
 282         (_NET_WM_NAME property) of that window.
 283         For all other containers, the content is not defined (yet).
 284 type (string)::
 285         Type of this container. Can be one of "root", "output", "con",
 286         "floating_con", "workspace" or "dockarea".
 287 border (string)::
 288         Can be either "normal", "none" or "1pixel", dependending on the
 289         container’s border style.
 290 current_border_width (integer)::
 291         Number of pixels of the border width.
 292 layout (string)::
 293         Can be either "splith", "splitv", "stacked", "tabbed", "dockarea" or
 294         "output".
 295         Other values might be possible in the future, should we add new
 296         layouts.
 297 orientation (string)::
 298         Can be either "none" (for non-split containers), "horizontal" or
 299         "vertical".
 300         THIS FIELD IS OBSOLETE. It is still present, but your code should not
 301         use it. Instead, rely on the layout field.
 302 percent (float)::
 303         The percentage which this container takes in its parent. A value of
 304         +null+ means that the percent property does not make sense for this
 305         container, for example for the root container.
 306 rect (map)::
 307         The absolute display coordinates for this container. Display
 308         coordinates means that when you have two 1600x1200 monitors on a single
 309         X11 Display (the standard way), the coordinates of the first window on
 310         the second monitor are +{ "x": 1600, "y": 0, "width": 1600, "height":
 311         1200 }+.
 312 window_rect (map)::
 313         The coordinates of the *actual client window* inside its container.
 314         These coordinates are relative to the container and do not include the
 315         window decoration (which is actually rendered on the parent container).
 316         So, when using the +default+ layout, you will have a 2 pixel border on
 317         each side, making the window_rect +{ "x": 2, "y": 0, "width": 632,
 318         "height": 366 }+ (for example).
 319 deco_rect (map)::
 320         The coordinates of the *window decoration* inside its container. These
 321         coordinates are relative to the container and do not include the actual
 322         client window.
 323 geometry (map)::
 324         The original geometry the window specified when i3 mapped it. Used when
 325         switching a window to floating mode, for example.
 326 window (integer)::
 327         The X11 window ID of the *actual client window* inside this container.
 328         This field is set to null for split containers or otherwise empty
 329         containers. This ID corresponds to what xwininfo(1) and other
 330         X11-related tools display (usually in hex).
 331 urgent (bool)::
 332         Whether this container (window or workspace) has the urgency hint set.
 333 focused (bool)::
 334         Whether this container is currently focused.
 335
 336 Please note that in the following example, I have left out some keys/values
 337 which are not relevant for the type of the node. Otherwise, the example would
 338 be by far too long (it already is quite long, despite showing only 1 window and
 339 one dock window).
 340
 341 It is useful to have an overview of the structure before taking a look at the
 342 JSON dump:
 343
 344 * root
 345 ** LVDS1
 346 *** topdock
 347 *** content
 348 **** workspace 1
 349 ***** window 1
 350 *** bottomdock
 351 **** dock window 1
 352 ** VGA1
 353
 354 *Example:*
 355 -----------------------
 356 {
 357  "id": 6875648,
 358  "name": "root",
 359  "rect": {
 360    "x": 0,
 361    "y": 0,
 362    "width": 1280,
 363    "height": 800
 364  },
 365  "nodes": [
 366
 367    {
 368     "id": 6878320,
 369     "name": "LVDS1",
 370     "layout": "output",
 371     "rect": {
 372       "x": 0,
 373       "y": 0,
 374       "width": 1280,
 375       "height": 800
 376     },
 377     "nodes": [
 378
 379       {
 380        "id": 6878784,
 381        "name": "topdock",
 382        "layout": "dockarea",
 383        "orientation": "vertical",
 384        "rect": {
 385          "x": 0,
 386          "y": 0,
 387          "width": 1280,
 388          "height": 0
 389        },
 390       },
 391
 392       {
 393        "id": 6879344,
 394        "name": "content",
 395        "rect": {
 396          "x": 0,
 397          "y": 0,
 398          "width": 1280,
 399          "height": 782
 400        },
 401        "nodes": [
 402
 403          {
 404           "id": 6880464,
 405           "name": "1",
 406           "orientation": "horizontal",
 407           "rect": {
 408             "x": 0,
 409             "y": 0,
 410             "width": 1280,
 411             "height": 782
 412           },
 413           "floating_nodes": [],
 414           "nodes": [
 415
 416             {
 417              "id": 6929968,
 418              "name": "#aa0000",
 419              "border": "normal",
 420              "percent": 1,
 421              "rect": {
 422                "x": 0,
 423                "y": 18,
 424                "width": 1280,
 425                "height": 782
 426              }
 427             }
 428
 429           ]
 430          }
 431
 432        ]
 433       },
 434
 435       {
 436        "id": 6880208,
 437        "name": "bottomdock",
 438        "layout": "dockarea",
 439        "orientation": "vertical",
 440        "rect": {
 441          "x": 0,
 442          "y": 782,
 443          "width": 1280,
 444          "height": 18
 445        },
 446        "nodes": [
 447
 448          {
 449           "id": 6931312,
 450           "name": "#00aa00",
 451           "percent": 1,
 452           "rect": {
 453             "x": 0,
 454             "y": 782,
 455             "width": 1280,
 456             "height": 18
 457           }
 458          }
 459
 460        ]
 461       }
 462     ]
 463    }
 464  ]
 465 }
 466 ------------------------
 467
 468 === MARKS reply
 469
 470 The reply consists of a single array of strings for each container that has a
 471 mark. A mark can only be set on one container, so the array is unique.
 472 The order of that array is undefined.
 473
 474 If no window has a mark the response will be the empty array [].
 475
 476 === BAR_CONFIG reply
 477
 478 This can be used by third-party workspace bars (especially i3bar, but others
 479 are free to implement compatible alternatives) to get the +bar+ block
 480 configuration from i3.
 481
 482 Depending on the input, the reply is either:
 483
 484 empty input::
 485         An array of configured bar IDs
 486 Bar ID::
 487         A JSON map containing the configuration for the specified bar.
 488
 489 Each bar configuration has the following properties:
 490
 491 id (string)::
 492         The ID for this bar. Included in case you request multiple
 493         configurations and want to differentiate the different replies.
 494 mode (string)::
 495         Either +dock+ (the bar sets the dock window type) or +hide+ (the bar
 496         does not show unless a specific key is pressed).
 497 position (string)::
 498         Either +bottom+ or +top+ at the moment.
 499 status_command (string)::
 500         Command which will be run to generate a statusline. Each line on stdout
 501         of this command will be displayed in the bar. At the moment, no
 502         formatting is supported.
 503 font (string)::
 504         The font to use for text on the bar.
 505 workspace_buttons (boolean)::
 506         Display workspace buttons or not? Defaults to true.
 507 binding_mode_indicator (boolean)::
 508         Display the mode indicator or not? Defaults to true.
 509 verbose (boolean)::
 510         Should the bar enable verbose output for debugging? Defaults to false.
 511 colors (map)::
 512         Contains key/value pairs of colors. Each value is a color code in hex,
 513         formatted #rrggbb (like in HTML).
 514
 515 The following colors can be configured at the moment:
 516
 517 background::
 518         Background color of the bar.
 519 statusline::
 520         Text color to be used for the statusline.
 521 separator::
 522         Text color to be used for the separator.
 523 focused_background::
 524         Background color of the bar on the currently focused monitor output.
 525 focused_statusline::
 526         Text color to be used for the statusline on the currently focused
 527         monitor output.
 528 focused_separator::
 529         Text color to be used for the separator on the currently focused
 530         monitor output.
 531 focused_workspace_text/focused_workspace_bg/focused_workspace_border::
 532         Text/background/border color for a workspace button when the workspace
 533         has focus.
 534 active_workspace_text/active_workspace_bg/active_workspace_border::
 535         Text/background/border color for a workspace button when the workspace
 536         is active (visible) on some output, but the focus is on another one.
 537         You can only tell this apart from the focused workspace when you are
 538         using multiple monitors.
 539 inactive_workspace_text/inactive_workspace_bg/inactive_workspace_border::
 540         Text/background/border color for a workspace button when the workspace
 541         does not have focus and is not active (visible) on any output. This
 542         will be the case for most workspaces.
 543 urgent_workspace_text/urgent_workspace_bg/urgent_workspace_border::
 544         Text/background/border color for workspaces which contain at least one
 545         window with the urgency hint set.
 546 binding_mode_text/binding_mode_bg/binding_mode_border::
 547         Text/background/border color for the binding mode indicator.
 548
 549
 550 *Example of configured bars:*
 551 --------------
 552 ["bar-bxuqzf"]
 553 --------------
 554
 555 *Example of bar configuration:*
 556 --------------
 557 {
 558  "id": "bar-bxuqzf",
 559  "mode": "dock",
 560  "position": "bottom",
 561  "status_command": "i3status",
 562  "font": "-misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1",
 563  "workspace_buttons": true,
 564  "binding_mode_indicator": true,
 565  "verbose": false,
 566  "colors": {
 567    "background": "#c0c0c0",
 568    "statusline": "#00ff00",
 569    "focused_workspace_text": "#ffffff",
 570    "focused_workspace_bg": "#000000"
 571  }
 572 }
 573 --------------
 574
 575 === VERSION reply
 576
 577 The reply consists of a single JSON dictionary with the following keys:
 578
 579 major (integer)::
 580         The major version of i3, such as +4+.
 581 minor (integer)::
 582         The minor version of i3, such as +2+. Changes in the IPC interface (new
 583         features) will only occur with new minor (or major) releases. However,
 584         bugfixes might be introduced in patch releases, too.
 585 patch (integer)::
 586         The patch version of i3, such as +1+ (when the complete version is
 587         +4.2.1+). For versions such as +4.2+, patch will be set to +0+.
 588 human_readable (string)::
 589         A human-readable version of i3 containing the precise git version,
 590         build date and branch name. When you need to display the i3 version to
 591         your users, use the human-readable version whenever possible (since
 592         this is what +i3 --version+ displays, too).
 593 loaded_config_file_name (string)::
 594         The current config path.
 595
 596 *Example:*
 597 -------------------
 598 {
 599    "human_readable" : "4.2-169-gf80b877 (2012-08-05, branch \"next\")",
 600    "loaded_config_file_name" : "/home/hwangcc23/.i3/config",
 601    "minor" : 2,
 602    "patch" : 0,
 603    "major" : 4
 604 }
 605 -------------------
 606
 607 == Events
 608
 609 [[events]]
 610
 611 To get informed when certain things happen in i3, clients can subscribe to
 612 events. Events consist of a name (like "workspace") and an event reply type
 613 (like I3_IPC_EVENT_WORKSPACE). The events sent by i3 are in the same format
 614 as replies to specific commands. However, the highest bit of the message type
 615 is set to 1 to indicate that this is an event reply instead of a normal reply.
 616
 617 Caveat: As soon as you subscribe to an event, it is not guaranteed any longer
 618 that the requests to i3 are processed in order. This means, the following
 619 situation can happen: You send a GET_WORKSPACES request but you receive a
 620 "workspace" event before receiving the reply to GET_WORKSPACES. If your
 621 program does not want to cope which such kinds of race conditions (an
 622 event based library may not have a problem here), I suggest you create a
 623 separate connection to receive events.
 624
 625 === Subscribing to events
 626
 627 By sending a message of type SUBSCRIBE with a JSON-encoded array as payload
 628 you can register to an event.
 629
 630 *Example:*
 631 ---------------------------------
 632 type: SUBSCRIBE
 633 payload: [ "workspace", "output" ]
 634 ---------------------------------
 635
 636
 637 === Available events
 638
 639 The numbers in parenthesis is the event type (keep in mind that you need to
 640 strip the highest bit first).
 641
 642 workspace (0)::
 643         Sent when the user switches to a different workspace, when a new
 644         workspace is initialized or when a workspace is removed (because the
 645         last client vanished).
 646 output (1)::
 647         Sent when RandR issues a change notification (of either screens,
 648         outputs, CRTCs or output properties).
 649 mode (2)::
 650         Sent whenever i3 changes its binding mode.
 651 window (3)::
 652         Sent when a client's window is successfully reparented (that is when i3
 653         has finished fitting it into a container), when a window received input
 654         focus or when certain properties of the window have changed.
 655 barconfig_update (4)::
 656     Sent when the hidden_state or mode field in the barconfig of any bar
 657     instance was updated and when the config is reloaded.
 658 binding (5)::
 659         Sent when a configured command binding is triggered with the keyboard or
 660         mouse
 661
 662 *Example:*
 663 --------------------------------------------------------------------
 664 # the appropriate 4 bytes read from the socket are stored in $input
 665
 666 # unpack a 32-bit unsigned integer
 667 my $message_type = unpack("L", $input);
 668
 669 # check if the highest bit is 1
 670 my $is_event = (($message_type >> 31) == 1);
 671
 672 # use the other bits
 673 my $event_type = ($message_type & 0x7F);
 674
 675 if ($is_event) {
 676   say "Received event of type $event_type";
 677 }
 678 --------------------------------------------------------------------
 679
 680 === workspace event
 681
 682 This event consists of a single serialized map containing a property
 683 +change (string)+ which indicates the type of the change ("focus", "init",
 684 "empty", "urgent"). A +current (object)+ property will be present with the
 685 affected workspace whenever the type of event affects a workspace (otherwise,
 686 it will be +null).
 687
 688 When the change is "focus", an +old (object)+ property will be present with the
 689 previous workspace.  When the first switch occurs (when i3 focuses the
 690 workspace visible at the beginning) there is no previous workspace, and the
 691 +old+ property will be set to +null+.  Also note that if the previous is empty
 692 it will get destroyed when switching, but will still be present in the "old"
 693 property.
 694
 695 *Example:*
 696 ---------------------
 697 {
 698  "change": "focus",
 699  "current": {
 700   "id": 28489712,
 701   "type": "workspace",
 702   ...
 703  }
 704  "old": {
 705   "id": 28489715,
 706   "type": "workspace",
 707   ...
 708  }
 709 }
 710 ---------------------
 711
 712 === output event
 713
 714 This event consists of a single serialized map containing a property
 715 +change (string)+ which indicates the type of the change (currently only
 716 "unspecified").
 717
 718 *Example:*
 719 ---------------------------
 720 { "change": "unspecified" }
 721 ---------------------------
 722
 723 === mode event
 724
 725 This event consists of a single serialized map containing a property
 726 +change (string)+ which holds the name of current mode in use. The name
 727 is the same as specified in config when creating a mode. The default
 728 mode is simply named default. It contains a second property, +pango_markup+, which
 729 defines whether pango markup shall be used for displaying this mode.
 730
 731 *Example:*
 732 ---------------------------
 733 {
 734   "change": "default",
 735   "pango_markup": true
 736 }
 737 ---------------------------
 738
 739 === window event
 740
 741 This event consists of a single serialized map containing a property
 742 +change (string)+ which indicates the type of the change
 743
 744 * +new+ - the window has become managed by i3
 745 * +close+ - the window has closed
 746 * +focus+ - the window has received input focus
 747 * +title+ - the window's title has changed
 748 * +fullscreen_mode+ - the window has entered or exited fullscreen mode
 749 * +move+ - the window has changed its position in the tree
 750 * +floating+ - the window has transitioned to or from floating
 751 * +urgent+ - the window has become urgent or lost its urgent status
 752
 753 Additionally a +container (object)+ field will be present, which consists
 754 of the window's parent container. Be aware that for the "new" event, the
 755 container will hold the initial name of the newly reparented window (e.g.
 756 if you run urxvt with a shell that changes the title, you will still at
 757 this point get the window title as "urxvt").
 758
 759 *Example:*
 760 ---------------------------
 761 {
 762  "change": "new",
 763  "container": {
 764   "id": 35569536,
 765   "type": "con",
 766   ...
 767  }
 768 }
 769 ---------------------------
 770
 771 === barconfig_update event
 772
 773 This event consists of a single serialized map reporting on options from the
 774 barconfig of the specified bar_id that were updated in i3. This event is the
 775 same as a +GET_BAR_CONFIG+ reply for the bar with the given id.
 776
 777 === binding event
 778
 779 This event consists of a single serialized map reporting on the details of a
 780 binding that ran a command because of user input. The +change (sring)+ field
 781 indicates what sort of binding event was triggered (right now it will always be
 782 +"run"+ but may be expanded in the future).
 783
 784 The +binding (object)+ field contains details about the binding that was run:
 785
 786 command (string)::
 787         The i3 command that is configured to run for this binding.
 788 event_state_mask (array of strings)::
 789         The group and modifier keys that were configured with this binding.
 790 input_code (integer)::
 791         If the binding was configured with +bindcode+, this will be the key code
 792         that was given for the binding. If the binding is a mouse binding, it will be
 793         the number of the mouse button that was pressed. Otherwise it will be 0.
 794 symbol (string or null)::
 795         If this is a keyboard binding that was configured with +bindsym+, this
 796         field will contain the given symbol. Otherwise it will be +null+.
 797 input_type (string)::
 798         This will be +"keyboard"+ or +"mouse"+ depending on whether or not this was
 799         a keyboard or a mouse binding.
 800
 801 *Example:*
 802 ---------------------------
 803 {
 804  "change": "run",
 805  "binding": {
 806   "command": "nop",
 807   "event_state_mask": [
 808     "shift",
 809     "ctrl"
 810   ],
 811   "input_code": 0,
 812   "symbol": "t",
 813   "input_type": "keyboard"
 814  }
 815 }
 816 ---------------------------
 817
 818 == See also (existing libraries)
 819
 820 [[libraries]]
 821
 822 For some languages, libraries are available (so you don’t have to implement
 823 all this on your own). This list names some (if you wrote one, please let me
 824 know):
 825
 826 C::
 827         * i3 includes a headerfile +i3/ipc.h+ which provides you all constants.
 828         * https://github.com/acrisci/i3ipc-glib
 829 Go::
 830         * https://github.com/proxypoke/i3ipc
 831 JavaScript::
 832         * https://github.com/acrisci/i3ipc-gjs
 833 Lua::
 834         * https://github.com/acrisci/i3ipc-lua
 835 Perl::
 836         * https://metacpan.org/module/AnyEvent::I3
 837 Python::
 838         * https://github.com/acrisci/i3ipc-python
 839         * https://github.com/whitelynx/i3ipc (not maintained)
 840         * https://github.com/ziberna/i3-py (not maintained)
 841 Ruby::
 842         * https://github.com/veelenga/i3ipc-ruby
 843         * https://github.com/badboy/i3-ipc (not maintained)
 844 Rust::
 845         * https://github.com/tmerr/i3ipc-rs