1 /* 2 * Copyright (c) 2024 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_COMMON_ACCESSIBILITY_JS_THIRD_PROVIDER_INTERATION_OPERATION_H 17 #define FOUNDATION_ACE_FRAMEWORKS_BRIDGE_COMMON_ACCESSIBILITY_JS_THIRD_PROVIDER_INTERATION_OPERATION_H 18 19 20 #include "core/accessibility/accessibility_provider.h" 21 #include "core/accessibility/third_accessibility_manager.h" 22 #include "js_accessibility_manager.h" 23 24 25 namespace OHOS::Ace::Framework { 26 struct NodeConfig { 27 OHOS::Ace::NG::OffsetF offset; 28 int32_t pageId = -1; 29 int32_t windowId = -1; 30 int32_t belongTreeId = AccessibilityElementInfo::UNDEFINED_TREE_ID; 31 int32_t childTreeId = AccessibilityElementInfo::UNDEFINED_TREE_ID; 32 int32_t childWindowId = AccessibilityElementInfo::UNDEFINED_WINID_ID; 33 int32_t parentWindowId = AccessibilityElementInfo::UNDEFINED_WINID_ID; 34 std::string bundleName; 35 std::string inspectorKey; 36 float scaleX = 1.0f; 37 float scaleY = 1.0f; 38 bool ignoreHostOffset = false; 39 }; 40 41 class JsThirdProviderInteractionOperation : public Accessibility::AccessibilityElementOperator, 42 public ThirdAccessibilityManager { 43 public: 44 JsThirdProviderInteractionOperation( 45 const WeakPtr<AccessibilityProvider>& accessibilityProvider, 46 const WeakPtr<JsAccessibilityManager>& jsAccessibilityManager, 47 WeakPtr<NG::FrameNode> host); 48 ~JsThirdProviderInteractionOperation() override; 49 void Initialize(); 50 // Accessibility override. 51 RetError SearchElementInfoByAccessibilityId( 52 const int64_t elementId, const int32_t requestId, 53 Accessibility::AccessibilityElementOperatorCallback& callback, 54 const int32_t mode) override; 55 void SearchElementInfoBySpecificProperty(const int64_t elementId, const SpecificPropertyParam ¶m, 56 const int32_t requestId, AccessibilityElementOperatorCallback &callback) override; 57 void SearchElementInfosByText( 58 const int64_t elementId, const std::string& text, const int32_t requestId, 59 Accessibility::AccessibilityElementOperatorCallback& callback) override; 60 void SearchDefaultFocusByWindowId(const int32_t windowId, const int32_t requestId, 61 AccessibilityElementOperatorCallback& callback, const int32_t pageId) override; 62 void FindFocusedElementInfo( 63 const int64_t elementId, const int32_t focusType, const int32_t requestId, 64 Accessibility::AccessibilityElementOperatorCallback& callback) override; 65 void FocusMoveSearch( 66 const int64_t elementId, const int32_t direction, const int32_t requestId, 67 Accessibility::AccessibilityElementOperatorCallback& callback) override; 68 void ExecuteAction(const int64_t elementId, const int32_t action, 69 const std::map<std::string, std::string>& actionArguments, const int32_t requestId, 70 Accessibility::AccessibilityElementOperatorCallback& callback) override; 71 void ClearFocus() override; 72 void OutsideTouch() override; 73 void GetCursorPosition(const int64_t elementId, const int32_t requestId, 74 Accessibility::AccessibilityElementOperatorCallback &callback) override; 75 void SetChildTreeIdAndWinId( 76 const int64_t nodeId, const int32_t treeId, const int32_t childWindowId) override; 77 void SetBelongTreeId(const int32_t treeId) override; 78 int32_t SendAccessibilityAsyncEvent( 79 const ArkUI_AccessibilityEventInfo& nativeAccessibilityEvent, 80 void (*callback)(int32_t errorCode)) override; 81 int32_t SendAccessibilityAsyncEventForThird( 82 int64_t thirdElementId, 83 Accessibility::EventType eventType); 84 bool FindAccessibilityNodeInfosByIdFromProvider( 85 const int64_t splitElementId, const int32_t mode, const int32_t requestId, 86 std::list<Accessibility::AccessibilityElementInfo>& infos, bool ignoreHostOffset = false); GetHandler()87 const WeakPtr<JsAccessibilityManager>& GetHandler() const 88 { 89 return jsAccessibilityManager_; 90 } 91 GetHost()92 const RefPtr<NG::FrameNode> GetHost() const 93 { 94 return host_.Upgrade(); 95 } 96 GetBelongTreeId()97 int32_t GetBelongTreeId() const 98 { 99 return belongTreeId_; 100 } 101 102 private: 103 void GetHostRectTranslateInfo(NodeConfig& config); 104 void GetNodeConfig(NodeConfig& nodeConfig); 105 void SetSearchElementInfoByAccessibilityIdResult( 106 AccessibilityElementOperatorCallback& callback, 107 std::list<AccessibilityElementInfo>&& infos, 108 const int32_t requestId); 109 void SetSearchElementInfoByTextResult( 110 AccessibilityElementOperatorCallback& callback, 111 std::list<AccessibilityElementInfo>&& infos, 112 const int32_t requestId); 113 void SetFindFocusedElementInfoResult( 114 AccessibilityElementOperatorCallback& callback, 115 AccessibilityElementInfo& info, 116 const int32_t requestId); 117 void SetFocusMoveSearchResult( 118 AccessibilityElementOperatorCallback& callback, 119 AccessibilityElementInfo& info, 120 const int32_t requestId); 121 void SetExecuteActionResult( 122 AccessibilityElementOperatorCallback& callback, 123 const bool succeeded, const int32_t requestId); 124 bool FindAccessibilityNodeInfosByTextFromProvider( 125 const int64_t splitElementId, const std::string& text, const int32_t requestId, 126 std::list<Accessibility::AccessibilityElementInfo>& infos); 127 bool ExecuteActionForThird( 128 int64_t elementId, const AccessibilityElementInfo& nodeInfo, const int32_t action); 129 void GetAccessibilityEventInfoFromNativeEvent( 130 const ArkUI_AccessibilityEventInfo& nativeEventInfo, 131 OHOS::Accessibility::AccessibilityEventInfo& accessibilityEventInfo, 132 bool ignoreHostOffset); 133 void GetAccessibilityEventInfoFromNativeEvent( 134 OHOS::Accessibility::AccessibilityEventInfo& accessibilityEventInfo, 135 bool ignoreHostOffset); 136 bool SendAccessibilitySyncEventToService( 137 const OHOS::Accessibility::AccessibilityEventInfo& eventInfo, 138 void (*callback)(int32_t errorCode)); 139 bool FindFocusedElementInfoFromProvider( 140 int64_t elementId, const int32_t focusType, const int32_t requestId, 141 Accessibility::AccessibilityElementInfo& info); 142 bool ExecuteActionFromProvider( 143 int64_t elementId, const int32_t action, 144 const std::map<std::string, std::string>& actionArguments, const int32_t requestId); 145 bool FocusMoveSearchProvider( 146 int64_t elementId, const int32_t direction, const int32_t requestId, 147 Accessibility::AccessibilityElementInfo& info); 148 bool ClearFocusFromProvider(); 149 bool ClearDrawBound(); 150 151 bool HandleNativeFocusUpdate( 152 int64_t elementId, 153 Accessibility::AccessibilityEventInfo& accessibilityEventInfo); 154 bool HandleEventByFramework( 155 const ArkUI_AccessibilityEventInfo& nativeAccessibilityEvent, 156 Accessibility::AccessibilityEventInfo& accessibilityEventInfo); 157 void HandleActionWhenFindNodeFail(const int32_t action); 158 159 WeakPtr<AccessibilityProvider> accessibilityProvider_; 160 WeakPtr<JsAccessibilityManager> jsAccessibilityManager_; 161 WeakPtr<NG::FrameNode> host_; 162 int32_t belongTreeId_ = AccessibilityElementInfo::UNDEFINED_TREE_ID; 163 }; 164 } // namespace OHOS::Ace::Framework 165 166 #endif // FOUNDATION_ACE_FRAMEWORKS_BRIDGE_COMMON_ACCESSIBILITY_JS_THIRD_PROVIDER_INTERATION_OPERATION_H 167