1 package Text::Tradition::Parser::CTE;
5 use Text::Tradition::Parser::Util qw/ collate_variants /;
7 use XML::LibXML::XPathContext;
11 Text::Tradition::Parser::CTE
15 Parser module for Text::Tradition, given a TEI file exported from
16 Classical Text Editor.
24 my @apparatus = read( $xml_file );
26 Takes a Tradition object and a TEI file exported from Classical Text
27 Editor using double-endpoint-attachment critical apparatus encoding;
28 initializes the Tradition from the file.
32 my %sigil_for; # Save the XML IDs for witnesses.
33 my %apps; # Save the apparatus XML for a given ID.
34 my %has_ac; # Keep track of witnesses that have corrections.
37 my( $tradition, $opts ) = @_;
38 my $c = $tradition->collation; # Some shorthand
40 # First, parse the XML.
41 my $parser = XML::LibXML->new();
43 if( exists $opts->{'string'} ) {
44 $doc = $parser->parse_string( $opts->{'string'} );
45 } elsif ( exists $opts->{'file'} ) {
46 $doc = $parser->parse_file( $opts->{'file'} );
48 warn "Could not find string or file option to parse";
51 my $tei = $doc->documentElement();
52 my $xpc = XML::LibXML::XPathContext->new( $tei );
54 # CTE uses a DTD rather than any xmlns-based parsing. Thus we
55 # need no namespace handling.
57 # Get the witnesses and create the witness objects.
58 foreach my $wit_el ( $xpc->findnodes( '//sourceDesc/listWit/witness' ) ) {
59 # The witness xml:id is used internally, and is *not* the sigil name.
60 my $id= $wit_el->getAttribute( 'xml:id' );
61 my @sig_parts = $xpc->findnodes( './abbr/descendant::text()', $wit_el );
62 my $sig = _stringify_sigil( @sig_parts );
63 $tradition->add_witness( sigil => $sig, source => $wit_el->toString() );
64 $sigil_for{'#'.$id} = $sig; # Make life easy by keying on the ID ref syntax
67 # Now go through the text and find the base tokens, apparatus tags, and
68 # anchors. Make a giant array of all of these things in sequence.
69 # TODO consider combining this with creation of graph below
71 foreach my $pg_el ( $xpc->findnodes( '/TEI/text/body/p' ) ) {
72 foreach my $xn ( $pg_el->childNodes ) {
73 push( @base_text, _get_base( $xn ) );
77 # We now have to work through this array applying the alternate
78 # apparatus readings to the base text. Essentially we will put
79 # everything on the graph, from which we will delete the apps and
80 # anchors when we are done.
82 # First, put the base tokens, apps, and anchors in the graph.
85 foreach my $item ( @base_text ) {
87 if( $item->{'type'} eq 'token' ) {
88 $r = $c->add_reading( { id => 'n'.$counter++,
89 text => $item->{'content'} } );
90 } elsif ( $item->{'type'} eq 'anchor' ) {
91 $r = $c->add_reading( { id => '#ANCHOR_' . $item->{'content'} . '#',
93 } elsif ( $item->{'type'} eq 'app' ) {
94 my $tag = '#APP_' . $counter++ . '#';
95 $r = $c->add_reading( { id => $tag, is_ph => 1 } );
96 $apps{$tag} = $item->{'content'};
98 $c->add_path( $last, $r, $c->baselabel );
101 $c->add_path( $last, $c->end, $c->baselabel );
103 # Now we can parse the apparatus entries, and add the variant readings
106 foreach my $app_id ( keys %apps ) {
107 _add_readings( $c, $app_id );
110 # Finally, add explicit witness paths, remove the base paths, and remove
111 # the app/anchor tags.
112 expand_all_paths( $c );
114 # Save the text for each witness so that we can ensure consistency
116 $tradition->collation->text_from_paths();
119 sub _stringify_sigil {
121 my @parts = grep { /\w/ } map { $_->data } @nodes;
122 return join( '', @parts );
125 ## Recursive little helper function to help us navigate through nested
126 ## XML, picking out the words, the apparatus, and the anchors.
131 if( $xn->nodeType == XML_TEXT_NODE ) {
132 # Base text, just split the words on whitespace and add them
134 # TODO consider that XML markup might appear mid-token.
137 foreach my $w ( split( /\s+/, $str ) ) {
138 push( @readings, { 'type' => 'token', 'content' => $w } );
140 } elsif( $xn->nodeName eq 'hi' ) {
141 # Recurse as if the hi weren't there.
142 foreach( $xn->childNodes ) {
143 push( @readings, _get_base( $_ ) );
145 } elsif( $xn->nodeName eq 'app' ) {
146 # Apparatus, just save the entire XML node.
147 push( @readings, { 'type' => 'app', 'content' => $xn } );
148 } elsif( $xn->nodeName eq 'anchor' ) {
149 # Anchor to mark the end of some apparatus; save its ID.
150 push( @readings, { 'type' => 'anchor',
151 'content' => $xn->getAttribute( 'xml:id' ) } );
152 } elsif ( $xn->nodeName ne 'note' ) { # Any tag we don't know to disregard
153 print STDERR "Unrecognized tag " . $xn->nodeName . "\n";
159 my( $c, $app_id ) = @_;
160 my $xn = $apps{$app_id};
161 my $anchor = _anchor_name( $xn->getAttribute( 'to' ) );
162 # Get the lemma, which is all the readings between app and anchor,
163 # excluding other apps or anchors.
164 my @lemma = _return_lemma( $c, $app_id, $anchor );
165 my $lemma_str = join( ' ', grep { $_ !~ /^\#/ } map { $_->text } @lemma );
167 # For each reading, send its text to 'interpret' along with the lemma,
168 # and then save the list of witnesses that these tokens belong to.
169 my %wit_rdgs; # Maps from witnesses to the variant text
172 $tag =~ s/^\#APP_(.*)\#$/$1/;
173 foreach my $rdg ( $xn->getChildrenByTagName( 'rdg' ) ) {
175 foreach ( $rdg->childNodes ) {
176 push( @text, _get_base( $_ ) );
178 my( $interpreted, $flag ) = ( '', undef );
180 ( $interpreted, $flag ) = interpret(
181 join( ' ', map { $_->{'content'} } @text ), $lemma_str );
183 next if( $interpreted eq $lemma_str ) && !$flag; # Reading is lemma.
186 if( $interpreted eq '#LACUNA#' ) {
187 push( @rdg_nodes, $c->add_reading( { id => $tag . "/" . $ctr++,
188 is_lacuna => 1 } ) );
190 foreach my $w ( split( /\s+/, $interpreted ) ) {
191 my $r = $c->add_reading( { id => $tag . "/" . $ctr++,
193 push( @rdg_nodes, $r );
196 # For each listed wit, save the reading.
197 foreach my $wit ( split( /\s+/, $rdg->getAttribute( 'wit' ) ) ) {
198 $wit .= $flag if $flag;
199 $wit_rdgs{$wit} = \@rdg_nodes;
202 # Does the reading have an ID? If so it probably has a witDetail
203 # attached, and we need to read it.
204 if( $rdg->hasAttribute( 'xml:id' ) ) {
205 warn "Witdetail on meta reading" if $flag; # this could get complicated.
206 my $rid = $rdg->getAttribute( 'xml:id' );
207 my $xpc = XML::LibXML::XPathContext->new( $xn );
208 my @details = $xpc->findnodes( './witDetail[@target="'.$rid.'"]' );
209 foreach my $d ( @details ) {
210 _parse_wit_detail( $d, \%wit_rdgs, \@lemma );
215 # Now collate the variant readings, since it is not done for us.
216 collate_variants( $c, \@lemma, values %wit_rdgs );
218 # Now add the witness paths for each reading.
219 foreach my $wit_id ( keys %wit_rdgs ) {
220 my $witstr = get_sigil( $wit_id, $c );
221 my $rdg_list = $wit_rdgs{$wit_id};
222 _add_wit_path( $c, $rdg_list, $app_id, $anchor, $witstr );
229 return sprintf( "#ANCHOR_%s#", $xmlid );
233 my( $c, $app, $anchor ) = @_;
234 my @nodes = grep { $_->id !~ /^\#A(PP|NCHOR)/ }
235 $c->reading_sequence( $c->reading( $app ), $c->reading( $anchor ),
241 # A utility function to change apparatus-ese into a full variant.
242 my( $reading, $lemma ) = @_;
243 return $reading if $reading eq $lemma;
244 my $oldreading = $reading;
245 # $lemma =~ s/\s+[[:punct:]]+$//;
246 # $reading =~ s/\s*\(?sic([\s\w.]+)?\)?$//;
247 my $flag; # In case of p.c. indications
248 my @words = split( /\s+/, $lemma );
249 if( $reading =~ /^(.*) praem.$/ ) {
250 $reading = "$1 $lemma";
251 } elsif( $reading =~ /^(.*) add.$/ ) {
252 $reading = "$lemma $1";
253 } elsif( $reading =~ /add. alia manu/
254 || $reading =~ /inscriptionem compegi e/ # TODO huh?
255 || $reading eq 'inc.' # TODO huh?
259 } elsif( $reading =~ /locus [uv]acuus/
260 || $reading eq 'def.'
262 $reading = '#LACUNA#';
263 } elsif( $reading eq 'om.' ) {
265 } elsif( $reading =~ /^in[uv]\.$/ ) {
266 # Hope it is two words.
267 print STDERR "WARNING: want to invert a lemma that is not two words\n"
268 unless scalar( @words ) == 2;
269 $reading = join( ' ', reverse( @words ) );
270 } elsif( $reading =~ /^iter(\.|at)$/ ) {
272 $reading = "$lemma $lemma";
273 } elsif( $reading eq 'in marg.' ) {
274 # There was nothing before a correction.
277 } elsif( $reading =~ /^(.*) \.\.\. (.*)$/ ) {
278 # The first and last N words captured should replace the first and
279 # last N words of the lemma.
280 my @begin = split( /\s+/, $1 );
281 my @end = split( /\s+/, $2 );
282 if( scalar( @begin ) + scalar ( @end ) > scalar( @words ) ) {
283 # Something is wrong and we can't do the splice.
284 print STDERR "ERROR: $lemma is too short to accommodate $oldreading\n";
286 splice( @words, 0, scalar @begin, @begin );
287 splice( @words, -(scalar @end), scalar @end, @end );
288 $reading = join( ' ', @words );
291 if( $oldreading ne $reading || $flag || $oldreading =~ /\./ ) {
293 $int .= " ($flag)" if $flag;
294 print STDERR "Interpreted $oldreading as $int given $lemma\n";
296 return( $reading, $flag );
299 sub _parse_wit_detail {
300 my( $detail, $readings, $lemma ) = @_;
301 my $wit = $detail->getAttribute( 'wit' );
302 my $content = $detail->textContent;
303 if( $content =~ /a\.\s*c\./ ) {
304 # Replace the key in the $readings hash
305 my $rdg = delete $readings->{$wit};
306 $readings->{$wit.'_ac'} = $rdg;
307 $has_ac{$sigil_for{$wit}} = 1;
308 } elsif( $content =~ /p\.\s*c\./ ) {
309 # If no key for the wit a.c. exists, add one pointing to the lemma
310 unless( exists $readings->{$wit.'_ac'} ) {
311 $readings->{$wit.'_ac'} = $lemma;
313 $has_ac{$sigil_for{$wit}} = 1;
314 } # else don't bother just yet
318 my( $xml_id, $c ) = @_;
319 if( $xml_id =~ /^(.*)_ac$/ ) {
321 return $sigil_for{$real_id} . $c->ac_label;
323 return $sigil_for{$xml_id};
327 sub expand_all_paths {
330 # Walk the collation and fish out the paths for each witness
331 foreach my $wit ( $c->tradition->witnesses ) {
332 my $sig = $wit->sigil;
333 my @path = grep { !$_->is_ph }
334 $c->reading_sequence( $c->start, $c->end, $sig );
335 $wit->path( \@path );
336 if( $has_ac{$sig} ) {
337 my @ac_path = grep { !$_->is_ph }
338 $c->reading_sequence( $c->start, $c->end, $sig.$c->ac_label );
339 $wit->uncorrected_path( \@ac_path );
344 foreach my $anchor ( grep { $_->is_ph } $c->readings ) {
345 $c->del_reading( $anchor );
347 # Delete the base edges
348 map { $c->del_path( $_, $c->baselabel ) } $c->paths;
350 # Make the path edges
351 $c->make_witness_paths();
355 my( $c, $rdg, $app, $anchor, $wit ) = @_;
357 push( @nodes, $c->reading( $anchor ) );
359 my $cur = $c->reading( $app );
360 foreach my $n ( @nodes ) {
361 $c->add_path( $cur, $n, $wit );
370 This package is free software and is provided "as is" without express
371 or implied warranty. You can redistribute it and/or modify it under
372 the same terms as Perl itself.
376 Tara L Andrews, aurum@cpan.org