SGMLS 1.03ii

SGMLS is a Perl class for postprocessing the output from the sgmls and nsgmls parsers.

SYNOPSIS

use SGMLS;

my $parse = new SGMLS(STDIN);

my $event = $parse->next_event;
while ($event) {

SWITCH: {

($event->type eq start_element) && do {
my $element = $event->data; # An object of class SGMLS_Element
[[your code for the beginning of an element]]
last SWITCH;
};

($event->type eq end_element) && do {
my $element = $event->data; # An object of class SGMLS_Element
[[your code for the end of an element]]
last SWITCH;
};

($event->type eq cdata) && do {
my $cdata = $event->data; # A string
[[your code for character data]]
last SWITCH;
};

($event->type eq sdata) && do {
my $sdata = $event->data; # A string
[[your code for system data]]
last SWITCH;
};

($event->type eq re) && do {
[[your code for a record end]]
last SWITCH;
};

($event->type eq pi) && do {
my $pi = $event->data; # A string
[[your code for a processing instruction]]
last SWITCH;
};

($event->type eq entity) && do {
my $entity = $event->data; # An object of class SGMLS_Entity
[[your code for an external entity]]
last SWITCH;
};

($event->type eq start_subdoc) && do {
my $entity = $event->data; # An object of class SGMLS_Entity
[[your code for the beginning of a subdoc entity]]
last SWITCH;
};

($event->type eq end_subdoc) && do {
my $entity = $event->data; # An object of class SGMLS_Entity
[[your code for the end of a subdoc entity]]
last SWITCH;
};

($event->type eq conforming) && do {
[[your code for a conforming document]]
last SWITCH;
};

die "Internal error: unknown event type " . $event->type . "n";
}

$event = $parse->next_event;
}

The SGMLS package consists of several related classes: see "SGMLS", "SGMLS_Event", "SGMLS_Element", "SGMLS_Attribute", "SGMLS_Notation", and "SGMLS_Entity". All of these classes are available when you specify use SGMLS;

Generally, the only object which you will create explicitly will belong to the SGMLS class; all of the others will then be created automatically for you over the course of the parse. Much fuller documentation is available in the .sgml files in the DOC/ directory of the SGMLS.pm distribution.