ivi_applicatoin extension creates ivi_surface objects tied to a given wl_surface with a given id. The given id can be used in a shell to identify which application is assigned to a wl_surface and layout the surface wherever the shell wants. ivi_surface objects can be used to receive status of wl_surface in the scenegraph of the compositor.
Signed-off-by: Nobuhiko Tanibata <nobuhiko_tanib...@xddp.denso.co.jp> --- Changes for v2: - Rename "error" to "warning" because meaning of "error" in wayland is fatal. Changes for v3: - Move "warning" from ivi_application to ivi_surface. - Squash Makefile. - Add description to ivi_surface:destroy. - Update description of ivi_application:surface_create. Changes for v4: - Remove detail description of server side from ivi_surface::destroy - Add clear discripton what client shall do if it encounters warning in ivi_surface ::warning. - Add decription what happens when client tries to tie a wl_surface to multiple ivi_surfaces. Changes for v5: - apply review comments from mailing list Changes for v6: - the same as v5 protocol/Makefile.am | 3 +- protocol/ivi-application.xml | 101 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 103 insertions(+), 1 deletion(-) create mode 100644 protocol/ivi-application.xml diff --git a/protocol/Makefile.am b/protocol/Makefile.am index 5e331a7..9913f16 100644 --- a/protocol/Makefile.am +++ b/protocol/Makefile.am @@ -8,7 +8,8 @@ protocol_sources = \ text-cursor-position.xml \ wayland-test.xml \ xdg-shell.xml \ - scaler.xml + scaler.xml \ + ivi-application.xml if HAVE_XMLLINT .PHONY: validate diff --git a/protocol/ivi-application.xml b/protocol/ivi-application.xml new file mode 100644 index 0000000..833fd38 --- /dev/null +++ b/protocol/ivi-application.xml @@ -0,0 +1,101 @@ +<?xml version="1.0" encoding="UTF-8"?> +<protocol name="ivi_application"> + + <copyright> + Copyright (C) 2013 DENSO CORPORATION + Copyright (c) 2013 BMW Car IT GmbH + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in + all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + THE SOFTWARE. + </copyright> + + <interface name="ivi_surface" version="1"> + <description summary="application interface to surface in ivi compositor"/> + + <request name="destroy" type="destructor"> + <description summary="destroy ivi_surface"> + This removes link from ivi_id to wl_surface and destroys ivi_surface. + </description> + </request> + + <event name="visibility"> + <description summary="visibility of surface in ivi compositor has changed"> + The new visibility state is provided in argument visibility. + If visibility is 0, the surface has become invisible. + If visibility is not 0, the surface has become visible. + </description> + <arg name="visibility" type="int"/> + </event> + + <enum name="warning_code"> + <description summary="possible warning codes returned by ivi compositor"> + These define all possible warning codes returned by ivi compositor on server-side warnings. + invalid_wl_surface: + - wl_surface already has a another role. + - wl_surface is destroyed before the ivi_surface is destroyed. + ivi_id_in_use: ivi_id is already assigned by another application. + </description> + <entry name="invalid_wl_surface" value="1" summary="wl_surface is invalid"/> + <entry name="ivi_id_in_use" value="2" summary="ivi_id is in use and can not be shared"/> + </enum> + + <event name="warning"> + <description summary="server-side warning detected"> + The ivi compositor encountered warning while processing a request by this + application. The warning is defined by argument warning_code and optional + warning_text. If the warning is detected, client shall destroy the ivi_surface + object. + + When a warning event is sent, the compositor turns the ivi_surface object inert. + The ivi_surface will not deliver further events, all requests on it are ignored + except 'destroy', and the association to the ivi_id is removed. The client + should destroy the ivi_surface object. If an inert ivi_surface object is used as + an argument to any other object's request, that request will [produce a fatal + error / produce a warning / be ignored]. + </description> + <arg name="warning_code" type="int"/> + <arg name="warning_text" type="string" allow-null="true"/> + </event> + + </interface> + + <interface name="ivi_application" version="1"> + <description summary="create ivi-style surfaces"> + This interface is implemented by servers that provide desktop-style user interfaces. + It allows clients to associate a ivi_surface with a basic surface. + </description> + + <request name="surface_create"> + <description summary="create ivi_surface with numeric ID in ivi compositor"> + surface_create will create a interface:ivi_surface with numeric ID; ivi_id in + ivi compositor. These ivi_ids are defined as unique in the system to identify + it inside of ivi compositor. The ivi compositor implements business logic how to + set properties of the surface with ivi_id according to status of the system. + E.g. a unique ID for Car Navigation application is used for implementing special + logic of the application about where it shall be located. + if a wl_surface which already has another role is set, the server regards this as + error and disconnects the client. + </description> + <arg name="ivi_id" type="uint"/> + <arg name="surface" type="object" interface="wl_surface"/> + <arg name="id" type="new_id" interface="ivi_surface"/> + </request> + + </interface> + +</protocol> -- 1.8.3.1 _______________________________________________ wayland-devel mailing list wayland-devel@lists.freedesktop.org http://lists.freedesktop.org/mailman/listinfo/wayland-devel