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