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 class AppList
  35 {
  36   public:
  37     AppList();
  38     virtual ~AppList();
  39     AppList(const AppList &obj) = delete;
  40
  41     // Client Database Interface
  42     /* TODO: consider, which is better WMClient as parameter or not
  43        If the WMClient should be more flexible, I think this param should be WMClient class
  44     */
  45     void addClient(const std::string &appid, unsigned layer,
  46                     unsigned surface, const std::string &role);
  47     void addClient(const std::string &appid, unsigned layer, const std::string &role);
  48     void addClient(const std::string &appid);
  49     void removeClient(const std::string &appid);
  50     bool contains(const std::string &appid) const;
  51     int  countClient() const;
  52     std::shared_ptr<WMClient> lookUpClient(const std::string &appid);
  53     void removeSurface(unsigned surface);
  54     std::string getAppID(unsigned surface, bool* found) const; // TODO: remove
  55
  56     // Request Interface
  57     unsigned currentRequestNumber() const;
  58     unsigned getRequestNumber(const std::string &appid) const;
  59     unsigned addRequest(WMRequest req);
  60     WMError setAction(unsigned req_num, const struct WMAction &action);
  61     WMError setAction(unsigned req_num, std::shared_ptr<WMClient> client,
  62                     const std::string &role, const std::string &area, TaskVisible visible);
  63     bool setEndDrawFinished(unsigned req_num, const std::string &appid, const std::string &role);
  64     bool endDrawFullfilled(unsigned req_num);
  65     void removeRequest(unsigned req_num);
  66     void next();
  67     bool haveRequest() const;
  68
  69     struct WMTrigger getRequest(unsigned req_num, bool* found);
  70     const std::vector<struct WMAction> &getActions(unsigned req_num, bool* found);
  71
  72     void clientDump();
  73     void reqDump();
  74
  75   private:
  76     std::vector<WMRequest> req_list;
  77     std::unordered_map<std::string, std::shared_ptr<WMClient>> app2client;
  78     unsigned current_req;
  79     std::mutex mtx;
  80 };
  81
  82 } // namespace wm
  83 #endif // ALLOCATE_LIST_HPP