lib/Text/Tradition/Collation.pm

   1 package Text::Tradition::Collation;
   2
   3 use Encode qw( decode_utf8 );
   4 use File::Temp;
   5 use Graph;
   6 use IPC::Run qw( run binary );
   7 use Text::CSV_XS;
   8 use Text::Tradition::Collation::Reading;
   9 use Text::Tradition::Collation::RelationshipStore;
  10 use XML::LibXML;
  11 use Moose;
  12
  13 has 'sequence' => (
  14     is => 'ro',
  15     isa => 'Graph',
  16     default => sub { Graph->new() },
  17     handles => {
  18         paths => 'edges',
  19     },
  20     );
  21
  22 has 'relations' => (
  23         is => 'ro',
  24         isa => 'Text::Tradition::Collation::RelationshipStore',
  25         handles => {
  26                 relationships => 'relationships',
  27                 related_readings => 'related_readings',
  28         },
  29         writer => '_set_relations',
  30         );
  31
  32 has 'tradition' => (
  33     is => 'ro',
  34     isa => 'Text::Tradition',
  35     weak_ref => 1,
  36     );
  37
  38 has 'readings' => (
  39         isa => 'HashRef[Text::Tradition::Collation::Reading]',
  40         traits => ['Hash'],
  41     handles => {
  42         reading     => 'get',
  43         _add_reading => 'set',
  44         del_reading => 'delete',
  45         has_reading => 'exists',
  46         readings   => 'values',
  47     },
  48     default => sub { {} },
  49         );
  50
  51 has 'wit_list_separator' => (
  52     is => 'rw',
  53     isa => 'Str',
  54     default => ', ',
  55     );
  56
  57 has 'baselabel' => (
  58     is => 'rw',
  59     isa => 'Str',
  60     default => 'base text',
  61     );
  62
  63 has 'linear' => (
  64     is => 'rw',
  65     isa => 'Bool',
  66     default => 1,
  67     );
  68
  69 has 'ac_label' => (
  70     is => 'rw',
  71     isa => 'Str',
  72     default => ' (a.c.)',
  73     );
  74
  75 has 'start' => (
  76         is => 'ro',
  77         isa => 'Text::Tradition::Collation::Reading',
  78         writer => '_set_start',
  79         weak_ref => 1,
  80         );
  81
  82 has 'end' => (
  83         is => 'ro',
  84         isa => 'Text::Tradition::Collation::Reading',
  85         writer => '_set_end',
  86         weak_ref => 1,
  87         );
  88
  89 # The collation can be created two ways:
  90 # 1. Collate a set of witnesses (with CollateX I guess) and process
  91 #    the results as in 2.
  92 # 2. Read a pre-prepared collation in one of a variety of formats,
  93 #    and make the graph from that.
  94
  95 # The graph itself will (for now) be immutable, and the positions
  96 # within the graph will also be immutable.  We need to calculate those
  97 # positions upon graph construction.  The equivalences between graph
  98 # nodes will be mutable, entirely determined by the user (or possibly
  99 # by some semantic pre-processing provided by the user.)  So the
 100 # constructor should just make an empty equivalences object.  The
 101 # constructor will also need to make the witness objects, if we didn't
 102 # come through option 1.
 103
 104 sub BUILD {
 105     my $self = shift;
 106     $self->_set_relations( Text::Tradition::Collation::RelationshipStore->new( 'collation' => $self ) );
 107     $self->_set_start( $self->add_reading( { 'collation' => $self, 'is_start' => 1 } ) );
 108     $self->_set_end( $self->add_reading( { 'collation' => $self, 'is_end' => 1 } ) );
 109 }
 110
 111 ### Reading construct/destruct functions
 112
 113 sub add_reading {
 114         my( $self, $reading ) = @_;
 115         unless( ref( $reading ) eq 'Text::Tradition::Collation::Reading' ) {
 116                 my %args = %$reading;
 117                 $reading = Text::Tradition::Collation::Reading->new(
 118                         'collation' => $self,
 119                         %args );
 120         }
 121         # First check to see if a reading with this ID exists.
 122         if( $self->reading( $reading->id ) ) {
 123                 warn "Collation already has a reading with id " . $reading->id;
 124                 return undef;
 125         }
 126         $self->_add_reading( $reading->id => $reading );
 127         # Once the reading has been added, put it in both graphs.
 128         $self->sequence->add_vertex( $reading->id );
 129         $self->relations->add_reading( $reading->id );
 130         return $reading;
 131 };
 132
 133 around del_reading => sub {
 134         my $orig = shift;
 135         my $self = shift;
 136         my $arg = shift;
 137
 138         if( ref( $arg ) eq 'Text::Tradition::Collation::Reading' ) {
 139                 $arg = $arg->id;
 140         }
 141         # Remove the reading from the graphs.
 142         $self->sequence->delete_vertex( $arg );
 143         $self->relations->delete_reading( $arg );
 144
 145         # Carry on.
 146         $self->$orig( $arg );
 147 };
 148
 149 # merge_readings( $main, $to_be_deleted );
 150
 151 sub merge_readings {
 152         my $self = shift;
 153
 154         # We only need the IDs for adding paths to the graph, not the reading
 155         # objects themselves.
 156     my( $kept, $deleted, $combine_char ) = $self->_stringify_args( @_ );
 157
 158     # The kept reading should inherit the paths and the relationships
 159     # of the deleted reading.
 160         foreach my $path ( $self->sequence->edges_at( $deleted ) ) {
 161                 my @vector = ( $kept );
 162                 push( @vector, $path->[1] ) if $path->[0] eq $deleted;
 163                 unshift( @vector, $path->[0] ) if $path->[1] eq $deleted;
 164                 next if $vector[0] eq $vector[1]; # Don't add a self loop
 165                 my %wits = %{$self->sequence->get_edge_attributes( @$path )};
 166                 $self->sequence->add_edge( @vector );
 167                 my $fwits = $self->sequence->get_edge_attributes( @vector );
 168                 @wits{keys %$fwits} = values %$fwits;
 169                 $self->sequence->set_edge_attributes( @vector, \%wits );
 170         }
 171         $self->relations->merge_readings( $kept, $deleted, $combine_char );
 172
 173         # Do the deletion deed.
 174         if( $combine_char ) {
 175                 my $kept_obj = $self->reading( $kept );
 176                 my $new_text = join( $combine_char, $kept_obj->text,
 177                         $self->reading( $deleted )->text );
 178                 $kept_obj->alter_text( $new_text );
 179         }
 180         $self->del_reading( $deleted );
 181 }
 182
 183
 184 # Helper function for manipulating the graph.
 185 sub _stringify_args {
 186         my( $self, $first, $second, $arg ) = @_;
 187     $first = $first->id
 188         if ref( $first ) eq 'Text::Tradition::Collation::Reading';
 189     $second = $second->id
 190         if ref( $second ) eq 'Text::Tradition::Collation::Reading';
 191     return( $first, $second, $arg );
 192 }
 193
 194 ### Path logic
 195
 196 sub add_path {
 197         my $self = shift;
 198
 199         # We only need the IDs for adding paths to the graph, not the reading
 200         # objects themselves.
 201     my( $source, $target, $wit ) = $self->_stringify_args( @_ );
 202
 203         # Connect the readings
 204     $self->sequence->add_edge( $source, $target );
 205     # Note the witness in question
 206     $self->sequence->set_edge_attribute( $source, $target, $wit, 1 );
 207 };
 208
 209 sub del_path {
 210         my $self = shift;
 211         my @args;
 212         if( ref( $_[0] ) eq 'ARRAY' ) {
 213                 my $e = shift @_;
 214                 @args = ( @$e, @_ );
 215         } else {
 216                 @args = @_;
 217         }
 218
 219         # We only need the IDs for adding paths to the graph, not the reading
 220         # objects themselves.
 221     my( $source, $target, $wit ) = $self->_stringify_args( @args );
 222
 223         if( $self->sequence->has_edge_attribute( $source, $target, $wit ) ) {
 224                 $self->sequence->delete_edge_attribute( $source, $target, $wit );
 225         }
 226         unless( keys %{$self->sequence->get_edge_attributes( $source, $target )} ) {
 227                 $self->sequence->delete_edge( $source, $target );
 228         }
 229 }
 230
 231
 232 # Extra graph-alike utility
 233 sub has_path {
 234         my $self = shift;
 235     my( $source, $target, $wit ) = $self->_stringify_args( @_ );
 236         return undef unless $self->sequence->has_edge( $source, $target );
 237         return $self->sequence->has_edge_attribute( $source, $target, $wit );
 238 }
 239
 240 =head2 add_relationship( $reading1, $reading2, $definition )
 241
 242 Adds the specified relationship between the two readings.  A relationship
 243 is transitive (i.e. undirected); the options for its definition may be found
 244 in Text::Tradition::Collation::Relationship.
 245
 246 =cut
 247
 248 # Wouldn't it be lovely if edges could be objects, and all this type checking
 249 # and attribute management could be done via Moose?
 250
 251 sub add_relationship {
 252         my $self = shift;
 253     my( $source, $target, $opts ) = $self->_stringify_args( @_ );
 254     return $self->relations->add_relationship( $source, $self->reading( $source ),
 255         $target, $self->reading( $target ), $opts );
 256 }
 257
 258 =head2 reading_witnesses( $reading )
 259
 260 Return a list of sigils corresponding to the witnesses in which the reading appears.
 261
 262 =cut
 263
 264 sub reading_witnesses {
 265         my( $self, $reading ) = @_;
 266         # We need only check either the incoming or the outgoing edges; I have
 267         # arbitrarily chosen "incoming".  Thus, special-case the start node.
 268         if( $reading eq $self->start ) {
 269                 return map { $_->sigil } $self->tradition->witnesses;
 270         }
 271         my %all_witnesses;
 272         foreach my $e ( $self->sequence->edges_to( $reading ) ) {
 273                 my $wits = $self->sequence->get_edge_attributes( @$e );
 274                 @all_witnesses{ keys %$wits } = 1;
 275         }
 276         return keys %all_witnesses;
 277 }
 278
 279 =head2 Output method(s)
 280
 281 =over
 282
 283 =item B<as_svg>
 284
 285 print $graph->as_svg( $recalculate );
 286
 287 Returns an SVG string that represents the graph, via as_dot and graphviz.
 288
 289 =cut
 290
 291 sub as_svg {
 292     my( $self ) = @_;
 293
 294     my @cmd = qw/dot -Tsvg/;
 295     my( $svg, $err );
 296     my $dotfile = File::Temp->new();
 297     ## TODO REMOVE
 298     # $dotfile->unlink_on_destroy(0);
 299     binmode $dotfile, ':utf8';
 300     print $dotfile $self->as_dot();
 301     push( @cmd, $dotfile->filename );
 302     run( \@cmd, ">", binary(), \$svg );
 303     $svg = decode_utf8( $svg );
 304     return $svg;
 305 }
 306
 307 =item B<as_dot>
 308
 309 print $graph->as_dot( $view, $recalculate );
 310
 311 Returns a string that is the collation graph expressed in dot
 312 (i.e. GraphViz) format.  The 'view' argument determines what kind of
 313 graph is produced.
 314     * 'path': a graph of witness paths through the collation (DEFAULT)
 315     * 'relationship': a graph of how collation readings relate to
 316       each other
 317
 318 =cut
 319
 320 sub as_dot {
 321     my( $self, $view ) = @_;
 322     $view = 'sequence' unless $view;
 323     # TODO consider making some of these things configurable
 324     my $graph_name = $self->tradition->name;
 325     $graph_name =~ s/[^\w\s]//g;
 326     $graph_name = join( '_', split( /\s+/, $graph_name ) );
 327     my $dot = sprintf( "digraph %s {\n", $graph_name );
 328     $dot .= "\tedge [ arrowhead=open ];\n";
 329     $dot .= "\tgraph [ rankdir=LR,bgcolor=none ];\n";
 330     $dot .= sprintf( "\tnode [ fontsize=%d, fillcolor=%s, style=%s, shape=%s ];\n",
 331                      11, "white", "filled", "ellipse" );
 332
 333     foreach my $reading ( $self->readings ) {
 334         # Need not output nodes without separate labels
 335         next if $reading->id eq $reading->text;
 336         my $label = $reading->text;
 337         $label =~ s/\"/\\\"/g;
 338         $dot .= sprintf( "\t\"%s\" [ label=\"%s\" ];\n", $reading->id, $label );
 339     }
 340
 341     # TODO do something sensible for relationships
 342
 343     my @edges = $self->paths;
 344     foreach my $edge ( @edges ) {
 345         my %variables = ( 'color' => '#000000',
 346                           'fontcolor' => '#000000',
 347                           'label' => join( ', ', $self->path_display_label( $edge ) ),
 348             );
 349         my $varopts = join( ', ', map { $_.'="'.$variables{$_}.'"' } sort keys %variables );
 350         # Account for the rank gap if necessary
 351         my $rankgap = $self->reading( $edge->[1] )->rank
 352                 - $self->reading( $edge->[0] )->rank;
 353                 $varopts .= ", minlen=$rankgap" if $rankgap > 1;
 354         $dot .= sprintf( "\t\"%s\" -> \"%s\" [ %s ];\n",
 355                          $edge->[0], $edge->[1], $varopts );
 356     }
 357     $dot .= "}\n";
 358     return $dot;
 359 }
 360
 361 sub path_witnesses {
 362         my( $self, @edge ) = @_;
 363         # If edge is an arrayref, cope.
 364         if( @edge == 1 && ref( $edge[0] ) eq 'ARRAY' ) {
 365                 my $e = shift @edge;
 366                 @edge = @$e;
 367         }
 368         my @wits = keys %{$self->sequence->get_edge_attributes( @edge )};
 369         return sort @wits;
 370 }
 371
 372 sub path_display_label {
 373         my( $self, $edge ) = @_;
 374         my @wits = $self->path_witnesses( $edge );
 375         my $maj = scalar( $self->tradition->witnesses ) * 0.6;
 376         if( scalar @wits > $maj ) {
 377                 return 'majority';
 378         } else {
 379                 return join( ', ', @wits );
 380         }
 381 }
 382
 383
 384 =item B<as_graphml>
 385
 386 print $graph->as_graphml( $recalculate )
 387
 388 Returns a GraphML representation of the collation graph, with
 389 transposition information and position information. Unless
 390 $recalculate is passed (and is a true value), the method will return a
 391 cached copy of the SVG after the first call to the method.
 392
 393 =cut
 394
 395 sub as_graphml {
 396     my( $self ) = @_;
 397
 398     # Some namespaces
 399     my $graphml_ns = 'http://graphml.graphdrawing.org/xmlns';
 400     my $xsi_ns = 'http://www.w3.org/2001/XMLSchema-instance';
 401     my $graphml_schema = 'http://graphml.graphdrawing.org/xmlns ' .
 402         'http://graphml.graphdrawing.org/xmlns/1.0/graphml.xsd';
 403
 404     # Create the document and root node
 405     my $graphml = XML::LibXML->createDocument( "1.0", "UTF-8" );
 406     my $root = $graphml->createElementNS( $graphml_ns, 'graphml' );
 407     $graphml->setDocumentElement( $root );
 408     $root->setNamespace( $xsi_ns, 'xsi', 0 );
 409     $root->setAttributeNS( $xsi_ns, 'schemaLocation', $graphml_schema );
 410
 411     # Add the data keys for the graph
 412     my %graph_data_keys;
 413     my $gdi = 0;
 414     my @graph_attributes = qw/ version wit_list_separator baselabel linear ac_label /;
 415     foreach my $datum ( @graph_attributes ) {
 416         $graph_data_keys{$datum} = 'dg'.$gdi++;
 417         my $key = $root->addNewChild( $graphml_ns, 'key' );
 418         $key->setAttribute( 'attr.name', $datum );
 419         $key->setAttribute( 'attr.type', $key eq 'linear' ? 'boolean' : 'string' );
 420         $key->setAttribute( 'for', 'graph' );
 421         $key->setAttribute( 'id', $graph_data_keys{$datum} );
 422     }
 423
 424     # Add the data keys for nodes
 425     my %node_data_keys;
 426     my $ndi = 0;
 427     my %node_data = (
 428         id => 'string',
 429         text => 'string',
 430         rank => 'string',
 431         is_start => 'boolean',
 432         is_end => 'boolean',
 433         is_lacuna => 'boolean',
 434         );
 435     foreach my $datum ( keys %node_data ) {
 436         $node_data_keys{$datum} = 'dn'.$ndi++;
 437         my $key = $root->addNewChild( $graphml_ns, 'key' );
 438         $key->setAttribute( 'attr.name', $datum );
 439         $key->setAttribute( 'attr.type', $node_data{$datum} );
 440         $key->setAttribute( 'for', 'node' );
 441         $key->setAttribute( 'id', $node_data_keys{$datum} );
 442     }
 443
 444     # Add the data keys for edges, i.e. witnesses
 445     my $edi = 0;
 446     my %edge_data_keys;
 447     my %edge_data = (
 448         class => 'string',                              # Class, deprecated soon
 449         witness => 'string',                    # ID/label for a path
 450         relationship => 'string',               # ID/label for a relationship
 451         extra => 'boolean',                             # Path key
 452         colocated => 'boolean',                 # Relationship key
 453         non_correctable => 'boolean',   # Relationship key
 454         non_independent => 'boolean',   # Relationship key
 455         );
 456     foreach my $datum ( keys %edge_data ) {
 457         $edge_data_keys{$datum} = 'de'.$edi++;
 458         my $key = $root->addNewChild( $graphml_ns, 'key' );
 459         $key->setAttribute( 'attr.name', $datum );
 460         $key->setAttribute( 'attr.type', $edge_data{$datum} );
 461         $key->setAttribute( 'for', 'edge' );
 462         $key->setAttribute( 'id', $edge_data_keys{$datum} );
 463     }
 464
 465     # Add the collation graph itself
 466     my $sgraph = $root->addNewChild( $graphml_ns, 'graph' );
 467     $sgraph->setAttribute( 'edgedefault', 'directed' );
 468     $sgraph->setAttribute( 'id', $self->tradition->name );
 469     $sgraph->setAttribute( 'parse.edgeids', 'canonical' );
 470     $sgraph->setAttribute( 'parse.edges', scalar($self->paths) );
 471     $sgraph->setAttribute( 'parse.nodeids', 'canonical' );
 472     $sgraph->setAttribute( 'parse.nodes', scalar($self->readings) );
 473     $sgraph->setAttribute( 'parse.order', 'nodesfirst' );
 474
 475     # Collation attribute data
 476     foreach my $datum ( @graph_attributes ) {
 477         my $value = $datum eq 'version' ? '3.0' : $self->$datum;
 478                 _add_graphml_data( $sgraph, $graph_data_keys{$datum}, $value );
 479         }
 480
 481     my $node_ctr = 0;
 482     my %node_hash;
 483     # Add our readings to the graph
 484     foreach my $n ( sort { $a->id cmp $b->id } $self->readings ) {
 485         # Add to the main graph
 486         my $node_el = $sgraph->addNewChild( $graphml_ns, 'node' );
 487         my $node_xmlid = 'n' . $node_ctr++;
 488         $node_hash{ $n->id } = $node_xmlid;
 489         $node_el->setAttribute( 'id', $node_xmlid );
 490         foreach my $d ( keys %node_data ) {
 491                 my $nval = $n->$d;
 492                 _add_graphml_data( $node_el, $node_data_keys{$d}, $nval )
 493                         if defined $nval;
 494         }
 495     }
 496
 497     # Add the path edges to the sequence graph
 498     my $edge_ctr = 0;
 499     foreach my $e ( sort { $a->[0] cmp $b->[0] } $self->sequence->edges() ) {
 500         # We add an edge in the graphml for every witness in $e.
 501         foreach my $wit ( $self->path_witnesses( $e ) ) {
 502                         my( $id, $from, $to ) = ( 'e'.$edge_ctr++,
 503                                                                                 $node_hash{ $e->[0] },
 504                                                                                 $node_hash{ $e->[1] } );
 505                         my $edge_el = $sgraph->addNewChild( $graphml_ns, 'edge' );
 506                         $edge_el->setAttribute( 'source', $from );
 507                         $edge_el->setAttribute( 'target', $to );
 508                         $edge_el->setAttribute( 'id', $id );
 509
 510                         # It's a witness path, so add the witness
 511                         my $base = $wit;
 512                         my $key = $edge_data_keys{'witness'};
 513                         # Is this an ante-corr witness?
 514                         my $aclabel = $self->ac_label;
 515                         if( $wit =~ /^(.*)\Q$aclabel\E$/ ) {
 516                                 # Keep the base witness
 517                                 $base = $1;
 518                                 # ...and record that this is an 'extra' reading path
 519                                 _add_graphml_data( $edge_el, $edge_data_keys{'extra'}, $aclabel );
 520                         }
 521                         _add_graphml_data( $edge_el, $edge_data_keys{'witness'}, $base );
 522                         _add_graphml_data( $edge_el, $edge_data_keys{'class'}, 'path' );
 523                 }
 524         }
 525
 526         # Add the relationship graph to the XML
 527         $self->relations->as_graphml( $root );
 528
 529     # Save and return the thing
 530     my $result = decode_utf8( $graphml->toString(1) );
 531     return $result;
 532 }
 533
 534 sub _add_graphml_data {
 535     my( $el, $key, $value ) = @_;
 536     return unless defined $value;
 537     my $data_el = $el->addNewChild( $el->namespaceURI, 'data' );
 538     $data_el->setAttribute( 'key', $key );
 539     $data_el->appendText( $value );
 540 }
 541
 542 =item B<as_csv>
 543
 544 print $graph->as_csv( $recalculate )
 545
 546 Returns a CSV alignment table representation of the collation graph, one
 547 row per witness (or witness uncorrected.)
 548
 549 =cut
 550
 551 sub as_csv {
 552     my( $self ) = @_;
 553     my $table = $self->make_alignment_table;
 554     my $csv = Text::CSV_XS->new( { binary => 1, quote_null => 0 } );
 555     my @result;
 556     # Make the header row
 557     $csv->combine( map { $_->{'witness'} } @{$table->{'alignment'}} );
 558         push( @result, decode_utf8( $csv->string ) );
 559     # Make the rest of the rows
 560     foreach my $idx ( 0 .. $table->{'length'} - 1 ) {
 561         my @rowobjs = map { $_->{'tokens'}->[$idx] } @{$table->{'alignment'}};
 562         my @row = map { $_ ? $_->{'t'} : $_ } @rowobjs;
 563         $csv->combine( @row );
 564         push( @result, decode_utf8( $csv->string ) );
 565     }
 566     return join( "\n", @result );
 567 }
 568
 569 =item B<make_alignment_table>
 570
 571 my $table = $graph->make_alignment_table( $use_refs, \@wits_to_include )
 572
 573 Return a reference to an alignment table, in a slightly enhanced CollateX
 574 format which looks like this:
 575
 576  $table = { alignment => [ { witness => "SIGIL",
 577                              tokens => [ { t => "READINGTEXT" }, ... ] },
 578                            { witness => "SIG2",
 579                              tokens => [ { t => "READINGTEXT" }, ... ] },
 580                            ... ],
 581             length => TEXTLEN };
 582
 583 If $use_refs is set to 1, the reading object is returned in the table
 584 instead of READINGTEXT; if not, the text of the reading is returned.
 585 If $wits_to_include is set to a hashref, only the witnesses whose sigil
 586 keys have a true hash value will be included.
 587
 588 =cut
 589
 590 sub make_alignment_table {
 591     my( $self, $noderefs, $include ) = @_;
 592     unless( $self->linear ) {
 593         warn "Need a linear graph in order to make an alignment table";
 594         return;
 595     }
 596     my $table = { 'alignment' => [], 'length' => $self->end->rank - 1 };
 597     my @all_pos = ( 1 .. $self->end->rank - 1 );
 598     foreach my $wit ( sort { $a->sigil cmp $b->sigil } $self->tradition->witnesses ) {
 599         if( $include ) {
 600                 next unless $include->{$wit->sigil};
 601         }
 602         # print STDERR "Making witness row(s) for " . $wit->sigil . "\n";
 603         my @wit_path = $self->reading_sequence( $self->start, $self->end, $wit->sigil );
 604         my @row = _make_witness_row( \@wit_path, \@all_pos, $noderefs );
 605         push( @{$table->{'alignment'}},
 606                 { 'witness' => $wit->sigil, 'tokens' => \@row } );
 607         if( $wit->is_layered ) {
 608                 my @wit_ac_path = $self->reading_sequence( $self->start, $self->end,
 609                         $wit->sigil.$self->ac_label, $wit->sigil );
 610             my @ac_row = _make_witness_row( \@wit_ac_path, \@all_pos, $noderefs );
 611                         push( @{$table->{'alignment'}},
 612                                 { 'witness' => $wit->sigil.$self->ac_label, 'tokens' => \@ac_row } );
 613         }
 614     }
 615         return $table;
 616 }
 617
 618 sub _make_witness_row {
 619     my( $path, $positions, $noderefs ) = @_;
 620     my %char_hash;
 621     map { $char_hash{$_} = undef } @$positions;
 622     my $debug = 0;
 623     foreach my $rdg ( @$path ) {
 624         my $rtext = $rdg->text;
 625         $rtext = '#LACUNA#' if $rdg->is_lacuna;
 626         print STDERR "rank " . $rdg->rank . "\n" if $debug;
 627         # print STDERR "No rank for " . $rdg->id . "\n" unless defined $rdg->rank;
 628         $char_hash{$rdg->rank} = $noderefs ? { 't' => $rdg }
 629                                                                            : { 't' => $rtext };
 630     }
 631     my @row = map { $char_hash{$_} } @$positions;
 632     # Fill in lacuna markers for undef spots in the row
 633     my $last_el = shift @row;
 634     my @filled_row = ( $last_el );
 635     foreach my $el ( @row ) {
 636         # If we are using node reference, make the lacuna node appear many times
 637         # in the table.  If not, use the lacuna tag.
 638         if( $last_el && _el_is_lacuna( $last_el ) && !defined $el ) {
 639             $el = $noderefs ? $last_el : { 't' => '#LACUNA#' };
 640         }
 641         push( @filled_row, $el );
 642         $last_el = $el;
 643     }
 644     return @filled_row;
 645 }
 646
 647 # Tiny utility function to say if a table element is a lacuna
 648 sub _el_is_lacuna {
 649     my $el = shift;
 650     return 1 if $el->{'t'} eq '#LACUNA#';
 651     return 1 if ref( $el->{'t'} ) eq 'Text::Tradition::Collation::Reading'
 652         && $el->{'t'}->is_lacuna;
 653     return 0;
 654 }
 655
 656 # Helper to turn the witnesses along columns rather than rows.  Assumes
 657 # equal-sized rows.
 658 sub _turn_table {
 659     my( $table ) = @_;
 660     my $result = [];
 661     return $result unless scalar @$table;
 662     my $nrows = scalar @{$table->[0]};
 663     foreach my $idx ( 0 .. $nrows - 1 ) {
 664         foreach my $wit ( 0 .. $#{$table} ) {
 665             $result->[$idx]->[$wit] = $table->[$wit]->[$idx];
 666         }
 667     }
 668     return $result;
 669 }
 670
 671 =back
 672
 673 =head2 Navigation methods
 674
 675 =over
 676
 677 =item B<start>
 678
 679 my $beginning = $collation->start();
 680
 681 Returns the beginning of the collation, a meta-reading with label '#START#'.
 682
 683 =item B<end>
 684
 685 my $end = $collation->end();
 686
 687 Returns the end of the collation, a meta-reading with label '#END#'.
 688
 689
 690 =item B<reading_sequence>
 691
 692 my @readings = $graph->reading_sequence( $first, $last, $path[, $alt_path] );
 693
 694 Returns the ordered list of readings, starting with $first and ending
 695 with $last, along the given witness path.  If no path is specified,
 696 assume that the path is that of the base text (if any.)
 697
 698 =cut
 699
 700 # TODO Think about returning some lazy-eval iterator.
 701
 702 sub reading_sequence {
 703     my( $self, $start, $end, $witness, $backup ) = @_;
 704
 705     $witness = $self->baselabel unless $witness;
 706     my @readings = ( $start );
 707     my %seen;
 708     my $n = $start;
 709     while( $n && $n->id ne $end->id ) {
 710         if( exists( $seen{$n->id} ) ) {
 711             warn "Detected loop at " . $n->id;
 712             last;
 713         }
 714         $seen{$n->id} = 1;
 715
 716         my $next = $self->next_reading( $n, $witness, $backup );
 717         unless( $next ) {
 718             warn "Did not find any path for $witness from reading " . $n->id;
 719             last;
 720         }
 721         push( @readings, $next );
 722         $n = $next;
 723     }
 724     # Check that the last reading is our end reading.
 725     my $last = $readings[$#readings];
 726     warn "Last reading found from " . $start->text .
 727         " for witness $witness is not the end!"
 728         unless $last->id eq $end->id;
 729
 730     return @readings;
 731 }
 732
 733 =item B<next_reading>
 734
 735 my $next_reading = $graph->next_reading( $reading, $witpath );
 736
 737 Returns the reading that follows the given reading along the given witness
 738 path.
 739
 740 =cut
 741
 742 sub next_reading {
 743     # Return the successor via the corresponding path.
 744     my $self = shift;
 745     my $answer = $self->_find_linked_reading( 'next', @_ );
 746         return undef unless $answer;
 747     return $self->reading( $answer );
 748 }
 749
 750 =item B<prior_reading>
 751
 752 my $prior_reading = $graph->prior_reading( $reading, $witpath );
 753
 754 Returns the reading that precedes the given reading along the given witness
 755 path.
 756
 757 =cut
 758
 759 sub prior_reading {
 760     # Return the predecessor via the corresponding path.
 761     my $self = shift;
 762     my $answer = $self->_find_linked_reading( 'prior', @_ );
 763     return $self->reading( $answer );
 764 }
 765
 766 sub _find_linked_reading {
 767     my( $self, $direction, $node, $path, $alt_path ) = @_;
 768     my @linked_paths = $direction eq 'next'
 769         ? $self->sequence->edges_from( $node )
 770         : $self->sequence->edges_to( $node );
 771     return undef unless scalar( @linked_paths );
 772
 773     # We have to find the linked path that contains all of the
 774     # witnesses supplied in $path.
 775     my( @path_wits, @alt_path_wits );
 776     @path_wits = sort( $self->witnesses_of_label( $path ) ) if $path;
 777     @alt_path_wits = sort( $self->witnesses_of_label( $alt_path ) ) if $alt_path;
 778     my $base_le;
 779     my $alt_le;
 780     foreach my $le ( @linked_paths ) {
 781         if( $self->sequence->has_edge_attribute( @$le, $self->baselabel ) ) {
 782             $base_le = $le;
 783         }
 784                 my @le_wits = $self->path_witnesses( $le );
 785                 if( _is_within( \@path_wits, \@le_wits ) ) {
 786                         # This is the right path.
 787                         return $direction eq 'next' ? $le->[1] : $le->[0];
 788                 } elsif( _is_within( \@alt_path_wits, \@le_wits ) ) {
 789                         $alt_le = $le;
 790                 }
 791     }
 792     # Got this far? Return the alternate path if it exists.
 793     return $direction eq 'next' ? $alt_le->[1] : $alt_le->[0]
 794         if $alt_le;
 795
 796     # Got this far? Return the base path if it exists.
 797     return $direction eq 'next' ? $base_le->[1] : $base_le->[0]
 798         if $base_le;
 799
 800     # Got this far? We have no appropriate path.
 801     warn "Could not find $direction node from " . $node->id
 802         . " along path $path";
 803     return undef;
 804 }
 805
 806 # Some set logic.
 807 sub _is_within {
 808     my( $set1, $set2 ) = @_;
 809     my $ret = @$set1; # will be 0, i.e. false, if set1 is empty
 810     foreach my $el ( @$set1 ) {
 811         $ret = 0 unless grep { /^\Q$el\E$/ } @$set2;
 812     }
 813     return $ret;
 814 }
 815
 816
 817 ## INITIALIZATION METHODS - for use by parsers
 818
 819 # For use when a collation is constructed from a base text and an apparatus.
 820 # We have the sequences of readings and just need to add path edges.
 821 # When we are done, clear out the witness path attributes, as they are no
 822 # longer needed.
 823 # TODO Find a way to replace the witness path attributes with encapsulated functions?
 824
 825 sub make_witness_paths {
 826     my( $self ) = @_;
 827     foreach my $wit ( $self->tradition->witnesses ) {
 828         # print STDERR "Making path for " . $wit->sigil . "\n";
 829         $self->make_witness_path( $wit );
 830     }
 831 }
 832
 833 sub make_witness_path {
 834     my( $self, $wit ) = @_;
 835     my @chain = @{$wit->path};
 836     my $sig = $wit->sigil;
 837     foreach my $idx ( 0 .. $#chain-1 ) {
 838         $self->add_path( $chain[$idx], $chain[$idx+1], $sig );
 839     }
 840     if( $wit->is_layered ) {
 841         @chain = @{$wit->uncorrected_path};
 842         foreach my $idx( 0 .. $#chain-1 ) {
 843             my $source = $chain[$idx];
 844             my $target = $chain[$idx+1];
 845             $self->add_path( $source, $target, $sig.$self->ac_label )
 846                 unless $self->has_path( $source, $target, $sig );
 847         }
 848     }
 849     $wit->clear_path;
 850     $wit->clear_uncorrected_path;
 851 }
 852
 853 sub calculate_ranks {
 854     my $self = shift;
 855     # Walk a version of the graph where every node linked by a relationship
 856     # edge is fundamentally the same node, and do a topological ranking on
 857     # the nodes in this graph.
 858     my $topo_graph = Graph->new();
 859     my %rel_containers;
 860     my $rel_ctr = 0;
 861     # Add the nodes
 862     foreach my $r ( $self->readings ) {
 863         next if exists $rel_containers{$r->id};
 864         my @rels = $r->related_readings( 'colocated' );
 865         if( @rels ) {
 866             # Make a relationship container.
 867             push( @rels, $r );
 868             my $rn = 'rel_container_' . $rel_ctr++;
 869             $topo_graph->add_vertex( $rn );
 870             foreach( @rels ) {
 871                 $rel_containers{$_->id} = $rn;
 872             }
 873         } else {
 874             # Add a new node to mirror the old node.
 875             $rel_containers{$r->id} = $r->id;
 876             $topo_graph->add_vertex( $r->id );
 877         }
 878     }
 879
 880     # Add the edges.
 881     foreach my $r ( $self->readings ) {
 882         foreach my $n ( $self->sequence->successors( $r->id ) ) {
 883                 my( $tfrom, $tto ) = ( $rel_containers{$r->id},
 884                         $rel_containers{$n} );
 885                 $DB::single = 1 unless $tfrom && $tto;
 886             $topo_graph->add_edge( $tfrom, $tto );
 887         }
 888     }
 889
 890     # Now do the rankings, starting with the start node.
 891     my $topo_start = $rel_containers{$self->start->id};
 892     my $node_ranks = { $topo_start => 0 };
 893     my @curr_origin = ( $topo_start );
 894     # A little iterative function.
 895     while( @curr_origin ) {
 896         @curr_origin = _assign_rank( $topo_graph, $node_ranks, @curr_origin );
 897     }
 898     # Transfer our rankings from the topological graph to the real one.
 899     foreach my $r ( $self->readings ) {
 900         if( defined $node_ranks->{$rel_containers{$r->id}} ) {
 901             $r->rank( $node_ranks->{$rel_containers{$r->id}} );
 902         } else {
 903             $DB::single = 1;
 904             die "No rank calculated for node " . $r->id
 905                 . " - do you have a cycle in the graph?";
 906         }
 907     }
 908 }
 909
 910 sub _assign_rank {
 911     my( $graph, $node_ranks, @current_nodes ) = @_;
 912     # Look at each of the children of @current_nodes.  If all the child's
 913     # parents have a rank, assign it the highest rank + 1 and add it to
 914     # @next_nodes.  Otherwise skip it; we will return when the highest-ranked
 915     # parent gets a rank.
 916     my @next_nodes;
 917     foreach my $c ( @current_nodes ) {
 918         warn "Current reading $c has no rank!"
 919             unless exists $node_ranks->{$c};
 920         # print STDERR "Looking at child of node $c, rank "
 921         #     . $node_ranks->{$c} . "\n";
 922         foreach my $child ( $graph->successors( $c ) ) {
 923             next if exists $node_ranks->{$child};
 924             my $highest_rank = -1;
 925             my $skip = 0;
 926             foreach my $parent ( $graph->predecessors( $child ) ) {
 927                 if( exists $node_ranks->{$parent} ) {
 928                     $highest_rank = $node_ranks->{$parent}
 929                         if $highest_rank <= $node_ranks->{$parent};
 930                 } else {
 931                     $skip = 1;
 932                     last;
 933                 }
 934             }
 935             next if $skip;
 936             my $c_rank = $highest_rank + 1;
 937             # print STDERR "Assigning rank $c_rank to node $child \n";
 938             $node_ranks->{$child} = $c_rank;
 939             push( @next_nodes, $child );
 940         }
 941     }
 942     return @next_nodes;
 943 }
 944
 945 # Another method to make up for rough collation methods.  If the same reading
 946 # appears multiple times at the same rank, collapse the nodes.
 947 sub flatten_ranks {
 948     my $self = shift;
 949     my %unique_rank_rdg;
 950     foreach my $rdg ( $self->readings ) {
 951         next unless $rdg->has_rank;
 952         my $key = $rdg->rank . "||" . $rdg->text;
 953         if( exists $unique_rank_rdg{$key} ) {
 954             # Combine!
 955             # print STDERR "Combining readings at same rank: $key\n";
 956             $self->merge_readings( $unique_rank_rdg{$key}, $rdg );
 957         } else {
 958             $unique_rank_rdg{$key} = $rdg;
 959         }
 960     }
 961 }
 962
 963
 964 ## Utility functions
 965
 966 # Return the string that joins together a list of witnesses for
 967 # display on a single path.
 968 sub witnesses_of_label {
 969     my( $self, $label ) = @_;
 970     my $regex = $self->wit_list_separator;
 971     my @answer = split( /\Q$regex\E/, $label );
 972     return @answer;
 973 }
 974
 975 =begin testing
 976
 977 use Text::Tradition;
 978
 979 my $cxfile = 't/data/Collatex-16.xml';
 980 my $t = Text::Tradition->new(
 981     'name'  => 'inline',
 982     'input' => 'CollateX',
 983     'file'  => $cxfile,
 984     );
 985 my $c = $t->collation;
 986
 987 is( $c->common_predecessor( $c->reading('n9'), $c->reading('n23') )->id,
 988     'n20', "Found correct common predecessor" );
 989 is( $c->common_successor( $c->reading('n9'), $c->reading('n23') )->id,
 990     '#END#', "Found correct common successor" );
 991
 992 is( $c->common_predecessor( $c->reading('n19'), $c->reading('n17') )->id,
 993     'n16', "Found correct common predecessor for readings on same path" );
 994 is( $c->common_successor( $c->reading('n21'), $c->reading('n26') )->id,
 995     '#END#', "Found correct common successor for readings on same path" );
 996
 997 =end testing
 998
 999 =cut
1000
1001 ## Return the closest reading that is a predecessor of both the given readings.
1002 sub common_predecessor {
1003         my $self = shift;
1004         return $self->common_in_path( @_, 'predecessors' );
1005 }
1006
1007 sub common_successor {
1008         my $self = shift;
1009         return $self->common_in_path( @_, 'successors' );
1010 }
1011
1012 sub common_in_path {
1013         my( $self, $r1, $r2, $dir ) = @_;
1014         my $iter = $r1->rank > $r2->rank ? $r1->rank : $r2->rank;
1015         $iter = $self->end->rank - $iter if $dir eq 'successors';
1016         my @candidates;
1017         my @last_checked = ( $r1, $r2 );
1018         my %all_seen;
1019         while( !@candidates ) {
1020                 my @new_lc;
1021                 foreach my $lc ( @last_checked ) {
1022                         foreach my $p ( $lc->$dir ) {
1023                                 if( $all_seen{$p->id} ) {
1024                                         push( @candidates, $p );
1025                                 } else {
1026                                         $all_seen{$p->id} = 1;
1027                                         push( @new_lc, $p );
1028                                 }
1029                         }
1030                 }
1031                 @last_checked = @new_lc;
1032         }
1033         my @answer = sort { $a->rank <=> $b->rank } @candidates;
1034         return $dir eq 'predecessors' ? pop( @answer ) : shift ( @answer );
1035 }
1036
1037 no Moose;
1038 __PACKAGE__->meta->make_immutable;
1039
1040 =head1 BUGS / TODO
1041
1042 =over
1043
1044 =item * Think about making Relationship objects again
1045
1046 =back