.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" 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 >0, 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 .\" ======================================================================== .\" .IX Title "Sub::HandlesVia::CodeGenerator 3pm" .TH Sub::HandlesVia::CodeGenerator 3pm "2023-04-09" "perl v5.36.0" "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" Sub::HandlesVia::CodeGenerator \- looks at a Handler and generates a string of Perl code for it .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBThis module is part of Sub::HandlesVia's internal \s-1API.\s0\fR It is mostly of interest to people extending Sub::HandlesVia. .PP Sub::HandlesVia toolkits create a code generator for each attribute they're dealing with, and use the code generator to generate Perl code for one or more delegated methods. .SH "CONSTRUCTORS" .IX Header "CONSTRUCTORS" .ie n .SS """new( %attributes )""" .el .SS "\f(CWnew( %attributes )\fP" .IX Subsection "new( %attributes )" Standard Moose-like constructor. .SH "ATTRIBUTES" .IX Header "ATTRIBUTES" .ie n .SS """toolkit"" \fBObject\fP" .el .SS "\f(CWtoolkit\fP \fBObject\fP" .IX Subsection "toolkit Object" The toolkit which made this code generator. .ie n .SS """target"" \fBClassName|RoleName\fP" .el .SS "\f(CWtarget\fP \fBClassName|RoleName\fP" .IX Subsection "target ClassName|RoleName" The target package for generated methods. .ie n .SS """sandboxing_package"" \fBClassName|RoleName|Undef\fP" .el .SS "\f(CWsandboxing_package\fP \fBClassName|RoleName|Undef\fP" .IX Subsection "sandboxing_package ClassName|RoleName|Undef" Package name to use as a sandbox; the default is usually fine. .ie n .SS """attribute"" \fBStr|ArrayRef\fP" .el .SS "\f(CWattribute\fP \fBStr|ArrayRef\fP" .IX Subsection "attribute Str|ArrayRef" The attribute delegated to. .ie n .SS """attribute_spec"" \fBHashRef\fP" .el .SS "\f(CWattribute_spec\fP \fBHashRef\fP" .IX Subsection "attribute_spec HashRef" Informational only. .ie n .SS """is_method"" \fBBool\fP" .el .SS "\f(CWis_method\fP \fBBool\fP" .IX Subsection "is_method Bool" Indicates whether the generated code should be methods rather than functions. This defaults to true, and false isn't really tested or well-defined. .ie n .SS """env"" \fBHashRef\fP" .el .SS "\f(CWenv\fP \fBHashRef\fP" .IX Subsection "env HashRef" Variables which need to be closed over when compiling coderefs. .ie n .SS """isa"" \fBMaybe[TypeTiny]\fP" .el .SS "\f(CWisa\fP \fBMaybe[TypeTiny]\fP" .IX Subsection "isa Maybe[TypeTiny]" The type constraint for the attribute. .ie n .SS """coerce"" \fBBool\fP" .el .SS "\f(CWcoerce\fP \fBBool\fP" .IX Subsection "coerce Bool" Should the attribute coerce? .ie n .SS """method_installer"" \fBCodeRef\fP" .el .SS "\f(CWmethod_installer\fP \fBCodeRef\fP" .IX Subsection "method_installer CodeRef" A coderef which can be called with \f(CW$method_name\fR and \f(CW$coderef\fR, will install the method. Note that it isn't passed the package to install into (which can be found in \f(CW\*(C`target\*(C'\fR), so that would need to be closed over. .ie n .SS """generator_for_self"" \fBCodeRef\fP" .el .SS "\f(CWgenerator_for_self\fP \fBCodeRef\fP" .IX Subsection "generator_for_self CodeRef" A coderef which if called, generates a string like \f(CW\*(Aq$_[0]\*(Aq\fR. .PP Has a sensible default. .PP All the \f(CW\*(C`generator_for_XXX\*(C'\fR methods are called as methods, so have the code generator object as an invocant. .ie n .SS """generator_for_slot"" \fBCodeRef\fP" .el .SS "\f(CWgenerator_for_slot\fP \fBCodeRef\fP" .IX Subsection "generator_for_slot CodeRef" A coderef which if called, generates a string like \f(CW\*(Aq$_[0]{attrname}\*(Aq\fR. .ie n .SS """generator_for_get"" \fBCodeRef\fP" .el .SS "\f(CWgenerator_for_get\fP \fBCodeRef\fP" .IX Subsection "generator_for_get CodeRef" A coderef which if called, generates a string like \f(CW\*(Aq$_[0]\->attrname\*(Aq\fR. .ie n .SS """generator_for_set"" \fBCodeRef\fP" .el .SS "\f(CWgenerator_for_set\fP \fBCodeRef\fP" .IX Subsection "generator_for_set CodeRef" A coderef which if called with a parameter, generates a string like \&\f(CW"\e$_[0]\->_set_attrname( $parameter )"\fR. .ie n .SS """generator_for_simple_default"" \fBCodeRef\fP" .el .SS "\f(CWgenerator_for_simple_default\fP \fBCodeRef\fP" .IX Subsection "generator_for_simple_default CodeRef" A coderef which if called with a parameter, generates a string like \&\f(CW\*(Aqundef\*(Aq\fR or \f(CW\*(Aqq[]\*(Aq\fR or \f(CW\*(Aq{}\*(Aq\fR. .PP The parameter is a handler object, which offers a \f(CW\*(C`default_for_reset\*(C'\fR attribute which might be able to provide a useful fallback. .ie n .SS """generator_for_args"" \fBCodeRef\fP" .el .SS "\f(CWgenerator_for_args\fP \fBCodeRef\fP" .IX Subsection "generator_for_args CodeRef" A coderef which if called, generates a string like \f(CW\*(Aq@_[1..$#_]\*(Aq\fR. .PP Has a sensible default. .ie n .SS """generator_for_argc"" \fBCodeRef\fP" .el .SS "\f(CWgenerator_for_argc\fP \fBCodeRef\fP" .IX Subsection "generator_for_argc CodeRef" A coderef which if called, generates a string like \f(CW\*(Aq$#_\*(Aq\fR. .PP Has a sensible default. .ie n .SS """generator_for_argc"" \fBCodeRef\fP" .el .SS "\f(CWgenerator_for_argc\fP \fBCodeRef\fP" .IX Subsection "generator_for_argc CodeRef" A coderef which if called with a parameter, generates a string like \&\f(CW"\e$_[$parameter + 1]"\fR. .PP Has a sensible default. .ie n .SS """generator_for_currying"" \fBCodeRef\fP" .el .SS "\f(CWgenerator_for_currying\fP \fBCodeRef\fP" .IX Subsection "generator_for_currying CodeRef" A coderef which if called with a parameter, generates a string like \&\f(CW"splice(\e@_,1,0,$parameter);"\fR. .PP Has a sensible default. .ie n .SS """generator_for_usage_string"" \fBCodeRef\fP" .el .SS "\f(CWgenerator_for_usage_string\fP \fBCodeRef\fP" .IX Subsection "generator_for_usage_string CodeRef" The default is this coderef: .PP .Vb 7 \& sub { \& @_==3 or die; \& shift; \& my $method_name = shift; \& my $guts = shift; \& return "\e$instance\->$method_name($guts)"; \& } .Ve .ie n .SS """generator_for_type_assertion"" \fBCodeRef\fP" .el .SS "\f(CWgenerator_for_type_assertion\fP \fBCodeRef\fP" .IX Subsection "generator_for_type_assertion CodeRef" Called as a method and passed a hashref compilation environment, a type constraint, and a variable name. Generates code to assert that the variable value meets the type constraint, with coercion if appropriate. .ie n .SS """generator_for_error"" \fBCodeRef\fP" .el .SS "\f(CWgenerator_for_error\fP \fBCodeRef\fP" .IX Subsection "generator_for_error CodeRef" Called as a method and passed a Perl string which is an expression evaluating to an error message. Generates code to throw the error. .ie n .SS """generator_for_prelude"" \fBCodeRef\fP" .el .SS "\f(CWgenerator_for_prelude\fP \fBCodeRef\fP" .IX Subsection "generator_for_prelude CodeRef" By default is a coderef returning the empty string. Can be used to generate some additional statements which will be inserted near the top of the method being generated. (Typically after parameter checks but before doing anything serious.) This can be used to unlock a read-only attribute, for example. .ie n .SS """get_is_lvalue"" \fBBool\fP" .el .SS "\f(CWget_is_lvalue\fP \fBBool\fP" .IX Subsection "get_is_lvalue Bool" Indicates wheter the code generated by \f(CW\*(C`generator_for_get\*(C'\fR will be suitable for used as an lvalue. .ie n .SS """set_checks_isa"" \fBBool\fP" .el .SS "\f(CWset_checks_isa\fP \fBBool\fP" .IX Subsection "set_checks_isa Bool" Indicates wheter the code generated by \f(CW\*(C`generator_for_set\*(C'\fR will do type checks. .ie n .SS """set_strictly"" \fBBool\fP" .el .SS "\f(CWset_strictly\fP \fBBool\fP" .IX Subsection "set_strictly Bool" Indicates wheter we want to ensure that the setter is always called, and we should not try to bypass it, even if we have an lvalue getter. .SH "METHODS" .IX Header "METHODS" For each \f(CW\*(C`generator_for_XXX\*(C'\fR attribute, there's a corresponding \&\f(CW\*(C`generate_XXX\*(C'\fR method to actually call the coderef, possibly including additional processing. .ie n .SS """generate_and_install_method( $method_name, $handler )""" .el .SS "\f(CWgenerate_and_install_method( $method_name, $handler )\fP" .IX Subsection "generate_and_install_method( $method_name, $handler )" Given a handler and a method name, will generate a coderef for the handler and install it into the target package. .ie n .SS """generate_coderef_for_handler( $method_name, $handler )""" .el .SS "\f(CWgenerate_coderef_for_handler( $method_name, $handler )\fP" .IX Subsection "generate_coderef_for_handler( $method_name, $handler )" As above, but just returns the coderef rather than installs it. .ie n .SS """install_method( $method_name, $coderef )""" .el .SS "\f(CWinstall_method( $method_name, $coderef )\fP" .IX Subsection "install_method( $method_name, $coderef )" Installs a coderef into the target package with the given name. .SH "BUGS" .IX Header "BUGS" Please report any bugs to . .SH "SEE ALSO" .IX Header "SEE ALSO" Sub::HandlesVia. .SH "AUTHOR" .IX Header "AUTHOR" Toby Inkster . .SH "COPYRIGHT AND LICENCE" .IX Header "COPYRIGHT AND LICENCE" This software is copyright (c) 2020, 2022 by Toby Inkster. .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. .SH "DISCLAIMER OF WARRANTIES" .IX Header "DISCLAIMER OF WARRANTIES" \&\s-1THIS PACKAGE IS PROVIDED \*(L"AS IS\*(R" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.\s0