Elaztek Developer Hub
Blamite Game Engine - Strings  00386.06.16.23.0646.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 
135  STRINGS_API std::vector<std::string> GetDeepFileList(std::string path);
136 
147  STRINGS_API std::string NormalizePath(std::string path);
148 
159  STRINGS_API std::string GetFileName(std::string path);
160 
171  STRINGS_API std::string GetFileNameWithoutExtension(std::string path);
172 
183  STRINGS_API std::string GetFileExtension(std::string path);
184 
199  STRINGS_API std::string GetContainingFolder(std::string path);
200 
216  STRINGS_API std::string GetContainingFolder(std::string path, bool require_exists);
217 
225  STRINGS_API std::string GetEngineDataRoot();
226 
230  STRINGS_API void ExploreDirectory(std::string path);
231 
239  STRINGS_API std::string GetAbsolutePathFromRelative(std::string relative_path);
240 
249  STRINGS_API std::string GetRelativePathFromAbsolute(std::string absolute_path);
250 }
logger.h
BlamStrings::Utils::IO::GetApplicationDir
STRINGS_API std::string GetApplicationDir()
Retrieves the application's working directory.
Definition: io.cpp:115
BlamStrings::Utils::String::Split
STRINGS_API std::vector< std::string > Split(std::string string, std::string splitter)
Splits a string around any instance of a substring.
Definition: string.cpp:114
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:206
BlamStrings::Utils::IO::GetFileExtension
STRINGS_API std::string GetFileExtension(std::string path)
Retrieves the extension of a file.
Definition: io.cpp:322
string.h
BlamStrings::Utils::String::Contains
STRINGS_API bool Contains(std::string string, std::string contains)
Determines whether or not a string contains the specified substring.
Definition: string.cpp:159
BlamStrings::Utils::IO::GetDeepFileList
STRINGS_API std::vector< std::string > GetDeepFileList(std::string path)
Retrieves the list of all files within a given directory.
Definition: io.cpp:234
BlamStrings::Logger::LogEvent
STRINGS_API void LogEvent(BlamBasicLogMessage message)
Logs an event to the logger.
Definition: logger.cpp:27
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:389
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:371
BlamStrings::Utils::String::Replace
STRINGS_API std::string Replace(std::string orig, std::string to_replace, std::string replace_with)
Replaces part of a string with another string.
Definition: string.cpp:94
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:178
res.h
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:287
BlamStrings::Utils::IO::GetFileContentsAsString
STRINGS_API std::string GetFileContentsAsString(std::string path)
Reads a file as a string.
Definition: io.cpp:138
BlamStrings::Utils::IO::NormalizePath
STRINGS_API std::string NormalizePath(std::string path)
Normalizes a path string.
Definition: io.cpp:270
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::GetFileNameWithoutExtension
STRINGS_API std::string GetFileNameWithoutExtension(std::string path)
Retrieves the name of the file or folder that a given path refers to, excluding the file's extension ...
Definition: io.cpp:310
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:108
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:341
BlamStrings::Utils::IO::ValidatePath
STRINGS_API void ValidatePath(std::string path)
Validates that the specified path exists.
Definition: io.cpp:94
io.h
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:154
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:122
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:397
BlamStrings::Utils::IO::ExploreDirectory
STRINGS_API void ExploreDirectory(std::string path)
Opens a directory within the system file explorer.
Definition: io.cpp:384
BlamStrings::Utils::String::ContainsChar
STRINGS_API bool ContainsChar(std::string string, char contains)
Determines whether or not a string contains the specified character.
Definition: string.cpp:143
BlamLogLevel::Warning
@ Warning
Indicates a warning message. Not something critical, but something that could cause unexpected behavi...