policy-default: Install a default policy engine

This is just an example on how to use the policy framework API and
allows all actions to performed by default.

Bug-AGL: SPEC-3217

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
Change-Id: I83c9e61a2f2a89c373352232009cea4c6f6a3ad6

diff --git a/meson.build b/meson.build
index cfe446d..642448e 100644 (file)
--- a/meson.build
+++ b/meson.build
@@ -121,6 +121,7 @@ srcs_agl_compositor = [
        'src/desktop.c',
        'src/layout.c',
        'src/policy.c',
+       'src/policy-default.c',
        'src/shell.c',
        'shared/option-parser.c',
        'shared/os-compatibility.c',

diff --git a/src/main.c b/src/main.c
index f715280..2b12a7b 100644 (file)
--- a/src/main.c
+++ b/src/main.c
@@ -24,6 +24,7 @@
  */
 
 #include "ivi-compositor.h"
+#include "policy.h"
 
 #include <assert.h>
 #include <errno.h>
@@ -1228,6 +1229,9 @@ int main(int argc, char *argv[])
        if (ivi_desktop_init(&ivi) < 0)
                goto error_compositor;
 
+       if (ivi_policy_init(&ivi) < 0)
+               goto error_compositor;
+
        if (ivi_shell_init(&ivi) < 0)
                goto error_compositor;
 
@@ -1263,6 +1267,8 @@ error_compositor:
 
        weston_log_subscriber_destroy_log(logger);
 
+       ivi_policy_destroy(ivi.policy);
+
 error_signals:
        for (size_t i = 0; i < ARRAY_LENGTH(signals); ++i)
                if (signals[i])

diff --git a/src/policy-default.c b/src/policy-default.c
new file mode 100644 (file)
index 0000000..89b858a
--- /dev/null
+++ b/src/policy-default.c
@@ -0,0 +1,104 @@
+/*
+ * Copyright © 2020 Collabora, Ltd.
+ *
+ * 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 (including the
+ * next paragraph) 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.
+ */
+
+#include "ivi-compositor.h"
+#include "policy.h"
+
+/*
+ * default policy implementation allows every action to be possible
+ *
+ * This is an example, that implements the API
+ *
+ * For injecting rules back in the compositor one should use ivi_policy_add()
+ * - policy_rule_allow_to_add is required in order to add further policy rules
+ * - policy_rule_try_event will be callback executed when handling the state
+ *   change
+ */
+static bool
+ivi_policy_default_surface_create(struct ivi_surface *surf, void *user_data)
+{
+       /* verify that the surface should be created */
+       return true;
+}
+
+static bool
+ivi_policy_default_surface_commmited(struct ivi_surface *surf, void *user_data)
+{
+       /* verify that the surface should be committed */
+       return true;
+}
+
+static bool
+ivi_policy_default_surface_activate(struct ivi_surface *surf, void *user_data)
+{
+       /* verify that the surface should be switched to */
+       return true;
+}
+
+static bool
+ivi_policy_default_allow_to_add(void *user_data)
+{
+       /* verify that policy rules can be added with ivi_policy_add() */
+       return true;
+}
+
+/*
+ * Policy rules added by ivi_policy_add() will be handled by this callback, and
+ * should be treated depending on the event. Note this is just an example.
+ */
+static void
+ivi_policy_default_try_event(struct ivi_a_policy *a_policy)
+{
+       uint32_t event = a_policy->event;
+
+       switch (event) {
+       case AGL_SHELL_POLICY_EVENT_SHOW:
+               ivi_layout_activate(a_policy->output, a_policy->app_id);
+               break;
+       case AGL_SHELL_POLICY_EVENT_HIDE:
+               /* FIXME: remove the active one, like basically unmap it? */
+       default:
+               break;
+       }
+}
+
+static const struct ivi_policy_api policy_api = {
+       .struct_size = sizeof(policy_api),
+       .surface_create = ivi_policy_default_surface_create,
+       .surface_commited = ivi_policy_default_surface_commmited,
+       .surface_activate = ivi_policy_default_surface_activate,
+       .policy_rule_allow_to_add = ivi_policy_default_allow_to_add,
+       .policy_rule_try_event = ivi_policy_default_try_event,
+};
+
+int
+ivi_policy_init(struct ivi_compositor *ivi)
+{
+       ivi->policy = ivi_policy_create(ivi, &policy_api, ivi);
+       if (!ivi->policy)
+               return -1;
+
+       return 0;
+}