| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "autouse 3perl" |
| 58 |
.TH autouse 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide" |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
autouse \- postpone load of modules until a function is used |
| 65 |
.SH SYNOPSIS |
| 66 |
.IX Header "SYNOPSIS" |
| 67 |
.Vb 2 |
| 68 |
\& use autouse \*(AqCarp\*(Aq => qw(carp croak); |
| 69 |
\& carp "this carp was predeclared and autoused "; |
| 70 |
.Ve |
| 71 |
.SH DESCRIPTION |
| 72 |
.IX Header "DESCRIPTION" |
| 73 |
If the module \f(CW\*(C`Module\*(C'\fR is already loaded, then the declaration |
| 74 |
.PP |
| 75 |
.Vb 1 |
| 76 |
\& use autouse \*(AqModule\*(Aq => qw(func1 func2($;$)); |
| 77 |
.Ve |
| 78 |
.PP |
| 79 |
is equivalent to |
| 80 |
.PP |
| 81 |
.Vb 1 |
| 82 |
\& use Module qw(func1 func2); |
| 83 |
.Ve |
| 84 |
.PP |
| 85 |
if \f(CW\*(C`Module\*(C'\fR defines \fBfunc2()\fR with prototype \f(CW\*(C`($;$)\*(C'\fR, and \fBfunc1()\fR has |
| 86 |
no prototypes. (At least if \f(CW\*(C`Module\*(C'\fR uses \f(CW\*(C`Exporter\*(C'\fR's \f(CW\*(C`import\*(C'\fR, |
| 87 |
otherwise it is a fatal error.) |
| 88 |
.PP |
| 89 |
If the module \f(CW\*(C`Module\*(C'\fR is not loaded yet, then the above declaration |
| 90 |
declares functions \fBfunc1()\fR and \fBfunc2()\fR in the current package. When |
| 91 |
these functions are called, they load the package \f(CW\*(C`Module\*(C'\fR if needed, |
| 92 |
and substitute themselves with the correct definitions. |
| 93 |
.SH WARNING |
| 94 |
.IX Header "WARNING" |
| 95 |
Using \f(CW\*(C`autouse\*(C'\fR will move important steps of your program's execution |
| 96 |
from compile time to runtime. This can |
| 97 |
.IP \(bu 4 |
| 98 |
Break the execution of your program if the module you \f(CW\*(C`autouse\*(C'\fRd has |
| 99 |
some initialization which it expects to be done early. |
| 100 |
.IP \(bu 4 |
| 101 |
hide bugs in your code since important checks (like correctness of |
| 102 |
prototypes) is moved from compile time to runtime. In particular, if |
| 103 |
the prototype you specified on \f(CW\*(C`autouse\*(C'\fR line is wrong, you will not |
| 104 |
find it out until the corresponding function is executed. This will be |
| 105 |
very unfortunate for functions which are not always called (note that |
| 106 |
for such functions \f(CW\*(C`autouse\*(C'\fRing gives biggest win, for a workaround |
| 107 |
see below). |
| 108 |
.PP |
| 109 |
To alleviate the second problem (partially) it is advised to write |
| 110 |
your scripts like this: |
| 111 |
.PP |
| 112 |
.Vb 3 |
| 113 |
\& use Module; |
| 114 |
\& use autouse Module => qw(carp($) croak(&$)); |
| 115 |
\& carp "this carp was predeclared and autoused "; |
| 116 |
.Ve |
| 117 |
.PP |
| 118 |
The first line ensures that the errors in your argument specification |
| 119 |
are found early. When you ship your application you should comment |
| 120 |
out the first line, since it makes the second one useless. |
| 121 |
.SH AUTHOR |
| 122 |
.IX Header "AUTHOR" |
| 123 |
Ilya Zakharevich ([email protected]\-state.edu) |
| 124 |
.SH "SEE ALSO" |
| 125 |
.IX Header "SEE ALSO" |
| 126 |
\&\fBperl\fR\|(1). |