exml::internal::Comment Class Reference

#include <Comment.hpp>

Inheritance diagram for exml::internal::Comment:

Public Member Functions
	Comment (const std::string &_value)
enum nodeType	getType () const override
bool	iParse (const std::string &_data, int32_t &_pos, bool _caseSensitive, exml::FilePos &_filePos, exml::internal::Document &_doc) override
bool	iGenerate (std::string &_data, int32_t _indent) const override
ememory::SharedPtr< exml::internal::Comment >	toComment () override
const ememory::SharedPtr< exml::internal::Comment >	toComment () const override
Public Member Functions inherited from exml::internal::Node
virtual	~Node ()=default
const exml::FilePos &	getPos () const
virtual void	setValue (std::string _value)
virtual const std::string &	getValue () const
virtual ememory::SharedPtr< exml::internal::Document >	toDocument ()
virtual const ememory::SharedPtr< exml::internal::Document >	toDocument () const
virtual ememory::SharedPtr< exml::internal::Attribute >	toAttribute ()
virtual const ememory::SharedPtr< exml::internal::Attribute >	toAttribute () const
virtual ememory::SharedPtr< exml::internal::Declaration >	toDeclaration ()
virtual const ememory::SharedPtr< exml::internal::Declaration >	toDeclaration () const
virtual ememory::SharedPtr< exml::internal::Element >	toElement ()
virtual const ememory::SharedPtr< exml::internal::Element >	toElement () const
virtual ememory::SharedPtr< exml::internal::Text >	toText ()
virtual const ememory::SharedPtr< exml::internal::Text >	toText () const
bool	isDocument () const
bool	isAttribute () const
bool	isComment () const
bool	isDeclaration () const
bool	isElement () const
bool	isText () const
virtual void	clear ()
Public Member Functions inherited from ememory::EnableSharedFromThis< Node >
ememory::SharedPtr< EMEMORY_TYPE >	sharedFromThis ()
const ememory::SharedPtr< EMEMORY_TYPE >	sharedFromThis () const
ememory::WeakPtr< EMEMORY_TYPE >	weakFromThis ()
const ememory::WeakPtr< EMEMORY_TYPE >	weakFromThis () const

Static Public Member Functions
static ememory::SharedPtr< exml::internal::Comment >	create (const std::string &_value="")

Additional Inherited Members
Protected Member Functions inherited from exml::internal::Node
	Node ()
	Node (const std::string &_value)
void	addIndent (std::string &_data, int32_t _indent) const
void	drawElementParsed (char32_t _val, const exml::FilePos &_filePos) const
bool	checkAvaillable (char32_t _val, bool _firstChar) const
int32_t	countWhiteChar (const std::string &_data, int32_t _pos, exml::FilePos &_filePos) const
Protected Attributes inherited from exml::internal::Node
exml::FilePos	m_pos
std::string	m_value

Detailed Description

Comment node: <!– ... –>.

Constructor & Destructor Documentation

Comment()

exml::internal::Comment::Comment ( const std::string &  _value )

inline

Constructor.

Parameters

[in]

_value

comment value

Member Function Documentation

create()

static ememory::SharedPtr<exml::internal::Comment> exml::internal::Comment::create ( const std::string &  _value = "" )

static

defined factory

Returns

Shared pointer on the Comment element

Parameters

[in]

_value

comment value

getType()

enum nodeType exml::internal::Comment::getType ( ) const

inlineoverridevirtual

get the node type.

Returns

the type of the Node.

Reimplemented from exml::internal::Node.

iGenerate()

bool exml::internal::Comment::iGenerate ( std::string &  _data, int32_t  _indent  ) const

overridevirtual

generate a string with the tree of the xml

Parameters

[in,out]	_data	string where to add the elements
[in]	_indent	current indentation of the file

Returns

false if an error occured.

Reimplemented from exml::internal::Node.

iParse()

bool exml::internal::Comment::iParse ( const std::string &  _data, int32_t &  _pos, bool  _caseSensitive, exml::FilePos &  _filePos, exml::internal::Document &  _doc  )

overridevirtual

parse the Current node [pure VIRUAL]

Parameters

[in]	_data	data string to parse.
[in,out]	_pos	position in the string to start parse, return the position end of parsing.
[in]	_caseSensitive	Request a parsion of element that is not case sensitive (all element is in low case)
[in,out]	_filePos	file parsing position (line x col x)
[in,out]	_doc	Base document reference

Returns

false if an error occured.

Implements exml::internal::Node.

toComment() [1/2]

ememory::SharedPtr<exml::internal::Comment> exml::internal::Comment::toComment ( )

inlineoverridevirtual

Cast the element in a Comment if it is possible.

Returns

pointer on the class or nullptr.

Reimplemented from exml::internal::Node.

toComment() [2/2]

const ememory::SharedPtr<exml::internal::Comment> exml::internal::Comment::toComment ( ) const

inlineoverridevirtual

Cast the element in a Comment if it is possible.

Returns

CONST pointer on the class or nullptr.

Reimplemented from exml::internal::Node.

---

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

• framework/atria-soft/exml/exml/internal/Comment.hpp