• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2023 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef OHOS_FORM_FWK_FORM_RENDER_MGR_INNER_H
17 #define OHOS_FORM_FWK_FORM_RENDER_MGR_INNER_H
18 
19 #include <atomic>
20 #include <queue>
21 #include <shared_mutex>
22 #include <unordered_map>
23 
24 #include "form_record.h"
25 #include "form_render_connection.h"
26 #include "form_render_interface.h"
27 #include "want.h"
28 
29 namespace OHOS {
30 namespace AppExecFwk {
31 using Want = OHOS::AAFwk::Want;
32 using WantParams = OHOS::AAFwk::WantParams;
33 /**
34  * @class FormRenderMgrInner
35  * FormRenderMgrInner provides a facility for managing form render life cycle.
36  */
37 class FormRenderMgrInner {
38 public:
39     FormRenderMgrInner();
40     virtual ~FormRenderMgrInner();
41 
42     virtual ErrCode RenderForm(
43         const FormRecord &formRecord, Want &want, const sptr<IRemoteObject> &hostToken = nullptr);
44 
45     ErrCode UpdateRenderingForm(FormRecord &formRecord, const FormProviderData &formProviderData,
46         const WantParams &wantParams, bool mergeData);
47 
48     ErrCode StopRenderingForm(int64_t formId, const FormRecord &formRecord,
49         const std::string &compId = "", const sptr<IRemoteObject> &hostToken = nullptr);
50 
51     ErrCode ReloadForm(const std::vector<FormRecord> &&formRecords, const std::string &bundleName, int32_t userId);
52 
53     ErrCode StopRenderingFormCallback(int64_t formId, const Want &want);
54 
55     ErrCode AddConnection(int64_t formId, sptr<FormRenderConnection> connection);
56 
57     void RemoveConnection(int64_t formId);
58 
59     void AddRenderDeathRecipient(const sptr<IRemoteObject> &renderRemoteObj);
60 
61     void RerenderAllForms();
62 
63     void CleanFormHost(const sptr<IRemoteObject> &host);
64 
65     void OnRenderingBlock(const std::string &bundleName);
66 
67     ErrCode ReleaseRenderer(int64_t formId, const FormRecord &formRecord, const std::string &compId);
68 
69     void PostOnUnlockTask();
70 
71     void NotifyScreenOn();
72 
73     void PostSetVisibleChangeTask(int64_t formId, bool isVisible);
74 
75     int32_t GetReRenderCount() const;
76 
77     sptr<IFormRender> GetRenderRemoteObj() const;
78 
79     void SetRenderRemoteObj(sptr<IFormRender> remoteObject);
80 
81     ErrCode RecycleForms(const std::vector<int64_t> &formIds, const Want &want,
82         const sptr<IRemoteObject> &remoteObjectOfHost);
83 
84     ErrCode RecoverForms(const std::vector<int64_t> &formIds, const WantParams &wantParams);
85 
86     void SetUserId(int32_t userId);
87 
88     int32_t GetUserId() const;
89 
90     void RerenderAllFormsImmediate();
91 
92     void DisconnectAllRenderConnections();
93 private:
94     ErrCode ConnectRenderService(const sptr<FormRenderConnection> &connection, int32_t level) const;
95 
96     void DisconnectRenderService(const sptr<FormRenderConnection> connection, size_t size) const;
97 
98     void AddHostToken(const sptr<IRemoteObject> &host, int64_t formId);
99 
100     void RemoveHostToken(const sptr<IRemoteObject> &host);
101 
102     void NotifyHostRenderServiceIsDead() const;
103 
104     void FillBundleInfo(Want &want, const std::string &bundleName) const;
105 
106     void CheckIfFormRecycled(FormRecord &formRecord, Want& want) const;
107 
108     ErrCode GetConnectionAndRenderForm(FormRecord &formRecord, Want &want);
109 
110     ErrCode GetRenderObject(sptr<IRemoteObject> &renderObj);
111 
112 private:
113     class RemoteObjHash {
114     public:
operator()115         size_t operator() (const sptr<IRemoteObject> &remoteObj) const
116         {
117             return reinterpret_cast<size_t>(remoteObj.GetRefPtr());
118         }
119     };
120 
121     mutable std::mutex resourceMutex_;
122     mutable std::shared_mutex renderRemoteObjMutex_;
123     // <formId, connectionToRenderService>
124     std::unordered_map<int64_t, sptr<FormRenderConnection>> renderFormConnections_;
125     // <hostToken, formIds>
126     std::unordered_map<sptr<IRemoteObject>, std::unordered_set<int64_t>, RemoteObjHash> etsHosts_;
127     sptr<IFormRender> renderRemoteObj_ = nullptr;
128     sptr<IRemoteObject::DeathRecipient> renderDeathRecipient_ = nullptr;
129     std::atomic<int32_t> atomicRerenderCount_ = 0;
130     // userId_ is Active User
131     bool isActiveUser_ = true;
132     int32_t userId_ = 0;
133 };
134 
135 /**
136  * @class FormRenderRecipient
137  * FormRenderRecipient notices IRemoteBroker died.
138  */
139 class FormRenderRecipient : public IRemoteObject::DeathRecipient {
140 public:
141     using RemoteDiedHandler = std::function<void()>;
142 
143     explicit FormRenderRecipient(RemoteDiedHandler handler);
144 
145     virtual ~FormRenderRecipient();
146 
147     void OnRemoteDied(const wptr<IRemoteObject> &remote) override;
148 
149 private:
150     RemoteDiedHandler handler_;
151 };
152 } // namespace AppExecFwk
153 } // namespace OHOS
154 #endif // OHOS_FORM_FWK_FORM_RENDER_MGR_INNER_H
155