protocol/agl-shell.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <protocol name="agl_shell">
   3   <copyright>
   4     Copyright © 2019, 2022 Collabora, Ltd.
   5
   6     Permission is hereby granted, free of charge, to any person obtaining a
   7     copy of this software and associated documentation files (the "Software"),
   8     to deal in the Software without restriction, including without limitation
   9     the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10     and/or sell copies of the Software, and to permit persons to whom the
  11     Software is furnished to do so, subject to the following conditions:
  12
  13     The above copyright notice and this permission notice (including the next
  14     paragraph) shall be included in all copies or substantial portions of the
  15     Software.
  16
  17     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18     IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19     FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20     THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21     LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  22     FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  23     DEALINGS IN THE SOFTWARE.
  24   </copyright>
  25   <interface name="agl_shell" version="7">
  26     <description summary="user interface for Automotive Grade Linux platform">
  27       Starting with version 2 of the protocol, the client is required to wait
  28       for the 'bound_ok' or 'bound_fail' events in order to proceed further.
  29
  30       In case the client gets a 'bound_fail' event then it should consider that
  31       there's another client already bound to the agl_shell protocol.
  32       A client that receives a 'bound_ok' event should consider that there's
  33       no other client already bound to the interface and can proceed further.
  34
  35       If the client uses an older version of the protocol it will receive
  36       automatically an error and the compositor will terminate the connection,
  37       if there's another client already bound the interface.
  38
  39       If the client receives the 'bound_fail' event and attempts to use the
  40       interface further it will receive an error and the compositor will
  41       terminate the connection. After the 'bound_fail' event was received the
  42       client should call the destructor, which has been added with version 2
  43       of the protocol. The client is free to try at a later point in time to
  44       see if it will receive the 'bound_ok' event, but there's no explicit way
  45       of finding out when that event will be delivered.
  46       It is assumed that it can infer that information through other
  47       means/other channels.
  48     </description>
  49
  50     <enum name="error">
  51       <entry name="invalid_argument" value="0"/>
  52       <entry name="background_exists" value="1"/>
  53       <entry name="panel_exists" value="2"/>
  54     </enum>
  55
  56     <enum name="edge">
  57       <entry name="top" value="0"/>
  58       <entry name="bottom" value="1"/>
  59       <entry name="left" value="2"/>
  60       <entry name="right" value="3"/>
  61     </enum>
  62
  63     <enum name="app_state" since="3">
  64       <entry name="started" value="0"/>
  65       <entry name="terminated" value="1"/>
  66       <entry name="activated" value="2"/>
  67       <entry name="deactivated" value="3"/>
  68     </enum>
  69
  70     <request name="ready">
  71       <description summary="client is ready to be shown">
  72         Tell the server that this client is ready to be shown. The server
  73         will delay presentation during start-up until all shell clients are
  74         ready to be shown, and will display a black screen instead.
  75         This gives the client an opportunity to set up and configure several
  76         surfaces into a coherent interface.
  77
  78         The client that binds to this interface must send this request, otherwise
  79         they may stall the compositor unnecessarily.
  80
  81         If this request is called after the compositor has already finished
  82         start-up, no operation is performed.
  83       </description>
  84     </request>
  85
  86     <request name="set_background">
  87       <description summary="set surface as output's background">
  88         Set the surface to act as the background of an output. After this
  89         request, the server will immediately send a configure event with
  90         the dimensions the client should use to cover the entire output.
  91
  92         The surface must have a "desktop" surface role, as supported by
  93         libweston-desktop.
  94
  95         Only a single surface may be the background for any output. If a
  96         background surface already exists, a protocol error is raised.
  97       </description>
  98       <arg name="surface" type="object" interface="wl_surface"/>
  99       <arg name="output" type="object" interface="wl_output"/>
 100     </request>
 101
 102     <request name="set_panel">
 103       <description summary="set surface as panel">
 104         Set the surface to act as a panel of an output. The 'edge' argument
 105         says what edge of the output the surface will be anchored to.
 106         After this request, the server will send a configure event with the
 107         corresponding width/height that the client should use, and 0 for the
 108         other dimension. E.g. if the edge is 'top', the width will be the
 109         output's width, and the height will be 0.
 110
 111         The surface must have a "desktop" surface role, as supported by
 112         libweston-desktop.
 113
 114         The compositor will take the panel's window geometry into account when
 115         positioning other windows, so the panels are not covered.
 116
 117         XXX: What happens if e.g. both top and left are used at the same time?
 118         Who gets to have the corner?
 119
 120         Only a single surface may be the panel for an output's edge. If a
 121         surface already exists on an edge, a protocol error is raised.
 122       </description>
 123       <arg name="surface" type="object" interface="wl_surface"/>
 124       <arg name="output" type="object" interface="wl_output"/>
 125       <arg name="edge" type="uint" enum="edge"/>
 126     </request>
 127
 128     <request name="activate_app">
 129       <description summary="make client current window">
 130         Ask the compositor to make a toplevel to become the current/focused
 131         window for window management purposes.
 132
 133         See xdg_toplevel.set_app_id from the xdg-shell protocol for a
 134         description of app_id.
 135
 136         If multiple toplevels have the same app_id, the result is unspecified.
 137
 138         XXX: Do we need feedback to say it didn't work? (e.g. client does
 139         not exist)
 140       </description>
 141       <arg name="app_id" type="string"/>
 142       <arg name="output" type="object" interface="wl_output"/>
 143     </request>
 144
 145     <event name="bound_ok" since="2">
 146      <description summary="event sent if binding was ok">
 147         Informs the client that it was able to bind the agl_shell
 148         interface succesfully. Clients are required to wait for this
 149         event before continuing further.
 150      </description>
 151     </event>
 152
 153     <event name="bound_fail" since="2">
 154       <description summary="event sent if binding was nok">
 155         Informs the client that binding to the agl_shell interface was
 156         unsuccesfull. Clients are required to wait for this event for
 157         continuing further.
 158       </description>
 159     </event>
 160
 161     <request name="destroy" type="destructor" since="2">
 162       <description summary="destroys the factory object">
 163       </description>
 164     </request>
 165
 166     <event name="app_state" since="3">
 167       <description summary="event sent when an application suffered state modification">
 168         Informs the client that an application has changed its state to another,
 169         specified by the app_state enum. Client can use this event to track
 170         current application state. For instance to know when the application has
 171         started, or when terminated/stopped.
 172       </description>
 173       <arg name="app_id" type="string"/>
 174       <arg name="state" type="uint" enum="app_state"/>
 175     </event>
 176
 177     <request name="set_activate_region" since="4">
 178       <description summary="sets a specific region to activate">
 179       A hint for the compositor to use a custom area, rather than
 180       inferring the activation area. If any panels are used
 181       the compositor computes the activation area by subtracting the
 182       panels geometry area. If no panels are used then the entire output
 183       is being used. This request changes that as to hint the compositor
 184       to use the supplied rectangle and ignore any potential panels
 185       that might been set-up previously.
 186
 187       In order for this request to take effect it will need to happen
 188       before the 'ready' request in order for the compositor to make use of it.
 189       Note that any 'set_panel' request be will not be honored, if this request
 190       has been called.
 191
 192       The x and y coordinates use the top-left corner as the origin. The
 193       rectangle area shouldn't exceed the output area, while an area smaller
 194       than the output, would basically result in showing up the background
 195       surface.
 196       </description>
 197       <arg name="output" type="object" interface="wl_output"/>
 198       <arg name="x" type="int" summary="x position of rectangle"/>
 199       <arg name="y" type="int" summary="y position of rectangle"/>
 200       <arg name="width" type="int" summary="width of rectangle"/>
 201       <arg name="height" type="int" summary="height of rectangle"/>
 202     </request>
 203
 204     <request name="deactivate_app" since="5">
 205       <description summary="de-activate/hide window identified by app_id">
 206         Ask the compositor to hide the toplevel window for window
 207         management purposes. Depending on the window role, this request
 208         will either display the previously active window (or the background
 209         in case there's no previously active surface) or temporarily (or
 210         until a 'activate_app' is called upon) hide the surface.
 211
 212         All the surfaces are identifiable by using the app_id, and no actions
 213         are taken in case the app_id is not/was not present.
 214
 215         See xdg_toplevel.set_app_id from the xdg-shell protocol for a
 216         description of app_id.
 217       </description>
 218       <arg name="app_id" type="string"/>
 219     </request>
 220
 221     <request name="set_app_float" since="6">
 222       <description summary="set the window identified by app_id as float">
 223         Makes the application identified by app_id as floating. If the
 224         application's window is already mapped, in a maximized, normal state,
 225         it would transition to the float state.
 226
 227         For applications that want to modify their own state, this request
 228         must be done before the initial surface commit in order to take effect.
 229
 230         If the application is already in floating state, this request wouldn't
 231         do anything.
 232
 233         There's no persistence of this request, once the application terminated
 234         you'll to issue this request again for that particular app_id.
 235
 236         The x, and y values would be initial position of the window where the
 237         window surface will be placed.
 238
 239         See xdg_toplevel.set_app_id from the xdg-shell protocol for a
 240         description of app_id.
 241       </description>
 242       <arg name="app_id" type="string"/>
 243       <arg name="x" type="int" summary="x position"/>
 244       <arg name="y" type="int" summary="y position"/>
 245     </request>
 246
 247     <request name="set_app_normal" since="6">
 248       <description summary="set the window identified by app_id as normally started">
 249       Returns the application identified by app_id as it was in the normal state.
 250       This is useful to come back from other states to the maximized state, the
 251       normal state applications are started.
 252       </description>
 253       <arg name="app_id" type="string"/>
 254     </request>
 255
 256     <request name="set_app_fullscreen" since="7">
 257       <description summary="">
 258         Makes the application identified by app_id as fullscreen. If the
 259         application's window is already mapped, in a maximized, normal state,
 260         it would transition to the fullscreen state.
 261
 262         For applications that want to modify their own state, this request
 263         must be done before the initial surface commit in order to take effect.
 264
 265         If the application is already in fullscreen state, this request wouldn't
 266         do anything.
 267
 268         There's no persistence of this request, once the application terminated
 269         you'll to issue this request again for that particular app_id.
 270
 271         See xdg_toplevel.set_app_id from the xdg-shell protocol for a
 272         description of app_id.
 273       </description>
 274       <arg name="app_id" type="string"/>
 275     </request>
 276   </interface>
 277
 278   <interface name="agl_shell_ext" version="1">
 279     <description summary="extended user interface for Automotive Grade Linux platform">
 280       This interface allows another client bind to the agl_shell interface,
 281       while there's another shell client already present.
 282
 283       The client should first bind to this interface and then inform the
 284       compositor with the 'doas_shell_client' request and it wants to bind to
 285       the agl_shell interface. The client is still expected, if using a new
 286       version of the agl_shell interface, to wait for the 'bound_ok' and
 287       'bound_fail' events before issueing any other requests/events.
 288
 289       Note that this interface has its limitations, and the compositor would
 290       still refuse the act for 'set_panel' or 'set_background' requests
 291       of the agl_shell interface if there's already a client that used them.
 292
 293       Any other requests or events should be delievered and handled as it would
 294       a client bound to the agl_shell interface.
 295     </description>
 296
 297     <enum name="doas_shell_client_status">
 298       <entry name="success" value="0"/>
 299       <entry name="failed" value="1"/>
 300     </enum>
 301
 302     <request name="destroy" type="destructor">
 303       <description summary="destroys the factory object">
 304         Call the destructor once you're ready with agl_shell_ext interface.
 305         This would reset the state and would make any requests made
 306         on the agl_shell interface be terminated. The client would need
 307         to bind again the agl_shell_ext and issue a 'doas_shell_client'
 308         request.
 309       </description>
 310     </request>
 311
 312     <request name="doas_shell_client">
 313       <description summary="Informs the compositor it wants to bind to the
 314       agl_shell interface">
 315         Prior to binding to agl_shell interface, this request would inform
 316         the compositor that it wants to gain access the agl_shell interface.
 317         The client is expected to wait for 'doas_shell_client_done' event and
 318         check for a successful status before going further with binding to
 319         the agl_shell interface.
 320       </description>
 321     </request>
 322
 323     <event name="doas_done">
 324       <description summary="event sent as a reply to doas_shell_client">
 325         The client should check the status event to verify that the
 326         compositor was able to handle the request.
 327       </description>
 328       <arg name="status" type="uint" enum="doas_shell_client_status"/>
 329     </event>
 330   </interface>
 331 </protocol>