-**Window Manager Application Guide**
-====
-<div align="right">Revision: 0.2Beta</div>
+# **Window Manager Application Guide**
+
+<div align="right">Revision: 0.7</div>
<div align="right">TOYOTA MOTOR CORPORATION</div>
-<div align="right">30th/Sep/2017</div>
+<div align="right">12th/Oct/2018</div>
* * *
-Introduction
-============
+<div id="Table\ of\ content"></div>
+
+# Table of content
+
+- [Target reader of this document](#Target\ reader\ of\ this\ document)
+- [Overview](#Overview)
+ - [Supported usecase](#Supported\ usecase)
+- [Getting Started](#Getting\ Started)
+ - [Build](#Build)
+ - [Install](#Install)
+ - [Bitbake](#Bitbake)
+ - [Enable to call Window Manager](#Enable\ to\ call\ Window\ Manager)
+- [Software Architecture](#Software\ Architecture)
+- [Sequence](#Sequence)
+- [API reference](#API\ reference)
+ - [Request to Window Manager](#Request\ to\ Window\ Manager)
+ - [Event from Window Manager](#Event\ from\ Window\ Manager)
+ - [Client Library](#Client\ library)
+- [Sample code](#Sample\ code)
+- [Policy Manager](#Policy\ Manager)
+ - [Enabling split](#Enabling\ split)
+- [Release Note](#Release\ Note)
-This WindowManager implements simple layout switching of applications on
-multiple layers and with different layer layouts.
+* * *
-Intended audience
------------------
+<div id="Target\ reader\ of\ this\ document"></div>
-This documentation is intended for developers and system integrators who
-need to know, how the window manager works and how it is to be used.
+## Target reader of this document
-Scope of this Document
-----------------------
+This document is intended for developers and system integrators who
+need to know, how Window manager works and how it is to be used.
-This document covers the window manager that was implemented for TMC and
+### Scope of this Document
+
+This document covers Window manager that was implemented for TMC and
delivered to the Automotive Grade Linux (AGL) project. It includes its
implementation details, concepts of operation, configuration and usage.
It does not include
-- documentation of the underlying architecture, see
- [HMI-Framework](https://wiki.automotivelinux.org/hmiframework).
+- document of the underlying architecture, see
+ [HMI-Framework](https://wiki.automotivelinux.org/hmiframework).
-- documentation of the AGL application framework and its technologies,
- see [AGL Application
+- document of the AGL application framework and its technologies,
+ see [AGL Application
Framework](https://wiki.automotivelinux.org/agl-distro/app-framework).
+- document of HomeScreen, see
+ [HomeScreen](http://docs.automotivelinux.org/docs/apis_services/en/dev/reference/hmi-framework/3_1-HomeScreen-Guide.html).
+
It is highly recommended to have a good understanding of these documents
-and projects before using the window manager.
+and projects before using Window manager.
-Known Issues
-------------
+* * *
+
+<div id="Overview"></div>
-Currently there is a one known issues:
+# Overview
-- Only single-surface Qt applications are support through the
- libwindowmanager library. This is a limitation of how Qt creates surface
- IDs for the ivi-application interface.
+Window Manager is the service process which provides **window management based on policy**.
+And implements a layout switching of applications on
+multiple layers and with different layer layouts.
+Window Manager is based on ivi layer management from GENIVI and AGL application framework.
-External libraries
-------------------
+Window Manager consists of
-This project includes a copy of version 2.1.1 the excellent [C++11 JSON
-library by Niels Lohmann](https://github.com/nlohmann/json).
+- afb-binder
+- service binding library
+- shared library for policy management
+- configuration files
-Client Library
---------------
+In order to understand Window Manager, the below figure shows the one of typical usecases.
+In this example, there are two mode for window management.
-A client library implementation that internally uses the *libafbwsc*, is
-provided in the subdirectory `libwindowmanager/` with its own documentation
-directory.
+1. Window Management in `Car Stops`
+1. Window Management in `Car Runs`
+
+
+
+The important points are:
+
+- **Window transition should be done by Window Manager**
+ Window Manager switch application displayed on top layer by user operation(touch shortcut button).
+ In this example, when an user touches `navigation` shortcut button, Window Manager displays `navigation` and hide `launcher`. Next, when an user touches `videoplayer` shortcut button, Window Manager divides a screen into two parts and display two applications.
+
+- **There is a priority `role` for each application.**
+ Window Manager realizes state transition change based on the policy which consists of `role`.
+ According to the state transition table, it controls the visibility of application window, layout change, and so on.
+ The reasons why this is necessary are
+
+ - to support user driving
+ - not to disturb a driver concerns on driving for safety
+
+ In this example, for safety, when the car starts running, Window Manager set up the role `videoplayer`
+ to be masked and uncontrollable by user not to disturb driver concerns.
+ And, for supporting driving, set up `navigation` role to be displayed 3 seconds after the car ran.
+ In `Car Run` state, the user can't switch to other application from Navigation application until car stops.
+
+<div id="Supported\ usecase"></div>
+
+## Supported usecase
-The client library is built together with the window manager itself.
+1. Window Management
+- When an user chooses a different application, Window Manager changes the layout and then displays the application.
+- When an user chooses a different application, Window Manager changes the layout and then hides the displayed application.
+2. Policy Management
+- Window Manager changes layout according to policy table based on `role`.
+3. Define Layout by `area` configuration
+- Window Manager realizes the abstracted `area` and can resize the window by using it. User can easily edit this configuration.
-Concepts
-========
+* * *
-The window manager implements a couple of concepts in order to allow
-efficient implementation.
+<div id="Getting\ Started"></div>
-Layers
-------
+# Getting Started
-Layers are entities that are stacked on top of each other. Each layer
-has an ID which is used for the ivi-controller interface, but this ID
-also implicitly specifies its stacking order, from lowest to highest.
+<div id="Build"></div>
-Layers are always full-screen. We do not use layer dimensions as a way
-to setup the scene, rather - each layer has a layout attached to it,
-which specifies an area that is used by surfaces to draw on.
+## Build
-Additionally, layers will generally leave surfaces on below layers
-activated, and only disable surfaces on layers the are above the
-currently used layer.
+```bash
+git clone https://gerrit.automotivelinux.org/gerrit/apps/agl-service-windowmanager
+cd agl-service-windowmanager
+mkdir build
+cd build
+source <your SDK path> // normally this is /opt/agl-sdk/environment
+cmake ..
+make
+make package
+```
-It is possible to deactivate these surfaces on lower layers explicitly
-using the `DeactivateSurface` API call.
+The widget package is populated in the 'package' directory.
-Surfaces
---------
+```bash
+ls package/
+root windowmanager-service.wgt
+```
-Surfaces are *placed* on layers according to their name. The surface
-will then be resized to dimensions, according to the layer’s layout
-configuration.
+<div id="Install"></div>
-Binding API
-===========
+## Install
-The binding API consists of a couple of AFB *verbs* - that is; function
-calls to the Window Manager.
+Copy windowmanager-service.wgt to the file system then execute the following command.
-Verbs (Functions)
------------------
+```bash
+afm-util install windowmanager-service.wgt
+```
-Each function returns a reply containing at least a failed or successful
-result of the call, additionally, when calls return something, it is
-noted. The notation used has the following meaning:
+<div id="Bitbake"></div>
- FunctionName(argument_name: argument_type)[: function_return_type]
+## Bitbake
-Where the return type may be omitted if it is void.
+You can make Window Manager object files with the following two stage operations.
-- `RequestSurface(drawing_name: string): int` Request a surface ID for
- the given name. This name and ID association will live until the
- surface is destroyed (or e.g. the application exits). Each surface
- that is managed by the window manager needs to call this function
- first!
+### Download recipe
-- `ActivateSurface(drawing_name: string)` This function requests the
- activation of a surface. It usually is not called by the
- application, but rather by the application framework or
- the HomeScreen.
+```bash
+mkdir WORK
+cd WORK
+repo init -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo
+repo sync
+```
-- `DeactivateSurface(drawing_name: string)` Request deactivation of
- a surface. This function is not usually called by applications
- themselves, but rather by the application framework or
- the HomeScreen.
+### Execute Bitbake
-- `EndDraw(drawing_name: string)` Signals the window manager, that the
- surface is finished drawing. This is useful for consistent
- flicker-free layout switches, see the Architecture document
- for details.
+```bash
+source meta-agl/scripts/aglsetup.sh -m m3ulcb agl-demo hmi-framework
+bitbake agl-demo-platform
+```
-There are a couple of non-essential (mostly for debugging and
-development) API calls:
+* * *
-- `list_drawing_names(): json` List known surface *name* to
- *ID* associations.
+<div id="Enable\ to\ call\ Window\ Manager"></div>
-- `ping()` Ping the window manager. Does also dispatch pending events
- if any.
+## Enable to call Window Manager
-- `debug_status(): json` Returns a json representation of the current
- layers and surfaces known to the window manager. This represents the
- wayland-ivi-extension object’s properties.
+To call Window Manager, it is important to enable the permission from security framework.
+To use Window Manager API, an application or a service shall add the following configuration definition into "config.xml" of your application.
-- `debug_surfaces(): json` Returns a json representation of all
- surfaces known to the window manager. This represents the
- wayland-ivi-extension properties of the surfaces.
+```xml
+<feature name="urn:AGL:widget:required-api">
+ <param name="windowmanager" value="ws" />
+</feature>
+```
-- `debug_layers(): json` Returns the current layer configuration, as
- configured through *layers.json*.
+To call Window Manager function easily, Window Manager provides a library which is called "libwindowmanager".
+This library provides a function style API calling interface.
+So you can include the libwindowmanager.hpp header file, and can link against this library.
+Please also refer to the sample application.
-- `debug_terminate()` Terminates the afb-daemon running the window
- manager binding, if the environment variable
- `WINMAN_DEBUG_TERMINATE` is set.
+See also our [Sample code](#Sample\ code).
-Events
-------
+* * *
-The window manager broadcasts certain events (to all applications) that
-signal information on the state of the surface regarding the current
-layout.
+<div id="Software\ Architecture"></div>
-- `Active(drawing_name: string)` Signal that the surface with the name
- `drawing_name` is now active.
+# Software Architecture
-- `Inactive(drawing_name: string)` Signal that the surface with the
- name `drawing_name` is now inactive. This usually means, the layout
- got changed, and the surface is now considered inactive
- (or sleeping).
+The static relationship with other components is shown below.
+The actual logic of Window Manager is the binding in Binder(afb-daemon).
+Window Manager is based on AGL application framework,
+so the IPC via websocket is protected by AGL application framework.
-- `Visible(drawing_name: string)` Signal applications, that the
- surface with name `drawing_name` is now visible.
+The upper binder is for the application side security context.
+The lower binder is the Window Manager for the server side security context.
+Usually an application side binder has some business logic for each application, so the number of binders depend on the number of applications which use Window Manager.
+On the other hand, regarding lower binder there is only one module in the system. This binder receives messages from multiple applications.
-- `Invisible(drawing_name: string)` Signal applications that the
- surface with name `drawing_name` is now invisible.
+An application can use libwindowmanager.so to call Window Manager API simply.
-- `SyncDraw(drawing_name: string)` Signal applications, that the
- surface with name `drawing_name` needs to redraw its content - this
- usually is sent when the surface geometry changed.
+Window Manager is based on the GENIVI layer management system.
-- `FlushDraw(drawing_name: string)` Signal to applications, that the
- surface with name `drawing_name` can now be swapped to its newly
- drawn content as the window manager is ready to activate a new
- layout (i.e. a new surface geometry).
+
-Binding API Usage
------------------
+## Layers
-For a detailed description on how the binding API is supposed to be
-used, refer to the Architecture document.
+Layers are entities that means the application stack group defined in `layers.json`.
+This doesn't mean layer ID defined in GENIVI ivi layer.
+The layer ID is used for application itself in Window Manager.
+Currently, application can't have multiple surfaces in Window Manager.
-Configuration
-=============
+<div id="Layers"></div>
-The window manager is configured with the *layers.json* configuration
-file, by default it is searched in `/etc/layers.json` but through the
-use of the environment variable `LAYERS_JSON` the WM can be instructed
-to use different file. Note, that the WM will not run unless this
-configuration is found and valid.
+## Surfaces
-A sample configuration is provided with the window manager
-implementation, this sample is installed to /etc/layers.json.
+Surfaces are *placed* on layers . The surface
+will then be resized to dimensions, according to the name of `areas.db`
+application requests by `activateWindow` or policy management.
+As default, `normal.full` is set by libwindowmanager for native application.
-Configuration Items
--------------------
+<div id="Configuration"></div>
-This section describes configuration items available through
-`layers.json`. It will do this, by first providing an example, and then
-going into its components.
+## Configuration
-### main\_surface
+The window manager is configured with the *layers.json*, *areas.db*, *roles.db* configuration
+files. By default they are searched in `${AFM_APP_INSTALL_DIR}/etc/`.
- "main_surface": {
- "surface_role": "HomeScreen",
- },
+Sample configurations are provided with the window manager
+implementation, these samples are installed to ${AFM_APP_INSTALL_DIR}/etc/ .
-The `main_surface` object describes a surface that will internally be
-treated as the main surface - usually this mean *HomeScreen*. The only
-special handling this surface receives, is that it is not allowed to
-deactivate it. Placement of this surface on an layer is done by the
-other configuration described below.
-
-- `surface_role` this configuration item specifies the name of the
- main surface. Set this to e.g. `HomeScreen`.
-
-### mappings
-
-This configuration item is a list of surface-name to layer mappings.
-
-#### surface to layer mapping
-
- "mappings": [
- {
- "role": "^HomeScreen$",
- "name": "HomeScreen",
- "layer_id": 1000,
- "area": { "type": "full" },
- },
- {
- "role": "MediaPlayer|Radio|Phone",
- "name": "apps",
- "layer_id": 1001,
- "area": { "type": "rect",
- "rect": { "x": 0,
- "y": 100,
- "width": -1,
- "height": -201 } },
- "split_layouts": []
- }
- ]
+This configuration is supposed to be configured by policy designer which means OEM or Tier1.
+
+### layers.json
+
+`layers.json` has three roles.
+First, to create application containers `Layer`.
+Second, to set id range for applications.
+Third, to attach application to `Layer` according to the role application requests.
+
+The sample configuration is here
+
+```json
+{
+ "comment": "Surface ID to Layer ID mapping",
+
+ "main_surface": {
+ "surface_role": "HomeScreen",
+ "comment": "This surface should never be made invisible (The HomeScreen)"
+ },
+
+ "mappings": [
+ {
+ "role": "BackGroundLayer",
+ "name": "BackGroundLayer",
+ "layer_id": 999,
+ "comment": "Single BackGround layer map for the map, radio, music and video"
+ },
+ {
+ "role": "homescreen",
+ "name": "FarHomeScreen",
+ "layer_id": 1000,
+ "comment": "FarHomeScreen is the part of HomeScreen. The z order of this layer is lower than NearHomeScreen"
+ },
+ {
+ "role": "music|video|browser|radio|phone|map|hvac|settings|dashboard|poi|mixer|sdl|launcher|fallback",
+ "name": "Apps",
+ "layer_id": 1001,
+ "comment": "Range of IDs that will always be placed on layer 1001"
+ },
+ {
+ "role": "^on_screen.*",
+ "name": "OnScreen",
+ "layer_id": 9999,
+ "comment": "Range of IDs that will always be placed on the OnScreen layer, that gets a very high 'dummy' id of 9999"
+ }
+ ]
+}
+```
Each mapping defines the following items to map corresponding surfaces
to a layer.
-- `role` defines a regular expression that application drawing names
- are matched against. If applications match tis regular expression,
+- `role` defines what kind of ability the application has. And the application will be attached to `Layer` according to the `role`.
+ A regular expression that application drawing names
+ are matched against. If applications match this regular expression,
the surface will be visible on this layer.
-- `name` is just a name definition for this layer, it has no
+- `name` is just a name definition for `Layer`, it has no
functional use apart from identifying a layer with a name.
+- `layer_id` is the id used in GENIVI IVI layer management control.
+
+`Layer` stacks from beginning to end.
+The above `Layer` example image is below.
+
+
+
+Note:
+"fallback" role is the special role. This role is set if the role application requests doesn't exist
+in `layers.json`. Then, Window Manager will accept any applications.
+If the "fallback" is not set in layers.json, window manager blocks the application displaying in such case.
+In such a situation, you have to add your role(application name) at "role" in layers.json.
+
+Note:
+`BackGroundLayer` name of `Layer` is exception for work around. This layer is fallback layer not to stop event loop of application when it becomes invisible.
+The problem is issued in <https://jira.automotivelinux.org/browse/SPEC-1484>.
+
+<div id="Configuration\ Items"></div>
+
+### areas.db
+
+Area means abstract expressions of 2-dimensional size and position.
+areas.db defines the area which an application is set.
+
+```json
+{
+ "areas": [
+ {
+ "name": "fullscreen",
+ "rect": {
+ "x": 0,
+ "y": 0,
+ "w": 1080,
+ "h": 1920
+ }
+ },
+ {
+ "name": "normal.full",
+ "rect": {
+ "x": 0,
+ "y": 218,
+ "w": 1080,
+ "h": 1488
+ }
+ },
+ {
+ "name": "split.main",
+ "rect": {
+ "x": 0,
+ "y": 218,
+ "w": 1080,
+ "h": 744
+ }
+ },
+ {
+ "name": "split.sub",
+ "rect": {
+ "x": 0,
+ "y": 962,
+ "w": 1080,
+ "h": 744
+ }
+ }
+ ]
+}
+```
-- `layer_id` specifies which ID this layer will use.
+The image of the above setting is described below.
+
-- `area` is an object that defines the area assigned to surfaces.
+- `name` is an abstract data of rectangle.
-- `split_layouts` is an optional item, that - if present - defines a
- number of possible split-screen layouts for this layer.
+- `rect` has 4 arguments. `x`, `y` means the offset from (0, 0) of screen.`w` means the width of the area, and `h` means the height of the area. The dimensions can be specified relative to the screen dimensions.
-#### Area
+The dimensions can be specified absolute to the screen dimensions. But if `fullscreen` is not suitable to screen dimensions, Window Manager scales the area automatically.
-Areas can be either `full` or `rect`, whereas `full` means a full-screen
-layer, this is mostly useful for the main\_surface or HomeScreen layer.
-`rect` declares a layer drawing area specified as a rectangle with start
-coordinates `x` and `y` as well as its dimensions `width` and `height`.
+Note:
+`fullscreen` must be set because this is the base size of scaling in Window Manger.
-The dimensions can be specified relative to the screen dimensions. For
-this negative values for width and height mus be used.
+Note:
+The direction of the coordinates depends on `transform` in weston.ini.
+Currently, agl-demo-platform set `transform=270`.
+This suppose to use screen vertically.
-For example, a full-screen surface can have the following `rect`
-definition:
+### roles.db
- "rect": { "x": 0,
- "y": 0,
- "width": -1,
- "height": -1 }
+* * *
-A surface that leaves a 200pixel margin on the top and bottom can use
-the following `rect` definition:
+<div id="Sequence"></div>
- "rect": { "x": 0,
- "y": 200,
- "width": -1,
- "height": -401 }
+# Sequence
-So the expression for the actual surface dimensions when using
-screen-size-relative values will be:
+To understand the sequence between application and window manager, refer to the [spec document](https://wiki.automotivelinux.org/hmiframework).
- actual_width = screen_width + 1 + width
- actual_height = screen_height + 1 + height
+The typical sequence to render your application, follow the sequence below.
-Or in other words, to leave an `N` wide border around a surface, the
-actual value in the dimension configuration needs to be `-N - 1`, and
-appropriate offsets need to be set for `x` and `y`.
+1. Register your role (and request surfaceID)
-#### split\_layouts
+
-This configuration item allows the specification of split-screen layouts
-on layers for certain surfaces.
+The above sequence is the initialization phase of your application to use Window Manager.
+An Application has to register your `role` to Window Manager. For ivi-shell application, Window Manager generates surfaceID to input it into the function
+to create surface.
+And also it is important for synchronization to get `syncDraw` event for receiving the request for resize and redraw, and notifying Window Manager of `endDraw`, so register callback function with setEventHandler for `syncDraw`.
-A split screen layout always has a *main* surface and a *sub* surface.
-In order to enter a split screen layout, first the *main* surface of the
-layout must be activated, and then the *sub* surface. In order to
-disable the split layout, one of the two participating surface must be
-deactivated (or a surface on a layer below the current one must be
-activated).
+[requestSurface](#requestSurface)
+[setEventHandler](#wm_subscribe)
- "split_layouts": [
- {
- "name": "Media Player",
- "main_match": "^App MPlayer Main$",
- "sub_match": "^App MPlayer Sub",
- }
- ]
+setEventHandler is API of libwindowmanager. This calls wm_subscribe internally.
+
+2. Display your window
+
+
+
+To display your window, your application has to request `activateWindow` with `role` and `area` to Window Manager.
+Window Manager checks the app should be visible on the `area` according to the policy table using `role` .
+If it is accepted, afb_req_success will be returned, and next Window Manager
+will push the event `syncDraw` to applications which will be displayed.
+If it is denied, afb_req_fail will be returned.
+In this sample sequence, `syncDraw` is emitted to the apps who requested only,
+but this shall be emitted to other applications whose size shall be changed.
+
+[activateWindow](#activateWindow)
+[syncDraw](#syncDraw)
+[endDraw](#endDraw)
+[flushDraw](#flushDraw)
+
+3. Activate OnScreen Window
+
+
+
+[deactivateWindow](#deactivateWindow)
+[See sample code for more detail about OnScreen Window.](https://gerrit.automotivelinux.org/gerrit/gitweb?p=apps%2Fonscreenapp.git;a=summary)
+
+The above sequence shows the sample of OnScreen Window.
+If the role is high priority than NormapApp, Window Manager rejects NormalApp
+request when OnScreenApp is displayed.
+
+Note : Above repository is currently empty, so please refer to the sandbox branch.
+
+* * *
+
+<div id="API\ reference"></div>
+
+# API reference
+
+## Request to Window Manager
+
+| Use | verb | version |
+|:-:|:-:|:-:|
+| Initialize | requestSurface | from 0.7 |
+| | wm_subscribe | from 0.7 |
+| | requestSurfaceXDG | from 0.7 |
+|Activate/Deactivate| activateWindow | from 0.7 |
+| | deactivateWindow | from 0.7 |
+| | endDraw | from 0.7 |
+| Get Infomation | getDisplayInfo | from 0.7 |
+
+Note: We created this table from 0.7
+
+The data of IPC via websocket consists of JSON.
+This section describes the verb of API and key.
+Normally, the body of requesting API will be here.
+
+<div id="Request\ to\ Widnow \Manager"></div>
+
+## Initialize
+
+<div id="requestSurface"></div>
+
+### *requestSurface*
+
+Register your role to Window Manager and get surfaceID for ivi-shell.
+The role is used for policy management.
+SurfaceID is supposed to be set to the API `ivi_application_surface_create` of ivi-application protocol or set it to environment variable `QT_IVI_SURFACE_ID` if your app is Qt and integrate ivi-shell.
+
+- verb : "requestSurface"
+- argument : {"drawing_name":"your role"}
+
+the value must be selected in layers.json.
+
+argument example :
+
+```json
+{
+ "drawing_name" : "navigation"
+}
+```
+
+### *requestSurfaceXDG*
+
+This API is for XDGLauncher, so it is not necessary for normal application.
+XDGLauncher is created for XDG application for desktop app without editing for HMI-Framework.
+Please see the repository in detail.
+<https://gerrit.automotivelinux.org/gerrit/gitweb?p=staging%2Fxdg-launcher.git;a=summary>
-A split layout object has the following attributes:
+<div id="wm_subscribe"></div>
-- `name` defines its name, it has no actual function other then a way
- to identify this split layout.
+### *wm_subscribe*
-- `main_match` is a regular expression that matches for the *main*
- surface of this split layout.
+Subscribe the Window Manager's event.
+Application must subscribe `syncDraw` event.
-- `sub_match` is a regular expression that matches for the *sub*
- surface of this layout.
+- verb : "wm_subscribe"
+- argument : {"event" : *event number*}
-In the above example only the surface with drawing name
-`App MPlayer Main` will be used as the *main* surface, but all surfaces
-that begin with `App MPlayer Sub` can be used as a *sub* surface for
-this layout.
+argument example :
-The names must still match the layer’s role match!
+```json
+{
+ "event" : 5
+}
+```
+
+The event is abstracted with a number (enumeration).
+
+| Number | Event |
+|:-:|:-:|
+| 0 | "active" |
+| 1 | "inactive" |
+| 2 | "visible" |
+| 3 | "invisible" |
+| 4 | "syncDraw" |
+| 5 | "flushDraw" |
+| 6 | "screenUpdated" |
+
+## Activate/Deactivate
+
+<div id="activateWindow"></div>
+
+### *activateWindow*
+
+Request to display your application with `role` on the `area` to Window Manager.
+Window Manager checks the app should be visible on the `area` and change layout according to the policy table using `role` .
+If it is accepted, afb_req_success will be returned, and next Window Manager
+will push the event `syncDraw` to applications which will be displayed.
+If it is denied, afb_req_fail will be returned.
+
+- verb : "activateWindow"
+- argument : {"drawing_name" : "your role", "drawing_area" : "your area"}
+
+the value must be selected among layers.json.
+
+argument example :
+
+```json
+{
+ "drawing_name" : "navigation",
+ "drawing_area" : "normal.full"
+}
+```
+
+<div id="deactivateWindow"></div>
+
+### *deactivateWindow*
+
+Request to hide your application to Window Manager.
+This verb is supposed to be used by high priority application which
+are for example popup application or system UI application such like alert.
+If Window Manager set the priority of popup high in the policy, Window Manager may not hide the popup even if normal applications
+send `activateWindow` until popup application send `deactivateWindow` . This behavior depends on the policy table.
+After this request, Window Manager checks which app should be visible
+and change layout according to the policy table.
+
+- verb : "deactivateWindow"
+- argument : None
+
+<div id="endDraw"></div>
+
+### *endDraw*
+
+Notify Window Manager of application finishes drawing.
+This function must be sent in event `syncDraw`.
+Otherwise, Window Manager will roll back to previous state and reject your request `activateWindow` .
+
+- verb : "endDraw"
+- argument : {"drawing_name" : "your role"}
+
+argument example :
+
+```json
+{
+ "drawing_name" : "navigation",
+}
+```
+
+## Get Information
+
+### *getDisplayInfo*
+
+Get screen information such as resolution.
+
+- verb : "getDisplayInfo"
+- argument : None
+
+Return : The screen information will return.
+Return example :
+
+```json
+{
+ "response":{
+ "width_pixel":1080,
+ "height_pixel":1920,
+ "width_mm":320,
+ "height_mm":520,
+ "scale":1
+ },
+ "jtype" : "afb-reply",
+ "request":{
+ "status":"success",
+ "info":"success",
+ "uuid":"05ae219a-0e56-4f46-af9f-3186a18cb110"
+ }
+}
+```
+
+Note :
+"width_mm", "height_mm" is from output which is one of the wayland object.
+These items lack reliability, so recommend not to use.
+
+<div id="Event\ from\ Window \Manager"></div>
+
+## Event from Window Manager
-Building and Running
-====================
+| Number | Event | version |
+|:-:|:-:|:-:|
+| 0 | "active" | from 0.7|
+| 1 | "inactive" | from 0.7 |
+| 2 | "visible" | from 0.7 |
+| 3 | "invisible" | from 0.7 |
+| 4 | "syncDraw" | from 0.7 |
+| 5 | "flushDraw" | from 0.7 |
+| 6 | "screenUpdated" | from 0.7 |
-Dependencies
-------------
+Events also consists of JSON.
+The data of event is contained in `data` such like
-This project is intended to be build with the 4.0 release of AGL.
+```json
+{
+ "event":"windowmanager\/active",
+ "date":{
+ "drawing_name":"navigation"
+ },
+ "jtype":"afb-event"
+}
+```
+
+"event" is the event name.
+"data" is the data object from Window Manager and contains
+the message of event.
+This section describes "event" and the contents of "data".
-Build dependencies are as follows:
+### active
-- afb-daemon >= 1.0
+This event means when the application becomes active state.
-- libsystemd >= 222
+example :
+
+```json
+{
+ "event":"windowmanager\/active",
+ "data":{
+ "drawing_name":"launcher"
+ }
+ },
+ "jtype":"afb-event"
+}
+```
-- wayland-client >= 1.11
+### inactive
-- cmake >= 3.6.1
+This event means when the application becomes inactive state.
-Build Configuration
--------------------
+example :
-**Download recipe**
-If repo is already done, please start with git clone
+```json
+{
+ "event":"windowmanager\/inactive",
+ "data":{
+ "drawing_name":"launcher"
+ }
+ },
+ "jtype":"afb-event"
+}
```
-$ mkdir WORK
-$ cd WORK
-$ repo init -b dab -m dab_4.0.0_xml -u https://gerrit.automotivelinux.org/gerrit/AGL/AGL-repo
-$ repo sync
-$ git clone https://gerrit.automotivelinux.org/gerrit/staging/meta-hmi-framework
+### visible
+
+This event is issued when the application is visible state.
+
+example :
+
+```json
+{
+ "event":"windowmanager\/visible",
+ "data":{
+ "drawing_name":"launcher"
+ }
+ },
+ "jtype":"afb-event"
+}
+```
+
+### invisible
+
+This event is issued when the application is invisible state.
+
+example :
+
+```json
+{
+ "event":"windowmanager\/invisible",
+ "data":{
+ "drawing_name":"launcher"
+ }
+ },
+ "jtype":"afb-event"
+}
+```
+
+<div id="syncDraw"></div>
+
+### syncDraw
+
+This event is issued by Window Manager state change operation in policy to the following cases.
+
+- Your app requested `activateWindow` then your application will be resized or visible.
+- Other app requested `activateWindow` then your application will be resized or visible.
+- Window Manager change layout due to vehicle condition.
+
+This event is the requests from Window Manager to
+
+- request your app to callback `endDraw` to Window Manager.
+- request your app to resize and redraw according to "drawing_area".
+
+This is the abstract word then the real size is given in "drawing_rect".
+
+example :
+
+```json
+{
+ "event":"windowmanager\/syncDraw",
+ "data":{
+ "drawing_name":"radio",
+ "drawing_area":"normal.full",
+ "drawing_rect":{
+ "x":0,
+ "y":218,
+ "width":1080,
+ "height":1488
+ }
+ },
+ "jtype":"afb-event"
+}
```
-Then you can get the following recipe.
-* `meta-hmi-framework/windowmanager`
+An application which gets this event must send `endDraw`.
+For details, please see the sequence.
+
+<div id="flushDraw"></div>
+
+### flushDraw
+
+This event is issued after Window Manager receives all `endDraw` from applications who recieved `syncDraw` .
+After this event, Window Manager expects applications to update its surface.
+example :
-**Bitbake**
+```json
+{
+ "event":"windowmanager\/flushDraw",
+ "data":{
+ "drawing_name":"launcher"
+ }
+ },
+ "jtype":"afb-event"
+}
```
-$ source meta-agl/scripts/aglsetup.sh -m m3ulcb agl-demo agl-devel agl-appfw-smack agl-hmi-framework
-$ bitbake agl-service-windowmanager-2017
+
+### screenUpdated
+
+This event is issued after the visible application changes as a state transition change. This contains resized applications and visible applications. This event is issued to all subscriber.
+Typical usecase is only for HomeScreen. If HomeScreen has an animation until the started application is visible such as progress bar, this signal may become a switch to stop the animation.
+
+```json
+{
+ "event":"windowmanager\/screenUpdated",
+ "data":{
+ "ids":[
+ "mediaplayer",
+ "navi"
+ ]
+ },
+ "jtype":"afb-event"
+}
```
+"ids" is the application_id described in config.xml of application.
-A couple of build options to configure the build are available:
+<div id="Client library"></div>
-- `ENABLE_DEBUG_OUTPUT:BOOL` Compiles including very verbose debug
- output from the window manager, use --verbose three times on an
- afb-daemon instance to see the debug messages.
+## Client library
-- `ENABLE_SCOPE_TRACING:BOOL` Enables a simple scope tracing mechanism
- used for a rather small portion of the window manager code. However,
- it is used quite extensively in the libwindowmanager implementation.
+A client library implementation that internally uses the *libafbwsc*, is
+provided in the `libwindowmanager`.
+This library is for C++ native application.
+
+Regarding more detail, please refer to <https://gerrit.automotivelinux.org/gerrit/gitweb?p=src%2Flibwindowmanager.git;a=summary>
-By default these options will be disabled.
+* * *
+<div id="Sample\ Code"></div>
-Implementation Notes
-====================
+# Sample code
-The window manager is implemented as a app-framework-binder binding.
-That means, the build produces one shared object that exports a binding
-interface.
+In order to enable application to activate application(render on layer),
+above described steps need to be implemented.
-Binding code generation
------------------------
+As a minimal example the usage and initialization can look like the
+following.
-The binding API is rather simple; functions receive a json object
-describing arguments and return a json object describing the result or
-an error. In order to simplify development, the
-`generate-binding-glue.py` script was added, that contains a description
-of the API as a python dictionary. This script generates the header
-`afb_binding_api.hpp` and the afb binding functions as
-`afb_binding_glue.inl`. Where the latter is included in `main.cpp`.
+Repo: `git clone https://gerrit.automotivelinux.org/gerrit/src/libhomescreen`
+Path: `sample/simple-egl/main.c`
+Typical implementation of C++ application.
-Each function for the AFB binding that is generated does the following:
+Repo: `git clone https://gerrit.automotivelinux.org/gerrit/apps/radio`
+Typical implementation of Qt application.
-- Lock the binding mutex, so that we serialize all access to
- the binding.
+Repo: `git clone https://gerrit.automotivelinux.org/gerrit/apps/videoplayer`
+This is the good example to write more simply for Qt application using QtAGLExtra.
-- Do some debug logging (if wanted).
+<div id="Policy Manager"></div>
-- Check the binding state, i.e. the compositor might have exited
- unexpectedly at which point it would not make sense to continue.
+# Policy Manager
-- Extract the arguments from the json object that is provided (doing
- some primitive type checking).
+## Concepts
-- Call the afb\_binding\_api method corresponding to this binding
- function
+Policy Manager decides next layout by using input event data and current state
+based on the policy table.
-- Check the afb\_binding\_api’s function return value, log an error
- state and return the result to the afb request.
+And PolicyManager is plugin for WindowManager.
+Therefore the OEMs can replace it.
-The generated functions do also check for any "loose" exception that
-comes out of the afb\_binding\_api call (which in turn might call the
-actual non-trivial implementation in `App`). However, **IF** an
-exception is thrown and not handled inside the afb\_binding\_call, that
-internal state of the window manager might be broken at this time (hence
-the talkative error log).
+<div id="Enabling\ split"></div>
-Structure
----------
+## Enabling split
-The implementation is loosely split across the following source files:
+Window Manager supports split layout to change policy and `areas.db`.
+This section describes how to play split layout.
+The sample image is here.
-- `main.cpp`: The program entry point as used by the afb-daemon. This
- file defines the afbBindingV2 symbol tat is used by the afb-daemon
- in order to load a binding. It also defines the wayland fd event
- dispatcher and some globals to be used (as context for the afb calls
- we receive).
+
-- `afb_binding_api.cpp`: The implementation of the afb
- binding functions. The actual functions are generated by
- `generate-binding-glue.py` which generates a **.inl** file that is
- included by `main.cpp`.
+To play the split layout,
-- `app.cpp` / `app.hpp`: This is the main application
- logic implementation.
+1. Edit in `policy_manager/CMakeLists.txt` as follows:
+ #set(STM_DIR stub)
+ set(STM_DIR zipc)
+ This results in using source code generated by ZIPC.
+1. Set bool value "ON" to TRY_SPLIT_LAYOUT at line 28 in policy_manager/CMakeLists.txt as follows:
+ set(TRY_SPLIT_LAYOUT ON CACHE BOOL "Enable to show split layout")
+1. compile
+1. copy window manager to your board
+1. re-install windowmanager and reboot
-- `config.cpp` / `config.hpp`: Very simple configuration
- item interface.
+As a result, if application requests `navi` with `activateWindow` when current layout is `video` or `mediaplayer`, Window Manager change layout to split window. The reverse is true.
-- `controller_hooks.hpp`: hook functions called by the wayland
- controller to call into the App instance. Only a very limited number
- of events are passed to the Application, which allowed the usage of
- such a simple interface.
+Note:
+Currently, the policy manager force application change the size even if the application which has the role doesn't have the split design.
+In that case, the view of application may be ugly.
+Window Manager supposes that applications may have multi designs according to system design by OEM.
+For example, if OEM sets 2 pattern layout for `navi`, the application which requests `navi` should have 2 pattern designs.
-- `json_helper.cpp` / `json_helper.hpp`: Smaller json related
- helper functions.
+* * *
-- `layers.cpp` / `layers.hpp`: Actually hold all the data from
- layers.json configuration, do some transformations and service the
- App implementation.
+<div id="Release\ Note"></div>
-- `layout.cpp` / `layout.hpp`: Very simple layout state for the
- implementation of split layouts and tracking of the
- surfaces involved.
+# Release Note
-- `policy.hpp`: PolicyManager implementation stub. Gets passed the
- current and new layout on layout switch and can decide upon it being
- valid or not.
+## version: 0.7
-- `result.hpp`: Simple result class around
- `std::experimental::optional` that additionally can hold a
- `char const *` to describe the error.
+### New Feature
-- `util.cpp` / `util.hpp`: general utility functions and structs - and
- preprocessor definitions (e.g. `log*()` to AFB logging functions.
+- Add Policy Manager
-- `wayland.cpp` / `wayland.hpp`: A C++ object-oriented
- libwayland-client wrapper. It is instanced in `main.cpp` and handles
- all our wayland needs.
+### Limitation
+- Only single-surface Qt applications are support through the
+ libwindowmanager library. This is a limitation of how Qt creates surface
+ IDs for the ivi-application interface.
+- Currenly, Window Manager supports only one screen. Dual display is not supported.
+- As implemented in sample code, Qt application has to wait requesting `activateWindow` until `frameSwapped` is emitted.
+- Qt application conceals, wayland and openGL processes, so it is difficult to call `swapBuffer` after `flushDraw` event described in the architecture document. But no problem if you use toolkit such as Qt, because it is automatically processed between applications and compositor(weston).
+- Editing ZIPC is difficult for open source developer due to licence.
Code Review / apps / agl-service-windowmanager.git / blobdiff