arsa
2.7
|
This namespace provides interfaces for input/output: Reading and writing files, accessing zip archives, xml files, ... More...
Classes | |
class | IArchiveLoader |
Class which is able to create an archive from a file. More... | |
class | IAttributeExchangingObject |
An object which is able to serialize and deserialize its attributes into an attributes object. More... | |
class | IAttributes |
Provides a generic interface for attributes and their values and the possibility to serialize them. More... | |
class | IFileArchive |
The FileArchive manages archives and provides access to files inside them. More... | |
class | IFileList |
Provides a list of files and folders. More... | |
class | IFileReadCallBack |
Callback class for file read abstraction. More... | |
class | IFileSystem |
The FileSystem manages files and archives and provides access to them. More... | |
class | IIrrXMLReader |
Interface providing easy read access to a XML file. More... | |
class | IIrrXMLWriter |
Interface providing methods for making it easier to write XML files. More... | |
class | IMemoryReadFile |
Interface providing read access to a memory read file. More... | |
class | IReadFile |
Interface providing read access to a file. More... | |
class | IWriteFile |
Interface providing write access to a file. More... | |
class | IXMLBase |
Empty class to be used as parent class for IrrXMLReader. More... | |
struct | SAttributeReadWriteOptions |
struct holding data describing options More... | |
struct | SNamedPath |
Used in places where we identify objects by a filename, but don't actually work with the real filename. More... | |
struct | xmlChar |
Typedefs | |
typedef xmlChar< unsigned short > | char16 |
defines the utf-16 type. More... | |
typedef xmlChar< unsigned int > | char32 |
defines the utf-32 type. More... | |
typedef IIrrXMLReader< char, IXMLBase > | IrrXMLReader |
A UTF-8 or ASCII character xml parser. More... | |
typedef IIrrXMLReader< char16, IXMLBase > | IrrXMLReaderUTF16 |
A UTF-16 xml parser. More... | |
typedef IIrrXMLReader< char32, IXMLBase > | IrrXMLReaderUTF32 |
A UTF-32 xml parser. More... | |
typedef IIrrXMLReader< wchar_t, IReferenceCounted > | IXMLReader |
An xml reader for wide characters, derived from IReferenceCounted. More... | |
typedef IIrrXMLReader< c8, IReferenceCounted > | IXMLReaderUTF8 |
An xml reader for ASCII or UTF-8 characters, derived from IReferenceCounted. More... | |
typedef IIrrXMLWriter< wchar_t, IReferenceCounted > | IXMLWriter |
An xml writer for wide characters, derived from IReferenceCounted. More... | |
typedef IIrrXMLWriter< c8, IReferenceCounted > | IXMLWriterUTF8 |
An xml writer for ASCII or UTF-8 characters, derived from IReferenceCounted. More... | |
typedef core::string< fschar_t > | path |
Type used for all file system related strings. More... | |
Enumerations | |
enum | E_ATTRIBUTE_TYPE { EAT_INT = 0, EAT_FLOAT, EAT_STRING, EAT_BOOL, EAT_ENUM, EAT_COLOR, EAT_COLORF, EAT_VECTOR3D, EAT_POSITION2D, EAT_VECTOR2D, EAT_RECT, EAT_MATRIX, EAT_QUATERNION, EAT_BBOX, EAT_PLANE, EAT_TRIANGLE3D, EAT_LINE2D, EAT_LINE3D, EAT_STRINGWARRAY, EAT_FLOATARRAY, EAT_INTARRAY, EAT_BINARY, EAT_TEXTURE, EAT_USER_POINTER, EAT_DIMENSION2D, EAT_COUNT, EAT_UNKNOWN } |
Types of attributes available for IAttributes. More... | |
enum | EREAD_FILE_TYPE { ERFT_READ_FILE = MAKE_IRR_ID('r','e','a','d'), ERFT_MEMORY_READ_FILE = MAKE_IRR_ID('r','m','e','m'), ERFT_LIMIT_READ_FILE = MAKE_IRR_ID('r','l','i','m'), EFIT_UNKNOWN = MAKE_IRR_ID('u','n','k','n') } |
An enumeration for different class types implementing IReadFile. More... | |
enum | E_ATTRIBUTE_READ_WRITE_FLAGS { EARWF_FOR_FILE = 0x00000001, EARWF_FOR_EDITOR = 0x00000002, EARWF_USE_RELATIVE_PATHS = 0x00000004 } |
Enumeration flags passed through SAttributeReadWriteOptions to the IAttributeExchangingObject object. More... | |
enum | EFileSystemType { FILESYSTEM_NATIVE = 0, FILESYSTEM_VIRTUAL } |
FileSystemType: which filesystem should be used for e.g. browsing. More... | |
enum | E_FILE_ARCHIVE_TYPE { EFAT_ZIP = MAKE_IRR_ID('Z','I','P', 0), EFAT_GZIP = MAKE_IRR_ID('g','z','i','p'), EFAT_FOLDER = MAKE_IRR_ID('f','l','d','r'), EFAT_PAK = MAKE_IRR_ID('P','A','K', 0), EFAT_NPK = MAKE_IRR_ID('N','P','K', 0), EFAT_TAR = MAKE_IRR_ID('T','A','R', 0), EFAT_WAD = MAKE_IRR_ID('W','A','D', 0), EFAT_ANDROID_ASSET = MAKE_IRR_ID('A','S','S','E'), EFAT_UNKNOWN = MAKE_IRR_ID('u','n','k','n') } |
Contains the different types of archives. More... | |
enum | ETEXT_FORMAT { ETF_ASCII, ETF_UTF8, ETF_UTF16_BE, ETF_UTF16_LE, ETF_UTF32_BE, ETF_UTF32_LE } |
Enumeration of all supported source text file formats. More... | |
enum | EXML_NODE { EXN_NONE, EXN_ELEMENT, EXN_ELEMENT_END, EXN_TEXT, EXN_COMMENT, EXN_CDATA, EXN_UNKNOWN } |
Enumeration for all xml nodes which are parsed by IrrXMLReader. More... | |
Functions | |
IReadFile * | createLimitReadFile (const io::path &fileName, IReadFile *alreadyOpenedFile, long pos, long areaSize) |
Internal function, please do not use. More... | |
IRRLICHT_API IrrXMLReader *IRRCALLCONV | createIrrXMLReader (const char *filename) |
Creates an instance of an UFT-8 or ASCII character xml parser. More... | |
IRRLICHT_API IrrXMLReader *IRRCALLCONV | createIrrXMLReader (FILE *file) |
Creates an instance of an UFT-8 or ASCII character xml parser. More... | |
IRRLICHT_API IrrXMLReader *IRRCALLCONV | createIrrXMLReader (IFileReadCallBack *callback, bool deleteCallback=false) |
Creates an instance of an UFT-8 or ASCII character xml parser. More... | |
IRRLICHT_API IrrXMLReaderUTF16 *IRRCALLCONV | createIrrXMLReaderUTF16 (const char *filename) |
Creates an instance of an UFT-16 xml parser. More... | |
IRRLICHT_API IrrXMLReaderUTF16 *IRRCALLCONV | createIrrXMLReaderUTF16 (FILE *file) |
Creates an instance of an UFT-16 xml parser. More... | |
IRRLICHT_API IrrXMLReaderUTF16 *IRRCALLCONV | createIrrXMLReaderUTF16 (IFileReadCallBack *callback, bool deleteCallback=false) |
Creates an instance of an UFT-16 xml parser. More... | |
IRRLICHT_API IrrXMLReaderUTF32 *IRRCALLCONV | createIrrXMLReaderUTF32 (const char *filename) |
Creates an instance of an UFT-32 xml parser. More... | |
IRRLICHT_API IrrXMLReaderUTF32 *IRRCALLCONV | createIrrXMLReaderUTF32 (FILE *file) |
Creates an instance of an UFT-32 xml parser. More... | |
IRRLICHT_API IrrXMLReaderUTF32 *IRRCALLCONV | createIrrXMLReaderUTF32 (IFileReadCallBack *callback, bool deleteCallback=false) |
Creates an instance of an UFT-32 xml parser. More... | |
This namespace provides interfaces for input/output: Reading and writing files, accessing zip archives, xml files, ...
typedef xmlChar<unsigned short> irr::io::char16 |
typedef xmlChar<unsigned int> irr::io::char32 |
typedef IIrrXMLReader<char, IXMLBase> irr::io::IrrXMLReader |
A UTF-8 or ASCII character xml parser.
This means that all character data will be returned in 8 bit ASCII or UTF-8 by this parser. The file to read can be in any format, it will be converted to UTF-8 if it is not in this format. Create an instance of this with createIrrXMLReader(); See IIrrXMLReader for description on how to use it.
A UTF-16 xml parser.
This means that all character data will be returned in UTF-16 by this parser. The file to read can be in any format, it will be converted to UTF-16 if it is not in this format. Create an instance of this with createIrrXMLReaderUTF16(); See IIrrXMLReader for description on how to use it.
A UTF-32 xml parser.
This means that all character data will be returned in UTF-32 by this parser. The file to read can be in any format, it will be converted to UTF-32 if it is not in this format. Create an instance of this with createIrrXMLReaderUTF32(); See IIrrXMLReader for description on how to use it.
typedef IIrrXMLReader<wchar_t, IReferenceCounted> irr::io::IXMLReader |
An xml reader for wide characters, derived from IReferenceCounted.
This XML Parser can read any type of text files from any source Irrlicht can read. Just call IFileSystem::createXMLReader(). For more information on how to use the parser, see IIrrXMLReader
Definition at line 19 of file IXMLReader.h.
An xml reader for ASCII or UTF-8 characters, derived from IReferenceCounted.
This XML Parser can read any type of text files from any source Irrlicht can read. Just call IFileSystem::createXMLReaderUTF8(). For more information on how to use the parser, see IIrrXMLReader
Definition at line 25 of file IXMLReader.h.
typedef IIrrXMLWriter<wchar_t, IReferenceCounted> irr::io::IXMLWriter |
An xml writer for wide characters, derived from IReferenceCounted.
Call IFileSystem::createXMLReader(). to create an IXMLWriter
Definition at line 17 of file IXMLWriter.h.
An xml writer for ASCII or UTF-8 characters, derived from IReferenceCounted.
Call IFileSystem::createXMLReaderUtf8(). to create an IXMLWriter
Definition at line 21 of file IXMLWriter.h.
typedef core::string<fschar_t> irr::io::path |
Enumeration flags passed through SAttributeReadWriteOptions to the IAttributeExchangingObject object.
Definition at line 20 of file IAttributeExchangingObject.h.
Types of attributes available for IAttributes.
Definition at line 14 of file EAttributes.h.
Contains the different types of archives.
Definition at line 25 of file IFileArchive.h.
FileSystemType: which filesystem should be used for e.g. browsing.
Enumerator | |
---|---|
FILESYSTEM_NATIVE | |
FILESYSTEM_VIRTUAL |
Definition at line 18 of file IFileArchive.h.
An enumeration for different class types implementing IReadFile.
Enumerator | |
---|---|
ERFT_READ_FILE | CReadFile. |
ERFT_MEMORY_READ_FILE | CMemoryReadFile. |
ERFT_LIMIT_READ_FILE | CLimitReadFile. |
EFIT_UNKNOWN | Unknown type. |
Definition at line 16 of file EReadFileType.h.
Enumeration of all supported source text file formats.
Definition at line 160 of file irrXML.h.
enum irr::io::EXML_NODE |
Enumeration for all xml nodes which are parsed by IrrXMLReader.
Definition at line 183 of file irrXML.h.
IRRLICHT_API IrrXMLReader* IRRCALLCONV irr::io::createIrrXMLReader | ( | const char * | filename | ) |
Creates an instance of an UFT-8 or ASCII character xml parser.
This means that all character data will be returned in 8 bit ASCII or UTF-8. The file to read can be in any format, it will be converted to UTF-8 if it is not in this format. If you are using the Irrlicht Engine, it is better not to use this function but IFileSystem::createXMLReaderUTF8() instead.
filename | Name of file to be opened. |
IRRLICHT_API IrrXMLReader* IRRCALLCONV irr::io::createIrrXMLReader | ( | FILE * | file | ) |
Creates an instance of an UFT-8 or ASCII character xml parser.
This means that all character data will be returned in 8 bit ASCII or UTF-8. The file to read can be in any format, it will be converted to UTF-8 if it is not in this format. If you are using the Irrlicht Engine, it is better not to use this function but IFileSystem::createXMLReaderUTF8() instead.
file | Pointer to opened file, must have been opened in binary mode, e.g. using fopen("foo.bar", "wb"); The file will not be closed after it has been read. |
IRRLICHT_API IrrXMLReader* IRRCALLCONV irr::io::createIrrXMLReader | ( | IFileReadCallBack * | callback, |
bool | deleteCallback = false |
||
) |
Creates an instance of an UFT-8 or ASCII character xml parser.
This means that all character data will be returned in 8 bit ASCII or UTF-8. The file to read can be in any format, it will be converted to UTF-8 if it is not in this format. If you are using the Irrlicht Engine, it is better not to use this function but IFileSystem::createXMLReaderUTF8() instead.
callback | Callback for file read abstraction. Implement your own callback to make the xml parser read in other things than just files. See IFileReadCallBack for more information about this. |
deleteCallback | if true, the callback will be deleted after the file has been read. Otherwise the caller is responsible for cleaning it up. |
IRRLICHT_API IrrXMLReaderUTF16* IRRCALLCONV irr::io::createIrrXMLReaderUTF16 | ( | const char * | filename | ) |
Creates an instance of an UFT-16 xml parser.
This means that all character data will be returned in UTF-16. The file to read can be in any format, it will be converted to UTF-16 if it is not in this format. If you are using the Irrlicht Engine, it is better not to use this function but IFileSystem::createXMLReader() instead.
filename | Name of file to be opened. |
IRRLICHT_API IrrXMLReaderUTF16* IRRCALLCONV irr::io::createIrrXMLReaderUTF16 | ( | FILE * | file | ) |
Creates an instance of an UFT-16 xml parser.
This means that all character data will be returned in UTF-16. The file to read can be in any format, it will be converted to UTF-16 if it is not in this format. If you are using the Irrlicht Engine, it is better not to use this function but IFileSystem::createXMLReader() instead.
file | Pointer to opened file, must have been opened in binary mode, e.g. using fopen("foo.bar", "wb"); The file will not be closed after it has been read. |
IRRLICHT_API IrrXMLReaderUTF16* IRRCALLCONV irr::io::createIrrXMLReaderUTF16 | ( | IFileReadCallBack * | callback, |
bool | deleteCallback = false |
||
) |
Creates an instance of an UFT-16 xml parser.
This means that all character data will be returned in UTF-16. The file to read can be in any format, it will be converted to UTF-16 if it is not in this format. If you are using the Irrlicht Engine, it is better not to use this function but IFileSystem::createXMLReader() instead.
callback | Callback for file read abstraction. Implement your own callback to make the xml parser read in other things than just files. See IFileReadCallBack for more information about this. |
deleteCallback | if true, the callback will be deleted after the file has been read. Otherwise the caller is responsible for cleaning it up. |
IRRLICHT_API IrrXMLReaderUTF32* IRRCALLCONV irr::io::createIrrXMLReaderUTF32 | ( | const char * | filename | ) |
Creates an instance of an UFT-32 xml parser.
This means that all character data will be returned in UTF-32. The file to read can be in any format, it will be converted to UTF-32 if it is not in this format. If you are using the Irrlicht Engine, it is better not to use this function but IFileSystem::createXMLReader() instead.
filename | Name of file to be opened. |
IRRLICHT_API IrrXMLReaderUTF32* IRRCALLCONV irr::io::createIrrXMLReaderUTF32 | ( | FILE * | file | ) |
Creates an instance of an UFT-32 xml parser.
This means that all character data will be returned in UTF-32. The file to read can be in any format, it will be converted to UTF-32 if it is not in this format. if you are using the Irrlicht Engine, it is better not to use this function but IFileSystem::createXMLReader() instead.
file | Pointer to opened file, must have been opened in binary mode, e.g. using fopen("foo.bar", "wb"); The file will not be closed after it has been read. |
IRRLICHT_API IrrXMLReaderUTF32* IRRCALLCONV irr::io::createIrrXMLReaderUTF32 | ( | IFileReadCallBack * | callback, |
bool | deleteCallback = false |
||
) |
Creates an instance of an UFT-32 xml parser.
This means that all character data will be returned in UTF-32. The file to read can be in any format, it will be converted to UTF-32 if it is not in this format. If you are using the Irrlicht Engine, it is better not to use this function but IFileSystem::createXMLReader() instead.
callback | Callback for file read abstraction. Implement your own callback to make the xml parser read in other things than just files. See IFileReadCallBack for more information about this. |
deleteCallback | if true, the callback will be deleted after the file has been read. Otherwise the caller is responsible for cleaning it up. |