-
-
16 Apr 2022 15:01:11 UTC
- Distribution: PPIx-Regexp
- Module version: 0.085
- Source (raw)
- Browse (raw)
- Changes
- How to Contribute
- Repository
- Issues (1)
- Testers (1476 / 0 / 0)
- Kwalitee
Bus factor: 1- 86.94% Coverage
- License: perl_5
- Perl: v5.6.0
- Activity
24 month- Tools
- Download (236.2KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
++ed by:5 non-PAUSE usersand 1 contributors- Thomas R. Wyant, III F<wyant at cpan dot org>
- Dependencies
- Carp
- Encode
- Exporter
- List::Util
- PPI::Document
- PPI::Dumper
- Scalar::Util
- Task::Weaken
- base
- constant
- strict
- warnings
- and possibly others
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
PPIx::Regexp::Util - Utility functions for PPIx::Regexp;
SYNOPSIS
use PPIx::Regexp::Util qw{ __instance }; . . . __instance( $foo, 'Bar' ) or die '$foo is not a Bar';
DESCRIPTION
This module contains utility functions for PPIx::Regexp which it is convenient to centralize.
Double-underscore subroutines are private to the
PPIx-Regexp
package. Their documentation is provided for the author's convenience only, and they are subject to change without notice. Caveat user.This module exports nothing by default.
SUBROUTINES
This module can export the following subroutines:
is_ppi_regexp_element
is_ppi_regexp_element( $elem ) and print "$elem is a regexp of some sort\n";
This subroutine is public and supported.
This subroutine takes as its argument a PPI::Element. It returns a true value if the argument represents a regular expression of some sort, and a false value otherwise.
__instance
__instance( $foo, 'Bar' ) and print '$foo isa Bar', "\n";
This subroutine is private to the
PPIx-Regexp
package.This subroutine returns true if its first argument is an instance of the class specified by its second argument. Unlike
UNIVERSAL::isa
, the result is always false unless the first argument is a reference.__is_ppi_regexp_element
__is_ppi_regexp_element( $elem ) and print "$elem is a regexp of some sort\n";
This subroutine is private to the
PPIx-Regexp
package.This is a synonym for is_ppi_regexp_element(), and is deprecated in favor of it. If called, it will complain via
Carp::cluck()
and thengoto &is_ppi_regexp_element
.__ns_can
This subroutine is private to the
PPIx-Regexp
package.This method is analogous to
can()
, but returns a reference to the code only if it is actually implemented by the invoking name space.__post_rebless_error
This method is private to the
PPIx-Regexp
package. The intended use is to alias it to__PPIX_ELEM__post_reblessing()
.It takes arguments as name/value pairs. Argument
{error}
is the error message; if it is omitted you get a warning with stack trace. Argument{explanation}
defaults to{error}
.It returns the number of errors to add to the parse.
__to_ordinal_en
This subroutine is private to the
PPIx-Regexp
package.This subroutine takes as its argument an integer and returns a string representing its ordinal in English. For example
say __to_ordinal_en( 17 ); # 17th
SEE ALSO
Params::Util, which I recommend, but in the case of
PPIx::Regexp
I did not want to introduce a dependency on an XS module when all I really wanted was the function of that module's_INSTANCE()
subroutine.SUPPORT
Support is by the author. Please file bug reports at https://rt.cpan.org/Public/Dist/Display.html?Name=PPIx-Regexp, https://github.com/trwyant/perl-PPIx-Regexp/issues, or in electronic mail to the author.
AUTHOR
Thomas R. Wyant, III wyant at cpan dot org
COPYRIGHT AND LICENSE
Copyright (C) 2010-2022 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.
Module Install Instructions
To install PPIx::Regexp, copy and paste the appropriate command in to your terminal.
cpanm PPIx::Regexp
perl -MCPAN -e shell install PPIx::Regexp
For more information on module installation, please visit the detailed CPAN module installation guide.