.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (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 .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . 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 "Template::Namespace::Constants 3" .TH Template::Namespace::Constants 3 2023-07-25 "perl v5.38.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 Template::Namespace::Constants \- Compile time constant folding .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 2 \& # easy way to define constants \& use Template; \& \& my $tt = Template\->new({ \& CONSTANTS => { \& pi => 3.14, \& e => 2.718, \& }, \& }); \& \& # nitty\-gritty, hands\-dirty way \& use Template::Namespace::Constants; \& \& my $tt = Template\->new({ \& NAMESPACE => { \& constants => Template::Namespace::Constants\->new({ \& pi => 3.14, \& e => 2.718, \& }, \& }, \& }); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" The \f(CW\*(C`Template::Namespace::Constants\*(C'\fR module implements a namespace handler which is plugged into the \f(CW\*(C`Template::Directive\*(C'\fR compiler module. This then performs compile time constant folding of variables in a particular namespace. .SH METHODS .IX Header "METHODS" .SS new(\e%constants) .IX Subsection "new(%constants)" The \fBnew()\fR constructor method creates and returns a reference to a new Template::Namespace::Constants object. This creates an internal stash to store the constant variable definitions passed as arguments. .PP .Vb 4 \& my $handler = Template::Namespace::Constants\->new({ \& pi => 3.14, \& e => 2.718, \& }); .Ve .SS ident(\e@ident) .IX Subsection "ident(@ident)" Method called to resolve a variable identifier into a compiled form. In this case, the method fetches the corresponding constant value from its internal stash and returns it. .SH AUTHOR .IX Header "AUTHOR" Andy Wardley .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright (C) 1996\-2022 Andy Wardley. All Rights Reserved. .PP This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .SH "SEE ALSO" .IX Header "SEE ALSO" Template::Directive