perlman gods <HR> <P> <H1><A NAME="NAME">NAME</A></H1> <P> perlsub - Perl subroutines <P> <HR> <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1> <P> To declare subroutines: <P> <PRE> sub NAME; # A &quot;forward&quot; declaration. sub NAME(PROTO); # ditto, but with prototypes </PRE> <P> <PRE> sub NAME BLOCK # A declaration and a definition. sub NAME(PROTO) BLOCK # ditto, but with prototypes </PRE> <P> To define an anonymous subroutine at runtime: <P> <PRE> $subref = sub BLOCK; # no proto $subref = sub (PROTO) BLOCK; # with proto </PRE> <P> To import subroutines: <P> <PRE> use PACKAGE qw(NAME1 NAME2 NAME3); </PRE> <P> To call subroutines: <P> <PRE> NAME(LIST); # &amp; is optional with parentheses. NAME LIST; # Parentheses optional if predeclared/imported. &amp;NAME; # Makes current @_ visible to called subroutine. </PRE> <P> <HR> <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1> <P> Like many languages, Perl provides for user-defined subroutines. These may be located anywhere in the main program, loaded in from other files via the [perlfunc:do|do], [perlfunc:require|require], or [perlfunc:use|use] keywords, or even generated on the fly using [perlfunc:eval|eval] or anonymous subroutines (closures). You can even call a function indirectly using a variable containing its name or a <FONT SIZE=-1>CODE</FONT> reference to it. <P> The Perl model for function call and return values is simple: all functions are passed as parameters one single flat list of scalars, and all functions likewise return to their caller one single flat list of scalars. Any arrays or hashes in these call and return lists will collapse, losing their identities--but you may always use pass-by-reference instead to avoid this. Both call and return lists may contain as many or as few scalar elements as you'd like. (Often a function without an explicit return statement is called a subroutine, but there's really no difference from the language's perspective.) <P> Any arguments passed to the routine come in as the array <CODE>@_</CODE>. Thus if you called a function with two arguments, those would be stored in <CODE>$_&#091;0&#093;</CODE> and <CODE>$_&#091;1&#093;</CODE>. The array <CODE>@_</CODE> is a local array, but its elements are aliases for the actual scalar parameters. In particular, if an element <CODE>$_&#091;0&#093;</CODE> is updated, the corresponding argument is updated (or an error occurs if it is not updatable). If an argument is an array or hash element which did not exist when the function was called, that element is created only when (and if) it is modified or if a reference to it is taken. (Some earlier versions of Perl created the element whether or not it was assigned to.) Note that assigning to the whole array <CODE>@_</CODE> removes the aliasing, and does not update any arguments. <P> The return value of the subroutine is the value of the last expression evaluated. Alternatively, a [perlfunc:return|return] statement may be used to exit the subroutine, optionally specifying the returned value, which will be evaluated in the appropriate context (list, scalar, or void) depending on the context of the subroutine call. If you specify no return value, the subroutine will return an empty list in a list context, an undefined value in a scalar context, or nothing in a void context. If you return one or more arrays and/or hashes, these will be flattened together into one large indistinguishable list. <P> Perl does not have named formal parameters, but in practice all you do is assign to a [perlfunc:my|my()] list of these. Any variables you use in the function that aren't declared private are global variables. For the gory details on creating private variables, see <A HREF="#Private_Variables_via_my_">Private Variables via my()</A> and <A HREF="#Temporary_Values_via_local_">Temporary Values via local()</A>. To create protected environments for a set of functions in a separate package (and probably a separate file), see <A HREF="perlmod.html#Packages">Packages</A>. <P> Example: <P> <PRE> sub max { my $max = shift(@_); foreach $foo (@_) { $max = $foo if $max &lt; $foo; } return $max; } $bestday = max($mon,$tue,$wed,$thu,$fri); </PRE> <P> Example: <P> <PRE> # get a line, combining continuation lines # that start with whitespace </PRE> <P> <PRE> sub get_line { $thisline = $lookahead; # GLOBAL VARIABLES!! LINE: while (defined($lookahead = &lt;STDIN&gt;)) { if ($lookahead =~ /^&#091; \t&#093;/) { $thisline .= $lookahead; } else { last LINE; } } $thisline; } </PRE> <P> <PRE> $lookahead = &lt;STDIN&gt;; # get first line while ($_ = get_line()) { ... } </PRE> <P> Use array assignment to a local list to name your formal arguments: <P> <PRE> sub maybeset { my($key, $value) = @_; $Foo{$key} = $value unless $Foo{$key}; } </PRE> <P> This also has the effect of turning call-by-reference into call-by-value, because the assignment copies the values. Otherwise a function is free to do in-place modifications of <CODE>@_</CODE> and change its caller's values. <P> <PRE> upcase_in($v1, $v2); # this changes $v1 and $v2 sub upcase_in { for (@_) { tr/a-z/A-Z/ } } </PRE> <P> You aren't allowed to modify constants in this way, of course. If an argument were actually literal and you tried to change it, you'd take a (presumably fatal) exception. For example, this won't work: <P> <PRE> upcase_in(&quot;frederick&quot;); </PRE> <P> It would be much safer if the <CODE>upcase_in()</CODE> function were written to return a copy of its parameters instead of changing them in place: <P> <PRE> ($v3, $v4) = upcase($v1, $v2); # this doesn't sub upcase { return unless defined wantarray; # void context, do nothing my @parms = @_; for (@parms) { tr/a-z/A-Z/ } return wantarray ? @parms : $parms&#091;0&#093;; } </PRE> <P> Notice how this (unprototyped) function doesn't care whether it was passed real scalars or arrays. Perl will see everything as one big long flat <CODE>@_</CODE> parameter list. This is one of the ways where Perl's simple argument-passing style shines. The <CODE>upcase()</CODE> function would work perfectly well without changing the <CODE>upcase()</CODE> definition even if we fed it things like this: <P> <PRE> @newlist = upcase(@list1, @list2); @newlist = upcase( split /:/, $var ); </PRE> <P> Do not, however, be tempted to do this: <P> <PRE> (@a, @b) = upcase(@list1, @list2); </PRE> <P> Because like its flat incoming parameter list, the return list is also flat. So all you have managed to do here is stored everything in <CODE>@a</CODE> and made <CODE>@b</CODE> an empty list. See <A HREF="#Pass_by_Reference">Pass by Reference</A> for alternatives. <P> <FONT SIZE=-1>A</FONT> subroutine may be called using the ``<CODE>&amp;</CODE>'' prefix. The ``<CODE>&amp;</CODE>'' is optional in modern Perls, and so are the parentheses if the subroutine has been predeclared. (Note, however, that the ``<CODE>&amp;</CODE>'' is <EM>NOT</EM> optional when you're just naming the subroutine, such as when it's used as an argument to [perlfunc:defined|defined()] or [perlfunc:undef|undef()]. Nor is it optional when you want to do an indirect subroutine call with a subroutine name or reference using the <CODE>&amp;$subref()</CODE> or <CODE>&amp;{$subref}()</CODE> constructs. See [perlman:perlref|the perlref manpage] for more on that.) <P> Subroutines may be called recursively. If a subroutine is called using the ``<CODE>&amp;</CODE>'' form, the argument list is optional, and if omitted, no <CODE>@_</CODE> array is set up for the subroutine: the <CODE>@_</CODE> array at the time of the call is visible to subroutine instead. This is an efficiency mechanism that new users may wish to avoid. <P> <PRE> &amp;foo(1,2,3); # pass three arguments foo(1,2,3); # the same </PRE> <P> <PRE> foo(); # pass a null list &amp;foo(); # the same </PRE> <P> <PRE> &amp;foo; # foo() get current args, like foo(@_) !! foo; # like foo() IFF sub foo predeclared, else &quot;foo&quot; </PRE> <P> Not only does the ``<CODE>&amp;</CODE>'' form make the argument list optional, but it also disables any prototype checking on the arguments you do provide. This is partly for historical reasons, and partly for having a convenient way to cheat if you know what you're doing. See the section on Prototypes below. <P> Function whose names are in all upper case are reserved to the Perl core, just as are modules whose names are in all lower case. <FONT SIZE=-1>A</FONT> function in all capitals is a loosely-held convention meaning it will be called indirectly by the run-time system itself. Functions that do special, pre-defined things are <CODE>BEGIN</CODE>, <CODE>END</CODE>, <CODE>AUTOLOAD</CODE>, and <CODE>DESTROY</CODE>--plus all the functions mentioned in [perlman:perltie|the perltie manpage]. The 5.005 release adds <CODE>INIT</CODE> to this list. <P> <HR> <H2><A NAME="Private_Variables_via_C_my_">Private Variables via [perlfunc:my|my()]</A></H2> <P> Synopsis: <P> <PRE> my $foo; # declare $foo lexically local my (@wid, %get); # declare list of variables local my $foo = &quot;flurp&quot;; # declare $foo lexical, and init it my @oof = @bar; # declare @oof lexical, and init it </PRE> <P> <FONT SIZE=-1>A</FONT> ``[perlfunc:my|my]'' declares the listed variables to be confined (lexically) to the enclosing block, conditional (<CODE>if/unless/elsif/else</CODE>), loop (<CODE>for/foreach/while/until/continue</CODE>), subroutine, [perlfunc:eval|eval], or <CODE>do/require/use</CODE>'d file. If more than one value is listed, the list must be placed in parentheses. All listed elements must be legal lvalues. Only alphanumeric identifiers may be lexically scoped--magical builtins like <CODE>$/</CODE> must currently be [perlfunc:local|local]ize with ``[perlfunc:local|local]'' instead. <P> Unlike dynamic variables created by the ``[perlfunc:local|local]'' operator, lexical variables declared with ``[perlfunc:my|my]'' are totally hidden from the outside world, including any called subroutines (even if it's the same subroutine called from itself or elsewhere--every call gets its own copy). <P> This doesn't mean that a [perlfunc:my|my()] variable declared in a statically <EM>enclosing</EM> lexical scope would be invisible. Only the dynamic scopes are cut off. For example, the <CODE>bumpx()</CODE> function below has access to the lexical <CODE>$x</CODE> variable because both the my and the sub occurred at the same scope, presumably the file scope. <P> <PRE> my $x = 10; sub bumpx { $x++ } </PRE> <P> (An [perlfunc:eval|eval()], however, can see the lexical variables of the scope it is being evaluated in so long as the names aren't hidden by declarations within the [perlfunc:eval|eval()] itself. See [perlman:perlref|the perlref manpage].) <P> The parameter list to [perlfunc:my|my()] may be assigned to if desired, which allows you to initialize your variables. (If no initializer is given for a particular variable, it is created with the undefined value.) Commonly this is used to name the parameters to a subroutine. Examples: <P> <PRE> $arg = &quot;fred&quot;; # &quot;global&quot; variable $n = cube_root(27); print &quot;$arg thinks the root is $n\n&quot;; fred thinks the root is 3 </PRE> <P> <PRE> sub cube_root { my $arg = shift; # name doesn't matter $arg **= 1/3; return $arg; } </PRE> <P> The ``[perlfunc:my|my]'' is simply a modifier on something you might assign to. So when you do assign to the variables in its argument list, the ``[perlfunc:my|my]'' doesn't change whether those variables are viewed as a scalar or an array. So <P> <PRE> my ($foo) = &lt;STDIN&gt;; # WRONG? my @FOO = &lt;STDIN&gt;; </PRE> <P> both supply a list context to the right-hand side, while <P> <PRE> my $foo = &lt;STDIN&gt;; </PRE> <P> supplies a scalar context. But the following declares only one variable: <P> <PRE> my $foo, $bar = 1; # WRONG </PRE> <P> That has the same effect as <P> <PRE> my $foo; $bar = 1; </PRE> <P> The declared variable is not introduced (is not visible) until after the current statement. Thus, <P> <PRE> my $x = $x; </PRE> <P> can be used to initialize the new <CODE>$x</CODE> with the value of the old <CODE>$x</CODE>, and the expression <P> <PRE> my $x = 123 and $x == 123 </PRE> <P> is false unless the old <CODE>$x</CODE> happened to have the value <CODE>123</CODE>. <P> Lexical scopes of control structures are not bounded precisely by the braces that delimit their controlled blocks; control expressions are part of the scope, too. Thus in the loop <P> <PRE> while (defined(my $line = &lt;&gt;)) { $line = lc $line; } continue { print $line; } </PRE> <P> the scope of <CODE>$line</CODE> extends from its declaration throughout the rest of the loop construct (including the [perlfunc:continue|continue] clause), but not beyond it. Similarly, in the conditional <P> <PRE> if ((my $answer = &lt;STDIN&gt;) =~ /^yes$/i) { user_agrees(); } elsif ($answer =~ /^no$/i) { user_disagrees(); } else { chomp $answer; die &quot;'$answer' is neither 'yes' nor 'no'&quot;; } </PRE> <P> the scope of <CODE>$answer</CODE> extends from its declaration throughout the rest of the conditional (including <CODE>elsif</CODE> and <CODE>else</CODE> clauses, if any), but not beyond it. <P> (None of the foregoing applies to <CODE>if/unless</CODE> or <CODE>while/until</CODE> modifiers appended to simple statements. Such modifiers are not control structures and have no effect on scoping.) <P> The <CODE>foreach</CODE> loop defaults to scoping its index variable dynamically (in the manner of [perlfunc:local|local]; see below). However, if the index variable is prefixed with the keyword ``[perlfunc:my|my]'', then it is lexically scoped instead. Thus in the loop <P> <PRE> for my $i (1, 2, 3) { some_function(); } </PRE> <P> the scope of <CODE>$i</CODE> extends to the end of the loop, but not beyond it, and so the value of <CODE>$i</CODE> is unavailable in <CODE>some_function()</CODE>. <P> Some users may wish to encourage the use of lexically scoped variables. As an aid to catching implicit references to package variables, if you say <P> <PRE> use strict 'vars'; </PRE> <P> then any variable reference from there to the end of the enclosing block must either refer to a lexical variable, or must be fully qualified with the package name. <FONT SIZE=-1>A</FONT> compilation error results otherwise. An inner block may countermand this with "<CODE>no&nbsp;strict&nbsp;'vars'</CODE>". <P> <FONT SIZE=-1>A</FONT> [perlfunc:my|my()] has both a compile-time and a run-time effect. At compile time, the compiler takes notice of it; the principle usefulness of this is to quiet "<CODE>use&nbsp;strict&nbsp;'vars'</CODE>". The actual initialization is delayed until run time, so it gets executed appropriately; every time through a loop, for example. <P> Variables declared with ``[perlfunc:my|my]'' are not part of any package and are therefore never fully qualified with the package name. In particular, you're not allowed to try to make a package variable (or other global) lexical: <P> <PRE> my $pack::var; # ERROR! Illegal syntax my $_; # also illegal (currently) </PRE> <P> In fact, a dynamic variable (also known as package or global variables) are still accessible using the fully qualified <CODE>::</CODE> notation even while a lexical of the same name is also visible: <P> <PRE> package main; local $x = 10; my $x = 20; print &quot;$x and $::x\n&quot;; </PRE> <P> That will print out <CODE>20</CODE> and <CODE>10</CODE>. <P> You may declare ``[perlfunc:my|my]'' variables at the outermost scope of a file to hide any such identifiers totally from the outside world. This is similar to C's static variables at the file level. To do this with a subroutine requires the use of a closure (anonymous function with lexical access). If a block (such as an [perlfunc:eval|eval()], function, or [perlfunc:package|package]) wants to create a private subroutine that cannot be called from outside that block, it can declare a lexical variable containing an anonymous sub reference: <P> <PRE> my $secret_version = '1.001-beta'; my $secret_sub = sub { print $secret_version }; &amp;$secret_sub(); </PRE> <P> As long as the reference is never returned by any function within the module, no outside module can see the subroutine, because its name is not in any package's symbol table. Remember that it's not <EM>REALLY</EM> called <CODE>$some_pack::secret_version</CODE> or anything; it's just <CODE>$secret_version</CODE>, unqualified and unqualifiable. <P> This does not work with object methods, however; all object methods have to be in the symbol table of some package to be found. <P> <HR> <H2><A NAME="Peristent_Private_Variables">Peristent Private Variables</A></H2> <P> Just because a lexical variable is lexically (also called statically) scoped to its enclosing block, [perlfunc:eval|eval], or [perlfunc:do|do] <FONT SIZE=-1>FILE,</FONT> this doesn't mean that within a function it works like a <FONT SIZE=-1>C</FONT> static. It normally works more like a <FONT SIZE=-1>C</FONT> auto, but with implicit garbage collection. <P> Unlike local variables in <FONT SIZE=-1>C</FONT> or <FONT SIZE=-1>C++,</FONT> Perl's lexical variables don't necessarily get recycled just because their scope has exited. If something more permanent is still aware of the lexical, it will stick around. So long as something else references a lexical, that lexical won't be freed--which is as it should be. You wouldn't want memory being free until you were done using it, or kept around once you were done. Automatic garbage collection takes care of this for you. <P> This means that you can pass back or save away references to lexical variables, whereas to return a pointer to a <FONT SIZE=-1>C</FONT> auto is a grave error. It also gives us a way to simulate C's function statics. Here's a mechanism for giving a function private variables with both lexical scoping and a static lifetime. If you do want to create something like C's static variables, just enclose the whole function in an extra block, and put the static variable outside the function but in the block. <P> <PRE> { my $secret_val = 0; sub gimme_another { return ++$secret_val; } } # $secret_val now becomes unreachable by the outside # world, but retains its value between calls to gimme_another </PRE> <P> If this function is being sourced in from a separate file via [perlfunc:require|require] or [perlfunc:use|use], then this is probably just fine. If it's all in the main program, you'll need to arrange for the [perlfunc:my|my()] to be executed early, either by putting the whole block above your main program, or more likely, placing merely a <CODE>BEGIN</CODE> sub around it to make sure it gets executed before your program starts to run: <P> <PRE> sub BEGIN { my $secret_val = 0; sub gimme_another { return ++$secret_val; } } </PRE> <P> See <A HREF="perlmod.html#Package_Constructors_and_Destruc">Package Constructors and Destructors</A> about the <CODE>BEGIN</CODE> function. <P> If declared at the outermost scope, the file scope, then lexicals work someone like C's file statics. They are available to all functions in that same file declared below them, but are inaccessible from outside of the file. This is sometimes used in modules to create private variables for the whole module. <P> <HR> <H2><A NAME="Temporary_Values_via_local_">Temporary Values via local()</A></H2> <P> <STRONG>NOTE</STRONG>: In general, you should be using ``[perlfunc:my|my]'' instead of ``[perlfunc:local|local]'', because it's faster and safer. Exceptions to this include the global punctuation variables, filehandles and formats, and direct manipulation of the Perl symbol table itself. Format variables often use ``[perlfunc:local|local]'' though, as do other variables whose current value must be visible to called subroutines. <P> Synopsis: <P> <PRE> local $foo; # declare $foo dynamically local local (@wid, %get); # declare list of variables local local $foo = &quot;flurp&quot;; # declare $foo dynamic, and init it local @oof = @bar; # declare @oof dynamic, and init it </PRE> <P> <PRE> local *FH; # localize $FH, @FH, %FH, &amp;FH ... local *merlyn = *randal; # now $merlyn is really $randal, plus # @merlyn is really @randal, etc local *merlyn = 'randal'; # SAME THING: promote 'randal' to *randal local *merlyn = \$randal; # just alias $merlyn, not @merlyn etc </PRE> <P> <FONT SIZE=-1>A</FONT> [perlfunc:local|local()] modifies its listed variables to be ``local'' to the enclosing block, [perlfunc:eval|eval], or <CODE>do FILE</CODE>--and to <EM>any subroutine called from within that block</EM>. <FONT SIZE=-1>A</FONT> [perlfunc:local|local()] just gives temporary values to global (meaning package) variables. It does <STRONG>not</STRONG> create a local variable. This is known as dynamic scoping. Lexical scoping is done with ``[perlfunc:my|my]'', which works more like C's auto declarations. <P> If more than one variable is given to [perlfunc:local|local()], they must be placed in parentheses. All listed elements must be legal lvalues. This operator works by saving the current values of those variables in its argument list on a hidden stack and restoring them upon exiting the block, subroutine, or eval. This means that called subroutines can also reference the local variable, but not the global one. The argument list may be assigned to if desired, which allows you to initialize your local variables. (If no initializer is given for a particular variable, it is created with an undefined value.) Commonly this is used to name the parameters to a subroutine. Examples: <P> <PRE> for $i ( 0 .. 9 ) { $digits{$i} = $i; } # assume this function uses global %digits hash parse_num(); </PRE> <P> <PRE> # now temporarily add to %digits hash if ($base12) { # (NOTE: not claiming this is efficient!) local %digits = (%digits, 't' =&gt; 10, 'e' =&gt; 11); parse_num(); # parse_num gets this new %digits! } # old %digits restored here </PRE> <P> Because [perlfunc:local|local()] is a run-time command, it gets executed every time through a loop. In releases of Perl previous to 5.0, this used more stack storage each time until the loop was exited. Perl now reclaims the space each time through, but it's still more efficient to declare your variables outside the loop. <P> <FONT SIZE=-1>A</FONT> [perlfunc:local|local] is simply a modifier on an lvalue expression. When you assign to a [perlfunc:local|local]ized variable, the [perlfunc:local|local] doesn't change whether its list is viewed as a scalar or an array. So <P> <PRE> local($foo) = &lt;STDIN&gt;; local @FOO = &lt;STDIN&gt;; </PRE> <P> both supply a list context to the right-hand side, while <P> <PRE> local $foo = &lt;STDIN&gt;; </PRE> <P> supplies a scalar context. <P> <FONT SIZE=-1>A</FONT> note about [perlfunc:local|local()] and composite types is in order. Something like [perlfunc:local|local(%foo)] works by temporarily placing a brand new hash in the symbol table. The old hash is left alone, but is hidden ``behind'' the new one. <P> This means the old variable is completely invisible via the symbol table (i.e. the hash entry in the <CODE>*foo</CODE> typeglob) for the duration of the dynamic scope within which the [perlfunc:local|local()] was seen. This has the effect of allowing one to temporarily occlude any magic on composite types. For instance, this will briefly alter a tied hash to some other implementation: <P> <PRE> tie %ahash, 'APackage'; &#091;...&#093; { local %ahash; tie %ahash, 'BPackage'; &#091;..called code will see %ahash tied to 'BPackage'..&#093; { local %ahash; &#091;..%ahash is a normal (untied) hash here..&#093; } } &#091;..%ahash back to its initial tied self again..&#093; </PRE> <P> As another example, a custom implementation of <CODE>%ENV</CODE> might look like this: <P> <PRE> { local %ENV; tie %ENV, 'MyOwnEnv'; &#091; your own fancy %ENV manipulation here..&#093; } &#091;..normal %ENV behavior here..&#093; </PRE> <P> It's also worth taking a moment to explain what happens when you [perlfunc:local|local]ize a member of a composite type (i.e. an array or hash element). In this case, the element is [perlfunc:local|local]ized <EM>by name</EM>. This means that when the scope of the [perlfunc:local|local()] ends, the saved value will be restored to the hash element whose key was named in the [perlfunc:local|local()], or the array element whose index was named in the [perlfunc:local|local()]. If that element was deleted while the [perlfunc:local|local()] was in effect (e.g. by a [perlfunc:delete|delete()] from a hash or a [perlfunc:shift|shift()] of an array), it will spring back into existence, possibly extending an array and filling in the skipped elements with [perlfunc:undef|undef]. For instance, if you say <P> <PRE> %hash = ( 'This' =&gt; 'is', 'a' =&gt; 'test' ); @ary = ( 0..5 ); { local($ary&#091;5&#093;) = 6; local($hash{'a'}) = 'drill'; while (my $e = pop(@ary)) { print &quot;$e . . .\n&quot;; last unless $e &gt; 3; } if (@ary) { $hash{'only a'} = 'test'; delete $hash{'a'}; } } print join(' ', map { &quot;$_ $hash{$_}&quot; } sort keys %hash),&quot;.\n&quot;; print &quot;The array has &quot;,scalar(@ary),&quot; elements: &quot;, join(', ', map { defined $_ ? $_ : 'undef' } @ary),&quot;\n&quot;; </PRE> <P> Perl will print <P> <PRE> 6 . . . 4 . . . 3 . . . This is a test only a test. The array has 6 elements: 0, 1, 2, undef, undef, 5 </PRE> <P> <HR> <H2><A NAME="Passing_Symbol_Table_Entries_ty">Passing Symbol Table Entries (typeglobs)</A></H2> <P> &#091;Note: The mechanism described in this section was originally the only way to simulate pass-by-reference in older versions of Perl. While it still works fine in modern versions, the new reference mechanism is generally easier to work with. See below.&#093; <P> Sometimes you don't want to pass the value of an array to a subroutine but rather the name of it, so that the subroutine can modify the global copy of it rather than working with a local copy. In perl you can refer to all objects of a particular name by prefixing the name with a star: <CODE>*foo</CODE>. This is often known as a ``typeglob'', because the star on the front can be thought of as a wildcard match for all the funny prefix characters on variables and subroutines and such. <P> When evaluated, the typeglob produces a scalar value that represents all the objects of that name, including any filehandle, format, or subroutine. When assigned to, it causes the name mentioned to refer to whatever ``<CODE>*</CODE>'' value was assigned to it. Example: <P> <PRE> sub doubleary { local(*someary) = @_; foreach $elem (@someary) { $elem *= 2; } } doubleary(*foo); doubleary(*bar); </PRE> <P> Note that scalars are already passed by reference, so you can modify scalar arguments without using this mechanism by referring explicitly to <CODE>$_&#091;0&#093;</CODE> etc. You can modify all the elements of an array by passing all the elements as scalars, but you have to use the <CODE>*</CODE> mechanism (or the equivalent reference mechanism) to [perlfunc:push|push], [perlfunc:pop|pop], or change the size of an array. It will certainly be faster to pass the typeglob (or reference). <P> Even if you don't want to modify an array, this mechanism is useful for passing multiple arrays in a single <FONT SIZE=-1>LIST,</FONT> because normally the <FONT SIZE=-1>LIST</FONT> mechanism will merge all the array values so that you can't extract out the individual arrays. For more on typeglobs, see <A HREF="perldata.html#Typeglobs_and_Filehandles">Typeglobs and Filehandles</A>. <P> <HR> <H2><A NAME="When_to_Still_Use_local_">When to Still Use local()</A></H2> <P> Despite the existence of [perlfunc:my|my()], there are still three places where the [perlfunc:local|local()] operator still shines. In fact, in these three places, you <EM>must</EM> use [perlfunc:local|local] instead of [perlfunc:my|my]. <OL> <LI><STRONG><A NAME="item_You_need_to_give_a_global_variab">You need to give a global variable a temporary value, especially $_.</A></STRONG> <P> The global variables, like <CODE>@ARGV</CODE> or the punctuation variables, must be [perlfunc:local|local]ized with [perlfunc:local|local()]. This block reads in <EM>/etc/motd</EM>, and splits it up into chunks separated by lines of equal signs, which are placed in <CODE>@Fields</CODE>. <P> <PRE> { local @ARGV = (&quot;/etc/motd&quot;); local $/ = undef; local $_ = &lt;&gt;; @Fields = split /^\s*=+\s*$/; } </PRE> <P> It particular, it's important to [perlfunc:local|local]ize <CODE>$_</CODE> in any routine that assigns to it. Look out for implicit assignments in <CODE>while</CODE> conditionals. <P><LI><STRONG><A NAME="item_You_need_to_create_a_local_file_">You need to create a local file or directory handle or a local function.</A></STRONG> <FONT SIZE=-1>A</FONT> function that needs a filehandle of its own must use [perlfunc:local|local()] uses [perlfunc:local|local()] on complete typeglob. This can be used to create new symbol table entries: <P> <PRE> sub ioqueue { local (*READER, *WRITER); # not my! pipe (READER, WRITER); or die &quot;pipe: $!&quot;; return (*READER, *WRITER); } ($head, $tail) = ioqueue(); </PRE> <P> See the Symbol module for a way to create anonymous symbol table entries. <P> Because assignment of a reference to a typeglob creates an alias, this can be used to create what is effectively a local function, or at least, a local alias. <P> <PRE> { local *grow = \&amp;shrink; # only until this block exists grow(); # really calls shrink() move(); # if move() grow()s, it shrink()s too } grow(); # get the real grow() again </PRE> <P> See <A HREF="perlref.html#Function_Templates">Function Templates</A> for more about manipulating functions by name in this way. <P><LI><STRONG><A NAME="item_You_want_to_temporarily_change_j">You want to temporarily change just one element of an array or hash.</A></STRONG> You can [perlfunc:local|local]ize just one element of an aggregate. Usually this is done on dynamics: <P> <PRE> { local $SIG{INT} = 'IGNORE'; funct(); # uninterruptible } # interruptibility automatically restored here </PRE> <P> But it also works on lexically declared aggregates. Prior to 5.005, this operation could on occasion misbehave. </OL> <P> <HR> <H2><A NAME="Pass_by_Reference">Pass by Reference</A></H2> <P> If you want to pass more than one array or hash into a function--or return them from it--and have them maintain their integrity, then you're going to have to use an explicit pass-by-reference. Before you do that, you need to understand references as detailed in [perlman:perlref|the perlref manpage]. This section may not make much sense to you otherwise. <P> Here are a few simple examples. First, let's pass in several arrays to a function and have it [perlfunc:pop|pop] all of then, return a new list of all their former last elements: <P> <PRE> @tailings = popmany ( \@a, \@b, \@c, \@d ); </PRE> <P> <PRE> sub popmany { my $aref; my @retlist = (); foreach $aref ( @_ ) { push @retlist, pop @$aref; } return @retlist; } </PRE> <P> Here's how you might write a function that returns a list of keys occurring in all the hashes passed to it: <P> <PRE> @common = inter( \%foo, \%bar, \%joe ); sub inter { my ($k, $href, %seen); # locals foreach $href (@_) { while ( $k = each %$href ) { $seen{$k}++; } } return grep { $seen{$_} == @_ } keys %seen; } </PRE> <P> So far, we're using just the normal list return mechanism. What happens if you want to pass or return a hash? Well, if you're using only one of them, or you don't mind them concatenating, then the normal calling convention is ok, although a little expensive. <P> Where people get into trouble is here: <P> <PRE> (@a, @b) = func(@c, @d); or (%a, %b) = func(%c, %d); </PRE> <P> That syntax simply won't work. It sets just <CODE>@a</CODE> or <CODE>%a</CODE> and clears the <CODE>@b</CODE> or <CODE>%b</CODE>. Plus the function didn't get passed into two separate arrays or hashes: it got one long list in <CODE>@_</CODE>, as always. <P> If you can arrange for everyone to deal with this through references, it's cleaner code, although not so nice to look at. Here's a function that takes two array references as arguments, returning the two array elements in order of how many elements they have in them: <P> <PRE> ($aref, $bref) = func(\@c, \@d); print &quot;@$aref has more than @$bref\n&quot;; sub func { my ($cref, $dref) = @_; if (@$cref &gt; @$dref) { return ($cref, $dref); } else { return ($dref, $cref); } } </PRE> <P> It turns out that you can actually do this also: <P> <PRE> (*a, *b) = func(\@c, \@d); print &quot;@a has more than @b\n&quot;; sub func { local (*c, *d) = @_; if (@c &gt; @d) { return (\@c, \@d); } else { return (\@d, \@c); } } </PRE> <P> Here we're using the typeglobs to do symbol table aliasing. It's a tad subtle, though, and also won't work if you're using [perlfunc:my|my()] variables, because only globals (well, and [perlfunc:local|local()]s) are in the symbol table. <P> If you're passing around filehandles, you could usually just use the bare typeglob, like <CODE>*STDOUT</CODE>, but typeglobs references would be better because they'll still work properly under <CODE>use&nbsp;strict&nbsp;'refs'</CODE>. For example: <P> <PRE> splutter(\*STDOUT); sub splutter { my $fh = shift; print $fh &quot;her um well a hmmm\n&quot;; } </PRE> <P> <PRE> $rec = get_rec(\*STDIN); sub get_rec { my $fh = shift; return scalar &lt;$fh&gt;; } </PRE> <P> Another way to do this is using <CODE>*HANDLE{IO}</CODE>, see [perlman:perlref|the perlref manpage] for usage and caveats. <P> If you're planning on generating new filehandles, you could do this: <P> <PRE> sub openit { my $name = shift; local *FH; return open (FH, $path) ? *FH : undef; } </PRE> <P> Although that will actually produce a small memory leak. See the bottom of [perlfunc:open|open()] for a somewhat cleaner way using the <CODE>IO::Handle</CODE> package. <P> <HR> <H2><A NAME="Prototypes">Prototypes</A></H2> <P> As of the 5.002 release of perl, if you declare <P> <PRE> sub mypush (\@@) </PRE> <P> then <CODE>mypush()</CODE> takes arguments exactly like [perlfunc:push|push()] does. The declaration of the function to be called must be visible at compile time. The prototype affects only the interpretation of new-style calls to the function, where new-style is defined as not using the <CODE>&amp;</CODE> character. In other words, if you call it like a builtin function, then it behaves like a builtin function. If you call it like an old-fashioned subroutine, then it behaves like an old-fashioned subroutine. It naturally falls out from this rule that prototypes have no influence on subroutine references like <CODE>\&amp;foo</CODE> or on indirect subroutine calls like <CODE>&amp;{$subref}</CODE>. <P> Method calls are not influenced by prototypes either, because the function to be called is indeterminate at compile time, because it depends on inheritance. <P> Because the intent is primarily to let you define subroutines that work like builtin commands, here are the prototypes for some other functions that parse almost exactly like the corresponding builtins. <P> <PRE> Declared as Called as </PRE> <P> <PRE> sub mylink ($$) mylink $old, $new sub myvec ($$$) myvec $var, $offset, 1 sub myindex ($$;$) myindex &amp;getstring, &quot;substr&quot; sub mysyswrite ($$$;$) mysyswrite $buf, 0, length($buf) - $off, $off sub myreverse (@) myreverse $a, $b, $c sub myjoin ($@) myjoin &quot;:&quot;, $a, $b, $c sub mypop (\@) mypop @array sub mysplice (\@$$@) mysplice @array, @array, 0, @pushme sub mykeys (\%) mykeys %{$hashref} sub myopen (*;$) myopen HANDLE, $name sub mypipe (**) mypipe READHANDLE, WRITEHANDLE sub mygrep (&amp;@) mygrep { /foo/ } $a, $b, $c sub myrand ($) myrand 42 sub mytime () mytime </PRE> <P> Any backslashed prototype character represents an actual argument that absolutely must start with that character. The value passed to the subroutine (as part of <CODE>@_</CODE>) will be a reference to the actual argument given in the subroutine call, obtained by applying <CODE>\</CODE> to that argument. <P> Unbackslashed prototype characters have special meanings. Any unbackslashed <CODE>@</CODE> or <CODE>%</CODE> eats all the rest of the arguments, and forces list context. An argument represented by <CODE>$</CODE> forces scalar context. An <CODE>&amp;</CODE> requires an anonymous subroutine, which, if passed as the first argument, does not require the ``[perlfunc:sub|sub]'' keyword or a subsequent comma. <FONT SIZE=-1>A</FONT> <CODE>*</CODE> does whatever it has to do to turn the argument into a reference to a symbol table entry. <P> <FONT SIZE=-1>A</FONT> semicolon separates mandatory arguments from optional arguments. (It is redundant before <CODE>@</CODE> or <CODE>%</CODE>.) <P> Note how the last three examples above are treated specially by the parser. <CODE>mygrep()</CODE> is parsed as a true list operator, <CODE>myrand()</CODE> is parsed as a true unary operator with unary precedence the same as [perlfunc:rand|rand()], and <CODE>mytime()</CODE> is truly without arguments, just like [perlfunc:time|time()]. That is, if you say <P> <PRE> mytime +2; </PRE> <P> you'll get <CODE>mytime() + 2</CODE>, not <CODE>mytime(2)</CODE>, which is how it would be parsed without the prototype. <P> The interesting thing about <CODE>&amp;</CODE> is that you can generate new syntax with it: <P> <PRE> sub try (&amp;@) { my($try,$catch) = @_; eval { &amp;$try }; if ($@) { local $_ = $@; &amp;$catch; } } sub catch (&amp;) { $_&#091;0&#093; } </PRE> <P> <PRE> try { die &quot;phooey&quot;; } catch { /phooey/ and print &quot;unphooey\n&quot;; }; </PRE> <P> That prints <CODE>&quot;unphooey&quot;</CODE>. (Yes, there are still unresolved issues having to do with the visibility of <CODE>@_</CODE>. I'm ignoring that question for the moment. (But note that if we make <CODE>@_</CODE> lexically scoped, those anonymous subroutines can act like closures... (Gee, is this sounding a little Lispish? (Never mind.)))) <P> And here's a reimplementation of [perlfunc:grep|grep]: <P> <PRE> sub mygrep (&amp;@) { my $code = shift; my @result; foreach $_ (@_) { push(@result, $_) if &amp;$code; } @result; } </PRE> <P> Some folks would prefer full alphanumeric prototypes. Alphanumerics have been intentionally left out of prototypes for the express purpose of someday in the future adding named, formal parameters. The current mechanism's main goal is to let module writers provide better diagnostics for module users. Larry feels the notation quite understandable to Perl programmers, and that it will not intrude greatly upon the meat of the module, nor make it harder to read. The line noise is visually encapsulated into a small pill that's easy to swallow. <P> It's probably best to prototype new functions, not retrofit prototyping into older ones. That's because you must be especially careful about silent impositions of differing list versus scalar contexts. For example, if you decide that a function should take just one parameter, like this: <P> <PRE> sub func ($) { my $n = shift; print &quot;you gave me $n\n&quot;; } </PRE> <P> and someone has been calling it with an array or expression returning a list: <P> <PRE> func(@foo); func( split /:/ ); </PRE> <P> Then you've just supplied an automatic [perlfunc:scalar|scalar()] in front of their argument, which can be more than a bit surprising. The old <CODE>@foo</CODE> which used to hold one thing doesn't get passed in. Instead, the <CODE>func()</CODE> now gets passed in <CODE>1</CODE>, that is, the number of elements in <CODE>@foo</CODE>. And the [perlfunc:split|split()] gets called in a scalar context and starts scribbling on your <CODE>@_</CODE> parameter list. <P> This is all very powerful, of course, and should be used only in moderation to make the world a better place. <P> <HR> <H2><A NAME="Constant_Functions">Constant Functions</A></H2> <P> Functions with a prototype of <CODE>()</CODE> are potential candidates for inlining. If the result after optimization and constant folding is either a constant or a lexically-scoped scalar which has no other references, then it will be used in place of function calls made without <CODE>&amp;</CODE> or [perlfunc:do|do]. Calls made using <CODE>&amp;</CODE> or [perlfunc:do|do] are never inlined. (See <EM></EM> for an easy way to declare most constants.) <P> The following functions would all be inlined: <P> <PRE> sub pi () { 3.14159 } # Not exact, but close. sub PI () { 4 * atan2 1, 1 } # As good as it gets, # and it's inlined, too! sub ST_DEV () { 0 } sub ST_INO () { 1 } </PRE> <P> <PRE> sub FLAG_FOO () { 1 &lt;&lt; 8 } sub FLAG_BAR () { 1 &lt;&lt; 9 } sub FLAG_MASK () { FLAG_FOO | FLAG_BAR } </PRE> <P> <PRE> sub OPT_BAZ () { not (0x1B58 &amp; FLAG_MASK) } sub BAZ_VAL () { if (OPT_BAZ) { return 23; } else { return 42; } } </PRE> <P> <PRE> sub N () { int(BAZ_VAL) / 3 } BEGIN { my $prod = 1; for (1..N) { $prod *= $_ } sub N_FACTORIAL () { $prod } } </PRE> <P> If you redefine a subroutine that was eligible for inlining, you'll get a mandatory warning. (You can use this warning to tell whether or not a particular subroutine is considered constant.) The warning is considered severe enough not to be optional because previously compiled invocations of the function will still be using the old value of the function. If you need to be able to redefine the subroutine you need to ensure that it isn't inlined, either by dropping the <CODE>()</CODE> prototype (which changes the calling semantics, so beware) or by thwarting the inlining mechanism in some other way, such as <P> <PRE> sub not_inlined () { 23 if $&#093;; } </PRE> <P> <HR> <H2><A NAME="Overriding_Builtin_Functions">Overriding Builtin Functions</A></H2> <P> Many builtin functions may be overridden, though this should be tried only occasionally and for good reason. Typically this might be done by a package attempting to emulate missing builtin functionality on a non-Unix system. <P> Overriding may be done only by importing the name from a module--ordinary predeclaration isn't good enough. However, the <CODE>subs</CODE> pragma (compiler directive) lets you, in effect, predeclare subs via the import syntax, and these names may then override the builtin ones: <P> <PRE> use subs 'chdir', 'chroot', 'chmod', 'chown'; chdir $somewhere; sub chdir { ... } </PRE> <P> To unambiguously refer to the builtin form, one may precede the builtin name with the special package qualifier <CODE>CORE::</CODE>. For example, saying <CODE>CORE::open()</CODE> will always refer to the builtin [perlfunc:open|open()], even if the current package has imported some other subroutine called <A HREF="perlfunc/open.html#item__open">&amp;open()</A> from elsewhere. <P> Library modules should not in general export builtin names like ``[perlfunc:open|open]'' or ``[perlfunc:chdir|chdir]'' as part of their default <CODE>@EXPORT</CODE> list, because these may sneak into someone else's namespace and change the semantics unexpectedly. Instead, if the module adds the name to the <CODE>@EXPORT_OK</CODE> list, then it's possible for a user to import the name explicitly, but not implicitly. That is, they could say <P> <PRE> use Module 'open'; </PRE> <P> and it would import the [perlfunc:open|open] override, but if they said <P> <PRE> use Module; </PRE> <P> they would get the default imports without the overrides. <P> The foregoing mechanism for overriding builtins is restricted, quite deliberately, to the package that requests the import. There is a second method that is sometimes applicable when you wish to override a builtin everywhere, without regard to namespace boundaries. This is achieved by importing a sub into the special namespace <CODE>CORE::GLOBAL::</CODE>. Here is an example that quite brazenly replaces the [perlfunc:glob|glob] operator with something that understands regular expressions. <P> <PRE> package REGlob; require Exporter; @ISA = 'Exporter'; @EXPORT_OK = 'glob'; </PRE> <P> <PRE> sub import { my $pkg = shift; return unless @_; my $sym = shift; my $where = ($sym =~ s/^GLOBAL_// ? 'CORE::GLOBAL' : caller(0)); $pkg-&gt;export($where, $sym, @_); } </PRE> <P> <PRE> sub glob { my $pat = shift; my @got; local(*D); if (opendir D, '.') { @got = grep /$pat/, readdir D; closedir D; } @got; } 1; </PRE> <P> And here's how it could be (ab)used: <P> <PRE> #use REGlob 'GLOBAL_glob'; # override glob() in ALL namespaces package Foo; use REGlob 'glob'; # override glob() in Foo:: only print for &lt;^&#091;a-z_&#093;+\.pm\$&gt;; # show all pragmatic modules </PRE> <P> Note that the initial comment shows a contrived, even dangerous example. By overriding [perlfunc:glob|glob] globally, you would be forcing the new (and subversive) behavior for the [perlfunc:glob|glob] operator for <STRONG>every</STRONG> namespace, without the complete cognizance or cooperation of the modules that own those namespaces. Naturally, this should be done with extreme caution--if it must be done at all. <P> The <CODE>REGlob</CODE> example above does not implement all the support needed to cleanly override perl's [perlfunc:glob|glob] operator. The builtin [perlfunc:glob|glob] has different behaviors depending on whether it appears in a scalar or list context, but our <CODE>REGlob</CODE> doesn't. Indeed, many perl builtins have such context sensitive behaviors, and these must be adequately supported by a properly written override. For a fully functional example of overriding [perlfunc:glob|glob], study the implementation of <CODE>File::DosGlob</CODE> in the standard library. <P> <HR> <H2><A NAME="Autoloading">Autoloading</A></H2> <P> If you call a subroutine that is undefined, you would ordinarily get an immediate fatal error complaining that the subroutine doesn't exist. (Likewise for subroutines being used as methods, when the method doesn't exist in any base class of the class package.) If, however, there is an <CODE>AUTOLOAD</CODE> subroutine defined in the package or packages that were searched for the original subroutine, then that <CODE>AUTOLOAD</CODE> subroutine is called with the arguments that would have been passed to the original subroutine. The fully qualified name of the original subroutine magically appears in the <CODE>$AUTOLOAD</CODE> variable in the same package as the <CODE>AUTOLOAD</CODE> routine. The name is not passed as an ordinary argument because, er, well, just because, that's why... <P> Most <CODE>AUTOLOAD</CODE> routines will load in a definition for the subroutine in question using eval, and then execute that subroutine using a special form of ``goto'' that erases the stack frame of the <CODE>AUTOLOAD</CODE> routine without a trace. (See the standard <CODE>AutoLoader</CODE> module, for example.) But an <CODE>AUTOLOAD</CODE> routine can also just emulate the routine and never define it. For example, let's pretend that a function that wasn't defined should just call [perlfunc:system|system()] with those arguments. All you'd do is this: <P> <PRE> sub AUTOLOAD { my $program = $AUTOLOAD; $program =~ s/.*:://; system($program, @_); } date(); who('am', 'i'); ls('-l'); </PRE> <P> In fact, if you predeclare the functions you want to call that way, you don't even need the parentheses: <P> <PRE> use subs qw(date who ls); date; who &quot;am&quot;, &quot;i&quot;; ls -l; </PRE> <P> <FONT SIZE=-1>A</FONT> more complete example of this is the standard Shell module, which can treat undefined subroutine calls as calls to Unix programs. <P> Mechanisms are available for modules writers to help split the modules up into autoloadable files. See the standard AutoLoader module described in <U>the AutoLoader manpage</U><!--../lib/AutoLoader.html--> and in <U>the AutoSplit manpage</U><!--../lib/AutoSplit.html-->, the standard SelfLoader modules in <U>the SelfLoader manpage</U><!--../lib/SelfLoader.html-->, and the document on adding <FONT SIZE=-1>C</FONT> functions to perl code in [perlman:perlxs|the perlxs manpage]. <P> <HR> <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1> <P> See [perlman:perlref|the perlref manpage] for more about references and closures. See [perlman:perlxs|the perlxs manpage] if you'd like to learn about calling <FONT SIZE=-1>C</FONT> subroutines from perl. See [perlman:perlmod|the perlmod manpage] to learn about bundling up your functions in separate files. <HR> <BR>Return to the [Library]<BR>