anki-3d-engine/include/anki/util/Filesystem.h

// Copyright (C) 2009-2015, Panagiotis Christopoulos Charitos.
// All rights reserved.
// Code licensed under the BSD License.
// http://www.anki3d.org/LICENSE

#pragma once

#include "anki/util/String.h"

namespace anki {

/// @addtogroup util_file
/// @{

/// Return true if a file exists
Bool fileExists(const CString& filename);

/// Get file extension.
void getFileExtension(
	const CString& filename,
	GenericMemoryPoolAllocator<U8> alloc,
	String& out);

/// Return true if directory exists?
Bool directoryExists(const CString& dir);

/// Callback for the @ref walkDirectoryTree.
/// - 1st parameter: The file or directory name.
/// - 2nd parameter: User data passed to walkDirectoryTree.
/// - 3rd parameter: True if it's directory, false if it's regular file.
using WalkDirectoryTreeCallback = Error(*)(const CString&, void*, Bool);

/// Walk a directory and it's subdirectories. Will walk and list all
/// directories and files of a directory.
ANKI_USE_RESULT Error walkDirectoryTree(
	const CString& dir,
	void* userData,
	WalkDirectoryTreeCallback callback);

/// Equivalent to: rm -rf dir
ANKI_USE_RESULT Error removeDirectory(const CString& dir);

/// Equivalent to: mkdir dir
ANKI_USE_RESULT Error createDirectory(const CString& dir);

/// Get the home directory.
/// Write the home directory to @a buff. The @a buffSize is the size of the
/// @a buff. If the @buffSize is not enough the function will throw
/// an exception.
ANKI_USE_RESULT Error getHomeDirectory(
	GenericMemoryPoolAllocator<U8> alloc, String& out);
/// @}

} // end namespace anki