• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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     void SearchElementInfoByAccessibilityId(
52         const int64_t elementId, const int32_t requestId,
53         Accessibility::AccessibilityElementOperatorCallback& callback,
54         const int32_t mode) override;
55     void SearchElementInfosByText(
56         const int64_t elementId, const std::string& text, const int32_t requestId,
57         Accessibility::AccessibilityElementOperatorCallback& callback) override;
58     void FindFocusedElementInfo(
59         const int64_t elementId, const int32_t focusType, const int32_t requestId,
60         Accessibility::AccessibilityElementOperatorCallback& callback) override;
61     void FocusMoveSearch(
62         const int64_t elementId, const int32_t direction, const int32_t requestId,
63         Accessibility::AccessibilityElementOperatorCallback& callback) override;
64     void ExecuteAction(const int64_t elementId, const int32_t action,
65         const std::map<std::string, std::string>& actionArguments, const int32_t requestId,
66         Accessibility::AccessibilityElementOperatorCallback& callback) override;
67     void ClearFocus() override;
68     void OutsideTouch() override;
69     void GetCursorPosition(const int64_t elementId, const int32_t requestId,
70         Accessibility::AccessibilityElementOperatorCallback &callback) override;
71     void SetChildTreeIdAndWinId(
72         const int64_t nodeId, const int32_t treeId, const int32_t childWindowId) override;
73     void SetBelongTreeId(const int32_t treeId) override;
74     int32_t SendAccessibilityAsyncEvent(
75         const ArkUI_AccessibilityEventInfo& nativeAccessibilityEvent,
76         void (*callback)(int32_t errorCode)) override;
77     int32_t SendAccessibilityAsyncEventForThird(
78         int64_t thirdElementId,
79         Accessibility::EventType eventType);
80     bool FindAccessibilityNodeInfosByIdFromProvider(
81         const int64_t splitElementId, const int32_t mode, const int32_t requestId,
82         std::list<Accessibility::AccessibilityElementInfo>& infos, bool ignoreHostOffset = false);
GetHandler()83     const WeakPtr<JsAccessibilityManager>& GetHandler() const
84     {
85         return jsAccessibilityManager_;
86     }
87 
GetHost()88     const RefPtr<NG::FrameNode> GetHost() const
89     {
90         return host_.Upgrade();
91     }
92 
93 private:
94     void GetHostRectTranslateInfo(NodeConfig& config);
95     void GetNodeConfig(NodeConfig& nodeConfig);
96     void SetSearchElementInfoByAccessibilityIdResult(
97         AccessibilityElementOperatorCallback& callback,
98         std::list<AccessibilityElementInfo>&& infos,
99         const int32_t requestId);
100     void SetSearchElementInfoByTextResult(
101         AccessibilityElementOperatorCallback& callback,
102         std::list<AccessibilityElementInfo>&& infos,
103         const int32_t requestId);
104     void SetFindFocusedElementInfoResult(
105         AccessibilityElementOperatorCallback& callback,
106         AccessibilityElementInfo& info,
107         const int32_t requestId);
108     void SetFocusMoveSearchResult(
109         AccessibilityElementOperatorCallback& callback,
110         AccessibilityElementInfo& info,
111         const int32_t requestId);
112     void SetExecuteActionResult(
113         AccessibilityElementOperatorCallback& callback,
114         const bool succeeded, const int32_t requestId);
115     bool FindAccessibilityNodeInfosByTextFromProvider(
116         const int64_t splitElementId, const std::string& text, const int32_t requestId,
117         std::list<Accessibility::AccessibilityElementInfo>& infos);
118     bool ExecuteActionForThird(
119         int64_t elementId, const AccessibilityElementInfo& nodeInfo, const int32_t action);
120     void GetAccessibilityEventInfoFromNativeEvent(
121         const ArkUI_AccessibilityEventInfo& nativeEventInfo,
122         OHOS::Accessibility::AccessibilityEventInfo& accessibilityEventInfo,
123         bool ignoreHostOffset);
124     void GetAccessibilityEventInfoFromNativeEvent(
125         OHOS::Accessibility::AccessibilityEventInfo& accessibilityEventInfo,
126         bool ignoreHostOffset);
127     bool SendAccessibilitySyncEventToService(
128         const OHOS::Accessibility::AccessibilityEventInfo& eventInfo,
129         void (*callback)(int32_t errorCode));
130     bool FindFocusedElementInfoFromProvider(
131         int64_t elementId, const int32_t focusType, const int32_t requestId,
132         Accessibility::AccessibilityElementInfo& info);
133     bool ExecuteActionFromProvider(
134         int64_t elementId, const int32_t action,
135         const std::map<std::string, std::string>& actionArguments, const int32_t requestId);
136     bool FocusMoveSearchProvider(
137         int64_t elementId, const int32_t direction, const int32_t requestId,
138         Accessibility::AccessibilityElementInfo& info);
139     bool ClearFocusFromProvider();
140     bool ClearDrawBound();
141 
142     bool HandleNativeFocusUpdate(
143         int64_t elementId,
144         Accessibility::AccessibilityEventInfo& accessibilityEventInfo);
145     bool HandleEventByFramework(
146         const ArkUI_AccessibilityEventInfo& nativeAccessibilityEvent,
147         Accessibility::AccessibilityEventInfo& accessibilityEventInfo);
148     void HandleActionWhenFindNodeFail(const int32_t action);
149 
150     WeakPtr<AccessibilityProvider> accessibilityProvider_;
151     WeakPtr<JsAccessibilityManager> jsAccessibilityManager_;
152     WeakPtr<NG::FrameNode> host_;
153     int32_t belongTreeId_ = AccessibilityElementInfo::UNDEFINED_TREE_ID;
154 };
155 } // namespace OHOS::Ace::Framework
156 
157 #endif // FOUNDATION_ACE_FRAMEWORKS_BRIDGE_COMMON_ACCESSIBILITY_JS_THIRD_PROVIDER_INTERATION_OPERATION_H
158