XMLDocument Class Reference

Small XML Document wrapper class. More...

#include <ored/utilities/xmlutils.hpp>

Collaboration diagram for XMLDocument:

Public Member Functions
	XMLDocument ()
	create an empty doc. More...
	XMLDocument (const string &filename)
	load an xml doc from the given file More...
	~XMLDocument ()
	destructor More...
void	fromXMLString (const string &xmlString)
	load a document from a hard-coded string More...
void	toFile (const string &filename) const
	save the XML Document to the given file. More...
std::string	toString () const
	return the XML Document as a string. More...
XMLNode *	getFirstNode (const string &name) const
void	appendNode (XMLNode *)
XMLNode *	allocNode (const string &nodeName)
	util functions that wrap rapidxml More...
XMLNode *	allocNode (const string &nodeName, const string &nodeValue)
char *	allocString (const string &str)
rapidxml::xml_document< char > *	doc ()

Private Attributes
rapidxml::xml_document< char > *	_doc
char *	_buffer

Detailed Description

Small XML Document wrapper class.

Definition at line 65 of file xmlutils.hpp.

Constructor & Destructor Documentation

XMLDocument() [1/2]

XMLDocument

(

)

create an empty doc.

Definition at line 75 of file xmlutils.cpp.

: _doc(new rapidxml::xml_document<char>()), _buffer(NULL) {}

XMLDocument() [2/2]

XMLDocument

(

const string &

filename

)

load an xml doc from the given file

Definition at line 77 of file xmlutils.cpp.

                                               : _doc(new rapidxml::xml_document<char>()), _buffer(NULL) {
    // Need to load the entire file into memory to pass to doc.parse().
    ifstream t(fileName.c_str());
    QL_REQUIRE(t.is_open(), "Failed to open file " << fileName);
    t.seekg(0, std::ios::end);                  // go to the end
    Size length = static_cast<Size>(t.tellg()); // report location (this is the length)
    QL_REQUIRE(length > 0, "File " << fileName << " is empty.");
    t.seekg(0, std::ios::beg);      // go back to the beginning
    _buffer = new char[length + 1]; // allocate memory for a buffer of appropriate dimension
    t.read(_buffer, length);        // read the whole file into the buffer
    _buffer[static_cast<int>(t.gcount())] = '\0';
    t.close(); // close file handle
    try {
        _doc->parse<0>(_buffer);
    } catch (const rapidxml::parse_error& pe) {
        handle_rapidxml_parse_error(pe);
    }
}

~XMLDocument()

~XMLDocument

(

)

destructor

Definition at line 96 of file xmlutils.cpp.

                          {
    if (_buffer != NULL)
        delete[] _buffer;
    if (_doc != NULL)
        delete _doc;
}

Member Function Documentation

fromXMLString()

void fromXMLString

(

const string &

xmlString

)

load a document from a hard-coded string

Definition at line 103 of file xmlutils.cpp.

                                                       {
    QL_REQUIRE(!_buffer, "XML Document is already loaded");
    Size length = xmlString.size();
    _buffer = new char[length + 1];
    strcpy(_buffer, xmlString.c_str());
    _buffer[length] = '\0';
    try {
        _doc->parse<0>(_buffer);
    } catch (const rapidxml::parse_error& pe) {
        handle_rapidxml_parse_error(pe);
    }
}

Here is the caller graph for this function:

toFile()

void toFile

(

const string &

filename

)

const

save the XML Document to the given file.

Definition at line 120 of file xmlutils.cpp.

                                                     {
    std::ofstream ofs(fileName.c_str());
    ofs << *_doc;
    ofs.close();
}

Here is the caller graph for this function:

toString()

string toString

(

)

const

return the XML Document as a string.

Definition at line 126 of file xmlutils.cpp.

                                   {
    ostringstream oss;
    oss << *_doc;
    return oss.str();
}

Here is the caller graph for this function:

getFirstNode()

XMLNode * getFirstNode

(

const string &

name

)

const

Definition at line 116 of file xmlutils.cpp.

{ return _doc->first_node(name == "" ? NULL : name.c_str()); }

Here is the caller graph for this function:

appendNode()

void appendNode

(

XMLNode *

node

)

Definition at line 118 of file xmlutils.cpp.

{ _doc->append_node(node); }

Here is the caller graph for this function:

allocNode() [1/2]

XMLNode * allocNode

(

const string &

nodeName

)

util functions that wrap rapidxml

Definition at line 132 of file xmlutils.cpp.

                                                      {
    XMLNode* n = _doc->allocate_node(node_element, allocString(nodeName));
    QL_REQUIRE(n, "Failed to allocate XMLNode for " << nodeName);
    return n;
}

Here is the call graph for this function:

Here is the caller graph for this function:

allocNode() [2/2]

XMLNode * allocNode	(	const string &	nodeName,
		const string &	nodeValue
	)

Definition at line 138 of file xmlutils.cpp.

                                                                               {
    XMLNode* n = _doc->allocate_node(node_element, allocString(nodeName), allocString(nodeValue));
    QL_REQUIRE(n, "Failed to allocate XMLNode for " << nodeName);
    return n;
}

Here is the call graph for this function:

allocString()

char * allocString

(

const string &

str

)

Definition at line 144 of file xmlutils.cpp.

                                                {
    char* s = _doc->allocate_string(str.c_str());
    QL_REQUIRE(s, "Failed to allocate string for " << str);
    return s;
}

Here is the caller graph for this function:

doc()

rapidxml::xml_document< char > * doc

(

)

Definition at line 91 of file xmlutils.hpp.

{ return _doc; }

Here is the caller graph for this function:

Member Data Documentation

_doc

rapidxml::xml_document<char>* _doc

private

Definition at line 94 of file xmlutils.hpp.

_buffer

char* _buffer

private

Definition at line 95 of file xmlutils.hpp.