1 /*
2  * Copyright (c) 2021-2023 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 OHOS_JS_WINDOW_H
17 #define OHOS_JS_WINDOW_H
18 
19 #include "js_runtime_utils.h"
20 
21 #ifndef WINDOW_PREVIEW
22 #include "js_window_register_manager.h"
23 #else
24 #include "mock/js_window_register_manager.h"
25 #endif
26 
27 #include "js_window_utils.h"
28 #include "native_engine/native_engine.h"
29 #include "native_engine/native_value.h"
30 #include "window.h"
31 
32 namespace OHOS {
33 namespace Rosen {
34 napi_value CreateJsWindowObject(napi_env env, sptr<Window>& window);
35 napi_value CreateJsWindowArrayObject(napi_env env, const std::vector<sptr<Window>>& windows);
36 std::shared_ptr<NativeReference> FindJsWindowObject(const std::string& windowName);
37 void BindFunctions(napi_env env, napi_value object, const char* moduleName);
38 napi_value NapiGetUndefined(napi_env env);
39 napi_valuetype GetType(napi_env env, napi_value value);
40 bool NapiIsCallable(napi_env env, napi_value value);
41 napi_value NapiThrowError(napi_env env, WmErrorCode errCode);
42 class JsWindow final {
43 public:
44     explicit JsWindow(const sptr<Window>& window);
45     ~JsWindow();
46     static void Finalizer(napi_env env, void* data, void* hint);
47     static napi_value Show(napi_env env, napi_callback_info info);
48     static napi_value ShowWindow(napi_env env, napi_callback_info info);
49     static napi_value ShowWithAnimation(napi_env env, napi_callback_info info);
50     static napi_value Destroy(napi_env env, napi_callback_info info);
51     static napi_value DestroyWindow(napi_env env, napi_callback_info info);
52     static napi_value Hide(napi_env env, napi_callback_info info);
53     static napi_value HideWithAnimation(napi_env env, napi_callback_info info);
54     static napi_value Recover(napi_env env, napi_callback_info info);
55     static napi_value Restore(napi_env env, napi_callback_info info);
56     static napi_value MoveTo(napi_env env, napi_callback_info info);
57     static napi_value MoveWindowTo(napi_env env, napi_callback_info info);
58     static napi_value MoveWindowToAsync(napi_env env, napi_callback_info info);
59     static napi_value MoveWindowToGlobal(napi_env env, napi_callback_info info);
60     static napi_value GetGlobalScaledRect(napi_env env, napi_callback_info info);
61     static napi_value Resize(napi_env env, napi_callback_info info);
62     static napi_value ResizeWindow(napi_env env, napi_callback_info info);
63     static napi_value ResizeWindowAsync(napi_env env, napi_callback_info info);
64     static napi_value SetWindowType(napi_env env, napi_callback_info info);
65     static napi_value SetWindowMode(napi_env env, napi_callback_info info);
66     static napi_value GetProperties(napi_env env, napi_callback_info info);
67     static napi_value GetWindowPropertiesSync(napi_env env, napi_callback_info info);
68     static napi_value RegisterWindowCallback(napi_env env, napi_callback_info info);
69     static napi_value UnregisterWindowCallback(napi_env env, napi_callback_info info);
70     static napi_value BindDialogTarget(napi_env env, napi_callback_info info);
71     static napi_value SetDialogBackGestureEnabled(napi_env env, napi_callback_info info);
72     static napi_value LoadContent(napi_env env, napi_callback_info info);
73     static napi_value LoadContentByName(napi_env env, napi_callback_info info);
74     static napi_value GetUIContext(napi_env env, napi_callback_info info);
75     static napi_value SetUIContent(napi_env env, napi_callback_info info);
76     static napi_value SetFullScreen(napi_env env, napi_callback_info info);
77     static napi_value SetLayoutFullScreen(napi_env env, napi_callback_info info);
78     static napi_value SetTitleAndDockHoverShown(napi_env env, napi_callback_info info);
79     static napi_value SetWindowLayoutFullScreen(napi_env env, napi_callback_info info);
80     static napi_value SetSystemBarEnable(napi_env env, napi_callback_info info);
81     static napi_value SetWindowSystemBarEnable(napi_env env, napi_callback_info info);
82     static napi_value SetSystemBarProperties(napi_env env, napi_callback_info info);
83     static napi_value GetWindowSystemBarPropertiesSync(napi_env env, napi_callback_info info);
84     static napi_value SetWindowSystemBarProperties(napi_env env, napi_callback_info info);
85     static napi_value GetAvoidArea(napi_env env, napi_callback_info info);
86     static napi_value GetWindowAvoidAreaSync(napi_env env, napi_callback_info info);
87     static napi_value IsShowing(napi_env env, napi_callback_info info);
88     static napi_value IsWindowShowingSync(napi_env env, napi_callback_info info);
89     static napi_value SetBackgroundColor(napi_env env, napi_callback_info info);
90     static napi_value SetWindowBackgroundColorSync(napi_env env, napi_callback_info info);
91     static napi_value SetBrightness(napi_env env, napi_callback_info info);
92     static napi_value SetWindowBrightness(napi_env env, napi_callback_info info);
93     static napi_value SetDimBehind(napi_env env, napi_callback_info info);
94     static napi_value SetFocusable(napi_env env, napi_callback_info info);
95     static napi_value SetWindowFocusable(napi_env env, napi_callback_info info);
96     static napi_value SetTopmost(napi_env env, napi_callback_info info);
97     static napi_value SetWindowTopmost(napi_env env, napi_callback_info info);
98     static napi_value SetKeepScreenOn(napi_env env, napi_callback_info info);
99     static napi_value SetWindowKeepScreenOn(napi_env env, napi_callback_info info);
100     static napi_value SetWakeUpScreen(napi_env env, napi_callback_info info);
101     static napi_value SetOutsideTouchable(napi_env env, napi_callback_info info);
102     static napi_value SetPrivacyMode(napi_env env, napi_callback_info info);
103     static napi_value SetWindowPrivacyMode(napi_env env, napi_callback_info info);
104     static napi_value SetTouchable(napi_env env, napi_callback_info info);
105     static napi_value SetTouchableAreas(napi_env env, napi_callback_info info);
106     static napi_value SetResizeByDragEnabled(napi_env env, napi_callback_info info);
107     static napi_value SetRaiseByClickEnabled(napi_env env, napi_callback_info info);
108     static napi_value HideNonSystemFloatingWindows(napi_env env, napi_callback_info info);
109     static napi_value SetWindowTouchable(napi_env env, napi_callback_info info);
110     static napi_value SetTransparent(napi_env env, napi_callback_info info);
111     static napi_value SetCallingWindow(napi_env env, napi_callback_info info);
112     static napi_value SetPreferredOrientation(napi_env env, napi_callback_info info);
113     static napi_value GetPreferredOrientation(napi_env env, napi_callback_info info);
114     static napi_value DisableWindowDecor(napi_env env, napi_callback_info info);
115     static napi_value SetSnapshotSkip(napi_env env, napi_callback_info info);
116     static napi_value RaiseToAppTop(napi_env env, napi_callback_info info);
117     static napi_value SetAspectRatio(napi_env env, napi_callback_info info);
118     static napi_value ResetAspectRatio(napi_env env, napi_callback_info info);
119     static napi_value Minimize(napi_env env, napi_callback_info info);
120     static napi_value Maximize(napi_env env, napi_callback_info info);
121     static napi_value RaiseAboveTarget(napi_env env, napi_callback_info info);
122     static napi_value KeepKeyboardOnFocus(napi_env env, napi_callback_info info);
123     static napi_value GetWindowLimits(napi_env env, napi_callback_info info);
124     static napi_value SetWindowLimits(napi_env env, napi_callback_info info);
125     static napi_value SetSpecificSystemBarEnabled(napi_env env, napi_callback_info info);
126     static napi_value SetSingleFrameComposerEnabled(napi_env env, napi_callback_info info);
127     static napi_value EnableLandscapeMultiWindow(napi_env env, napi_callback_info info);
128     static napi_value DisableLandscapeMultiWindow(napi_env env, napi_callback_info info);
129     static napi_value GetWindowStatus(napi_env env, napi_callback_info info);
130     static napi_value IsFocused(napi_env env, napi_callback_info info);
131     static napi_value RequestFocus(napi_env env, napi_callback_info info);
132     static napi_value StartMoving(napi_env env, napi_callback_info info);
133 
134     // colorspace, gamut
135     static napi_value IsSupportWideGamut(napi_env env, napi_callback_info info);
136     static napi_value IsWindowSupportWideGamut(napi_env env, napi_callback_info info);
137     static napi_value SetColorSpace(napi_env env, napi_callback_info info);
138     static napi_value SetWindowColorSpace(napi_env env, napi_callback_info info);
139     static napi_value GetColorSpace(napi_env env, napi_callback_info info);
140     static napi_value GetWindowColorSpaceSync(napi_env env, napi_callback_info info);
141     static napi_value Dump(napi_env env, napi_callback_info info);
142     static napi_value SetForbidSplitMove(napi_env env, napi_callback_info info);
143     static napi_value Snapshot(napi_env env, napi_callback_info info);
144 
145     // animation config
146     static napi_value Opacity(napi_env env, napi_callback_info info);
147     static napi_value Scale(napi_env env, napi_callback_info info);
148     static napi_value Rotate(napi_env env, napi_callback_info info);
149     static napi_value Translate(napi_env env, napi_callback_info info);
150     static napi_value GetTransitionController(napi_env env, napi_callback_info info);
151 
152     // window effect
153     static napi_value SetCornerRadius(napi_env env, napi_callback_info info);
154     static napi_value SetShadow(napi_env env, napi_callback_info info);
155     static napi_value SetBlur(napi_env env, napi_callback_info info);
156     static napi_value SetBackdropBlur(napi_env env, napi_callback_info info);
157     static napi_value SetBackdropBlurStyle(napi_env env, napi_callback_info info);
158     static napi_value SetWaterMarkFlag(napi_env env, napi_callback_info info);
159     static napi_value SetHandwritingFlag(napi_env env, napi_callback_info info);
160     static napi_value SetWindowDecorVisible(napi_env env, napi_callback_info info);
161     static napi_value SetWindowTitleMoveEnabled(napi_env env, napi_callback_info info);
162     static napi_value SetSubWindowModal(napi_env env, napi_callback_info info);
163     static napi_value SetWindowDecorHeight(napi_env env, napi_callback_info info);
164     static napi_value GetWindowDecorHeight(napi_env env, napi_callback_info info);
165     static napi_value GetTitleButtonRect(napi_env env, napi_callback_info info);
166     static napi_value SetWindowTitleButtonVisible(napi_env env, napi_callback_info info);
167     static napi_value SetWindowMask(napi_env env, napi_callback_info info);
168     static napi_value SetTitleButtonVisible(napi_env env, napi_callback_info info);
169     static napi_value SetWindowGrayScale(napi_env env, napi_callback_info info);
170     static napi_value SetImmersiveModeEnabledState(napi_env env, napi_callback_info info);
171     static napi_value GetImmersiveModeEnabledState(napi_env env, napi_callback_info info);
172     static napi_value EnableDrag(napi_env env, napi_callback_info info);
173 
174     /**
175      * Sub Window
176      */
177     static napi_value CreateSubWindowWithOptions(napi_env env, napi_callback_info info);
178 
179     /*
180      * Gesture Back
181      */
182     static napi_value SetGestureBackEnabled(napi_env env, napi_callback_info info);
183     static napi_value GetGestureBackEnabled(napi_env env, napi_callback_info info);
184 
185 private:
186     std::string GetWindowName();
187     static bool ParseScaleOption(napi_env env, napi_value jsObject, Transform& trans);
188     static bool ParseRotateOption(napi_env env, napi_value jsObject, Transform& trans);
189     static bool ParseTranslateOption(napi_env env, napi_value jsObject, Transform& trans);
190     static bool ParseWindowLimits(napi_env env, napi_value jsObject, WindowLimits& windowLimits);
191     bool CheckWindowMaskParams(napi_env env, napi_value jsObject);
192     napi_value LoadContentScheduleOld(napi_env env, napi_callback_info info, bool isLoadedByName);
193     napi_value LoadContentScheduleNew(napi_env env, napi_callback_info info, bool isLoadedByName);
194     napi_value HideWindowFunction(napi_env env, napi_callback_info info, WmErrorCode errCode);
195     napi_value OnShow(napi_env env, napi_callback_info info);
196     napi_value OnShowWindow(napi_env env, napi_callback_info info);
197     napi_value OnShowWithAnimation(napi_env env, napi_callback_info info);
198     napi_value OnDestroy(napi_env env, napi_callback_info info);
199     napi_value OnDestroyWindow(napi_env env, napi_callback_info info);
200     napi_value OnHide(napi_env env, napi_callback_info info);
201     napi_value OnHideWithAnimation(napi_env env, napi_callback_info info);
202     napi_value OnRecover(napi_env env, napi_callback_info info);
203     napi_value OnRestore(napi_env env, napi_callback_info info);
204     napi_value OnMoveTo(napi_env env, napi_callback_info info);
205     napi_value OnMoveWindowTo(napi_env env, napi_callback_info info);
206     napi_value OnMoveWindowToAsync(napi_env env, napi_callback_info info);
207     napi_value OnMoveWindowToGlobal(napi_env env, napi_callback_info info);
208     napi_value OnGetGlobalScaledRect(napi_env env, napi_callback_info info);
209     napi_value OnResize(napi_env env, napi_callback_info info);
210     napi_value OnResizeWindow(napi_env env, napi_callback_info info);
211     napi_value OnResizeWindowAsync(napi_env env, napi_callback_info info);
212     napi_value OnSetWindowType(napi_env env, napi_callback_info info);
213     napi_value OnSetWindowMode(napi_env env, napi_callback_info info);
214     napi_value OnGetProperties(napi_env env, napi_callback_info info);
215     napi_value OnGetWindowPropertiesSync(napi_env env, napi_callback_info info);
216     napi_value OnRegisterWindowCallback(napi_env env, napi_callback_info info);
217     napi_value OnUnregisterWindowCallback(napi_env env, napi_callback_info info);
218     napi_value OnBindDialogTarget(napi_env env, napi_callback_info info);
219     napi_value OnSetDialogBackGestureEnabled(napi_env env, napi_callback_info info);
220     napi_value OnSetFullScreen(napi_env env, napi_callback_info info);
221     napi_value OnSetLayoutFullScreen(napi_env env, napi_callback_info info);
222     napi_value OnSetTitleAndDockHoverShown(napi_env env, napi_callback_info info);
223     napi_value OnSetWindowLayoutFullScreen(napi_env env, napi_callback_info info);
224     napi_value OnSetSystemBarEnable(napi_env env, napi_callback_info info);
225     napi_value OnSetWindowSystemBarEnable(napi_env env, napi_callback_info info);
226     napi_value OnSetSystemBarProperties(napi_env env, napi_callback_info info);
227     napi_value OnGetWindowSystemBarPropertiesSync(napi_env env, napi_callback_info info);
228     napi_value OnSetWindowSystemBarProperties(napi_env env, napi_callback_info info);
229     napi_value OnLoadContent(napi_env env, napi_callback_info info, bool isLoadedByName);
230     napi_value OnGetUIContext(napi_env env, napi_callback_info info);
231     napi_value OnSetUIContent(napi_env env, napi_callback_info info);
232     napi_value OnGetAvoidArea(napi_env env, napi_callback_info info);
233     napi_value OnGetWindowAvoidAreaSync(napi_env env, napi_callback_info info);
234     napi_value OnIsShowing(napi_env env, napi_callback_info info);
235     napi_value OnIsWindowShowingSync(napi_env env, napi_callback_info info);
236     napi_value OnSetPreferredOrientation(napi_env env, napi_callback_info info);
237     napi_value OnGetPreferredOrientation(napi_env env, napi_callback_info info);
238     napi_value OnRaiseToAppTop(napi_env env, napi_callback_info info);
239     napi_value OnSetAspectRatio(napi_env env, napi_callback_info info);
240     napi_value OnResetAspectRatio(napi_env env, napi_callback_info info);
241     napi_value OnMinimize(napi_env env, napi_callback_info info);
242     napi_value OnMaximize(napi_env env, napi_callback_info info);
243     napi_value OnRaiseAboveTarget(napi_env env, napi_callback_info info);
244     napi_value OnKeepKeyboardOnFocus(napi_env env, napi_callback_info info);
245     napi_value OnSetWindowLimits(napi_env env, napi_callback_info info);
246     napi_value OnGetWindowLimits(napi_env env, napi_callback_info info);
247     napi_value OnSetSpecificSystemBarEnabled(napi_env env, napi_callback_info info);
248     napi_value OnSetWindowDecorVisible(napi_env env, napi_callback_info info);
249     napi_value OnSetWindowTitleMoveEnabled(napi_env env, napi_callback_info info);
250     napi_value OnSetSubWindowModal(napi_env env, napi_callback_info info);
251     napi_value OnSetWindowDecorHeight(napi_env env, napi_callback_info info);
252     napi_value OnGetWindowDecorHeight(napi_env env, napi_callback_info info);
253     napi_value OnGetTitleButtonRect(napi_env env, napi_callback_info info);
254     napi_value OnSetTitleButtonVisible(napi_env env, napi_callback_info info);
255     napi_value OnSetWindowTitleButtonVisible(napi_env env, napi_callback_info info);
256     napi_value OnSetImmersiveModeEnabledState(napi_env env, napi_callback_info info);
257     napi_value OnGetImmersiveModeEnabledState(napi_env env, napi_callback_info info);
258     napi_value OnGetWindowStatus(napi_env env, napi_callback_info info);
259     napi_value OnIsFocused(napi_env env, napi_callback_info info);
260     napi_value OnRequestFocus(napi_env env, napi_callback_info info);
261     napi_value OnEnableDrag(napi_env env, napi_callback_info info);
262 
263     // colorspace, gamut
264     napi_value OnIsSupportWideGamut(napi_env env, napi_callback_info info);
265     napi_value OnIsWindowSupportWideGamut(napi_env env, napi_callback_info info);
266     napi_value OnSetColorSpace(napi_env env, napi_callback_info info);
267     napi_value OnSetWindowColorSpace(napi_env env, napi_callback_info info);
268     napi_value OnGetColorSpace(napi_env env, napi_callback_info info);
269     napi_value OnGetWindowColorSpaceSync(napi_env env, napi_callback_info info);
270     napi_value OnSetBackgroundColor(napi_env env, napi_callback_info info);
271     napi_value OnSetWindowBackgroundColorSync(napi_env env, napi_callback_info info);
272     napi_value OnSetBrightness(napi_env env, napi_callback_info info);
273     napi_value OnSetWindowBrightness(napi_env env, napi_callback_info info);
274     napi_value OnSetDimBehind(napi_env env, napi_callback_info info);
275     napi_value OnSetFocusable(napi_env env, napi_callback_info info);
276     napi_value OnSetWindowFocusable(napi_env env, napi_callback_info info);
277     napi_value OnSetTopmost(napi_env env, napi_callback_info info);
278     napi_value OnSetWindowTopmost(napi_env env, napi_callback_info info);
279     napi_value OnSetKeepScreenOn(napi_env env, napi_callback_info info);
280     napi_value OnSetWindowKeepScreenOn(napi_env env, napi_callback_info info);
281     napi_value OnSetWakeUpScreen(napi_env env, napi_callback_info info);
282     napi_value OnSetOutsideTouchable(napi_env env, napi_callback_info info);
283     napi_value OnSetPrivacyMode(napi_env env, napi_callback_info info);
284     napi_value OnSetWindowPrivacyMode(napi_env env, napi_callback_info info);
285     napi_value OnSetTouchable(napi_env env, napi_callback_info info);
286     napi_value OnSetTouchableAreas(napi_env env, napi_callback_info info);
287     napi_value OnSetResizeByDragEnabled(napi_env env, napi_callback_info info);
288     napi_value OnSetRaiseByClickEnabled(napi_env env, napi_callback_info info);
289     napi_value OnHideNonSystemFloatingWindows(napi_env env, napi_callback_info info);
290     napi_value OnSetWindowTouchable(napi_env env, napi_callback_info info);
291     napi_value OnSetTransparent(napi_env env, napi_callback_info info);
292     napi_value OnSetCallingWindow(napi_env env, napi_callback_info info);
293     napi_value OnDisableWindowDecor(napi_env env, napi_callback_info info);
294     napi_value OnDump(napi_env env, napi_callback_info info);
295     napi_value OnSetForbidSplitMove(napi_env env, napi_callback_info info);
296     napi_value OnSnapshot(napi_env env, napi_callback_info info);
297     napi_value OnSetSnapshotSkip(napi_env env, napi_callback_info info);
298     napi_value OnSetSingleFrameComposerEnabled(napi_env env, napi_callback_info info);
299     napi_value OnEnableLandscapeMultiWindow(napi_env env, napi_callback_info info);
300     napi_value OnDisableLandscapeMultiWindow(napi_env env, napi_callback_info info);
301 
302     // animation Config
303     napi_value OnOpacity(napi_env env, napi_callback_info info);
304     napi_value OnScale(napi_env env, napi_callback_info info);
305     napi_value OnRotate(napi_env env, napi_callback_info info);
306     napi_value OnTranslate(napi_env env, napi_callback_info info);
307     napi_value OnGetTransitionController(napi_env env, napi_callback_info info);
308     WmErrorCode CreateTransitionController(napi_env env);
309 
310     // window effect
311     napi_value OnSetCornerRadius(napi_env env, napi_callback_info info);
312     napi_value OnSetShadow(napi_env env, napi_callback_info info);
313     napi_value OnSetBlur(napi_env env, napi_callback_info info);
314     napi_value OnSetBackdropBlur(napi_env env, napi_callback_info info);
315     napi_value OnSetBackdropBlurStyle(napi_env env, napi_callback_info info);
316     napi_value OnSetHandwritingFlag(napi_env env, napi_callback_info info);
317     napi_value OnSetWaterMarkFlag(napi_env env, napi_callback_info info);
318     napi_value OnSetWindowMask(napi_env env, napi_callback_info info);
319     napi_value OnSetWindowGrayScale(napi_env env, napi_callback_info info);
320     napi_value OnStartMoving(napi_env env, napi_callback_info info);
321 
322     /**
323      * Sub Window
324      */
325     napi_value OnCreateSubWindowWithOptions(napi_env env, napi_callback_info info);
326 
327     /*
328      * Gesture Back
329      */
330     napi_value OnSetGestureBackEnabled(napi_env env, napi_callback_info info);
331     napi_value OnGetGestureBackEnabled(napi_env env, napi_callback_info info);
332 
333     sptr<Window> windowToken_ = nullptr;
334     std::unique_ptr<JsWindowRegisterManager> registerManager_ = nullptr;
335     std::shared_ptr<NativeReference> jsTransControllerObj_ = nullptr;
336 };
337 }  // namespace Rosen
338 }  // namespace OHOS
339 #endif