Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
PPIx::Regexp::Token::RUsereContributed Perl DPPIx::Regexp::Token::Reference(3)

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(), "\n";

       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\n";

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

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

       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(), "\n";

       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(),	"\n";

       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-2014 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.24.1			  2014-11-12 PPIx::Regexp::Token::Reference(3)

NAME | SYNOPSIS | INHERITANCE | DESCRIPTION | METHODS | SUPPORT | AUTHOR | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=PPIx::Regexp::Token::Reference&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help