.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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" ''
.    ds C`
.    ds C'
'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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" 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 "Mason::Compilation 3pm"
.TH Mason::Compilation 3pm "2014-02-01" "perl v5.18.2" "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"
Mason::Compilation \- Performs compilation of a single component
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A new \f(CW\*(C`Mason::Compilation\*(C'\fR object is created by Mason::Interp to compile
each component.
.PP
This class has no public \s-1API\s0 at this time.
.SH "MODIFIABLE METHODS"
.IX Header "MODIFIABLE METHODS"
These methods are not intended to be called externally, but may be useful to
modify with method modifiers in plugins and
subclasses. Their APIs will be kept as stable as
possible.
.IP "bad_attribute_names ()" 4
.IX Item "bad_attribute_names ()"
A list of attribute names that should not be used because they are reserved for
built-in attributes or methods: \f(CW\*(C`args\*(C'\fR, \f(CW\*(C`m\*(C'\fR, \f(CW\*(C`cmeta\*(C'\fR, \f(CW\*(C`render\*(C'\fR, \f(CW\*(C`main\*(C'\fR,
etc.
.IP "bad_method_names ()" 4
.IX Item "bad_method_names ()"
A list of method names that should not be used because they are reserved for
built-in attributes: \f(CW\*(C`args\*(C'\fR, \f(CW\*(C`m\*(C'\fR, \f(CW\*(C`cmeta\*(C'\fR, etc. Not as extensive as
bad_attribute_names above because methods like \f(CW\*(C`render\*(C'\fR and \f(CW\*(C`main\*(C'\fR can be
overridden but make no sense as attributes.
.IP "compile ()" 4
.IX Item "compile ()"
The top-level method called to compile the component. Returns the generated
component class.
.IP "named_block_types ()" 4
.IX Item "named_block_types ()"
An arrayref of valid named block types: \f(CW\*(C`after\*(C'\fR, \f(CW\*(C`filter\*(C'\fR, \f(CW\*(C`method\*(C'\fR, etc.
Add to this list if you want to create your own named blocks (i.e. blocks that
take a name argument).
.IP "output_class_footer ()" 4
.IX Item "output_class_footer ()"
Perl code to be added at the bottom of the class. Empty by default.
.IP "output_class_header ()" 4
.IX Item "output_class_header ()"
Perl code to be added at the top of the class, just after initialization of
Moose, \f(CW$m\fR and other required pieces. By default it consults the
class_header parameter.
.Sp
.Vb 10
\&    # Add to the top of every component class:
\&    #   use Modern::Perl;
\&    #   use JSON::XS qw(encode_json decode_json);
\&    #
\&    override \*(Aqoutput_class_header\*(Aq => sub {
\&        return join( "\en",
\&            super(),
\&            \*(Aquse Modern::Perl;\*(Aq,
\&            \*(Aquse JSON::XS qw(encode_json decode_json);\*(Aq );
\&    };
.Ve
.IP "process_perl_code ($coderef)" 4
.IX Item "process_perl_code ($coderef)"
This method is called on each distinct piece of Perl code in the component.
\&\fI\f(CI$coderef\fI\fR is a reference to a string containing the code; the method can
modify the code as desired. See Mason::Plugin::DollarDot for a sample usage.
.IP "unnamed_block_types ()" 4
.IX Item "unnamed_block_types ()"
An arrayref of valid unnamed block types: \f(CW\*(C`args\*(C'\fR, \f(CW\*(C`class\*(C'\fR, \f(CW\*(C`init\*(C'\fR, etc. Add
to this list if you want to create your own unnamed blocks.
.IP "valid_flags ()" 4
.IX Item "valid_flags ()"
An arrayref of valid flags: contains only \f(CW\*(C`extends\*(C'\fR at time of writing. Add to
this list if you want to create your own flags.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mason
.SH "AUTHOR"
.IX Header "AUTHOR"
Jonathan Swartz <swartz@pobox.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2012 by Jonathan Swartz.
.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.