This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Promote v5.36 usage and feature bundles doc
[perl5.git] / feature.h
CommitLineData
f2c01b15
FC
1/* -*- buffer-read-only: t -*-
2 !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
3 This file is built by regen/feature.pl.
4 Any changes made here will be lost!
5 */
6
7
3dd7db29
JK
8#ifndef PERL_FEATURE_H_
9#define PERL_FEATURE_H_
10
f2c01b15
FC
11#if defined(PERL_CORE) || defined (PERL_EXT)
12
13#define HINT_FEATURE_SHIFT 26
14
9c9853e8
KW
15#define FEATURE_BAREWORD_FILEHANDLES_BIT 0x0001
16#define FEATURE_BITWISE_BIT 0x0002
17#define FEATURE___SUB___BIT 0x0004
18#define FEATURE_MYREF_BIT 0x0008
19#define FEATURE_DEFER_BIT 0x0010
20#define FEATURE_EVALBYTES_BIT 0x0020
21#define FEATURE_MORE_DELIMS_BIT 0x0040
22#define FEATURE_FC_BIT 0x0080
23#define FEATURE_INDIRECT_BIT 0x0100
24#define FEATURE_ISA_BIT 0x0200
25#define FEATURE_MULTIDIMENSIONAL_BIT 0x0400
26#define FEATURE_POSTDEREF_QQ_BIT 0x0800
27#define FEATURE_REFALIASING_BIT 0x1000
28#define FEATURE_SAY_BIT 0x2000
29#define FEATURE_SIGNATURES_BIT 0x4000
30#define FEATURE_STATE_BIT 0x8000
31#define FEATURE_SWITCH_BIT 0x10000
32#define FEATURE_TRY_BIT 0x20000
33#define FEATURE_UNIEVAL_BIT 0x40000
34#define FEATURE_UNICODE_BIT 0x80000
9f601cf3 35
f2c01b15
FC
36#define FEATURE_BUNDLE_DEFAULT 0
37#define FEATURE_BUNDLE_510 1
38#define FEATURE_BUNDLE_511 2
39#define FEATURE_BUNDLE_515 3
2ad792cd 40#define FEATURE_BUNDLE_523 4
401d2aaa 41#define FEATURE_BUNDLE_527 5
915e574d 42#define FEATURE_BUNDLE_535 6
31c1155d 43#define FEATURE_BUNDLE_537 7
2b9e0ab7 44#define FEATURE_BUNDLE_CUSTOM (HINT_FEATURE_MASK >> HINT_FEATURE_SHIFT)
f2c01b15 45
d1fd0100
FC
46#define CURRENT_HINTS \
47 (PL_curcop == &PL_compiling ? PL_hints : PL_curcop->cop_hints)
035b6821
FC
48#define CURRENT_FEATURE_BUNDLE \
49 ((CURRENT_HINTS & HINT_FEATURE_MASK) >> HINT_FEATURE_SHIFT)
d1fd0100 50
9f601cf3
TC
51#define FEATURE_IS_ENABLED_MASK(mask) \
52 ((CURRENT_HINTS & HINT_LOCALIZE_HH) \
53 ? (PL_curcop->cop_features & (mask)) : FALSE)
54
7d058bc9 55/* The longest string we pass in. */
0f2beabb 56#define MAX_FEATURE_LEN (sizeof("bareword_filehandles")-1)
7d058bc9 57
2a4315f8
BF
58#define FEATURE_FC_IS_ENABLED \
59 ( \
2ad792cd 60 (CURRENT_FEATURE_BUNDLE >= FEATURE_BUNDLE_515 && \
31c1155d 61 CURRENT_FEATURE_BUNDLE <= FEATURE_BUNDLE_537) \
2a4315f8 62 || (CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM && \
9f601cf3 63 FEATURE_IS_ENABLED_MASK(FEATURE_FC_BIT)) \
2a4315f8
BF
64 )
65
813e85a0
PE
66#define FEATURE_ISA_IS_ENABLED \
67 ( \
31c1155d
DIM
68 (CURRENT_FEATURE_BUNDLE >= FEATURE_BUNDLE_535 && \
69 CURRENT_FEATURE_BUNDLE <= FEATURE_BUNDLE_537) \
02547a38
PE
70 || (CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM && \
71 FEATURE_IS_ENABLED_MASK(FEATURE_ISA_BIT)) \
813e85a0
PE
72 )
73
03222170
FC
74#define FEATURE_SAY_IS_ENABLED \
75 ( \
76 (CURRENT_FEATURE_BUNDLE >= FEATURE_BUNDLE_510 && \
31c1155d 77 CURRENT_FEATURE_BUNDLE <= FEATURE_BUNDLE_537) \
03222170 78 || (CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM && \
9f601cf3 79 FEATURE_IS_ENABLED_MASK(FEATURE_SAY_BIT)) \
03222170
FC
80 )
81
a1325b90
PE
82#define FEATURE_TRY_IS_ENABLED \
83 ( \
84 CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM && \
85 FEATURE_IS_ENABLED_MASK(FEATURE_TRY_BIT) \
86 )
87
f79e2ff9
PE
88#define FEATURE_DEFER_IS_ENABLED \
89 ( \
90 CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM && \
91 FEATURE_IS_ENABLED_MASK(FEATURE_DEFER_BIT) \
92 )
93
03222170
FC
94#define FEATURE_STATE_IS_ENABLED \
95 ( \
96 (CURRENT_FEATURE_BUNDLE >= FEATURE_BUNDLE_510 && \
31c1155d 97 CURRENT_FEATURE_BUNDLE <= FEATURE_BUNDLE_537) \
03222170 98 || (CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM && \
9f601cf3 99 FEATURE_IS_ENABLED_MASK(FEATURE_STATE_BIT)) \
03222170
FC
100 )
101
102#define FEATURE_SWITCH_IS_ENABLED \
103 ( \
104 (CURRENT_FEATURE_BUNDLE >= FEATURE_BUNDLE_510 && \
401d2aaa 105 CURRENT_FEATURE_BUNDLE <= FEATURE_BUNDLE_527) \
03222170 106 || (CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM && \
9f601cf3 107 FEATURE_IS_ENABLED_MASK(FEATURE_SWITCH_BIT)) \
03222170
FC
108 )
109
cec892e7
FC
110#define FEATURE_BITWISE_IS_ENABLED \
111 ( \
915e574d 112 (CURRENT_FEATURE_BUNDLE >= FEATURE_BUNDLE_527 && \
31c1155d 113 CURRENT_FEATURE_BUNDLE <= FEATURE_BUNDLE_537) \
401d2aaa 114 || (CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM && \
9f601cf3 115 FEATURE_IS_ENABLED_MASK(FEATURE_BITWISE_BIT)) \
cec892e7
FC
116 )
117
0b657b19
DIM
118#define FEATURE_INDIRECT_IS_ENABLED \
119 ( \
cdba169f 120 CURRENT_FEATURE_BUNDLE <= FEATURE_BUNDLE_527 \
0b657b19
DIM
121 || (CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM && \
122 FEATURE_IS_ENABLED_MASK(FEATURE_INDIRECT_BIT)) \
123 )
124
03222170
FC
125#define FEATURE_EVALBYTES_IS_ENABLED \
126 ( \
2ad792cd 127 (CURRENT_FEATURE_BUNDLE >= FEATURE_BUNDLE_515 && \
31c1155d 128 CURRENT_FEATURE_BUNDLE <= FEATURE_BUNDLE_537) \
03222170 129 || (CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM && \
9f601cf3 130 FEATURE_IS_ENABLED_MASK(FEATURE_EVALBYTES_BIT)) \
03222170
FC
131 )
132
30d9c59b
Z
133#define FEATURE_SIGNATURES_IS_ENABLED \
134 ( \
31c1155d
DIM
135 (CURRENT_FEATURE_BUNDLE >= FEATURE_BUNDLE_535 && \
136 CURRENT_FEATURE_BUNDLE <= FEATURE_BUNDLE_537) \
3d1a4f06
PE
137 || (CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM && \
138 FEATURE_IS_ENABLED_MASK(FEATURE_SIGNATURES_BIT)) \
30d9c59b
Z
139 )
140
03222170
FC
141#define FEATURE___SUB___IS_ENABLED \
142 ( \
2ad792cd 143 (CURRENT_FEATURE_BUNDLE >= FEATURE_BUNDLE_515 && \
31c1155d 144 CURRENT_FEATURE_BUNDLE <= FEATURE_BUNDLE_537) \
03222170 145 || (CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM && \
9f601cf3 146 FEATURE_IS_ENABLED_MASK(FEATURE___SUB___BIT)) \
03222170
FC
147 )
148
baabe3fb 149#define FEATURE_REFALIASING_IS_ENABLED \
7b1dc818
FC
150 ( \
151 CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM && \
9f601cf3 152 FEATURE_IS_ENABLED_MASK(FEATURE_REFALIASING_BIT) \
7b1dc818
FC
153 )
154
158becca
FC
155#define FEATURE_POSTDEREF_QQ_IS_ENABLED \
156 ( \
401d2aaa 157 (CURRENT_FEATURE_BUNDLE >= FEATURE_BUNDLE_523 && \
31c1155d 158 CURRENT_FEATURE_BUNDLE <= FEATURE_BUNDLE_537) \
2ad792cd 159 || (CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM && \
9f601cf3 160 FEATURE_IS_ENABLED_MASK(FEATURE_POSTDEREF_QQ_BIT)) \
158becca
FC
161 )
162
03222170
FC
163#define FEATURE_UNIEVAL_IS_ENABLED \
164 ( \
2ad792cd 165 (CURRENT_FEATURE_BUNDLE >= FEATURE_BUNDLE_515 && \
31c1155d 166 CURRENT_FEATURE_BUNDLE <= FEATURE_BUNDLE_537) \
03222170 167 || (CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM && \
9f601cf3 168 FEATURE_IS_ENABLED_MASK(FEATURE_UNIEVAL_BIT)) \
03222170
FC
169 )
170
82d83da3
FC
171#define FEATURE_MYREF_IS_ENABLED \
172 ( \
173 CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM && \
9f601cf3 174 FEATURE_IS_ENABLED_MASK(FEATURE_MYREF_BIT) \
82d83da3
FC
175 )
176
03222170
FC
177#define FEATURE_UNICODE_IS_ENABLED \
178 ( \
179 (CURRENT_FEATURE_BUNDLE >= FEATURE_BUNDLE_511 && \
31c1155d 180 CURRENT_FEATURE_BUNDLE <= FEATURE_BUNDLE_537) \
03222170 181 || (CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM && \
9f601cf3 182 FEATURE_IS_ENABLED_MASK(FEATURE_UNICODE_BIT)) \
03222170
FC
183 )
184
1ad5a39c
TC
185#define FEATURE_MULTIDIMENSIONAL_IS_ENABLED \
186 ( \
cdba169f 187 CURRENT_FEATURE_BUNDLE <= FEATURE_BUNDLE_527 \
1ad5a39c
TC
188 || (CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM && \
189 FEATURE_IS_ENABLED_MASK(FEATURE_MULTIDIMENSIONAL_BIT)) \
190 )
191
0f2beabb
TC
192#define FEATURE_BAREWORD_FILEHANDLES_IS_ENABLED \
193 ( \
eca9683b 194 CURRENT_FEATURE_BUNDLE <= FEATURE_BUNDLE_535 \
0f2beabb
TC
195 || (CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM && \
196 FEATURE_IS_ENABLED_MASK(FEATURE_BAREWORD_FILEHANDLES_BIT)) \
197 )
198
9c9853e8
KW
199#define FEATURE_MORE_DELIMS_IS_ENABLED \
200 ( \
201 CURRENT_FEATURE_BUNDLE == FEATURE_BUNDLE_CUSTOM && \
202 FEATURE_IS_ENABLED_MASK(FEATURE_MORE_DELIMS_BIT) \
203 )
204
03222170 205
9f601cf3
TC
206#define SAVEFEATUREBITS() SAVEI32(PL_compiling.cop_features)
207
208#define CLEARFEATUREBITS() (PL_compiling.cop_features = 0)
209
210#define STOREFEATUREBITSHH(hh) \
211 (hv_stores((hh), "feature/bits", newSVuv(PL_compiling.cop_features)))
212
213#define FETCHFEATUREBITSHH(hh) \
214 STMT_START { \
215 SV **fbsv = hv_fetchs((hh), "feature/bits", FALSE); \
216 PL_compiling.cop_features = fbsv ? SvUV(*fbsv) : 0; \
217 } STMT_END
218
f2c01b15
FC
219#endif /* PERL_CORE or PERL_EXT */
220
4160ddbd
FC
221#ifdef PERL_IN_OP_C
222PERL_STATIC_INLINE void
223S_enable_feature_bundle(pTHX_ SV *ver)
224{
225 SV *comp_ver = sv_newmortal();
226 PL_hints = (PL_hints &~ HINT_FEATURE_MASK)
227 | (
31c1155d
DIM
228 (sv_setnv(comp_ver, 5.037),
229 vcmp(ver, upg_version(comp_ver, FALSE)) >= 0)
230 ? FEATURE_BUNDLE_537 :
915e574d
RS
231 (sv_setnv(comp_ver, 5.035),
232 vcmp(ver, upg_version(comp_ver, FALSE)) >= 0)
233 ? FEATURE_BUNDLE_535 :
401d2aaa
FC
234 (sv_setnv(comp_ver, 5.027),
235 vcmp(ver, upg_version(comp_ver, FALSE)) >= 0)
236 ? FEATURE_BUNDLE_527 :
2ad792cd
AC
237 (sv_setnv(comp_ver, 5.023),
238 vcmp(ver, upg_version(comp_ver, FALSE)) >= 0)
239 ? FEATURE_BUNDLE_523 :
4160ddbd
FC
240 (sv_setnv(comp_ver, 5.015),
241 vcmp(ver, upg_version(comp_ver, FALSE)) >= 0)
242 ? FEATURE_BUNDLE_515 :
243 (sv_setnv(comp_ver, 5.011),
244 vcmp(ver, upg_version(comp_ver, FALSE)) >= 0)
245 ? FEATURE_BUNDLE_511 :
246 (sv_setnv(comp_ver, 5.009005),
247 vcmp(ver, upg_version(comp_ver, FALSE)) >= 0)
248 ? FEATURE_BUNDLE_510 :
249 FEATURE_BUNDLE_DEFAULT
250 ) << HINT_FEATURE_SHIFT;
6389c777
FC
251 /* special case */
252 assert(PL_curcop == &PL_compiling);
253 if (FEATURE_UNICODE_IS_ENABLED) PL_hints |= HINT_UNI_8_BIT;
254 else PL_hints &= ~HINT_UNI_8_BIT;
4160ddbd
FC
255}
256#endif /* PERL_IN_OP_C */
257
b34c1a7e
TC
258#ifdef PERL_IN_MG_C
259
260#define magic_sethint_feature(keysv, keypv, keylen, valsv, valbool) \
261 S_magic_sethint_feature(aTHX_ (keysv), (keypv), (keylen), (valsv), (valbool))
262PERL_STATIC_INLINE void
263S_magic_sethint_feature(pTHX_ SV *keysv, const char *keypv, STRLEN keylen,
264 SV *valsv, bool valbool) {
265 if (keysv)
266 keypv = SvPV_const(keysv, keylen);
267
268 if (memBEGINs(keypv, keylen, "feature_")) {
269 const char *subf = keypv + (sizeof("feature_")-1);
270 U32 mask = 0;
271 switch (*subf) {
272 case '_':
273 if (keylen == sizeof("feature___SUB__")-1
274 && memcmp(subf+1, "_SUB__", keylen - sizeof("feature_")) == 0) {
275 mask = FEATURE___SUB___BIT;
276 break;
277 }
278 return;
279
280 case 'b':
0f2beabb
TC
281 if (keylen == sizeof("feature_bareword_filehandles")-1
282 && memcmp(subf+1, "areword_filehandles", keylen - sizeof("feature_")) == 0) {
283 mask = FEATURE_BAREWORD_FILEHANDLES_BIT;
284 break;
285 }
286 else if (keylen == sizeof("feature_bitwise")-1
b34c1a7e
TC
287 && memcmp(subf+1, "itwise", keylen - sizeof("feature_")) == 0) {
288 mask = FEATURE_BITWISE_BIT;
289 break;
290 }
291 return;
292
f79e2ff9
PE
293 case 'd':
294 if (keylen == sizeof("feature_defer")-1
295 && memcmp(subf+1, "efer", keylen - sizeof("feature_")) == 0) {
296 mask = FEATURE_DEFER_BIT;
297 break;
298 }
299 return;
300
b34c1a7e
TC
301 case 'e':
302 if (keylen == sizeof("feature_evalbytes")-1
303 && memcmp(subf+1, "valbytes", keylen - sizeof("feature_")) == 0) {
304 mask = FEATURE_EVALBYTES_BIT;
305 break;
306 }
307 return;
308
309 case 'f':
310 if (keylen == sizeof("feature_fc")-1
311 && memcmp(subf+1, "c", keylen - sizeof("feature_")) == 0) {
312 mask = FEATURE_FC_BIT;
313 break;
314 }
315 return;
316
813e85a0 317 case 'i':
0b657b19
DIM
318 if (keylen == sizeof("feature_indirect")-1
319 && memcmp(subf+1, "ndirect", keylen - sizeof("feature_")) == 0) {
320 mask = FEATURE_INDIRECT_BIT;
321 break;
322 }
323 else if (keylen == sizeof("feature_isa")-1
813e85a0
PE
324 && memcmp(subf+1, "sa", keylen - sizeof("feature_")) == 0) {
325 mask = FEATURE_ISA_BIT;
326 break;
327 }
328 return;
329
b34c1a7e 330 case 'm':
9c9853e8
KW
331 if (keylen == sizeof("feature_more_delims")-1
332 && memcmp(subf+1, "ore_delims", keylen - sizeof("feature_")) == 0) {
333 mask = FEATURE_MORE_DELIMS_BIT;
334 break;
335 }
336 else if (keylen == sizeof("feature_multidimensional")-1
1ad5a39c
TC
337 && memcmp(subf+1, "ultidimensional", keylen - sizeof("feature_")) == 0) {
338 mask = FEATURE_MULTIDIMENSIONAL_BIT;
339 break;
340 }
341 else if (keylen == sizeof("feature_myref")-1
b34c1a7e
TC
342 && memcmp(subf+1, "yref", keylen - sizeof("feature_")) == 0) {
343 mask = FEATURE_MYREF_BIT;
344 break;
345 }
346 return;
347
348 case 'p':
349 if (keylen == sizeof("feature_postderef_qq")-1
350 && memcmp(subf+1, "ostderef_qq", keylen - sizeof("feature_")) == 0) {
351 mask = FEATURE_POSTDEREF_QQ_BIT;
352 break;
353 }
354 return;
355
356 case 'r':
357 if (keylen == sizeof("feature_refaliasing")-1
358 && memcmp(subf+1, "efaliasing", keylen - sizeof("feature_")) == 0) {
359 mask = FEATURE_REFALIASING_BIT;
360 break;
361 }
362 return;
363
364 case 's':
365 if (keylen == sizeof("feature_say")-1
366 && memcmp(subf+1, "ay", keylen - sizeof("feature_")) == 0) {
367 mask = FEATURE_SAY_BIT;
368 break;
369 }
370 else if (keylen == sizeof("feature_signatures")-1
371 && memcmp(subf+1, "ignatures", keylen - sizeof("feature_")) == 0) {
372 mask = FEATURE_SIGNATURES_BIT;
373 break;
374 }
375 else if (keylen == sizeof("feature_state")-1
376 && memcmp(subf+1, "tate", keylen - sizeof("feature_")) == 0) {
377 mask = FEATURE_STATE_BIT;
378 break;
379 }
380 else if (keylen == sizeof("feature_switch")-1
381 && memcmp(subf+1, "witch", keylen - sizeof("feature_")) == 0) {
382 mask = FEATURE_SWITCH_BIT;
383 break;
384 }
385 return;
386
a1325b90
PE
387 case 't':
388 if (keylen == sizeof("feature_try")-1
389 && memcmp(subf+1, "ry", keylen - sizeof("feature_")) == 0) {
390 mask = FEATURE_TRY_BIT;
391 break;
392 }
393 return;
394
b34c1a7e
TC
395 case 'u':
396 if (keylen == sizeof("feature_unicode")-1
397 && memcmp(subf+1, "nicode", keylen - sizeof("feature_")) == 0) {
398 mask = FEATURE_UNICODE_BIT;
399 break;
400 }
401 else if (keylen == sizeof("feature_unieval")-1
402 && memcmp(subf+1, "nieval", keylen - sizeof("feature_")) == 0) {
403 mask = FEATURE_UNIEVAL_BIT;
404 break;
405 }
406 return;
407
408 default:
409 return;
410 }
411 if (valsv ? SvTRUE(valsv) : valbool)
412 PL_compiling.cop_features |= mask;
413 else
414 PL_compiling.cop_features &= ~mask;
415 }
416}
417#endif /* PERL_IN_MG_C */
418
3dd7db29
JK
419#endif /* PERL_FEATURE_H_ */
420
f2c01b15 421/* ex: set ro: */