io.h File Reference

#include <string>
#include <vector>
#include <Windows.h>

Include dependency graph for io.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
	BlamStrings
	Namespace for Blamite's shared C++ library.
	BlamStrings::Utils
	Namespace containing general-purpose utilities.
	BlamStrings::Utils::IO
	Utilities relating to reading/writing to and from files.

Macros
#define	STRINGS_API   __declspec(dllimport)

Functions
STRINGS_API bool	BlamStrings::Utils::IO::FileExists (std::string name)
	Checks if the specified file or directory exists. More...
STRINGS_API bool	BlamStrings::Utils::IO::IsFile (std::string path)
	Checks if a given path refers to a regular file. More...
STRINGS_API bool	BlamStrings::Utils::IO::IsDirectory (std::string path)
	Checks if a given path refers to a directory. More...
STRINGS_API bool	BlamStrings::Utils::IO::CreateNewFile (std::string filename, std::string file_contents)
	Creates a file with the specified contents, or overwrites an existing file if it already exists. More...
STRINGS_API void	BlamStrings::Utils::IO::ValidatePath (std::string path)
	Validates that the specified path exists. More...
STRINGS_API void	BlamStrings::Utils::IO::OpenGameDirectory ()
	Opens the engine's game directory in Windows Explorer. More...
STRINGS_API std::string	BlamStrings::Utils::IO::GetApplicationDir ()
	Retrieves the application's working directory. More...
STRINGS_API bool	BlamStrings::Utils::IO::ReadBinaryFile (std::string path, void *data, int64_t *size)
	Reads a file as raw binary data. More...
STRINGS_API std::vector< std::string >	BlamStrings::Utils::IO::GetFileContentsAsLines (std::string path)
	Reads a file as a list of strings. More...
STRINGS_API std::string	BlamStrings::Utils::IO::GetFileContentsAsString (std::string path)
	Reads a file as a string. More...
STRINGS_API std::vector< std::string >	BlamStrings::Utils::IO::GetFileList (std::string path)
	Retrieves the list of all files in a given directory. More...
STRINGS_API std::vector< std::string >	BlamStrings::Utils::IO::GetDirectoryList (std::string path)
	Retrieves the list of all folders in the root of a given directory. More...
STRINGS_API std::vector< std::string >	BlamStrings::Utils::IO::GetDeepFileList (std::string path)
	Retrieves the list of all files within a given directory. More...
STRINGS_API std::string	BlamStrings::Utils::IO::NormalizePath (std::string path)
	Normalizes a path string. More...
STRINGS_API std::string	BlamStrings::Utils::IO::GetFileName (std::string path)
	Retrieves the name of the file or folder that a given path refers to. More...
STRINGS_API std::string	BlamStrings::Utils::IO::GetFileNameWithoutExtension (std::string path)
	Retrieves the name of the file or folder that a given path refers to, excluding the file's extension (if applicable). More...
STRINGS_API std::string	BlamStrings::Utils::IO::GetFileExtension (std::string path)
	Retrieves the extension of a file. More...
STRINGS_API std::string	BlamStrings::Utils::IO::GetContainingFolder (std::string path)
	Retrieves the containing folder of a given file or directory. More...
STRINGS_API std::string	BlamStrings::Utils::IO::GetContainingFolder (std::string path, bool require_exists)
	Retrieves the containing folder of a given file or directory. More...
STRINGS_API std::string	BlamStrings::Utils::IO::GetEngineDataRoot ()
	Retrieves the root folder for all game engine and editing kit user data files. More...
STRINGS_API void	BlamStrings::Utils::IO::ExploreDirectory (std::string path)
	Opens a directory within the system file explorer. More...
STRINGS_API std::string	BlamStrings::Utils::IO::GetAbsolutePathFromRelative (std::string relative_path)
	Converts a relative path to an absolute file path. More...
STRINGS_API std::string	BlamStrings::Utils::IO::GetRelativePathFromAbsolute (std::string absolute_path)
	Converts an absolute path to a relative file path. More...

Macro Definition Documentation

STRINGS_API

#define STRINGS_API   __declspec(dllimport)