From f144f0f71f1b75df9216c36747513444c7941c09 Mon Sep 17 00:00:00 2001 From: Yusuke Binsaki Date: Wed, 10 Feb 2016 18:52:59 +0900 Subject: Implement initial IVI-shell support with shell integration. IVI-shell provides a shell interface for Weston, which maps the GENIVI API (http://www.genivi.org) for In-Vehicle Infotainment as Wayland-Ivi-Extension (http://wiki.projects.genivi.org/index.php/Wayland_IVI_Extension_Design). This patch is included in two protocol. The first is ivi-application protocol which provided by weston. Next is ivi-controller protocol which provided by Genivi's wayland-ivi-extension. In IVI use case, the client create and destroy surface with the unique ID by using ivi-application protocol. On the other hand, the controller such as HMI Controller control some properties, which are visibility, position, size, etc, with created the unique ID by using ivi-controller protocol. It means the unique ID is necessary to create and control the ivi-surface and the the ivi-layer. However Qt has no API to set the some surface or layer ID. In this ivi-shell plugin, the unique ID can be set via the environment parameter so that we can control the ivi-surface and ivi-layer. The name of environment parameter is QT_IVI_SURFACE_ID. QT_IVI_SURFACE_ID will be used as ivi-surface and ivi-layer. If application needs more than two surfaces, ivi-surface IDs will be incremented. When QT_IVI_SURFACE_ID isn't set, ivi-surface and ivi-layer ID will be generated internally. The ID consists of the process ID and the surface ID which is incremented in ivi-shell plugin. The process ID is used as lower 22 bit per 32bit. 23 to 32 bit is used as the surface IDs in a process. e.g. When the process ID is 0x765 and create two surfaces, ivi-layer ID is 0x765 and ivi-surface IDs are 0x765 and 0x00400765. +------------+---------------------------+ |31 23|22 0| +------------+---------------------------+ |0000 0000 00|00 0000 0000 0000 0000 0000| |<- ID ->|<- process ID ->| +------------+---------------------------+ We can set QT_WAYLAND_SHELL_INTEGRATION of the environment parameter to "ivi-shell" to use IVI-shell. Change-Id: Iddcfb3de89dc022530c0285524cf6bbf640147b6 Reviewed-by: Giulio Camuffo --- .gitignore | 6 + README | 23 + src/3rdparty/protocol/ivi-application.xml | 99 ++++ src/3rdparty/protocol/ivi-controller.xml | 603 +++++++++++++++++++++ src/client/client.pro | 3 +- src/plugins/plugins.pro | 3 +- src/plugins/shellintegration/ivi-shell/README | 33 ++ .../shellintegration/ivi-shell/ivi-shell.json | 3 + .../shellintegration/ivi-shell/ivi-shell.pro | 38 ++ src/plugins/shellintegration/ivi-shell/main.cpp | 61 +++ .../ivi-shell/qwaylandivishellintegration.cpp | 173 ++++++ .../ivi-shell/qwaylandivishellintegration.h | 77 +++ .../ivi-shell/qwaylandivisurface.cpp | 87 +++ .../ivi-shell/qwaylandivisurface_p.h | 71 +++ src/plugins/shellintegration/shellintegration.pro | 3 + 15 files changed, 1281 insertions(+), 2 deletions(-) create mode 100644 src/3rdparty/protocol/ivi-application.xml create mode 100644 src/3rdparty/protocol/ivi-controller.xml create mode 100644 src/plugins/shellintegration/ivi-shell/README create mode 100644 src/plugins/shellintegration/ivi-shell/ivi-shell.json create mode 100644 src/plugins/shellintegration/ivi-shell/ivi-shell.pro create mode 100644 src/plugins/shellintegration/ivi-shell/main.cpp create mode 100644 src/plugins/shellintegration/ivi-shell/qwaylandivishellintegration.cpp create mode 100644 src/plugins/shellintegration/ivi-shell/qwaylandivishellintegration.h create mode 100644 src/plugins/shellintegration/ivi-shell/qwaylandivisurface.cpp create mode 100644 src/plugins/shellintegration/ivi-shell/qwaylandivisurface_p.h create mode 100644 src/plugins/shellintegration/shellintegration.pro diff --git a/.gitignore b/.gitignore index e7ba647b2..6681af4ac 100644 --- a/.gitignore +++ b/.gitignore @@ -68,6 +68,12 @@ src/plugins/hardwareintegration/*/*/qwayland*.h src/plugins/hardwareintegration/*/*/*-server-protocol.h src/plugins/hardwareintegration/*/*/*-client-protocol.h src/plugins/hardwareintegration/*/*/*-protocol.c +src/plugins/shellintegration/ivi-shell/qwayland-ivi-application.h +src/plugins/shellintegration/ivi-shell/qwayland-ivi-application.cpp +src/plugins/shellintegration/ivi-shell/qwayland-ivi-controller.h +src/plugins/shellintegration/ivi-shell/qwayland-ivi-controller.cpp +src/plugins/shellintegration/*/*-client-protocol.h +src/plugins/shellintegration/*/*-protocol.c src/imports/compositor/compositor.qrc tests/auto/client/tst_client tests/auto/compositor/tst_compositor diff --git a/README b/README index f26089766..dcd47d6eb 100644 --- a/README +++ b/README @@ -45,6 +45,29 @@ brcm xcomposite-egl xcomposite-glx +Shell Integration: + +Some platforms, especially non-desktop ones, use a custom Wayland shell +extension. These are tailored to the specific embedded form factor better than +the generic wl_shell or xdg_shell extensions that target desktop systems. + +Instead of adding multiple protocol implementations into the QPA plugin, +a plugin architecture is used for selecting the shell integration; +when creating a shell surface, the protocol to use is taken from +the QT_WAYLAND_SHELL_INTEGRATION environment variable. If one is not provided or +not pointing to a valid plugin, wl_shell or xdg_shell will be used as fallbacks. + +Example Usage: + +Starting the hellowindow example application (one of the examples for qtbase) +with ivi-shell integration: + + QT_WAYLAND_SHELL_INTEGRATION=ivi-shell ./hellowindow -platform wayland + +Available Shell Integrations: + + * ivi-shell + We hang out at #qt-labs and #qt-lighthouse on freenode if you have any questions diff --git a/src/3rdparty/protocol/ivi-application.xml b/src/3rdparty/protocol/ivi-application.xml new file mode 100644 index 000000000..61ec7d273 --- /dev/null +++ b/src/3rdparty/protocol/ivi-application.xml @@ -0,0 +1,99 @@ + + + + + Copyright (C) 2013 DENSO CORPORATION + Copyright (c) 2013 BMW Car IT GmbH + + Permission to use, copy, modify, distribute, and sell this software and + its documentation for any purpose is hereby granted without fee, provided + that the above copyright notice appear in all copies and that both that + copyright notice and this permission notice appear in supporting + documentation, and that the name of the copyright holders not be used in + advertising or publicity pertaining to distribution of the software + without specific, written prior permission. The copyright holders make + no representations about the suitability of this software for any + purpose. It is provided "as is" without express or implied warranty. + + THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS + SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND + FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY + SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER + RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF + CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN + CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + + + + + + + + This removes link from ivi_id to wl_surface and destroys ivi_surface. + The ID, ivi_id, is free and can be used for surface_create again. + + + + + + The configure event asks the client to resize its surface. + + The size is a hint, in the sense that the client is free to + ignore it if it doesn't resize, pick a smaller size (to + satisfy aspect ratio or resize in steps of NxM pixels). + + The client is free to dismiss all but the last configure + event it received. + + The width and height arguments specify the size of the window + in surface local coordinates. + + + + + + + + + This interface is exposed as a global singleton. + This interface is implemented by servers that provide IVI-style user interfaces. + It allows clients to associate a ivi_surface with wl_surface. + + + + + + + + + + This request gives the wl_surface the role of an IVI Surface. Creating more than + one ivi_surface for a wl_surface is not allowed. Note, that this still allows the + following example: + + 1. create a wl_surface + 2. create ivi_surface for the wl_surface + 3. destroy the ivi_surface + 4. create ivi_surface for the wl_surface (with the same or another ivi_id as before) + + 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. + The server regards following cases as protocol errors and disconnects the client. + - wl_surface already has an nother role. + - ivi_id is already assigned to an another wl_surface. + + If client destroys ivi_surface or wl_surface which is assigne to the ivi_surface, + ivi_id which is assigned to the ivi_surface is free for reuse. + + + + + + + + + diff --git a/src/3rdparty/protocol/ivi-controller.xml b/src/3rdparty/protocol/ivi-controller.xml new file mode 100644 index 000000000..521d62525 --- /dev/null +++ b/src/3rdparty/protocol/ivi-controller.xml @@ -0,0 +1,603 @@ + + + + + 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. + + + + + + + + If visibility argument is 0, the surface in the ivi compositor is set to invisible. + If visibility argument is not 0, the surface in the ivi compositor is set to visible. + + + + + + + The valid range for opacity is 0.0 (fully transparent) to 1.0 (fully opaque). + + + + + + + The source rectangle defines the part of the surface content, that is used for + compositing the surface. It can be used, if valid content of the surface is smaller + than the surface. Effectively it can be used to zoom the content of the surface. + x: horizontal start position of scanout area within the surface + y: vertical start position of scanout area within the surface + width: width of scanout area within the surface + height: height of scanout area within the surface + + + + + + + + + + The destination rectangle defines the position and size of a surface on a layer. + The surface will be scaled to this rectangle for rendering. + x: horizontal start position of surface within the layer + y: vertical start position of surface within the layer + width : width of surface within the layer + height: height of surface within the layer + + + + + + + + + + Request the client providing content for this surface, to resize of the buffers + provided as surface content. + + + + + + + + The orientation of a surface in ivi compositor can be rotated in 90 degree steps, + as defined in orientation enum. + + + + + + + Store a screenshot of the surface content in the file provided by argument filename. + + + + + + + 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. + + + + + + + The new opacity state is provided in argument opacity. + The valid range for opactiy is 0.0 (fully transparent) to 1.0 (fully opaque). + + + + + + + The scanout region of the surface content has changed. + The new values for source rectangle are provided by + x: new horizontal start position of scanout area within the surface + y: new vertical start position of scanout area within the surface + width: new width of scanout area within the surface + height: new height of scanout area within the surface + + + + + + + + + + The new values for source rectangle are provided by + x: new horizontal start position of surface within the layer + y: new vertical start position of surface within the layer + width : new width of surface within the layer + height: new height of surface within the layer + + + + + + + + + + The client providing content for this surface was requested to resize the buffer + provided as surface content. The requested buffer size is provided by arguments + width and height. + + + + + + + + The surfaces in ivi controller can be rotated in 90 degrees steps. + This enum defines all valid orientations for surfaces. + + + + + + + + + + The new orientation status is provided by argument orientation. + + + + + + + Applications can provide buffers as surface content with differernt buffer + properties. This enum defines all supported buffer configurations. + + + + + + + + + + + + + + When client attach buffers as surface content, these buffers have a pixelformat + configuration. If the pixelformat of a newly attached buffer is different from + the previous buffer configuration, this event is raised. + This is also done, when the first buffer is provided by application. + + + + + + + This surface was added to the render order of the layer defined by argument layer. + This is essential for a surface to become visible on screen, since ivi compositors + will only render layers (or more precise all surfaces in the render order of a layer). + + + + + + + These stats contain information required for monitoring, debugging, logging + and tracing. + + + + + + The information contained in this event is essential for monitoring, debugging, + logging and tracing support in IVI systems. + + + + + + + + + + + Request to destroy the ivi_controller_surface. If argument + destroy_scene_object id not 0, the surface will be destroyed in + ivi compositor. If argument is 0, only the proxy object is destroyed. + + + + + + + + + + + This enum defines all possible content states of a surface. This is + required, since surfaces in ivi compositor can exist without applications + providing content for them. + + + + + + + + Surfaces in ivi compositor can exist without any application or controller + referencing it. All surfaces initially have no content. This event indicates + when content state has changed. All possible content states are defined + in enum content_state. + + + + + + + + + + + + If visibility argument is 0, the layer in the ivi compositor is set to invisible. + If visibility argument is not 0, the layer in the ivi compositor is set to visible. + + + + + + + The valid range for opacity is 0.0 (fully transparent) to 1.0 (fully opaque). + + + + + + + The source rectangle defines the part of the layer content, that is used for + compositing the screen. It can be used, if valid content of the layer is smaller + than the layer. Effectively it can be used to zoom the content of the layer. + x: horizontal start position of scanout area within the layer + y: vertical start position of scanout area within the layer + width: width of scanout area within the layer + height: height of scanout area within the layer + + + + + + + + + + The destination rectangle defines the position and size of a layer on a screen. + The layer will be scaled to this rectangle for rendering. + x: horizontal start position of layer within the screen + y: vertical start position of layer within the screen + width : width of surface within the screen + height: height of surface within the screen + + + + + + + + + + Layers are created with an initial size, but they can be resized at runtime. + This request changes the widht and height of a layer. + + + + + + + + The orientation of a layer in ivi compositor can be rotated in 90 degree steps, + as defined in orientation enum. + + + + + + + Store a screenshot of the layer content in the file provided by argument filename. + + + + + + + A layer has no content assigned to itself, it is a container for surfaces. + This request removes all surfaces from the layer render order. + Note: the surfaces are not destroyed, they are just no longer contained by + the layer. + + + + + + A layer has no content assigned to itself, it is a container for surfaces. + This request adds a surface to the topmost position of the layer render order. + The added surface will cover all other surfaces of the layer. + + + + + + + A layer has no content assigned to itself, it is a container for surfaces. + This request removes one surfaces from the layer render order. + Note: the surface is not destroyed, it is just no longer contained by + the layer. + + + + + + + A layer has no content assigned to itself, it is a container for surfaces. + This request removes all surfaces from the layer render order and set a + completely new render order. + + + + + + + The new visibility state is provided in argument visibility. + If visibility is 0, the layer has become invisible. + If visibility is not 0, the layer has become visible. + + + + + + + The new opacity state is provided in argument opacity. + The valid range for opactiy is 0.0 (fully transparent) to 1.0 (fully opaque). + + + + + + + The scanout region of the layer content has changed. + The new values for source rectangle are provided by + x: new horizontal start position of scanout area within the layer + y: new vertical start position of scanout area within the layer + width: new width of scanout area within the layer + height: new height of scanout area within the layer + + + + + + + + + + The new values for source rectangle are provided by + x: new horizontal start position of layer within the screen + y: new vertical start position of layer within the screen + width : new width of layer within the screen + height: new height of layer within the screen + + + + + + + + + + The layer was resized. The new layer size is provided by arguments + width and height. + + + + + + + + The new orientation status is provided by argument orientation. + + + + + + + This layer was added to the render order of the screen defined by argument screen. + This is essential for a layer to become visible on screen, since ivi compositors + will only render screens (or more precise all layers in the render order of a screen). + + + + + + + Request to destroy the ivi_controller_layer. If argument + destroy_scene_object id not 0, the layer will be destroyed in + ivi compositor. If argument is 0, only the proxy object is destroyed. + + + + + + + + + + + + + + + + + + + + A screen has no content assigned to itself, it is a container for layers. + This request removes all layers from the screen render order. + Note: the layers are not destroyed, they are just no longer contained by + the screen. + + + + + + A screen has no content assigned to itself, it is a container for layers. + This request adds a layers to the topmost position of the screen render order. + The added layer will cover all other layers of the screen. + + + + + + + Store a screenshot of the screen content in the file provided by argument filename. + + + + + + + A screen has no content assigned to itself, it is a container for layers. + This request removes all layers from the screen render order and set a + completely new render order. + + + + + + + + + + + + All requests are not applied directly to scene object, so a controller + can set different properties and apply the changes all at once. + Note: there's an exception to this. Creation and destruction of + scene objects is executed immediately. + + + + + + A new screen is announced to the controller. This is typically + the case in two cases: + 1. controller was just started, ivi compositor announces existing screen + 2. a new screen was added to the system at runtime + + + + + + + + layer_create will create a new layer with id_layer in ivi compositor, + if it does not yet exists. If the layer with id_layer already exists in + ivi compositor, a handle to the existing layer is returned and width and + height properties are ignored. + + + + + + + + + + A new layer is announced to the controller. + + + + + + + surface_create will create a new surface with id_surface in ivi compositor, + if it does not yet exists. If the surface with id_surface already exists in + ivi compositor, a handle to the existing surface is returned. + + + + + + + + A new surface is announced to the controller. + + + + + + + This enum defines all scene object available in ivi compositor. + + + + + + + + + These error codes define all possible error codes returned by ivi compositor + on server-side errors. + + + + + + + + The ivi compositor encountered error while processing a request by this + controller. The error is defined by argument error_code and optional + error_text. Additionally the object type and id is contained in the error + event to provide some detailes to handle the error. + If the controller requires to associate this error event to a request, + it can + 1. send request + 2. force display roundtrip + 3. check, if error event was received + but this restricts the controller to have only one open request at a time. + + + + + + + + + + + diff --git a/src/client/client.pro b/src/client/client.pro index 6802cd47b..4ad32c124 100644 --- a/src/client/client.pro +++ b/src/client/client.pro @@ -6,7 +6,8 @@ MODULE=waylandclient MODULE_PLUGIN_TYPES = \ wayland-graphics-integration-client \ wayland-inputdevice-integration \ - wayland-decoration-client + wayland-decoration-client \ + wayland-shell-integration CONFIG += generated_privates diff --git a/src/plugins/plugins.pro b/src/plugins/plugins.pro index a1a8a5b7d..9b66b851e 100644 --- a/src/plugins/plugins.pro +++ b/src/plugins/plugins.pro @@ -2,4 +2,5 @@ TEMPLATE=subdirs SUBDIRS += \ platforms \ hardwareintegration \ - decorations + decorations \ + shellintegration diff --git a/src/plugins/shellintegration/ivi-shell/README b/src/plugins/shellintegration/ivi-shell/README new file mode 100644 index 000000000..244458650 --- /dev/null +++ b/src/plugins/shellintegration/ivi-shell/README @@ -0,0 +1,33 @@ +IVI-shell +========= + +IVI-shell provides a shell interface for Weston, which maps the GENIVI +API (http://www.genivi.org) for In-Vehicle Infotainment as Wayland-Ivi-Extension +(http://wiki.projects.genivi.org/index.php/Wayland_IVI_Extension_Design). + +This module includes two protocols: ivi-application (provided by weston), and +ivi-controller (provided by GENIVI's wayland-ivi-extension). +In IVI use case, the client creates and destroys a surface using a +unique ID acquired from the ivi-application protocol. +On the other hand, a controller (such as the HMI Controller) manages a set of +properties (visibility, position, size, etc.), +created using unique IDs provided by the ivi-controller protocol. +A Unique ID is necessary to create and control both the ivi-surface and +the ivi-layer, however Qt has no API for setting these IDs. + +The ivi-shell plugin works around this limitation by setting the unique ID via +the environment variable QT_IVI_SURFACE_ID, used for both ivi-surface and +ivi-layer. If an application needs more than two surfaces, +ivi-surface IDs will be incremented automatically. If QT_IVI_SURFACE_ID is +not set, ivi-surface and ivi-layer IDs will be generated internally. +QT_IVI_SURFACE_ID is a 32 bit value composed of the process ID and the +surface ID. Bits 0 to 22 represent the process ID, and bits 23 to 32 represent +the surface ID in a process. +For example, when the process ID is 0x765 and there are two surfaces, +ivi-layer ID is 0x765 and ivi-surface IDs are 0x765 and 0x00400765. + +------------+---------------------------+ + |31 23|22 0| + +------------+---------------------------+ + |0000 0000 00|00 0000 0000 0000 0000 0000| + |<- ID ->|<- process ID ->| + +------------+---------------------------+ diff --git a/src/plugins/shellintegration/ivi-shell/ivi-shell.json b/src/plugins/shellintegration/ivi-shell/ivi-shell.json new file mode 100644 index 000000000..c48528e36 --- /dev/null +++ b/src/plugins/shellintegration/ivi-shell/ivi-shell.json @@ -0,0 +1,3 @@ +{ + "Keys":[ "ivi-shell" ] +} diff --git a/src/plugins/shellintegration/ivi-shell/ivi-shell.pro b/src/plugins/shellintegration/ivi-shell/ivi-shell.pro new file mode 100644 index 000000000..8fd774736 --- /dev/null +++ b/src/plugins/shellintegration/ivi-shell/ivi-shell.pro @@ -0,0 +1,38 @@ +PLUGIN_TYPE = wayland-shell-integration +load(qt_plugin) + +QT += waylandclient-private +CONFIG += wayland-scanner + +!contains(QT_CONFIG, no-pkg-config) { + PKGCONFIG += wayland-client wayland-cursor + CONFIG += link_pkgconfig +} else { + LIBS += -lwayland-client -lwayland-cursor +} + +config_xkbcommon { + !contains(QT_CONFIG, no-pkg-config) { + PKGCONFIG += xkbcommon + } else { + LIBS += -lxkbcommon + } +} else { + DEFINES += QT_NO_WAYLAND_XKB +} + +WAYLANDCLIENTSOURCES += \ + ../../../3rdparty/protocol/ivi-application.xml \ + ../../../3rdparty/protocol/ivi-controller.xml + +HEADERS += \ + qwaylandivishellintegration.h \ + qwaylandivisurface_p.h + +SOURCES += \ + main.cpp \ + qwaylandivishellintegration.cpp \ + qwaylandivisurface.cpp + +OTHER_FILES += \ + ivi-shell.json diff --git a/src/plugins/shellintegration/ivi-shell/main.cpp b/src/plugins/shellintegration/ivi-shell/main.cpp new file mode 100644 index 000000000..c7af9b157 --- /dev/null +++ b/src/plugins/shellintegration/ivi-shell/main.cpp @@ -0,0 +1,61 @@ +/**************************************************************************** +** +** Copyright (C) 2015 ITAGE Corporation, author: +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the plugins of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL21$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 or version 3 as published by the Free +** Software Foundation and appearing in the file LICENSE.LGPLv21 and +** LICENSE.LGPLv3 included in the packaging of this file. Please review the +** following information to ensure the GNU Lesser General Public License +** requirements will be met: https://www.gnu.org/licenses/lgpl.html and +** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** As a special exception, The Qt Company gives you certain additional +** rights. These rights are described in The Qt Company LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include +#include "qwaylandivishellintegration.h" + +QT_BEGIN_NAMESPACE + +namespace QtWaylandClient { + +class QWaylandIviShellIntegrationPlugin : public QWaylandShellIntegrationPlugin +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID QWaylandShellIntegrationFactoryInterface_iid FILE "ivi-shell.json") + +public: + virtual QWaylandShellIntegration *create(const QString &key, const QStringList ¶mList) Q_DECL_OVERRIDE; +}; + +QWaylandShellIntegration *QWaylandIviShellIntegrationPlugin::create(const QString &key, const QStringList ¶mList) +{ + Q_UNUSED(key); + Q_UNUSED(paramList); + return new QWaylandIviShellIntegration(); +} + +} + +QT_END_NAMESPACE + +#include "main.moc" diff --git a/src/plugins/shellintegration/ivi-shell/qwaylandivishellintegration.cpp b/src/plugins/shellintegration/ivi-shell/qwaylandivishellintegration.cpp new file mode 100644 index 000000000..6876385b8 --- /dev/null +++ b/src/plugins/shellintegration/ivi-shell/qwaylandivishellintegration.cpp @@ -0,0 +1,173 @@ +/**************************************************************************** +** +** Copyright (C) 2015 ITAGE Corporation, author: +** Contact: http://www.qt-project.org/legal +** +** This file is part of the plugins of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL21$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 or version 3 as published by the Free +** Software Foundation and appearing in the file LICENSE.LGPLv21 and +** LICENSE.LGPLv3 included in the packaging of this file. Please review the +** following information to ensure the GNU Lesser General Public License +** requirements will be met: https://www.gnu.org/licenses/lgpl.html and +** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** As a special exception, The Qt Company gives you certain additional +** rights. These rights are described in The Qt Company LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include "qwaylandivishellintegration.h" + +#include +#include + +#include +#include +#include + +#include "qwaylandivisurface_p.h" + +#include + +QT_BEGIN_NAMESPACE + +namespace QtWaylandClient { + +QWaylandIviShellIntegration::QWaylandIviShellIntegration() + : m_iviApplication(Q_NULLPTR) + , m_iviController(Q_NULLPTR) + , m_lastSurfaceId(0) + , m_surfaceNumber(0) + , m_useEnvSurfaceId(false) + , m_mutex(QMutex::Recursive) +{ +} + +QWaylandIviShellIntegration::~QWaylandIviShellIntegration() +{ + delete m_iviApplication; + delete m_iviController; +} + +bool QWaylandIviShellIntegration::initialize(QWaylandDisplay *display) +{ + display->addRegistryListener(registryIvi, this); + + return true; +} + +/* get unique id + * pattern1: + * When set QT_IVI_SURFACE_ID, We use it as ID. + * Next ID is increment. + * pattern2: + * When not set QT_IVI_SURFACE_ID, We use process ID and unused bit. + * process ID maximum is 2^22. Unused bit is 23 to 32 bit. + * Therefor, We use 23 to 32 bit. This do not overlap with other clients. + * Next ID is increment of 23 to 32 bit. + * +------------+---------------------------+ + * |31 23|22 0| + * +------------+---------------------------+ + * |0000 0000 00|00 0000 0000 0000 0000 0000| + * |<- ID ->|<- process ID ->| + * +------------+---------------------------+ + */ +uint32_t QWaylandIviShellIntegration::getNextUniqueSurfaceId() +{ + const uint32_t PID_MAX_EXPONENTIATION = 22; // 22 bit shift operation + const uint32_t ID_LIMIT = 2 ^ (32 - PID_MAX_EXPONENTIATION); // 10 bit is uniqeu id + QMutexLocker locker(&m_mutex); + + if (m_lastSurfaceId == 0) { + QByteArray env = qgetenv("QT_IVI_SURFACE_ID"); + bool ok; + m_lastSurfaceId = env.toUInt(&ok, 10); + if (ok) + m_useEnvSurfaceId = true; + else + m_lastSurfaceId = getpid(); + + return m_lastSurfaceId; + } + + if (m_useEnvSurfaceId) { + m_lastSurfaceId++; + } else { + m_surfaceNumber++; + if (m_surfaceNumber >= ID_LIMIT) { + qWarning("IVI surface id counter overflow\n"); + return 0; + } + m_lastSurfaceId += (m_surfaceNumber << PID_MAX_EXPONENTIATION); + } + + return m_lastSurfaceId; +} + +QWaylandShellSurface *QWaylandIviShellIntegration::createShellSurface(QWaylandWindow *window) +{ + if (!m_iviApplication) + return Q_NULLPTR; + + uint32_t surfaceId = getNextUniqueSurfaceId(); + if (surfaceId == 0) + return Q_NULLPTR; + + struct ivi_surface *surface = m_iviApplication->surface_create(surfaceId, window->object()); + if (!m_iviController) + return new QWaylandIviSurface(surface, window); + + struct ::ivi_controller_surface *controller = m_iviController->ivi_controller::surface_create(surfaceId); + QWaylandIviSurface *iviSurface = new QWaylandIviSurface(surface, window, controller); + + if (window->window()->type() == Qt::Popup) { + QPoint transientPos = window->geometry().topLeft(); // this is absolute + QWaylandWindow *parent = window->transientParent(); + if (parent && parent->decoration()) { + transientPos -= parent->geometry().topLeft(); + transientPos.setX(transientPos.x() + parent->decoration()->margins().left()); + transientPos.setY(transientPos.y() + parent->decoration()->margins().top()); + } + QSize size = window->window()->geometry().size(); + iviSurface->ivi_controller_surface::set_destination_rectangle(transientPos.x(), + transientPos.y(), + size.width(), + size.height()); + } + + return iviSurface; +} + +void QWaylandIviShellIntegration::registryIvi(void *data, + struct wl_registry *registry, + uint32_t id, + const QString &interface, + uint32_t version) +{ + QWaylandIviShellIntegration *shell = static_cast(data); + + if (interface == QStringLiteral("ivi_application")) + shell->m_iviApplication = new QtWayland::ivi_application(registry, id, version); + + if (interface == QStringLiteral("ivi_controller")) + shell->m_iviController = new QtWayland::ivi_controller(registry, id, version); +} + +} + +QT_END_NAMESPACE diff --git a/src/plugins/shellintegration/ivi-shell/qwaylandivishellintegration.h b/src/plugins/shellintegration/ivi-shell/qwaylandivishellintegration.h new file mode 100644 index 000000000..ef1c7609a --- /dev/null +++ b/src/plugins/shellintegration/ivi-shell/qwaylandivishellintegration.h @@ -0,0 +1,77 @@ +/**************************************************************************** +** +** Copyright (C) 2015 ITAGE Corporation, author: +** Contact: http://www.qt-project.org/legal +** +** This file is part of the plugins of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL21$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 or version 3 as published by the Free +** Software Foundation and appearing in the file LICENSE.LGPLv21 and +** LICENSE.LGPLv3 included in the packaging of this file. Please review the +** following information to ensure the GNU Lesser General Public License +** requirements will be met: https://www.gnu.org/licenses/lgpl.html and +** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** As a special exception, The Qt Company gives you certain additional +** rights. These rights are described in The Qt Company LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef QWAYLANDIVIINTEGRATION_H +#define QWAYLANDIVIINTEGRATION_H + +#include + +#include +#include "qwayland-ivi-application.h" +#include "qwayland-ivi-controller.h" + +QT_BEGIN_NAMESPACE + +namespace QtWaylandClient { + +class QWaylandWindow; +class QWaylandDisplay; +class QWaylandIviControllerSurface; + +class Q_WAYLAND_CLIENT_EXPORT QWaylandIviShellIntegration : public QWaylandShellIntegration +{ +public: + QWaylandIviShellIntegration(); + ~QWaylandIviShellIntegration(); + bool initialize(QWaylandDisplay *display); + virtual QWaylandShellSurface *createShellSurface(QWaylandWindow *window) Q_DECL_OVERRIDE; + +private: + static void registryIvi(void *data, struct wl_registry *registry, + uint32_t id, const QString &interface, uint32_t version); + uint32_t getNextUniqueSurfaceId(); + +private: + QtWayland::ivi_application *m_iviApplication; + QtWayland::ivi_controller *m_iviController; + uint32_t m_lastSurfaceId; + uint32_t m_surfaceNumber; + bool m_useEnvSurfaceId; + QMutex m_mutex; +}; + +} + +QT_END_NAMESPACE + +#endif // QWAYLANDIVIINTEGRATION_H diff --git a/src/plugins/shellintegration/ivi-shell/qwaylandivisurface.cpp b/src/plugins/shellintegration/ivi-shell/qwaylandivisurface.cpp new file mode 100644 index 000000000..f8871fa26 --- /dev/null +++ b/src/plugins/shellintegration/ivi-shell/qwaylandivisurface.cpp @@ -0,0 +1,87 @@ +/**************************************************************************** +** +** Copyright (C) 2015 ITAGE Corporation, author: +** Contact: http://www.qt-project.org/legal +** +** This file is part of the plugins of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL21$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 or version 3 as published by the Free +** Software Foundation and appearing in the file LICENSE.LGPLv21 and +** LICENSE.LGPLv3 included in the packaging of this file. Please review the +** following information to ensure the GNU Lesser General Public License +** requirements will be met: https://www.gnu.org/licenses/lgpl.html and +** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** As a special exception, The Qt Company gives you certain additional +** rights. These rights are described in The Qt Company LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include "qwaylandivisurface_p.h" + +#include +#include +#include +#include + +QT_BEGIN_NAMESPACE + +namespace QtWaylandClient { + +QWaylandIviSurface::QWaylandIviSurface(struct ::ivi_surface *ivi_surface, QWaylandWindow *window) + : QtWayland::ivi_surface(ivi_surface) + , QWaylandShellSurface(window) + , m_window(window) + , m_extendedWindow(Q_NULLPTR) +{ + createExtendedSurface(window); +} + +QWaylandIviSurface::QWaylandIviSurface(struct ::ivi_surface *ivi_surface, QWaylandWindow *window, + struct ::ivi_controller_surface *iviControllerSurface) + : QtWayland::ivi_surface(ivi_surface) + , QWaylandShellSurface(window) + , QtWayland::ivi_controller_surface(iviControllerSurface) + , m_window(window) + , m_extendedWindow(Q_NULLPTR) +{ + createExtendedSurface(window); +} + +QWaylandIviSurface::~QWaylandIviSurface() +{ + ivi_surface::destroy(); + if (QtWayland::ivi_controller_surface::object()) + QtWayland::ivi_controller_surface::destroy(0); + + delete m_extendedWindow; +} + +void QWaylandIviSurface::createExtendedSurface(QWaylandWindow *window) +{ + if (window->display()->windowExtension()) + m_extendedWindow = new QWaylandExtendedSurface(window); +} + +void QWaylandIviSurface::ivi_surface_configure(int32_t width, int32_t height) +{ + this->m_window->configure(0, width, height); +} + +} + +QT_END_NAMESPACE diff --git a/src/plugins/shellintegration/ivi-shell/qwaylandivisurface_p.h b/src/plugins/shellintegration/ivi-shell/qwaylandivisurface_p.h new file mode 100644 index 000000000..96978e28b --- /dev/null +++ b/src/plugins/shellintegration/ivi-shell/qwaylandivisurface_p.h @@ -0,0 +1,71 @@ +/**************************************************************************** +** +** Copyright (C) 2015 ITAGE Corporation, author: +** Contact: http://www.qt-project.org/legal +** +** This file is part of the plugins of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL21$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 or version 3 as published by the Free +** Software Foundation and appearing in the file LICENSE.LGPLv21 and +** LICENSE.LGPLv3 included in the packaging of this file. Please review the +** following information to ensure the GNU Lesser General Public License +** requirements will be met: https://www.gnu.org/licenses/lgpl.html and +** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** As a special exception, The Qt Company gives you certain additional +** rights. These rights are described in The Qt Company LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef QWAYLANDIVISURFACE_H +#define QWAYLANDIVISURFACE_H + +#include +#include "qwayland-ivi-application.h" +#include "qwayland-ivi-controller.h" + +QT_BEGIN_NAMESPACE + +namespace QtWaylandClient { + +class QWaylandWindow; +class QWaylandInputDevice; +class QWindow; +class QWaylandExtendedSurface; + +class Q_WAYLAND_CLIENT_EXPORT QWaylandIviSurface : public QtWayland::ivi_surface + , public QWaylandShellSurface, public QtWayland::ivi_controller_surface +{ +public: + QWaylandIviSurface(struct ::ivi_surface *shell_surface, QWaylandWindow *window); + QWaylandIviSurface(struct ::ivi_surface *shell_surface, QWaylandWindow *window, + struct ::ivi_controller_surface *iviControllerSurface); + virtual ~QWaylandIviSurface(); + +private: + void createExtendedSurface(QWaylandWindow *window); + virtual void ivi_surface_configure(int32_t width, int32_t height) Q_DECL_OVERRIDE; + + QWaylandWindow *m_window; + QWaylandExtendedSurface *m_extendedWindow; +}; + +} + +QT_END_NAMESPACE + +#endif // QWAYLANDIVISURFACE_H diff --git a/src/plugins/shellintegration/shellintegration.pro b/src/plugins/shellintegration/shellintegration.pro new file mode 100644 index 000000000..9867d2b40 --- /dev/null +++ b/src/plugins/shellintegration/shellintegration.pro @@ -0,0 +1,3 @@ +TEMPLATE = subdirs + +SUBDIRS += ivi-shell -- cgit v1.2.3