Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

ppix::regexp::token::reference(3pm) [debian man page]

PPIx::Regexp::Token::Reference(3pm)			User Contributed Perl Documentation		       PPIx::Regexp::Token::Reference(3pm)

NAME

       PPIx::Regexp::Token::Reference - Represent a reference to a capture

SYNOPSIS

	use PPIx::Regexp::Dumper;
	PPIx::Regexp::Dumper->new( 'qr{1}smx' )
	    ->print();

INHERITANCE

       "PPIx::Regexp::Token::Reference" is a PPIx::Regexp::Token.

       "PPIx::Regexp::Token::Reference" is the parent of PPIx::Regexp::Token::Backreference, PPIx::Regexp::Token::Condition and
       PPIx::Regexp::Token::Recursion.

DESCRIPTION

       This abstract class represents a reference to a capture buffer, either numbered or named. It should never be instantiated, but it provides
       a number of methods to its subclasses.

METHODS

       This class provides the following public methods. Methods not documented here are private, and unsupported in the sense that the author
       reserves the right to change or remove them without notice.

   absolute
	print "The absolute reference is ", $ref->absolute(), "
";

       This method returns the absolute number of the capture buffer referred to. This is the same as number() for unsigned numeric references. If
       the reference is to a named buffer, "undef" is returned.

   is_named
	$ref->is_named and print "named reference
";

       This method returns true if the reference is named rather than numbered.

   is_relative
	$ref->is_relative()
	    and print "relative numbered reference
";

       This method returns true if the reference is numbered and it is a relative number (i.e. if it is signed).

   name
	print "The name is ", $ref->name(), "
";

       This method returns the name of the capture buffer referred to. In the case of a reference to a numbered capture (i.e. "is_named" returns
       false), this method returns "undef".

   number
	print "The number is ", $ref->number(), "
";

       This method returns the number of the capture buffer referred to. In the case of a reference to a named capture (i.e. "is_named" returns
       true), this method returns "undef".

SUPPORT

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

AUTHOR

       Thomas R. Wyant, III wyant at cpan dot org

COPYRIGHT AND LICENSE

       Copyright (C) 2009-2012 by Thomas R. Wyant, III

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl 5.10.0. For more details, see the full
       text of the licenses in the directory LICENSES.

       This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of
       merchantability or fitness for a particular purpose.

perl v5.14.2							    2012-06-06				       PPIx::Regexp::Token::Reference(3pm)

Check Out this Related Man Page

PPIx::Regexp::Token::Interpolation(3pm) 		User Contributed Perl Documentation		   PPIx::Regexp::Token::Interpolation(3pm)

NAME

       PPIx::Regexp::Token::Interpolation - Represent an interpolation in the PPIx::Regexp package.

SYNOPSIS

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

INHERITANCE

       "PPIx::Regexp::Token::Interpolation" is a PPIx::Regexp::Token::Code.

       "PPIx::Regexp::Token::Interpolation" has no descendants.

DESCRIPTION

       This class represents a variable interpolation into a regular expression. In the "SYNOPSIS" the $foo would be represented by an object of
       this class.

METHODS

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

   ppi
       This convenience method returns the PPI::Document representing the content. This document should be considered read only.

       Note that the content of the returned PPI::Document may not be the same as the content of the original
       "PPIx::Regexp::Token::Interpolation". This can happen because interpolated variable names may be enclosed in curly brackets, but this does
       not happen in normal code. For example, in "/${foo}bar/", the content of the "PPIx::Regexp::Token::Interpolation" object will be '${foo}',
       but the content of the "PPI::Document" will be '$foo'.

SUPPORT

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

AUTHOR

       Thomas R. Wyant, III wyant at cpan dot org

COPYRIGHT AND LICENSE

       Copyright (C) 2009-2012 by Thomas R. Wyant, III

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl 5.10.0. For more details, see the full
       text of the licenses in the directory LICENSES.

       This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of
       merchantability or fitness for a particular purpose.

perl v5.14.2							    2012-06-06				   PPIx::Regexp::Token::Interpolation(3pm)
Man Page