Manual Reference Pages - PPI::STATEMENT::INCLUDE (3)
PPI::Statement::Include - Statements that include other code
# The following are all includes
use constant FOO => Foo;
require $foo if 1;
no strict refs;
Despite its name, the PPI::Statement::Include class covers a number
of different types of statement that cover all statements starting with
use, no and require.
But basically, they cover three situations.
Firstly, a dependency on a particular version of perl (for which the
version method returns true), a pragma (for which the pragma method
returns true), or the loading (and unloading via no) of modules.
PPI::Statement::Include has a number of methods in addition to the standard
PPI::Statement, PPI::Node and PPI::Element methods.
The type method returns the general type of statement (use, no
Returns the type as a string, or undef if the type cannot be detected.
The module method returns the module name specified in any include
statement. This includes pragma names, because pragma are implemented
as modules. (And lets face it, the definition of a pragma can be fuzzy
at the best of times in any case)
This covers all of these...
...but does not cover any of these...
Returns the module name as a string, or undef if the include does
not specify a module name.
The module_version method returns the minimum version of the module
required by the statement, if there is one.
The pragma method checks for an include statements use as a
pragma, and returns it if so.
Or at least, it claims to. In practice its a lot harder to say exactly
what is or isnt a pragma, because the definition is fuzzy.
The intent of a pragma is to modify the way in which the parser works.
This is done though the use of modules that do various types of internals
For now, PPI assumes that any module name that is only a set of
lowercase letters (and perhaps numbers, like use utf8;). This
behaviour is expected to change, most likely to something that knows
the specific names of the various pragmas.
Returns the name of the pragma, or false () if the include is not a
The version method checks for an include statement that introduces a
dependency on the version of perl the code is compatible with.
This covers two specific statements.
Currently the version is returned as a string, although in future the version
may be returned as a version object. If you want a numeric representation,
use version_literal(). Returns false if the statement is not a version
The version_literal method has the same behavior as version(), but the
version is returned as a numeric literal. Returns false if the statement is
not a version dependency.
The arguments method gives you the rest of the statement after the
module/pragma and module version, i.e. the stuff that will be used to
construct what gets passed to the modules import() subroutine. This does
include the comma, etc. operators, but doesnt include non-significant direct
children or any final semicolon.
- Write specific unit tests for this package
See the support section in the main module.
Adam Kennedy <firstname.lastname@example.org>
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.
|perl v5.20.3 ||PPI::STATEMENT::INCLUDE (3) ||2014-11-11 |
Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.