/usr/lib/perl5/SGML/Parser/OpenSP/Tools.pm is in libsgml-parser-opensp-perl 0.994-2build1.
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 | # Tools.pm -- SGML::Parser::OpenSP::Tools module
#
# $Id: Tools.pm,v 1.9 2006/08/30 14:50:35 hoehrmann Exp $
package SGML::Parser::OpenSP::Tools;
use 5.008;
use strict;
use warnings;
use Carp;
# white-space as defined in XML 1.0
our $WHITESPACE = qr/[\x20\x09\x0d\x0a]/;
sub value_attribute
{
my $attr = shift;
# illegal input
return 0 unless defined $attr;
return 0 unless ref $attr eq "HASH";
return 0 unless exists $attr->{Type};
# these cannot have values
return 0 if $attr->{Type} eq "implied";
return 0 if $attr->{Type} eq "invalid";
return 1;
}
sub specified_attribute
{
my $attr = shift;
return 0 unless value_attribute($attr);
return 0 if $attr->{Defaulted} ne "specified";
return 1;
}
sub defaulted_attribute
{
my $attr = shift;
return 0 unless value_attribute($attr);
return 0 if $attr->{Defaulted} eq "specified";
return 1;
}
sub attribute_value
{
my $attr = shift;
# ...
return unless value_attribute($attr);
# tokenized attributes
return $attr->{Tokens}
if $attr->{Type} eq "tokenized";
my $value = "";
# type is cdata
foreach my $chunk (@{$attr->{CdataChunks}})
{
# todo: fix this for SDATA
# todo: fix this for non-sgml chars
$value .= $chunk->{Data};
}
return $value;
}
sub split_pi
{
my $orig = shift;
return unless defined $orig;
return unless length $orig;
my ($targ, $data) = split /$WHITESPACE/, $orig, 1;
return $targ, $data;
}
sub split_message
{
my $mess = shift; # message text
my $name = shift; # file name
my $oent = shift; # show_open_entities
my $errn = shift; # show_error_numbers
my $oelm = shift; # show_open_elements
my $mess_debug = $mess;
my %resu;
if ($oent)
{
while($mess =~ s/^In entity (\S+) included from (.*?):(\d+):(\d+)\s+//)
{
push @{$resu{open_entities}}, { EntityName => $1,
FileName => $2,
LineNumber => $3,
ColumnNumber => $4 }
}
}
# this splits the error message into its components. this is designed
# to cope with most if not all delimiter problems inherent to the
# message format which does not escape delimiters which can result in
# ambiguous data. The following format is expected by this code
# each error message component starts on a new line which is either
# the first line or something that follows \n, then an optional formal
# system identifier such as <LITERAL> or <OSFILE>, then the file name
# as reported by $p->get_location->{FileName} then the line and finally
# the column number -- for each message there should thus be three
# individual components, line, column, "text" -- which can contain
# additional components depending on the message, see below.
my @comp = split(/(?:^|\n)(?:<[^>]+>)?\Q$name\E:(\d+):(\d+):\s*/, $mess);
# check for proper format, the first component must be
# empty and each entry must have line, column and text
croak "Unexpected error message format ($mess_debug)"
if length $comp[0] or (@comp - 1) % 3;
# remove empty component
shift @comp;
# the first component is the primary message
$resu{primary_message}->{LineNumber} = shift @comp;
$resu{primary_message}->{ColumnNumber} = shift @comp;
if ($errn)
{
# with show_error_numbers the first component is
# "<module>.<error number>", remove and store it
$comp[0] =~ s/^(\d+)\.(\d+)://;
# this can happen if it was incorrectly specified
# that show_error_numbers was enabled or if OpenSP
# has a bug that causes the number to be missing
croak "message lacks error number information"
unless defined $1 and defined $2;
$resu{primary_message}->{Module} = $1;
$resu{primary_message}->{Number} = $2;
}
# next component is a character indicating the severity
$comp[0] =~ s/^(\w):\s+//;
# this can happen if OpenSP has a bug in this regard
croak "severity character missing from error message"
unless defined $1;
$resu{primary_message}->{Severity} = $1;
# trim trailing white-space from the text
$comp[0] =~ s/\s+$//;
# the remainder of the message is the error message text
$resu{primary_message}->{Text} = shift @comp;
# optional auxiliary message
if (@comp > 3 or (@comp == 3 and !$oelm))
{
# trim trailing white-space from the text
$comp[2] =~ s/\s+$//;
$resu{aux_message}->{LineNumber} = shift @comp;
$resu{aux_message}->{ColumnNumber} = shift @comp;
$resu{aux_message}->{Text} = shift @comp;
}
# open elements are optional in SGML declarations, etc.
if ($oelm and @comp)
{
# this should only happen in case of OpenSP bugs
croak "unexpected number of components in message"
unless @comp == 3;
croak "expected listing of open elements"
unless pop(@comp) =~ /^open elements: (.*)/s;
$resu{open_elements} = $1;
}
\%resu
}
1;
__END__
=pod
=head1 NAME
SGML::Parser::OpenSP::Tools - Tools to process OpenSP output
=head1 DESCRIPTION
Routines to post-process OpenSP event data.
=head1 UTILITY FUNCTIONS
=over 4
=item specified_attribute($attribute)
specified_attribute returns a true value if the attribute is
of type C<cdata> or C<tokenized> and has its C<Defaulted> property
set to C<specified>. For example
sub start_element
{
my $self = shift;
my $elem = shift;
my @spec = grep specified_attribute($_),
values %{$elem->{Attributes}};
# @spec contains all explicitly specified attributes
}
=item defaulted_attribute($attribute)
defaulted_attribute returns a true value if the attribute is
of type C<cdata> or C<tokenized> and has its C<Defaulted> property
set to something but C<specified>. For all attributes, the following
always holds true,
!defined(attribute_value($_)) or
defaulted_attribute($_) or
specified_attribute($_)
since only defaulted and specified attributes can have a value.
=item value_attribute($attribute)
Returns true if the value can have a value, i.e., it is either
specified or defaulted.
=item attribute_value($attribute)
attribute_value returns a textual representation of the value
of an attribute as reported to a C<start_element> handler or
C<undef> if no value is available.
=item split_message($message, $filename, $open_ent, $error_num, $open_elem)
split_message splits an OpenSP error message into its components,
the error or warning message, an optional auxiliary message that
provides additional information about the error, like the first
occurence of an ID in case of duplicate IDs in a document, each
accompanied by line and column numbers relevant to the message,
and depending on the parser configuration the open entities for
the message, the error number of the message and a list of the
current open elements.
It returns a hash reference like
# this is always present
primary_message =>
{
Number => 141, # only if $p->show_error_numbers(1)
Module => 554521624, # only if $p->show_error_numbers(1)
ColumnNumber => 9,
LineNumber => 12,
Severity => 'E',
Text => 'ID "a" already defined'
},
# only some messages have an aux_message
aux_message =>
{
ColumnNumber => 9,
LineNumber => 11,
Text => 'ID "a" first defined here'
},
# iff $p->show_open_elements(1) and there are open elements
open_elements => 'html body[1] (p[1])',
# iff $p->show_open_entities(1) and there are open entities
# other than the document, but the document will be reported
# if the error is in some other entity
open_entities => [
{
ColumnNumber => 55,
FileName => 'example.xhtml',
EntityName => 'html',
LineNumber => 2
}, ... ],
This would typically be used like
sub error
{
my $self = shift;
my $erro = shift;
my $mess = $erro->{Message};
# parser is the SGML::Parser::OpenSP
# object stored in the handler object
my $loca = $self->{parser}->get_location;
my $name = $loca->{FileName};
my $splt = split_message($mess, $name,
$self->{parser}->show_open_entities,
$self->{parser}->show_error_numbers,
$self->{parser}->show_open_elements);
# ...
}
A more convenient way to access this function is provided by the
C<SGML::Parser::OpenSP> module which you can use like
sub error
{
my $self = shift;
my $erro = shift;
my $mess = $self->{parser}->split_message($erro);
# relevant data is now $mess and $erro->{Severity}
# of which the latter provides more detailed information
# than $mess->{primary_message}->{Severity}, see the
# SGML::Parser::OpenSP documentation for details
}
=item split_pi($data)
split_pi splits the data of a processing instructions at the first
white space character into two components where white space character
is defined in the $WHITESPACE package variable, qr/[\x20\x09\x0d\x0a]/
by default. It returns C<undef> if there is no data to split.
sub pi
{
my $self = shift;
my $proc = shift;
my ($target, $data) = split_pi($proc->{Data});
# ...
}
=back
=head1 AUTHOR / COPYRIGHT / LICENSE
Copyright (c) 2006-2008 Bjoern Hoehrmann <bjoern@hoehrmann.de>.
This module is licensed under the same terms as Perl itself.
=cut
|