rnr::Xml Class Reference

XML base class. More...

#include <Xml.h>

Public Member Functions
	Xml (const std::string &strRootElem, const std::string &strXsiUrl="", const std::string &strXslUrl="")
	Initialization constructor. More...
virtual	~Xml ()
	Destructor.
virtual int	loadFile (const std::string &strXmlFileName)
	Load XML file into DOM. More...
virtual int	saveFile (const std::string &strXmlFileName)
	Save DOM to XML file. More...
virtual int	createTemplateFile (const std::string &strXmlFileName, const std::string &strMajorElemName)
	Create XML file with the given major element name under the root element. More...
bool	fileExists (const std::string &strXmlFileName, bool bRequired=false)
	Check that the XML file exists and has read/write access. More...
void	setSchemaInstance (const std::string &strXsiUrl)
	Set XML document schema instance. More...
void	setStylesheet (const std::string &strXslUrl)
	Set XML Extended Style Sheet. More...
std::string	getFileName ()
	Get last load/save/create XML file name. More...
bool	isModified ()
	Check if DOM has been modified since last save. More...
void	setModifiedState (bool bModified)
	Set DOM modified state. More...
std::string	getErrorMsg ()
	Get last error message. More...
TiXmlElement *	getMajorElem (const std::string &strMajorElemName)
	Get the major element in the DOM. More...
std::string	elemText (TiXmlElement *pElem)
	Get element's text. More...
std::string	elemAttr (TiXmlElement *pElem, const std::string &strAttrName)
	Get element's attribute value. More...
int	strToInt (const std::string &str, int &val)
	Convert string to integer. More...
int	intToStr (const int val, std::string &str, int base=10)
	Convert integer to string. More...
int	strToDouble (const std::string &str, double &val)
	Convert string to double-precision floating-point number. More...
int	doubleToStr (const double val, std::string &str)
	Convert double to string. More...

Protected Member Functions
virtual void	makeXmlHead ()
	Make XML document head string. More...
virtual void	makeXmlTail ()
	Make XML document tail string. More...
void	setErrorMsg (const char *sFmt,...)
	Set XML error message. More...

Protected Attributes
std::string	m_strRootElemName
	xml top-level root element name
std::string	m_strXsiUrl
	xml schema instance
std::string	m_strXslUrl
	xml style sheet
std::string	m_strXmlFileName
	xml file path name
std::string	m_strXmlHead
	xml document head
std::string	m_strXmlTail
	xml document tail
TiXmlDocument	m_xmlDoc
	parsed xml DOM
TiXmlElement *	m_pElemRoot
	top-level root element
bool	m_bModified
	xml [not] modified
char	m_bufErrMsg [256]
	error message buffer

Detailed Description

XML base class.

Definition at line 90 of file Xml.h.

Constructor & Destructor Documentation

Xml::Xml	(	const std::string &	strRootElem,
		const std::string &	strXsiUrl = "",
		const std::string &	strXslUrl = ""
	)

Initialization constructor.

Parameters

strRootElem	XML document top-level root element.
strXsiUrl	XML schema instance URL. Examples: "http://www.roadnarrows.com/xml/<em>pkg</em>/1.0/<em>name</em>.xsd" "file://<em>prefix</em>/share/<em>pkg</em>/<em>name</em>.xsd" "<em>name</em>.xsd" Default: No schema.
strXslUrl	XML extended stylesheet language transformation URL. Examples "http://www.roadnarrows.com/xml/<em>pkg</em>/1.0/<em>name</em>.xsl" "file://<em>prefix</em>/share/<em>pkg</em>/<em>name</em>.xsl" "<em>name</em>.xsl" Default: No stylesheet.

Definition at line 79 of file Xml.cxx.

References m_bModified, m_bufErrMsg, and m_pElemRoot.

                                  :
  m_strRootElemName(strRootElem),
  m_strXsiUrl(strXsiUrl),
  m_strXslUrl(strXslUrl)
{
  m_pElemRoot     = NULL;
  m_bModified     = false;
  m_bufErrMsg[0]  = 0;
}

Member Function Documentation

int Xml::createTemplateFile ( const std::string &  strXmlFileName, const std::string &  strMajorElemName  )

virtual

Create XML file with the given major element name under the root element.

Any current DOM is not accessed nor altered.

Parameters

strXmlFileName	XML file path name.
strMajorElemName	XML major element name. A major element is an XML direct child of the root element.

Returns

On success, OK(0) is returned.
On error, RC_ERROR(-1) is returned.

Definition at line 171 of file Xml.cxx.

References m_bufErrMsg, m_strXmlFileName, m_strXmlHead, m_strXmlTail, makeXmlHead(), makeXmlTail(), and setErrorMsg().

{
  FILE  *fp;

  if( strXmlFileName.empty() )
  {
    setErrorMsg("No file name.");
    LOGERROR("%s", m_bufErrMsg);
    return RC_ERROR;
  }

  m_strXmlFileName = strXmlFileName;

  // open file
  if( (fp = fopen(m_strXmlFileName.c_str(), "w+")) == NULL )
  {
    setErrorMsg("%s: %s(errno=%d).",
        m_strXmlFileName.c_str(), strerror(errno), errno);
    LOGERROR("%s", m_bufErrMsg);
    return RC_ERROR;
  }

  makeXmlHead();
  makeXmlTail();

  // create template of document
  fprintf(fp, "%s", m_strXmlHead.c_str());
  fprintf(fp, "<%s>\n</%s>\n",
      strMajorElemName.c_str(), strMajorElemName.c_str());
  fprintf(fp, "%s", m_strXmlTail.c_str());

  fclose(fp);

  LOGDIAG3("Created file %s.", m_strXmlFileName.c_str());

  return OK;
}

int Xml::doubleToStr	(	const double	val,
		std::string &	str
	)

Convert double to string.

Parameters

[in]	val	Double value.
[out]	str	Converted string in hex, decimal, or octal format.

Returns

On success, OK(0) is returned.
On error, RC_ERROR(-1) is returned.

Definition at line 353 of file Xml.cxx.

Referenced by getErrorMsg().

{
  char buf[64];

  snprintf(buf, sizeof(buf), "%lf", val);

  buf[sizeof(buf)-1] = 0;
    
  str = buf;

  return OK;
}

string Xml::elemAttr	(	TiXmlElement *	pElem,
		const std::string &	strAttrName
	)

Get element's attribute value.

Parameters

pElem

Pointer to DOM element object.

Returns

Attribute value string.

Definition at line 283 of file Xml.cxx.

Referenced by getErrorMsg().

{
  std::string  str;
  const char  *s;

  if( (pElem != NULL) &&
      !strAttrName.empty() &&
      ((s = pElem->Attribute(strAttrName.c_str())) != NULL) )
  {
    str = s;
  }

  return str;
}

string Xml::elemText

(

TiXmlElement *

pElem

)

Get element's text.

Leading and trailing white space is stripped.

Parameters

pElem

Pointer to DOM element object.

<elem> text... </elem>

Returns

Text string.

Definition at line 270 of file Xml.cxx.

Referenced by getErrorMsg().

{
  std::string  str;
  const char  *s;

  if( (pElem != NULL) && ((s = pElem->GetText()) != NULL) )
  {
    str = s;
  }

  return str;
}

bool Xml::fileExists	(	const std::string &	strXmlFileName,
		bool	bRequired = false
	)

Check that the XML file exists and has read/write access.

Parameters

strXmlFileName	XML file path name.
bRequired	File is [not] required to exist.

Returns

Returns true if access permitted, false otherwise.

Definition at line 210 of file Xml.cxx.

References m_bufErrMsg, and setErrorMsg().

{
  bool bAccess;

  if( strXmlFileName.empty() )
  {
    setErrorMsg("No file name.");
    LOGERROR("%s", m_bufErrMsg);
    bAccess = false;
  }
  else
  {
    bAccess = access(strXmlFileName.c_str(), F_OK|R_OK|W_OK) == 0;
  }

  if( !bAccess && bRequired )
  {
    setErrorMsg("%s: %s(errno=%d).",
        strXmlFileName.c_str(), strerror(errno), errno);
    LOGERROR("%s", m_bufErrMsg);
  }

  return bAccess;
}

std::string rnr::Xml::getErrorMsg ( )

inline

Get last error message.

Returns

String.

Definition at line 226 of file Xml.h.

References doubleToStr(), elemAttr(), elemText(), getMajorElem(), intToStr(), m_bufErrMsg, strToDouble(), and strToInt().

    {
      return m_bufErrMsg;
    }

std::string rnr::Xml::getFileName ( )

inline

Get last load/save/create XML file name.

Returns

File path name.

Definition at line 196 of file Xml.h.

References m_strXmlFileName.

    {
      return m_strXmlFileName;
    }

TiXmlElement * Xml::getMajorElem

(

const std::string &

strMajorElemName

)

Get the major element in the DOM.

Parameters

strMajorElemName

XML major element name. A major element is an XML direct child of the root element.

Returns

On success, returns pointer to elemen.
On failure, NULL is returned.

Definition at line 235 of file Xml.cxx.

References m_pElemRoot.

Referenced by getErrorMsg().

{
  TiXmlElement  *pElem;
  const char    *sValue;

  if( strMajorElemName.empty() )
  {
    return NULL;
  }

  if( m_pElemRoot == NULL )
  {
    return NULL;
  }

  // major secion elements
  for(pElem = m_pElemRoot->FirstChildElement();
      pElem != NULL;
      pElem = pElem->NextSiblingElement())
  {
    sValue = pElem->Value();

    if( sValue == NULL )
    {
      continue;
    }
    else if( !strcasecmp(sValue, strMajorElemName.c_str()) )
    {
      return pElem;
    }
  }

  return NULL;
}

int Xml::intToStr	(	const int	val,
		std::string &	str,
		int	base = 10
	)

Convert integer to string.

Parameters

[in]	val	Integer value.
[out]	str	Converted string in hex, decimal, or octal format.
	base	One of: 16 10 8.

Returns

On success, OK(0) is returned.
On error, RC_ERROR(-1) is returned.

Definition at line 313 of file Xml.cxx.

Referenced by getErrorMsg().

{
  char buf[64];

  switch( base )
  {
    case 16:
      snprintf(buf, sizeof(buf), "0x%x", val);
      break;
    case 10:
      snprintf(buf, sizeof(buf), "%d", val);
      break;
    case 8:
      snprintf(buf, sizeof(buf), "0%o", val);
      break;
    default:
      LOGERROR("%d: Unsupported base conversion.", base);
      return RC_ERROR;
  }

  buf[sizeof(buf)-1] = 0;
    
  str = buf;

  return OK;
}

bool rnr::Xml::isModified ( )

inline

Check if DOM has been modified since last save.

Returns

Returns true or false.

Definition at line 206 of file Xml.h.

References m_bModified.

    {
      return m_bModified;
    }

int Xml::loadFile ( const std::string &  strXmlFileName )

virtual

Load XML file into DOM.

Parameters

strXmlFileName

XML file path name.

Returns

On success, OK(0) is returned.
On error, RC_ERROR(-1) is returned.

Definition at line 95 of file Xml.cxx.

References m_bufErrMsg, m_pElemRoot, m_strRootElemName, m_strXmlFileName, m_xmlDoc, setErrorMsg(), and setModifiedState().

{
  if( strXmlFileName.empty() )
  {
    setErrorMsg("No file name.");
    LOGERROR("%s", m_bufErrMsg);
    return RC_ERROR;
  }

  m_strXmlFileName = strXmlFileName;

  // load and parse xml file
  if( !m_xmlDoc.LoadFile(m_strXmlFileName.c_str()) )
  {
    setErrorMsg("%s[r%d,c%d]: %s.",
        m_strXmlFileName.c_str(), m_xmlDoc.ErrorRow(),
        m_xmlDoc.ErrorCol(), m_xmlDoc.ErrorDesc());
    LOGERROR("%s", m_bufErrMsg);
    return RC_ERROR;
  }

  // <rootelem> ... </rootelem>
  m_pElemRoot = m_xmlDoc.RootElement();

  if( m_pElemRoot == NULL )
  {
    setErrorMsg("Not a valid %s XML document: No root <%s> element found.",
      m_strXmlFileName.c_str(), m_strRootElemName.c_str());
    LOGERROR("%s", m_bufErrMsg);
    return RC_ERROR;
  }

  else if( strcasecmp(m_pElemRoot->Value(), m_strRootElemName.c_str()) )
  {
    setErrorMsg("Not a valid %s XML document: Root <%s> element not <%s>.",
      m_strXmlFileName.c_str(), m_pElemRoot->Value(),
      m_strRootElemName.c_str());
    LOGERROR("%s", m_bufErrMsg);
    return RC_ERROR;
  }

  setModifiedState(false);

  LOGDIAG3("XMl document %s loaded.", m_strXmlFileName.c_str());
  
  return OK;
}

void Xml::makeXmlHead ( )

protectedvirtual

Make XML document head string.

The XML head string contains XML declarations plus the root element opening statement.

Definition at line 366 of file Xml.cxx.

References m_strRootElemName, m_strXmlHead, m_strXsiUrl, m_strXslUrl, rnr::XmlDecl, and rnr::XmlNsXsi.

Referenced by createTemplateFile().

{
  stringstream  ssStylesheetStmt;
  stringstream  ssRootStmt;
  stringstream  ssHead;

  // no stylesheet
  if( m_strXslUrl.empty() )
  {
    ssStylesheetStmt << "";
  }

  // xslt stylesheet
  else
  {
    ssStylesheetStmt << "<?xml-stylestheet type=\"text/xsl\" href=\""
                     << m_strXslUrl
                     << "\"?>\n";
  }

  // no schema
  if( m_strXsiUrl.empty() )
  {
    ssRootStmt << "<" << m_strRootElemName << ">";
  }

  // validation schema
  else
  {
    ssRootStmt << "<" << m_strRootElemName << " " << XmlNsXsi << "\n"
            << "    xsi:noNamespaceSchemaLocation=\"" << m_strXsiUrl << "\">";
  }
 
  ssHead << XmlDecl << "\n"
         << ssStylesheetStmt.str() << "\n"
         << ssRootStmt.str() << ">\n\n";

  m_strXmlHead = ssHead.str();
}

void Xml::makeXmlTail ( )

protectedvirtual

Make XML document tail string.

The XML tail string contains the root element closing statement.

Definition at line 406 of file Xml.cxx.

References m_strRootElemName, and m_strXmlTail.

Referenced by createTemplateFile().

{
  m_strXmlTail = "\n</" + m_strRootElemName + ">\n";
}

int Xml::saveFile ( const std::string &  strXmlFileName )

virtual

Save DOM to XML file.

Parameters

strXmlFileName

XML file path name.

Returns

On success, OK(0) is returned.
On error, RC_ERROR(-1) is returned.

Definition at line 143 of file Xml.cxx.

References m_bufErrMsg, m_strXmlFileName, m_xmlDoc, setErrorMsg(), and setModifiedState().

{
  if( strXmlFileName.empty() )
  {
    setErrorMsg("No file name.");
    LOGERROR("%s", m_bufErrMsg);
    return RC_ERROR;
  }

  m_strXmlFileName = strXmlFileName;

  // save xml file
  if( !m_xmlDoc.SaveFile(m_strXmlFileName.c_str()) )
  {
    setErrorMsg("%s[r%d,c%d]: %s.",
        m_strXmlFileName.c_str(), m_xmlDoc.ErrorRow(),
        m_xmlDoc.ErrorCol(), m_xmlDoc.ErrorDesc());
    LOGERROR("%s", m_bufErrMsg);
    return RC_ERROR;
  }
  
  setModifiedState(false);

  LOGDIAG3("XMl document %s saved.", m_strXmlFileName.c_str());

  return OK;
}

void Xml::setErrorMsg ( const char *  sFmt,   ...  )

protected

Set XML error message.

Parameters

sFmt	Format string.
...	Format variable arguments.

Definition at line 411 of file Xml.cxx.

References m_bufErrMsg.

Referenced by createTemplateFile(), fileExists(), loadFile(), and saveFile().

{
  va_list         ap;

  // format error message
  va_start(ap, sFmt);
  vsnprintf(m_bufErrMsg, sizeof(m_bufErrMsg), sFmt, ap);
  m_bufErrMsg[sizeof(m_bufErrMsg)-1] = 0;
  va_end(ap);
}

void rnr::Xml::setModifiedState ( bool  bModified )

inline

Set DOM modified state.

Parameters

bModified

Modified state: true or false.

Definition at line 216 of file Xml.h.

References m_bModified.

Referenced by loadFile(), and saveFile().

    {
      m_bModified = bModified;
    }

void rnr::Xml::setSchemaInstance ( const std::string &  strXsiUrl )

inline

Set XML document schema instance.

Parameters

strXsiUrl

URL of schema.

Definition at line 176 of file Xml.h.

References m_strXsiUrl.

    {
      m_strXsiUrl = strXsiUrl;
    }

void rnr::Xml::setStylesheet ( const std::string &  strXslUrl )

inline

Set XML Extended Style Sheet.

Parameters

strXslUrl

URL of stylesheet.

Definition at line 186 of file Xml.h.

References m_strXslUrl.

    {
      m_strXslUrl = strXslUrl;
    }

int Xml::strToDouble	(	const std::string &	str,
		double &	val
	)

Convert string to double-precision floating-point number.

Parameters

[in]	str	String in hex, decimal, or octal format.
[out]	val	Converted double value.

Returns

On success, OK(0) is returned.
On error, RC_ERROR(-1) is returned.

Definition at line 340 of file Xml.cxx.

Referenced by getErrorMsg().

{
  if( sscanf(str.c_str(), "%lf", &val) != 1 )
  {
    LOGERROR("%s: Bad floating-point number string representation.",
        str.c_str());
    return RC_ERROR;
  }


  return OK;
}

int Xml::strToInt	(	const std::string &	str,
		int &	val
	)

Convert string to integer.

Parameters

[in]	str	String in hex, decimal, or octal format.
[out]	val	Converted integer value.

Returns

On success, OK(0) is returned.
On error, RC_ERROR(-1) is returned.

Definition at line 298 of file Xml.cxx.

Referenced by getErrorMsg().

{
  long long int val1; // must use 64-bit for linaro 32bit

  if( sscanf(str.c_str(), "%lli", &val1) != 1 )
  {
    LOGERROR("%s: Bad integer string representation.", str.c_str());
    return RC_ERROR;
  }

  val = (int)val1;

  return OK;
}

---

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

• include/rnr/appkit/Xml.h
• sw/librnr_appkit/Xml.cxx