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