blob: cfd9ee300427be859864ec4e944a108d8ffba00f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
/* -------------------------------------------
Copyright SoftwareLabs
------------------------------------------- */
#pragma once
#include <Headers/Defines.h>
#define kMaxForkNameLength (256U) /* long fork names. */
struct _Fork;
/// @brief Filesystem wrapper.
typedef QWordType FSRef;
/// @brief Opens a new file.
/// @param path where to find it.
/// @param rest the restrict (rw, rwe, r+, w+, r, w)
/// @return FSRef the file.
CS_EXTERN_C FSRef CSOpenFile(const CharacterTypeUTF8* path, const CharacterTypeUTF8* r);
/// @brief Closes the file and flushes it to the said file.
/// @param refCS the filesystem reference.
/// @return
CS_EXTERN_C VoidType CSCloseFile(FSRef refCS);
/// @brief A fork information header.
typedef struct _Fork
{
Int32Type forkFlags;
Int32Type forkKind;
CharacterTypeUTF8 forkName[kMaxForkNameLength];
SizeType forkSize;
CharacterTypeUTF8 forkData[];
} ForkType, ForkTypePtr;
typedef ForkType* FSForkRef;
/// @brief Gets the fork inside a file.
/// @param refCS the filesystem ref
/// @param forkName the fork's name
/// @return the fork data.
CS_EXTERN_C FSForkRef CSGetFork(FSRef refCS, const CharacterTypeUTF8* forkName);
/// @brief Check if the filesystem path is valid.
/// @return if not return false, or true.
CS_EXTERN_C BooleanType CSIsValidPath(const CharacterTypeUTF8* path);
/// @brief Flush file
/// @param refCS the file reference.
/// @return
CS_EXTERN_C VoidType CSFlushFile(FSRef refCS);
/// END OF FILE
|
