X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FGitalist.git;a=blobdiff_plain;f=local-lib5%2Fman%2Fman3%2FMoose%3A%3ACookbook%3A%3ASnack%3A%3AKeywords.3pm;fp=local-lib5%2Fman%2Fman3%2FMoose%3A%3ACookbook%3A%3ASnack%3A%3AKeywords.3pm;h=ec45de7746bbcbf865ff714223169e4418c270cd;hp=0000000000000000000000000000000000000000;hb=3fea05b9fbf95091f4522528b9980a33e0235603;hpb=af746827daa7a8feccee889e1d12ebc74cc9201e

diff --git a/local-lib5/man/man3/Moose::Cookbook::Snack::Keywords.3pm b/local-lib5/man/man3/Moose::Cookbook::Snack::Keywords.3pm
new file mode 100644
index 0000000..ec45de7
--- /dev/null
+++ b/local-lib5/man/man3/Moose::Cookbook::Snack::Keywords.3pm
@@ -0,0 +1,303 @@
+.\" 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 "Moose::Cookbook::Snack::Keywords 3"
+.TH Moose::Cookbook::Snack::Keywords 3 "2009-03-14" "perl v5.8.7" "User Contributed Perl Documentation"
+.SH "NAME"
+Moose::Cookbook::Snack::Keywords \- Restricted "keywords" in Moose
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+Moose exports a number of sugar functions in order to emulate Perl
+built-in keywords. These can cause clashes with other user-defined
+functions. This document provides a list of those keywords for easy
+reference.
+.Sh "The 'meta' keyword"
+.IX Subsection "The 'meta' keyword"
+While most collisions can be avoided, you cannot avoid importing a
+\&\f(CW\*(C`meta\*(C'\fR method when you \f(CW\*(C`use\ Moose\*(C'\fR. If you try to override or
+change what \f(CW\*(C`meta\*(C'\fR does, you could end up breaking Moose internals.
+.Sh "Moose Keywords"
+.IX Subsection "Moose Keywords"
+If you are using Moose or Moose::Role its best to avoid these
+keywords:
+.IP "extends" 4
+.IX Item "extends"
+.PD 0
+.IP "with" 4
+.IX Item "with"
+.IP "has" 4
+.IX Item "has"
+.IP "before" 4
+.IX Item "before"
+.IP "after" 4
+.IX Item "after"
+.IP "around" 4
+.IX Item "around"
+.IP "super" 4
+.IX Item "super"
+.IP "override" 4
+.IX Item "override"
+.IP "inner" 4
+.IX Item "inner"
+.IP "augment" 4
+.IX Item "augment"
+.IP "confess" 4
+.IX Item "confess"
+.IP "blessed" 4
+.IX Item "blessed"
+.PD
+.Sh "Moose::Util::TypeConstraints Keywords"
+.IX Subsection "Moose::Util::TypeConstraints Keywords"
+If you are using Moose::Util::TypeConstraints its best to avoid
+these keywords
+.IP "type" 4
+.IX Item "type"
+.PD 0
+.IP "subtype" 4
+.IX Item "subtype"
+.IP "class_type" 4
+.IX Item "class_type"
+.IP "role_type" 4
+.IX Item "role_type"
+.IP "maybe_type" 4
+.IX Item "maybe_type"
+.IP "as" 4
+.IX Item "as"
+.IP "where" 4
+.IX Item "where"
+.IP "message" 4
+.IX Item "message"
+.IP "optimize_as" 4
+.IX Item "optimize_as"
+.IP "coerce" 4
+.IX Item "coerce"
+.IP "from" 4
+.IX Item "from"
+.IP "via" 4
+.IX Item "via"
+.IP "enum" 4
+.IX Item "enum"
+.IP "find_type_constraint" 4
+.IX Item "find_type_constraint"
+.IP "register_type_constraint" 4
+.IX Item "register_type_constraint"
+.PD
+.Sh "Avoiding collisions"
+.IX Subsection "Avoiding collisions"
+\fITurning off Moose\fR
+.IX Subsection "Turning off Moose"
+.PP
+To remove the sugar functions Moose exports just add \f(CW\*(C`no\ Moose\*(C'\fR
+at the bottom of your code:
+.PP
+.Vb 2
+\&  package Thing;
+\&  use Moose;
+.Ve
+.PP
+.Vb 1
+\&  # code here
+.Ve
+.PP
+.Vb 1
+\&  no Moose;
+.Ve
+.PP
+This will unexport the sugar functions that Moose originally
+exported. The same will also work for Moose::Role and
+Moose::Util::TypeConstraints.
+.PP
+\fISub::Exporter features\fR
+.IX Subsection "Sub::Exporter features"
+.PP
+Moose, Moose::Role and Moose::Util::TypeConstraints all use
+Sub::Exporter to handle all their exporting needs. This means that
+all the features that Sub::Exporter provides are also available to
+them.
+.PP
+For instance, with Sub::Exporter you can rename keywords, like so:
+.PP
+.Vb 2
+\&  package LOL::Cat;
+\&  use Moose 'has' => { \-as => 'i_can_haz' };
+.Ve
+.PP
+.Vb 4
+\&  i_can_haz 'cheeseburger' => (
+\&      is      => 'rw',
+\&      trigger => sub { print "NOM NOM" }
+\&  );
+.Ve
+.PP
+.Vb 1
+\&  LOL::Cat\->new\->cheeseburger('KTHNXBYE');
+.Ve
+.PP
+See the Sub::Exporter docs for more information.
+.PP
+\fInamespace::clean\fR
+.IX Subsection "namespace::clean"
+.PP
+You can also use namespace::clean to clean up your namespace, but
+you must be careful not to remove \f(CW\*(C`meta\*(C'\fR when doing so:
+.PP
+.Vb 4
+\&  package Foo;
+\&  use Moose;
+\&  use namespace::clean \-except => 'meta';
+\&  # ...
+.Ve
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+.IP "Moose" 4
+.IX Item "Moose"
+.PD 0
+.IP "Moose::Role" 4
+.IX Item "Moose::Role"
+.IP "Moose::Utils::TypeConstraints" 4
+.IX Item "Moose::Utils::TypeConstraints"
+.IP "Sub::Exporter" 4
+.IX Item "Sub::Exporter"
+.IP "namespace::clean" 4
+.IX Item "namespace::clean"
+.PD
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+John Goulah \f(CW\*(C`<jgoulah@cpan.org<gt\*(C'\fR>
+.PP
+Stevan Little <stevan@iinteractive.com>
+.SH "COPYRIGHT AND LICENSE"
+.IX Header "COPYRIGHT AND LICENSE"
+Copyright 2006\-2009 by Infinity Interactive, Inc.
+.PP
+<http://www.iinteractive.com>
+.PP
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.