summaryrefslogtreecommitdiffstats
path: root/upstream/debian-bookworm/man3/experimental.3perl
blob: 15c490cd8976382fd7bbadfe9d4d7d243a32547d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
.\" 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 "experimental 3perl"
.TH experimental 3perl "2023-11-25" "perl v5.36.0" "Perl Programmers Reference Guide"
.\" 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"
experimental \- Experimental features made easy
.SH "VERSION"
.IX Header "VERSION"
version 0.027
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& use experimental \*(Aqlexical_subs\*(Aq, \*(Aqsignatures\*(Aq;
\& my sub plus_one($value) { $value + 1 }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This pragma provides an easy and convenient way to enable or disable
experimental features.
.PP
Every version of perl has some number of features present but considered
\&\*(L"experimental.\*(R"  For much of the life of Perl 5, this was only a designation
found in the documentation.  Starting in Perl v5.10.0, and more aggressively in
v5.18.0, experimental features were placed behind pragmata used to enable the
feature and disable associated warnings.
.PP
The \f(CW\*(C`experimental\*(C'\fR pragma exists to combine the required incantations into a
single interface stable across releases of perl.  For every experimental
feature, this should enable the feature and silence warnings for the enclosing
lexical scope:
.PP
.Vb 1
\&  use experimental \*(Aqfeature\-name\*(Aq;
.Ve
.PP
To disable the feature and, if applicable, re-enable any warnings, use:
.PP
.Vb 1
\&  no experimental \*(Aqfeature\-name\*(Aq;
.Ve
.PP
The supported features, documented further below, are:
.IP "\(bu" 4
\&\f(CW\*(C`args_array_with_signatures\*(C'\fR \- allow \f(CW@_\fR to be used in signatured subs.
.Sp
This is supported on perl 5.20.0 and above, but is likely to be removed in the future.
.IP "\(bu" 4
\&\f(CW\*(C`array_base\*(C'\fR \- allow the use of \f(CW$[\fR to change the starting index of \f(CW@array\fR.
.Sp
This was removed in perl 5.30.0.
.IP "\(bu" 4
\&\f(CW\*(C`autoderef\*(C'\fR \- allow push, each, keys, and other built-ins on references.
.Sp
This was added in perl 5.14.0 and removed in perl 5.24.0.
.IP "\(bu" 4
\&\f(CW\*(C`bitwise\*(C'\fR \- allow the new stringwise bit operators
.Sp
This was added in perl 5.22.0.
.IP "\(bu" 4
\&\f(CW\*(C`builtin\*(C'\fR \- allow the use of the functions in the builtin:: namespace
.Sp
This was added in perl 5.36.0
.IP "\(bu" 4
\&\f(CW\*(C`const_attr\*(C'\fR \- allow the :const attribute on subs
.Sp
This was added in perl 5.22.0.
.IP "\(bu" 4
\&\f(CW\*(C`declared_refs\*(C'\fR \- enables aliasing via assignment to references
.Sp
This was added in perl 5.26.0.
.IP "\(bu" 4
\&\f(CW\*(C`defer\*(C'\fR \- enables the use of defer blocks
.Sp
This was added in perl 5.36.0
.IP "\(bu" 4
\&\f(CW\*(C`for_list\*(C'\fR \- allows iterating over multiple values at a time with \f(CW\*(C`for\*(C'\fR
.Sp
This was added in perl 5.36.0
.IP "\(bu" 4
\&\f(CW\*(C`isa\*(C'\fR \- allow the use of the \f(CW\*(C`isa\*(C'\fR infix operator
.Sp
This was added in perl 5.32.0.
.IP "\(bu" 4
\&\f(CW\*(C`lexical_topic\*(C'\fR \- allow the use of lexical \f(CW$_\fR via \f(CW\*(C`my $_\*(C'\fR.
.Sp
This was added in perl 5.10.0 and removed in perl 5.24.0.
.IP "\(bu" 4
\&\f(CW\*(C`lexical_subs\*(C'\fR \- allow the use of lexical subroutines.
.Sp
This was added in 5.18.0.
.IP "\(bu" 4
\&\f(CW\*(C`postderef\*(C'\fR \- allow the use of postfix dereferencing expressions
.Sp
This was added in perl 5.20.0, and became non-experimental (and always enabled) in 5.24.0.
.IP "\(bu" 4
\&\f(CW\*(C`postderef_qq\*(C'\fR \- allow the use of postfix dereferencing expressions inside interpolating strings
.Sp
This was added in perl 5.20.0, and became non-experimental (and always enabled) in 5.24.0.
.IP "\(bu" 4
\&\f(CW\*(C`re_strict\*(C'\fR \- enables strict mode in regular expressions
.Sp
This was added in perl 5.22.0.
.IP "\(bu" 4
\&\f(CW\*(C`refaliasing\*(C'\fR \- allow aliasing via \f(CW\*(C`\e$x = \e$y\*(C'\fR
.Sp
This was added in perl 5.22.0.
.IP "\(bu" 4
\&\f(CW\*(C`regex_sets\*(C'\fR \- allow extended bracketed character classes in regexps
.Sp
This was added in perl 5.18.0.
.IP "\(bu" 4
\&\f(CW\*(C`signatures\*(C'\fR \- allow subroutine signatures (for named arguments)
.Sp
This was added in perl 5.20.0.
.IP "\(bu" 4
\&\f(CW\*(C`smartmatch\*(C'\fR \- allow the use of \f(CW\*(C`~~\*(C'\fR
.Sp
This was added in perl 5.10.0, but it should be noted there are significant
incompatibilities between 5.10.0 and 5.10.1.
.IP "\(bu" 4
\&\f(CW\*(C`switch\*(C'\fR \- allow the use of \f(CW\*(C`~~\*(C'\fR, given, and when
.Sp
This was added in perl 5.10.0.
.IP "\(bu" 4
\&\f(CW\*(C`try\*(C'\fR \- allow the use of \f(CW\*(C`try\*(C'\fR and \f(CW\*(C`catch\*(C'\fR
.Sp
This was added in perl 5.34.0
.IP "\(bu" 4
\&\f(CW\*(C`win32_perlio\*(C'\fR \- allows the use of the :win32 \s-1IO\s0 layer.
.Sp
This was added on perl 5.22.0.
.SS "Ordering matters"
.IX Subsection "Ordering matters"
Using this pragma to 'enable an experimental feature' is another way of saying
that this pragma will disable the warnings which would result from using that
feature.  Therefore, the order in which pragmas are applied is important.  In
particular, you probably want to enable experimental features \fIafter\fR you
enable warnings:
.PP
.Vb 2
\&  use warnings;
\&  use experimental \*(Aqsmartmatch\*(Aq;
.Ve
.PP
You also need to take care with modules that enable warnings for you.  A common
example being Moose.  In this example, warnings for the 'smartmatch' feature are
first turned on by the warnings pragma, off by the experimental pragma and back
on again by the Moose module (fix is to switch the last two lines):
.PP
.Vb 3
\&  use warnings;
\&  use experimental \*(Aqsmartmatch\*(Aq;
\&  use Moose;
.Ve
.SS "Disclaimer"
.IX Subsection "Disclaimer"
Because of the nature of the features it enables, forward compatibility can not
be guaranteed in any way.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
perlexperiment contains more information about experimental features.
.SH "AUTHOR"
.IX Header "AUTHOR"
Leon Timmermans <leont@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2013 by Leon Timmermans.
.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.