XmlNode Class Reference

Collaboration diagram for XmlNode:

Public Types
using	attrpair = std::pair< std::string, std::string >

Public Member Functions
std::string	getName () const
template<typename T >
void	setName (const T &val)
int	getAttributeIndex (const std::string &name, int strict=0) const
template<typename T >
void	getAttribute (const std::string &name, T &result) const
template<typename T >
void	getAttribute (const char *name, T &result) const
std::string	getAttribute (const std::string &name) const
std::string	getAttribute (const char *name) const
std::string	getAttribute (int index) const
std::string	getAttributeName (int index) const
int	getNumAttributes () const
template<typename T , typename TT >
void	addAttribute (const T &n, const TT &v)
template<typename T >
void	addYesNoAttribute (const T &n, int i)
template<typename T >
void	getValue (T &result) const
template<typename T >
void	getValue (std::vector< T > &result) const
std::string	getValue () const
int	getValueSize () const
template<typename T >
void	setValue (const T &v)
int	getNumChildren () const
int	getChildIndex (const std::string &name, int strict=0) const
XmlNode &	getChild (const std::string &name)
const XmlNode &	getChild (const std::string &name) const
const XmlNode &	getChild (int i) const
XmlNode &	getChild (int i)
XmlNode &	addChild (const XmlNode &nd)
XmlNode &	addChild ()
template<typename T , typename TT >
void	addParameterChild (const T &n, const TT &v)
template<typename T >
void	addYesNoParameterChild (const T &n, int v)
	XmlNode ()
	XmlNode (std::istream *stream, int start=0, bool deferValue=false)
	XmlNode (const XmlStream &xstream, std::istream *const stream, int start, bool deferValue=false)
	XmlNode (const XmlNode &c)
void	write (std::ostream &os, int indentLevel=0) const
std::string	getString (int indentLevel=0) const

Private Member Functions
void	readToString (std::string &s) const
void	createFromStream (const XmlStream &stream, int start=0, bool deferValue=true)
std::string	getInStr (int is) const
std::string	trimWhitespace (const std::string &str) const
size_t	getPosNextLiveChar (const std::string &str, char c) const
void	getNextKeyVal (std::string &contentstr, std::string &key, std::string &val) const
void	handleTagString (const XmlStream &xs, int loc)

Private Attributes
bool	isSelfClosing_
std::string	name_
std::vector< attrpair >	attributes_
bool	valInline_
std::string	value_
bool	valueDeferred_
std::streampos	podStart_
std::streampos	podEnd_
std::vector< XmlNode >	children_
std::istream *	stream_

Detailed Description

Definition at line 81 of file XmlRep.h.

Member Typedef Documentation

attrpair

using attrpair = std::pair<std::string, std::string>

Definition at line 84 of file XmlRep.h.

Constructor & Destructor Documentation

XmlNode() [1/4]

XmlNode ( )

inline

Definition at line 164 of file XmlRep.h.

References isSelfClosing_, valInline_, and valueDeferred_.

            : stream_(NULL)
  {
    isSelfClosing_ = false;
    valueDeferred_ = false;
    valInline_     = false;
  }

XmlNode() [2/4]

XmlNode	(	std::istream *	stream,
		int	start = 0,
		bool	deferValue = false
	)

XmlNode() [3/4]

XmlNode	(	const XmlStream &	xstream,
		std::istream *const	stream,
		int	start,
		bool	deferValue = false
	)

Definition at line 722 of file XmlRep.cpp.

References createFromStream().

                                                                                                : stream_(_stream)
{
  createFromStream(xstream, start, deferValue);
}

XmlNode() [4/4]

XmlNode

(

const XmlNode &

c

)

Definition at line 701 of file XmlRep.cpp.

References attributes_, children_, isSelfClosing_, name_, podEnd_, podStart_, valInline_, value_, and valueDeferred_.

                                 : stream_(c.stream_)
{
  isSelfClosing_ = c.isSelfClosing_;
  name_          = c.name_;
  attributes_    = c.attributes_;
  valInline_     = c.valInline_;
  value_         = c.value_;
  valueDeferred_ = c.valueDeferred_;
  podStart_      = c.podStart_;
  podEnd_        = c.podEnd_;
  children_      = c.children_;
}

Member Function Documentation

addAttribute()

void addAttribute	(	const T &	n,
		const TT &	v
	)

Definition at line 252 of file XmlRep.h.

References attributes_, and qmcplusplus::n.

Referenced by addParameterChild().

{
  std::stringstream ss1;
  ss1 << n;
  std::stringstream ss2;
  ss2 << v;
  attrpair ap(ss1.str(), ss2.str());
  attributes_.push_back(ap);
}

addChild() [1/2]

XmlNode & addChild

(

const XmlNode &

nd

)

Definition at line 541 of file XmlRep.cpp.

References children_.

{
  children_.push_back(nd);
  return children_.back();
}

addChild() [2/2]

XmlNode & addChild

(

)

Definition at line 547 of file XmlRep.cpp.

References children_.

Referenced by addParameterChild().

{
  XmlNode nd;
  children_.push_back(nd);
  return children_.back();
}

addParameterChild()

void addParameterChild	(	const T &	n,
		const TT &	v
	)

Definition at line 281 of file XmlRep.h.

References addAttribute(), addChild(), qmcplusplus::n, setName(), setValue(), and valInline_.

Referenced by addYesNoParameterChild().

{
  XmlNode nd;
  nd.setName("parameter");
  nd.addAttribute("name", n);
  nd.valInline_ = true;
  nd.setValue(v);
  addChild(nd);
}

addYesNoAttribute()

void addYesNoAttribute	(	const T &	n,
		int	i
	)

Definition at line 263 of file XmlRep.h.

References attributes_, and qmcplusplus::n.

{
  std::stringstream ss;
  ss << n;
  attrpair ap;
  ap.first = ss.str();
  if (i == 0)
  {
    ap.second = "no";
  }
  else
  {
    ap.second = "yes";
  }
  attributes_.push_back(ap);
}

addYesNoParameterChild()

void addYesNoParameterChild	(	const T &	n,
		int	v
	)

Definition at line 292 of file XmlRep.h.

References addParameterChild(), and qmcplusplus::n.

{
  std::string vstr;
  if (v == 0)
  {
    vstr = "no";
  }
  else
  {
    vstr = "yes";
  }
  addParameterChild(n, vstr);
}

createFromStream()

void createFromStream ( const XmlStream &  stream, int  start = 0, bool  deferValue = true  )

private

Definition at line 727 of file XmlRep.cpp.

References children_, XmlStream::elements, XmlStream::findChildElements(), handleTagString(), isSelfClosing_, podEnd_, podStart_, readToString(), selfClosing, stream_, valInline_, value_, and valueDeferred_.

Referenced by XmlNode().

{
  valueDeferred_ = deferValue;
  valInline_     = false;

  // this will populate the name and attributes
  handleTagString(xstream, start);
  tagType tt = xstream.elements[start].type;
  if (tt == tagType::selfClosing)
  {
    // if self closing, then there is not POD and we are at the end
    isSelfClosing_ = true;
  }
  else
  {
    // otherwise need to look for POD and subtags
    isSelfClosing_ = false;

    vector<int> childIndices;
    int podIndex = -1;
    xstream.findChildElements(start, childIndices, podIndex);

    // if no children, try to put and POD inline
    if (childIndices.size() == 0)
    {
      valInline_ = true;
    }
    else
    {
      valInline_ = false;
    }

    // deal with POD if it exists
    if (podIndex > 0)
    {
      podStart_ = xstream.elements[podIndex].startLoc;
      podEnd_   = xstream.elements[podIndex].endLoc;
      if (valueDeferred_ == false)
      {
        valueDeferred_ = true;
        readToString(value_);
        valueDeferred_ = false;
      }
    }

    // now sequentially create XmlNodes from subelements and add them to children vector
    for (int i = 0; i < childIndices.size(); i++)
    {
      XmlNode child(xstream, this->stream_, childIndices[i], valueDeferred_);
      children_.push_back(child);
    }
  }
}

getAttribute() [1/5]

void getAttribute	(	const std::string &	name,
		T &	result
	)		const

Definition at line 191 of file XmlRep.h.

References attributes_, and getAttributeIndex().

Referenced by getAttribute(), EshdfFile::handleDensity(), EshdfFile::processKPts(), EshdfFile::readInEigFcn(), EshdfFile::writeQboxAtoms(), EshdfFile::writeQboxElectrons(), EshdfFile::writeQboxSupercell(), EshdfFile::writeQEAtoms(), and EshdfFile::writeQEBoilerPlate().

{
  std::string value = attributes_[getAttributeIndex(name, 1)].second;
  std::stringstream ss(value);
  ss >> result;
}

getAttribute() [2/5]

void getAttribute	(	const char *	name,
		T &	result
	)		const

Definition at line 199 of file XmlRep.h.

References getAttribute().

{
  std::string sname(name);
  return getAttribute(sname, result);
}

getAttribute() [3/5]

string getAttribute

(

const std::string &

name

)

const

Definition at line 513 of file XmlRep.cpp.

References attributes_, and getAttributeIndex().

{ return attributes_[getAttributeIndex(name, 1)].second; }

getAttribute() [4/5]

string getAttribute

(

const char *

name

)

const

Definition at line 515 of file XmlRep.cpp.

References getAttribute().

{
  string sname(name);
  return getAttribute(sname);
}

getAttribute() [5/5]

string getAttribute

(

int

index

)

const

Definition at line 502 of file XmlRep.cpp.

References attributes_, and name_.

{
  if (index < 0 || index >= attributes_.size())
  {
    cerr << "in XmlNode with name: " << name_ << ", requested attribute with index " << index
         << ", but this index is not present." << endl;
    exit(1);
  }
  return attributes_[index].second;
}

getAttributeIndex()

int getAttributeIndex	(	const std::string &	name,
		int	strict = 0
	)		const

Definition at line 482 of file XmlRep.cpp.

References attributes_, and name_.

Referenced by getAttribute(), and EshdfFile::writeQboxElectrons().

{
  int index = -1;
  for (int i = 0; i < attributes_.size(); i++)
  {
    if (attributes_[i].first == attrName)
    {
      index = i;
    }
  }
  if (strict != 0 && index < 0)
  {
    cerr << "In XmlNode with name: " << name_ << ", could not find index for attribute with name: " << attrName << endl;
    exit(1);
  }
  return index;
}

getAttributeName()

string getAttributeName

(

int

index

)

const

Definition at line 500 of file XmlRep.cpp.

References attributes_.

{ return attributes_[index].first; }

getChild() [1/4]

XmlNode & getChild

(

const std::string &

name

)

Definition at line 458 of file XmlRep.cpp.

References getChildIndex().

Referenced by getChild(), EshdfFile::getOccupation(), EshdfFile::getPtvs(), EshdfFile::handleDensity(), EshdfFile::handleSpinGroup(), EshdfFile::processKPts(), EshdfFile::writeQboxAtoms(), EshdfFile::writeQboxBoilerPlate(), EshdfFile::writeQboxElectrons(), EshdfFile::writeQboxSupercell(), EshdfFile::writeQEAtoms(), EshdfFile::writeQEBoilerPlate(), EshdfFile::writeQEElectrons(), and EshdfFile::writeQESupercell().

{ return getChild(getChildIndex(name, 1)); }

getChild() [2/4]

const XmlNode & getChild

(

const std::string &

name

)

const

Definition at line 460 of file XmlRep.cpp.

References getChild(), and getChildIndex().

{ return getChild(getChildIndex(name, 1)); }

getChild() [3/4]

const XmlNode & getChild

(

int

i

)

const

Definition at line 472 of file XmlRep.cpp.

References children_, and getNumChildren().

{
  if (i < 0 || i >= children_.size())
  {
    cerr << "Asked to get child node: " << i << ", but there are only " << getNumChildren() << "nodes" << endl;
    exit(1);
  }
  return children_[i];
}

getChild() [4/4]

XmlNode & getChild

(

int

i

)

Definition at line 462 of file XmlRep.cpp.

References children_, and getNumChildren().

{
  if (i < 0 || i >= children_.size())
  {
    cerr << "Asked to get child node: " << i << ", but there are only " << getNumChildren() << "nodes" << endl;
    exit(1);
  }
  return children_[i];
}

getChildIndex()

int getChildIndex	(	const std::string &	name,
		int	strict = 0
	)		const

Definition at line 440 of file XmlRep.cpp.

References children_, getName(), and name_.

Referenced by getChild().

{
  int index = -1;
  for (int i = 0; i < children_.size(); i++)
  {
    if (children_[i].getName() == childName)
    {
      index = i;
    }
  }
  if (strict != 0 && index < 0)
  {
    cerr << "In XmlNode with name: " << name_ << ", could not find index for child with name: " << childName << endl;
    exit(1);
  }
  return index;
}

getInStr()

std::string getInStr ( int  is ) const

private

Definition at line 647 of file XmlRep.cpp.

Referenced by getString().

{
  std::stringstream ss;
  for (int i = 0; i < is; i++)
  {
    ss << " ";
  }
  return ss.str();
}

getName()

std::string getName ( ) const

inline

Definition at line 114 of file XmlRep.h.

References name_.

Referenced by getChildIndex(), EshdfFile::handleSpinGroup(), EshdfFile::processKPts(), EshdfFile::writeQboxAtoms(), EshdfFile::writeQboxElectrons(), and EshdfFile::writeQEAtoms().

{ return name_; }

getNextKeyVal()

void getNextKeyVal ( std::string &  contentstr, std::string &  key, std::string &  val  ) const

private

Definition at line 600 of file XmlRep.cpp.

References getPosNextLiveChar(), and trimWhitespace().

Referenced by handleTagString().

{
  size_t breakone = getPosNextLiveChar(contentstr, '=');

  key = contentstr.substr(0, breakone);
  key = trimWhitespace(key);
  //cout << "in getNextKeyVal, key = \'" << key << "\'" << endl;
  contentstr = contentstr.substr(breakone + 1);

  size_t firstquote = getPosNextLiveChar(contentstr, '\"');
  if (firstquote == string::npos)
  {
    firstquote = getPosNextLiveChar(contentstr, '\'');
  }
  contentstr         = contentstr.substr(firstquote + 1);
  size_t secondquote = getPosNextLiveChar(contentstr, '\"');
  if (secondquote == string::npos)
  {
    secondquote = getPosNextLiveChar(contentstr, '\'');
  }
  val = contentstr.substr(0, secondquote);
  val = trimWhitespace(val);

  contentstr = contentstr.substr(secondquote + 1);
}

getNumAttributes()

int getNumAttributes ( ) const

inline

Definition at line 133 of file XmlRep.h.

References attributes_.

{ return attributes_.size(); }

getNumChildren()

int getNumChildren ( ) const

inline

Definition at line 150 of file XmlRep.h.

References children_.

Referenced by getChild(), EshdfFile::handleSpinGroup(), EshdfFile::processKPts(), EshdfFile::writeQboxAtoms(), EshdfFile::writeQboxElectrons(), and EshdfFile::writeQEAtoms().

{ return children_.size(); }

getPosNextLiveChar()

size_t getPosNextLiveChar ( const std::string &  str, char  c  ) const

private

Definition at line 626 of file XmlRep.cpp.

Referenced by getNextKeyVal().

{
  size_t index = string::npos;
  if (str[0] == c)
  {
    index = 0;
  }
  else
  {
    for (int i = 1; i < str.size(); i++)
    {
      if (str[i] == c && str[i - 1] != '\\')
      {
        index = i;
        break;
      }
    }
  }
  return index;
}

getString()

string getString

(

int

indentLevel = 0

)

const

Definition at line 663 of file XmlRep.cpp.

References attributes_, children_, getInStr(), getValue(), getValueSize(), isSelfClosing_, name_, and valInline_.

Referenced by write().

{
  stringstream ss;
  ss << getInStr(indentLevel);
  ss << "<" << name_;

  for (int i = 0; i < attributes_.size(); i++)
  {
    ss << " " << attributes_[i].first << "=\"" << attributes_[i].second << "\"";
  }
  if (isSelfClosing_ == 1)
  {
    ss << "/>" << endl;
    return ss.str();
  }
  else
  {
    ss << ">";
  }
  if (valInline_)
  {
    ss << getValue() << "</" << name_ << ">" << endl;
  }
  else
  {
    ss << endl;
    for (int i = 0; i < children_.size(); i++)
    {
      ss << children_[i].getString(indentLevel + 2);
    }

    if (getValueSize() > 0)
      ss << getInStr(indentLevel + 2) << getValue() << endl;
    ss << getInStr(indentLevel) << "</" << name_ << ">" << endl;
  }
  return ss.str();
}

getValue() [1/3]

void getValue

(

T &

result

)

const

Definition at line 206 of file XmlRep.h.

References readToString(), value_, and valueDeferred_.

Referenced by EshdfFile::getOccupation(), EshdfFile::getPtvs(), EshdfFile::handleDensity(), EshdfFile::processKPts(), EshdfFile::readInEigFcn(), EshdfFile::writeQboxAtoms(), EshdfFile::writeQboxBoilerPlate(), EshdfFile::writeQEAtoms(), EshdfFile::writeQEElectrons(), and EshdfFile::writeQESupercell().

{
  if (valueDeferred_)
  {
    std::string val;
    readToString(val);
    std::stringstream ss(val);
    ss >> result;
  }
  else
  {
    std::stringstream ss(value_);
    ss >> result;
  }
}

getValue() [2/3]

void getValue

(

std::vector< T > &

result

)

const

Definition at line 222 of file XmlRep.h.

References readToString(), value_, and valueDeferred_.

{
  std::stringstream ss;
  if (valueDeferred_)
  {
    std::string val;
    readToString(val);
    ss << val;
  }
  else
  {
    ss << value_;
  }
  T temp;
  while (ss >> temp)
  {
    result.push_back(temp);
  }
}

getValue() [3/3]

std::string getValue

(

)

const

Definition at line 521 of file XmlRep.cpp.

References readToString(), value_, and valueDeferred_.

Referenced by getString().

{
  if (valueDeferred_)
  {
    std::string val;
    readToString(val);
    return val;
  }
  return value_;
}

getValueSize()

int getValueSize

(

)

const

Definition at line 532 of file XmlRep.cpp.

References podEnd_, podStart_, value_, and valueDeferred_.

Referenced by getString().

{
  if (valueDeferred_)
  {
    return (podEnd_ - podStart_);
  }
  return value_.size();
}

handleTagString()

void handleTagString ( const XmlStream &  xs, int  loc  )

private

Definition at line 566 of file XmlRep.cpp.

References attributes_, XmlStream::elements, getNextKeyVal(), XmlStream::getTag(), isSelfClosing_, XmlElement::name, name_, selfClosing, trimWhitespace(), and XmlElement::type.

Referenced by createFromStream().

{
  const XmlElement& elem = xs.elements[loc];
  name_                  = elem.name;
  string tagstr          = xs.getTag(elem);
  if (elem.type == tagType::selfClosing)
  {
    isSelfClosing_ = true;
  }
  else
  {
    isSelfClosing_ = false;
  }

  // take everything after the name
  string decliningstring = tagstr.substr(tagstr.find(name_) + name_.size() + 1);

  // remove trailing > or /> if appropriate and trim whitespace from left and right ends
  int numToRemove = 1;
  if (isSelfClosing_)
  {
    numToRemove++;
  }
  decliningstring = decliningstring.substr(0, decliningstring.size() - numToRemove);
  decliningstring = trimWhitespace(decliningstring);

  while (decliningstring.size() > 1)
  {
    attrpair att;
    getNextKeyVal(decliningstring, att.first, att.second);
    attributes_.push_back(att);
  }
}

readToString()

void readToString ( std::string &  s ) const

private

Definition at line 396 of file XmlRep.cpp.

References podEnd_, podStart_, qmcplusplus::Units::time::s, stream_, value_, and valueDeferred_.

Referenced by createFromStream(), and getValue().

{
  if (valueDeferred_)
  {
    std::streampos curLoc = stream_->tellg();

    s.resize(podEnd_ - podStart_);
    stream_->seekg(podStart_);
    stream_->read(s.data(), podEnd_ - podStart_);

    // go back to current place in the stream
    stream_->seekg(curLoc);

    // now strip out any xml comments
    std::stringstream ss;
    int commentStart = -1;
    int commentEnd   = 0;

    // if we find a comment, will put everything but the comments in ss
    while (s.find("<!--", commentEnd) != string::npos)
    {
      commentStart = s.find("<!--", commentEnd);
      ss << s.substr(commentEnd, commentStart - commentEnd);
      commentEnd = s.find("-->", commentStart);
    }
    // this means we didn't find a comment, so the string s is OK to return
    if (commentStart == -1)
    {
      return;
    }
    else
    {
      // we found comments and we're putting everything after the last comment in ss
      ss << s.substr(commentEnd + 3, s.size() - commentEnd - 3);
    }
    s = ss.str();
  }
  else
  {
    s = value_;
  }
}

setName()

void setName

(

const T &

val

)

Definition at line 183 of file XmlRep.h.

References name_.

Referenced by addParameterChild().

{
  std::stringstream ss;
  ss << val;
  name_ = ss.str();
}

setValue()

void setValue

(

const T &

v

)

Definition at line 243 of file XmlRep.h.

References value_, and valueDeferred_.

Referenced by addParameterChild().

{
  valueDeferred_ = false;
  std::stringstream ss;
  ss << v;
  value_ = ss.str();
}

trimWhitespace()

string trimWhitespace ( const std::string &  str ) const

private

Definition at line 555 of file XmlRep.cpp.

Referenced by getNextKeyVal(), and handleTagString().

{
  size_t first = str.find_first_not_of(" \n\t\v\f\r");
  if (string::npos == first)
  {
    return string("");
  }
  size_t last = str.find_last_not_of(" \n\t\v\f\r");
  return str.substr(first, (last - first + 1));
}

write()

void write	(	std::ostream &	os,
		int	indentLevel = 0
	)		const

Definition at line 657 of file XmlRep.cpp.

References getString().

{
  string str = getString(indentLevel);
  os << str;
}

Member Data Documentation

attributes_

std::vector<attrpair> attributes_

private

Definition at line 90 of file XmlRep.h.

Referenced by addAttribute(), addYesNoAttribute(), getAttribute(), getAttributeIndex(), getAttributeName(), getNumAttributes(), getString(), handleTagString(), and XmlNode().

children_

std::vector<XmlNode> children_

private

Definition at line 97 of file XmlRep.h.

Referenced by addChild(), createFromStream(), getChild(), getChildIndex(), getNumChildren(), getString(), and XmlNode().

isSelfClosing_

bool isSelfClosing_

private

Definition at line 88 of file XmlRep.h.

Referenced by createFromStream(), getString(), handleTagString(), and XmlNode().

name_

std::string name_

private

Definition at line 89 of file XmlRep.h.

Referenced by getAttribute(), getAttributeIndex(), getChildIndex(), getName(), getString(), handleTagString(), setName(), and XmlNode().

podEnd_

std::streampos podEnd_

private

Definition at line 96 of file XmlRep.h.

Referenced by createFromStream(), getValueSize(), readToString(), and XmlNode().

podStart_

std::streampos podStart_

private

Definition at line 95 of file XmlRep.h.

Referenced by createFromStream(), getValueSize(), readToString(), and XmlNode().

stream_

std::istream* stream_

private

Definition at line 98 of file XmlRep.h.

Referenced by createFromStream(), and readToString().

valInline_

bool valInline_

private

Definition at line 91 of file XmlRep.h.

Referenced by addParameterChild(), createFromStream(), getString(), and XmlNode().

value_

std::string value_

private

Definition at line 92 of file XmlRep.h.

Referenced by createFromStream(), getValue(), getValueSize(), readToString(), setValue(), and XmlNode().

valueDeferred_

bool valueDeferred_

private

Definition at line 93 of file XmlRep.h.

Referenced by createFromStream(), getValue(), getValueSize(), readToString(), setValue(), and XmlNode().

---

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

• /home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/QMCTools/XmlRep.h
• /home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/QMCTools/XmlRep.cpp