| 1 | package XML::Essex; | ||||||||||||||||||||||||||||||||||
| 2 | |||||||||||||||||||||||||||||||||||
| 3 | 2 | $VERSION = 0.000_1; | |||||||||||||||||||||||||||||||||
| 4 | |||||||||||||||||||||||||||||||||||
| 5 | =head1 NAME | ||||||||||||||||||||||||||||||||||
| 6 | |||||||||||||||||||||||||||||||||||
| 7 | XML::Essex - Essex XML processing primitives | ||||||||||||||||||||||||||||||||||
| 8 | |||||||||||||||||||||||||||||||||||
| 9 | =head1 SYNOPSIS | ||||||||||||||||||||||||||||||||||
| 10 | |||||||||||||||||||||||||||||||||||
| 11 | TODO | ||||||||||||||||||||||||||||||||||
| 12 | |||||||||||||||||||||||||||||||||||
| 13 | =head1 DESCRIPTION | ||||||||||||||||||||||||||||||||||
| 14 | |||||||||||||||||||||||||||||||||||
| 15 | =head2 Result Value | ||||||||||||||||||||||||||||||||||
| 16 | |||||||||||||||||||||||||||||||||||
| 17 | The return value will be returned to the caller. For handlers, this is | ||||||||||||||||||||||||||||||||||
| 18 | usually a "1" for success or some other value, such as a data | ||||||||||||||||||||||||||||||||||
| 19 | structure that has been built or the result of a query. | ||||||||||||||||||||||||||||||||||
| 20 | |||||||||||||||||||||||||||||||||||
| 21 | For generators and filters, it is important that the result of the next | ||||||||||||||||||||||||||||||||||
| 22 | filter's end_document() is returned at the end of your Essex script, so | ||||||||||||||||||||||||||||||||||
| 23 | that it may be used upstream of such modules as XML::Simple. | ||||||||||||||||||||||||||||||||||
| 24 | |||||||||||||||||||||||||||||||||||
| 25 | Errors should be reported using die(). | ||||||||||||||||||||||||||||||||||
| 26 | |||||||||||||||||||||||||||||||||||
| 27 | =cut | ||||||||||||||||||||||||||||||||||
| 28 | |||||||||||||||||||||||||||||||||||
| 29 | #=head2 A short word on abbreviations | ||||||||||||||||||||||||||||||||||
| 30 | # | ||||||||||||||||||||||||||||||||||
| 31 | #A goal of essex is to allow code to be as terse or verbose as | ||||||||||||||||||||||||||||||||||
| 32 | #appropriate for the job at hand. So almost every object may be | ||||||||||||||||||||||||||||||||||
| 33 | #abbreviated. For instance, C<start_element> may be abbreviated as | ||||||||||||||||||||||||||||||||||
| 34 | #C<start_elt> when using L<C<isa()>|/isa> to check o. | ||||||||||||||||||||||||||||||||||
| 35 | # | ||||||||||||||||||||||||||||||||||
| 36 | #Most of the examples use the abbreviated form, though you can spell | ||||||||||||||||||||||||||||||||||
| 37 | #them out longhand if you like. Here's a list of abbreviations: | ||||||||||||||||||||||||||||||||||
| 38 | # | ||||||||||||||||||||||||||||||||||
| 39 | # document doc | ||||||||||||||||||||||||||||||||||
| 40 | # element elt | ||||||||||||||||||||||||||||||||||
| 41 | # characters chars | ||||||||||||||||||||||||||||||||||
| 42 | # processing instruction pi | ||||||||||||||||||||||||||||||||||
| 43 | # namespace ns | ||||||||||||||||||||||||||||||||||
| 44 | # attribute attr | ||||||||||||||||||||||||||||||||||
| 45 | # | ||||||||||||||||||||||||||||||||||
| 46 | #Class names, functions, and parameters to the Essex C<isa()> | ||||||||||||||||||||||||||||||||||
| 47 | #function/method are all encouraged to use these abbreviations. | ||||||||||||||||||||||||||||||||||
| 48 | |||||||||||||||||||||||||||||||||||
| 49 | =head2 Result Values | ||||||||||||||||||||||||||||||||||
| 50 | |||||||||||||||||||||||||||||||||||
| 51 | =for Document maintainers: if you edit this section, copy and paste it | ||||||||||||||||||||||||||||||||||
| 52 | over the first section of lib/XML/Essex/ResultValues.pod. Thanks. | ||||||||||||||||||||||||||||||||||
| 53 | |||||||||||||||||||||||||||||||||||
| 54 | Essex is designed to Do The Right Thing for the vast majority of | ||||||||||||||||||||||||||||||||||
| 55 | uses, so it manages result values automatically unless you take | ||||||||||||||||||||||||||||||||||
| 56 | control. Below is a set of detailed rules for how it manages | ||||||||||||||||||||||||||||||||||
| 57 | the result value for a filter's processing run, but the overview is: | ||||||||||||||||||||||||||||||||||
| 58 | |||||||||||||||||||||||||||||||||||
| 59 | =over | ||||||||||||||||||||||||||||||||||
| 60 | |||||||||||||||||||||||||||||||||||
| 61 | =item * | ||||||||||||||||||||||||||||||||||
| 62 | |||||||||||||||||||||||||||||||||||
| 63 | Filters normally do not need to manage a result. The result from the | ||||||||||||||||||||||||||||||||||
| 64 | next filter downstream will be returned automatically, or an exception | ||||||||||||||||||||||||||||||||||
| 65 | will be thrown if an incomplete document is sent downstream. | ||||||||||||||||||||||||||||||||||
| 66 | |||||||||||||||||||||||||||||||||||
| 67 | =item * | ||||||||||||||||||||||||||||||||||
| 68 | |||||||||||||||||||||||||||||||||||
| 69 | Generators act like filters mostly, except that if a generator decides | ||||||||||||||||||||||||||||||||||
| 70 | not to send any results downstream, it should either set a result value | ||||||||||||||||||||||||||||||||||
| 71 | by calling C<result()> with it, or C<return> that result normally, just | ||||||||||||||||||||||||||||||||||
| 72 | like a handler. | ||||||||||||||||||||||||||||||||||
| 73 | |||||||||||||||||||||||||||||||||||
| 74 | =item * | ||||||||||||||||||||||||||||||||||
| 75 | |||||||||||||||||||||||||||||||||||
| 76 | Handlers should either set a result value | ||||||||||||||||||||||||||||||||||
| 77 | by calling C<result()> with it, or C<return> that result normally. | ||||||||||||||||||||||||||||||||||
| 78 | |||||||||||||||||||||||||||||||||||
| 79 | =item * | ||||||||||||||||||||||||||||||||||
| 80 | |||||||||||||||||||||||||||||||||||
| 81 | Generators, filters and handlers should all die() on unexpected | ||||||||||||||||||||||||||||||||||
| 82 | conditions and most error conditions (a FALSE or undefined result is not | ||||||||||||||||||||||||||||||||||
| 83 | necessarily an error condition for a handler). | ||||||||||||||||||||||||||||||||||
| 84 | |||||||||||||||||||||||||||||||||||
| 85 | Generators and filters generally should not return a value of their own | ||||||||||||||||||||||||||||||||||
| 86 | because this will surprise calling code which is expecting a return | ||||||||||||||||||||||||||||||||||
| 87 | value of the type that the final SAX handler returns. | ||||||||||||||||||||||||||||||||||
| 88 | |||||||||||||||||||||||||||||||||||
| 89 | =for Document maintainers: if you edit this section, copy and paste it | ||||||||||||||||||||||||||||||||||
| 90 | over the first section of lib/XML/Essex/ResultValues.pod. Thanks. | ||||||||||||||||||||||||||||||||||
| 91 | |||||||||||||||||||||||||||||||||||
| 92 | =cut | ||||||||||||||||||||||||||||||||||
| 93 | |||||||||||||||||||||||||||||||||||
| 94 | 2 | ▶ | use Carp; | ||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||
| 95 | 2 | ▶ | use Exporter; | ||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||
| 96 | 2 | ▶ | use Filter::Util::Call; | ||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||
| 97 | 2 | ▶ | use UNIVERSAL; | ||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||
| 98 | |||||||||||||||||||||||||||||||||||
| 99 | 2 | ▶ | use strict; | ||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||
| 100 | 2 | ▶ | use vars qw( %EXPORT_TAGS @EXPORT ); ## Set by the controlling process | ||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||
| 101 | 2 | ▶ | use XML::Essex::Constants qw( EOD ); | ||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||
| 102 | |||||||||||||||||||||||||||||||||||
| 103 | sub EOL() { "XML::Essex: End of last document" } | ||||||||||||||||||||||||||||||||||
| 104 | |||||||||||||||||||||||||||||||||||
| 105 | { | ||||||||||||||||||||||||||||||||||
| 106 | 2 | %EXPORT_TAGS = ( | |||||||||||||||||||||||||||||||||
| 107 | read => [qw( | ||||||||||||||||||||||||||||||||||
| 108 | get | ||||||||||||||||||||||||||||||||||
| 109 | read_from | ||||||||||||||||||||||||||||||||||
| 110 | parse_doc | ||||||||||||||||||||||||||||||||||
| 111 | isa | ||||||||||||||||||||||||||||||||||
| 112 | next_event | ||||||||||||||||||||||||||||||||||
| 113 | path | ||||||||||||||||||||||||||||||||||
| 114 | type | ||||||||||||||||||||||||||||||||||
| 115 | xeof | ||||||||||||||||||||||||||||||||||
| 116 | )], | ||||||||||||||||||||||||||||||||||
| 117 | rules => [qw( | ||||||||||||||||||||||||||||||||||
| 118 | on | ||||||||||||||||||||||||||||||||||
| 119 | xvalue | ||||||||||||||||||||||||||||||||||
| 120 | |||||||||||||||||||||||||||||||||||
| 121 | xpush | ||||||||||||||||||||||||||||||||||
| 122 | xpop | ||||||||||||||||||||||||||||||||||
| 123 | xset | ||||||||||||||||||||||||||||||||||
| 124 | xadd | ||||||||||||||||||||||||||||||||||
| 125 | )], | ||||||||||||||||||||||||||||||||||
| 126 | write => [qw( | ||||||||||||||||||||||||||||||||||
| 127 | put | ||||||||||||||||||||||||||||||||||
| 128 | write_to | ||||||||||||||||||||||||||||||||||
| 129 | push_output_filters | ||||||||||||||||||||||||||||||||||
| 130 | |||||||||||||||||||||||||||||||||||
| 131 | characters | ||||||||||||||||||||||||||||||||||
| 132 | chars | ||||||||||||||||||||||||||||||||||
| 133 | |||||||||||||||||||||||||||||||||||
| 134 | end_document | ||||||||||||||||||||||||||||||||||
| 135 | end_doc | ||||||||||||||||||||||||||||||||||
| 136 | end_element | ||||||||||||||||||||||||||||||||||
| 137 | end_elt | ||||||||||||||||||||||||||||||||||
| 138 | start_document | ||||||||||||||||||||||||||||||||||
| 139 | start_doc | ||||||||||||||||||||||||||||||||||
| 140 | start_element | ||||||||||||||||||||||||||||||||||
| 141 | start_elt | ||||||||||||||||||||||||||||||||||
| 142 | xml_decl | ||||||||||||||||||||||||||||||||||
| 143 | )], | ||||||||||||||||||||||||||||||||||
| 144 | ); | ||||||||||||||||||||||||||||||||||
| 145 | |||||||||||||||||||||||||||||||||||
| 146 | 2 | my %seen; | |||||||||||||||||||||||||||||||||
| 147 | $EXPORT_TAGS{filter} = [ | ||||||||||||||||||||||||||||||||||
| 148 | grep !$seen{$_}++, | ||||||||||||||||||||||||||||||||||
| 149 | map @$_, | ||||||||||||||||||||||||||||||||||
| 150 | 2 | @EXPORT_TAGS{qw( read write )} | |||||||||||||||||||||||||||||||||
| 151 | ]; | ||||||||||||||||||||||||||||||||||
| 152 | |||||||||||||||||||||||||||||||||||
| 153 | 2 | %seen = (); | |||||||||||||||||||||||||||||||||
| 154 | |||||||||||||||||||||||||||||||||||
| 155 | 2 | @EXPORT = grep !$seen{$_}++, map @$_, values %EXPORT_TAGS; | |||||||||||||||||||||||||||||||||
| 156 | |||||||||||||||||||||||||||||||||||
| 157 | 2 | $EXPORT_TAGS{all} = \@EXPORT; | |||||||||||||||||||||||||||||||||
| 158 | } | ||||||||||||||||||||||||||||||||||
| 159 | |||||||||||||||||||||||||||||||||||
| 160 | |||||||||||||||||||||||||||||||||||
| 161 | 2 | ▶ | sub import { | ||||||||||||||||||||||||||||||||
|
Subroutine
import: called CC=11 SCAR=29.0
| |||||||||||||||||||||||||||||||||||
| 162 | 2 | my ( undef, @args ) = @_; | |||||||||||||||||||||||||||||||||
| 163 | |||||||||||||||||||||||||||||||||||
| 164 | ## Figure out whether to read, write, or do both. | ||||||||||||||||||||||||||||||||||
| 165 | 2 | my %exports; | |||||||||||||||||||||||||||||||||
| 166 | 2 | ▶ | $exports{$_} = 1 for | ||||||||||||||||||||||||||||||||
|
Branch: 3 branches
| |||||||||||||||||||||||||||||||||||
| 167 | @args | ||||||||||||||||||||||||||||||||||
| 168 | ? map s/^:// | ||||||||||||||||||||||||||||||||||
| 169 | ? exists $EXPORT_TAGS{$_} | ||||||||||||||||||||||||||||||||||
| 170 | 0 | ? @{$EXPORT_TAGS{$_}} | |||||||||||||||||||||||||||||||||
| 171 | : croak "Unkown export tag ':$_' for ", __PACKAGE__ | ||||||||||||||||||||||||||||||||||
| 172 | : $_, @args | ||||||||||||||||||||||||||||||||||
| 173 | : @EXPORT; | ||||||||||||||||||||||||||||||||||
| 174 | |||||||||||||||||||||||||||||||||||
| 175 | 2 | ▶ | my $is_reader = exists $exports{get} || exists $exports{on} || exists $exports{parse_doc}; | ||||||||||||||||||||||||||||||||
|
Condition33%2/6
exists $exports{'get'} || exists $exports{'on'} || exists $exports{'parse_doc'}
exists $exports{"get"} or exists $exports{"on"}
MC/DC0%0/3
exists $exports{'get'} || exists $exports{'on'} || exists $exports{'parse_doc'}
exists $exports{"get"}
exists $exports{"on"}
exists $exports{'parse_doc'}
Truth table25%1/4
A or B || C
A= exists $exports{"get"}B= exists $exports{"on"}C= exists $exports{'parse_doc'}
| |||||||||||||||||||||||||||||||||||
| 176 | 2 | my $is_writer = exists $exports{put}; | |||||||||||||||||||||||||||||||||
| 177 | |||||||||||||||||||||||||||||||||||
| 178 | 2 | ▶ | croak "XML::Essex not used as a reader (with :read, get(), :rules or on()) or a writer (with :write put())\n" | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition33%1/3
$is_reader or $is_writer
MC/DC0%0/2
$is_reader or $is_writer
$is_reader
$is_writer
Truth table33%1/3
A or B
A= $is_readerB= $is_writer
| |||||||||||||||||||||||||||||||||||
| 179 | unless $is_reader || $is_writer; | ||||||||||||||||||||||||||||||||||
| 180 | |||||||||||||||||||||||||||||||||||
| 181 | 2 | ▶ | my $sax_processor_type = | ||||||||||||||||||||||||||||||||
|
Branch: 2 branches
| |||||||||||||||||||||||||||||||||||
| 182 | ! $is_reader ? "XML::Generator::Essex" : | ||||||||||||||||||||||||||||||||||
| 183 | ! $is_writer ? "XML::Handler::Essex" : | ||||||||||||||||||||||||||||||||||
| 184 | "XML::Filter::Essex"; | ||||||||||||||||||||||||||||||||||
| 185 | |||||||||||||||||||||||||||||||||||
| 186 | 2 | my $state = 0; # 0=init; 1=code; 2=pod; 3=EOF | |||||||||||||||||||||||||||||||||
| 187 | filter_add( | ||||||||||||||||||||||||||||||||||
| 188 | 83 | ▶ | sub { | ||||||||||||||||||||||||||||||||
|
Subroutine
__ANON__: called CC=9 SCAR=24.4
| |||||||||||||||||||||||||||||||||||
| 189 | 83 | ▶ | if ( $state == 0 ) { | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||
| 190 | 2 | $_ = join '', | |||||||||||||||||||||||||||||||||
| 191 | "XML::Essex::_init '", | ||||||||||||||||||||||||||||||||||
| 192 | $sax_processor_type, | ||||||||||||||||||||||||||||||||||
| 193 | "'; XML::Essex::_cleanup eval {"; | ||||||||||||||||||||||||||||||||||
| 194 | 2 | ++$state; | |||||||||||||||||||||||||||||||||
| 195 | 2 | return 1; | |||||||||||||||||||||||||||||||||
| 196 | } | ||||||||||||||||||||||||||||||||||
| 197 | |||||||||||||||||||||||||||||||||||
| 198 | 81 | ▶ | return 0 if $state > 2; | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||
| 199 | 79 | my $status = filter_read; | |||||||||||||||||||||||||||||||||
| 200 | |||||||||||||||||||||||||||||||||||
| 201 | 79 | ▶ | if ( $status > 0 && substr( $_, 0, 1 ) eq "=" ) { | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition66%2/3
$status > 0 and substr($_, 0, 1) eq "="
MC/DC0%0/2
$status > 0 and substr($_, 0, 1) eq "="
$status > 0
substr($_, 0, 1) eq "="
Truth table66%2/3
A and B
A= $status > 0B= substr($_, 0, 1) eq "="
| |||||||||||||||||||||||||||||||||||
| 202 | 0 | ▶ | if ( $state == 1 ) { $state = 2 } | ||||||||||||||||||||||||||||||||
|
Branch: 2 branches
| |||||||||||||||||||||||||||||||||||
| 203 | 0 | elsif ( substr( $_, 0, 4 ) eq "=cut" ) { $state = 1 } | |||||||||||||||||||||||||||||||||
| 204 | } | ||||||||||||||||||||||||||||||||||
| 205 | |||||||||||||||||||||||||||||||||||
| 206 | 79 | ▶ | return $status if $status != 0; | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||
| 207 | |||||||||||||||||||||||||||||||||||
| 208 | 2 | ▶ | $_ .= "\n\n=cut\n" if $state == 2; | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||
| 209 | 2 | $_ .= "\n;1};"; | |||||||||||||||||||||||||||||||||
| 210 | |||||||||||||||||||||||||||||||||||
| 211 | 2 | $state = 3; | |||||||||||||||||||||||||||||||||
| 212 | |||||||||||||||||||||||||||||||||||
| 213 | 2 | return 1; | |||||||||||||||||||||||||||||||||
| 214 | }, | ||||||||||||||||||||||||||||||||||
| 215 | 2 | ); | |||||||||||||||||||||||||||||||||
| 216 | |||||||||||||||||||||||||||||||||||
| 217 | 2 | goto \&Exporter::import; | |||||||||||||||||||||||||||||||||
| 218 | } | ||||||||||||||||||||||||||||||||||
| 219 | |||||||||||||||||||||||||||||||||||
| 220 | 2 | my @self_stack; | |||||||||||||||||||||||||||||||||
| 221 | |||||||||||||||||||||||||||||||||||
| 222 | 4 | ▶ | sub _init_new { | ||||||||||||||||||||||||||||||||
|
Subroutine
_init_new: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||
| 223 | 4 | my ( $sax_processor_type ) = @_; | |||||||||||||||||||||||||||||||||
| 224 | |||||||||||||||||||||||||||||||||||
| 225 | 4 | push @self_stack, $XML::Essex::Base::self; | |||||||||||||||||||||||||||||||||
| 226 | 4 | my $self = $XML::Essex::Base::self = $sax_processor_type->new; | |||||||||||||||||||||||||||||||||
| 227 | 4 | $self->{NoExecute} = 1; | |||||||||||||||||||||||||||||||||
| 228 | |||||||||||||||||||||||||||||||||||
| 229 | ## The first part of XML::Essex::Base::execute(); | ||||||||||||||||||||||||||||||||||
| 230 | 4 | $self->reset; | |||||||||||||||||||||||||||||||||
| 231 | } | ||||||||||||||||||||||||||||||||||
| 232 | |||||||||||||||||||||||||||||||||||
| 233 | 2 | ▶ | sub _init { | ||||||||||||||||||||||||||||||||
|
Subroutine
_init: called CC=2 SCAR=7.1
| |||||||||||||||||||||||||||||||||||
| 234 | 2 | my ( $sax_processor_type ) = @_; | |||||||||||||||||||||||||||||||||
| 235 | 2 | ▶ | eval "require $sax_processor_type" or croak $@; | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||
| 236 | 2 | _init_new $sax_processor_type; | |||||||||||||||||||||||||||||||||
| 237 | }; | ||||||||||||||||||||||||||||||||||
| 238 | |||||||||||||||||||||||||||||||||||
| 239 | |||||||||||||||||||||||||||||||||||
| 240 | 4 | ▶ | sub _cleanup { | ||||||||||||||||||||||||||||||||
|
Subroutine
_cleanup: called CC=3 SCAR=11.3
| |||||||||||||||||||||||||||||||||||
| 241 | 4 | my ( $ok ) = @_; | |||||||||||||||||||||||||||||||||
| 242 | 4 | my $self = $XML::Essex::Base::self; | |||||||||||||||||||||||||||||||||
| 243 | |||||||||||||||||||||||||||||||||||
| 244 | 4 | my $x = $@; | |||||||||||||||||||||||||||||||||
| 245 | |||||||||||||||||||||||||||||||||||
| 246 | ## The last part of XML::Essex::Base::execute(); | ||||||||||||||||||||||||||||||||||
| 247 | 4 | my ( $ok2, $result, $result_set ) = eval { | |||||||||||||||||||||||||||||||||
| 248 | 4 | ( 1, $self->finish( $ok, $x ) ); | |||||||||||||||||||||||||||||||||
| 249 | }; | ||||||||||||||||||||||||||||||||||
| 250 | 4 | $XML::Essex::Base::self = pop @self_stack; | |||||||||||||||||||||||||||||||||
| 251 | |||||||||||||||||||||||||||||||||||
| 252 | 4 | ▶ | die $@ unless $ok2; | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||
| 253 | 4 | ▶ | return $result if $result_set; | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||
| 254 | 0 | return 1; | |||||||||||||||||||||||||||||||||
| 255 | } | ||||||||||||||||||||||||||||||||||
| 256 | |||||||||||||||||||||||||||||||||||
| 257 | 2 | ▶ | sub _reinit { | ||||||||||||||||||||||||||||||||
|
Subroutine
_reinit: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||
| 258 | 2 | my $type = ref $XML::Essex::Base::self; | |||||||||||||||||||||||||||||||||
| 259 | 2 | _cleanup 1; | |||||||||||||||||||||||||||||||||
| 260 | 2 | _init_new $type; | |||||||||||||||||||||||||||||||||
| 261 | } | ||||||||||||||||||||||||||||||||||
| 262 | |||||||||||||||||||||||||||||||||||
| 263 | =back | ||||||||||||||||||||||||||||||||||
| 264 | |||||||||||||||||||||||||||||||||||
| 265 | =head1 Exported Functions | ||||||||||||||||||||||||||||||||||
| 266 | |||||||||||||||||||||||||||||||||||
| 267 | These are exported by default, use the C<use XML::Essex ();> syntax to | ||||||||||||||||||||||||||||||||||
| 268 | avoid exporting any of these or export only the ones you want. | ||||||||||||||||||||||||||||||||||
| 269 | |||||||||||||||||||||||||||||||||||
| 270 | The following export tags are also defined: | ||||||||||||||||||||||||||||||||||
| 271 | |||||||||||||||||||||||||||||||||||
| 272 | :read get read_from parse_doc isa next_event path type xeof | ||||||||||||||||||||||||||||||||||
| 273 | :rules on | ||||||||||||||||||||||||||||||||||
| 274 | :write put write_to start_doc end_doc start_elt chars ... | ||||||||||||||||||||||||||||||||||
| 275 | |||||||||||||||||||||||||||||||||||
| 276 | so you can | ||||||||||||||||||||||||||||||||||
| 277 | |||||||||||||||||||||||||||||||||||
| 278 | use XML::Essex qw( :read :rules ); | ||||||||||||||||||||||||||||||||||
| 279 | |||||||||||||||||||||||||||||||||||
| 280 | for an Essex script that just handles input and uses some rules, or | ||||||||||||||||||||||||||||||||||
| 281 | even: | ||||||||||||||||||||||||||||||||||
| 282 | |||||||||||||||||||||||||||||||||||
| 283 | use XML::Essex qw( parse_doc :rules ); | ||||||||||||||||||||||||||||||||||
| 284 | |||||||||||||||||||||||||||||||||||
| 285 | for a purely rule-based script. | ||||||||||||||||||||||||||||||||||
| 286 | |||||||||||||||||||||||||||||||||||
| 287 | Importing only what you need is a little quicker and more memory | ||||||||||||||||||||||||||||||||||
| 288 | efficient, but it cal also allow XML::Essex to run more efficiently. If | ||||||||||||||||||||||||||||||||||
| 289 | you don't import any output functions (see C<:write> above), it will not | ||||||||||||||||||||||||||||||||||
| 290 | load the output routines. Same for the input and rule based APIs. | ||||||||||||||||||||||||||||||||||
| 291 | |||||||||||||||||||||||||||||||||||
| 292 | =over | ||||||||||||||||||||||||||||||||||
| 293 | |||||||||||||||||||||||||||||||||||
| 294 | =item get | ||||||||||||||||||||||||||||||||||
| 295 | |||||||||||||||||||||||||||||||||||
| 296 | my $e = get; | ||||||||||||||||||||||||||||||||||
| 297 | |||||||||||||||||||||||||||||||||||
| 298 | Returns the next SAX event. Sets $_ as an EXPERIMENTAL feature. | ||||||||||||||||||||||||||||||||||
| 299 | |||||||||||||||||||||||||||||||||||
| 300 | Throws an exception (which is silently caught outside the main code) | ||||||||||||||||||||||||||||||||||
| 301 | on end of input. | ||||||||||||||||||||||||||||||||||
| 302 | |||||||||||||||||||||||||||||||||||
| 303 | See C<isa()> and C<type()> functions and method (in | ||||||||||||||||||||||||||||||||||
| 304 | L<XML::Essex::Object>) for how to test what was just gotten. | ||||||||||||||||||||||||||||||||||
| 305 | |||||||||||||||||||||||||||||||||||
| 306 | =cut | ||||||||||||||||||||||||||||||||||
| 307 | |||||||||||||||||||||||||||||||||||
| 308 | 4 | ▶ | sub get { | ||||||||||||||||||||||||||||||||
|
Subroutine
get: called CC=2 SCAR=7.1
Pod
documented
| |||||||||||||||||||||||||||||||||||
| 309 | 4 | my $self = $XML::Essex::Base::self; | |||||||||||||||||||||||||||||||||
| 310 | |||||||||||||||||||||||||||||||||||
| 311 | 4 | ▶ | $self->_read_from_default unless $self->{Reader}; | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||
| 312 | |||||||||||||||||||||||||||||||||||
| 313 | 4 | $XML::Essex::Base::self->get( @_ ); | |||||||||||||||||||||||||||||||||
| 314 | } | ||||||||||||||||||||||||||||||||||
| 315 | |||||||||||||||||||||||||||||||||||
| 316 | =item read_from | ||||||||||||||||||||||||||||||||||
| 317 | |||||||||||||||||||||||||||||||||||
| 318 | read_from \*STDIN; ## From a filehandle | ||||||||||||||||||||||||||||||||||
| 319 | read_from "-"; ## From \*STDIN | ||||||||||||||||||||||||||||||||||
| 320 | read_from "foo.xml"; ## From a file or URI (URI support is parser dependant) | ||||||||||||||||||||||||||||||||||
| 321 | read_from \$xml_string; ## From a string. | ||||||||||||||||||||||||||||||||||
| 322 | read_from undef; ## STDIN or files named in @ARGV, as appropriate | ||||||||||||||||||||||||||||||||||
| 323 | |||||||||||||||||||||||||||||||||||
| 324 | Tells the next get() or parse_doc() to read from the indicated source. | ||||||||||||||||||||||||||||||||||
| 325 | |||||||||||||||||||||||||||||||||||
| 326 | Calling read_from automatically disassembles the current processing chain | ||||||||||||||||||||||||||||||||||
| 327 | and builds a new one (just like Perl's open() closes an already open | ||||||||||||||||||||||||||||||||||
| 328 | filehandle). | ||||||||||||||||||||||||||||||||||
| 329 | |||||||||||||||||||||||||||||||||||
| 330 | =cut | ||||||||||||||||||||||||||||||||||
| 331 | |||||||||||||||||||||||||||||||||||
| 332 | 0 | ▶ | sub XML::Essex::Base::_read_from_default { | ||||||||||||||||||||||||||||||||
|
Subroutine
_read_from_default: not called CC=4 SCAR=30.0
| |||||||||||||||||||||||||||||||||||
| 333 | 0 | my $self = shift; | |||||||||||||||||||||||||||||||||
| 334 | |||||||||||||||||||||||||||||||||||
| 335 | 0 | ▶ | if ( @ARGV || $self->{FromARGV} ) { | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
@ARGV or $self->{"FromARGV"}
MC/DC0%0/2
@ARGV or $self->{"FromARGV"}
@ARGV
$self->{"FromARGV"}
Truth table0%0/3
A or B
A= @ARGVB= $self->{"FromARGV"}
| |||||||||||||||||||||||||||||||||||
| 336 | 0 | $self->{FromARGV} = 1; | |||||||||||||||||||||||||||||||||
| 337 | 0 | ▶ | die EOL."\n" unless @ARGV; | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||
| 338 | 0 | read_from( shift @ARGV ); | |||||||||||||||||||||||||||||||||
| 339 | } | ||||||||||||||||||||||||||||||||||
| 340 | else { | ||||||||||||||||||||||||||||||||||
| 341 | 0 | read_from( \*STDIN ); | |||||||||||||||||||||||||||||||||
| 342 | } | ||||||||||||||||||||||||||||||||||
| 343 | } | ||||||||||||||||||||||||||||||||||
| 344 | |||||||||||||||||||||||||||||||||||
| 345 | ## TODO: move this in to XML::Handler::Essex as a set of standard | ||||||||||||||||||||||||||||||||||
| 346 | ## SAX parse_foo() APIs. | ||||||||||||||||||||||||||||||||||
| 347 | 3 | ▶ | sub read_from { | ||||||||||||||||||||||||||||||||
|
Subroutine
read_from: called CC=3 SCAR=12.9
Pod
documented
| |||||||||||||||||||||||||||||||||||
| 348 | ## Shut down the old processing chain if it a Reader was already | ||||||||||||||||||||||||||||||||||
| 349 | ## created. | ||||||||||||||||||||||||||||||||||
| 350 | ## NOTE: This ASSumes that there is only one instance of the Essex | ||||||||||||||||||||||||||||||||||
| 351 | ## scripting env. in play at once. This is ok for now, but it does | ||||||||||||||||||||||||||||||||||
| 352 | ## contradict the idea of @self_stack. Perhaps having the source | ||||||||||||||||||||||||||||||||||
| 353 | ## filter set a secretly named global to point us to the right | ||||||||||||||||||||||||||||||||||
| 354 | ## $self would help. The goal is to enable handling of multiple | ||||||||||||||||||||||||||||||||||
| 355 | ## inputs at the same time: get from this, get from that. | ||||||||||||||||||||||||||||||||||
| 356 | 3 | ▶ | _reinit if $XML::Essex::Base::self->{Reader}; | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||
| 357 | |||||||||||||||||||||||||||||||||||
| 358 | 3 | my $self = $XML::Essex::Base::self; | |||||||||||||||||||||||||||||||||
| 359 | 3 | my ( $what ) = @_; | |||||||||||||||||||||||||||||||||
| 360 | |||||||||||||||||||||||||||||||||||
| 361 | 3 | ▶ | if ( ! defined $what ) { | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||
| 362 | 0 | return delete $self->{Reader}; | |||||||||||||||||||||||||||||||||
| 363 | } | ||||||||||||||||||||||||||||||||||
| 364 | |||||||||||||||||||||||||||||||||||
| 365 | 3 | ▶ | $self->{Reader} = sub { | ||||||||||||||||||||||||||||||||
|
Subroutine
__ANON__: called CC=6 SCAR=24.2
| |||||||||||||||||||||||||||||||||||
| 366 | 3 | require XML::SAX::PurePerl; ## ugh. need XML::LibXMl to support SAX2 | |||||||||||||||||||||||||||||||||
| 367 | 3 | my $p = XML::SAX::PurePerl->new( Handler => $self ); | |||||||||||||||||||||||||||||||||
| 368 | |||||||||||||||||||||||||||||||||||
| 369 | 3 | my $type = ref $what; | |||||||||||||||||||||||||||||||||
| 370 | |||||||||||||||||||||||||||||||||||
| 371 | ## This is purely a non-threading implementation. | ||||||||||||||||||||||||||||||||||
| 372 | ## TODO: build the parser and save the reference to be parsed, then | ||||||||||||||||||||||||||||||||||
| 373 | ## use an appropriate driver for the parser that is called when | ||||||||||||||||||||||||||||||||||
| 374 | ## there are no more events in @{$self->{Events}}. | ||||||||||||||||||||||||||||||||||
| 375 | 3 | ▶ | if ( ! $type ) { | ||||||||||||||||||||||||||||||||
|
Branch: 3 branches
| |||||||||||||||||||||||||||||||||||
| 376 | 0 | ▶ | $what eq "-" | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||
| 377 | ? $p->parse_file( \*STDIN ) | ||||||||||||||||||||||||||||||||||
| 378 | : $p->parse_uri( $what ); | ||||||||||||||||||||||||||||||||||
| 379 | } | ||||||||||||||||||||||||||||||||||
| 380 | ▶ | elsif ( $type eq "GLOB" || UNIVERSAL::isa( $what, "IO::Handle" ) ) { | |||||||||||||||||||||||||||||||||
|
Condition33%1/3
$type eq "GLOB" or UNIVERSAL::isa($what, "IO::Handle")
MC/DC0%0/2
$type eq "GLOB" or UNIVERSAL::isa($what, "IO::Handle")
$type eq "GLOB"
UNIVERSAL::isa($what, "IO::Handle")
Truth table33%1/3
A or B
A= $type eq "GLOB"B= UNIVERSAL::isa($what, "IO::Handle")
| |||||||||||||||||||||||||||||||||||
| 381 | 0 | $p->parse_file( $what ); | |||||||||||||||||||||||||||||||||
| 382 | } | ||||||||||||||||||||||||||||||||||
| 383 | elsif ( $type eq "SCALAR" ) { | ||||||||||||||||||||||||||||||||||
| 384 | 3 | $p->parse_string( $$what ); | |||||||||||||||||||||||||||||||||
| 385 | } | ||||||||||||||||||||||||||||||||||
| 386 | else { | ||||||||||||||||||||||||||||||||||
| 387 | 0 | croak "Don't know how to read from a $type"; | |||||||||||||||||||||||||||||||||
| 388 | } | ||||||||||||||||||||||||||||||||||
| 389 | 3 | }; | |||||||||||||||||||||||||||||||||
| 390 | } | ||||||||||||||||||||||||||||||||||
| 391 | |||||||||||||||||||||||||||||||||||
| 392 | =item push_output_filters | ||||||||||||||||||||||||||||||||||
| 393 | |||||||||||||||||||||||||||||||||||
| 394 | Adds an output filter to the end of the current list (and before the | ||||||||||||||||||||||||||||||||||
| 395 | eventual writer). Can be a class name (which will be C<require()>ed | ||||||||||||||||||||||||||||||||||
| 396 | unless the class can already new()) or a reference to a filter. | ||||||||||||||||||||||||||||||||||
| 397 | |||||||||||||||||||||||||||||||||||
| 398 | =cut | ||||||||||||||||||||||||||||||||||
| 399 | |||||||||||||||||||||||||||||||||||
| 400 | 0 | ▶ | sub push_output_filters { | ||||||||||||||||||||||||||||||||
|
Subroutine
push_output_filters: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||
| 401 | 0 | my $self = $XML::Essex::Base::self; | |||||||||||||||||||||||||||||||||
| 402 | |||||||||||||||||||||||||||||||||||
| 403 | 0 | push @{$self->{OutputFilters}}, @_; | |||||||||||||||||||||||||||||||||
| 404 | } | ||||||||||||||||||||||||||||||||||
| 405 | |||||||||||||||||||||||||||||||||||
| 406 | =item parse_doc | ||||||||||||||||||||||||||||||||||
| 407 | |||||||||||||||||||||||||||||||||||
| 408 | Parses a single document from the current input. Morally equivalent to C<get() | ||||||||||||||||||||||||||||||||||
| 409 | while 1;> but exits normally (as opposed to throwing an exception) when the | ||||||||||||||||||||||||||||||||||
| 410 | end of document is reached. Also slightly faster now and hopefully moreso | ||||||||||||||||||||||||||||||||||
| 411 | when optimizations can be made. | ||||||||||||||||||||||||||||||||||
| 412 | |||||||||||||||||||||||||||||||||||
| 413 | Used to read to the end of a document, primarily in rule-based processing | ||||||||||||||||||||||||||||||||||
| 414 | (L</on>). | ||||||||||||||||||||||||||||||||||
| 415 | |||||||||||||||||||||||||||||||||||
| 416 | TODO: Allow parse_doc to take rules. | ||||||||||||||||||||||||||||||||||
| 417 | |||||||||||||||||||||||||||||||||||
| 418 | =cut | ||||||||||||||||||||||||||||||||||
| 419 | |||||||||||||||||||||||||||||||||||
| 420 | 1 | ▶ | sub parse_doc { | ||||||||||||||||||||||||||||||||
|
Subroutine
parse_doc: called CC=4 SCAR=14.2
Pod
documented
| |||||||||||||||||||||||||||||||||||
| 421 | 1 | my $self = $XML::Essex::Base::self; | |||||||||||||||||||||||||||||||||
| 422 | |||||||||||||||||||||||||||||||||||
| 423 | 1 | ▶ | $self->_read_from_default unless $self->{Reader}; | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||
| 424 | |||||||||||||||||||||||||||||||||||
| 425 | 1 | ▶ | write_to( \*STDOUT ) unless $self->{Writer}; | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||
| 426 | |||||||||||||||||||||||||||||||||||
| 427 | ## The result is undocumented; what should be returned is the | ||||||||||||||||||||||||||||||||||
| 428 | ## normal XML::Filter::Dispatcher | ||||||||||||||||||||||||||||||||||
| 429 | 1 | my $result; | |||||||||||||||||||||||||||||||||
| 430 | 1 | eval { | |||||||||||||||||||||||||||||||||
| 431 | 1 | $result = $self->get while 1; ## I did say I<slightly> ;) | |||||||||||||||||||||||||||||||||
| 432 | }; | ||||||||||||||||||||||||||||||||||
| 433 | |||||||||||||||||||||||||||||||||||
| 434 | 1 | ▶ | die $@ unless $@ eq EOD . "\n"; | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||
| 435 | |||||||||||||||||||||||||||||||||||
| 436 | 1 | return $result; | |||||||||||||||||||||||||||||||||
| 437 | } | ||||||||||||||||||||||||||||||||||
| 438 | |||||||||||||||||||||||||||||||||||
| 439 | =item put | ||||||||||||||||||||||||||||||||||
| 440 | |||||||||||||||||||||||||||||||||||
| 441 | Output one or more events. Usually these events are created by | ||||||||||||||||||||||||||||||||||
| 442 | constructors like C<start_elt()> (see | ||||||||||||||||||||||||||||||||||
| 443 | L<XML::Generator::Essex|XML::Generator::Essex> for details) or | ||||||||||||||||||||||||||||||||||
| 444 | are objects returned C<get()> method. | ||||||||||||||||||||||||||||||||||
| 445 | |||||||||||||||||||||||||||||||||||
| 446 | =cut | ||||||||||||||||||||||||||||||||||
| 447 | |||||||||||||||||||||||||||||||||||
| 448 | 4 | ▶ | sub put { | ||||||||||||||||||||||||||||||||
|
Subroutine
put: called CC=2 SCAR=7.1
Pod
documented
| |||||||||||||||||||||||||||||||||||
| 449 | 4 | my $self = $XML::Essex::Base::self; | |||||||||||||||||||||||||||||||||
| 450 | |||||||||||||||||||||||||||||||||||
| 451 | 4 | ▶ | write_to( \*STDOUT ) unless $self->{Writer}; | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||
| 452 | 4 | $self->put( @_ ); | |||||||||||||||||||||||||||||||||
| 453 | } | ||||||||||||||||||||||||||||||||||
| 454 | |||||||||||||||||||||||||||||||||||
| 455 | =item write_to | ||||||||||||||||||||||||||||||||||
| 456 | |||||||||||||||||||||||||||||||||||
| 457 | write_to \*STDOUT; ## To a filehandle | ||||||||||||||||||||||||||||||||||
| 458 | write_to "-"; ## To \*STDOUT | ||||||||||||||||||||||||||||||||||
| 459 | write_to "foo.xml"; ## To a file or URI (URI support is parser dependant) | ||||||||||||||||||||||||||||||||||
| 460 | write_to \$xml_string; ## To a string. | ||||||||||||||||||||||||||||||||||
| 461 | |||||||||||||||||||||||||||||||||||
| 462 | Tells the next put() to write the indicated source. | ||||||||||||||||||||||||||||||||||
| 463 | |||||||||||||||||||||||||||||||||||
| 464 | =cut | ||||||||||||||||||||||||||||||||||
| 465 | |||||||||||||||||||||||||||||||||||
| 466 | 3 | ▶ | sub write_to { | ||||||||||||||||||||||||||||||||
|
Subroutine
write_to: called CC=2 SCAR=10.4
Pod
documented
| |||||||||||||||||||||||||||||||||||
| 467 | 3 | my $self = $XML::Essex::Base::self; | |||||||||||||||||||||||||||||||||
| 468 | 3 | my ( $what ) = @_; | |||||||||||||||||||||||||||||||||
| 469 | |||||||||||||||||||||||||||||||||||
| 470 | 3 | ▶ | croak "Can't write to an undefined output" unless defined $what; | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||
| 471 | |||||||||||||||||||||||||||||||||||
| 472 | 3 | require XML::SAX::Writer; | |||||||||||||||||||||||||||||||||
| 473 | 2 | ▶ | $self->{Writer} = sub { | ||||||||||||||||||||||||||||||||
|
Subroutine
__ANON__: called CC=6 SCAR=30.5
| |||||||||||||||||||||||||||||||||||
| 474 | 2 | my $h = XML::SAX::Writer->new( Output => $what ); | |||||||||||||||||||||||||||||||||
| 475 | 2 | ▶ | for ( reverse @{$self->{OutputFilters} || [] } ) { | ||||||||||||||||||||||||||||||||
|
Condition50%1/2
$self->{'OutputFilters'} || []
MC/DC0%0/1
$self->{'OutputFilters'} || []
$self->{'OutputFilters'}
Truth table50%1/2
A
A= $self->{'OutputFilters'}
| |||||||||||||||||||||||||||||||||||
| 476 | 0 | ▶ | unless ( ref $_ ) { | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||
| 477 | 0 | ▶ | eval "require $_" or die $@ unless $_->can( "new" ); | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/5
$_->can('new') || (eval "require $_" || die($@))
eval "require $_" or die $@
MC/DC0%0/2
$_->can('new') || (eval "require $_" || die($@))
$_->can('new')
eval "require $_"
Truth table0%0/3
A || B
A= $_->can('new')B= eval "require $_"
| |||||||||||||||||||||||||||||||||||
| 478 | 0 | $_ = $_->new( Handler => $h ); | |||||||||||||||||||||||||||||||||
| 479 | } | ||||||||||||||||||||||||||||||||||
| 480 | else { | ||||||||||||||||||||||||||||||||||
| 481 | 0 | $_->set_handler( $h ); | |||||||||||||||||||||||||||||||||
| 482 | } | ||||||||||||||||||||||||||||||||||
| 483 | 0 | $h = $_; | |||||||||||||||||||||||||||||||||
| 484 | } | ||||||||||||||||||||||||||||||||||
| 485 | 2 | return $h; | |||||||||||||||||||||||||||||||||
| 486 | 3 | }; | |||||||||||||||||||||||||||||||||
| 487 | } | ||||||||||||||||||||||||||||||||||
| 488 | |||||||||||||||||||||||||||||||||||
| 489 | =back | ||||||||||||||||||||||||||||||||||
| 490 | |||||||||||||||||||||||||||||||||||
| 491 | =head2 Miscellaneous | ||||||||||||||||||||||||||||||||||
| 492 | |||||||||||||||||||||||||||||||||||
| 493 | =over | ||||||||||||||||||||||||||||||||||
| 494 | |||||||||||||||||||||||||||||||||||
| 495 | =item isa | ||||||||||||||||||||||||||||||||||
| 496 | |||||||||||||||||||||||||||||||||||
| 497 | get until isa "start_elt" and $_->name eq "foo"; | ||||||||||||||||||||||||||||||||||
| 498 | $r = get until isa $r, "start_elt" and $_->name eq "foo"; | ||||||||||||||||||||||||||||||||||
| 499 | |||||||||||||||||||||||||||||||||||
| 500 | Returns true if the parameter is of the indicated object type. Tests $_ | ||||||||||||||||||||||||||||||||||
| 501 | unless more than one parameter is passed. | ||||||||||||||||||||||||||||||||||
| 502 | |||||||||||||||||||||||||||||||||||
| 503 | =cut | ||||||||||||||||||||||||||||||||||
| 504 | |||||||||||||||||||||||||||||||||||
| 505 | 4 | ▶ | sub isa($) { | ||||||||||||||||||||||||||||||||
|
Subroutine
isa: called CC=3 SCAR=12.0
Pod
documented
| |||||||||||||||||||||||||||||||||||
| 506 | 4 | ▶ | local $_ = shift if @_ >= 2; | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||
| 507 | 4 | ▶ | UNIVERSAL::can( $_, "isa" ) | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||
| 508 | ? $_->isa( @_ ) | ||||||||||||||||||||||||||||||||||
| 509 | : UNIVERSAL::isa( $_, @_ ); | ||||||||||||||||||||||||||||||||||
| 510 | } | ||||||||||||||||||||||||||||||||||
| 511 | |||||||||||||||||||||||||||||||||||
| 512 | =item next_event | ||||||||||||||||||||||||||||||||||
| 513 | |||||||||||||||||||||||||||||||||||
| 514 | Like C<get()> (see L<below|/get>), but does not remove the next event | ||||||||||||||||||||||||||||||||||
| 515 | from the input stream. | ||||||||||||||||||||||||||||||||||
| 516 | |||||||||||||||||||||||||||||||||||
| 517 | get "start_document::*"; | ||||||||||||||||||||||||||||||||||
| 518 | get if next_event->isa( "xml_decl" ); | ||||||||||||||||||||||||||||||||||
| 519 | ...process remainder of document... | ||||||||||||||||||||||||||||||||||
| 520 | |||||||||||||||||||||||||||||||||||
| 521 | =cut | ||||||||||||||||||||||||||||||||||
| 522 | |||||||||||||||||||||||||||||||||||
| 523 | 0 | ▶ | sub next_event { | ||||||||||||||||||||||||||||||||
|
Subroutine
next_event: not called CC=2 SCAR=17.9
Pod
documented
| |||||||||||||||||||||||||||||||||||
| 524 | 0 | my $self = $XML::Essex::Base::self; | |||||||||||||||||||||||||||||||||
| 525 | 0 | ▶ | die "No XML input defined\n" unless $self->{Reader}; | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||
| 526 | 0 | $self->{Reader}->peek; | |||||||||||||||||||||||||||||||||
| 527 | } | ||||||||||||||||||||||||||||||||||
| 528 | |||||||||||||||||||||||||||||||||||
| 529 | =item path | ||||||||||||||||||||||||||||||||||
| 530 | |||||||||||||||||||||||||||||||||||
| 531 | get "start_element::*" until path eq "/path/to/foo:bar" | ||||||||||||||||||||||||||||||||||
| 532 | |||||||||||||||||||||||||||||||||||
| 533 | Returns the path to the current element as a string. | ||||||||||||||||||||||||||||||||||
| 534 | |||||||||||||||||||||||||||||||||||
| 535 | =cut | ||||||||||||||||||||||||||||||||||
| 536 | |||||||||||||||||||||||||||||||||||
| 537 | 0 | ▶ | sub path { | ||||||||||||||||||||||||||||||||
|
Subroutine
path: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||
| 538 | 0 | my $self = $XML::Essex::Base::self; | |||||||||||||||||||||||||||||||||
| 539 | 0 | return join "/", "", map $_->name, @{$self->{Stack}}; | |||||||||||||||||||||||||||||||||
| 540 | } | ||||||||||||||||||||||||||||||||||
| 541 | |||||||||||||||||||||||||||||||||||
| 542 | =for import XML::Generator::Essex/put | ||||||||||||||||||||||||||||||||||
| 543 | |||||||||||||||||||||||||||||||||||
| 544 | =item type | ||||||||||||||||||||||||||||||||||
| 545 | |||||||||||||||||||||||||||||||||||
| 546 | get until type eq "start_document"; | ||||||||||||||||||||||||||||||||||
| 547 | $r = get until type $r eq "start_document"; | ||||||||||||||||||||||||||||||||||
| 548 | |||||||||||||||||||||||||||||||||||
| 549 | |||||||||||||||||||||||||||||||||||
| 550 | Return the type name of the object. This is the class name with a | ||||||||||||||||||||||||||||||||||
| 551 | leading XML::Essex:: stripped off. This is a wrapper around the | ||||||||||||||||||||||||||||||||||
| 552 | event's C<type()> method. | ||||||||||||||||||||||||||||||||||
| 553 | |||||||||||||||||||||||||||||||||||
| 554 | =cut | ||||||||||||||||||||||||||||||||||
| 555 | |||||||||||||||||||||||||||||||||||
| 556 | 0 | ▶ | sub type { | ||||||||||||||||||||||||||||||||
|
Subroutine
type: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||
| 557 | 0 | my $self = $XML::Essex::Base::self; | |||||||||||||||||||||||||||||||||
| 558 | 0 | $self->type( @_ ); | |||||||||||||||||||||||||||||||||
| 559 | } | ||||||||||||||||||||||||||||||||||
| 560 | |||||||||||||||||||||||||||||||||||
| 561 | =item xeof | ||||||||||||||||||||||||||||||||||
| 562 | |||||||||||||||||||||||||||||||||||
| 563 | Return TRUE if the last event has been read. | ||||||||||||||||||||||||||||||||||
| 564 | |||||||||||||||||||||||||||||||||||
| 565 | =cut | ||||||||||||||||||||||||||||||||||
| 566 | |||||||||||||||||||||||||||||||||||
| 567 | 0 | ▶ | sub xeof { | ||||||||||||||||||||||||||||||||
|
Subroutine
xeof: not called CC=2 SCAR=17.9
Pod
documented
| |||||||||||||||||||||||||||||||||||
| 568 | 0 | my $self = $XML::Essex::Base::self; | |||||||||||||||||||||||||||||||||
| 569 | 0 | ▶ | die "No XML input defined\n" unless $self->{Reader}; | ||||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||||
| 570 | 0 | $self->{Reader}->eof; | |||||||||||||||||||||||||||||||||
| 571 | } | ||||||||||||||||||||||||||||||||||
| 572 | |||||||||||||||||||||||||||||||||||
| 573 | =back | ||||||||||||||||||||||||||||||||||
| 574 | |||||||||||||||||||||||||||||||||||
| 575 | =head2 Namespaces | ||||||||||||||||||||||||||||||||||
| 576 | |||||||||||||||||||||||||||||||||||
| 577 | If this section doesn't make any sense, see | ||||||||||||||||||||||||||||||||||
| 578 | L<http://www.jclark.com/xml/xmlns.htm|http://www.jclark.com/xml/xmlns.htm> | ||||||||||||||||||||||||||||||||||
| 579 | for your next dose of XML koolaid. If it still doesn't make any sense | ||||||||||||||||||||||||||||||||||
| 580 | then ding me for writing gibberish. | ||||||||||||||||||||||||||||||||||
| 581 | |||||||||||||||||||||||||||||||||||
| 582 | Element names, attribute names, and PI targets returned by Essex are | ||||||||||||||||||||||||||||||||||
| 583 | generated in one of three forms, depending on whether the named item | ||||||||||||||||||||||||||||||||||
| 584 | has a namespace URI associated with it and whether the filter program | ||||||||||||||||||||||||||||||||||
| 585 | has mapped that namespace URI to a prefix. You may also use any of | ||||||||||||||||||||||||||||||||||
| 586 | these three forms when passing a name to Essex: | ||||||||||||||||||||||||||||||||||
| 587 | |||||||||||||||||||||||||||||||||||
| 588 | =over | ||||||||||||||||||||||||||||||||||
| 589 | |||||||||||||||||||||||||||||||||||
| 590 | =item "id" | ||||||||||||||||||||||||||||||||||
| 591 | |||||||||||||||||||||||||||||||||||
| 592 | If an attribute has no NamespaceURI or an empty string for a | ||||||||||||||||||||||||||||||||||
| 593 | NamespaceURI, it will be returned as a simple string. | ||||||||||||||||||||||||||||||||||
| 594 | |||||||||||||||||||||||||||||||||||
| 595 | TODO: Add an option to enable this for the default namespace or | ||||||||||||||||||||||||||||||||||
| 596 | for attrs in the element's namespace. | ||||||||||||||||||||||||||||||||||
| 597 | |||||||||||||||||||||||||||||||||||
| 598 | =item "foo:id" | ||||||||||||||||||||||||||||||||||
| 599 | |||||||||||||||||||||||||||||||||||
| 600 | If the attribute is in a namespace and there is a namespace -> prefix | ||||||||||||||||||||||||||||||||||
| 601 | mapping has been declared by the filter | ||||||||||||||||||||||||||||||||||
| 602 | |||||||||||||||||||||||||||||||||||
| 603 | =item "{http://foo/}id" | ||||||||||||||||||||||||||||||||||
| 604 | |||||||||||||||||||||||||||||||||||
| 605 | If the attribute is in a namespace with no prefix mapped to it by | ||||||||||||||||||||||||||||||||||
| 606 | the filter. | ||||||||||||||||||||||||||||||||||
| 607 | |||||||||||||||||||||||||||||||||||
| 608 | =back | ||||||||||||||||||||||||||||||||||
| 609 | |||||||||||||||||||||||||||||||||||
| 610 | Namespace prefixes from the source document are ignored; there's no | ||||||||||||||||||||||||||||||||||
| 611 | telling what prefix somebody might have used. Intercept the | ||||||||||||||||||||||||||||||||||
| 612 | start_prefix_mapping and end_prefix_mapping events to follow the weave | ||||||||||||||||||||||||||||||||||
| 613 | of source document namespace mappings. | ||||||||||||||||||||||||||||||||||
| 614 | |||||||||||||||||||||||||||||||||||
| 615 | When outputting events that belong to a namespace not in the source | ||||||||||||||||||||||||||||||||||
| 616 | document, you need to C<put()> the start_prefix_mapping and | ||||||||||||||||||||||||||||||||||
| 617 | end_prefix_mapping events manually, and be careful avoid existing | ||||||||||||||||||||||||||||||||||
| 618 | prefixes from the document if need be while doing so. Future additions | ||||||||||||||||||||||||||||||||||
| 619 | to Essex should make this easier and perhaps automatic. | ||||||||||||||||||||||||||||||||||
| 620 | |||||||||||||||||||||||||||||||||||
| 621 | Essex lets you manage namespace mappings by mapping, hiding, and | ||||||||||||||||||||||||||||||||||
| 622 | destroying ( $namespace => $prefix ) pairs using the functions: | ||||||||||||||||||||||||||||||||||
| 623 | |||||||||||||||||||||||||||||||||||
| 624 | =over | ||||||||||||||||||||||||||||||||||
| 625 | |||||||||||||||||||||||||||||||||||
| 626 | =cut | ||||||||||||||||||||||||||||||||||
| 627 | |||||||||||||||||||||||||||||||||||
| 628 | =item namespace_map | ||||||||||||||||||||||||||||||||||
| 629 | |||||||||||||||||||||||||||||||||||
| 630 | aka: ns_map | ||||||||||||||||||||||||||||||||||
| 631 | |||||||||||||||||||||||||||||||||||
| 632 | my $map = ns_map( | ||||||||||||||||||||||||||||||||||
| 633 | $ns1 => $prefix1, | ||||||||||||||||||||||||||||||||||
| 634 | $ns2 => $prefix2, | ||||||||||||||||||||||||||||||||||
| 635 | ... | ||||||||||||||||||||||||||||||||||
| 636 | ); | ||||||||||||||||||||||||||||||||||
| 637 | |||||||||||||||||||||||||||||||||||
| 638 | Creates a new set of mappings in addition to any that are already in | ||||||||||||||||||||||||||||||||||
| 639 | effect. If a namespace is mapped to multiple prefixes, the last one | ||||||||||||||||||||||||||||||||||
| 640 | created is used. The mappings stay in effect until the map objected | ||||||||||||||||||||||||||||||||||
| 641 | referred to by C<$map> is destroyed. | ||||||||||||||||||||||||||||||||||
| 642 | |||||||||||||||||||||||||||||||||||
| 643 | =cut | ||||||||||||||||||||||||||||||||||
| 644 | |||||||||||||||||||||||||||||||||||
| 645 | 0 | ▶ | sub ns_map { | ||||||||||||||||||||||||||||||||
|
Subroutine
ns_map: not called CC=1 SCAR=6.9
Pod
undocumented
| |||||||||||||||||||||||||||||||||||
| 646 | 0 | my $self = $XML::Essex::Base::self; | |||||||||||||||||||||||||||||||||
| 647 | 0 | return $self->new( @_ ); | |||||||||||||||||||||||||||||||||
| 648 | } | ||||||||||||||||||||||||||||||||||
| 649 | |||||||||||||||||||||||||||||||||||
| 650 | |||||||||||||||||||||||||||||||||||
| 651 | =back | ||||||||||||||||||||||||||||||||||
| 652 | |||||||||||||||||||||||||||||||||||
| 653 | =head2 Rule Based Processing | ||||||||||||||||||||||||||||||||||
| 654 | |||||||||||||||||||||||||||||||||||
| 655 | It is often advantageous to declare exceptional events that should | ||||||||||||||||||||||||||||||||||
| 656 | be processed as they occur in the stream rather than testing for them | ||||||||||||||||||||||||||||||||||
| 657 | explicitly everywhere they might occur in the script. This is done | ||||||||||||||||||||||||||||||||||
| 658 | using the "on" function. | ||||||||||||||||||||||||||||||||||
| 659 | |||||||||||||||||||||||||||||||||||
| 660 | =cut | ||||||||||||||||||||||||||||||||||
| 661 | |||||||||||||||||||||||||||||||||||
| 662 | =over | ||||||||||||||||||||||||||||||||||
| 663 | |||||||||||||||||||||||||||||||||||
| 664 | =item on | ||||||||||||||||||||||||||||||||||
| 665 | |||||||||||||||||||||||||||||||||||
| 666 | on( | ||||||||||||||||||||||||||||||||||
| 667 | "start_document::*" => sub { warn "start of document reached" }, | ||||||||||||||||||||||||||||||||||
| 668 | "end_document::*" => sub { warn "end of document reached" }, | ||||||||||||||||||||||||||||||||||
| 669 | ); | ||||||||||||||||||||||||||||||||||
| 670 | |||||||||||||||||||||||||||||||||||
| 671 | =for TODO | ||||||||||||||||||||||||||||||||||
| 672 | my $rule = on $pat1 => sub { ... }, ...; | ||||||||||||||||||||||||||||||||||
| 673 | ...time passes with rules in effect... | ||||||||||||||||||||||||||||||||||
| 674 | disable_rule $rule; | ||||||||||||||||||||||||||||||||||
| 675 | ...time passes with rules I<not> in effect... | ||||||||||||||||||||||||||||||||||
| 676 | enable_rule $rule; | ||||||||||||||||||||||||||||||||||
| 677 | ...time passes with rules in effect again... | ||||||||||||||||||||||||||||||||||
| 678 | |||||||||||||||||||||||||||||||||||
| 679 | This declares that a rule should be in effect until the end of the | ||||||||||||||||||||||||||||||||||
| 680 | document | ||||||||||||||||||||||||||||||||||
| 681 | |||||||||||||||||||||||||||||||||||
| 682 | =for TODO or it is disabled. | ||||||||||||||||||||||||||||||||||
| 683 | |||||||||||||||||||||||||||||||||||
| 684 | =for TODO Returns a handle that may be used to enable or disable all | ||||||||||||||||||||||||||||||||||
| 685 | rules passed in. | ||||||||||||||||||||||||||||||||||
| 686 | |||||||||||||||||||||||||||||||||||
| 687 | For now, this must be called before the first get() for predictable | ||||||||||||||||||||||||||||||||||
| 688 | results. | ||||||||||||||||||||||||||||||||||
| 689 | |||||||||||||||||||||||||||||||||||
| 690 | Rules remain in effect after the main() routine has exited to facilitate | ||||||||||||||||||||||||||||||||||
| 691 | pure rule based processing. | ||||||||||||||||||||||||||||||||||
| 692 | |||||||||||||||||||||||||||||||||||
| 693 | =cut | ||||||||||||||||||||||||||||||||||
| 694 | |||||||||||||||||||||||||||||||||||
| 695 | 3 | ▶ | sub on { | ||||||||||||||||||||||||||||||||
|
Subroutine
on: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||
| 696 | 3 | my $self = $XML::Essex::Base::self; | |||||||||||||||||||||||||||||||||
| 697 | 3 | $self->on( @_ ); | |||||||||||||||||||||||||||||||||
| 698 | } | ||||||||||||||||||||||||||||||||||
| 699 | |||||||||||||||||||||||||||||||||||
| 700 | =item xvalue | ||||||||||||||||||||||||||||||||||
| 701 | |||||||||||||||||||||||||||||||||||
| 702 | Returns the result of the expression that fired an action. Valid only | ||||||||||||||||||||||||||||||||||
| 703 | within rules. | ||||||||||||||||||||||||||||||||||
| 704 | |||||||||||||||||||||||||||||||||||
| 705 | =cut | ||||||||||||||||||||||||||||||||||
| 706 | |||||||||||||||||||||||||||||||||||
| 707 | 1 | ▶ | sub xvalue { | ||||||||||||||||||||||||||||||||
|
Subroutine
xvalue: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||||
| 708 | 1 | my $self = $XML::Essex::Base::self; | |||||||||||||||||||||||||||||||||
| 709 | 1 | $self->xvalue; | |||||||||||||||||||||||||||||||||
| 710 | } | ||||||||||||||||||||||||||||||||||
| 711 | |||||||||||||||||||||||||||||||||||
| 712 | =item xpush | ||||||||||||||||||||||||||||||||||
| 713 | |||||||||||||||||||||||||||||||||||
| 714 | Returns the result of the expression that fired an action. Valid only | ||||||||||||||||||||||||||||||||||
| 715 | within rules. | ||||||||||||||||||||||||||||||||||
| 716 | |||||||||||||||||||||||||||||||||||
| 717 | =item xpop | ||||||||||||||||||||||||||||||||||
| 718 | |||||||||||||||||||||||||||||||||||
| 719 | Returns the result of the expression that fired an action. Valid only | ||||||||||||||||||||||||||||||||||
| 720 | within rules. | ||||||||||||||||||||||||||||||||||
| 721 | |||||||||||||||||||||||||||||||||||
| 722 | =item xset | ||||||||||||||||||||||||||||||||||
| 723 | |||||||||||||||||||||||||||||||||||
| 724 | Returns the result of the expression that fired an action. Valid only | ||||||||||||||||||||||||||||||||||
| 725 | within rules. | ||||||||||||||||||||||||||||||||||
| 726 | |||||||||||||||||||||||||||||||||||
| 727 | =item xadd | ||||||||||||||||||||||||||||||||||
| 728 | |||||||||||||||||||||||||||||||||||
| 729 | Returns the result of the expression that fired an action. Valid only | ||||||||||||||||||||||||||||||||||
| 730 | within rules. | ||||||||||||||||||||||||||||||||||
| 731 | |||||||||||||||||||||||||||||||||||
| 732 | =cut | ||||||||||||||||||||||||||||||||||
| 733 | |||||||||||||||||||||||||||||||||||
| 734 | 0 | ▶ | sub xpush { XML::Filter::Dispatcher::xpush( @_ ) } | ||||||||||||||||||||||||||||||||
|
Subroutine
xpush: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||
| 735 | 0 | ▶ | sub xpop { XML::Filter::Dispatcher::xpop( @_ ) } | ||||||||||||||||||||||||||||||||
|
Subroutine
xpop: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||
| 736 | 0 | ▶ | sub xadd { XML::Filter::Dispatcher::xadd( @_ ) } | ||||||||||||||||||||||||||||||||
|
Subroutine
xadd: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||
| 737 | 0 | ▶ | sub xset { XML::Filter::Dispatcher::xset( @_ ) } | ||||||||||||||||||||||||||||||||
|
Subroutine
xset: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||
| 738 | |||||||||||||||||||||||||||||||||||
| 739 | =back | ||||||||||||||||||||||||||||||||||
| 740 | |||||||||||||||||||||||||||||||||||
| 741 | =head2 Event Constructors | ||||||||||||||||||||||||||||||||||
| 742 | |||||||||||||||||||||||||||||||||||
| 743 | These are exported by :write (in addition to being available individually). | ||||||||||||||||||||||||||||||||||
| 744 | |||||||||||||||||||||||||||||||||||
| 745 | =over | ||||||||||||||||||||||||||||||||||
| 746 | |||||||||||||||||||||||||||||||||||
| 747 | =cut | ||||||||||||||||||||||||||||||||||
| 748 | |||||||||||||||||||||||||||||||||||
| 749 | 2 | ▶ | no warnings "once"; | ||||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||||
| 750 | |||||||||||||||||||||||||||||||||||
| 751 | =item chars | ||||||||||||||||||||||||||||||||||
| 752 | |||||||||||||||||||||||||||||||||||
| 753 | aka: characters | ||||||||||||||||||||||||||||||||||
| 754 | |||||||||||||||||||||||||||||||||||
| 755 | =cut | ||||||||||||||||||||||||||||||||||
| 756 | |||||||||||||||||||||||||||||||||||
| 757 | 0 | ▶ | sub characters { | ||||||||||||||||||||||||||||||||
|
Subroutine
characters: not called CC=1 SCAR=6.9
Pod
undocumented
| |||||||||||||||||||||||||||||||||||
| 758 | 0 | XML::Essex::Event::characters->new( @_ ); | |||||||||||||||||||||||||||||||||
| 759 | } | ||||||||||||||||||||||||||||||||||
| 760 | |||||||||||||||||||||||||||||||||||
| 761 | 2 | *chars = \&characters; | |||||||||||||||||||||||||||||||||
| 762 | |||||||||||||||||||||||||||||||||||
| 763 | |||||||||||||||||||||||||||||||||||
| 764 | =item end_doc | ||||||||||||||||||||||||||||||||||
| 765 | |||||||||||||||||||||||||||||||||||
| 766 | aka: end_document | ||||||||||||||||||||||||||||||||||
| 767 | |||||||||||||||||||||||||||||||||||
| 768 | =cut | ||||||||||||||||||||||||||||||||||
| 769 | |||||||||||||||||||||||||||||||||||
| 770 | 0 | ▶ | sub end_document { | ||||||||||||||||||||||||||||||||
|
Subroutine
end_document: not called CC=1 SCAR=6.9
Pod
undocumented
| |||||||||||||||||||||||||||||||||||
| 771 | 0 | XML::Essex::Event::end_doc->new( @_ ); | |||||||||||||||||||||||||||||||||
| 772 | } | ||||||||||||||||||||||||||||||||||
| 773 | |||||||||||||||||||||||||||||||||||
| 774 | 2 | *end_doc = \&end_document; | |||||||||||||||||||||||||||||||||
| 775 | |||||||||||||||||||||||||||||||||||
| 776 | =item end_elt | ||||||||||||||||||||||||||||||||||
| 777 | |||||||||||||||||||||||||||||||||||
| 778 | aka: end_element | ||||||||||||||||||||||||||||||||||
| 779 | |||||||||||||||||||||||||||||||||||
| 780 | =cut | ||||||||||||||||||||||||||||||||||
| 781 | |||||||||||||||||||||||||||||||||||
| 782 | 0 | ▶ | sub end_element { | ||||||||||||||||||||||||||||||||
|
Subroutine
end_element: not called CC=1 SCAR=6.9
Pod
undocumented
| |||||||||||||||||||||||||||||||||||
| 783 | 0 | XML::Essex::Event::end_element->new( @_ ); | |||||||||||||||||||||||||||||||||
| 784 | } | ||||||||||||||||||||||||||||||||||
| 785 | |||||||||||||||||||||||||||||||||||
| 786 | 2 | *end_elt = \&end_element; | |||||||||||||||||||||||||||||||||
| 787 | |||||||||||||||||||||||||||||||||||
| 788 | |||||||||||||||||||||||||||||||||||
| 789 | =item start_doc | ||||||||||||||||||||||||||||||||||
| 790 | |||||||||||||||||||||||||||||||||||
| 791 | aka: start_document | ||||||||||||||||||||||||||||||||||
| 792 | |||||||||||||||||||||||||||||||||||
| 793 | =cut | ||||||||||||||||||||||||||||||||||
| 794 | |||||||||||||||||||||||||||||||||||
| 795 | 0 | ▶ | sub start_document { | ||||||||||||||||||||||||||||||||
|
Subroutine
start_document: not called CC=1 SCAR=6.9
Pod
undocumented
| |||||||||||||||||||||||||||||||||||
| 796 | 0 | XML::Essex::Event::start_document->new( @_ ); | |||||||||||||||||||||||||||||||||
| 797 | } | ||||||||||||||||||||||||||||||||||
| 798 | |||||||||||||||||||||||||||||||||||
| 799 | |||||||||||||||||||||||||||||||||||
| 800 | 2 | *start_doc = \&start_document; | |||||||||||||||||||||||||||||||||
| 801 | |||||||||||||||||||||||||||||||||||
| 802 | |||||||||||||||||||||||||||||||||||
| 803 | =item start_elt | ||||||||||||||||||||||||||||||||||
| 804 | |||||||||||||||||||||||||||||||||||
| 805 | aka: start_element | ||||||||||||||||||||||||||||||||||
| 806 | |||||||||||||||||||||||||||||||||||
| 807 | =cut | ||||||||||||||||||||||||||||||||||
| 808 | |||||||||||||||||||||||||||||||||||
| 809 | 0 | ▶ | sub start_element { | ||||||||||||||||||||||||||||||||
|
Subroutine
start_element: not called CC=1 SCAR=6.9
Pod
undocumented
| |||||||||||||||||||||||||||||||||||
| 810 | 0 | XML::Essex::Event::start_element->new( @_ ); | |||||||||||||||||||||||||||||||||
| 811 | } | ||||||||||||||||||||||||||||||||||
| 812 | |||||||||||||||||||||||||||||||||||
| 813 | |||||||||||||||||||||||||||||||||||
| 814 | 2 | *start_elt = \&start_element; | |||||||||||||||||||||||||||||||||
| 815 | |||||||||||||||||||||||||||||||||||
| 816 | =item xml_decl | ||||||||||||||||||||||||||||||||||
| 817 | |||||||||||||||||||||||||||||||||||
| 818 | =cut | ||||||||||||||||||||||||||||||||||
| 819 | |||||||||||||||||||||||||||||||||||
| 820 | 0 | ▶ | sub xml_decl { | ||||||||||||||||||||||||||||||||
|
Subroutine
xml_decl: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||||
| 821 | 0 | XML::Essex::Event::xml_decl->new( @_ ); | |||||||||||||||||||||||||||||||||
| 822 | } | ||||||||||||||||||||||||||||||||||
| 823 | |||||||||||||||||||||||||||||||||||
| 824 | |||||||||||||||||||||||||||||||||||
| 825 | =back | ||||||||||||||||||||||||||||||||||
| 826 | |||||||||||||||||||||||||||||||||||
| 827 | =head1 IMPLEMENTATION NOTES | ||||||||||||||||||||||||||||||||||
| 828 | |||||||||||||||||||||||||||||||||||
| 829 | XML::Essex is a source filter that wraps from the C<use> line to the | ||||||||||||||||||||||||||||||||||
| 830 | end of the file in an eval { ... } block. | ||||||||||||||||||||||||||||||||||
| 831 | |||||||||||||||||||||||||||||||||||
| 832 | =head1 LIMITATIONS | ||||||||||||||||||||||||||||||||||
| 833 | |||||||||||||||||||||||||||||||||||
| 834 | Stay tuned. | ||||||||||||||||||||||||||||||||||
| 835 | |||||||||||||||||||||||||||||||||||
| 836 | =head1 COPYRIGHT | ||||||||||||||||||||||||||||||||||
| 837 | |||||||||||||||||||||||||||||||||||
| 838 | Copyright 2002, R. Barrie Slaymaker, Jr., All Rights Reserved | ||||||||||||||||||||||||||||||||||
| 839 | |||||||||||||||||||||||||||||||||||
| 840 | =head1 LICENSE | ||||||||||||||||||||||||||||||||||
| 841 | |||||||||||||||||||||||||||||||||||
| 842 | You may use this module under the terms of the BSD, Artistic, oir GPL licenses, | ||||||||||||||||||||||||||||||||||
| 843 | any version. | ||||||||||||||||||||||||||||||||||
| 844 | |||||||||||||||||||||||||||||||||||
| 845 | =head1 AUTHOR | ||||||||||||||||||||||||||||||||||
| 846 | |||||||||||||||||||||||||||||||||||
| 847 | Barrie Slaymaker <barries@slaysys.com> | ||||||||||||||||||||||||||||||||||
| 848 | |||||||||||||||||||||||||||||||||||
| 849 | =cut | ||||||||||||||||||||||||||||||||||
| 850 | |||||||||||||||||||||||||||||||||||
| 851 | 2 | 1; | |||||||||||||||||||||||||||||||||