Fission FSN
Loading...
Searching...
No Matches
fsIFile.h
Go to the documentation of this file.
1/********************************************************************
2*
3* File: fsIFile.h
4*
5* Purpose: Interface for file operations
6*
7*********************************************************************/
8
9#ifndef fsIFilehdr
10#define fsIFilehdr
11
12#include <vector>
13
14#include "fsBaseTypes.h"
15
16class fsCResourceName;
17class fsStr;
18
20{
23 friend class fsCHardware;
24
25public:
26
27#ifdef fsInAppPurchase
28 static void preLoadODR(const fsCResourceName& pFilename);
29#endif
30
32
33 static fsStr fullPathGet(const fsCResourceName& pFilename);
34 static fsStr bytesGetFromCompressedFile(const fsCResourceName& pFilename);
35 static fsStr strGetFromFile(const fsCResourceName& pFilename);
36 static void strWriteToFile(const fsCResourceName& pFilename, const fsStr& pStr);
37 static void strAppendToFile(const fsCResourceName& pFilename, const fsStr& pStr);
38
39 // Binary-safe counterpart to strWriteToFile(): writes exactly
40 // pBytes.dataSizeGet() bytes verbatim. strWriteToFile() ultimately hands
41 // the data to APIs that take a null-terminated/length-via-strlen string
42 // (e.g. axmol's FileUtils::writeStringToFile(std::string_view)), which
43 // silently truncates at the first embedded 0x00 byte -- fine for text,
44 // silently corrupting for arbitrary binary payloads (a PNG's IHDR chunk
45 // alone puts a 0x00 within the first ~16 bytes). Use this whenever the
46 // buffer being written is not known to be a plain string.
47 static void bytesWriteToFileBinary(const fsCResourceName& pFilename, const fsStr& pBytes);
48
49 static std::vector<fsStr> textFileReadToVector(const fsCResourceName& pFileName);
50
51 static fsBool fileExistsGet(const fsCResourceName& pFileName);
52 static fsBool fileDelete(const fsCResourceName& pFileName);
53
54 static fsBool folderCreate(const fsCResourceName& pFolderName);
55 static fsBool folderIs(const fsCResourceName& pFolderName);
56
57 static void fileCopy(const fsCResourceName& pSource, const fsCResourceName& pDestination);
58 static fsBool folderDelete(const fsCResourceName& pFolderName);
59
60protected:
61
62private:
63
64 // Use sparingly - all file work must use fsCResourceName except fsCResourceName itself or
65 // it ends up calling itself
66 static fsBool rawFileNameExistsCheck(const fsStr& pFileName);
67 static void systemFolderCreate(const fsStr& pFolderName);
68 static void systemFolderDelete(const fsStr& pFolderName);
69};
70
71#endif
Definition fsCResourceName.h:32
Definition fsIFile.h:20
static fsStr bytesGetFromCompressedFileBinary(const fsCResourceName &pFilename)
Definition fsIFile.cpp:32
static std::vector< fsStr > textFileReadToVector(const fsCResourceName &pFileName)
Definition fsIFile.cpp:57
static fsStr bytesGetFromCompressedFile(const fsCResourceName &pFilename)
Definition fsIFile.cpp:42
static void fileCopy(const fsCResourceName &pSource, const fsCResourceName &pDestination)
Definition fsIFile.cpp:111
static fsBool folderIs(const fsCResourceName &pFolderName)
Definition fsIFile.cpp:91
static fsBool folderDelete(const fsCResourceName &pFolderName)
Definition fsIFile.cpp:123
friend class fsCResourceNamePathAdjuster
Definition fsIFile.h:21
static void strAppendToFile(const fsCResourceName &pFilename, const fsStr &pStr)
Definition fsIFile.cpp:96
static fsBool folderCreate(const fsCResourceName &pFolderName)
Definition fsIFile.cpp:118
static void bytesWriteToFileBinary(const fsCResourceName &pFilename, const fsStr &pBytes)
Definition fsIFile.cpp:102
static fsStr strGetFromFile(const fsCResourceName &pFilename)
Definition fsIFile.cpp:47
static fsStr fullPathGet(const fsCResourceName &pFilename)
Definition fsIFile.cpp:37
static void preLoadODR(const fsCResourceName &pFilename)
Definition fsIFile.cpp:26
friend class fsIResourceNamePathAdjuster
Definition fsIFile.h:22
static fsBool fileExistsGet(const fsCResourceName &pFileName)
Definition fsIFile.cpp:77
static void strWriteToFile(const fsCResourceName &pFilename, const fsStr &pStr)
Definition fsIFile.cpp:52
friend class fsCHardware
Definition fsIFile.h:23
static fsBool fileDelete(const fsCResourceName &pFileName)
Definition fsIFile.cpp:82
Definition fsStr.h:23
bool fsBool
Definition fsBaseTypes.h:26