PPIx::Regexp::Token::Comment - Represent a comment.


PPIx-Regexp documentation Contained in the PPIx-Regexp distribution.

Index


Code Index:

NAME

Top

PPIx::Regexp::Token::Comment - Represent a comment.

SYNOPSIS

Top

 use PPIx::Regexp::Dumper;
 PPIx::Regexp::Dumper->new( 'qr{foo(?#bar)}smx' )
     ->print();

INHERITANCE

Top

PPIx::Regexp::Token::Comment is a PPIx::Regexp::Token.

PPIx::Regexp::Token::Comment has no descendants.

DESCRIPTION

Top

This class represents a comment - both parenthesized comments (i.e. (?# this is a comment ) and the /x mode end-of-line comments.

METHODS

Top

This class provides no public methods beyond those provided by its superclass.

SUPPORT

Top

Support is by the author. Please file bug reports at http://rt.cpan.org, or in electronic mail to the author.

AUTHOR

Top

Thomas R. Wyant, III wyant at cpan dot org

COPYRIGHT AND LICENSE

Top


PPIx-Regexp documentation Contained in the PPIx-Regexp distribution.
package PPIx::Regexp::Token::Comment;

use strict;
use warnings;

use base qw{ PPIx::Regexp::Token };

our $VERSION = '0.020';

# Return true if the token can be quantified, and false otherwise
sub can_be_quantified { return };

sub significant {
    return;
}

sub comment {
    return 1;
}

# This must be implemented by tokens which do not recognize themselves.
# The return is a list of list references. Each list reference must
# contain a regular expression that recognizes the token, and optionally
# a reference to a hash to pass to make_token as the class-specific
# arguments. The regular expression MUST be anchored to the beginning of
# the string.
sub __PPIX_TOKEN__recognize {
    return ( [ qr{ \A \( \? \# [^\)]* \) }smx ] );
}

# We anticipate that these tokens will be generated by other classes:
# PPIx::Regexp::Token::Structure for parenthesized comments, and
# PPIx::Regexp::Token::Literal for end-of-line /x mode comments.

1;

__END__

# ex: set textwidth=72 :