1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
|
// Copyright (C) 2002-2012 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in irrlicht.h
#ifndef __I_XML_WRITER_H_INCLUDED__
#define __I_XML_WRITER_H_INCLUDED__
#include "IReferenceCounted.h"
#include "irrArray.h"
#include "irrString.h"
namespace irr
{
namespace io
{
//! Interface providing methods for making it easier to write XML files.
/** This XML Writer writes xml files using in the platform dependent
wchar_t format and sets the xml-encoding correspondingly. */
class IXMLWriter : public virtual IReferenceCounted
{
public:
//! Writes an xml 1.0 header.
/** Looks like <?xml version="1.0"?>. This should always
be called before writing anything other, because also the text
file header for unicode texts is written out with this method. */
virtual void writeXMLHeader() = 0;
//! Writes an xml element with maximal 5 attributes like "<foo />" or
//! <foo optAttr="value" />.
/** The element can be empty or not.
\param name: Name of the element
\param empty: Specifies if the element should be empty. Like
"<foo />". If You set this to false, something like this is
written instead: "<foo>".
\param attr1Name: 1st attributes name
\param attr1Value: 1st attributes value
\param attr2Name: 2nd attributes name
\param attr2Value: 2nd attributes value
\param attr3Name: 3rd attributes name
\param attr3Value: 3rd attributes value
\param attr4Name: 4th attributes name
\param attr4Value: 4th attributes value
\param attr5Name: 5th attributes name
\param attr5Value: 5th attributes value */
virtual void writeElement(const wchar_t* name, bool empty=false,
const wchar_t* attr1Name = 0, const wchar_t* attr1Value = 0,
const wchar_t* attr2Name = 0, const wchar_t* attr2Value = 0,
const wchar_t* attr3Name = 0, const wchar_t* attr3Value = 0,
const wchar_t* attr4Name = 0, const wchar_t* attr4Value = 0,
const wchar_t* attr5Name = 0, const wchar_t* attr5Value = 0) = 0;
//! Writes an xml element with any number of attributes
virtual void writeElement(const wchar_t* name, bool empty,
core::array<core::stringw> &names, core::array<core::stringw> &values) = 0;
//! Writes a comment into the xml file
virtual void writeComment(const wchar_t* comment) = 0;
//! Writes the closing tag for an element. Like "</foo>"
virtual void writeClosingTag(const wchar_t* name) = 0;
//! Writes a text into the file.
/** All occurrences of special characters such as
& (&), < (<), > (>), and " (") are automaticly
replaced. */
virtual void writeText(const wchar_t* text) = 0;
//! Writes a line break
virtual void writeLineBreak() = 0;
};
} // end namespace io
} // end namespace irr
#endif
|
