Irrlicht 3D Engine: irr::io::IFileSystem Class Reference

| Irrlicht 3D Engine |

Public Member Functions
irr::io::IFileSystem Class Reference

The FileSystem manages files and archives and provides access to them. More...

`#include <IFileSystem.h>`

Inheritance diagram for irr::io::IFileSystem:

List of all members.

## Public Member Functions

- virtual void addArchiveLoader (IArchiveLoader *loader)=0
    Adds an external archive loader to the engine.
- virtual bool addFileArchive (const path &filename, bool ignoreCase=true, bool ignorePaths=true, E_FILE_ARCHIVE_TYPE archiveType=EFAT_UNKNOWN, const core::stringc &password="", IFileArchive **retArchive=0)=0
    Adds an archive to the file system.
- virtual bool addFileArchive (IReadFile *file, bool ignoreCase=true, bool ignorePaths=true, E_FILE_ARCHIVE_TYPE archiveType=EFAT_UNKNOWN, const core::stringc &password="", IFileArchive **retArchive=0)=0
    Adds an archive to the file system.
- virtual bool addFileArchive (IFileArchive *archive)=0
    Adds an archive to the file system.
- virtual _IRR_DEPRECATED_ bool addFolderFileArchive (const c8 *filename, bool ignoreCase=true, bool ignorePaths=true)
    Adds an unzipped archive (or basedirectory with subdirectories..) to the file system.
- virtual _IRR_DEPRECATED_ bool addPakFileArchive (const c8 *filename, bool ignoreCase=true, bool ignorePaths=true)
    Adds a pak archive to the file system.
- virtual _IRR_DEPRECATED_ bool addZipFileArchive (const c8 *filename, bool ignoreCase=true, bool ignorePaths=true)
    Adds a zip archive to the file system.
- virtual bool changeWorkingDirectoryTo (const path &newDirectory)=0
    Changes the current working directory.
- virtual IReadFile * createAndOpenFile (const path &filename)=0
    Opens a file for read access.
- virtual IWriteFile * createAndWriteFile (const path &filename, bool append=false)=0
    Opens a file for write access.
- virtual IAttributes * createEmptyAttributes (video::IVideoDriver *driver=0)=0
    Creates a new empty collection of attributes, usable for serialization and more.
- virtual IFileList * createEmptyFileList (const io::path &path, bool ignoreCase, bool ignorePaths)=0
    Creates an empty filelist.
- virtual IFileList * createFileList ()=0
    Creates a list of files and directories in the current working directory and returns it.
- virtual IReadFile * createLimitReadFile (const path &fileName, IReadFile *alreadyOpenedFile, long pos, long areaSize)=0
    Creates an IReadFile interface for accessing files inside files.
- virtual IReadFile * createMemoryReadFile (void *memory, s32 len, const path &fileName, bool deleteMemoryWhenDropped=false)=0
    Creates an IReadFile interface for accessing memory like a file.
- virtual IWriteFile * createMemoryWriteFile (void *memory, s32 len, const path &fileName, bool deleteMemoryWhenDropped=false)=0
    Creates an IWriteFile interface for accessing memory like a file.
- virtual IXMLReader * createXMLReader (const path &filename)=0
    Creates a XML Reader from a file which returns all parsed strings as wide characters (wchar_t*).
- virtual IXMLReader * createXMLReader (IReadFile *file)=0
    Creates a XML Reader from a file which returns all parsed strings as wide characters (wchar_t*).
- virtual IXMLReaderUTF8 * createXMLReaderUTF8 (const path &filename)=0
    Creates a XML Reader from a file which returns all parsed strings as ASCII/UTF-8 characters (char*).
- virtual IXMLReaderUTF8 * createXMLReaderUTF8 (IReadFile *file)=0
    Creates a XML Reader from a file which returns all parsed strings as ASCII/UTF-8 characters (char*).
- virtual IXMLWriter * createXMLWriter (const path &filename)=0
    Creates a XML Writer from a file.
- virtual IXMLWriter * createXMLWriter (IWriteFile *file)=0
    Creates a XML Writer from a file.
- virtual bool existFile (const path &filename) const =0
    Determines if a file exists and could be opened.
- virtual path & flattenFilename (path &directory, const path &root="/") const =0
    flatten a path and file name for example: "/you/me/../." becomes "/you"
- virtual path getAbsolutePath (const path &filename) const =0
    Converts a relative path to an absolute (unique) path, resolving symbolic links if required.
- virtual IArchiveLoader * getArchiveLoader (u32 index) const =0
    Retrieve the given archive loader.
- virtual u32 getArchiveLoaderCount () const =0
    Gets the number of archive loaders currently added.
- virtual IFileArchive * getFileArchive (u32 index)=0
    Get the archive at a given index.
- virtual u32 getFileArchiveCount () const =0
    Get the number of archives currently attached to the file system.
- virtual path getFileBasename (const path &filename, bool keepExtension=true) const =0
    Get the base part of a filename, i.e. the name without the directory part.
- virtual path getFileDir (const path &filename) const =0
    Get the directory a file is located in.
- virtual path getRelativeFilename (const path &filename, const path &directory) const =0
    Get the relative filename, relative to the given directory.
- virtual const path & getWorkingDirectory ()=0
    Get the current working directory.
- virtual bool moveFileArchive (u32 sourceIndex, s32 relative)=0
    Changes the search order of attached archives.
- virtual bool removeFileArchive (u32 index)=0
    Removes an archive from the file system.
- virtual bool removeFileArchive (const path &filename)=0
    Removes an archive from the file system.
- virtual bool removeFileArchive (const IFileArchive *archive)=0
    Removes an archive from the file system.
- virtual EFileSystemType setFileListSystem (EFileSystemType listType)=0
    Set the active type of file system.

## Detailed Description

The FileSystem manages files and archives and provides access to them.

It manages where files are, so that modules which use the the IO do not need to know where every file is located. A file could be in a .zip-Archive or as file on disk, using the IFileSystem makes no difference to this.

Definition at line 32 of file IFileSystem.h.

## Member Function Documentation

virtual void irr::io::IFileSystem::addArchiveLoader | ( | IArchiveLoader * | loader | ) | `[pure virtual]`

Adds an external archive loader to the engine.

Use this function to add support for new archive types to the engine, for example proprietary or encrypted file storage.

virtual bool irr::io::IFileSystem::addFileArchive | ( | const path & | filename,
|  | bool | ignoreCase = `true`,
|  | bool | ignorePaths = `true`,
|  | E_FILE_ARCHIVE_TYPE | archiveType = `EFAT_UNKNOWN`,
|  | const core::stringc & | password = `""`,
|  | IFileArchive ** | retArchive = `0`
| ) |  | `[pure virtual]`

Adds an archive to the file system.

After calling this, the Irrlicht Engine will also search and open files directly from this archive. This is useful for hiding data from the end user, speeding up file access and making it possible to access for example Quake3 .pk3 files, which are just renamed .zip files. By default Irrlicht supports ZIP, PAK, TAR, PNK, and directories as archives. You can provide your own archive types by implementing IArchiveLoader and passing an instance to addArchiveLoader. Irrlicht supports AES-encrypted zip files, and the advanced compression techniques lzma and bzip2.

Parameters:

  filename,: | Filename of the archive to add to the file system.
  ignoreCase,: | If set to true, files in the archive can be accessed without writing all letters in the right case.
  ignorePaths,: | If set to true, files in the added archive can be accessed without its complete path.
  archiveType,: | If no specific E_FILE_ARCHIVE_TYPE is selected then the type of archive will depend on the extension of the file name. If you use a different extension then you can use this parameter to force a specific type of archive.
  password | An optional password, which is used in case of encrypted archives.
  retArchive | A pointer that will be set to the archive that is added.

Returns:
  True if the archive was added successfully, false if not.

Referenced by addFolderFileArchive(), addPakFileArchive(), and addZipFileArchive().

virtual bool irr::io::IFileSystem::addFileArchive | ( | IReadFile * | file,
|  | bool | ignoreCase = `true`,
|  | bool | ignorePaths = `true`,
|  | E_FILE_ARCHIVE_TYPE | archiveType = `EFAT_UNKNOWN`,
|  | const core::stringc & | password = `""`,
|  | IFileArchive ** | retArchive = `0`
| ) |  | `[pure virtual]`

Adds an archive to the file system.

After calling this, the Irrlicht Engine will also search and open files directly from this archive. This is useful for hiding data from the end user, speeding up file access and making it possible to access for example Quake3 .pk3 files, which are just renamed .zip files. By default Irrlicht supports ZIP, PAK, TAR, PNK, and directories as archives. You can provide your own archive types by implementing IArchiveLoader and passing an instance to addArchiveLoader. Irrlicht supports AES-encrypted zip files, and the advanced compression techniques lzma and bzip2. If you want to add a directory as an archive, prefix its name with a slash in order to let Irrlicht recognize it as a folder mount (mypath/). Using this technique one can build up a search order, because archives are read first, and can be used more easily with relative filenames.

Parameters:

  file,: | Archive to add to the file system.
  ignoreCase,: | If set to true, files in the archive can be accessed without writing all letters in the right case.
  ignorePaths,: | If set to true, files in the added archive can be accessed without its complete path.
  archiveType,: | If no specific E_FILE_ARCHIVE_TYPE is selected then the type of archive will depend on the extension of the file name. If you use a different extension then you can use this parameter to force a specific type of archive.
  password | An optional password, which is used in case of encrypted archives.
  retArchive | A pointer that will be set to the archive that is added.

Returns:
  True if the archive was added successfully, false if not.

virtual bool irr::io::IFileSystem::addFileArchive | ( | IFileArchive * | archive | ) | `[pure virtual]`

Adds an archive to the file system.

Parameters:

  archive,: | The archive to add to the file system.

Returns:
  True if the archive was added successfully, false if not.

virtual _IRR_DEPRECATED_ bool irr::io::IFileSystem::addFolderFileArchive | ( | const c8 * | filename,
|  | bool | ignoreCase = `true`,
|  | bool | ignorePaths = `true`
| ) |  | `[inline, virtual]`

Adds an unzipped archive (or basedirectory with subdirectories..) to the file system.

Deprecated:
  This function is provided for compatibility with older versions of Irrlicht and may be removed in Irrlicht 1.9, you should use addFileArchive instead. Useful for handling data which will be in a zip file

Parameters:

  filename,: | Filename of the unzipped zip archive base directory to add to the file system.
  ignoreCase,: | If set to true, files in the archive can be accessed without writing all letters in the right case.
  ignorePaths,: | If set to true, files in the added archive can be accessed without its complete path.

Returns:
  True if the archive was added successful, false if not.

Definition at line 244 of file IFileSystem.h.

References addFileArchive(), and irr::io::EFAT_FOLDER.

virtual _IRR_DEPRECATED_ bool irr::io::IFileSystem::addPakFileArchive | ( | const c8 * | filename,
|  | bool | ignoreCase = `true`,
|  | bool | ignorePaths = `true`
| ) |  | `[inline, virtual]`

Adds a pak archive to the file system.

Deprecated:
  This function is provided for compatibility with older versions of Irrlicht and may be removed in Irrlicht 1.9, you should use addFileArchive instead. After calling this, the Irrlicht Engine will search and open files directly from this archive too. This is useful for hiding data from the end user, speeding up file access and making it possible to access for example Quake2/KingPin/Hexen2 .pak files

Parameters:

  filename,: | Filename of the pak archive to add to the file system.
  ignoreCase,: | If set to true, files in the archive can be accessed without writing all letters in the right case.
  ignorePaths,: | If set to true, files in the added archive can be accessed without its complete path.(should not use with Quake2 paks

Returns:
  True if the archive was added successful, false if not.

Definition at line 262 of file IFileSystem.h.

References addFileArchive(), and irr::io::EFAT_PAK.

virtual _IRR_DEPRECATED_ bool irr::io::IFileSystem::addZipFileArchive | ( | const c8 * | filename,
|  | bool | ignoreCase = `true`,
|  | bool | ignorePaths = `true`
| ) |  | `[inline, virtual]`

Adds a zip archive to the file system.

Deprecated:
  This function is provided for compatibility with older versions of Irrlicht and may be removed in Irrlicht 1.9, you should use addFileArchive instead. After calling this, the Irrlicht Engine will search and open files directly from this archive too. This is useful for hiding data from the end user, speeding up file access and making it possible to access for example Quake3 .pk3 files, which are no different than .zip files.

Parameters:

  filename,: | Filename of the zip archive to add to the file system.
  ignoreCase,: | If set to true, files in the archive can be accessed without writing all letters in the right case.
  ignorePaths,: | If set to true, files in the added archive can be accessed without its complete path.

Returns:
  True if the archive was added successfully, false if not.

Definition at line 228 of file IFileSystem.h.

References addFileArchive(), and irr::io::EFAT_ZIP.

virtual bool irr::io::IFileSystem::changeWorkingDirectoryTo | ( | const path & | newDirectory | ) | `[pure virtual]`

Changes the current working directory.

Parameters:

  newDirectory,: | A string specifying the new working directory. The string is operating system dependent. Under Windows it has the form "<drive>:\<directory>\<sudirectory>\<..>". An example would be: "C:\Windows\"

Returns:
  True if successful, otherwise false.

virtual IReadFile* irr::io::IFileSystem::createAndOpenFile | ( | const path & | filename | ) | `[pure virtual]`

Opens a file for read access.

Parameters:

  filename,: | Name of file to open.

Returns:
  Pointer to the created file interface. The returned pointer should be dropped when no longer needed. See IReferenceCounted::drop() for more information.

virtual IWriteFile* irr::io::IFileSystem::createAndWriteFile | ( | const path & | filename,
|  | bool | append = `false`
| ) |  | `[pure virtual]`

Opens a file for write access.

Parameters:

  filename,: | Name of file to open.
  append,: | If the file already exist, all write operations are appended to the file.

Returns:
  Pointer to the created file interface. 0 is returned, if the file could not created or opened for writing. The returned pointer should be dropped when no longer needed. See IReferenceCounted::drop() for more information.

virtual IAttributes* irr::io::IFileSystem::createEmptyAttributes | ( | video::IVideoDriver * | driver = `0` | ) | `[pure virtual]`

Creates a new empty collection of attributes, usable for serialization and more.

Parameters:

  driver,: | Video driver to be used to load textures when specified as attribute values. Can be null to prevent automatic texture loading by attributes.

Returns:
  Pointer to the created object. If you no longer need the object, you should call IAttributes::drop(). See IReferenceCounted::drop() for more information.

virtual IFileList* irr::io::IFileSystem::createEmptyFileList | ( | const io::path & | path,
|  | bool | ignoreCase,
|  | bool | ignorePaths
| ) |  | `[pure virtual]`

Creates an empty filelist.

Returns:
  a Pointer to the created IFileList is returned. After the list has been used it has to be deleted using its IFileList::drop() method. See IReferenceCounted::drop() for more information.

virtual IFileList* irr::io::IFileSystem::createFileList | ( |  | ) | `[pure virtual]`

Creates a list of files and directories in the current working directory and returns it.

Returns:
  a Pointer to the created IFileList is returned. After the list has been used it has to be deleted using its IFileList::drop() method. See IReferenceCounted::drop() for more information.

virtual IReadFile* irr::io::IFileSystem::createLimitReadFile | ( | const path & | fileName,
|  | IReadFile * | alreadyOpenedFile,
|  | long | pos,
|  | long | areaSize
| ) |  | `[pure virtual]`

Creates an IReadFile interface for accessing files inside files.

This is useful e.g. for archives.

Parameters:

  fileName,: | The name given to this file
  alreadyOpenedFile,: | Pointer to the enclosing file
  pos,: | Start of the file inside alreadyOpenedFile
  areaSize,: | The length of the file

Returns:
  A pointer to the created file interface. The returned pointer should be dropped when no longer needed. See IReferenceCounted::drop() for more information.

virtual IReadFile* irr::io::IFileSystem::createMemoryReadFile | ( | void * | memory,
|  | s32 | len,
|  | const path & | fileName,
|  | bool | deleteMemoryWhenDropped = `false`
| ) |  | `[pure virtual]`

Creates an IReadFile interface for accessing memory like a file.

This allows you to use a pointer to memory where an IReadFile is requested.

Parameters:

  memory,: | A pointer to the start of the file in memory
  len,: | The length of the memory in bytes
  fileName,: | The name given to this file
  deleteMemoryWhenDropped,: | True if the memory should be deleted along with the IReadFile when it is dropped.

Returns:
  Pointer to the created file interface. The returned pointer should be dropped when no longer needed. See IReferenceCounted::drop() for more information.

virtual IWriteFile* irr::io::IFileSystem::createMemoryWriteFile | ( | void * | memory,
|  | s32 | len,
|  | const path & | fileName,
|  | bool | deleteMemoryWhenDropped = `false`
| ) |  | `[pure virtual]`

Creates an IWriteFile interface for accessing memory like a file.

This allows you to use a pointer to memory where an IWriteFile is requested. You are responsible for allocating enough memory.

Parameters:

  memory,: | A pointer to the start of the file in memory (allocated by you)
  len,: | The length of the memory in bytes
  fileName,: | The name given to this file
  deleteMemoryWhenDropped,: | True if the memory should be deleted along with the IWriteFile when it is dropped.

Returns:
  Pointer to the created file interface. The returned pointer should be dropped when no longer needed. See IReferenceCounted::drop() for more information.

virtual IXMLReader* irr::io::IFileSystem::createXMLReader | ( | const path & | filename | ) | `[pure virtual]`

Creates a XML Reader from a file which returns all parsed strings as wide characters (wchar_t*).

Use createXMLReaderUTF8() if you prefer char* instead of wchar_t*. See IIrrXMLReader for more information on how to use the parser.

Returns:
  0, if file could not be opened, otherwise a pointer to the created IXMLReader is returned. After use, the reader has to be deleted using its IXMLReader::drop() method. See IReferenceCounted::drop() for more information.

virtual IXMLReader* irr::io::IFileSystem::createXMLReader | ( | IReadFile * | file | ) | `[pure virtual]`

Creates a XML Reader from a file which returns all parsed strings as wide characters (wchar_t*).

Use createXMLReaderUTF8() if you prefer char* instead of wchar_t*. See IIrrXMLReader for more information on how to use the parser.

Returns:
  0, if file could not be opened, otherwise a pointer to the created IXMLReader is returned. After use, the reader has to be deleted using its IXMLReader::drop() method. See IReferenceCounted::drop() for more information.

virtual IXMLReaderUTF8* irr::io::IFileSystem::createXMLReaderUTF8 | ( | const path & | filename | ) | `[pure virtual]`

Creates a XML Reader from a file which returns all parsed strings as ASCII/UTF-8 characters (char*).

Use createXMLReader() if you prefer wchar_t* instead of char*. See IIrrXMLReader for more information on how to use the parser.

Returns:
  0, if file could not be opened, otherwise a pointer to the created IXMLReader is returned. After use, the reader has to be deleted using its IXMLReaderUTF8::drop() method. See IReferenceCounted::drop() for more information.

virtual IXMLReaderUTF8* irr::io::IFileSystem::createXMLReaderUTF8 | ( | IReadFile * | file | ) | `[pure virtual]`

Creates a XML Reader from a file which returns all parsed strings as ASCII/UTF-8 characters (char*).

Use createXMLReader() if you prefer wchar_t* instead of char*. See IIrrXMLReader for more information on how to use the parser.

Returns:
  0, if file could not be opened, otherwise a pointer to the created IXMLReader is returned. After use, the reader has to be deleted using its IXMLReaderUTF8::drop() method. See IReferenceCounted::drop() for more information.

virtual IXMLWriter* irr::io::IFileSystem::createXMLWriter | ( | const path & | filename | ) | `[pure virtual]`

Creates a XML Writer from a file.

Returns:
  0, if file could not be opened, otherwise a pointer to the created IXMLWriter is returned. After use, the reader has to be deleted using its IXMLWriter::drop() method. See IReferenceCounted::drop() for more information.

virtual IXMLWriter* irr::io::IFileSystem::createXMLWriter | ( | IWriteFile * | file | ) | `[pure virtual]`

Creates a XML Writer from a file.

Returns:
  0, if file could not be opened, otherwise a pointer to the created IXMLWriter is returned. After use, the reader has to be deleted using its IXMLWriter::drop() method. See IReferenceCounted::drop() for more information.

virtual bool irr::io::IFileSystem::existFile | ( | const path & | filename | ) | const`[pure virtual]`

Determines if a file exists and could be opened.

Parameters:

  filename | is the string identifying the file which should be tested for existence.

Returns:
  True if file exists, and false if it does not exist or an error occured.

Referenced by irr::scene::quake3::getTextures().

virtual path& irr::io::IFileSystem::flattenFilename | ( | path & | directory,
|  | const path & | root = `"/"`
| ) |  | const`[pure virtual]`

flatten a path and file name for example: "/you/me/../." becomes "/you"

virtual path irr::io::IFileSystem::getAbsolutePath | ( | const path & | filename | ) | const`[pure virtual]`

Converts a relative path to an absolute (unique) path, resolving symbolic links if required.

Parameters:

  filename | Possibly relative file or directory name to query.

Returns:
  Absolute filename which points to the same file.

virtual IArchiveLoader* irr::io::IFileSystem::getArchiveLoader | ( | u32 | index | ) | const`[pure virtual]`

Retrieve the given archive loader.

Parameters:

  index | The index of the loader to retrieve. This parameter is an 0-based array index.

Returns:
  A pointer to the specified loader, 0 if the index is incorrect.

virtual u32 irr::io::IFileSystem::getArchiveLoaderCount | ( |  | ) | const`[pure virtual]`

Gets the number of archive loaders currently added.

virtual IFileArchive* irr::io::IFileSystem::getFileArchive | ( | u32 | index | ) | `[pure virtual]`

Get the archive at a given index.

virtual u32 irr::io::IFileSystem::getFileArchiveCount | ( |  | ) | const`[pure virtual]`

Get the number of archives currently attached to the file system.

virtual path irr::io::IFileSystem::getFileBasename | ( | const path & | filename,
|  | bool | keepExtension = `true`
| ) |  | const`[pure virtual]`

Get the base part of a filename, i.e. the name without the directory part.

If no directory is prefixed, the full name is returned.

Parameters:

  filename,: | The file to get the basename from
  keepExtension | True if filename with extension is returned otherwise everything after the final '.' is removed as well.

virtual path irr::io::IFileSystem::getFileDir | ( | const path & | filename | ) | const`[pure virtual]`

Get the directory a file is located in.

Parameters:

  filename,: | The file to get the directory from.

Returns:
  String containing the directory of the file.

virtual path irr::io::IFileSystem::getRelativeFilename | ( | const path & | filename,
|  | const path & | directory
| ) |  | const`[pure virtual]`

Get the relative filename, relative to the given directory.

virtual const path& irr::io::IFileSystem::getWorkingDirectory | ( |  | ) | `[pure virtual]`

Get the current working directory.

Returns:
  Current working directory as a string.

virtual bool irr::io::IFileSystem::moveFileArchive | ( | u32 | sourceIndex,
|  | s32 | relative
| ) |  | `[pure virtual]`

Changes the search order of attached archives.

Parameters:

  sourceIndex,: | The index of the archive to change
  relative,: | The relative change in position, archives with a lower index are searched first

virtual bool irr::io::IFileSystem::removeFileArchive | ( | u32 | index | ) | `[pure virtual]`

Removes an archive from the file system.

This will close the archive and free any file handles, but will not close resources which have already been loaded and are now cached, for example textures and meshes.

Parameters:

  index,: | The index of the archive to remove

Returns:
  True on success, false on failure

virtual bool irr::io::IFileSystem::removeFileArchive | ( | const path & | filename | ) | `[pure virtual]`

Removes an archive from the file system.

This will close the archive and free any file handles, but will not close resources which have already been loaded and are now cached, for example textures and meshes. Note that a relative filename might be interpreted differently on each call, depending on the current working directory. In case you want to remove an archive that was added using a relative path name, you have to change to the same working directory again. This means, that the filename given on creation is not an identifier for the archive, but just a usual filename that is used for locating the archive to work with.

Parameters:

  filename | The archive pointed to by the name will be removed

Returns:
  True on success, false on failure

virtual bool irr::io::IFileSystem::removeFileArchive | ( | const IFileArchive * | archive | ) | `[pure virtual]`

Removes an archive from the file system.

This will close the archive and free any file handles, but will not close resources which have already been loaded and are now cached, for example textures and meshes.

Parameters:

  archive | The archive to remove.

Returns:
  True on success, false on failure

virtual EFileSystemType irr::io::IFileSystem::setFileListSystem | ( | EFileSystemType | listType | ) | `[pure virtual]`

Set the active type of file system.

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

- IFileSystem.h