Add built local::lib

[catagits/Gitalist.git] / local-lib5 / man / man3 / namespace::autoclean.3pm

.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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 "namespace::autoclean 3"
.TH namespace::autoclean 3 "2009-09-15" "perl v5.8.7" "User Contributed Perl Documentation"
.SH "NAME"
namespace::autoclean \- Keep imports out of your namespace
.SH "VERSION"
.IX Header "VERSION"
version 0.09
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    package Foo;
\&    use namespace::autoclean;
\&    use Some::Package qw/imported_function/;
.Ve
.PP
.Vb 1
\&    sub bar { imported_function('stuff') }
.Ve
.PP
.Vb 3
\&    # later on:
\&    Foo\->bar;               # works
\&    Foo\->imported_function; # will fail. imported_function got cleaned after compilation
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
When you import a function into a Perl package, it will naturally also be
available as a method.
.PP
The \f(CW\*(C`namespace::autoclean\*(C'\fR pragma will remove all imported symbols at the end
of the current package's compile cycle. Functions called in the package itself
will still be bound by their name, but they won't show up as methods on your
class or instances.
.PP
This module is very similar to namespace::clean, except it
will clean all imported functions, no matter if you imported them before or
after you \f(CW\*(C`use\*(C'\fRd the pragma. It will also not touch anything that looks like a
method, according to \f(CW\*(C`Class::MOP::Class::get_method_list\*(C'\fR.
.PP
If you're writing an exporter and you want to clean up after yourself (and your
peers), you can use the \f(CW\*(C`\-cleanee\*(C'\fR switch to specify what package to clean:
.PP
.Vb 2
\&  package My::MooseX::namespace::autoclean;
\&  use strict;
.Ve
.PP
.Vb 1
\&  use namespace::autocleanclean (); # no cleanup, just load
.Ve
.PP
.Vb 5
\&  sub import {
\&      namespace::autoclean\->import(
\&        \-cleanee => scalar(caller),
\&      );
\&  }
.Ve
.SH "PARAMETERS"
.IX Header "PARAMETERS"
.Sh "\-also => [ \s-1ITEM\s0 | \s-1REGEX\s0 | \s-1SUB\s0, .. ]"
.IX Subsection "-also => [ ITEM | REGEX | SUB, .. ]"
.Sh "\-also => \s-1ITEM\s0"
.IX Subsection "-also => ITEM"
.Sh "\-also => \s-1REGEX\s0"
.IX Subsection "-also => REGEX"
.Sh "\-also => \s-1SUB\s0"
.IX Subsection "-also => SUB"
Sometimes you don't want to clean imports only, but also helper functions
you're using in your methods. The \f(CW\*(C`\-also\*(C'\fR switch can be used to declare a list
of functions that should be removed additional to any imports:
.PP
.Vb 1
\&    use namespace::autoclean \-also => ['some_function', 'another_function'];
.Ve
.PP
If only one function needs to be additionally cleaned the \f(CW\*(C`\-also\*(C'\fR switch also
accepts a plain string:
.PP
.Vb 1
\&    use namespace::autoclean \-also => 'some_function';
.Ve
.PP
In some situations, you may wish for a more \fIpowerful\fR cleaning solution.
.PP
The \f(CW\*(C`\-also\*(C'\fR switch can take a Regex or a CodeRef to match against local
function names to clean.
.PP
.Vb 1
\&    use namespace::autoclean \-also => qr/^_/
.Ve
.PP
.Vb 1
\&    use namespace::autoclean \-also => sub { $_ =~ m{^_} };
.Ve
.PP
.Vb 1
\&    use namespace::autoclean \-also => [qr/^_/ , qr/^hidden_/ ];
.Ve
.PP
.Vb 1
\&    use namespace::autoclean \-also => [sub { $_ =~ m/^_/ or $_ =~ m/^hidden/ }, sub { uc($_) == $_ } ];
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
namespace::clean
.PP
Class::MOP
.PP
B::Hooks::EndOfScope
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 1
\&  Florian Ragwitz <rafl@debian.org>
.Ve
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2009 by Florian Ragwitz.
.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.