src/applist.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 ALLOCATE_LIST_HPP
  18 #define ALLOCATE_LIST_HPP
  19 #include <vector>
  20 #include <string>
  21 #include <map>
  22 #include <memory>
  23 #include <mutex>
  24 #include "wm_client.hpp"
  25 #include "request.hpp"
  26 #include "wm_error.hpp"
  27
  28 namespace wm
  29 {
  30
  31 /* using std::experimental::nullopt;
  32 using std::experimental::optional; */
  33
  34 struct FloatingSurface
  35 {
  36     std::string appid;
  37     unsigned surface_id;
  38     unsigned pid;
  39 };
  40
  41 class AppList
  42 {
  43   public:
  44     AppList();
  45     virtual ~AppList();
  46     AppList(const AppList &obj) = delete;
  47
  48     // Client Database Interface
  49     /* TODO: consider, which is better WMClient as parameter or not
  50        If the WMClient should be more flexible, I think this param should be WMClient class
  51     */
  52     void addClient(const std::string &appid, unsigned layer,
  53                     unsigned surface, const std::string &role);
  54     void addClient(const std::string &appid, unsigned layer, const std::string &role);
  55     void removeClient(const std::string &appid);
  56     bool contains(const std::string &appid) const;
  57     int  countClient() const;
  58     std::shared_ptr<WMClient> lookUpClient(const std::string &appid);
  59     void removeSurface(unsigned surface);
  60     std::string getAppID(unsigned surface, bool* found) const; // TODO: remove
  61
  62
  63     // Floating surface
  64     void addFloatingClient(const std::string &appid, unsigned layer, const std::string &role);
  65     void addFloatingSurface(const std::string &appid, unsigned surface, unsigned pid);
  66     WMError popFloatingSurface(unsigned pid, unsigned *surface);
  67     WMError popFloatingSurface(const std::string &appid, unsigned *surface);
  68     void removeFloatingSurface(unsigned surface);
  69
  70     // Request Interface
  71     unsigned currentRequestNumber() const;
  72     unsigned getRequestNumber(const std::string &appid) const;
  73     unsigned addRequest(WMRequest req);
  74     WMError setAction(unsigned req_num, const struct WMAction &action);
  75     WMError setAction(unsigned req_num, std::shared_ptr<WMClient> client,
  76                     const std::string &role, const std::string &area, TaskVisible visible);
  77     bool setEndDrawFinished(unsigned req_num, const std::string &appid, const std::string &role);
  78     bool endDrawFullfilled(unsigned req_num);
  79     void removeRequest(unsigned req_num);
  80     void next();
  81     bool haveRequest() const;
  82
  83     struct WMTrigger getRequest(unsigned req_num, bool* found);
  84     const std::vector<struct WMAction> &getActions(unsigned req_num, bool* found);
  85
  86     void clientDump();
  87     void reqDump();
  88     void dumpFloatingSurfaces();
  89
  90   private:
  91     std::vector<WMRequest> req_list;
  92     std::unordered_map<std::string, std::shared_ptr<WMClient>> app2client;
  93     unsigned current_req;
  94     std::mutex mtx;
  95     std::vector<struct FloatingSurface> floating_surfaces;
  96 };
  97
  98 } // namespace wm
  99 #endif // ALLOCATE_LIST_HPP