pod/perlintern.pod

   1 =head1 NAME
   2
   3 perlintern - autogenerated documentation of purely B<internal>
   4                  Perl functions
   5
   6 =head1 DESCRIPTION
   7
   8 This file is the autogenerated documentation of functions in the
   9 Perl interpreter that are documented using Perl's internal documentation
  10 format but are not marked as part of the Perl API. In other words,
  11 B<they are not for use in extensions>!
  12
  13
  14 =head1 Functions in file pad.h
  15
  16
  17 =over 8
  18
  19 =item CX_CURPAD_SAVE
  20
  21 Save the current pad in the given context block structure.
  22
  23         void    CX_CURPAD_SAVE(struct context)
  24
  25 =for hackers
  26 Found in file pad.h
  27
  28 =item CX_CURPAD_SV
  29
  30 Access the SV at offset po in the saved current pad in the given
  31 context block structure (can be used as an lvalue).
  32
  33         SV *    CX_CURPAD_SV(struct context, PADOFFSET po)
  34
  35 =for hackers
  36 Found in file pad.h
  37
  38 =item PAD_BASE_SV
  39
  40 Get the value from slot C<po> in the base (DEPTH=1) pad of a padlist
  41
  42         SV *    PAD_BASE_SV     (PADLIST padlist, PADOFFSET po)
  43
  44 =for hackers
  45 Found in file pad.h
  46
  47 =item PAD_CLONE_VARS
  48
  49 |CLONE_PARAMS* param
  50 Clone the state variables associated with running and compiling pads.
  51
  52         void    PAD_CLONE_VARS(PerlInterpreter *proto_perl \)
  53
  54 =for hackers
  55 Found in file pad.h
  56
  57 =item PAD_COMPNAME_FLAGS
  58
  59 Return the flags for the current compiling pad name
  60 at offset C<po>. Assumes a valid slot entry.
  61
  62         U32     PAD_COMPNAME_FLAGS(PADOFFSET po)
  63
  64 =for hackers
  65 Found in file pad.h
  66
  67 =item PAD_COMPNAME_GEN
  68
  69 The generation number of the name at offset C<po> in the current
  70 compiling pad (lvalue). Note that C<SvCUR> is hijacked for this purpose.
  71
  72         STRLEN  PAD_COMPNAME_GEN(PADOFFSET po)
  73
  74 =for hackers
  75 Found in file pad.h
  76
  77 =item PAD_COMPNAME_OURSTASH
  78
  79 Return the stash associated with an C<our> variable.
  80 Assumes the slot entry is a valid C<our> lexical.
  81
  82         HV *    PAD_COMPNAME_OURSTASH(PADOFFSET po)
  83
  84 =for hackers
  85 Found in file pad.h
  86
  87 =item PAD_COMPNAME_PV
  88
  89 Return the name of the current compiling pad name
  90 at offset C<po>. Assumes a valid slot entry.
  91
  92         char *  PAD_COMPNAME_PV(PADOFFSET po)
  93
  94 =for hackers
  95 Found in file pad.h
  96
  97 =item PAD_COMPNAME_TYPE
  98
  99 Return the type (stash) of the current compiling pad name at offset
 100 C<po>. Must be a valid name. Returns null if not typed.
 101
 102         HV *    PAD_COMPNAME_TYPE(PADOFFSET po)
 103
 104 =for hackers
 105 Found in file pad.h
 106
 107 =item PAD_DUP
 108
 109 Clone a padlist.
 110
 111         void    PAD_DUP(PADLIST dstpad, PADLIST srcpad, CLONE_PARAMS* param)
 112
 113 =for hackers
 114 Found in file pad.h
 115
 116 =item PAD_RESTORE_LOCAL
 117
 118 Restore the old pad saved into the local variable opad by PAD_SAVE_LOCAL()
 119
 120         void    PAD_RESTORE_LOCAL(PAD *opad)
 121
 122 =for hackers
 123 Found in file pad.h
 124
 125 =item PAD_SAVE_LOCAL
 126
 127 Save the current pad to the local variable opad, then make the
 128 current pad equal to npad
 129
 130         void    PAD_SAVE_LOCAL(PAD *opad, PAD *npad)
 131
 132 =for hackers
 133 Found in file pad.h
 134
 135 =item PAD_SAVE_SETNULLPAD
 136
 137 Save the current pad then set it to null.
 138
 139         void    PAD_SAVE_SETNULLPAD()
 140
 141 =for hackers
 142 Found in file pad.h
 143
 144 =item PAD_SETSV
 145
 146 Set the slot at offset C<po> in the current pad to C<sv>
 147
 148         SV *    PAD_SETSV       (PADOFFSET po, SV* sv)
 149
 150 =for hackers
 151 Found in file pad.h
 152
 153 =item PAD_SET_CUR
 154
 155 Set the current pad to be pad C<n> in the padlist, saving
 156 the previous current pad.
 157
 158         void    PAD_SET_CUR     (PADLIST padlist, I32 n)
 159
 160 =for hackers
 161 Found in file pad.h
 162
 163 =item PAD_SV
 164
 165 Get the value at offset C<po> in the current pad
 166
 167         void    PAD_SV  (PADOFFSET po)
 168
 169 =for hackers
 170 Found in file pad.h
 171
 172 =item PAD_SVl
 173
 174 Lightweight and lvalue version of C<PAD_SV>.
 175 Get or set the value at offset C<po> in the current pad.
 176 Unlike C<PAD_SV>, does not print diagnostics with -DX.
 177 For internal use only.
 178
 179         SV *    PAD_SVl (PADOFFSET po)
 180
 181 =for hackers
 182 Found in file pad.h
 183
 184 =item SAVECLEARSV
 185
 186 Clear the pointed to pad value on scope exit. (ie the runtime action of 'my')
 187
 188         void    SAVECLEARSV     (SV **svp)
 189
 190 =for hackers
 191 Found in file pad.h
 192
 193 =item SAVECOMPPAD
 194
 195 save PL_comppad and PL_curpad
 196
 197
 198
 199
 200
 201         void    SAVECOMPPAD()
 202
 203 =for hackers
 204 Found in file pad.h
 205
 206 =item SAVEPADSV
 207
 208 Save a pad slot (used to restore after an iteration)
 209
 210 XXX DAPM it would make more sense to make the arg a PADOFFSET
 211         void    SAVEPADSV       (PADOFFSET po)
 212
 213 =for hackers
 214 Found in file pad.h
 215
 216
 217 =back
 218
 219 =head1 Functions in file pp_ctl.c
 220
 221
 222 =over 8
 223
 224 =item find_runcv
 225
 226 Locate the CV corresponding to the currently executing sub or eval.
 227
 228         CV*     find_runcv()
 229
 230 =for hackers
 231 Found in file pp_ctl.c
 232
 233
 234 =back
 235
 236 =head1 Global Variables
 237
 238 =over 8
 239
 240 =item PL_DBsingle
 241
 242 When Perl is run in debugging mode, with the B<-d> switch, this SV is a
 243 boolean which indicates whether subs are being single-stepped.
 244 Single-stepping is automatically turned on after every step.  This is the C
 245 variable which corresponds to Perl's $DB::single variable.  See
 246 C<PL_DBsub>.
 247
 248         SV *    PL_DBsingle
 249
 250 =for hackers
 251 Found in file intrpvar.h
 252
 253 =item PL_DBsub
 254
 255 When Perl is run in debugging mode, with the B<-d> switch, this GV contains
 256 the SV which holds the name of the sub being debugged.  This is the C
 257 variable which corresponds to Perl's $DB::sub variable.  See
 258 C<PL_DBsingle>.
 259
 260         GV *    PL_DBsub
 261
 262 =for hackers
 263 Found in file intrpvar.h
 264
 265 =item PL_DBtrace
 266
 267 Trace variable used when Perl is run in debugging mode, with the B<-d>
 268 switch.  This is the C variable which corresponds to Perl's $DB::trace
 269 variable.  See C<PL_DBsingle>.
 270
 271         SV *    PL_DBtrace
 272
 273 =for hackers
 274 Found in file intrpvar.h
 275
 276 =item PL_dowarn
 277
 278 The C variable which corresponds to Perl's $^W warning variable.
 279
 280         bool    PL_dowarn
 281
 282 =for hackers
 283 Found in file intrpvar.h
 284
 285 =item PL_last_in_gv
 286
 287 The GV which was last used for a filehandle input operation. (C<< <FH> >>)
 288
 289         GV*     PL_last_in_gv
 290
 291 =for hackers
 292 Found in file thrdvar.h
 293
 294 =item PL_ofs_sv
 295
 296 The output field separator - C<$,> in Perl space.
 297
 298         SV*     PL_ofs_sv
 299
 300 =for hackers
 301 Found in file thrdvar.h
 302
 303 =item PL_rs
 304
 305 The input record separator - C<$/> in Perl space.
 306
 307         SV*     PL_rs
 308
 309 =for hackers
 310 Found in file thrdvar.h
 311
 312
 313 =back
 314
 315 =head1 GV Functions
 316
 317 =over 8
 318
 319 =item is_gv_magical
 320
 321 Returns C<TRUE> if given the name of a magical GV.
 322
 323 Currently only useful internally when determining if a GV should be
 324 created even in rvalue contexts.
 325
 326 C<flags> is not used at present but available for future extension to
 327 allow selecting particular classes of magical variable.
 328
 329         bool    is_gv_magical(char *name, STRLEN len, U32 flags)
 330
 331 =for hackers
 332 Found in file gv.c
 333
 334
 335 =back
 336
 337 =head1 IO Functions
 338
 339 =over 8
 340
 341 =item start_glob
 342
 343 Function called by C<do_readline> to spawn a glob (or do the glob inside
 344 perl on VMS). This code used to be inline, but now perl uses C<File::Glob>
 345 this glob starter is only used by miniperl during the build process.
 346 Moving it away shrinks pp_hot.c; shrinking pp_hot.c helps speed perl up.
 347
 348         PerlIO* start_glob(SV* pattern, IO *io)
 349
 350 =for hackers
 351 Found in file doio.c
 352
 353
 354 =back
 355
 356 =head1 Pad Data Structures
 357
 358 =over 8
 359
 360 =item CvPADLIST
 361
 362 CV's can have CvPADLIST(cv) set to point to an AV.
 363
 364 For these purposes "forms" are a kind-of CV, eval""s are too (except they're
 365 not callable at will and are always thrown away after the eval"" is done
 366 executing).
 367
 368 XSUBs don't have CvPADLIST set - dXSTARG fetches values from PL_curpad,
 369 but that is really the callers pad (a slot of which is allocated by
 370 every entersub).
 371
 372 The CvPADLIST AV has does not have AvREAL set, so REFCNT of component items
 373 is managed "manual" (mostly in pad.c) rather than normal av.c rules.
 374 The items in the AV are not SVs as for a normal AV, but other AVs:
 375
 376 0'th Entry of the CvPADLIST is an AV which represents the "names" or rather
 377 the "static type information" for lexicals.
 378
 379 The CvDEPTH'th entry of CvPADLIST AV is an AV which is the stack frame at that
 380 depth of recursion into the CV.
 381 The 0'th slot of a frame AV is an AV which is @_.
 382 other entries are storage for variables and op targets.
 383
 384 During compilation:
 385 C<PL_comppad_name> is set the the the names AV.
 386 C<PL_comppad> is set the the frame AV for the frame CvDEPTH == 1.
 387 C<PL_curpad> is set the body of the frame AV (i.e. AvARRAY(PL_comppad)).
 388
 389 During execution, C<PL_comppad> and C<PL_curpad> refer to the live
 390 frame of the currently executing sub.
 391
 392 Iterating over the names AV iterates over all possible pad
 393 items. Pad slots that are SVs_PADTMP (targets/GVs/constants) end up having
 394 &PL_sv_undef "names" (see pad_alloc()).
 395
 396 Only my/our variable (SVs_PADMY/SVs_PADOUR) slots get valid names.
 397 The rest are op targets/GVs/constants which are statically allocated
 398 or resolved at compile time.  These don't have names by which they
 399 can be looked up from Perl code at run time through eval"" like
 400 my/our variables can be.  Since they can't be looked up by "name"
 401 but only by their index allocated at compile time (which is usually
 402 in PL_op->op_targ), wasting a name SV for them doesn't make sense.
 403
 404 The SVs in the names AV have their PV being the name of the variable.
 405 NV+1..IV inclusive is a range of cop_seq numbers for which the name is
 406 valid.  For typed lexicals name SV is SVt_PVMG and SvSTASH points at the
 407 type.  For C<our> lexicals, the type is SVt_PVGV, and GvSTASH points at the
 408 stash of the associated global (so that duplicate C<our> delarations in the
 409 same package can be detected).  SvCUR is sometimes hijacked to
 410 store the generation number during compilation.
 411
 412 If SvFAKE is set on the name SV then slot in the frame AVs are
 413 a REFCNT'ed references to a lexical from "outside".
 414
 415 If the 'name' is '&' the the corresponding entry in frame AV
 416 is a CV representing a possible closure.
 417 (SvFAKE and name of '&' is not a meaningful combination currently but could
 418 become so if C<my sub foo {}> is implemented.)
 419
 420         AV *    CvPADLIST(CV *cv)
 421
 422 =for hackers
 423 Found in file pad.c
 424
 425 =item cv_clone
 426
 427 Clone a CV: make a new CV which points to the same code etc, but which
 428 has a newly-created pad built by copying the prototype pad and capturing
 429 any outer lexicals.
 430
 431         CV*     cv_clone(CV* proto)
 432
 433 =for hackers
 434 Found in file pad.c
 435
 436 =item cv_dump
 437
 438 dump the contents of a CV
 439
 440         void    cv_dump(CV *cv, char *title)
 441
 442 =for hackers
 443 Found in file pad.c
 444
 445 =item do_dump_pad
 446
 447 Dump the contents of a padlist
 448
 449         void    do_dump_pad(I32 level, PerlIO *file, PADLIST *padlist, int full)
 450
 451 =for hackers
 452 Found in file pad.c
 453
 454 =item intro_my
 455
 456 "Introduce" my variables to visible status.
 457
 458         U32     intro_my()
 459
 460 =for hackers
 461 Found in file pad.c
 462
 463 =item pad_add_anon
 464
 465 Add an anon code entry to the current compiling pad
 466
 467         PADOFFSET       pad_add_anon(SV* sv, OPCODE op_type)
 468
 469 =for hackers
 470 Found in file pad.c
 471
 472 =item pad_add_name
 473
 474 Create a new name in the current pad at the specified offset.
 475 If C<typestash> is valid, the name is for a typed lexical; set the
 476 name's stash to that value.
 477 If C<ourstash> is valid, it's an our lexical, set the name's
 478 GvSTASH to that value
 479
 480 Also, if the name is @.. or %.., create a new array or hash for that slot
 481
 482 If fake, it means we're cloning an existing entry
 483
 484         PADOFFSET       pad_add_name(char *name, HV* typestash, HV* ourstash, bool clone)
 485
 486 =for hackers
 487 Found in file pad.c
 488
 489 =item pad_alloc
 490
 491 Allocate a new my or tmp pad entry. For a my, simply push a null SV onto
 492 the end of PL_comppad, but for a tmp, scan the pad from PL_padix upwards
 493 for a slot which has no name and and no active value.
 494
 495         PADOFFSET       pad_alloc(I32 optype, U32 tmptype)
 496
 497 =for hackers
 498 Found in file pad.c
 499
 500 =item pad_block_start
 501
 502 Update the pad compilation state variables on entry to a new block
 503
 504         void    pad_block_start(int full)
 505
 506 =for hackers
 507 Found in file pad.c
 508
 509 =item pad_check_dup
 510
 511 Check for duplicate declarations: report any of:
 512      * a my in the current scope with the same name;
 513      * an our (anywhere in the pad) with the same name and the same stash
 514        as C<ourstash>
 515 C<is_our> indicates that the name to check is an 'our' declaration
 516
 517         void    pad_check_dup(char* name, bool is_our, HV* ourstash)
 518
 519 =for hackers
 520 Found in file pad.c
 521
 522 =item pad_findlex
 523
 524 Find a named lexical anywhere in a chain of nested pads. Add fake entries
 525 in the inner pads if it's found in an outer one. innercv is the CV *inside*
 526 the chain of outer CVs to be searched. If newoff is non-null, this is a
 527 run-time cloning: don't add fake entries, just find the lexical and add a
 528 ref to it at newoff in the current pad.
 529
 530         PADOFFSET       pad_findlex(char* name, PADOFFSET newoff, CV* innercv)
 531
 532 =for hackers
 533 Found in file pad.c
 534
 535 =item pad_findmy
 536
 537 Given a lexical name, try to find its offset, first in the current pad,
 538 or failing that, in the pads of any lexically enclosing subs (including
 539 the complications introduced by eval). If the name is found in an outer pad,
 540 then a fake entry is added to the current pad.
 541 Returns the offset in the current pad, or NOT_IN_PAD on failure.
 542
 543         PADOFFSET       pad_findmy(char* name)
 544
 545 =for hackers
 546 Found in file pad.c
 547
 548 =item pad_fixup_inner_anons
 549
 550 For any anon CVs in the pad, change CvOUTSIDE of that CV from
 551 old_cv to new_cv if necessary.
 552
 553         void    pad_fixup_inner_anons(PADLIST *padlist, CV *old_cv, CV *new_cv)
 554
 555 =for hackers
 556 Found in file pad.c
 557
 558 =item pad_free
 559
 560 Free the SV at offet po in the current pad.
 561
 562         void    pad_free(PADOFFSET po)
 563
 564 =for hackers
 565 Found in file pad.c
 566
 567 =item pad_leavemy
 568
 569 Cleanup at end of scope during compilation: set the max seq number for
 570 lexicals in this scope and warn of any lexicals that never got introduced.
 571
 572         void    pad_leavemy()
 573
 574 =for hackers
 575 Found in file pad.c
 576
 577 =item pad_new
 578
 579 Create a new compiling padlist, saving and updating the various global
 580 vars at the same time as creating the pad itself. The following flags
 581 can be OR'ed together:
 582
 583     padnew_CLONE        this pad is for a cloned CV
 584     padnew_SAVE         save old globals
 585     padnew_SAVESUB      also save extra stuff for start of sub
 586
 587         PADLIST*        pad_new(padnew_flags flags)
 588
 589 =for hackers
 590 Found in file pad.c
 591
 592 =item pad_push
 593
 594 Push a new pad frame onto the padlist, unless there's already a pad at
 595 this depth, in which case don't bother creating a new one.
 596 If has_args is true, give the new pad an @_ in slot zero.
 597
 598         void    pad_push(PADLIST *padlist, int depth, int has_args)
 599
 600 =for hackers
 601 Found in file pad.c
 602
 603 =item pad_reset
 604
 605 Mark all the current temporaries for reuse
 606
 607         void    pad_reset()
 608
 609 =for hackers
 610 Found in file pad.c
 611
 612 =item pad_setsv
 613
 614 Set the entry at offset po in the current pad to sv.
 615 Use the macro PAD_SETSV() rather than calling this function directly.
 616
 617         void    pad_setsv(PADOFFSET po, SV* sv)
 618
 619 =for hackers
 620 Found in file pad.c
 621
 622 =item pad_swipe
 623
 624 Abandon the tmp in the current pad at offset po and replace with a
 625 new one.
 626
 627         void    pad_swipe(PADOFFSET po, bool refadjust)
 628
 629 =for hackers
 630 Found in file pad.c
 631
 632 =item pad_tidy
 633
 634 Tidy up a pad after we've finished compiling it:
 635     * remove most stuff from the pads of anonsub prototypes;
 636     * give it a @_;
 637     * mark tmps as such.
 638
 639         void    pad_tidy(padtidy_type type)
 640
 641 =for hackers
 642 Found in file pad.c
 643
 644 =item pad_undef
 645
 646 Free the padlist associated with a CV.
 647 If parts of it happen to be current, we null the relevant
 648 PL_*pad* global vars so that we don't have any dangling references left.
 649 We also repoint the CvOUTSIDE of any about-to-be-orphaned
 650 inner subs to the outer of this cv.
 651
 652         void    pad_undef(CV* cv)
 653
 654 =for hackers
 655 Found in file pad.c
 656
 657
 658 =back
 659
 660 =head1 Stack Manipulation Macros
 661
 662 =over 8
 663
 664 =item djSP
 665
 666 Declare Just C<SP>. This is actually identical to C<dSP>, and declares
 667 a local copy of perl's stack pointer, available via the C<SP> macro.
 668 See C<SP>.  (Available for backward source code compatibility with the
 669 old (Perl 5.005) thread model.)
 670
 671                 djSP;
 672
 673 =for hackers
 674 Found in file pp.h
 675
 676 =item LVRET
 677
 678 True if this op will be the return value of an lvalue subroutine
 679
 680 =for hackers
 681 Found in file pp.h
 682
 683
 684 =back
 685
 686 =head1 SV Manipulation Functions
 687
 688 =over 8
 689
 690 =item report_uninit
 691
 692 Print appropriate "Use of uninitialized variable" warning
 693
 694         void    report_uninit()
 695
 696 =for hackers
 697 Found in file sv.c
 698
 699 =item sv_add_arena
 700
 701 Given a chunk of memory, link it to the head of the list of arenas,
 702 and split it into a list of free SVs.
 703
 704         void    sv_add_arena(char* ptr, U32 size, U32 flags)
 705
 706 =for hackers
 707 Found in file sv.c
 708
 709 =item sv_clean_all
 710
 711 Decrement the refcnt of each remaining SV, possibly triggering a
 712 cleanup. This function may have to be called multiple times to free
 713 SVs which are in complex self-referential hierarchies.
 714
 715         I32     sv_clean_all()
 716
 717 =for hackers
 718 Found in file sv.c
 719
 720 =item sv_clean_objs
 721
 722 Attempt to destroy all objects not yet freed
 723
 724         void    sv_clean_objs()
 725
 726 =for hackers
 727 Found in file sv.c
 728
 729 =item sv_free_arenas
 730
 731 Deallocate the memory used by all arenas. Note that all the individual SV
 732 heads and bodies within the arenas must already have been freed.
 733
 734         void    sv_free_arenas()
 735
 736 =for hackers
 737 Found in file sv.c
 738
 739
 740 =back
 741
 742 =head1 AUTHORS
 743
 744 The autodocumentation system was originally added to the Perl core by
 745 Benjamin Stuhl. Documentation is by whoever was kind enough to
 746 document their functions.
 747
 748 =head1 SEE ALSO
 749
 750 perlguts(1), perlapi(1)
 751