Irrlicht 3D Engine
irrXML.h
Go to the documentation of this file.
1 // Copyright (C) 2002-2012 Nikolaus Gebhardt
2 // This file is part of the "Irrlicht Engine" and the "irrXML" project.
3 // For conditions of distribution and use, see copyright notice in irrlicht.h and/or irrXML.h
4 
5 #ifndef __IRR_XML_H_INCLUDED__
6 #define __IRR_XML_H_INCLUDED__
7 
8 #include <stdio.h>
9 #include "IrrCompileConfig.h"
10 
153 namespace irr
154 {
155 namespace io
156 {
159  {
162 
165 
168 
171 
174 
177  };
178 
179 
182  {
185 
188 
191 
195 
198 
201 
204  };
205 
207 
215  {
216  public:
217 
219  virtual ~IFileReadCallBack() {}
220 
222 
225  virtual int read(void* buffer, int sizeToRead) = 0;
226 
228  virtual long getSize() const = 0;
229  };
230 
232 
237  class IXMLBase
238  {
239  };
240 
242 
274  template<class char_type, class super_class>
275  class IIrrXMLReader : public super_class
276  {
277  public:
278 
280  virtual ~IIrrXMLReader() {}
281 
283 
284  virtual bool read() = 0;
285 
287  virtual EXML_NODE getNodeType() const = 0;
288 
290 
293  virtual unsigned int getAttributeCount() const = 0;
294 
296 
298  virtual const char_type* getAttributeName(int idx) const = 0;
299 
301 
303  virtual const char_type* getAttributeValue(int idx) const = 0;
304 
306 
308  virtual const char_type* getAttributeValue(const char_type* name) const = 0;
309 
311 
315  virtual const char_type* getAttributeValueSafe(const char_type* name) const = 0;
316 
318 
321  virtual int getAttributeValueAsInt(const char_type* name) const = 0;
322 
324 
327  virtual int getAttributeValueAsInt(int idx) const = 0;
328 
330 
333  virtual float getAttributeValueAsFloat(const char_type* name) const = 0;
334 
336 
339  virtual float getAttributeValueAsFloat(int idx) const = 0;
340 
342 
344  virtual const char_type* getNodeName() const = 0;
345 
347 
349  virtual const char_type* getNodeData() const = 0;
350 
352  virtual bool isEmptyElement() const = 0;
353 
355 
359  virtual ETEXT_FORMAT getSourceFormat() const = 0;
360 
362 
366  virtual ETEXT_FORMAT getParserFormat() const = 0;
367  };
368 
369 
370  template <typename T>
371  struct xmlChar
372  {
373  T c;
375  xmlChar<T>(char in) : c(static_cast<T>(in)) {}
376  xmlChar<T>(wchar_t in) : c(static_cast<T>(in)) {}
377 #if defined(__BORLANDC__)
378  // Note - removing explicit for borland was to get it to even compile.
379  // There haven't been any kind of tests for that besides that.
380  xmlChar<T>(unsigned char in) : c(static_cast<T>(in)) {}
381  xmlChar<T>(unsigned short in) : c(static_cast<T>(in)) {}
382  xmlChar<T>(unsigned int in) : c(static_cast<T>(in)) {}
383  xmlChar<T>(unsigned long in) : c(static_cast<T>(in)) {}
384 #else
385  explicit xmlChar<T>(unsigned char in) : c(static_cast<T>(in)) {}
386  explicit xmlChar<T>(unsigned short in) : c(static_cast<T>(in)) {}
387  explicit xmlChar<T>(unsigned int in) : c(static_cast<T>(in)) {}
388  explicit xmlChar<T>(unsigned long in) : c(static_cast<T>(in)) {}
389 #endif
390  operator T() const { return c; }
391  void operator=(int t) { c=static_cast<T>(t); }
392  };
393 
395 
398 
400 
403 
405 
411 
413 
419 
421 
427 
428 
430 
439 
441 
451 
453 
466  bool deleteCallback = false);
467 
469 
479 
481 
491 
493 
506  bool deleteCallback = false);
507 
508 
510 
519 
521 
531 
533 
547  bool deleteCallback = false);
548 
549 
571 } // end namespace io
572 } // end namespace irr
573 
574 #endif // __IRR_XML_H_INCLUDED__
575 
irr::io::ETEXT_FORMAT
ETEXT_FORMAT
Enumeration of all supported source text file formats.
Definition: irrXML.h:158
irr::io::ETF_UTF8
@ ETF_UTF8
UTF-8 format.
Definition: irrXML.h:164
irr::io::IIrrXMLReader::getNodeName
virtual const char_type * getNodeName() const =0
Returns the name of the current node.
irr::io::IrrXMLReaderUTF16
IIrrXMLReader< char16, IXMLBase > IrrXMLReaderUTF16
A UTF-16 xml parser.
Definition: irrXML.h:418
irr::io::xmlChar::c
T c
Definition: irrXML.h:373
irr::io::xmlChar
Definition: irrXML.h:371
IRRLICHT_API
#define IRRLICHT_API
Set FPU settings.
Definition: IrrCompileConfig.h:705
irr::io::IIrrXMLReader::getAttributeValueSafe
virtual const char_type * getAttributeValueSafe(const char_type *name) const =0
Returns the value of an attribute in a safe way.
irr::io::EXN_ELEMENT_END
@ EXN_ELEMENT_END
End of an xml element such as </foo>.
Definition: irrXML.h:190
irr::io::EXN_COMMENT
@ EXN_COMMENT
An xml comment like <!– I am a comment –> or a DTD definition.
Definition: irrXML.h:197
irr::io::IIrrXMLReader::getAttributeName
virtual const char_type * getAttributeName(int idx) const =0
Returns name of an attribute.
irr::io::IIrrXMLReader::getAttributeCount
virtual unsigned int getAttributeCount() const =0
Returns attribute count of the current XML node.
irr::io::char16
xmlChar< unsigned short > char16
defines the utf-16 type.
Definition: irrXML.h:397
irr::io::IIrrXMLReader::getAttributeValueAsInt
virtual int getAttributeValueAsInt(const char_type *name) const =0
Returns the value of an attribute as integer.
IrrCompileConfig.h
irr::io::EXN_ELEMENT
@ EXN_ELEMENT
An xml element such as <foo>.
Definition: irrXML.h:187
irr::io::createIrrXMLReaderUTF32
IRRLICHT_API IrrXMLReaderUTF32 *IRRCALLCONV createIrrXMLReaderUTF32(const char *filename)
Creates an instance of an UFT-32 xml parser.
irr::io::ETF_UTF16_BE
@ ETF_UTF16_BE
UTF-16 format, big endian.
Definition: irrXML.h:167
irr::io::ETF_UTF16_LE
@ ETF_UTF16_LE
UTF-16 format, little endian.
Definition: irrXML.h:170
irr::io::IrrXMLReaderUTF32
IIrrXMLReader< char32, IXMLBase > IrrXMLReaderUTF32
A UTF-32 xml parser.
Definition: irrXML.h:426
irr::io::IIrrXMLReader::getNodeData
virtual const char_type * getNodeData() const =0
Returns data of the current node.
irr::io::IIrrXMLReader::~IIrrXMLReader
virtual ~IIrrXMLReader()
Destructor.
Definition: irrXML.h:280
irr::io::EXN_CDATA
@ EXN_CDATA
An xml cdata section like <![CDATA[ this is some CDATA ]]>.
Definition: irrXML.h:200
irr::io::EXN_UNKNOWN
@ EXN_UNKNOWN
Unknown element.
Definition: irrXML.h:203
irr::io::IIrrXMLReader::read
virtual bool read()=0
Reads forward to the next xml node.
irr::io::createIrrXMLReader
IRRLICHT_API IrrXMLReader *IRRCALLCONV createIrrXMLReader(const char *filename)
Creates an instance of an UFT-8 or ASCII character xml parser.
irr::io::IIrrXMLReader::getAttributeValueAsFloat
virtual float getAttributeValueAsFloat(const char_type *name) const =0
Returns the value of an attribute as float.
irr::io::IFileReadCallBack::read
virtual int read(void *buffer, int sizeToRead)=0
Reads an amount of bytes from the file.
irr::io::ETF_UTF32_BE
@ ETF_UTF32_BE
UTF-32 format, big endian.
Definition: irrXML.h:173
irr::io::IXMLBase
Empty class to be used as parent class for IrrXMLReader.
Definition: irrXML.h:237
irr::io::EXN_NONE
@ EXN_NONE
No xml node. This is usually the node if you did not read anything yet.
Definition: irrXML.h:184
irr::io::IFileReadCallBack
Callback class for file read abstraction.
Definition: irrXML.h:214
irr::io::IIrrXMLReader::getNodeType
virtual EXML_NODE getNodeType() const =0
Returns the type of the current XML node.
irr::io::xmlChar::operator=
void operator=(int t)
Definition: irrXML.h:391
irr::io::IFileReadCallBack::~IFileReadCallBack
virtual ~IFileReadCallBack()
Destructor.
Definition: irrXML.h:219
irr::io::IIrrXMLReader::getSourceFormat
virtual ETEXT_FORMAT getSourceFormat() const =0
Returns format of the source xml file.
IRRCALLCONV
#define IRRCALLCONV
Definition: IrrCompileConfig.h:708
irr::io::IIrrXMLReader::getParserFormat
virtual ETEXT_FORMAT getParserFormat() const =0
Returns format of the strings returned by the parser.
irr::io::char32
xmlChar< unsigned int > char32
defines the utf-32 type.
Definition: irrXML.h:402
irr::io::createIrrXMLReaderUTF16
IRRLICHT_API IrrXMLReaderUTF16 *IRRCALLCONV createIrrXMLReaderUTF16(const char *filename)
Creates an instance of an UFT-16 xml parser.
irr::io::ETF_UTF32_LE
@ ETF_UTF32_LE
UTF-32 format, little endian.
Definition: irrXML.h:176
irr
Everything in the Irrlicht Engine can be found in this namespace.
Definition: aabbox3d.h:12
irr::io::IIrrXMLReader::isEmptyElement
virtual bool isEmptyElement() const =0
Returns if an element is an empty element, like <foo />
irr::io::ETF_ASCII
@ ETF_ASCII
ASCII, file without byte order mark, or not a text file.
Definition: irrXML.h:161
irr::io::IIrrXMLReader::getAttributeValue
virtual const char_type * getAttributeValue(int idx) const =0
Returns the value of an attribute.
irr::io::IFileReadCallBack::getSize
virtual long getSize() const =0
Returns size of file in bytes.
irr::io::EXN_TEXT
@ EXN_TEXT
Definition: irrXML.h:194
irr::io::IIrrXMLReader
Interface providing easy read access to a XML file.
Definition: irrXML.h:275
irr::io::EXML_NODE
EXML_NODE
Enumeration for all xml nodes which are parsed by IrrXMLReader.
Definition: irrXML.h:181
irr::io::IrrXMLReader
IIrrXMLReader< char, IXMLBase > IrrXMLReader
A UTF-8 or ASCII character xml parser.
Definition: irrXML.h:410