XML is a class representing xml object. More...

#include <XML.hpp>

Collaboration diagram for samchon::library::XML:

Public Member Functions
	XML ()
	Default Constructor. More...

	XML (const XML &)
	Copy Constructor. More...

	XML (XML &&)
	Move Constructor. More...

	XML (WeakString)
	Constructor by string. More...

void	push_back (const WeakString &)
	Add children xml objects by string representing them. More...

void	push_back (const std::shared_ptr< XML >)
	Add children xml. More...

void	addAllProperty (const std::shared_ptr< XML >)
	Add all properties from another XML. More...

void	setTag (const std::string &)
	Set tag (identifier) of the XML. More...

template<typename T >
void	setValue (const T &val)
	Set value of the XML. More...

template<typename T >
void	setProperty (const std::string &key, const T &val)
	Set a property with its key. More...

void	eraseProperty (const std::string &)
	Erase a property by its key. More...

void	clearProperties ()
	Remove all properties in the XML. More...

auto	getTag () const -> std::string
	Get key; identifer of the XML. More...

template<class T = std::string>
auto	getValue () const -> T
	Get value of the XML. More...

template<class T = std::string>
auto	getProperty (const std::string &key) const -> T
	Get property. More...

auto	hasProperty (const std::string &) const -> bool
	Test wheter a property exists or not. More...

auto	getPropertyMap () const -> const HashMap< std::string, std::string > &
	Get propertyMap. More...

auto	toString (size_t level=0) const -> std::string
	Get the string content. More...

Public Member Functions inherited from samchon::HashMap< std::string, std::shared_ptr< XMLList > >
auto	has (const std::string &key) const -> bool
	Whether have the item or not. More...

auto	get (const std::string &key) -> std::shared_ptr< XMLList > &
	Get element. More...

void	set (const std::string &key, const std::shared_ptr< XMLList > &val)
	Set element. More...

auto	pop (const std::string &key) -> std::shared_ptr< XMLList >
	Pop item. More...

Private Member Functions
	XML (XML *, WeakString &)
	Protected Constructor by string for child. More...

Private Attributes
std::string	tag
	Tag name. More...

std::string	value
	Value of the XML. More...

HashMap< std::string, std::string >	propertyMap
	Properties belongs to the XML. More...

Detailed Description

XML is a class representing xml object.

The XML class provides methods and properties for working with XML objects.

The XML class (along with the XMLList and Namespace) implements the powerful XML-handling standard defined in ECMAScript for XML (E4X) specification.

XML class has a recursive, hierarchical relationship.

All XML objects're managed by shared_ptr.

XML contains XMLList from dictionary of shared pointer<XMLList>
XMLList contains XML from vector of shared pointer<XML>
Even if user creates an XML object directly, it's the basic principle to use shared pointer

Note

Parsing comment is not supported yet.

It's not recommeded to creating an XML object which is not being managed by shared pointer.

Warning

Do not abuse values for expressing member variables.

Standard Usage	Non-standard usage abusing value
<memberList> <member id='jhnam88' name='Jeongho+Nam' birthdate='1988-03-11' /> <member id='master' name='Administartor' birthdate='2011-07-28' /> </memberList>	<member> <id>jhnam88</id> <name>Jeongho+Nam</name> <birthdate>1988-03-11</birthdate> </member>

 #include <iostream>
 #include <vector>
 #include <string>
 
 #include <samchon/library/XML.hpp>
 
 #ifdef _WIN64
 #   ifdef _DEBUG
 #       pragma comment(lib, "x64/Debug/SamchonFramework.lib")
 #   else
 #       pragma comment(lib, "x64/Release/SamchonFramework.lib")
 #   endif
 #else
 #   ifdef _DEBUG
 #       pragma comment(lib, "Debug/SamchonFramework.lib")
 #   else
 #       pragma comment(lib, "Release/SamchonFramework.lib")
 #   endif
 #endif
 
 using namespace std;
 using namespace samchon::library;
 
 struct Member
 {
     string id;
     string name;
     int age;
     int grade;
 
     auto toXML() const -> shared_ptr<XML>
     {
         shared_ptr<XML> xml(new XML());
         xml->setTag("member");
         xml->setProperty("id", id);
         xml->setProperty("name", name);
         xml->setProperty("age", age);
         xml->setProperty("grade", grade);
 
         return xml;
     };
 };
 
 void main()
 {
     //DECLARE An XML WITH MEMBER_ARRAY TAG
     shared_ptr<XML> xml(new XML());
     xml->setTag("memberArray");
     
     //ADD MEMBER(S) TO XML
     vector<struct Member> memberArray =
     {
         {"samchon", "Jeongho Nam", 27, 1},
         {"gkyu", "Kwangkyu Ko", 25, 1},
         {"guest", "John Doe", 99, 4}
     };
     for(size_t i = 0; i < memberArray.size(); i++)
         xml->push_back( memberArray[i].toXML() );
 
     //ADD FILE_LIST BY STRING DIRECTLY
     xml->push_back
     (
         string("") +
         "<fileList>\n" + 
             "<file extension='pdf' name='API' />" +
             "<file extension='pdf' name='Guidance+For+Developer'>Damaged</file>" + 
             "<file extension='docx' name='Resume' />" +
             "<file extension='jpg' name='My+House' />" +
             "<file extension='xlsx' name='Grades' />" +
         "</fileList>"
     );
 
     cout << "-----------------------------------------------------------------" << endl;
     cout << " Get Properties And Values" << endl;
     cout << "-----------------------------------------------------------------" << endl;
     cout << "Age of 2nd member: " << xml->get("member")->at(1)->getProperty<int>("age") << endl;
     cout << "Age of 1st member: " << xml->get("member")->at(0)->getProperty("id") << endl << endl;
 
     cout << "File name and extension of 5th: "
         << xml->get("fileList")->at(0)->get("file")->at(4)->getProperty("name") << "."
         << xml->get("fileList")->at(0)->get("file")->at(4)->getProperty("extension") << endl;
     cout << "Value of 2nd file: " << xml->get("fileList")->at(0)->get("file")->at(1)->getValue() << endl << endl;
 
     cout << "-----------------------------------------------------------------" << endl;
     cout << " XML to String: " << endl;
     cout << "-----------------------------------------------------------------" << endl;
     cout << xml->toString() << endl;
 
     system("pause");
 }

See also: samchon::library

Author: Jeongho Nam http://samchon.org

Definition at line 72 of file XML.hpp.

Constructor & Destructor Documentation

XML::XML ( )

Default Constructor.

Warning: Declare XML to managed by shared pointer

Definition at line 36 of file XML.cpp.

Referenced by push_back(), and XML().

Here is the caller graph for this function:

XML::XML ( const XML & xml )

Copy Constructor.

Not copying (shared) pointer of children xml objects, but copying the real objects of children xml

Definition at line 42 of file XML.cpp.

References propertyMap, tag, and value.

XML::XML ( XML && xml )

Move Constructor.

Definition at line 65 of file XML.cpp.

References propertyMap, tag, and value.

XML::XML ( WeakString wStr )

Constructor by string.

Parses a string so that constructs an XML object

Parameters

str	A string representing xml object

Warning: Declare XML to managed by shared pointer

Definition at line 74 of file XML.cpp.

References samchon::WeakString::between(), samchon::WeakString::find(), samchon::HashMap< Key, T, Hash, Pred, Alloc >::pop(), samchon::WeakString::size(), samchon::WeakString::substr(), and samchon::WeakString::substring().

Here is the call graph for this function:

XML::XML	(	XML *	parent,
		WeakString &	str
	)

private

Protected Constructor by string for child.

Parses a string so that creates an XML object It is called for creating children XML objects from parent XML object.

Parameters

parent	Parent object who will contains this XML object
str	A string to be parsed

Definition at line 117 of file XML.cpp.

References samchon::WeakString::find(), propertyMap, push_back(), samchon::WeakString::rfind(), samchon::HashMap< Key, T, Hash, Pred, Alloc >::set(), samchon::WeakString::size(), samchon::WeakString::substr(), samchon::WeakString::substring(), tag, samchon::WeakString::trim(), value, and XML().

Here is the call graph for this function:

Member Function Documentation

void XML::push_back ( const WeakString & str )

Add children xml objects by string representing them.

Parameters

str	A string representing xml objects whould be belonged to this XML

Definition at line 439 of file XML.cpp.

References samchon::WeakString::empty(), samchon::HashMap< std::string, std::shared_ptr< XMLList > >::has(), tag, and XML().

Referenced by XML().

Here is the call graph for this function:

Here is the caller graph for this function:

void samchon::library::XML::push_back ( const std::shared_ptr< XML > )

Add children xml.

Parameters

xml	An xml object you want to add

void XML::addAllProperty ( const std::shared_ptr< XML > )

Add all properties from another XML.

Copies all properties from target to here.

Warning: Not a category of assign, but an insert.

Parameters

xml	Target xml object to deliver its properties

Definition at line 469 of file XML.cpp.

References propertyMap.

void XML::setTag ( const std::string & tag )

Set tag (identifier) of the XML.

See also: XML::tag

Definition at line 384 of file XML.cpp.

References tag.

template<typename T >

void samchon::library::XML::setValue ( const T & val )

inline

Set value of the XML.

Template Parameters

_Ty	Type of the value

Parameters

val	The value to set

Warning

Do not abuse values for expressing member variables

Standard Usage	Non-standard usage abusing value
<memberList> <member id='jhnam88' name='Jeongho+Nam' birthdate='1988-03-11' /> <member id='master' name='Administartor' birthdate='2011-07-28' /> </memberList>	<member> <id>jhnam88</id> <name>Jeongho+Nam</name> <birthdate>1988-03-11</birthdate> </member>

Definition at line 229 of file XML.hpp.

References samchon::WeakString::str().

Here is the call graph for this function:

template<typename T >

void samchon::library::XML::setProperty	(	const std::string &	key,
		const T &	val
	)

inline

Set a property with its key.

Definition at line 259 of file XML.hpp.

References samchon::HashMap< Key, T, Hash, Pred, Alloc >::set(), and samchon::WeakString::str().

Here is the call graph for this function:

void XML::eraseProperty ( const std::string & tag )

Erase a property by its key.

Parameters

key	The key of the property to erase

Exceptions

exception Unable to find the element

Definition at line 476 of file XML.cpp.

References propertyMap.

void XML::clearProperties ( )

Remove all properties in the XML.

Definition at line 480 of file XML.cpp.

References propertyMap.

auto XML::getTag ( ) const -> std::string

Get key; identifer of the XML.

Returns: tag, identifer of the XML

See also: XML::tag

Definition at line 330 of file XML.cpp.

References tag.

template<class T = std::string>

auto samchon::library::XML::getValue ( ) const -> T

inline

Get value of the XML.

Definition at line 303 of file XML.hpp.

template<class T = std::string>

auto samchon::library::XML::getProperty ( const std::string & key ) const -> T

inline

Get property.

Definition at line 326 of file XML.hpp.

References samchon::HashMap< Key, T, Hash, Pred, Alloc >::get().

Here is the call graph for this function:

auto XML::hasProperty ( const std::string & tag ) const -> bool

Test wheter a property exists or not.

Definition at line 491 of file XML.cpp.

References samchon::HashMap< Key, T, Hash, Pred, Alloc >::has(), propertyMap, samchon::WeakString::replaceAll(), tag, and samchon::WeakString::trim().

Here is the call graph for this function:

auto XML::getPropertyMap ( ) const -> const HashMap<std::string, std::string>&

Get propertyMap.

Definition at line 485 of file XML.cpp.

References propertyMap.

auto XML::toString ( size_t level = 0 ) const -> std::string

Get the string content.

Returns a string representation of the XML and its all children.

Returns: A string represents the XML.

Definition at line 647 of file XML.cpp.

References propertyMap, tag, and value.

Member Data Documentation

std::string samchon::library::XML::tag

private

Tag name.

<tag label='property' />: tag => "tag"
<price high='1500' low='1300' open='1450' close='1320' />: tag => "price"

Definition at line 85 of file XML.hpp.

Referenced by getTag(), hasProperty(), push_back(), setTag(), toString(), and XML().

std::string samchon::library::XML::value

private

Value of the XML.

<parameter name='age' type='int'>26</parameter>: value => 26
<price high='1500' low='1300' open='1450' close='1320' />: tag => null

Definition at line 94 of file XML.hpp.

Referenced by toString(), and XML().

HashMap<std::string, std::string> samchon::library::XML::propertyMap

private

Properties belongs to the XML.

A Dictionary of properties accessing each property by its key.

<price high='1500' low='1300' open='1450' close='1320' />: propertyMap => {{"high": 1500}, {"low": 1300}, {"open": 1450}, {"close", 1320}}
<member id='jhnam88' name='Jeongho+Nam' comment='Hello.+My+name+is+Jeongho+Nam' >: propertyMap => {{"id", "jhnam88"}, {"name", "Jeongho Nam http://samchon.org"}, {"comment", "Hello. My name is Jeongho Nam http://samchon.org"}}

Definition at line 106 of file XML.hpp.

Referenced by addAllProperty(), clearProperties(), eraseProperty(), getPropertyMap(), hasProperty(), toString(), and XML().

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

D:/OneDrive/Project/Samchon/framework/cpp/samchon/library/XML.hpp
D:/OneDrive/Project/Samchon/framework/cpp/samchon/library/XML.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation