exml/exml/Document.h

140 lines
3.6 KiB
C++

/**
* @author Edouard DUPIN
*
* @copyright 2011, Edouard DUPIN, all right reserved
*
* @license BSD v3 (see license file)
*/
#ifndef __ETK_XML_DOCUMENT_H__
#define __ETK_XML_DOCUMENT_H__
#include <exml/Element.h>
#include <etk/unicode.h>
#include <etk/Vector.h>
namespace exml {
class Document : public exml::Element {
public:
/**
* @brief Constructor
*/
Document(void);
/**
* @brief Destructor
*/
virtual ~Document(void) { };
private:
enum unicode::charset m_charset;
public:
/**
* @brief get the current charset of the Parsing
* @param[in] _charset The new charset
*/
virtual void setCharset(enum unicode::charset _charset) {
m_charset = _charset;
};
/**
* @brief get the current charset of the Parsing
* @return The current charset
*/
virtual enum unicode::charset getCharset(void) const {
return m_charset;
};
private:
bool m_caseSensitive; // check the case sensitive of the nodes and attribute
public:
/**
* @brief Enable or diasable the case sensitive (must be done before the call of parsing)
* @param[in] _val true if enable; false else.
*/
virtual void setCaseSensitive(bool _val) {
m_caseSensitive = _val;
};
/**
* @brief get the status of case sensitive mode.
* @return true if case sensitive is active
*/
virtual bool getCaseSensitive(void) const {
return m_caseSensitive;
};
public:
/**
* @brief parse a string that contain an XML
* @param[in] _data Data to parse
* @return false : An error occured
* @return true : Parsing is OK
*/
bool parse(const etk::UString& _data);
/**
* @brief generate a string that contain the created XML
* @param[out] _data Data where the xml is stored
* @return false : An error occured
* @return true : Parsing is OK
*/
bool generate(etk::UString& _data);
/**
* @brief Load the file that might contain the xml
* @param[in] _file Filename of the xml (compatible with etk FSNode naming)
* @return false : An error occured
* @return true : Parsing is OK
*/
bool load(const etk::UString& _file);
/**
* @brief Store the Xml in the file
* @param[in] _file Filename of the xml (compatible with etk FSNode naming)
* @return false : An error occured
* @return true : Parsing is OK
*/
bool store(const etk::UString& _file);
/**
* @brief Display the Document on console
*/
void display(void);
private:
bool m_writeErrorWhenDetexted;
etk::UString m_comment;
etk::UString m_Line;
exml::filePos m_filePos;
public:
void displayErrorWhenDetected(void) {
m_writeErrorWhenDetexted = true;
};
void notDisplayErrorWhenDetected(void) {
m_writeErrorWhenDetexted = false;
};
void createError(const etk::UString& _data, int32_t _pos, const exml::filePos& _filePos, const etk::UString& _comment);
void displayError(void);
public: // herited function:
virtual enum nodeType getType(void) const {
return typeDocument;
};
bool iGenerate(etk::UString& _data, int32_t _indent) const;
virtual exml::Document* toDocument(void) {
return this;
};
virtual const exml::Document* toDocument(void) const {
return this;
};
};
};
/*
#define CREATE_ERROR(doc,data,pos,filePos,comment) \
EXML_ERROR( (pos) << " " << (comment) << "\n" \
<< (data).ExtractLine((pos)) << "\n" \
<< CreatePosPointer((filePos).getCol()) )
*/
#define CREATE_ERROR(doc,data,pos,filePos,comment) \
do { \
EXML_ERROR(comment); \
(doc).createError((data),(pos),(filePos),(comment)); \
} while (0)
//__LINE__, __class__, __func__
#endif