• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 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 OHOS_FILE_FS_FFI_H
17 #define OHOS_FILE_FS_FFI_H
18 
19 #include <cstdint>
20 
21 #include "cj_common_ffi.h"
22 #include "copy_dir.h"
23 #include "ffi_remote_data.h"
24 #include "file_fs_impl.h"
25 #include "list_file.h"
26 #include "napi/native_api.h"
27 
28 extern "C" {
29     FFI_EXPORT RetDataI64 FfiOHOSFileFsStatByID(int32_t file);
30     FFI_EXPORT RetDataI64 FfiOHOSFileFsStatByString(const char* file);
31     FFI_EXPORT RetDataI64 FfiOHOSFileFsCreateStream(const char* path, const char* mode);
32     FFI_EXPORT RetDataI64 FfiOHOSFileFsFdopenStream(int32_t fd, const char* mode);
33     FFI_EXPORT RetDataI64 FfiOHOSFileFsLstat(const char* path);
34 
35     // RandomAccessFile
36     FFI_EXPORT napi_value FfiConvertRandomAccessFile2Napi(napi_env env, int64_t id);
37     FFI_EXPORT int64_t FfiCreateRandomAccessFileFromNapi(napi_env env, napi_value objRAF);
38     FFI_EXPORT RetDataI64 FfiOHOSFileFsCreateRandomAccessFileByString(const char* file, int64_t mode);
39     FFI_EXPORT RetDataI64 FfiOHOSFileFsCreateRandomAccessFileByID(int64_t file, int64_t mode);
40     FFI_EXPORT int32_t FfiOHOSRandomAccessFileGetFd(int64_t id);
41     FFI_EXPORT int64_t FfiOHOSRandomAccessFileGetFPointer(int64_t id);
42     FFI_EXPORT void FfiOHOSRandomAccessFileSetFilePointerSync(int64_t id, int64_t fd);
43     FFI_EXPORT void FfiOHOSRandomAccessFileClose(int64_t id);
44     FFI_EXPORT RetDataI64 FfiOHOSRandomAccessFileWrite(int64_t id, char* buf, size_t len, int64_t offset);
45     FFI_EXPORT RetDataI64 FfiOHOSRandomAccessFileRead(int64_t id, char* buf, size_t len, int64_t offset);
46     FFI_EXPORT int32_t FfiOHOSFileFsMkdir(const char* path, bool recursion, bool isTwoArgs);
47     FFI_EXPORT int32_t FfiOHOSFileFsRmdir(const char* path);
48     FFI_EXPORT OHOS::CJSystemapi::RetDataCArrConflictFiles FfiOHOSFileFsMoveDir(const char* src, const char* dest,
49         int32_t mode);
50     FFI_EXPORT int32_t FfiOHOSFileFsRename(const char* oldFile, const char* newFile);
51     FFI_EXPORT int32_t FfiOHOSFileFsUnlink(const char* path);
52     FFI_EXPORT RetDataBool FfiOHOSFileFsAccess(const char* path);
53     FFI_EXPORT RetDataBool FfiOHOSFileFsAccessExt(const char* path, int32_t mode, int32_t flag);
54     FFI_EXPORT RetDataI64 FfiOHOSFileFsOpen(const char* path, uint64_t mode);
55     FFI_EXPORT RetDataI64 FfiOHOSFileFsRead(int32_t fd, char* buffer, int64_t bufLen, size_t length, int64_t offset);
56     FFI_EXPORT RetDataI64 FfiOHOSFileFsReadCur(int32_t fd, char* buffer, int64_t bufLen, size_t length);
57     FFI_EXPORT RetDataI64 FfiOHOSFileFsWrite(int32_t fd, char* buffer, size_t length, int64_t offset,
58         const char* encode);
59     FFI_EXPORT RetDataI64 FfiOHOSFileFsWriteCur(int32_t fd, char* buffer, size_t length, const char* encode);
60     FFI_EXPORT OHOS::CJSystemapi::RetDataCArrConflictFiles FfiOHOSFileFsCopyDir(const char* src, const char* dest,
61         int mode);
62     FFI_EXPORT int FfiOHOSFileFsCopyFile(const char* src, const char* dest, int mode);
63     FFI_EXPORT int FfiOHOSFileFsCopyFileSI(const char* src, int32_t dest, int mode);
64     FFI_EXPORT int FfiOHOSFileFsCopyFileIS(int32_t src, const char* dest, int mode);
65     FFI_EXPORT int FfiOHOSFileFsCopyFileII(int32_t src, int32_t dest, int mode);
66     FFI_EXPORT int FfiOHOSFileFsMoveFile(const char* src, const char* dest, int mode);
67     FFI_EXPORT RetDataCString FfiOHOSFileFsMkdtemp(const char* prefix);
68     FFI_EXPORT int32_t FfiOHOSFileFsTruncateByString(const char* file, int64_t len);
69     FFI_EXPORT int32_t FfiOHOSFileFsTruncateByFd(int32_t file, int64_t len);
70     FFI_EXPORT RetDataI64 FfiOHOSFileFsReadLines(char* path, char* encoding);
71     FFI_EXPORT RetDataCString FfiOHOSFileFsReadText(char* path, int64_t offset, bool hasLen, int64_t len,
72         char* encoding);
73     FFI_EXPORT int32_t FfiOHOSFileFsUtimes(char* path, double mtime);
74     FFI_EXPORT RetDataI64 FfiOHOSFileFsCreateWatcher(char* path, uint32_t events,
75         void (*callback)(OHOS::CJSystemapi::CWatchEvent));
76     FFI_EXPORT int32_t FfiOHOSFileFsWatcherStart(int64_t id);
77     FFI_EXPORT int32_t FfiOHOSFileFsWatcherStop(int64_t id);
78 
79     struct RetReaderIteratorResult {
80         int32_t code;
81         bool done;
82         char* data;
83     };
84     FFI_EXPORT RetReaderIteratorResult FfiOHOSFileFsReaderIteratorNext(int64_t id);
85     FFI_EXPORT OHOS::CJSystemapi::RetDataCArrStringN FfiOHOSFileListFile(const char* path,
86         OHOS::CJSystemapi::CListFileOptions options);
87     FFI_EXPORT RetDataI64 FfiOHOSFileFsLseek(int32_t fd, int64_t offset, int whence);
88     FFI_EXPORT int FfiOHOSFileFsFdatasync(int32_t fd);
89     FFI_EXPORT int FfiOHOSFileFsFsync(int32_t fd);
90     FFI_EXPORT int FfiOHOSFileFsSymlink(const char* target, const char* srcPath);
91     FFI_EXPORT int64_t FfiOHOSFileFsCreateCopyOptions(int64_t callbackId, int64_t signalId);
92     FFI_EXPORT int64_t FfiOHOSFileFsCreateTaskSignal();
93     FFI_EXPORT int64_t FfiOHOSFileFsTaskSignalCancel(int64_t id);
94     FFI_EXPORT void FfiOHOSFileFsCopy(const char* src, const char* dest, int64_t opt);
95 
96     FFI_EXPORT int64_t FfiCreateStreamFromNapi(napi_env env, napi_value stream);
97     FFI_EXPORT napi_value FfiConvertStream2Napi(napi_env env, int64_t id);
98 }
99 #endif