.\" Automatically generated by Pod::Man 2.28 (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 "HTML::Mason::Compiler::ToObject 3pm" .TH HTML::Mason::Compiler::ToObject 3pm "2014-01-19" "perl v5.20.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" HTML::Mason::Compiler::ToObject \- A Compiler subclass that generates Mason object code .SH "VERSION" .IX Header "VERSION" version 1.54 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& my $compiler = HTML::Mason::Compiler::ToObject\->new; \& \& my $object_code = \& $compiler\->compile( comp_source => $source, \& name => $comp_name, \& comp_path => $comp_path, \& ); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This Compiler subclass generates Mason object code (Perl code). It is the default Compiler class used by Mason. .SH "PARAMETERS TO THE \fInew()\fP CONSTRUCTOR" .IX Header "PARAMETERS TO THE new() CONSTRUCTOR" All of these parameters are optional. .IP "comp_class" 4 .IX Item "comp_class" The class into which component objects are blessed. This defaults to HTML::Mason::Component. .IP "subcomp_class" 4 .IX Item "subcomp_class" The class into which subcomponent objects are blessed. This defaults to HTML::Mason::Component::Subcomponent. .IP "in_package" 4 .IX Item "in_package" This is the package in which a component's code is executed. For historical reasons, this defaults to \f(CW\*(C`HTML::Mason::Commands\*(C'\fR. .IP "preamble" 4 .IX Item "preamble" Text given for this parameter is placed at the beginning of each component, but after the execution of any \f(CW\*(C`<%once>\*(C'\fR block. See also postamble. The request will be available as \f(CW$m\fR in preamble code. .IP "postamble" 4 .IX Item "postamble" Text given for this parameter is placed at the end of each component. See also preamble. The request will be available as \&\f(CW$m\fR in postamble code. .IP "use_strict" 4 .IX Item "use_strict" True or false, default is true. Indicates whether or not a given component should \f(CW\*(C`use strict\*(C'\fR. .IP "use_warnings" 4 .IX Item "use_warnings" True or false, default is false. Indicates whether or not a given component should \f(CW\*(C`use warnings\*(C'\fR. .IP "named_component_subs" 4 .IX Item "named_component_subs" When compiling a component, use uniquely named subroutines for the a component's body, subcomponents, and methods. Doing this allows you to effectively profile Mason components. Without this, all components simply show up as _\|_ANON_\|_ or something similar in the profiler. .IP "define_args_hash" 4 .IX Item "define_args_hash" One of \*(L"always\*(R", \*(L"auto\*(R", or \*(L"never\*(R". This determines whether or not an \f(CW%ARGS\fR hash is created in components. If it is set to \*(L"always\*(R", one is always defined. If set to \*(L"never\*(R", it is never defined. .Sp The default, \*(L"auto\*(R", will cause the hash to be defined only if some part of the component contains the string \*(L"\s-1ARGS\*(R". \s0 This is somewhat crude, and may result in some false positives, but this is preferable to false negatives. .Sp Not defining the args hash means that we can avoid copying component arguments, which can save memory and slightly improve execution speed. .SH "ACCESSOR METHODS" .IX Header "ACCESSOR METHODS" All of the above properties have read-only accessor methods of the same name. You cannot change any property of a compiler after it has been created (but you can create multiple compilers with different properties). .SH "METHODS" .IX Header "METHODS" This class is primarily meant to be used by the Interpreter object, and as such has a very limited public \s-1API.\s0 .IP "compile(...)" 4 .IX Item "compile(...)" This method will take component source and return the compiled object code for that source. See \*(L"compile(...)\*(R" in HTML::Mason::Compiler for details on this method. .Sp This subclass also accepts a \f(CW\*(C`comp_class\*(C'\fR parameter, allowing you to override the class into which the component is compiled. .SH "SEE ALSO" .IX Header "SEE ALSO" Mason .SH "AUTHORS" .IX Header "AUTHORS" .IP "\(bu" 4 Jonathan Swartz .IP "\(bu" 4 Dave Rolsky .IP "\(bu" 4 Ken Williams .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.