Add setRenderOrder into WMClient
[apps/agl-service-windowmanager.git] / src / wm_client.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 WINDOWMANAGER_CLIENT_HPP
18 #define WINDOWMANAGER_CLIENT_HPP
19
20 #include <vector>
21 #include <string>
22 #include <unordered_map>
23 #include "wm_error.hpp"
24
25 extern "C"
26 {
27 #define AFB_BINDING_VERSION 2
28 #include <afb/afb-binding.h>
29 }
30
31 namespace wm
32 {
33
34 enum WM_CLIENT_ERROR_EVENT
35 {
36     UNKNOWN_ERROR
37 };
38
39 class WMClient
40 {
41   public:
42     WMClient();
43     WMClient(const std::string &appid, unsigned layer,
44             unsigned surface, const std::string &role);
45     WMClient(const std::string &appid, const std::string &role);
46     WMClient(const std::string &appid, unsigned layer, const std::string &role);
47     WMClient(const std::string &appid, unsigned layer,
48         const std::string& layer_name, unsigned surface, const std::string &role);
49     ~WMClient() = default;
50
51     std::string appID() const;
52     std::string role() const;
53     unsigned layerID() const;
54     unsigned surfaceID() const;
55     // void setRole(const std::string& role);
56     // void appendRole(const std::string& role);
57     WMError addSurface(unsigned surface);
58     bool removeSurfaceIfExist(unsigned surface);
59     // bool removeRole(const std::string& role);
60     std::vector<unsigned> renderOrder() const;
61     WMError setRenderOrder(const std::vector<std::string>& order);
62
63 #if GTEST_ENABLED
64     bool subscribe(afb_req req, const std::string &event_name);
65     void emitError(WM_CLIENT_ERROR_EVENT ev);
66 #endif
67
68     void dumpInfo();
69
70   private:
71     std::string id;
72     unsigned layer;
73     std::string main_role;
74     std::string area;
75     unsigned surface; // currently, main application has only one surface.
76     //std::vector<std::string> role_list;
77     std::vector<unsigned> surface_render_order;
78     std::unordered_map<std::string, unsigned> service2surfaces;
79     std::unordered_map<std::string, unsigned> role2surface;
80 #if GTEST_ENABLED
81     // This is for unit test. afb_make_event occurs sig11 if call not in afb-binding
82     std::unordered_map<std::string, std::string> evname2afb_event;
83 #else
84     std::unordered_map<std::string, struct afb_event> evname2afb_event;
85 #endif
86 };
87 } // namespace wm
88
89 #endif