1 /*
2 * Copyright (c) 2021-2022 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 COMMUNICATIONNETSTACK_NETSTACK_MODULE_TEMPLATE_H
17 #define COMMUNICATIONNETSTACK_NETSTACK_MODULE_TEMPLATE_H
18
19 #include <cstddef>
20 #include <initializer_list>
21 #include <iosfwd>
22 #include <type_traits>
23 #include <vector>
24
25 #include "base_async_work.h"
26 #include "napi/native_api.h"
27 #include "napi/native_common.h"
28 #include "base_context.h"
29 #include "netstack_log.h"
30 #include "napi_utils.h"
31
32 namespace OHOS::NetStack {
33 class EventManager;
34 }
35
36 #define MAX_PARAM_NUM 64
37
38 namespace OHOS::NetStack::ModuleTemplate {
39 typedef void (*Finalizer)(napi_env, void *data, void *);
40
41 template <class Context>
Interface(napi_env env,napi_callback_info info,const std::string & asyncWorkName,bool (* Work)(napi_env,napi_value,Context *),AsyncWorkExecutor executor,AsyncWorkCallback callback)42 napi_value Interface(napi_env env, napi_callback_info info, const std::string &asyncWorkName,
43 bool (*Work)(napi_env, napi_value, Context *), AsyncWorkExecutor executor,
44 AsyncWorkCallback callback)
45 {
46 static_assert(std::is_base_of<BaseContext, Context>::value);
47
48 napi_value thisVal = nullptr;
49 size_t paramsCount = MAX_PARAM_NUM;
50 napi_value params[MAX_PARAM_NUM] = {nullptr};
51 NAPI_CALL(env, napi_get_cb_info(env, info, ¶msCount, params, &thisVal, nullptr));
52
53 EventManager *manager = nullptr;
54 auto napi_ret = napi_unwrap(env, thisVal, reinterpret_cast<void **>(&manager));
55 if (napi_ret != napi_ok) {
56 NETSTACK_LOGE("get event manager in napi_unwrap failed, napi_ret is %{public}d", napi_ret);
57 return NapiUtils::GetUndefined(env);
58 }
59
60 auto context = new Context(env, manager);
61 context->ParseParams(params, paramsCount);
62 if (context->IsNeedThrowException()) { // only api9 or later need throw exception.
63 napi_throw_error(env, std::to_string(context->GetErrorCode()).c_str(), context->GetErrorMessage().c_str());
64 delete context;
65 context = nullptr;
66 return NapiUtils::GetUndefined(env);
67 }
68 if (Work != nullptr) {
69 if (!Work(env, thisVal, context)) {
70 NETSTACK_LOGE("work failed error code = %{public}d", context->GetErrorCode());
71 }
72 }
73
74 context->CreateReference(thisVal);
75 context->CreateAsyncWork(asyncWorkName, executor, callback);
76 if (NapiUtils::GetValueType(env, context->GetCallback()) != napi_function && context->IsNeedPromise()) {
77 NETSTACK_LOGI("%{public}s create promise", asyncWorkName.c_str());
78 return context->CreatePromise();
79 }
80 return NapiUtils::GetUndefined(env);
81 }
82
83 template <class Context>
InterfaceWithOutAsyncWork(napi_env env,napi_callback_info info,bool (* Work)(napi_env,napi_value,Context *),const std::string & asyncWorkName,AsyncWorkExecutor executor,AsyncWorkCallback callback)84 napi_value InterfaceWithOutAsyncWork(napi_env env, napi_callback_info info,
85 bool (*Work)(napi_env, napi_value, Context *), const std::string &asyncWorkName,
86 AsyncWorkExecutor executor, AsyncWorkCallback callback)
87 {
88 static_assert(std::is_base_of<BaseContext, Context>::value);
89
90 napi_value thisVal = nullptr;
91 size_t paramsCount = MAX_PARAM_NUM;
92 napi_value params[MAX_PARAM_NUM] = {nullptr};
93 NAPI_CALL(env, napi_get_cb_info(env, info, ¶msCount, params, &thisVal, nullptr));
94
95 EventManager *manager = nullptr;
96 auto napi_ret = napi_unwrap(env, thisVal, reinterpret_cast<void **>(&manager));
97 if (napi_ret != napi_ok) {
98 NETSTACK_LOGE("get event manager in napi_unwrap failed, napi_ret is %{public}d", napi_ret);
99 return NapiUtils::GetUndefined(env);
100 }
101
102 auto context = new Context(env, manager);
103 context->ParseParams(params, paramsCount);
104 napi_value ret = NapiUtils::GetUndefined(env);
105 if (NapiUtils::GetValueType(env, context->GetCallback()) != napi_function && context->IsNeedPromise()) {
106 NETSTACK_LOGI("%{public}s create promise", asyncWorkName.c_str());
107 ret = context->CreatePromise();
108 }
109 context->CreateReference(thisVal);
110 if (Work != nullptr) {
111 if (!Work(env, thisVal, context)) {
112 NETSTACK_LOGE("work failed error code = %{public}d", context->GetErrorCode());
113 }
114 }
115 if (!context->IsParseOK() || context->IsPermissionDenied() || context->GetManager()->IsEventDestroy()) {
116 context->CreateAsyncWork(asyncWorkName, executor, callback);
117 }
118 return ret;
119 }
120
121 napi_value On(napi_env env, napi_callback_info info, const std::initializer_list<std::string> &events,
122 bool asyncCallback);
123
124 napi_value Once(napi_env env, napi_callback_info info, const std::initializer_list<std::string> &events,
125 bool asyncCallback);
126
127 napi_value Off(napi_env env, napi_callback_info info, const std::initializer_list<std::string> &events);
128
129 void DefineClass(napi_env env, napi_value exports, const std::initializer_list<napi_property_descriptor> &properties,
130 const std::string &className);
131
132 napi_value NewInstance(napi_env env, napi_callback_info info, const std::string &className, Finalizer finalizer);
133
134 napi_value NewInstanceNoManager(napi_env env, napi_callback_info info, const std::string &name, Finalizer finalizer);
135 } // namespace OHOS::NetStack::ModuleTemplate
136 #endif /* COMMUNICATIONNETSTACK_NETSTACK_MODULE_TEMPLATE_H */
137