Xport Interface: document::descendant_end

Returns a descendant iterator pointing just past the last pre-order descendant markup object in the document.

markup::descendant_iterator document::descendant_end();1st Variety

markup::const_descendant_iterator document::descendant_end() const;2nd Variety

Parameters

None

Returns

Returns a descendant_iterator, (or const_descendant_iterator in the 2nd variety), which points just past the last descendant markup object in the document. By nature of pre-order traversals, this the last pre-order descendant node would be the right most descendant node at the deepest level.

Remarks

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

Complexity

Constant

Example

#include "xhtml_doc.h"
#include "xport_brochure.h"
#include <iostream>
#include <algorithm>

// create a unary predicate which checks for the code element
bool is_code(Xport::markup& mkup) {return mkup.tag() == Xport::code; }
int main(int argc, char* argv[])
{
  using namespace Xport;

  // create an xhtml strict root doc
  document doc(root_doc);
  stylesheet ss;

  // create xport brochure
  xport_brochure brochure;
  brochure.create(doc, ss);

  // count the number of code elements in the document
  markup::size_type code_count = std::count_if(doc.descendant_begin(), doc.descendant_end(), is_code);
  std::cout << "Xport Brochure contains " << code_count << " code elements.\n";
  return 0;
}