local-lib5/man/man3/namespace::autoclean.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "namespace::autoclean 3"
 132 .TH namespace::autoclean 3 "2009-09-15" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 namespace::autoclean \- Keep imports out of your namespace
 135 .SH "VERSION"
 136 .IX Header "VERSION"
 137 version 0.09
 138 .SH "SYNOPSIS"
 139 .IX Header "SYNOPSIS"
 140 .Vb 3
 141 \&    package Foo;
 142 \&    use namespace::autoclean;
 143 \&    use Some::Package qw/imported_function/;
 144 .Ve
 145 .PP
 146 .Vb 1
 147 \&    sub bar { imported_function('stuff') }
 148 .Ve
 149 .PP
 150 .Vb 3
 151 \&    # later on:
 152 \&    Foo\->bar;               # works
 153 \&    Foo\->imported_function; # will fail. imported_function got cleaned after compilation
 154 .Ve
 155 .SH "DESCRIPTION"
 156 .IX Header "DESCRIPTION"
 157 When you import a function into a Perl package, it will naturally also be
 158 available as a method.
 159 .PP
 160 The \f(CW\*(C`namespace::autoclean\*(C'\fR pragma will remove all imported symbols at the end
 161 of the current package's compile cycle. Functions called in the package itself
 162 will still be bound by their name, but they won't show up as methods on your
 163 class or instances.
 164 .PP
 165 This module is very similar to namespace::clean, except it
 166 will clean all imported functions, no matter if you imported them before or
 167 after you \f(CW\*(C`use\*(C'\fRd the pragma. It will also not touch anything that looks like a
 168 method, according to \f(CW\*(C`Class::MOP::Class::get_method_list\*(C'\fR.
 169 .PP
 170 If you're writing an exporter and you want to clean up after yourself (and your
 171 peers), you can use the \f(CW\*(C`\-cleanee\*(C'\fR switch to specify what package to clean:
 172 .PP
 173 .Vb 2
 174 \&  package My::MooseX::namespace::autoclean;
 175 \&  use strict;
 176 .Ve
 177 .PP
 178 .Vb 1
 179 \&  use namespace::autocleanclean (); # no cleanup, just load
 180 .Ve
 181 .PP
 182 .Vb 5
 183 \&  sub import {
 184 \&      namespace::autoclean\->import(
 185 \&        \-cleanee => scalar(caller),
 186 \&      );
 187 \&  }
 188 .Ve
 189 .SH "PARAMETERS"
 190 .IX Header "PARAMETERS"
 191 .Sh "\-also => [ \s-1ITEM\s0 | \s-1REGEX\s0 | \s-1SUB\s0, .. ]"
 192 .IX Subsection "-also => [ ITEM | REGEX | SUB, .. ]"
 193 .Sh "\-also => \s-1ITEM\s0"
 194 .IX Subsection "-also => ITEM"
 195 .Sh "\-also => \s-1REGEX\s0"
 196 .IX Subsection "-also => REGEX"
 197 .Sh "\-also => \s-1SUB\s0"
 198 .IX Subsection "-also => SUB"
 199 Sometimes you don't want to clean imports only, but also helper functions
 200 you're using in your methods. The \f(CW\*(C`\-also\*(C'\fR switch can be used to declare a list
 201 of functions that should be removed additional to any imports:
 202 .PP
 203 .Vb 1
 204 \&    use namespace::autoclean \-also => ['some_function', 'another_function'];
 205 .Ve
 206 .PP
 207 If only one function needs to be additionally cleaned the \f(CW\*(C`\-also\*(C'\fR switch also
 208 accepts a plain string:
 209 .PP
 210 .Vb 1
 211 \&    use namespace::autoclean \-also => 'some_function';
 212 .Ve
 213 .PP
 214 In some situations, you may wish for a more \fIpowerful\fR cleaning solution.
 215 .PP
 216 The \f(CW\*(C`\-also\*(C'\fR switch can take a Regex or a CodeRef to match against local
 217 function names to clean.
 218 .PP
 219 .Vb 1
 220 \&    use namespace::autoclean \-also => qr/^_/
 221 .Ve
 222 .PP
 223 .Vb 1
 224 \&    use namespace::autoclean \-also => sub { $_ =~ m{^_} };
 225 .Ve
 226 .PP
 227 .Vb 1
 228 \&    use namespace::autoclean \-also => [qr/^_/ , qr/^hidden_/ ];
 229 .Ve
 230 .PP
 231 .Vb 1
 232 \&    use namespace::autoclean \-also => [sub { $_ =~ m/^_/ or $_ =~ m/^hidden/ }, sub { uc($_) == $_ } ];
 233 .Ve
 234 .SH "SEE ALSO"
 235 .IX Header "SEE ALSO"
 236 namespace::clean
 237 .PP
 238 Class::MOP
 239 .PP
 240 B::Hooks::EndOfScope
 241 .SH "AUTHOR"
 242 .IX Header "AUTHOR"
 243 .Vb 1
 244 \&  Florian Ragwitz <rafl@debian.org>
 245 .Ve
 246 .SH "COPYRIGHT AND LICENSE"
 247 .IX Header "COPYRIGHT AND LICENSE"
 248 This software is copyright (c) 2009 by Florian Ragwitz.
 249 .PP
 250 This is free software; you can redistribute it and/or modify it under
 251 the same terms as the Perl 5 programming language system itself.