1 /* 2 * Copyright (c) 2021 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 FOUNDATION_ACE_FRAMEWORKS_BRIDGE_PLUGIN_FRONTEND_PLUGIN_FRONTEND_H 17 #define FOUNDATION_ACE_FRAMEWORKS_BRIDGE_PLUGIN_FRONTEND_PLUGIN_FRONTEND_H 18 19 #include <string> 20 #include <unordered_map> 21 22 #include "base/memory/ace_type.h" 23 #include "base/utils/string_utils.h" 24 #include "core/common/ace_page.h" 25 #include "core/common/container.h" 26 #include "core/common/frontend.h" 27 #include "core/common/js_message_dispatcher.h" 28 #include "frameworks/bridge/plugin_frontend/plugin_frontend_delegate.h" 29 #include "frameworks/bridge/js_frontend/engine/common/js_engine.h" 30 31 namespace OHOS::Ace { 32 // PluginFrontend is the unique entrance from ACE backend to frontend. 33 // The relationship between AceActivity, AceContainer and PluginFrontend is 1:1:1. 34 // So PluginFrontend would be responsible for below things: 35 // - Create and initialize QuickJS engine. 36 // - Load pages of a JS app, and parse the manifest.json before loading main page. 37 // - Maintain the page stack of JS app by PluginFrontendDelegate. 38 // - Lifecycle of JS app (also AceActivity). 39 class PluginFrontend : public Frontend { 40 DECLARE_ACE_TYPE(PluginFrontend, Frontend); 41 42 public: 43 PluginFrontend() = default; 44 ~PluginFrontend() override; 45 46 bool Initialize(FrontendType type, const RefPtr<TaskExecutor>& taskExecutor) override; 47 48 void Destroy() override; 49 50 void AttachPipelineContext(const RefPtr<PipelineContext>& context) override; 51 52 void SetAssetManager(const RefPtr<AssetManager>& assetManager) override; 53 54 void RunPage(int32_t pageId, const std::string& url, const std::string& params) override; 55 56 void ReplacePage(const std::string& url, const std::string& params) override; 57 58 void PushPage(const std::string& url, const std::string& params) override; 59 60 // Js frontend manages all pages self. AddPage(const RefPtr<AcePage> & page)61 void AddPage(const RefPtr<AcePage>& page) override {}; 62 GetPage(int32_t pageId)63 RefPtr<AcePage> GetPage(int32_t pageId) const override 64 { 65 return nullptr; 66 }; 67 68 void TriggerGarbageCollection() override; 69 70 void SendCallbackMessage(const std::string& callbackId, const std::string& data) const override; 71 // platform channel. 72 void SetJsMessageDispatcher(const RefPtr<JsMessageDispatcher>& dispatcher) const override; 73 void TransferComponentResponseData(int32_t callbackId, int32_t code, 74 std::vector<uint8_t>&& data) const override; 75 void TransferJsResponseData(int32_t callbackId, int32_t code, std::vector<uint8_t>&& data) const override; 76 #if defined(WINDOWS_PLATFORM) || defined(MAC_PLATFORM) 77 void TransferJsResponseDataPreview(int32_t callbackId, int32_t code, ResponseData responseData) const; 78 #endif 79 void TransferJsPluginGetError(int32_t callbackId, int32_t errorCode, std::string&& errorMessage) const override; 80 void TransferJsEventData(int32_t callbackId, int32_t code, std::vector<uint8_t>&& data) const override; 81 void LoadPluginJsCode(std::string&& jsCode) const override; 82 void LoadPluginJsByteCode(std::vector<uint8_t>&& jsCode, std::vector<int32_t>&& jsCodeLen) const override; 83 84 // application lifecycle. 85 void UpdateState(Frontend::State state) override; 86 87 // page lifecycle. 88 bool OnBackPressed() override; 89 void OnShow() override; 90 void OnHide() override; 91 void OnConfigurationUpdated(const std::string& data) override; 92 void OnSaveAbilityState(std::string& data) override; 93 void OnRestoreAbilityState(const std::string& data) override; 94 void OnNewWant(const std::string& data) override; 95 void OnActive() override; 96 void OnInactive() override; 97 bool OnStartContinuation() override; 98 void OnCompleteContinuation(int32_t code) override; 99 void OnSaveData(std::string& data) override; 100 void GetPluginsUsed(std::string& data) override; 101 bool OnRestoreData(const std::string& data) override; 102 void OnRemoteTerminated() override; 103 void OnNewRequest(const std::string& data) override; 104 void OnMemoryLevel(const int32_t level) override; 105 void SetColorMode(ColorMode colorMode) override; 106 void CallRouterBack() override; 107 void NotifyAppStorage(const std::string& key, const std::string& value) override; 108 109 void OnSurfaceChanged(int32_t width, int32_t height) override; 110 111 void DumpFrontend() const override; 112 GetEventHandler()113 RefPtr<AceEventHandler> GetEventHandler() override 114 { 115 return handler_; 116 }; 117 GetType()118 FrontendType GetType() override 119 { 120 return type_; 121 } 122 123 // judge frontend is foreground frontend. IsForeground()124 bool IsForeground() override 125 { 126 return foregroundFrontend_; 127 } 128 129 RefPtr<AccessibilityManager> GetAccessibilityManager() const override; 130 WindowConfig& GetWindowConfig() override; 131 132 // navigator component call router 133 void NavigatePage(uint8_t type, const PageTarget& target, const std::string& params) override; 134 135 void OnWindowDisplayModeChanged(bool isShownInMultiWindow, const std::string& data); 136 SetJsEngine(const RefPtr<Framework::JsEngine> & jsEngine)137 void SetJsEngine(const RefPtr<Framework::JsEngine>& jsEngine) 138 { 139 jsEngine_ = jsEngine; 140 } 141 SetNeedDebugBreakPoint(bool value)142 void SetNeedDebugBreakPoint(bool value) 143 { 144 if (jsEngine_) { 145 jsEngine_->SetNeedDebugBreakPoint(value); 146 } 147 } 148 SetDebugVersion(bool value)149 void SetDebugVersion(bool value) 150 { 151 if (jsEngine_) { 152 jsEngine_->SetDebugVersion(value); 153 } 154 } 155 SetInstanceName(const std::string & name)156 void SetInstanceName(const std::string& name) 157 { 158 if (jsEngine_) { 159 jsEngine_->SetInstanceName(name); 160 } 161 } 162 MarkIsSubWindow(bool isSubWindow)163 void MarkIsSubWindow(bool isSubWindow) 164 { 165 isSubWindow_ = isSubWindow; 166 } 167 168 void RebuildAllPages() override; 169 SetDensity(double density)170 void SetDensity(double density) 171 { 172 density_ = density; 173 } 174 ResetPageLoadState()175 void ResetPageLoadState() 176 { 177 pageLoaded_ = false; 178 } 179 180 private: 181 void InitializeFrontendDelegate(const RefPtr<TaskExecutor>& taskExecutor); 182 183 FrontendType type_ = FrontendType::DECLARATIVE_JS; 184 RefPtr<Framework::PluginFrontendDelegate> delegate_; 185 RefPtr<AceEventHandler> handler_; 186 RefPtr<Framework::JsEngine> jsEngine_; 187 RefPtr<AccessibilityManager> accessibilityManager_; 188 bool foregroundFrontend_ = false; 189 bool isSubWindow_ = false; 190 bool pageLoaded_ = false; 191 double density_ = 1.0; 192 }; 193 194 class PluginEventHandler : public AceEventHandler { 195 public: PluginEventHandler(const RefPtr<Framework::PluginFrontendDelegate> & delegate)196 explicit PluginEventHandler(const RefPtr<Framework::PluginFrontendDelegate>& delegate) 197 : delegate_(delegate) 198 { 199 ACE_DCHECK(delegate_); 200 } PluginEventHandler()201 PluginEventHandler() {} 202 203 ~PluginEventHandler() override = default; 204 205 void HandleAsyncEvent(const EventMarker& eventMarker) override; 206 207 void HandleAsyncEvent(const EventMarker& eventMarker, int32_t param) override; 208 209 void HandleAsyncEvent(const EventMarker& eventMarker, const BaseEventInfo& info) override; 210 211 void HandleAsyncEvent(const EventMarker& eventMarker, const std::shared_ptr<BaseEventInfo>& info) override; 212 213 void HandleAsyncEvent(const EventMarker& eventMarker, const KeyEvent& info) override; 214 215 void HandleAsyncEvent(const EventMarker& eventMarker, const std::string& param) override; 216 217 void HandleSyncEvent(const EventMarker& eventMarker, bool& result) override; 218 219 void HandleSyncEvent(const EventMarker& eventMarker, const BaseEventInfo& info, bool& result) override; 220 221 void HandleSyncEvent(const EventMarker& eventMarker, const KeyEvent& info, bool& result) override; 222 223 void HandleSyncEvent(const EventMarker& eventMarker, const std::string& param, std::string& result) override; 224 225 void HandleSyncEvent(const EventMarker& eventMarker, const std::shared_ptr<BaseEventInfo>& info) override; 226 227 void HandleSyncEvent(const EventMarker& eventMarker, const std::string& componentId, const int32_t nodeId) override; 228 229 private: 230 RefPtr<Framework::PluginFrontendDelegate> delegate_; 231 }; 232 } // namespace OHOS::Ace 233 #endif // FOUNDATION_ACE_FRAMEWORKS_BRIDGE_PLUGIN_FRONTEND_PLUGIN_FRONTEND_H 234