Xport Interface: procinstr::markup_type

Returns the mt_procinstr enumerator of xhtml_markup_type, to indicate the called markup object is a procinstr object.

Parameters

None

Returns

Returns mt_procinstr, which is an enumerator of xhtml_markup_type.

Remarks

This operation is used to determine the derived type of the called object derived from markup. This operation is overridden from all types derived from markup to return the respective enumerator for that type. This operation is overridden in procinstr to simply return the enumerator mt_procinstr.

Many object oriented experts feel that operations such as this, break the object oriented paradigm, and that there should be no reason to disclose the derived type of an object. In practice, however, this need often arises, so this operation is included for those events.

Complexity

Constant

Example

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

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

  document doc(root_doc);

  // create a php processing instruction which includes another file
  markup::iterator it = doc.begin();
  ++it;
  doc.insert(it, procinstr("php include 'somefile.htm';"));

  // write the document to cout
  formatter fmtr(std::cout);
  fmtr << doc;
  std::cout << "\n\n";

  // iterate over all markup objects to count the processing instructions in the doc
  int pi_count = 0;
  markup::const_descendant_iterator dit = doc.descendant_begin();
  for (; dit != doc.descendant_end(); ++dit) {
    if (dit->markup_type() == mt_processing_instruction) {
      ++pi_count;
    }
  }

  std::cout << "There is " << pi_count << " processing instruction(s) in the document.\n\n";

  return 0;
}