Source

Fiction-XML / perl / modules / XML-Grammar-Fiction / lib / XML / Grammar / Fiction / FromProto.pm

Full commit
shl...@52c325ad-… a2b836c 



Shlomi Fish 38da779 
shl...@52c325ad-… a2b836c 


shl...@52c325ad-… 887754f 
shl...@52c325ad-… a2b836c 
Shlomi Fish f136e54 
shl...@52c325ad-… a2b836c 
shl...@52c325ad-… 24980b2 

shl...@52c325ad-… 5fa2350 



shl...@52c325ad-… 40dad8d 
shl...@52c325ad-… a2b836c 



shl...@52c325ad-… 5500585 
shl...@52c325ad-… a2b836c 


Shlomi Fish 7dbc955 
shl...@52c325ad-… a2b836c 


Shlomi Fish 7dbc955 
shl...@52c325ad-… a2b836c 













shl...@52c325ad-… 5500585 

shl...@52c325ad-… a2b836c 




Shlomi Fish 9773cfd 








shl...@52c325ad-… a2b836c 




shl...@52c325ad-… 5fa2350 
shl...@52c325ad-… a2b836c 









Shlomi Fish 43810e1 
shl...@52c325ad-… a2b836c 










shl...@52c325ad-… 7c01d8a 





shl...@52c325ad-… 9163241 


shl...@52c325ad-… 7c01d8a 


shl...@52c325ad-… 9163241 



shl...@52c325ad-… 7c01d8a 
shl...@52c325ad-… 9163241 



shl...@52c325ad-… 7c01d8a 


shl...@52c325ad-… 9163241 


shl...@52c325ad-… cebba1d 
shl...@52c325ad-… 9163241 
shl...@52c325ad-… cebba1d 









shl...@52c325ad-… 7c01d8a 



shl...@52c325ad-… 9163241 
shl...@52c325ad-… 7c01d8a 




shl...@52c325ad-… a2b836c 



shl...@52c325ad-… ed40f70 
shl...@52c325ad-… a2b836c 


shl...@52c325ad-… ed40f70 
shl...@52c325ad-… a2b836c 








shl...@52c325ad-… 4affaaf 




shl...@52c325ad-… 40dad8d 



shl...@52c325ad-… cebba1d 


shl...@52c325ad-… 40dad8d 
shl...@52c325ad-… cebba1d 



shl...@52c325ad-… 40dad8d 




shl...@52c325ad-… ad2bff0 



shl...@52c325ad-… 3e59310 


shl...@52c325ad-… ad2bff0 
shl...@52c325ad-… 3e59310 

shl...@52c325ad-… ad2bff0 




shl...@52c325ad-… 5fb950b 
shl...@52c325ad-… 834eaba 

















































shl...@52c325ad-… 9163241 















shl...@52c325ad-… 12969c1 













Shlomi Fish 43810e1 
shl...@52c325ad-… 12969c1 
shl...@52c325ad-… 0f4c08c 
shl...@52c325ad-… 12969c1 





shl...@52c325ad-… 135230f 
shl...@52c325ad-… 12969c1 
shl...@52c325ad-… 135230f 
shl...@52c325ad-… 12969c1 

shl...@52c325ad-… ad95a95 
shl...@52c325ad-… 12969c1 
shl...@52c325ad-… ad95a95 
shl...@52c325ad-… 12969c1 

shl...@52c325ad-… 4d9c695 













shl...@52c325ad-… a2b836c 









shl...@52c325ad-… ed40f70 
shl...@52c325ad-… 84e1dd3 





shl...@52c325ad-… ed40f70 
shl...@52c325ad-… a2b836c 


shl...@52c325ad-… 4affaaf 
shl...@52c325ad-… a2b836c 



shl...@52c325ad-… ed40f70 
shl...@52c325ad-… 5fa2350 





shl...@52c325ad-… ed40f70 
shl...@52c325ad-… a2b836c 
shl...@52c325ad-… 0f4c08c 
shl...@52c325ad-… a2b836c 
shl...@52c325ad-… ed40f70 
shl...@52c325ad-… a2b836c 
shl...@52c325ad-… 4d9c695 
shl...@52c325ad-… a2b836c 
shl...@52c325ad-… ed40f70 
shl...@52c325ad-… a2b836c 











Shlomi Fish 43810e1 
shl...@52c325ad-… a2b836c 

shl...@52c325ad-… 7c01d8a 



shl...@52c325ad-… a2b836c 






















Shlomi Fish 43810e1 
shl...@52c325ad-… a2b836c 












shl...@52c325ad-… 5fa2350 













shl...@52c325ad-… dea59e0 
shl...@52c325ad-… 5fa2350 





Shlomi Fish 43810e1 
shl...@52c325ad-… 5fa2350 




shl...@52c325ad-… dea59e0 
shl...@52c325ad-… 5fa2350 



shl...@52c325ad-… 7c01d8a 



shl...@52c325ad-… 5fa2350 




shl...@52c325ad-… a2b836c 






Shlomi Fish 43810e1 
shl...@52c325ad-… a2b836c 
Shlomi Fish 43810e1 
shl...@52c325ad-… a2b836c 









Shlomi Fish 43810e1 
shl...@52c325ad-… a2b836c 



shl...@52c325ad-… 40dad8d 


shl...@52c325ad-… a2b836c 



shl...@52c325ad-… 0355d3f 
shl...@52c325ad-… 5fa2350 
shl...@52c325ad-… a2b836c 




shl...@52c325ad-… 5fa2350 
shl...@52c325ad-… a2b836c 

Shlomi Fish 43810e1 
shl...@52c325ad-… a2b836c 



  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
package XML::Grammar::Fiction::FromProto;

use strict;
use warnings;
use autodie;

use Carp;
use HTML::Entities ();
use XML::Writer;

use MooX 'late';

extends("XML::Grammar::FictionBase::TagsTree2XML");

use List::Util (qw(first));

my $fiction_ns = q{http://web-cpan.berlios.de/modules/XML-Grammar-Fortune/fiction-xml-0.2/};
my $xml_ns = "http://www.w3.org/XML/1998/namespace";
my $xlink_ns = "http://www.w3.org/1999/xlink";

=head1 NAME

XML::Grammar::Fiction::FromProto - module that converts well-formed
text representing prose to an XML format.

=head1 VERSION

Version 0.12.2

=cut

our $VERSION = '0.12.2';

=head2 new()

Accepts no arguments so far. May take some time as the grammar is compiled
at that point.

=head2 meta()

Internal - (to settle pod-coverage.).

=cut

=head2 $self->convert({ source => { file => $path_to_file } })

Converts the file $path_to_file to XML and returns it. Throws an exception
on failure.

=cut

use Data::Dumper;

my %lookup = (map { $_ => 1 } qw( li ol ul ));

sub _is_passthrough_elem
{
    my ($self, $name) = @_;

    return exists($lookup{$name});
}

sub _output_tag
{
    my ($self, $args) = @_;

    my @start = @{$args->{start}};
    $self->_writer->startTag([$fiction_ns,$start[0]], @start[1..$#start]);

    $args->{in}->($self, $args);

    $self->_writer->endTag();
}

sub _output_tag_with_childs
{
    my ($self, $args) = @_;

    return
        $self->_output_tag({
            %$args,
            'in' => sub {
                foreach my $child (@{$args->{elem}->_get_childs()})
                {
                    $self->_write_elem({elem => $child,});
                }
            },
        });
}

sub _output_tag_with_childs_and_common_attributes
{
    my ($self, $elem, $tag_name, $args) = @_;

    my $id = $elem->lookup_attr("id");
    my $lang = $elem->lookup_attr("lang");
    my $href = $elem->lookup_attr("href");

    my @attr;

    if (!defined($id))
    {
        if (! $args->{optional_id} )
        {
            Carp::confess($args->{missing_id_msg} || "Unspecified id!");
        }
    }
    else
    {
        push @attr, ([$xml_ns, "id"] => $id);
    }

    if (defined($lang))
    {
        push @attr, ([$xml_ns, 'lang'] => $lang);
    }

    if (! defined($href))
    {
        if ($args->{required_href})
        {
            Carp::confess(
                $args->{missing_href_msg} || 'Unspecified href in tag!'
            );
        }
    }
    else
    {
        push @attr, ([$xlink_ns, 'href'] => $href);
    }

    return $self->_output_tag_with_childs(
        {
            'start' => [$tag_name, @attr,],
            elem => $elem,
        }
    );
}

sub _get_text_start
{
    my ($self, $elem) = @_;

    if ($elem->_short_isa("Saying"))
    {
        return ["saying", 'character' => $elem->character()];
    }
    elsif ($elem->_short_isa("Description"))
    {
        return ["description"];
    }
    else
    {
        Carp::confess ("Unknown element class - " . ref($elem) . "!");
    }
}

sub _paragraph_tag
{
    return "p";
}

sub _handle_elem_of_name_a
{
    my ($self, $elem) = @_;

    $self->_output_tag_with_childs_and_common_attributes(
        $elem,
        'span',
        {
            optional_id => 1,
            required_href => 1,
            missing_href_msg => 'Unspecified href in a tag.',
        },
    );

    return;
}

sub _handle_elem_of_name_blockquote
{
    my ($self, $elem) = @_;

    $self->_output_tag_with_childs_and_common_attributes(
        $elem,
        'blockquote',
        {
            optional_id => 1,
        },
    );

    return;
}


sub _handle_elem_of_name_programlisting
{
    my ($self, $elem) = @_;

    my $throw_found_tag_exception = sub {
        XML::Grammar::Fiction::Err::Parse::ProgramListingContainsTags->throw(
            error => "<programlisting> tag cannot contain other tags.",
            line => $elem->open_line(),
        );
    };

    return $self->_output_tag(
        {
            start => ['programlisting'],
            elem => $elem,
            'in' => sub {
                foreach my $child (@{ $elem->_get_childs() })
                {
                    if ($child->_short_isa("Paragraph"))
                    {
                        foreach my $text_node (
                            @{ $child->children()->contents() }
                        )
                        {
                            if ($text_node->_short_isa("Text"))
                            {
                                $self->_write_elem({elem => $text_node});
                            }
                            else
                            {
                                $throw_found_tag_exception->();
                            }
                        }
                    }
                    else
                    {
                        $throw_found_tag_exception->();
                    }
                    # End of paragraph.
                    $self->_writer->characters("\n\n");
                }

                return;
            },
        }
    );

    return;
}

sub _handle_elem_of_name_span
{
    my ($self, $elem) = @_;

    $self->_output_tag_with_childs_and_common_attributes(
        $elem,
        'span',
        {
            optional_id => 1,
            missing_id_msg => "Unspecified id for span!",
        },
    );

    return;
}

sub _handle_elem_of_name_title
{
    my ($self, $elem) = @_;

    # TODO :
    # Eliminate the Law-of-Demeter-syndrome here.
    my $list = $elem->_get_childs()->[0];
    $self->_output_tag(
        {
            start => ["title"],
            in => sub {
                $self->_write_elem(
                    {
                        elem => $list,
                    }
                ),
            },
        },
    );

    return;
}

sub _bold_tag_name
{
    return "b";
}

sub _italics_tag_name
{
    return "i";
}

sub _handle_text_start
{
    my ($self, $elem) = @_;

    $self->_output_tag_with_childs(
        {
            start => $self->_get_text_start($elem),
            elem => $elem,
        },
    );

    return;
}

sub _write_elem
{
    my ($self, $args) = @_;

    my $elem = $args->{elem};

    if (ref($elem) eq "")
    {
        $self->_writer->characters($elem);
    }
    elsif ($elem->_short_isa("Text"))
    {
        foreach my $child (@{$elem->_get_childs()})
        {
            $self->_write_elem({ elem => $child,},);
        }
    }
    elsif ($elem->_short_isa("Paragraph"))
    {
        $self->_output_tag_with_childs(
            {
                start => [$self->_paragraph_tag()],
                elem => $elem,
            },
        );
    }
    elsif ($elem->_short_isa("List"))
    {
        foreach my $child (@{$elem->contents()})
        {
            $self->_write_elem({elem => $child, });
        }
    }
    elsif ($elem->_short_isa("Element"))
    {
        $self->_write_Element_elem($elem);
    }
    elsif ($elem->_short_isa("Text"))
    {
        $self->_handle_text_start($elem);
    }
    elsif ($elem->_short_isa("Comment"))
    {
        $self->_writer->comment($elem->text());
    }
}

sub _write_scene
{
    my ($self, $args) = @_;

    my $scene = $args->{scene};

    my $tag = $scene->name;

    if (($tag eq "s") || ($tag eq "scene"))
    {
        $self->_output_tag_with_childs_and_common_attributes(
            $scene,
            "section",
            { missing_id_msg => "Unspecified id for scene!", },
        );
    }
    else
    {
        confess "Improper scene tag - should be '<s>' or '<scene>'!";
    }

    return;
}

sub _read_file
{
    my ($self, $filename) = @_;

    open my $in, "<", $filename or
        confess "Could not open the file \"$filename\" for slurping.";
    binmode $in, ":utf8";
    my $contents;
    {
        local $/;
        $contents = <$in>;
    }
    close($in);

    return $contents;
}

sub _calc_tree
{
    my ($self, $args) = @_;

    my $filename = $args->{source}->{file} or
        confess "Wrong filename given.";

    return $self->_parser->process_text($self->_read_file($filename));
}

sub _write_body
{
    my $self = shift;
    my $args = shift;

    my $body = $args->{'body'};

    my $tag = $body->name;
    if ($tag ne "body")
    {
        confess "Improper body tag - should be '<body>'!";
    }

=begin foo

    my $title =
        first
        { $_->name() eq "title" }
        @{$body->_get_childs()}
        ;

    my @t =
    (
          defined($title)
        ? (title => $title->_get_childs()->[0])
        : ()
    );

=end foo

=cut

    $self->_output_tag_with_childs_and_common_attributes(
        $body,
        'body',
        { missing_id_msg => "Unspecified id for body tag!", },
    );

    return;
}

sub convert
{
    my ($self, $args) = @_;

    # These should be un-commented for debugging.
    # local $::RD_HINT = 1;
    # local $::RD_TRACE = 1;

    # We need this so P::RD won't skip leading whitespace at lines
    # which are siginificant.

    my $tree = $self->_calc_tree($args);

    if (!defined($tree))
    {
        Carp::confess("Parsing failed.");
    }

    my $buffer = "";
    my $writer = XML::Writer->new(
        OUTPUT => \$buffer,
        ENCODING => "utf-8",
        NAMESPACES => 1,
        PREFIX_MAP =>
        {
             $fiction_ns => q{},
             $xml_ns => 'xml',
             $xlink_ns => 'xlink',
        }
    );

    $writer->xmlDecl("utf-8");
    $writer->startTag([$fiction_ns, "document"], "version" => "0.2");
    $writer->startTag([$fiction_ns, "head"]);
    $writer->endTag();

    # Now we're inside the body.
    $self->_writer($writer);

    $self->_write_body({body => $tree});

    $writer->endTag();

    return $buffer;
}

1;