galaxy::VirtualFileSystem Class Reference

File System to make managing files easier. More...

#include <VirtualFileSystem.hpp>

Collaboration diagram for galaxy::VirtualFileSystem:

Public Member Functions
	VirtualFileSystem () noexcept
	Constructor.
	~VirtualFileSystem () noexcept
	Destructor.
std::string	read (const std::string &file)
	Read a file.
std::vector< std::uint8_t >	read_binary (const std::string &file)
	Read a binary file.
bool	write (const std::string &data, const std::string &file)
	Writes a file to disk.
bool	write_binary (std::span< std::uint8_t > data, const std::string &file)
	Writes a binary file to disk.
bool	write_raw (const void *data, const std::size_t size, const std::string &file)
	Raw data writing.
std::optional< ray::Image >	load_ray_image (const std::string &filename) noexcept
	Load an image from VFS. You must manually free the data after.
std::optional< ray::Image >	load_ray_image_anim (const std::string &filename, int *frames) noexcept
	Load an animated image from VFS (e.g. GIF). You must manually free the data after.
std::optional< ray::Texture2D >	load_ray_texture (const std::string &filename) noexcept
	Load a texture from VFS. You must manually free the data after.
std::optional< ray::Wave >	load_ray_wave (const std::string &filename) noexcept
	Load wave data from VFS. You must manually free the data after.
std::optional< ray::Music >	load_ray_music_stream (const std::string &filename) noexcept
	Load module music from VFS. You must manually free the data after.
std::optional< ray::Font >	load_ray_font (const std::string &filename, int font_size, std::span< int > font_chars) noexcept
	Load font from VFS. You must manually free the data after.
void	mkdir (const std::string &dir) noexcept
	Creates an empty folder in the filesystem relative to the root.
void	remove (const std::string &path) noexcept
	Delete a file or folder.
bool	exists (const std::string &file) noexcept
	Does the file exist in the vfs.
bool	is_dir (const std::string &path) noexcept
	Checks if a file is a folder.
std::vector< std::string >	list (const std::string &dir)
	Get assets in an asset folder.
void	alert () noexcept
	Trigger a standard filesystem audio alert.
void	notification (const std::string &title, const std::string &msg, const DialogIcon icon) noexcept
	Trigger a system notification.
int	message_box (const std::string &title, const std::string &msg, const DialogType type, const DialogIcon icon, const DialogButton btn) noexcept
	Opens a platform specific message box.
std::string	input_box (const std::string &title, const std::string &msg, const std::string &default_text="", const bool password=false) noexcept
	Opens a platform specific text input box.
std::string	open_save_dialog (const std::string &default_filename, const std::vector< const char * > &filters={})
	Open a save file dialog.
std::string	open_file_dialog (const std::vector< const char * > &filters={}, const std::string &def_path="")
	Open a file dialog.
std::string	select_folder_dialog (const std::string &def_path="")
	Select a folder using a dialog.

Private Member Functions
	VirtualFileSystem (const VirtualFileSystem &)=delete
	Copy constructor.
	VirtualFileSystem (VirtualFileSystem &&)=delete
	Move constructor.
VirtualFileSystem &	operator= (const VirtualFileSystem &)=delete
	Copy assignment operator.
VirtualFileSystem &	operator= (VirtualFileSystem &&)=delete
	Move assignment operator.

Detailed Description

File System to make managing files easier.

Definition at line 26 of file VirtualFileSystem.hpp.

Constructor & Destructor Documentation

VirtualFileSystem() [1/3]

galaxy::VirtualFileSystem::VirtualFileSystem ( )

noexcept

Constructor.

Definition at line 30 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

~VirtualFileSystem()

galaxy::VirtualFileSystem::~VirtualFileSystem ( )

noexcept

Destructor.

Definition at line 81 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

VirtualFileSystem() [2/3]

galaxy::VirtualFileSystem::VirtualFileSystem ( const VirtualFileSystem & )

privatedelete

Copy constructor.

Here is the call graph for this function:

VirtualFileSystem() [3/3]

galaxy::VirtualFileSystem::VirtualFileSystem ( VirtualFileSystem && )

privatedelete

Move constructor.

Here is the call graph for this function:

Member Function Documentation

read()

std::string galaxy::VirtualFileSystem::read ( const std::string & file )

nodiscard

Read a file.

Parameters

file	File to read from.

Returns

Buffer containing read data.

Definition at line 86 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

read_binary()

std::vector< std::uint8_t > galaxy::VirtualFileSystem::read_binary ( const std::string & file )

nodiscard

Read a binary file.

Parameters

file	File to read from.

Returns

Buffer containing read data.

Definition at line 122 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

write()

bool galaxy::VirtualFileSystem::write ( const std::string & data, const std::string & file )

nodiscard

Writes a file to disk.

Checks for existing file to overwrite first.

Parameters

data	Data to write to file.
file	Path to write to, including path from root.

Returns

True if successful.

Definition at line 158 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

write_binary()

bool galaxy::VirtualFileSystem::write_binary ( std::span< std::uint8_t > data, const std::string & file )

nodiscard

Writes a binary file to disk.

Checks for existing file to overwrite first.

Parameters

data	Data to write to file.
file	Path to write to, including path from root.

Returns

True if successful.

Definition at line 163 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

write_raw()

bool galaxy::VirtualFileSystem::write_raw ( const void * data, const std::size_t size, const std::string & file )

nodiscard

Raw data writing.

Parameters

data	Data to write to file.
size	Size of data to write.
file	Path to write to, including path from root.

Returns

True if successful.

Definition at line 168 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

load_ray_image()

std::optional< ray::Image > galaxy::VirtualFileSystem::load_ray_image ( const std::string & filename )

nodiscardnoexcept

Load an image from VFS. You must manually free the data after.

Parameters

filename

The filename to load from the search paths.

Returns

The loaded image on success.

Definition at line 200 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

load_ray_image_anim()

std::optional< ray::Image > galaxy::VirtualFileSystem::load_ray_image_anim ( const std::string & filename, int * frames )

nodiscardnoexcept

Load an animated image from VFS (e.g. GIF). You must manually free the data after.

Parameters

filename	The filename to load from the search paths.
frames	Set to the number of frames decoded on success.

Returns

The loaded image on success (height = frames * frameHeight).

Definition at line 231 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

load_ray_texture()

std::optional< ray::Texture2D > galaxy::VirtualFileSystem::load_ray_texture ( const std::string & filename )

nodiscardnoexcept

Load a texture from VFS. You must manually free the data after.

Parameters

fileName

The filename to load from the search paths.

Returns

The loaded texture on success.

Definition at line 262 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

load_ray_wave()

std::optional< ray::Wave > galaxy::VirtualFileSystem::load_ray_wave ( const std::string & filename )

nodiscardnoexcept

Load wave data from VFS. You must manually free the data after.

Parameters

filename

The file name to load from the PhysFS mount paths.

Returns

The Wave object.

Definition at line 286 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

load_ray_music_stream()

std::optional< ray::Music > galaxy::VirtualFileSystem::load_ray_music_stream ( const std::string & filename )

nodiscardnoexcept

Load module music from VFS. You must manually free the data after.

Parameters

filename

The file name to load from the PhysFS mount paths.

Returns

The Music object.

Definition at line 317 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

load_ray_font()

std::optional< ray::Font > galaxy::VirtualFileSystem::load_ray_font ( const std::string & filename, int font_size, std::span< int > font_chars )

nodiscardnoexcept

Load font from VFS. You must manually free the data after.

Parameters

filename	The file name to load from the PhysFS mount paths.
font_size	Size of the font.
font_chars	Characters to load.

Returns

The Font object.

Definition at line 348 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

mkdir()

void galaxy::VirtualFileSystem::mkdir ( const std::string & dir )

noexcept

Creates an empty folder in the filesystem relative to the root.

All missing parent directories are also created if they don't exist.

Parameters

dir	Directory(s) to create.

Definition at line 386 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

remove()

void galaxy::VirtualFileSystem::remove ( const std::string & path )

noexcept

Delete a file or folder.

Relative to the root. I.e. "textures/test.png" will become ROOT/textures/test.png.

Parameters

path	File or folder to delete.

Definition at line 394 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

exists()

bool galaxy::VirtualFileSystem::exists ( const std::string & file )

nodiscardnoexcept

Does the file exist in the vfs.

Parameters

file	File to check.

Returns

True if file exists.

Definition at line 399 of file VirtualFileSystem.cpp.

Here is the caller graph for this function:

is_dir()

bool galaxy::VirtualFileSystem::is_dir ( const std::string & path )

nodiscardnoexcept

Checks if a file is a folder.

Parameters

path	File/folder to check.

Returns

True if directory.

Definition at line 404 of file VirtualFileSystem.cpp.

Here is the caller graph for this function:

list()

std::vector< std::string > galaxy::VirtualFileSystem::list ( const std::string & dir )

nodiscard

Get assets in an asset folder.

Parameters

dir	Directory to fetch assets from.

Returns

List of assets in directory.

Definition at line 409 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

alert()

void galaxy::VirtualFileSystem::alert ( )

noexcept

Trigger a standard filesystem audio alert.

Definition at line 433 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

notification()

void galaxy::VirtualFileSystem::notification ( const std::string & title, const std::string & msg, const DialogIcon icon )

noexcept

Trigger a system notification.

Parameters

title	Notification title.
msg	Body text of notification.
icon	Icon to display alongside text.

Definition at line 438 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

message_box()

int galaxy::VirtualFileSystem::message_box ( const std::string & title, const std::string & msg, const DialogType type, const DialogIcon icon, const DialogButton btn )

nodiscardnoexcept

Opens a platform specific message box.

Parameters

title	Notification title.
msg	Body text of notification.
type	Type of message box.
icon	Icon to display alongside text.
btn	Button to show on message box.

Returns

Integer with outcome. 0 for cancel/no , 1 for ok/yes , 2 for no in yesnocancel.

Definition at line 444 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

input_box()

std::string galaxy::VirtualFileSystem::input_box ( const std::string & title, const std::string & msg, const std::string & default_text = "", const bool password = false )

nodiscardnoexcept

Opens a platform specific text input box.

Parameters

title	Notification title.
msg	Body text of notification.
default_text	Default text displayed in input box.
password	True to obscure input. Note that enabling this disables default_text.

Returns

Input as a string.

Definition at line 452 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

open_save_dialog()

std::string galaxy::VirtualFileSystem::open_save_dialog ( const std::string & default_filename, const std::vector< const char * > & filters = {} )

nodiscard

Open a save file dialog.

Parameters

default_filename	Default name to save file as.
filters	List of filters for dialog, i.e. "*.png", "*.jpg", etc.

Returns

String with path, empty if error.

Definition at line 458 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

open_file_dialog()

std::string galaxy::VirtualFileSystem::open_file_dialog ( const std::vector< const char * > & filters = {}, const std::string & def_path = "" )

nodiscard

Open a file dialog.

Parameters

filters	List of filters for dialog, i.e. "*.png", "*.jpg", etc.
def_path	Default starting path to open dialog at.

Returns

String with path, empty if error.

Definition at line 473 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

select_folder_dialog()

std::string galaxy::VirtualFileSystem::select_folder_dialog ( const std::string & def_path = "" )

nodiscard

Select a folder using a dialog.

Parameters

def_path

Default starting path to open dialog at.

Returns

String with path, empty if error.

Definition at line 490 of file VirtualFileSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [1/2]

VirtualFileSystem & galaxy::VirtualFileSystem::operator= ( const VirtualFileSystem & )

privatedelete

Copy assignment operator.

Here is the call graph for this function:

operator=() [2/2]

VirtualFileSystem & galaxy::VirtualFileSystem::operator= ( VirtualFileSystem && )

privatedelete

Move assignment operator.

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• galaxy/src/galaxy/fs/VirtualFileSystem.hpp
• galaxy/src/galaxy/fs/VirtualFileSystem.cpp