Support XDG application
[apps/agl-service-windowmanager-2017.git] / src / app.hpp
1 /*
2  * Copyright (c) 2017 TOYOTA MOTOR CORPORATION
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef TMCAGLWM_APP_HPP
18 #define TMCAGLWM_APP_HPP
19
20 #include <json-c/json.h>
21
22 #include <atomic>
23 #include <memory>
24 #include <unordered_map>
25 #include <unordered_set>
26 #include <experimental/optional>
27
28 #include "afb_binding_api.hpp"
29 #include "config.hpp"
30 #include "controller_hooks.hpp"
31 #include "layers.hpp"
32 #include "layout.hpp"
33 #include "policy.hpp"
34 #include "result.hpp"
35 #include "wayland.hpp"
36 #include "hmi-debug.h"
37
38 namespace wl {
39 struct display;
40 }
41
42 namespace compositor {
43 struct controller;
44 }
45
46 namespace wm {
47
48 using std::experimental::optional;
49
50 /* DrawingArea name used by "{layout}.{area}" */
51 static const char *kNameLayoutNormal = "normal";
52 static const char *kNameLayoutSplit = "split";
53 static const char *kNameAreaFull = "full";
54 static const char *kNameAreaMain = "main";
55 static const char *kNameAreaSub = "sub";
56
57 /* Key for json obejct */
58 static const char *kKeyDrawingName = "drawing_name";
59 static const char *kKeyDrawingArea = "drawing_area";
60
61 struct id_allocator {
62    unsigned next = 1;
63
64    // Surfaces that where requested but not yet created
65    std::unordered_map<unsigned, std::string> id2name;
66    // std::unordered_set<unsigned> pending_surfaces;
67    std::unordered_map<std::string, unsigned> name2id;
68
69    id_allocator(id_allocator const &) = delete;
70    id_allocator(id_allocator &&) = delete;
71    id_allocator &operator=(id_allocator const &);
72    id_allocator &operator=(id_allocator &&) = delete;
73
74    // Insert and return a new ID
75    unsigned generate_id(std::string const &name) {
76       unsigned sid = this->next++;
77       this->id2name[sid] = name;
78       // this->pending_surfaces.insert({sid});
79       this->name2id[name] = sid;
80       HMI_DEBUG("wm", "allocated new id %u with name %s", sid, name.c_str());
81       return sid;
82    }
83
84    // Insert a new ID which defined outside
85    void register_name_id(std::string const &name, unsigned sid) {
86       this->id2name[sid] = name;
87       this->name2id[name] = sid;
88       HMI_DEBUG("wm", "register id %u with name %s", sid, name.c_str());
89       return;
90    }
91
92    // Lookup by ID or by name
93    optional<unsigned> lookup(std::string const &name) const {
94       auto i = this->name2id.find(name);
95       return i == this->name2id.end() ? nullopt : optional<unsigned>(i->second);
96    }
97
98    optional<std::string> lookup(unsigned id) const {
99       auto i = this->id2name.find(id);
100       return i == this->id2name.end() ? nullopt
101                                        : optional<std::string>(i->second);
102    }
103
104    // Remove a surface id and name
105    void remove_id(std::string const &name) {
106       auto i = this->name2id.find(name);
107       if (i != this->name2id.end()) {
108          this->id2name.erase(i->second);
109          this->name2id.erase(i);
110       }
111    }
112
113    void remove_id(unsigned id) {
114       auto i = this->id2name.find(id);
115       if (i != this->id2name.end()) {
116          this->name2id.erase(i->second);
117          this->id2name.erase(i);
118       }
119    }
120 };
121
122 struct App {
123    enum EventType {
124       Event_Val_Min = 0,
125
126       Event_Active = Event_Val_Min,
127       Event_Inactive,
128
129       Event_Visible,
130       Event_Invisible,
131
132       Event_SyncDraw,
133       Event_FlushDraw,
134
135       Event_Val_Max = Event_FlushDraw,
136    };
137
138    const std::vector<const char *> kListEventName{
139      "active",
140      "inactive",
141      "visible",
142      "invisible",
143      "syncdraw",
144      "flushdraw"
145    };
146
147    struct binding_api api;
148    struct controller_hooks chooks;
149
150    // This is the one thing, we do not own.
151    struct wl::display *display;
152
153    std::unique_ptr<struct compositor::controller> controller;
154    std::vector<std::unique_ptr<struct wl::output>> outputs;
155
156    struct config config;
157
158    // track current layouts separately
159    layer_map layers;
160
161    // ID allocation and proxy methods for lookup
162    struct id_allocator id_alloc;
163
164    // Set by AFB API when wayland events need to be dispatched
165    std::atomic<bool> pending_events;
166
167    std::vector<int> pending_end_draw;
168
169    Policy policy;
170
171    std::map<const char *, struct afb_event> map_afb_event;
172
173    explicit App(wl::display *d);
174    ~App() = default;
175
176    App(App const &) = delete;
177    App &operator=(App const &) = delete;
178    App(App &&) = delete;
179    App &operator=(App &&) = delete;
180
181    int init();
182
183    int dispatch_events();
184    int dispatch_pending_events();
185
186    void set_pending_events();
187
188    result<int> api_request_surface(char const *drawing_name);
189    char const *api_request_surface(char const *drawing_name, char const *ivi_id);
190    char const *api_activate_surface(char const *drawing_name, char const *drawing_area);
191    char const *api_deactivate_surface(char const *drawing_name);
192    char const *api_enddraw(char const *drawing_name);
193    char const *api_subscribe(afb_req *req, char const *event_name);
194    void api_ping();
195
196    // Events from the compositor we are interested in
197    void surface_created(uint32_t surface_id);
198    void surface_removed(uint32_t surface_id);
199
200 private:
201    optional<int> lookup_id(char const *name);
202    optional<std::string> lookup_name(int id);
203
204    bool pop_pending_events();
205
206    void enqueue_flushdraw(int surface_id);
207    void check_flushdraw(int surface_id);
208
209    int init_layers();
210
211    void surface_set_layout(int surface_id, optional<int> sub_surface_id = nullopt);
212    void layout_commit();
213
214    // TMC WM Events to clients
215    void emit_activated(char const *label);
216    void emit_deactivated(char const *label);
217    void emit_syncdraw(char const *label, char const *area);
218    void emit_flushdraw(char const *label);
219    void emit_visible(char const *label, bool is_visible);
220    void emit_invisible(char const *label);
221    void emit_visible(char const *label);
222
223    void activate(int id);
224    void deactivate(int id);
225    void deactivate_main_surface();
226
227    bool can_split(struct LayoutState const &state, int new_id);
228    void try_layout(struct LayoutState &state,
229                    struct LayoutState const &new_layout,
230                    std::function<void(LayoutState const &nl)> apply);
231 };
232
233 }  // namespace wm
234
235 #endif  // TMCAGLWM_APP_HPP