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