Xport Interface: document::end

returns a child iterator pointing just past the last markup object in the document.

markup::iterator document::end();1st Variety

markup::const_iterator document::end() const;2nd Variety

Parameters

none

Returns

A child markup iterator (or const_iterator in the second variety) pointing just past the last markup object in the document.

Remarks

This operation is normally used to mark the end of a child iteration. For this to work properly, the iterator should be compared to end(). When this condition is true, the child iterator has already reached the end. This is consistant with the iterators of the STL.

Complexity

Constant

Example

#include "xhtml_doc.h"
#include <string>
#include <cassert>

template<typename DT> void parse_document(Xport::xhtml_doc<DT, char>& doc);

int main(int argc, char* argv[])
{
  using namespace Xport;

  // create an xhtml transitional root document
  tdocument doc(root_doc);

  // iterate over all markup objects, and output the element names
  tmarkup::const_iterator it = doc.begin();
  for (; it != doc.end(); ++it) {
    if (it->markup_type() == mt_element) {
      std::cout << "Encountered the element <" << it->tag_name() << ">\n";
    }
  }

  return 0;
}