AtteanX::API::Lexer - Role defining common functionality for lexers.
This document describes AtteanX::API::Lexer version 0.026
The AtteanX::API::Lexer role provides a common interface and implementation for lexer implementations, allowing line-based buffer filling, and consuming of characters, constant strings, and fixed-length buffers.
Fills the buffer with a new line from the underlying filehandle.
Remove a BOM character if one appears at the start of the buffer.
get_char_safe( $char )
Consume the single character
$charfrom the buffer. Throw an error if
$charis not at the start of the buffer.
get_char( $char )
Consume and return a single character from the buffer.
peek_char( $char )
Return a single character from the start of the buffer.
read_word( $word )
Consume the string
$wordfrom the start of the buffer. Throw an error if
$wordis not at the start of the buffer.
read_length( $length )
Consume and return
$lengthcharacters from the start of the buffer.
Please report any bugs or feature requests to through the GitHub web interface at https://github.com/kasei/attean/issues.
Gregory Todd Williams
Copyright (c) 2014--2019 Gregory Todd Williams. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.