/usr/lib/perl5/XML/Parser/Expat.pm is in libxml-parser-perl 2.41-1+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 | package XML::Parser::Expat;
require 5.004;
use strict;
use vars qw($VERSION @ISA %Handler_Setters %Encoding_Table @Encoding_Path
$have_File_Spec);
use Carp;
require DynaLoader;
@ISA = qw(DynaLoader);
$VERSION = "2.41";
$have_File_Spec = $INC{'File/Spec.pm'} || do 'File/Spec.pm';
%Encoding_Table = ();
if ($have_File_Spec) {
@Encoding_Path = (grep(-d $_,
map(File::Spec->catdir($_, qw(XML Parser Encodings)),
@INC)),
File::Spec->curdir);
}
else {
@Encoding_Path = (grep(-d $_, map($_ . '/XML/Parser/Encodings', @INC)), '.');
}
bootstrap XML::Parser::Expat $VERSION;
%Handler_Setters = (
Start => \&SetStartElementHandler,
End => \&SetEndElementHandler,
Char => \&SetCharacterDataHandler,
Proc => \&SetProcessingInstructionHandler,
Comment => \&SetCommentHandler,
CdataStart => \&SetStartCdataHandler,
CdataEnd => \&SetEndCdataHandler,
Default => \&SetDefaultHandler,
Unparsed => \&SetUnparsedEntityDeclHandler,
Notation => \&SetNotationDeclHandler,
ExternEnt => \&SetExternalEntityRefHandler,
ExternEntFin => \&SetExtEntFinishHandler,
Entity => \&SetEntityDeclHandler,
Element => \&SetElementDeclHandler,
Attlist => \&SetAttListDeclHandler,
Doctype => \&SetDoctypeHandler,
DoctypeFin => \&SetEndDoctypeHandler,
XMLDecl => \&SetXMLDeclHandler
);
sub new {
my ($class, %args) = @_;
my $self = bless \%args, $_[0];
$args{_State_} = 0;
$args{Context} = [];
$args{Namespaces} ||= 0;
$args{ErrorMessage} ||= '';
if ($args{Namespaces}) {
$args{Namespace_Table} = {};
$args{Namespace_List} = [undef];
$args{Prefix_Table} = {};
$args{New_Prefixes} = [];
}
$args{_Setters} = \%Handler_Setters;
$args{Parser} = ParserCreate($self, $args{ProtocolEncoding},
$args{Namespaces});
$self;
}
sub load_encoding {
my ($file) = @_;
$file =~ s!([^/]+)$!\L$1\E!;
$file .= '.enc' unless $file =~ /\.enc$/;
unless ($file =~ m!^/!) {
foreach (@Encoding_Path) {
my $tmp = ($have_File_Spec
? File::Spec->catfile($_, $file)
: "$_/$file");
if (-e $tmp) {
$file = $tmp;
last;
}
}
}
local(*ENC);
open(ENC, $file) or croak("Couldn't open encmap $file:\n$!\n");
binmode(ENC);
my $data;
my $br = sysread(ENC, $data, -s $file);
croak("Trouble reading $file:\n$!\n")
unless defined($br);
close(ENC);
my $name = LoadEncoding($data, $br);
croak("$file isn't an encmap file")
unless defined($name);
$name;
} # End load_encoding
sub setHandlers {
my ($self, @handler_pairs) = @_;
croak("Uneven number of arguments to setHandlers method")
if (int(@handler_pairs) & 1);
my @ret;
while (@handler_pairs) {
my $type = shift @handler_pairs;
my $handler = shift @handler_pairs;
croak "Handler for $type not a Code ref"
unless (! defined($handler) or ! $handler or ref($handler) eq 'CODE');
my $hndl = $self->{_Setters}->{$type};
unless (defined($hndl)) {
my @types = sort keys %{$self->{_Setters}};
croak("Unknown Expat handler type: $type\n Valid types: @types");
}
my $old = &$hndl($self->{Parser}, $handler);
push (@ret, $type, $old);
}
return @ret;
}
sub xpcroak
{
my ($self, $message) = @_;
my $eclines = $self->{ErrorContext};
my $line = GetCurrentLineNumber($_[0]->{Parser});
$message .= " at line $line";
$message .= ":\n" . $self->position_in_context($eclines)
if defined($eclines);
croak $message;
}
sub xpcarp {
my ($self, $message) = @_;
my $eclines = $self->{ErrorContext};
my $line = GetCurrentLineNumber($_[0]->{Parser});
$message .= " at line $line";
$message .= ":\n" . $self->position_in_context($eclines)
if defined($eclines);
carp $message;
}
sub default_current {
my $self = shift;
if ($self->{_State_} == 1) {
return DefaultCurrent($self->{Parser});
}
}
sub recognized_string {
my $self = shift;
if ($self->{_State_} == 1) {
return RecognizedString($self->{Parser});
}
}
sub original_string {
my $self = shift;
if ($self->{_State_} == 1) {
return OriginalString($self->{Parser});
}
}
sub current_line {
my $self = shift;
if ($self->{_State_} == 1) {
return GetCurrentLineNumber($self->{Parser});
}
}
sub current_column {
my $self = shift;
if ($self->{_State_} == 1) {
return GetCurrentColumnNumber($self->{Parser});
}
}
sub current_byte {
my $self = shift;
if ($self->{_State_} == 1) {
return GetCurrentByteIndex($self->{Parser});
}
}
sub base {
my ($self, $newbase) = @_;
my $p = $self->{Parser};
my $oldbase = GetBase($p);
SetBase($p, $newbase) if @_ > 1;
return $oldbase;
}
sub context {
my $ctx = $_[0]->{Context};
@$ctx;
}
sub current_element {
my ($self) = @_;
@{$self->{Context}} ? $self->{Context}->[-1] : undef;
}
sub in_element {
my ($self, $element) = @_;
@{$self->{Context}} ? $self->eq_name($self->{Context}->[-1], $element)
: undef;
}
sub within_element {
my ($self, $element) = @_;
my $cnt = 0;
foreach (@{$self->{Context}}) {
$cnt++ if $self->eq_name($_, $element);
}
return $cnt;
}
sub depth {
my ($self) = @_;
int(@{$self->{Context}});
}
sub element_index {
my ($self) = @_;
if ($self->{_State_} == 1) {
return ElementIndex($self->{Parser});
}
}
################
# Namespace methods
sub namespace {
my ($self, $name) = @_;
local($^W) = 0;
$self->{Namespace_List}->[int($name)];
}
sub eq_name {
my ($self, $nm1, $nm2) = @_;
local($^W) = 0;
int($nm1) == int($nm2) and $nm1 eq $nm2;
}
sub generate_ns_name {
my ($self, $name, $namespace) = @_;
$namespace ?
GenerateNSName($name, $namespace, $self->{Namespace_Table},
$self->{Namespace_List})
: $name;
}
sub new_ns_prefixes {
my ($self) = @_;
if ($self->{Namespaces}) {
return @{$self->{New_Prefixes}};
}
return ();
}
sub expand_ns_prefix {
my ($self, $prefix) = @_;
if ($self->{Namespaces}) {
my $stack = $self->{Prefix_Table}->{$prefix};
return (defined($stack) and @$stack) ? $stack->[-1] : undef;
}
return undef;
}
sub current_ns_prefixes {
my ($self) = @_;
if ($self->{Namespaces}) {
my %set = %{$self->{Prefix_Table}};
if (exists $set{'#default'} and not defined($set{'#default'}->[-1])) {
delete $set{'#default'};
}
return keys %set;
}
return ();
}
################################################################
# Namespace declaration handlers
#
sub NamespaceStart {
my ($self, $prefix, $uri) = @_;
$prefix = '#default' unless defined $prefix;
my $stack = $self->{Prefix_Table}->{$prefix};
if (defined $stack) {
push(@$stack, $uri);
}
else {
$self->{Prefix_Table}->{$prefix} = [$uri];
}
# The New_Prefixes list gets emptied at end of startElement function
# in Expat.xs
push(@{$self->{New_Prefixes}}, $prefix);
}
sub NamespaceEnd {
my ($self, $prefix) = @_;
$prefix = '#default' unless defined $prefix;
my $stack = $self->{Prefix_Table}->{$prefix};
if (@$stack > 1) {
pop(@$stack);
}
else {
delete $self->{Prefix_Table}->{$prefix};
}
}
################
sub specified_attr {
my $self = shift;
if ($self->{_State_} == 1) {
return GetSpecifiedAttributeCount($self->{Parser});
}
}
sub finish {
my ($self) = @_;
if ($self->{_State_} == 1) {
my $parser = $self->{Parser};
UnsetAllHandlers($parser);
}
}
sub position_in_context {
my ($self, $lines) = @_;
if ($self->{_State_} == 1) {
my $parser = $self->{Parser};
my ($string, $linepos) = PositionContext($parser, $lines);
return '' unless defined($string);
my $col = GetCurrentColumnNumber($parser);
my $ptr = ('=' x ($col - 1)) . '^' . "\n";
my $ret;
my $dosplit = $linepos < length($string);
$string .= "\n" unless $string =~ /\n$/;
if ($dosplit) {
$ret = substr($string, 0, $linepos) . $ptr
. substr($string, $linepos);
} else {
$ret = $string . $ptr;
}
return $ret;
}
}
sub xml_escape {
my $self = shift;
my $text = shift;
study $text;
$text =~ s/\&/\&/g;
$text =~ s/</\</g;
foreach (@_) {
croak "xml_escape: '$_' isn't a single character" if length($_) > 1;
if ($_ eq '>') {
$text =~ s/>/\>/g;
}
elsif ($_ eq '"') {
$text =~ s/\"/\"/;
}
elsif ($_ eq "'") {
$text =~ s/\'/\'/;
}
else {
my $rep = '&#' . sprintf('x%X', ord($_)) . ';';
if (/\W/) {
my $ptrn = "\\$_";
$text =~ s/$ptrn/$rep/g;
}
else {
$text =~ s/$_/$rep/g;
}
}
}
$text;
}
sub skip_until {
my $self = shift;
if ($self->{_State_} <= 1) {
SkipUntil($self->{Parser}, $_[0]);
}
}
sub release {
my $self = shift;
ParserRelease($self->{Parser});
}
sub DESTROY {
my $self = shift;
ParserFree($self->{Parser});
}
sub parse {
my $self = shift;
my $arg = shift;
croak "Parse already in progress (Expat)" if $self->{_State_};
$self->{_State_} = 1;
my $parser = $self->{Parser};
my $ioref;
my $result = 0;
if (defined $arg) {
local *@;
if (ref($arg) and UNIVERSAL::isa($arg, 'IO::Handle')) {
$ioref = $arg;
} elsif ($] < 5.008 and defined tied($arg)) {
require IO::Handle;
$ioref = $arg;
}
else {
require IO::Handle;
eval {
no strict 'refs';
$ioref = *{$arg}{IO} if defined *{$arg};
};
}
}
if (defined($ioref)) {
my $delim = $self->{Stream_Delimiter};
my $prev_rs;
my $ioclass = ref $ioref;
$ioclass = "IO::Handle" if !length $ioclass;
$prev_rs = $ioclass->input_record_separator("\n$delim\n")
if defined($delim);
$result = ParseStream($parser, $ioref, $delim);
$ioclass->input_record_separator($prev_rs)
if defined($delim);
} else {
$result = ParseString($parser, $arg);
}
$self->{_State_} = 2;
$result or croak $self->{ErrorMessage};
}
sub parsestring {
my $self = shift;
$self->parse(@_);
}
sub parsefile {
my $self = shift;
croak "Parser has already been used" if $self->{_State_};
local(*FILE);
open(FILE, $_[0]) or croak "Couldn't open $_[0]:\n$!";
binmode(FILE);
my $ret = $self->parse(*FILE);
close(FILE);
$ret;
}
################################################################
package #hide from PAUSE
XML::Parser::ContentModel;
use overload '""' => \&asString, 'eq' => \&thiseq;
sub EMPTY () {1}
sub ANY () {2}
sub MIXED () {3}
sub NAME () {4}
sub CHOICE () {5}
sub SEQ () {6}
sub isempty {
return $_[0]->{Type} == EMPTY;
}
sub isany {
return $_[0]->{Type} == ANY;
}
sub ismixed {
return $_[0]->{Type} == MIXED;
}
sub isname {
return $_[0]->{Type} == NAME;
}
sub name {
return $_[0]->{Tag};
}
sub ischoice {
return $_[0]->{Type} == CHOICE;
}
sub isseq {
return $_[0]->{Type} == SEQ;
}
sub quant {
return $_[0]->{Quant};
}
sub children {
my $children = $_[0]->{Children};
if (defined $children) {
return @$children;
}
return undef;
}
sub asString {
my ($self) = @_;
my $ret;
if ($self->{Type} == NAME) {
$ret = $self->{Tag};
}
elsif ($self->{Type} == EMPTY) {
return "EMPTY";
}
elsif ($self->{Type} == ANY) {
return "ANY";
}
elsif ($self->{Type} == MIXED) {
$ret = '(#PCDATA';
foreach (@{$self->{Children}}) {
$ret .= '|' . $_;
}
$ret .= ')';
}
else {
my $sep = $self->{Type} == CHOICE ? '|' : ',';
$ret = '(' . join($sep, map { $_->asString } @{$self->{Children}}) . ')';
}
$ret .= $self->{Quant} if $self->{Quant};
return $ret;
}
sub thiseq {
my $self = shift;
return $self->asString eq $_[0];
}
################################################################
package #hide from PAUSE
XML::Parser::ExpatNB;
use vars qw(@ISA);
use Carp;
@ISA = qw(XML::Parser::Expat);
sub parse {
my $self = shift;
my $class = ref($self);
croak "parse method not supported in $class";
}
sub parsestring {
my $self = shift;
my $class = ref($self);
croak "parsestring method not supported in $class";
}
sub parsefile {
my $self = shift;
my $class = ref($self);
croak "parsefile method not supported in $class";
}
sub parse_more {
my ($self, $data) = @_;
$self->{_State_} = 1;
my $ret = XML::Parser::Expat::ParsePartial($self->{Parser}, $data);
croak $self->{ErrorMessage} unless $ret;
}
sub parse_done {
my $self = shift;
my $ret = XML::Parser::Expat::ParseDone($self->{Parser});
unless ($ret) {
my $msg = $self->{ErrorMessage};
$self->release;
croak $msg;
}
$self->{_State_} = 2;
my $result = $ret;
my @result = ();
my $final = $self->{FinalHandler};
if (defined $final) {
if (wantarray) {
@result = &$final($self);
}
else {
$result = &$final($self);
}
}
$self->release;
return unless defined wantarray;
return wantarray ? @result : $result;
}
################################################################
package #hide from PAUSE
XML::Parser::Encinfo;
sub DESTROY {
my $self = shift;
XML::Parser::Expat::FreeEncoding($self);
}
1;
__END__
=head1 NAME
XML::Parser::Expat - Lowlevel access to James Clark's expat XML parser
=head1 SYNOPSIS
use XML::Parser::Expat;
$parser = XML::Parser::Expat->new;
$parser->setHandlers('Start' => \&sh,
'End' => \&eh,
'Char' => \&ch);
open(FOO, '<', 'info.xml') or die "Couldn't open";
$parser->parse(*FOO);
close(FOO);
# $parser->parse('<foo id="me"> here <em>we</em> go </foo>');
sub sh
{
my ($p, $el, %atts) = @_;
$p->setHandlers('Char' => \&spec)
if ($el eq 'special');
...
}
sub eh
{
my ($p, $el) = @_;
$p->setHandlers('Char' => \&ch) # Special elements won't contain
if ($el eq 'special'); # other special elements
...
}
=head1 DESCRIPTION
This module provides an interface to James Clark's XML parser, expat. As in
expat, a single instance of the parser can only parse one document. Calls
to parsestring after the first for a given instance will die.
Expat (and XML::Parser::Expat) are event based. As the parser recognizes
parts of the document (say the start or end of an XML element), then any
handlers registered for that type of an event are called with suitable
parameters.
=head1 METHODS
=over 4
=item new
This is a class method, the constructor for XML::Parser::Expat. Options are
passed as keyword value pairs. The recognized options are:
=over 4
=item * ProtocolEncoding
The protocol encoding name. The default is none. The expat built-in
encodings are: C<UTF-8>, C<ISO-8859-1>, C<UTF-16>, and C<US-ASCII>.
Other encodings may be used if they have encoding maps in one of the
directories in the @Encoding_Path list. Setting the protocol encoding
overrides any encoding in the XML declaration.
=item * Namespaces
When this option is given with a true value, then the parser does namespace
processing. By default, namespace processing is turned off. When it is
turned on, the parser consumes I<xmlns> attributes and strips off prefixes
from element and attributes names where those prefixes have a defined
namespace. A name's namespace can be found using the L<"namespace"> method
and two names can be checked for absolute equality with the L<"eq_name">
method.
=item * NoExpand
Normally, the parser will try to expand references to entities defined in
the internal subset. If this option is set to a true value, and a default
handler is also set, then the default handler will be called when an
entity reference is seen in text. This has no effect if a default handler
has not been registered, and it has no effect on the expansion of entity
references inside attribute values.
=item * Stream_Delimiter
This option takes a string value. When this string is found alone on a line
while parsing from a stream, then the parse is ended as if it saw an end of
file. The intended use is with a stream of xml documents in a MIME multipart
format. The string should not contain a trailing newline.
=item * ErrorContext
When this option is defined, errors are reported in context. The value
of ErrorContext should be the number of lines to show on either side of
the line in which the error occurred.
=item * ParseParamEnt
Unless standalone is set to "yes" in the XML declaration, setting this to
a true value allows the external DTD to be read, and parameter entities
to be parsed and expanded.
=item * Base
The base to use for relative pathnames or URLs. This can also be done by
using the base method.
=back
=item setHandlers(TYPE, HANDLER [, TYPE, HANDLER [...]])
This method registers handlers for the various events. If no handlers are
registered, then a call to parsestring or parsefile will only determine if
the corresponding XML document is well formed (by returning without error.)
This may be called from within a handler, after the parse has started.
Setting a handler to something that evaluates to false unsets that
handler.
This method returns a list of type, handler pairs corresponding to the
input. The handlers returned are the ones that were in effect before the
call to setHandlers.
The recognized events and the parameters passed to the corresponding
handlers are:
=over 4
=item * Start (Parser, Element [, Attr, Val [,...]])
This event is generated when an XML start tag is recognized. Parser is
an XML::Parser::Expat instance. Element is the name of the XML element that
is opened with the start tag. The Attr & Val pairs are generated for each
attribute in the start tag.
=item * End (Parser, Element)
This event is generated when an XML end tag is recognized. Note that
an XML empty tag (<foo/>) generates both a start and an end event.
There is always a lower level start and end handler installed that wrap
the corresponding callbacks. This is to handle the context mechanism.
A consequence of this is that the default handler (see below) will not
see a start tag or end tag unless the default_current method is called.
=item * Char (Parser, String)
This event is generated when non-markup is recognized. The non-markup
sequence of characters is in String. A single non-markup sequence of
characters may generate multiple calls to this handler. Whatever the
encoding of the string in the original document, this is given to the
handler in UTF-8.
=item * Proc (Parser, Target, Data)
This event is generated when a processing instruction is recognized.
=item * Comment (Parser, String)
This event is generated when a comment is recognized.
=item * CdataStart (Parser)
This is called at the start of a CDATA section.
=item * CdataEnd (Parser)
This is called at the end of a CDATA section.
=item * Default (Parser, String)
This is called for any characters that don't have a registered handler.
This includes both characters that are part of markup for which no
events are generated (markup declarations) and characters that
could generate events, but for which no handler has been registered.
Whatever the encoding in the original document, the string is returned to
the handler in UTF-8.
=item * Unparsed (Parser, Entity, Base, Sysid, Pubid, Notation)
This is called for a declaration of an unparsed entity. Entity is the name
of the entity. Base is the base to be used for resolving a relative URI.
Sysid is the system id. Pubid is the public id. Notation is the notation
name. Base and Pubid may be undefined.
=item * Notation (Parser, Notation, Base, Sysid, Pubid)
This is called for a declaration of notation. Notation is the notation name.
Base is the base to be used for resolving a relative URI. Sysid is the system
id. Pubid is the public id. Base, Sysid, and Pubid may all be undefined.
=item * ExternEnt (Parser, Base, Sysid, Pubid)
This is called when an external entity is referenced. Base is the base to be
used for resolving a relative URI. Sysid is the system id. Pubid is the public
id. Base, and Pubid may be undefined.
This handler should either return a string, which represents the contents of
the external entity, or return an open filehandle that can be read to obtain
the contents of the external entity, or return undef, which indicates the
external entity couldn't be found and will generate a parse error.
If an open filehandle is returned, it must be returned as either a glob
(*FOO) or as a reference to a glob (e.g. an instance of IO::Handle).
=item * ExternEntFin (Parser)
This is called after an external entity has been parsed. It allows
applications to perform cleanup on actions performed in the above
ExternEnt handler.
=item * Entity (Parser, Name, Val, Sysid, Pubid, Ndata, IsParam)
This is called when an entity is declared. For internal entities, the Val
parameter will contain the value and the remaining three parameters will
be undefined. For external entities, the Val parameter
will be undefined, the Sysid parameter will have the system id, the Pubid
parameter will have the public id if it was provided (it will be undefined
otherwise), the Ndata parameter will contain the notation for unparsed
entities. If this is a parameter entity declaration, then the IsParam
parameter is true.
Note that this handler and the Unparsed handler above overlap. If both are
set, then this handler will not be called for unparsed entities.
=item * Element (Parser, Name, Model)
The element handler is called when an element declaration is found. Name is
the element name, and Model is the content model as an
XML::Parser::ContentModel object. See L<"XML::Parser::ContentModel Methods">
for methods available for this class.
=item * Attlist (Parser, Elname, Attname, Type, Default, Fixed)
This handler is called for each attribute in an ATTLIST declaration.
So an ATTLIST declaration that has multiple attributes
will generate multiple calls to this handler. The Elname parameter is the
name of the element with which the attribute is being associated. The Attname
parameter is the name of the attribute. Type is the attribute type, given as
a string. Default is the default value, which will either be "#REQUIRED",
"#IMPLIED" or a quoted string (i.e. the returned string will begin and end
with a quote character). If Fixed is true, then this is a fixed attribute.
=item * Doctype (Parser, Name, Sysid, Pubid, Internal)
This handler is called for DOCTYPE declarations. Name is the document type
name. Sysid is the system id of the document type, if it was provided,
otherwise it's undefined. Pubid is the public id of the document type,
which will be undefined if no public id was given. Internal will be
true or false, indicating whether or not the doctype declaration contains
an internal subset.
=item * DoctypeFin (Parser)
This handler is called after parsing of the DOCTYPE declaration has finished,
including any internal or external DTD declarations.
=item * XMLDecl (Parser, Version, Encoding, Standalone)
This handler is called for XML declarations. Version is a string containg
the version. Encoding is either undefined or contains an encoding string.
Standalone is either undefined, or true or false. Undefined indicates
that no standalone parameter was given in the XML declaration. True or
false indicates "yes" or "no" respectively.
=back
=item namespace(name)
Return the URI of the namespace that the name belongs to. If the name doesn't
belong to any namespace, an undef is returned. This is only valid on names
received through the Start or End handlers from a single document, or through
a call to the generate_ns_name method. In other words, don't use names
generated from one instance of XML::Parser::Expat with other instances.
=item eq_name(name1, name2)
Return true if name1 and name2 are identical (i.e. same name and from
the same namespace.) This is only meaningful if both names were obtained
through the Start or End handlers from a single document, or through
a call to the generate_ns_name method.
=item generate_ns_name(name, namespace)
Return a name, associated with a given namespace, good for using with the
above 2 methods. The namespace argument should be the namespace URI, not
a prefix.
=item new_ns_prefixes
When called from a start tag handler, returns namespace prefixes declared
with this start tag. If called elsewere (or if there were no namespace
prefixes declared), it returns an empty list. Setting of the default
namespace is indicated with '#default' as a prefix.
=item expand_ns_prefix(prefix)
Return the uri to which the given prefix is currently bound. Returns
undef if the prefix isn't currently bound. Use '#default' to find the
current binding of the default namespace (if any).
=item current_ns_prefixes
Return a list of currently bound namespace prefixes. The order of the
the prefixes in the list has no meaning. If the default namespace is
currently bound, '#default' appears in the list.
=item recognized_string
Returns the string from the document that was recognized in order to call
the current handler. For instance, when called from a start handler, it
will give us the the start-tag string. The string is encoded in UTF-8.
This method doesn't return a meaningful string inside declaration handlers.
=item original_string
Returns the verbatim string from the document that was recognized in
order to call the current handler. The string is in the original document
encoding. This method doesn't return a meaningful string inside declaration
handlers.
=item default_current
When called from a handler, causes the sequence of characters that generated
the corresponding event to be sent to the default handler (if one is
registered). Use of this method is deprecated in favor the recognized_string
method, which you can use without installing a default handler. This
method doesn't deliver a meaningful string to the default handler when
called from inside declaration handlers.
=item xpcroak(message)
Concatenate onto the given message the current line number within the
XML document plus the message implied by ErrorContext. Then croak with
the formed message.
=item xpcarp(message)
Concatenate onto the given message the current line number within the
XML document plus the message implied by ErrorContext. Then carp with
the formed message.
=item current_line
Returns the line number of the current position of the parse.
=item current_column
Returns the column number of the current position of the parse.
=item current_byte
Returns the current position of the parse.
=item base([NEWBASE]);
Returns the current value of the base for resolving relative URIs. If
NEWBASE is supplied, changes the base to that value.
=item context
Returns a list of element names that represent open elements, with the
last one being the innermost. Inside start and end tag handlers, this
will be the tag of the parent element.
=item current_element
Returns the name of the innermost currently opened element. Inside
start or end handlers, returns the parent of the element associated
with those tags.
=item in_element(NAME)
Returns true if NAME is equal to the name of the innermost currently opened
element. If namespace processing is being used and you want to check
against a name that may be in a namespace, then use the generate_ns_name
method to create the NAME argument.
=item within_element(NAME)
Returns the number of times the given name appears in the context list.
If namespace processing is being used and you want to check
against a name that may be in a namespace, then use the generate_ns_name
method to create the NAME argument.
=item depth
Returns the size of the context list.
=item element_index
Returns an integer that is the depth-first visit order of the current
element. This will be zero outside of the root element. For example,
this will return 1 when called from the start handler for the root element
start tag.
=item skip_until(INDEX)
INDEX is an integer that represents an element index. When this method
is called, all handlers are suspended until the start tag for an element
that has an index number equal to INDEX is seen. If a start handler has
been set, then this is the first tag that the start handler will see
after skip_until has been called.
=item position_in_context(LINES)
Returns a string that shows the current parse position. LINES should be
an integer >= 0 that represents the number of lines on either side of the
current parse line to place into the returned string.
=item xml_escape(TEXT [, CHAR [, CHAR ...]])
Returns TEXT with markup characters turned into character entities. Any
additional characters provided as arguments are also turned into character
references where found in TEXT.
=item parse (SOURCE)
The SOURCE parameter should either be a string containing the whole XML
document, or it should be an open IO::Handle. Only a single document
may be parsed for a given instance of XML::Parser::Expat, so this will croak
if it's been called previously for this instance.
=item parsestring(XML_DOC_STRING)
Parses the given string as an XML document. Only a single document may be
parsed for a given instance of XML::Parser::Expat, so this will die if either
parsestring or parsefile has been called for this instance previously.
This method is deprecated in favor of the parse method.
=item parsefile(FILENAME)
Parses the XML document in the given file. Will die if parsestring or
parsefile has been called previously for this instance.
=item is_defaulted(ATTNAME)
NO LONGER WORKS. To find out if an attribute is defaulted please use
the specified_attr method.
=item specified_attr
When the start handler receives lists of attributes and values, the
non-defaulted (i.e. explicitly specified) attributes occur in the list
first. This method returns the number of specified items in the list.
So if this number is equal to the length of the list, there were no
defaulted values. Otherwise the number points to the index of the
first defaulted attribute name.
=item finish
Unsets all handlers (including internal ones that set context), but expat
continues parsing to the end of the document or until it finds an error.
It should finish up a lot faster than with the handlers set.
=item release
There are data structures used by XML::Parser::Expat that have circular
references. This means that these structures will never be garbage
collected unless these references are explicitly broken. Calling this
method breaks those references (and makes the instance unusable.)
Normally, higher level calls handle this for you, but if you are using
XML::Parser::Expat directly, then it's your responsibility to call it.
=back
=head2 XML::Parser::ContentModel Methods
The element declaration handlers are passed objects of this class as the
content model of the element declaration. They also represent content
particles, components of a content model.
When referred to as a string, these objects are automagicly converted to a
string representation of the model (or content particle).
=over 4
=item isempty
This method returns true if the object is "EMPTY", false otherwise.
=item isany
This method returns true if the object is "ANY", false otherwise.
=item ismixed
This method returns true if the object is "(#PCDATA)" or "(#PCDATA|...)*",
false otherwise.
=item isname
This method returns if the object is an element name.
=item ischoice
This method returns true if the object is a choice of content particles.
=item isseq
This method returns true if the object is a sequence of content particles.
=item quant
This method returns undef or a string representing the quantifier
('?', '*', '+') associated with the model or particle.
=item children
This method returns undef or (for mixed, choice, and sequence types)
an array of component content particles. There will always be at least
one component for choices and sequences, but for a mixed content model
of pure PCDATA, "(#PCDATA)", then an undef is returned.
=back
=head2 XML::Parser::ExpatNB Methods
The class XML::Parser::ExpatNB is a subclass of XML::Parser::Expat used
for non-blocking access to the expat library. It does not support the parse,
parsestring, or parsefile methods, but it does have these additional methods:
=over 4
=item parse_more(DATA)
Feed expat more text to munch on.
=item parse_done
Tell expat that it's gotten the whole document.
=back
=head1 FUNCTIONS
=over 4
=item XML::Parser::Expat::load_encoding(ENCODING)
Load an external encoding. ENCODING is either the name of an encoding or
the name of a file. The basename is converted to lowercase and a '.enc'
extension is appended unless there's one already there. Then, unless
it's an absolute pathname (i.e. begins with '/'), the first file by that
name discovered in the @Encoding_Path path list is used.
The encoding in the file is loaded and kept in the %Encoding_Table
table. Earlier encodings of the same name are replaced.
This function is automatically called by expat when it encounters an encoding
it doesn't know about. Expat shouldn't call this twice for the same
encoding name. The only reason users should use this function is to
explicitly load an encoding not contained in the @Encoding_Path list.
=back
=head1 AUTHORS
Larry Wall <F<larry@wall.org>> wrote version 1.0.
Clark Cooper <F<coopercc@netheaven.com>> picked up support, changed the API
for this version (2.x), provided documentation, and added some standard
package features.
=cut
|