• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2022-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_FORM_FWK_JS_FORM_PROVIDER_H
17 #define OHOS_FORM_FWK_JS_FORM_PROVIDER_H
18 
19 #include "ability.h"
20 #include "form_info_filter.h"
21 #include "form_provider_info.h"
22 #include "napi_form_util.h"
23 #include "napi/native_api.h"
24 #include "napi/native_common.h"
25 #include "napi/native_node_api.h"
26 #include "nlohmann/json.hpp"
27 #include "want.h"
28 #include <vector>
29 
30 namespace OHOS {
31 namespace AbilityRuntime {
32 struct RequestPublishFormCallbackInfo {
33     Want want {};
34     bool withFormBindingData = false;
35     std::unique_ptr<OHOS::AppExecFwk::FormProviderData> formProviderData = nullptr;
36     std::vector<AppExecFwk::FormDataProxy> formDataProxies;
37 };
38 
39 struct AsyncIsRequestPublishFormSupportedCallbackInfo : AsyncCallbackInfoBase {
40     bool result = false;
41 
AsyncIsRequestPublishFormSupportedCallbackInfoAsyncIsRequestPublishFormSupportedCallbackInfo42     explicit AsyncIsRequestPublishFormSupportedCallbackInfo(napi_env env) : AsyncCallbackInfoBase(env) {};
43     ~AsyncIsRequestPublishFormSupportedCallbackInfo() override = default;
44 };
45 
46 napi_value NAPI_RequestPublishForm(napi_env env, napi_callback_info info);
47 
48 /**
49  * @brief Check if the request to publish a form to the form host is supported.
50  *
51  * @param[in] env The environment that the Node-API call is invoked under
52  * @param[in] info This is an opaque pointer that is used to represent a JavaScript value
53  *
54  * @return This is an opaque pointer that is used to represent a JavaScript value
55  *         which is true if the request of publishing form is supported and false otherwise
56  */
57 napi_value NAPI_IsRequestPublishFormSupported(napi_env env, napi_callback_info info);
58 
59 class JsFormProvider {
60 public:
61     JsFormProvider() = default;
62     ~JsFormProvider() = default;
63 
64     static void Finalizer(napi_env env, void* data, void* hint);
65     static napi_value GetFormsInfo(napi_env env, napi_callback_info info);
66     static napi_value SetFormNextRefreshTime(napi_env env, napi_callback_info info);
67     static napi_value UpdateForm(napi_env env, napi_callback_info info);
68     static napi_value IsRequestPublishFormSupported(napi_env env, napi_callback_info info);
69     static napi_value RequestPublishForm(napi_env env, napi_callback_info info);
70     static napi_value GetPublishedFormInfoById(napi_env env, napi_callback_info info);
71     static napi_value GetPublishedFormInfos(napi_env env, napi_callback_info info);
72     static napi_value OpenFormManager(napi_env env, napi_callback_info info);
73     static napi_value OpenFormManagerCrossBundle(napi_env env, napi_callback_info info);
74     static napi_value OpenFormEditAbility(napi_env env, napi_callback_info info);
75     static napi_value RequestOverflow(napi_env env, napi_callback_info info);
76     static napi_value CancelOverflow(napi_env env, napi_callback_info info);
77     static napi_value ActivateSceneAnimation(napi_env env, napi_callback_info info);
78     static napi_value DeactivateSceneAnimation(napi_env env, napi_callback_info info);
79     static napi_value GetFormRect(napi_env env, napi_callback_info info);
80     static napi_value GetPublishedRunningFormInfoById(napi_env env, napi_callback_info info);
81     static napi_value GetPublishedRunningFormInfos(napi_env env, napi_callback_info info);
82 private:
83     napi_value OnGetFormsInfo(napi_env env, size_t argc, napi_value* argv);
84     napi_value OnGetPublishedFormInfoById(napi_env env, size_t argc, napi_value* argv);
85     napi_value OnGetPublishedFormInfos(napi_env env, size_t argc, napi_value* argv);
86     napi_value OnOpenFormManager(napi_env env, size_t argc, napi_value* argv);
87     napi_value OnOpenFormManagerCrossBundle(napi_env env, size_t argc, napi_value* argv);
88     napi_value OnSetFormNextRefreshTime(napi_env env, size_t argc, napi_value* argv);
89     napi_value OnUpdateForm(napi_env env, size_t argc, napi_value* argv);
90     napi_value OnIsRequestPublishFormSupported(napi_env env, size_t argc, napi_value* argv);
91     napi_value OnRequestPublishForm(napi_env env, size_t argc, napi_value* argv);
92     napi_value OnGetFormRect(napi_env env, size_t argc, napi_value* argv);
93     napi_value OnGetPublishedRunningFormInfoById(napi_env env, size_t argc, napi_value* argv);
94     napi_value OnGetPublishedRunningFormInfos(napi_env env, size_t argc, napi_value* argv);
95     bool ConvertFromDataProxies(napi_env env, napi_value jsValue,
96         std::vector<AppExecFwk::FormDataProxy> &formDataProxies);
97     bool ConvertFormDataProxy(napi_env env, napi_value jsValue, AppExecFwk::FormDataProxy &formDataProxy);
98 
99     bool OnGetFormsInfoParseParam(NapiParamPackage &napiParam,
100         size_t &convertArgc, bool &isPromise, AppExecFwk::FormInfoFilter &formInfoFilter);
101     napi_value OnUpdateFormParseParam(napi_env env, size_t argc, napi_value* argv, int64_t &formId);
102     napi_value OnOpenFormEditAbility(napi_env env, size_t argc, napi_value* argv);
103     napi_value OnRequestOverflow(napi_env env, size_t argc, napi_value* argv);
104     napi_value OnCancelOverflow(napi_env env, size_t argc, napi_value* argv);
105     napi_value OnActivateSceneAnimation(napi_env env, size_t argc, napi_value* argv);
106     napi_value OnDeactivateSceneAnimation(napi_env env, size_t argc, napi_value* argv);
107     static bool ConvertFormOverflowInfo(napi_env env, napi_value argv, AppExecFwk::OverflowInfo* overflowInfo);
108     static bool ConvertOverflowInfoArea(napi_env env, napi_value rangeArea, AppExecFwk::Rect &area);
109     static bool GetAndConvertProperty(napi_env env, napi_value object, const char* propertyName, double& outValue);
110 };
111 }  // namespace AbilityRuntime
112 }  // namespace OHOS
113 #endif /* OHOS_FORM_FWK_JS_FORM_PROVIDER_H */
114