XmlStream Class Reference

Collaboration diagram for XmlStream:

Public Member Functions
	XmlStream (std::istream *is)
std::string	getTag (const XmlElement &e) const
std::string	getTag (int i) const
std::string	getStreamSection (const std::streampos &start, const std::streampos &end) const
void	findChildElements (int start, std::vector< int > &childIndices, int &podIndex) const
void	listAll () const

Public Attributes
std::vector< XmlElement >	elements

Private Member Functions
int	addNextTag ()
std::string	getTagName (const std::string &tag, tagType type) const
int	checkForPOD (const XmlElement &before, const XmlElement &after) const
int	startComment (long position, long length) const
int	endComment (long position, long length) const

Private Attributes
std::istream *	stream_

Detailed Description

Definition at line 54 of file XmlRep.h.

Constructor & Destructor Documentation

XmlStream()

XmlStream

(

std::istream *

is

)

Definition at line 358 of file XmlRep.cpp.

References addNextTag(), checkForPOD(), elements, XmlElement::endLoc, pod, XmlElement::startLoc, and XmlElement::type.

                                   : stream_(is)
{
  // on first pass, try to find all of the tags and encode their names
  while (addNextTag() != -1) {}

  //now go through and look at space between live tags and see if there is POD there
  std::vector<XmlElement> tags;
  elements.swap(tags);

  elements.push_back(tags[0]);
  for (int i = 1; i < tags.size(); i++)
  {
    if (checkForPOD(tags[i - 1], tags[i]) == 1)
    {
      // add POD element
      XmlElement podElem;
      podElem.startLoc = tags[i - 1].endLoc;
      podElem.endLoc   = tags[i].startLoc;
      podElem.type     = tagType::pod;
      elements.push_back(podElem);
    }
    elements.push_back(tags[i]);
  }
}

Member Function Documentation

addNextTag()

int addNextTag ( )

private

Definition at line 146 of file XmlRep.cpp.

References closing, XmlElement::endLoc, XmlElement::name, opening, selfClosing, XmlElement::startLoc, and XmlElement::type.

Referenced by XmlStream().

{
  std::streampos start;
  std::streampos end;
  int twoprev = 0;
  int prev    = 0;
  int current = 0;

  int isProcessingInstruction = 0;
  int isComment               = 0;
  int isClosingTag            = 0;
  int isSelfClosing           = 0;

  int openCaretFound  = 0;
  int closeCaretFound = 0;

  int numSingleQuotes = 0;
  int numDoubleQuotes = 0;
  while ((current = stream_->get()) && current != EOF && closeCaretFound == 0)
  {
    if (current == '<')
    {
      if (prev != '\\')
      {
        // we found a live start string
        stream_->unget();
        start = stream_->tellg();
        stream_->get();
        openCaretFound = 1;
      }
      int one   = stream_->get();
      int two   = stream_->get();
      int three = stream_->get();
      if (one == '\?')
      {
        isProcessingInstruction = 1;
      }
      if (one == '!' && two == '-' && three == '-')
      {
        isComment = 1;
      }
      if (one == '/')
      {
        isClosingTag = 1;
      }
      stream_->unget();
      stream_->unget();
      stream_->unget();
    }
    if (openCaretFound == 1)
    {
      if (current == '\'')
      {
        numSingleQuotes++;
      }
      else if (current == '\"')
      {
        numDoubleQuotes++;
      }
      else if (current == '>')
      {
        // check that we aren't currently in a quoted section
        if (numSingleQuotes % 2 == 0 && numDoubleQuotes % 2 == 0)
        {
          // check that this close caret isn't escaped
          if (prev != '\\')
          {
            if (isComment == 1)
            {
              if (prev == '-' && twoprev == '-')
              {
                closeCaretFound = 1;
                end             = stream_->tellg();
              }
            }
            else
            {
              closeCaretFound = 1;
              end             = stream_->tellg();
              if (prev == '/')
              {
                isSelfClosing = 1;
              }
            }
          }
        }
      }
    }
    twoprev = prev;
    prev    = current;
  }

  if (current == EOF)
  {
    stream_->clear();
    stream_->seekg(0);
    return -1;
  }

  if (isProcessingInstruction == 0 && isComment == 0)
  {
    XmlElement elem;
    elem.startLoc = start;
    elem.endLoc   = end;

    if (isSelfClosing == 1)
    {
      elem.type = tagType::selfClosing;
    }
    else if (isClosingTag == 1)
    {
      elem.type = tagType::closing;
    }
    else
    {
      elem.type = tagType::opening;
      stream_->unget();
    }
    elem.name = getTagName(getTag(elem), elem.type);
    elements.push_back(elem);
    return 1;
  }
  if (isProcessingInstruction == 1 || isComment == 1)
  {
    stream_->unget();
    return 0;
  }
  return -1;
}

checkForPOD()

int checkForPOD ( const XmlElement &  before, const XmlElement &  after  ) const

private

Definition at line 92 of file XmlRep.cpp.

References XmlElement::endLoc, and XmlElement::startLoc.

Referenced by XmlStream().

{
  int foundPOD          = 0;
  std::streampos curLoc = stream_->tellg();

  stream_->seekg(before.endLoc);

  long length   = after.startLoc - before.endLoc;
  long position = 0;
  int c;
  int inComment = 0;
  while (foundPOD == 0 && position < length)
  {
    c = stream_->get();
    if (!isspace(c))
    {
      //if (!isspace(c) && c != '\n') {
      stream_->unget();
      // if we're in a comment, check that we are not ending it
      if (inComment == 1)
      {
        if (endComment(position, length) == 1)
        {
          // position ourselves after the end comment tag
          stream_->seekg(3, std::ios_base::cur);
          position += 3;
          inComment = 0;
        }
      }
      else
      {
        // if we're not in a comment, check that we aren't starting one
        if (endComment(position, length) == 1)
        {
          // position ourselves after the comment tag
          stream_->seekg(4, std::ios_base::cur);
          position += 4;
          inComment = 1;
        }
        else
        {
          // we've found POD !!
          foundPOD = 1;
        }
      }
    }
    position++;
  }

  stream_->seekg(curLoc);
  return foundPOD;
}

endComment()

int endComment ( long  position, long  length  ) const

private

Definition at line 75 of file XmlRep.cpp.

{
  int isCommentEnd      = 0;
  std::streampos curLoc = stream_->tellg();
  if ((length - position) > 3)
  {
    char buf[3];
    stream_->read(buf, 3);
    if (strncmp(buf, "-->", 3) == 0)
    {
      isCommentEnd = 1;
    }
  }
  stream_->seekg(curLoc);
  return isCommentEnd;
}

findChildElements()

void findChildElements	(	int	start,
		std::vector< int > &	childIndices,
		int &	podIndex
	)		const

Definition at line 290 of file XmlRep.cpp.

References closing, opening, pod, and selfClosing.

Referenced by XmlNode::createFromStream().

{
  int index = start + 1;
  int level = 1;

  while (index < elements.size() && level > 0)
  {
    const tagType tt = elements[index].type;
    if (tt == tagType::opening)
    {
      if (level == 1)
      {
        childIndices.push_back(index);
      }
      level++;
    }
    else if (tt == tagType::closing)
    {
      level--;
    }
    else if (tt == tagType::selfClosing)
    {
      if (level == 1)
      {
        childIndices.push_back(index);
      }
    }
    else if (tt == tagType::pod)
    {
      if (level == 1)
      {
        podIndex = index;
      }
    }
    else
    {
      //cout << "There is an error, in findChildElements and the XmlElement at index: " << index << " did not have a recognized tag type" << endl;
      exit(1);
    }
    index++;
  }
}

getStreamSection()

string getStreamSection	(	const std::streampos &	start,
		const std::streampos &	end
	)		const

Definition at line 276 of file XmlRep.cpp.

Referenced by getTag().

{
  // save current place in the stream
  std::streampos curLoc = stream_->tellg();

  std::string result(end - start, '\0');
  stream_->seekg(start);
  stream_->read(result.data(), end - start);

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

getTag() [1/2]

string getTag

(

const XmlElement &

e

)

const

Definition at line 384 of file XmlRep.cpp.

References qmcplusplus::Units::charge::e, and getStreamSection().

Referenced by getTag(), and XmlNode::handleTagString().

{ return getStreamSection(e.startLoc, e.endLoc); }

getTag() [2/2]

string getTag

(

int

i

)

const

Definition at line 386 of file XmlRep.cpp.

References elements, and getTag().

{
  if (i >= elements.size())
  {
    cerr << "requested a tag index past the end of the vector" << endl;
    exit(1);
  }
  return getTag(elements[i]);
}

getTagName()

string getTagName ( const std::string &  tag, tagType  type  ) const

private

Definition at line 18 of file XmlRep.cpp.

References closing, and selfClosing.

{
  string tagName;

  size_t spaceLoc = tagstr.find(" ");
  size_t closeLoc = tagstr.find('>');
  size_t slashLoc = string::npos;

  if (type == tagType::selfClosing)
  {
    slashLoc = tagstr.find("/");
  }

  int endChar = tagstr.size();
  if (spaceLoc != string::npos)
  {
    endChar = spaceLoc;
  }
  if (closeLoc < endChar && closeLoc != string::npos)
  {
    endChar = closeLoc;
  }
  if (slashLoc < endChar && slashLoc != string::npos)
  {
    endChar = slashLoc;
  }

  if (type == tagType::closing)
  {
    endChar -= 2;
    tagName = tagstr.substr(2, endChar);
  }
  else
  {
    endChar -= 1;
    tagName = tagstr.substr(1, endChar);
  }
  return tagName;
}

listAll()

void listAll

(

)

const

Definition at line 333 of file XmlRep.cpp.

References closing, opening, pod, and selfClosing.

{
  for (int i = 0; i < elements.size(); i++)
  {
    std::cout << i << "   ";
    tagType tt = elements[i].type;
    if (tt == tagType::opening)
    {
      std::cout << "opening, name = " << elements[i].name << std::endl;
    }
    else if (tt == tagType::closing)
    {
      std::cout << "closing, name = " << elements[i].name << std::endl;
    }
    else if (tt == tagType::selfClosing)
    {
      std::cout << "selfClosing, name = " << elements[i].name << std::endl;
    }
    else if (tt == tagType::pod)
    {
      std::cout << "POD" << std::endl;
    }
  }
}

startComment()

int startComment ( long  position, long  length  ) const

private

Definition at line 58 of file XmlRep.cpp.

{
  int isCommentStart    = 0;
  std::streampos curLoc = stream_->tellg();
  if ((length - position) > 4)
  {
    char buf[4];
    stream_->read(buf, 4);
    if (strncmp(buf, "<!--", 4) == 0)
    {
      isCommentStart = 1;
    }
  }
  stream_->seekg(curLoc);
  return isCommentStart;
}

Member Data Documentation

elements

std::vector<XmlElement> elements

Definition at line 75 of file XmlRep.h.

Referenced by XmlNode::createFromStream(), getTag(), XmlNode::handleTagString(), and XmlStream().

stream_

std::istream* stream_

private

Definition at line 72 of file XmlRep.h.

---

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