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<PipelineContext>& 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 return delegate_->GetPage(pageId); 68 }; 69 GetCurrentReadyPage()70 WeakPtr<AcePage> GetCurrentReadyPage() const 71 { 72 return delegate_->GetCurrentReadyPage(); 73 } 74 75 void TriggerGarbageCollection() override; 76 77 void SendCallbackMessage(const std::string& callbackId, const std::string& data) const override; 78 // platform channel. 79 void SetJsMessageDispatcher(const RefPtr<JsMessageDispatcher>& dispatcher) const override; 80 void TransferComponentResponseData(int32_t callbackId, int32_t code, 81 std::vector<uint8_t>&& data) const override; 82 void TransferJsResponseData(int32_t callbackId, int32_t code, std::vector<uint8_t>&& data) const override; 83 #if defined(WINDOWS_PLATFORM) || defined(MAC_PLATFORM) RunNativeEngineLoop()84 void RunNativeEngineLoop() override 85 { 86 if (jsEngine_) { 87 jsEngine_->RunNativeEngineLoop(); 88 } 89 } 90 void TransferJsResponseDataPreview(int32_t callbackId, int32_t code, ResponseData responseData) const; 91 #endif 92 void TransferJsPluginGetError(int32_t callbackId, int32_t errorCode, std::string&& errorMessage) const override; 93 void TransferJsEventData(int32_t callbackId, int32_t code, std::vector<uint8_t>&& data) const override; 94 void LoadPluginJsCode(std::string&& jsCode) const override; 95 void LoadPluginJsByteCode(std::vector<uint8_t>&& jsCode, std::vector<int32_t>&& jsCodeLen) const override; 96 97 // application lifecycle. 98 void UpdateState(Frontend::State state) override; 99 100 // page lifecycle. 101 bool OnBackPressed() override; OnSaveAbilityState(std::string & data)102 void OnSaveAbilityState(std::string& data) override {} OnRestoreAbilityState(const std::string & data)103 void OnRestoreAbilityState(const std::string& data) override {} 104 void OnShow() override; 105 void OnHide() override; 106 void OnConfigurationUpdated(const std::string& data) override; 107 void OnActive() override; 108 void OnInactive() override; 109 bool OnStartContinuation() override; 110 void OnCompleteContinuation(int32_t code) override; 111 void OnRemoteTerminated() override; 112 void OnSaveData(std::string& data) override; 113 bool OnRestoreData(const std::string& data) override; 114 OnMemoryLevel(const int32_t level)115 void OnMemoryLevel(const int32_t level) override {} 116 void OnNewRequest(const std::string& data) override; OnNewWant(const std::string & data)117 void OnNewWant(const std::string& data) override {} 118 void CallRouterBack() override; 119 void SetColorMode(ColorMode colorMode) override; 120 121 void OnSurfaceChanged(int32_t width, int32_t height) override; 122 123 void DumpFrontend() const override; 124 GetEventHandler()125 RefPtr<AceEventHandler> GetEventHandler() override 126 { 127 return handler_; 128 }; 129 GetType()130 FrontendType GetType() override 131 { 132 return type_; 133 } 134 135 // judge frontend is foreground frontend. IsForeground()136 bool IsForeground() override 137 { 138 return foregroundFrontend_; 139 } 140 141 RefPtr<AccessibilityManager> GetAccessibilityManager() const override; 142 WindowConfig& GetWindowConfig() override; 143 SetJsEngine(const RefPtr<Framework::JsEngine> & jsEngine)144 void SetJsEngine(const RefPtr<Framework::JsEngine>& jsEngine) 145 { 146 jsEngine_ = jsEngine; 147 } 148 SetNeedDebugBreakPoint(bool value)149 void SetNeedDebugBreakPoint(bool value) 150 { 151 if (jsEngine_) { 152 jsEngine_->SetNeedDebugBreakPoint(value); 153 } 154 } 155 SetDebugVersion(bool value)156 void SetDebugVersion(bool value) 157 { 158 if (jsEngine_) { 159 jsEngine_->SetDebugVersion(value); 160 } 161 } 162 SetInstanceName(const std::string & name)163 void SetInstanceName(const std::string& name) 164 { 165 if (jsEngine_) { 166 jsEngine_->SetInstanceName(name); 167 } 168 } 169 170 void RebuildAllPages() override; 171 172 void GetPluginsUsed(std::string& data) override; 173 174 private: 175 void InitializeFrontendDelegate(const RefPtr<TaskExecutor>& taskExecutor); 176 177 FrontendType type_ = FrontendType::JS; 178 RefPtr<Framework::FrontendDelegateImpl> delegate_; 179 RefPtr<AceEventHandler> handler_; 180 RefPtr<Framework::JsEngine> jsEngine_; 181 bool foregroundFrontend_ = false; 182 }; 183 184 class JsEventHandler : public AceEventHandler { 185 public: JsEventHandler(const RefPtr<Framework::FrontendDelegateImpl> & delegate)186 explicit JsEventHandler(const RefPtr<Framework::FrontendDelegateImpl>& delegate) : delegate_(delegate) 187 { 188 ACE_DCHECK(delegate_); 189 } 190 191 ~JsEventHandler() override = default; 192 193 void HandleAsyncEvent(const EventMarker& eventMarker) override; 194 195 void HandleAsyncEvent(const EventMarker& eventMarker, int32_t param) override; 196 197 void HandleAsyncEvent(const EventMarker& eventMarker, const BaseEventInfo& info) override; 198 199 void HandleAsyncEvent(const EventMarker& eventMarker, const KeyEvent& info) override; 200 201 void HandleAsyncEvent(const EventMarker& eventMarker, const GestureEvent& info) override; 202 203 void HandleAsyncEvent(const EventMarker& eventMarker, const RotationEvent& info) override; 204 205 void HandleAsyncEvent(const EventMarker& eventMarker, const std::string& param) override; 206 207 void HandleSyncEvent(const EventMarker& eventMarker, bool& result) override; 208 209 void HandleSyncEvent(const EventMarker& eventMarker, const BaseEventInfo& info, bool& result) override; 210 211 void HandleSyncEvent(const EventMarker& eventMarker, const KeyEvent& info, bool& result) override; 212 213 void HandleSyncEvent(const EventMarker& eventMarker, const std::string& param, std::string& result) override; 214 215 void HandleSyncEvent(const EventMarker& eventMarker, const std::string& componentId, const int32_t nodeId) override; 216 217 private: 218 RefPtr<Framework::FrontendDelegateImpl> delegate_; 219 }; 220 221 } // namespace OHOS::Ace 222 223 #endif // FOUNDATION_ACE_FRAMEWORKS_BRIDGE_JS_FRONTEND_JS_FRONTEND_H 224