Current File : //proc/self/root/usr/local/share/man/man3/Sub::Exporter::Util.3pm
.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Sub::Exporter::Util 3"
.TH Sub::Exporter::Util 3 "2013-06-14" "perl v5.10.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Sub::Exporter::Util \- utilities to make Sub::Exporter easier
.SH "VERSION"
.IX Header "VERSION"
version 0.986
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides a number of utility functions for performing common or
useful operations when setting up a Sub::Exporter configuration. All of the
utilities may be exported, but none are by default.
.SH "THE UTILITIES"
.IX Header "THE UTILITIES"
.SS "curry_method"
.IX Subsection "curry_method"
.Vb 3
\& exports => {
\& some_method => curry_method,
\& }
.Ve
.PP
This utility returns a generator which will produce an invocant-curried version
of a method. In other words, it will export a method call with the exporting
class built in as the invocant.
.PP
A module importing the code some the above example might do this:
.PP
.Vb 1
\& use Some::Module qw(some_method);
\&
\& my $x = some_method;
.Ve
.PP
This would be equivalent to:
.PP
.Vb 1
\& use Some::Module;
\&
\& my $x = Some::Module\->some_method;
.Ve
.PP
If Some::Module is subclassed and the subclass's import method is called to
import \f(CW\*(C`some_method\*(C'\fR, the subclass will be curried in as the invocant.
.PP
If an argument is provided for \f(CW\*(C`curry_method\*(C'\fR it is used as the name of the
curried method to export. This means you could export a Widget constructor
like this:
.PP
.Vb 1
\& exports => { widget => curry_method(\*(Aqnew\*(Aq) }
.Ve
.PP
This utility may also be called as \f(CW\*(C`curry_class\*(C'\fR, for backwards compatibility.
.SS "curry_chain"
.IX Subsection "curry_chain"
\&\f(CW\*(C`curry_chain\*(C'\fR behaves like \f(CW"curry_method"\fR, but is meant for generating
exports that will call several methods in succession.
.PP
.Vb 5
\& exports => {
\& reticulate => curry_chain(
\& new => gather_data => analyze => [ detail => 100 ] => \*(Aqresults\*(Aq
\& ),
\& }
.Ve
.PP
If imported from Spliner, calling the \f(CW\*(C`reticulate\*(C'\fR routine will be equivalent
to:
.PP
.Vb 1
\& Spliner\->new\->gather_data\->analyze(detail => 100)\->results;
.Ve
.PP
If any method returns something on which methods may not be called, the routine
croaks.
.PP
The arguments to \f(CW\*(C`curry_chain\*(C'\fR form an optlist. The names are methods to be
called and the arguments, if given, are arrayrefs to be dereferenced and passed
as arguments to those methods. \f(CW\*(C`curry_chain\*(C'\fR returns a generator like those
expected by Sub::Exporter.
.PP
\&\fBAchtung!\fR at present, there is no way to pass arguments from the generated
routine to the method calls. This will probably be solved in future revisions
by allowing the opt list's values to be subroutines that will be called with
the generated routine's stack.
.SS "merge_col"
.IX Subsection "merge_col"
.Vb 6
\& exports => {
\& merge_col(defaults => {
\& twiddle => \e\*(Aq_twiddle_gen\*(Aq,
\& tweak => \e&_tweak_gen,
\& }),
\& }
.Ve
.PP
This utility wraps the given generator in one that will merge the named
collection into its args before calling it. This means that you can support a
\&\*(L"default\*(R" collector in multiple exports without writing the code each time.
.PP
You can specify as many pairs of collection names and generators as you like.
.SS "mixin_installer"
.IX Subsection "mixin_installer"
.Vb 4
\& use Sub::Exporter \-setup => {
\& installer => Sub::Exporter::Util::mixin_installer,
\& exports => [ qw(foo bar baz) ],
\& };
.Ve
.PP
This utility returns an installer that will install into a superclass and
adjust the \s-1ISA\s0 importing class to include the newly generated superclass.
.PP
If the target of importing is an object, the hierarchy is reversed: the new
class will be \s-1ISA\s0 the object's class, and the object will be reblessed.
.PP
\&\fBPrerequisites\fR: This utility requires that Package::Generator be installed.
.SS "like"
.IX Subsection "like"
It's a collector that adds imports for anything like given regex.
.PP
If you provide this configuration:
.PP
.Vb 2
\& exports => [ qw(igrep imap islurp exhausted) ],
\& collectors => { \-like => Sub::Exporter::Util::like },
.Ve
.PP
A user may import from your module like this:
.PP
.Vb 1
\& use Your::Iterator \-like => qr/^i/; # imports igre, imap, islurp
.Ve
.PP
or
.PP
.Vb 1
\& use Your::Iterator \-like => [ qr/^i/ => { \-prefix => \*(Aqyour_\*(Aq } ];
.Ve
.PP
The group-like prefix and suffix arguments are respected; other arguments are
passed on to the generators for matching exports.
.SH "AUTHOR"
.IX Header "AUTHOR"
Ricardo Signes <rjbs@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2007 by Ricardo Signes.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
Mini Shell