Elaztek Developer Hub
Blamite Game Engine - Strings  00341.11.29.21.2042.blamite
A library containing general purpose utilities and classes for use in multiple projects.
io.h
Go to the documentation of this file.
1 #include <string>
2 #include <vector>
3 #include <Windows.h>
4 
5 #ifdef STRINGS_EXPORTS
6 #define STRINGS_API __declspec(dllexport)
7 #else
8 #define STRINGS_API __declspec(dllimport)
9 #endif
10 
15 {
23  STRINGS_API bool FileExists(std::string name);
24 
33  STRINGS_API bool IsFile(std::string path);
34 
43  STRINGS_API bool IsDirectory(std::string path);
44 
53  STRINGS_API bool CreateNewFile(std::string filename, std::string file_contents);
54 
63  STRINGS_API void ValidatePath(std::string path);
64 
69 
75  STRINGS_API std::string GetApplicationDir();
76 
86  STRINGS_API bool ReadBinaryFile(std::string path, void* data, int64_t* size);
87 
96  STRINGS_API std::vector<std::string> GetFileContentsAsLines(std::string path);
97 
105  STRINGS_API std::string GetFileContentsAsString(std::string path);
106 
115  STRINGS_API std::vector<std::string> GetFileList(std::string path);
116 
125  STRINGS_API std::vector<std::string> GetDirectoryList(std::string path);
126 
137  STRINGS_API std::string NormalizePath(std::string path);
138 
149  STRINGS_API std::string GetFileName(std::string path);
150 
161  STRINGS_API std::string GetFileExtension(std::string path);
162 
177  STRINGS_API std::string GetContainingFolder(std::string path);
178 
186  STRINGS_API std::string GetEngineDataRoot();
187 
191  STRINGS_API void ExploreDirectory(std::string path);
192 
200  STRINGS_API std::string GetAbsolutePathFromRelative(std::string relative_path);
201 
210  STRINGS_API std::string GetRelativePathFromAbsolute(std::string absolute_path);
211 }
BlamStrings::Utils::IO::GetApplicationDir
STRINGS_API std::string GetApplicationDir()
Retrieves the application's working directory.
Definition: io.cpp:117
BlamStrings::Utils::IO::GetDirectoryList
STRINGS_API std::vector< std::string > GetDirectoryList(std::string path)
Retrieves the list of all folders in the root of a given directory.
Definition: io.cpp:208
BlamStrings::Utils::IO::GetFileExtension
STRINGS_API std::string GetFileExtension(std::string path)
Retrieves the extension of a file.
Definition: io.cpp:276
BlamStrings::Utils::IO
Utilities relating to reading/writing to and from files.
Definition: io.h:14
BlamStrings::Utils::IO::GetAbsolutePathFromRelative
STRINGS_API std::string GetAbsolutePathFromRelative(std::string relative_path)
Converts a relative path to an absolute file path.
Definition: io.cpp:331
BlamStrings::Utils::IO::CreateNewFile
STRINGS_API bool CreateNewFile(std::string filename, std::string file_contents)
Creates a file with the specified contents, or overwrites an existing file if it already exists.
Definition: io.cpp:76
BlamStrings::Utils::IO::GetEngineDataRoot
STRINGS_API std::string GetEngineDataRoot()
Retrieves the root folder for all game engine and editing kit user data files.
Definition: io.cpp:313
BlamStrings::Utils::IO::GetFileList
STRINGS_API std::vector< std::string > GetFileList(std::string path)
Retrieves the list of all files in a given directory.
Definition: io.cpp:180
BlamStrings::Utils::IO::IsDirectory
STRINGS_API bool IsDirectory(std::string path)
Checks if a given path refers to a directory.
Definition: io.cpp:59
BlamStrings::Utils::IO::GetFileName
STRINGS_API std::string GetFileName(std::string path)
Retrieves the name of the file or folder that a given path refers to.
Definition: io.cpp:253
BlamStrings::Utils::IO::GetFileContentsAsString
STRINGS_API std::string GetFileContentsAsString(std::string path)
Reads a file as a string.
Definition: io.cpp:140
BlamStrings::Utils::IO::NormalizePath
STRINGS_API std::string NormalizePath(std::string path)
Normalizes a path string.
Definition: io.cpp:236
BlamStrings::Utils::IO::IsFile
STRINGS_API bool IsFile(std::string path)
Checks if a given path refers to a regular file.
Definition: io.cpp:42
BlamStrings::Utils::IO::FileExists
STRINGS_API bool FileExists(std::string name)
Checks if the specified file or directory exists.
Definition: io.cpp:26
BlamStrings::Utils::IO::OpenGameDirectory
STRINGS_API void OpenGameDirectory()
Opens the engine's game directory in Windows Explorer.
Definition: io.cpp:110
BlamStrings::Utils::IO::GetContainingFolder
STRINGS_API std::string GetContainingFolder(std::string path)
Retrieves the containing folder of a given file or directory.
Definition: io.cpp:292
BlamStrings::Utils::IO::ValidatePath
STRINGS_API void ValidatePath(std::string path)
Validates that the specified path exists.
Definition: io.cpp:94
BlamStrings::Utils::IO::ReadBinaryFile
STRINGS_API bool ReadBinaryFile(std::string path, void *data, int64_t *size)
Reads a file as raw binary data.
Definition: io.cpp:156
BlamStrings::Utils::IO::GetFileContentsAsLines
STRINGS_API std::vector< std::string > GetFileContentsAsLines(std::string path)
Reads a file as a list of strings.
Definition: io.cpp:124
STRINGS_API
#define STRINGS_API
Definition: io.h:8
BlamStrings::Utils::IO::GetRelativePathFromAbsolute
STRINGS_API std::string GetRelativePathFromAbsolute(std::string absolute_path)
Converts an absolute path to a relative file path.
Definition: io.cpp:339
BlamStrings::Utils::IO::ExploreDirectory
STRINGS_API void ExploreDirectory(std::string path)
Opens a directory within the system file explorer.
Definition: io.cpp:326