The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
XML-Grammar-Fiction-0.30.0
River stage one • 1 direct dependent • 2 total dependents
++
/ XML::Grammar::FictionBase::FromProto::Parser::LineIterator

NAME

XML::Grammar::FictionBase::FromProto::Parser::LineIterator - line iterator base class for the parser.

For internal use only.

VERSION

version 0.30.0

SYNOPSIS

TODO: write one.

DESCRIPTION

This is a line iterator that is useful to handle text (e.g: out of a file) and process it incrementally.

METHODS

$self->setup_text($multi_line_text)

Use $multi_line_text as the text to process, populate the lines array with it and reset the other variables.

$line_ref = $self->curr_line_ref()

Returns a reference to the current line (a string).

For example:

    my $l_ref = $self->curr_line_ref();

    if ($$l_ref !~ m{\G<tag>}g)
    {
        die "Could not match tag.";
    }

my $pos = $self->curr_pos()

Returns the current position (using pos($$l)) of the current line.

$self->at_line_start()

Returns if at start of line (curr_pos == 0).

my ($line_ref, $pos) = $self->curr_line_and_pos();

Convenience method to return the line reference and the position.

For example:

    # Check for a tag.
    my ($l_ref, $p) = $self->curr_line_and_pos();

    my $is_tag_cond = ($$l_ref =~ m{\G<}cg);
    my $is_close = $is_tag_cond && ($$l_ref =~ m{\G/}cg);

    pos($$l) = $p;

    return ($is_tag_cond, $is_close);

my $line_copy_ref = $self->curr_line_copy()

Returns a reference to a copy of the current line that is allowed to be tempered with (by assigning to pos() or in a different way.). The line is returned as a reference so to avoid destroying its pos() value.

For example:

    sub _look_ahead_for_tag
    {
        my $self = shift;

        my $l = $self->curr_line_copy();

        my $is_tag_cond = ($$l =~ m{\G<}cg);
        my $is_close = $is_tag_cond && ($$l =~ m{\G/}cg);

        return ($is_tag_cond, $is_close);
    }

my $line_ref = $self->next_line_ref()

Advance the line pointer and return the next line.

$self->skip_space()

Skip whitespace (spaces and tabs) from the current position onwards.

$self->skip_multiline_space()

Skip multiline space.

$self->curr_line_continues_with($regex)

Matches the current line with $regex starting from the current position and returns the result. The position remains at the original position if the regular expression does not match (using qr//cg ).

my $line_number = $self->line_idx()

Returns the line index as an integer. It starts from 0 for the first line (like in Perl lines.)

my $line_number = $self->line_num()

Returns the line number as an integer. It starts from 1 for the first line (like in file lines.)

$self->consume($regex)

Consume as much text as $regex matches.

$self->consume_up_to($regex)

Consume up to the point where $regex matches.

$self->throw_text_error($exception_class, $text)

Throws the Error class $exception_class with the text $text (and the current line number.

eof()

Returns if the parser reached the end of the file.

$self->meta()

Leftover from Moo.

SUPPORT

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

Bugs / Feature Requests

Please report any bugs or feature requests by email to bug-xml-grammar-fiction at rt.cpan.org, or through the web interface at https://rt.cpan.org/Public/Bug/Report.html?Queue=XML-Grammar-Fiction. You will be automatically notified of any progress on the request by the system.

Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

https://github.com/shlomif/fiction-xml

  git clone git://github.com/shlomif/fiction-xml.git

AUTHOR

Shlomi Fish <shlomif@cpan.org>

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/shlomif/fiction-xml/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

COPYRIGHT AND LICENSE

This software is Copyright (c) 2007 by Shlomi Fish.

This is free software, licensed under:

  The MIT (X11) License