3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
28 /* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
32 #ifdef PERL_UTF8_CACHE_ASSERT
33 /* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
44 #define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
47 #define ASSERT_UTF8_CACHE(cache) NOOP
50 #ifdef PERL_COPY_ON_WRITE
51 #define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
52 #define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
53 /* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
57 /* ============================================================================
59 =head1 Allocation and deallocation of SVs.
61 An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62 av, hv...) contains type and reference count information, as well as a
63 pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64 specific to each type.
66 Normally, this allocation is done using arenas, which are approximately
67 1K chunks of memory parcelled up into N heads or bodies. The first slot
68 in each arena is reserved, and is used to hold a link to the next arena.
69 In the case of heads, the unused first slot also contains some flags and
70 a note of the number of slots. Snaked through each arena chain is a
71 linked list of free items; when this becomes empty, an extra arena is
72 allocated and divided up into N items which are threaded into the free
75 The following global variables are associated with arenas:
77 PL_sv_arenaroot pointer to list of SV arenas
78 PL_sv_root pointer to list of free SV structures
80 PL_foo_arenaroot pointer to list of foo arenas,
81 PL_foo_root pointer to list of free foo bodies
82 ... for foo in xiv, xnv, xrv, xpv etc.
84 Note that some of the larger and more rarely used body types (eg xpvio)
85 are not allocated using arenas, but are instead just malloc()/free()ed as
86 required. Also, if PURIFY is defined, arenas are abandoned altogether,
87 with all items individually malloc()ed. In addition, a few SV heads are
88 not allocated from an arena, but are instead directly created as static
89 or auto variables, eg PL_sv_undef.
91 The SV arena serves the secondary purpose of allowing still-live SVs
92 to be located and destroyed during final cleanup.
94 At the lowest level, the macros new_SV() and del_SV() grab and free
95 an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
96 to return the SV to the free list with error checking.) new_SV() calls
97 more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
98 SVs in the free list have their SvTYPE field set to all ones.
100 Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
101 that allocate and return individual body types. Normally these are mapped
102 to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
103 instead mapped directly to malloc()/free() if PURIFY is defined. The
104 new/del functions remove from, or add to, the appropriate PL_foo_root
105 list, and call more_xiv() etc to add a new arena if the list is empty.
107 At the time of very final cleanup, sv_free_arenas() is called from
108 perl_destruct() to physically free all the arenas allocated since the
109 start of the interpreter. Note that this also clears PL_he_arenaroot,
110 which is otherwise dealt with in hv.c.
112 Manipulation of any of the PL_*root pointers is protected by enclosing
113 LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
114 if threads are enabled.
116 The function visit() scans the SV arenas list, and calls a specified
117 function for each SV it finds which is still live - ie which has an SvTYPE
118 other than all 1's, and a non-zero SvREFCNT. visit() is used by the
119 following functions (specified as [function that calls visit()] / [function
120 called by visit() for each SV]):
122 sv_report_used() / do_report_used()
123 dump all remaining SVs (debugging aid)
125 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
126 Attempt to free all objects pointed to by RVs,
127 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
128 try to do the same for all objects indirectly
129 referenced by typeglobs too. Called once from
130 perl_destruct(), prior to calling sv_clean_all()
133 sv_clean_all() / do_clean_all()
134 SvREFCNT_dec(sv) each remaining SV, possibly
135 triggering an sv_free(). It also sets the
136 SVf_BREAK flag on the SV to indicate that the
137 refcnt has been artificially lowered, and thus
138 stopping sv_free() from giving spurious warnings
139 about SVs which unexpectedly have a refcnt
140 of zero. called repeatedly from perl_destruct()
141 until there are no SVs left.
145 Private API to rest of sv.c
149 new_XIV(), del_XIV(),
150 new_XNV(), del_XNV(),
155 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
160 ============================================================================ */
165 * "A time to plant, and a time to uproot what was planted..."
168 #ifdef DEBUG_LEAKING_SCALARS
170 # define FREE_SV_DEBUG_FILE(sv) PerlMemfree((sv)->sv_debug_file)
172 # define FREE_SV_DEBUG_FILE(sv) PerlMemShared_free((sv)->sv_debug_file)
175 # define FREE_SV_DEBUG_FILE(sv)
178 #define plant_SV(p) \
180 FREE_SV_DEBUG_FILE(p); \
181 SvANY(p) = (void *)PL_sv_root; \
182 SvFLAGS(p) = SVTYPEMASK; \
187 /* sv_mutex must be held while calling uproot_SV() */
188 #define uproot_SV(p) \
191 PL_sv_root = (SV*)SvANY(p); \
196 /* new_SV(): return a new, empty SV head */
198 #ifdef DEBUG_LEAKING_SCALARS
199 /* provide a real function for a debugger to play with */
214 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
215 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
216 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
217 sv->sv_debug_inpad = 0;
218 sv->sv_debug_cloned = 0;
220 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
222 sv->sv_debug_file = PL_curcop ? savesharedpv(CopFILE(PL_curcop)): NULL;
227 # define new_SV(p) (p)=S_new_SV(aTHX)
245 /* del_SV(): return an empty SV head to the free list */
260 S_del_sv(pTHX_ SV *p)
267 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
269 svend = &sva[SvREFCNT(sva)];
270 if (p >= sv && p < svend)
274 if (ckWARN_d(WARN_INTERNAL))
275 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
276 "Attempt to free non-arena SV: 0x%"UVxf
277 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
284 #else /* ! DEBUGGING */
286 #define del_SV(p) plant_SV(p)
288 #endif /* DEBUGGING */
292 =head1 SV Manipulation Functions
294 =for apidoc sv_add_arena
296 Given a chunk of memory, link it to the head of the list of arenas,
297 and split it into a list of free SVs.
303 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
309 /* The first SV in an arena isn't an SV. */
310 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
311 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
312 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
314 PL_sv_arenaroot = sva;
315 PL_sv_root = sva + 1;
317 svend = &sva[SvREFCNT(sva) - 1];
320 SvANY(sv) = (void *)(SV*)(sv + 1);
322 SvFLAGS(sv) = SVTYPEMASK;
326 SvFLAGS(sv) = SVTYPEMASK;
329 /* make some more SVs by adding another arena */
331 /* sv_mutex must be held while calling more_sv() */
338 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
339 PL_nice_chunk = Nullch;
340 PL_nice_chunk_size = 0;
343 char *chunk; /* must use New here to match call to */
344 New(704,chunk,1008,char); /* Safefree() in sv_free_arenas() */
345 sv_add_arena(chunk, 1008, 0);
351 /* visit(): call the named function for each non-free SV in the arenas
352 * whose flags field matches the flags/mask args. */
355 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
362 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
363 svend = &sva[SvREFCNT(sva)];
364 for (sv = sva + 1; sv < svend; ++sv) {
365 if (SvTYPE(sv) != SVTYPEMASK
366 && (sv->sv_flags & mask) == flags
379 /* called by sv_report_used() for each live SV */
382 do_report_used(pTHX_ SV *sv)
384 if (SvTYPE(sv) != SVTYPEMASK) {
385 PerlIO_printf(Perl_debug_log, "****\n");
392 =for apidoc sv_report_used
394 Dump the contents of all SVs not yet freed. (Debugging aid).
400 Perl_sv_report_used(pTHX)
403 visit(do_report_used, 0, 0);
407 /* called by sv_clean_objs() for each live SV */
410 do_clean_objs(pTHX_ SV *sv)
414 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
415 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
427 /* XXX Might want to check arrays, etc. */
430 /* called by sv_clean_objs() for each live SV */
432 #ifndef DISABLE_DESTRUCTOR_KLUDGE
434 do_clean_named_objs(pTHX_ SV *sv)
436 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
437 if ( SvOBJECT(GvSV(sv)) ||
438 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
439 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
440 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
441 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
443 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
444 SvFLAGS(sv) |= SVf_BREAK;
452 =for apidoc sv_clean_objs
454 Attempt to destroy all objects not yet freed
460 Perl_sv_clean_objs(pTHX)
462 PL_in_clean_objs = TRUE;
463 visit(do_clean_objs, SVf_ROK, SVf_ROK);
464 #ifndef DISABLE_DESTRUCTOR_KLUDGE
465 /* some barnacles may yet remain, clinging to typeglobs */
466 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
468 PL_in_clean_objs = FALSE;
471 /* called by sv_clean_all() for each live SV */
474 do_clean_all(pTHX_ SV *sv)
476 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
477 SvFLAGS(sv) |= SVf_BREAK;
478 if (PL_comppad == (AV*)sv) {
480 PL_curpad = Null(SV**);
486 =for apidoc sv_clean_all
488 Decrement the refcnt of each remaining SV, possibly triggering a
489 cleanup. This function may have to be called multiple times to free
490 SVs which are in complex self-referential hierarchies.
496 Perl_sv_clean_all(pTHX)
499 PL_in_clean_all = TRUE;
500 cleaned = visit(do_clean_all, 0,0);
501 PL_in_clean_all = FALSE;
506 =for apidoc sv_free_arenas
508 Deallocate the memory used by all arenas. Note that all the individual SV
509 heads and bodies within the arenas must already have been freed.
515 Perl_sv_free_arenas(pTHX)
519 XPV *arena, *arenanext;
521 /* Free arenas here, but be careful about fake ones. (We assume
522 contiguity of the fake ones with the corresponding real ones.) */
524 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
525 svanext = (SV*) SvANY(sva);
526 while (svanext && SvFAKE(svanext))
527 svanext = (SV*) SvANY(svanext);
530 Safefree((void *)sva);
533 for (arena = PL_xiv_arenaroot; arena; arena = arenanext) {
534 arenanext = (XPV*)arena->xpv_pv;
537 PL_xiv_arenaroot = 0;
540 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
541 arenanext = (XPV*)arena->xpv_pv;
544 PL_xnv_arenaroot = 0;
547 for (arena = PL_xrv_arenaroot; arena; arena = arenanext) {
548 arenanext = (XPV*)arena->xpv_pv;
551 PL_xrv_arenaroot = 0;
554 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
555 arenanext = (XPV*)arena->xpv_pv;
558 PL_xpv_arenaroot = 0;
561 for (arena = (XPV*)PL_xpviv_arenaroot; arena; arena = arenanext) {
562 arenanext = (XPV*)arena->xpv_pv;
565 PL_xpviv_arenaroot = 0;
568 for (arena = (XPV*)PL_xpvnv_arenaroot; arena; arena = arenanext) {
569 arenanext = (XPV*)arena->xpv_pv;
572 PL_xpvnv_arenaroot = 0;
575 for (arena = (XPV*)PL_xpvcv_arenaroot; arena; arena = arenanext) {
576 arenanext = (XPV*)arena->xpv_pv;
579 PL_xpvcv_arenaroot = 0;
582 for (arena = (XPV*)PL_xpvav_arenaroot; arena; arena = arenanext) {
583 arenanext = (XPV*)arena->xpv_pv;
586 PL_xpvav_arenaroot = 0;
589 for (arena = (XPV*)PL_xpvhv_arenaroot; arena; arena = arenanext) {
590 arenanext = (XPV*)arena->xpv_pv;
593 PL_xpvhv_arenaroot = 0;
596 for (arena = (XPV*)PL_xpvmg_arenaroot; arena; arena = arenanext) {
597 arenanext = (XPV*)arena->xpv_pv;
600 PL_xpvmg_arenaroot = 0;
603 for (arena = (XPV*)PL_xpvlv_arenaroot; arena; arena = arenanext) {
604 arenanext = (XPV*)arena->xpv_pv;
607 PL_xpvlv_arenaroot = 0;
610 for (arena = (XPV*)PL_xpvbm_arenaroot; arena; arena = arenanext) {
611 arenanext = (XPV*)arena->xpv_pv;
614 PL_xpvbm_arenaroot = 0;
617 for (arena = (XPV*)PL_he_arenaroot; arena; arena = arenanext) {
618 arenanext = (XPV*)arena->xpv_pv;
625 Safefree(PL_nice_chunk);
626 PL_nice_chunk = Nullch;
627 PL_nice_chunk_size = 0;
632 /* ---------------------------------------------------------------------
634 * support functions for report_uninit()
637 /* the maxiumum size of array or hash where we will scan looking
638 * for the undefined element that triggered the warning */
640 #define FUV_MAX_SEARCH_SIZE 1000
642 /* Look for an entry in the hash whose value has the same SV as val;
643 * If so, return a mortal copy of the key. */
646 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
653 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
654 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
659 for (i=HvMAX(hv); i>0; i--) {
660 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
661 if (HeVAL(entry) != val)
663 if ( HeVAL(entry) == &PL_sv_undef ||
664 HeVAL(entry) == &PL_sv_placeholder)
668 if (HeKLEN(entry) == HEf_SVKEY)
669 return sv_mortalcopy(HeKEY_sv(entry));
670 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
676 /* Look for an entry in the array whose value has the same SV as val;
677 * If so, return the index, otherwise return -1. */
680 S_find_array_subscript(pTHX_ AV *av, SV* val)
684 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
685 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
689 for (i=AvFILLp(av); i>=0; i--) {
690 if (svp[i] == val && svp[i] != &PL_sv_undef)
696 /* S_varname(): return the name of a variable, optionally with a subscript.
697 * If gv is non-zero, use the name of that global, along with gvtype (one
698 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
699 * targ. Depending on the value of the subscript_type flag, return:
702 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
703 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
704 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
705 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
708 S_varname(pTHX_ GV *gv, const char *gvtype, PADOFFSET targ,
709 SV* keyname, I32 aindex, int subscript_type)
715 name = sv_newmortal();
718 /* simulate gv_fullname4(), but add literal '^' for $^FOO names
719 * XXX get rid of all this if gv_fullnameX() ever supports this
723 HV *hv = GvSTASH(gv);
724 sv_setpv(name, gvtype);
727 else if (!(p=HvNAME(hv)))
729 if (strNE(p, "main")) {
731 sv_catpvn(name,"::", 2);
733 if (GvNAMELEN(gv)>= 1 &&
734 ((unsigned int)*GvNAME(gv)) <= 26)
736 Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
737 sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
740 sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
744 CV *cv = find_runcv(&u);
745 if (!cv || !CvPADLIST(cv))
747 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
748 sv = *av_fetch(av, targ, FALSE);
749 /* SvLEN in a pad name is not to be trusted */
750 sv_setpv(name, SvPV_nolen(sv));
753 if (subscript_type == FUV_SUBSCRIPT_HASH) {
756 Perl_sv_catpvf(aTHX_ name, "{%s}",
757 pv_display(sv,SvPVX(keyname), SvCUR(keyname), 0, 32));
760 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
762 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
764 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
765 sv_insert(name, 0, 0, "within ", 7);
772 =for apidoc find_uninit_var
774 Find the name of the undefined variable (if any) that caused the operator o
775 to issue a "Use of uninitialized value" warning.
776 If match is true, only return a name if it's value matches uninit_sv.
777 So roughly speaking, if a unary operator (such as OP_COS) generates a
778 warning, then following the direct child of the op may yield an
779 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
780 other hand, with OP_ADD there are two branches to follow, so we only print
781 the variable name if we get an exact match.
783 The name is returned as a mortal SV.
785 Assumes that PL_op is the op that originally triggered the error, and that
786 PL_comppad/PL_curpad points to the currently executing pad.
792 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
801 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
802 uninit_sv == &PL_sv_placeholder)))
805 switch (obase->op_type) {
812 bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
813 bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
816 int subscript_type = FUV_SUBSCRIPT_WITHIN;
818 if (pad) { /* @lex, %lex */
819 sv = PAD_SVl(obase->op_targ);
823 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
824 /* @global, %global */
825 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
828 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
830 else /* @{expr}, %{expr} */
831 return find_uninit_var(cUNOPx(obase)->op_first,
835 /* attempt to find a match within the aggregate */
837 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
839 subscript_type = FUV_SUBSCRIPT_HASH;
842 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
844 subscript_type = FUV_SUBSCRIPT_ARRAY;
847 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
850 return S_varname(aTHX_ gv, hash ? "%" : "@", obase->op_targ,
851 keysv, index, subscript_type);
855 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
857 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
858 Nullsv, 0, FUV_SUBSCRIPT_NONE);
861 gv = cGVOPx_gv(obase);
862 if (!gv || (match && GvSV(gv) != uninit_sv))
864 return S_varname(aTHX_ gv, "$", 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
867 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
869 av = (AV*)PAD_SV(obase->op_targ);
870 if (!av || SvRMAGICAL(av))
872 svp = av_fetch(av, (I32)obase->op_private, FALSE);
873 if (!svp || *svp != uninit_sv)
876 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
877 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
880 gv = cGVOPx_gv(obase);
885 if (!av || SvRMAGICAL(av))
887 svp = av_fetch(av, (I32)obase->op_private, FALSE);
888 if (!svp || *svp != uninit_sv)
891 return S_varname(aTHX_ gv, "$", 0,
892 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
897 o = cUNOPx(obase)->op_first;
898 if (!o || o->op_type != OP_NULL ||
899 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
901 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
906 /* $a[uninit_expr] or $h{uninit_expr} */
907 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
910 o = cBINOPx(obase)->op_first;
911 kid = cBINOPx(obase)->op_last;
913 /* get the av or hv, and optionally the gv */
915 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
916 sv = PAD_SV(o->op_targ);
918 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
919 && cUNOPo->op_first->op_type == OP_GV)
921 gv = cGVOPx_gv(cUNOPo->op_first);
924 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
929 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
930 /* index is constant */
934 if (obase->op_type == OP_HELEM) {
935 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
936 if (!he || HeVAL(he) != uninit_sv)
940 svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
941 if (!svp || *svp != uninit_sv)
945 if (obase->op_type == OP_HELEM)
946 return S_varname(aTHX_ gv, "%", o->op_targ,
947 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
949 return S_varname(aTHX_ gv, "@", o->op_targ, Nullsv,
950 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
954 /* index is an expression;
955 * attempt to find a match within the aggregate */
956 if (obase->op_type == OP_HELEM) {
957 SV *keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
959 return S_varname(aTHX_ gv, "%", o->op_targ,
960 keysv, 0, FUV_SUBSCRIPT_HASH);
963 I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
965 return S_varname(aTHX_ gv, "@", o->op_targ,
966 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
970 return S_varname(aTHX_ gv,
971 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
973 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
979 /* only examine RHS */
980 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
983 o = cUNOPx(obase)->op_first;
984 if (o->op_type == OP_PUSHMARK)
987 if (!o->op_sibling) {
988 /* one-arg version of open is highly magical */
990 if (o->op_type == OP_GV) { /* open FOO; */
992 if (match && GvSV(gv) != uninit_sv)
994 return S_varname(aTHX_ gv, "$", 0,
995 Nullsv, 0, FUV_SUBSCRIPT_NONE);
997 /* other possibilities not handled are:
998 * open $x; or open my $x; should return '${*$x}'
999 * open expr; should return '$'.expr ideally
1005 /* ops where $_ may be an implicit arg */
1009 if ( !(obase->op_flags & OPf_STACKED)) {
1010 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
1011 ? PAD_SVl(obase->op_targ)
1014 sv = sv_newmortal();
1023 /* skip filehandle as it can't produce 'undef' warning */
1024 o = cUNOPx(obase)->op_first;
1025 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
1026 o = o->op_sibling->op_sibling;
1033 match = 1; /* XS or custom code could trigger random warnings */
1038 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
1039 return sv_2mortal(newSVpv("${$/}", 0));
1044 if (!(obase->op_flags & OPf_KIDS))
1046 o = cUNOPx(obase)->op_first;
1052 /* if all except one arg are constant, or have no side-effects,
1053 * or are optimized away, then it's unambiguous */
1055 for (kid=o; kid; kid = kid->op_sibling) {
1057 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1058 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1059 || (kid->op_type == OP_PUSHMARK)
1063 if (o2) { /* more than one found */
1070 return find_uninit_var(o2, uninit_sv, match);
1074 sv = find_uninit_var(o, uninit_sv, 1);
1086 =for apidoc report_uninit
1088 Print appropriate "Use of uninitialized variable" warning
1094 Perl_report_uninit(pTHX_ SV* uninit_sv)
1097 SV* varname = Nullsv;
1099 varname = find_uninit_var(PL_op, uninit_sv,0);
1101 sv_insert(varname, 0, 0, " ", 1);
1103 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1104 varname ? SvPV_nolen(varname) : "",
1105 " in ", OP_DESC(PL_op));
1108 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1112 /* grab a new IV body from the free list, allocating more if necessary */
1123 * See comment in more_xiv() -- RAM.
1125 PL_xiv_root = *(IV**)xiv;
1127 return (XPVIV*)((char*)xiv - STRUCT_OFFSET(XPVIV, xiv_iv));
1130 /* return an IV body to the free list */
1133 S_del_xiv(pTHX_ XPVIV *p)
1135 IV* xiv = (IV*)((char*)(p) + STRUCT_OFFSET(XPVIV, xiv_iv));
1137 *(IV**)xiv = PL_xiv_root;
1142 /* allocate another arena's worth of IV bodies */
1148 register IV* xivend;
1150 New(705, ptr, 1008/sizeof(XPV), XPV);
1151 ptr->xpv_pv = (char*)PL_xiv_arenaroot; /* linked list of xiv arenas */
1152 PL_xiv_arenaroot = ptr; /* to keep Purify happy */
1155 xivend = &xiv[1008 / sizeof(IV) - 1];
1156 xiv += (sizeof(XPV) - 1) / sizeof(IV) + 1; /* fudge by size of XPV */
1158 while (xiv < xivend) {
1159 *(IV**)xiv = (IV *)(xiv + 1);
1165 /* grab a new NV body from the free list, allocating more if necessary */
1175 PL_xnv_root = *(NV**)xnv;
1177 return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
1180 /* return an NV body to the free list */
1183 S_del_xnv(pTHX_ XPVNV *p)
1185 NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
1187 *(NV**)xnv = PL_xnv_root;
1192 /* allocate another arena's worth of NV bodies */
1198 register NV* xnvend;
1200 New(711, ptr, 1008/sizeof(XPV), XPV);
1201 ptr->xpv_pv = (char*)PL_xnv_arenaroot;
1202 PL_xnv_arenaroot = ptr;
1205 xnvend = &xnv[1008 / sizeof(NV) - 1];
1206 xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
1208 while (xnv < xnvend) {
1209 *(NV**)xnv = (NV*)(xnv + 1);
1215 /* grab a new struct xrv from the free list, allocating more if necessary */
1225 PL_xrv_root = (XRV*)xrv->xrv_rv;
1230 /* return a struct xrv to the free list */
1233 S_del_xrv(pTHX_ XRV *p)
1236 p->xrv_rv = (SV*)PL_xrv_root;
1241 /* allocate another arena's worth of struct xrv */
1247 register XRV* xrvend;
1249 New(712, ptr, 1008/sizeof(XPV), XPV);
1250 ptr->xpv_pv = (char*)PL_xrv_arenaroot;
1251 PL_xrv_arenaroot = ptr;
1254 xrvend = &xrv[1008 / sizeof(XRV) - 1];
1255 xrv += (sizeof(XPV) - 1) / sizeof(XRV) + 1;
1257 while (xrv < xrvend) {
1258 xrv->xrv_rv = (SV*)(xrv + 1);
1264 /* grab a new struct xpv from the free list, allocating more if necessary */
1274 PL_xpv_root = (XPV*)xpv->xpv_pv;
1279 /* return a struct xpv to the free list */
1282 S_del_xpv(pTHX_ XPV *p)
1285 p->xpv_pv = (char*)PL_xpv_root;
1290 /* allocate another arena's worth of struct xpv */
1296 register XPV* xpvend;
1297 New(713, xpv, 1008/sizeof(XPV), XPV);
1298 xpv->xpv_pv = (char*)PL_xpv_arenaroot;
1299 PL_xpv_arenaroot = xpv;
1301 xpvend = &xpv[1008 / sizeof(XPV) - 1];
1302 PL_xpv_root = ++xpv;
1303 while (xpv < xpvend) {
1304 xpv->xpv_pv = (char*)(xpv + 1);
1310 /* grab a new struct xpviv from the free list, allocating more if necessary */
1319 xpviv = PL_xpviv_root;
1320 PL_xpviv_root = (XPVIV*)xpviv->xpv_pv;
1325 /* return a struct xpviv to the free list */
1328 S_del_xpviv(pTHX_ XPVIV *p)
1331 p->xpv_pv = (char*)PL_xpviv_root;
1336 /* allocate another arena's worth of struct xpviv */
1341 register XPVIV* xpviv;
1342 register XPVIV* xpvivend;
1343 New(714, xpviv, 1008/sizeof(XPVIV), XPVIV);
1344 xpviv->xpv_pv = (char*)PL_xpviv_arenaroot;
1345 PL_xpviv_arenaroot = xpviv;
1347 xpvivend = &xpviv[1008 / sizeof(XPVIV) - 1];
1348 PL_xpviv_root = ++xpviv;
1349 while (xpviv < xpvivend) {
1350 xpviv->xpv_pv = (char*)(xpviv + 1);
1356 /* grab a new struct xpvnv from the free list, allocating more if necessary */
1365 xpvnv = PL_xpvnv_root;
1366 PL_xpvnv_root = (XPVNV*)xpvnv->xpv_pv;
1371 /* return a struct xpvnv to the free list */
1374 S_del_xpvnv(pTHX_ XPVNV *p)
1377 p->xpv_pv = (char*)PL_xpvnv_root;
1382 /* allocate another arena's worth of struct xpvnv */
1387 register XPVNV* xpvnv;
1388 register XPVNV* xpvnvend;
1389 New(715, xpvnv, 1008/sizeof(XPVNV), XPVNV);
1390 xpvnv->xpv_pv = (char*)PL_xpvnv_arenaroot;
1391 PL_xpvnv_arenaroot = xpvnv;
1393 xpvnvend = &xpvnv[1008 / sizeof(XPVNV) - 1];
1394 PL_xpvnv_root = ++xpvnv;
1395 while (xpvnv < xpvnvend) {
1396 xpvnv->xpv_pv = (char*)(xpvnv + 1);
1402 /* grab a new struct xpvcv from the free list, allocating more if necessary */
1411 xpvcv = PL_xpvcv_root;
1412 PL_xpvcv_root = (XPVCV*)xpvcv->xpv_pv;
1417 /* return a struct xpvcv to the free list */
1420 S_del_xpvcv(pTHX_ XPVCV *p)
1423 p->xpv_pv = (char*)PL_xpvcv_root;
1428 /* allocate another arena's worth of struct xpvcv */
1433 register XPVCV* xpvcv;
1434 register XPVCV* xpvcvend;
1435 New(716, xpvcv, 1008/sizeof(XPVCV), XPVCV);
1436 xpvcv->xpv_pv = (char*)PL_xpvcv_arenaroot;
1437 PL_xpvcv_arenaroot = xpvcv;
1439 xpvcvend = &xpvcv[1008 / sizeof(XPVCV) - 1];
1440 PL_xpvcv_root = ++xpvcv;
1441 while (xpvcv < xpvcvend) {
1442 xpvcv->xpv_pv = (char*)(xpvcv + 1);
1448 /* grab a new struct xpvav from the free list, allocating more if necessary */
1457 xpvav = PL_xpvav_root;
1458 PL_xpvav_root = (XPVAV*)xpvav->xav_array;
1463 /* return a struct xpvav to the free list */
1466 S_del_xpvav(pTHX_ XPVAV *p)
1469 p->xav_array = (char*)PL_xpvav_root;
1474 /* allocate another arena's worth of struct xpvav */
1479 register XPVAV* xpvav;
1480 register XPVAV* xpvavend;
1481 New(717, xpvav, 1008/sizeof(XPVAV), XPVAV);
1482 xpvav->xav_array = (char*)PL_xpvav_arenaroot;
1483 PL_xpvav_arenaroot = xpvav;
1485 xpvavend = &xpvav[1008 / sizeof(XPVAV) - 1];
1486 PL_xpvav_root = ++xpvav;
1487 while (xpvav < xpvavend) {
1488 xpvav->xav_array = (char*)(xpvav + 1);
1491 xpvav->xav_array = 0;
1494 /* grab a new struct xpvhv from the free list, allocating more if necessary */
1503 xpvhv = PL_xpvhv_root;
1504 PL_xpvhv_root = (XPVHV*)xpvhv->xhv_array;
1509 /* return a struct xpvhv to the free list */
1512 S_del_xpvhv(pTHX_ XPVHV *p)
1515 p->xhv_array = (char*)PL_xpvhv_root;
1520 /* allocate another arena's worth of struct xpvhv */
1525 register XPVHV* xpvhv;
1526 register XPVHV* xpvhvend;
1527 New(718, xpvhv, 1008/sizeof(XPVHV), XPVHV);
1528 xpvhv->xhv_array = (char*)PL_xpvhv_arenaroot;
1529 PL_xpvhv_arenaroot = xpvhv;
1531 xpvhvend = &xpvhv[1008 / sizeof(XPVHV) - 1];
1532 PL_xpvhv_root = ++xpvhv;
1533 while (xpvhv < xpvhvend) {
1534 xpvhv->xhv_array = (char*)(xpvhv + 1);
1537 xpvhv->xhv_array = 0;
1540 /* grab a new struct xpvmg from the free list, allocating more if necessary */
1549 xpvmg = PL_xpvmg_root;
1550 PL_xpvmg_root = (XPVMG*)xpvmg->xpv_pv;
1555 /* return a struct xpvmg to the free list */
1558 S_del_xpvmg(pTHX_ XPVMG *p)
1561 p->xpv_pv = (char*)PL_xpvmg_root;
1566 /* allocate another arena's worth of struct xpvmg */
1571 register XPVMG* xpvmg;
1572 register XPVMG* xpvmgend;
1573 New(719, xpvmg, 1008/sizeof(XPVMG), XPVMG);
1574 xpvmg->xpv_pv = (char*)PL_xpvmg_arenaroot;
1575 PL_xpvmg_arenaroot = xpvmg;
1577 xpvmgend = &xpvmg[1008 / sizeof(XPVMG) - 1];
1578 PL_xpvmg_root = ++xpvmg;
1579 while (xpvmg < xpvmgend) {
1580 xpvmg->xpv_pv = (char*)(xpvmg + 1);
1586 /* grab a new struct xpvlv from the free list, allocating more if necessary */
1595 xpvlv = PL_xpvlv_root;
1596 PL_xpvlv_root = (XPVLV*)xpvlv->xpv_pv;
1601 /* return a struct xpvlv to the free list */
1604 S_del_xpvlv(pTHX_ XPVLV *p)
1607 p->xpv_pv = (char*)PL_xpvlv_root;
1612 /* allocate another arena's worth of struct xpvlv */
1617 register XPVLV* xpvlv;
1618 register XPVLV* xpvlvend;
1619 New(720, xpvlv, 1008/sizeof(XPVLV), XPVLV);
1620 xpvlv->xpv_pv = (char*)PL_xpvlv_arenaroot;
1621 PL_xpvlv_arenaroot = xpvlv;
1623 xpvlvend = &xpvlv[1008 / sizeof(XPVLV) - 1];
1624 PL_xpvlv_root = ++xpvlv;
1625 while (xpvlv < xpvlvend) {
1626 xpvlv->xpv_pv = (char*)(xpvlv + 1);
1632 /* grab a new struct xpvbm from the free list, allocating more if necessary */
1641 xpvbm = PL_xpvbm_root;
1642 PL_xpvbm_root = (XPVBM*)xpvbm->xpv_pv;
1647 /* return a struct xpvbm to the free list */
1650 S_del_xpvbm(pTHX_ XPVBM *p)
1653 p->xpv_pv = (char*)PL_xpvbm_root;
1658 /* allocate another arena's worth of struct xpvbm */
1663 register XPVBM* xpvbm;
1664 register XPVBM* xpvbmend;
1665 New(721, xpvbm, 1008/sizeof(XPVBM), XPVBM);
1666 xpvbm->xpv_pv = (char*)PL_xpvbm_arenaroot;
1667 PL_xpvbm_arenaroot = xpvbm;
1669 xpvbmend = &xpvbm[1008 / sizeof(XPVBM) - 1];
1670 PL_xpvbm_root = ++xpvbm;
1671 while (xpvbm < xpvbmend) {
1672 xpvbm->xpv_pv = (char*)(xpvbm + 1);
1678 #define my_safemalloc(s) (void*)safemalloc(s)
1679 #define my_safefree(p) safefree((char*)p)
1683 #define new_XIV() my_safemalloc(sizeof(XPVIV))
1684 #define del_XIV(p) my_safefree(p)
1686 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1687 #define del_XNV(p) my_safefree(p)
1689 #define new_XRV() my_safemalloc(sizeof(XRV))
1690 #define del_XRV(p) my_safefree(p)
1692 #define new_XPV() my_safemalloc(sizeof(XPV))
1693 #define del_XPV(p) my_safefree(p)
1695 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1696 #define del_XPVIV(p) my_safefree(p)
1698 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1699 #define del_XPVNV(p) my_safefree(p)
1701 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1702 #define del_XPVCV(p) my_safefree(p)
1704 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1705 #define del_XPVAV(p) my_safefree(p)
1707 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1708 #define del_XPVHV(p) my_safefree(p)
1710 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1711 #define del_XPVMG(p) my_safefree(p)
1713 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1714 #define del_XPVLV(p) my_safefree(p)
1716 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1717 #define del_XPVBM(p) my_safefree(p)
1721 #define new_XIV() (void*)new_xiv()
1722 #define del_XIV(p) del_xiv((XPVIV*) p)
1724 #define new_XNV() (void*)new_xnv()
1725 #define del_XNV(p) del_xnv((XPVNV*) p)
1727 #define new_XRV() (void*)new_xrv()
1728 #define del_XRV(p) del_xrv((XRV*) p)
1730 #define new_XPV() (void*)new_xpv()
1731 #define del_XPV(p) del_xpv((XPV *)p)
1733 #define new_XPVIV() (void*)new_xpviv()
1734 #define del_XPVIV(p) del_xpviv((XPVIV *)p)
1736 #define new_XPVNV() (void*)new_xpvnv()
1737 #define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1739 #define new_XPVCV() (void*)new_xpvcv()
1740 #define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1742 #define new_XPVAV() (void*)new_xpvav()
1743 #define del_XPVAV(p) del_xpvav((XPVAV *)p)
1745 #define new_XPVHV() (void*)new_xpvhv()
1746 #define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1748 #define new_XPVMG() (void*)new_xpvmg()
1749 #define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1751 #define new_XPVLV() (void*)new_xpvlv()
1752 #define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1754 #define new_XPVBM() (void*)new_xpvbm()
1755 #define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1759 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1760 #define del_XPVGV(p) my_safefree(p)
1762 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1763 #define del_XPVFM(p) my_safefree(p)
1765 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1766 #define del_XPVIO(p) my_safefree(p)
1769 =for apidoc sv_upgrade
1771 Upgrade an SV to a more complex form. Generally adds a new body type to the
1772 SV, then copies across as much information as possible from the old body.
1773 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1779 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1790 if (mt != SVt_PV && SvIsCOW(sv)) {
1791 sv_force_normal_flags(sv, 0);
1794 if (SvTYPE(sv) == mt)
1798 (void)SvOOK_off(sv);
1808 switch (SvTYPE(sv)) {
1816 else if (mt < SVt_PVIV)
1826 pv = (char*)SvRV(sv);
1836 else if (mt == SVt_NV)
1844 del_XPVIV(SvANY(sv));
1852 del_XPVNV(SvANY(sv));
1860 magic = SvMAGIC(sv);
1861 stash = SvSTASH(sv);
1862 del_XPVMG(SvANY(sv));
1865 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1868 SvFLAGS(sv) &= ~SVTYPEMASK;
1873 Perl_croak(aTHX_ "Can't upgrade to undef");
1875 SvANY(sv) = new_XIV();
1879 SvANY(sv) = new_XNV();
1883 SvANY(sv) = new_XRV();
1884 SvRV_set(sv, (SV*)pv);
1887 SvANY(sv) = new_XPVHV();
1894 HvTOTALKEYS(sv) = 0;
1895 HvPLACEHOLDERS(sv) = 0;
1897 /* Fall through... */
1900 SvANY(sv) = new_XPVAV();
1905 AvFLAGS(sv) = AVf_REAL;
1912 SvPV_set(sv, (char*)0);
1913 SvMAGIC_set(sv, magic);
1914 SvSTASH_set(sv, stash);
1918 SvANY(sv) = new_XPVIO();
1919 Zero(SvANY(sv), 1, XPVIO);
1920 IoPAGE_LEN(sv) = 60;
1921 goto set_magic_common;
1923 SvANY(sv) = new_XPVFM();
1924 Zero(SvANY(sv), 1, XPVFM);
1925 goto set_magic_common;
1927 SvANY(sv) = new_XPVBM();
1931 goto set_magic_common;
1933 SvANY(sv) = new_XPVGV();
1939 goto set_magic_common;
1941 SvANY(sv) = new_XPVCV();
1942 Zero(SvANY(sv), 1, XPVCV);
1943 goto set_magic_common;
1945 SvANY(sv) = new_XPVLV();
1958 SvANY(sv) = new_XPVMG();
1961 SvMAGIC_set(sv, magic);
1962 SvSTASH_set(sv, stash);
1966 SvANY(sv) = new_XPVNV();
1972 SvANY(sv) = new_XPVIV();
1981 SvANY(sv) = new_XPV();
1992 =for apidoc sv_backoff
1994 Remove any string offset. You should normally use the C<SvOOK_off> macro
2001 Perl_sv_backoff(pTHX_ register SV *sv)
2005 char *s = SvPVX(sv);
2006 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
2007 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
2009 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
2011 SvFLAGS(sv) &= ~SVf_OOK;
2018 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
2019 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2020 Use the C<SvGROW> wrapper instead.
2026 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
2030 #ifdef HAS_64K_LIMIT
2031 if (newlen >= 0x10000) {
2032 PerlIO_printf(Perl_debug_log,
2033 "Allocation too large: %"UVxf"\n", (UV)newlen);
2036 #endif /* HAS_64K_LIMIT */
2039 if (SvTYPE(sv) < SVt_PV) {
2040 sv_upgrade(sv, SVt_PV);
2043 else if (SvOOK(sv)) { /* pv is offset? */
2046 if (newlen > SvLEN(sv))
2047 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
2048 #ifdef HAS_64K_LIMIT
2049 if (newlen >= 0x10000)
2056 if (newlen > SvLEN(sv)) { /* need more room? */
2057 if (SvLEN(sv) && s) {
2059 STRLEN l = malloced_size((void*)SvPVX(sv));
2065 Renew(s,newlen,char);
2068 New(703, s, newlen, char);
2069 if (SvPVX(sv) && SvCUR(sv)) {
2070 Move(SvPVX(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
2074 SvLEN_set(sv, newlen);
2080 =for apidoc sv_setiv
2082 Copies an integer into the given SV, upgrading first if necessary.
2083 Does not handle 'set' magic. See also C<sv_setiv_mg>.
2089 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
2091 SV_CHECK_THINKFIRST_COW_DROP(sv);
2092 switch (SvTYPE(sv)) {
2094 sv_upgrade(sv, SVt_IV);
2097 sv_upgrade(sv, SVt_PVNV);
2101 sv_upgrade(sv, SVt_PVIV);
2110 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
2113 (void)SvIOK_only(sv); /* validate number */
2119 =for apidoc sv_setiv_mg
2121 Like C<sv_setiv>, but also handles 'set' magic.
2127 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
2134 =for apidoc sv_setuv
2136 Copies an unsigned integer into the given SV, upgrading first if necessary.
2137 Does not handle 'set' magic. See also C<sv_setuv_mg>.
2143 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
2145 /* With these two if statements:
2146 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2149 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2151 If you wish to remove them, please benchmark to see what the effect is
2153 if (u <= (UV)IV_MAX) {
2154 sv_setiv(sv, (IV)u);
2163 =for apidoc sv_setuv_mg
2165 Like C<sv_setuv>, but also handles 'set' magic.
2171 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
2173 /* With these two if statements:
2174 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2177 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2179 If you wish to remove them, please benchmark to see what the effect is
2181 if (u <= (UV)IV_MAX) {
2182 sv_setiv(sv, (IV)u);
2192 =for apidoc sv_setnv
2194 Copies a double into the given SV, upgrading first if necessary.
2195 Does not handle 'set' magic. See also C<sv_setnv_mg>.
2201 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
2203 SV_CHECK_THINKFIRST_COW_DROP(sv);
2204 switch (SvTYPE(sv)) {
2207 sv_upgrade(sv, SVt_NV);
2212 sv_upgrade(sv, SVt_PVNV);
2221 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
2225 (void)SvNOK_only(sv); /* validate number */
2230 =for apidoc sv_setnv_mg
2232 Like C<sv_setnv>, but also handles 'set' magic.
2238 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
2244 /* Print an "isn't numeric" warning, using a cleaned-up,
2245 * printable version of the offending string
2249 S_not_a_number(pTHX_ SV *sv)
2256 dsv = sv_2mortal(newSVpv("", 0));
2257 pv = sv_uni_display(dsv, sv, 10, 0);
2260 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
2261 /* each *s can expand to 4 chars + "...\0",
2262 i.e. need room for 8 chars */
2265 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
2267 if (ch & 128 && !isPRINT_LC(ch)) {
2276 else if (ch == '\r') {
2280 else if (ch == '\f') {
2284 else if (ch == '\\') {
2288 else if (ch == '\0') {
2292 else if (isPRINT_LC(ch))
2309 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2310 "Argument \"%s\" isn't numeric in %s", pv,
2313 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2314 "Argument \"%s\" isn't numeric", pv);
2318 =for apidoc looks_like_number
2320 Test if the content of an SV looks like a number (or is a number).
2321 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2322 non-numeric warning), even if your atof() doesn't grok them.
2328 Perl_looks_like_number(pTHX_ SV *sv)
2330 register char *sbegin;
2337 else if (SvPOKp(sv))
2338 sbegin = SvPV(sv, len);
2340 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
2341 return grok_number(sbegin, len, NULL);
2344 /* Actually, ISO C leaves conversion of UV to IV undefined, but
2345 until proven guilty, assume that things are not that bad... */
2350 As 64 bit platforms often have an NV that doesn't preserve all bits of
2351 an IV (an assumption perl has been based on to date) it becomes necessary
2352 to remove the assumption that the NV always carries enough precision to
2353 recreate the IV whenever needed, and that the NV is the canonical form.
2354 Instead, IV/UV and NV need to be given equal rights. So as to not lose
2355 precision as a side effect of conversion (which would lead to insanity
2356 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2357 1) to distinguish between IV/UV/NV slots that have cached a valid
2358 conversion where precision was lost and IV/UV/NV slots that have a
2359 valid conversion which has lost no precision
2360 2) to ensure that if a numeric conversion to one form is requested that
2361 would lose precision, the precise conversion (or differently
2362 imprecise conversion) is also performed and cached, to prevent
2363 requests for different numeric formats on the same SV causing
2364 lossy conversion chains. (lossless conversion chains are perfectly
2369 SvIOKp is true if the IV slot contains a valid value
2370 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
2371 SvNOKp is true if the NV slot contains a valid value
2372 SvNOK is true only if the NV value is accurate
2375 while converting from PV to NV, check to see if converting that NV to an
2376 IV(or UV) would lose accuracy over a direct conversion from PV to
2377 IV(or UV). If it would, cache both conversions, return NV, but mark
2378 SV as IOK NOKp (ie not NOK).
2380 While converting from PV to IV, check to see if converting that IV to an
2381 NV would lose accuracy over a direct conversion from PV to NV. If it
2382 would, cache both conversions, flag similarly.
2384 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2385 correctly because if IV & NV were set NV *always* overruled.
2386 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2387 changes - now IV and NV together means that the two are interchangeable:
2388 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
2390 The benefit of this is that operations such as pp_add know that if
2391 SvIOK is true for both left and right operands, then integer addition
2392 can be used instead of floating point (for cases where the result won't
2393 overflow). Before, floating point was always used, which could lead to
2394 loss of precision compared with integer addition.
2396 * making IV and NV equal status should make maths accurate on 64 bit
2398 * may speed up maths somewhat if pp_add and friends start to use
2399 integers when possible instead of fp. (Hopefully the overhead in
2400 looking for SvIOK and checking for overflow will not outweigh the
2401 fp to integer speedup)
2402 * will slow down integer operations (callers of SvIV) on "inaccurate"
2403 values, as the change from SvIOK to SvIOKp will cause a call into
2404 sv_2iv each time rather than a macro access direct to the IV slot
2405 * should speed up number->string conversion on integers as IV is
2406 favoured when IV and NV are equally accurate
2408 ####################################################################
2409 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2410 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2411 On the other hand, SvUOK is true iff UV.
2412 ####################################################################
2414 Your mileage will vary depending your CPU's relative fp to integer
2418 #ifndef NV_PRESERVES_UV
2419 # define IS_NUMBER_UNDERFLOW_IV 1
2420 # define IS_NUMBER_UNDERFLOW_UV 2
2421 # define IS_NUMBER_IV_AND_UV 2
2422 # define IS_NUMBER_OVERFLOW_IV 4
2423 # define IS_NUMBER_OVERFLOW_UV 5
2425 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2427 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2429 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2431 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
2432 if (SvNVX(sv) < (NV)IV_MIN) {
2433 (void)SvIOKp_on(sv);
2435 SvIV_set(sv, IV_MIN);
2436 return IS_NUMBER_UNDERFLOW_IV;
2438 if (SvNVX(sv) > (NV)UV_MAX) {
2439 (void)SvIOKp_on(sv);
2442 SvUV_set(sv, UV_MAX);
2443 return IS_NUMBER_OVERFLOW_UV;
2445 (void)SvIOKp_on(sv);
2447 /* Can't use strtol etc to convert this string. (See truth table in
2449 if (SvNVX(sv) <= (UV)IV_MAX) {
2450 SvIV_set(sv, I_V(SvNVX(sv)));
2451 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2452 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2454 /* Integer is imprecise. NOK, IOKp */
2456 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2459 SvUV_set(sv, U_V(SvNVX(sv)));
2460 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2461 if (SvUVX(sv) == UV_MAX) {
2462 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2463 possibly be preserved by NV. Hence, it must be overflow.
2465 return IS_NUMBER_OVERFLOW_UV;
2467 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2469 /* Integer is imprecise. NOK, IOKp */
2471 return IS_NUMBER_OVERFLOW_IV;
2473 #endif /* !NV_PRESERVES_UV*/
2475 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2476 * this function provided for binary compatibility only
2480 Perl_sv_2iv(pTHX_ register SV *sv)
2482 return sv_2iv_flags(sv, SV_GMAGIC);
2486 =for apidoc sv_2iv_flags
2488 Return the integer value of an SV, doing any necessary string
2489 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2490 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2496 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2500 if (SvGMAGICAL(sv)) {
2501 if (flags & SV_GMAGIC)
2506 return I_V(SvNVX(sv));
2508 if (SvPOKp(sv) && SvLEN(sv))
2511 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2512 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2518 if (SvTHINKFIRST(sv)) {
2521 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2522 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2523 return SvIV(tmpstr);
2524 return PTR2IV(SvRV(sv));
2527 sv_force_normal_flags(sv, 0);
2529 if (SvREADONLY(sv) && !SvOK(sv)) {
2530 if (ckWARN(WARN_UNINITIALIZED))
2537 return (IV)(SvUVX(sv));
2544 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2545 * without also getting a cached IV/UV from it at the same time
2546 * (ie PV->NV conversion should detect loss of accuracy and cache
2547 * IV or UV at same time to avoid this. NWC */
2549 if (SvTYPE(sv) == SVt_NV)
2550 sv_upgrade(sv, SVt_PVNV);
2552 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2553 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2554 certainly cast into the IV range at IV_MAX, whereas the correct
2555 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2557 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2558 SvIV_set(sv, I_V(SvNVX(sv)));
2559 if (SvNVX(sv) == (NV) SvIVX(sv)
2560 #ifndef NV_PRESERVES_UV
2561 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2562 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2563 /* Don't flag it as "accurately an integer" if the number
2564 came from a (by definition imprecise) NV operation, and
2565 we're outside the range of NV integer precision */
2568 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2569 DEBUG_c(PerlIO_printf(Perl_debug_log,
2570 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2576 /* IV not precise. No need to convert from PV, as NV
2577 conversion would already have cached IV if it detected
2578 that PV->IV would be better than PV->NV->IV
2579 flags already correct - don't set public IOK. */
2580 DEBUG_c(PerlIO_printf(Perl_debug_log,
2581 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2586 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2587 but the cast (NV)IV_MIN rounds to a the value less (more
2588 negative) than IV_MIN which happens to be equal to SvNVX ??
2589 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2590 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2591 (NV)UVX == NVX are both true, but the values differ. :-(
2592 Hopefully for 2s complement IV_MIN is something like
2593 0x8000000000000000 which will be exact. NWC */
2596 SvUV_set(sv, U_V(SvNVX(sv)));
2598 (SvNVX(sv) == (NV) SvUVX(sv))
2599 #ifndef NV_PRESERVES_UV
2600 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2601 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2602 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2603 /* Don't flag it as "accurately an integer" if the number
2604 came from a (by definition imprecise) NV operation, and
2605 we're outside the range of NV integer precision */
2611 DEBUG_c(PerlIO_printf(Perl_debug_log,
2612 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2616 return (IV)SvUVX(sv);
2619 else if (SvPOKp(sv) && SvLEN(sv)) {
2621 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2622 /* We want to avoid a possible problem when we cache an IV which
2623 may be later translated to an NV, and the resulting NV is not
2624 the same as the direct translation of the initial string
2625 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2626 be careful to ensure that the value with the .456 is around if the
2627 NV value is requested in the future).
2629 This means that if we cache such an IV, we need to cache the
2630 NV as well. Moreover, we trade speed for space, and do not
2631 cache the NV if we are sure it's not needed.
2634 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2635 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2636 == IS_NUMBER_IN_UV) {
2637 /* It's definitely an integer, only upgrade to PVIV */
2638 if (SvTYPE(sv) < SVt_PVIV)
2639 sv_upgrade(sv, SVt_PVIV);
2641 } else if (SvTYPE(sv) < SVt_PVNV)
2642 sv_upgrade(sv, SVt_PVNV);
2644 /* If NV preserves UV then we only use the UV value if we know that
2645 we aren't going to call atof() below. If NVs don't preserve UVs
2646 then the value returned may have more precision than atof() will
2647 return, even though value isn't perfectly accurate. */
2648 if ((numtype & (IS_NUMBER_IN_UV
2649 #ifdef NV_PRESERVES_UV
2652 )) == IS_NUMBER_IN_UV) {
2653 /* This won't turn off the public IOK flag if it was set above */
2654 (void)SvIOKp_on(sv);
2656 if (!(numtype & IS_NUMBER_NEG)) {
2658 if (value <= (UV)IV_MAX) {
2659 SvIV_set(sv, (IV)value);
2661 SvUV_set(sv, value);
2665 /* 2s complement assumption */
2666 if (value <= (UV)IV_MIN) {
2667 SvIV_set(sv, -(IV)value);
2669 /* Too negative for an IV. This is a double upgrade, but
2670 I'm assuming it will be rare. */
2671 if (SvTYPE(sv) < SVt_PVNV)
2672 sv_upgrade(sv, SVt_PVNV);
2676 SvNV_set(sv, -(NV)value);
2677 SvIV_set(sv, IV_MIN);
2681 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2682 will be in the previous block to set the IV slot, and the next
2683 block to set the NV slot. So no else here. */
2685 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2686 != IS_NUMBER_IN_UV) {
2687 /* It wasn't an (integer that doesn't overflow the UV). */
2688 SvNV_set(sv, Atof(SvPVX(sv)));
2690 if (! numtype && ckWARN(WARN_NUMERIC))
2693 #if defined(USE_LONG_DOUBLE)
2694 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2695 PTR2UV(sv), SvNVX(sv)));
2697 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2698 PTR2UV(sv), SvNVX(sv)));
2702 #ifdef NV_PRESERVES_UV
2703 (void)SvIOKp_on(sv);
2705 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2706 SvIV_set(sv, I_V(SvNVX(sv)));
2707 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2710 /* Integer is imprecise. NOK, IOKp */
2712 /* UV will not work better than IV */
2714 if (SvNVX(sv) > (NV)UV_MAX) {
2716 /* Integer is inaccurate. NOK, IOKp, is UV */
2717 SvUV_set(sv, UV_MAX);
2720 SvUV_set(sv, U_V(SvNVX(sv)));
2721 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2722 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2726 /* Integer is imprecise. NOK, IOKp, is UV */
2732 #else /* NV_PRESERVES_UV */
2733 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2734 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2735 /* The IV slot will have been set from value returned by
2736 grok_number above. The NV slot has just been set using
2739 assert (SvIOKp(sv));
2741 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2742 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2743 /* Small enough to preserve all bits. */
2744 (void)SvIOKp_on(sv);
2746 SvIV_set(sv, I_V(SvNVX(sv)));
2747 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2749 /* Assumption: first non-preserved integer is < IV_MAX,
2750 this NV is in the preserved range, therefore: */
2751 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2753 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
2757 0 0 already failed to read UV.
2758 0 1 already failed to read UV.
2759 1 0 you won't get here in this case. IV/UV
2760 slot set, public IOK, Atof() unneeded.
2761 1 1 already read UV.
2762 so there's no point in sv_2iuv_non_preserve() attempting
2763 to use atol, strtol, strtoul etc. */
2764 if (sv_2iuv_non_preserve (sv, numtype)
2765 >= IS_NUMBER_OVERFLOW_IV)
2769 #endif /* NV_PRESERVES_UV */
2772 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2774 if (SvTYPE(sv) < SVt_IV)
2775 /* Typically the caller expects that sv_any is not NULL now. */
2776 sv_upgrade(sv, SVt_IV);
2779 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2780 PTR2UV(sv),SvIVX(sv)));
2781 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2784 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2785 * this function provided for binary compatibility only
2789 Perl_sv_2uv(pTHX_ register SV *sv)
2791 return sv_2uv_flags(sv, SV_GMAGIC);
2795 =for apidoc sv_2uv_flags
2797 Return the unsigned integer value of an SV, doing any necessary string
2798 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2799 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2805 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2809 if (SvGMAGICAL(sv)) {
2810 if (flags & SV_GMAGIC)
2815 return U_V(SvNVX(sv));
2816 if (SvPOKp(sv) && SvLEN(sv))
2819 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2820 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2826 if (SvTHINKFIRST(sv)) {
2829 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2830 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2831 return SvUV(tmpstr);
2832 return PTR2UV(SvRV(sv));
2835 sv_force_normal_flags(sv, 0);
2837 if (SvREADONLY(sv) && !SvOK(sv)) {
2838 if (ckWARN(WARN_UNINITIALIZED))
2848 return (UV)SvIVX(sv);
2852 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2853 * without also getting a cached IV/UV from it at the same time
2854 * (ie PV->NV conversion should detect loss of accuracy and cache
2855 * IV or UV at same time to avoid this. */
2856 /* IV-over-UV optimisation - choose to cache IV if possible */
2858 if (SvTYPE(sv) == SVt_NV)
2859 sv_upgrade(sv, SVt_PVNV);
2861 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2862 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2863 SvIV_set(sv, I_V(SvNVX(sv)));
2864 if (SvNVX(sv) == (NV) SvIVX(sv)
2865 #ifndef NV_PRESERVES_UV
2866 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2867 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2868 /* Don't flag it as "accurately an integer" if the number
2869 came from a (by definition imprecise) NV operation, and
2870 we're outside the range of NV integer precision */
2873 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2874 DEBUG_c(PerlIO_printf(Perl_debug_log,
2875 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2881 /* IV not precise. No need to convert from PV, as NV
2882 conversion would already have cached IV if it detected
2883 that PV->IV would be better than PV->NV->IV
2884 flags already correct - don't set public IOK. */
2885 DEBUG_c(PerlIO_printf(Perl_debug_log,
2886 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2891 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2892 but the cast (NV)IV_MIN rounds to a the value less (more
2893 negative) than IV_MIN which happens to be equal to SvNVX ??
2894 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2895 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2896 (NV)UVX == NVX are both true, but the values differ. :-(
2897 Hopefully for 2s complement IV_MIN is something like
2898 0x8000000000000000 which will be exact. NWC */
2901 SvUV_set(sv, U_V(SvNVX(sv)));
2903 (SvNVX(sv) == (NV) SvUVX(sv))
2904 #ifndef NV_PRESERVES_UV
2905 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2906 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2907 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2908 /* Don't flag it as "accurately an integer" if the number
2909 came from a (by definition imprecise) NV operation, and
2910 we're outside the range of NV integer precision */
2915 DEBUG_c(PerlIO_printf(Perl_debug_log,
2916 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2922 else if (SvPOKp(sv) && SvLEN(sv)) {
2924 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2926 /* We want to avoid a possible problem when we cache a UV which
2927 may be later translated to an NV, and the resulting NV is not
2928 the translation of the initial data.
2930 This means that if we cache such a UV, we need to cache the
2931 NV as well. Moreover, we trade speed for space, and do not
2932 cache the NV if not needed.
2935 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2936 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2937 == IS_NUMBER_IN_UV) {
2938 /* It's definitely an integer, only upgrade to PVIV */
2939 if (SvTYPE(sv) < SVt_PVIV)
2940 sv_upgrade(sv, SVt_PVIV);
2942 } else if (SvTYPE(sv) < SVt_PVNV)
2943 sv_upgrade(sv, SVt_PVNV);
2945 /* If NV preserves UV then we only use the UV value if we know that
2946 we aren't going to call atof() below. If NVs don't preserve UVs
2947 then the value returned may have more precision than atof() will
2948 return, even though it isn't accurate. */
2949 if ((numtype & (IS_NUMBER_IN_UV
2950 #ifdef NV_PRESERVES_UV
2953 )) == IS_NUMBER_IN_UV) {
2954 /* This won't turn off the public IOK flag if it was set above */
2955 (void)SvIOKp_on(sv);
2957 if (!(numtype & IS_NUMBER_NEG)) {
2959 if (value <= (UV)IV_MAX) {
2960 SvIV_set(sv, (IV)value);
2962 /* it didn't overflow, and it was positive. */
2963 SvUV_set(sv, value);
2967 /* 2s complement assumption */
2968 if (value <= (UV)IV_MIN) {
2969 SvIV_set(sv, -(IV)value);
2971 /* Too negative for an IV. This is a double upgrade, but
2972 I'm assuming it will be rare. */
2973 if (SvTYPE(sv) < SVt_PVNV)
2974 sv_upgrade(sv, SVt_PVNV);
2978 SvNV_set(sv, -(NV)value);
2979 SvIV_set(sv, IV_MIN);
2984 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2985 != IS_NUMBER_IN_UV) {
2986 /* It wasn't an integer, or it overflowed the UV. */
2987 SvNV_set(sv, Atof(SvPVX(sv)));
2989 if (! numtype && ckWARN(WARN_NUMERIC))
2992 #if defined(USE_LONG_DOUBLE)
2993 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2994 PTR2UV(sv), SvNVX(sv)));
2996 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
2997 PTR2UV(sv), SvNVX(sv)));
3000 #ifdef NV_PRESERVES_UV
3001 (void)SvIOKp_on(sv);
3003 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3004 SvIV_set(sv, I_V(SvNVX(sv)));
3005 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
3008 /* Integer is imprecise. NOK, IOKp */
3010 /* UV will not work better than IV */
3012 if (SvNVX(sv) > (NV)UV_MAX) {
3014 /* Integer is inaccurate. NOK, IOKp, is UV */
3015 SvUV_set(sv, UV_MAX);
3018 SvUV_set(sv, U_V(SvNVX(sv)));
3019 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
3020 NV preservse UV so can do correct comparison. */
3021 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
3025 /* Integer is imprecise. NOK, IOKp, is UV */
3030 #else /* NV_PRESERVES_UV */
3031 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3032 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
3033 /* The UV slot will have been set from value returned by
3034 grok_number above. The NV slot has just been set using
3037 assert (SvIOKp(sv));
3039 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3040 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3041 /* Small enough to preserve all bits. */
3042 (void)SvIOKp_on(sv);
3044 SvIV_set(sv, I_V(SvNVX(sv)));
3045 if ((NV)(SvIVX(sv)) == SvNVX(sv))
3047 /* Assumption: first non-preserved integer is < IV_MAX,
3048 this NV is in the preserved range, therefore: */
3049 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
3051 Perl_croak(aTHX_ "sv_2uv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
3054 sv_2iuv_non_preserve (sv, numtype);
3056 #endif /* NV_PRESERVES_UV */
3060 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3061 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3064 if (SvTYPE(sv) < SVt_IV)
3065 /* Typically the caller expects that sv_any is not NULL now. */
3066 sv_upgrade(sv, SVt_IV);
3070 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
3071 PTR2UV(sv),SvUVX(sv)));
3072 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
3078 Return the num value of an SV, doing any necessary string or integer
3079 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3086 Perl_sv_2nv(pTHX_ register SV *sv)
3090 if (SvGMAGICAL(sv)) {
3094 if (SvPOKp(sv) && SvLEN(sv)) {
3095 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
3096 !grok_number(SvPVX(sv), SvCUR(sv), NULL))
3098 return Atof(SvPVX(sv));
3102 return (NV)SvUVX(sv);
3104 return (NV)SvIVX(sv);
3107 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3108 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3114 if (SvTHINKFIRST(sv)) {
3117 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
3118 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
3119 return SvNV(tmpstr);
3120 return PTR2NV(SvRV(sv));
3123 sv_force_normal_flags(sv, 0);
3125 if (SvREADONLY(sv) && !SvOK(sv)) {
3126 if (ckWARN(WARN_UNINITIALIZED))
3131 if (SvTYPE(sv) < SVt_NV) {
3132 if (SvTYPE(sv) == SVt_IV)
3133 sv_upgrade(sv, SVt_PVNV);
3135 sv_upgrade(sv, SVt_NV);
3136 #ifdef USE_LONG_DOUBLE
3138 STORE_NUMERIC_LOCAL_SET_STANDARD();
3139 PerlIO_printf(Perl_debug_log,
3140 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
3141 PTR2UV(sv), SvNVX(sv));
3142 RESTORE_NUMERIC_LOCAL();
3146 STORE_NUMERIC_LOCAL_SET_STANDARD();
3147 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
3148 PTR2UV(sv), SvNVX(sv));
3149 RESTORE_NUMERIC_LOCAL();
3153 else if (SvTYPE(sv) < SVt_PVNV)
3154 sv_upgrade(sv, SVt_PVNV);
3159 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
3160 #ifdef NV_PRESERVES_UV
3163 /* Only set the public NV OK flag if this NV preserves the IV */
3164 /* Check it's not 0xFFFFFFFFFFFFFFFF */
3165 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
3166 : (SvIVX(sv) == I_V(SvNVX(sv))))
3172 else if (SvPOKp(sv) && SvLEN(sv)) {
3174 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3175 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
3177 #ifdef NV_PRESERVES_UV
3178 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3179 == IS_NUMBER_IN_UV) {
3180 /* It's definitely an integer */
3181 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
3183 SvNV_set(sv, Atof(SvPVX(sv)));
3186 SvNV_set(sv, Atof(SvPVX(sv)));
3187 /* Only set the public NV OK flag if this NV preserves the value in
3188 the PV at least as well as an IV/UV would.
3189 Not sure how to do this 100% reliably. */
3190 /* if that shift count is out of range then Configure's test is
3191 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
3193 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3194 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3195 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
3196 } else if (!(numtype & IS_NUMBER_IN_UV)) {
3197 /* Can't use strtol etc to convert this string, so don't try.
3198 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
3201 /* value has been set. It may not be precise. */
3202 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
3203 /* 2s complement assumption for (UV)IV_MIN */
3204 SvNOK_on(sv); /* Integer is too negative. */
3209 if (numtype & IS_NUMBER_NEG) {
3210 SvIV_set(sv, -(IV)value);
3211 } else if (value <= (UV)IV_MAX) {
3212 SvIV_set(sv, (IV)value);
3214 SvUV_set(sv, value);
3218 if (numtype & IS_NUMBER_NOT_INT) {
3219 /* I believe that even if the original PV had decimals,
3220 they are lost beyond the limit of the FP precision.
3221 However, neither is canonical, so both only get p
3222 flags. NWC, 2000/11/25 */
3223 /* Both already have p flags, so do nothing */
3226 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3227 if (SvIVX(sv) == I_V(nv)) {
3232 /* It had no "." so it must be integer. */
3235 /* between IV_MAX and NV(UV_MAX).
3236 Could be slightly > UV_MAX */
3238 if (numtype & IS_NUMBER_NOT_INT) {
3239 /* UV and NV both imprecise. */
3241 UV nv_as_uv = U_V(nv);
3243 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
3254 #endif /* NV_PRESERVES_UV */
3257 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3259 if (SvTYPE(sv) < SVt_NV)
3260 /* Typically the caller expects that sv_any is not NULL now. */
3261 /* XXX Ilya implies that this is a bug in callers that assume this
3262 and ideally should be fixed. */
3263 sv_upgrade(sv, SVt_NV);
3266 #if defined(USE_LONG_DOUBLE)
3268 STORE_NUMERIC_LOCAL_SET_STANDARD();
3269 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
3270 PTR2UV(sv), SvNVX(sv));
3271 RESTORE_NUMERIC_LOCAL();
3275 STORE_NUMERIC_LOCAL_SET_STANDARD();
3276 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
3277 PTR2UV(sv), SvNVX(sv));
3278 RESTORE_NUMERIC_LOCAL();
3284 /* asIV(): extract an integer from the string value of an SV.
3285 * Caller must validate PVX */
3288 S_asIV(pTHX_ SV *sv)
3291 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3293 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3294 == IS_NUMBER_IN_UV) {
3295 /* It's definitely an integer */
3296 if (numtype & IS_NUMBER_NEG) {
3297 if (value < (UV)IV_MIN)
3300 if (value < (UV)IV_MAX)
3305 if (ckWARN(WARN_NUMERIC))
3308 return I_V(Atof(SvPVX(sv)));
3311 /* asUV(): extract an unsigned integer from the string value of an SV
3312 * Caller must validate PVX */
3315 S_asUV(pTHX_ SV *sv)
3318 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3320 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3321 == IS_NUMBER_IN_UV) {
3322 /* It's definitely an integer */
3323 if (!(numtype & IS_NUMBER_NEG))
3327 if (ckWARN(WARN_NUMERIC))
3330 return U_V(Atof(SvPVX(sv)));
3334 =for apidoc sv_2pv_nolen
3336 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3337 use the macro wrapper C<SvPV_nolen(sv)> instead.
3342 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
3345 return sv_2pv(sv, &n_a);
3348 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
3349 * UV as a string towards the end of buf, and return pointers to start and
3352 * We assume that buf is at least TYPE_CHARS(UV) long.
3356 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
3358 char *ptr = buf + TYPE_CHARS(UV);
3372 *--ptr = '0' + (char)(uv % 10);
3380 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
3381 * this function provided for binary compatibility only
3385 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
3387 return sv_2pv_flags(sv, lp, SV_GMAGIC);
3391 =for apidoc sv_2pv_flags
3393 Returns a pointer to the string value of an SV, and sets *lp to its length.
3394 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3396 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3397 usually end up here too.
3403 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3408 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3409 char *tmpbuf = tbuf;
3415 if (SvGMAGICAL(sv)) {
3416 if (flags & SV_GMAGIC)
3424 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3426 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3431 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3436 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3437 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3444 if (SvTHINKFIRST(sv)) {
3447 register const char *typestr;
3448 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3449 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3450 char *pv = SvPV(tmpstr, *lp);
3460 typestr = "NULLREF";
3464 switch (SvTYPE(sv)) {
3466 if ( ((SvFLAGS(sv) &
3467 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3468 == (SVs_OBJECT|SVs_SMG))
3469 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3470 const regexp *re = (regexp *)mg->mg_obj;
3473 const char *fptr = "msix";
3478 char need_newline = 0;
3479 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3481 while((ch = *fptr++)) {
3483 reflags[left++] = ch;
3486 reflags[right--] = ch;
3491 reflags[left] = '-';
3495 mg->mg_len = re->prelen + 4 + left;
3497 * If /x was used, we have to worry about a regex
3498 * ending with a comment later being embedded
3499 * within another regex. If so, we don't want this
3500 * regex's "commentization" to leak out to the
3501 * right part of the enclosing regex, we must cap
3502 * it with a newline.
3504 * So, if /x was used, we scan backwards from the
3505 * end of the regex. If we find a '#' before we
3506 * find a newline, we need to add a newline
3507 * ourself. If we find a '\n' first (or if we
3508 * don't find '#' or '\n'), we don't need to add
3509 * anything. -jfriedl
3511 if (PMf_EXTENDED & re->reganch)
3513 const char *endptr = re->precomp + re->prelen;
3514 while (endptr >= re->precomp)
3516 const char c = *(endptr--);
3518 break; /* don't need another */
3520 /* we end while in a comment, so we
3522 mg->mg_len++; /* save space for it */
3523 need_newline = 1; /* note to add it */
3529 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3530 Copy("(?", mg->mg_ptr, 2, char);
3531 Copy(reflags, mg->mg_ptr+2, left, char);
3532 Copy(":", mg->mg_ptr+left+2, 1, char);
3533 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3535 mg->mg_ptr[mg->mg_len - 2] = '\n';
3536 mg->mg_ptr[mg->mg_len - 1] = ')';
3537 mg->mg_ptr[mg->mg_len] = 0;
3539 PL_reginterp_cnt += re->program[0].next_off;
3541 if (re->reganch & ROPT_UTF8)
3556 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3557 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3558 /* tied lvalues should appear to be
3559 * scalars for backwards compatitbility */
3560 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3561 ? "SCALAR" : "LVALUE"; break;
3562 case SVt_PVAV: typestr = "ARRAY"; break;
3563 case SVt_PVHV: typestr = "HASH"; break;
3564 case SVt_PVCV: typestr = "CODE"; break;
3565 case SVt_PVGV: typestr = "GLOB"; break;
3566 case SVt_PVFM: typestr = "FORMAT"; break;
3567 case SVt_PVIO: typestr = "IO"; break;
3568 default: typestr = "UNKNOWN"; break;
3572 const char *name = HvNAME(SvSTASH(sv));
3573 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3574 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3577 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3580 *lp = strlen(typestr);
3581 return (char *)typestr;
3583 if (SvREADONLY(sv) && !SvOK(sv)) {
3584 if (ckWARN(WARN_UNINITIALIZED))
3590 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3591 /* I'm assuming that if both IV and NV are equally valid then
3592 converting the IV is going to be more efficient */
3593 const U32 isIOK = SvIOK(sv);
3594 const U32 isUIOK = SvIsUV(sv);
3595 char buf[TYPE_CHARS(UV)];
3598 if (SvTYPE(sv) < SVt_PVIV)
3599 sv_upgrade(sv, SVt_PVIV);
3601 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3603 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3604 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
3605 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3606 SvCUR_set(sv, ebuf - ptr);
3616 else if (SvNOKp(sv)) {
3617 if (SvTYPE(sv) < SVt_PVNV)
3618 sv_upgrade(sv, SVt_PVNV);
3619 /* The +20 is pure guesswork. Configure test needed. --jhi */
3620 SvGROW(sv, NV_DIG + 20);
3622 olderrno = errno; /* some Xenix systems wipe out errno here */
3624 if (SvNVX(sv) == 0.0)
3625 (void)strcpy(s,"0");
3629 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3632 #ifdef FIXNEGATIVEZERO
3633 if (*s == '-' && s[1] == '0' && !s[2])
3643 if (ckWARN(WARN_UNINITIALIZED)
3644 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3647 if (SvTYPE(sv) < SVt_PV)
3648 /* Typically the caller expects that sv_any is not NULL now. */
3649 sv_upgrade(sv, SVt_PV);
3652 *lp = s - SvPVX(sv);
3655 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3656 PTR2UV(sv),SvPVX(sv)));
3660 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3661 /* Sneaky stuff here */
3665 tsv = newSVpv(tmpbuf, 0);
3682 len = strlen(tmpbuf);
3684 #ifdef FIXNEGATIVEZERO
3685 if (len == 2 && t[0] == '-' && t[1] == '0') {
3690 (void)SvUPGRADE(sv, SVt_PV);
3692 s = SvGROW(sv, len + 1);
3695 return strcpy(s, t);
3700 =for apidoc sv_copypv
3702 Copies a stringified representation of the source SV into the
3703 destination SV. Automatically performs any necessary mg_get and
3704 coercion of numeric values into strings. Guaranteed to preserve
3705 UTF-8 flag even from overloaded objects. Similar in nature to
3706 sv_2pv[_flags] but operates directly on an SV instead of just the
3707 string. Mostly uses sv_2pv_flags to do its work, except when that
3708 would lose the UTF-8'ness of the PV.
3714 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3719 sv_setpvn(dsv,s,len);
3727 =for apidoc sv_2pvbyte_nolen
3729 Return a pointer to the byte-encoded representation of the SV.
3730 May cause the SV to be downgraded from UTF-8 as a side-effect.
3732 Usually accessed via the C<SvPVbyte_nolen> macro.
3738 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3741 return sv_2pvbyte(sv, &n_a);
3745 =for apidoc sv_2pvbyte
3747 Return a pointer to the byte-encoded representation of the SV, and set *lp
3748 to its length. May cause the SV to be downgraded from UTF-8 as a
3751 Usually accessed via the C<SvPVbyte> macro.
3757 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3759 sv_utf8_downgrade(sv,0);
3760 return SvPV(sv,*lp);
3764 =for apidoc sv_2pvutf8_nolen
3766 Return a pointer to the UTF-8-encoded representation of the SV.
3767 May cause the SV to be upgraded to UTF-8 as a side-effect.
3769 Usually accessed via the C<SvPVutf8_nolen> macro.
3775 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3778 return sv_2pvutf8(sv, &n_a);
3782 =for apidoc sv_2pvutf8
3784 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3785 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3787 Usually accessed via the C<SvPVutf8> macro.
3793 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3795 sv_utf8_upgrade(sv);
3796 return SvPV(sv,*lp);
3800 =for apidoc sv_2bool
3802 This function is only called on magical items, and is only used by
3803 sv_true() or its macro equivalent.
3809 Perl_sv_2bool(pTHX_ register SV *sv)
3818 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3819 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3820 return (bool)SvTRUE(tmpsv);
3821 return SvRV(sv) != 0;
3824 register XPV* Xpvtmp;
3825 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3826 (*Xpvtmp->xpv_pv > '0' ||
3827 Xpvtmp->xpv_cur > 1 ||
3828 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
3835 return SvIVX(sv) != 0;
3838 return SvNVX(sv) != 0.0;
3845 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3846 * this function provided for binary compatibility only
3851 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3853 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3857 =for apidoc sv_utf8_upgrade
3859 Converts the PV of an SV to its UTF-8-encoded form.
3860 Forces the SV to string form if it is not already.
3861 Always sets the SvUTF8 flag to avoid future validity checks even
3862 if all the bytes have hibit clear.
3864 This is not as a general purpose byte encoding to Unicode interface:
3865 use the Encode extension for that.
3867 =for apidoc sv_utf8_upgrade_flags
3869 Converts the PV of an SV to its UTF-8-encoded form.
3870 Forces the SV to string form if it is not already.
3871 Always sets the SvUTF8 flag to avoid future validity checks even
3872 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3873 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3874 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3876 This is not as a general purpose byte encoding to Unicode interface:
3877 use the Encode extension for that.
3883 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3888 if (sv == &PL_sv_undef)
3892 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3893 (void) sv_2pv_flags(sv,&len, flags);
3897 (void) SvPV_force(sv,len);
3906 sv_force_normal_flags(sv, 0);
3909 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3910 sv_recode_to_utf8(sv, PL_encoding);
3911 else { /* Assume Latin-1/EBCDIC */
3912 /* This function could be much more efficient if we
3913 * had a FLAG in SVs to signal if there are any hibit
3914 * chars in the PV. Given that there isn't such a flag
3915 * make the loop as fast as possible. */
3916 s = (U8 *) SvPVX(sv);
3917 e = (U8 *) SvEND(sv);
3921 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3926 (void)SvOOK_off(sv);
3928 len = SvCUR(sv) + 1; /* Plus the \0 */
3929 SvPV_set(sv, (char*)bytes_to_utf8((U8*)s, &len));
3930 SvCUR_set(sv, len - 1);
3932 Safefree(s); /* No longer using what was there before. */
3933 SvLEN_set(sv, len); /* No longer know the real size. */
3935 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3942 =for apidoc sv_utf8_downgrade
3944 Attempts to convert the PV of an SV from characters to bytes.
3945 If the PV contains a character beyond byte, this conversion will fail;
3946 in this case, either returns false or, if C<fail_ok> is not
3949 This is not as a general purpose Unicode to byte encoding interface:
3950 use the Encode extension for that.
3956 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3958 if (SvPOKp(sv) && SvUTF8(sv)) {
3964 sv_force_normal_flags(sv, 0);
3966 s = (U8 *) SvPV(sv, len);
3967 if (!utf8_to_bytes(s, &len)) {
3972 Perl_croak(aTHX_ "Wide character in %s",
3975 Perl_croak(aTHX_ "Wide character");
3986 =for apidoc sv_utf8_encode
3988 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3989 flag off so that it looks like octets again.
3995 Perl_sv_utf8_encode(pTHX_ register SV *sv)
3997 (void) sv_utf8_upgrade(sv);
3999 sv_force_normal_flags(sv, 0);
4001 if (SvREADONLY(sv)) {
4002 Perl_croak(aTHX_ PL_no_modify);
4008 =for apidoc sv_utf8_decode
4010 If the PV of the SV is an octet sequence in UTF-8
4011 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
4012 so that it looks like a character. If the PV contains only single-byte
4013 characters, the C<SvUTF8> flag stays being off.
4014 Scans PV for validity and returns false if the PV is invalid UTF-8.
4020 Perl_sv_utf8_decode(pTHX_ register SV *sv)
4026 /* The octets may have got themselves encoded - get them back as
4029 if (!sv_utf8_downgrade(sv, TRUE))
4032 /* it is actually just a matter of turning the utf8 flag on, but
4033 * we want to make sure everything inside is valid utf8 first.
4035 c = (U8 *) SvPVX(sv);
4036 if (!is_utf8_string(c, SvCUR(sv)+1))
4038 e = (U8 *) SvEND(sv);
4041 if (!UTF8_IS_INVARIANT(ch)) {
4050 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
4051 * this function provided for binary compatibility only
4055 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
4057 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
4061 =for apidoc sv_setsv
4063 Copies the contents of the source SV C<ssv> into the destination SV
4064 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4065 function if the source SV needs to be reused. Does not handle 'set' magic.
4066 Loosely speaking, it performs a copy-by-value, obliterating any previous
4067 content of the destination.
4069 You probably want to use one of the assortment of wrappers, such as
4070 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4071 C<SvSetMagicSV_nosteal>.
4073 =for apidoc sv_setsv_flags
4075 Copies the contents of the source SV C<ssv> into the destination SV
4076 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4077 function if the source SV needs to be reused. Does not handle 'set' magic.
4078 Loosely speaking, it performs a copy-by-value, obliterating any previous
4079 content of the destination.
4080 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4081 C<ssv> if appropriate, else not. If the C<flags> parameter has the
4082 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4083 and C<sv_setsv_nomg> are implemented in terms of this function.
4085 You probably want to use one of the assortment of wrappers, such as
4086 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4087 C<SvSetMagicSV_nosteal>.
4089 This is the primary function for copying scalars, and most other
4090 copy-ish functions and macros use this underneath.
4096 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
4098 register U32 sflags;
4104 SV_CHECK_THINKFIRST_COW_DROP(dstr);
4106 sstr = &PL_sv_undef;
4107 stype = SvTYPE(sstr);
4108 dtype = SvTYPE(dstr);
4113 /* need to nuke the magic */
4115 SvRMAGICAL_off(dstr);
4118 /* There's a lot of redundancy below but we're going for speed here */
4123 if (dtype != SVt_PVGV) {
4124 (void)SvOK_off(dstr);
4132 sv_upgrade(dstr, SVt_IV);
4135 sv_upgrade(dstr, SVt_PVNV);
4139 sv_upgrade(dstr, SVt_PVIV);
4142 (void)SvIOK_only(dstr);
4143 SvIV_set(dstr, SvIVX(sstr));
4146 if (SvTAINTED(sstr))
4157 sv_upgrade(dstr, SVt_NV);
4162 sv_upgrade(dstr, SVt_PVNV);
4165 SvNV_set(dstr, SvNVX(sstr));
4166 (void)SvNOK_only(dstr);
4167 if (SvTAINTED(sstr))
4175 sv_upgrade(dstr, SVt_RV);
4176 else if (dtype == SVt_PVGV &&
4177 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
4180 if (GvIMPORTED(dstr) != GVf_IMPORTED
4181 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4183 GvIMPORTED_on(dstr);
4192 #ifdef PERL_COPY_ON_WRITE
4193 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4194 if (dtype < SVt_PVIV)
4195 sv_upgrade(dstr, SVt_PVIV);
4202 sv_upgrade(dstr, SVt_PV);
4205 if (dtype < SVt_PVIV)
4206 sv_upgrade(dstr, SVt_PVIV);
4209 if (dtype < SVt_PVNV)
4210 sv_upgrade(dstr, SVt_PVNV);
4217 Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
4220 Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
4224 if (dtype <= SVt_PVGV) {
4226 if (dtype != SVt_PVGV) {
4227 char *name = GvNAME(sstr);
4228 STRLEN len = GvNAMELEN(sstr);
4229 /* don't upgrade SVt_PVLV: it can hold a glob */
4230 if (dtype != SVt_PVLV)
4231 sv_upgrade(dstr, SVt_PVGV);
4232 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
4233 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
4234 GvNAME(dstr) = savepvn(name, len);
4235 GvNAMELEN(dstr) = len;
4236 SvFAKE_on(dstr); /* can coerce to non-glob */
4238 /* ahem, death to those who redefine active sort subs */
4239 else if (PL_curstackinfo->si_type == PERLSI_SORT
4240 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
4241 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
4244 #ifdef GV_UNIQUE_CHECK
4245 if (GvUNIQUE((GV*)dstr)) {
4246 Perl_croak(aTHX_ PL_no_modify);
4250 (void)SvOK_off(dstr);
4251 GvINTRO_off(dstr); /* one-shot flag */
4253 GvGP(dstr) = gp_ref(GvGP(sstr));
4254 if (SvTAINTED(sstr))
4256 if (GvIMPORTED(dstr) != GVf_IMPORTED
4257 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4259 GvIMPORTED_on(dstr);
4267 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4269 if ((int)SvTYPE(sstr) != stype) {
4270 stype = SvTYPE(sstr);
4271 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
4275 if (stype == SVt_PVLV)
4276 (void)SvUPGRADE(dstr, SVt_PVNV);
4278 (void)SvUPGRADE(dstr, (U32)stype);
4281 sflags = SvFLAGS(sstr);
4283 if (sflags & SVf_ROK) {
4284 if (dtype >= SVt_PV) {
4285 if (dtype == SVt_PVGV) {
4286 SV *sref = SvREFCNT_inc(SvRV(sstr));
4288 int intro = GvINTRO(dstr);
4290 #ifdef GV_UNIQUE_CHECK
4291 if (GvUNIQUE((GV*)dstr)) {
4292 Perl_croak(aTHX_ PL_no_modify);
4297 GvINTRO_off(dstr); /* one-shot flag */
4298 GvLINE(dstr) = CopLINE(PL_curcop);
4299 GvEGV(dstr) = (GV*)dstr;
4302 switch (SvTYPE(sref)) {
4305 SAVEGENERICSV(GvAV(dstr));
4307 dref = (SV*)GvAV(dstr);
4308 GvAV(dstr) = (AV*)sref;
4309 if (!GvIMPORTED_AV(dstr)
4310 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4312 GvIMPORTED_AV_on(dstr);
4317 SAVEGENERICSV(GvHV(dstr));
4319 dref = (SV*)GvHV(dstr);
4320 GvHV(dstr) = (HV*)sref;
4321 if (!GvIMPORTED_HV(dstr)
4322 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4324 GvIMPORTED_HV_on(dstr);
4329 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
4330 SvREFCNT_dec(GvCV(dstr));
4331 GvCV(dstr) = Nullcv;
4332 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4333 PL_sub_generation++;
4335 SAVEGENERICSV(GvCV(dstr));
4338 dref = (SV*)GvCV(dstr);
4339 if (GvCV(dstr) != (CV*)sref) {
4340 CV* cv = GvCV(dstr);
4342 if (!GvCVGEN((GV*)dstr) &&
4343 (CvROOT(cv) || CvXSUB(cv)))
4345 /* ahem, death to those who redefine
4346 * active sort subs */
4347 if (PL_curstackinfo->si_type == PERLSI_SORT &&
4348 PL_sortcop == CvSTART(cv))
4350 "Can't redefine active sort subroutine %s",
4351 GvENAME((GV*)dstr));
4352 /* Redefining a sub - warning is mandatory if
4353 it was a const and its value changed. */
4354 if (ckWARN(WARN_REDEFINE)
4356 && (!CvCONST((CV*)sref)
4357 || sv_cmp(cv_const_sv(cv),
4358 cv_const_sv((CV*)sref)))))
4360 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
4362 ? "Constant subroutine %s::%s redefined"
4363 : "Subroutine %s::%s redefined",
4364 HvNAME(GvSTASH((GV*)dstr)),
4365 GvENAME((GV*)dstr));
4369 cv_ckproto(cv, (GV*)dstr,
4370 SvPOK(sref) ? SvPVX(sref) : Nullch);
4372 GvCV(dstr) = (CV*)sref;
4373 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4374 GvASSUMECV_on(dstr);
4375 PL_sub_generation++;
4377 if (!GvIMPORTED_CV(dstr)
4378 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4380 GvIMPORTED_CV_on(dstr);
4385 SAVEGENERICSV(GvIOp(dstr));
4387 dref = (SV*)GvIOp(dstr);
4388 GvIOp(dstr) = (IO*)sref;
4392 SAVEGENERICSV(GvFORM(dstr));
4394 dref = (SV*)GvFORM(dstr);
4395 GvFORM(dstr) = (CV*)sref;
4399 SAVEGENERICSV(GvSV(dstr));
4401 dref = (SV*)GvSV(dstr);
4403 if (!GvIMPORTED_SV(dstr)
4404 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4406 GvIMPORTED_SV_on(dstr);
4412 if (SvTAINTED(sstr))
4417 (void)SvOOK_off(dstr); /* backoff */
4419 Safefree(SvPVX(dstr));
4424 (void)SvOK_off(dstr);
4425 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
4427 if (sflags & SVp_NOK) {
4429 /* Only set the public OK flag if the source has public OK. */
4430 if (sflags & SVf_NOK)
4431 SvFLAGS(dstr) |= SVf_NOK;
4432 SvNV_set(dstr, SvNVX(sstr));
4434 if (sflags & SVp_IOK) {
4435 (void)SvIOKp_on(dstr);
4436 if (sflags & SVf_IOK)
4437 SvFLAGS(dstr) |= SVf_IOK;
4438 if (sflags & SVf_IVisUV)
4440 SvIV_set(dstr, SvIVX(sstr));
4442 if (SvAMAGIC(sstr)) {
4446 else if (sflags & SVp_POK) {
4450 * Check to see if we can just swipe the string. If so, it's a
4451 * possible small lose on short strings, but a big win on long ones.
4452 * It might even be a win on short strings if SvPVX(dstr)
4453 * has to be allocated and SvPVX(sstr) has to be freed.
4456 /* Whichever path we take through the next code, we want this true,
4457 and doing it now facilitates the COW check. */
4458 (void)SvPOK_only(dstr);
4461 #ifdef PERL_COPY_ON_WRITE
4462 (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4466 (sflags & SVs_TEMP) && /* slated for free anyway? */
4467 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4468 (!(flags & SV_NOSTEAL)) &&
4469 /* and we're allowed to steal temps */
4470 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4471 SvLEN(sstr) && /* and really is a string */
4472 /* and won't be needed again, potentially */
4473 !(PL_op && PL_op->op_type == OP_AASSIGN))
4474 #ifdef PERL_COPY_ON_WRITE
4475 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4476 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4477 && SvTYPE(sstr) >= SVt_PVIV)
4480 /* Failed the swipe test, and it's not a shared hash key either.
4481 Have to copy the string. */
4482 STRLEN len = SvCUR(sstr);
4483 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4484 Move(SvPVX(sstr),SvPVX(dstr),len,char);
4485 SvCUR_set(dstr, len);
4486 *SvEND(dstr) = '\0';
4488 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
4490 #ifdef PERL_COPY_ON_WRITE
4491 /* Either it's a shared hash key, or it's suitable for
4492 copy-on-write or we can swipe the string. */
4494 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4499 /* I believe I should acquire a global SV mutex if
4500 it's a COW sv (not a shared hash key) to stop
4501 it going un copy-on-write.
4502 If the source SV has gone un copy on write between up there
4503 and down here, then (assert() that) it is of the correct
4504 form to make it copy on write again */
4505 if ((sflags & (SVf_FAKE | SVf_READONLY))
4506 != (SVf_FAKE | SVf_READONLY)) {
4507 SvREADONLY_on(sstr);
4509 /* Make the source SV into a loop of 1.
4510 (about to become 2) */
4511 SV_COW_NEXT_SV_SET(sstr, sstr);
4515 /* Initial code is common. */
4516 if (SvPVX(dstr)) { /* we know that dtype >= SVt_PV */
4518 SvFLAGS(dstr) &= ~SVf_OOK;
4519 Safefree(SvPVX(dstr) - SvIVX(dstr));
4521 else if (SvLEN(dstr))
4522 Safefree(SvPVX(dstr));
4525 #ifdef PERL_COPY_ON_WRITE
4527 /* making another shared SV. */
4528 STRLEN cur = SvCUR(sstr);
4529 STRLEN len = SvLEN(sstr);
4530 assert (SvTYPE(dstr) >= SVt_PVIV);
4532 /* SvIsCOW_normal */
4533 /* splice us in between source and next-after-source. */
4534 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4535 SV_COW_NEXT_SV_SET(sstr, dstr);
4536 SvPV_set(dstr, SvPVX(sstr));
4538 /* SvIsCOW_shared_hash */
4539 UV hash = SvUVX(sstr);
4540 DEBUG_C(PerlIO_printf(Perl_debug_log,
4541 "Copy on write: Sharing hash\n"));
4543 sharepvn(SvPVX(sstr),
4544 (sflags & SVf_UTF8?-cur:cur), hash));
4545 SvUV_set(dstr, hash);
4547 SvLEN_set(dstr, len);
4548 SvCUR_set(dstr, cur);
4549 SvREADONLY_on(dstr);
4551 /* Relesase a global SV mutex. */
4555 { /* Passes the swipe test. */
4556 SvPV_set(dstr, SvPVX(sstr));
4557 SvLEN_set(dstr, SvLEN(sstr));
4558 SvCUR_set(dstr, SvCUR(sstr));
4561 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4562 SvPV_set(sstr, Nullch);
4568 if (sflags & SVf_UTF8)
4571 if (sflags & SVp_NOK) {
4573 if (sflags & SVf_NOK)
4574 SvFLAGS(dstr) |= SVf_NOK;
4575 SvNV_set(dstr, SvNVX(sstr));
4577 if (sflags & SVp_IOK) {
4578 (void)SvIOKp_on(dstr);
4579 if (sflags & SVf_IOK)
4580 SvFLAGS(dstr) |= SVf_IOK;
4581 if (sflags & SVf_IVisUV)
4583 SvIV_set(dstr, SvIVX(sstr));
4586 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4587 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4588 smg->mg_ptr, smg->mg_len);
4589 SvRMAGICAL_on(dstr);
4592 else if (sflags & SVp_IOK) {
4593 if (sflags & SVf_IOK)
4594 (void)SvIOK_only(dstr);
4596 (void)SvOK_off(dstr);
4597 (void)SvIOKp_on(dstr);
4599 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4600 if (sflags & SVf_IVisUV)
4602 SvIV_set(dstr, SvIVX(sstr));
4603 if (sflags & SVp_NOK) {
4604 if (sflags & SVf_NOK)
4605 (void)SvNOK_on(dstr);
4607 (void)SvNOKp_on(dstr);
4608 SvNV_set(dstr, SvNVX(sstr));
4611 else if (sflags & SVp_NOK) {
4612 if (sflags & SVf_NOK)
4613 (void)SvNOK_only(dstr);
4615 (void)SvOK_off(dstr);
4618 SvNV_set(dstr, SvNVX(sstr));
4621 if (dtype == SVt_PVGV) {
4622 if (ckWARN(WARN_MISC))
4623 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4626 (void)SvOK_off(dstr);
4628 if (SvTAINTED(sstr))
4633 =for apidoc sv_setsv_mg
4635 Like C<sv_setsv>, but also handles 'set' magic.
4641 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4643 sv_setsv(dstr,sstr);
4647 #ifdef PERL_COPY_ON_WRITE
4649 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4651 STRLEN cur = SvCUR(sstr);
4652 STRLEN len = SvLEN(sstr);
4653 register char *new_pv;
4656 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4664 if (SvTHINKFIRST(dstr))
4665 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4666 else if (SvPVX(dstr))
4667 Safefree(SvPVX(dstr));
4671 (void)SvUPGRADE (dstr, SVt_PVIV);
4673 assert (SvPOK(sstr));
4674 assert (SvPOKp(sstr));
4675 assert (!SvIOK(sstr));
4676 assert (!SvIOKp(sstr));
4677 assert (!SvNOK(sstr));
4678 assert (!SvNOKp(sstr));
4680 if (SvIsCOW(sstr)) {
4682 if (SvLEN(sstr) == 0) {
4683 /* source is a COW shared hash key. */
4684 UV hash = SvUVX(sstr);
4685 DEBUG_C(PerlIO_printf(Perl_debug_log,
4686 "Fast copy on write: Sharing hash\n"));
4687 SvUV_set(dstr, hash);
4688 new_pv = sharepvn(SvPVX(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4691 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4693 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4694 (void)SvUPGRADE (sstr, SVt_PVIV);
4695 SvREADONLY_on(sstr);
4697 DEBUG_C(PerlIO_printf(Perl_debug_log,
4698 "Fast copy on write: Converting sstr to COW\n"));
4699 SV_COW_NEXT_SV_SET(dstr, sstr);
4701 SV_COW_NEXT_SV_SET(sstr, dstr);
4702 new_pv = SvPVX(sstr);
4705 SvPV_set(dstr, new_pv);
4706 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4709 SvLEN_set(dstr, len);
4710 SvCUR_set(dstr, cur);
4719 =for apidoc sv_setpvn
4721 Copies a string into an SV. The C<len> parameter indicates the number of
4722 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4723 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4729 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4731 register char *dptr;
4733 SV_CHECK_THINKFIRST_COW_DROP(sv);
4739 /* len is STRLEN which is unsigned, need to copy to signed */
4742 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4744 (void)SvUPGRADE(sv, SVt_PV);
4746 SvGROW(sv, len + 1);
4748 Move(ptr,dptr,len,char);
4751 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4756 =for apidoc sv_setpvn_mg
4758 Like C<sv_setpvn>, but also handles 'set' magic.
4764 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4766 sv_setpvn(sv,ptr,len);
4771 =for apidoc sv_setpv
4773 Copies a string into an SV. The string must be null-terminated. Does not
4774 handle 'set' magic. See C<sv_setpv_mg>.
4780 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4782 register STRLEN len;
4784 SV_CHECK_THINKFIRST_COW_DROP(sv);
4790 (void)SvUPGRADE(sv, SVt_PV);
4792 SvGROW(sv, len + 1);
4793 Move(ptr,SvPVX(sv),len+1,char);
4795 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4800 =for apidoc sv_setpv_mg
4802 Like C<sv_setpv>, but also handles 'set' magic.
4808 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4815 =for apidoc sv_usepvn
4817 Tells an SV to use C<ptr> to find its string value. Normally the string is
4818 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4819 The C<ptr> should point to memory that was allocated by C<malloc>. The
4820 string length, C<len>, must be supplied. This function will realloc the
4821 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4822 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4823 See C<sv_usepvn_mg>.
4829 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4831 SV_CHECK_THINKFIRST_COW_DROP(sv);
4832 (void)SvUPGRADE(sv, SVt_PV);
4837 (void)SvOOK_off(sv);
4838 if (SvPVX(sv) && SvLEN(sv))
4839 Safefree(SvPVX(sv));
4840 Renew(ptr, len+1, char);
4843 SvLEN_set(sv, len+1);
4845 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4850 =for apidoc sv_usepvn_mg
4852 Like C<sv_usepvn>, but also handles 'set' magic.
4858 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4860 sv_usepvn(sv,ptr,len);
4864 #ifdef PERL_COPY_ON_WRITE
4865 /* Need to do this *after* making the SV normal, as we need the buffer
4866 pointer to remain valid until after we've copied it. If we let go too early,
4867 another thread could invalidate it by unsharing last of the same hash key
4868 (which it can do by means other than releasing copy-on-write Svs)
4869 or by changing the other copy-on-write SVs in the loop. */
4871 S_sv_release_COW(pTHX_ register SV *sv, char *pvx, STRLEN cur, STRLEN len,
4872 U32 hash, SV *after)
4874 if (len) { /* this SV was SvIsCOW_normal(sv) */
4875 /* we need to find the SV pointing to us. */
4876 SV *current = SV_COW_NEXT_SV(after);
4878 if (current == sv) {
4879 /* The SV we point to points back to us (there were only two of us
4881 Hence other SV is no longer copy on write either. */
4883 SvREADONLY_off(after);
4885 /* We need to follow the pointers around the loop. */
4887 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4890 /* don't loop forever if the structure is bust, and we have
4891 a pointer into a closed loop. */
4892 assert (current != after);
4893 assert (SvPVX(current) == pvx);
4895 /* Make the SV before us point to the SV after us. */
4896 SV_COW_NEXT_SV_SET(current, after);
4899 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4904 Perl_sv_release_IVX(pTHX_ register SV *sv)
4907 sv_force_normal_flags(sv, 0);
4913 =for apidoc sv_force_normal_flags
4915 Undo various types of fakery on an SV: if the PV is a shared string, make
4916 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4917 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4918 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4919 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4920 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4921 set to some other value.) In addition, the C<flags> parameter gets passed to
4922 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4923 with flags set to 0.
4929 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4931 #ifdef PERL_COPY_ON_WRITE
4932 if (SvREADONLY(sv)) {
4933 /* At this point I believe I should acquire a global SV mutex. */
4935 char *pvx = SvPVX(sv);
4936 STRLEN len = SvLEN(sv);
4937 STRLEN cur = SvCUR(sv);
4938 U32 hash = SvUVX(sv);
4939 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4941 PerlIO_printf(Perl_debug_log,
4942 "Copy on write: Force normal %ld\n",
4948 /* This SV doesn't own the buffer, so need to New() a new one: */
4949 SvPV_set(sv, (char*)0);
4951 if (flags & SV_COW_DROP_PV) {
4952 /* OK, so we don't need to copy our buffer. */
4955 SvGROW(sv, cur + 1);
4956 Move(pvx,SvPVX(sv),cur,char);
4960 sv_release_COW(sv, pvx, cur, len, hash, next);
4965 else if (IN_PERL_RUNTIME)
4966 Perl_croak(aTHX_ PL_no_modify);
4967 /* At this point I believe that I can drop the global SV mutex. */
4970 if (SvREADONLY(sv)) {
4972 char *pvx = SvPVX(sv);
4973 int is_utf8 = SvUTF8(sv);
4974 STRLEN len = SvCUR(sv);
4975 U32 hash = SvUVX(sv);
4978 SvPV_set(sv, (char*)0);
4980 SvGROW(sv, len + 1);
4981 Move(pvx,SvPVX(sv),len,char);
4983 unsharepvn(pvx, is_utf8 ? -(I32)len : len, hash);
4985 else if (IN_PERL_RUNTIME)
4986 Perl_croak(aTHX_ PL_no_modify);
4990 sv_unref_flags(sv, flags);
4991 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4996 =for apidoc sv_force_normal
4998 Undo various types of fakery on an SV: if the PV is a shared string, make
4999 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5000 an xpvmg. See also C<sv_force_normal_flags>.
5006 Perl_sv_force_normal(pTHX_ register SV *sv)
5008 sv_force_normal_flags(sv, 0);
5014 Efficient removal of characters from the beginning of the string buffer.
5015 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5016 the string buffer. The C<ptr> becomes the first character of the adjusted
5017 string. Uses the "OOK hack".
5018 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
5019 refer to the same chunk of data.
5025 Perl_sv_chop(pTHX_ register SV *sv, register char *ptr)
5027 register STRLEN delta;
5028 if (!ptr || !SvPOKp(sv))
5030 delta = ptr - SvPVX(sv);
5031 SV_CHECK_THINKFIRST(sv);
5032 if (SvTYPE(sv) < SVt_PVIV)
5033 sv_upgrade(sv,SVt_PVIV);
5036 if (!SvLEN(sv)) { /* make copy of shared string */
5037 char *pvx = SvPVX(sv);
5038 STRLEN len = SvCUR(sv);
5039 SvGROW(sv, len + 1);
5040 Move(pvx,SvPVX(sv),len,char);
5044 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
5045 and we do that anyway inside the SvNIOK_off
5047 SvFLAGS(sv) |= SVf_OOK;
5050 SvLEN_set(sv, SvLEN(sv) - delta);
5051 SvCUR_set(sv, SvCUR(sv) - delta);
5052 SvPV_set(sv, SvPVX(sv) + delta);
5053 SvIV_set(sv, SvIVX(sv) + delta);
5056 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
5057 * this function provided for binary compatibility only
5061 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
5063 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
5067 =for apidoc sv_catpvn
5069 Concatenates the string onto the end of the string which is in the SV. The
5070 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5071 status set, then the bytes appended should be valid UTF-8.
5072 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5074 =for apidoc sv_catpvn_flags
5076 Concatenates the string onto the end of the string which is in the SV. The
5077 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5078 status set, then the bytes appended should be valid UTF-8.
5079 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5080 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5081 in terms of this function.
5087 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
5092 dstr = SvPV_force_flags(dsv, dlen, flags);
5093 SvGROW(dsv, dlen + slen + 1);
5096 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5097 SvCUR_set(dsv, SvCUR(dsv) + slen);
5099 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5104 =for apidoc sv_catpvn_mg
5106 Like C<sv_catpvn>, but also handles 'set' magic.
5112 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
5114 sv_catpvn(sv,ptr,len);
5118 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
5119 * this function provided for binary compatibility only
5123 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
5125 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
5129 =for apidoc sv_catsv
5131 Concatenates the string from SV C<ssv> onto the end of the string in
5132 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5133 not 'set' magic. See C<sv_catsv_mg>.
5135 =for apidoc sv_catsv_flags
5137 Concatenates the string from SV C<ssv> onto the end of the string in
5138 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5139 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5140 and C<sv_catsv_nomg> are implemented in terms of this function.
5145 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
5151 if ((spv = SvPV(ssv, slen))) {
5152 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
5153 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
5154 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
5155 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
5156 dsv->sv_flags doesn't have that bit set.
5157 Andy Dougherty 12 Oct 2001
5159 I32 sutf8 = DO_UTF8(ssv);
5162 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5164 dutf8 = DO_UTF8(dsv);
5166 if (dutf8 != sutf8) {
5168 /* Not modifying source SV, so taking a temporary copy. */
5169 SV* csv = sv_2mortal(newSVpvn(spv, slen));
5171 sv_utf8_upgrade(csv);
5172 spv = SvPV(csv, slen);
5175 sv_utf8_upgrade_nomg(dsv);
5177 sv_catpvn_nomg(dsv, spv, slen);
5182 =for apidoc sv_catsv_mg
5184 Like C<sv_catsv>, but also handles 'set' magic.
5190 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
5197 =for apidoc sv_catpv
5199 Concatenates the string onto the end of the string which is in the SV.
5200 If the SV has the UTF-8 status set, then the bytes appended should be
5201 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5206 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
5208 register STRLEN len;
5214 junk = SvPV_force(sv, tlen);
5216 SvGROW(sv, tlen + len + 1);
5219 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5220 SvCUR_set(sv, SvCUR(sv) + len);
5221 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5226 =for apidoc sv_catpv_mg
5228 Like C<sv_catpv>, but also handles 'set' magic.
5234 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
5243 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
5244 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
5251 Perl_newSV(pTHX_ STRLEN len)
5257 sv_upgrade(sv, SVt_PV);
5258 SvGROW(sv, len + 1);
5263 =for apidoc sv_magicext
5265 Adds magic to an SV, upgrading it if necessary. Applies the
5266 supplied vtable and returns a pointer to the magic added.
5268 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5269 In particular, you can add magic to SvREADONLY SVs, and add more than
5270 one instance of the same 'how'.
5272 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5273 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5274 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5275 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5277 (This is now used as a subroutine by C<sv_magic>.)
5282 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
5283 const char* name, I32 namlen)
5287 if (SvTYPE(sv) < SVt_PVMG) {
5288 (void)SvUPGRADE(sv, SVt_PVMG);
5290 Newz(702,mg, 1, MAGIC);
5291 mg->mg_moremagic = SvMAGIC(sv);
5292 SvMAGIC_set(sv, mg);
5294 /* Sometimes a magic contains a reference loop, where the sv and
5295 object refer to each other. To prevent a reference loop that
5296 would prevent such objects being freed, we look for such loops
5297 and if we find one we avoid incrementing the object refcount.
5299 Note we cannot do this to avoid self-tie loops as intervening RV must
5300 have its REFCNT incremented to keep it in existence.
5303 if (!obj || obj == sv ||
5304 how == PERL_MAGIC_arylen ||
5305 how == PERL_MAGIC_qr ||
5306 (SvTYPE(obj) == SVt_PVGV &&
5307 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
5308 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
5309 GvFORM(obj) == (CV*)sv)))
5314 mg->mg_obj = SvREFCNT_inc(obj);
5315 mg->mg_flags |= MGf_REFCOUNTED;
5318 /* Normal self-ties simply pass a null object, and instead of
5319 using mg_obj directly, use the SvTIED_obj macro to produce a
5320 new RV as needed. For glob "self-ties", we are tieing the PVIO
5321 with an RV obj pointing to the glob containing the PVIO. In
5322 this case, to avoid a reference loop, we need to weaken the
5326 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5327 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
5333 mg->mg_len = namlen;
5336 mg->mg_ptr = savepvn(name, namlen);
5337 else if (namlen == HEf_SVKEY)
5338 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
5340 mg->mg_ptr = (char *) name;
5342 mg->mg_virtual = vtable;
5346 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5351 =for apidoc sv_magic
5353 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5354 then adds a new magic item of type C<how> to the head of the magic list.
5356 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5357 handling of the C<name> and C<namlen> arguments.
5359 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5360 to add more than one instance of the same 'how'.
5366 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
5368 const MGVTBL *vtable = 0;
5371 #ifdef PERL_COPY_ON_WRITE
5373 sv_force_normal_flags(sv, 0);
5375 if (SvREADONLY(sv)) {
5377 && how != PERL_MAGIC_regex_global
5378 && how != PERL_MAGIC_bm
5379 && how != PERL_MAGIC_fm
5380 && how != PERL_MAGIC_sv
5381 && how != PERL_MAGIC_backref
5384 Perl_croak(aTHX_ PL_no_modify);
5387 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5388 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5389 /* sv_magic() refuses to add a magic of the same 'how' as an
5392 if (how == PERL_MAGIC_taint)
5400 vtable = &PL_vtbl_sv;
5402 case PERL_MAGIC_overload:
5403 vtable = &PL_vtbl_amagic;
5405 case PERL_MAGIC_overload_elem:
5406 vtable = &PL_vtbl_amagicelem;
5408 case PERL_MAGIC_overload_table:
5409 vtable = &PL_vtbl_ovrld;
5412 vtable = &PL_vtbl_bm;
5414 case PERL_MAGIC_regdata:
5415 vtable = &PL_vtbl_regdata;
5417 case PERL_MAGIC_regdatum:
5418 vtable = &PL_vtbl_regdatum;
5420 case PERL_MAGIC_env:
5421 vtable = &PL_vtbl_env;
5424 vtable = &PL_vtbl_fm;
5426 case PERL_MAGIC_envelem:
5427 vtable = &PL_vtbl_envelem;
5429 case PERL_MAGIC_regex_global:
5430 vtable = &PL_vtbl_mglob;
5432 case PERL_MAGIC_isa:
5433 vtable = &PL_vtbl_isa;
5435 case PERL_MAGIC_isaelem:
5436 vtable = &PL_vtbl_isaelem;
5438 case PERL_MAGIC_nkeys:
5439 vtable = &PL_vtbl_nkeys;
5441 case PERL_MAGIC_dbfile:
5444 case PERL_MAGIC_dbline:
5445 vtable = &PL_vtbl_dbline;
5447 #ifdef USE_LOCALE_COLLATE
5448 case PERL_MAGIC_collxfrm:
5449 vtable = &PL_vtbl_collxfrm;
5451 #endif /* USE_LOCALE_COLLATE */
5452 case PERL_MAGIC_tied:
5453 vtable = &PL_vtbl_pack;
5455 case PERL_MAGIC_tiedelem:
5456 case PERL_MAGIC_tiedscalar:
5457 vtable = &PL_vtbl_packelem;
5460 vtable = &PL_vtbl_regexp;
5462 case PERL_MAGIC_sig:
5463 vtable = &PL_vtbl_sig;
5465 case PERL_MAGIC_sigelem:
5466 vtable = &PL_vtbl_sigelem;
5468 case PERL_MAGIC_taint:
5469 vtable = &PL_vtbl_taint;
5471 case PERL_MAGIC_uvar:
5472 vtable = &PL_vtbl_uvar;
5474 case PERL_MAGIC_vec:
5475 vtable = &PL_vtbl_vec;
5477 case PERL_MAGIC_vstring:
5480 case PERL_MAGIC_utf8:
5481 vtable = &PL_vtbl_utf8;
5483 case PERL_MAGIC_substr:
5484 vtable = &PL_vtbl_substr;
5486 case PERL_MAGIC_defelem:
5487 vtable = &PL_vtbl_defelem;
5489 case PERL_MAGIC_glob:
5490 vtable = &PL_vtbl_glob;
5492 case PERL_MAGIC_arylen:
5493 vtable = &PL_vtbl_arylen;
5495 case PERL_MAGIC_pos:
5496 vtable = &PL_vtbl_pos;
5498 case PERL_MAGIC_backref:
5499 vtable = &PL_vtbl_backref;
5501 case PERL_MAGIC_ext:
5502 /* Reserved for use by extensions not perl internals. */
5503 /* Useful for attaching extension internal data to perl vars. */
5504 /* Note that multiple extensions may clash if magical scalars */
5505 /* etc holding private data from one are passed to another. */
5508 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5511 /* Rest of work is done else where */
5512 mg = sv_magicext(sv,obj,how,(MGVTBL*)vtable,name,namlen);
5515 case PERL_MAGIC_taint:
5518 case PERL_MAGIC_ext:
5519 case PERL_MAGIC_dbfile:
5526 =for apidoc sv_unmagic
5528 Removes all magic of type C<type> from an SV.
5534 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5538 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5541 for (mg = *mgp; mg; mg = *mgp) {
5542 if (mg->mg_type == type) {
5543 const MGVTBL* const vtbl = mg->mg_virtual;
5544 *mgp = mg->mg_moremagic;
5545 if (vtbl && vtbl->svt_free)
5546 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5547 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5549 Safefree(mg->mg_ptr);
5550 else if (mg->mg_len == HEf_SVKEY)
5551 SvREFCNT_dec((SV*)mg->mg_ptr);
5552 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5553 Safefree(mg->mg_ptr);
5555 if (mg->mg_flags & MGf_REFCOUNTED)
5556 SvREFCNT_dec(mg->mg_obj);
5560 mgp = &mg->mg_moremagic;
5564 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5571 =for apidoc sv_rvweaken
5573 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5574 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5575 push a back-reference to this RV onto the array of backreferences
5576 associated with that magic.
5582 Perl_sv_rvweaken(pTHX_ SV *sv)
5585 if (!SvOK(sv)) /* let undefs pass */
5588 Perl_croak(aTHX_ "Can't weaken a nonreference");
5589 else if (SvWEAKREF(sv)) {
5590 if (ckWARN(WARN_MISC))
5591 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5595 sv_add_backref(tsv, sv);
5601 /* Give tsv backref magic if it hasn't already got it, then push a
5602 * back-reference to sv onto the array associated with the backref magic.
5606 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5610 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5611 av = (AV*)mg->mg_obj;
5614 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5615 /* av now has a refcnt of 2, which avoids it getting freed
5616 * before us during global cleanup. The extra ref is removed
5617 * by magic_killbackrefs() when tsv is being freed */
5619 if (AvFILLp(av) >= AvMAX(av)) {
5621 SV **svp = AvARRAY(av);
5622 for (i = AvFILLp(av); i >= 0; i--)
5624 svp[i] = sv; /* reuse the slot */
5627 av_extend(av, AvFILLp(av)+1);
5629 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5632 /* delete a back-reference to ourselves from the backref magic associated
5633 * with the SV we point to.
5637 S_sv_del_backref(pTHX_ SV *sv)
5644 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5645 Perl_croak(aTHX_ "panic: del_backref");
5646 av = (AV *)mg->mg_obj;
5648 for (i = AvFILLp(av); i >= 0; i--)
5649 if (svp[i] == sv) svp[i] = Nullsv;
5653 =for apidoc sv_insert
5655 Inserts a string at the specified offset/length within the SV. Similar to
5656 the Perl substr() function.
5662 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5666 register char *midend;
5667 register char *bigend;
5673 Perl_croak(aTHX_ "Can't modify non-existent substring");
5674 SvPV_force(bigstr, curlen);
5675 (void)SvPOK_only_UTF8(bigstr);
5676 if (offset + len > curlen) {
5677 SvGROW(bigstr, offset+len+1);
5678 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5679 SvCUR_set(bigstr, offset+len);
5683 i = littlelen - len;
5684 if (i > 0) { /* string might grow */
5685 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5686 mid = big + offset + len;
5687 midend = bigend = big + SvCUR(bigstr);
5690 while (midend > mid) /* shove everything down */
5691 *--bigend = *--midend;
5692 Move(little,big+offset,littlelen,char);
5693 SvCUR_set(bigstr, SvCUR(bigstr) + i);
5698 Move(little,SvPVX(bigstr)+offset,len,char);
5703 big = SvPVX(bigstr);
5706 bigend = big + SvCUR(bigstr);
5708 if (midend > bigend)
5709 Perl_croak(aTHX_ "panic: sv_insert");
5711 if (mid - big > bigend - midend) { /* faster to shorten from end */
5713 Move(little, mid, littlelen,char);
5716 i = bigend - midend;
5718 Move(midend, mid, i,char);
5722 SvCUR_set(bigstr, mid - big);
5725 else if ((i = mid - big)) { /* faster from front */
5726 midend -= littlelen;
5728 sv_chop(bigstr,midend-i);
5733 Move(little, mid, littlelen,char);
5735 else if (littlelen) {
5736 midend -= littlelen;
5737 sv_chop(bigstr,midend);
5738 Move(little,midend,littlelen,char);
5741 sv_chop(bigstr,midend);
5747 =for apidoc sv_replace
5749 Make the first argument a copy of the second, then delete the original.
5750 The target SV physically takes over ownership of the body of the source SV
5751 and inherits its flags; however, the target keeps any magic it owns,
5752 and any magic in the source is discarded.
5753 Note that this is a rather specialist SV copying operation; most of the
5754 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5760 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5762 U32 refcnt = SvREFCNT(sv);
5763 SV_CHECK_THINKFIRST_COW_DROP(sv);
5764 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5765 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5766 if (SvMAGICAL(sv)) {
5770 sv_upgrade(nsv, SVt_PVMG);
5771 SvMAGIC_set(nsv, SvMAGIC(sv));
5772 SvFLAGS(nsv) |= SvMAGICAL(sv);
5774 SvMAGIC_set(sv, NULL);
5778 assert(!SvREFCNT(sv));
5779 #ifdef DEBUG_LEAKING_SCALARS
5780 sv->sv_flags = nsv->sv_flags;
5781 sv->sv_any = nsv->sv_any;
5782 sv->sv_refcnt = nsv->sv_refcnt;
5784 StructCopy(nsv,sv,SV);
5787 #ifdef PERL_COPY_ON_WRITE
5788 if (SvIsCOW_normal(nsv)) {
5789 /* We need to follow the pointers around the loop to make the
5790 previous SV point to sv, rather than nsv. */
5793 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5796 assert(SvPVX(current) == SvPVX(nsv));
5798 /* Make the SV before us point to the SV after us. */
5800 PerlIO_printf(Perl_debug_log, "previous is\n");
5802 PerlIO_printf(Perl_debug_log,
5803 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5804 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5806 SV_COW_NEXT_SV_SET(current, sv);
5809 SvREFCNT(sv) = refcnt;
5810 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5816 =for apidoc sv_clear
5818 Clear an SV: call any destructors, free up any memory used by the body,
5819 and free the body itself. The SV's head is I<not> freed, although
5820 its type is set to all 1's so that it won't inadvertently be assumed
5821 to be live during global destruction etc.
5822 This function should only be called when REFCNT is zero. Most of the time
5823 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5830 Perl_sv_clear(pTHX_ register SV *sv)
5835 assert(SvREFCNT(sv) == 0);
5838 if (PL_defstash) { /* Still have a symbol table? */
5845 stash = SvSTASH(sv);
5846 destructor = StashHANDLER(stash,DESTROY);
5848 SV* tmpref = newRV(sv);
5849 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5851 PUSHSTACKi(PERLSI_DESTROY);
5856 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5862 if(SvREFCNT(tmpref) < 2) {
5863 /* tmpref is not kept alive! */
5865 SvRV_set(tmpref, NULL);
5868 SvREFCNT_dec(tmpref);
5870 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5874 if (PL_in_clean_objs)
5875 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5877 /* DESTROY gave object new lease on life */
5883 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5884 SvOBJECT_off(sv); /* Curse the object. */
5885 if (SvTYPE(sv) != SVt_PVIO)
5886 --PL_sv_objcount; /* XXX Might want something more general */
5889 if (SvTYPE(sv) >= SVt_PVMG) {
5892 if (SvFLAGS(sv) & SVpad_TYPED)
5893 SvREFCNT_dec(SvSTASH(sv));
5896 switch (SvTYPE(sv)) {
5899 IoIFP(sv) != PerlIO_stdin() &&
5900 IoIFP(sv) != PerlIO_stdout() &&
5901 IoIFP(sv) != PerlIO_stderr())
5903 io_close((IO*)sv, FALSE);
5905 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5906 PerlDir_close(IoDIRP(sv));
5907 IoDIRP(sv) = (DIR*)NULL;
5908 Safefree(IoTOP_NAME(sv));
5909 Safefree(IoFMT_NAME(sv));
5910 Safefree(IoBOTTOM_NAME(sv));
5925 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5926 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5927 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5928 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5930 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5931 SvREFCNT_dec(LvTARG(sv));
5935 Safefree(GvNAME(sv));
5936 /* cannot decrease stash refcount yet, as we might recursively delete
5937 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5938 of stash until current sv is completely gone.
5939 -- JohnPC, 27 Mar 1998 */
5940 stash = GvSTASH(sv);
5954 SvREFCNT_dec(SvRV(sv));
5956 #ifdef PERL_COPY_ON_WRITE
5957 else if (SvPVX(sv)) {
5959 /* I believe I need to grab the global SV mutex here and
5960 then recheck the COW status. */
5962 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
5965 sv_release_COW(sv, SvPVX(sv), SvCUR(sv), SvLEN(sv),
5966 SvUVX(sv), SV_COW_NEXT_SV(sv));
5967 /* And drop it here. */
5969 } else if (SvLEN(sv)) {
5970 Safefree(SvPVX(sv));
5974 else if (SvPVX(sv) && SvLEN(sv))
5975 Safefree(SvPVX(sv));
5976 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5977 unsharepvn(SvPVX(sv),
5978 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5992 switch (SvTYPE(sv)) {
6008 del_XPVIV(SvANY(sv));
6011 del_XPVNV(SvANY(sv));
6014 del_XPVMG(SvANY(sv));
6017 del_XPVLV(SvANY(sv));
6020 del_XPVAV(SvANY(sv));
6023 del_XPVHV(SvANY(sv));
6026 del_XPVCV(SvANY(sv));
6029 del_XPVGV(SvANY(sv));
6030 /* code duplication for increased performance. */
6031 SvFLAGS(sv) &= SVf_BREAK;
6032 SvFLAGS(sv) |= SVTYPEMASK;
6033 /* decrease refcount of the stash that owns this GV, if any */
6035 SvREFCNT_dec(stash);
6036 return; /* not break, SvFLAGS reset already happened */
6038 del_XPVBM(SvANY(sv));
6041 del_XPVFM(SvANY(sv));
6044 del_XPVIO(SvANY(sv));
6047 SvFLAGS(sv) &= SVf_BREAK;
6048 SvFLAGS(sv) |= SVTYPEMASK;
6052 =for apidoc sv_newref
6054 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6061 Perl_sv_newref(pTHX_ SV *sv)
6071 Decrement an SV's reference count, and if it drops to zero, call
6072 C<sv_clear> to invoke destructors and free up any memory used by
6073 the body; finally, deallocate the SV's head itself.
6074 Normally called via a wrapper macro C<SvREFCNT_dec>.
6080 Perl_sv_free(pTHX_ SV *sv)
6085 if (SvREFCNT(sv) == 0) {
6086 if (SvFLAGS(sv) & SVf_BREAK)
6087 /* this SV's refcnt has been artificially decremented to
6088 * trigger cleanup */
6090 if (PL_in_clean_all) /* All is fair */
6092 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6093 /* make sure SvREFCNT(sv)==0 happens very seldom */
6094 SvREFCNT(sv) = (~(U32)0)/2;
6097 if (ckWARN_d(WARN_INTERNAL))
6098 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6099 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6100 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6103 if (--(SvREFCNT(sv)) > 0)
6105 Perl_sv_free2(aTHX_ sv);
6109 Perl_sv_free2(pTHX_ SV *sv)
6114 if (ckWARN_d(WARN_DEBUGGING))
6115 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
6116 "Attempt to free temp prematurely: SV 0x%"UVxf
6117 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6121 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6122 /* make sure SvREFCNT(sv)==0 happens very seldom */
6123 SvREFCNT(sv) = (~(U32)0)/2;
6134 Returns the length of the string in the SV. Handles magic and type
6135 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6141 Perl_sv_len(pTHX_ register SV *sv)
6149 len = mg_length(sv);
6151 (void)SvPV(sv, len);
6156 =for apidoc sv_len_utf8
6158 Returns the number of characters in the string in an SV, counting wide
6159 UTF-8 bytes as a single character. Handles magic and type coercion.
6165 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
6166 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
6167 * (Note that the mg_len is not the length of the mg_ptr field.)
6172 Perl_sv_len_utf8(pTHX_ register SV *sv)
6178 return mg_length(sv);
6182 U8 *s = (U8*)SvPV(sv, len);
6183 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
6185 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
6187 #ifdef PERL_UTF8_CACHE_ASSERT
6188 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
6192 ulen = Perl_utf8_length(aTHX_ s, s + len);
6193 if (!mg && !SvREADONLY(sv)) {
6194 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6195 mg = mg_find(sv, PERL_MAGIC_utf8);
6205 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
6206 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6207 * between UTF-8 and byte offsets. There are two (substr offset and substr
6208 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
6209 * and byte offset) cache positions.
6211 * The mg_len field is used by sv_len_utf8(), see its comments.
6212 * Note that the mg_len is not the length of the mg_ptr field.
6216 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, U8 *s, U8 *start)
6220 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6222 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
6226 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6228 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6229 (*mgp)->mg_ptr = (char *) *cachep;
6233 (*cachep)[i] = *offsetp;
6234 (*cachep)[i+1] = s - start;
6242 * S_utf8_mg_pos() is used to query and update mg_ptr field of
6243 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6244 * between UTF-8 and byte offsets. See also the comments of
6245 * S_utf8_mg_pos_init().
6249 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
6253 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6255 *mgp = mg_find(sv, PERL_MAGIC_utf8);
6256 if (*mgp && (*mgp)->mg_ptr) {
6257 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6258 ASSERT_UTF8_CACHE(*cachep);
6259 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
6261 else { /* We will skip to the right spot. */
6266 /* The assumption is that going backward is half
6267 * the speed of going forward (that's where the
6268 * 2 * backw in the below comes from). (The real
6269 * figure of course depends on the UTF-8 data.) */
6271 if ((*cachep)[i] > (STRLEN)uoff) {
6273 backw = (*cachep)[i] - (STRLEN)uoff;
6275 if (forw < 2 * backw)
6278 p = start + (*cachep)[i+1];
6280 /* Try this only for the substr offset (i == 0),
6281 * not for the substr length (i == 2). */
6282 else if (i == 0) { /* (*cachep)[i] < uoff */
6283 STRLEN ulen = sv_len_utf8(sv);
6285 if ((STRLEN)uoff < ulen) {
6286 forw = (STRLEN)uoff - (*cachep)[i];
6287 backw = ulen - (STRLEN)uoff;
6289 if (forw < 2 * backw)
6290 p = start + (*cachep)[i+1];
6295 /* If the string is not long enough for uoff,
6296 * we could extend it, but not at this low a level. */
6300 if (forw < 2 * backw) {
6307 while (UTF8_IS_CONTINUATION(*p))
6312 /* Update the cache. */
6313 (*cachep)[i] = (STRLEN)uoff;
6314 (*cachep)[i+1] = p - start;
6316 /* Drop the stale "length" cache */
6325 if (found) { /* Setup the return values. */
6326 *offsetp = (*cachep)[i+1];
6327 *sp = start + *offsetp;
6330 *offsetp = send - start;
6332 else if (*sp < start) {
6338 #ifdef PERL_UTF8_CACHE_ASSERT
6343 while (n-- && s < send)
6347 assert(*offsetp == s - start);
6348 assert((*cachep)[0] == (STRLEN)uoff);
6349 assert((*cachep)[1] == *offsetp);
6351 ASSERT_UTF8_CACHE(*cachep);
6360 =for apidoc sv_pos_u2b
6362 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6363 the start of the string, to a count of the equivalent number of bytes; if
6364 lenp is non-zero, it does the same to lenp, but this time starting from
6365 the offset, rather than from the start of the string. Handles magic and
6372 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6373 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6374 * byte offsets. See also the comments of S_utf8_mg_pos().
6379 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6390 start = s = (U8*)SvPV(sv, len);
6392 I32 uoffset = *offsetp;
6397 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6399 if (!found && uoffset > 0) {
6400 while (s < send && uoffset--)
6404 if (utf8_mg_pos_init(sv, &mg, &cache, 0, offsetp, s, start))
6406 *offsetp = s - start;
6411 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
6415 if (!found && *lenp > 0) {
6418 while (s < send && ulen--)
6422 utf8_mg_pos_init(sv, &mg, &cache, 2, lenp, s, start);
6426 ASSERT_UTF8_CACHE(cache);
6438 =for apidoc sv_pos_b2u
6440 Converts the value pointed to by offsetp from a count of bytes from the
6441 start of the string, to a count of the equivalent number of UTF-8 chars.
6442 Handles magic and type coercion.
6448 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6449 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6450 * byte offsets. See also the comments of S_utf8_mg_pos().
6455 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6463 s = (U8*)SvPV(sv, len);
6464 if ((I32)len < *offsetp)
6465 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6467 U8* send = s + *offsetp;
6469 STRLEN *cache = NULL;
6473 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6474 mg = mg_find(sv, PERL_MAGIC_utf8);
6475 if (mg && mg->mg_ptr) {
6476 cache = (STRLEN *) mg->mg_ptr;
6477 if (cache[1] == (STRLEN)*offsetp) {
6478 /* An exact match. */
6479 *offsetp = cache[0];
6483 else if (cache[1] < (STRLEN)*offsetp) {
6484 /* We already know part of the way. */
6487 /* Let the below loop do the rest. */
6489 else { /* cache[1] > *offsetp */
6490 /* We already know all of the way, now we may
6491 * be able to walk back. The same assumption
6492 * is made as in S_utf8_mg_pos(), namely that
6493 * walking backward is twice slower than
6494 * walking forward. */
6495 STRLEN forw = *offsetp;
6496 STRLEN backw = cache[1] - *offsetp;
6498 if (!(forw < 2 * backw)) {
6499 U8 *p = s + cache[1];
6506 while (UTF8_IS_CONTINUATION(*p)) {
6514 *offsetp = cache[0];
6516 /* Drop the stale "length" cache */
6524 ASSERT_UTF8_CACHE(cache);
6530 /* Call utf8n_to_uvchr() to validate the sequence
6531 * (unless a simple non-UTF character) */
6532 if (!UTF8_IS_INVARIANT(*s))
6533 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6542 if (!SvREADONLY(sv)) {
6544 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6545 mg = mg_find(sv, PERL_MAGIC_utf8);
6550 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6551 mg->mg_ptr = (char *) cache;
6556 cache[1] = *offsetp;
6557 /* Drop the stale "length" cache */
6570 Returns a boolean indicating whether the strings in the two SVs are
6571 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6572 coerce its args to strings if necessary.
6578 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6586 SV* svrecode = Nullsv;
6593 pv1 = SvPV(sv1, cur1);
6600 pv2 = SvPV(sv2, cur2);
6602 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6603 /* Differing utf8ness.
6604 * Do not UTF8size the comparands as a side-effect. */
6607 svrecode = newSVpvn(pv2, cur2);
6608 sv_recode_to_utf8(svrecode, PL_encoding);
6609 pv2 = SvPV(svrecode, cur2);
6612 svrecode = newSVpvn(pv1, cur1);
6613 sv_recode_to_utf8(svrecode, PL_encoding);
6614 pv1 = SvPV(svrecode, cur1);
6616 /* Now both are in UTF-8. */
6618 SvREFCNT_dec(svrecode);
6623 bool is_utf8 = TRUE;
6626 /* sv1 is the UTF-8 one,
6627 * if is equal it must be downgrade-able */
6628 char *pv = (char*)bytes_from_utf8((const U8*)pv1,
6634 /* sv2 is the UTF-8 one,
6635 * if is equal it must be downgrade-able */
6636 char *pv = (char *)bytes_from_utf8((const U8*)pv2,
6642 /* Downgrade not possible - cannot be eq */
6650 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6653 SvREFCNT_dec(svrecode);
6664 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6665 string in C<sv1> is less than, equal to, or greater than the string in
6666 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6667 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6673 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6676 const char *pv1, *pv2;
6679 SV *svrecode = Nullsv;
6686 pv1 = SvPV(sv1, cur1);
6693 pv2 = SvPV(sv2, cur2);
6695 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6696 /* Differing utf8ness.
6697 * Do not UTF8size the comparands as a side-effect. */
6700 svrecode = newSVpvn(pv2, cur2);
6701 sv_recode_to_utf8(svrecode, PL_encoding);
6702 pv2 = SvPV(svrecode, cur2);
6705 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6710 svrecode = newSVpvn(pv1, cur1);
6711 sv_recode_to_utf8(svrecode, PL_encoding);
6712 pv1 = SvPV(svrecode, cur1);
6715 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6721 cmp = cur2 ? -1 : 0;
6725 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6728 cmp = retval < 0 ? -1 : 1;
6729 } else if (cur1 == cur2) {
6732 cmp = cur1 < cur2 ? -1 : 1;
6737 SvREFCNT_dec(svrecode);
6746 =for apidoc sv_cmp_locale
6748 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6749 'use bytes' aware, handles get magic, and will coerce its args to strings
6750 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6756 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6758 #ifdef USE_LOCALE_COLLATE
6764 if (PL_collation_standard)
6768 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6770 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6772 if (!pv1 || !len1) {
6783 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6786 return retval < 0 ? -1 : 1;
6789 * When the result of collation is equality, that doesn't mean
6790 * that there are no differences -- some locales exclude some
6791 * characters from consideration. So to avoid false equalities,
6792 * we use the raw string as a tiebreaker.
6798 #endif /* USE_LOCALE_COLLATE */
6800 return sv_cmp(sv1, sv2);
6804 #ifdef USE_LOCALE_COLLATE
6807 =for apidoc sv_collxfrm
6809 Add Collate Transform magic to an SV if it doesn't already have it.
6811 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6812 scalar data of the variable, but transformed to such a format that a normal
6813 memory comparison can be used to compare the data according to the locale
6820 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6824 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6825 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6830 Safefree(mg->mg_ptr);
6832 if ((xf = mem_collxfrm(s, len, &xlen))) {
6833 if (SvREADONLY(sv)) {
6836 return xf + sizeof(PL_collation_ix);
6839 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6840 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6853 if (mg && mg->mg_ptr) {
6855 return mg->mg_ptr + sizeof(PL_collation_ix);
6863 #endif /* USE_LOCALE_COLLATE */
6868 Get a line from the filehandle and store it into the SV, optionally
6869 appending to the currently-stored string.
6875 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6879 register STDCHAR rslast;
6880 register STDCHAR *bp;
6886 if (SvTHINKFIRST(sv))
6887 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6888 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6890 However, perlbench says it's slower, because the existing swipe code
6891 is faster than copy on write.
6892 Swings and roundabouts. */
6893 (void)SvUPGRADE(sv, SVt_PV);
6898 if (PerlIO_isutf8(fp)) {
6900 sv_utf8_upgrade_nomg(sv);
6901 sv_pos_u2b(sv,&append,0);
6903 } else if (SvUTF8(sv)) {
6904 SV *tsv = NEWSV(0,0);
6905 sv_gets(tsv, fp, 0);
6906 sv_utf8_upgrade_nomg(tsv);
6907 SvCUR_set(sv,append);
6910 goto return_string_or_null;
6915 if (PerlIO_isutf8(fp))
6918 if (IN_PERL_COMPILETIME) {
6919 /* we always read code in line mode */
6923 else if (RsSNARF(PL_rs)) {
6924 /* If it is a regular disk file use size from stat() as estimate
6925 of amount we are going to read - may result in malloc-ing
6926 more memory than we realy need if layers bellow reduce
6927 size we read (e.g. CRLF or a gzip layer)
6930 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6931 Off_t offset = PerlIO_tell(fp);
6932 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6933 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6939 else if (RsRECORD(PL_rs)) {
6943 /* Grab the size of the record we're getting */
6944 recsize = SvIV(SvRV(PL_rs));
6945 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6948 /* VMS wants read instead of fread, because fread doesn't respect */
6949 /* RMS record boundaries. This is not necessarily a good thing to be */
6950 /* doing, but we've got no other real choice - except avoid stdio
6951 as implementation - perhaps write a :vms layer ?
6953 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6955 bytesread = PerlIO_read(fp, buffer, recsize);
6959 SvCUR_set(sv, bytesread += append);
6960 buffer[bytesread] = '\0';
6961 goto return_string_or_null;
6963 else if (RsPARA(PL_rs)) {
6969 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6970 if (PerlIO_isutf8(fp)) {
6971 rsptr = SvPVutf8(PL_rs, rslen);
6974 if (SvUTF8(PL_rs)) {
6975 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6976 Perl_croak(aTHX_ "Wide character in $/");
6979 rsptr = SvPV(PL_rs, rslen);
6983 rslast = rslen ? rsptr[rslen - 1] : '\0';
6985 if (rspara) { /* have to do this both before and after */
6986 do { /* to make sure file boundaries work right */
6989 i = PerlIO_getc(fp);
6993 PerlIO_ungetc(fp,i);
6999 /* See if we know enough about I/O mechanism to cheat it ! */
7001 /* This used to be #ifdef test - it is made run-time test for ease
7002 of abstracting out stdio interface. One call should be cheap
7003 enough here - and may even be a macro allowing compile
7007 if (PerlIO_fast_gets(fp)) {
7010 * We're going to steal some values from the stdio struct
7011 * and put EVERYTHING in the innermost loop into registers.
7013 register STDCHAR *ptr;
7017 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7018 /* An ungetc()d char is handled separately from the regular
7019 * buffer, so we getc() it back out and stuff it in the buffer.
7021 i = PerlIO_getc(fp);
7022 if (i == EOF) return 0;
7023 *(--((*fp)->_ptr)) = (unsigned char) i;
7027 /* Here is some breathtakingly efficient cheating */
7029 cnt = PerlIO_get_cnt(fp); /* get count into register */
7030 /* make sure we have the room */
7031 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7032 /* Not room for all of it
7033 if we are looking for a separator and room for some
7035 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7036 /* just process what we have room for */
7037 shortbuffered = cnt - SvLEN(sv) + append + 1;
7038 cnt -= shortbuffered;
7042 /* remember that cnt can be negative */
7043 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7048 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
7049 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7050 DEBUG_P(PerlIO_printf(Perl_debug_log,
7051 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7052 DEBUG_P(PerlIO_printf(Perl_debug_log,
7053 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7054 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7055 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7060 while (cnt > 0) { /* this | eat */
7062 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7063 goto thats_all_folks; /* screams | sed :-) */
7067 Copy(ptr, bp, cnt, char); /* this | eat */
7068 bp += cnt; /* screams | dust */
7069 ptr += cnt; /* louder | sed :-) */
7074 if (shortbuffered) { /* oh well, must extend */
7075 cnt = shortbuffered;
7077 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
7079 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7080 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7084 DEBUG_P(PerlIO_printf(Perl_debug_log,
7085 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7086 PTR2UV(ptr),(long)cnt));
7087 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7089 DEBUG_P(PerlIO_printf(Perl_debug_log,
7090 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7091 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7092 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7094 /* This used to call 'filbuf' in stdio form, but as that behaves like
7095 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7096 another abstraction. */
7097 i = PerlIO_getc(fp); /* get more characters */
7099 DEBUG_P(PerlIO_printf(Perl_debug_log,
7100 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7101 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7102 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7104 cnt = PerlIO_get_cnt(fp);
7105 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7106 DEBUG_P(PerlIO_printf(Perl_debug_log,
7107 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7109 if (i == EOF) /* all done for ever? */
7110 goto thats_really_all_folks;
7112 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
7114 SvGROW(sv, bpx + cnt + 2);
7115 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7117 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7119 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7120 goto thats_all_folks;
7124 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
7125 memNE((char*)bp - rslen, rsptr, rslen))
7126 goto screamer; /* go back to the fray */
7127 thats_really_all_folks:
7129 cnt += shortbuffered;
7130 DEBUG_P(PerlIO_printf(Perl_debug_log,
7131 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7132 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7133 DEBUG_P(PerlIO_printf(Perl_debug_log,
7134 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7135 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7136 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7138 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
7139 DEBUG_P(PerlIO_printf(Perl_debug_log,
7140 "Screamer: done, len=%ld, string=|%.*s|\n",
7141 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
7145 /*The big, slow, and stupid way. */
7146 #ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
7148 New(0, buf, 8192, STDCHAR);
7156 const register STDCHAR *bpe = buf + sizeof(buf);
7158 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7159 ; /* keep reading */
7163 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7164 /* Accomodate broken VAXC compiler, which applies U8 cast to
7165 * both args of ?: operator, causing EOF to change into 255
7168 i = (U8)buf[cnt - 1];
7174 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7176 sv_catpvn(sv, (char *) buf, cnt);
7178 sv_setpvn(sv, (char *) buf, cnt);
7180 if (i != EOF && /* joy */
7182 SvCUR(sv) < rslen ||
7183 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7187 * If we're reading from a TTY and we get a short read,
7188 * indicating that the user hit his EOF character, we need
7189 * to notice it now, because if we try to read from the TTY
7190 * again, the EOF condition will disappear.
7192 * The comparison of cnt to sizeof(buf) is an optimization
7193 * that prevents unnecessary calls to feof().
7197 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
7201 #ifdef USE_HEAP_INSTEAD_OF_STACK
7206 if (rspara) { /* have to do this both before and after */
7207 while (i != EOF) { /* to make sure file boundaries work right */
7208 i = PerlIO_getc(fp);
7210 PerlIO_ungetc(fp,i);
7216 return_string_or_null:
7217 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
7223 Auto-increment of the value in the SV, doing string to numeric conversion
7224 if necessary. Handles 'get' magic.
7230 Perl_sv_inc(pTHX_ register SV *sv)
7239 if (SvTHINKFIRST(sv)) {
7241 sv_force_normal_flags(sv, 0);
7242 if (SvREADONLY(sv)) {
7243 if (IN_PERL_RUNTIME)
7244 Perl_croak(aTHX_ PL_no_modify);
7248 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7250 i = PTR2IV(SvRV(sv));
7255 flags = SvFLAGS(sv);
7256 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7257 /* It's (privately or publicly) a float, but not tested as an
7258 integer, so test it to see. */
7260 flags = SvFLAGS(sv);
7262 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7263 /* It's publicly an integer, or privately an integer-not-float */
7264 #ifdef PERL_PRESERVE_IVUV
7268 if (SvUVX(sv) == UV_MAX)
7269 sv_setnv(sv, UV_MAX_P1);
7271 (void)SvIOK_only_UV(sv);
7272 SvUV_set(sv, SvUVX(sv) + 1);
7274 if (SvIVX(sv) == IV_MAX)
7275 sv_setuv(sv, (UV)IV_MAX + 1);
7277 (void)SvIOK_only(sv);
7278 SvIV_set(sv, SvIVX(sv) + 1);
7283 if (flags & SVp_NOK) {
7284 (void)SvNOK_only(sv);
7285 SvNV_set(sv, SvNVX(sv) + 1.0);
7289 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
7290 if ((flags & SVTYPEMASK) < SVt_PVIV)
7291 sv_upgrade(sv, SVt_IV);
7292 (void)SvIOK_only(sv);
7297 while (isALPHA(*d)) d++;
7298 while (isDIGIT(*d)) d++;
7300 #ifdef PERL_PRESERVE_IVUV
7301 /* Got to punt this as an integer if needs be, but we don't issue
7302 warnings. Probably ought to make the sv_iv_please() that does
7303 the conversion if possible, and silently. */
7304 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
7305 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7306 /* Need to try really hard to see if it's an integer.
7307 9.22337203685478e+18 is an integer.
7308 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7309 so $a="9.22337203685478e+18"; $a+0; $a++
7310 needs to be the same as $a="9.22337203685478e+18"; $a++
7317 /* sv_2iv *should* have made this an NV */
7318 if (flags & SVp_NOK) {
7319 (void)SvNOK_only(sv);
7320 SvNV_set(sv, SvNVX(sv) + 1.0);
7323 /* I don't think we can get here. Maybe I should assert this
7324 And if we do get here I suspect that sv_setnv will croak. NWC
7326 #if defined(USE_LONG_DOUBLE)
7327 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"PERL_PRIgldbl"\n",
7328 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7330 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7331 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7334 #endif /* PERL_PRESERVE_IVUV */
7335 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
7339 while (d >= SvPVX(sv)) {
7347 /* MKS: The original code here died if letters weren't consecutive.
7348 * at least it didn't have to worry about non-C locales. The
7349 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7350 * arranged in order (although not consecutively) and that only
7351 * [A-Za-z] are accepted by isALPHA in the C locale.
7353 if (*d != 'z' && *d != 'Z') {
7354 do { ++*d; } while (!isALPHA(*d));
7357 *(d--) -= 'z' - 'a';
7362 *(d--) -= 'z' - 'a' + 1;
7366 /* oh,oh, the number grew */
7367 SvGROW(sv, SvCUR(sv) + 2);
7368 SvCUR_set(sv, SvCUR(sv) + 1);
7369 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
7380 Auto-decrement of the value in the SV, doing string to numeric conversion
7381 if necessary. Handles 'get' magic.
7387 Perl_sv_dec(pTHX_ register SV *sv)
7395 if (SvTHINKFIRST(sv)) {
7397 sv_force_normal_flags(sv, 0);
7398 if (SvREADONLY(sv)) {
7399 if (IN_PERL_RUNTIME)
7400 Perl_croak(aTHX_ PL_no_modify);
7404 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7406 i = PTR2IV(SvRV(sv));
7411 /* Unlike sv_inc we don't have to worry about string-never-numbers
7412 and keeping them magic. But we mustn't warn on punting */
7413 flags = SvFLAGS(sv);
7414 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7415 /* It's publicly an integer, or privately an integer-not-float */
7416 #ifdef PERL_PRESERVE_IVUV
7420 if (SvUVX(sv) == 0) {
7421 (void)SvIOK_only(sv);
7425 (void)SvIOK_only_UV(sv);
7426 SvUV_set(sv, SvUVX(sv) + 1);
7429 if (SvIVX(sv) == IV_MIN)
7430 sv_setnv(sv, (NV)IV_MIN - 1.0);
7432 (void)SvIOK_only(sv);
7433 SvIV_set(sv, SvIVX(sv) - 1);
7438 if (flags & SVp_NOK) {
7439 SvNV_set(sv, SvNVX(sv) - 1.0);
7440 (void)SvNOK_only(sv);
7443 if (!(flags & SVp_POK)) {
7444 if ((flags & SVTYPEMASK) < SVt_PVNV)
7445 sv_upgrade(sv, SVt_NV);
7447 (void)SvNOK_only(sv);
7450 #ifdef PERL_PRESERVE_IVUV
7452 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
7453 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7454 /* Need to try really hard to see if it's an integer.
7455 9.22337203685478e+18 is an integer.
7456 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7457 so $a="9.22337203685478e+18"; $a+0; $a--
7458 needs to be the same as $a="9.22337203685478e+18"; $a--
7465 /* sv_2iv *should* have made this an NV */
7466 if (flags & SVp_NOK) {
7467 (void)SvNOK_only(sv);
7468 SvNV_set(sv, SvNVX(sv) - 1.0);
7471 /* I don't think we can get here. Maybe I should assert this
7472 And if we do get here I suspect that sv_setnv will croak. NWC
7474 #if defined(USE_LONG_DOUBLE)
7475 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"PERL_PRIgldbl"\n",
7476 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7478 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7479 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7483 #endif /* PERL_PRESERVE_IVUV */
7484 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
7488 =for apidoc sv_mortalcopy
7490 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7491 The new SV is marked as mortal. It will be destroyed "soon", either by an
7492 explicit call to FREETMPS, or by an implicit call at places such as
7493 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7498 /* Make a string that will exist for the duration of the expression
7499 * evaluation. Actually, it may have to last longer than that, but
7500 * hopefully we won't free it until it has been assigned to a
7501 * permanent location. */
7504 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7509 sv_setsv(sv,oldstr);
7511 PL_tmps_stack[++PL_tmps_ix] = sv;
7517 =for apidoc sv_newmortal
7519 Creates a new null SV which is mortal. The reference count of the SV is
7520 set to 1. It will be destroyed "soon", either by an explicit call to
7521 FREETMPS, or by an implicit call at places such as statement boundaries.
7522 See also C<sv_mortalcopy> and C<sv_2mortal>.
7528 Perl_sv_newmortal(pTHX)
7533 SvFLAGS(sv) = SVs_TEMP;
7535 PL_tmps_stack[++PL_tmps_ix] = sv;
7540 =for apidoc sv_2mortal
7542 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7543 by an explicit call to FREETMPS, or by an implicit call at places such as
7544 statement boundaries. SvTEMP() is turned on which means that the SV's
7545 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7546 and C<sv_mortalcopy>.
7552 Perl_sv_2mortal(pTHX_ register SV *sv)
7557 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7560 PL_tmps_stack[++PL_tmps_ix] = sv;
7568 Creates a new SV and copies a string into it. The reference count for the
7569 SV is set to 1. If C<len> is zero, Perl will compute the length using
7570 strlen(). For efficiency, consider using C<newSVpvn> instead.
7576 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7583 sv_setpvn(sv,s,len);
7588 =for apidoc newSVpvn
7590 Creates a new SV and copies a string into it. The reference count for the
7591 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7592 string. You are responsible for ensuring that the source string is at least
7593 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7599 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7604 sv_setpvn(sv,s,len);
7609 =for apidoc newSVpvn_share
7611 Creates a new SV with its SvPVX pointing to a shared string in the string
7612 table. If the string does not already exist in the table, it is created
7613 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7614 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7615 otherwise the hash is computed. The idea here is that as the string table
7616 is used for shared hash keys these strings will have SvPVX == HeKEY and
7617 hash lookup will avoid string compare.
7623 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7626 bool is_utf8 = FALSE;
7628 STRLEN tmplen = -len;
7630 /* See the note in hv.c:hv_fetch() --jhi */
7631 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7635 PERL_HASH(hash, src, len);
7637 sv_upgrade(sv, SVt_PVIV);
7638 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
7651 #if defined(PERL_IMPLICIT_CONTEXT)
7653 /* pTHX_ magic can't cope with varargs, so this is a no-context
7654 * version of the main function, (which may itself be aliased to us).
7655 * Don't access this version directly.
7659 Perl_newSVpvf_nocontext(const char* pat, ...)
7664 va_start(args, pat);
7665 sv = vnewSVpvf(pat, &args);
7672 =for apidoc newSVpvf
7674 Creates a new SV and initializes it with the string formatted like
7681 Perl_newSVpvf(pTHX_ const char* pat, ...)
7685 va_start(args, pat);
7686 sv = vnewSVpvf(pat, &args);
7691 /* backend for newSVpvf() and newSVpvf_nocontext() */
7694 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7698 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7705 Creates a new SV and copies a floating point value into it.
7706 The reference count for the SV is set to 1.
7712 Perl_newSVnv(pTHX_ NV n)
7724 Creates a new SV and copies an integer into it. The reference count for the
7731 Perl_newSViv(pTHX_ IV i)
7743 Creates a new SV and copies an unsigned integer into it.
7744 The reference count for the SV is set to 1.
7750 Perl_newSVuv(pTHX_ UV u)
7760 =for apidoc newRV_noinc
7762 Creates an RV wrapper for an SV. The reference count for the original
7763 SV is B<not> incremented.
7769 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7774 sv_upgrade(sv, SVt_RV);
7776 SvRV_set(sv, tmpRef);
7781 /* newRV_inc is the official function name to use now.
7782 * newRV_inc is in fact #defined to newRV in sv.h
7786 Perl_newRV(pTHX_ SV *tmpRef)
7788 return newRV_noinc(SvREFCNT_inc(tmpRef));
7794 Creates a new SV which is an exact duplicate of the original SV.
7801 Perl_newSVsv(pTHX_ register SV *old)
7807 if (SvTYPE(old) == SVTYPEMASK) {
7808 if (ckWARN_d(WARN_INTERNAL))
7809 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7813 /* SV_GMAGIC is the default for sv_setv()
7814 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7815 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7816 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7821 =for apidoc sv_reset
7823 Underlying implementation for the C<reset> Perl function.
7824 Note that the perl-level function is vaguely deprecated.
7830 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7839 char todo[PERL_UCHAR_MAX+1];
7844 if (!*s) { /* reset ?? searches */
7845 for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
7846 pm->op_pmdynflags &= ~PMdf_USED;
7851 /* reset variables */
7853 if (!HvARRAY(stash))
7856 Zero(todo, 256, char);
7858 i = (unsigned char)*s;
7862 max = (unsigned char)*s++;
7863 for ( ; i <= max; i++) {
7866 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7867 for (entry = HvARRAY(stash)[i];
7869 entry = HeNEXT(entry))
7871 if (!todo[(U8)*HeKEY(entry)])
7873 gv = (GV*)HeVAL(entry);
7875 if (SvTHINKFIRST(sv)) {
7876 if (!SvREADONLY(sv) && SvROK(sv))
7881 if (SvTYPE(sv) >= SVt_PV) {
7883 if (SvPVX(sv) != Nullch)
7890 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
7893 #ifdef USE_ENVIRON_ARRAY
7895 # ifdef USE_ITHREADS
7896 && PL_curinterp == aTHX
7900 environ[0] = Nullch;
7903 #endif /* !PERL_MICRO */
7913 Using various gambits, try to get an IO from an SV: the IO slot if its a
7914 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7915 named after the PV if we're a string.
7921 Perl_sv_2io(pTHX_ SV *sv)
7926 switch (SvTYPE(sv)) {
7934 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7938 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7940 return sv_2io(SvRV(sv));
7941 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
7947 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
7956 Using various gambits, try to get a CV from an SV; in addition, try if
7957 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7963 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
7970 return *gvp = Nullgv, Nullcv;
7971 switch (SvTYPE(sv)) {
7990 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7991 tryAMAGICunDEREF(to_cv);
7994 if (SvTYPE(sv) == SVt_PVCV) {
8003 Perl_croak(aTHX_ "Not a subroutine reference");
8008 gv = gv_fetchsv(sv, lref, SVt_PVCV);
8014 if (lref && !GvCVu(gv)) {
8017 tmpsv = NEWSV(704,0);
8018 gv_efullname3(tmpsv, gv, Nullch);
8019 /* XXX this is probably not what they think they're getting.
8020 * It has the same effect as "sub name;", i.e. just a forward
8022 newSUB(start_subparse(FALSE, 0),
8023 newSVOP(OP_CONST, 0, tmpsv),
8028 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8038 Returns true if the SV has a true value by Perl's rules.
8039 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8040 instead use an in-line version.
8046 Perl_sv_true(pTHX_ register SV *sv)
8051 const register XPV* tXpv;
8052 if ((tXpv = (XPV*)SvANY(sv)) &&
8053 (tXpv->xpv_cur > 1 ||
8054 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
8061 return SvIVX(sv) != 0;
8064 return SvNVX(sv) != 0.0;
8066 return sv_2bool(sv);
8074 A private implementation of the C<SvIVx> macro for compilers which can't
8075 cope with complex macro expressions. Always use the macro instead.
8081 Perl_sv_iv(pTHX_ register SV *sv)
8085 return (IV)SvUVX(sv);
8094 A private implementation of the C<SvUVx> macro for compilers which can't
8095 cope with complex macro expressions. Always use the macro instead.
8101 Perl_sv_uv(pTHX_ register SV *sv)
8106 return (UV)SvIVX(sv);
8114 A private implementation of the C<SvNVx> macro for compilers which can't
8115 cope with complex macro expressions. Always use the macro instead.
8121 Perl_sv_nv(pTHX_ register SV *sv)
8128 /* sv_pv() is now a macro using SvPV_nolen();
8129 * this function provided for binary compatibility only
8133 Perl_sv_pv(pTHX_ SV *sv)
8140 return sv_2pv(sv, &n_a);
8146 Use the C<SvPV_nolen> macro instead
8150 A private implementation of the C<SvPV> macro for compilers which can't
8151 cope with complex macro expressions. Always use the macro instead.
8157 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
8163 return sv_2pv(sv, lp);
8168 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
8174 return sv_2pv_flags(sv, lp, 0);
8177 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
8178 * this function provided for binary compatibility only
8182 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
8184 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
8188 =for apidoc sv_pvn_force
8190 Get a sensible string out of the SV somehow.
8191 A private implementation of the C<SvPV_force> macro for compilers which
8192 can't cope with complex macro expressions. Always use the macro instead.
8194 =for apidoc sv_pvn_force_flags
8196 Get a sensible string out of the SV somehow.
8197 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8198 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8199 implemented in terms of this function.
8200 You normally want to use the various wrapper macros instead: see
8201 C<SvPV_force> and C<SvPV_force_nomg>
8207 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
8211 if (SvTHINKFIRST(sv) && !SvROK(sv))
8212 sv_force_normal_flags(sv, 0);
8218 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
8219 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8223 s = sv_2pv_flags(sv, lp, flags);
8224 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
8229 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8230 SvGROW(sv, len + 1);
8231 Move(s,SvPVX(sv),len,char);
8236 SvPOK_on(sv); /* validate pointer */
8238 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8239 PTR2UV(sv),SvPVX(sv)));
8245 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
8246 * this function provided for binary compatibility only
8250 Perl_sv_pvbyte(pTHX_ SV *sv)
8252 sv_utf8_downgrade(sv,0);
8257 =for apidoc sv_pvbyte
8259 Use C<SvPVbyte_nolen> instead.
8261 =for apidoc sv_pvbyten
8263 A private implementation of the C<SvPVbyte> macro for compilers
8264 which can't cope with complex macro expressions. Always use the macro
8271 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
8273 sv_utf8_downgrade(sv,0);
8274 return sv_pvn(sv,lp);
8278 =for apidoc sv_pvbyten_force
8280 A private implementation of the C<SvPVbytex_force> macro for compilers
8281 which can't cope with complex macro expressions. Always use the macro
8288 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8290 sv_pvn_force(sv,lp);
8291 sv_utf8_downgrade(sv,0);
8296 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8297 * this function provided for binary compatibility only
8301 Perl_sv_pvutf8(pTHX_ SV *sv)
8303 sv_utf8_upgrade(sv);
8308 =for apidoc sv_pvutf8
8310 Use the C<SvPVutf8_nolen> macro instead
8312 =for apidoc sv_pvutf8n
8314 A private implementation of the C<SvPVutf8> macro for compilers
8315 which can't cope with complex macro expressions. Always use the macro
8322 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8324 sv_utf8_upgrade(sv);
8325 return sv_pvn(sv,lp);
8329 =for apidoc sv_pvutf8n_force
8331 A private implementation of the C<SvPVutf8_force> macro for compilers
8332 which can't cope with complex macro expressions. Always use the macro
8339 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8341 sv_pvn_force(sv,lp);
8342 sv_utf8_upgrade(sv);
8348 =for apidoc sv_reftype
8350 Returns a string describing what the SV is a reference to.
8356 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8358 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8359 inside return suggests a const propagation bug in g++. */
8360 if (ob && SvOBJECT(sv)) {
8361 char *name = HvNAME(SvSTASH(sv));
8362 return name ? name : (char *) "__ANON__";
8365 switch (SvTYPE(sv)) {
8382 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
8383 /* tied lvalues should appear to be
8384 * scalars for backwards compatitbility */
8385 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8386 ? "SCALAR" : "LVALUE");
8387 case SVt_PVAV: return "ARRAY";
8388 case SVt_PVHV: return "HASH";
8389 case SVt_PVCV: return "CODE";
8390 case SVt_PVGV: return "GLOB";
8391 case SVt_PVFM: return "FORMAT";
8392 case SVt_PVIO: return "IO";
8393 default: return "UNKNOWN";
8399 =for apidoc sv_isobject
8401 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8402 object. If the SV is not an RV, or if the object is not blessed, then this
8409 Perl_sv_isobject(pTHX_ SV *sv)
8426 Returns a boolean indicating whether the SV is blessed into the specified
8427 class. This does not check for subtypes; use C<sv_derived_from> to verify
8428 an inheritance relationship.
8434 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8445 if (!HvNAME(SvSTASH(sv)))
8448 return strEQ(HvNAME(SvSTASH(sv)), name);
8454 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8455 it will be upgraded to one. If C<classname> is non-null then the new SV will
8456 be blessed in the specified package. The new SV is returned and its
8457 reference count is 1.
8463 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8469 SV_CHECK_THINKFIRST_COW_DROP(rv);
8472 if (SvTYPE(rv) >= SVt_PVMG) {
8473 U32 refcnt = SvREFCNT(rv);
8477 SvREFCNT(rv) = refcnt;
8480 if (SvTYPE(rv) < SVt_RV)
8481 sv_upgrade(rv, SVt_RV);
8482 else if (SvTYPE(rv) > SVt_RV) {
8484 if (SvPVX(rv) && SvLEN(rv))
8485 Safefree(SvPVX(rv));
8495 HV* stash = gv_stashpv(classname, TRUE);
8496 (void)sv_bless(rv, stash);
8502 =for apidoc sv_setref_pv
8504 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8505 argument will be upgraded to an RV. That RV will be modified to point to
8506 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8507 into the SV. The C<classname> argument indicates the package for the
8508 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8509 will have a reference count of 1, and the RV will be returned.
8511 Do not use with other Perl types such as HV, AV, SV, CV, because those
8512 objects will become corrupted by the pointer copy process.
8514 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8520 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8523 sv_setsv(rv, &PL_sv_undef);
8527 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8532 =for apidoc sv_setref_iv
8534 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8535 argument will be upgraded to an RV. That RV will be modified to point to
8536 the new SV. The C<classname> argument indicates the package for the
8537 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8538 will have a reference count of 1, and the RV will be returned.
8544 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8546 sv_setiv(newSVrv(rv,classname), iv);
8551 =for apidoc sv_setref_uv
8553 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8554 argument will be upgraded to an RV. That RV will be modified to point to
8555 the new SV. The C<classname> argument indicates the package for the
8556 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8557 will have a reference count of 1, and the RV will be returned.
8563 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8565 sv_setuv(newSVrv(rv,classname), uv);
8570 =for apidoc sv_setref_nv
8572 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8573 argument will be upgraded to an RV. That RV will be modified to point to
8574 the new SV. The C<classname> argument indicates the package for the
8575 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8576 will have a reference count of 1, and the RV will be returned.
8582 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8584 sv_setnv(newSVrv(rv,classname), nv);
8589 =for apidoc sv_setref_pvn
8591 Copies a string into a new SV, optionally blessing the SV. The length of the
8592 string must be specified with C<n>. The C<rv> argument will be upgraded to
8593 an RV. That RV will be modified to point to the new SV. The C<classname>
8594 argument indicates the package for the blessing. Set C<classname> to
8595 C<Nullch> to avoid the blessing. The new SV will have a reference count
8596 of 1, and the RV will be returned.
8598 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8604 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8606 sv_setpvn(newSVrv(rv,classname), pv, n);
8611 =for apidoc sv_bless
8613 Blesses an SV into a specified package. The SV must be an RV. The package
8614 must be designated by its stash (see C<gv_stashpv()>). The reference count
8615 of the SV is unaffected.
8621 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8625 Perl_croak(aTHX_ "Can't bless non-reference value");
8627 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8628 if (SvREADONLY(tmpRef))
8629 Perl_croak(aTHX_ PL_no_modify);
8630 if (SvOBJECT(tmpRef)) {
8631 if (SvTYPE(tmpRef) != SVt_PVIO)
8633 SvREFCNT_dec(SvSTASH(tmpRef));
8636 SvOBJECT_on(tmpRef);
8637 if (SvTYPE(tmpRef) != SVt_PVIO)
8639 (void)SvUPGRADE(tmpRef, SVt_PVMG);
8640 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
8647 if(SvSMAGICAL(tmpRef))
8648 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8656 /* Downgrades a PVGV to a PVMG.
8660 S_sv_unglob(pTHX_ SV *sv)
8664 assert(SvTYPE(sv) == SVt_PVGV);
8669 SvREFCNT_dec(GvSTASH(sv));
8670 GvSTASH(sv) = Nullhv;
8672 sv_unmagic(sv, PERL_MAGIC_glob);
8673 Safefree(GvNAME(sv));
8676 /* need to keep SvANY(sv) in the right arena */
8677 xpvmg = new_XPVMG();
8678 StructCopy(SvANY(sv), xpvmg, XPVMG);
8679 del_XPVGV(SvANY(sv));
8682 SvFLAGS(sv) &= ~SVTYPEMASK;
8683 SvFLAGS(sv) |= SVt_PVMG;
8687 =for apidoc sv_unref_flags
8689 Unsets the RV status of the SV, and decrements the reference count of
8690 whatever was being referenced by the RV. This can almost be thought of
8691 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8692 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8693 (otherwise the decrementing is conditional on the reference count being
8694 different from one or the reference being a readonly SV).
8701 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8705 if (SvWEAKREF(sv)) {
8713 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8714 assigned to as BEGIN {$a = \"Foo"} will fail. */
8715 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8717 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8718 sv_2mortal(rv); /* Schedule for freeing later */
8722 =for apidoc sv_unref
8724 Unsets the RV status of the SV, and decrements the reference count of
8725 whatever was being referenced by the RV. This can almost be thought of
8726 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8727 being zero. See C<SvROK_off>.
8733 Perl_sv_unref(pTHX_ SV *sv)
8735 sv_unref_flags(sv, 0);
8739 =for apidoc sv_taint
8741 Taint an SV. Use C<SvTAINTED_on> instead.
8746 Perl_sv_taint(pTHX_ SV *sv)
8748 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8752 =for apidoc sv_untaint
8754 Untaint an SV. Use C<SvTAINTED_off> instead.
8759 Perl_sv_untaint(pTHX_ SV *sv)
8761 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8762 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8769 =for apidoc sv_tainted
8771 Test an SV for taintedness. Use C<SvTAINTED> instead.
8776 Perl_sv_tainted(pTHX_ SV *sv)
8778 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8779 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8780 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8787 =for apidoc sv_setpviv
8789 Copies an integer into the given SV, also updating its string value.
8790 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8796 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8798 char buf[TYPE_CHARS(UV)];
8800 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8802 sv_setpvn(sv, ptr, ebuf - ptr);
8806 =for apidoc sv_setpviv_mg
8808 Like C<sv_setpviv>, but also handles 'set' magic.
8814 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8816 char buf[TYPE_CHARS(UV)];
8818 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8820 sv_setpvn(sv, ptr, ebuf - ptr);
8824 #if defined(PERL_IMPLICIT_CONTEXT)
8826 /* pTHX_ magic can't cope with varargs, so this is a no-context
8827 * version of the main function, (which may itself be aliased to us).
8828 * Don't access this version directly.
8832 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8836 va_start(args, pat);
8837 sv_vsetpvf(sv, pat, &args);
8841 /* pTHX_ magic can't cope with varargs, so this is a no-context
8842 * version of the main function, (which may itself be aliased to us).
8843 * Don't access this version directly.
8847 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8851 va_start(args, pat);
8852 sv_vsetpvf_mg(sv, pat, &args);
8858 =for apidoc sv_setpvf
8860 Works like C<sv_catpvf> but copies the text into the SV instead of
8861 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8867 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8870 va_start(args, pat);
8871 sv_vsetpvf(sv, pat, &args);
8876 =for apidoc sv_vsetpvf
8878 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8879 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8881 Usually used via its frontend C<sv_setpvf>.
8887 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8889 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8893 =for apidoc sv_setpvf_mg
8895 Like C<sv_setpvf>, but also handles 'set' magic.
8901 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8904 va_start(args, pat);
8905 sv_vsetpvf_mg(sv, pat, &args);
8910 =for apidoc sv_vsetpvf_mg
8912 Like C<sv_vsetpvf>, but also handles 'set' magic.
8914 Usually used via its frontend C<sv_setpvf_mg>.
8920 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8922 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8926 #if defined(PERL_IMPLICIT_CONTEXT)
8928 /* pTHX_ magic can't cope with varargs, so this is a no-context
8929 * version of the main function, (which may itself be aliased to us).
8930 * Don't access this version directly.
8934 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8938 va_start(args, pat);
8939 sv_vcatpvf(sv, pat, &args);
8943 /* pTHX_ magic can't cope with varargs, so this is a no-context
8944 * version of the main function, (which may itself be aliased to us).
8945 * Don't access this version directly.
8949 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8953 va_start(args, pat);
8954 sv_vcatpvf_mg(sv, pat, &args);
8960 =for apidoc sv_catpvf
8962 Processes its arguments like C<sprintf> and appends the formatted
8963 output to an SV. If the appended data contains "wide" characters
8964 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8965 and characters >255 formatted with %c), the original SV might get
8966 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
8967 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
8968 valid UTF-8; if the original SV was bytes, the pattern should be too.
8973 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
8976 va_start(args, pat);
8977 sv_vcatpvf(sv, pat, &args);
8982 =for apidoc sv_vcatpvf
8984 Processes its arguments like C<vsprintf> and appends the formatted output
8985 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
8987 Usually used via its frontend C<sv_catpvf>.
8993 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8995 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8999 =for apidoc sv_catpvf_mg
9001 Like C<sv_catpvf>, but also handles 'set' magic.
9007 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
9010 va_start(args, pat);
9011 sv_vcatpvf_mg(sv, pat, &args);
9016 =for apidoc sv_vcatpvf_mg
9018 Like C<sv_vcatpvf>, but also handles 'set' magic.
9020 Usually used via its frontend C<sv_catpvf_mg>.
9026 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9028 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9033 =for apidoc sv_vsetpvfn
9035 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9038 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9044 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9046 sv_setpvn(sv, "", 0);
9047 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9050 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
9053 S_expect_number(pTHX_ char** pattern)
9056 switch (**pattern) {
9057 case '1': case '2': case '3':
9058 case '4': case '5': case '6':
9059 case '7': case '8': case '9':
9060 while (isDIGIT(**pattern))
9061 var = var * 10 + (*(*pattern)++ - '0');
9065 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
9068 F0convert(NV nv, char *endbuf, STRLEN *len)
9079 if (uv & 1 && uv == nv)
9080 uv--; /* Round to even */
9082 unsigned dig = uv % 10;
9095 =for apidoc sv_vcatpvfn
9097 Processes its arguments like C<vsprintf> and appends the formatted output
9098 to an SV. Uses an array of SVs if the C style variable argument list is
9099 missing (NULL). When running with taint checks enabled, indicates via
9100 C<maybe_tainted> if results are untrustworthy (often due to the use of
9103 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
9108 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
9111 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9118 static const char nullstr[] = "(null)";
9120 bool has_utf8; /* has the result utf8? */
9121 bool pat_utf8; /* the pattern is in utf8? */
9123 /* Times 4: a decimal digit takes more than 3 binary digits.
9124 * NV_DIG: mantissa takes than many decimal digits.
9125 * Plus 32: Playing safe. */
9126 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9127 /* large enough for "%#.#f" --chip */
9128 /* what about long double NVs? --jhi */
9130 has_utf8 = pat_utf8 = DO_UTF8(sv);
9132 /* no matter what, this is a string now */
9133 (void)SvPV_force(sv, origlen);
9135 /* special-case "", "%s", and "%_" */
9138 if (patlen == 2 && pat[0] == '%') {
9142 const char *s = va_arg(*args, char*);
9143 sv_catpv(sv, s ? s : nullstr);
9145 else if (svix < svmax) {
9146 sv_catsv(sv, *svargs);
9147 if (DO_UTF8(*svargs))
9153 argsv = va_arg(*args, SV*);
9154 sv_catsv(sv, argsv);
9159 /* See comment on '_' below */
9164 #ifndef USE_LONG_DOUBLE
9165 /* special-case "%.<number>[gf]" */
9166 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9167 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9168 unsigned digits = 0;
9172 while (*pp >= '0' && *pp <= '9')
9173 digits = 10 * digits + (*pp++ - '0');
9174 if (pp - pat == (int)patlen - 1) {
9178 nv = (NV)va_arg(*args, double);
9179 else if (svix < svmax)
9184 /* Add check for digits != 0 because it seems that some
9185 gconverts are buggy in this case, and we don't yet have
9186 a Configure test for this. */
9187 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9188 /* 0, point, slack */
9189 Gconvert(nv, (int)digits, 0, ebuf);
9191 if (*ebuf) /* May return an empty string for digits==0 */
9194 } else if (!digits) {
9197 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9198 sv_catpvn(sv, p, l);
9204 #endif /* !USE_LONG_DOUBLE */
9206 if (!args && svix < svmax && DO_UTF8(*svargs))
9209 patend = (char*)pat + patlen;
9210 for (p = (char*)pat; p < patend; p = q) {
9213 bool vectorize = FALSE;
9214 bool vectorarg = FALSE;
9215 bool vec_utf8 = FALSE;
9221 bool has_precis = FALSE;
9224 bool is_utf8 = FALSE; /* is this item utf8? */
9225 #ifdef HAS_LDBL_SPRINTF_BUG
9226 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9227 with sfio - Allen <allens@cpan.org> */
9228 bool fix_ldbl_sprintf_bug = FALSE;
9232 U8 utf8buf[UTF8_MAXBYTES+1];
9233 STRLEN esignlen = 0;
9235 char *eptr = Nullch;
9238 U8 *vecstr = Null(U8*);
9245 /* we need a long double target in case HAS_LONG_DOUBLE but
9248 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9256 const char *dotstr = ".";
9257 STRLEN dotstrlen = 1;
9258 I32 efix = 0; /* explicit format parameter index */
9259 I32 ewix = 0; /* explicit width index */
9260 I32 epix = 0; /* explicit precision index */
9261 I32 evix = 0; /* explicit vector index */
9262 bool asterisk = FALSE;
9264 /* echo everything up to the next format specification */
9265 for (q = p; q < patend && *q != '%'; ++q) ;
9267 if (has_utf8 && !pat_utf8)
9268 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9270 sv_catpvn(sv, p, q - p);
9277 We allow format specification elements in this order:
9278 \d+\$ explicit format parameter index
9280 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9281 0 flag (as above): repeated to allow "v02"
9282 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9283 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9285 [%bcdefginopsux_DFOUX] format (mandatory)
9287 if (EXPECT_NUMBER(q, width)) {
9328 if (EXPECT_NUMBER(q, ewix))
9337 if ((vectorarg = asterisk)) {
9349 EXPECT_NUMBER(q, width);
9354 vecsv = va_arg(*args, SV*);
9356 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9357 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9358 dotstr = SvPVx(vecsv, dotstrlen);
9363 vecsv = va_arg(*args, SV*);
9364 vecstr = (U8*)SvPVx(vecsv,veclen);
9365 vec_utf8 = DO_UTF8(vecsv);
9367 else if (efix ? efix <= svmax : svix < svmax) {
9368 vecsv = svargs[efix ? efix-1 : svix++];
9369 vecstr = (U8*)SvPVx(vecsv,veclen);
9370 vec_utf8 = DO_UTF8(vecsv);
9371 /* if this is a version object, we need to return the
9372 * stringified representation (which the SvPVX has
9373 * already done for us), but not vectorize the args
9375 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9377 q++; /* skip past the rest of the %vd format */
9378 eptr = (char *) vecstr;
9379 elen = strlen(eptr);
9392 i = va_arg(*args, int);
9394 i = (ewix ? ewix <= svmax : svix < svmax) ?
9395 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9397 width = (i < 0) ? -i : i;
9407 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9409 /* XXX: todo, support specified precision parameter */
9413 i = va_arg(*args, int);
9415 i = (ewix ? ewix <= svmax : svix < svmax)
9416 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9417 precis = (i < 0) ? 0 : i;
9422 precis = precis * 10 + (*q++ - '0');
9431 case 'I': /* Ix, I32x, and I64x */
9433 if (q[1] == '6' && q[2] == '4') {
9439 if (q[1] == '3' && q[2] == '2') {
9449 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9460 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9461 if (*(q + 1) == 'l') { /* lld, llf */
9486 argsv = (efix ? efix <= svmax : svix < svmax) ?
9487 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9494 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9496 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9498 eptr = (char*)utf8buf;
9499 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9510 if (args && !vectorize) {
9511 eptr = va_arg(*args, char*);
9513 #ifdef MACOS_TRADITIONAL
9514 /* On MacOS, %#s format is used for Pascal strings */
9519 elen = strlen(eptr);
9521 eptr = (char *)nullstr;
9522 elen = sizeof nullstr - 1;
9526 eptr = SvPVx(argsv, elen);
9527 if (DO_UTF8(argsv)) {
9528 if (has_precis && precis < elen) {
9530 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9533 if (width) { /* fudge width (can't fudge elen) */
9534 width += elen - sv_len_utf8(argsv);
9546 * The "%_" hack might have to be changed someday,
9547 * if ISO or ANSI decide to use '_' for something.
9548 * So we keep it hidden from users' code.
9550 if (!args || vectorize)
9552 argsv = va_arg(*args, SV*);
9553 eptr = SvPVx(argsv, elen);
9559 if (has_precis && elen > precis)
9570 goto format_sv; /* %-p -> %_ */
9574 goto format_sv; /* %-Np -> %.N_ */
9577 if (alt || vectorize)
9579 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9597 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9606 esignbuf[esignlen++] = plus;
9610 case 'h': iv = (short)va_arg(*args, int); break;
9611 case 'l': iv = va_arg(*args, long); break;
9612 case 'V': iv = va_arg(*args, IV); break;
9613 default: iv = va_arg(*args, int); break;
9615 case 'q': iv = va_arg(*args, Quad_t); break;
9620 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9622 case 'h': iv = (short)tiv; break;
9623 case 'l': iv = (long)tiv; break;
9625 default: iv = tiv; break;
9627 case 'q': iv = (Quad_t)tiv; break;
9631 if ( !vectorize ) /* we already set uv above */
9636 esignbuf[esignlen++] = plus;
9640 esignbuf[esignlen++] = '-';
9683 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9694 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9695 case 'l': uv = va_arg(*args, unsigned long); break;
9696 case 'V': uv = va_arg(*args, UV); break;
9697 default: uv = va_arg(*args, unsigned); break;
9699 case 'q': uv = va_arg(*args, Uquad_t); break;
9704 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9706 case 'h': uv = (unsigned short)tuv; break;
9707 case 'l': uv = (unsigned long)tuv; break;
9709 default: uv = tuv; break;
9711 case 'q': uv = (Uquad_t)tuv; break;
9717 eptr = ebuf + sizeof ebuf;
9723 p = (char*)((c == 'X')
9724 ? "0123456789ABCDEF" : "0123456789abcdef");
9730 esignbuf[esignlen++] = '0';
9731 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9737 *--eptr = '0' + dig;
9739 if (alt && *eptr != '0')
9745 *--eptr = '0' + dig;
9748 esignbuf[esignlen++] = '0';
9749 esignbuf[esignlen++] = 'b';
9752 default: /* it had better be ten or less */
9755 *--eptr = '0' + dig;
9756 } while (uv /= base);
9759 elen = (ebuf + sizeof ebuf) - eptr;
9762 zeros = precis - elen;
9763 else if (precis == 0 && elen == 1 && *eptr == '0')
9768 /* FLOATING POINT */
9771 c = 'f'; /* maybe %F isn't supported here */
9777 /* This is evil, but floating point is even more evil */
9779 /* for SV-style calling, we can only get NV
9780 for C-style calling, we assume %f is double;
9781 for simplicity we allow any of %Lf, %llf, %qf for long double
9785 #if defined(USE_LONG_DOUBLE)
9789 /* [perl #20339] - we should accept and ignore %lf rather than die */
9793 #if defined(USE_LONG_DOUBLE)
9794 intsize = args ? 0 : 'q';
9798 #if defined(HAS_LONG_DOUBLE)
9807 /* now we need (long double) if intsize == 'q', else (double) */
9808 nv = (args && !vectorize) ?
9809 #if LONG_DOUBLESIZE > DOUBLESIZE
9811 va_arg(*args, long double) :
9812 va_arg(*args, double)
9814 va_arg(*args, double)
9820 if (c != 'e' && c != 'E') {
9822 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9823 will cast our (long double) to (double) */
9824 (void)Perl_frexp(nv, &i);
9825 if (i == PERL_INT_MIN)
9826 Perl_die(aTHX_ "panic: frexp");
9828 need = BIT_DIGITS(i);
9830 need += has_precis ? precis : 6; /* known default */
9835 #ifdef HAS_LDBL_SPRINTF_BUG
9836 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9837 with sfio - Allen <allens@cpan.org> */
9840 # define MY_DBL_MAX DBL_MAX
9841 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9842 # if DOUBLESIZE >= 8
9843 # define MY_DBL_MAX 1.7976931348623157E+308L
9845 # define MY_DBL_MAX 3.40282347E+38L
9849 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9850 # define MY_DBL_MAX_BUG 1L
9852 # define MY_DBL_MAX_BUG MY_DBL_MAX
9856 # define MY_DBL_MIN DBL_MIN
9857 # else /* XXX guessing! -Allen */
9858 # if DOUBLESIZE >= 8
9859 # define MY_DBL_MIN 2.2250738585072014E-308L
9861 # define MY_DBL_MIN 1.17549435E-38L
9865 if ((intsize == 'q') && (c == 'f') &&
9866 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9868 /* it's going to be short enough that
9869 * long double precision is not needed */
9871 if ((nv <= 0L) && (nv >= -0L))
9872 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9874 /* would use Perl_fp_class as a double-check but not
9875 * functional on IRIX - see perl.h comments */
9877 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9878 /* It's within the range that a double can represent */
9879 #if defined(DBL_MAX) && !defined(DBL_MIN)
9880 if ((nv >= ((long double)1/DBL_MAX)) ||
9881 (nv <= (-(long double)1/DBL_MAX)))
9883 fix_ldbl_sprintf_bug = TRUE;
9886 if (fix_ldbl_sprintf_bug == TRUE) {
9896 # undef MY_DBL_MAX_BUG
9899 #endif /* HAS_LDBL_SPRINTF_BUG */
9901 need += 20; /* fudge factor */
9902 if (PL_efloatsize < need) {
9903 Safefree(PL_efloatbuf);
9904 PL_efloatsize = need + 20; /* more fudge */
9905 New(906, PL_efloatbuf, PL_efloatsize, char);
9906 PL_efloatbuf[0] = '\0';
9909 if ( !(width || left || plus || alt) && fill != '0'
9910 && has_precis && intsize != 'q' ) { /* Shortcuts */
9911 /* See earlier comment about buggy Gconvert when digits,
9913 if ( c == 'g' && precis) {
9914 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9915 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9916 goto float_converted;
9917 } else if ( c == 'f' && !precis) {
9918 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9922 eptr = ebuf + sizeof ebuf;
9925 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9926 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9927 if (intsize == 'q') {
9928 /* Copy the one or more characters in a long double
9929 * format before the 'base' ([efgEFG]) character to
9930 * the format string. */
9931 static char const prifldbl[] = PERL_PRIfldbl;
9932 char const *p = prifldbl + sizeof(prifldbl) - 3;
9933 while (p >= prifldbl) { *--eptr = *p--; }
9938 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9943 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9955 /* No taint. Otherwise we are in the strange situation
9956 * where printf() taints but print($float) doesn't.
9958 #if defined(HAS_LONG_DOUBLE)
9960 (void)sprintf(PL_efloatbuf, eptr, nv);
9962 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
9964 (void)sprintf(PL_efloatbuf, eptr, nv);
9967 eptr = PL_efloatbuf;
9968 elen = strlen(PL_efloatbuf);
9974 i = SvCUR(sv) - origlen;
9975 if (args && !vectorize) {
9977 case 'h': *(va_arg(*args, short*)) = i; break;
9978 default: *(va_arg(*args, int*)) = i; break;
9979 case 'l': *(va_arg(*args, long*)) = i; break;
9980 case 'V': *(va_arg(*args, IV*)) = i; break;
9982 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
9987 sv_setuv_mg(argsv, (UV)i);
9989 continue; /* not "break" */
9995 if (!args && ckWARN(WARN_PRINTF) &&
9996 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
9997 SV *msg = sv_newmortal();
9998 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9999 (PL_op->op_type == OP_PRTF) ? "" : "s");
10002 Perl_sv_catpvf(aTHX_ msg,
10003 "\"%%%c\"", c & 0xFF);
10005 Perl_sv_catpvf(aTHX_ msg,
10006 "\"%%\\%03"UVof"\"",
10009 sv_catpv(msg, "end of string");
10010 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
10013 /* output mangled stuff ... */
10019 /* ... right here, because formatting flags should not apply */
10020 SvGROW(sv, SvCUR(sv) + elen + 1);
10022 Copy(eptr, p, elen, char);
10025 SvCUR_set(sv, p - SvPVX(sv));
10027 continue; /* not "break" */
10030 /* calculate width before utf8_upgrade changes it */
10031 have = esignlen + zeros + elen;
10033 if (is_utf8 != has_utf8) {
10036 sv_utf8_upgrade(sv);
10039 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
10040 sv_utf8_upgrade(nsv);
10044 SvGROW(sv, SvCUR(sv) + elen + 1);
10049 need = (have > width ? have : width);
10052 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10054 if (esignlen && fill == '0') {
10055 for (i = 0; i < (int)esignlen; i++)
10056 *p++ = esignbuf[i];
10058 if (gap && !left) {
10059 memset(p, fill, gap);
10062 if (esignlen && fill != '0') {
10063 for (i = 0; i < (int)esignlen; i++)
10064 *p++ = esignbuf[i];
10067 for (i = zeros; i; i--)
10071 Copy(eptr, p, elen, char);
10075 memset(p, ' ', gap);
10080 Copy(dotstr, p, dotstrlen, char);
10084 vectorize = FALSE; /* done iterating over vecstr */
10091 SvCUR_set(sv, p - SvPVX(sv));
10099 /* =========================================================================
10101 =head1 Cloning an interpreter
10103 All the macros and functions in this section are for the private use of
10104 the main function, perl_clone().
10106 The foo_dup() functions make an exact copy of an existing foo thinngy.
10107 During the course of a cloning, a hash table is used to map old addresses
10108 to new addresses. The table is created and manipulated with the
10109 ptr_table_* functions.
10113 ============================================================================*/
10116 #if defined(USE_ITHREADS)
10118 #ifndef GpREFCNT_inc
10119 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10123 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10124 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10125 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10126 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10127 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10128 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10129 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10130 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10131 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10132 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10133 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10134 #define SAVEPV(p) (p ? savepv(p) : Nullch)
10135 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
10138 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
10139 regcomp.c. AMS 20010712 */
10142 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
10147 struct reg_substr_datum *s;
10150 return (REGEXP *)NULL;
10152 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
10155 len = r->offsets[0];
10156 npar = r->nparens+1;
10158 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
10159 Copy(r->program, ret->program, len+1, regnode);
10161 New(0, ret->startp, npar, I32);
10162 Copy(r->startp, ret->startp, npar, I32);
10163 New(0, ret->endp, npar, I32);
10164 Copy(r->startp, ret->startp, npar, I32);
10166 New(0, ret->substrs, 1, struct reg_substr_data);
10167 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
10168 s->min_offset = r->substrs->data[i].min_offset;
10169 s->max_offset = r->substrs->data[i].max_offset;
10170 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
10171 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
10174 ret->regstclass = NULL;
10176 struct reg_data *d;
10177 const int count = r->data->count;
10179 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
10180 char, struct reg_data);
10181 New(0, d->what, count, U8);
10184 for (i = 0; i < count; i++) {
10185 d->what[i] = r->data->what[i];
10186 switch (d->what[i]) {
10187 /* legal options are one of: sfpont
10188 see also regcomp.h and pregfree() */
10190 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
10193 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
10196 /* This is cheating. */
10197 New(0, d->data[i], 1, struct regnode_charclass_class);
10198 StructCopy(r->data->data[i], d->data[i],
10199 struct regnode_charclass_class);
10200 ret->regstclass = (regnode*)d->data[i];
10203 /* Compiled op trees are readonly, and can thus be
10204 shared without duplication. */
10206 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
10210 d->data[i] = r->data->data[i];
10213 d->data[i] = r->data->data[i];
10215 ((reg_trie_data*)d->data[i])->refcount++;
10219 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
10228 New(0, ret->offsets, 2*len+1, U32);
10229 Copy(r->offsets, ret->offsets, 2*len+1, U32);
10231 ret->precomp = SAVEPVN(r->precomp, r->prelen);
10232 ret->refcnt = r->refcnt;
10233 ret->minlen = r->minlen;
10234 ret->prelen = r->prelen;
10235 ret->nparens = r->nparens;
10236 ret->lastparen = r->lastparen;
10237 ret->lastcloseparen = r->lastcloseparen;
10238 ret->reganch = r->reganch;
10240 ret->sublen = r->sublen;
10242 if (RX_MATCH_COPIED(ret))
10243 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
10245 ret->subbeg = Nullch;
10246 #ifdef PERL_COPY_ON_WRITE
10247 ret->saved_copy = Nullsv;
10250 ptr_table_store(PL_ptr_table, r, ret);
10254 /* duplicate a file handle */
10257 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
10263 return (PerlIO*)NULL;
10265 /* look for it in the table first */
10266 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10270 /* create anew and remember what it is */
10271 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10272 ptr_table_store(PL_ptr_table, fp, ret);
10276 /* duplicate a directory handle */
10279 Perl_dirp_dup(pTHX_ DIR *dp)
10287 /* duplicate a typeglob */
10290 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
10295 /* look for it in the table first */
10296 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10300 /* create anew and remember what it is */
10301 Newz(0, ret, 1, GP);
10302 ptr_table_store(PL_ptr_table, gp, ret);
10305 ret->gp_refcnt = 0; /* must be before any other dups! */
10306 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10307 ret->gp_io = io_dup_inc(gp->gp_io, param);
10308 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10309 ret->gp_av = av_dup_inc(gp->gp_av, param);
10310 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10311 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10312 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10313 ret->gp_cvgen = gp->gp_cvgen;
10314 ret->gp_flags = gp->gp_flags;
10315 ret->gp_line = gp->gp_line;
10316 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10320 /* duplicate a chain of magic */
10323 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10325 MAGIC *mgprev = (MAGIC*)NULL;
10328 return (MAGIC*)NULL;
10329 /* look for it in the table first */
10330 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10334 for (; mg; mg = mg->mg_moremagic) {
10336 Newz(0, nmg, 1, MAGIC);
10338 mgprev->mg_moremagic = nmg;
10341 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10342 nmg->mg_private = mg->mg_private;
10343 nmg->mg_type = mg->mg_type;
10344 nmg->mg_flags = mg->mg_flags;
10345 if (mg->mg_type == PERL_MAGIC_qr) {
10346 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10348 else if(mg->mg_type == PERL_MAGIC_backref) {
10349 const AV * const av = (AV*) mg->mg_obj;
10352 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10354 for (i = AvFILLp(av); i >= 0; i--) {
10355 if (!svp[i]) continue;
10356 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10360 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10361 ? sv_dup_inc(mg->mg_obj, param)
10362 : sv_dup(mg->mg_obj, param);
10364 nmg->mg_len = mg->mg_len;
10365 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10366 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10367 if (mg->mg_len > 0) {
10368 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10369 if (mg->mg_type == PERL_MAGIC_overload_table &&
10370 AMT_AMAGIC((AMT*)mg->mg_ptr))
10372 AMT *amtp = (AMT*)mg->mg_ptr;
10373 AMT *namtp = (AMT*)nmg->mg_ptr;
10375 for (i = 1; i < NofAMmeth; i++) {
10376 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10380 else if (mg->mg_len == HEf_SVKEY)
10381 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10383 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10384 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10391 /* create a new pointer-mapping table */
10394 Perl_ptr_table_new(pTHX)
10397 Newz(0, tbl, 1, PTR_TBL_t);
10398 tbl->tbl_max = 511;
10399 tbl->tbl_items = 0;
10400 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10405 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10407 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10410 /* map an existing pointer using a table */
10413 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10415 PTR_TBL_ENT_t *tblent;
10416 UV hash = PTR_TABLE_HASH(sv);
10418 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10419 for (; tblent; tblent = tblent->next) {
10420 if (tblent->oldval == sv)
10421 return tblent->newval;
10423 return (void*)NULL;
10426 /* add a new entry to a pointer-mapping table */
10429 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10431 PTR_TBL_ENT_t *tblent, **otblent;
10432 /* XXX this may be pessimal on platforms where pointers aren't good
10433 * hash values e.g. if they grow faster in the most significant
10435 UV hash = PTR_TABLE_HASH(oldv);
10439 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10440 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10441 if (tblent->oldval == oldv) {
10442 tblent->newval = newv;
10446 Newz(0, tblent, 1, PTR_TBL_ENT_t);
10447 tblent->oldval = oldv;
10448 tblent->newval = newv;
10449 tblent->next = *otblent;
10452 if (!empty && tbl->tbl_items > tbl->tbl_max)
10453 ptr_table_split(tbl);
10456 /* double the hash bucket size of an existing ptr table */
10459 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10461 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10462 UV oldsize = tbl->tbl_max + 1;
10463 UV newsize = oldsize * 2;
10466 Renew(ary, newsize, PTR_TBL_ENT_t*);
10467 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10468 tbl->tbl_max = --newsize;
10469 tbl->tbl_ary = ary;
10470 for (i=0; i < oldsize; i++, ary++) {
10471 PTR_TBL_ENT_t **curentp, **entp, *ent;
10474 curentp = ary + oldsize;
10475 for (entp = ary, ent = *ary; ent; ent = *entp) {
10476 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10478 ent->next = *curentp;
10488 /* remove all the entries from a ptr table */
10491 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10493 register PTR_TBL_ENT_t **array;
10494 register PTR_TBL_ENT_t *entry;
10495 register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
10499 if (!tbl || !tbl->tbl_items) {
10503 array = tbl->tbl_ary;
10505 max = tbl->tbl_max;
10510 entry = entry->next;
10514 if (++riter > max) {
10517 entry = array[riter];
10521 tbl->tbl_items = 0;
10524 /* clear and free a ptr table */
10527 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10532 ptr_table_clear(tbl);
10533 Safefree(tbl->tbl_ary);
10537 /* attempt to make everything in the typeglob readonly */
10540 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10542 GV *gv = (GV*)sstr;
10543 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10545 if (GvIO(gv) || GvFORM(gv)) {
10546 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10548 else if (!GvCV(gv)) {
10549 GvCV(gv) = (CV*)sv;
10552 /* CvPADLISTs cannot be shared */
10553 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10558 if (!GvUNIQUE(gv)) {
10560 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10561 HvNAME(GvSTASH(gv)), GvNAME(gv));
10567 * write attempts will die with
10568 * "Modification of a read-only value attempted"
10574 SvREADONLY_on(GvSV(gv));
10578 GvAV(gv) = (AV*)sv;
10581 SvREADONLY_on(GvAV(gv));
10585 GvHV(gv) = (HV*)sv;
10588 SvREADONLY_on(GvHV(gv));
10591 return sstr; /* he_dup() will SvREFCNT_inc() */
10594 /* duplicate an SV of any type (including AV, HV etc) */
10597 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10600 SvRV_set(dstr, SvWEAKREF(sstr)
10601 ? sv_dup(SvRV(sstr), param)
10602 : sv_dup_inc(SvRV(sstr), param));
10605 else if (SvPVX(sstr)) {
10606 /* Has something there */
10608 /* Normal PV - clone whole allocated space */
10609 SvPV_set(dstr, SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1));
10610 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10611 /* Not that normal - actually sstr is copy on write.
10612 But we are a true, independant SV, so: */
10613 SvREADONLY_off(dstr);
10618 /* Special case - not normally malloced for some reason */
10619 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10620 /* A "shared" PV - clone it as unshared string */
10621 if(SvPADTMP(sstr)) {
10622 /* However, some of them live in the pad
10623 and they should not have these flags
10626 SvPV_set(dstr, sharepvn(SvPVX(sstr), SvCUR(sstr),
10628 SvUV_set(dstr, SvUVX(sstr));
10631 SvPV_set(dstr, SAVEPVN(SvPVX(sstr), SvCUR(sstr)));
10633 SvREADONLY_off(dstr);
10637 /* Some other special case - random pointer */
10638 SvPV_set(dstr, SvPVX(sstr));
10643 /* Copy the Null */
10644 if (SvTYPE(dstr) == SVt_RV)
10645 SvRV_set(dstr, NULL);
10652 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10657 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10659 /* look for it in the table first */
10660 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10664 if(param->flags & CLONEf_JOIN_IN) {
10665 /** We are joining here so we don't want do clone
10666 something that is bad **/
10668 if(SvTYPE(sstr) == SVt_PVHV &&
10670 /** don't clone stashes if they already exist **/
10671 HV* old_stash = gv_stashpv(HvNAME(sstr),0);
10672 return (SV*) old_stash;
10676 /* create anew and remember what it is */
10679 #ifdef DEBUG_LEAKING_SCALARS
10680 dstr->sv_debug_optype = sstr->sv_debug_optype;
10681 dstr->sv_debug_line = sstr->sv_debug_line;
10682 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10683 dstr->sv_debug_cloned = 1;
10685 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10687 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10691 ptr_table_store(PL_ptr_table, sstr, dstr);
10694 SvFLAGS(dstr) = SvFLAGS(sstr);
10695 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10696 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10699 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
10700 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10701 PL_watch_pvx, SvPVX(sstr));
10704 /* don't clone objects whose class has asked us not to */
10705 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10706 SvFLAGS(dstr) &= ~SVTYPEMASK;
10707 SvOBJECT_off(dstr);
10711 switch (SvTYPE(sstr)) {
10713 SvANY(dstr) = NULL;
10716 SvANY(dstr) = new_XIV();
10717 SvIV_set(dstr, SvIVX(sstr));
10720 SvANY(dstr) = new_XNV();
10721 SvNV_set(dstr, SvNVX(sstr));
10724 SvANY(dstr) = new_XRV();
10725 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10728 SvANY(dstr) = new_XPV();
10729 SvCUR_set(dstr, SvCUR(sstr));
10730 SvLEN_set(dstr, SvLEN(sstr));
10731 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10734 SvANY(dstr) = new_XPVIV();
10735 SvCUR_set(dstr, SvCUR(sstr));
10736 SvLEN_set(dstr, SvLEN(sstr));
10737 SvIV_set(dstr, SvIVX(sstr));
10738 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10741 SvANY(dstr) = new_XPVNV();
10742 SvCUR_set(dstr, SvCUR(sstr));
10743 SvLEN_set(dstr, SvLEN(sstr));
10744 SvIV_set(dstr, SvIVX(sstr));
10745 SvNV_set(dstr, SvNVX(sstr));
10746 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10749 SvANY(dstr) = new_XPVMG();
10750 SvCUR_set(dstr, SvCUR(sstr));
10751 SvLEN_set(dstr, SvLEN(sstr));
10752 SvIV_set(dstr, SvIVX(sstr));
10753 SvNV_set(dstr, SvNVX(sstr));
10754 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10755 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10756 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10759 SvANY(dstr) = new_XPVBM();
10760 SvCUR_set(dstr, SvCUR(sstr));
10761 SvLEN_set(dstr, SvLEN(sstr));
10762 SvIV_set(dstr, SvIVX(sstr));
10763 SvNV_set(dstr, SvNVX(sstr));
10764 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10765 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10766 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10767 BmRARE(dstr) = BmRARE(sstr);
10768 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10769 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10772 SvANY(dstr) = new_XPVLV();
10773 SvCUR_set(dstr, SvCUR(sstr));
10774 SvLEN_set(dstr, SvLEN(sstr));
10775 SvIV_set(dstr, SvIVX(sstr));
10776 SvNV_set(dstr, SvNVX(sstr));
10777 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10778 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10779 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10780 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10781 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10782 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10783 LvTARG(dstr) = dstr;
10784 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10785 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10787 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10788 LvTYPE(dstr) = LvTYPE(sstr);
10791 if (GvUNIQUE((GV*)sstr)) {
10793 if ((share = gv_share(sstr, param))) {
10796 ptr_table_store(PL_ptr_table, sstr, dstr);
10798 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10799 HvNAME(GvSTASH(share)), GvNAME(share));
10804 SvANY(dstr) = new_XPVGV();
10805 SvCUR_set(dstr, SvCUR(sstr));
10806 SvLEN_set(dstr, SvLEN(sstr));
10807 SvIV_set(dstr, SvIVX(sstr));
10808 SvNV_set(dstr, SvNVX(sstr));
10809 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10810 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10811 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10812 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10813 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10814 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10815 GvFLAGS(dstr) = GvFLAGS(sstr);
10816 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10817 (void)GpREFCNT_inc(GvGP(dstr));
10820 SvANY(dstr) = new_XPVIO();
10821 SvCUR_set(dstr, SvCUR(sstr));
10822 SvLEN_set(dstr, SvLEN(sstr));
10823 SvIV_set(dstr, SvIVX(sstr));
10824 SvNV_set(dstr, SvNVX(sstr));
10825 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10826 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10827 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10828 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10829 if (IoOFP(sstr) == IoIFP(sstr))
10830 IoOFP(dstr) = IoIFP(dstr);
10832 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10833 /* PL_rsfp_filters entries have fake IoDIRP() */
10834 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10835 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10837 IoDIRP(dstr) = IoDIRP(sstr);
10838 IoLINES(dstr) = IoLINES(sstr);
10839 IoPAGE(dstr) = IoPAGE(sstr);
10840 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10841 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10842 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10843 /* I have no idea why fake dirp (rsfps)
10844 should be treaded differently but otherwise
10845 we end up with leaks -- sky*/
10846 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10847 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10848 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10850 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10851 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10852 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10854 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10855 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10856 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10857 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10858 IoTYPE(dstr) = IoTYPE(sstr);
10859 IoFLAGS(dstr) = IoFLAGS(sstr);
10862 SvANY(dstr) = new_XPVAV();
10863 SvCUR_set(dstr, SvCUR(sstr));
10864 SvLEN_set(dstr, SvLEN(sstr));
10865 SvIV_set(dstr, SvIVX(sstr));
10866 SvNV_set(dstr, SvNVX(sstr));
10867 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10868 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10869 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
10870 AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
10871 if (AvARRAY((AV*)sstr)) {
10872 SV **dst_ary, **src_ary;
10873 SSize_t items = AvFILLp((AV*)sstr) + 1;
10875 src_ary = AvARRAY((AV*)sstr);
10876 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10877 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10878 SvPV_set(dstr, (char*)dst_ary);
10879 AvALLOC((AV*)dstr) = dst_ary;
10880 if (AvREAL((AV*)sstr)) {
10881 while (items-- > 0)
10882 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10885 while (items-- > 0)
10886 *dst_ary++ = sv_dup(*src_ary++, param);
10888 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10889 while (items-- > 0) {
10890 *dst_ary++ = &PL_sv_undef;
10894 SvPV_set(dstr, Nullch);
10895 AvALLOC((AV*)dstr) = (SV**)NULL;
10899 SvANY(dstr) = new_XPVHV();
10900 SvCUR_set(dstr, SvCUR(sstr));
10901 SvLEN_set(dstr, SvLEN(sstr));
10902 SvIV_set(dstr, SvIVX(sstr));
10903 SvNV_set(dstr, SvNVX(sstr));
10904 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10905 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10906 HvRITER((HV*)dstr) = HvRITER((HV*)sstr);
10907 if (HvARRAY((HV*)sstr)) {
10909 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
10910 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
10911 Newz(0, dxhv->xhv_array,
10912 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
10913 while (i <= sxhv->xhv_max) {
10914 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
10915 (bool)!!HvSHAREKEYS(sstr),
10919 dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter,
10920 (bool)!!HvSHAREKEYS(sstr), param);
10923 SvPV_set(dstr, Nullch);
10924 HvEITER((HV*)dstr) = (HE*)NULL;
10926 HvPMROOT((HV*)dstr) = HvPMROOT((HV*)sstr); /* XXX */
10927 HvNAME((HV*)dstr) = SAVEPV(HvNAME((HV*)sstr));
10928 /* Record stashes for possible cloning in Perl_clone(). */
10929 if(HvNAME((HV*)dstr))
10930 av_push(param->stashes, dstr);
10933 SvANY(dstr) = new_XPVFM();
10934 FmLINES(dstr) = FmLINES(sstr);
10938 SvANY(dstr) = new_XPVCV();
10940 SvCUR_set(dstr, SvCUR(sstr));
10941 SvLEN_set(dstr, SvLEN(sstr));
10942 SvIV_set(dstr, SvIVX(sstr));
10943 SvNV_set(dstr, SvNVX(sstr));
10944 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10945 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
10946 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10947 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
10948 CvSTART(dstr) = CvSTART(sstr);
10950 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
10952 CvXSUB(dstr) = CvXSUB(sstr);
10953 CvXSUBANY(dstr) = CvXSUBANY(sstr);
10954 if (CvCONST(sstr)) {
10955 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
10956 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
10957 sv_dup_inc((SV *)CvXSUBANY(sstr).any_ptr, param);
10959 /* don't dup if copying back - CvGV isn't refcounted, so the
10960 * duped GV may never be freed. A bit of a hack! DAPM */
10961 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10962 Nullgv : gv_dup(CvGV(sstr), param) ;
10963 if (param->flags & CLONEf_COPY_STACKS) {
10964 CvDEPTH(dstr) = CvDEPTH(sstr);
10968 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
10969 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
10971 CvWEAKOUTSIDE(sstr)
10972 ? cv_dup( CvOUTSIDE(sstr), param)
10973 : cv_dup_inc(CvOUTSIDE(sstr), param);
10974 CvFLAGS(dstr) = CvFLAGS(sstr);
10975 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
10978 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
10982 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
10988 /* duplicate a context */
10991 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
10993 PERL_CONTEXT *ncxs;
10996 return (PERL_CONTEXT*)NULL;
10998 /* look for it in the table first */
10999 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
11003 /* create anew and remember what it is */
11004 Newz(56, ncxs, max + 1, PERL_CONTEXT);
11005 ptr_table_store(PL_ptr_table, cxs, ncxs);
11008 PERL_CONTEXT *cx = &cxs[ix];
11009 PERL_CONTEXT *ncx = &ncxs[ix];
11010 ncx->cx_type = cx->cx_type;
11011 if (CxTYPE(cx) == CXt_SUBST) {
11012 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
11015 ncx->blk_oldsp = cx->blk_oldsp;
11016 ncx->blk_oldcop = cx->blk_oldcop;
11017 ncx->blk_oldmarksp = cx->blk_oldmarksp;
11018 ncx->blk_oldscopesp = cx->blk_oldscopesp;
11019 ncx->blk_oldpm = cx->blk_oldpm;
11020 ncx->blk_gimme = cx->blk_gimme;
11021 switch (CxTYPE(cx)) {
11023 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
11024 ? cv_dup_inc(cx->blk_sub.cv, param)
11025 : cv_dup(cx->blk_sub.cv,param));
11026 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
11027 ? av_dup_inc(cx->blk_sub.argarray, param)
11029 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
11030 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
11031 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11032 ncx->blk_sub.lval = cx->blk_sub.lval;
11033 ncx->blk_sub.retop = cx->blk_sub.retop;
11036 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
11037 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
11038 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
11039 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
11040 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
11041 ncx->blk_eval.retop = cx->blk_eval.retop;
11044 ncx->blk_loop.label = cx->blk_loop.label;
11045 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
11046 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
11047 ncx->blk_loop.next_op = cx->blk_loop.next_op;
11048 ncx->blk_loop.last_op = cx->blk_loop.last_op;
11049 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
11050 ? cx->blk_loop.iterdata
11051 : gv_dup((GV*)cx->blk_loop.iterdata, param));
11052 ncx->blk_loop.oldcomppad
11053 = (PAD*)ptr_table_fetch(PL_ptr_table,
11054 cx->blk_loop.oldcomppad);
11055 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
11056 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
11057 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
11058 ncx->blk_loop.iterix = cx->blk_loop.iterix;
11059 ncx->blk_loop.itermax = cx->blk_loop.itermax;
11062 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
11063 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
11064 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
11065 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11066 ncx->blk_sub.retop = cx->blk_sub.retop;
11078 /* duplicate a stack info structure */
11081 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
11086 return (PERL_SI*)NULL;
11088 /* look for it in the table first */
11089 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11093 /* create anew and remember what it is */
11094 Newz(56, nsi, 1, PERL_SI);
11095 ptr_table_store(PL_ptr_table, si, nsi);
11097 nsi->si_stack = av_dup_inc(si->si_stack, param);
11098 nsi->si_cxix = si->si_cxix;
11099 nsi->si_cxmax = si->si_cxmax;
11100 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
11101 nsi->si_type = si->si_type;
11102 nsi->si_prev = si_dup(si->si_prev, param);
11103 nsi->si_next = si_dup(si->si_next, param);
11104 nsi->si_markoff = si->si_markoff;
11109 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11110 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
11111 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11112 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
11113 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11114 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
11115 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11116 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
11117 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11118 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11119 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11120 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11121 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11122 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11125 #define pv_dup_inc(p) SAVEPV(p)
11126 #define pv_dup(p) SAVEPV(p)
11127 #define svp_dup_inc(p,pp) any_dup(p,pp)
11129 /* map any object to the new equivent - either something in the
11130 * ptr table, or something in the interpreter structure
11134 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
11139 return (void*)NULL;
11141 /* look for it in the table first */
11142 ret = ptr_table_fetch(PL_ptr_table, v);
11146 /* see if it is part of the interpreter structure */
11147 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11148 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11156 /* duplicate the save stack */
11159 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11161 ANY *ss = proto_perl->Tsavestack;
11162 I32 ix = proto_perl->Tsavestack_ix;
11163 I32 max = proto_perl->Tsavestack_max;
11176 void (*dptr) (void*);
11177 void (*dxptr) (pTHX_ void*);
11180 Newz(54, nss, max, ANY);
11184 TOPINT(nss,ix) = i;
11186 case SAVEt_ITEM: /* normal string */
11187 sv = (SV*)POPPTR(ss,ix);
11188 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11189 sv = (SV*)POPPTR(ss,ix);
11190 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11192 case SAVEt_SV: /* scalar reference */
11193 sv = (SV*)POPPTR(ss,ix);
11194 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11195 gv = (GV*)POPPTR(ss,ix);
11196 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11198 case SAVEt_GENERIC_PVREF: /* generic char* */
11199 c = (char*)POPPTR(ss,ix);
11200 TOPPTR(nss,ix) = pv_dup(c);
11201 ptr = POPPTR(ss,ix);
11202 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11204 case SAVEt_SHARED_PVREF: /* char* in shared space */
11205 c = (char*)POPPTR(ss,ix);
11206 TOPPTR(nss,ix) = savesharedpv(c);
11207 ptr = POPPTR(ss,ix);
11208 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11210 case SAVEt_GENERIC_SVREF: /* generic sv */
11211 case SAVEt_SVREF: /* scalar reference */
11212 sv = (SV*)POPPTR(ss,ix);
11213 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11214 ptr = POPPTR(ss,ix);
11215 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11217 case SAVEt_AV: /* array reference */
11218 av = (AV*)POPPTR(ss,ix);
11219 TOPPTR(nss,ix) = av_dup_inc(av, param);
11220 gv = (GV*)POPPTR(ss,ix);
11221 TOPPTR(nss,ix) = gv_dup(gv, param);
11223 case SAVEt_HV: /* hash reference */
11224 hv = (HV*)POPPTR(ss,ix);
11225 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11226 gv = (GV*)POPPTR(ss,ix);
11227 TOPPTR(nss,ix) = gv_dup(gv, param);
11229 case SAVEt_INT: /* int reference */
11230 ptr = POPPTR(ss,ix);
11231 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11232 intval = (int)POPINT(ss,ix);
11233 TOPINT(nss,ix) = intval;
11235 case SAVEt_LONG: /* long reference */
11236 ptr = POPPTR(ss,ix);
11237 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11238 longval = (long)POPLONG(ss,ix);
11239 TOPLONG(nss,ix) = longval;
11241 case SAVEt_I32: /* I32 reference */
11242 case SAVEt_I16: /* I16 reference */
11243 case SAVEt_I8: /* I8 reference */
11244 ptr = POPPTR(ss,ix);
11245 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11247 TOPINT(nss,ix) = i;
11249 case SAVEt_IV: /* IV reference */
11250 ptr = POPPTR(ss,ix);
11251 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11253 TOPIV(nss,ix) = iv;
11255 case SAVEt_SPTR: /* SV* reference */
11256 ptr = POPPTR(ss,ix);
11257 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11258 sv = (SV*)POPPTR(ss,ix);
11259 TOPPTR(nss,ix) = sv_dup(sv, param);
11261 case SAVEt_VPTR: /* random* reference */
11262 ptr = POPPTR(ss,ix);
11263 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11264 ptr = POPPTR(ss,ix);
11265 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11267 case SAVEt_PPTR: /* char* reference */
11268 ptr = POPPTR(ss,ix);
11269 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11270 c = (char*)POPPTR(ss,ix);
11271 TOPPTR(nss,ix) = pv_dup(c);
11273 case SAVEt_HPTR: /* HV* reference */
11274 ptr = POPPTR(ss,ix);
11275 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11276 hv = (HV*)POPPTR(ss,ix);
11277 TOPPTR(nss,ix) = hv_dup(hv, param);
11279 case SAVEt_APTR: /* AV* reference */
11280 ptr = POPPTR(ss,ix);
11281 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11282 av = (AV*)POPPTR(ss,ix);
11283 TOPPTR(nss,ix) = av_dup(av, param);
11286 gv = (GV*)POPPTR(ss,ix);
11287 TOPPTR(nss,ix) = gv_dup(gv, param);
11289 case SAVEt_GP: /* scalar reference */
11290 gp = (GP*)POPPTR(ss,ix);
11291 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11292 (void)GpREFCNT_inc(gp);
11293 gv = (GV*)POPPTR(ss,ix);
11294 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11295 c = (char*)POPPTR(ss,ix);
11296 TOPPTR(nss,ix) = pv_dup(c);
11298 TOPIV(nss,ix) = iv;
11300 TOPIV(nss,ix) = iv;
11303 case SAVEt_MORTALIZESV:
11304 sv = (SV*)POPPTR(ss,ix);
11305 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11308 ptr = POPPTR(ss,ix);
11309 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11310 /* these are assumed to be refcounted properly */
11311 switch (((OP*)ptr)->op_type) {
11313 case OP_LEAVESUBLV:
11317 case OP_LEAVEWRITE:
11318 TOPPTR(nss,ix) = ptr;
11323 TOPPTR(nss,ix) = Nullop;
11328 TOPPTR(nss,ix) = Nullop;
11331 c = (char*)POPPTR(ss,ix);
11332 TOPPTR(nss,ix) = pv_dup_inc(c);
11334 case SAVEt_CLEARSV:
11335 longval = POPLONG(ss,ix);
11336 TOPLONG(nss,ix) = longval;
11339 hv = (HV*)POPPTR(ss,ix);
11340 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11341 c = (char*)POPPTR(ss,ix);
11342 TOPPTR(nss,ix) = pv_dup_inc(c);
11344 TOPINT(nss,ix) = i;
11346 case SAVEt_DESTRUCTOR:
11347 ptr = POPPTR(ss,ix);
11348 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11349 dptr = POPDPTR(ss,ix);
11350 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
11352 case SAVEt_DESTRUCTOR_X:
11353 ptr = POPPTR(ss,ix);
11354 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11355 dxptr = POPDXPTR(ss,ix);
11356 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
11358 case SAVEt_REGCONTEXT:
11361 TOPINT(nss,ix) = i;
11364 case SAVEt_STACK_POS: /* Position on Perl stack */
11366 TOPINT(nss,ix) = i;
11368 case SAVEt_AELEM: /* array element */
11369 sv = (SV*)POPPTR(ss,ix);
11370 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11372 TOPINT(nss,ix) = i;
11373 av = (AV*)POPPTR(ss,ix);
11374 TOPPTR(nss,ix) = av_dup_inc(av, param);
11376 case SAVEt_HELEM: /* hash element */
11377 sv = (SV*)POPPTR(ss,ix);
11378 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11379 sv = (SV*)POPPTR(ss,ix);
11380 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11381 hv = (HV*)POPPTR(ss,ix);
11382 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11385 ptr = POPPTR(ss,ix);
11386 TOPPTR(nss,ix) = ptr;
11390 TOPINT(nss,ix) = i;
11392 case SAVEt_COMPPAD:
11393 av = (AV*)POPPTR(ss,ix);
11394 TOPPTR(nss,ix) = av_dup(av, param);
11397 longval = (long)POPLONG(ss,ix);
11398 TOPLONG(nss,ix) = longval;
11399 ptr = POPPTR(ss,ix);
11400 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11401 sv = (SV*)POPPTR(ss,ix);
11402 TOPPTR(nss,ix) = sv_dup(sv, param);
11405 ptr = POPPTR(ss,ix);
11406 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11407 longval = (long)POPBOOL(ss,ix);
11408 TOPBOOL(nss,ix) = (bool)longval;
11410 case SAVEt_SET_SVFLAGS:
11412 TOPINT(nss,ix) = i;
11414 TOPINT(nss,ix) = i;
11415 sv = (SV*)POPPTR(ss,ix);
11416 TOPPTR(nss,ix) = sv_dup(sv, param);
11419 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11427 /* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11428 * flag to the result. This is done for each stash before cloning starts,
11429 * so we know which stashes want their objects cloned */
11432 do_mark_cloneable_stash(pTHX_ SV *sv)
11434 if (HvNAME((HV*)sv)) {
11435 GV* cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11436 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11437 if (cloner && GvCV(cloner)) {
11444 XPUSHs(sv_2mortal(newSVpv(HvNAME((HV*)sv), 0)));
11446 call_sv((SV*)GvCV(cloner), G_SCALAR);
11453 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11461 =for apidoc perl_clone
11463 Create and return a new interpreter by cloning the current one.
11465 perl_clone takes these flags as parameters:
11467 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11468 without it we only clone the data and zero the stacks,
11469 with it we copy the stacks and the new perl interpreter is
11470 ready to run at the exact same point as the previous one.
11471 The pseudo-fork code uses COPY_STACKS while the
11472 threads->new doesn't.
11474 CLONEf_KEEP_PTR_TABLE
11475 perl_clone keeps a ptr_table with the pointer of the old
11476 variable as a key and the new variable as a value,
11477 this allows it to check if something has been cloned and not
11478 clone it again but rather just use the value and increase the
11479 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11480 the ptr_table using the function
11481 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11482 reason to keep it around is if you want to dup some of your own
11483 variable who are outside the graph perl scans, example of this
11484 code is in threads.xs create
11487 This is a win32 thing, it is ignored on unix, it tells perls
11488 win32host code (which is c++) to clone itself, this is needed on
11489 win32 if you want to run two threads at the same time,
11490 if you just want to do some stuff in a separate perl interpreter
11491 and then throw it away and return to the original one,
11492 you don't need to do anything.
11497 /* XXX the above needs expanding by someone who actually understands it ! */
11498 EXTERN_C PerlInterpreter *
11499 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11502 perl_clone(PerlInterpreter *proto_perl, UV flags)
11505 #ifdef PERL_IMPLICIT_SYS
11507 /* perlhost.h so we need to call into it
11508 to clone the host, CPerlHost should have a c interface, sky */
11510 if (flags & CLONEf_CLONE_HOST) {
11511 return perl_clone_host(proto_perl,flags);
11513 return perl_clone_using(proto_perl, flags,
11515 proto_perl->IMemShared,
11516 proto_perl->IMemParse,
11518 proto_perl->IStdIO,
11522 proto_perl->IProc);
11526 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11527 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11528 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11529 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11530 struct IPerlDir* ipD, struct IPerlSock* ipS,
11531 struct IPerlProc* ipP)
11533 /* XXX many of the string copies here can be optimized if they're
11534 * constants; they need to be allocated as common memory and just
11535 * their pointers copied. */
11538 CLONE_PARAMS clone_params;
11539 CLONE_PARAMS* param = &clone_params;
11541 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11542 /* for each stash, determine whether its objects should be cloned */
11543 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11544 PERL_SET_THX(my_perl);
11547 Poison(my_perl, 1, PerlInterpreter);
11549 PL_curcop = (COP *)Nullop;
11553 PL_savestack_ix = 0;
11554 PL_savestack_max = -1;
11555 PL_sig_pending = 0;
11556 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11557 # else /* !DEBUGGING */
11558 Zero(my_perl, 1, PerlInterpreter);
11559 # endif /* DEBUGGING */
11561 /* host pointers */
11563 PL_MemShared = ipMS;
11564 PL_MemParse = ipMP;
11571 #else /* !PERL_IMPLICIT_SYS */
11573 CLONE_PARAMS clone_params;
11574 CLONE_PARAMS* param = &clone_params;
11575 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11576 /* for each stash, determine whether its objects should be cloned */
11577 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
11578 PERL_SET_THX(my_perl);
11581 Poison(my_perl, 1, PerlInterpreter);
11583 PL_curcop = (COP *)Nullop;
11587 PL_savestack_ix = 0;
11588 PL_savestack_max = -1;
11589 PL_sig_pending = 0;
11590 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11591 # else /* !DEBUGGING */
11592 Zero(my_perl, 1, PerlInterpreter);
11593 # endif /* DEBUGGING */
11594 #endif /* PERL_IMPLICIT_SYS */
11595 param->flags = flags;
11596 param->proto_perl = proto_perl;
11599 PL_xiv_arenaroot = NULL;
11600 PL_xiv_root = NULL;
11601 PL_xnv_arenaroot = NULL;
11602 PL_xnv_root = NULL;
11603 PL_xrv_arenaroot = NULL;
11604 PL_xrv_root = NULL;
11605 PL_xpv_arenaroot = NULL;
11606 PL_xpv_root = NULL;
11607 PL_xpviv_arenaroot = NULL;
11608 PL_xpviv_root = NULL;
11609 PL_xpvnv_arenaroot = NULL;
11610 PL_xpvnv_root = NULL;
11611 PL_xpvcv_arenaroot = NULL;
11612 PL_xpvcv_root = NULL;
11613 PL_xpvav_arenaroot = NULL;
11614 PL_xpvav_root = NULL;
11615 PL_xpvhv_arenaroot = NULL;
11616 PL_xpvhv_root = NULL;
11617 PL_xpvmg_arenaroot = NULL;
11618 PL_xpvmg_root = NULL;
11619 PL_xpvlv_arenaroot = NULL;
11620 PL_xpvlv_root = NULL;
11621 PL_xpvbm_arenaroot = NULL;
11622 PL_xpvbm_root = NULL;
11623 PL_he_arenaroot = NULL;
11625 PL_nice_chunk = NULL;
11626 PL_nice_chunk_size = 0;
11628 PL_sv_objcount = 0;
11629 PL_sv_root = Nullsv;
11630 PL_sv_arenaroot = Nullsv;
11632 PL_debug = proto_perl->Idebug;
11634 #ifdef USE_REENTRANT_API
11635 /* XXX: things like -Dm will segfault here in perlio, but doing
11636 * PERL_SET_CONTEXT(proto_perl);
11637 * breaks too many other things
11639 Perl_reentrant_init(aTHX);
11642 /* create SV map for pointer relocation */
11643 PL_ptr_table = ptr_table_new();
11645 /* initialize these special pointers as early as possible */
11646 SvANY(&PL_sv_undef) = NULL;
11647 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11648 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11649 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11651 SvANY(&PL_sv_no) = new_XPVNV();
11652 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11653 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11654 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11655 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
11656 SvCUR_set(&PL_sv_no, 0);
11657 SvLEN_set(&PL_sv_no, 1);
11658 SvIV_set(&PL_sv_no, 0);
11659 SvNV_set(&PL_sv_no, 0);
11660 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11662 SvANY(&PL_sv_yes) = new_XPVNV();
11663 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11664 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11665 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11666 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
11667 SvCUR_set(&PL_sv_yes, 1);
11668 SvLEN_set(&PL_sv_yes, 2);
11669 SvIV_set(&PL_sv_yes, 1);
11670 SvNV_set(&PL_sv_yes, 1);
11671 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11673 /* create (a non-shared!) shared string table */
11674 PL_strtab = newHV();
11675 HvSHAREKEYS_off(PL_strtab);
11676 hv_ksplit(PL_strtab, 512);
11677 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11679 PL_compiling = proto_perl->Icompiling;
11681 /* These two PVs will be free'd special way so must set them same way op.c does */
11682 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11683 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11685 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11686 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11688 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11689 if (!specialWARN(PL_compiling.cop_warnings))
11690 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11691 if (!specialCopIO(PL_compiling.cop_io))
11692 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11693 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11695 /* pseudo environmental stuff */
11696 PL_origargc = proto_perl->Iorigargc;
11697 PL_origargv = proto_perl->Iorigargv;
11699 param->stashes = newAV(); /* Setup array of objects to call clone on */
11701 #ifdef PERLIO_LAYERS
11702 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11703 PerlIO_clone(aTHX_ proto_perl, param);
11706 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11707 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11708 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11709 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11710 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11711 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11714 PL_minus_c = proto_perl->Iminus_c;
11715 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11716 PL_localpatches = proto_perl->Ilocalpatches;
11717 PL_splitstr = proto_perl->Isplitstr;
11718 PL_preprocess = proto_perl->Ipreprocess;
11719 PL_minus_n = proto_perl->Iminus_n;
11720 PL_minus_p = proto_perl->Iminus_p;
11721 PL_minus_l = proto_perl->Iminus_l;
11722 PL_minus_a = proto_perl->Iminus_a;
11723 PL_minus_F = proto_perl->Iminus_F;
11724 PL_doswitches = proto_perl->Idoswitches;
11725 PL_dowarn = proto_perl->Idowarn;
11726 PL_doextract = proto_perl->Idoextract;
11727 PL_sawampersand = proto_perl->Isawampersand;
11728 PL_unsafe = proto_perl->Iunsafe;
11729 PL_inplace = SAVEPV(proto_perl->Iinplace);
11730 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11731 PL_perldb = proto_perl->Iperldb;
11732 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11733 PL_exit_flags = proto_perl->Iexit_flags;
11735 /* magical thingies */
11736 /* XXX time(&PL_basetime) when asked for? */
11737 PL_basetime = proto_perl->Ibasetime;
11738 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11740 PL_maxsysfd = proto_perl->Imaxsysfd;
11741 PL_multiline = proto_perl->Imultiline;
11742 PL_statusvalue = proto_perl->Istatusvalue;
11744 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11746 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11748 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11749 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11750 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11752 /* Clone the regex array */
11753 PL_regex_padav = newAV();
11755 I32 len = av_len((AV*)proto_perl->Iregex_padav);
11756 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11757 av_push(PL_regex_padav,
11758 sv_dup_inc(regexen[0],param));
11759 for(i = 1; i <= len; i++) {
11760 if(SvREPADTMP(regexen[i])) {
11761 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11763 av_push(PL_regex_padav,
11765 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11766 SvIVX(regexen[i])), param)))
11771 PL_regex_pad = AvARRAY(PL_regex_padav);
11773 /* shortcuts to various I/O objects */
11774 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11775 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11776 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11777 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11778 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11779 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11781 /* shortcuts to regexp stuff */
11782 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11784 /* shortcuts to misc objects */
11785 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11787 /* shortcuts to debugging objects */
11788 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11789 PL_DBline = gv_dup(proto_perl->IDBline, param);
11790 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11791 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11792 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11793 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11794 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11795 PL_lineary = av_dup(proto_perl->Ilineary, param);
11796 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11798 /* symbol tables */
11799 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11800 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11801 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11802 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11803 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11805 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11806 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11807 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11808 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11809 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11810 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11812 PL_sub_generation = proto_perl->Isub_generation;
11814 /* funky return mechanisms */
11815 PL_forkprocess = proto_perl->Iforkprocess;
11817 /* subprocess state */
11818 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11820 /* internal state */
11821 PL_tainting = proto_perl->Itainting;
11822 PL_taint_warn = proto_perl->Itaint_warn;
11823 PL_maxo = proto_perl->Imaxo;
11824 if (proto_perl->Iop_mask)
11825 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11827 PL_op_mask = Nullch;
11828 /* PL_asserting = proto_perl->Iasserting; */
11830 /* current interpreter roots */
11831 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11832 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11833 PL_main_start = proto_perl->Imain_start;
11834 PL_eval_root = proto_perl->Ieval_root;
11835 PL_eval_start = proto_perl->Ieval_start;
11837 /* runtime control stuff */
11838 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11839 PL_copline = proto_perl->Icopline;
11841 PL_filemode = proto_perl->Ifilemode;
11842 PL_lastfd = proto_perl->Ilastfd;
11843 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11846 PL_gensym = proto_perl->Igensym;
11847 PL_preambled = proto_perl->Ipreambled;
11848 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11849 PL_laststatval = proto_perl->Ilaststatval;
11850 PL_laststype = proto_perl->Ilaststype;
11851 PL_mess_sv = Nullsv;
11853 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11854 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11856 /* interpreter atexit processing */
11857 PL_exitlistlen = proto_perl->Iexitlistlen;
11858 if (PL_exitlistlen) {
11859 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11860 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11863 PL_exitlist = (PerlExitListEntry*)NULL;
11864 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11865 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11866 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11868 PL_profiledata = NULL;
11869 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11870 /* PL_rsfp_filters entries have fake IoDIRP() */
11871 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11873 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11875 PAD_CLONE_VARS(proto_perl, param);
11877 #ifdef HAVE_INTERP_INTERN
11878 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11881 /* more statics moved here */
11882 PL_generation = proto_perl->Igeneration;
11883 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11885 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11886 PL_in_clean_all = proto_perl->Iin_clean_all;
11888 PL_uid = proto_perl->Iuid;
11889 PL_euid = proto_perl->Ieuid;
11890 PL_gid = proto_perl->Igid;
11891 PL_egid = proto_perl->Iegid;
11892 PL_nomemok = proto_perl->Inomemok;
11893 PL_an = proto_perl->Ian;
11894 PL_evalseq = proto_perl->Ievalseq;
11895 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11896 PL_origalen = proto_perl->Iorigalen;
11897 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11898 PL_osname = SAVEPV(proto_perl->Iosname);
11899 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
11900 PL_sighandlerp = proto_perl->Isighandlerp;
11903 PL_runops = proto_perl->Irunops;
11905 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11908 PL_cshlen = proto_perl->Icshlen;
11909 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11912 PL_lex_state = proto_perl->Ilex_state;
11913 PL_lex_defer = proto_perl->Ilex_defer;
11914 PL_lex_expect = proto_perl->Ilex_expect;
11915 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11916 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11917 PL_lex_starts = proto_perl->Ilex_starts;
11918 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11919 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11920 PL_lex_op = proto_perl->Ilex_op;
11921 PL_lex_inpat = proto_perl->Ilex_inpat;
11922 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11923 PL_lex_brackets = proto_perl->Ilex_brackets;
11924 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11925 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11926 PL_lex_casemods = proto_perl->Ilex_casemods;
11927 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11928 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11930 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11931 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11932 PL_nexttoke = proto_perl->Inexttoke;
11934 /* XXX This is probably masking the deeper issue of why
11935 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11936 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11937 * (A little debugging with a watchpoint on it may help.)
11939 if (SvANY(proto_perl->Ilinestr)) {
11940 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11941 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
11942 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11943 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
11944 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11945 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
11946 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11947 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
11948 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11951 PL_linestr = NEWSV(65,79);
11952 sv_upgrade(PL_linestr,SVt_PVIV);
11953 sv_setpvn(PL_linestr,"",0);
11954 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11956 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11957 PL_pending_ident = proto_perl->Ipending_ident;
11958 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11960 PL_expect = proto_perl->Iexpect;
11962 PL_multi_start = proto_perl->Imulti_start;
11963 PL_multi_end = proto_perl->Imulti_end;
11964 PL_multi_open = proto_perl->Imulti_open;
11965 PL_multi_close = proto_perl->Imulti_close;
11967 PL_error_count = proto_perl->Ierror_count;
11968 PL_subline = proto_perl->Isubline;
11969 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11971 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11972 if (SvANY(proto_perl->Ilinestr)) {
11973 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
11974 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11975 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
11976 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11977 PL_last_lop_op = proto_perl->Ilast_lop_op;
11980 PL_last_uni = SvPVX(PL_linestr);
11981 PL_last_lop = SvPVX(PL_linestr);
11982 PL_last_lop_op = 0;
11984 PL_in_my = proto_perl->Iin_my;
11985 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11987 PL_cryptseen = proto_perl->Icryptseen;
11990 PL_hints = proto_perl->Ihints;
11992 PL_amagic_generation = proto_perl->Iamagic_generation;
11994 #ifdef USE_LOCALE_COLLATE
11995 PL_collation_ix = proto_perl->Icollation_ix;
11996 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11997 PL_collation_standard = proto_perl->Icollation_standard;
11998 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11999 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
12000 #endif /* USE_LOCALE_COLLATE */
12002 #ifdef USE_LOCALE_NUMERIC
12003 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
12004 PL_numeric_standard = proto_perl->Inumeric_standard;
12005 PL_numeric_local = proto_perl->Inumeric_local;
12006 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
12007 #endif /* !USE_LOCALE_NUMERIC */
12009 /* utf8 character classes */
12010 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
12011 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
12012 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
12013 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
12014 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
12015 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
12016 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
12017 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
12018 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
12019 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
12020 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
12021 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
12022 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
12023 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
12024 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
12025 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
12026 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
12027 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
12028 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
12029 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
12031 /* Did the locale setup indicate UTF-8? */
12032 PL_utf8locale = proto_perl->Iutf8locale;
12033 /* Unicode features (see perlrun/-C) */
12034 PL_unicode = proto_perl->Iunicode;
12036 /* Pre-5.8 signals control */
12037 PL_signals = proto_perl->Isignals;
12039 /* times() ticks per second */
12040 PL_clocktick = proto_perl->Iclocktick;
12042 /* Recursion stopper for PerlIO_find_layer */
12043 PL_in_load_module = proto_perl->Iin_load_module;
12045 /* sort() routine */
12046 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
12048 /* Not really needed/useful since the reenrant_retint is "volatile",
12049 * but do it for consistency's sake. */
12050 PL_reentrant_retint = proto_perl->Ireentrant_retint;
12052 /* Hooks to shared SVs and locks. */
12053 PL_sharehook = proto_perl->Isharehook;
12054 PL_lockhook = proto_perl->Ilockhook;
12055 PL_unlockhook = proto_perl->Iunlockhook;
12056 PL_threadhook = proto_perl->Ithreadhook;
12058 PL_runops_std = proto_perl->Irunops_std;
12059 PL_runops_dbg = proto_perl->Irunops_dbg;
12061 #ifdef THREADS_HAVE_PIDS
12062 PL_ppid = proto_perl->Ippid;
12066 PL_last_swash_hv = Nullhv; /* reinits on demand */
12067 PL_last_swash_klen = 0;
12068 PL_last_swash_key[0]= '\0';
12069 PL_last_swash_tmps = (U8*)NULL;
12070 PL_last_swash_slen = 0;
12072 PL_glob_index = proto_perl->Iglob_index;
12073 PL_srand_called = proto_perl->Isrand_called;
12074 PL_hash_seed = proto_perl->Ihash_seed;
12075 PL_rehash_seed = proto_perl->Irehash_seed;
12076 PL_uudmap['M'] = 0; /* reinits on demand */
12077 PL_bitcount = Nullch; /* reinits on demand */
12079 if (proto_perl->Ipsig_pend) {
12080 Newz(0, PL_psig_pend, SIG_SIZE, int);
12083 PL_psig_pend = (int*)NULL;
12086 if (proto_perl->Ipsig_ptr) {
12087 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
12088 Newz(0, PL_psig_name, SIG_SIZE, SV*);
12089 for (i = 1; i < SIG_SIZE; i++) {
12090 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
12091 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
12095 PL_psig_ptr = (SV**)NULL;
12096 PL_psig_name = (SV**)NULL;
12099 /* thrdvar.h stuff */
12101 if (flags & CLONEf_COPY_STACKS) {
12102 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12103 PL_tmps_ix = proto_perl->Ttmps_ix;
12104 PL_tmps_max = proto_perl->Ttmps_max;
12105 PL_tmps_floor = proto_perl->Ttmps_floor;
12106 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
12108 while (i <= PL_tmps_ix) {
12109 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
12113 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
12114 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
12115 Newz(54, PL_markstack, i, I32);
12116 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
12117 - proto_perl->Tmarkstack);
12118 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
12119 - proto_perl->Tmarkstack);
12120 Copy(proto_perl->Tmarkstack, PL_markstack,
12121 PL_markstack_ptr - PL_markstack + 1, I32);
12123 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12124 * NOTE: unlike the others! */
12125 PL_scopestack_ix = proto_perl->Tscopestack_ix;
12126 PL_scopestack_max = proto_perl->Tscopestack_max;
12127 Newz(54, PL_scopestack, PL_scopestack_max, I32);
12128 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
12130 /* NOTE: si_dup() looks at PL_markstack */
12131 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
12133 /* PL_curstack = PL_curstackinfo->si_stack; */
12134 PL_curstack = av_dup(proto_perl->Tcurstack, param);
12135 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
12137 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12138 PL_stack_base = AvARRAY(PL_curstack);
12139 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
12140 - proto_perl->Tstack_base);
12141 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12143 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12144 * NOTE: unlike the others! */
12145 PL_savestack_ix = proto_perl->Tsavestack_ix;
12146 PL_savestack_max = proto_perl->Tsavestack_max;
12147 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
12148 PL_savestack = ss_dup(proto_perl, param);
12152 ENTER; /* perl_destruct() wants to LEAVE; */
12155 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
12156 PL_top_env = &PL_start_env;
12158 PL_op = proto_perl->Top;
12161 PL_Xpv = (XPV*)NULL;
12162 PL_na = proto_perl->Tna;
12164 PL_statbuf = proto_perl->Tstatbuf;
12165 PL_statcache = proto_perl->Tstatcache;
12166 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
12167 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
12169 PL_timesbuf = proto_perl->Ttimesbuf;
12172 PL_tainted = proto_perl->Ttainted;
12173 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
12174 PL_rs = sv_dup_inc(proto_perl->Trs, param);
12175 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
12176 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
12177 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
12178 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
12179 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
12180 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
12181 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
12183 PL_restartop = proto_perl->Trestartop;
12184 PL_in_eval = proto_perl->Tin_eval;
12185 PL_delaymagic = proto_perl->Tdelaymagic;
12186 PL_dirty = proto_perl->Tdirty;
12187 PL_localizing = proto_perl->Tlocalizing;
12189 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
12190 PL_hv_fetch_ent_mh = Nullhe;
12191 PL_modcount = proto_perl->Tmodcount;
12192 PL_lastgotoprobe = Nullop;
12193 PL_dumpindent = proto_perl->Tdumpindent;
12195 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
12196 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
12197 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
12198 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
12199 PL_sortcxix = proto_perl->Tsortcxix;
12200 PL_efloatbuf = Nullch; /* reinits on demand */
12201 PL_efloatsize = 0; /* reinits on demand */
12205 PL_screamfirst = NULL;
12206 PL_screamnext = NULL;
12207 PL_maxscream = -1; /* reinits on demand */
12208 PL_lastscream = Nullsv;
12210 PL_watchaddr = NULL;
12211 PL_watchok = Nullch;
12213 PL_regdummy = proto_perl->Tregdummy;
12214 PL_regprecomp = Nullch;
12217 PL_colorset = 0; /* reinits PL_colors[] */
12218 /*PL_colors[6] = {0,0,0,0,0,0};*/
12219 PL_reginput = Nullch;
12220 PL_regbol = Nullch;
12221 PL_regeol = Nullch;
12222 PL_regstartp = (I32*)NULL;
12223 PL_regendp = (I32*)NULL;
12224 PL_reglastparen = (U32*)NULL;
12225 PL_reglastcloseparen = (U32*)NULL;
12226 PL_regtill = Nullch;
12227 PL_reg_start_tmp = (char**)NULL;
12228 PL_reg_start_tmpl = 0;
12229 PL_regdata = (struct reg_data*)NULL;
12232 PL_reg_eval_set = 0;
12234 PL_regprogram = (regnode*)NULL;
12236 PL_regcc = (CURCUR*)NULL;
12237 PL_reg_call_cc = (struct re_cc_state*)NULL;
12238 PL_reg_re = (regexp*)NULL;
12239 PL_reg_ganch = Nullch;
12240 PL_reg_sv = Nullsv;
12241 PL_reg_match_utf8 = FALSE;
12242 PL_reg_magic = (MAGIC*)NULL;
12244 PL_reg_oldcurpm = (PMOP*)NULL;
12245 PL_reg_curpm = (PMOP*)NULL;
12246 PL_reg_oldsaved = Nullch;
12247 PL_reg_oldsavedlen = 0;
12248 #ifdef PERL_COPY_ON_WRITE
12251 PL_reg_maxiter = 0;
12252 PL_reg_leftiter = 0;
12253 PL_reg_poscache = Nullch;
12254 PL_reg_poscache_size= 0;
12256 /* RE engine - function pointers */
12257 PL_regcompp = proto_perl->Tregcompp;
12258 PL_regexecp = proto_perl->Tregexecp;
12259 PL_regint_start = proto_perl->Tregint_start;
12260 PL_regint_string = proto_perl->Tregint_string;
12261 PL_regfree = proto_perl->Tregfree;
12263 PL_reginterp_cnt = 0;
12264 PL_reg_starttry = 0;
12266 /* Pluggable optimizer */
12267 PL_peepp = proto_perl->Tpeepp;
12269 PL_stashcache = newHV();
12271 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12272 ptr_table_free(PL_ptr_table);
12273 PL_ptr_table = NULL;
12276 /* Call the ->CLONE method, if it exists, for each of the stashes
12277 identified by sv_dup() above.
12279 while(av_len(param->stashes) != -1) {
12280 HV* stash = (HV*) av_shift(param->stashes);
12281 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12282 if (cloner && GvCV(cloner)) {
12287 XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
12289 call_sv((SV*)GvCV(cloner), G_DISCARD);
12295 SvREFCNT_dec(param->stashes);
12300 #endif /* USE_ITHREADS */
12303 =head1 Unicode Support
12305 =for apidoc sv_recode_to_utf8
12307 The encoding is assumed to be an Encode object, on entry the PV
12308 of the sv is assumed to be octets in that encoding, and the sv
12309 will be converted into Unicode (and UTF-8).
12311 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12312 is not a reference, nothing is done to the sv. If the encoding is not
12313 an C<Encode::XS> Encoding object, bad things will happen.
12314 (See F<lib/encoding.pm> and L<Encode>).
12316 The PV of the sv is returned.
12321 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12324 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12338 Passing sv_yes is wrong - it needs to be or'ed set of constants
12339 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12340 remove converted chars from source.
12342 Both will default the value - let them.
12344 XPUSHs(&PL_sv_yes);
12347 call_method("decode", G_SCALAR);
12351 s = SvPV(uni, len);
12352 if (s != SvPVX(sv)) {
12353 SvGROW(sv, len + 1);
12354 Move(s, SvPVX(sv), len, char);
12355 SvCUR_set(sv, len);
12356 SvPVX(sv)[len] = 0;
12363 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12367 =for apidoc sv_cat_decode
12369 The encoding is assumed to be an Encode object, the PV of the ssv is
12370 assumed to be octets in that encoding and decoding the input starts
12371 from the position which (PV + *offset) pointed to. The dsv will be
12372 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12373 when the string tstr appears in decoding output or the input ends on
12374 the PV of the ssv. The value which the offset points will be modified
12375 to the last input position on the ssv.
12377 Returns TRUE if the terminator was found, else returns FALSE.
12382 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12383 SV *ssv, int *offset, char *tstr, int tlen)
12387 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12398 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12399 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12401 call_method("cat_decode", G_SCALAR);
12403 ret = SvTRUE(TOPs);
12404 *offset = SvIV(offsv);
12410 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12416 * c-indentation-style: bsd
12417 * c-basic-offset: 4
12418 * indent-tabs-mode: t
12421 * vim: shiftwidth=4: