Debian Codegraph @

upstream/opensuse-tumbleweed/man1/perlintern.1

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 "PERLINTERN 1"
61 .TH PERLINTERN 1 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 perlintern \- autogenerated documentation of purely internal
68 Perl functions
69 .SH DESCRIPTION
70 .IX Xref "internal Perl functions interpreter functions"
71 .IX Header "DESCRIPTION"
72 This file is the autogenerated documentation of functions in the
73 Perl interpreter that are documented using Perl\*(Aqs internal documentation
74 format but are not marked as part of the Perl API. In other words,
75 \&\fBthey are not for use in extensions\fR!
76 .PP
77 It has the same sections as perlapi, though some may be empty.
78 .SH "AV Handling"
79 .IX Header "AV Handling"
80 .ie n .IP """av_fetch_simple""" 4
81 .el .IP \f(CWav_fetch_simple\fR 4
82 .IX Xref "av_fetch_simple"
83 .IX Item "av_fetch_simple"
84 This is a cut\-down version of av_fetch that assumes that the array is
85 very straightforward \- no magic, not readonly, and AvREAL \- and that
86 \&\f(CW\*(C`key\*(C'\fR is not negative. This function MUST NOT be used in situations
87 where any of those assumptions may not hold.
88 .Sp
89 Returns the SV at the specified index in the array. The \f(CW\*(C`key\*(C'\fR is the
90 index. If lval is true, you are guaranteed to get a real SV back (in case
91 it wasn\*(Aqt real before), which you can then modify. Check that the return
92 value is non\-null before dereferencing it to a \f(CW\*(C`SV*\*(C'\fR.
93 .Sp
94 The rough perl equivalent is \f(CW$myarray[$key]\fR.
95 .RS 4
96 .Sp
97 .Vb 2
98 \& SV ** av_fetch_simple( AV *av, SSize_t key, I32 lval)
99 \& SV ** Perl_av_fetch_simple(pTHX_ AV *av, SSize_t key, I32 lval)
100 .Ve
101 .RE
102 .RS 4
103 .RE
104 .ie n .IP """av_new_alloc""" 4
105 .el .IP \f(CWav_new_alloc\fR 4
106 .IX Xref "av_new_alloc"
107 .IX Item "av_new_alloc"
108 This implements "\f(CW\*(C`newAV_alloc_x\*(C'\fR" in perlapi
109 and "\f(CW\*(C`newAV_alloc_xz\*(C'\fR" in perlapi, which are the public API for this
110 functionality.
111 .Sp
112 Creates a new AV and allocates its SV* array.
113 .Sp
114 This is similar to, but more efficient than doing:
115 .Sp
116 .Vb 2
117 \& AV *av = newAV();
118 \& av_extend(av, key);
119 .Ve
120 .Sp
121 The size parameter is used to pre\-allocate a SV* array large enough to
122 hold at least elements \f(CW\*(C`0..(size\-1)\*(C'\fR. \f(CW\*(C`size\*(C'\fR must be at least 1.
123 .Sp
124 The \f(CW\*(C`zeroflag\*(C'\fR parameter controls whether or not the array is NULL
125 initialized.
126 .RS 4
127 .Sp
128 .Vb 2
129 \& AV * av_new_alloc( SSize_t size, bool zeroflag)
130 \& AV * Perl_av_new_alloc(pTHX_ SSize_t size, bool zeroflag)
131 .Ve
132 .RE
133 .RS 4
134 .RE
135 .ie n .IP """av_store_simple""" 4
136 .el .IP \f(CWav_store_simple\fR 4
137 .IX Xref "av_store_simple"
138 .IX Item "av_store_simple"
139 This is a cut\-down version of av_store that assumes that the array is
140 very straightforward \- no magic, not readonly, and AvREAL \- and that
141 \&\f(CW\*(C`key\*(C'\fR is not negative. This function MUST NOT be used in situations
142 where any of those assumptions may not hold.
143 .Sp
144 Stores an SV in an array. The array index is specified as \f(CW\*(C`key\*(C'\fR. It
145 can be dereferenced to get the \f(CW\*(C`SV*\*(C'\fR that was stored there (= \f(CW\*(C`val\*(C'\fR)).
146 .Sp
147 Note that the caller is responsible for suitably incrementing the reference
148 count of \f(CW\*(C`val\*(C'\fR before the call.
149 .Sp
150 Approximate Perl equivalent: \f(CW\*(C`splice(@myarray, $key, 1, $val)\*(C'\fR.
151 .RS 4
152 .Sp
153 .Vb 2
154 \& SV ** av_store_simple( AV *av, SSize_t key, SV *val)
155 \& SV ** Perl_av_store_simple(pTHX_ AV *av, SSize_t key, SV *val)
156 .Ve
157 .RE
158 .RS 4
159 .RE
160 .ie n .IP """AvFILLp""" 4
161 .el .IP \f(CWAvFILLp\fR 4
162 .IX Xref "AvFILLp"
163 .IX Item "AvFILLp"
164 If the array \f(CW\*(C`av\*(C'\fR is empty, this returns \-1; otherwise it returns the maximum
165 value of the indices of all the array elements which are currently defined in
166 \&\f(CW\*(C`av\*(C'\fR. It does not handle magic, hence the \f(CW\*(C`p\*(C'\fR private indication in its name.
167 .RS 4
168 .Sp
169 .Vb 1
170 \& SSize_t AvFILLp(AV* av)
171 .Ve
172 .RE
173 .RS 4
174 .RE
175 .SH "Callback Functions"
176 .IX Header "Callback Functions"
177 .ie n .IP """dowantarray""" 4
178 .el .IP \f(CWdowantarray\fR 4
179 .IX Xref "dowantarray"
180 .IX Item "dowantarray"
181 \&\f(CW\*(C`\fR\f(CBDEPRECATED!\fR\f(CW\*(C'\fR It is planned to remove \f(CW\*(C`dowantarray\*(C'\fR
182 from a future release of Perl. Do not use it for
183 new code; remove it from existing code.
184 .Sp
185 Implements the deprecated "\f(CW\*(C`GIMME\*(C'\fR" in perlapi.
186 .RS 4
187 .Sp
188 .Vb 2
189 \& U8 dowantarray()
190 \& U8 Perl_dowantarray(pTHX)
191 .Ve
192 .RE
193 .RS 4
194 .RE
195 .ie n .IP """leave_scope""" 4
196 .el .IP \f(CWleave_scope\fR 4
197 .IX Xref "leave_scope"
198 .IX Item "leave_scope"
199 Implements \f(CW\*(C`LEAVE_SCOPE\*(C'\fR which you should use instead.
200 .RS 4
201 .Sp
202 .Vb 2
203 \& void leave_scope( I32 base)
204 \& void Perl_leave_scope(pTHX_ I32 base)
205 .Ve
206 .RE
207 .RS 4
208 .RE
209 .ie n .IP """magic_freedestruct""" 4
210 .el .IP \f(CWmagic_freedestruct\fR 4
211 .IX Xref "magic_freedestruct"
212 .IX Item "magic_freedestruct"
213 This function is called via magic to implement the
214 \&\f(CWmortal_destructor_sv()\fR and \f(CWmortal_destructor_x()\fR functions. It
215 should not be called directly and has no user serviceable parts.
216 .RS 4
217 .Sp
218 .Vb 2
219 \& int magic_freedestruct( SV *sv, MAGIC *mg)
220 \& int Perl_magic_freedestruct(pTHX_ SV *sv, MAGIC *mg)
221 .Ve
222 .RE
223 .RS 4
224 .RE
225 .ie n .IP """mortal_svfunc_x""" 4
226 .el .IP \f(CWmortal_svfunc_x\fR 4
227 .IX Xref "mortal_svfunc_x"
228 .IX Item "mortal_svfunc_x"
229 This function arranges for a C function reference to be called at the
230 \&\fBend of the current statement\fR with the arguments provided. It is a
231 wrapper around \f(CWmortal_destructor_sv()\fR which ensures that the latter
232 function is called appropriately.
233 .Sp
234 Be aware that there is a significant difference in timing between the
235 \&\fIend of the current statement\fR and the \fIend of the current pseudo
236 block\fR. If you are looking for a mechanism to trigger a function at the
237 end of the \fBcurrent pseudo block\fR you should look at
238 "\f(CW\*(C`SAVEDESTRUCTOR_X\*(C'\fR" in perlapi instead of this function.
239 .RS 4
240 .Sp
241 .Vb 2
242 \& void mortal_svfunc_x( SVFUNC_t f, SV *p)
243 \& void Perl_mortal_svfunc_x(pTHX_ SVFUNC_t f, SV *p)
244 .Ve
245 .RE
246 .RS 4
247 .RE
248 .ie n .IP """pop_scope""" 4
249 .el .IP \f(CWpop_scope\fR 4
250 .IX Xref "pop_scope"
251 .IX Item "pop_scope"
252 Implements "\f(CW\*(C`LEAVE\*(C'\fR" in perlapi
253 .RS 4
254 .Sp
255 .Vb 2
256 \& void pop_scope()
257 \& void Perl_pop_scope(pTHX)
258 .Ve
259 .RE
260 .RS 4
261 .RE
262 .ie n .IP """push_scope""" 4
263 .el .IP \f(CWpush_scope\fR 4
264 .IX Xref "push_scope"
265 .IX Item "push_scope"
266 Implements "\f(CW\*(C`ENTER\*(C'\fR" in perlapi
267 .RS 4
268 .Sp
269 .Vb 2
270 \& void push_scope()
271 \& void Perl_push_scope(pTHX)
272 .Ve
273 .RE
274 .RS 4
275 .RE
276 .ie n .IP """save_adelete""" 4
277 .el .IP \f(CWsave_adelete\fR 4
278 .IX Xref "save_adelete"
279 .IX Item "save_adelete"
280 Implements \f(CW\*(C`SAVEADELETE\*(C'\fR.
281 .RS 4
282 .Sp
283 .Vb 2
284 \& void save_adelete( AV *av, SSize_t key)
285 \& void Perl_save_adelete(pTHX_ AV *av, SSize_t key)
286 .Ve
287 .RE
288 .RS 4
289 .RE
290 .ie n .IP """save_freercpv""" 4
291 .el .IP \f(CWsave_freercpv\fR 4
292 .IX Xref "save_freercpv"
293 .IX Item "save_freercpv"
294 Implements \f(CW\*(C`SAVEFREERCPV\*(C'\fR.
295 .Sp
296 Saves and frees a refcounted string. Calls \fBrcpv_free()\fR
297 on the argument when the current pseudo block is finished.
298 .RS 4
299 .Sp
300 .Vb 2
301 \& void save_freercpv( char *rcpv)
302 \& void Perl_save_freercpv(pTHX_ char *rcpv)
303 .Ve
304 .RE
305 .RS 4
306 .RE
307 .ie n .IP """save_generic_pvref""" 4
308 .el .IP \f(CWsave_generic_pvref\fR 4
309 .IX Xref "save_generic_pvref"
310 .IX Item "save_generic_pvref"
311 Implements \f(CW\*(C`SAVEGENERICPV\*(C'\fR.
312 .Sp
313 Like \fBsave_pptr()\fR, but also \fBSafefree()\fRs the new value if it is different
314 from the old one. Can be used to restore a global char* to its prior
315 contents, freeing new value.
316 .RS 4
317 .Sp
318 .Vb 2
319 \& void save_generic_pvref( char **str)
320 \& void Perl_save_generic_pvref(pTHX_ char **str)
321 .Ve
322 .RE
323 .RS 4
324 .RE
325 .ie n .IP """save_generic_svref""" 4
326 .el .IP \f(CWsave_generic_svref\fR 4
327 .IX Xref "save_generic_svref"
328 .IX Item "save_generic_svref"
329 Implements \f(CW\*(C`SAVEGENERICSV\*(C'\fR.
330 .Sp
331 Like \fBsave_sptr()\fR, but also \fBSvREFCNT_dec()\fRs the new value. Can be used to
332 restore a global SV to its prior contents, freeing new value.
333 .RS 4
334 .Sp
335 .Vb 2
336 \& void save_generic_svref( SV **sptr)
337 \& void Perl_save_generic_svref(pTHX_ SV **sptr)
338 .Ve
339 .RE
340 .RS 4
341 .RE
342 .ie n .IP """save_hdelete""" 4
343 .el .IP \f(CWsave_hdelete\fR 4
344 .IX Xref "save_hdelete"
345 .IX Item "save_hdelete"
346 Implements \f(CW\*(C`SAVEHDELETE\*(C'\fR.
347 .RS 4
348 .Sp
349 .Vb 2
350 \& void save_hdelete( HV *hv, SV *keysv)
351 \& void Perl_save_hdelete(pTHX_ HV *hv, SV *keysv)
352 .Ve
353 .RE
354 .RS 4
355 .RE
356 .ie n .IP """save_hints""" 4
357 .el .IP \f(CWsave_hints\fR 4
358 .IX Xref "save_hints"
359 .IX Item "save_hints"
360 Implements \f(CW\*(C`SAVEHINTS\*(C'\fR.
361 .RS 4
362 .Sp
363 .Vb 2
364 \& void save_hints()
365 \& void Perl_save_hints(pTHX)
366 .Ve
367 .RE
368 .RS 4
369 .RE
370 .ie n .IP """save_op""" 4
371 .el .IP \f(CWsave_op\fR 4
372 .IX Xref "save_op"
373 .IX Item "save_op"
374 Implements \f(CW\*(C`SAVEOP\*(C'\fR.
375 .RS 4
376 .Sp
377 .Vb 2
378 \& void save_op()
379 \& void Perl_save_op(pTHX)
380 .Ve
381 .RE
382 .RS 4
383 .RE
384 .ie n .IP """save_padsv_and_mortalize""" 4
385 .el .IP \f(CWsave_padsv_and_mortalize\fR 4
386 .IX Xref "save_padsv_and_mortalize"
387 .IX Item "save_padsv_and_mortalize"
388 Implements \f(CW\*(C`SAVEPADSVANDMORTALIZE\*(C'\fR.
389 .RS 4
390 .Sp
391 .Vb 2
392 \& void save_padsv_and_mortalize( PADOFFSET off)
393 \& void Perl_save_padsv_and_mortalize(pTHX_ PADOFFSET off)
394 .Ve
395 .RE
396 .RS 4
397 .RE
398 .ie n .IP """save_pushptr""" 4
399 .el .IP \f(CWsave_pushptr\fR 4
400 .IX Xref "save_pushptr"
401 .IX Item "save_pushptr"
402 The refcnt of object \f(CW\*(C`ptr\*(C'\fR will be decremented at the end of the current
403 \&\fIpseudo\-block\fR. \f(CW\*(C`type\*(C'\fR gives the type of \f(CW\*(C`ptr\*(C'\fR, expressed as one of the
404 constants in \fIscope.h\fR whose name begins with \f(CW\*(C`SAVEt_\*(C'\fR.
405 .Sp
406 This is the underlying implementation of several macros, like
407 \&\f(CW\*(C`SAVEFREESV\*(C'\fR.
408 .RS 4
409 .Sp
410 .Vb 2
411 \& void save_pushptr( void * const ptr, const int type)
412 \& void Perl_save_pushptr(pTHX_ void * const ptr, const int type)
413 .Ve
414 .RE
415 .RS 4
416 .RE
417 .ie n .IP """save_rcpv""" 4
418 .el .IP \f(CWsave_rcpv\fR 4
419 .IX Xref "save_rcpv"
420 .IX Item "save_rcpv"
421 Implements \f(CW\*(C`SAVERCPV\*(C'\fR.
422 .Sp
423 Saves and restores a refcounted string, similar to what
424 save_generic_svref would do for a SV*. Can be used to restore
425 a refcounted string to its previous state. Performs the
426 appropriate refcount counting so that nothing should leak
427 or be prematurely freed.
428 .RS 4
429 .Sp
430 .Vb 2
431 \& void save_rcpv( char **prcpv)
432 \& void Perl_save_rcpv(pTHX_ char **prcpv)
433 .Ve
434 .RE
435 .RS 4
436 .RE
437 .ie n .IP """save_scalar_at""" 4
438 .el .IP \f(CWsave_scalar_at\fR 4
439 .IX Xref "save_scalar_at"
440 .IX Item "save_scalar_at"
441 A helper function for localizing the SV referenced by \f(CW*sptr\fR.
442 .Sp
443 If \f(CW\*(C`SAVEf_KEEPOLDELEM\*(C'\fR is set in in \f(CW\*(C`flags\*(C'\fR, the function returns the input
444 scalar untouched.
445 .Sp
446 Otherwise it replaces \f(CW*sptr\fR with a new \f(CW\*(C`undef\*(C'\fR scalar, and returns that.
447 The new scalar will have the old one\*(Aqs magic (if any) copied to it.
448 If there is such magic, and \f(CW\*(C`SAVEf_SETMAGIC\*(C'\fR is set in in \f(CW\*(C`flags\*(C'\fR, \*(Aqset\*(Aq
449 magic will be processed on the new scalar. If unset, \*(Aqset\*(Aq magic will be
450 skipped. The latter typically means that assignment will soon follow (\fIe.g.\fR,
451 \&\f(CW\*(Aqlocal\ $x\ =\ $y\*(Aq\fR), and that will handle the magic.
452 .RS 4
453 .Sp
454 .Vb 1
455 \& SV * save_scalar_at(SV **sptr, const U32 flags)
456 .Ve
457 .RE
458 .RS 4
459 .RE
460 .ie n .IP """save_set_svflags""" 4
461 .el .IP \f(CWsave_set_svflags\fR 4
462 .IX Xref "save_set_svflags"
463 .IX Item "save_set_svflags"
464 Implements \f(CW\*(C`SAVESETSVFLAGS\*(C'\fR.
465 .Sp
466 Set the SvFLAGS specified by mask to the values in val
467 .RS 4
468 .Sp
469 .Vb 2
470 \& void save_set_svflags( SV *sv, U32 mask, U32 val)
471 \& void Perl_save_set_svflags(pTHX_ SV *sv, U32 mask, U32 val)
472 .Ve
473 .RE
474 .RS 4
475 .RE
476 .ie n .IP """save_shared_pvref""" 4
477 .el .IP \f(CWsave_shared_pvref\fR 4
478 .IX Xref "save_shared_pvref"
479 .IX Item "save_shared_pvref"
480 Implements \f(CW\*(C`SAVESHAREDPV\*(C'\fR.
481 .Sp
482 Like \fBsave_generic_pvref()\fR, but uses \fBPerlMemShared_free()\fR rather than \fBSafefree()\fR.
483 Can be used to restore a shared global char* to its prior
484 contents, freeing new value.
485 .RS 4
486 .Sp
487 .Vb 2
488 \& void save_shared_pvref( char **str)
489 \& void Perl_save_shared_pvref(pTHX_ char **str)
490 .Ve
491 .RE
492 .RS 4
493 .RE
494 .ie n .IP """save_vptr""" 4
495 .el .IP \f(CWsave_vptr\fR 4
496 .IX Xref "save_vptr"
497 .IX Item "save_vptr"
498 Implements \f(CW\*(C`SAVEVPTR\*(C'\fR.
499 .RS 4
500 .Sp
501 .Vb 2
502 \& void save_vptr( void *ptr)
503 \& void Perl_save_vptr(pTHX_ void *ptr)
504 .Ve
505 .RE
506 .RS 4
507 .RE
508 .SH Casting
509 .IX Xref "NUM2PTR"
510 .IX Header "Casting"
511 There are currently no internal API items in Casting
512 .SH "Character case changing"
513 .IX Header "Character case changing"
514 There are currently no internal API items in Character case changing
515 .SH "Character classification"
516 .IX Header "Character classification"
517 There are currently no internal API items in Character classification
518 .SH "Compiler and Preprocessor information"
519 .IX Header "Compiler and Preprocessor information"
520 There are currently no internal API items in Compiler and Preprocessor information
521 .SH "Compiler directives"
522 .IX Header "Compiler directives"
523 There are currently no internal API items in Compiler directives
524 .SH "Compile\-time scope hooks"
525 .IX Header "Compile-time scope hooks"
526 .ie n .IP """BhkENTRY""" 4
527 .el .IP \f(CWBhkENTRY\fR 4
528 .IX Xref "BhkENTRY"
529 .IX Item "BhkENTRY"
530 NOTE: \f(CW\*(C`BhkENTRY\*(C'\fR is \fBexperimental\fR and may change or be
531 removed without notice.
532 .Sp
533 Return an entry from the BHK structure. \f(CW\*(C`which\*(C'\fR is a preprocessor token
534 indicating which entry to return. If the appropriate flag is not set
535 this will return \f(CW\*(C`NULL\*(C'\fR. The type of the return value depends on which
536 entry you ask for.
537 .RS 4
538 .Sp
539 .Vb 1
540 \& void * BhkENTRY(BHK *hk, token which)
541 .Ve
542 .RE
543 .RS 4
544 .RE
545 .ie n .IP """BhkFLAGS""" 4
546 .el .IP \f(CWBhkFLAGS\fR 4
547 .IX Xref "BhkFLAGS"
548 .IX Item "BhkFLAGS"
549 NOTE: \f(CW\*(C`BhkFLAGS\*(C'\fR is \fBexperimental\fR and may change or be
550 removed without notice.
551 .Sp
552 Return the BHK\*(Aqs flags.
553 .RS 4
554 .Sp
555 .Vb 1
556 \& U32 BhkFLAGS(BHK *hk)
557 .Ve
558 .RE
559 .RS 4
560 .RE
561 .ie n .IP """CALL_BLOCK_HOOKS""" 4
562 .el .IP \f(CWCALL_BLOCK_HOOKS\fR 4
563 .IX Xref "CALL_BLOCK_HOOKS"
564 .IX Item "CALL_BLOCK_HOOKS"
565 NOTE: \f(CW\*(C`CALL_BLOCK_HOOKS\*(C'\fR is \fBexperimental\fR and may change or be
566 removed without notice.
567 .Sp
568 Call all the registered block hooks for type \f(CW\*(C`which\*(C'\fR. \f(CW\*(C`which\*(C'\fR is a
569 preprocessing token; the type of \f(CW\*(C`arg\*(C'\fR depends on \f(CW\*(C`which\*(C'\fR.
570 .RS 4
571 .Sp
572 .Vb 1
573 \& void CALL_BLOCK_HOOKS(token which, arg)
574 .Ve
575 .RE
576 .RS 4
577 .RE
578 .SH Concurrency
579 .IX Header "Concurrency"
580 .ie n .IP """CVf_SLABBED""" 4
581 .el .IP \f(CWCVf_SLABBED\fR 4
582 .IX Item "CVf_SLABBED"
583 .PD 0
584 .ie n .IP """CvROOT""" 4
585 .el .IP \f(CWCvROOT\fR 4
586 .IX Item "CvROOT"
587 .ie n .IP """CvSTART""" 4
588 .el .IP \f(CWCvSTART\fR 4
589 .IX Item "CvSTART"
590 .ie n .IP """CX_CUR""" 4
591 .el .IP \f(CWCX_CUR\fR 4
592 .IX Item "CX_CUR"
593 .ie n .IP """CX_LEAVE_SCOPE""" 4
594 .el .IP \f(CWCX_LEAVE_SCOPE\fR 4
595 .IX Item "CX_LEAVE_SCOPE"
596 .ie n .IP """CX_POP""" 4
597 .el .IP \f(CWCX_POP\fR 4
598 .IX Item "CX_POP"
599 .ie n .IP """cx_type""" 4
600 .el .IP \f(CWcx_type\fR 4
601 .IX Item "cx_type"
602 .ie n .IP """CXINC""" 4
603 .el .IP \f(CWCXINC\fR 4
604 .IX Item "CXINC"
605 .ie n .IP """cxstack""" 4
606 .el .IP \f(CWcxstack\fR 4
607 .IX Item "cxstack"
608 .ie n .IP """cxstack_ix""" 4
609 .el .IP \f(CWcxstack_ix\fR 4
610 .IX Item "cxstack_ix"
611 .ie n .IP """CXt_BLOCK""" 4
612 .el .IP \f(CWCXt_BLOCK\fR 4
613 .IX Item "CXt_BLOCK"
614 .ie n .IP """CXt_EVAL""" 4
615 .el .IP \f(CWCXt_EVAL\fR 4
616 .IX Item "CXt_EVAL"
617 .ie n .IP """CXt_FORMAT""" 4
618 .el .IP \f(CWCXt_FORMAT\fR 4
619 .IX Item "CXt_FORMAT"
620 .ie n .IP """CXt_GIVEN""" 4
621 .el .IP \f(CWCXt_GIVEN\fR 4
622 .IX Item "CXt_GIVEN"
623 .ie n .IP """CXt_LOOP_ARY""" 4
624 .el .IP \f(CWCXt_LOOP_ARY\fR 4
625 .IX Item "CXt_LOOP_ARY"
626 .ie n .IP """CXt_LOOP_LAZYIV""" 4
627 .el .IP \f(CWCXt_LOOP_LAZYIV\fR 4
628 .IX Item "CXt_LOOP_LAZYIV"
629 .ie n .IP """CXt_LOOP_LAZYSV""" 4
630 .el .IP \f(CWCXt_LOOP_LAZYSV\fR 4
631 .IX Item "CXt_LOOP_LAZYSV"
632 .ie n .IP """CXt_LOOP_LIST""" 4
633 .el .IP \f(CWCXt_LOOP_LIST\fR 4
634 .IX Item "CXt_LOOP_LIST"
635 .ie n .IP """CXt_LOOP_PLAIN""" 4
636 .el .IP \f(CWCXt_LOOP_PLAIN\fR 4
637 .IX Item "CXt_LOOP_PLAIN"
638 .ie n .IP """CXt_NULL""" 4
639 .el .IP \f(CWCXt_NULL\fR 4
640 .IX Item "CXt_NULL"
641 .ie n .IP """CXt_SUB""" 4
642 .el .IP \f(CWCXt_SUB\fR 4
643 .IX Item "CXt_SUB"
644 .ie n .IP """CXt_SUBST""" 4
645 .el .IP \f(CWCXt_SUBST\fR 4
646 .IX Item "CXt_SUBST"
647 .ie n .IP """CXt_WHEN""" 4
648 .el .IP \f(CWCXt_WHEN\fR 4
649 .IX Item "CXt_WHEN"
650 .ie n .IP """dounwind""" 4
651 .el .IP \f(CWdounwind\fR 4
652 .IX Item "dounwind"
653 .PD
654 Described in perlguts.
655 .RS 4
656 .Sp
657 .Vb 9
658 \& OP * CvROOT ( CV * sv)
659 \& OP * CvSTART ( CV * sv)
660 \& CX_CUR ()
661 \& void CX_LEAVE_SCOPE( PERL_CONTEXT* cx)
662 \& void CX_POP ( PERL_CONTEXT* cx)
663 \& PERL_CONTEXT * cxstack
664 \& I32 cxstack_ix
665 \& void dounwind ( I32 cxix)
666 \& void Perl_dounwind (pTHX_ I32 cxix)
667 .Ve
668 .RE
669 .RS 4
670 .RE
671 .ie n .IP """my_fork""" 4
672 .el .IP \f(CWmy_fork\fR 4
673 .IX Xref "my_fork"
674 .IX Item "my_fork"
675 This is for the use of \f(CW\*(C`PerlProc_fork\*(C'\fR as a wrapper for the C library
676 \&\fBfork\fR\|(2) on some platforms to hide some platform quirks. It should not be
677 used except through \f(CW\*(C`PerlProc_fork\*(C'\fR.
678 .RS 4
679 .Sp
680 .Vb 2
681 \& Pid_t my_fork()
682 \& Pid_t Perl_my_fork()
683 .Ve
684 .RE
685 .RS 4
686 .RE
687 .ie n .IP """PERL_CONTEXT""" 4
688 .el .IP \f(CWPERL_CONTEXT\fR 4
689 .IX Item "PERL_CONTEXT"
690 Described in perlguts.
691 .SH "COPs and Hint Hashes"
692 .IX Header "COPs and Hint Hashes"
693 There are currently no internal API items in COPs and Hint Hashes
694 .SH "Custom Operators"
695 .IX Header "Custom Operators"
696 .ie n .IP """core_prototype""" 4
697 .el .IP \f(CWcore_prototype\fR 4
698 .IX Xref "core_prototype"
699 .IX Item "core_prototype"
700 This function assigns the prototype of the named core function to \f(CW\*(C`sv\*(C'\fR, or
701 to a new mortal SV if \f(CW\*(C`sv\*(C'\fR is \f(CW\*(C`NULL\*(C'\fR. It returns the modified \f(CW\*(C`sv\*(C'\fR, or
702 \&\f(CW\*(C`NULL\*(C'\fR if the core function has no prototype. \f(CW\*(C`code\*(C'\fR is a code as returned
703 by \f(CWkeyword()\fR. It must not be equal to 0.
704 .RS 4
705 .Sp
706 .Vb 6
707 \& SV * core_prototype( SV *sv, const char *name,
708 \& const int code,
709 \& int * const opnum)
710 \& SV * Perl_core_prototype(pTHX_ SV *sv, const char *name,
711 \& const int code,
712 \& int * const opnum)
713 .Ve
714 .RE
715 .RS 4
716 .RE
717 .SH "CV Handling"
718 .IX Header "CV Handling"
719 .ie n .IP """CvREFCOUNTED_ANYSV""" 4
720 .el .IP \f(CWCvREFCOUNTED_ANYSV\fR 4
721 .IX Xref "CvREFCOUNTED_ANYSV"
722 .IX Item "CvREFCOUNTED_ANYSV"
723 If true, indicates that the \f(CW\*(C`CvXSUBANY(cv).any_sv\*(C'\fR member contains an SV
724 pointer whose reference count should be decremented when the CV itself is
725 freed. In addition, \f(CWcv_clone()\fR will increment the reference count, and
726 \&\f(CWsv_dup()\fR will duplicate the entire pointed\-to SV if this flag is set.
727 .Sp
728 Any CV that wraps an XSUB has an \f(CW\*(C`ANY\*(C'\fR union that the XSUB function is free
729 to use for its own purposes. It may be the case that the code wishes to store
730 an SV in the \f(CW\*(C`any_sv\*(C'\fR member of this union. By setting this flag, this SV
731 reference will be properly reclaimed or duplicated when the CV itself is.
732 .RS 4
733 .Sp
734 .Vb 1
735 \& bool CvREFCOUNTED_ANYSV(CV *cv)
736 .Ve
737 .RE
738 .RS 4
739 .RE
740 .ie n .IP """CvREFCOUNTED_ANYSV_off""" 4
741 .el .IP \f(CWCvREFCOUNTED_ANYSV_off\fR 4
742 .IX Xref "CvREFCOUNTED_ANYSV_off"
743 .IX Item "CvREFCOUNTED_ANYSV_off"
744 Helper macro to turn off the \f(CW\*(C`CvREFCOUNTED_ANYSV\*(C'\fR flag.
745 .RS 4
746 .Sp
747 .Vb 1
748 \& void CvREFCOUNTED_ANYSV_off(CV *cv)
749 .Ve
750 .RE
751 .RS 4
752 .RE
753 .ie n .IP """CvREFCOUNTED_ANYSV_on""" 4
754 .el .IP \f(CWCvREFCOUNTED_ANYSV_on\fR 4
755 .IX Xref "CvREFCOUNTED_ANYSV_on"
756 .IX Item "CvREFCOUNTED_ANYSV_on"
757 Helper macro to turn on the \f(CW\*(C`CvREFCOUNTED_ANYSV\*(C'\fR flag.
758 .RS 4
759 .Sp
760 .Vb 1
761 \& void CvREFCOUNTED_ANYSV_on(CV *cv)
762 .Ve
763 .RE
764 .RS 4
765 .RE
766 .ie n .IP """CvWEAKOUTSIDE""" 4
767 .el .IP \f(CWCvWEAKOUTSIDE\fR 4
768 .IX Xref "CvWEAKOUTSIDE"
769 .IX Item "CvWEAKOUTSIDE"
770 Each CV has a pointer, \f(CWCvOUTSIDE()\fR, to its lexically enclosing
771 CV (if any). Because pointers to anonymous sub prototypes are
772 stored in \f(CW\*(C`&\*(C'\fR pad slots, it is a possible to get a circular reference,
773 with the parent pointing to the child and vice\-versa. To avoid the
774 ensuing memory leak, we do not increment the reference count of the CV
775 pointed to by \f(CW\*(C`CvOUTSIDE\*(C'\fR in the \fIone specific instance\fR that the parent
776 has a \f(CW\*(C`&\*(C'\fR pad slot pointing back to us. In this case, we set the
777 \&\f(CW\*(C`CvWEAKOUTSIDE\*(C'\fR flag in the child. This allows us to determine under what
778 circumstances we should decrement the refcount of the parent when freeing
779 the child.
780 .Sp
781 There is a further complication with non\-closure anonymous subs (i.e. those
782 that do not refer to any lexicals outside that sub). In this case, the
783 anonymous prototype is shared rather than being cloned. This has the
784 consequence that the parent may be freed while there are still active
785 children, \fIe.g.\fR,
786 .Sp
787 .Vb 1
788 \& BEGIN { $a = sub { eval \*(Aq$x\*(Aq } }
789 .Ve
790 .Sp
791 In this case, the BEGIN is freed immediately after execution since there
792 are no active references to it: the anon sub prototype has
793 \&\f(CW\*(C`CvWEAKOUTSIDE\*(C'\fR set since it\*(Aqs not a closure, and \f(CW$a\fR points to the same
794 CV, so it doesn\*(Aqt contribute to BEGIN\*(Aqs refcount either. When \f(CW$a\fR is
795 executed, the \f(CW\*(C`eval \*(Aq$x\*(Aq\*(C'\fR causes the chain of \f(CW\*(C`CvOUTSIDE\*(C'\fRs to be followed,
796 and the freed BEGIN is accessed.
797 .Sp
798 To avoid this, whenever a CV and its associated pad is freed, any
799 \&\f(CW\*(C`&\*(C'\fR entries in the pad are explicitly removed from the pad, and if the
800 refcount of the pointed\-to anon sub is still positive, then that
801 child\*(Aqs \f(CW\*(C`CvOUTSIDE\*(C'\fR is set to point to its grandparent. This will only
802 occur in the single specific case of a non\-closure anon prototype
803 having one or more active references (such as \f(CW$a\fR above).
804 .Sp
805 One other thing to consider is that a CV may be merely undefined
806 rather than freed, eg \f(CW\*(C`undef &foo\*(C'\fR. In this case, its refcount may
807 not have reached zero, but we still delete its pad and its \f(CW\*(C`CvROOT\*(C'\fR etc.
808 Since various children may still have their \f(CW\*(C`CvOUTSIDE\*(C'\fR pointing at this
809 undefined CV, we keep its own \f(CW\*(C`CvOUTSIDE\*(C'\fR for the time being, so that
810 the chain of lexical scopes is unbroken. For example, the following
811 should print 123:
812 .Sp
813 .Vb 5
814 \& my $x = 123;
815 \& sub tmp { sub { eval \*(Aq$x\*(Aq } }
816 \& my $a = tmp();
817 \& undef &tmp;
818 \& print $a\->();
819 .Ve
820 .RS 4
821 .Sp
822 .Vb 1
823 \& bool CvWEAKOUTSIDE(CV *cv)
824 .Ve
825 .RE
826 .RS 4
827 .RE
828 .ie n .IP """docatch""" 4
829 .el .IP \f(CWdocatch\fR 4
830 .IX Xref "docatch"
831 .IX Item "docatch"
832 Interpose, for the current op and RUNOPS loop,
833 .Sp
834 .Vb 3
835 \& \- a new JMPENV stack catch frame, and
836 \& \- an inner RUNOPS loop to run all the remaining ops following the
837 \& current PL_op.
838 .Ve
839 .Sp
840 Then handle any exceptions raised while in that loop.
841 For a caught eval at this level, re\-enter the loop with the specified
842 restart op (i.e. the op following the OP_LEAVETRY etc); otherwise re\-throw
843 the exception.
844 .Sp
845 \&\fBdocatch()\fR is intended to be used like this:
846 .Sp
847 .Vb 4
848 \& PP(pp_entertry)
849 \& {
850 \& if (CATCH_GET)
851 \& return docatch(Perl_pp_entertry);
852 \&
853 \& ... rest of function ...
854 \& return PL_op\->op_next;
855 \& }
856 .Ve
857 .Sp
858 If a new catch frame isn\*(Aqt needed, the op behaves normally. Otherwise it
859 calls \fBdocatch()\fR, which recursively calls \fBpp_entertry()\fR, this time with
860 \&\fBCATCH_GET()\fR false, so the rest of the body of the entertry is run. Then
861 \&\fBdocatch()\fR calls \fBCALLRUNOPS()\fR which executes all the ops following the
862 entertry. When the loop finally finishes, control returns to \fBdocatch()\fR,
863 which pops the JMPENV and returns to the parent \fBpp_entertry()\fR, which
864 itself immediately returns. Note that *all* subsequent ops are run within
865 the inner RUNOPS loop, not just the body of the eval. For example, in
866 .Sp
867 .Vb 2
868 \& sub TIEARRAY { eval {1}; my $x }
869 \& tie @a, "main";
870 .Ve
871 .Sp
872 at the point the \*(Aqmy\*(Aq is executed, the C stack will look something like:
873 .Sp
874 .Vb 11
875 \& #10 main()
876 \& #9 perl_run() # JMPENV_PUSH level 1 here
877 \& #8 S_run_body()
878 \& #7 Perl_runops_standard() # main RUNOPS loop
879 \& #6 Perl_pp_tie()
880 \& #5 Perl_call_sv()
881 \& #4 Perl_runops_standard() # unguarded RUNOPS loop: no new JMPENV
882 \& #3 Perl_pp_entertry()
883 \& #2 S_docatch() # JMPENV_PUSH level 2 here
884 \& #1 Perl_runops_standard() # docatch()\*(Aqs RUNOPs loop
885 \& #0 Perl_pp_padsv()
886 .Ve
887 .Sp
888 Basically, any section of the perl core which starts a RUNOPS loop may
889 make a promise that it will catch any exceptions and restart the loop if
890 necessary. If it\*(Aqs not prepared to do that (like \fBcall_sv()\fR isn\*(Aqt), then
891 it sets \fBCATCH_GET()\fR to true, so that any later eval\-like code knows to
892 set up a new handler and loop (via \fBdocatch()\fR).
893 .Sp
894 See "Exception handing" in perlinterp for further details.
895 .RS 4
896 .Sp
897 .Vb 1
898 \& OP * docatch(Perl_ppaddr_t firstpp)
899 .Ve
900 .RE
901 .RS 4
902 .RE
903 .SH Debugging
904 .IX Header "Debugging"
905 .ie n .IP """comma_aDEPTH""" 4
906 .el .IP \f(CWcomma_aDEPTH\fR 4
907 .IX Xref "comma_aDEPTH"
908 .IX Item "comma_aDEPTH"
909 Some functions when compiled under DEBUGGING take an extra final argument named
910 \&\f(CW\*(C`depth\*(C'\fR, indicating the C stack depth. This argument is omitted otherwise.
911 This macro expands to either \f(CW\*(C`,\ depth\*(C'\fR under DEBUGGING, or to nothing at
912 all when not under DEBUGGING, reducing the number of \f(CW\*(C`#ifdef\*(C'\fR\*(Aqs in the code.
913 .Sp
914 The program is responsible for maintaining the correct value for \f(CW\*(C`depth\*(C'\fR.
915 .ie n .IP """comma_pDEPTH""" 4
916 .el .IP \f(CWcomma_pDEPTH\fR 4
917 .IX Xref "comma_pDEPTH"
918 .IX Item "comma_pDEPTH"
919 This is used in the prototype declarations for functions that take a "\f(CW\*(C`comma_aDEPTH\*(C'\fR"
920 final parameter, much like \f(CW\*(C`pTHX_\*(C'\fR
921 is used in functions that take a thread context initial parameter.
922 .ie n .IP """debop""" 4
923 .el .IP \f(CWdebop\fR 4
924 .IX Xref "debop"
925 .IX Item "debop"
926 Implements \fB\-Dt\fR perl command line option on OP \f(CW\*(C`o\*(C'\fR.
927 .RS 4
928 .Sp
929 .Vb 2
930 \& I32 debop( const OP *o)
931 \& I32 Perl_debop(pTHX_ const OP *o)
932 .Ve
933 .RE
934 .RS 4
935 .RE
936 .ie n .IP """debprof""" 4
937 .el .IP \f(CWdebprof\fR 4
938 .IX Xref "debprof"
939 .IX Item "debprof"
940 Called to indicate that \f(CW\*(C`o\*(C'\fR was executed, for profiling purposes under the
941 \&\f(CW\*(C`\-DP\*(C'\fR command line option.
942 .RS 4
943 .Sp
944 .Vb 1
945 \& void debprof(const OP *o)
946 .Ve
947 .RE
948 .RS 4
949 .RE
950 .ie n .IP """debprofdump""" 4
951 .el .IP \f(CWdebprofdump\fR 4
952 .IX Xref "debprofdump"
953 .IX Item "debprofdump"
954 Dumps the contents of the data collected by the \f(CW\*(C`\-DP\*(C'\fR perl command line
955 option.
956 .RS 4
957 .Sp
958 .Vb 2
959 \& void debprofdump()
960 \& void Perl_debprofdump(pTHX)
961 .Ve
962 .RE
963 .RS 4
964 .RE
965 .ie n .IP """debug_aDEPTH""" 4
966 .el .IP \f(CWdebug_aDEPTH\fR 4
967 .IX Xref "debug_aDEPTH"
968 .IX Item "debug_aDEPTH"
969 Same as "\f(CW\*(C`comma_aDEPTH\*(C'\fR" but with no leading argument. Intended for functions with
970 no normal arguments, and used by "\f(CW\*(C`comma_aDEPTH\*(C'\fR" itself.
971 .ie n .IP """debug_pDEPTH""" 4
972 .el .IP \f(CWdebug_pDEPTH\fR 4
973 .IX Xref "debug_pDEPTH"
974 .IX Item "debug_pDEPTH"
975 Same as "\f(CW\*(C`comma_pDEPTH\*(C'\fR" but with no leading argument. Intended for functions with
976 no normal arguments, and used by "\f(CW\*(C`comma_pDEPTH\*(C'\fR" itself.
977 .ie n .IP """free_c_backtrace""" 4
978 .el .IP \f(CWfree_c_backtrace\fR 4
979 .IX Xref "free_c_backtrace"
980 .IX Item "free_c_backtrace"
981 Deallocates a backtrace received from get_c_backtrace.
982 .RS 4
983 .Sp
984 .Vb 1
985 \& void free_c_backtrace(Perl_c_backtrace *bt)
986 .Ve
987 .RE
988 .RS 4
989 .RE
990 .ie n .IP """get_c_backtrace""" 4
991 .el .IP \f(CWget_c_backtrace\fR 4
992 .IX Xref "get_c_backtrace"
993 .IX Item "get_c_backtrace"
994 Collects the backtrace (aka "stacktrace") into a single linear
995 malloced buffer, which the caller \fBmust\fR \f(CWPerl_free_c_backtrace()\fR.
996 .Sp
997 Scans the frames back by \f(CW\*(C`depth\ +\ skip\*(C'\fR, then drops the \f(CW\*(C`skip\*(C'\fR innermost,
998 returning at most \f(CW\*(C`depth\*(C'\fR frames.
999 .RS 4
1000 .Sp
1001 .Vb 4
1002 \& Perl_c_backtrace * get_c_backtrace( int max_depth,
1003 \& int skip)
1004 \& Perl_c_backtrace * Perl_get_c_backtrace(pTHX_ int max_depth,
1005 \& int skip)
1006 .Ve
1007 .RE
1008 .RS 4
1009 .RE
1010 .ie n .IP """PL_DBsingle""" 4
1011 .el .IP \f(CWPL_DBsingle\fR 4
1012 .IX Xref "PL_DBsingle"
1013 .IX Item "PL_DBsingle"
1014 When Perl is run in debugging mode, with the \fB\-d\fR switch, this SV is a
1015 boolean which indicates whether subs are being single\-stepped.
1016 Single\-stepping is automatically turned on after every step. This is the C
1017 variable which corresponds to Perl\*(Aqs \f(CW$DB::single\fR variable. See
1018 \&\f(CW"PL_DBsub"\fR.
1019 .Sp
1020 On threaded perls, each thread has an independent copy of this variable;
1021 each initialized at creation time with the current value of the creating
1022 thread\*(Aqs copy.
1023 .RS 4
1024 .Sp
1025 .Vb 1
1026 \& SV * PL_DBsingle
1027 .Ve
1028 .RE
1029 .RS 4
1030 .RE
1031 .ie n .IP """PL_DBsub""" 4
1032 .el .IP \f(CWPL_DBsub\fR 4
1033 .IX Xref "PL_DBsub"
1034 .IX Item "PL_DBsub"
1035 When Perl is run in debugging mode, with the \fB\-d\fR switch, this GV contains
1036 the SV which holds the name of the sub being debugged. This is the C
1037 variable which corresponds to Perl\*(Aqs \f(CW$DB::sub\fR variable. See
1038 \&\f(CW"PL_DBsingle"\fR.
1039 .Sp
1040 On threaded perls, each thread has an independent copy of this variable;
1041 each initialized at creation time with the current value of the creating
1042 thread\*(Aqs copy.
1043 .RS 4
1044 .Sp
1045 .Vb 1
1046 \& GV * PL_DBsub
1047 .Ve
1048 .RE
1049 .RS 4
1050 .RE
1051 .ie n .IP """PL_DBtrace""" 4
1052 .el .IP \f(CWPL_DBtrace\fR 4
1053 .IX Xref "PL_DBtrace"
1054 .IX Item "PL_DBtrace"
1055 Trace variable used when Perl is run in debugging mode, with the \fB\-d\fR
1056 switch. This is the C variable which corresponds to Perl\*(Aqs \f(CW$DB::trace\fR
1057 variable. See \f(CW"PL_DBsingle"\fR.
1058 .Sp
1059 On threaded perls, each thread has an independent copy of this variable;
1060 each initialized at creation time with the current value of the creating
1061 thread\*(Aqs copy.
1062 .RS 4
1063 .Sp
1064 .Vb 1
1065 \& SV * PL_DBtrace
1066 .Ve
1067 .RE
1068 .RS 4
1069 .RE
1070 .ie n .IP """runops_debug""" 4
1071 .el .IP \f(CWrunops_debug\fR 4
1072 .IX Item "runops_debug"
1073 .PD 0
1074 .ie n .IP """runops_standard""" 4
1075 .el .IP \f(CWrunops_standard\fR 4
1076 .IX Item "runops_standard"
1077 .PD
1078 Described in perlguts.
1079 .RS 4
1080 .Sp
1081 .Vb 4
1082 \& int runops_debug ()
1083 \& int Perl_runops_debug (pTHX)
1084 \& int runops_standard()
1085 \& int Perl_runops_standard(pTHX)
1086 .Ve
1087 .RE
1088 .RS 4
1089 .RE
1090 .SH "Display functions"
1091 .IX Xref "PERL_PV_PRETTY_DUMP PERL_PV_PRETTY_NOCLEAR PERL_PV_PRETTY_REGPROP"
1092 .IX Header "Display functions"
1093 .ie n .IP """sv_peek""" 4
1094 .el .IP \f(CWsv_peek\fR 4
1095 .IX Xref "sv_peek"
1096 .IX Item "sv_peek"
1097 Implements \f(CW\*(C`SvPEEK\*(C'\fR
1098 .RS 4
1099 .Sp
1100 .Vb 2
1101 \& char * sv_peek( SV *sv)
1102 \& char * Perl_sv_peek(pTHX_ SV *sv)
1103 .Ve
1104 .RE
1105 .RS 4
1106 .RE
1107 .SH "Embedding, Threads, and Interpreter Cloning"
1108 .IX Header "Embedding, Threads, and Interpreter Cloning"
1109 .ie n .IP """cv_dump""" 4
1110 .el .IP \f(CWcv_dump\fR 4
1111 .IX Xref "cv_dump"
1112 .IX Item "cv_dump"
1113 dump the contents of a CV
1114 .RS 4
1115 .Sp
1116 .Vb 1
1117 \& void cv_dump(const CV *cv, const char *title)
1118 .Ve
1119 .RE
1120 .RS 4
1121 .RE
1122 .ie n .IP """cv_forget_slab""" 4
1123 .el .IP \f(CWcv_forget_slab\fR 4
1124 .IX Xref "cv_forget_slab"
1125 .IX Item "cv_forget_slab"
1126 When a CV has a reference count on its slab (\f(CW\*(C`CvSLABBED\*(C'\fR), it is responsible
1127 for making sure it is freed. (Hence, no two CVs should ever have a
1128 reference count on the same slab.) The CV only needs to reference the slab
1129 during compilation. Once it is compiled and \f(CW\*(C`CvROOT\*(C'\fR attached, it has
1130 finished its job, so it can forget the slab.
1131 .RS 4
1132 .Sp
1133 .Vb 2
1134 \& void cv_forget_slab( CV *cv)
1135 \& void Perl_cv_forget_slab(pTHX_ CV *cv)
1136 .Ve
1137 .RE
1138 .RS 4
1139 .RE
1140 .ie n .IP """do_dump_pad""" 4
1141 .el .IP \f(CWdo_dump_pad\fR 4
1142 .IX Xref "do_dump_pad"
1143 .IX Item "do_dump_pad"
1144 Dump the contents of a padlist
1145 .RS 4
1146 .Sp
1147 .Vb 4
1148 \& void do_dump_pad( I32 level, PerlIO *file,
1149 \& PADLIST *padlist, int full)
1150 \& void Perl_do_dump_pad(pTHX_ I32 level, PerlIO *file,
1151 \& PADLIST *padlist, int full)
1152 .Ve
1153 .RE
1154 .RS 4
1155 .RE
1156 .ie n .IP """get_context""" 4
1157 .el .IP \f(CWget_context\fR 4
1158 .IX Xref "get_context"
1159 .IX Item "get_context"
1160 Implements "\f(CW\*(C`PERL_GET_CONTEXT\*(C'\fR" in perlapi, which you should use instead.
1161 .RS 4
1162 .Sp
1163 .Vb 2
1164 \& void * get_context()
1165 \& void * Perl_get_context()
1166 .Ve
1167 .RE
1168 .RS 4
1169 .RE
1170 .ie n .IP """noshutdownhook""" 4
1171 .el .IP \f(CWnoshutdownhook\fR 4
1172 .IX Xref "noshutdownhook"
1173 .IX Item "noshutdownhook"
1174 Stub that provides shutdown hook.
1175 .RS 4
1176 .Sp
1177 .Vb 2
1178 \& void noshutdownhook()
1179 \& void Perl_noshutdownhook()
1180 .Ve
1181 .RE
1182 .RS 4
1183 .RE
1184 .ie n .IP """pad_alloc_name""" 4
1185 .el .IP \f(CWpad_alloc_name\fR 4
1186 .IX Xref "pad_alloc_name"
1187 .IX Item "pad_alloc_name"
1188 Allocates a place in the currently\-compiling
1189 pad (via "pad_alloc" in perlapi) and
1190 then stores a name for that entry. \f(CW\*(C`name\*(C'\fR is adopted and
1191 becomes the name entry; it must already contain the name
1192 string. \f(CW\*(C`typestash\*(C'\fR and \f(CW\*(C`ourstash\*(C'\fR and the \f(CW\*(C`padadd_STATE\*(C'\fR
1193 flag gets added to \f(CW\*(C`name\*(C'\fR.
1194 None of the other processing of "pad_add_name_pvn" in perlapi
1195 is done. Returns the offset of the allocated pad slot.
1196 .RS 4
1197 .Sp
1198 .Vb 2
1199 \& PADOFFSET pad_alloc_name(PADNAME *name, U32 flags,
1200 \& NOCHECK HV *typestash, HV *ourstash)
1201 .Ve
1202 .RE
1203 .RS 4
1204 .RE
1205 .ie n .IP """pad_block_start""" 4
1206 .el .IP \f(CWpad_block_start\fR 4
1207 .IX Xref "pad_block_start"
1208 .IX Item "pad_block_start"
1209 Update the pad compilation state variables on entry to a new block.
1210 .RS 4
1211 .Sp
1212 .Vb 2
1213 \& void pad_block_start( int full)
1214 \& void Perl_pad_block_start(pTHX_ int full)
1215 .Ve
1216 .RE
1217 .RS 4
1218 .RE
1219 .ie n .IP """pad_check_dup""" 4
1220 .el .IP \f(CWpad_check_dup\fR 4
1221 .IX Xref "pad_check_dup"
1222 .IX Item "pad_check_dup"
1223 Check for duplicate declarations: report any of:
1224 .Sp
1225 .Vb 3
1226 \& * a \*(Aqmy\*(Aq in the current scope with the same name;
1227 \& * an \*(Aqour\*(Aq (anywhere in the pad) with the same name and the
1228 \& same stash as \*(Aqourstash\*(Aq
1229 .Ve
1230 .Sp
1231 \&\f(CW\*(C`is_our\*(C'\fR indicates that the name to check is an \f(CW"our"\fR declaration.
1232 .RS 4
1233 .Sp
1234 .Vb 1
1235 \& void pad_check_dup(PADNAME *name, U32 flags, const HV *ourstash)
1236 .Ve
1237 .RE
1238 .RS 4
1239 .RE
1240 .ie n .IP """pad_findlex""" 4
1241 .el .IP \f(CWpad_findlex\fR 4
1242 .IX Xref "pad_findlex"
1243 .IX Item "pad_findlex"
1244 Find a named lexical anywhere in a chain of nested pads. Add fake entries
1245 in the inner pads if it\*(Aqs found in an outer one.
1246 .Sp
1247 Returns the offset in the bottom pad of the lex or the fake lex.
1248 \&\f(CW\*(C`cv\*(C'\fR is the CV in which to start the search, and seq is the current \f(CW\*(C`cop_seq\*(C'\fR
1249 to match against. If \f(CW\*(C`warn\*(C'\fR is true, print appropriate warnings. The \f(CW\*(C`out_\*(C'\fR*
1250 vars return values, and so are pointers to where the returned values
1251 should be stored. \f(CW\*(C`out_capture\*(C'\fR, if non\-null, requests that the innermost
1252 instance of the lexical is captured; \f(CW\*(C`out_name\*(C'\fR is set to the innermost
1253 matched pad name or fake pad name; \f(CW\*(C`out_flags\*(C'\fR returns the flags normally
1254 associated with the \f(CW\*(C`PARENT_FAKELEX_FLAGS\*(C'\fR field of a fake pad name.
1255 .Sp
1256 Note that \f(CWpad_findlex()\fR is recursive; it recurses up the chain of CVs,
1257 then comes back down, adding fake entries
1258 as it goes. It has to be this way
1259 because fake names in anon prototypes have to store in \f(CW\*(C`xpadn_low\*(C'\fR the
1260 index into the parent pad.
1261 .RS 4
1262 .Sp
1263 .Vb 4
1264 \& PADOFFSET pad_findlex(const char *namepv, STRLEN namelen,
1265 \& U32 flags, const CV *cv, U32 seq,
1266 \& int warn, SV **out_capture,
1267 \& PADNAME **out_name, int *out_flags)
1268 .Ve
1269 .RE
1270 .RS 4
1271 .RE
1272 .ie n .IP """pad_fixup_inner_anons""" 4
1273 .el .IP \f(CWpad_fixup_inner_anons\fR 4
1274 .IX Xref "pad_fixup_inner_anons"
1275 .IX Item "pad_fixup_inner_anons"
1276 For any anon CVs in the pad, change \f(CW\*(C`CvOUTSIDE\*(C'\fR of that CV from
1277 \&\f(CW\*(C`old_cv\*(C'\fR to \f(CW\*(C`new_cv\*(C'\fR if necessary. Needed when a newly\-compiled CV has to be
1278 moved to a pre\-existing CV struct.
1279 .RS 4
1280 .Sp
1281 .Vb 4
1282 \& void pad_fixup_inner_anons( PADLIST *padlist,
1283 \& CV *old_cv, CV *new_cv)
1284 \& void Perl_pad_fixup_inner_anons(pTHX_ PADLIST *padlist,
1285 \& CV *old_cv, CV *new_cv)
1286 .Ve
1287 .RE
1288 .RS 4
1289 .RE
1290 .ie n .IP """pad_free""" 4
1291 .el .IP \f(CWpad_free\fR 4
1292 .IX Xref "pad_free"
1293 .IX Item "pad_free"
1294 Free the SV at offset po in the current pad.
1295 .RS 4
1296 .Sp
1297 .Vb 2
1298 \& void pad_free( PADOFFSET po)
1299 \& void Perl_pad_free(pTHX_ PADOFFSET po)
1300 .Ve
1301 .RE
1302 .RS 4
1303 .RE
1304 .ie n .IP """pad_leavemy""" 4
1305 .el .IP \f(CWpad_leavemy\fR 4
1306 .IX Xref "pad_leavemy"
1307 .IX Item "pad_leavemy"
1308 Cleanup at end of scope during compilation: set the max seq number for
1309 lexicals in this scope and warn of any lexicals that never got introduced.
1310 .RS 4
1311 .Sp
1312 .Vb 2
1313 \& OP * pad_leavemy()
1314 \& OP * Perl_pad_leavemy(pTHX)
1315 .Ve
1316 .RE
1317 .RS 4
1318 .RE
1319 .ie n .IP """pad_push""" 4
1320 .el .IP \f(CWpad_push\fR 4
1321 .IX Xref "pad_push"
1322 .IX Item "pad_push"
1323 Push a new pad frame onto the padlist, unless there\*(Aqs already a pad at
1324 this depth, in which case don\*(Aqt bother creating a new one. Then give
1325 the new pad an \f(CW@_\fR in slot zero.
1326 .RS 4
1327 .Sp
1328 .Vb 2
1329 \& void pad_push( PADLIST *padlist, int depth)
1330 \& void Perl_pad_push(pTHX_ PADLIST *padlist, int depth)
1331 .Ve
1332 .RE
1333 .RS 4
1334 .RE
1335 .ie n .IP """pad_reset""" 4
1336 .el .IP \f(CWpad_reset\fR 4
1337 .IX Xref "pad_reset"
1338 .IX Item "pad_reset"
1339 Mark all the current temporaries for reuse
1340 .RS 4
1341 .Sp
1342 .Vb 1
1343 \& void pad_reset()
1344 .Ve
1345 .RE
1346 .RS 4
1347 .RE
1348 .ie n .IP """pad_setsv""" 4
1349 .el .IP \f(CWpad_setsv\fR 4
1350 .IX Xref "pad_setsv"
1351 .IX Item "pad_setsv"
1352 Set the value at offset \f(CW\*(C`po\*(C'\fR in the current (compiling or executing) pad.
1353 Use the macro \f(CWPAD_SETSV()\fR rather than calling this function directly.
1354 .RS 4
1355 .Sp
1356 .Vb 2
1357 \& void pad_setsv( PADOFFSET po, SV *sv)
1358 \& void Perl_pad_setsv(pTHX_ PADOFFSET po, SV *sv)
1359 .Ve
1360 .RE
1361 .RS 4
1362 .RE
1363 .ie n .IP """pad_sv""" 4
1364 .el .IP \f(CWpad_sv\fR 4
1365 .IX Xref "pad_sv"
1366 .IX Item "pad_sv"
1367 Get the value at offset \f(CW\*(C`po\*(C'\fR in the current (compiling or executing) pad.
1368 Use macro \f(CW\*(C`PAD_SV\*(C'\fR instead of calling this function directly.
1369 .RS 4
1370 .Sp
1371 .Vb 2
1372 \& SV * pad_sv( PADOFFSET po)
1373 \& SV * Perl_pad_sv(pTHX_ PADOFFSET po)
1374 .Ve
1375 .RE
1376 .RS 4
1377 .RE
1378 .ie n .IP """pad_swipe""" 4
1379 .el .IP \f(CWpad_swipe\fR 4
1380 .IX Xref "pad_swipe"
1381 .IX Item "pad_swipe"
1382 Abandon the tmp in the current pad at offset \f(CW\*(C`po\*(C'\fR and replace with a
1383 new one.
1384 .RS 4
1385 .Sp
1386 .Vb 2
1387 \& void pad_swipe( PADOFFSET po, bool refadjust)
1388 \& void Perl_pad_swipe(pTHX_ PADOFFSET po, bool refadjust)
1389 .Ve
1390 .RE
1391 .RS 4
1392 .RE
1393 .ie n .IP """padlist_dup""" 4
1394 .el .IP \f(CWpadlist_dup\fR 4
1395 .IX Xref "padlist_dup"
1396 .IX Item "padlist_dup"
1397 Duplicates a pad.
1398 .RS 4
1399 .Sp
1400 .Vb 4
1401 \& PADLIST * padlist_dup( PADLIST *srcpad,
1402 \& CLONE_PARAMS *param)
1403 \& PADLIST * Perl_padlist_dup(pTHX_ PADLIST *srcpad,
1404 \& CLONE_PARAMS *param)
1405 .Ve
1406 .RE
1407 .RS 4
1408 .RE
1409 .ie n .IP """padname_dup""" 4
1410 .el .IP \f(CWpadname_dup\fR 4
1411 .IX Xref "padname_dup"
1412 .IX Item "padname_dup"
1413 Duplicates a pad name.
1414 .RS 4
1415 .Sp
1416 .Vb 4
1417 \& PADNAME * padname_dup( PADNAME *src,
1418 \& CLONE_PARAMS *param)
1419 \& PADNAME * Perl_padname_dup(pTHX_ PADNAME *src,
1420 \& CLONE_PARAMS *param)
1421 .Ve
1422 .RE
1423 .RS 4
1424 .RE
1425 .ie n .IP """padnamelist_dup""" 4
1426 .el .IP \f(CWpadnamelist_dup\fR 4
1427 .IX Xref "padnamelist_dup"
1428 .IX Item "padnamelist_dup"
1429 Duplicates a pad name list.
1430 .RS 4
1431 .Sp
1432 .Vb 4
1433 \& PADNAMELIST * padnamelist_dup( PADNAMELIST *srcpad,
1434 \& CLONE_PARAMS *param)
1435 \& PADNAMELIST * Perl_padnamelist_dup(pTHX_ PADNAMELIST *srcpad,
1436 \& CLONE_PARAMS *param)
1437 .Ve
1438 .RE
1439 .RS 4
1440 .RE
1441 .ie n .IP """set_context""" 4
1442 .el .IP \f(CWset_context\fR 4
1443 .IX Xref "set_context"
1444 .IX Item "set_context"
1445 Implements "\f(CW\*(C`PERL_SET_CONTEXT\*(C'\fR" in perlapi, which you should use instead.
1446 .RS 4
1447 .Sp
1448 .Vb 2
1449 \& void set_context(void *t)
1450 \& void Perl_set_context(void *t)
1451 .Ve
1452 .RE
1453 .RS 4
1454 .RE
1455 .ie n .IP """si_dup""" 4
1456 .el .IP \f(CWsi_dup\fR 4
1457 .IX Xref "si_dup"
1458 .IX Item "si_dup"
1459 Duplicate a stack info structure, returning a pointer to the cloned object.
1460 .RS 4
1461 .Sp
1462 .Vb 2
1463 \& PERL_SI * si_dup( PERL_SI *si, CLONE_PARAMS *param)
1464 \& PERL_SI * Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS *param)
1465 .Ve
1466 .RE
1467 .RS 4
1468 .RE
1469 .ie n .IP """ss_dup""" 4
1470 .el .IP \f(CWss_dup\fR 4
1471 .IX Xref "ss_dup"
1472 .IX Item "ss_dup"
1473 Duplicate the save stack, returning a pointer to the cloned object.
1474 .RS 4
1475 .Sp
1476 .Vb 4
1477 \& ANY * ss_dup( PerlInterpreter *proto_perl,
1478 \& CLONE_PARAMS *param)
1479 \& ANY * Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl,
1480 \& CLONE_PARAMS *param)
1481 .Ve
1482 .RE
1483 .RS 4
1484 .RE
1485 .SH Errno
1486 .IX Header "Errno"
1487 .ie n .IP """dSAVE_ERRNO""" 4
1488 .el .IP \f(CWdSAVE_ERRNO\fR 4
1489 .IX Xref "dSAVE_ERRNO"
1490 .IX Item "dSAVE_ERRNO"
1491 Declare variables needed to save \f(CW\*(C`errno\*(C'\fR and any operating system
1492 specific error number, and save them for optional later restoration
1493 by \f(CW\*(C`RESTORE_ERRNO\*(C'\fR.
1494 .RS 4
1495 .Sp
1496 .Vb 1
1497 \& void dSAVE_ERRNO
1498 .Ve
1499 .RE
1500 .RS 4
1501 .RE
1502 .ie n .IP """dSAVEDERRNO""" 4
1503 .el .IP \f(CWdSAVEDERRNO\fR 4
1504 .IX Xref "dSAVEDERRNO"
1505 .IX Item "dSAVEDERRNO"
1506 Declare variables needed to save \f(CW\*(C`errno\*(C'\fR and any operating system
1507 specific error number.
1508 .RS 4
1509 .Sp
1510 .Vb 1
1511 \& void dSAVEDERRNO
1512 .Ve
1513 .RE
1514 .RS 4
1515 .RE
1516 .ie n .IP """RESTORE_ERRNO""" 4
1517 .el .IP \f(CWRESTORE_ERRNO\fR 4
1518 .IX Xref "RESTORE_ERRNO"
1519 .IX Item "RESTORE_ERRNO"
1520 Restore \f(CW\*(C`errno\*(C'\fR and any operating system specific error number that
1521 was saved by \f(CW\*(C`dSAVE_ERRNO\*(C'\fR or \f(CW\*(C`RESTORE_ERRNO\*(C'\fR.
1522 .RS 4
1523 .Sp
1524 .Vb 1
1525 \& void RESTORE_ERRNO
1526 .Ve
1527 .RE
1528 .RS 4
1529 .RE
1530 .ie n .IP """SAVE_ERRNO""" 4
1531 .el .IP \f(CWSAVE_ERRNO\fR 4
1532 .IX Xref "SAVE_ERRNO"
1533 .IX Item "SAVE_ERRNO"
1534 Save \f(CW\*(C`errno\*(C'\fR and any operating system specific error number for
1535 optional later restoration by \f(CW\*(C`RESTORE_ERRNO\*(C'\fR. Requires
1536 \&\f(CW\*(C`dSAVEDERRNO\*(C'\fR or \f(CW\*(C`dSAVE_ERRNO\*(C'\fR in scope.
1537 .RS 4
1538 .Sp
1539 .Vb 1
1540 \& void SAVE_ERRNO
1541 .Ve
1542 .RE
1543 .RS 4
1544 .RE
1545 .ie n .IP """SETERRNO""" 4
1546 .el .IP \f(CWSETERRNO\fR 4
1547 .IX Xref "SETERRNO"
1548 .IX Item "SETERRNO"
1549 Set \f(CW\*(C`errno\*(C'\fR, and on VMS set \f(CW\*(C`vaxc$errno\*(C'\fR.
1550 .RS 4
1551 .Sp
1552 .Vb 1
1553 \& void SETERRNO(int errcode, int vmserrcode)
1554 .Ve
1555 .RE
1556 .RS 4
1557 .RE
1558 .SH "Exception Handling (simple) Macros"
1559 .IX Header "Exception Handling (simple) Macros"
1560 There are currently no internal API items in Exception Handling (simple) Macros
1561 .SH "Filesystem configuration values"
1562 .IX Header "Filesystem configuration values"
1563 There are currently no internal API items in Filesystem configuration values
1564 .SH "Floating point"
1565 .IX Header "Floating point"
1566 There are currently no internal API items in Floating point
1567 .SH "General Configuration"
1568 .IX Header "General Configuration"
1569 There are currently no internal API items in General Configuration
1570 .SH "Global Variables"
1571 .IX Header "Global Variables"
1572 There are currently no internal API items in Global Variables
1573 .SH "GV Handling and Stashes"
1574 .IX Xref "GV_CACHE_ONLY"
1575 .IX Header "GV Handling and Stashes"
1576 .ie n .IP """amagic_applies""" 4
1577 .el .IP \f(CWamagic_applies\fR 4
1578 .IX Xref "amagic_applies"
1579 .IX Item "amagic_applies"
1580 Check \f(CW\*(C`sv\*(C'\fR to see if the overloaded (active magic) operation \f(CW\*(C`method\*(C'\fR
1581 applies to it. If the sv is not SvROK or it is not an object then returns
1582 false, otherwise checks if the object is blessed into a class supporting
1583 overloaded operations, and returns true if a call to \fBamagic_call()\fR with
1584 this SV and the given method would trigger an amagic operation, including
1585 via the overload fallback rules or via nomethod. Thus a call like:
1586 .Sp
1587 .Vb 1
1588 \& amagic_applies(sv, string_amg, AMG_unary)
1589 .Ve
1590 .Sp
1591 would return true for an object with overloading set up in any of the
1592 following ways:
1593 .Sp
1594 .Vb 2
1595 \& use overload q("") => sub { ... };
1596 \& use overload q(0+) => sub { ... }, fallback => 1;
1597 .Ve
1598 .Sp
1599 and could be used to tell if a given object would stringify to something
1600 other than the normal default ref stringification.
1601 .Sp
1602 Note that the fact that this function returns TRUE does not mean you
1603 can successfully perform the operation with \fBamagic_call()\fR, for instance
1604 any overloaded method might throw a fatal exception, however if this
1605 function returns FALSE you can be confident that it will NOT perform
1606 the given overload operation.
1607 .Sp
1608 \&\f(CW\*(C`method\*(C'\fR is an integer enum, one of the values found in \fIoverload.h\fR,
1609 for instance \f(CW\*(C`string_amg\*(C'\fR.
1610 .Sp
1611 \&\f(CW\*(C`flags\*(C'\fR should be set to AMG_unary for unary operations.
1612 .RS 4
1613 .Sp
1614 .Vb 2
1615 \& bool amagic_applies( SV *sv, int method, int flags)
1616 \& bool Perl_amagic_applies(pTHX_ SV *sv, int method, int flags)
1617 .Ve
1618 .RE
1619 .RS 4
1620 .RE
1621 .ie n .IP """gp_dup""" 4
1622 .el .IP \f(CWgp_dup\fR 4
1623 .IX Xref "gp_dup"
1624 .IX Item "gp_dup"
1625 Duplicate a typeglob, returning a pointer to the cloned object.
1626 .RS 4
1627 .Sp
1628 .Vb 4
1629 \& GP * gp_dup( GP * const gp,
1630 \& CLONE_PARAMS * const param)
1631 \& GP * Perl_gp_dup(pTHX_ GP * const gp,
1632 \& CLONE_PARAMS * const param)
1633 .Ve
1634 .RE
1635 .RS 4
1636 .RE
1637 .ie n .IP """gv_handler""" 4
1638 .el .IP \f(CWgv_handler\fR 4
1639 .IX Xref "gv_handler"
1640 .IX Item "gv_handler"
1641 Implements \f(CW\*(C`StashHANDLER\*(C'\fR, which you should use instead
1642 .RS 4
1643 .Sp
1644 .Vb 2
1645 \& CV * gv_handler( HV *stash, I32 id)
1646 \& CV * Perl_gv_handler(pTHX_ HV *stash, I32 id)
1647 .Ve
1648 .RE
1649 .RS 4
1650 .RE
1651 .ie n .IP """gv_stashsvpvn_cached""" 4
1652 .el .IP \f(CWgv_stashsvpvn_cached\fR 4
1653 .IX Xref "gv_stashsvpvn_cached"
1654 .IX Item "gv_stashsvpvn_cached"
1655 Returns a pointer to the stash for a specified package, possibly
1656 cached. Implements both "\f(CW\*(C`gv_stashpvn\*(C'\fR" in perlapi and
1657 "\f(CW\*(C`gv_stashsv\*(C'\fR" in perlapi.
1658 .Sp
1659 Requires one of either \f(CW\*(C`namesv\*(C'\fR or \f(CW\*(C`namepv\*(C'\fR to be non\-null.
1660 .Sp
1661 If the flag \f(CW\*(C`GV_CACHE_ONLY\*(C'\fR is set, return the stash only if found in the
1662 cache; see "\f(CW\*(C`gv_stashpvn\*(C'\fR" in perlapi for details on the other \f(CW\*(C`flags\*(C'\fR.
1663 .Sp
1664 Note it is strongly preferred for \f(CW\*(C`namesv\*(C'\fR to be non\-null, for performance
1665 reasons.
1666 .RS 4
1667 .Sp
1668 .Vb 6
1669 \& HV * gv_stashsvpvn_cached( SV *namesv,
1670 \& const char *name,
1671 \& U32 namelen, I32 flags)
1672 \& HV * Perl_gv_stashsvpvn_cached(pTHX_ SV *namesv,
1673 \& const char *name,
1674 \& U32 namelen, I32 flags)
1675 .Ve
1676 .RE
1677 .RS 4
1678 .RE
1679 .ie n .IP """gv_try_downgrade""" 4
1680 .el .IP \f(CWgv_try_downgrade\fR 4
1681 .IX Xref "gv_try_downgrade"
1682 .IX Item "gv_try_downgrade"
1683 NOTE: \f(CW\*(C`gv_try_downgrade\*(C'\fR is \fBexperimental\fR and may change or be
1684 removed without notice.
1685 .Sp
1686 If the typeglob \f(CW\*(C`gv\*(C'\fR can be expressed more succinctly, by having
1687 something other than a real GV in its place in the stash, replace it
1688 with the optimised form. Basic requirements for this are that \f(CW\*(C`gv\*(C'\fR
1689 is a real typeglob, is sufficiently ordinary, and is only referenced
1690 from its package. This function is meant to be used when a GV has been
1691 looked up in part to see what was there, causing upgrading, but based
1692 on what was found it turns out that the real GV isn\*(Aqt required after all.
1693 .Sp
1694 If \f(CW\*(C`gv\*(C'\fR is a completely empty typeglob, it is deleted from the stash.
1695 .Sp
1696 If \f(CW\*(C`gv\*(C'\fR is a typeglob containing only a sufficiently\-ordinary constant
1697 sub, the typeglob is replaced with a scalar\-reference placeholder that
1698 more compactly represents the same thing.
1699 .RS 4
1700 .Sp
1701 .Vb 2
1702 \& void gv_try_downgrade( GV *gv)
1703 \& void Perl_gv_try_downgrade(pTHX_ GV *gv)
1704 .Ve
1705 .RE
1706 .RS 4
1707 .RE
1708 .SH "Hook manipulation"
1709 .IX Header "Hook manipulation"
1710 There are currently no internal API items in Hook manipulation
1711 .SH "HV Handling"
1712 .IX Xref "HvNAME_get"
1713 .IX Header "HV Handling"
1714 .ie n .IP """hv_eiter_p""" 4
1715 .el .IP \f(CWhv_eiter_p\fR 4
1716 .IX Xref "hv_eiter_p"
1717 .IX Item "hv_eiter_p"
1718 Implements \f(CW\*(C`HvEITER\*(C'\fR which you should use instead.
1719 .RS 4
1720 .Sp
1721 .Vb 1
1722 \& HE ** Perl_hv_eiter_p(pTHX_ HV *hv)
1723 .Ve
1724 .RE
1725 .RS 4
1726 .RE
1727 .ie n .IP """hv_eiter_set""" 4
1728 .el .IP \f(CWhv_eiter_set\fR 4
1729 .IX Xref "hv_eiter_set"
1730 .IX Item "hv_eiter_set"
1731 Implements \f(CW\*(C`HvEITER_set\*(C'\fR which you should use instead.
1732 .RS 4
1733 .Sp
1734 .Vb 1
1735 \& void Perl_hv_eiter_set(pTHX_ HV *hv, HE *eiter)
1736 .Ve
1737 .RE
1738 .RS 4
1739 .RE
1740 .ie n .IP """hv_ename_add""" 4
1741 .el .IP \f(CWhv_ename_add\fR 4
1742 .IX Xref "hv_ename_add"
1743 .IX Item "hv_ename_add"
1744 Adds a name to a stash\*(Aqs internal list of effective names. See
1745 \&\f(CW"hv_ename_delete"\fR.
1746 .Sp
1747 This is called when a stash is assigned to a new location in the symbol
1748 table.
1749 .RS 4
1750 .Sp
1751 .Vb 4
1752 \& void hv_ename_add( HV *hv, const char *name, U32 len,
1753 \& U32 flags)
1754 \& void Perl_hv_ename_add(pTHX_ HV *hv, const char *name, U32 len,
1755 \& U32 flags)
1756 .Ve
1757 .RE
1758 .RS 4
1759 .RE
1760 .ie n .IP """hv_ename_delete""" 4
1761 .el .IP \f(CWhv_ename_delete\fR 4
1762 .IX Xref "hv_ename_delete"
1763 .IX Item "hv_ename_delete"
1764 Removes a name from a stash\*(Aqs internal list of effective names. If this is
1765 the name returned by \f(CW\*(C`HvENAME\*(C'\fR, then another name in the list will take
1766 its place (\f(CW\*(C`HvENAME\*(C'\fR will use it).
1767 .Sp
1768 This is called when a stash is deleted from the symbol table.
1769 .RS 4
1770 .Sp
1771 .Vb 4
1772 \& void hv_ename_delete( HV *hv, const char *name,
1773 \& U32 len, U32 flags)
1774 \& void Perl_hv_ename_delete(pTHX_ HV *hv, const char *name,
1775 \& U32 len, U32 flags)
1776 .Ve
1777 .RE
1778 .RS 4
1779 .RE
1780 .ie n .IP """hv_fill""" 4
1781 .el .IP \f(CWhv_fill\fR 4
1782 .IX Xref "hv_fill"
1783 .IX Item "hv_fill"
1784 Returns the number of hash buckets that happen to be in use.
1785 .Sp
1786 This function implements the \f(CW\*(C`HvFILL\*(C'\fR macro which you should
1787 use instead.
1788 .Sp
1789 As of perl 5.25 this function is used only for debugging
1790 purposes, and the number of used hash buckets is not
1791 in any way cached, thus this function can be costly
1792 to execute as it must iterate over all the buckets in the
1793 hash.
1794 .RS 4
1795 .Sp
1796 .Vb 1
1797 \& STRLEN Perl_hv_fill(pTHX_ HV * const hv)
1798 .Ve
1799 .RE
1800 .RS 4
1801 .RE
1802 .ie n .IP """hv_placeholders_get""" 4
1803 .el .IP \f(CWhv_placeholders_get\fR 4
1804 .IX Xref "hv_placeholders_get"
1805 .IX Item "hv_placeholders_get"
1806 Implements \f(CW\*(C`HvPLACEHOLDERS_get\*(C'\fR, which you should use instead.
1807 .RS 4
1808 .Sp
1809 .Vb 1
1810 \& I32 Perl_hv_placeholders_get(pTHX_ const HV *hv)
1811 .Ve
1812 .RE
1813 .RS 4
1814 .RE
1815 .ie n .IP """hv_placeholders_set""" 4
1816 .el .IP \f(CWhv_placeholders_set\fR 4
1817 .IX Xref "hv_placeholders_set"
1818 .IX Item "hv_placeholders_set"
1819 Implements \f(CW\*(C`HvPLACEHOLDERS_set\*(C'\fR, which you should use instead.
1820 .RS 4
1821 .Sp
1822 .Vb 1
1823 \& void Perl_hv_placeholders_set(pTHX_ HV *hv, I32 ph)
1824 .Ve
1825 .RE
1826 .RS 4
1827 .RE
1828 .ie n .IP """hv_riter_p""" 4
1829 .el .IP \f(CWhv_riter_p\fR 4
1830 .IX Xref "hv_riter_p"
1831 .IX Item "hv_riter_p"
1832 Implements \f(CW\*(C`HvRITER\*(C'\fR which you should use instead.
1833 .RS 4
1834 .Sp
1835 .Vb 1
1836 \& I32 * Perl_hv_riter_p(pTHX_ HV *hv)
1837 .Ve
1838 .RE
1839 .RS 4
1840 .RE
1841 .ie n .IP """hv_riter_set""" 4
1842 .el .IP \f(CWhv_riter_set\fR 4
1843 .IX Xref "hv_riter_set"
1844 .IX Item "hv_riter_set"
1845 Implements \f(CW\*(C`HvRITER_set\*(C'\fR which you should use instead.
1846 .RS 4
1847 .Sp
1848 .Vb 1
1849 \& void Perl_hv_riter_set(pTHX_ HV *hv, I32 riter)
1850 .Ve
1851 .RE
1852 .RS 4
1853 .RE
1854 .ie n .IP """refcounted_he_chain_2hv""" 4
1855 .el .IP \f(CWrefcounted_he_chain_2hv\fR 4
1856 .IX Xref "refcounted_he_chain_2hv"
1857 .IX Item "refcounted_he_chain_2hv"
1858 Generates and returns a \f(CW\*(C`HV *\*(C'\fR representing the content of a
1859 \&\f(CW\*(C`refcounted_he\*(C'\fR chain.
1860 \&\f(CW\*(C`flags\*(C'\fR is currently unused and must be zero.
1861 .RS 4
1862 .Sp
1863 .Vb 5
1864 \& HV * refcounted_he_chain_2hv(const struct refcounted_he *c,
1865 \& U32 flags)
1866 \& HV * Perl_refcounted_he_chain_2hv(pTHX_
1867 \& const struct refcounted_he *c,
1868 \& U32 flags)
1869 .Ve
1870 .RE
1871 .RS 4
1872 .RE
1873 .ie n .IP """refcounted_he_fetch_pv""" 4
1874 .el .IP \f(CWrefcounted_he_fetch_pv\fR 4
1875 .IX Xref "refcounted_he_fetch_pv"
1876 .IX Item "refcounted_he_fetch_pv"
1877 Like "refcounted_he_fetch_pvn", but takes a nul\-terminated string
1878 instead of a string/length pair.
1879 .RS 4
1880 .Sp
1881 .Vb 8
1882 \& SV * refcounted_he_fetch_pv(
1883 \& const struct refcounted_he *chain,
1884 \& const char *key, U32 hash,
1885 \& U32 flags)
1886 \& SV * Perl_refcounted_he_fetch_pv(pTHX_
1887 \& const struct refcounted_he *chain,
1888 \& const char *key, U32 hash,
1889 \& U32 flags)
1890 .Ve
1891 .RE
1892 .RS 4
1893 .RE
1894 .ie n .IP """refcounted_he_fetch_pvn""" 4
1895 .el .IP \f(CWrefcounted_he_fetch_pvn\fR 4
1896 .IX Xref "refcounted_he_fetch_pvn"
1897 .IX Item "refcounted_he_fetch_pvn"
1898 Search along a \f(CW\*(C`refcounted_he\*(C'\fR chain for an entry with the key specified
1899 by \f(CW\*(C`keypv\*(C'\fR and \f(CW\*(C`keylen\*(C'\fR. If \f(CW\*(C`flags\*(C'\fR has the \f(CW\*(C`REFCOUNTED_HE_KEY_UTF8\*(C'\fR
1900 bit set, the key octets are interpreted as UTF\-8, otherwise they
1901 are interpreted as Latin\-1. \f(CW\*(C`hash\*(C'\fR is a precomputed hash of the key
1902 string, or zero if it has not been precomputed. Returns a mortal scalar
1903 representing the value associated with the key, or \f(CW&PL_sv_placeholder\fR
1904 if there is no value associated with the key.
1905 .RS 4
1906 .Sp
1907 .Vb 8
1908 \& SV * refcounted_he_fetch_pvn(
1909 \& const struct refcounted_he *chain,
1910 \& const char *keypv, STRLEN keylen,
1911 \& U32 hash, U32 flags)
1912 \& SV * Perl_refcounted_he_fetch_pvn(pTHX_
1913 \& const struct refcounted_he *chain,
1914 \& const char *keypv, STRLEN keylen,
1915 \& U32 hash, U32 flags)
1916 .Ve
1917 .RE
1918 .RS 4
1919 .RE
1920 .ie n .IP """refcounted_he_fetch_pvs""" 4
1921 .el .IP \f(CWrefcounted_he_fetch_pvs\fR 4
1922 .IX Xref "refcounted_he_fetch_pvs"
1923 .IX Item "refcounted_he_fetch_pvs"
1924 Like "refcounted_he_fetch_pvn", but takes a literal string
1925 instead of a string/length pair, and no precomputed hash.
1926 .RS 4
1927 .Sp
1928 .Vb 2
1929 \& SV * refcounted_he_fetch_pvs(const struct refcounted_he *chain,
1930 \& "key", U32 flags)
1931 .Ve
1932 .RE
1933 .RS 4
1934 .RE
1935 .ie n .IP """refcounted_he_fetch_sv""" 4
1936 .el .IP \f(CWrefcounted_he_fetch_sv\fR 4
1937 .IX Xref "refcounted_he_fetch_sv"
1938 .IX Item "refcounted_he_fetch_sv"
1939 Like "refcounted_he_fetch_pvn", but takes a Perl scalar instead of a
1940 string/length pair.
1941 .RS 4
1942 .Sp
1943 .Vb 6
1944 \& SV * refcounted_he_fetch_sv(
1945 \& const struct refcounted_he *chain,
1946 \& SV *key, U32 hash, U32 flags)
1947 \& SV * Perl_refcounted_he_fetch_sv(pTHX_
1948 \& const struct refcounted_he *chain,
1949 \& SV *key, U32 hash, U32 flags)
1950 .Ve
1951 .RE
1952 .RS 4
1953 .RE
1954 .ie n .IP """refcounted_he_free""" 4
1955 .el .IP \f(CWrefcounted_he_free\fR 4
1956 .IX Xref "refcounted_he_free"
1957 .IX Item "refcounted_he_free"
1958 Decrements the reference count of a \f(CW\*(C`refcounted_he\*(C'\fR by one. If the
1959 reference count reaches zero the structure\*(Aqs memory is freed, which
1960 (recursively) causes a reduction of its parent \f(CW\*(C`refcounted_he\*(C'\fR\*(Aqs
1961 reference count. It is safe to pass a null pointer to this function:
1962 no action occurs in this case.
1963 .RS 4
1964 .Sp
1965 .Vb 2
1966 \& void refcounted_he_free( struct refcounted_he *he)
1967 \& void Perl_refcounted_he_free(pTHX_ struct refcounted_he *he)
1968 .Ve
1969 .RE
1970 .RS 4
1971 .RE
1972 .ie n .IP """refcounted_he_inc""" 4
1973 .el .IP \f(CWrefcounted_he_inc\fR 4
1974 .IX Xref "refcounted_he_inc"
1975 .IX Item "refcounted_he_inc"
1976 Increment the reference count of a \f(CW\*(C`refcounted_he\*(C'\fR. The pointer to the
1977 \&\f(CW\*(C`refcounted_he\*(C'\fR is also returned. It is safe to pass a null pointer
1978 to this function: no action occurs and a null pointer is returned.
1979 .RS 4
1980 .Sp
1981 .Vb 4
1982 \& struct refcounted_he * refcounted_he_inc(
1983 \& struct refcounted_he *he)
1984 \& struct refcounted_he * Perl_refcounted_he_inc(pTHX_
1985 \& struct refcounted_he *he)
1986 .Ve
1987 .RE
1988 .RS 4
1989 .RE
1990 .ie n .IP """refcounted_he_new_pv""" 4
1991 .el .IP \f(CWrefcounted_he_new_pv\fR 4
1992 .IX Xref "refcounted_he_new_pv"
1993 .IX Item "refcounted_he_new_pv"
1994 Like "refcounted_he_new_pvn", but takes a nul\-terminated string instead
1995 of a string/length pair.
1996 .RS 4
1997 .Sp
1998 .Vb 8
1999 \& struct refcounted_he * refcounted_he_new_pv(
2000 \& struct refcounted_he *parent,
2001 \& const char *key, U32 hash,
2002 \& SV *value, U32 flags)
2003 \& struct refcounted_he * Perl_refcounted_he_new_pv(pTHX_
2004 \& struct refcounted_he *parent,
2005 \& const char *key, U32 hash,
2006 \& SV *value, U32 flags)
2007 .Ve
2008 .RE
2009 .RS 4
2010 .RE
2011 .ie n .IP """refcounted_he_new_pvn""" 4
2012 .el .IP \f(CWrefcounted_he_new_pvn\fR 4
2013 .IX Xref "refcounted_he_new_pvn"
2014 .IX Item "refcounted_he_new_pvn"
2015 Creates a new \f(CW\*(C`refcounted_he\*(C'\fR. This consists of a single key/value
2016 pair and a reference to an existing \f(CW\*(C`refcounted_he\*(C'\fR chain (which may
2017 be empty), and thus forms a longer chain. When using the longer chain,
2018 the new key/value pair takes precedence over any entry for the same key
2019 further along the chain.
2020 .Sp
2021 The new key is specified by \f(CW\*(C`keypv\*(C'\fR and \f(CW\*(C`keylen\*(C'\fR. If \f(CW\*(C`flags\*(C'\fR has
2022 the \f(CW\*(C`REFCOUNTED_HE_KEY_UTF8\*(C'\fR bit set, the key octets are interpreted
2023 as UTF\-8, otherwise they are interpreted as Latin\-1. \f(CW\*(C`hash\*(C'\fR is
2024 a precomputed hash of the key string, or zero if it has not been
2025 precomputed.
2026 .Sp
2027 \&\f(CW\*(C`value\*(C'\fR is the scalar value to store for this key. \f(CW\*(C`value\*(C'\fR is copied
2028 by this function, which thus does not take ownership of any reference
2029 to it, and later changes to the scalar will not be reflected in the
2030 value visible in the \f(CW\*(C`refcounted_he\*(C'\fR. Complex types of scalar will not
2031 be stored with referential integrity, but will be coerced to strings.
2032 \&\f(CW\*(C`value\*(C'\fR may be either null or \f(CW&PL_sv_placeholder\fR to indicate that no
2033 value is to be associated with the key; this, as with any non\-null value,
2034 takes precedence over the existence of a value for the key further along
2035 the chain.
2036 .Sp
2037 \&\f(CW\*(C`parent\*(C'\fR points to the rest of the \f(CW\*(C`refcounted_he\*(C'\fR chain to be
2038 attached to the new \f(CW\*(C`refcounted_he\*(C'\fR. This function takes ownership
2039 of one reference to \f(CW\*(C`parent\*(C'\fR, and returns one reference to the new
2040 \&\f(CW\*(C`refcounted_he\*(C'\fR.
2041 .RS 4
2042 .Sp
2043 .Vb 10
2044 \& struct refcounted_he * refcounted_he_new_pvn(
2045 \& struct refcounted_he *parent,
2046 \& const char *keypv,
2047 \& STRLEN keylen, U32 hash,
2048 \& SV *value, U32 flags)
2049 \& struct refcounted_he * Perl_refcounted_he_new_pvn(pTHX_
2050 \& struct refcounted_he *parent,
2051 \& const char *keypv,
2052 \& STRLEN keylen, U32 hash,
2053 \& SV *value, U32 flags)
2054 .Ve
2055 .RE
2056 .RS 4
2057 .RE
2058 .ie n .IP """refcounted_he_new_pvs""" 4
2059 .el .IP \f(CWrefcounted_he_new_pvs\fR 4
2060 .IX Xref "refcounted_he_new_pvs"
2061 .IX Item "refcounted_he_new_pvs"
2062 Like "refcounted_he_new_pvn", but takes a literal string
2063 instead of a string/length pair, and no precomputed hash.
2064 .RS 4
2065 .Sp
2066 .Vb 3
2067 \& struct refcounted_he * refcounted_he_new_pvs(
2068 \& struct refcounted_he *parent,
2069 \& "key", SV *value, U32 flags)
2070 .Ve
2071 .RE
2072 .RS 4
2073 .RE
2074 .ie n .IP """refcounted_he_new_sv""" 4
2075 .el .IP \f(CWrefcounted_he_new_sv\fR 4
2076 .IX Xref "refcounted_he_new_sv"
2077 .IX Item "refcounted_he_new_sv"
2078 Like "refcounted_he_new_pvn", but takes a Perl scalar instead of a
2079 string/length pair.
2080 .RS 4
2081 .Sp
2082 .Vb 8
2083 \& struct refcounted_he * refcounted_he_new_sv(
2084 \& struct refcounted_he *parent,
2085 \& SV *key, U32 hash, SV *value,
2086 \& U32 flags)
2087 \& struct refcounted_he * Perl_refcounted_he_new_sv(pTHX_
2088 \& struct refcounted_he *parent,
2089 \& SV *key, U32 hash, SV *value,
2090 \& U32 flags)
2091 .Ve
2092 .RE
2093 .RS 4
2094 .RE
2095 .ie n .IP """unsharepvn""" 4
2096 .el .IP \f(CWunsharepvn\fR 4
2097 .IX Xref "unsharepvn"
2098 .IX Item "unsharepvn"
2099 If no one has access to shared string \f(CW\*(C`str\*(C'\fR with length \f(CW\*(C`len\*(C'\fR, free it.
2100 .Sp
2101 \&\f(CW\*(C`len\*(C'\fR and \f(CW\*(C`hash\*(C'\fR must both be valid for \f(CW\*(C`str\*(C'\fR.
2102 .RS 4
2103 .Sp
2104 .Vb 2
2105 \& void unsharepvn( const char *sv, I32 len, U32 hash)
2106 \& void Perl_unsharepvn(pTHX_ const char *sv, I32 len, U32 hash)
2107 .Ve
2108 .RE
2109 .RS 4
2110 .RE
2111 .SH Input/Output
2112 .IX Header "Input/Output"
2113 .ie n .IP """dirp_dup""" 4
2114 .el .IP \f(CWdirp_dup\fR 4
2115 .IX Xref "dirp_dup"
2116 .IX Item "dirp_dup"
2117 Duplicate a directory handle, returning a pointer to the cloned object.
2118 .RS 4
2119 .Sp
2120 .Vb 4
2121 \& DIR * dirp_dup( DIR * const dp,
2122 \& CLONE_PARAMS * const param)
2123 \& DIR * Perl_dirp_dup(pTHX_ DIR * const dp,
2124 \& CLONE_PARAMS * const param)
2125 .Ve
2126 .RE
2127 .RS 4
2128 .RE
2129 .ie n .IP """fp_dup""" 4
2130 .el .IP \f(CWfp_dup\fR 4
2131 .IX Xref "fp_dup"
2132 .IX Item "fp_dup"
2133 Duplicate a file handle, returning a pointer to the cloned object.
2134 .RS 4
2135 .Sp
2136 .Vb 4
2137 \& PerlIO * fp_dup( PerlIO * const fp, const char type,
2138 \& CLONE_PARAMS * const param)
2139 \& PerlIO * Perl_fp_dup(pTHX_ PerlIO * const fp, const char type,
2140 \& CLONE_PARAMS * const param)
2141 .Ve
2142 .RE
2143 .RS 4
2144 .RE
2145 .ie n .IP """my_fflush_all""" 4
2146 .el .IP \f(CWmy_fflush_all\fR 4
2147 .IX Xref "my_fflush_all"
2148 .IX Item "my_fflush_all"
2149 Implements \f(CW\*(C`PERL_FLUSHALL_FOR_CHILD\*(C'\fR on some platforms.
2150 .RS 4
2151 .Sp
2152 .Vb 2
2153 \& I32 my_fflush_all()
2154 \& I32 Perl_my_fflush_all(pTHX)
2155 .Ve
2156 .RE
2157 .RS 4
2158 .RE
2159 .ie n .IP """my_mkostemp""" 4
2160 .el .IP \f(CWmy_mkostemp\fR 4
2161 .IX Xref "my_mkostemp"
2162 .IX Item "my_mkostemp"
2163 The C library \f(CW\*(C`\fR\f(CBmkostemp\fR\f(CW\|(3)\*(C'\fR if available, or a Perl implementation of it.
2164 .RS 4
2165 .Sp
2166 .Vb 1
2167 \& int Perl_my_mkostemp(char *templte, int flags)
2168 .Ve
2169 .RE
2170 .RS 4
2171 .RE
2172 .ie n .IP """my_mkstemp""" 4
2173 .el .IP \f(CWmy_mkstemp\fR 4
2174 .IX Xref "my_mkstemp"
2175 .IX Item "my_mkstemp"
2176 The C library \f(CW\*(C`\fR\f(CBmkstemp\fR\f(CW\|(3)\*(C'\fR if available, or a Perl implementation of it.
2177 .RS 4
2178 .Sp
2179 .Vb 1
2180 \& int Perl_my_mkstemp(char *templte)
2181 .Ve
2182 .RE
2183 .RS 4
2184 .RE
2185 .ie n .IP """PL_last_in_gv""" 4
2186 .el .IP \f(CWPL_last_in_gv\fR 4
2187 .IX Xref "PL_last_in_gv"
2188 .IX Item "PL_last_in_gv"
2189 The GV which was last used for a filehandle input operation. (\f(CW\*(C`<FH>\*(C'\fR)
2190 .Sp
2191 On threaded perls, each thread has an independent copy of this variable;
2192 each initialized at creation time with the current value of the creating
2193 thread\*(Aqs copy.
2194 .RS 4
2195 .Sp
2196 .Vb 1
2197 \& GV* PL_last_in_gv
2198 .Ve
2199 .RE
2200 .RS 4
2201 .RE
2202 .ie n .IP """PL_ofsgv""" 4
2203 .el .IP \f(CWPL_ofsgv\fR 4
2204 .IX Xref "PL_ofsgv"
2205 .IX Item "PL_ofsgv"
2206 The glob containing the output field separator \- \f(CW\*(C`*,\*(C'\fR in Perl space.
2207 .Sp
2208 On threaded perls, each thread has an independent copy of this variable;
2209 each initialized at creation time with the current value of the creating
2210 thread\*(Aqs copy.
2211 .RS 4
2212 .Sp
2213 .Vb 1
2214 \& GV* PL_ofsgv
2215 .Ve
2216 .RE
2217 .RS 4
2218 .RE
2219 .ie n .IP """PL_rs""" 4
2220 .el .IP \f(CWPL_rs\fR 4
2221 .IX Xref "PL_rs"
2222 .IX Item "PL_rs"
2223 The input record separator \- \f(CW$/\fR in Perl space.
2224 .Sp
2225 On threaded perls, each thread has an independent copy of this variable;
2226 each initialized at creation time with the current value of the creating
2227 thread\*(Aqs copy.
2228 .RS 4
2229 .Sp
2230 .Vb 1
2231 \& SV* PL_rs
2232 .Ve
2233 .RE
2234 .RS 4
2235 .RE
2236 .ie n .IP """start_glob""" 4
2237 .el .IP \f(CWstart_glob\fR 4
2238 .IX Xref "start_glob"
2239 .IX Item "start_glob"
2240 NOTE: \f(CW\*(C`start_glob\*(C'\fR is \fBexperimental\fR and may change or be
2241 removed without notice.
2242 .Sp
2243 Function called by \f(CW\*(C`do_readline\*(C'\fR to spawn a glob (or do the glob inside
2244 perl on VMS). This code used to be inline, but now perl uses \f(CW\*(C`File::Glob\*(C'\fR
2245 this glob starter is only used by miniperl during the build process,
2246 or when PERL_EXTERNAL_GLOB is defined.
2247 Moving it away shrinks \fIpp_hot.c\fR; shrinking \fIpp_hot.c\fR helps speed perl up.
2248 .RS 4
2249 .Sp
2250 .Vb 1
2251 \& PerlIO * Perl_start_glob(pTHX_ SV *tmpglob, IO *io)
2252 .Ve
2253 .RE
2254 .RS 4
2255 .RE
2256 .SH Integer
2257 .IX Header "Integer"
2258 .ie n .IP """ABS_IV_MIN""" 4
2259 .el .IP \f(CWABS_IV_MIN\fR 4
2260 .IX Xref "ABS_IV_MIN"
2261 .IX Item "ABS_IV_MIN"
2262 Returns the absolute value of "\f(CW\*(C`IV_MIN\*(C'\fR" in perlapi, suitable for use in a UV
2263 .RS 4
2264 .Sp
2265 .Vb 1
2266 \& UV ABS_IV_MIN
2267 .Ve
2268 .RE
2269 .RS 4
2270 .RE
2271 .ie n .IP """NEGATE_2IV""" 4
2272 .el .IP \f(CWNEGATE_2IV\fR 4
2273 .IX Xref "NEGATE_2IV"
2274 .IX Item "NEGATE_2IV"
2275 Returns the negative value of \f(CW\*(C`uv\*(C'\fR, which must be non\-negative, for use in an
2276 IV. The results are undefined if that value would be less than
2277 "\f(CW\*(C`IV_MIN\*(C'\fR" in perlapi. This macro is needed because naively saying \f(CW\*(C`\-uv\*(C'\fR gives
2278 undefined behavior when \f(CW\*(C`uv\*(C'\fR is equal to \f(CW"ABS_IV_MIN"\fR.
2279 .RS 4
2280 .Sp
2281 .Vb 1
2282 \& IV NEGATE_2IV(UV uv)
2283 .Ve
2284 .RE
2285 .RS 4
2286 .RE
2287 .ie n .IP """NEGATE_2UV""" 4
2288 .el .IP \f(CWNEGATE_2UV\fR 4
2289 .IX Xref "NEGATE_2UV"
2290 .IX Item "NEGATE_2UV"
2291 Returns the absolute value of \f(CW\*(C`iv\*(C'\fR, which must be negative, while avoiding
2292 undefined behavior even if \f(CW\*(C`iv\*(C'\fR is "\f(CW\*(C`IV_MIN\*(C'\fR" in perlapi.
2293 .RS 4
2294 .Sp
2295 .Vb 1
2296 \& UV NEGATE_2UV(IV iv)
2297 .Ve
2298 .RE
2299 .RS 4
2300 .RE
2301 .SH "I/O Formats"
2302 .IX Header "I/O Formats"
2303 There are currently no internal API items in I/O Formats
2304 .SH "Lexer interface"
2305 .IX Header "Lexer interface"
2306 .ie n .IP """validate_proto""" 4
2307 .el .IP \f(CWvalidate_proto\fR 4
2308 .IX Xref "validate_proto"
2309 .IX Item "validate_proto"
2310 NOTE: \f(CW\*(C`validate_proto\*(C'\fR is \fBexperimental\fR and may change or be
2311 removed without notice.
2312 .Sp
2313 This function performs syntax checking on a prototype, \f(CW\*(C`proto\*(C'\fR.
2314 If \f(CW\*(C`warn\*(C'\fR is true, any illegal characters or mismatched brackets
2315 will trigger illegalproto warnings, declaring that they were
2316 detected in the prototype for \f(CW\*(C`name\*(C'\fR.
2317 .Sp
2318 The return value is \f(CW\*(C`true\*(C'\fR if this is a valid prototype, and
2319 \&\f(CW\*(C`false\*(C'\fR if it is not, regardless of whether \f(CW\*(C`warn\*(C'\fR was \f(CW\*(C`true\*(C'\fR or
2320 \&\f(CW\*(C`false\*(C'\fR.
2321 .Sp
2322 Note that \f(CW\*(C`NULL\*(C'\fR is a valid \f(CW\*(C`proto\*(C'\fR and will always return \f(CW\*(C`true\*(C'\fR.
2323 .RS 4
2324 .Sp
2325 .Vb 4
2326 \& bool validate_proto( SV *name, SV *proto, bool warn,
2327 \& bool curstash)
2328 \& bool Perl_validate_proto(pTHX_ SV *name, SV *proto, bool warn,
2329 \& bool curstash)
2330 .Ve
2331 .RE
2332 .RS 4
2333 .RE
2334 .SH Locales
2335 .IX Header "Locales"
2336 There are currently no internal API items in Locales
2337 .SH Magic
2338 .IX Header "Magic"
2339 .ie n .IP """magic_clearhint""" 4
2340 .el .IP \f(CWmagic_clearhint\fR 4
2341 .IX Xref "magic_clearhint"
2342 .IX Item "magic_clearhint"
2343 Triggered by a delete from \f(CW\*(C`%^H\*(C'\fR, records the key to
2344 \&\f(CW\*(C`PL_compiling.cop_hints_hash\*(C'\fR.
2345 .RS 4
2346 .Sp
2347 .Vb 2
2348 \& int magic_clearhint( SV *sv, MAGIC *mg)
2349 \& int Perl_magic_clearhint(pTHX_ SV *sv, MAGIC *mg)
2350 .Ve
2351 .RE
2352 .RS 4
2353 .RE
2354 .ie n .IP """magic_clearhints""" 4
2355 .el .IP \f(CWmagic_clearhints\fR 4
2356 .IX Xref "magic_clearhints"
2357 .IX Item "magic_clearhints"
2358 Triggered by clearing \f(CW\*(C`%^H\*(C'\fR, resets \f(CW\*(C`PL_compiling.cop_hints_hash\*(C'\fR.
2359 .RS 4
2360 .Sp
2361 .Vb 2
2362 \& int magic_clearhints( SV *sv, MAGIC *mg)
2363 \& int Perl_magic_clearhints(pTHX_ SV *sv, MAGIC *mg)
2364 .Ve
2365 .RE
2366 .RS 4
2367 .RE
2368 .ie n .IP """magic_methcall""" 4
2369 .el .IP \f(CWmagic_methcall\fR 4
2370 .IX Xref "magic_methcall"
2371 .IX Item "magic_methcall"
2372 Invoke a magic method (like FETCH).
2373 .Sp
2374 \&\f(CW\*(C`sv\*(C'\fR and \f(CW\*(C`mg\*(C'\fR are the tied thingy and the tie magic.
2375 .Sp
2376 \&\f(CW\*(C`meth\*(C'\fR is the name of the method to call.
2377 .Sp
2378 \&\f(CW\*(C`argc\*(C'\fR is the number of args (in addition to \f(CW$self\fR) to pass to the method.
2379 .Sp
2380 The \f(CW\*(C`flags\*(C'\fR can be:
2381 .Sp
2382 .Vb 4
2383 \& G_DISCARD invoke method with G_DISCARD flag and don\*(Aqt
2384 \& return a value
2385 \& G_UNDEF_FILL fill the stack with argc pointers to
2386 \& PL_sv_undef
2387 .Ve
2388 .Sp
2389 The arguments themselves are any values following the \f(CW\*(C`flags\*(C'\fR argument.
2390 .Sp
2391 Returns the SV (if any) returned by the method, or \f(CW\*(C`NULL\*(C'\fR on failure.
2392 .RS 4
2393 .Sp
2394 .Vb 3
2395 \& SV * Perl_magic_methcall(pTHX_ SV *sv, const MAGIC *mg,
2396 \& SV *meth, U32 flags, U32 argc,
2397 \& ...)
2398 .Ve
2399 .RE
2400 .RS 4
2401 .RE
2402 .ie n .IP """magic_sethint""" 4
2403 .el .IP \f(CWmagic_sethint\fR 4
2404 .IX Xref "magic_sethint"
2405 .IX Item "magic_sethint"
2406 Triggered by a store to \f(CW\*(C`%^H\*(C'\fR, records the key/value pair to
2407 \&\f(CW\*(C`PL_compiling.cop_hints_hash\*(C'\fR. It is assumed that hints aren\*(Aqt storing
2408 anything that would need a deep copy. Maybe we should warn if we find a
2409 reference.
2410 .RS 4
2411 .Sp
2412 .Vb 2
2413 \& int magic_sethint( SV *sv, MAGIC *mg)
2414 \& int Perl_magic_sethint(pTHX_ SV *sv, MAGIC *mg)
2415 .Ve
2416 .RE
2417 .RS 4
2418 .RE
2419 .ie n .IP """mg_dup""" 4
2420 .el .IP \f(CWmg_dup\fR 4
2421 .IX Xref "mg_dup"
2422 .IX Item "mg_dup"
2423 Duplicate a chain of magic, returning a pointer to the cloned object.
2424 .RS 4
2425 .Sp
2426 .Vb 2
2427 \& MAGIC * mg_dup( MAGIC *mg, CLONE_PARAMS * const param)
2428 \& MAGIC * Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS * const param)
2429 .Ve
2430 .RE
2431 .RS 4
2432 .RE
2433 .ie n .IP """mg_localize""" 4
2434 .el .IP \f(CWmg_localize\fR 4
2435 .IX Xref "mg_localize"
2436 .IX Item "mg_localize"
2437 Copy some of the magic from an existing SV to new localized version of that
2438 SV. Container magic (\fIe.g.\fR, \f(CW%ENV\fR, \f(CW$1\fR, \f(CW\*(C`tie\*(C'\fR)
2439 gets copied, value magic doesn\*(Aqt (\fIe.g.\fR,
2440 \&\f(CW\*(C`taint\*(C'\fR, \f(CW\*(C`pos\*(C'\fR).
2441 .Sp
2442 If \f(CW\*(C`setmagic\*(C'\fR is false then no set magic will be called on the new (empty) SV.
2443 This typically means that assignment will soon follow (e.g. \f(CW\*(Aqlocal\ $x\ =\ $y\*(Aq\fR),
2444 and that will handle the magic.
2445 .RS 4
2446 .Sp
2447 .Vb 2
2448 \& void mg_localize( SV *sv, SV *nsv, bool setmagic)
2449 \& void Perl_mg_localize(pTHX_ SV *sv, SV *nsv, bool setmagic)
2450 .Ve
2451 .RE
2452 .RS 4
2453 .RE
2454 .SH "Memory Management"
2455 .IX Header "Memory Management"
2456 .ie n .IP """calloc""" 4
2457 .el .IP \f(CWcalloc\fR 4
2458 .IX Xref "calloc"
2459 .IX Item "calloc"
2460 Implements "\f(CW\*(C`Newxz\*(C'\fR" in perlapi which you should use instead.
2461 .RS 4
2462 .Sp
2463 .Vb 1
2464 \& Malloc_t Perl_calloc(MEM_SIZE elements, MEM_SIZE size)
2465 .Ve
2466 .RE
2467 .RS 4
2468 .RE
2469 .ie n .IP """malloc""" 4
2470 .el .IP \f(CWmalloc\fR 4
2471 .IX Xref "malloc"
2472 .IX Item "malloc"
2473 Implements "\f(CW\*(C`Newx\*(C'\fR" in perlapi which you should use instead.
2474 .RS 4
2475 .Sp
2476 .Vb 1
2477 \& Malloc_t Perl_malloc(MEM_SIZE nbytes)
2478 .Ve
2479 .RE
2480 .RS 4
2481 .RE
2482 .ie n .IP """mfree""" 4
2483 .el .IP \f(CWmfree\fR 4
2484 .IX Xref "mfree"
2485 .IX Item "mfree"
2486 Implements "\f(CW\*(C`Safefree\*(C'\fR" in perlapi which you should use instead.
2487 .RS 4
2488 .Sp
2489 .Vb 1
2490 \& Free_t Perl_mfree(Malloc_t where)
2491 .Ve
2492 .RE
2493 .RS 4
2494 .RE
2495 .ie n .IP """realloc""" 4
2496 .el .IP \f(CWrealloc\fR 4
2497 .IX Xref "realloc"
2498 .IX Item "realloc"
2499 Implements "\f(CW\*(C`Renew\*(C'\fR" in perlapi which you should use instead.
2500 .RS 4
2501 .Sp
2502 .Vb 1
2503 \& Malloc_t Perl_realloc(Malloc_t where, MEM_SIZE nbytes)
2504 .Ve
2505 .RE
2506 .RS 4
2507 .RE
2508 .SH MRO
2509 .IX Header "MRO"
2510 .ie n .IP """mro_get_linear_isa_dfs""" 4
2511 .el .IP \f(CWmro_get_linear_isa_dfs\fR 4
2512 .IX Xref "mro_get_linear_isa_dfs"
2513 .IX Item "mro_get_linear_isa_dfs"
2514 Returns the Depth\-First Search linearization of \f(CW@ISA\fR
2515 the given stash. The return value is a read\-only AV*
2516 whose elements are string SVs giving class names.
2517 \&\f(CW\*(C`level\*(C'\fR should be 0 (it is used internally in this
2518 function\*(Aqs recursion).
2519 .Sp
2520 You are responsible for \f(CWSvREFCNT_inc()\fR on the
2521 return value if you plan to store it anywhere
2522 semi\-permanently (otherwise it might be deleted
2523 out from under you the next time the cache is
2524 invalidated).
2525 .RS 4
2526 .Sp
2527 .Vb 1
2528 \& AV * mro_get_linear_isa_dfs(HV *stash, U32 level)
2529 .Ve
2530 .RE
2531 .RS 4
2532 .RE
2533 .ie n .IP """mro_isa_changed_in""" 4
2534 .el .IP \f(CWmro_isa_changed_in\fR 4
2535 .IX Xref "mro_isa_changed_in"
2536 .IX Item "mro_isa_changed_in"
2537 Takes the necessary steps (cache invalidations, mostly)
2538 when the \f(CW@ISA\fR of the given package has changed. Invoked
2539 by the \f(CW\*(C`setisa\*(C'\fR magic, should not need to invoke directly.
2540 .RS 4
2541 .Sp
2542 .Vb 2
2543 \& void mro_isa_changed_in( HV *stash)
2544 \& void Perl_mro_isa_changed_in(pTHX_ HV *stash)
2545 .Ve
2546 .RE
2547 .RS 4
2548 .RE
2549 .ie n .IP """mro_package_moved""" 4
2550 .el .IP \f(CWmro_package_moved\fR 4
2551 .IX Xref "mro_package_moved"
2552 .IX Item "mro_package_moved"
2553 Call this function to signal to a stash that it has been assigned to
2554 another spot in the stash hierarchy. \f(CW\*(C`stash\*(C'\fR is the stash that has been
2555 assigned. \f(CW\*(C`oldstash\*(C'\fR is the stash it replaces, if any. \f(CW\*(C`gv\*(C'\fR is the glob
2556 that is actually being assigned to.
2557 .Sp
2558 This can also be called with a null first argument to
2559 indicate that \f(CW\*(C`oldstash\*(C'\fR has been deleted.
2560 .Sp
2561 This function invalidates isa caches on the old stash, on all subpackages
2562 nested inside it, and on the subclasses of all those, including
2563 non\-existent packages that have corresponding entries in \f(CW\*(C`stash\*(C'\fR.
2564 .Sp
2565 It also sets the effective names (\f(CW\*(C`HvENAME\*(C'\fR) on all the stashes as
2566 appropriate.
2567 .Sp
2568 If the \f(CW\*(C`gv\*(C'\fR is present and is not in the symbol table, then this function
2569 simply returns. This checked will be skipped if \f(CW\*(C`flags & 1\*(C'\fR.
2570 .RS 4
2571 .Sp
2572 .Vb 8
2573 \& void mro_package_moved( HV * const stash,
2574 \& HV * const oldstash,
2575 \& const GV * const gv,
2576 \& U32 flags)
2577 \& void Perl_mro_package_moved(pTHX_ HV * const stash,
2578 \& HV * const oldstash,
2579 \& const GV * const gv,
2580 \& U32 flags)
2581 .Ve
2582 .RE
2583 .RS 4
2584 .RE
2585 .SH "Multicall Functions"
2586 .IX Header "Multicall Functions"
2587 There are currently no internal API items in Multicall Functions
2588 .SH "Numeric Functions"
2589 .IX Header "Numeric Functions"
2590 .ie n .IP """isinfnansv""" 4
2591 .el .IP \f(CWisinfnansv\fR 4
2592 .IX Xref "isinfnansv"
2593 .IX Item "isinfnansv"
2594 Checks whether the argument would be either an infinity or \f(CW\*(C`NaN\*(C'\fR when used
2595 as a number, but is careful not to trigger non\-numeric or uninitialized
2596 warnings. it assumes the caller has done \f(CWSvGETMAGIC(sv)\fR already.
2597 .Sp
2598 Note that this always accepts trailing garbage (similar to \f(CW\*(C`grok_number_flags\*(C'\fR
2599 with \f(CW\*(C`PERL_SCAN_TRAILING\*(C'\fR), so \f(CW"inferior"\fR and \f(CW"NAND gates"\fR will
2600 return true.
2601 .RS 4
2602 .Sp
2603 .Vb 2
2604 \& bool isinfnansv( SV *sv)
2605 \& bool Perl_isinfnansv(pTHX_ SV *sv)
2606 .Ve
2607 .RE
2608 .RS 4
2609 .RE
2610 .ie n .IP """S_perl_hash_siphash_1_3""" 4
2611 .el .IP \f(CWS_perl_hash_siphash_1_3\fR 4
2612 .IX Xref "S_perl_hash_siphash_1_3"
2613 .IX Item "S_perl_hash_siphash_1_3"
2614 Implements the variant of Siphash which performs 1 round function
2615 per block, and 3 as part of the finalizer.
2616 .Sp
2617 Takes a 16 byte \f(CW\*(C`seed\*(C'\fR vector, and uses it to hash \f(CW\*(C`inlen\*(C'\fR bytes
2618 from the buffer pointed to by \f(CW\*(C`in\*(C'\fR, returns a 32 bit hash.
2619 .Sp
2620 The following code should return 0x2976B3A1
2621 .Sp
2622 .Vb 4
2623 \& char seed[] = "Call me Ishmael.";
2624 \& char in[] = "It is not down on any map; true places never are.";
2625 \& U32 hash = S_perl_hash_siphash_1_3(
2626 \& (const U8*)seed, (const U8*)in, sizeof(in)\-1);
2627 .Ve
2628 .RS 4
2629 .Sp
2630 .Vb 4
2631 \& U64 S_perl_hash_siphash_1_3(const unsigned char * const seed,
2632 \& const unsigned char *in,
2633 \& const STRLEN inlen
2634 \&)
2635 .Ve
2636 .RE
2637 .RS 4
2638 .RE
2639 .ie n .IP """S_perl_hash_siphash_1_3_with_state""" 4
2640 .el .IP \f(CWS_perl_hash_siphash_1_3_with_state\fR 4
2641 .IX Xref "S_perl_hash_siphash_1_3_with_state"
2642 .IX Item "S_perl_hash_siphash_1_3_with_state"
2643 Implements the variant of Siphash which performs 1 round function
2644 per block, and 3 as part of the finalizer.
2645 .Sp
2646 Takes a 32 byte \*(Aqstate\*(Aq vector prepared by \fBS_perl_siphash_seed_state()\fR
2647 and uses it to hash \f(CW\*(C`inlen\*(C'\fR bytes from the buffer pointed to by \f(CW\*(C`in\*(C'\fR,
2648 returns a 32 bit hash.
2649 .Sp
2650 The following code should return 0x2976B3A1
2651 .Sp
2652 .Vb 3
2653 \& U8 state[32];
2654 \& char seed[] = "Call me Ishmael.";
2655 \& S_perl_siphash_seed_state((const U8*)seed, state);
2656 \&
2657 \& char in[] = "It is not down on any map; true places never are.";
2658 \& U32 hash = S_perl_hash_siphash_1_3_with_state(
2659 \& state, (const U8*)in, sizeof(in)\-1);
2660 .Ve
2661 .RS 4
2662 .Sp
2663 .Vb 5
2664 \& U32 S_perl_hash_siphash_1_3_with_state(
2665 \& const unsigned char * const state,
2666 \& const unsigned char *in,
2667 \& const STRLEN inlen
2668 \&)
2669 .Ve
2670 .RE
2671 .RS 4
2672 .RE
2673 .ie n .IP """S_perl_hash_siphash_1_3_with_state_64""" 4
2674 .el .IP \f(CWS_perl_hash_siphash_1_3_with_state_64\fR 4
2675 .IX Xref "S_perl_hash_siphash_1_3_with_state_64"
2676 .IX Item "S_perl_hash_siphash_1_3_with_state_64"
2677 Implements the variant of Siphash which performs 1 round function
2678 per block, and 3 as part of the finalizer.
2679 .Sp
2680 Takes a 32 byte \*(Aqstate\*(Aq vector prepared by \fBS_perl_siphash_seed_state()\fR
2681 and uses it to hash \f(CW\*(C`inlen\*(C'\fR bytes from the buffer pointed to by \f(CW\*(C`in\*(C'\fR,
2682 returns a 64 bit hash.
2683 .Sp
2684 The following code should return 0xB70339FD9E758A5C
2685 .Sp
2686 .Vb 3
2687 \& U8 state[32];
2688 \& char seed[] = "Call me Ishmael.";
2689 \& S_perl_siphash_seed_state((const U8*)seed, state);
2690 \&
2691 \& char in[] = "It is not down on any map; true places never are.";
2692 \& U64 hash = S_perl_hash_siphash_1_3_with_state_64(
2693 \& state, (const U8*)in, sizeof(in)\-1);
2694 .Ve
2695 .RS 4
2696 .Sp
2697 .Vb 5
2698 \& U64 S_perl_hash_siphash_1_3_with_state_64(
2699 \& const unsigned char * const state,
2700 \& const unsigned char *in,
2701 \& const STRLEN inlen
2702 \&)
2703 .Ve
2704 .RE
2705 .RS 4
2706 .RE
2707 .ie n .IP """S_perl_hash_siphash_1_3_64""" 4
2708 .el .IP \f(CWS_perl_hash_siphash_1_3_64\fR 4
2709 .IX Xref "S_perl_hash_siphash_1_3_64"
2710 .IX Item "S_perl_hash_siphash_1_3_64"
2711 Implements the variant of Siphash which performs 1 round function
2712 per block, and 3 as part of the finalizer.
2713 .Sp
2714 Takes a 16 byte \f(CW\*(C`seed\*(C'\fR vector, and uses it to hash \f(CW\*(C`inlen\*(C'\fR bytes
2715 from the buffer pointed to by \f(CW\*(C`in\*(C'\fR, returns a 64 bit hash.
2716 .Sp
2717 The following code should return 0xB70339FD9E758A5C
2718 .Sp
2719 .Vb 4
2720 \& char seed[] = "Call me Ishmael.";
2721 \& char in[] = "It is not down on any map; true places never are.";
2722 \& U64 hash = S_perl_hash_siphash_1_3_64(
2723 \& (const U8*)seed, (const U8*)in, sizeof(in)\-1);
2724 .Ve
2725 .RS 4
2726 .Sp
2727 .Vb 4
2728 \& U64 S_perl_hash_siphash_1_3_64(const unsigned char * const seed,
2729 \& const unsigned char *in,
2730 \& const STRLEN inlen
2731 \&)
2732 .Ve
2733 .RE
2734 .RS 4
2735 .RE
2736 .ie n .IP """S_perl_hash_siphash_2_4""" 4
2737 .el .IP \f(CWS_perl_hash_siphash_2_4\fR 4
2738 .IX Xref "S_perl_hash_siphash_2_4"
2739 .IX Item "S_perl_hash_siphash_2_4"
2740 Implements the variant of Siphash which performs 2 round functions
2741 per block, and 4 as part of the finalizer.
2742 .Sp
2743 Takes a 16 byte \f(CW\*(C`seed\*(C'\fR vector, and uses it to hash \f(CW\*(C`inlen\*(C'\fR bytes
2744 from the buffer pointed to by \f(CW\*(C`in\*(C'\fR, returns a 32 bit hash.
2745 .Sp
2746 The following code should return 0x6421D9AA
2747 .Sp
2748 .Vb 4
2749 \& char seed[] = "Call me Ishmael.";
2750 \& char in[] = "It is not down on any map; true places never are.";
2751 \& U32 hash = S_perl_hash_siphash_2_4(
2752 \& (const U8*)seed, (const U8*)in, sizeof(in)\-1);
2753 .Ve
2754 .RS 4
2755 .Sp
2756 .Vb 4
2757 \& U32 S_perl_hash_siphash_2_4(const unsigned char * const seed,
2758 \& const unsigned char *in,
2759 \& const STRLEN inlen
2760 \&)
2761 .Ve
2762 .RE
2763 .RS 4
2764 .RE
2765 .ie n .IP """S_perl_hash_siphash_2_4_with_state""" 4
2766 .el .IP \f(CWS_perl_hash_siphash_2_4_with_state\fR 4
2767 .IX Xref "S_perl_hash_siphash_2_4_with_state"
2768 .IX Item "S_perl_hash_siphash_2_4_with_state"
2769 Implements the variant of Siphash which performs 2 round function
2770 per block, and 4 as part of the finalizer.
2771 .Sp
2772 Takes a 32 byte \*(Aqstate\*(Aq vector prepared by \fBS_perl_siphash_seed_state()\fR
2773 and uses it to hash \f(CW\*(C`inlen\*(C'\fR bytes from the buffer pointed to by \f(CW\*(C`in\*(C'\fR,
2774 returns a 32 bit hash.
2775 .Sp
2776 The following code should return 0x6421D9AA
2777 .Sp
2778 .Vb 3
2779 \& U8 state[32];
2780 \& char seed[] = "Call me Ishmael.";
2781 \& S_perl_siphash_seed_state((const U8*)seed, state);
2782 \&
2783 \& char in[] = "It is not down on any map; true places never are.";
2784 \& U32 hash = S_perl_hash_siphash_2_4_with_state(
2785 \& state, (const U8*)in, sizeof(in)\-1);
2786 .Ve
2787 .RS 4
2788 .Sp
2789 .Vb 5
2790 \& U32 S_perl_hash_siphash_2_4_with_state(
2791 \& const unsigned char * const state,
2792 \& const unsigned char *in,
2793 \& const STRLEN inlen
2794 \&)
2795 .Ve
2796 .RE
2797 .RS 4
2798 .RE
2799 .ie n .IP """S_perl_hash_siphash_2_4_with_state_64""" 4
2800 .el .IP \f(CWS_perl_hash_siphash_2_4_with_state_64\fR 4
2801 .IX Xref "S_perl_hash_siphash_2_4_with_state_64"
2802 .IX Item "S_perl_hash_siphash_2_4_with_state_64"
2803 Implements the variant of Siphash which performs 2 round functions
2804 per block, and 4 as part of the finalizer.
2805 .Sp
2806 Takes a 32 byte \*(Aqstate\*(Aq vector prepared by \fBS_perl_siphash_seed_state()\fR
2807 and uses it to hash \f(CW\*(C`inlen\*(C'\fR bytes from the buffer pointed to by \f(CW\*(C`in\*(C'\fR,
2808 returns a 64 bit hash.
2809 .Sp
2810 The following code should return 0x1E84CF1D7AA516B7
2811 .Sp
2812 .Vb 3
2813 \& U8 state[32];
2814 \& char seed[] = "Call me Ishmael.";
2815 \& S_perl_siphash_seed_state((const U8*)seed, state);
2816 \&
2817 \& char in[] = "It is not down on any map; true places never are.";
2818 \& U64 hash = S_perl_hash_siphash_2_4_with_state_64(
2819 \& state, (const U8*)in, sizeof(in)\-1);
2820 .Ve
2821 .RS 4
2822 .Sp
2823 .Vb 5
2824 \& U64 S_perl_hash_siphash_2_4_with_state_64(
2825 \& const unsigned char * const state,
2826 \& const unsigned char *in,
2827 \& const STRLEN inlen
2828 \&)
2829 .Ve
2830 .RE
2831 .RS 4
2832 .RE
2833 .ie n .IP """S_perl_hash_siphash_2_4_64""" 4
2834 .el .IP \f(CWS_perl_hash_siphash_2_4_64\fR 4
2835 .IX Xref "S_perl_hash_siphash_2_4_64"
2836 .IX Item "S_perl_hash_siphash_2_4_64"
2837 Implements the variant of Siphash which performs 2 round functions
2838 per block, and 4 as part of the finalizer.
2839 .Sp
2840 Takes a 16 byte \f(CW\*(C`seed\*(C'\fR vector, and uses it to hash \f(CW\*(C`inlen\*(C'\fR bytes
2841 from the buffer pointed to by \f(CW\*(C`in\*(C'\fR, returns a 64 bit hash.
2842 .Sp
2843 The following code should return 0x1E84CF1D7AA516B7
2844 .Sp
2845 .Vb 4
2846 \& char seed[] = "Call me Ishmael.";
2847 \& char in[] = "It is not down on any map; true places never are.";
2848 \& U64 hash = S_perl_hash_siphash_2_4_64(
2849 \& (const U8*)seed, (const U8*)in, sizeof(in)\-1);
2850 .Ve
2851 .RS 4
2852 .Sp
2853 .Vb 4
2854 \& U64 S_perl_hash_siphash_2_4_64(const unsigned char * const seed,
2855 \& const unsigned char *in,
2856 \& const STRLEN inlen
2857 \&)
2858 .Ve
2859 .RE
2860 .RS 4
2861 .RE
2862 .ie n .IP """S_perl_siphash_seed_state""" 4
2863 .el .IP \f(CWS_perl_siphash_seed_state\fR 4
2864 .IX Xref "S_perl_siphash_seed_state"
2865 .IX Item "S_perl_siphash_seed_state"
2866 Takes a 16 byte seed and converts it into a 32 byte state buffer. The
2867 contents of state_buf will be overwritten.
2868 .Sp
2869 If you need to hash a lot of things, then you can use this to process
2870 the seed once, and then reuse the state over and over.
2871 .Sp
2872 The siphash functions which take a seed argument will call this function
2873 implicitly every time they are used. Those which take a state argument
2874 require the seed to be converted into a state before they are used.
2875 .Sp
2876 See the various _with_state siphash functions for a usage example.
2877 .RS 4
2878 .Sp
2879 .Vb 4
2880 \& void S_perl_siphash_seed_state(
2881 \& const unsigned char * const seed_buf,
2882 \& unsigned char * state_buf
2883 \&)
2884 .Ve
2885 .RE
2886 .RS 4
2887 .RE
2888 .SH Optrees
2889 .IX Header "Optrees"
2890 .ie n .IP """newATTRSUB_x""" 4
2891 .el .IP \f(CWnewATTRSUB_x\fR 4
2892 .IX Xref "newATTRSUB_x"
2893 .IX Item "newATTRSUB_x"
2894 Construct a Perl subroutine, also performing some surrounding jobs.
2895 .Sp
2896 This function is expected to be called in a Perl compilation context,
2897 and some aspects of the subroutine are taken from global variables
2898 associated with compilation. In particular, \f(CW\*(C`PL_compcv\*(C'\fR represents
2899 the subroutine that is currently being compiled. It must be non\-null
2900 when this function is called, and some aspects of the subroutine being
2901 constructed are taken from it. The constructed subroutine may actually
2902 be a reuse of the \f(CW\*(C`PL_compcv\*(C'\fR object, but will not necessarily be so.
2903 .Sp
2904 If \f(CW\*(C`block\*(C'\fR is null then the subroutine will have no body, and for the
2905 time being it will be an error to call it. This represents a forward
2906 subroutine declaration such as \f(CW\*(C`sub\ foo\ ($$);\*(C'\fR. If \f(CW\*(C`block\*(C'\fR is
2907 non\-null then it provides the Perl code of the subroutine body, which
2908 will be executed when the subroutine is called. This body includes
2909 any argument unwrapping code resulting from a subroutine signature or
2910 similar. The pad use of the code must correspond to the pad attached
2911 to \f(CW\*(C`PL_compcv\*(C'\fR. The code is not expected to include a \f(CW\*(C`leavesub\*(C'\fR or
2912 \&\f(CW\*(C`leavesublv\*(C'\fR op; this function will add such an op. \f(CW\*(C`block\*(C'\fR is consumed
2913 by this function and will become part of the constructed subroutine.
2914 .Sp
2915 \&\f(CW\*(C`proto\*(C'\fR specifies the subroutine\*(Aqs prototype, unless one is supplied
2916 as an attribute (see below). If \f(CW\*(C`proto\*(C'\fR is null, then the subroutine
2917 will not have a prototype. If \f(CW\*(C`proto\*(C'\fR is non\-null, it must point to a
2918 \&\f(CW\*(C`const\*(C'\fR op whose value is a string, and the subroutine will have that
2919 string as its prototype. If a prototype is supplied as an attribute, the
2920 attribute takes precedence over \f(CW\*(C`proto\*(C'\fR, but in that case \f(CW\*(C`proto\*(C'\fR should
2921 preferably be null. In any case, \f(CW\*(C`proto\*(C'\fR is consumed by this function.
2922 .Sp
2923 \&\f(CW\*(C`attrs\*(C'\fR supplies attributes to be applied the subroutine. A handful of
2924 attributes take effect by built\-in means, being applied to \f(CW\*(C`PL_compcv\*(C'\fR
2925 immediately when seen. Other attributes are collected up and attached
2926 to the subroutine by this route. \f(CW\*(C`attrs\*(C'\fR may be null to supply no
2927 attributes, or point to a \f(CW\*(C`const\*(C'\fR op for a single attribute, or point
2928 to a \f(CW\*(C`list\*(C'\fR op whose children apart from the \f(CW\*(C`pushmark\*(C'\fR are \f(CW\*(C`const\*(C'\fR
2929 ops for one or more attributes. Each \f(CW\*(C`const\*(C'\fR op must be a string,
2930 giving the attribute name optionally followed by parenthesised arguments,
2931 in the manner in which attributes appear in Perl source. The attributes
2932 will be applied to the sub by this function. \f(CW\*(C`attrs\*(C'\fR is consumed by
2933 this function.
2934 .Sp
2935 If \f(CW\*(C`o_is_gv\*(C'\fR is false and \f(CW\*(C`o\*(C'\fR is null, then the subroutine will
2936 be anonymous. If \f(CW\*(C`o_is_gv\*(C'\fR is false and \f(CW\*(C`o\*(C'\fR is non\-null, then \f(CW\*(C`o\*(C'\fR
2937 must point to a \f(CW\*(C`const\*(C'\fR OP, which will be consumed by this function,
2938 and its string value supplies a name for the subroutine. The name may
2939 be qualified or unqualified, and if it is unqualified then a default
2940 stash will be selected in some manner. If \f(CW\*(C`o_is_gv\*(C'\fR is true, then \f(CW\*(C`o\*(C'\fR
2941 doesn\*(Aqt point to an \f(CW\*(C`OP\*(C'\fR at all, but is instead a cast pointer to a \f(CW\*(C`GV\*(C'\fR
2942 by which the subroutine will be named.
2943 .Sp
2944 If there is already a subroutine of the specified name, then the new
2945 sub will either replace the existing one in the glob or be merged with
2946 the existing one. A warning may be generated about redefinition.
2947 .Sp
2948 If the subroutine has one of a few special names, such as \f(CW\*(C`BEGIN\*(C'\fR or
2949 \&\f(CW\*(C`END\*(C'\fR, then it will be claimed by the appropriate queue for automatic
2950 running of phase\-related subroutines. In this case the relevant glob will
2951 be left not containing any subroutine, even if it did contain one before.
2952 In the case of \f(CW\*(C`BEGIN\*(C'\fR, the subroutine will be executed and the reference
2953 to it disposed of before this function returns.
2954 .Sp
2955 The function returns a pointer to the constructed subroutine. If the sub
2956 is anonymous then ownership of one counted reference to the subroutine
2957 is transferred to the caller. If the sub is named then the caller does
2958 not get ownership of a reference. In most such cases, where the sub
2959 has a non\-phase name, the sub will be alive at the point it is returned
2960 by virtue of being contained in the glob that names it. A phase\-named
2961 subroutine will usually be alive by virtue of the reference owned by the
2962 phase\*(Aqs automatic run queue. But a \f(CW\*(C`BEGIN\*(C'\fR subroutine, having already
2963 been executed, will quite likely have been destroyed already by the
2964 time this function returns, making it erroneous for the caller to make
2965 any use of the returned pointer. It is the caller\*(Aqs responsibility to
2966 ensure that it knows which of these situations applies.
2967 .RS 4
2968 .Sp
2969 .Vb 4
2970 \& CV * newATTRSUB_x( I32 floor, OP *o, OP *proto,
2971 \& OP *attrs, OP *block, bool o_is_gv)
2972 \& CV * Perl_newATTRSUB_x(pTHX_ I32 floor, OP *o, OP *proto,
2973 \& OP *attrs, OP *block, bool o_is_gv)
2974 .Ve
2975 .RE
2976 .RS 4
2977 .RE
2978 .ie n .IP """newMYSUB""" 4
2979 .el .IP \f(CWnewMYSUB\fR 4
2980 .IX Xref "newMYSUB"
2981 .IX Item "newMYSUB"
2982 Construct a Perl lexical subroutine, also performing some surrounding jobs, and
2983 returning a pointer to the constructed subroutine.
2984 .Sp
2985 Similar in action to "\f(CW\*(C`newATTRSUB_x\*(C'\fR" in perlintern.
2986 .RS 4
2987 .Sp
2988 .Vb 4
2989 \& CV * newMYSUB( I32 floor, OP *o, OP *proto, OP *attrs,
2990 \& OP *block)
2991 \& CV * Perl_newMYSUB(pTHX_ I32 floor, OP *o, OP *proto, OP *attrs,
2992 \& OP *block)
2993 .Ve
2994 .RE
2995 .RS 4
2996 .RE
2997 .ie n .IP """newXS_len_flags""" 4
2998 .el .IP \f(CWnewXS_len_flags\fR 4
2999 .IX Xref "newXS_len_flags"
3000 .IX Item "newXS_len_flags"
3001 Construct an XS subroutine, also performing some surrounding jobs.
3002 .Sp
3003 The subroutine will have the entry point \f(CW\*(C`subaddr\*(C'\fR. It will have
3004 the prototype specified by the nul\-terminated string \f(CW\*(C`proto\*(C'\fR, or
3005 no prototype if \f(CW\*(C`proto\*(C'\fR is null. The prototype string is copied;
3006 the caller can mutate the supplied string afterwards. If \f(CW\*(C`filename\*(C'\fR
3007 is non\-null, it must be a nul\-terminated filename, and the subroutine
3008 will have its \f(CW\*(C`CvFILE\*(C'\fR set accordingly. By default \f(CW\*(C`CvFILE\*(C'\fR is set to
3009 point directly to the supplied string, which must be static. If \f(CW\*(C`flags\*(C'\fR
3010 has the \f(CW\*(C`XS_DYNAMIC_FILENAME\*(C'\fR bit set, then a copy of the string will
3011 be taken instead.
3012 .Sp
3013 Other aspects of the subroutine will be left in their default state.
3014 If anything else needs to be done to the subroutine for it to function
3015 correctly, it is the caller\*(Aqs responsibility to do that after this
3016 function has constructed it. However, beware of the subroutine
3017 potentially being destroyed before this function returns, as described
3018 below.
3019 .Sp
3020 If \f(CW\*(C`name\*(C'\fR is null then the subroutine will be anonymous, with its
3021 \&\f(CW\*(C`CvGV\*(C'\fR referring to an \f(CW\*(C`_\|_ANON_\|_\*(C'\fR glob. If \f(CW\*(C`name\*(C'\fR is non\-null then the
3022 subroutine will be named accordingly, referenced by the appropriate glob.
3023 \&\f(CW\*(C`name\*(C'\fR is a string of length \f(CW\*(C`len\*(C'\fR bytes giving a sigilless symbol name,
3024 in UTF\-8 if \f(CW\*(C`flags\*(C'\fR has the \f(CW\*(C`SVf_UTF8\*(C'\fR bit set and in Latin\-1 otherwise.
3025 The name may be either qualified or unqualified, with the stash defaulting
3026 in the same manner as for \f(CW\*(C`gv_fetchpvn_flags\*(C'\fR. \f(CW\*(C`flags\*(C'\fR may contain
3027 flag bits understood by \f(CW\*(C`gv_fetchpvn_flags\*(C'\fR with the same meaning as
3028 they have there, such as \f(CW\*(C`GV_ADDWARN\*(C'\fR. The symbol is always added to
3029 the stash if necessary, with \f(CW\*(C`GV_ADDMULTI\*(C'\fR semantics.
3030 .Sp
3031 If there is already a subroutine of the specified name, then the new sub
3032 will replace the existing one in the glob. A warning may be generated
3033 about the redefinition. If the old subroutine was \f(CW\*(C`CvCONST\*(C'\fR then the
3034 decision about whether to warn is influenced by an expectation about
3035 whether the new subroutine will become a constant of similar value.
3036 That expectation is determined by \f(CW\*(C`const_svp\*(C'\fR. (Note that the call to
3037 this function doesn\*(Aqt make the new subroutine \f(CW\*(C`CvCONST\*(C'\fR in any case;
3038 that is left to the caller.) If \f(CW\*(C`const_svp\*(C'\fR is null then it indicates
3039 that the new subroutine will not become a constant. If \f(CW\*(C`const_svp\*(C'\fR
3040 is non\-null then it indicates that the new subroutine will become a
3041 constant, and it points to an \f(CW\*(C`SV*\*(C'\fR that provides the constant value
3042 that the subroutine will have.
3043 .Sp
3044 If the subroutine has one of a few special names, such as \f(CW\*(C`BEGIN\*(C'\fR or
3045 \&\f(CW\*(C`END\*(C'\fR, then it will be claimed by the appropriate queue for automatic
3046 running of phase\-related subroutines. In this case the relevant glob will
3047 be left not containing any subroutine, even if it did contain one before.
3048 In the case of \f(CW\*(C`BEGIN\*(C'\fR, the subroutine will be executed and the reference
3049 to it disposed of before this function returns, and also before its
3050 prototype is set. If a \f(CW\*(C`BEGIN\*(C'\fR subroutine would not be sufficiently
3051 constructed by this function to be ready for execution then the caller
3052 must prevent this happening by giving the subroutine a different name.
3053 .Sp
3054 The function returns a pointer to the constructed subroutine. If the sub
3055 is anonymous then ownership of one counted reference to the subroutine
3056 is transferred to the caller. If the sub is named then the caller does
3057 not get ownership of a reference. In most such cases, where the sub
3058 has a non\-phase name, the sub will be alive at the point it is returned
3059 by virtue of being contained in the glob that names it. A phase\-named
3060 subroutine will usually be alive by virtue of the reference owned by the
3061 phase\*(Aqs automatic run queue. But a \f(CW\*(C`BEGIN\*(C'\fR subroutine, having already
3062 been executed, will quite likely have been destroyed already by the
3063 time this function returns, making it erroneous for the caller to make
3064 any use of the returned pointer. It is the caller\*(Aqs responsibility to
3065 ensure that it knows which of these situations applies.
3066 .RS 4
3067 .Sp
3068 .Vb 10
3069 \& CV * newXS_len_flags( const char *name, STRLEN len,
3070 \& XSUBADDR_t subaddr,
3071 \& const char * const filename,
3072 \& const char * const proto,
3073 \& SV ** const_svp, U32 flags)
3074 \& CV * Perl_newXS_len_flags(pTHX_ const char *name, STRLEN len,
3075 \& XSUBADDR_t subaddr,
3076 \& const char * const filename,
3077 \& const char * const proto,
3078 \& SV ** const_svp, U32 flags)
3079 .Ve
3080 .RE
3081 .RS 4
3082 .RE
3083 .ie n .IP """op_refcnt_lock""" 4
3084 .el .IP \f(CWop_refcnt_lock\fR 4
3085 .IX Xref "op_refcnt_lock"
3086 .IX Item "op_refcnt_lock"
3087 Implements the \f(CW\*(C`OP_REFCNT_LOCK\*(C'\fR macro which you should use instead.
3088 .RS 4
3089 .Sp
3090 .Vb 2
3091 \& void op_refcnt_lock()
3092 \& void Perl_op_refcnt_lock(pTHX)
3093 .Ve
3094 .RE
3095 .RS 4
3096 .RE
3097 .ie n .IP """op_refcnt_unlock""" 4
3098 .el .IP \f(CWop_refcnt_unlock\fR 4
3099 .IX Xref "op_refcnt_unlock"
3100 .IX Item "op_refcnt_unlock"
3101 Implements the \f(CW\*(C`OP_REFCNT_UNLOCK\*(C'\fR macro which you should use instead.
3102 .RS 4
3103 .Sp
3104 .Vb 2
3105 \& void op_refcnt_unlock()
3106 \& void Perl_op_refcnt_unlock(pTHX)
3107 .Ve
3108 .RE
3109 .RS 4
3110 .RE
3111 .ie n .IP """traverse_op_tree""" 4
3112 .el .IP \f(CWtraverse_op_tree\fR 4
3113 .IX Xref "traverse_op_tree"
3114 .IX Item "traverse_op_tree"
3115 Return the next op in a depth\-first traversal of the op tree,
3116 returning NULL when the traversal is complete.
3117 .Sp
3118 The initial call must supply the root of the tree as both top and o.
3119 .Sp
3120 For now it\*(Aqs static, but it may be exposed to the API in the future.
3121 .RS 4
3122 .Sp
3123 .Vb 1
3124 \& OP * traverse_op_tree(OP *top, OP *o)
3125 .Ve
3126 .RE
3127 .RS 4
3128 .RE
3129 .SH "Pack and Unpack"
3130 .IX Header "Pack and Unpack"
3131 There are currently no internal API items in Pack and Unpack
3132 .SH "Pad Data Structures"
3133 .IX Header "Pad Data Structures"
3134 .ie n .IP """CX_CURPAD_SAVE""" 4
3135 .el .IP \f(CWCX_CURPAD_SAVE\fR 4
3136 .IX Xref "CX_CURPAD_SAVE"
3137 .IX Item "CX_CURPAD_SAVE"
3138 Save the current pad in the given context block structure.
3139 .RS 4
3140 .Sp
3141 .Vb 1
3142 \& void CX_CURPAD_SAVE(struct context)
3143 .Ve
3144 .RE
3145 .RS 4
3146 .RE
3147 .ie n .IP """CX_CURPAD_SV""" 4
3148 .el .IP \f(CWCX_CURPAD_SV\fR 4
3149 .IX Xref "CX_CURPAD_SV"
3150 .IX Item "CX_CURPAD_SV"
3151 Access the SV at offset \f(CW\*(C`po\*(C'\fR in the saved current pad in the given
3152 context block structure (can be used as an lvalue).
3153 .RS 4
3154 .Sp
3155 .Vb 1
3156 \& SV * CX_CURPAD_SV(struct context, PADOFFSET po)
3157 .Ve
3158 .RE
3159 .RS 4
3160 .RE
3161 .ie n .IP """PAD_BASE_SV""" 4
3162 .el .IP \f(CWPAD_BASE_SV\fR 4
3163 .IX Xref "PAD_BASE_SV"
3164 .IX Item "PAD_BASE_SV"
3165 Get the value from slot \f(CW\*(C`po\*(C'\fR in the base (DEPTH=1) pad of a padlist
3166 .RS 4
3167 .Sp
3168 .Vb 1
3169 \& SV * PAD_BASE_SV(PADLIST padlist, PADOFFSET po)
3170 .Ve
3171 .RE
3172 .RS 4
3173 .RE
3174 .ie n .IP """PAD_CLONE_VARS""" 4
3175 .el .IP \f(CWPAD_CLONE_VARS\fR 4
3176 .IX Xref "PAD_CLONE_VARS"
3177 .IX Item "PAD_CLONE_VARS"
3178 Clone the state variables associated with running and compiling pads.
3179 .RS 4
3180 .Sp
3181 .Vb 2
3182 \& void PAD_CLONE_VARS(PerlInterpreter *proto_perl,
3183 \& CLONE_PARAMS* param)
3184 .Ve
3185 .RE
3186 .RS 4
3187 .RE
3188 .ie n .IP """PAD_COMPNAME_FLAGS""" 4
3189 .el .IP \f(CWPAD_COMPNAME_FLAGS\fR 4
3190 .IX Xref "PAD_COMPNAME_FLAGS"
3191 .IX Item "PAD_COMPNAME_FLAGS"
3192 Return the flags for the current compiling pad name
3193 at offset \f(CW\*(C`po\*(C'\fR. Assumes a valid slot entry.
3194 .RS 4
3195 .Sp
3196 .Vb 1
3197 \& U32 PAD_COMPNAME_FLAGS(PADOFFSET po)
3198 .Ve
3199 .RE
3200 .RS 4
3201 .RE
3202 .ie n .IP """PAD_COMPNAME_GEN""" 4
3203 .el .IP \f(CWPAD_COMPNAME_GEN\fR 4
3204 .IX Xref "PAD_COMPNAME_GEN"
3205 .IX Item "PAD_COMPNAME_GEN"
3206 The generation number of the name at offset \f(CW\*(C`po\*(C'\fR in the current
3207 compiling pad (lvalue).
3208 .RS 4
3209 .Sp
3210 .Vb 1
3211 \& STRLEN PAD_COMPNAME_GEN(PADOFFSET po)
3212 .Ve
3213 .RE
3214 .RS 4
3215 .RE
3216 .ie n .IP """PAD_COMPNAME_GEN_set""" 4
3217 .el .IP \f(CWPAD_COMPNAME_GEN_set\fR 4
3218 .IX Xref "PAD_COMPNAME_GEN_set"
3219 .IX Item "PAD_COMPNAME_GEN_set"
3220 Sets the generation number of the name at offset \f(CW\*(C`po\*(C'\fR in the current
3221 ling pad (lvalue) to \f(CW\*(C`gen\*(C'\fR.
3222 .RS 4
3223 .Sp
3224 .Vb 1
3225 \& STRLEN PAD_COMPNAME_GEN_set(PADOFFSET po, int gen)
3226 .Ve
3227 .RE
3228 .RS 4
3229 .RE
3230 .ie n .IP """PAD_COMPNAME_OURSTASH""" 4
3231 .el .IP \f(CWPAD_COMPNAME_OURSTASH\fR 4
3232 .IX Xref "PAD_COMPNAME_OURSTASH"
3233 .IX Item "PAD_COMPNAME_OURSTASH"
3234 Return the stash associated with an \f(CW\*(C`our\*(C'\fR variable.
3235 Assumes the slot entry is a valid \f(CW\*(C`our\*(C'\fR lexical.
3236 .RS 4
3237 .Sp
3238 .Vb 1
3239 \& HV * PAD_COMPNAME_OURSTASH(PADOFFSET po)
3240 .Ve
3241 .RE
3242 .RS 4
3243 .RE
3244 .ie n .IP """PAD_COMPNAME_PV""" 4
3245 .el .IP \f(CWPAD_COMPNAME_PV\fR 4
3246 .IX Xref "PAD_COMPNAME_PV"
3247 .IX Item "PAD_COMPNAME_PV"
3248 Return the name of the current compiling pad name
3249 at offset \f(CW\*(C`po\*(C'\fR. Assumes a valid slot entry.
3250 .RS 4
3251 .Sp
3252 .Vb 1
3253 \& char * PAD_COMPNAME_PV(PADOFFSET po)
3254 .Ve
3255 .RE
3256 .RS 4
3257 .RE
3258 .ie n .IP """PAD_COMPNAME_TYPE""" 4
3259 .el .IP \f(CWPAD_COMPNAME_TYPE\fR 4
3260 .IX Xref "PAD_COMPNAME_TYPE"
3261 .IX Item "PAD_COMPNAME_TYPE"
3262 Return the type (stash) of the current compiling pad name at offset
3263 \&\f(CW\*(C`po\*(C'\fR. Must be a valid name. Returns null if not typed.
3264 .RS 4
3265 .Sp
3266 .Vb 1
3267 \& HV * PAD_COMPNAME_TYPE(PADOFFSET po)
3268 .Ve
3269 .RE
3270 .RS 4
3271 .RE
3272 .ie n .IP """PAD_RESTORE_LOCAL""" 4
3273 .el .IP \f(CWPAD_RESTORE_LOCAL\fR 4
3274 .IX Xref "PAD_RESTORE_LOCAL"
3275 .IX Item "PAD_RESTORE_LOCAL"
3276 Restore the old pad saved into the local variable \f(CW\*(C`opad\*(C'\fR by \f(CWPAD_SAVE_LOCAL()\fR
3277 .RS 4
3278 .Sp
3279 .Vb 1
3280 \& void PAD_RESTORE_LOCAL(PAD *opad)
3281 .Ve
3282 .RE
3283 .RS 4
3284 .RE
3285 .ie n .IP """PAD_SAVE_LOCAL""" 4
3286 .el .IP \f(CWPAD_SAVE_LOCAL\fR 4
3287 .IX Xref "PAD_SAVE_LOCAL"
3288 .IX Item "PAD_SAVE_LOCAL"
3289 Save the current pad to the local variable \f(CW\*(C`opad\*(C'\fR, then make the
3290 current pad equal to \f(CW\*(C`npad\*(C'\fR
3291 .RS 4
3292 .Sp
3293 .Vb 1
3294 \& void PAD_SAVE_LOCAL(PAD *opad, PAD *npad)
3295 .Ve
3296 .RE
3297 .RS 4
3298 .RE
3299 .ie n .IP """PAD_SAVE_SETNULLPAD""" 4
3300 .el .IP \f(CWPAD_SAVE_SETNULLPAD\fR 4
3301 .IX Xref "PAD_SAVE_SETNULLPAD"
3302 .IX Item "PAD_SAVE_SETNULLPAD"
3303 Save the current pad then set it to null.
3304 .RS 4
3305 .Sp
3306 .Vb 1
3307 \& void PAD_SAVE_SETNULLPAD()
3308 .Ve
3309 .RE
3310 .RS 4
3311 .RE
3312 .ie n .IP """PAD_SET_CUR""" 4
3313 .el .IP \f(CWPAD_SET_CUR\fR 4
3314 .IX Xref "PAD_SET_CUR"
3315 .IX Item "PAD_SET_CUR"
3316 Set the current pad to be pad \f(CW\*(C`n\*(C'\fR in the padlist, saving
3317 the previous current pad. NB currently this macro expands to a string too
3318 long for some compilers, so it\*(Aqs best to replace it with
3319 .Sp
3320 .Vb 2
3321 \& SAVECOMPPAD();
3322 \& PAD_SET_CUR_NOSAVE(padlist,n);
3323 .Ve
3324 .RS 4
3325 .Sp
3326 .Vb 1
3327 \& void PAD_SET_CUR(PADLIST padlist, I32 n)
3328 .Ve
3329 .RE
3330 .RS 4
3331 .RE
3332 .ie n .IP """PAD_SET_CUR_NOSAVE""" 4
3333 .el .IP \f(CWPAD_SET_CUR_NOSAVE\fR 4
3334 .IX Xref "PAD_SET_CUR_NOSAVE"
3335 .IX Item "PAD_SET_CUR_NOSAVE"
3336 like PAD_SET_CUR, but without the save
3337 .RS 4
3338 .Sp
3339 .Vb 1
3340 \& void PAD_SET_CUR_NOSAVE(PADLIST padlist, I32 n)
3341 .Ve
3342 .RE
3343 .RS 4
3344 .RE
3345 .ie n .IP """PAD_SETSV""" 4
3346 .el .IP \f(CWPAD_SETSV\fR 4
3347 .IX Xref "PAD_SETSV"
3348 .IX Item "PAD_SETSV"
3349 Set the slot at offset \f(CW\*(C`po\*(C'\fR in the current pad to \f(CW\*(C`sv\*(C'\fR
3350 .RS 4
3351 .Sp
3352 .Vb 1
3353 \& SV * PAD_SETSV(PADOFFSET po, SV* sv)
3354 .Ve
3355 .RE
3356 .RS 4
3357 .RE
3358 .ie n .IP """PAD_SV""" 4
3359 .el .IP \f(CWPAD_SV\fR 4
3360 .IX Xref "PAD_SV"
3361 .IX Item "PAD_SV"
3362 Get the value at offset \f(CW\*(C`po\*(C'\fR in the current pad
3363 .RS 4
3364 .Sp
3365 .Vb 1
3366 \& SV * PAD_SV(PADOFFSET po)
3367 .Ve
3368 .RE
3369 .RS 4
3370 .RE
3371 .ie n .IP """PAD_SVl""" 4
3372 .el .IP \f(CWPAD_SVl\fR 4
3373 .IX Xref "PAD_SVl"
3374 .IX Item "PAD_SVl"
3375 Lightweight and lvalue version of \f(CW\*(C`PAD_SV\*(C'\fR.
3376 Get or set the value at offset \f(CW\*(C`po\*(C'\fR in the current pad.
3377 Unlike \f(CW\*(C`PAD_SV\*(C'\fR, does not print diagnostics with \-DX.
3378 For internal use only.
3379 .RS 4
3380 .Sp
3381 .Vb 1
3382 \& SV * PAD_SVl(PADOFFSET po)
3383 .Ve
3384 .RE
3385 .RS 4
3386 .RE
3387 .ie n .IP """PadnameIsFIELD""" 4
3388 .el .IP \f(CWPadnameIsFIELD\fR 4
3389 .IX Xref "PadnameIsFIELD"
3390 .IX Item "PadnameIsFIELD"
3391 Whether this is a "field" variable. PADNAMEs where this is true will
3392 have additional information available via \f(CW\*(C`PadnameFIELDINFO\*(C'\fR.
3393 .RS 4
3394 .Sp
3395 .Vb 1
3396 \& bool PadnameIsFIELD(PADNAME * pn)
3397 .Ve
3398 .RE
3399 .RS 4
3400 .RE
3401 .ie n .IP """PadnameIsOUR""" 4
3402 .el .IP \f(CWPadnameIsOUR\fR 4
3403 .IX Xref "PadnameIsOUR"
3404 .IX Item "PadnameIsOUR"
3405 Whether this is an "our" variable.
3406 .RS 4
3407 .Sp
3408 .Vb 1
3409 \& bool PadnameIsOUR(PADNAME * pn)
3410 .Ve
3411 .RE
3412 .RS 4
3413 .RE
3414 .ie n .IP """PadnameIsSTATE""" 4
3415 .el .IP \f(CWPadnameIsSTATE\fR 4
3416 .IX Xref "PadnameIsSTATE"
3417 .IX Item "PadnameIsSTATE"
3418 Whether this is a "state" variable.
3419 .RS 4
3420 .Sp
3421 .Vb 1
3422 \& bool PadnameIsSTATE(PADNAME * pn)
3423 .Ve
3424 .RE
3425 .RS 4
3426 .RE
3427 .ie n .IP """PadnameOURSTASH""" 4
3428 .el .IP \f(CWPadnameOURSTASH\fR 4
3429 .IX Xref "PadnameOURSTASH"
3430 .IX Item "PadnameOURSTASH"
3431 The stash in which this "our" variable was declared.
3432 .RS 4
3433 .Sp
3434 .Vb 1
3435 \& HV * PadnameOURSTASH(PADNAME * pn)
3436 .Ve
3437 .RE
3438 .RS 4
3439 .RE
3440 .ie n .IP """PadnameOUTER""" 4
3441 .el .IP \f(CWPadnameOUTER\fR 4
3442 .IX Xref "PadnameOUTER"
3443 .IX Item "PadnameOUTER"
3444 Whether this entry belongs to an outer pad. Entries for which this is true
3445 are often referred to as \*(Aqfake\*(Aq.
3446 .RS 4
3447 .Sp
3448 .Vb 1
3449 \& bool PadnameOUTER(PADNAME * pn)
3450 .Ve
3451 .RE
3452 .RS 4
3453 .RE
3454 .ie n .IP """PadnameTYPE""" 4
3455 .el .IP \f(CWPadnameTYPE\fR 4
3456 .IX Xref "PadnameTYPE"
3457 .IX Item "PadnameTYPE"
3458 The stash associated with a typed lexical. This returns the \f(CW%Foo::\fR hash
3459 for \f(CW\*(C`my Foo $bar\*(C'\fR.
3460 .RS 4
3461 .Sp
3462 .Vb 1
3463 \& HV * PadnameTYPE(PADNAME * pn)
3464 .Ve
3465 .RE
3466 .RS 4
3467 .RE
3468 .ie n .IP """SAVECLEARSV""" 4
3469 .el .IP \f(CWSAVECLEARSV\fR 4
3470 .IX Xref "SAVECLEARSV"
3471 .IX Item "SAVECLEARSV"
3472 Clear the pointed to pad value on scope exit. (i.e. the runtime action of
3473 \&\f(CW\*(C`my\*(C'\fR)
3474 .RS 4
3475 .Sp
3476 .Vb 1
3477 \& void SAVECLEARSV(SV **svp)
3478 .Ve
3479 .RE
3480 .RS 4
3481 .RE
3482 .ie n .IP """SAVECOMPPAD""" 4
3483 .el .IP \f(CWSAVECOMPPAD\fR 4
3484 .IX Xref "SAVECOMPPAD"
3485 .IX Item "SAVECOMPPAD"
3486 save \f(CW\*(C`PL_comppad\*(C'\fR and \f(CW\*(C`PL_curpad\*(C'\fR
3487 .RS 4
3488 .Sp
3489 .Vb 1
3490 \& void SAVECOMPPAD()
3491 .Ve
3492 .RE
3493 .RS 4
3494 .RE
3495 .ie n .IP """SAVEPADSV""" 4
3496 .el .IP \f(CWSAVEPADSV\fR 4
3497 .IX Xref "SAVEPADSV"
3498 .IX Item "SAVEPADSV"
3499 Save a pad slot (used to restore after an iteration)
3500 .RS 4
3501 .Sp
3502 .Vb 1
3503 \& void SAVEPADSV(PADOFFSET po)
3504 .Ve
3505 .RE
3506 .RS 4
3507 .RE
3508 .SH "Password and Group access"
3509 .IX Header "Password and Group access"
3510 There are currently no internal API items in Password and Group access
3511 .SH "Paths to system commands"
3512 .IX Header "Paths to system commands"
3513 There are currently no internal API items in Paths to system commands
3514 .SH "Prototype information"
3515 .IX Header "Prototype information"
3516 There are currently no internal API items in Prototype information
3517 .SH "Reference\-counted stack manipulation"
3518 .IX Header "Reference-counted stack manipulation"
3519 There are currently no internal API items in Reference\-counted stack manipulation
3520 .SH "REGEXP Functions"
3521 .IX Xref "RX_OFFSp"
3522 .IX Header "REGEXP Functions"
3523 .ie n .IP """regnode""" 4
3524 .el .IP \f(CWregnode\fR 4
3525 .IX Item "regnode"
3526 Described in perlreguts.
3527 .SH "Reports and Formats"
3528 .IX Header "Reports and Formats"
3529 There are currently no internal API items in Reports and Formats
3530 .SH Signals
3531 .IX Header "Signals"
3532 There are currently no internal API items in Signals
3533 .SH "Site configuration"
3534 .IX Header "Site configuration"
3535 There are currently no internal API items in Site configuration
3536 .SH "Sockets configuration values"
3537 .IX Header "Sockets configuration values"
3538 There are currently no internal API items in Sockets configuration values
3539 .SH "Source Filters"
3540 .IX Header "Source Filters"
3541 There are currently no internal API items in Source Filters
3542 .SH "Stack Manipulation Macros"
3543 .IX Header "Stack Manipulation Macros"
3544 .ie n .IP """djSP""" 4
3545 .el .IP \f(CWdjSP\fR 4
3546 .IX Xref "djSP"
3547 .IX Item "djSP"
3548 Declare Just \f(CW\*(C`SP\*(C'\fR. This is actually identical to \f(CW\*(C`dSP\*(C'\fR, and declares
3549 a local copy of perl\*(Aqs stack pointer, available via the \f(CW\*(C`SP\*(C'\fR macro.
3550 See \f(CW\*(C`"SP" in perlapi\*(C'\fR. (Available for backward source code compatibility with
3551 the old (Perl 5.005) thread model.)
3552 .RS 4
3553 .Sp
3554 .Vb 1
3555 \& djSP();
3556 .Ve
3557 .RE
3558 .RS 4
3559 .RE
3560 .ie n .IP """LVRET""" 4
3561 .el .IP \f(CWLVRET\fR 4
3562 .IX Xref "LVRET"
3563 .IX Item "LVRET"
3564 True if this op will be the return value of an lvalue subroutine
3565 .ie n .IP """save_alloc""" 4
3566 .el .IP \f(CWsave_alloc\fR 4
3567 .IX Xref "save_alloc"
3568 .IX Item "save_alloc"
3569 Implements "\f(CW\*(C`SSNEW\*(C'\fR" in perlapi and kin, which should be used instead of this
3570 function.
3571 .RS 4
3572 .Sp
3573 .Vb 2
3574 \& SSize_t save_alloc( SSize_t size, I32 pad)
3575 \& SSize_t Perl_save_alloc(pTHX_ SSize_t size, I32 pad)
3576 .Ve
3577 .RE
3578 .RS 4
3579 .RE
3580 .SH "String Handling"
3581 .IX Header "String Handling"
3582 .ie n .IP """delimcpy_no_escape""" 4
3583 .el .IP \f(CWdelimcpy_no_escape\fR 4
3584 .IX Xref "delimcpy_no_escape"
3585 .IX Item "delimcpy_no_escape"
3586 Copy a source buffer to a destination buffer, stopping at (but not including)
3587 the first occurrence in the source of the delimiter byte, \f(CW\*(C`delim\*(C'\fR. The source
3588 is the bytes between \f(CW\*(C`from\*(C'\fR\ and\ \f(CW\*(C`from_end\*(C'\fR\ \-\ 1. Similarly, the dest is
3589 \&\f(CW\*(C`to\*(C'\fR up to \f(CW\*(C`to_end\*(C'\fR.
3590 .Sp
3591 The number of bytes copied is written to \f(CW*retlen\fR.
3592 .Sp
3593 Returns the position of \f(CW\*(C`delim\*(C'\fR in the \f(CW\*(C`from\*(C'\fR buffer, but if there is no
3594 such occurrence before \f(CW\*(C`from_end\*(C'\fR, then \f(CW\*(C`from_end\*(C'\fR is returned, and the entire
3595 buffer \f(CW\*(C`from\*(C'\fR\ ..\ \f(CW\*(C`from_end\*(C'\fR\ \-\ 1 is copied.
3596 .Sp
3597 If there is room in the destination available after the copy, an extra
3598 terminating safety \f(CW\*(C`NUL\*(C'\fR byte is appended (not included in the returned
3599 length).
3600 .Sp
3601 The error case is if the destination buffer is not large enough to accommodate
3602 everything that should be copied. In this situation, a value larger than
3603 \&\f(CW\*(C`to_end\*(C'\fR\ \-\ \f(CW\*(C`to\*(C'\fR is written to \f(CW*retlen\fR, and as much of the source as
3604 fits will be written to the destination. Not having room for the safety \f(CW\*(C`NUL\*(C'\fR
3605 is not considered an error.
3606 .RS 4
3607 .Sp
3608 .Vb 8
3609 \& char * delimcpy_no_escape(char *to, const char *to_end,
3610 \& const char *from,
3611 \& const char *from_end,
3612 \& const int delim, I32 *retlen)
3613 \& char * Perl_delimcpy_no_escape(char *to, const char *to_end,
3614 \& const char *from,
3615 \& const char *from_end,
3616 \& const int delim, I32 *retlen)
3617 .Ve
3618 .RE
3619 .RS 4
3620 .RE
3621 .ie n .IP """quadmath_format_needed""" 4
3622 .el .IP \f(CWquadmath_format_needed\fR 4
3623 .IX Xref "quadmath_format_needed"
3624 .IX Item "quadmath_format_needed"
3625 \&\f(CWquadmath_format_needed()\fR returns true if the \f(CW\*(C`format\*(C'\fR string seems to
3626 contain at least one non\-Q\-prefixed \f(CW\*(C`%[efgaEFGA]\*(C'\fR format specifier,
3627 or returns false otherwise.
3628 .Sp
3629 The format specifier detection is not complete printf\-syntax detection,
3630 but it should catch most common cases.
3631 .Sp
3632 If true is returned, those arguments \fBshould\fR in theory be processed
3633 with \f(CWquadmath_snprintf()\fR, but in case there is more than one such
3634 format specifier (see "quadmath_format_valid"), and if there is
3635 anything else beyond that one (even just a single byte), they
3636 \&\fBcannot\fR be processed because \f(CWquadmath_snprintf()\fR is very strict,
3637 accepting only one format spec, and nothing else.
3638 In this case, the code should probably fail.
3639 .RS 4
3640 .Sp
3641 .Vb 2
3642 \& bool quadmath_format_needed(const char *format)
3643 \& bool Perl_quadmath_format_needed(const char *format)
3644 .Ve
3645 .RE
3646 .RS 4
3647 .RE
3648 .ie n .IP """quadmath_format_valid""" 4
3649 .el .IP \f(CWquadmath_format_valid\fR 4
3650 .IX Xref "quadmath_format_valid"
3651 .IX Item "quadmath_format_valid"
3652 \&\f(CWquadmath_snprintf()\fR is very strict about its \f(CW\*(C`format\*(C'\fR string and will
3653 fail, returning \-1, if the format is invalid. It accepts exactly
3654 one format spec.
3655 .Sp
3656 \&\f(CWquadmath_format_valid()\fR checks that the intended single spec looks
3657 sane: begins with \f(CW\*(C`%\*(C'\fR, has only one \f(CW\*(C`%\*(C'\fR, ends with \f(CW\*(C`[efgaEFGA]\*(C'\fR,
3658 and has \f(CW\*(C`Q\*(C'\fR before it. This is not a full "printf syntax check",
3659 just the basics.
3660 .Sp
3661 Returns true if it is valid, false if not.
3662 .Sp
3663 See also "quadmath_format_needed".
3664 .RS 4
3665 .Sp
3666 .Vb 2
3667 \& bool quadmath_format_valid(const char *format)
3668 \& bool Perl_quadmath_format_valid(const char *format)
3669 .Ve
3670 .RE
3671 .RS 4
3672 .RE
3673 .SH "SV Flags"
3674 .IX Header "SV Flags"
3675 .ie n .IP """SVt_INVLIST""" 4
3676 .el .IP \f(CWSVt_INVLIST\fR 4
3677 .IX Xref "SVt_INVLIST"
3678 .IX Item "SVt_INVLIST"
3679 Type flag for scalars. See "svtype" in perlapi.
3680 .SH "SV Handling"
3681 .IX Header "SV Handling"
3682 .ie n .IP """PL_Sv""" 4
3683 .el .IP \f(CWPL_Sv\fR 4
3684 .IX Xref "PL_Sv"
3685 .IX Item "PL_Sv"
3686 A scratch pad SV for whatever temporary use you need. Chiefly used as a
3687 fallback by macros on platforms where "PERL_USE_GCC_BRACE_GROUPS" in perlapi> is
3688 unavailable, and which would otherwise evaluate their SV parameter more than
3689 once.
3690 .Sp
3691 \&\fBBUT BEWARE\fR, if this is used in a situation where something that is using it
3692 is in a call stack with something else that is using it, this variable would
3693 get zapped, leading to hard\-to\-diagnose errors.
3694 .Sp
3695 These days using an inline function is generally preferred instead.
3696 .ie n .IP """sv_add_arena""" 4
3697 .el .IP \f(CWsv_add_arena\fR 4
3698 .IX Xref "sv_add_arena"
3699 .IX Item "sv_add_arena"
3700 Given a chunk of memory, link it to the head of the list of arenas,
3701 and split it into a list of free SVs.
3702 .RS 4
3703 .Sp
3704 .Vb 2
3705 \& void sv_add_arena(char * const ptr, const U32 size,
3706 \& const U32 flags)
3707 .Ve
3708 .RE
3709 .RS 4
3710 .RE
3711 .ie n .IP """sv_clean_all""" 4
3712 .el .IP \f(CWsv_clean_all\fR 4
3713 .IX Xref "sv_clean_all"
3714 .IX Item "sv_clean_all"
3715 Decrement the refcnt of each remaining SV, possibly triggering a
3716 cleanup. This function may have to be called multiple times to free
3717 SVs which are in complex self\-referential hierarchies.
3718 .RS 4
3719 .Sp
3720 .Vb 2
3721 \& SSize_t sv_clean_all()
3722 \& SSize_t Perl_sv_clean_all(pTHX)
3723 .Ve
3724 .RE
3725 .RS 4
3726 .RE
3727 .ie n .IP """sv_clean_objs""" 4
3728 .el .IP \f(CWsv_clean_objs\fR 4
3729 .IX Xref "sv_clean_objs"
3730 .IX Item "sv_clean_objs"
3731 Attempt to destroy all objects not yet freed.
3732 .RS 4
3733 .Sp
3734 .Vb 2
3735 \& void sv_clean_objs()
3736 \& void Perl_sv_clean_objs(pTHX)
3737 .Ve
3738 .RE
3739 .RS 4
3740 .RE
3741 .ie n .IP """sv_free_arenas""" 4
3742 .el .IP \f(CWsv_free_arenas\fR 4
3743 .IX Xref "sv_free_arenas"
3744 .IX Item "sv_free_arenas"
3745 Deallocate the memory used by all arenas. Note that all the individual SV
3746 heads and bodies within the arenas must already have been freed.
3747 .RS 4
3748 .Sp
3749 .Vb 2
3750 \& void sv_free_arenas()
3751 \& void Perl_sv_free_arenas(pTHX)
3752 .Ve
3753 .RE
3754 .RS 4
3755 .RE
3756 .ie n .IP """sv_grow""" 4
3757 .el .IP \f(CWsv_grow\fR 4
3758 .IX Xref "sv_grow"
3759 .IX Item "sv_grow"
3760 Expands the character buffer in the SV. If necessary, uses \f(CW\*(C`sv_unref\*(C'\fR and
3761 upgrades the SV to \f(CW\*(C`SVt_PV\*(C'\fR. Returns a pointer to the character buffer.
3762 Use the \f(CW\*(C`SvGROW\*(C'\fR wrapper instead.
3763 .RS 4
3764 .Sp
3765 .Vb 2
3766 \& char * sv_grow( SV * const sv, STRLEN newlen)
3767 \& char * Perl_sv_grow(pTHX_ SV * const sv, STRLEN newlen)
3768 .Ve
3769 .RE
3770 .RS 4
3771 .RE
3772 .ie n .IP """sv_grow_fresh""" 4
3773 .el .IP \f(CWsv_grow_fresh\fR 4
3774 .IX Xref "sv_grow_fresh"
3775 .IX Item "sv_grow_fresh"
3776 A cut\-down version of sv_grow intended only for when sv is a freshly\-minted
3777 SVt_PV, SVt_PVIV, SVt_PVNV, or SVt_PVMG. i.e. sv has the default flags, has
3778 never been any other type, and does not have an existing string. Basically,
3779 just assigns a char buffer and returns a pointer to it.
3780 .RS 4
3781 .Sp
3782 .Vb 2
3783 \& char * sv_grow_fresh( SV * const sv, STRLEN newlen)
3784 \& char * Perl_sv_grow_fresh(pTHX_ SV * const sv, STRLEN newlen)
3785 .Ve
3786 .RE
3787 .RS 4
3788 .RE
3789 .ie n .IP """sv_newref""" 4
3790 .el .IP \f(CWsv_newref\fR 4
3791 .IX Xref "sv_newref"
3792 .IX Item "sv_newref"
3793 Increment an SV\*(Aqs reference count. Use the \f(CWSvREFCNT_inc()\fR wrapper
3794 instead.
3795 .RS 4
3796 .Sp
3797 .Vb 2
3798 \& SV * sv_newref( SV * const sv)
3799 \& SV * Perl_sv_newref(pTHX_ SV * const sv)
3800 .Ve
3801 .RE
3802 .RS 4
3803 .RE
3804 .ie n .IP """sv_pv""" 4
3805 .el .IP \f(CWsv_pv\fR 4
3806 .IX Xref "sv_pv"
3807 .IX Item "sv_pv"
3808 Use the \f(CW\*(C`SvPV_nolen\*(C'\fR macro instead
3809 .RS 4
3810 .Sp
3811 .Vb 2
3812 \& char * sv_pv( SV *sv)
3813 \& char * Perl_sv_pv(pTHX_ SV *sv)
3814 .Ve
3815 .RE
3816 .RS 4
3817 .RE
3818 .ie n .IP """sv_pvbyte""" 4
3819 .el .IP \f(CWsv_pvbyte\fR 4
3820 .IX Xref "sv_pvbyte"
3821 .IX Item "sv_pvbyte"
3822 Use \f(CW\*(C`SvPVbyte_nolen\*(C'\fR instead.
3823 .RS 4
3824 .Sp
3825 .Vb 2
3826 \& char * sv_pvbyte( SV *sv)
3827 \& char * Perl_sv_pvbyte(pTHX_ SV *sv)
3828 .Ve
3829 .RE
3830 .RS 4
3831 .RE
3832 .ie n .IP """sv_pvbyten_force""" 4
3833 .el .IP \f(CWsv_pvbyten_force\fR 4
3834 .IX Xref "sv_pvbyten_force"
3835 .IX Item "sv_pvbyten_force"
3836 The backend for the \f(CW\*(C`SvPVbytex_force\*(C'\fR macro. Always use the macro
3837 instead. If the SV cannot be downgraded from UTF\-8, this croaks.
3838 .RS 4
3839 .Sp
3840 .Vb 4
3841 \& char * sv_pvbyten_force( SV * const sv,
3842 \& STRLEN * const lp)
3843 \& char * Perl_sv_pvbyten_force(pTHX_ SV * const sv,
3844 \& STRLEN * const lp)
3845 .Ve
3846 .RE
3847 .RS 4
3848 .RE
3849 .ie n .IP """sv_pvn_force""" 4
3850 .el .IP \f(CWsv_pvn_force\fR 4
3851 .IX Xref "sv_pvn_force"
3852 .IX Item "sv_pvn_force"
3853 Get a sensible string out of the SV somehow.
3854 A private implementation of the \f(CW\*(C`SvPV_force\*(C'\fR macro for compilers which
3855 can\*(Aqt cope with complex macro expressions. Always use the macro instead.
3856 .RS 4
3857 .Sp
3858 .Vb 2
3859 \& char * sv_pvn_force( SV *sv, STRLEN *lp)
3860 \& char * Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
3861 .Ve
3862 .RE
3863 .RS 4
3864 .RE
3865 .ie n .IP """sv_pvutf8""" 4
3866 .el .IP \f(CWsv_pvutf8\fR 4
3867 .IX Xref "sv_pvutf8"
3868 .IX Item "sv_pvutf8"
3869 Use the \f(CW\*(C`SvPVutf8_nolen\*(C'\fR macro instead
3870 .RS 4
3871 .Sp
3872 .Vb 2
3873 \& char * sv_pvutf8( SV *sv)
3874 \& char * Perl_sv_pvutf8(pTHX_ SV *sv)
3875 .Ve
3876 .RE
3877 .RS 4
3878 .RE
3879 .ie n .IP """sv_pvutf8n_force""" 4
3880 .el .IP \f(CWsv_pvutf8n_force\fR 4
3881 .IX Xref "sv_pvutf8n_force"
3882 .IX Item "sv_pvutf8n_force"
3883 The backend for the \f(CW\*(C`SvPVutf8x_force\*(C'\fR macro. Always use the macro
3884 instead.
3885 .RS 4
3886 .Sp
3887 .Vb 4
3888 \& char * sv_pvutf8n_force( SV * const sv,
3889 \& STRLEN * const lp)
3890 \& char * Perl_sv_pvutf8n_force(pTHX_ SV * const sv,
3891 \& STRLEN * const lp)
3892 .Ve
3893 .RE
3894 .RS 4
3895 .RE
3896 .ie n .IP """sv_tainted""" 4
3897 .el .IP \f(CWsv_tainted\fR 4
3898 .IX Xref "sv_tainted"
3899 .IX Item "sv_tainted"
3900 Test an SV for taintedness. Use \f(CW\*(C`SvTAINTED\*(C'\fR instead.
3901 .RS 4
3902 .Sp
3903 .Vb 2
3904 \& bool sv_tainted( SV * const sv)
3905 \& bool Perl_sv_tainted(pTHX_ SV * const sv)
3906 .Ve
3907 .RE
3908 .RS 4
3909 .RE
3910 .ie n .IP """sv_true""" 4
3911 .el .IP \f(CWsv_true\fR 4
3912 .IX Xref "sv_true"
3913 .IX Item "sv_true"
3914 Returns true if the SV has a true value by Perl\*(Aqs rules.
3915 Use the \f(CW\*(C`SvTRUE\*(C'\fR macro instead, which may call \f(CWsv_true()\fR or may
3916 instead use an in\-line version.
3917 .RS 4
3918 .Sp
3919 .Vb 2
3920 \& I32 sv_true( SV * const sv)
3921 \& I32 Perl_sv_true(pTHX_ SV * const sv)
3922 .Ve
3923 .RE
3924 .RS 4
3925 .RE
3926 .ie n .IP """sv_untaint""" 4
3927 .el .IP \f(CWsv_untaint\fR 4
3928 .IX Xref "sv_untaint"
3929 .IX Item "sv_untaint"
3930 Untaint an SV. Use \f(CW\*(C`SvTAINTED_off\*(C'\fR instead.
3931 .RS 4
3932 .Sp
3933 .Vb 2
3934 \& void sv_untaint( SV * const sv)
3935 \& void Perl_sv_untaint(pTHX_ SV * const sv)
3936 .Ve
3937 .RE
3938 .RS 4
3939 .RE
3940 .ie n .IP """sv_2bool""" 4
3941 .el .IP \f(CWsv_2bool\fR 4
3942 .IX Xref "sv_2bool"
3943 .IX Item "sv_2bool"
3944 This macro is only used by \f(CWsv_true()\fR or its macro equivalent, and only if
3945 the latter\*(Aqs argument is neither \f(CW\*(C`SvPOK\*(C'\fR, \f(CW\*(C`SvIOK\*(C'\fR nor \f(CW\*(C`SvNOK\*(C'\fR.
3946 It calls \f(CW\*(C`sv_2bool_flags\*(C'\fR with the \f(CW\*(C`SV_GMAGIC\*(C'\fR flag.
3947 .RS 4
3948 .Sp
3949 .Vb 2
3950 \& bool sv_2bool( SV * const sv)
3951 \& bool Perl_sv_2bool(pTHX_ SV * const sv)
3952 .Ve
3953 .RE
3954 .RS 4
3955 .RE
3956 .ie n .IP """sv_2bool_flags""" 4
3957 .el .IP \f(CWsv_2bool_flags\fR 4
3958 .IX Xref "sv_2bool_flags"
3959 .IX Item "sv_2bool_flags"
3960 This function is only used by \f(CWsv_true()\fR and friends, and only if
3961 the latter\*(Aqs argument is neither \f(CW\*(C`SvPOK\*(C'\fR, \f(CW\*(C`SvIOK\*(C'\fR nor \f(CW\*(C`SvNOK\*(C'\fR. If the flags
3962 contain \f(CW\*(C`SV_GMAGIC\*(C'\fR, then it does an \f(CWmg_get()\fR first.
3963 .RS 4
3964 .Sp
3965 .Vb 2
3966 \& bool sv_2bool_flags( SV *sv, I32 flags)
3967 \& bool Perl_sv_2bool_flags(pTHX_ SV *sv, I32 flags)
3968 .Ve
3969 .RE
3970 .RS 4
3971 .RE
3972 .ie n .IP """sv_2num""" 4
3973 .el .IP \f(CWsv_2num\fR 4
3974 .IX Xref "sv_2num"
3975 .IX Item "sv_2num"
3976 NOTE: \f(CW\*(C`sv_2num\*(C'\fR is \fBexperimental\fR and may change or be
3977 removed without notice.
3978 .Sp
3979 Return an SV with the numeric value of the source SV, doing any necessary
3980 reference or overload conversion. The caller is expected to have handled
3981 get\-magic already.
3982 .RS 4
3983 .Sp
3984 .Vb 2
3985 \& SV * sv_2num( SV * const sv)
3986 \& SV * Perl_sv_2num(pTHX_ SV * const sv)
3987 .Ve
3988 .RE
3989 .RS 4
3990 .RE
3991 .ie n .IP """sv_2pv_nolen""" 4
3992 .el .IP \f(CWsv_2pv_nolen\fR 4
3993 .IX Xref "sv_2pv_nolen"
3994 .IX Item "sv_2pv_nolen"
3995 Like \f(CWsv_2pv()\fR, but doesn\*(Aqt return the length too. You should usually
3996 use the macro wrapper \f(CWSvPV_nolen(sv)\fR instead.
3997 .RS 4
3998 .Sp
3999 .Vb 2
4000 \& char * sv_2pv_nolen( SV *sv)
4001 \& char * Perl_sv_2pv_nolen(pTHX_ SV *sv)
4002 .Ve
4003 .RE
4004 .RS 4
4005 .RE
4006 .ie n .IP """sv_2pvbyte_nolen""" 4
4007 .el .IP \f(CWsv_2pvbyte_nolen\fR 4
4008 .IX Xref "sv_2pvbyte_nolen"
4009 .IX Item "sv_2pvbyte_nolen"
4010 Return a pointer to the byte\-encoded representation of the SV.
4011 May cause the SV to be downgraded from UTF\-8 as a side\-effect.
4012 .Sp
4013 Usually accessed via the \f(CW\*(C`SvPVbyte_nolen\*(C'\fR macro.
4014 .RS 4
4015 .Sp
4016 .Vb 2
4017 \& char * sv_2pvbyte_nolen( SV *sv)
4018 \& char * Perl_sv_2pvbyte_nolen(pTHX_ SV *sv)
4019 .Ve
4020 .RE
4021 .RS 4
4022 .RE
4023 .ie n .IP """sv_2pvutf8_nolen""" 4
4024 .el .IP \f(CWsv_2pvutf8_nolen\fR 4
4025 .IX Xref "sv_2pvutf8_nolen"
4026 .IX Item "sv_2pvutf8_nolen"
4027 Return a pointer to the UTF\-8\-encoded representation of the SV.
4028 May cause the SV to be upgraded to UTF\-8 as a side\-effect.
4029 .Sp
4030 Usually accessed via the \f(CW\*(C`SvPVutf8_nolen\*(C'\fR macro.
4031 .RS 4
4032 .Sp
4033 .Vb 2
4034 \& char * sv_2pvutf8_nolen( SV *sv)
4035 \& char * Perl_sv_2pvutf8_nolen(pTHX_ SV *sv)
4036 .Ve
4037 .RE
4038 .RS 4
4039 .RE
4040 .ie n .IP """SvTHINKFIRST""" 4
4041 .el .IP \f(CWSvTHINKFIRST\fR 4
4042 .IX Xref "SvTHINKFIRST"
4043 .IX Item "SvTHINKFIRST"
4044 A quick flag check to see whether an \f(CW\*(C`sv\*(C'\fR should be passed to \f(CW\*(C`sv_force_normal\*(C'\fR
4045 to be "downgraded" before \f(CW\*(C`SvIVX\*(C'\fR or \f(CW\*(C`SvPVX\*(C'\fR can be modified directly.
4046 .Sp
4047 For example, if your scalar is a reference and you want to modify the \f(CW\*(C`SvIVX\*(C'\fR
4048 slot, you can\*(Aqt just do \f(CW\*(C`SvROK_off\*(C'\fR, as that will leak the referent.
4049 .Sp
4050 This is used internally by various sv\-modifying functions, such as
4051 \&\f(CW\*(C`sv_setsv\*(C'\fR, \f(CW\*(C`sv_setiv\*(C'\fR and \f(CW\*(C`sv_pvn_force\*(C'\fR.
4052 .Sp
4053 One case that this does not handle is a gv without SvFAKE set. After
4054 .Sp
4055 .Vb 1
4056 \& if (SvTHINKFIRST(gv)) sv_force_normal(gv);
4057 .Ve
4058 .Sp
4059 it will still be a gv.
4060 .Sp
4061 \&\f(CW\*(C`SvTHINKFIRST\*(C'\fR sometimes produces false positives. In those cases
4062 \&\f(CW\*(C`sv_force_normal\*(C'\fR does nothing.
4063 .RS 4
4064 .Sp
4065 .Vb 1
4066 \& U32 SvTHINKFIRST(SV *sv)
4067 .Ve
4068 .RE
4069 .RS 4
4070 .RE
4071 .SH Tainting
4072 .IX Header "Tainting"
4073 .ie n .IP """sv_taint""" 4
4074 .el .IP \f(CWsv_taint\fR 4
4075 .IX Xref "sv_taint"
4076 .IX Item "sv_taint"
4077 Taint an SV. Use \f(CW\*(C`SvTAINTED_on\*(C'\fR instead.
4078 .RS 4
4079 .Sp
4080 .Vb 2
4081 \& void sv_taint( SV *sv)
4082 \& void Perl_sv_taint(pTHX_ SV *sv)
4083 .Ve
4084 .RE
4085 .RS 4
4086 .RE
4087 .ie n .IP """TAINT""" 4
4088 .el .IP \f(CWTAINT\fR 4
4089 .IX Xref "TAINT"
4090 .IX Item "TAINT"
4091 If we aren\*(Aqt in taint checking mode, do nothing;
4092 otherwise indicate to "\f(CW\*(C`TAINT_set\*(C'\fR" and "\f(CW\*(C`TAINT_PROPER\*(C'\fR" that some
4093 unspecified element is tainted.
4094 .RS 4
4095 .Sp
4096 .Vb 1
4097 \& void TAINT
4098 .Ve
4099 .RE
4100 .RS 4
4101 .RE
4102 .ie n .IP """TAINT_ENV""" 4
4103 .el .IP \f(CWTAINT_ENV\fR 4
4104 .IX Xref "TAINT_ENV"
4105 .IX Item "TAINT_ENV"
4106 Looks at several components of \f(CW%ENV\fR for taintedness, and
4107 calls "\f(CW\*(C`taint_proper\*(C'\fR" if any are tainted. The components it searches are
4108 things like \f(CW$PATH\fR.
4109 .RS 4
4110 .Sp
4111 .Vb 1
4112 \& void TAINT_ENV()
4113 .Ve
4114 .RE
4115 .RS 4
4116 .RE
4117 .ie n .IP """taint_env""" 4
4118 .el .IP \f(CWtaint_env\fR 4
4119 .IX Xref "taint_env"
4120 .IX Item "taint_env"
4121 Implements the "TAINT_ENV" macro, which you should generally use instead.
4122 .RS 4
4123 .Sp
4124 .Vb 2
4125 \& void taint_env()
4126 \& void Perl_taint_env(pTHX)
4127 .Ve
4128 .RE
4129 .RS 4
4130 .RE
4131 .ie n .IP """TAINT_get""" 4
4132 .el .IP \f(CWTAINT_get\fR 4
4133 .IX Xref "TAINT_get"
4134 .IX Item "TAINT_get"
4135 Returns a boolean as to whether some element is tainted or not.
4136 .RS 4
4137 .Sp
4138 .Vb 1
4139 \& bool TAINT_get
4140 .Ve
4141 .RE
4142 .RS 4
4143 .RE
4144 .ie n .IP """TAINT_IF""" 4
4145 .el .IP \f(CWTAINT_IF\fR 4
4146 .IX Xref "TAINT_IF"
4147 .IX Item "TAINT_IF"
4148 If \f(CW\*(C`c\*(C'\fR evaluates to true, call "\f(CW\*(C`TAINT\*(C'\fR" to indicate that something is
4149 tainted; otherwise do nothing.
4150 .RS 4
4151 .Sp
4152 .Vb 1
4153 \& void TAINT_IF(bool c)
4154 .Ve
4155 .RE
4156 .RS 4
4157 .RE
4158 .ie n .IP """TAINT_NOT""" 4
4159 .el .IP \f(CWTAINT_NOT\fR 4
4160 .IX Xref "TAINT_NOT"
4161 .IX Item "TAINT_NOT"
4162 Remove any taintedness previously set by, \fIe.g.\fR, \f(CW\*(C`TAINT\*(C'\fR.
4163 .RS 4
4164 .Sp
4165 .Vb 1
4166 \& void TAINT_NOT
4167 .Ve
4168 .RE
4169 .RS 4
4170 .RE
4171 .ie n .IP """TAINT_PROPER""" 4
4172 .el .IP \f(CWTAINT_PROPER\fR 4
4173 .IX Xref "TAINT_PROPER"
4174 .IX Item "TAINT_PROPER"
4175 If no element is tainted, do nothing;
4176 otherwise output a message (containing \f(CW\*(C`s\*(C'\fR) that indicates there is a
4177 tainting violation. If such violations are fatal, it croaks.
4178 .RS 4
4179 .Sp
4180 .Vb 1
4181 \& void TAINT_PROPER(const char * s)
4182 .Ve
4183 .RE
4184 .RS 4
4185 .RE
4186 .ie n .IP """taint_proper""" 4
4187 .el .IP \f(CWtaint_proper\fR 4
4188 .IX Xref "taint_proper"
4189 .IX Item "taint_proper"
4190 Implements the "TAINT_PROPER" macro, which you should generally use instead.
4191 .RS 4
4192 .Sp
4193 .Vb 4
4194 \& void taint_proper( const char *f,
4195 \& const char * const s)
4196 \& void Perl_taint_proper(pTHX_ const char *f,
4197 \& const char * const s)
4198 .Ve
4199 .RE
4200 .RS 4
4201 .RE
4202 .ie n .IP """TAINT_set""" 4
4203 .el .IP \f(CWTAINT_set\fR 4
4204 .IX Xref "TAINT_set"
4205 .IX Item "TAINT_set"
4206 If \f(CW\*(C`s\*(C'\fR is true, "\f(CW\*(C`TAINT_get\*(C'\fR" returns true;
4207 If \f(CW\*(C`s\*(C'\fR is false, "\f(CW\*(C`TAINT_get\*(C'\fR" returns false;
4208 .RS 4
4209 .Sp
4210 .Vb 1
4211 \& void TAINT_set(bool s)
4212 .Ve
4213 .RE
4214 .RS 4
4215 .RE
4216 .ie n .IP """TAINT_WARN_get""" 4
4217 .el .IP \f(CWTAINT_WARN_get\fR 4
4218 .IX Xref "TAINT_WARN_get"
4219 .IX Item "TAINT_WARN_get"
4220 Returns false if tainting violations are fatal;
4221 Returns true if they\*(Aqre just warnings
4222 .RS 4
4223 .Sp
4224 .Vb 1
4225 \& bool TAINT_WARN_get
4226 .Ve
4227 .RE
4228 .RS 4
4229 .RE
4230 .ie n .IP """TAINT_WARN_set""" 4
4231 .el .IP \f(CWTAINT_WARN_set\fR 4
4232 .IX Xref "TAINT_WARN_set"
4233 .IX Item "TAINT_WARN_set"
4234 \&\f(CW\*(C`s\*(C'\fR being true indicates "\f(CW\*(C`TAINT_WARN_get\*(C'\fR" should return that tainting
4235 violations are just warnings
4236 .Sp
4237 \&\f(CW\*(C`s\*(C'\fR being false indicates "\f(CW\*(C`TAINT_WARN_get\*(C'\fR" should return that tainting
4238 violations are fatal.
4239 .RS 4
4240 .Sp
4241 .Vb 1
4242 \& void TAINT_WARN_set(bool s)
4243 .Ve
4244 .RE
4245 .RS 4
4246 .RE
4247 .ie n .IP """TAINTING_get""" 4
4248 .el .IP \f(CWTAINTING_get\fR 4
4249 .IX Xref "TAINTING_get"
4250 .IX Item "TAINTING_get"
4251 Returns a boolean as to whether taint checking is enabled or not.
4252 .RS 4
4253 .Sp
4254 .Vb 1
4255 \& bool TAINTING_get
4256 .Ve
4257 .RE
4258 .RS 4
4259 .RE
4260 .ie n .IP """TAINTING_set""" 4
4261 .el .IP \f(CWTAINTING_set\fR 4
4262 .IX Xref "TAINTING_set"
4263 .IX Item "TAINTING_set"
4264 Turn taint checking mode off/on
4265 .RS 4
4266 .Sp
4267 .Vb 1
4268 \& void TAINTING_set(bool s)
4269 .Ve
4270 .RE
4271 .RS 4
4272 .RE
4273 .SH Time
4274 .IX Header "Time"
4275 There are currently no internal API items in Time
4276 .SH "Typedef names"
4277 .IX Header "Typedef names"
4278 There are currently no internal API items in Typedef names
4279 .SH "Unicode Support"
4280 .IX Xref "FOLDEQ_LOCALE FOLDEQ_S1_ALREADY_FOLDED FOLDEQ_S1_FOLDS_SANE FOLDEQ_S2_ALREADY_FOLDED FOLDEQ_S2_FOLDS_SANE FOLDEQ_UTF8_NOMIX_ASCII"
4281 .IX Header "Unicode Support"
4282 .ie n .IP """is_utf8_non_invariant_string""" 4
4283 .el .IP \f(CWis_utf8_non_invariant_string\fR 4
4284 .IX Xref "is_utf8_non_invariant_string"
4285 .IX Item "is_utf8_non_invariant_string"
4286 Returns TRUE if "is_utf8_invariant_string" in perlapi returns FALSE for the first
4287 \&\f(CW\*(C`len\*(C'\fR bytes of the string \f(CW\*(C`s\*(C'\fR, but they are, nonetheless, legal Perl\-extended
4288 UTF\-8; otherwise returns FALSE.
4289 .Sp
4290 A TRUE return means that at least one code point represented by the sequence
4291 either is a wide character not representable as a single byte, or the
4292 representation differs depending on whether the sequence is encoded in UTF\-8 or
4293 not.
4294 .Sp
4295 See also \f(CW\*(C`"is_utf8_invariant_string" in perlapi\*(C'\fR.
4296 .RS 4
4297 .Sp
4298 .Vb 4
4299 \& bool is_utf8_non_invariant_string(const U8 * const s,
4300 \& STRLEN len)
4301 \& bool Perl_is_utf8_non_invariant_string(const U8 * const s,
4302 \& STRLEN len)
4303 .Ve
4304 .RE
4305 .RS 4
4306 .RE
4307 .ie n .IP """isSCRIPT_RUN""" 4
4308 .el .IP \f(CWisSCRIPT_RUN\fR 4
4309 .IX Xref "isSCRIPT_RUN"
4310 .IX Item "isSCRIPT_RUN"
4311 Returns a bool as to whether or not the sequence of bytes from \f(CW\*(C`s\*(C'\fR up to but
4312 not including \f(CW\*(C`send\*(C'\fR form a "script run". \f(CW\*(C`utf8_target\*(C'\fR is true iff the
4313 sequence starting at \f(CW\*(C`s\*(C'\fR is to be treated as UTF\-8. To be precise, except for
4314 two degenerate cases given below, this function returns true iff all code
4315 points in it come from any combination of three "scripts" given by the Unicode
4316 "Script Extensions" property: Common, Inherited, and possibly one other.
4317 Additionally all decimal digits must come from the same consecutive sequence of
4318 10.
4319 .Sp
4320 For example, if all the characters in the sequence are Greek, or Common, or
4321 Inherited, this function will return true, provided any decimal digits in it
4322 are from the same block of digits in Common. (These are the ASCII digits
4323 "0".."9" and additionally a block for full width forms of these, and several
4324 others used in mathematical notation.) For scripts (unlike Greek) that have
4325 their own digits defined this will accept either digits from that set or from
4326 one of the Common digit sets, but not a combination of the two. Some scripts,
4327 such as Arabic, have more than one set of digits. All digits must come from
4328 the same set for this function to return true.
4329 .Sp
4330 \&\f(CW*ret_script\fR, if \f(CW\*(C`ret_script\*(C'\fR is not NULL, will on return of true
4331 contain the script found, using the \f(CW\*(C`SCX_enum\*(C'\fR typedef. Its value will be
4332 \&\f(CW\*(C`SCX_INVALID\*(C'\fR if the function returns false.
4333 .Sp
4334 If the sequence is empty, true is returned, but \f(CW*ret_script\fR (if asked for)
4335 will be \f(CW\*(C`SCX_INVALID\*(C'\fR.
4336 .Sp
4337 If the sequence contains a single code point which is unassigned to a character
4338 in the version of Unicode being used, the function will return true, and the
4339 script will be \f(CW\*(C`SCX_Unknown\*(C'\fR. Any other combination of unassigned code points
4340 in the input sequence will result in the function treating the input as not
4341 being a script run.
4342 .Sp
4343 The returned script will be \f(CW\*(C`SCX_Inherited\*(C'\fR iff all the code points in it are
4344 from the Inherited script.
4345 .Sp
4346 Otherwise, the returned script will be \f(CW\*(C`SCX_Common\*(C'\fR iff all the code points in
4347 it are from the Inherited or Common scripts.
4348 .RS 4
4349 .Sp
4350 .Vb 4
4351 \& bool isSCRIPT_RUN( const U8 *s, const U8 *send,
4352 \& const bool utf8_target)
4353 \& bool Perl_isSCRIPT_RUN(pTHX_ const U8 *s, const U8 *send,
4354 \& const bool utf8_target)
4355 .Ve
4356 .RE
4357 .RS 4
4358 .RE
4359 .ie n .IP """utf8_to_uvuni""" 4
4360 .el .IP \f(CWutf8_to_uvuni\fR 4
4361 .IX Xref "utf8_to_uvuni"
4362 .IX Item "utf8_to_uvuni"
4363 \&\f(CW\*(C`\fR\f(CBDEPRECATED!\fR\f(CW\*(C'\fR It is planned to remove \f(CW\*(C`utf8_to_uvuni\*(C'\fR
4364 from a future release of Perl. Do not use it for
4365 new code; remove it from existing code.
4366 .Sp
4367 Returns the Unicode code point of the first character in the string \f(CW\*(C`s\*(C'\fR
4368 which is assumed to be in UTF\-8 encoding; \f(CW\*(C`retlen\*(C'\fR will be set to the
4369 length, in bytes, of that character.
4370 .Sp
4371 Some, but not all, UTF\-8 malformations are detected, and in fact, some
4372 malformed input could cause reading beyond the end of the input buffer, which
4373 is one reason why this function is deprecated. The other is that only in
4374 extremely limited circumstances should the Unicode versus native code point be
4375 of any interest to you.
4376 .Sp
4377 If \f(CW\*(C`s\*(C'\fR points to one of the detected malformations, and UTF8 warnings are
4378 enabled, zero is returned and \f(CW*retlen\fR is set (if \f(CW\*(C`retlen\*(C'\fR doesn\*(Aqt point to
4379 NULL) to \-1. If those warnings are off, the computed value if well\-defined (or
4380 the Unicode REPLACEMENT CHARACTER, if not) is silently returned, and \f(CW*retlen\fR
4381 is set (if \f(CW\*(C`retlen\*(C'\fR isn\*(Aqt NULL) so that (\f(CW\*(C`s\*(C'\fR\ +\ \f(CW*retlen\fR) is the
4382 next possible position in \f(CW\*(C`s\*(C'\fR that could begin a non\-malformed character.
4383 See "utf8n_to_uvchr" in perlapi for details on when the REPLACEMENT CHARACTER is returned.
4384 .RS 4
4385 .Sp
4386 .Vb 2
4387 \& UV utf8_to_uvuni( const U8 *s, STRLEN *retlen)
4388 \& UV Perl_utf8_to_uvuni(pTHX_ const U8 *s, STRLEN *retlen)
4389 .Ve
4390 .RE
4391 .RS 4
4392 .RE
4393 .ie n .IP """utf8n_to_uvuni""" 4
4394 .el .IP \f(CWutf8n_to_uvuni\fR 4
4395 .IX Xref "utf8n_to_uvuni"
4396 .IX Item "utf8n_to_uvuni"
4397 \&\f(CW\*(C`\fR\f(CBDEPRECATED!\fR\f(CW\*(C'\fR It is planned to remove \f(CW\*(C`utf8n_to_uvuni\*(C'\fR
4398 from a future release of Perl. Do not use it for
4399 new code; remove it from existing code.
4400 .Sp
4401 Instead use "utf8_to_uv" in perlapi, or rarely, "utf8_to_uv_flags" in perlapi.
4402 .Sp
4403 This function was useful for code that wanted to handle both EBCDIC and
4404 ASCII platforms with Unicode properties, but starting in Perl v5.20, the
4405 distinctions between the platforms have mostly been made invisible to most
4406 code, so this function is quite unlikely to be what you want. If you do need
4407 this precise functionality, use instead "\f(CW\*(C`utf8_to_uv\*(C'\fR" in perlapi or
4408 "\f(CW\*(C`utf8_to_uv_flags\*(C'\fR" in perlapi to calculate the native code point, and then
4409 convert to Unicode using "\f(CW\*(C`NATIVE_TO_UNI\*(C'\fR" in perlapi.
4410 .RS 4
4411 .Sp
4412 .Vb 4
4413 \& UV utf8n_to_uvuni( const U8 *s, STRLEN curlen,
4414 \& STRLEN *retlen, U32 flags)
4415 \& UV Perl_utf8n_to_uvuni(pTHX_ const U8 *s, STRLEN curlen,
4416 \& STRLEN *retlen, U32 flags)
4417 .Ve
4418 .RE
4419 .RS 4
4420 .RE
4421 .ie n .IP """uvoffuni_to_utf8_flags""" 4
4422 .el .IP \f(CWuvoffuni_to_utf8_flags\fR 4
4423 .IX Xref "uvoffuni_to_utf8_flags"
4424 .IX Item "uvoffuni_to_utf8_flags"
4425 THIS FUNCTION SHOULD BE USED IN ONLY VERY SPECIALIZED CIRCUMSTANCES.
4426 Instead, \fBAlmost all code should use "uv_to_utf8" in perlapi or
4427 "uv_to_utf8_flags" in perlapi\fR.
4428 .Sp
4429 This function is like them, but the input is a strict Unicode
4430 (as opposed to native) code point. Only in very rare circumstances should code
4431 not be using the native code point.
4432 .Sp
4433 For details, see the description for "uv_to_utf8_flags" in perlapi.
4434 .RS 4
4435 .Sp
4436 .Vb 2
4437 \& U8 * uvoffuni_to_utf8_flags( U8 *d, UV uv, UV flags)
4438 \& U8 * Perl_uvoffuni_to_utf8_flags(pTHX_ U8 *d, UV uv, UV flags)
4439 .Ve
4440 .RE
4441 .RS 4
4442 .RE
4443 .ie n .IP """valid_utf8_to_uvchr""" 4
4444 .el .IP \f(CWvalid_utf8_to_uvchr\fR 4
4445 .IX Xref "valid_utf8_to_uvchr"
4446 .IX Item "valid_utf8_to_uvchr"
4447 Like \f(CW\*(C`"utf8_to_uv" in perlapi\*(C'\fR, but should only be called when it is
4448 known that the next character in the input UTF\-8 string \f(CW\*(C`s\*(C'\fR is well\-formed
4449 (\fIe.g.\fR, it passes \f(CW\*(C`"isUTF8_CHAR" in perlapi\*(C'\fR. Surrogates, non\-character code
4450 points, and non\-Unicode code points are allowed.
4451 .RS 4
4452 .Sp
4453 .Vb 2
4454 \& UV valid_utf8_to_uvchr(const U8 *s, STRLEN *retlen)
4455 \& UV Perl_valid_utf8_to_uvchr(const U8 *s, STRLEN *retlen)
4456 .Ve
4457 .RE
4458 .RS 4
4459 .RE
4460 .ie n .IP """variant_under_utf8_count""" 4
4461 .el .IP \f(CWvariant_under_utf8_count\fR 4
4462 .IX Xref "variant_under_utf8_count"
4463 .IX Item "variant_under_utf8_count"
4464 This function looks at the sequence of bytes between \f(CW\*(C`s\*(C'\fR and \f(CW\*(C`e\*(C'\fR, which are
4465 assumed to be encoded in ASCII/Latin1, and returns how many of them would
4466 change should the string be translated into UTF\-8. Due to the nature of UTF\-8,
4467 each of these would occupy two bytes instead of the single one in the input
4468 string. Thus, this function returns the precise number of bytes the string
4469 would expand by when translated to UTF\-8.
4470 .Sp
4471 Unlike most of the other functions that have \f(CW\*(C`utf8\*(C'\fR in their name, the input
4472 to this function is NOT a UTF\-8\-encoded string. The function name is slightly
4473 \&\fIodd\fR to emphasize this.
4474 .Sp
4475 This function is internal to Perl because khw thinks that any XS code that
4476 would want this is probably operating too close to the internals. Presenting a
4477 valid use case could change that.
4478 .Sp
4479 See also
4480 \&\f(CW\*(C`"is_utf8_invariant_string" in perlapi\*(C'\fR
4481 and
4482 \&\f(CW\*(C`"is_utf8_invariant_string_loc" in perlapi\*(C'\fR,
4483 .RS 4
4484 .Sp
4485 .Vb 2
4486 \& Size_t variant_under_utf8_count(const U8 * const s,
4487 \& const U8 * const e)
4488 .Ve
4489 .RE
4490 .RS 4
4491 .RE
4492 .SH "Utility Functions"
4493 .IX Header "Utility Functions"
4494 .ie n .IP """my_popen_list""" 4
4495 .el .IP \f(CWmy_popen_list\fR 4
4496 .IX Xref "my_popen_list"
4497 .IX Item "my_popen_list"
4498 Implementing function on some systems for \fBPerlProc_popen_list()\fR
4499 .RS 4
4500 .Sp
4501 .Vb 4
4502 \& PerlIO * my_popen_list( const char *mode, int n,
4503 \& SV **args)
4504 \& PerlIO * Perl_my_popen_list(pTHX_ const char *mode, int n,
4505 \& SV **args)
4506 .Ve
4507 .RE
4508 .RS 4
4509 .RE
4510 .ie n .IP """my_socketpair""" 4
4511 .el .IP \f(CWmy_socketpair\fR 4
4512 .IX Xref "my_socketpair"
4513 .IX Item "my_socketpair"
4514 Emulates \fBsocketpair\fR\|(2) on systems that don\*(Aqt have it, but which do have
4515 enough functionality for the emulation.
4516 .RS 4
4517 .Sp
4518 .Vb 4
4519 \& int my_socketpair(int family, int type, int protocol,
4520 \& int fd[2])
4521 \& int Perl_my_socketpair(int family, int type, int protocol,
4522 \& int fd[2])
4523 .Ve
4524 .RE
4525 .RS 4
4526 .RE
4527 .SH Versioning
4528 .IX Header "Versioning"
4529 There are currently no internal API items in Versioning
4530 .SH "Warning and Dieing"
4531 .IX Header "Warning and Dieing"
4532 .ie n .IP """deprecate""" 4
4533 .el .IP \f(CWdeprecate\fR 4
4534 .IX Xref "deprecate"
4535 .IX Item "deprecate"
4536 Wrapper around \fBPerl_ck_warner_d()\fR to produce a deprecated warning in the
4537 given category with an appropriate message. The \f(CW\*(C`message\*(C'\fR argument must
4538 be a C string. The string " is deprecated" will automatically be added
4539 to the end of the \f(CW\*(C`message\*(C'\fR.
4540 .RS 4
4541 .Sp
4542 .Vb 1
4543 \& deprecate(U32 category, "message")
4544 .Ve
4545 .RE
4546 .RS 4
4547 .RE
4548 .ie n .IP """deprecate_disappears_in""" 4
4549 .el .IP \f(CWdeprecate_disappears_in\fR 4
4550 .IX Xref "deprecate_disappears_in"
4551 .IX Item "deprecate_disappears_in"
4552 Wrapper around \fBPerl_ck_warner_d()\fR to produce a deprecated warning in the
4553 given category with an appropriate message that the construct referred
4554 to by the message will disappear in a specific release. The \f(CW\*(C`when\*(C'\fR and
4555 \&\f(CW\*(C`message\*(C'\fR arguments must be a C string. The \f(CW\*(C`when\*(C'\fR string is expected
4556 to be of the form "5.40", with no minor element in the version. The actual
4557 message output will be the result of the following expression \f(CW\*(C`message
4558 " is deprecated, and will disappear in Perl " when\*(C'\fR which is why \f(CW\*(C`message\*(C'\fR
4559 and \f(CW\*(C`when\*(C'\fR must be literal C strings.
4560 .RS 4
4561 .Sp
4562 .Vb 1
4563 \& deprecate_disappears_in(U32 category, "when", "message")
4564 .Ve
4565 .RE
4566 .RS 4
4567 .RE
4568 .ie n .IP """deprecate_fatal_in""" 4
4569 .el .IP \f(CWdeprecate_fatal_in\fR 4
4570 .IX Xref "deprecate_fatal_in"
4571 .IX Item "deprecate_fatal_in"
4572 Wrapper around \fBPerl_ck_warner_d()\fR to produce a deprecated warning in the
4573 given category with an appropriate message that the construct referred
4574 to by the message will become fatal in a specific release. The \f(CW\*(C`when\*(C'\fR
4575 and \f(CW\*(C`message\*(C'\fR arguments must be a C string. The \f(CW\*(C`when\*(C'\fR string is expected
4576 to be of the form "5.40", with no minor element in the version. The actual
4577 message output will be the result of the following expression \f(CW\*(C`message " is
4578 deprecated, and will become fatal in Perl " when\*(C'\fR which is why \f(CW\*(C`message\*(C'\fR
4579 and \f(CW\*(C`when\*(C'\fR must be literal C strings.
4580 .RS 4
4581 .Sp
4582 .Vb 1
4583 \& deprecate_fatal_in(U32 category, "when", "message")
4584 .Ve
4585 .RE
4586 .RS 4
4587 .RE
4588 .ie n .IP """find_uninit_var""" 4
4589 .el .IP \f(CWfind_uninit_var\fR 4
4590 .IX Xref "find_uninit_var"
4591 .IX Item "find_uninit_var"
4592 NOTE: \f(CW\*(C`find_uninit_var\*(C'\fR is \fBexperimental\fR and may change or be
4593 removed without notice.
4594 .Sp
4595 Find the name of the undefined variable (if any) that caused the operator
4596 to issue a "Use of uninitialized value" warning.
4597 If match is true, only return a name if its value matches \f(CW\*(C`uninit_sv\*(C'\fR.
4598 So roughly speaking, if a unary operator (such as \f(CW\*(C`OP_COS\*(C'\fR) generates a
4599 warning, then following the direct child of the op may yield an
4600 \&\f(CW\*(C`OP_PADSV\*(C'\fR or \f(CW\*(C`OP_GV\*(C'\fR that gives the name of the undefined variable. On the
4601 other hand, with \f(CW\*(C`OP_ADD\*(C'\fR there are two branches to follow, so we only print
4602 the variable name if we get an exact match.
4603 \&\f(CW\*(C`desc_p\*(C'\fR points to a string pointer holding the description of the op.
4604 This may be updated if needed.
4605 .Sp
4606 The name is returned as a mortal SV.
4607 .Sp
4608 Assumes that \f(CW\*(C`PL_op\*(C'\fR is the OP that originally triggered the error, and that
4609 \&\f(CW\*(C`PL_comppad\*(C'\fR/\f(CW\*(C`PL_curpad\*(C'\fR points to the currently executing pad.
4610 .RS 4
4611 .Sp
4612 .Vb 3
4613 \& SV * find_uninit_var(const OP * const obase,
4614 \& const SV * const uninit_sv, bool match,
4615 \& const char **desc_p)
4616 .Ve
4617 .RE
4618 .RS 4
4619 .RE
4620 .ie n .IP """PL_dowarn""" 4
4621 .el .IP \f(CWPL_dowarn\fR 4
4622 .IX Xref "PL_dowarn"
4623 .IX Item "PL_dowarn"
4624 The C variable that roughly corresponds to Perl\*(Aqs \f(CW$^W\fR warning variable.
4625 However, \f(CW$^W\fR is treated as a boolean, whereas \f(CW\*(C`PL_dowarn\*(C'\fR is a
4626 collection of flag bits.
4627 .Sp
4628 On threaded perls, each thread has an independent copy of this variable;
4629 each initialized at creation time with the current value of the creating
4630 thread\*(Aqs copy.
4631 .RS 4
4632 .Sp
4633 .Vb 1
4634 \& U8 PL_dowarn
4635 .Ve
4636 .RE
4637 .RS 4
4638 .RE
4639 .ie n .IP """report_uninit""" 4
4640 .el .IP \f(CWreport_uninit\fR 4
4641 .IX Xref "report_uninit"
4642 .IX Item "report_uninit"
4643 Print appropriate "Use of uninitialized variable" warning.
4644 .RS 4
4645 .Sp
4646 .Vb 2
4647 \& void report_uninit( const SV *uninit_sv)
4648 \& void Perl_report_uninit(pTHX_ const SV *uninit_sv)
4649 .Ve
4650 .RE
4651 .RS 4
4652 .RE
4653 .SH XS
4654 .IX Header "XS"
4655 .ie n .IP """my_cxt_init""" 4
4656 .el .IP \f(CWmy_cxt_init\fR 4
4657 .IX Xref "my_cxt_init"
4658 .IX Item "my_cxt_init"
4659 Implements the "\f(CW\*(C`MY_CXT_INIT\*(C'\fR" in perlxs macro, which you should use instead.
4660 .Sp
4661 The first time a module is loaded, the global \f(CW\*(C`PL_my_cxt_index\*(C'\fR is incremented,
4662 and that value is assigned to that module\*(Aqs static \f(CW\*(C`my_cxt_index\*(C'\fR (whose
4663 address is passed as an arg). Then, for each interpreter this function is
4664 called for, it makes sure a \f(CW\*(C`void*\*(C'\fR slot is available to hang the static data
4665 off, by allocating or extending the interpreter\*(Aqs \f(CW\*(C`PL_my_cxt_list\*(C'\fR array
4666 .RS 4
4667 .Sp
4668 .Vb 1
4669 \& void * Perl_my_cxt_init(pTHX_ int *indexp, size_t size)
4670 .Ve
4671 .RE
4672 .RS 4
4673 .RE
4674 .SH "Undocumented elements"
4675 .IX Header "Undocumented elements"
4676 This section lists the elements that are otherwise undocumented. If you use
4677 any of them, please consider creating and submitting documentation for it.
4678 .PP
4679 Experimental and deprecated undocumented elements are listed separately at the
4680 end.
4681 .PP
4682
4683 .IX Xref "abort_execution add_above_Latin1_folds add_cp_to_invlist _add_range_to_invlist allocmy amagic_cmp amagic_cmp_desc amagic_cmp_locale amagic_cmp_locale_desc amagic_i_ncmp amagic_i_ncmp_desc amagic_is_enabled amagic_ncmp amagic_ncmp_desc any_dup append_utf8_from_native_byte apply atfork_lock atfork_unlock av_arylen_p av_extend_guts av_iter_p av_nonelem av_reify bind_match block_gimme boot_core_builtin boot_core_mro boot_core_PerlIO boot_core_UNIVERSAL build_infix_plugin _byte_dump_string call_list cando capture_clear cast_iv cast_i32 cast_ulong cast_uv check_hash_fields_and_hekify check_regnode_after check_utf8_print ck_anoncode ck_backtick ck_bitop ck_classname ck_cmp ck_concat ck_defined ck_delete ck_each ck_entersub_args_core ck_eof ck_eval ck_exec ck_exists ck_ftst ck_fun ck_glob ck_grep ck_helemexistsor ck_index ck_isa ck_join ck_length ck_lfun ck_listiob ck_match ck_method ck_null ck_open ck_prototype ck_readline ck_refassign ck_repeat ck_require ck_return ck_rfun ck_rvconst ck_sassign ck_scmp ck_select ck_shift ck_smartmatch ck_sort ck_spair ck_split ck_stringify ck_subr ck_substr ck_svconst ck_tell ck_trunc ck_trycatch ckwarn ckwarn_d class_add_ADJUST class_add_field class_apply_attributes class_apply_field_attributes class_prepare_initfield_parse class_prepare_method_parse class_seal_stash class_set_field_defop class_setup_stash class_wrap_method_body clear_defarray closest_cop cmp_desc cmp_locale_desc cmpchain_extend cmpchain_finish cmpchain_start cntrl_to_mnemonic construct_ahocorasick_from_trie cop_file_avn coresub_op croak_caller croak_kw_unless_class croak_memory_wrap croak_no_mem croak_no_mem_ext croak_popstack csighandler csighandler1 csighandler3 current_re_engine custom_op_get_field cv_clone_into cv_const_sv_or_av cv_undef_flags cvgv_from_hek cvgv_set cvstash_set cx_dump cx_dup cxinc deb_stack_all debstackptrs debug_hash_seed debug_peep debug_show_study_flags debug_studydata defelem_target despatch_signals die_unwind do_aexec do_aexec5 do_aspawn do_eof do_exec do_exec3 do_gv_dump do_gvgv_dump do_hv_dump do_ipcctl do_ipcget do_magic_dump do_msgrcv do_msgsnd do_ncmp do_op_dump do_pmop_dump do_print do_readline do_seek do_semop do_shmio do_spawn do_spawn_nowait do_sv_dump do_sysseek do_tell do_trans do_uniprop_match do_vecget do_vecset do_vop does_utf8_overflow dofile doing_taint doref drand48_init_r drand48_r dtrace_probe_call dtrace_probe_load dtrace_probe_op dtrace_probe_phase dump_all_perl dump_indent dump_packsubs_perl dump_sub_perl dump_sv_child dump_vindent dumpuntil dup_warnings find_first_differing_byte_pos find_lexical_cv find_runcv_where find_script finish_export_lexical foldEQ_latin1 foldEQ_latin1_s2_folded foldEQ_utf8_flags force_locale_unlock force_out_malformed_utf8_message_ form_alien_digit_msg form_cp_too_large_msg free_tied_hv_pool free_tmps get_and_check_backslash_N_name get_ANYOFHbbm_contents get_ANYOFM_contents get_db_sub get_debug_opts get_deprecated_property_msg get_extended_os_errno get_hash_seed get_invlist_iter_addr get_invlist_offset_addr get_invlist_previous_index_addr get_mstats get_prop_definition get_prop_values get_re_gclass_aux_data get_regclass_aux_data get_regex_charset_name get_win32_message_utf8ness getenv_len gp_free gp_ref grok_bin_oct_hex grok_bslash_c grok_bslash_o grok_bslash_x gv_check gv_fetchmeth_internal gv_override gv_setref gv_stashpvn_internal he_dup hek_dup hfree_next_entry hv_auxalloc hv_common hv_common_key_len hv_delayfree_ent hv_free_ent hv_placeholders_p hv_pushkv hv_rand_set hv_undef_flags import_builtin_bundle infix_plugin_standard init_argv_symbols init_constants init_dbargs init_debugger init_i18nl10n init_named_cv init_stacks init_tm init_uniprops _inverse_folds invert invlist_array _invlist_array_init invlist_clear invlist_clone _invlist_contains_cp invlist_contents _invlist_dump invlist_extend invlist_highest _invlist_intersection_maybe_complement_2nd _invlist_intersection _invlist_invert invlist_is_iterating invlist_iterfinish invlist_iterinit invlist_iternext _invlist_len invlist_max invlist_previous_index _invlist_search invlist_set_len invlist_set_previous_index _invlist_subtract invlist_trim _invlist_union_maybe_complement_2nd _invlist_union _invlistEQ invmap_dump invoke_exception_hook io_close is_grapheme is_in_locale_category_ is_invlist is_standard_filehandle_name _is_uni_FOO _is_uni_perl_idcont _is_uni_perl_idstart is_utf8_char_helper_ is_utf8_FF_helper_ _is_utf8_FOO is_utf8_overlong _is_utf8_perl_idcont _is_utf8_perl_idstart isFF_overlong jmaybe join_exact keyword keyword_plugin_standard list load_charnames locale_panic localize lossless_NV_to_IV lsbit_pos32 lsbit_pos64 magic_clear_all_env magic_cleararylen_p magic_clearenv magic_clearhook magic_clearhookall magic_clearisa magic_clearpack magic_clearsig magic_copycallchecker magic_existspack magic_freearylen_p magic_freecollxfrm magic_freemglob magic_freeovrld magic_freeutf8 magic_get magic_getarylen magic_getdebugvar magic_getdefelem magic_getnkeys magic_getpack magic_getpos magic_getsig magic_getsubstr magic_gettaint magic_getuvar magic_getvec magic_killbackrefs magic_nextpack magic_regdata_cnt magic_regdatum_get magic_regdatum_set magic_scalarpack magic_set magic_set_all_env magic_setarylen magic_setcollxfrm magic_setdbline magic_setdebugvar magic_setdefelem magic_setenv magic_sethook magic_sethookall magic_setisa magic_setlvref magic_setmglob magic_setnkeys magic_setnonelem magic_setpack magic_setpos magic_setregexp magic_setsig magic_setsigall magic_setsubstr magic_settaint magic_setutf8 magic_setuvar magic_setvec magic_sizepack magic_wipepack make_trie malloc_good_size malloced_size markstack_grow mbtowc_ mem_collxfrm_ mem_log_alloc mem_log_del_sv mem_log_free mem_log_new_sv mem_log_realloc mg_find_mglob mg_size mode_from_discipline more_bodies more_sv moreswitches mortal_getenv mortalized_pv_copy mro_get_private_data mro_meta_dup mro_meta_init msbit_pos32 msbit_pos64 multiconcat_stringify multideref_stringify my_atof2 my_atof3 my_attrs my_clearenv my_lstat my_lstat_flags my_memrchr my_mkostemp_cloexec my_mkstemp_cloexec my_stat my_stat_flags my_strerror my_unexec _new_invlist_C_array _new_invlist new_stackinfo new_stackinfo_flags new_sv newFORM newMETHOP_internal newPROG newSTUB newSVavdefelem newXS_deffile nextargv no_bareword_allowed no_bareword_filehandle noperl_die notify_parser_that_encoding_changed oopsAV oopsHV op_clear op_integerize op_lvalue_flags op_prune_chain_head op_relocate_sv op_std_init op_varname opmethod_stash opslab_force_free opslab_free opslab_free_nopad opslab_slot_offset package package_version pad_add_weakref padlist_store padname_free PadnameIN_SCOPE padnamelist_free parse_unicode_opts parser_dup parser_free parser_free_nexttoke_ops path_is_searchable peep perl_alloc_using perl_clone_using PerlEnv_putenv PerlIO_context_layers PerlIO_restore_errno PerlIO_save_errno PerlLIO_dup_cloexec PerlLIO_dup2_cloexec PerlLIO_open_cloexec PerlLIO_open3_cloexec PerlProc_pipe_cloexec PerlSock_accept_cloexec PerlSock_socket_cloexec PerlSock_socketpair_cloexec perly_sighandler pmruntime POPMARK populate_anyof_bitmap_from_invlist populate_bitmap_from_invlist populate_invlist_from_bitmap populate_isa pregfree pregfree2 prepare_export_lexical ptr_hash qerror re_exec_indentf re_indentf re_intuit_start re_intuit_string re_op_compile re_printf ReANY reentrant_free reentrant_init reentrant_retry reentrant_size ref reg_add_data reg_named_buff reg_named_buff_all reg_named_buff_exists reg_named_buff_fetch reg_named_buff_firstkey reg_named_buff_iter reg_named_buff_nextkey reg_named_buff_scalar reg_numbered_buff_fetch reg_numbered_buff_fetch_flags reg_numbered_buff_length reg_numbered_buff_store reg_qr_package reg_skipcomment reg_temp_copy regcurly regdump regdupe_internal regexec_flags regfree_internal reginitcolors regnext regnode_after regprop release_RExC_state report_evil_fh report_redefined_cv report_wrongway_fh resume_compcv rpeep rsignal_restore rsignal_save rvpv_dup rxres_save same_dirent save_bool save_clearsv save_delete save_destructor save_destructor_x save_freeop save_freepv save_freesv save_int save_iv save_I8 save_I16 save_I32 save_mortalizesv save_pptr save_pushi32ptr save_pushptrptr save_re_context save_sptr save_strlen savestack_grow savestack_grow_cnt sawparens scalar scalarvoid scan_commit scan_num seed set_ANYOF_arg set_caret_X set_numeric_standard set_numeric_underlying set_padlist setfd_cloexec setfd_cloexec_for_nonsysfd setfd_cloexec_or_inhexec_by_sysfdness setfd_inhexec setfd_inhexec_for_sysfd _setup_canned_invlist share_hek should_warn_nl should_we_output_Debug_r sighandler sighandler1 sighandler3 single_1bit_pos32 single_1bit_pos64 size_to_psize Slab_Alloc Slab_Free Slab_to_ro Slab_to_rw softref2xv sortsv_flags_impl ssc_init stack_grow str_to_version strxfrm study_chunk sub_crush_depth subsignature_append_positional subsignature_append_slurpy subsignature_finish subsignature_start sv_add_backref sv_buf_to_ro sv_can_swipe_pv_buf sv_del_backref sv_i_ncmp sv_i_ncmp_desc sv_magicext_mglob sv_mark_arenas sv_ncmp sv_ncmp_desc sv_only_taint_gmagic sv_or_pv_pos_u2b sv_pvbyten_force_wrapper sv_pvutf8n_force_wrapper sv_resetpvn sv_sethek sv_sweep_arenas sv_unglob sv_2iv sv_2uv SvTRUE_common switch_locale_context sys_init sys_init3 sys_intern_clear sys_intern_dup sys_intern_init sys_term tied_method tmps_grow_p _to_fold_latin1 to_uni_fold _to_uni_fold_flags to_uni_lower to_uni_title to_uni_upper _to_upper_title_latin1 _to_utf8_fold_flags _to_utf8_lower_flags _to_utf8_title_flags _to_utf8_upper_flags TOPMARK translate_substr_offsets try_amagic_bin try_amagic_un unlnk unshare_hek unwind_paren utf8_to_bytes_ utf8_to_uv_msgs_helper_ utf16_to_utf8 utf16_to_utf8_base utf16_to_utf8_reversed utilize uvoffuni_to_utf8_flags_msgs variant_byte_number varname vivify_defelem vivify_ref wait4pid warn_elem_scalar_context warn_problematic_locale was_lvalue_sub watch win32_croak_not_implemented write_to_stderr xs_boot_epilog XS_builtin_indexed xs_handshake yyerror yyerror_pv yyerror_pvn yylex yyparse yyquit yyunlex"
4684 .PP
4685 .Vb 10
4686 \& abort_execution
4687 \& add_above_Latin1_folds
4688 \& add_cp_to_invlist
4689 \& _add_range_to_invlist
4690 \& allocmy
4691 \& amagic_cmp
4692 \& amagic_cmp_desc
4693 \& amagic_cmp_locale
4694 \& amagic_cmp_locale_desc
4695 \& amagic_i_ncmp
4696 \& amagic_i_ncmp_desc
4697 \& amagic_is_enabled
4698 \& amagic_ncmp
4699 \& amagic_ncmp_desc
4700 \& any_dup
4701 \& append_utf8_from_native_byte
4702 \& apply
4703 \& atfork_lock
4704 \& atfork_unlock
4705 \& av_arylen_p
4706 \& av_extend_guts
4707 \& av_iter_p
4708 \& av_nonelem
4709 \& av_reify
4710 \& bind_match
4711 \& block_gimme
4712 \& boot_core_builtin
4713 \& boot_core_mro
4714 \& boot_core_PerlIO
4715 \& boot_core_UNIVERSAL
4716 \& build_infix_plugin
4717 \& _byte_dump_string
4718 \& call_list
4719 \& cando
4720 \& capture_clear
4721 \& cast_iv
4722 \& cast_i32
4723 \& cast_ulong
4724 \& cast_uv
4725 \& check_hash_fields_and_hekify
4726 \& check_regnode_after
4727 \& check_utf8_print
4728 \& ck_anoncode
4729 \& ck_backtick
4730 \& ck_bitop
4731 \& ck_classname
4732 \& ck_cmp
4733 \& ck_concat
4734 \& ck_defined
4735 \& ck_delete
4736 \& ck_each
4737 \& ck_entersub_args_core
4738 \& ck_eof
4739 \& ck_eval
4740 \& ck_exec
4741 \& ck_exists
4742 \& ck_ftst
4743 \& ck_fun
4744 \& ck_glob
4745 \& ck_grep
4746 \& ck_helemexistsor
4747 \& ck_index
4748 \& ck_isa
4749 \& ck_join
4750 \& ck_length
4751 \& ck_lfun
4752 \& ck_listiob
4753 \& ck_match
4754 \& ck_method
4755 \& ck_null
4756 \& ck_open
4757 \& ck_prototype
4758 \& ck_readline
4759 \& ck_refassign
4760 \& ck_repeat
4761 \& ck_require
4762 \& ck_return
4763 \& ck_rfun
4764 \& ck_rvconst
4765 \& ck_sassign
4766 \& ck_scmp
4767 \& ck_select
4768 \& ck_shift
4769 \& ck_smartmatch
4770 \& ck_sort
4771 \& ck_spair
4772 \& ck_split
4773 \& ck_stringify
4774 \& ck_subr
4775 \& ck_substr
4776 \& ck_svconst
4777 \& ck_tell
4778 \& ck_trunc
4779 \& ck_trycatch
4780 \& ckwarn
4781 \& ckwarn_d
4782 \& class_add_ADJUST
4783 \& class_add_field
4784 \& class_apply_attributes
4785 \& class_apply_field_attributes
4786 \& class_prepare_initfield_parse
4787 \& class_prepare_method_parse
4788 \& class_seal_stash
4789 \& class_set_field_defop
4790 \& class_setup_stash
4791 \& class_wrap_method_body
4792 \& clear_defarray
4793 \& closest_cop
4794 \& cmp_desc
4795 \& cmp_locale_desc
4796 \& cmpchain_extend
4797 \& cmpchain_finish
4798 \& cmpchain_start
4799 \& cntrl_to_mnemonic
4800 \& construct_ahocorasick_from_trie
4801 \& cop_file_avn
4802 \& coresub_op
4803 \& croak_caller
4804 \& croak_kw_unless_class
4805 \& croak_memory_wrap
4806 \& croak_no_mem
4807 \& croak_no_mem_ext
4808 \& croak_popstack
4809 \& csighandler
4810 \& csighandler1
4811 \& csighandler3
4812 \& current_re_engine
4813 \& custom_op_get_field
4814 \& cv_clone_into
4815 \& cv_const_sv_or_av
4816 \& cv_undef_flags
4817 \& cvgv_from_hek
4818 \& cvgv_set
4819 \& cvstash_set
4820 \& cx_dump
4821 \& cx_dup
4822 \& cxinc
4823 \& deb_stack_all
4824 \& debstackptrs
4825 \& debug_hash_seed
4826 \& debug_peep
4827 \& debug_show_study_flags
4828 \& debug_studydata
4829 \& defelem_target
4830 \& despatch_signals
4831 \& die_unwind
4832 \& do_aexec
4833 \& do_aexec5
4834 \& do_aspawn
4835 \& do_eof
4836 \& do_exec
4837 \& do_exec3
4838 \& do_gv_dump
4839 \& do_gvgv_dump
4840 \& do_hv_dump
4841 \& do_ipcctl
4842 \& do_ipcget
4843 \& do_magic_dump
4844 \& do_msgrcv
4845 \& do_msgsnd
4846 \& do_ncmp
4847 \& do_op_dump
4848 \& do_pmop_dump
4849 \& do_print
4850 \& do_readline
4851 \& do_seek
4852 \& do_semop
4853 \& do_shmio
4854 \& do_spawn
4855 \& do_spawn_nowait
4856 \& do_sv_dump
4857 \& do_sysseek
4858 \& do_tell
4859 \& do_trans
4860 \& do_uniprop_match
4861 \& do_vecget
4862 \& do_vecset
4863 \& do_vop
4864 \& does_utf8_overflow
4865 \& dofile
4866 \& doing_taint
4867 \& doref
4868 \& drand48_init_r
4869 \& drand48_r
4870 \& dtrace_probe_call
4871 \& dtrace_probe_load
4872 \& dtrace_probe_op
4873 \& dtrace_probe_phase
4874 \& dump_all_perl
4875 \& dump_indent
4876 \& dump_packsubs_perl
4877 \& dump_sub_perl
4878 \& dump_sv_child
4879 \& dump_vindent
4880 \& dumpuntil
4881 \& dup_warnings
4882 \& find_first_differing_byte_pos
4883 \& find_lexical_cv
4884 \& find_runcv_where
4885 \& find_script
4886 \& finish_export_lexical
4887 \& foldEQ_latin1
4888 \& foldEQ_latin1_s2_folded
4889 \& foldEQ_utf8_flags
4890 \& force_locale_unlock
4891 \& force_out_malformed_utf8_message_
4892 \& form_alien_digit_msg
4893 \& form_cp_too_large_msg
4894 \& free_tied_hv_pool
4895 \& free_tmps
4896 \& get_and_check_backslash_N_name
4897 \& get_ANYOFHbbm_contents
4898 \& get_ANYOFM_contents
4899 \& get_db_sub
4900 \& get_debug_opts
4901 \& get_deprecated_property_msg
4902 \& get_extended_os_errno
4903 \& get_hash_seed
4904 \& get_invlist_iter_addr
4905 \& get_invlist_offset_addr
4906 \& get_invlist_previous_index_addr
4907 \& get_mstats
4908 \& get_prop_definition
4909 \& get_prop_values
4910 \& get_re_gclass_aux_data
4911 \& get_regclass_aux_data
4912 \& get_regex_charset_name
4913 \& get_win32_message_utf8ness
4914 \& getenv_len
4915 \& gp_free
4916 \& gp_ref
4917 \& grok_bin_oct_hex
4918 \& grok_bslash_c
4919 \& grok_bslash_o
4920 \& grok_bslash_x
4921 \& gv_check
4922 \& gv_fetchmeth_internal
4923 \& gv_override
4924 \& gv_setref
4925 \& gv_stashpvn_internal
4926 \& he_dup
4927 \& hek_dup
4928 \& hfree_next_entry
4929 \& hv_auxalloc
4930 \& hv_common
4931 \& hv_common_key_len
4932 \& hv_delayfree_ent
4933 \& hv_free_ent
4934 \& hv_placeholders_p
4935 \& hv_pushkv
4936 \& hv_rand_set
4937 \& hv_undef_flags
4938 \& import_builtin_bundle
4939 \& infix_plugin_standard
4940 \& init_argv_symbols
4941 \& init_constants
4942 \& init_dbargs
4943 \& init_debugger
4944 \& init_i18nl10n
4945 \& init_named_cv
4946 \& init_stacks
4947 \& init_tm
4948 \& init_uniprops
4949 \& _inverse_folds
4950 \& invert
4951 \& invlist_array
4952 \& _invlist_array_init
4953 \& invlist_clear
4954 \& invlist_clone
4955 \& _invlist_contains_cp
4956 \& invlist_contents
4957 \& _invlist_dump
4958 \& invlist_extend
4959 \& invlist_highest
4960 \& _invlist_intersection_maybe_complement_2nd
4961 \& _invlist_intersection
4962 \& _invlist_invert
4963 \& invlist_is_iterating
4964 \& invlist_iterfinish
4965 \& invlist_iterinit
4966 \& invlist_iternext
4967 \& _invlist_len
4968 \& invlist_max
4969 \& invlist_previous_index
4970 \& _invlist_search
4971 \& invlist_set_len
4972 \& invlist_set_previous_index
4973 \& _invlist_subtract
4974 \& invlist_trim
4975 \& _invlist_union_maybe_complement_2nd
4976 \& _invlist_union
4977 \& _invlistEQ
4978 \& invmap_dump
4979 \& invoke_exception_hook
4980 \& io_close
4981 \& is_grapheme
4982 \& is_in_locale_category_
4983 \& is_invlist
4984 \& is_standard_filehandle_name
4985 \& _is_uni_FOO
4986 \& _is_uni_perl_idcont
4987 \& _is_uni_perl_idstart
4988 \& is_utf8_char_helper_
4989 \& is_utf8_FF_helper_
4990 \& _is_utf8_FOO
4991 \& is_utf8_overlong
4992 \& _is_utf8_perl_idcont
4993 \& _is_utf8_perl_idstart
4994 \& isFF_overlong
4995 \& jmaybe
4996 \& join_exact
4997 \& keyword
4998 \& keyword_plugin_standard
4999 \& list
5000 \& load_charnames
5001 \& locale_panic
5002 \& localize
5003 \& lossless_NV_to_IV
5004 \& lsbit_pos32
5005 \& lsbit_pos64
5006 \& magic_clear_all_env
5007 \& magic_cleararylen_p
5008 \& magic_clearenv
5009 \& magic_clearhook
5010 \& magic_clearhookall
5011 \& magic_clearisa
5012 \& magic_clearpack
5013 \& magic_clearsig
5014 \& magic_copycallchecker
5015 \& magic_existspack
5016 \& magic_freearylen_p
5017 \& magic_freecollxfrm
5018 \& magic_freemglob
5019 \& magic_freeovrld
5020 \& magic_freeutf8
5021 \& magic_get
5022 \& magic_getarylen
5023 \& magic_getdebugvar
5024 \& magic_getdefelem
5025 \& magic_getnkeys
5026 \& magic_getpack
5027 \& magic_getpos
5028 \& magic_getsig
5029 \& magic_getsubstr
5030 \& magic_gettaint
5031 \& magic_getuvar
5032 \& magic_getvec
5033 \& magic_killbackrefs
5034 \& magic_nextpack
5035 \& magic_regdata_cnt
5036 \& magic_regdatum_get
5037 \& magic_regdatum_set
5038 \& magic_scalarpack
5039 \& magic_set
5040 \& magic_set_all_env
5041 \& magic_setarylen
5042 \& magic_setcollxfrm
5043 \& magic_setdbline
5044 \& magic_setdebugvar
5045 \& magic_setdefelem
5046 \& magic_setenv
5047 \& magic_sethook
5048 \& magic_sethookall
5049 \& magic_setisa
5050 \& magic_setlvref
5051 \& magic_setmglob
5052 \& magic_setnkeys
5053 \& magic_setnonelem
5054 \& magic_setpack
5055 \& magic_setpos
5056 \& magic_setregexp
5057 \& magic_setsig
5058 \& magic_setsigall
5059 \& magic_setsubstr
5060 \& magic_settaint
5061 \& magic_setutf8
5062 \& magic_setuvar
5063 \& magic_setvec
5064 \& magic_sizepack
5065 \& magic_wipepack
5066 \& make_trie
5067 \& malloc_good_size
5068 \& malloced_size
5069 \& markstack_grow
5070 \& mbtowc_
5071 \& mem_collxfrm_
5072 \& mem_log_alloc
5073 \& mem_log_del_sv
5074 \& mem_log_free
5075 \& mem_log_new_sv
5076 \& mem_log_realloc
5077 \& mg_find_mglob
5078 \& mg_size
5079 \& mode_from_discipline
5080 \& more_bodies
5081 \& more_sv
5082 \& moreswitches
5083 \& mortal_getenv
5084 \& mortalized_pv_copy
5085 \& mro_get_private_data
5086 \& mro_meta_dup
5087 \& mro_meta_init
5088 \& msbit_pos32
5089 \& msbit_pos64
5090 \& multiconcat_stringify
5091 \& multideref_stringify
5092 \& my_atof2
5093 \& my_atof3
5094 \& my_attrs
5095 \& my_clearenv
5096 \& my_lstat
5097 \& my_lstat_flags
5098 \& my_memrchr
5099 \& my_mkostemp_cloexec
5100 \& my_mkstemp_cloexec
5101 \& my_stat
5102 \& my_stat_flags
5103 \& my_strerror
5104 \& my_unexec
5105 \& _new_invlist_C_array
5106 \& _new_invlist
5107 \& new_stackinfo
5108 \& new_stackinfo_flags
5109 \& new_sv
5110 \& newFORM
5111 \& newMETHOP_internal
5112 \& newPROG
5113 \& newSTUB
5114 \& newSVavdefelem
5115 \& newXS_deffile
5116 \& nextargv
5117 \& no_bareword_allowed
5118 \& no_bareword_filehandle
5119 \& noperl_die
5120 \& notify_parser_that_encoding_changed
5121 \& oopsAV
5122 \& oopsHV
5123 \& op_clear
5124 \& op_integerize
5125 \& op_lvalue_flags
5126 \& op_prune_chain_head
5127 \& op_relocate_sv
5128 \& op_std_init
5129 \& op_varname
5130 \& opmethod_stash
5131 \& opslab_force_free
5132 \& opslab_free
5133 \& opslab_free_nopad
5134 \& opslab_slot_offset
5135 \& package
5136 \& package_version
5137 \& pad_add_weakref
5138 \& padlist_store
5139 \& padname_free
5140 \& PadnameIN_SCOPE
5141 \& padnamelist_free
5142 \& parse_unicode_opts
5143 \& parser_dup
5144 \& parser_free
5145 \& parser_free_nexttoke_ops
5146 \& path_is_searchable
5147 \& peep
5148 \& perl_alloc_using
5149 \& perl_clone_using
5150 \& PerlEnv_putenv
5151 \& PerlIO_context_layers
5152 \& PerlIO_restore_errno
5153 \& PerlIO_save_errno
5154 \& PerlLIO_dup_cloexec
5155 \& PerlLIO_dup2_cloexec
5156 \& PerlLIO_open_cloexec
5157 \& PerlLIO_open3_cloexec
5158 \& PerlProc_pipe_cloexec
5159 \& PerlSock_accept_cloexec
5160 \& PerlSock_socket_cloexec
5161 \& PerlSock_socketpair_cloexec
5162 \& perly_sighandler
5163 \& pmruntime
5164 \& POPMARK
5165 \& populate_anyof_bitmap_from_invlist
5166 \& populate_bitmap_from_invlist
5167 \& populate_invlist_from_bitmap
5168 \& populate_isa
5169 \& pregfree
5170 \& pregfree2
5171 \& prepare_export_lexical
5172 \& ptr_hash
5173 \& qerror
5174 \& re_exec_indentf
5175 \& re_indentf
5176 \& re_intuit_start
5177 \& re_intuit_string
5178 \& re_op_compile
5179 \& re_printf
5180 \& ReANY
5181 \& reentrant_free
5182 \& reentrant_init
5183 \& reentrant_retry
5184 \& reentrant_size
5185 \& ref
5186 \& reg_add_data
5187 \& reg_named_buff
5188 \& reg_named_buff_all
5189 \& reg_named_buff_exists
5190 \& reg_named_buff_fetch
5191 \& reg_named_buff_firstkey
5192 \& reg_named_buff_iter
5193 \& reg_named_buff_nextkey
5194 \& reg_named_buff_scalar
5195 \& reg_numbered_buff_fetch
5196 \& reg_numbered_buff_fetch_flags
5197 \& reg_numbered_buff_length
5198 \& reg_numbered_buff_store
5199 \& reg_qr_package
5200 \& reg_skipcomment
5201 \& reg_temp_copy
5202 \& regcurly
5203 \& regdump
5204 \& regdupe_internal
5205 \& regexec_flags
5206 \& regfree_internal
5207 \& reginitcolors
5208 \& regnext
5209 \& regnode_after
5210 \& regprop
5211 \& release_RExC_state
5212 \& report_evil_fh
5213 \& report_redefined_cv
5214 \& report_wrongway_fh
5215 \& resume_compcv
5216 \& rpeep
5217 \& rsignal_restore
5218 \& rsignal_save
5219 \& rvpv_dup
5220 \& rxres_save
5221 \& same_dirent
5222 \& save_bool
5223 \& save_clearsv
5224 \& save_delete
5225 \& save_destructor
5226 \& save_destructor_x
5227 \& save_freeop
5228 \& save_freepv
5229 \& save_freesv
5230 \& save_int
5231 \& save_iv
5232 \& save_I8
5233 \& save_I16
5234 \& save_I32
5235 \& save_mortalizesv
5236 \& save_pptr
5237 \& save_pushi32ptr
5238 \& save_pushptrptr
5239 \& save_re_context
5240 \& save_sptr
5241 \& save_strlen
5242 \& savestack_grow
5243 \& savestack_grow_cnt
5244 \& sawparens
5245 \& scalar
5246 \& scalarvoid
5247 \& scan_commit
5248 \& scan_num
5249 \& seed
5250 \& set_ANYOF_arg
5251 \& set_caret_X
5252 \& set_numeric_standard
5253 \& set_numeric_underlying
5254 \& set_padlist
5255 \& setfd_cloexec
5256 \& setfd_cloexec_for_nonsysfd
5257 \& setfd_cloexec_or_inhexec_by_sysfdness
5258 \& setfd_inhexec
5259 \& setfd_inhexec_for_sysfd
5260 \& _setup_canned_invlist
5261 \& share_hek
5262 \& should_warn_nl
5263 \& should_we_output_Debug_r
5264 \& sighandler
5265 \& sighandler1
5266 \& sighandler3
5267 \& single_1bit_pos32
5268 \& single_1bit_pos64
5269 \& size_to_psize
5270 \& Slab_Alloc
5271 \& Slab_Free
5272 \& Slab_to_ro
5273 \& Slab_to_rw
5274 \& softref2xv
5275 \& sortsv_flags_impl
5276 \& ssc_init
5277 \& stack_grow
5278 \& str_to_version
5279 \& strxfrm
5280 \& study_chunk
5281 \& sub_crush_depth
5282 \& subsignature_append_positional
5283 \& subsignature_append_slurpy
5284 \& subsignature_finish
5285 \& subsignature_start
5286 \& sv_add_backref
5287 \& sv_buf_to_ro
5288 \& sv_can_swipe_pv_buf
5289 \& sv_del_backref
5290 \& sv_i_ncmp
5291 \& sv_i_ncmp_desc
5292 \& sv_magicext_mglob
5293 \& sv_mark_arenas
5294 \& sv_ncmp
5295 \& sv_ncmp_desc
5296 \& sv_only_taint_gmagic
5297 \& sv_or_pv_pos_u2b
5298 \& sv_pvbyten_force_wrapper
5299 \& sv_pvutf8n_force_wrapper
5300 \& sv_resetpvn
5301 \& sv_sethek
5302 \& sv_sweep_arenas
5303 \& sv_unglob
5304 \& sv_2iv
5305 \& sv_2uv
5306 \& SvTRUE_common
5307 \& switch_locale_context
5308 \& sys_init
5309 \& sys_init3
5310 \& sys_intern_clear
5311 \& sys_intern_dup
5312 \& sys_intern_init
5313 \& sys_term
5314 \& tied_method
5315 \& tmps_grow_p
5316 \& _to_fold_latin1
5317 \& to_uni_fold
5318 \& _to_uni_fold_flags
5319 \& to_uni_lower
5320 \& to_uni_title
5321 \& to_uni_upper
5322 \& _to_upper_title_latin1
5323 \& _to_utf8_fold_flags
5324 \& _to_utf8_lower_flags
5325 \& _to_utf8_title_flags
5326 \& _to_utf8_upper_flags
5327 \& TOPMARK
5328 \& translate_substr_offsets
5329 \& try_amagic_bin
5330 \& try_amagic_un
5331 \& unlnk
5332 \& unshare_hek
5333 \& unwind_paren
5334 \& utf8_to_bytes_
5335 \& utf8_to_uv_msgs_helper_
5336 \& utf16_to_utf8
5337 \& utf16_to_utf8_base
5338 \& utf16_to_utf8_reversed
5339 \& utilize
5340 \& uvoffuni_to_utf8_flags_msgs
5341 \& variant_byte_number
5342 \& varname
5343 \& vivify_defelem
5344 \& vivify_ref
5345 \& wait4pid
5346 \& warn_elem_scalar_context
5347 \& warn_problematic_locale
5348 \& was_lvalue_sub
5349 \& watch
5350 \& win32_croak_not_implemented
5351 \& write_to_stderr
5352 \& xs_boot_epilog
5353 \& XS_builtin_indexed
5354 \& xs_handshake
5355 \& yyerror
5356 \& yyerror_pv
5357 \& yyerror_pvn
5358 \& yylex
5359 \& yyparse
5360 \& yyquit
5361 \& yyunlex
5362 .Ve
5363 .PP
5364 Next are the experimental undocumented elements
5365 .PP
5366
5367 .IX Xref "alloc_LOGOP av_remove_offset clear_defarray_simple create_eval_scope cv_ckproto_len_flags cx_popblock cx_popeval cx_popformat cx_popgiven cx_poploop cx_popsub cx_popsub_args cx_popsub_common cx_popwhen cx_pushblock cx_pusheval cx_pushformat cx_pushgiven cx_pushloop_for cx_pushloop_plain cx_pushsub cx_pushtry cx_pushwhen cx_topblock delete_eval_scope do_open_raw do_open6 emulate_cop_io get_re_arg get_vtbl gimme_V hv_backreferences_p hv_kill_backrefs invlist_highest_range_start invlist_lowest new_warnings_bitfield newGP op_refcnt_dec op_refcnt_inc op_unscope pop_stackinfo pp_wrap push_stackinfo rpp_free_2_ rpp_obliterate_stack_to rpp_replace_2_1_COMMON runops_wrap scan_str scan_word skipspace_flags sv_free2 sv_kill_backrefs sv_setpv_freshbuf sv_setsv_cow switch_argstack utf8_to_utf16_base xs_wrap"
5368 .PP
5369 .Vb 10
5370 \& alloc_LOGOP get_vtbl
5371 \& av_remove_offset gimme_V
5372 \& clear_defarray_simple hv_backreferences_p
5373 \& create_eval_scope hv_kill_backrefs
5374 \& cv_ckproto_len_flags invlist_highest_range_start
5375 \& cx_popblock invlist_lowest
5376 \& cx_popeval new_warnings_bitfield
5377 \& cx_popformat newGP
5378 \& cx_popgiven op_refcnt_dec
5379 \& cx_poploop op_refcnt_inc
5380 \& cx_popsub op_unscope
5381 \& cx_popsub_args pop_stackinfo
5382 \& cx_popsub_common pp_wrap
5383 \& cx_popwhen push_stackinfo
5384 \& cx_pushblock rpp_free_2_
5385 \& cx_pusheval rpp_obliterate_stack_to
5386 \& cx_pushformat rpp_replace_2_1_COMMON
5387 \& cx_pushgiven runops_wrap
5388 \& cx_pushloop_for scan_str
5389 \& cx_pushloop_plain scan_word
5390 \& cx_pushsub skipspace_flags
5391 \& cx_pushtry sv_free2
5392 \& cx_pushwhen sv_kill_backrefs
5393 \& cx_topblock sv_setpv_freshbuf
5394 \& delete_eval_scope sv_setsv_cow
5395 \& do_open_raw switch_argstack
5396 \& do_open6 utf8_to_utf16_base
5397 \& emulate_cop_io xs_wrap
5398 \& get_re_arg
5399 .Ve
5400 .PP
5401 Finally are the deprecated undocumented elements.
5402 Do not use any for new code; remove all occurrences of all of these from
5403 existing code.
5404 .PP
5405
5406 .IX Xref "get_no_modify get_opargs get_ppaddr uvuni_to_utf8"
5407 .PP
5408 .Vb 1
5409 \& get_no_modify get_opargs get_ppaddr uvuni_to_utf8
5410 .Ve
5411 .SH AUTHORS
5412 .IX Header "AUTHORS"
5413 The autodocumentation system was originally added to the Perl core by
5414 Benjamin Stuhl. Documentation is by whoever was kind enough to
5415 document their functions.
5416 .SH "SEE ALSO"
5417 .IX Header "SEE ALSO"
5418 \&\fIconfig.h\fR, perlapi, perlapio, perlcall, perlclib, perlembed, perlfilter, perlguts, perlhacktips, perlinterp, perliol, perlmroapi, perlreapi, perlreguts, perlxs