gentle.documentation - gtFileSystem

Класс содержащий статичные методы для работы с файлами и папками.

constexpr u32 GT_MAX_PATH = 0xffff;

GT_API static bool addArchive( const gtString& file );

GT_API static gtPtrNew<gtFile> createFile( const gtString& fileName, gtFileMode mode, gtFileAccessMode access, gtFileAction action, gtFileShareMode shareMode = gtFileShareMode::None, u32 attributeFlags = 0u );

Параметр attributeFlags хранит флаги указанные в gtFileAttribute.

Необъодимо использовать gtPtr для автоматического закрытия файла и удаления объекта.

gtPtr<gtFile> file = gtFileSystem::createFile(...)

Можно использовать синоним gtFile_t.

gtFile_t file = gtFileSystem::createFile(...)

Для краткости записи вызова метода createFile созданы вспомогательные функции.

GT_API static bool copyFile( const gtString& existingFileName, const gtString& newFileName, bool overwrite );

Параметр overwrite true если нужно перезаписать существующий файл.

GT_API static bool createDir( const gtString& dir );

GT_API static bool deleteDir( const gtString& dir );

Удалит директорию вместе с файлами и поддиректориями.

GT_API static bool deleteFile( const gtString& file );

GT_API static bool existDir( const gtString& dir );

Вернёт истину если указанная директория существует.

GT_API static bool existFile( const gtString& file );

Вернёт истину если указанный файл существует.

GT_API static gtString getProgramPath();

Получить путь к программе.

GT_API static gtString getRealPath( const gtString& in );

Получить из относительного пути реальный путь.

GT_API static gtString getSystemPath();

Получить путь к системной директории.

GT_API static bool getDirObject( DirObject* inout );

При сканировании директории, получить текущий объект директории.

GT_API static void scanDirBegin( gtString dir );

Начать сканировать директорию.

Перед сканированием директории, нужно вызвать эту функцию.

После сканирования, нужно вызвать gtFileSystem::scanDirEnd.

GT_API static void scanDirEnd();

Завершить сканирование директории.

GT_API static u8 * unpack( const gtString& file, u32 * size );

Распакует файл из архива.

Вернёт массив который нужно будет удалить вызвав gtMemFree.

Для автоматического удаления можно использовать класс gtMemPtr.

Размер данных запишется в переменную через второй параметр.

Если файлы не найдутся в папке, то плагины при загрузке ресурсов попробоют найти эти файлы в архиве.

GT_API static gtPtr<gtXMLDocument> XMLRead( const gtString& file );

GT_API static void XMLWrite( const gtString& file, gtXMLNode* rootNode, bool utf8 = false );

Для записи необходим лиш корневой элемент.

Данные типы созданы в помощь при сканировании директории.

Перечисляет тип объекта что находится в директории.

Не директория и не файл (например точки . и .. ).

Описывает объект директории.