summaryrefslogtreecommitdiffhomepage
path: root/SDK/Developer/CoreSystem/Headers/File.h
blob: 6b0bb29b1f6420bc0f47cc6edad03410af88577c (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
/* -------------------------------------------

    Copyright Mahrouss Logic

------------------------------------------- */

#pragma once

#include <Headers/Defines.h>

/// @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.
CA_EXTERN_C FSRef FsOpenFile(const CharacterTypeUTF8* path, const CharacterTypeUTF8* r);

/// @brief Closes the file and flushes it to the said file.
/// @param refFs the filesystem reference.
/// @return
CA_EXTERN_C VoidType FsCloseFile(FSRef refFs);

#define kMaxForkNameLength 256 /* long fork names. */

/// @brief A fork information header.
typedef struct _Fork
{
	PtrVoidType		  forkData;
	SizeType		  forkSize;
	Int32Type		  forkFlags;
	Int32Type		  forkKind;
	CharacterTypeUTF8 forkName[kMaxForkNameLength];
} ForkType;

typedef ForkType* FSForkRef;

/// @brief Gets the fork inside a file.
/// @param refFs the filesystem ref
/// @param forkName the fork's name
/// @return the fork data.
CA_EXTERN_C FSForkRef FsGetFork(FSRef refFs, const CharacterTypeUTF8* forkName);

/// @brief Check if the filesystem path is valid.
/// @return if not return false, or true.
CA_EXTERN_C BooleanType FsIsValidPath(const CharacterTypeUTF8* path);

/// @note not only limited to, there is code forks, icon forks...
#define FsGetDataFork(refFs) FsGetFork(refFs, "data")
#define FsGetRsrcFork(refFs) FsGetFork(refFs, "rsrc")