Commit | Line | Data |
---|---|---|
3f98fbb3 RGS |
1 | -*- buffer-read-only: t -*- |
2 | ||
3 | !!!!!!! DO NOT EDIT THIS FILE !!!!!!! | |
4 | This file is built by autodoc.pl extracting documentation from the C source | |
5 | files. | |
6 | ||
954c1994 GS |
7 | =head1 NAME |
8 | ||
1c846c1f | 9 | perlintern - autogenerated documentation of purely B<internal> |
954c1994 GS |
10 | Perl functions |
11 | ||
12 | =head1 DESCRIPTION | |
d8c40edc | 13 | X<internal Perl functions> X<interpreter functions> |
954c1994 | 14 | |
1c846c1f | 15 | This file is the autogenerated documentation of functions in the |
4375e838 | 16 | Perl interpreter that are documented using Perl's internal documentation |
1c846c1f | 17 | format but are not marked as part of the Perl API. In other words, |
954c1994 GS |
18 | B<they are not for use in extensions>! |
19 | ||
a8586c98 | 20 | |
7dafbf52 DM |
21 | =head1 CV reference counts and CvOUTSIDE |
22 | ||
23 | =over 8 | |
24 | ||
25 | =item CvWEAKOUTSIDE | |
d8c40edc | 26 | X<CvWEAKOUTSIDE> |
7dafbf52 DM |
27 | |
28 | Each CV has a pointer, C<CvOUTSIDE()>, to its lexically enclosing | |
29 | CV (if any). Because pointers to anonymous sub prototypes are | |
30 | stored in C<&> pad slots, it is a possible to get a circular reference, | |
31 | with the parent pointing to the child and vice-versa. To avoid the | |
32 | ensuing memory leak, we do not increment the reference count of the CV | |
33 | pointed to by C<CvOUTSIDE> in the I<one specific instance> that the parent | |
34 | has a C<&> pad slot pointing back to us. In this case, we set the | |
35 | C<CvWEAKOUTSIDE> flag in the child. This allows us to determine under what | |
36 | circumstances we should decrement the refcount of the parent when freeing | |
37 | the child. | |
38 | ||
28a5cf3b | 39 | There is a further complication with non-closure anonymous subs (i.e. those |
7dafbf52 DM |
40 | that do not refer to any lexicals outside that sub). In this case, the |
41 | anonymous prototype is shared rather than being cloned. This has the | |
42 | consequence that the parent may be freed while there are still active | |
43 | children, eg | |
44 | ||
45 | BEGIN { $a = sub { eval '$x' } } | |
46 | ||
47 | In this case, the BEGIN is freed immediately after execution since there | |
48 | are no active references to it: the anon sub prototype has | |
49 | C<CvWEAKOUTSIDE> set since it's not a closure, and $a points to the same | |
50 | CV, so it doesn't contribute to BEGIN's refcount either. When $a is | |
51 | executed, the C<eval '$x'> causes the chain of C<CvOUTSIDE>s to be followed, | |
52 | and the freed BEGIN is accessed. | |
53 | ||
54 | To avoid this, whenever a CV and its associated pad is freed, any | |
55 | C<&> entries in the pad are explicitly removed from the pad, and if the | |
56 | refcount of the pointed-to anon sub is still positive, then that | |
57 | child's C<CvOUTSIDE> is set to point to its grandparent. This will only | |
58 | occur in the single specific case of a non-closure anon prototype | |
59 | having one or more active references (such as C<$a> above). | |
60 | ||
61 | One other thing to consider is that a CV may be merely undefined | |
62 | rather than freed, eg C<undef &foo>. In this case, its refcount may | |
63 | not have reached zero, but we still delete its pad and its C<CvROOT> etc. | |
64 | Since various children may still have their C<CvOUTSIDE> pointing at this | |
65 | undefined CV, we keep its own C<CvOUTSIDE> for the time being, so that | |
66 | the chain of lexical scopes is unbroken. For example, the following | |
67 | should print 123: | |
68 | ||
69 | my $x = 123; | |
70 | sub tmp { sub { eval '$x' } } | |
71 | my $a = tmp(); | |
72 | undef &tmp; | |
73 | print $a->(); | |
74 | ||
75 | bool CvWEAKOUTSIDE(CV *cv) | |
76 | ||
77 | =for hackers | |
78 | Found in file cv.h | |
79 | ||
80 | ||
81 | =back | |
82 | ||
dd2155a4 DM |
83 | =head1 Functions in file pad.h |
84 | ||
85 | ||
86 | =over 8 | |
87 | ||
88 | =item CX_CURPAD_SAVE | |
d8c40edc | 89 | X<CX_CURPAD_SAVE> |
dd2155a4 DM |
90 | |
91 | Save the current pad in the given context block structure. | |
92 | ||
93 | void CX_CURPAD_SAVE(struct context) | |
94 | ||
95 | =for hackers | |
96 | Found in file pad.h | |
97 | ||
98 | =item CX_CURPAD_SV | |
d8c40edc | 99 | X<CX_CURPAD_SV> |
dd2155a4 DM |
100 | |
101 | Access the SV at offset po in the saved current pad in the given | |
102 | context block structure (can be used as an lvalue). | |
103 | ||
f3548bdc | 104 | SV * CX_CURPAD_SV(struct context, PADOFFSET po) |
dd2155a4 DM |
105 | |
106 | =for hackers | |
107 | Found in file pad.h | |
108 | ||
d8c40edc AT |
109 | =item PAD_BASE_SV |
110 | X<PAD_BASE_SV> | |
dd2155a4 DM |
111 | |
112 | Get the value from slot C<po> in the base (DEPTH=1) pad of a padlist | |
113 | ||
d8c40edc | 114 | SV * PAD_BASE_SV(PADLIST padlist, PADOFFSET po) |
dd2155a4 DM |
115 | |
116 | =for hackers | |
117 | Found in file pad.h | |
118 | ||
119 | =item PAD_CLONE_VARS | |
d8c40edc | 120 | X<PAD_CLONE_VARS> |
dd2155a4 DM |
121 | |
122 | |CLONE_PARAMS* param | |
123 | Clone the state variables associated with running and compiling pads. | |
124 | ||
125 | void PAD_CLONE_VARS(PerlInterpreter *proto_perl \) | |
126 | ||
127 | =for hackers | |
128 | Found in file pad.h | |
129 | ||
130 | =item PAD_COMPNAME_FLAGS | |
d8c40edc | 131 | X<PAD_COMPNAME_FLAGS> |
dd2155a4 DM |
132 | |
133 | Return the flags for the current compiling pad name | |
134 | at offset C<po>. Assumes a valid slot entry. | |
135 | ||
136 | U32 PAD_COMPNAME_FLAGS(PADOFFSET po) | |
137 | ||
138 | =for hackers | |
139 | Found in file pad.h | |
140 | ||
141 | =item PAD_COMPNAME_GEN | |
d8c40edc | 142 | X<PAD_COMPNAME_GEN> |
dd2155a4 DM |
143 | |
144 | The generation number of the name at offset C<po> in the current | |
00a0d662 | 145 | compiling pad (lvalue). Note that C<SvUVX> is hijacked for this purpose. |
dd2155a4 DM |
146 | |
147 | STRLEN PAD_COMPNAME_GEN(PADOFFSET po) | |
148 | ||
149 | =for hackers | |
150 | Found in file pad.h | |
151 | ||
27da23d5 | 152 | =item PAD_COMPNAME_GEN_set |
d8c40edc | 153 | X<PAD_COMPNAME_GEN_set> |
27da23d5 JH |
154 | |
155 | Sets the generation number of the name at offset C<po> in the current | |
00a0d662 | 156 | ling pad (lvalue) to C<gen>. Note that C<SvUV_set> is hijacked for this purpose. |
27da23d5 JH |
157 | |
158 | STRLEN PAD_COMPNAME_GEN_set(PADOFFSET po, int gen) | |
159 | ||
160 | =for hackers | |
161 | Found in file pad.h | |
162 | ||
dd2155a4 | 163 | =item PAD_COMPNAME_OURSTASH |
d8c40edc | 164 | X<PAD_COMPNAME_OURSTASH> |
dd2155a4 DM |
165 | |
166 | Return the stash associated with an C<our> variable. | |
167 | Assumes the slot entry is a valid C<our> lexical. | |
168 | ||
169 | HV * PAD_COMPNAME_OURSTASH(PADOFFSET po) | |
170 | ||
171 | =for hackers | |
172 | Found in file pad.h | |
173 | ||
174 | =item PAD_COMPNAME_PV | |
d8c40edc | 175 | X<PAD_COMPNAME_PV> |
dd2155a4 DM |
176 | |
177 | Return the name of the current compiling pad name | |
178 | at offset C<po>. Assumes a valid slot entry. | |
179 | ||
180 | char * PAD_COMPNAME_PV(PADOFFSET po) | |
181 | ||
182 | =for hackers | |
183 | Found in file pad.h | |
184 | ||
185 | =item PAD_COMPNAME_TYPE | |
d8c40edc | 186 | X<PAD_COMPNAME_TYPE> |
dd2155a4 DM |
187 | |
188 | Return the type (stash) of the current compiling pad name at offset | |
189 | C<po>. Must be a valid name. Returns null if not typed. | |
190 | ||
191 | HV * PAD_COMPNAME_TYPE(PADOFFSET po) | |
192 | ||
193 | =for hackers | |
194 | Found in file pad.h | |
195 | ||
196 | =item PAD_DUP | |
d8c40edc | 197 | X<PAD_DUP> |
dd2155a4 DM |
198 | |
199 | Clone a padlist. | |
200 | ||
201 | void PAD_DUP(PADLIST dstpad, PADLIST srcpad, CLONE_PARAMS* param) | |
202 | ||
203 | =for hackers | |
204 | Found in file pad.h | |
205 | ||
f3548bdc | 206 | =item PAD_RESTORE_LOCAL |
d8c40edc | 207 | X<PAD_RESTORE_LOCAL> |
f3548bdc DM |
208 | |
209 | Restore the old pad saved into the local variable opad by PAD_SAVE_LOCAL() | |
210 | ||
211 | void PAD_RESTORE_LOCAL(PAD *opad) | |
212 | ||
213 | =for hackers | |
214 | Found in file pad.h | |
215 | ||
216 | =item PAD_SAVE_LOCAL | |
d8c40edc | 217 | X<PAD_SAVE_LOCAL> |
f3548bdc DM |
218 | |
219 | Save the current pad to the local variable opad, then make the | |
220 | current pad equal to npad | |
221 | ||
222 | void PAD_SAVE_LOCAL(PAD *opad, PAD *npad) | |
223 | ||
224 | =for hackers | |
225 | Found in file pad.h | |
226 | ||
dd2155a4 | 227 | =item PAD_SAVE_SETNULLPAD |
d8c40edc | 228 | X<PAD_SAVE_SETNULLPAD> |
dd2155a4 DM |
229 | |
230 | Save the current pad then set it to null. | |
231 | ||
232 | void PAD_SAVE_SETNULLPAD() | |
233 | ||
234 | =for hackers | |
235 | Found in file pad.h | |
236 | ||
d8c40edc AT |
237 | =item PAD_SETSV |
238 | X<PAD_SETSV> | |
dd2155a4 DM |
239 | |
240 | Set the slot at offset C<po> in the current pad to C<sv> | |
241 | ||
d8c40edc | 242 | SV * PAD_SETSV(PADOFFSET po, SV* sv) |
dd2155a4 DM |
243 | |
244 | =for hackers | |
245 | Found in file pad.h | |
246 | ||
d8c40edc AT |
247 | =item PAD_SET_CUR |
248 | X<PAD_SET_CUR> | |
dd2155a4 DM |
249 | |
250 | Set the current pad to be pad C<n> in the padlist, saving | |
f54ba1c2 DM |
251 | the previous current pad. NB currently this macro expands to a string too |
252 | long for some compilers, so it's best to replace it with | |
253 | ||
254 | SAVECOMPPAD(); | |
255 | PAD_SET_CUR_NOSAVE(padlist,n); | |
256 | ||
dd2155a4 | 257 | |
d8c40edc | 258 | void PAD_SET_CUR(PADLIST padlist, I32 n) |
dd2155a4 DM |
259 | |
260 | =for hackers | |
261 | Found in file pad.h | |
262 | ||
d8c40edc AT |
263 | =item PAD_SET_CUR_NOSAVE |
264 | X<PAD_SET_CUR_NOSAVE> | |
bf9cdc68 RG |
265 | |
266 | like PAD_SET_CUR, but without the save | |
267 | ||
d8c40edc | 268 | void PAD_SET_CUR_NOSAVE(PADLIST padlist, I32 n) |
bf9cdc68 RG |
269 | |
270 | =for hackers | |
271 | Found in file pad.h | |
272 | ||
d8c40edc AT |
273 | =item PAD_SV |
274 | X<PAD_SV> | |
dd2155a4 DM |
275 | |
276 | Get the value at offset C<po> in the current pad | |
277 | ||
d8c40edc | 278 | void PAD_SV(PADOFFSET po) |
dd2155a4 DM |
279 | |
280 | =for hackers | |
281 | Found in file pad.h | |
282 | ||
d8c40edc AT |
283 | =item PAD_SVl |
284 | X<PAD_SVl> | |
dd2155a4 DM |
285 | |
286 | Lightweight and lvalue version of C<PAD_SV>. | |
287 | Get or set the value at offset C<po> in the current pad. | |
288 | Unlike C<PAD_SV>, does not print diagnostics with -DX. | |
289 | For internal use only. | |
290 | ||
d8c40edc | 291 | SV * PAD_SVl(PADOFFSET po) |
dd2155a4 DM |
292 | |
293 | =for hackers | |
294 | Found in file pad.h | |
295 | ||
d8c40edc AT |
296 | =item SAVECLEARSV |
297 | X<SAVECLEARSV> | |
dd2155a4 | 298 | |
28a5cf3b | 299 | Clear the pointed to pad value on scope exit. (i.e. the runtime action of 'my') |
dd2155a4 | 300 | |
d8c40edc | 301 | void SAVECLEARSV(SV **svp) |
dd2155a4 DM |
302 | |
303 | =for hackers | |
304 | Found in file pad.h | |
305 | ||
306 | =item SAVECOMPPAD | |
d8c40edc | 307 | X<SAVECOMPPAD> |
dd2155a4 DM |
308 | |
309 | save PL_comppad and PL_curpad | |
310 | ||
dd2155a4 | 311 | |
dd2155a4 DM |
312 | |
313 | ||
314 | ||
f3548bdc | 315 | void SAVECOMPPAD() |
dd2155a4 DM |
316 | |
317 | =for hackers | |
318 | Found in file pad.h | |
319 | ||
d8c40edc AT |
320 | =item SAVEPADSV |
321 | X<SAVEPADSV> | |
dd2155a4 DM |
322 | |
323 | Save a pad slot (used to restore after an iteration) | |
324 | ||
f3548bdc | 325 | XXX DAPM it would make more sense to make the arg a PADOFFSET |
d8c40edc | 326 | void SAVEPADSV(PADOFFSET po) |
dd2155a4 DM |
327 | |
328 | =for hackers | |
329 | Found in file pad.h | |
330 | ||
331 | ||
332 | =back | |
333 | ||
a4f1a029 NIS |
334 | =head1 GV Functions |
335 | ||
336 | =over 8 | |
337 | ||
338 | =item is_gv_magical | |
d8c40edc | 339 | X<is_gv_magical> |
a4f1a029 NIS |
340 | |
341 | Returns C<TRUE> if given the name of a magical GV. | |
342 | ||
343 | Currently only useful internally when determining if a GV should be | |
344 | created even in rvalue contexts. | |
345 | ||
346 | C<flags> is not used at present but available for future extension to | |
347 | allow selecting particular classes of magical variable. | |
348 | ||
766f8916 MHM |
349 | Currently assumes that C<name> is NUL terminated (as well as len being valid). |
350 | This assumption is met by all callers within the perl core, which all pass | |
351 | pointers returned by SvPV. | |
352 | ||
7fc63493 AL |
353 | bool is_gv_magical(const char *name, STRLEN len, U32 flags) |
354 | ||
355 | =for hackers | |
356 | Found in file gv.c | |
357 | ||
358 | =item is_gv_magical_sv | |
d8c40edc | 359 | X<is_gv_magical_sv> |
7fc63493 AL |
360 | |
361 | Returns C<TRUE> if given the name of a magical GV. Calls is_gv_magical. | |
362 | ||
363 | bool is_gv_magical_sv(SV *name, U32 flags) | |
645c22ef DM |
364 | |
365 | =for hackers | |
a4f1a029 NIS |
366 | Found in file gv.c |
367 | ||
368 | ||
369 | =back | |
370 | ||
b3ca2e83 NC |
371 | =head1 Hash Manipulation Functions |
372 | ||
373 | =over 8 | |
374 | ||
bd95ae50 SH |
375 | =item refcounted_he_chain_2hv |
376 | X<refcounted_he_chain_2hv> | |
377 | ||
8a0be661 | 378 | Generates and returns a C<HV *> by walking up the tree starting at the passed |
bd95ae50 SH |
379 | in C<struct refcounted_he *>. |
380 | ||
381 | HV * refcounted_he_chain_2hv(const struct refcounted_he *c) | |
382 | ||
383 | =for hackers | |
384 | Found in file hv.c | |
385 | ||
b3ca2e83 NC |
386 | =item refcounted_he_free |
387 | X<refcounted_he_free> | |
388 | ||
389 | Decrements the reference count of the passed in C<struct refcounted_he *> | |
390 | by one. If the reference count reaches zero the structure's memory is freed, | |
391 | and C<refcounted_he_free> iterates onto the parent node. | |
392 | ||
393 | void refcounted_he_free(struct refcounted_he *he) | |
394 | ||
395 | =for hackers | |
396 | Found in file hv.c | |
397 | ||
398 | =item refcounted_he_new | |
399 | X<refcounted_he_new> | |
400 | ||
ec2a1de7 NC |
401 | Creates a new C<struct refcounted_he>. As S<key> is copied, and value is |
402 | stored in a compact form, all references remain the property of the caller. | |
403 | The C<struct refcounted_he> is returned with a reference count of 1. | |
b3ca2e83 | 404 | |
b46c265e | 405 | struct refcounted_he * refcounted_he_new(struct refcounted_he *const parent, SV *const key, SV *const value) |
b3ca2e83 NC |
406 | |
407 | =for hackers | |
408 | Found in file hv.c | |
409 | ||
410 | ||
411 | =back | |
412 | ||
a4f1a029 NIS |
413 | =head1 IO Functions |
414 | ||
415 | =over 8 | |
645c22ef | 416 | |
a8586c98 | 417 | =item start_glob |
d8c40edc | 418 | X<start_glob> |
a8586c98 JH |
419 | |
420 | Function called by C<do_readline> to spawn a glob (or do the glob inside | |
421 | perl on VMS). This code used to be inline, but now perl uses C<File::Glob> | |
bd16a5f0 | 422 | this glob starter is only used by miniperl during the build process. |
a8586c98 JH |
423 | Moving it away shrinks pp_hot.c; shrinking pp_hot.c helps speed perl up. |
424 | ||
425 | PerlIO* start_glob(SV* pattern, IO *io) | |
426 | ||
427 | =for hackers | |
428 | Found in file doio.c | |
429 | ||
a4f1a029 NIS |
430 | |
431 | =back | |
432 | ||
0cbee0a4 DM |
433 | =head1 Magical Functions |
434 | ||
435 | =over 8 | |
436 | ||
b3ca2e83 NC |
437 | =item magic_sethint |
438 | X<magic_sethint> | |
439 | ||
c28fe1ec NC |
440 | Triggered by a delete from %^H, records the key to |
441 | C<PL_compiling.cop_hints_hash>. | |
b3ca2e83 NC |
442 | |
443 | int magic_sethint(SV* sv, MAGIC* mg) | |
444 | ||
445 | =for hackers | |
446 | Found in file mg.c | |
447 | ||
0cbee0a4 | 448 | =item mg_localize |
d8c40edc | 449 | X<mg_localize> |
0cbee0a4 DM |
450 | |
451 | Copy some of the magic from an existing SV to new localized version of | |
452 | that SV. Container magic (eg %ENV, $1, tie) gets copied, value magic | |
453 | doesn't (eg taint, pos). | |
454 | ||
455 | void mg_localize(SV* sv, SV* nsv) | |
456 | ||
457 | =for hackers | |
458 | Found in file mg.c | |
459 | ||
460 | ||
461 | =back | |
462 | ||
47c9dd14 BB |
463 | =head1 MRO Functions |
464 | ||
465 | =over 8 | |
466 | ||
467 | =item mro_isa_changed_in | |
468 | X<mro_isa_changed_in> | |
469 | ||
470 | Takes the necessary steps (cache invalidations, mostly) | |
471 | when the @ISA of the given package has changed. Invoked | |
472 | by the C<setisa> magic, should not need to invoke directly. | |
473 | ||
474 | void mro_isa_changed_in(HV* stash) | |
475 | ||
476 | =for hackers | |
477 | Found in file mro.c | |
478 | ||
479 | ||
480 | =back | |
481 | ||
a4f1a029 NIS |
482 | =head1 Pad Data Structures |
483 | ||
484 | =over 8 | |
485 | ||
486 | =item CvPADLIST | |
d8c40edc | 487 | X<CvPADLIST> |
a4f1a029 NIS |
488 | |
489 | CV's can have CvPADLIST(cv) set to point to an AV. | |
490 | ||
491 | For these purposes "forms" are a kind-of CV, eval""s are too (except they're | |
492 | not callable at will and are always thrown away after the eval"" is done | |
b5c19bd7 DM |
493 | executing). Require'd files are simply evals without any outer lexical |
494 | scope. | |
a4f1a029 NIS |
495 | |
496 | XSUBs don't have CvPADLIST set - dXSTARG fetches values from PL_curpad, | |
497 | but that is really the callers pad (a slot of which is allocated by | |
498 | every entersub). | |
499 | ||
500 | The CvPADLIST AV has does not have AvREAL set, so REFCNT of component items | |
f3548bdc | 501 | is managed "manual" (mostly in pad.c) rather than normal av.c rules. |
a4f1a029 NIS |
502 | The items in the AV are not SVs as for a normal AV, but other AVs: |
503 | ||
504 | 0'th Entry of the CvPADLIST is an AV which represents the "names" or rather | |
505 | the "static type information" for lexicals. | |
506 | ||
507 | The CvDEPTH'th entry of CvPADLIST AV is an AV which is the stack frame at that | |
508 | depth of recursion into the CV. | |
509 | The 0'th slot of a frame AV is an AV which is @_. | |
510 | other entries are storage for variables and op targets. | |
511 | ||
512 | During compilation: | |
a6d05634 TM |
513 | C<PL_comppad_name> is set to the names AV. |
514 | C<PL_comppad> is set to the frame AV for the frame CvDEPTH == 1. | |
515 | C<PL_curpad> is set to the body of the frame AV (i.e. AvARRAY(PL_comppad)). | |
a4f1a029 | 516 | |
f3548bdc DM |
517 | During execution, C<PL_comppad> and C<PL_curpad> refer to the live |
518 | frame of the currently executing sub. | |
519 | ||
520 | Iterating over the names AV iterates over all possible pad | |
a4f1a029 NIS |
521 | items. Pad slots that are SVs_PADTMP (targets/GVs/constants) end up having |
522 | &PL_sv_undef "names" (see pad_alloc()). | |
523 | ||
524 | Only my/our variable (SVs_PADMY/SVs_PADOUR) slots get valid names. | |
525 | The rest are op targets/GVs/constants which are statically allocated | |
526 | or resolved at compile time. These don't have names by which they | |
527 | can be looked up from Perl code at run time through eval"" like | |
528 | my/our variables can be. Since they can't be looked up by "name" | |
529 | but only by their index allocated at compile time (which is usually | |
530 | in PL_op->op_targ), wasting a name SV for them doesn't make sense. | |
531 | ||
532 | The SVs in the names AV have their PV being the name of the variable. | |
00a0d662 NC |
533 | xlow+1..xhigh inclusive in the NV union is a range of cop_seq numbers for |
534 | which the name is valid. For typed lexicals name SV is SVt_PVMG and SvSTASH | |
535 | points at the type. For C<our> lexicals, the type is also SVt_PVMG, with the | |
44a2ac75 | 536 | SvOURSTASH slot pointing at the stash of the associated global (so that |
00a0d662 NC |
537 | duplicate C<our> declarations in the same package can be detected). SvUVX is |
538 | sometimes hijacked to store the generation number during compilation. | |
a4f1a029 | 539 | |
b5c19bd7 DM |
540 | If SvFAKE is set on the name SV, then that slot in the frame AV is |
541 | a REFCNT'ed reference to a lexical from "outside". In this case, | |
00a0d662 NC |
542 | the name SV does not use xlow and xhigh to store a cop_seq range, since it is |
543 | in scope throughout. Instead xhigh stores some flags containing info about | |
b5c19bd7 | 544 | the real lexical (is it declared in an anon, and is it capable of being |
00a0d662 | 545 | instantiated multiple times?), and for fake ANONs, xlow contains the index |
b5c19bd7 DM |
546 | within the parent's pad where the lexical's value is stored, to make |
547 | cloning quicker. | |
a4f1a029 | 548 | |
a6d05634 | 549 | If the 'name' is '&' the corresponding entry in frame AV |
a4f1a029 NIS |
550 | is a CV representing a possible closure. |
551 | (SvFAKE and name of '&' is not a meaningful combination currently but could | |
552 | become so if C<my sub foo {}> is implemented.) | |
553 | ||
5c3943b6 RGS |
554 | Note that formats are treated as anon subs, and are cloned each time |
555 | write is called (if necessary). | |
556 | ||
2814eb74 PJ |
557 | The flag SVf_PADSTALE is cleared on lexicals each time the my() is executed, |
558 | and set on scope exit. This allows the 'Variable $x is not available' warning | |
559 | to be generated in evals, such as | |
560 | ||
561 | { my $x = 1; sub f { eval '$x'} } f(); | |
562 | ||
a4f1a029 NIS |
563 | AV * CvPADLIST(CV *cv) |
564 | ||
565 | =for hackers | |
dd2155a4 DM |
566 | Found in file pad.c |
567 | ||
568 | =item cv_clone | |
d8c40edc | 569 | X<cv_clone> |
dd2155a4 DM |
570 | |
571 | Clone a CV: make a new CV which points to the same code etc, but which | |
ad63d80f | 572 | has a newly-created pad built by copying the prototype pad and capturing |
dd2155a4 DM |
573 | any outer lexicals. |
574 | ||
575 | CV* cv_clone(CV* proto) | |
576 | ||
577 | =for hackers | |
578 | Found in file pad.c | |
579 | ||
580 | =item cv_dump | |
d8c40edc | 581 | X<cv_dump> |
dd2155a4 DM |
582 | |
583 | dump the contents of a CV | |
584 | ||
e1ec3a88 | 585 | void cv_dump(const CV *cv, const char *title) |
dd2155a4 DM |
586 | |
587 | =for hackers | |
588 | Found in file pad.c | |
589 | ||
590 | =item do_dump_pad | |
d8c40edc | 591 | X<do_dump_pad> |
dd2155a4 DM |
592 | |
593 | Dump the contents of a padlist | |
594 | ||
595 | void do_dump_pad(I32 level, PerlIO *file, PADLIST *padlist, int full) | |
596 | ||
597 | =for hackers | |
598 | Found in file pad.c | |
599 | ||
600 | =item intro_my | |
d8c40edc | 601 | X<intro_my> |
dd2155a4 DM |
602 | |
603 | "Introduce" my variables to visible status. | |
604 | ||
605 | U32 intro_my() | |
606 | ||
607 | =for hackers | |
608 | Found in file pad.c | |
609 | ||
610 | =item pad_add_anon | |
d8c40edc | 611 | X<pad_add_anon> |
dd2155a4 DM |
612 | |
613 | Add an anon code entry to the current compiling pad | |
614 | ||
615 | PADOFFSET pad_add_anon(SV* sv, OPCODE op_type) | |
616 | ||
617 | =for hackers | |
618 | Found in file pad.c | |
619 | ||
620 | =item pad_add_name | |
d8c40edc | 621 | X<pad_add_name> |
dd2155a4 | 622 | |
b5c19bd7 DM |
623 | Create a new name and associated PADMY SV in the current pad; return the |
624 | offset. | |
dd2155a4 DM |
625 | If C<typestash> is valid, the name is for a typed lexical; set the |
626 | name's stash to that value. | |
627 | If C<ourstash> is valid, it's an our lexical, set the name's | |
44a2ac75 | 628 | SvOURSTASH to that value |
dd2155a4 | 629 | |
dd2155a4 DM |
630 | If fake, it means we're cloning an existing entry |
631 | ||
952306ac | 632 | PADOFFSET pad_add_name(const char *name, HV* typestash, HV* ourstash, bool clone, bool state) |
dd2155a4 DM |
633 | |
634 | =for hackers | |
635 | Found in file pad.c | |
636 | ||
637 | =item pad_alloc | |
d8c40edc | 638 | X<pad_alloc> |
dd2155a4 DM |
639 | |
640 | Allocate a new my or tmp pad entry. For a my, simply push a null SV onto | |
641 | the end of PL_comppad, but for a tmp, scan the pad from PL_padix upwards | |
324092c6 | 642 | for a slot which has no name and no active value. |
dd2155a4 DM |
643 | |
644 | PADOFFSET pad_alloc(I32 optype, U32 tmptype) | |
645 | ||
646 | =for hackers | |
647 | Found in file pad.c | |
648 | ||
649 | =item pad_block_start | |
d8c40edc | 650 | X<pad_block_start> |
dd2155a4 DM |
651 | |
652 | Update the pad compilation state variables on entry to a new block | |
653 | ||
654 | void pad_block_start(int full) | |
655 | ||
656 | =for hackers | |
657 | Found in file pad.c | |
658 | ||
659 | =item pad_check_dup | |
d8c40edc | 660 | X<pad_check_dup> |
dd2155a4 DM |
661 | |
662 | Check for duplicate declarations: report any of: | |
663 | * a my in the current scope with the same name; | |
664 | * an our (anywhere in the pad) with the same name and the same stash | |
665 | as C<ourstash> | |
666 | C<is_our> indicates that the name to check is an 'our' declaration | |
667 | ||
e1ec3a88 | 668 | void pad_check_dup(const char* name, bool is_our, const HV* ourstash) |
dd2155a4 DM |
669 | |
670 | =for hackers | |
671 | Found in file pad.c | |
672 | ||
673 | =item pad_findlex | |
d8c40edc | 674 | X<pad_findlex> |
dd2155a4 DM |
675 | |
676 | Find a named lexical anywhere in a chain of nested pads. Add fake entries | |
b5c19bd7 DM |
677 | in the inner pads if it's found in an outer one. |
678 | ||
679 | Returns the offset in the bottom pad of the lex or the fake lex. | |
680 | cv is the CV in which to start the search, and seq is the current cop_seq | |
681 | to match against. If warn is true, print appropriate warnings. The out_* | |
682 | vars return values, and so are pointers to where the returned values | |
683 | should be stored. out_capture, if non-null, requests that the innermost | |
684 | instance of the lexical is captured; out_name_sv is set to the innermost | |
685 | matched namesv or fake namesv; out_flags returns the flags normally | |
686 | associated with the IVX field of a fake namesv. | |
687 | ||
688 | Note that pad_findlex() is recursive; it recurses up the chain of CVs, | |
689 | then comes back down, adding fake entries as it goes. It has to be this way | |
00a0d662 | 690 | because fake namesvs in anon protoypes have to store in xlow the index into |
b5c19bd7 DM |
691 | the parent pad. |
692 | ||
e1ec3a88 | 693 | PADOFFSET pad_findlex(const char *name, const CV* cv, U32 seq, int warn, SV** out_capture, SV** out_name_sv, int *out_flags) |
dd2155a4 DM |
694 | |
695 | =for hackers | |
696 | Found in file pad.c | |
697 | ||
698 | =item pad_findmy | |
d8c40edc | 699 | X<pad_findmy> |
dd2155a4 | 700 | |
ad63d80f | 701 | Given a lexical name, try to find its offset, first in the current pad, |
dd2155a4 | 702 | or failing that, in the pads of any lexically enclosing subs (including |
ad63d80f JP |
703 | the complications introduced by eval). If the name is found in an outer pad, |
704 | then a fake entry is added to the current pad. | |
dd2155a4 DM |
705 | Returns the offset in the current pad, or NOT_IN_PAD on failure. |
706 | ||
e1ec3a88 | 707 | PADOFFSET pad_findmy(const char* name) |
dd2155a4 DM |
708 | |
709 | =for hackers | |
710 | Found in file pad.c | |
711 | ||
712 | =item pad_fixup_inner_anons | |
d8c40edc | 713 | X<pad_fixup_inner_anons> |
dd2155a4 DM |
714 | |
715 | For any anon CVs in the pad, change CvOUTSIDE of that CV from | |
7dafbf52 DM |
716 | old_cv to new_cv if necessary. Needed when a newly-compiled CV has to be |
717 | moved to a pre-existing CV struct. | |
dd2155a4 DM |
718 | |
719 | void pad_fixup_inner_anons(PADLIST *padlist, CV *old_cv, CV *new_cv) | |
720 | ||
721 | =for hackers | |
722 | Found in file pad.c | |
723 | ||
724 | =item pad_free | |
d8c40edc | 725 | X<pad_free> |
dd2155a4 | 726 | |
d7f8936a | 727 | Free the SV at offset po in the current pad. |
dd2155a4 DM |
728 | |
729 | void pad_free(PADOFFSET po) | |
730 | ||
731 | =for hackers | |
732 | Found in file pad.c | |
733 | ||
734 | =item pad_leavemy | |
d8c40edc | 735 | X<pad_leavemy> |
dd2155a4 DM |
736 | |
737 | Cleanup at end of scope during compilation: set the max seq number for | |
738 | lexicals in this scope and warn of any lexicals that never got introduced. | |
739 | ||
740 | void pad_leavemy() | |
741 | ||
742 | =for hackers | |
743 | Found in file pad.c | |
744 | ||
745 | =item pad_new | |
d8c40edc | 746 | X<pad_new> |
dd2155a4 | 747 | |
ad63d80f | 748 | Create a new compiling padlist, saving and updating the various global |
dd2155a4 DM |
749 | vars at the same time as creating the pad itself. The following flags |
750 | can be OR'ed together: | |
751 | ||
752 | padnew_CLONE this pad is for a cloned CV | |
753 | padnew_SAVE save old globals | |
754 | padnew_SAVESUB also save extra stuff for start of sub | |
755 | ||
c7c737cb | 756 | PADLIST* pad_new(int flags) |
dd2155a4 DM |
757 | |
758 | =for hackers | |
759 | Found in file pad.c | |
760 | ||
761 | =item pad_push | |
d8c40edc | 762 | X<pad_push> |
dd2155a4 DM |
763 | |
764 | Push a new pad frame onto the padlist, unless there's already a pad at | |
26019298 AL |
765 | this depth, in which case don't bother creating a new one. Then give |
766 | the new pad an @_ in slot zero. | |
dd2155a4 | 767 | |
26019298 | 768 | void pad_push(PADLIST *padlist, int depth) |
dd2155a4 DM |
769 | |
770 | =for hackers | |
771 | Found in file pad.c | |
772 | ||
773 | =item pad_reset | |
d8c40edc | 774 | X<pad_reset> |
dd2155a4 DM |
775 | |
776 | Mark all the current temporaries for reuse | |
777 | ||
778 | void pad_reset() | |
779 | ||
780 | =for hackers | |
781 | Found in file pad.c | |
782 | ||
783 | =item pad_setsv | |
d8c40edc | 784 | X<pad_setsv> |
dd2155a4 DM |
785 | |
786 | Set the entry at offset po in the current pad to sv. | |
787 | Use the macro PAD_SETSV() rather than calling this function directly. | |
788 | ||
789 | void pad_setsv(PADOFFSET po, SV* sv) | |
790 | ||
791 | =for hackers | |
792 | Found in file pad.c | |
793 | ||
794 | =item pad_swipe | |
d8c40edc | 795 | X<pad_swipe> |
dd2155a4 DM |
796 | |
797 | Abandon the tmp in the current pad at offset po and replace with a | |
798 | new one. | |
799 | ||
800 | void pad_swipe(PADOFFSET po, bool refadjust) | |
801 | ||
802 | =for hackers | |
803 | Found in file pad.c | |
804 | ||
805 | =item pad_tidy | |
d8c40edc | 806 | X<pad_tidy> |
dd2155a4 DM |
807 | |
808 | Tidy up a pad after we've finished compiling it: | |
809 | * remove most stuff from the pads of anonsub prototypes; | |
810 | * give it a @_; | |
811 | * mark tmps as such. | |
812 | ||
813 | void pad_tidy(padtidy_type type) | |
814 | ||
815 | =for hackers | |
816 | Found in file pad.c | |
817 | ||
818 | =item pad_undef | |
d8c40edc | 819 | X<pad_undef> |
dd2155a4 DM |
820 | |
821 | Free the padlist associated with a CV. | |
822 | If parts of it happen to be current, we null the relevant | |
823 | PL_*pad* global vars so that we don't have any dangling references left. | |
824 | We also repoint the CvOUTSIDE of any about-to-be-orphaned | |
a3985cdc | 825 | inner subs to the outer of this cv. |
dd2155a4 | 826 | |
7dafbf52 DM |
827 | (This function should really be called pad_free, but the name was already |
828 | taken) | |
829 | ||
a3985cdc | 830 | void pad_undef(CV* cv) |
dd2155a4 DM |
831 | |
832 | =for hackers | |
833 | Found in file pad.c | |
a4f1a029 NIS |
834 | |
835 | ||
836 | =back | |
837 | ||
907b3e23 DM |
838 | =head1 Per-Interpreter Variables |
839 | ||
840 | =over 8 | |
841 | ||
842 | =item PL_DBsingle | |
843 | X<PL_DBsingle> | |
844 | ||
845 | When Perl is run in debugging mode, with the B<-d> switch, this SV is a | |
846 | boolean which indicates whether subs are being single-stepped. | |
847 | Single-stepping is automatically turned on after every step. This is the C | |
848 | variable which corresponds to Perl's $DB::single variable. See | |
849 | C<PL_DBsub>. | |
850 | ||
851 | SV * PL_DBsingle | |
852 | ||
853 | =for hackers | |
854 | Found in file intrpvar.h | |
855 | ||
856 | =item PL_DBsub | |
857 | X<PL_DBsub> | |
858 | ||
859 | When Perl is run in debugging mode, with the B<-d> switch, this GV contains | |
860 | the SV which holds the name of the sub being debugged. This is the C | |
861 | variable which corresponds to Perl's $DB::sub variable. See | |
862 | C<PL_DBsingle>. | |
863 | ||
864 | GV * PL_DBsub | |
865 | ||
866 | =for hackers | |
867 | Found in file intrpvar.h | |
868 | ||
869 | =item PL_DBtrace | |
870 | X<PL_DBtrace> | |
871 | ||
872 | Trace variable used when Perl is run in debugging mode, with the B<-d> | |
873 | switch. This is the C variable which corresponds to Perl's $DB::trace | |
874 | variable. See C<PL_DBsingle>. | |
875 | ||
876 | SV * PL_DBtrace | |
877 | ||
878 | =for hackers | |
879 | Found in file intrpvar.h | |
880 | ||
881 | =item PL_dowarn | |
882 | X<PL_dowarn> | |
883 | ||
884 | The C variable which corresponds to Perl's $^W warning variable. | |
885 | ||
886 | bool PL_dowarn | |
887 | ||
888 | =for hackers | |
889 | Found in file intrpvar.h | |
890 | ||
891 | =item PL_last_in_gv | |
892 | X<PL_last_in_gv> | |
893 | ||
894 | The GV which was last used for a filehandle input operation. (C<< <FH> >>) | |
895 | ||
896 | GV* PL_last_in_gv | |
897 | ||
898 | =for hackers | |
899 | Found in file intrpvar.h | |
900 | ||
901 | =item PL_ofs_sv | |
902 | X<PL_ofs_sv> | |
903 | ||
904 | The output field separator - C<$,> in Perl space. | |
905 | ||
906 | SV* PL_ofs_sv | |
907 | ||
908 | =for hackers | |
909 | Found in file intrpvar.h | |
910 | ||
911 | =item PL_rs | |
912 | X<PL_rs> | |
913 | ||
914 | The input record separator - C<$/> in Perl space. | |
915 | ||
916 | SV* PL_rs | |
917 | ||
918 | =for hackers | |
919 | Found in file intrpvar.h | |
920 | ||
921 | ||
922 | =back | |
923 | ||
a4f1a029 NIS |
924 | =head1 Stack Manipulation Macros |
925 | ||
926 | =over 8 | |
927 | ||
928 | =item djSP | |
d8c40edc | 929 | X<djSP> |
a4f1a029 NIS |
930 | |
931 | Declare Just C<SP>. This is actually identical to C<dSP>, and declares | |
932 | a local copy of perl's stack pointer, available via the C<SP> macro. | |
933 | See C<SP>. (Available for backward source code compatibility with the | |
934 | old (Perl 5.005) thread model.) | |
935 | ||
936 | djSP; | |
937 | ||
938 | =for hackers | |
939 | Found in file pp.h | |
940 | ||
941 | =item LVRET | |
d8c40edc | 942 | X<LVRET> |
a4f1a029 NIS |
943 | |
944 | True if this op will be the return value of an lvalue subroutine | |
945 | ||
946 | =for hackers | |
947 | Found in file pp.h | |
948 | ||
949 | ||
950 | =back | |
951 | ||
952 | =head1 SV Manipulation Functions | |
953 | ||
954 | =over 8 | |
955 | ||
645c22ef | 956 | =item sv_add_arena |
d8c40edc | 957 | X<sv_add_arena> |
645c22ef DM |
958 | |
959 | Given a chunk of memory, link it to the head of the list of arenas, | |
960 | and split it into a list of free SVs. | |
961 | ||
962 | void sv_add_arena(char* ptr, U32 size, U32 flags) | |
963 | ||
964 | =for hackers | |
965 | Found in file sv.c | |
966 | ||
967 | =item sv_clean_all | |
d8c40edc | 968 | X<sv_clean_all> |
645c22ef DM |
969 | |
970 | Decrement the refcnt of each remaining SV, possibly triggering a | |
971 | cleanup. This function may have to be called multiple times to free | |
8fb26106 | 972 | SVs which are in complex self-referential hierarchies. |
645c22ef DM |
973 | |
974 | I32 sv_clean_all() | |
975 | ||
976 | =for hackers | |
977 | Found in file sv.c | |
978 | ||
979 | =item sv_clean_objs | |
d8c40edc | 980 | X<sv_clean_objs> |
645c22ef DM |
981 | |
982 | Attempt to destroy all objects not yet freed | |
983 | ||
984 | void sv_clean_objs() | |
985 | ||
986 | =for hackers | |
987 | Found in file sv.c | |
988 | ||
989 | =item sv_free_arenas | |
d8c40edc | 990 | X<sv_free_arenas> |
645c22ef DM |
991 | |
992 | Deallocate the memory used by all arenas. Note that all the individual SV | |
993 | heads and bodies within the arenas must already have been freed. | |
994 | ||
995 | void sv_free_arenas() | |
996 | ||
997 | =for hackers | |
998 | Found in file sv.c | |
999 | ||
a4f1a029 | 1000 | |
954c1994 GS |
1001 | =back |
1002 | ||
979f2922 TS |
1003 | =head1 Unicode Support |
1004 | ||
1005 | =over 8 | |
1006 | ||
1007 | =item find_uninit_var | |
1008 | X<find_uninit_var> | |
1009 | ||
1010 | Find the name of the undefined variable (if any) that caused the operator o | |
1011 | to issue a "Use of uninitialized value" warning. | |
1012 | If match is true, only return a name if it's value matches uninit_sv. | |
1013 | So roughly speaking, if a unary operator (such as OP_COS) generates a | |
1014 | warning, then following the direct child of the op may yield an | |
1015 | OP_PADSV or OP_GV that gives the name of the undefined variable. On the | |
1016 | other hand, with OP_ADD there are two branches to follow, so we only print | |
1017 | the variable name if we get an exact match. | |
1018 | ||
1019 | The name is returned as a mortal SV. | |
1020 | ||
1021 | Assumes that PL_op is the op that originally triggered the error, and that | |
1022 | PL_comppad/PL_curpad points to the currently executing pad. | |
1023 | ||
1024 | SV* find_uninit_var(OP* obase, SV* uninit_sv, bool top) | |
1025 | ||
1026 | =for hackers | |
1027 | Found in file sv.c | |
1028 | ||
1029 | =item report_uninit | |
1030 | X<report_uninit> | |
1031 | ||
1032 | Print appropriate "Use of uninitialized variable" warning | |
1033 | ||
1034 | void report_uninit(SV* uninit_sv) | |
1035 | ||
1036 | =for hackers | |
1037 | Found in file sv.c | |
1038 | ||
1039 | ||
1040 | =back | |
1041 | ||
954c1994 GS |
1042 | =head1 AUTHORS |
1043 | ||
1c846c1f NIS |
1044 | The autodocumentation system was originally added to the Perl core by |
1045 | Benjamin Stuhl. Documentation is by whoever was kind enough to | |
954c1994 GS |
1046 | document their functions. |
1047 | ||
1048 | =head1 SEE ALSO | |
1049 | ||
1050 | perlguts(1), perlapi(1) | |
1051 | ||
3f98fbb3 RGS |
1052 | =cut |
1053 | ||
1054 | ex: set ro: |