Debian Codegraph @

upstream/opensuse-tumbleweed/man3/autouse.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "autouse 3pm"
61 .TH autouse 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 autouse \- postpone load of modules until a function is used
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 2
71 \& use autouse \*(AqCarp\*(Aq => qw(carp croak);
72 \& carp "this carp was predeclared and autoused ";
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 If the module \f(CW\*(C`Module\*(C'\fR is already loaded, then the declaration
77 .PP
78 .Vb 1
79 \& use autouse \*(AqModule\*(Aq => qw(func1 func2($;$));
80 .Ve
81 .PP
82 is equivalent to
83 .PP
84 .Vb 1
85 \& use Module qw(func1 func2);
86 .Ve
87 .PP
88 if \f(CW\*(C`Module\*(C'\fR defines \fBfunc2()\fR with prototype \f(CW\*(C`($;$)\*(C'\fR, and \fBfunc1()\fR has
89 no prototypes. (At least if \f(CW\*(C`Module\*(C'\fR uses \f(CW\*(C`Exporter\*(C'\fR\*(Aqs \f(CW\*(C`import\*(C'\fR,
90 otherwise it is a fatal error.)
91 .PP
92 If the module \f(CW\*(C`Module\*(C'\fR is not loaded yet, then the above declaration
93 declares functions \fBfunc1()\fR and \fBfunc2()\fR in the current package. When
94 these functions are called, they load the package \f(CW\*(C`Module\*(C'\fR if needed,
95 and substitute themselves with the correct definitions.
96 .SH WARNING
97 .IX Header "WARNING"
98 Using \f(CW\*(C`autouse\*(C'\fR will move important steps of your program\*(Aqs execution
99 from compile time to runtime. This can
100 .IP \(bu 4
101 Break the execution of your program if the module you \f(CW\*(C`autouse\*(C'\fRd has
102 some initialization which it expects to be done early.
103 .IP \(bu 4
104 hide bugs in your code since important checks (like correctness of
105 prototypes) is moved from compile time to runtime. In particular, if
106 the prototype you specified on \f(CW\*(C`autouse\*(C'\fR line is wrong, you will not
107 find it out until the corresponding function is executed. This will be
108 very unfortunate for functions which are not always called (note that
109 for such functions \f(CW\*(C`autouse\*(C'\fRing gives biggest win, for a workaround
110 see below).
111 .PP
112 To alleviate the second problem (partially) it is advised to write
113 your scripts like this:
114 .PP
115 .Vb 3
116 \& use Module;
117 \& use autouse Module => qw(carp($) croak(&$));
118 \& carp "this carp was predeclared and autoused ";
119 .Ve
120 .PP
121 The first line ensures that the errors in your argument specification
122 are found early. When you ship your application you should comment
123 out the first line, since it makes the second one useless.
124 .SH AUTHOR
125 .IX Header "AUTHOR"
126 Ilya Zakharevich ([email protected]\-state.edu)
127 .SH "SEE ALSO"
128 .IX Header "SEE ALSO"
129 \&\fBperl\fR\|(1).