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
  24 extern "C"
  25 {
  26 #define AFB_BINDING_VERSION 2
  27 #include <afb/afb-binding.h>
  28 }
  29
  30 namespace wm
  31 {
  32
  33 enum WM_CLIENT_ERROR_EVENT
  34 {
  35     UNKNOWN_ERROR
  36 };
  37
  38 class WMClient
  39 {
  40   public:
  41     WMClient();
  42     WMClient(const std::string &appid, unsigned layer,
  43             unsigned surface, const std::string &role);
  44     WMClient(const std::string &appid, const std::string &role);
  45     WMClient(const std::string &appid, unsigned layer,
  46         const std::string& layer_name, unsigned surface, const std::string &role);
  47     ~WMClient() = default;
  48
  49     std::string appID() const;
  50     unsigned surfaceID(const std::string &role) const;
  51     unsigned layerID() const;
  52     const std::string& getWMLayerName();
  53     unsigned surfaceID() const;
  54     std::vector<unsigned> renderOrder() const;
  55     std::string role(unsigned surface) const;
  56     std::string role() const;
  57     const std::vector<std::string> &roles() const;
  58     void setRole(const std::string& role);
  59     void appendRole(const std::string& role);
  60     bool addSurface(const std::string& role, unsigned surface);
  61     bool removeSurfaceIfExist(unsigned surface);
  62     bool removeRole(const std::string& role);
  63
  64 #if GTEST_ENABLED
  65     bool subscribe(afb_req req, const std::string &event_name);
  66     void emitError(WM_CLIENT_ERROR_EVENT ev);
  67 #endif
  68
  69     void dumpInfo();
  70
  71   private:
  72     std::string id;
  73     unsigned layer;
  74     std::string wm_layer_name;
  75     std::string main_role;
  76     std::string area;
  77     unsigned surface; // currently, main application has only one surface.
  78     std::vector<std::string> role_list;
  79     std::vector<unsigned> surface_render_order;
  80     std::unordered_map<std::string, unsigned> service2surfaces;
  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, struct afb_event> evname2afb_event;
  87 #endif
  88 };
  89 } // namespace wm
  90
  91 #endif