doylet/Dqn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add DqnFile_WriteAll and convenience flag FileReadWrite

Browse Source
This commit is contained in:
Doyle T 2018-07-28 15:16:01 +10:00
parent e2dbf2816a
commit 2eff450a72
2 changed files with 79 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
DqnUnitTest.cpp
View File

@ -1697,9 +1697,8 @@ void DqnFile_Test()
} }
DqnFile file = {}; DqnFile file = {};
DQN_ASSERT(file.Open(".clang-format", DQN_ASSERT(file.Open(
(DqnFile::Permission::FileWrite | DqnFile::Permission::FileRead), ".clang-format", DqnFile::Flag::FileReadWrite, DqnFile::Action::OpenOnly));
DqnFile::Action::OpenOnly));
DQN_ASSERTM(file.size == expectedSize, DQN_ASSERTM(file.size == expectedSize,
"DqnFileOpen() failed: file.size: %d, expected:%d\n", file.size, "DqnFileOpen() failed: file.size: %d, expected:%d\n", file.size,
@ -1715,9 +1714,8 @@ void DqnFile_Test()
if (1) if (1)
{ {
DqnSmartFile raiiFile = {}; DqnSmartFile raiiFile = {};
if (raiiFile.Open(FILE_TO_OPEN, if (raiiFile.Open(
DqnFile::Permission::FileWrite | DqnFile::Permission::FileRead, FILE_TO_OPEN, DqnFile::Flag::FileReadWrite, DqnFile::Action::OpenOnly))
DqnFile::Action::OpenOnly))
{ {
i32 breakHereToTestRaii = 0; i32 breakHereToTestRaii = 0;
(void)breakHereToTestRaii; (void)breakHereToTestRaii;
@ -1731,9 +1729,8 @@ void DqnFile_Test()
if (1) if (1)
{ {
DqnFile file = {}; DqnFile file = {};
DQN_ASSERT(!file.Open("asdljasdnel;kajdf", (DqnFile::Permission::FileWrite | DQN_ASSERT(!file.Open(
DqnFile::Permission::FileRead), "asdljasdnel;kajdf", DqnFile::Flag::FileReadWrite, DqnFile::Action::OpenOnly));
DqnFile::Action::OpenOnly));
DQN_ASSERT(file.size == 0); DQN_ASSERT(file.size == 0);
DQN_ASSERT(file.flags == 0); DQN_ASSERT(file.flags == 0);
DQN_ASSERT(!file.handle); DQN_ASSERT(!file.handle);
@ -1751,7 +1748,7 @@ void DqnFile_Test()
// Write data out to some files // Write data out to some files
for (u32 i = 0; i < DQN_ARRAY_COUNT(fileNames); i++) for (u32 i = 0; i < DQN_ARRAY_COUNT(fileNames); i++)
{ {
u32 permissions = DqnFile::Permission::FileRead | DqnFile::Permission::FileWrite; u32 permissions = DqnFile::Flag::FileReadWrite;
DqnFile *file = files + i; DqnFile *file = files + i;
if (!file->Open(fileNames[i], permissions, DqnFile::Action::ClearIfExist)) if (!file->Open(fileNames[i], permissions, DqnFile::Action::ClearIfExist))
{ {
@ -1773,7 +1770,7 @@ void DqnFile_Test()
{ {
// Manual read the file contents // Manual read the file contents
{ {
u32 permissions = DqnFile::Permission::FileRead; u32 permissions = DqnFile::Flag::FileRead;
DqnFile *file = files + i; DqnFile *file = files + i;
bool result = file->Open(fileNames[i], permissions, DqnFile::Action::OpenOnly); bool result = file->Open(fileNames[i], permissions, DqnFile::Action::OpenOnly);
DQN_ASSERT(result); DQN_ASSERT(result);
@ -1816,7 +1813,7 @@ void DqnFile_Test()
for (u32 i = 0; i < DQN_ARRAY_COUNT(fileNames); i++) for (u32 i = 0; i < DQN_ARRAY_COUNT(fileNames); i++)
{ {
DqnFile dummy = {}; DqnFile dummy = {};
u32 permissions = DqnFile::Permission::FileRead; u32 permissions = DqnFile::Flag::FileRead;
bool fileExists = dummy.Open(fileNames[i], permissions, DqnFile::Action::OpenOnly); bool fileExists = dummy.Open(fileNames[i], permissions, DqnFile::Action::OpenOnly);
DQN_ASSERT(!fileExists); DQN_ASSERT(!fileExists);
} }
@ -2357,9 +2354,8 @@ void DqnCatalog_Test()
// Write file A and check we are able to open it up in the catalog // Write file A and check we are able to open it up in the catalog
{ {
DQN_ASSERTM(file.Open(testFile.str, DQN_ASSERTM(
DqnFile::Permission::FileRead | DqnFile::Permission::FileWrite, file.Open(testFile.str, DqnFile::Flag::FileReadWrite, DqnFile::Action::ForceCreate),
DqnFile::Action::ForceCreate),
"Could not create testing file for DqnCatalog"); "Could not create testing file for DqnCatalog");
file.Write(reinterpret_cast<u8 const *>(bufA), DQN_CHAR_COUNT(bufA), 0); file.Write(reinterpret_cast<u8 const *>(bufA), DQN_CHAR_COUNT(bufA), 0);
file.Close(); file.Close();
@ -2372,9 +2368,8 @@ void DqnCatalog_Test()
// Write file B check that it has been updated // Write file B check that it has been updated
{ {
file = {}; file = {};
DQN_ASSERTM(file.Open(testFile.str, DQN_ASSERTM(
DqnFile::Permission::FileRead | DqnFile::Permission::FileWrite, file.Open(testFile.str, DqnFile::Flag::FileReadWrite, DqnFile::Action::ForceCreate),
DqnFile::Action::ForceCreate),
"Could not create testing file for DqnCatalog"); "Could not create testing file for DqnCatalog");
file.Write(reinterpret_cast<u8 const *>(bufX), DQN_CHAR_COUNT(bufX), 0); file.Write(reinterpret_cast<u8 const *>(bufX), DQN_CHAR_COUNT(bufX), 0);
file.Close(); file.Close();

76
dqn.h
View File

@ -2838,12 +2838,13 @@ DQN_VHASH_TABLE_TEMPLATE void DQN_VHASH_TABLE_DECL::Erase(Key const &key)
// ================================================================================================= // =================================================================================================
struct DqnFile struct DqnFile
{ {
enum Permission enum Flag
{ {
FileRead = (1 << 0), FileRead = (1 << 0),
FileWrite = (1 << 1), FileWrite = (1 << 1),
Execute = (1 << 2), Execute = (1 << 2),
All = (1 << 3) All = (1 << 3),
FileReadWrite = FileRead | FileWrite
}; };
enum struct Action enum struct Action
@ -2864,7 +2865,7 @@ struct DqnFile
// Open a handle for file read and writing. Deleting files does not need a handle. Handles should be // Open a handle for file read and writing. Deleting files does not need a handle. Handles should be
// closed before deleting files otherwise the OS may not be able to delete the file. // closed before deleting files otherwise the OS may not be able to delete the file.
// return: FALSE if invalid args or failed to get handle (i.e. insufficient permissions) // return: FALSE if invalid args or failed to get handle (i.e. insufficient permission)
bool Open(char const *path, u32 const flags_, Action const action); bool Open(char const *path, u32 const flags_, Action const action);
bool Open(wchar_t const *path, u32 const flags_, Action const action); bool Open(wchar_t const *path, u32 const flags_, Action const action);
@ -2900,6 +2901,9 @@ DQN_FILE_SCOPE bool DqnFile_ReadAll(wchar_t const *path, u8 *buf, usize const
DQN_FILE_SCOPE u8 *DqnFile_ReadAll(char const *path, usize *bufSize, DqnMemAPI *api = DQN_DEFAULT_HEAP_ALLOCATOR); DQN_FILE_SCOPE u8 *DqnFile_ReadAll(char const *path, usize *bufSize, DqnMemAPI *api = DQN_DEFAULT_HEAP_ALLOCATOR);
DQN_FILE_SCOPE u8 *DqnFile_ReadAll(wchar_t const *path, usize *bufSize, DqnMemAPI *api = DQN_DEFAULT_HEAP_ALLOCATOR); DQN_FILE_SCOPE u8 *DqnFile_ReadAll(wchar_t const *path, usize *bufSize, DqnMemAPI *api = DQN_DEFAULT_HEAP_ALLOCATOR);
DQN_FILE_SCOPE bool DqnFile_WriteAll(char const *path, u8 const *buf, usize const bufSize);
DQN_FILE_SCOPE bool DqnFile_WriteAll(wchar_t const *path, u8 const *buf, usize const bufSize);
// return: False if file access failure // return: False if file access failure
DQN_FILE_SCOPE bool DqnFile_Size(char const *path, usize *size); DQN_FILE_SCOPE bool DqnFile_Size(char const *path, usize *size);
DQN_FILE_SCOPE bool DqnFile_Size(wchar_t const *path, usize *size); DQN_FILE_SCOPE bool DqnFile_Size(wchar_t const *path, usize *size);
@ -8484,16 +8488,16 @@ DqnFile__Win32Open(wchar_t const *path, DqnFile *file, u32 flags, DqnFile::Actio
u32 const WIN32_FILE_ATTRIBUTE_NORMAL = 0x00000080; u32 const WIN32_FILE_ATTRIBUTE_NORMAL = 0x00000080;
DWORD win32Permission = 0; DWORD win32Flag = 0;
if (flags & DqnFile::Permission::All) if (flags & DqnFile::Flag::All)
{ {
win32Permission = WIN32_GENERIC_ALL; win32Flag = WIN32_GENERIC_ALL;
} }
else else
{ {
if (flags & DqnFile::Permission::FileRead) win32Permission |= WIN32_GENERIC_READ; if (flags & DqnFile::Flag::FileRead) win32Flag |= WIN32_GENERIC_READ;
if (flags & DqnFile::Permission::FileWrite) win32Permission |= WIN32_GENERIC_WRITE; if (flags & DqnFile::Flag::FileWrite) win32Flag |= WIN32_GENERIC_WRITE;
if (flags & DqnFile::Permission::Execute) win32Permission |= WIN32_GENERIC_EXECUTE; if (flags & DqnFile::Flag::Execute) win32Flag |= WIN32_GENERIC_EXECUTE;
} }
DWORD win32Action = 0; DWORD win32Action = 0;
@ -8507,7 +8511,7 @@ DqnFile__Win32Open(wchar_t const *path, DqnFile *file, u32 flags, DqnFile::Actio
case DqnFile::Action::ForceCreate: win32Action = WIN32_CREATE_ALWAYS; break; case DqnFile::Action::ForceCreate: win32Action = WIN32_CREATE_ALWAYS; break;
} }
HANDLE handle = CreateFileW(path, win32Permission, 0, nullptr, win32Action, HANDLE handle = CreateFileW(path, win32Flag, 0, nullptr, win32Action,
WIN32_FILE_ATTRIBUTE_NORMAL, nullptr); WIN32_FILE_ATTRIBUTE_NORMAL, nullptr);
if (handle == INVALID_HANDLE_VALUE) if (handle == INVALID_HANDLE_VALUE)
@ -8656,7 +8660,7 @@ DqnFile__UnixOpen(char const *path, DqnFile *file, u32 flags, DqnFile::Action ac
char operation = 0; char operation = 0;
bool updateFlag = false; bool updateFlag = false;
if (flags & DqnFile::Permission::FileWrite) if (flags & DqnFile::Flag::FileWrite)
{ {
updateFlag = true; updateFlag = true;
switch (action) switch (action)
@ -8677,10 +8681,10 @@ DqnFile__UnixOpen(char const *path, DqnFile *file, u32 flags, DqnFile::Action ac
break; break;
} }
} }
else if ((flags & DqnFile::Permission::FileRead) || else if ((flags & DqnFile::Flag::FileRead) ||
(flags & DqnFile::Permission::Execute)) (flags & DqnFile::Flag::Execute))
{ {
if (flags & DqnFile::Permission::Execute) if (flags & DqnFile::Flag::Execute)
{ {
// TODO(doyle): Logging, UNIX doesn't have execute param for file // TODO(doyle): Logging, UNIX doesn't have execute param for file
// handles. Execution goes through system() // handles. Execution goes through system()
@ -8924,10 +8928,50 @@ u8 *DqnFile_ReadAll(char const *path, usize *bufSize, DqnMemAPI *api)
return nullptr; return nullptr;
} }
DQN_FILE_SCOPE bool DqnFile_WriteAll(char const *path, u8 const *buf, usize const bufSize)
{
DqnFile file = {};
if (!file.Open(path, DqnFile::Flag::FileReadWrite, DqnFile::Action::ForceCreate))
{
DQN_LOGE("Could not open file at: %s", path);
return false;
}
DQN_DEFER(file.Close());
usize bytesWritten = file.Write(buf, bufSize, 0);
if (bytesWritten != bufSize)
{
DQN_LOGE("Bytes written did not match the buffer size, %zu != %zu", bytesWritten, bufSize);
return false;
}
return true;
}
DQN_FILE_SCOPE bool DqnFile_WriteAll(wchar_t const *path, u8 const *buf, usize const bufSize)
{
DqnFile file = {};
if (!file.Open(path, DqnFile::Flag::FileReadWrite, DqnFile::Action::ForceCreate))
{
DQN_LOGE("Could not open file at: %s", path);
return false;
}
DQN_DEFER(file.Close());
usize bytesWritten = file.Write(buf, bufSize, 0);
if (bytesWritten != bufSize)
{
DQN_LOGE("Bytes written did not match the buffer size, %zu != %zu", bytesWritten, bufSize);
return false;
}
return true;
}
bool DqnFile_ReadAll(wchar_t const *path, u8 *buf, usize bufSize, usize *bytesRead) bool DqnFile_ReadAll(wchar_t const *path, u8 *buf, usize bufSize, usize *bytesRead)
{ {
DqnFile file = {}; DqnFile file = {};
bool result = file.Open(path, DqnFile::Permission::FileRead, DqnFile::Action::OpenOnly); bool result = file.Open(path, DqnFile::Flag::FileRead, DqnFile::Action::OpenOnly);
DQN_DEFER(file.Close()); DQN_DEFER(file.Close());
// TODO(doyle): Logging // TODO(doyle): Logging
@ -8945,7 +8989,7 @@ bool DqnFile_ReadAll(wchar_t const *path, u8 *buf, usize bufSize, usize *bytesRe
bool DqnFile_ReadAll(const char *path, u8 *buf, usize bufSize, usize *bytesRead) bool DqnFile_ReadAll(const char *path, u8 *buf, usize bufSize, usize *bytesRead)
{ {
DqnFile file = {}; DqnFile file = {};
bool result = file.Open(path, DqnFile::Permission::FileRead, DqnFile::Action::OpenOnly); bool result = file.Open(path, DqnFile::Flag::FileRead, DqnFile::Action::OpenOnly);
DQN_DEFER(file.Close()); DQN_DEFER(file.Close());
if (!result || file.size > bufSize) if (!result || file.size > bufSize)