G3D::XML Class Reference

Easy loading and saving of XML and HTML files. More...

#include <XML.h>

Public Types
enum	Type { VALUE, TAG }
typedef Table< std::string, XML >	AttributeTable

Public Member Functions
	XML ()
	XML (const std::string &v)
	XML (const double &v)
	XML (float v)
	XML (int v)
	XML (Type tagType, const std::string &name, const AttributeTable &at, const Array< XML > &ch=Array< XML >())
	XML (Type tagType, const std::string &name, const Array< XML > &ch=Array< XML >())
	XML (TextInput &t)
void	serialize (TextOutput &t) const
void	deserialize (TextInput &t)
void	load (const std::string &filename)
void	save (const std::string &filename) const
void	parse (const std::string &s)
void	unparse (std::string &s) const
const AttributeTable &	attributeTable () const
const Array< XML > &	childArray () const
int	numChildren () const
size_t	numAttributes () const
const XML &	operator[] (int i) const
const XML &	operator[] (const std::string &k) const
bool	containsAttribute (const std::string &k) const
XML	get (const std::string &k, const XML &defaultVal) const
Type	type () const
const std::string	name () const
const std::string &	string () const
double	number () const
bool	boolean () const
	operator std::string () const
	operator bool () const
	operator double () const
	operator float () const
	operator int () const

Private Attributes
Type	m_type
std::string	m_name
std::string	m_value
AttributeTable	m_attribute
Array< XML >	m_child

Detailed Description

Easy loading and saving of XML and HTML files.

The XML class is intended primarily for interchange with other programs. We recommend using G3D::Any to make your own human-readable formats because it is a more general syntax, the implementation is more efficient, and contains better error handling.

Every XML is either a VALUE, or a TAG that contains both a table of its XML attributes and an array of its children. Children are nested tags and the strings between the nested tags.

No validation is performed, and the XML must be completely legal. XML Entity references (e.g., the ampersand codes for greater than and less than) are not automatically converted.

Tags with names that begin with "!" or "?" are ignored. Comment tags must end with "-->" e.g.,

  <?xml version="1.0" encoding="ISO-8859-1"?>
  <!DOCTYPE note SYSTEM "Note.dtd">

See also

G3D::Any, http://www.grinninglizard.com/tinyxml/

  child0 ...
  ...
  child2 ...

Member Typedef Documentation

typedef Table<std::string, XML> G3D::XML::AttributeTable

Member Enumeration Documentation

enum G3D::XML::Type

Enumerator
VALUE
TAG

{VALUE, TAG};

Constructor & Destructor Documentation

G3D::XML::XML ( )

inline

: m_type(VALUE) {}

G3D::XML::XML ( const std::string &  v )

inline

: m_type(VALUE), m_value(v) {}

G3D::XML::XML ( const double &  v )

inline

: m_type(VALUE), m_value(format("%f", v)) {}

G3D::XML::XML ( float  v )

inline

: m_type(VALUE), m_value(format("%f", v)) {}

G3D::XML::XML ( int  v )

inline

: m_type(VALUE), m_value(format("%d", v)) {}

G3D::XML::XML ( Type  tagType, const std::string &  name, const AttributeTable &  at, const Array< XML > &  ch = Array<XML>()  )

inline

Parameters

tagType

Must be XML::TAG to dismbiguate from the string constructor

 : m_type(TAG), m_name(name), m_attribute(at), m_child(ch) {
 (void)tagType;
 debugAssert(tagType == TAG);
 }

G3D::XML::XML ( Type  tagType, const std::string &  name, const Array< XML > &  ch = Array<XML>()  )

inline

Parameters

tagType

Must be XML::TAG to dismbiguate from the string constructor

 : m_type(TAG), m_name(name), m_child(ch) {
 (void)tagType;
 debugAssert(tagType == TAG);
 }

G3D::XML::XML

(

TextInput &

t

)

 : m_type(VALUE) {
 deserialize(t);
}

Here is the call graph for this function:

Member Function Documentation

const AttributeTable& G3D::XML::attributeTable ( ) const

inline

 {
 return m_attribute;
 }

bool G3D::XML::boolean

(

)

const

Returns false if a TAG.

 {
 return TextInput::parseBoolean(m_value);
}

Here is the call graph for this function:

Here is the caller graph for this function:

const Array<XML>& G3D::XML::childArray ( ) const

inline

 {
 return m_child;
 }

bool G3D::XML::containsAttribute ( const std::string &  k ) const

inline

 {
 return m_attribute.containsKey(k);
 }

Here is the call graph for this function:

void G3D::XML::deserialize

(

TextInput &

t

)

 {
 begin:
 Token n = t.read();
 m_attribute.clear();
 m_child.clear();
 m_name = "";
 m_value = "";

 if ((n.type() == Token::SYMBOL) && (n.string() == "<")) {
 // Beginning a tag
 
 // Read name
 n = t.read();
 debugAssert(n.type() == Token::SYMBOL);
 bool isComment = 
 (n.string() == "!") && 
 (t.peek().type() == Token::SYMBOL) &&
 (t.peek().string() == "--");

 // ignored tag: <?xml> or <!xml>
 // comment tag: <!-- ... -->

 if ((n.string() == "?") || ((n.string() == "!") && ! isComment)) {
 // Ignore this tag
 while (t.hasMore() && ! ((n.type() == Token::SYMBOL) && (n.string() == ">"))) {
 n = t.read();
 }
 goto begin;
 } else if (isComment) {
 // Ignore until "-->"
 bool prevWasDash = false;
 while (t.hasMore() && ! ((n.type() == Token::SYMBOL) && (n.string() == ">") && prevWasDash)) {
 prevWasDash = (n.type() == Token::SYMBOL) && (n.string() == "--");
 n = t.read();
 }
 goto begin;
 }

 // Keep reading until no colon
 m_name += n.string();
 n = t.read();
 while ((n.type() == Token::SYMBOL) && (n.string() == ":")) {
 // tag with namespace: <x:y>
 m_name += ":" + t.readSymbol();
 n = t.read();
 }
 
 // Read end of tag/close
 bool done = false;
 while (! done) {
 debugAssert(n.type() == Token::SYMBOL);
 if (n.string() == "/") {
 // empty-element tag: <foo/>
 // Consume the close tag
 t.readSymbol(">");
 done = true;

 } else if (n.string() == ">") {
 // End of open tag: read children until close tag
 while (! atClose(t, m_name)) {
 m_child.next().deserialize(t);
 }

 // Read close tag (we wouldn't be here unless it parses correctly)
 while (t.hasMore() && ! (t.readSymbol() == ">")) {}
 
 done = true;
 } else {
 // Attribute pair
 std::string k = n.string();
 t.readSymbol("=");
 std::string v = t.read().string();
 m_attribute.set(k, v);

 // Advance to next
 n = t.read();
 }
 }
 } else {
 // Beginning embedded content. Read until the end of file or the next tag.
 m_type = VALUE;
 m_value += n.string();

 n = t.peek();
 while (t.hasMore() && ! ((n.type() == Token::SYMBOL) && (n.string() == "<"))) {
 m_value += " " + t.read().string();
 n = t.peek();
 }
 }
}

Here is the call graph for this function:

Here is the caller graph for this function:

XML G3D::XML::get ( const std::string &  k, const XML &  defaultVal  ) const

inline

Note that the result is always copied, making this inefficient for return values that are not VALUEs.

 {
 const XML* x = m_attribute.getPointer(k);
 if (x) {
 return *x;
 } else {
 return defaultVal;
 }
 }

Here is the call graph for this function:

void G3D::XML::load

(

const std::string &

filename

)

 {
 TextInput::Settings s;
 s.cppBlockComments = false;
 s.cppLineComments = false;
 s.proofSymbols = false;

 TextInput t(filename, s);
 deserialize(t);
}

Here is the call graph for this function:

const std::string G3D::XML::name ( ) const

inline

The name, if this is a TAG.

 {
 return m_name;
 }

size_t G3D::XML::numAttributes ( ) const

inline

Attribute table size; zero for a TAG

 {
 return m_attribute.size();
 }

Here is the call graph for this function:

double G3D::XML::number

(

)

const

Parse as a number. Returns nan() if a TAG or unparseable as a number.

 {
 return TextInput::parseNumber(m_value);
}

Here is the call graph for this function:

Here is the caller graph for this function:

int G3D::XML::numChildren ( ) const

inline

Array size; zero for a VALUE

 {
 return m_child.size();
 }

Here is the call graph for this function:

G3D::XML::operator bool ( ) const

inline

 {
 return boolean();
 }

Here is the call graph for this function:

G3D::XML::operator double ( ) const

inline

 {
 return number();
 }

Here is the call graph for this function:

G3D::XML::operator float ( ) const

inline

 {
 return float(number());
 }

Here is the call graph for this function:

G3D::XML::operator int ( ) const

inline

 {
 return iRound(number());
 }

Here is the call graph for this function:

G3D::XML::operator std::string ( ) const

inline

 {
 return m_value;
 }

const XML& G3D::XML::operator[] ( int  i ) const

inline

Return child i. Children are nested tags and the unquoted strings of characters between tags.

 {
 return m_child[i];
 }

const XML& G3D::XML::operator[] ( const std::string &  k ) const

inline

Return the attribute with this name.

 {
 return m_attribute[k];
 }

void G3D::XML::parse

(

const std::string &

s

)

 {
 TextInput t(TextInput::FROM_STRING, s);
 deserialize(t);
}

Here is the call graph for this function:

void G3D::XML::save

(

const std::string &

filename

)

const

 {
 std::string s;
 unparse(s);
 writeWholeFile(filename, s);
}

Here is the call graph for this function:

void G3D::XML::serialize

(

TextOutput &

t

)

const

 {
 if (m_type == VALUE) {
 // Raw string; no quotes
 t.writeSymbol(m_value);
 } else {
 t.printf("<%s", m_name.c_str());
 for (AttributeTable::Iterator it = m_attribute.begin(); it.isValid(); ++it) {
 t.printf(" %s=\"%s\"", it->key.c_str(), it->value.m_value.c_str());
 }
 t.printf(">");
 t.writeNewline();
 t.pushIndent();
 for (int i = 0; i < m_child.size(); ++i) {
 m_child[i].serialize(t);
 if (m_child[i].m_type == VALUE) {
 // Only tags know to append a newline
 t.writeNewline();
 }
 }
 t.popIndent();
 t.printf("</%s>", m_name.c_str());
 t.writeNewline();
 }
}

Here is the call graph for this function:

Here is the caller graph for this function:

const std::string& G3D::XML::string ( ) const

inline

Returns "" if a TAG.

 {
 return m_value;
 }

Type G3D::XML::type ( ) const

inline

 {
 return m_type;
 }

void G3D::XML::unparse

(

std::string &

s

)

const

 {
 TextOutput::Settings set;
 set.wordWrap = TextOutput::Settings::WRAP_WITHOUT_BREAKING;
 TextOutput t(set);

 serialize(t);

 t.commitString(s);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

AttributeTable G3D::XML::m_attribute

private

Array<XML> G3D::XML::m_child

private

std::string G3D::XML::m_name

private

Type G3D::XML::m_type

private

std::string G3D::XML::m_value

private

---

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

• dep/g3dlite/include/G3D/XML.h
• dep/g3dlite/source/XML.cpp