Fix invalid markdown
[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 "util.hpp"
24 #include "wm_error.hpp"
25
26 extern "C"
27 {
28 #include <afb/afb-binding.h>
29 }
30
31 namespace wm
32 {
33
34 class WMClient
35 {
36   public:
37     WMClient();
38     WMClient(const std::string &appid, unsigned layer,
39             unsigned surface, const std::string &role);
40     WMClient(const std::string &appid, const std::string &role);
41     WMClient(const std::string &appid, unsigned layer, const std::string &role);
42     WMClient(const std::string &appid, unsigned layer,
43         const std::string& layer_name, unsigned surface, const std::string &role);
44     ~WMClient() = default;
45
46     std::string appID() const;
47     std::string role() const;
48     void setRole(const std::string& role);
49     unsigned layerID() const;
50     void setLayerID(unsigned id);
51     unsigned surfaceID() const;
52     void registerSurface(unsigned surface);
53     void activate();
54     void deactivate();
55     std::string area() const {return this->app_area;};
56     void setArea(const std::string area) {this->app_area = area;}
57     WMError addSurface(unsigned surface);
58     bool isSourceSizeSet();
59     void setSurfaceSizeCorrectly();
60     bool isActive() { return this->is_active;}
61     bool removeSurfaceIfExist(unsigned surface);
62
63     bool subscribe(afb_req_t req, const std::string &event_name);
64     void emitActive(bool active);
65     void emitVisible(bool visible);
66     void emitSyncDraw(const std::string& area, struct rect& r);
67     void emitFlushDraw();
68     void emitError(WMError error);
69
70     void dumpInfo();
71
72   private:
73     std::string id;
74     unsigned layer;
75     bool is_source_set;
76     bool is_active;
77     std::string main_role;
78     std::string app_area;
79     unsigned surface; // currently, main application has only one surface.
80     //std::vector<std::string> role_list;
81     std::unordered_map<std::string, unsigned> role2surface;
82 #if GTEST_ENABLED
83     // This is for unit test. afb_make_event occurs sig11 if call not in afb-binding
84     std::unordered_map<std::string, std::string> evname2afb_event;
85 #else
86     std::unordered_map<std::string, afb_event_t> evname2afb_event;
87 #endif
88 };
89 } // namespace wm
90
91 #endif