1 /*
2 * Copyright (c) 2023-2025 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_CORE_INTERFACES_NATIVE_NODE_NODE_MODEL_H
17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_INTERFACES_NATIVE_NODE_NODE_MODEL_H
18
19 #include <cstdint>
20 #include <set>
21 #include <vector>
22 #include <string>
23
24 #include "native_compatible.h"
25 #include "native_node.h"
26 #include "native_type.h"
27
28 #include "frameworks/core/interfaces/arkoala/arkoala_api.h"
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33
34 struct ArkUI_Node {
35 int32_t type;
36 ArkUINodeHandle uiNodeHandle = nullptr;
37 bool cNode = false;
38 bool buildNode = false;
39 void* extraData = nullptr;
40 void* extraCustomData = nullptr;
41 ArkUI_LengthMetricUnit lengthMetricUnit = ARKUI_LENGTH_METRIC_UNIT_DEFAULT;
42 void* eventListeners = nullptr;
43 void* barrierOption = nullptr;
44 void* guidelineOption = nullptr;
45 void* alignRuleOption = nullptr;
46 void* userData = nullptr;
47 void* swiperIndicator = nullptr;
48 int32_t linearGradientDirection = -1;
49 void* customEventListeners = nullptr;
50 void* altDrawableDescriptor = nullptr;
51 void* drawableDescriptor = nullptr;
52 void* imageFrameInfos = nullptr;
53 ArkUI_AttributeItem* areaChangeRadio = nullptr;
54 void* transitionOption = nullptr;
55 void* progressLinearStyle = nullptr;
56 };
57
58 struct ArkUI_Context {
59 int32_t id;
60 };
61
62 constexpr int BASIC_COMPONENT_NUM = 22;
63 struct ArkUI_GuidelineStyle {
64 std::string id;
65 ArkUI_Axis direction;
66 float start;
67 bool hasStart;
68 float end;
69 bool hasEnd;
70 };
71
72 struct ArkUI_GuidelineOption {
73 std::vector<ArkUI_GuidelineStyle> styles;
74 };
75
76 struct ArkUI_BarrierStyle {
77 std::string id;
78 ArkUI_BarrierDirection direction;
79 std::vector<std::string> referencedId;
80 };
81
82 struct ArkUI_BarrierOption {
83 std::vector<ArkUI_BarrierStyle> styles;
84 };
85
86 struct ArkUI_HorizontalAlignRule {
87 bool hasValue;
88 std::string anchor;
89 ArkUI_HorizontalAlignment align;
90 };
91
92 struct ArkUI_VerticalAlignRule {
93 bool hasValue;
94 std::string anchor;
95 ArkUI_VerticalAlignment align;
96 };
97
98 struct ArkUI_AlignmentRuleOption {
99 ArkUI_HorizontalAlignRule left;
100 ArkUI_HorizontalAlignRule middle;
101 ArkUI_HorizontalAlignRule right;
102 ArkUI_VerticalAlignRule top;
103 ArkUI_VerticalAlignRule center;
104 ArkUI_VerticalAlignRule bottom;
105 float biasHorizontal;
106 float biasVertical;
107 };
108 #ifdef __cplusplus
109 };
110 #endif
111
112 struct ArkUIFullNodeAPI;
113
114 namespace OHOS::Ace::NodeModel {
115
UsePXUnit(ArkUI_NodeHandle nodePtr)116 inline bool UsePXUnit(ArkUI_NodeHandle nodePtr)
117 {
118 return nodePtr && (nodePtr->lengthMetricUnit == ARKUI_LENGTH_METRIC_UNIT_PX);
119 }
120
121 bool InitialFullImpl();
122 ArkUIFullNodeAPI* GetFullImpl();
123 ArkUI_NodeHandle CreateNode(ArkUI_NodeType type);
124 void DisposeNode(ArkUI_NodeHandle nativePtr);
125 bool IsValidArkUINode(ArkUI_NodeHandle nodePtr);
126
127 int32_t AddChild(ArkUI_NodeHandle parentNode, ArkUI_NodeHandle childNode);
128 int32_t RemoveChild(ArkUI_NodeHandle parentNode, ArkUI_NodeHandle childNode);
129 int32_t InsertChildAfter(ArkUI_NodeHandle parentNode, ArkUI_NodeHandle childNode, ArkUI_NodeHandle siblingNode);
130 int32_t InsertChildBefore(ArkUI_NodeHandle parentNode, ArkUI_NodeHandle childNode, ArkUI_NodeHandle siblingNode);
131 int32_t InsertChildAt(ArkUI_NodeHandle parentNode, ArkUI_NodeHandle childNode, int32_t position);
132
133 // deprecated.
134 [[deprecated]] void SetAttribute(ArkUI_NodeHandle node, ArkUI_NodeAttributeType attribute, const char* value);
135
136 int32_t SetAttribute(ArkUI_NodeHandle node, ArkUI_NodeAttributeType attribute, const ArkUI_AttributeItem* value);
137 const ArkUI_AttributeItem* GetAttribute(ArkUI_NodeHandle node, ArkUI_NodeAttributeType attribute);
138 int32_t ResetAttribute(ArkUI_NodeHandle node, ArkUI_NodeAttributeType attribute);
139
140 int32_t RegisterNodeEvent(ArkUI_NodeHandle nodePtr, ArkUI_NodeEventType eventType, int32_t targetId);
141 int32_t RegisterNodeEvent(ArkUI_NodeHandle nodePtr, ArkUI_NodeEventType eventType, int32_t targetId, void* userData);
142 void UnregisterNodeEvent(ArkUI_NodeHandle nodePtr, ArkUI_NodeEventType eventType);
143 void RegisterOnEvent(void (*eventReceiver)(ArkUI_NodeEvent* event));
144 void RegisterOnEvent(void (*eventReceiver)(ArkUI_CompatibleNodeEvent* event));
145 void UnregisterOnEvent();
146 void HandleTouchEvent(ArkUI_UIInputEvent& uiEvent, ArkUINodeEvent* innerEvent);
147 void HandleMouseEvent(ArkUI_UIInputEvent& uiEvent, ArkUINodeEvent* innerEvent);
148 void HandleKeyEvent(ArkUI_UIInputEvent& uiEvent, ArkUINodeEvent* innerEvent);
149 void HandleFocusAxisEvent(ArkUI_UIInputEvent& uiEvent, ArkUINodeEvent* innerEvent);
150 int32_t CheckEvent(ArkUI_NodeEvent* event);
151 void HandleInnerNodeEvent(ArkUINodeEvent* innerEvent);
152 int32_t GetNativeNodeEventType(ArkUINodeEvent* innerEvent);
153 void HandleNodeEvent(ArkUI_NodeEvent* event);
154 void TriggerNodeEvent(ArkUI_NodeEvent* event, std::set<void (*)(ArkUI_NodeEvent*)>* eventListenersSet);
155 void ApplyModifierFinish(ArkUI_NodeHandle nodePtr);
156 void MarkDirty(ArkUI_NodeHandle nodePtr, ArkUI_NodeDirtyFlag dirtyFlag);
157
158 int32_t SetUserData(ArkUI_NodeHandle node, void* userData);
159 void* GetUserData(ArkUI_NodeHandle node);
160 int32_t SetLengthMetricUnit(ArkUI_NodeHandle nodePtr, ArkUI_LengthMetricUnit unit);
161 int32_t AddNodeEventReceiver(ArkUI_NodeHandle node, void (*eventReceiver)(ArkUI_NodeEvent* event));
162 int32_t RemoveNodeEventReceiver(ArkUI_NodeHandle node, void (*eventReceiver)(ArkUI_NodeEvent* event));
163 void* GetParseJsMedia();
164 bool CheckIsCNode(ArkUI_NodeHandle node);
165 bool CheckIsCNodeOrCrossLanguage(ArkUI_NodeHandle node);
166 ArkUI_NodeHandle GetArkUINode(ArkUINodeHandle node);
167 int32_t GetNodeTypeByTag(ArkUI_NodeHandle node);
168 }; // namespace OHOS::Ace::NodeModel
169 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_INTERFACES_NATIVE_NODE_NODE_MODEL_H
170