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 N_VAL_H 17 #define N_VAL_H 18 19 #include <string_view> 20 21 #include "sys/types.h" 22 #include "uni_header.h" 23 24 namespace OHOS { 25 namespace DistributedFS { 26 class NVal final { 27 public: 28 NVal() = default; 29 NVal(napi_env nEnv, napi_value nVal); 30 NVal(const NVal &) = default; 31 NVal &operator = (const NVal &) = default; 32 virtual ~NVal() = default; 33 34 // NOTE! env_ and val_ is LIKELY to be null 35 napi_env env_ = nullptr; 36 napi_value val_ = nullptr; 37 38 explicit operator bool() const; 39 bool TypeIs(napi_valuetype expType) const; 40 bool TypeIsError(bool checkErrno = false) const; 41 42 /* SHOULD ONLY BE USED FOR EXPECTED TYPE */ 43 std::tuple<bool, std::unique_ptr<char[]>, size_t> ToUTF8String() const; 44 std::tuple<bool, std::unique_ptr<char[]>, size_t> ToUTF8String(std::string_view defaultValue) const; 45 std::tuple<bool, std::unique_ptr<char[]>, size_t> ToUTF16String() const; 46 std::tuple<bool, std::unique_ptr<char[]>, size_t> ToUTF8StringPath() const; 47 std::tuple<bool, void *> ToPointer() const; 48 std::tuple<bool, bool> ToBool() const; 49 std::tuple<bool, bool> ToBool(bool defaultValue) const; 50 std::tuple<bool, int32_t> ToInt32() const; 51 std::tuple<bool, int32_t> ToInt32(int32_t defaultValue) const; 52 std::tuple<bool, int64_t> ToInt64() const; 53 std::tuple<bool, int64_t> ToInt64(int64_t defaultValue) const; 54 std::tuple<bool, void *, size_t> ToArraybuffer() const; 55 std::tuple<bool, void *, size_t> ToTypedArray() const; 56 std::tuple<bool, std::vector<std::string>, uint32_t> ToStringArray(); 57 std::tuple<bool, uint64_t, bool> ToUint64() const; 58 std::tuple<bool, double> ToDouble() const; 59 60 /* Static helpers to create js objects */ 61 static NVal CreateUndefined(napi_env env); 62 static NVal CreateBigInt64(napi_env env, int64_t val); 63 static NVal CreateInt64(napi_env env, int64_t val); 64 static NVal CreateInt32(napi_env env, int32_t val); 65 static NVal CreateObject(napi_env env); 66 static NVal CreateBool(napi_env env, bool val); 67 static NVal CreateUTF8String(napi_env env, std::string str); 68 static NVal CreateUTF8String(napi_env env, const char* str, ssize_t len); 69 static NVal CreateUint8Array(napi_env env, void *buf, size_t bufLen); 70 static NVal CreateArrayString(napi_env env, std::vector<std::string> strs); 71 static std::tuple<NVal, void *> CreateArrayBuffer(napi_env env, size_t len); 72 /* SHOULD ONLY BE USED FOR OBJECT */ 73 bool HasProp(std::string propName) const; 74 NVal GetProp(std::string propName) const; 75 bool AddProp(std::vector<napi_property_descriptor> &&propVec) const; 76 bool AddProp(std::string propName, napi_value nVal) const; 77 78 /* Static helpers to create prop of js objects */ 79 static napi_property_descriptor DeclareNapiProperty(const char *name, napi_value val); 80 static napi_property_descriptor DeclareNapiStaticProperty(const char *name, napi_value val); 81 static napi_property_descriptor DeclareNapiFunction(const char *name, napi_callback func); 82 static napi_property_descriptor DeclareNapiStaticFunction(const char *name, napi_callback func); 83 static napi_property_descriptor DeclareNapiGetter(const char *name, napi_callback getter); 84 static napi_property_descriptor DeclareNapiSetter(const char *name, napi_callback setter); 85 static inline napi_property_descriptor DeclareNapiGetterSetter(const char *name, 86 napi_callback getter, 87 napi_callback setter); 88 }; 89 } // namespace DistributedFS 90 } // namespace OHOS 91 #endif // N_VAL_H