NAME

SGML::ElementMap::Driver - Perl base class for controlling SGML/XML oriented processing


SYNOPSIS

  $obj = new SGML::ElementMap;
  $driver = new SGML::ElementMap::Driver::Grove;
  $obj->set_driver($driver);
  $driver->process($obj,$grove_root);
  $obj->set_driver("SGML::ElementMap::Driver::SAXParser");
  $obj->process_file($filename);
  package SGML::ElementMap::Driver::SOME_MODULE;
  @ISA = qw( SGML::ElementMap::Driver );
  # ...


DESCRIPTION

To facilitate different uses, code managing the interface to the parser or grove resides in interchangeable Driver modules. The module can implicitly select the Grove driver, so the Driver interface can be safely ignored.

parser()

Pass a parser object, or the class name for a parser object to instantiate. Returns the old parser or undef if there was a problem.

markup()

Pass the type of markup to parse, either SGML or XML. Returning zero means the driver can't do that markup.

input()

Pass the type of input to use, either file for file names, handle for IO references, string or literal for reading from a scalar, or default to guess (scalar is file name, scalar ref is literal, handle ref is, well, a handle).

process(ElementMapObject, Source, ExtraArgs)

Start the processing. ExtraArgs are passed to the top document handler.

process_sgml_file() or process_xml_file()

shortcut for process with file name (these are both redundant, but they are provided from the base class so there's not much point to taking them out).

trace()

turn kinds of tracing on. mostly good for debugging, it can help you find out why things aren't working like you think they should.

reparent_subtree(), reparent_current_subtree(), skip_subtree()

internal driver method

dispatch_subtrees()

internal driver method

context_path()

return the current element context as ``/'' separated identifiers. (primarily for matching against handler specifications).


AUTHOR

Robert Braddock, robert@concordant-thought.com


SEE ALSO

perl(1), SGML::ElementMap(3pm), SGML::ElementMap::Driver::Grove(3pm), SGML::ElementMap::Driver::SGMLS(3pm), SGML::ElementMap::Driver::XMLParser(3pm)