-
-
19 Jul 2022 21:50:31 UTC
- Distribution: PPI
- Module version: 1.276
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues
- Testers (877 / 0 / 0)
- Kwalitee
Bus factor: 2- 85.12% Coverage
- License: perl_5
- Perl: v5.6.0
- Activity
24 month- Tools
- Download (239.45KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 44 contributors-
Adam Kennedy
-
Arnout Pierre
-
bowtie
-
brian d foy
-
Chas. J. Owens IV
-
Chris Capaci
-
Chris Dolan
-
Christian Walde
-
Colin Newell
-
Damyan Ivanov
-
Dan Book
-
David Steinbrunner
-
Edmund Adjei
-
Elliot Shank
-
Gabor Szabo
-
Graham Knop
-
Graham Ollis
-
Guillaume Aubert
-
James E Keenan
-
Joel Maslak
-
Julian Fondren
-
Karen Etheridge
-
Kent Fredric
-
Lance Wicks
-
Matt Church
-
Matthew Horsfall
-
Mike O'Regan
-
Milos Kukla
-
Mohammad S Anwar
-
nanto_vi
-
Olaf Alders
-
Olivier Mengué
-
Philippe Bruhat (BooK)
-
Randy Lauen
-
Reini Urban
-
reneeb
-
Shmuel Fomberg
-
Steffen Müller
-
Szymon Nieznański
-
Takumi Akiyama
-
Thomas Sibley
-
Tom Wyant
-
Van de Bugger
-
Will Braswell
- Dependencies
- Carp
- Clone
- Digest::MD5
- Exporter
- File::Path
- File::Spec
- List::Util
- Params::Util
- Scalar::Util
- Storable
- Task::Weaken
- constant
- if
- overload
- strict
- and possibly others
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
PPI::Statement::Sub - Subroutine declaration
INHERITANCE
PPI::Statement::Sub isa PPI::Statement isa PPI::Node isa PPI::Element
DESCRIPTION
Except for the special BEGIN, CHECK, UNITCHECK, INIT, and END subroutines (which are part of PPI::Statement::Scheduled) all subroutine declarations are lexed as a PPI::Statement::Sub object.
Primarily, this means all of the various
sub foo {}
statements, but also forward declarations such assub foo;
orsub foo($);
. It does not include anonymous subroutines, as these are merely part of a normal statement.METHODS
PPI::Statement::Sub
has a number of methods in addition to the standard PPI::Statement, PPI::Node and PPI::Element methods.name
The
name
method returns the name of the subroutine being declared.In some rare cases such as a naked
sub
at the end of the file, this may return false.prototype
If it has one, the
prototype
method returns the subroutine's prototype. It is returned in the same format as "prototype" in PPI::Token::Prototype, cleaned and removed from its brackets.Returns the subroutine's prototype, or undef if the subroutine does not define one. Note that when the sub has an empty prototype (
()
) the return is an empty string.block
With its name and implementation shared with PPI::Statement::Scheduled, the
block
method finds and returns the actual Structure object of the code block for this subroutine.Returns false if this is a forward declaration, or otherwise does not have a code block.
forward
The
forward
method returns true if the subroutine declaration is a forward declaration.That is, it returns false if the subroutine has a code block, or true if it does not.
reserved
The
reserved
method provides a convenience method for checking to see if this is a special reserved subroutine. It does not check against any particular list of reserved sub names, but just returns true if the name is all uppercase, as defined in perlsub.Note that in the case of BEGIN, CHECK, UNITCHECK, INIT and END, these will be defined as PPI::Statement::Scheduled objects, not subroutines.
Returns true if it is a special reserved subroutine, or false if not.
type
The
type
method checks and returns the declaration type of the statement, which will be one of 'my', 'our', or 'state'.Returns a string of the type, or
undef
if the type is not declared.SUPPORT
See the support section in the main module.
AUTHOR
Adam Kennedy <adamk@cpan.org>
COPYRIGHT
Copyright 2001 - 2011 Adam Kennedy.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
The full text of the license can be found in the LICENSE file included with this module.
Module Install Instructions
To install PPI, copy and paste the appropriate command in to your terminal.
cpanm PPI
perl -MCPAN -e shell install PPI
For more information on module installation, please visit the detailed CPAN module installation guide.