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) SvUVX(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 #define plant_SV(p) \
170 SvANY(p) = (void *)PL_sv_root; \
171 SvFLAGS(p) = SVTYPEMASK; \
176 /* sv_mutex must be held while calling uproot_SV() */
177 #define uproot_SV(p) \
180 PL_sv_root = (SV*)SvANY(p); \
185 /* new_SV(): return a new, empty SV head */
187 #ifdef DEBUG_LEAKING_SCALARS
188 /* provide a real function for a debugger to play with */
205 # define new_SV(p) (p)=S_new_SV(aTHX)
223 /* del_SV(): return an empty SV head to the free list */
238 S_del_sv(pTHX_ SV *p)
245 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
247 svend = &sva[SvREFCNT(sva)];
248 if (p >= sv && p < svend)
252 if (ckWARN_d(WARN_INTERNAL))
253 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
254 "Attempt to free non-arena SV: 0x%"UVxf
255 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
262 #else /* ! DEBUGGING */
264 #define del_SV(p) plant_SV(p)
266 #endif /* DEBUGGING */
270 =head1 SV Manipulation Functions
272 =for apidoc sv_add_arena
274 Given a chunk of memory, link it to the head of the list of arenas,
275 and split it into a list of free SVs.
281 Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
287 /* The first SV in an arena isn't an SV. */
288 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
289 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
290 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
292 PL_sv_arenaroot = sva;
293 PL_sv_root = sva + 1;
295 svend = &sva[SvREFCNT(sva) - 1];
298 SvANY(sv) = (void *)(SV*)(sv + 1);
300 SvFLAGS(sv) = SVTYPEMASK;
304 SvFLAGS(sv) = SVTYPEMASK;
307 /* make some more SVs by adding another arena */
309 /* sv_mutex must be held while calling more_sv() */
316 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
317 PL_nice_chunk = Nullch;
318 PL_nice_chunk_size = 0;
321 char *chunk; /* must use New here to match call to */
322 New(704,chunk,1008,char); /* Safefree() in sv_free_arenas() */
323 sv_add_arena(chunk, 1008, 0);
329 /* visit(): call the named function for each non-free SV in the arenas
330 * whose flags field matches the flags/mask args. */
333 S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
340 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
341 svend = &sva[SvREFCNT(sva)];
342 for (sv = sva + 1; sv < svend; ++sv) {
343 if (SvTYPE(sv) != SVTYPEMASK
344 && (sv->sv_flags & mask) == flags
357 /* called by sv_report_used() for each live SV */
360 do_report_used(pTHX_ SV *sv)
362 if (SvTYPE(sv) != SVTYPEMASK) {
363 PerlIO_printf(Perl_debug_log, "****\n");
370 =for apidoc sv_report_used
372 Dump the contents of all SVs not yet freed. (Debugging aid).
378 Perl_sv_report_used(pTHX)
381 visit(do_report_used, 0, 0);
385 /* called by sv_clean_objs() for each live SV */
388 do_clean_objs(pTHX_ SV *sv)
392 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
393 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
405 /* XXX Might want to check arrays, etc. */
408 /* called by sv_clean_objs() for each live SV */
410 #ifndef DISABLE_DESTRUCTOR_KLUDGE
412 do_clean_named_objs(pTHX_ SV *sv)
414 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
415 if ( SvOBJECT(GvSV(sv)) ||
416 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
417 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
418 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
419 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
421 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
422 SvFLAGS(sv) |= SVf_BREAK;
430 =for apidoc sv_clean_objs
432 Attempt to destroy all objects not yet freed
438 Perl_sv_clean_objs(pTHX)
440 PL_in_clean_objs = TRUE;
441 visit(do_clean_objs, SVf_ROK, SVf_ROK);
442 #ifndef DISABLE_DESTRUCTOR_KLUDGE
443 /* some barnacles may yet remain, clinging to typeglobs */
444 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
446 PL_in_clean_objs = FALSE;
449 /* called by sv_clean_all() for each live SV */
452 do_clean_all(pTHX_ SV *sv)
454 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
455 SvFLAGS(sv) |= SVf_BREAK;
456 if (PL_comppad == (AV*)sv) {
458 PL_curpad = Null(SV**);
464 =for apidoc sv_clean_all
466 Decrement the refcnt of each remaining SV, possibly triggering a
467 cleanup. This function may have to be called multiple times to free
468 SVs which are in complex self-referential hierarchies.
474 Perl_sv_clean_all(pTHX)
477 PL_in_clean_all = TRUE;
478 cleaned = visit(do_clean_all, 0,0);
479 PL_in_clean_all = FALSE;
484 =for apidoc sv_free_arenas
486 Deallocate the memory used by all arenas. Note that all the individual SV
487 heads and bodies within the arenas must already have been freed.
493 Perl_sv_free_arenas(pTHX)
497 XPV *arena, *arenanext;
499 /* Free arenas here, but be careful about fake ones. (We assume
500 contiguity of the fake ones with the corresponding real ones.) */
502 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
503 svanext = (SV*) SvANY(sva);
504 while (svanext && SvFAKE(svanext))
505 svanext = (SV*) SvANY(svanext);
508 Safefree((void *)sva);
511 for (arena = PL_xiv_arenaroot; arena; arena = arenanext) {
512 arenanext = (XPV*)arena->xpv_pv;
515 PL_xiv_arenaroot = 0;
518 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
519 arenanext = (XPV*)arena->xpv_pv;
522 PL_xnv_arenaroot = 0;
525 for (arena = PL_xrv_arenaroot; arena; arena = arenanext) {
526 arenanext = (XPV*)arena->xpv_pv;
529 PL_xrv_arenaroot = 0;
532 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
533 arenanext = (XPV*)arena->xpv_pv;
536 PL_xpv_arenaroot = 0;
539 for (arena = (XPV*)PL_xpviv_arenaroot; arena; arena = arenanext) {
540 arenanext = (XPV*)arena->xpv_pv;
543 PL_xpviv_arenaroot = 0;
546 for (arena = (XPV*)PL_xpvnv_arenaroot; arena; arena = arenanext) {
547 arenanext = (XPV*)arena->xpv_pv;
550 PL_xpvnv_arenaroot = 0;
553 for (arena = (XPV*)PL_xpvcv_arenaroot; arena; arena = arenanext) {
554 arenanext = (XPV*)arena->xpv_pv;
557 PL_xpvcv_arenaroot = 0;
560 for (arena = (XPV*)PL_xpvav_arenaroot; arena; arena = arenanext) {
561 arenanext = (XPV*)arena->xpv_pv;
564 PL_xpvav_arenaroot = 0;
567 for (arena = (XPV*)PL_xpvhv_arenaroot; arena; arena = arenanext) {
568 arenanext = (XPV*)arena->xpv_pv;
571 PL_xpvhv_arenaroot = 0;
574 for (arena = (XPV*)PL_xpvmg_arenaroot; arena; arena = arenanext) {
575 arenanext = (XPV*)arena->xpv_pv;
578 PL_xpvmg_arenaroot = 0;
581 for (arena = (XPV*)PL_xpvlv_arenaroot; arena; arena = arenanext) {
582 arenanext = (XPV*)arena->xpv_pv;
585 PL_xpvlv_arenaroot = 0;
588 for (arena = (XPV*)PL_xpvbm_arenaroot; arena; arena = arenanext) {
589 arenanext = (XPV*)arena->xpv_pv;
592 PL_xpvbm_arenaroot = 0;
595 for (arena = (XPV*)PL_he_arenaroot; arena; arena = arenanext) {
596 arenanext = (XPV*)arena->xpv_pv;
603 Safefree(PL_nice_chunk);
604 PL_nice_chunk = Nullch;
605 PL_nice_chunk_size = 0;
610 /* ---------------------------------------------------------------------
612 * support functions for report_uninit()
615 /* the maxiumum size of array or hash where we will scan looking
616 * for the undefined element that triggered the warning */
618 #define FUV_MAX_SEARCH_SIZE 1000
620 /* Look for an entry in the hash whose value has the same SV as val;
621 * If so, return a mortal copy of the key. */
624 S_find_hash_subscript(pTHX_ HV *hv, SV* val)
630 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
631 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
636 for (i=HvMAX(hv); i>0; i--) {
637 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
638 if (HeVAL(entry) != val)
640 if ( HeVAL(entry) == &PL_sv_undef ||
641 HeVAL(entry) == &PL_sv_placeholder)
645 if (HeKLEN(entry) == HEf_SVKEY)
646 return sv_mortalcopy(HeKEY_sv(entry));
647 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
653 /* Look for an entry in the array whose value has the same SV as val;
654 * If so, return the index, otherwise return -1. */
657 S_find_array_subscript(pTHX_ AV *av, SV* val)
661 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
662 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
666 for (i=AvFILLp(av); i>=0; i--) {
667 if (svp[i] == val && svp[i] != &PL_sv_undef)
673 /* S_varname(): return the name of a variable, optionally with a subscript.
674 * If gv is non-zero, use the name of that global, along with gvtype (one
675 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
676 * targ. Depending on the value of the subscript_type flag, return:
679 #define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
680 #define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
681 #define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
682 #define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
685 S_varname(pTHX_ GV *gv, const char *gvtype, PADOFFSET targ,
686 SV* keyname, I32 aindex, int subscript_type)
692 name = sv_newmortal();
695 /* simulate gv_fullname4(), but add literal '^' for $^FOO names
696 * XXX get rid of all this if gv_fullnameX() ever supports this
700 HV *hv = GvSTASH(gv);
701 sv_setpv(name, gvtype);
704 else if (!(p=HvNAME(hv)))
706 if (strNE(p, "main")) {
708 sv_catpvn(name,"::", 2);
710 if (GvNAMELEN(gv)>= 1 &&
711 ((unsigned int)*GvNAME(gv)) <= 26)
713 Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
714 sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
717 sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
721 CV *cv = find_runcv(&u);
722 if (!cv || !CvPADLIST(cv))
724 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
725 sv = *av_fetch(av, targ, FALSE);
726 /* SvLEN in a pad name is not to be trusted */
727 sv_setpv(name, SvPV_nolen(sv));
730 if (subscript_type == FUV_SUBSCRIPT_HASH) {
733 Perl_sv_catpvf(aTHX_ name, "{%s}",
734 pv_display(sv,SvPVX(keyname), SvCUR(keyname), 0, 32));
737 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
739 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
741 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
742 sv_insert(name, 0, 0, "within ", 7);
749 =for apidoc find_uninit_var
751 Find the name of the undefined variable (if any) that caused the operator o
752 to issue a "Use of uninitialized value" warning.
753 If match is true, only return a name if it's value matches uninit_sv.
754 So roughly speaking, if a unary operator (such as OP_COS) generates a
755 warning, then following the direct child of the op may yield an
756 OP_PADSV or OP_GV that gives the name of the undefined variable. On the
757 other hand, with OP_ADD there are two branches to follow, so we only print
758 the variable name if we get an exact match.
760 The name is returned as a mortal SV.
762 Assumes that PL_op is the op that originally triggered the error, and that
763 PL_comppad/PL_curpad points to the currently executing pad.
769 S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
777 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
778 uninit_sv == &PL_sv_placeholder)))
781 switch (obase->op_type) {
788 bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
789 bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
792 int subscript_type = FUV_SUBSCRIPT_WITHIN;
794 if (pad) { /* @lex, %lex */
795 sv = PAD_SVl(obase->op_targ);
799 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
800 /* @global, %global */
801 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
804 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
806 else /* @{expr}, %{expr} */
807 return find_uninit_var(cUNOPx(obase)->op_first,
811 /* attempt to find a match within the aggregate */
813 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
815 subscript_type = FUV_SUBSCRIPT_HASH;
818 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
820 subscript_type = FUV_SUBSCRIPT_ARRAY;
823 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
826 return S_varname(aTHX_ gv, hash ? "%" : "@", obase->op_targ,
827 keysv, index, subscript_type);
831 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
833 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
834 Nullsv, 0, FUV_SUBSCRIPT_NONE);
837 gv = cGVOPx_gv(obase);
838 if (!gv || (match && GvSV(gv) != uninit_sv))
840 return S_varname(aTHX_ gv, "$", 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
843 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
845 av = (AV*)PAD_SV(obase->op_targ);
846 if (!av || SvRMAGICAL(av))
848 svp = av_fetch(av, (I32)obase->op_private, FALSE);
849 if (!svp || *svp != uninit_sv)
852 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
853 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
856 gv = cGVOPx_gv(obase);
861 if (!av || SvRMAGICAL(av))
863 svp = av_fetch(av, (I32)obase->op_private, FALSE);
864 if (!svp || *svp != uninit_sv)
867 return S_varname(aTHX_ gv, "$", 0,
868 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
873 o = cUNOPx(obase)->op_first;
874 if (!o || o->op_type != OP_NULL ||
875 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
877 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
882 /* $a[uninit_expr] or $h{uninit_expr} */
883 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
886 o = cBINOPx(obase)->op_first;
887 kid = cBINOPx(obase)->op_last;
889 /* get the av or hv, and optionally the gv */
891 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
892 sv = PAD_SV(o->op_targ);
894 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
895 && cUNOPo->op_first->op_type == OP_GV)
897 gv = cGVOPx_gv(cUNOPo->op_first);
900 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
905 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
906 /* index is constant */
910 if (obase->op_type == OP_HELEM) {
911 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
912 if (!he || HeVAL(he) != uninit_sv)
916 svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
917 if (!svp || *svp != uninit_sv)
921 if (obase->op_type == OP_HELEM)
922 return S_varname(aTHX_ gv, "%", o->op_targ,
923 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
925 return S_varname(aTHX_ gv, "@", o->op_targ, Nullsv,
926 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
930 /* index is an expression;
931 * attempt to find a match within the aggregate */
932 if (obase->op_type == OP_HELEM) {
933 SV *keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
935 return S_varname(aTHX_ gv, "%", o->op_targ,
936 keysv, 0, FUV_SUBSCRIPT_HASH);
939 I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
941 return S_varname(aTHX_ gv, "@", o->op_targ,
942 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
946 return S_varname(aTHX_ gv,
947 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
949 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
955 /* only examine RHS */
956 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
959 o = cUNOPx(obase)->op_first;
960 if (o->op_type == OP_PUSHMARK)
963 if (!o->op_sibling) {
964 /* one-arg version of open is highly magical */
966 if (o->op_type == OP_GV) { /* open FOO; */
968 if (match && GvSV(gv) != uninit_sv)
970 return S_varname(aTHX_ gv, "$", 0,
971 Nullsv, 0, FUV_SUBSCRIPT_NONE);
973 /* other possibilities not handled are:
974 * open $x; or open my $x; should return '${*$x}'
975 * open expr; should return '$'.expr ideally
981 /* ops where $_ may be an implicit arg */
985 if ( !(obase->op_flags & OPf_STACKED)) {
986 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
987 ? PAD_SVl(obase->op_targ)
999 /* skip filehandle as it can't produce 'undef' warning */
1000 o = cUNOPx(obase)->op_first;
1001 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
1002 o = o->op_sibling->op_sibling;
1009 match = 1; /* XS or custom code could trigger random warnings */
1014 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
1015 return sv_2mortal(newSVpv("${$/}", 0));
1020 if (!(obase->op_flags & OPf_KIDS))
1022 o = cUNOPx(obase)->op_first;
1028 /* if all except one arg are constant, or have no side-effects,
1029 * or are optimized away, then it's unambiguous */
1031 for (kid=o; kid; kid = kid->op_sibling) {
1033 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1034 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1035 || (kid->op_type == OP_PUSHMARK)
1039 if (o2) { /* more than one found */
1046 return find_uninit_var(o2, uninit_sv, match);
1050 sv = find_uninit_var(o, uninit_sv, 1);
1062 =for apidoc report_uninit
1064 Print appropriate "Use of uninitialized variable" warning
1070 Perl_report_uninit(pTHX_ SV* uninit_sv)
1073 SV* varname = Nullsv;
1075 varname = find_uninit_var(PL_op, uninit_sv,0);
1077 sv_insert(varname, 0, 0, " ", 1);
1079 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1080 varname ? SvPV_nolen(varname) : "",
1081 " in ", OP_DESC(PL_op));
1084 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1088 /* grab a new IV body from the free list, allocating more if necessary */
1099 * See comment in more_xiv() -- RAM.
1101 PL_xiv_root = *(IV**)xiv;
1103 return (XPVIV*)((char*)xiv - STRUCT_OFFSET(XPVIV, xiv_iv));
1106 /* return an IV body to the free list */
1109 S_del_xiv(pTHX_ XPVIV *p)
1111 IV* xiv = (IV*)((char*)(p) + STRUCT_OFFSET(XPVIV, xiv_iv));
1113 *(IV**)xiv = PL_xiv_root;
1118 /* allocate another arena's worth of IV bodies */
1124 register IV* xivend;
1126 New(705, ptr, 1008/sizeof(XPV), XPV);
1127 ptr->xpv_pv = (char*)PL_xiv_arenaroot; /* linked list of xiv arenas */
1128 PL_xiv_arenaroot = ptr; /* to keep Purify happy */
1131 xivend = &xiv[1008 / sizeof(IV) - 1];
1132 xiv += (sizeof(XPV) - 1) / sizeof(IV) + 1; /* fudge by size of XPV */
1134 while (xiv < xivend) {
1135 *(IV**)xiv = (IV *)(xiv + 1);
1141 /* grab a new NV body from the free list, allocating more if necessary */
1151 PL_xnv_root = *(NV**)xnv;
1153 return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
1156 /* return an NV body to the free list */
1159 S_del_xnv(pTHX_ XPVNV *p)
1161 NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
1163 *(NV**)xnv = PL_xnv_root;
1168 /* allocate another arena's worth of NV bodies */
1174 register NV* xnvend;
1176 New(711, ptr, 1008/sizeof(XPV), XPV);
1177 ptr->xpv_pv = (char*)PL_xnv_arenaroot;
1178 PL_xnv_arenaroot = ptr;
1181 xnvend = &xnv[1008 / sizeof(NV) - 1];
1182 xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
1184 while (xnv < xnvend) {
1185 *(NV**)xnv = (NV*)(xnv + 1);
1191 /* grab a new struct xrv from the free list, allocating more if necessary */
1201 PL_xrv_root = (XRV*)xrv->xrv_rv;
1206 /* return a struct xrv to the free list */
1209 S_del_xrv(pTHX_ XRV *p)
1212 p->xrv_rv = (SV*)PL_xrv_root;
1217 /* allocate another arena's worth of struct xrv */
1223 register XRV* xrvend;
1225 New(712, ptr, 1008/sizeof(XPV), XPV);
1226 ptr->xpv_pv = (char*)PL_xrv_arenaroot;
1227 PL_xrv_arenaroot = ptr;
1230 xrvend = &xrv[1008 / sizeof(XRV) - 1];
1231 xrv += (sizeof(XPV) - 1) / sizeof(XRV) + 1;
1233 while (xrv < xrvend) {
1234 xrv->xrv_rv = (SV*)(xrv + 1);
1240 /* grab a new struct xpv from the free list, allocating more if necessary */
1250 PL_xpv_root = (XPV*)xpv->xpv_pv;
1255 /* return a struct xpv to the free list */
1258 S_del_xpv(pTHX_ XPV *p)
1261 p->xpv_pv = (char*)PL_xpv_root;
1266 /* allocate another arena's worth of struct xpv */
1272 register XPV* xpvend;
1273 New(713, xpv, 1008/sizeof(XPV), XPV);
1274 xpv->xpv_pv = (char*)PL_xpv_arenaroot;
1275 PL_xpv_arenaroot = xpv;
1277 xpvend = &xpv[1008 / sizeof(XPV) - 1];
1278 PL_xpv_root = ++xpv;
1279 while (xpv < xpvend) {
1280 xpv->xpv_pv = (char*)(xpv + 1);
1286 /* grab a new struct xpviv from the free list, allocating more if necessary */
1295 xpviv = PL_xpviv_root;
1296 PL_xpviv_root = (XPVIV*)xpviv->xpv_pv;
1301 /* return a struct xpviv to the free list */
1304 S_del_xpviv(pTHX_ XPVIV *p)
1307 p->xpv_pv = (char*)PL_xpviv_root;
1312 /* allocate another arena's worth of struct xpviv */
1317 register XPVIV* xpviv;
1318 register XPVIV* xpvivend;
1319 New(714, xpviv, 1008/sizeof(XPVIV), XPVIV);
1320 xpviv->xpv_pv = (char*)PL_xpviv_arenaroot;
1321 PL_xpviv_arenaroot = xpviv;
1323 xpvivend = &xpviv[1008 / sizeof(XPVIV) - 1];
1324 PL_xpviv_root = ++xpviv;
1325 while (xpviv < xpvivend) {
1326 xpviv->xpv_pv = (char*)(xpviv + 1);
1332 /* grab a new struct xpvnv from the free list, allocating more if necessary */
1341 xpvnv = PL_xpvnv_root;
1342 PL_xpvnv_root = (XPVNV*)xpvnv->xpv_pv;
1347 /* return a struct xpvnv to the free list */
1350 S_del_xpvnv(pTHX_ XPVNV *p)
1353 p->xpv_pv = (char*)PL_xpvnv_root;
1358 /* allocate another arena's worth of struct xpvnv */
1363 register XPVNV* xpvnv;
1364 register XPVNV* xpvnvend;
1365 New(715, xpvnv, 1008/sizeof(XPVNV), XPVNV);
1366 xpvnv->xpv_pv = (char*)PL_xpvnv_arenaroot;
1367 PL_xpvnv_arenaroot = xpvnv;
1369 xpvnvend = &xpvnv[1008 / sizeof(XPVNV) - 1];
1370 PL_xpvnv_root = ++xpvnv;
1371 while (xpvnv < xpvnvend) {
1372 xpvnv->xpv_pv = (char*)(xpvnv + 1);
1378 /* grab a new struct xpvcv from the free list, allocating more if necessary */
1387 xpvcv = PL_xpvcv_root;
1388 PL_xpvcv_root = (XPVCV*)xpvcv->xpv_pv;
1393 /* return a struct xpvcv to the free list */
1396 S_del_xpvcv(pTHX_ XPVCV *p)
1399 p->xpv_pv = (char*)PL_xpvcv_root;
1404 /* allocate another arena's worth of struct xpvcv */
1409 register XPVCV* xpvcv;
1410 register XPVCV* xpvcvend;
1411 New(716, xpvcv, 1008/sizeof(XPVCV), XPVCV);
1412 xpvcv->xpv_pv = (char*)PL_xpvcv_arenaroot;
1413 PL_xpvcv_arenaroot = xpvcv;
1415 xpvcvend = &xpvcv[1008 / sizeof(XPVCV) - 1];
1416 PL_xpvcv_root = ++xpvcv;
1417 while (xpvcv < xpvcvend) {
1418 xpvcv->xpv_pv = (char*)(xpvcv + 1);
1424 /* grab a new struct xpvav from the free list, allocating more if necessary */
1433 xpvav = PL_xpvav_root;
1434 PL_xpvav_root = (XPVAV*)xpvav->xav_array;
1439 /* return a struct xpvav to the free list */
1442 S_del_xpvav(pTHX_ XPVAV *p)
1445 p->xav_array = (char*)PL_xpvav_root;
1450 /* allocate another arena's worth of struct xpvav */
1455 register XPVAV* xpvav;
1456 register XPVAV* xpvavend;
1457 New(717, xpvav, 1008/sizeof(XPVAV), XPVAV);
1458 xpvav->xav_array = (char*)PL_xpvav_arenaroot;
1459 PL_xpvav_arenaroot = xpvav;
1461 xpvavend = &xpvav[1008 / sizeof(XPVAV) - 1];
1462 PL_xpvav_root = ++xpvav;
1463 while (xpvav < xpvavend) {
1464 xpvav->xav_array = (char*)(xpvav + 1);
1467 xpvav->xav_array = 0;
1470 /* grab a new struct xpvhv from the free list, allocating more if necessary */
1479 xpvhv = PL_xpvhv_root;
1480 PL_xpvhv_root = (XPVHV*)xpvhv->xhv_array;
1485 /* return a struct xpvhv to the free list */
1488 S_del_xpvhv(pTHX_ XPVHV *p)
1491 p->xhv_array = (char*)PL_xpvhv_root;
1496 /* allocate another arena's worth of struct xpvhv */
1501 register XPVHV* xpvhv;
1502 register XPVHV* xpvhvend;
1503 New(718, xpvhv, 1008/sizeof(XPVHV), XPVHV);
1504 xpvhv->xhv_array = (char*)PL_xpvhv_arenaroot;
1505 PL_xpvhv_arenaroot = xpvhv;
1507 xpvhvend = &xpvhv[1008 / sizeof(XPVHV) - 1];
1508 PL_xpvhv_root = ++xpvhv;
1509 while (xpvhv < xpvhvend) {
1510 xpvhv->xhv_array = (char*)(xpvhv + 1);
1513 xpvhv->xhv_array = 0;
1516 /* grab a new struct xpvmg from the free list, allocating more if necessary */
1525 xpvmg = PL_xpvmg_root;
1526 PL_xpvmg_root = (XPVMG*)xpvmg->xpv_pv;
1531 /* return a struct xpvmg to the free list */
1534 S_del_xpvmg(pTHX_ XPVMG *p)
1537 p->xpv_pv = (char*)PL_xpvmg_root;
1542 /* allocate another arena's worth of struct xpvmg */
1547 register XPVMG* xpvmg;
1548 register XPVMG* xpvmgend;
1549 New(719, xpvmg, 1008/sizeof(XPVMG), XPVMG);
1550 xpvmg->xpv_pv = (char*)PL_xpvmg_arenaroot;
1551 PL_xpvmg_arenaroot = xpvmg;
1553 xpvmgend = &xpvmg[1008 / sizeof(XPVMG) - 1];
1554 PL_xpvmg_root = ++xpvmg;
1555 while (xpvmg < xpvmgend) {
1556 xpvmg->xpv_pv = (char*)(xpvmg + 1);
1562 /* grab a new struct xpvlv from the free list, allocating more if necessary */
1571 xpvlv = PL_xpvlv_root;
1572 PL_xpvlv_root = (XPVLV*)xpvlv->xpv_pv;
1577 /* return a struct xpvlv to the free list */
1580 S_del_xpvlv(pTHX_ XPVLV *p)
1583 p->xpv_pv = (char*)PL_xpvlv_root;
1588 /* allocate another arena's worth of struct xpvlv */
1593 register XPVLV* xpvlv;
1594 register XPVLV* xpvlvend;
1595 New(720, xpvlv, 1008/sizeof(XPVLV), XPVLV);
1596 xpvlv->xpv_pv = (char*)PL_xpvlv_arenaroot;
1597 PL_xpvlv_arenaroot = xpvlv;
1599 xpvlvend = &xpvlv[1008 / sizeof(XPVLV) - 1];
1600 PL_xpvlv_root = ++xpvlv;
1601 while (xpvlv < xpvlvend) {
1602 xpvlv->xpv_pv = (char*)(xpvlv + 1);
1608 /* grab a new struct xpvbm from the free list, allocating more if necessary */
1617 xpvbm = PL_xpvbm_root;
1618 PL_xpvbm_root = (XPVBM*)xpvbm->xpv_pv;
1623 /* return a struct xpvbm to the free list */
1626 S_del_xpvbm(pTHX_ XPVBM *p)
1629 p->xpv_pv = (char*)PL_xpvbm_root;
1634 /* allocate another arena's worth of struct xpvbm */
1639 register XPVBM* xpvbm;
1640 register XPVBM* xpvbmend;
1641 New(721, xpvbm, 1008/sizeof(XPVBM), XPVBM);
1642 xpvbm->xpv_pv = (char*)PL_xpvbm_arenaroot;
1643 PL_xpvbm_arenaroot = xpvbm;
1645 xpvbmend = &xpvbm[1008 / sizeof(XPVBM) - 1];
1646 PL_xpvbm_root = ++xpvbm;
1647 while (xpvbm < xpvbmend) {
1648 xpvbm->xpv_pv = (char*)(xpvbm + 1);
1654 #define my_safemalloc(s) (void*)safemalloc(s)
1655 #define my_safefree(p) safefree((char*)p)
1659 #define new_XIV() my_safemalloc(sizeof(XPVIV))
1660 #define del_XIV(p) my_safefree(p)
1662 #define new_XNV() my_safemalloc(sizeof(XPVNV))
1663 #define del_XNV(p) my_safefree(p)
1665 #define new_XRV() my_safemalloc(sizeof(XRV))
1666 #define del_XRV(p) my_safefree(p)
1668 #define new_XPV() my_safemalloc(sizeof(XPV))
1669 #define del_XPV(p) my_safefree(p)
1671 #define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1672 #define del_XPVIV(p) my_safefree(p)
1674 #define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1675 #define del_XPVNV(p) my_safefree(p)
1677 #define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1678 #define del_XPVCV(p) my_safefree(p)
1680 #define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1681 #define del_XPVAV(p) my_safefree(p)
1683 #define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1684 #define del_XPVHV(p) my_safefree(p)
1686 #define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1687 #define del_XPVMG(p) my_safefree(p)
1689 #define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1690 #define del_XPVLV(p) my_safefree(p)
1692 #define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1693 #define del_XPVBM(p) my_safefree(p)
1697 #define new_XIV() (void*)new_xiv()
1698 #define del_XIV(p) del_xiv((XPVIV*) p)
1700 #define new_XNV() (void*)new_xnv()
1701 #define del_XNV(p) del_xnv((XPVNV*) p)
1703 #define new_XRV() (void*)new_xrv()
1704 #define del_XRV(p) del_xrv((XRV*) p)
1706 #define new_XPV() (void*)new_xpv()
1707 #define del_XPV(p) del_xpv((XPV *)p)
1709 #define new_XPVIV() (void*)new_xpviv()
1710 #define del_XPVIV(p) del_xpviv((XPVIV *)p)
1712 #define new_XPVNV() (void*)new_xpvnv()
1713 #define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1715 #define new_XPVCV() (void*)new_xpvcv()
1716 #define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1718 #define new_XPVAV() (void*)new_xpvav()
1719 #define del_XPVAV(p) del_xpvav((XPVAV *)p)
1721 #define new_XPVHV() (void*)new_xpvhv()
1722 #define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1724 #define new_XPVMG() (void*)new_xpvmg()
1725 #define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1727 #define new_XPVLV() (void*)new_xpvlv()
1728 #define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1730 #define new_XPVBM() (void*)new_xpvbm()
1731 #define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1735 #define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1736 #define del_XPVGV(p) my_safefree(p)
1738 #define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1739 #define del_XPVFM(p) my_safefree(p)
1741 #define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1742 #define del_XPVIO(p) my_safefree(p)
1745 =for apidoc sv_upgrade
1747 Upgrade an SV to a more complex form. Generally adds a new body type to the
1748 SV, then copies across as much information as possible from the old body.
1749 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
1755 Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
1763 MAGIC* magic = NULL;
1766 if (mt != SVt_PV && SvIsCOW(sv)) {
1767 sv_force_normal_flags(sv, 0);
1770 if (SvTYPE(sv) == mt)
1774 (void)SvOOK_off(sv);
1776 switch (SvTYPE(sv)) {
1797 else if (mt < SVt_PVIV)
1814 pv = (char*)SvRV(sv);
1834 else if (mt == SVt_NV)
1845 del_XPVIV(SvANY(sv));
1855 del_XPVNV(SvANY(sv));
1863 magic = SvMAGIC(sv);
1864 stash = SvSTASH(sv);
1865 del_XPVMG(SvANY(sv));
1868 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
1871 SvFLAGS(sv) &= ~SVTYPEMASK;
1876 Perl_croak(aTHX_ "Can't upgrade to undef");
1878 SvANY(sv) = new_XIV();
1882 SvANY(sv) = new_XNV();
1886 SvANY(sv) = new_XRV();
1890 SvANY(sv) = new_XPV();
1896 SvANY(sv) = new_XPVIV();
1906 SvANY(sv) = new_XPVNV();
1914 SvANY(sv) = new_XPVMG();
1920 SvMAGIC(sv) = magic;
1921 SvSTASH(sv) = stash;
1924 SvANY(sv) = new_XPVLV();
1930 SvMAGIC(sv) = magic;
1931 SvSTASH(sv) = stash;
1943 SvANY(sv) = new_XPVAV();
1951 SvMAGIC(sv) = magic;
1952 SvSTASH(sv) = stash;
1955 AvFLAGS(sv) = AVf_REAL;
1958 SvANY(sv) = new_XPVHV();
1964 HvTOTALKEYS(sv) = 0;
1965 HvPLACEHOLDERS(sv) = 0;
1966 SvMAGIC(sv) = magic;
1967 SvSTASH(sv) = stash;
1974 SvANY(sv) = new_XPVCV();
1975 Zero(SvANY(sv), 1, XPVCV);
1981 SvMAGIC(sv) = magic;
1982 SvSTASH(sv) = stash;
1985 SvANY(sv) = new_XPVGV();
1991 SvMAGIC(sv) = magic;
1992 SvSTASH(sv) = stash;
2000 SvANY(sv) = new_XPVBM();
2006 SvMAGIC(sv) = magic;
2007 SvSTASH(sv) = stash;
2013 SvANY(sv) = new_XPVFM();
2014 Zero(SvANY(sv), 1, XPVFM);
2020 SvMAGIC(sv) = magic;
2021 SvSTASH(sv) = stash;
2024 SvANY(sv) = new_XPVIO();
2025 Zero(SvANY(sv), 1, XPVIO);
2031 SvMAGIC(sv) = magic;
2032 SvSTASH(sv) = stash;
2033 IoPAGE_LEN(sv) = 60;
2040 =for apidoc sv_backoff
2042 Remove any string offset. You should normally use the C<SvOOK_off> macro
2049 Perl_sv_backoff(pTHX_ register SV *sv)
2053 char *s = SvPVX(sv);
2054 SvLEN(sv) += SvIVX(sv);
2055 SvPVX(sv) -= SvIVX(sv);
2057 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
2059 SvFLAGS(sv) &= ~SVf_OOK;
2066 Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
2067 upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2068 Use the C<SvGROW> wrapper instead.
2074 Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
2078 #ifdef HAS_64K_LIMIT
2079 if (newlen >= 0x10000) {
2080 PerlIO_printf(Perl_debug_log,
2081 "Allocation too large: %"UVxf"\n", (UV)newlen);
2084 #endif /* HAS_64K_LIMIT */
2087 if (SvTYPE(sv) < SVt_PV) {
2088 sv_upgrade(sv, SVt_PV);
2091 else if (SvOOK(sv)) { /* pv is offset? */
2094 if (newlen > SvLEN(sv))
2095 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
2096 #ifdef HAS_64K_LIMIT
2097 if (newlen >= 0x10000)
2104 if (newlen > SvLEN(sv)) { /* need more room? */
2105 if (SvLEN(sv) && s) {
2107 STRLEN l = malloced_size((void*)SvPVX(sv));
2113 Renew(s,newlen,char);
2116 New(703, s, newlen, char);
2117 if (SvPVX(sv) && SvCUR(sv)) {
2118 Move(SvPVX(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
2122 SvLEN_set(sv, newlen);
2128 =for apidoc sv_setiv
2130 Copies an integer into the given SV, upgrading first if necessary.
2131 Does not handle 'set' magic. See also C<sv_setiv_mg>.
2137 Perl_sv_setiv(pTHX_ register SV *sv, IV i)
2139 SV_CHECK_THINKFIRST_COW_DROP(sv);
2140 switch (SvTYPE(sv)) {
2142 sv_upgrade(sv, SVt_IV);
2145 sv_upgrade(sv, SVt_PVNV);
2149 sv_upgrade(sv, SVt_PVIV);
2158 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
2161 (void)SvIOK_only(sv); /* validate number */
2167 =for apidoc sv_setiv_mg
2169 Like C<sv_setiv>, but also handles 'set' magic.
2175 Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
2182 =for apidoc sv_setuv
2184 Copies an unsigned integer into the given SV, upgrading first if necessary.
2185 Does not handle 'set' magic. See also C<sv_setuv_mg>.
2191 Perl_sv_setuv(pTHX_ register SV *sv, UV u)
2193 /* With these two if statements:
2194 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2197 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2199 If you wish to remove them, please benchmark to see what the effect is
2201 if (u <= (UV)IV_MAX) {
2202 sv_setiv(sv, (IV)u);
2211 =for apidoc sv_setuv_mg
2213 Like C<sv_setuv>, but also handles 'set' magic.
2219 Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
2221 /* With these two if statements:
2222 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
2225 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
2227 If you wish to remove them, please benchmark to see what the effect is
2229 if (u <= (UV)IV_MAX) {
2230 sv_setiv(sv, (IV)u);
2240 =for apidoc sv_setnv
2242 Copies a double into the given SV, upgrading first if necessary.
2243 Does not handle 'set' magic. See also C<sv_setnv_mg>.
2249 Perl_sv_setnv(pTHX_ register SV *sv, NV num)
2251 SV_CHECK_THINKFIRST_COW_DROP(sv);
2252 switch (SvTYPE(sv)) {
2255 sv_upgrade(sv, SVt_NV);
2260 sv_upgrade(sv, SVt_PVNV);
2269 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
2273 (void)SvNOK_only(sv); /* validate number */
2278 =for apidoc sv_setnv_mg
2280 Like C<sv_setnv>, but also handles 'set' magic.
2286 Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
2292 /* Print an "isn't numeric" warning, using a cleaned-up,
2293 * printable version of the offending string
2297 S_not_a_number(pTHX_ SV *sv)
2304 dsv = sv_2mortal(newSVpv("", 0));
2305 pv = sv_uni_display(dsv, sv, 10, 0);
2308 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
2309 /* each *s can expand to 4 chars + "...\0",
2310 i.e. need room for 8 chars */
2313 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
2315 if (ch & 128 && !isPRINT_LC(ch)) {
2324 else if (ch == '\r') {
2328 else if (ch == '\f') {
2332 else if (ch == '\\') {
2336 else if (ch == '\0') {
2340 else if (isPRINT_LC(ch))
2357 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2358 "Argument \"%s\" isn't numeric in %s", pv,
2361 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
2362 "Argument \"%s\" isn't numeric", pv);
2366 =for apidoc looks_like_number
2368 Test if the content of an SV looks like a number (or is a number).
2369 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2370 non-numeric warning), even if your atof() doesn't grok them.
2376 Perl_looks_like_number(pTHX_ SV *sv)
2378 register char *sbegin;
2385 else if (SvPOKp(sv))
2386 sbegin = SvPV(sv, len);
2388 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
2389 return grok_number(sbegin, len, NULL);
2392 /* Actually, ISO C leaves conversion of UV to IV undefined, but
2393 until proven guilty, assume that things are not that bad... */
2398 As 64 bit platforms often have an NV that doesn't preserve all bits of
2399 an IV (an assumption perl has been based on to date) it becomes necessary
2400 to remove the assumption that the NV always carries enough precision to
2401 recreate the IV whenever needed, and that the NV is the canonical form.
2402 Instead, IV/UV and NV need to be given equal rights. So as to not lose
2403 precision as a side effect of conversion (which would lead to insanity
2404 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2405 1) to distinguish between IV/UV/NV slots that have cached a valid
2406 conversion where precision was lost and IV/UV/NV slots that have a
2407 valid conversion which has lost no precision
2408 2) to ensure that if a numeric conversion to one form is requested that
2409 would lose precision, the precise conversion (or differently
2410 imprecise conversion) is also performed and cached, to prevent
2411 requests for different numeric formats on the same SV causing
2412 lossy conversion chains. (lossless conversion chains are perfectly
2417 SvIOKp is true if the IV slot contains a valid value
2418 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
2419 SvNOKp is true if the NV slot contains a valid value
2420 SvNOK is true only if the NV value is accurate
2423 while converting from PV to NV, check to see if converting that NV to an
2424 IV(or UV) would lose accuracy over a direct conversion from PV to
2425 IV(or UV). If it would, cache both conversions, return NV, but mark
2426 SV as IOK NOKp (ie not NOK).
2428 While converting from PV to IV, check to see if converting that IV to an
2429 NV would lose accuracy over a direct conversion from PV to NV. If it
2430 would, cache both conversions, flag similarly.
2432 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2433 correctly because if IV & NV were set NV *always* overruled.
2434 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2435 changes - now IV and NV together means that the two are interchangeable:
2436 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
2438 The benefit of this is that operations such as pp_add know that if
2439 SvIOK is true for both left and right operands, then integer addition
2440 can be used instead of floating point (for cases where the result won't
2441 overflow). Before, floating point was always used, which could lead to
2442 loss of precision compared with integer addition.
2444 * making IV and NV equal status should make maths accurate on 64 bit
2446 * may speed up maths somewhat if pp_add and friends start to use
2447 integers when possible instead of fp. (Hopefully the overhead in
2448 looking for SvIOK and checking for overflow will not outweigh the
2449 fp to integer speedup)
2450 * will slow down integer operations (callers of SvIV) on "inaccurate"
2451 values, as the change from SvIOK to SvIOKp will cause a call into
2452 sv_2iv each time rather than a macro access direct to the IV slot
2453 * should speed up number->string conversion on integers as IV is
2454 favoured when IV and NV are equally accurate
2456 ####################################################################
2457 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2458 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2459 On the other hand, SvUOK is true iff UV.
2460 ####################################################################
2462 Your mileage will vary depending your CPU's relative fp to integer
2466 #ifndef NV_PRESERVES_UV
2467 # define IS_NUMBER_UNDERFLOW_IV 1
2468 # define IS_NUMBER_UNDERFLOW_UV 2
2469 # define IS_NUMBER_IV_AND_UV 2
2470 # define IS_NUMBER_OVERFLOW_IV 4
2471 # define IS_NUMBER_OVERFLOW_UV 5
2473 /* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
2475 /* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2477 S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
2479 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));
2480 if (SvNVX(sv) < (NV)IV_MIN) {
2481 (void)SvIOKp_on(sv);
2484 return IS_NUMBER_UNDERFLOW_IV;
2486 if (SvNVX(sv) > (NV)UV_MAX) {
2487 (void)SvIOKp_on(sv);
2491 return IS_NUMBER_OVERFLOW_UV;
2493 (void)SvIOKp_on(sv);
2495 /* Can't use strtol etc to convert this string. (See truth table in
2497 if (SvNVX(sv) <= (UV)IV_MAX) {
2498 SvIVX(sv) = I_V(SvNVX(sv));
2499 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2500 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2502 /* Integer is imprecise. NOK, IOKp */
2504 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2507 SvUVX(sv) = U_V(SvNVX(sv));
2508 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2509 if (SvUVX(sv) == UV_MAX) {
2510 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2511 possibly be preserved by NV. Hence, it must be overflow.
2513 return IS_NUMBER_OVERFLOW_UV;
2515 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2517 /* Integer is imprecise. NOK, IOKp */
2519 return IS_NUMBER_OVERFLOW_IV;
2521 #endif /* !NV_PRESERVES_UV*/
2523 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2524 * this function provided for binary compatibility only
2528 Perl_sv_2iv(pTHX_ register SV *sv)
2530 return sv_2iv_flags(sv, SV_GMAGIC);
2534 =for apidoc sv_2iv_flags
2536 Return the integer value of an SV, doing any necessary string
2537 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2538 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2544 Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
2548 if (SvGMAGICAL(sv)) {
2549 if (flags & SV_GMAGIC)
2554 return I_V(SvNVX(sv));
2556 if (SvPOKp(sv) && SvLEN(sv))
2559 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2560 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2566 if (SvTHINKFIRST(sv)) {
2569 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2570 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2571 return SvIV(tmpstr);
2572 return PTR2IV(SvRV(sv));
2575 sv_force_normal_flags(sv, 0);
2577 if (SvREADONLY(sv) && !SvOK(sv)) {
2578 if (ckWARN(WARN_UNINITIALIZED))
2585 return (IV)(SvUVX(sv));
2592 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2593 * without also getting a cached IV/UV from it at the same time
2594 * (ie PV->NV conversion should detect loss of accuracy and cache
2595 * IV or UV at same time to avoid this. NWC */
2597 if (SvTYPE(sv) == SVt_NV)
2598 sv_upgrade(sv, SVt_PVNV);
2600 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2601 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2602 certainly cast into the IV range at IV_MAX, whereas the correct
2603 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2605 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2606 SvIVX(sv) = I_V(SvNVX(sv));
2607 if (SvNVX(sv) == (NV) SvIVX(sv)
2608 #ifndef NV_PRESERVES_UV
2609 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2610 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2611 /* Don't flag it as "accurately an integer" if the number
2612 came from a (by definition imprecise) NV operation, and
2613 we're outside the range of NV integer precision */
2616 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2617 DEBUG_c(PerlIO_printf(Perl_debug_log,
2618 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
2624 /* IV not precise. No need to convert from PV, as NV
2625 conversion would already have cached IV if it detected
2626 that PV->IV would be better than PV->NV->IV
2627 flags already correct - don't set public IOK. */
2628 DEBUG_c(PerlIO_printf(Perl_debug_log,
2629 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
2634 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2635 but the cast (NV)IV_MIN rounds to a the value less (more
2636 negative) than IV_MIN which happens to be equal to SvNVX ??
2637 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2638 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2639 (NV)UVX == NVX are both true, but the values differ. :-(
2640 Hopefully for 2s complement IV_MIN is something like
2641 0x8000000000000000 which will be exact. NWC */
2644 SvUVX(sv) = U_V(SvNVX(sv));
2646 (SvNVX(sv) == (NV) SvUVX(sv))
2647 #ifndef NV_PRESERVES_UV
2648 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2649 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2650 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2651 /* Don't flag it as "accurately an integer" if the number
2652 came from a (by definition imprecise) NV operation, and
2653 we're outside the range of NV integer precision */
2659 DEBUG_c(PerlIO_printf(Perl_debug_log,
2660 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
2664 return (IV)SvUVX(sv);
2667 else if (SvPOKp(sv) && SvLEN(sv)) {
2669 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2670 /* We want to avoid a possible problem when we cache an IV which
2671 may be later translated to an NV, and the resulting NV is not
2672 the same as the direct translation of the initial string
2673 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2674 be careful to ensure that the value with the .456 is around if the
2675 NV value is requested in the future).
2677 This means that if we cache such an IV, we need to cache the
2678 NV as well. Moreover, we trade speed for space, and do not
2679 cache the NV if we are sure it's not needed.
2682 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2683 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2684 == IS_NUMBER_IN_UV) {
2685 /* It's definitely an integer, only upgrade to PVIV */
2686 if (SvTYPE(sv) < SVt_PVIV)
2687 sv_upgrade(sv, SVt_PVIV);
2689 } else if (SvTYPE(sv) < SVt_PVNV)
2690 sv_upgrade(sv, SVt_PVNV);
2692 /* If NV preserves UV then we only use the UV value if we know that
2693 we aren't going to call atof() below. If NVs don't preserve UVs
2694 then the value returned may have more precision than atof() will
2695 return, even though value isn't perfectly accurate. */
2696 if ((numtype & (IS_NUMBER_IN_UV
2697 #ifdef NV_PRESERVES_UV
2700 )) == IS_NUMBER_IN_UV) {
2701 /* This won't turn off the public IOK flag if it was set above */
2702 (void)SvIOKp_on(sv);
2704 if (!(numtype & IS_NUMBER_NEG)) {
2706 if (value <= (UV)IV_MAX) {
2707 SvIVX(sv) = (IV)value;
2713 /* 2s complement assumption */
2714 if (value <= (UV)IV_MIN) {
2715 SvIVX(sv) = -(IV)value;
2717 /* Too negative for an IV. This is a double upgrade, but
2718 I'm assuming it will be rare. */
2719 if (SvTYPE(sv) < SVt_PVNV)
2720 sv_upgrade(sv, SVt_PVNV);
2724 SvNVX(sv) = -(NV)value;
2729 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2730 will be in the previous block to set the IV slot, and the next
2731 block to set the NV slot. So no else here. */
2733 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2734 != IS_NUMBER_IN_UV) {
2735 /* It wasn't an (integer that doesn't overflow the UV). */
2736 SvNVX(sv) = Atof(SvPVX(sv));
2738 if (! numtype && ckWARN(WARN_NUMERIC))
2741 #if defined(USE_LONG_DOUBLE)
2742 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2743 PTR2UV(sv), SvNVX(sv)));
2745 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
2746 PTR2UV(sv), SvNVX(sv)));
2750 #ifdef NV_PRESERVES_UV
2751 (void)SvIOKp_on(sv);
2753 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2754 SvIVX(sv) = I_V(SvNVX(sv));
2755 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2758 /* Integer is imprecise. NOK, IOKp */
2760 /* UV will not work better than IV */
2762 if (SvNVX(sv) > (NV)UV_MAX) {
2764 /* Integer is inaccurate. NOK, IOKp, is UV */
2768 SvUVX(sv) = U_V(SvNVX(sv));
2769 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2770 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2774 /* Integer is imprecise. NOK, IOKp, is UV */
2780 #else /* NV_PRESERVES_UV */
2781 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2782 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2783 /* The IV slot will have been set from value returned by
2784 grok_number above. The NV slot has just been set using
2787 assert (SvIOKp(sv));
2789 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2790 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2791 /* Small enough to preserve all bits. */
2792 (void)SvIOKp_on(sv);
2794 SvIVX(sv) = I_V(SvNVX(sv));
2795 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2797 /* Assumption: first non-preserved integer is < IV_MAX,
2798 this NV is in the preserved range, therefore: */
2799 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2801 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);
2805 0 0 already failed to read UV.
2806 0 1 already failed to read UV.
2807 1 0 you won't get here in this case. IV/UV
2808 slot set, public IOK, Atof() unneeded.
2809 1 1 already read UV.
2810 so there's no point in sv_2iuv_non_preserve() attempting
2811 to use atol, strtol, strtoul etc. */
2812 if (sv_2iuv_non_preserve (sv, numtype)
2813 >= IS_NUMBER_OVERFLOW_IV)
2817 #endif /* NV_PRESERVES_UV */
2820 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
2822 if (SvTYPE(sv) < SVt_IV)
2823 /* Typically the caller expects that sv_any is not NULL now. */
2824 sv_upgrade(sv, SVt_IV);
2827 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2828 PTR2UV(sv),SvIVX(sv)));
2829 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
2832 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2833 * this function provided for binary compatibility only
2837 Perl_sv_2uv(pTHX_ register SV *sv)
2839 return sv_2uv_flags(sv, SV_GMAGIC);
2843 =for apidoc sv_2uv_flags
2845 Return the unsigned integer value of an SV, doing any necessary string
2846 conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2847 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
2853 Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
2857 if (SvGMAGICAL(sv)) {
2858 if (flags & SV_GMAGIC)
2863 return U_V(SvNVX(sv));
2864 if (SvPOKp(sv) && SvLEN(sv))
2867 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
2868 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
2874 if (SvTHINKFIRST(sv)) {
2877 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
2878 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
2879 return SvUV(tmpstr);
2880 return PTR2UV(SvRV(sv));
2883 sv_force_normal_flags(sv, 0);
2885 if (SvREADONLY(sv) && !SvOK(sv)) {
2886 if (ckWARN(WARN_UNINITIALIZED))
2896 return (UV)SvIVX(sv);
2900 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2901 * without also getting a cached IV/UV from it at the same time
2902 * (ie PV->NV conversion should detect loss of accuracy and cache
2903 * IV or UV at same time to avoid this. */
2904 /* IV-over-UV optimisation - choose to cache IV if possible */
2906 if (SvTYPE(sv) == SVt_NV)
2907 sv_upgrade(sv, SVt_PVNV);
2909 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2910 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2911 SvIVX(sv) = I_V(SvNVX(sv));
2912 if (SvNVX(sv) == (NV) SvIVX(sv)
2913 #ifndef NV_PRESERVES_UV
2914 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2915 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2916 /* Don't flag it as "accurately an integer" if the number
2917 came from a (by definition imprecise) NV operation, and
2918 we're outside the range of NV integer precision */
2921 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2922 DEBUG_c(PerlIO_printf(Perl_debug_log,
2923 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
2929 /* IV not precise. No need to convert from PV, as NV
2930 conversion would already have cached IV if it detected
2931 that PV->IV would be better than PV->NV->IV
2932 flags already correct - don't set public IOK. */
2933 DEBUG_c(PerlIO_printf(Perl_debug_log,
2934 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
2939 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2940 but the cast (NV)IV_MIN rounds to a the value less (more
2941 negative) than IV_MIN which happens to be equal to SvNVX ??
2942 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2943 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2944 (NV)UVX == NVX are both true, but the values differ. :-(
2945 Hopefully for 2s complement IV_MIN is something like
2946 0x8000000000000000 which will be exact. NWC */
2949 SvUVX(sv) = U_V(SvNVX(sv));
2951 (SvNVX(sv) == (NV) SvUVX(sv))
2952 #ifndef NV_PRESERVES_UV
2953 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2954 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2955 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2956 /* Don't flag it as "accurately an integer" if the number
2957 came from a (by definition imprecise) NV operation, and
2958 we're outside the range of NV integer precision */
2963 DEBUG_c(PerlIO_printf(Perl_debug_log,
2964 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
2970 else if (SvPOKp(sv) && SvLEN(sv)) {
2972 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2974 /* We want to avoid a possible problem when we cache a UV which
2975 may be later translated to an NV, and the resulting NV is not
2976 the translation of the initial data.
2978 This means that if we cache such a UV, we need to cache the
2979 NV as well. Moreover, we trade speed for space, and do not
2980 cache the NV if not needed.
2983 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2984 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2985 == IS_NUMBER_IN_UV) {
2986 /* It's definitely an integer, only upgrade to PVIV */
2987 if (SvTYPE(sv) < SVt_PVIV)
2988 sv_upgrade(sv, SVt_PVIV);
2990 } else if (SvTYPE(sv) < SVt_PVNV)
2991 sv_upgrade(sv, SVt_PVNV);
2993 /* If NV preserves UV then we only use the UV value if we know that
2994 we aren't going to call atof() below. If NVs don't preserve UVs
2995 then the value returned may have more precision than atof() will
2996 return, even though it isn't accurate. */
2997 if ((numtype & (IS_NUMBER_IN_UV
2998 #ifdef NV_PRESERVES_UV
3001 )) == IS_NUMBER_IN_UV) {
3002 /* This won't turn off the public IOK flag if it was set above */
3003 (void)SvIOKp_on(sv);
3005 if (!(numtype & IS_NUMBER_NEG)) {
3007 if (value <= (UV)IV_MAX) {
3008 SvIVX(sv) = (IV)value;
3010 /* it didn't overflow, and it was positive. */
3015 /* 2s complement assumption */
3016 if (value <= (UV)IV_MIN) {
3017 SvIVX(sv) = -(IV)value;
3019 /* Too negative for an IV. This is a double upgrade, but
3020 I'm assuming it will be rare. */
3021 if (SvTYPE(sv) < SVt_PVNV)
3022 sv_upgrade(sv, SVt_PVNV);
3026 SvNVX(sv) = -(NV)value;
3032 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3033 != IS_NUMBER_IN_UV) {
3034 /* It wasn't an integer, or it overflowed the UV. */
3035 SvNVX(sv) = Atof(SvPVX(sv));
3037 if (! numtype && ckWARN(WARN_NUMERIC))
3040 #if defined(USE_LONG_DOUBLE)
3041 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
3042 PTR2UV(sv), SvNVX(sv)));
3044 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
3045 PTR2UV(sv), SvNVX(sv)));
3048 #ifdef NV_PRESERVES_UV
3049 (void)SvIOKp_on(sv);
3051 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3052 SvIVX(sv) = I_V(SvNVX(sv));
3053 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
3056 /* Integer is imprecise. NOK, IOKp */
3058 /* UV will not work better than IV */
3060 if (SvNVX(sv) > (NV)UV_MAX) {
3062 /* Integer is inaccurate. NOK, IOKp, is UV */
3066 SvUVX(sv) = U_V(SvNVX(sv));
3067 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
3068 NV preservse UV so can do correct comparison. */
3069 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
3073 /* Integer is imprecise. NOK, IOKp, is UV */
3078 #else /* NV_PRESERVES_UV */
3079 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3080 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
3081 /* The UV slot will have been set from value returned by
3082 grok_number above. The NV slot has just been set using
3085 assert (SvIOKp(sv));
3087 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3088 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3089 /* Small enough to preserve all bits. */
3090 (void)SvIOKp_on(sv);
3092 SvIVX(sv) = I_V(SvNVX(sv));
3093 if ((NV)(SvIVX(sv)) == SvNVX(sv))
3095 /* Assumption: first non-preserved integer is < IV_MAX,
3096 this NV is in the preserved range, therefore: */
3097 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
3099 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);
3102 sv_2iuv_non_preserve (sv, numtype);
3104 #endif /* NV_PRESERVES_UV */
3108 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3109 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3112 if (SvTYPE(sv) < SVt_IV)
3113 /* Typically the caller expects that sv_any is not NULL now. */
3114 sv_upgrade(sv, SVt_IV);
3118 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
3119 PTR2UV(sv),SvUVX(sv)));
3120 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
3126 Return the num value of an SV, doing any necessary string or integer
3127 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3134 Perl_sv_2nv(pTHX_ register SV *sv)
3138 if (SvGMAGICAL(sv)) {
3142 if (SvPOKp(sv) && SvLEN(sv)) {
3143 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
3144 !grok_number(SvPVX(sv), SvCUR(sv), NULL))
3146 return Atof(SvPVX(sv));
3150 return (NV)SvUVX(sv);
3152 return (NV)SvIVX(sv);
3155 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3156 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3162 if (SvTHINKFIRST(sv)) {
3165 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
3166 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
3167 return SvNV(tmpstr);
3168 return PTR2NV(SvRV(sv));
3171 sv_force_normal_flags(sv, 0);
3173 if (SvREADONLY(sv) && !SvOK(sv)) {
3174 if (ckWARN(WARN_UNINITIALIZED))
3179 if (SvTYPE(sv) < SVt_NV) {
3180 if (SvTYPE(sv) == SVt_IV)
3181 sv_upgrade(sv, SVt_PVNV);
3183 sv_upgrade(sv, SVt_NV);
3184 #ifdef USE_LONG_DOUBLE
3186 STORE_NUMERIC_LOCAL_SET_STANDARD();
3187 PerlIO_printf(Perl_debug_log,
3188 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
3189 PTR2UV(sv), SvNVX(sv));
3190 RESTORE_NUMERIC_LOCAL();
3194 STORE_NUMERIC_LOCAL_SET_STANDARD();
3195 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
3196 PTR2UV(sv), SvNVX(sv));
3197 RESTORE_NUMERIC_LOCAL();
3201 else if (SvTYPE(sv) < SVt_PVNV)
3202 sv_upgrade(sv, SVt_PVNV);
3207 SvNVX(sv) = SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv);
3208 #ifdef NV_PRESERVES_UV
3211 /* Only set the public NV OK flag if this NV preserves the IV */
3212 /* Check it's not 0xFFFFFFFFFFFFFFFF */
3213 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
3214 : (SvIVX(sv) == I_V(SvNVX(sv))))
3220 else if (SvPOKp(sv) && SvLEN(sv)) {
3222 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3223 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
3225 #ifdef NV_PRESERVES_UV
3226 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3227 == IS_NUMBER_IN_UV) {
3228 /* It's definitely an integer */
3229 SvNVX(sv) = (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value;
3231 SvNVX(sv) = Atof(SvPVX(sv));
3234 SvNVX(sv) = Atof(SvPVX(sv));
3235 /* Only set the public NV OK flag if this NV preserves the value in
3236 the PV at least as well as an IV/UV would.
3237 Not sure how to do this 100% reliably. */
3238 /* if that shift count is out of range then Configure's test is
3239 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
3241 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3242 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3243 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
3244 } else if (!(numtype & IS_NUMBER_IN_UV)) {
3245 /* Can't use strtol etc to convert this string, so don't try.
3246 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
3249 /* value has been set. It may not be precise. */
3250 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
3251 /* 2s complement assumption for (UV)IV_MIN */
3252 SvNOK_on(sv); /* Integer is too negative. */
3257 if (numtype & IS_NUMBER_NEG) {
3258 SvIVX(sv) = -(IV)value;
3259 } else if (value <= (UV)IV_MAX) {
3260 SvIVX(sv) = (IV)value;
3266 if (numtype & IS_NUMBER_NOT_INT) {
3267 /* I believe that even if the original PV had decimals,
3268 they are lost beyond the limit of the FP precision.
3269 However, neither is canonical, so both only get p
3270 flags. NWC, 2000/11/25 */
3271 /* Both already have p flags, so do nothing */
3274 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3275 if (SvIVX(sv) == I_V(nv)) {
3280 /* It had no "." so it must be integer. */
3283 /* between IV_MAX and NV(UV_MAX).
3284 Could be slightly > UV_MAX */
3286 if (numtype & IS_NUMBER_NOT_INT) {
3287 /* UV and NV both imprecise. */
3289 UV nv_as_uv = U_V(nv);
3291 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
3302 #endif /* NV_PRESERVES_UV */
3305 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3307 if (SvTYPE(sv) < SVt_NV)
3308 /* Typically the caller expects that sv_any is not NULL now. */
3309 /* XXX Ilya implies that this is a bug in callers that assume this
3310 and ideally should be fixed. */
3311 sv_upgrade(sv, SVt_NV);
3314 #if defined(USE_LONG_DOUBLE)
3316 STORE_NUMERIC_LOCAL_SET_STANDARD();
3317 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
3318 PTR2UV(sv), SvNVX(sv));
3319 RESTORE_NUMERIC_LOCAL();
3323 STORE_NUMERIC_LOCAL_SET_STANDARD();
3324 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
3325 PTR2UV(sv), SvNVX(sv));
3326 RESTORE_NUMERIC_LOCAL();
3332 /* asIV(): extract an integer from the string value of an SV.
3333 * Caller must validate PVX */
3336 S_asIV(pTHX_ SV *sv)
3339 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3341 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3342 == IS_NUMBER_IN_UV) {
3343 /* It's definitely an integer */
3344 if (numtype & IS_NUMBER_NEG) {
3345 if (value < (UV)IV_MIN)
3348 if (value < (UV)IV_MAX)
3353 if (ckWARN(WARN_NUMERIC))
3356 return I_V(Atof(SvPVX(sv)));
3359 /* asUV(): extract an unsigned integer from the string value of an SV
3360 * Caller must validate PVX */
3363 S_asUV(pTHX_ SV *sv)
3366 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3368 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3369 == IS_NUMBER_IN_UV) {
3370 /* It's definitely an integer */
3371 if (!(numtype & IS_NUMBER_NEG))
3375 if (ckWARN(WARN_NUMERIC))
3378 return U_V(Atof(SvPVX(sv)));
3382 =for apidoc sv_2pv_nolen
3384 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3385 use the macro wrapper C<SvPV_nolen(sv)> instead.
3390 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
3393 return sv_2pv(sv, &n_a);
3396 /* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
3397 * UV as a string towards the end of buf, and return pointers to start and
3400 * We assume that buf is at least TYPE_CHARS(UV) long.
3404 uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
3406 char *ptr = buf + TYPE_CHARS(UV);
3420 *--ptr = '0' + (char)(uv % 10);
3428 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
3429 * this function provided for binary compatibility only
3433 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
3435 return sv_2pv_flags(sv, lp, SV_GMAGIC);
3439 =for apidoc sv_2pv_flags
3441 Returns a pointer to the string value of an SV, and sets *lp to its length.
3442 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3444 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3445 usually end up here too.
3451 Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3456 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3457 char *tmpbuf = tbuf;
3463 if (SvGMAGICAL(sv)) {
3464 if (flags & SV_GMAGIC)
3472 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
3474 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
3479 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
3484 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
3485 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
3492 if (SvTHINKFIRST(sv)) {
3495 register const char *typestr;
3496 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
3497 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
3498 char *pv = SvPV(tmpstr, *lp);
3508 typestr = "NULLREF";
3512 switch (SvTYPE(sv)) {
3514 if ( ((SvFLAGS(sv) &
3515 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3516 == (SVs_OBJECT|SVs_SMG))
3517 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
3518 const regexp *re = (regexp *)mg->mg_obj;
3521 const char *fptr = "msix";
3526 char need_newline = 0;
3527 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
3529 while((ch = *fptr++)) {
3531 reflags[left++] = ch;
3534 reflags[right--] = ch;
3539 reflags[left] = '-';
3543 mg->mg_len = re->prelen + 4 + left;
3545 * If /x was used, we have to worry about a regex
3546 * ending with a comment later being embedded
3547 * within another regex. If so, we don't want this
3548 * regex's "commentization" to leak out to the
3549 * right part of the enclosing regex, we must cap
3550 * it with a newline.
3552 * So, if /x was used, we scan backwards from the
3553 * end of the regex. If we find a '#' before we
3554 * find a newline, we need to add a newline
3555 * ourself. If we find a '\n' first (or if we
3556 * don't find '#' or '\n'), we don't need to add
3557 * anything. -jfriedl
3559 if (PMf_EXTENDED & re->reganch)
3561 const char *endptr = re->precomp + re->prelen;
3562 while (endptr >= re->precomp)
3564 const char c = *(endptr--);
3566 break; /* don't need another */
3568 /* we end while in a comment, so we
3570 mg->mg_len++; /* save space for it */
3571 need_newline = 1; /* note to add it */
3577 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3578 Copy("(?", mg->mg_ptr, 2, char);
3579 Copy(reflags, mg->mg_ptr+2, left, char);
3580 Copy(":", mg->mg_ptr+left+2, 1, char);
3581 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
3583 mg->mg_ptr[mg->mg_len - 2] = '\n';
3584 mg->mg_ptr[mg->mg_len - 1] = ')';
3585 mg->mg_ptr[mg->mg_len] = 0;
3587 PL_reginterp_cnt += re->program[0].next_off;
3589 if (re->reganch & ROPT_UTF8)
3604 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3605 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
3606 /* tied lvalues should appear to be
3607 * scalars for backwards compatitbility */
3608 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3609 ? "SCALAR" : "LVALUE"; break;
3610 case SVt_PVAV: typestr = "ARRAY"; break;
3611 case SVt_PVHV: typestr = "HASH"; break;
3612 case SVt_PVCV: typestr = "CODE"; break;
3613 case SVt_PVGV: typestr = "GLOB"; break;
3614 case SVt_PVFM: typestr = "FORMAT"; break;
3615 case SVt_PVIO: typestr = "IO"; break;
3616 default: typestr = "UNKNOWN"; break;
3620 const char *name = HvNAME(SvSTASH(sv));
3621 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3622 name ? name : "__ANON__" , typestr, PTR2UV(sv));
3625 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
3628 *lp = strlen(typestr);
3629 return (char *)typestr;
3631 if (SvREADONLY(sv) && !SvOK(sv)) {
3632 if (ckWARN(WARN_UNINITIALIZED))
3638 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3639 /* I'm assuming that if both IV and NV are equally valid then
3640 converting the IV is going to be more efficient */
3641 const U32 isIOK = SvIOK(sv);
3642 const U32 isUIOK = SvIsUV(sv);
3643 char buf[TYPE_CHARS(UV)];
3646 if (SvTYPE(sv) < SVt_PVIV)
3647 sv_upgrade(sv, SVt_PVIV);
3649 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3651 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
3652 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
3653 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3654 SvCUR_set(sv, ebuf - ptr);
3664 else if (SvNOKp(sv)) {
3665 if (SvTYPE(sv) < SVt_PVNV)
3666 sv_upgrade(sv, SVt_PVNV);
3667 /* The +20 is pure guesswork. Configure test needed. --jhi */
3668 SvGROW(sv, NV_DIG + 20);
3670 olderrno = errno; /* some Xenix systems wipe out errno here */
3672 if (SvNVX(sv) == 0.0)
3673 (void)strcpy(s,"0");
3677 Gconvert(SvNVX(sv), NV_DIG, 0, s);
3680 #ifdef FIXNEGATIVEZERO
3681 if (*s == '-' && s[1] == '0' && !s[2])
3691 if (ckWARN(WARN_UNINITIALIZED)
3692 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
3695 if (SvTYPE(sv) < SVt_PV)
3696 /* Typically the caller expects that sv_any is not NULL now. */
3697 sv_upgrade(sv, SVt_PV);
3700 *lp = s - SvPVX(sv);
3703 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3704 PTR2UV(sv),SvPVX(sv)));
3708 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3709 /* Sneaky stuff here */
3713 tsv = newSVpv(tmpbuf, 0);
3729 len = strlen(tmpbuf);
3731 #ifdef FIXNEGATIVEZERO
3732 if (len == 2 && t[0] == '-' && t[1] == '0') {
3737 (void)SvUPGRADE(sv, SVt_PV);
3739 s = SvGROW(sv, len + 1);
3742 return strcpy(s, t);
3747 =for apidoc sv_copypv
3749 Copies a stringified representation of the source SV into the
3750 destination SV. Automatically performs any necessary mg_get and
3751 coercion of numeric values into strings. Guaranteed to preserve
3752 UTF-8 flag even from overloaded objects. Similar in nature to
3753 sv_2pv[_flags] but operates directly on an SV instead of just the
3754 string. Mostly uses sv_2pv_flags to do its work, except when that
3755 would lose the UTF-8'ness of the PV.
3761 Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3766 sv_setpvn(dsv,s,len);
3774 =for apidoc sv_2pvbyte_nolen
3776 Return a pointer to the byte-encoded representation of the SV.
3777 May cause the SV to be downgraded from UTF-8 as a side-effect.
3779 Usually accessed via the C<SvPVbyte_nolen> macro.
3785 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3788 return sv_2pvbyte(sv, &n_a);
3792 =for apidoc sv_2pvbyte
3794 Return a pointer to the byte-encoded representation of the SV, and set *lp
3795 to its length. May cause the SV to be downgraded from UTF-8 as a
3798 Usually accessed via the C<SvPVbyte> macro.
3804 Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3806 sv_utf8_downgrade(sv,0);
3807 return SvPV(sv,*lp);
3811 =for apidoc sv_2pvutf8_nolen
3813 Return a pointer to the UTF-8-encoded representation of the SV.
3814 May cause the SV to be upgraded to UTF-8 as a side-effect.
3816 Usually accessed via the C<SvPVutf8_nolen> macro.
3822 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3825 return sv_2pvutf8(sv, &n_a);
3829 =for apidoc sv_2pvutf8
3831 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3832 to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3834 Usually accessed via the C<SvPVutf8> macro.
3840 Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3842 sv_utf8_upgrade(sv);
3843 return SvPV(sv,*lp);
3847 =for apidoc sv_2bool
3849 This function is only called on magical items, and is only used by
3850 sv_true() or its macro equivalent.
3856 Perl_sv_2bool(pTHX_ register SV *sv)
3865 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
3866 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
3867 return (bool)SvTRUE(tmpsv);
3868 return SvRV(sv) != 0;
3871 register XPV* Xpvtmp;
3872 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3873 (*Xpvtmp->xpv_pv > '0' ||
3874 Xpvtmp->xpv_cur > 1 ||
3875 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
3882 return SvIVX(sv) != 0;
3885 return SvNVX(sv) != 0.0;
3892 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3893 * this function provided for binary compatibility only
3898 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3900 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3904 =for apidoc sv_utf8_upgrade
3906 Converts the PV of an SV to its UTF-8-encoded form.
3907 Forces the SV to string form if it is not already.
3908 Always sets the SvUTF8 flag to avoid future validity checks even
3909 if all the bytes have hibit clear.
3911 This is not as a general purpose byte encoding to Unicode interface:
3912 use the Encode extension for that.
3914 =for apidoc sv_utf8_upgrade_flags
3916 Converts the PV of an SV to its UTF-8-encoded form.
3917 Forces the SV to string form if it is not already.
3918 Always sets the SvUTF8 flag to avoid future validity checks even
3919 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3920 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3921 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3923 This is not as a general purpose byte encoding to Unicode interface:
3924 use the Encode extension for that.
3930 Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3935 if (sv == &PL_sv_undef)
3939 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3940 (void) sv_2pv_flags(sv,&len, flags);
3944 (void) SvPV_force(sv,len);
3953 sv_force_normal_flags(sv, 0);
3956 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
3957 sv_recode_to_utf8(sv, PL_encoding);
3958 else { /* Assume Latin-1/EBCDIC */
3959 /* This function could be much more efficient if we
3960 * had a FLAG in SVs to signal if there are any hibit
3961 * chars in the PV. Given that there isn't such a flag
3962 * make the loop as fast as possible. */
3963 s = (U8 *) SvPVX(sv);
3964 e = (U8 *) SvEND(sv);
3968 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3973 (void)SvOOK_off(sv);
3975 len = SvCUR(sv) + 1; /* Plus the \0 */
3976 SvPVX(sv) = (char*)bytes_to_utf8((U8*)s, &len);
3977 SvCUR(sv) = len - 1;
3979 Safefree(s); /* No longer using what was there before. */
3980 SvLEN(sv) = len; /* No longer know the real size. */
3982 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3989 =for apidoc sv_utf8_downgrade
3991 Attempts to convert the PV of an SV from characters to bytes.
3992 If the PV contains a character beyond byte, this conversion will fail;
3993 in this case, either returns false or, if C<fail_ok> is not
3996 This is not as a general purpose Unicode to byte encoding interface:
3997 use the Encode extension for that.
4003 Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
4005 if (SvPOKp(sv) && SvUTF8(sv)) {
4011 sv_force_normal_flags(sv, 0);
4013 s = (U8 *) SvPV(sv, len);
4014 if (!utf8_to_bytes(s, &len)) {
4019 Perl_croak(aTHX_ "Wide character in %s",
4022 Perl_croak(aTHX_ "Wide character");
4033 =for apidoc sv_utf8_encode
4035 Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
4036 flag off so that it looks like octets again.
4042 Perl_sv_utf8_encode(pTHX_ register SV *sv)
4044 (void) sv_utf8_upgrade(sv);
4046 sv_force_normal_flags(sv, 0);
4048 if (SvREADONLY(sv)) {
4049 Perl_croak(aTHX_ PL_no_modify);
4055 =for apidoc sv_utf8_decode
4057 If the PV of the SV is an octet sequence in UTF-8
4058 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
4059 so that it looks like a character. If the PV contains only single-byte
4060 characters, the C<SvUTF8> flag stays being off.
4061 Scans PV for validity and returns false if the PV is invalid UTF-8.
4067 Perl_sv_utf8_decode(pTHX_ register SV *sv)
4073 /* The octets may have got themselves encoded - get them back as
4076 if (!sv_utf8_downgrade(sv, TRUE))
4079 /* it is actually just a matter of turning the utf8 flag on, but
4080 * we want to make sure everything inside is valid utf8 first.
4082 c = (U8 *) SvPVX(sv);
4083 if (!is_utf8_string(c, SvCUR(sv)+1))
4085 e = (U8 *) SvEND(sv);
4088 if (!UTF8_IS_INVARIANT(ch)) {
4097 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
4098 * this function provided for binary compatibility only
4102 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
4104 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
4108 =for apidoc sv_setsv
4110 Copies the contents of the source SV C<ssv> into the destination SV
4111 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4112 function if the source SV needs to be reused. Does not handle 'set' magic.
4113 Loosely speaking, it performs a copy-by-value, obliterating any previous
4114 content of the destination.
4116 You probably want to use one of the assortment of wrappers, such as
4117 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4118 C<SvSetMagicSV_nosteal>.
4120 =for apidoc sv_setsv_flags
4122 Copies the contents of the source SV C<ssv> into the destination SV
4123 C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4124 function if the source SV needs to be reused. Does not handle 'set' magic.
4125 Loosely speaking, it performs a copy-by-value, obliterating any previous
4126 content of the destination.
4127 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4128 C<ssv> if appropriate, else not. If the C<flags> parameter has the
4129 C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4130 and C<sv_setsv_nomg> are implemented in terms of this function.
4132 You probably want to use one of the assortment of wrappers, such as
4133 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4134 C<SvSetMagicSV_nosteal>.
4136 This is the primary function for copying scalars, and most other
4137 copy-ish functions and macros use this underneath.
4143 Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
4145 register U32 sflags;
4151 SV_CHECK_THINKFIRST_COW_DROP(dstr);
4153 sstr = &PL_sv_undef;
4154 stype = SvTYPE(sstr);
4155 dtype = SvTYPE(dstr);
4160 /* need to nuke the magic */
4162 SvRMAGICAL_off(dstr);
4165 /* There's a lot of redundancy below but we're going for speed here */
4170 if (dtype != SVt_PVGV) {
4171 (void)SvOK_off(dstr);
4179 sv_upgrade(dstr, SVt_IV);
4182 sv_upgrade(dstr, SVt_PVNV);
4186 sv_upgrade(dstr, SVt_PVIV);
4189 (void)SvIOK_only(dstr);
4190 SvIVX(dstr) = SvIVX(sstr);
4193 if (SvTAINTED(sstr))
4204 sv_upgrade(dstr, SVt_NV);
4209 sv_upgrade(dstr, SVt_PVNV);
4212 SvNVX(dstr) = SvNVX(sstr);
4213 (void)SvNOK_only(dstr);
4214 if (SvTAINTED(sstr))
4222 sv_upgrade(dstr, SVt_RV);
4223 else if (dtype == SVt_PVGV &&
4224 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
4227 if (GvIMPORTED(dstr) != GVf_IMPORTED
4228 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4230 GvIMPORTED_on(dstr);
4239 #ifdef PERL_COPY_ON_WRITE
4240 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4241 if (dtype < SVt_PVIV)
4242 sv_upgrade(dstr, SVt_PVIV);
4249 sv_upgrade(dstr, SVt_PV);
4252 if (dtype < SVt_PVIV)
4253 sv_upgrade(dstr, SVt_PVIV);
4256 if (dtype < SVt_PVNV)
4257 sv_upgrade(dstr, SVt_PVNV);
4264 Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
4267 Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
4271 if (dtype <= SVt_PVGV) {
4273 if (dtype != SVt_PVGV) {
4274 char *name = GvNAME(sstr);
4275 STRLEN len = GvNAMELEN(sstr);
4276 /* don't upgrade SVt_PVLV: it can hold a glob */
4277 if (dtype != SVt_PVLV)
4278 sv_upgrade(dstr, SVt_PVGV);
4279 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
4280 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
4281 GvNAME(dstr) = savepvn(name, len);
4282 GvNAMELEN(dstr) = len;
4283 SvFAKE_on(dstr); /* can coerce to non-glob */
4285 /* ahem, death to those who redefine active sort subs */
4286 else if (PL_curstackinfo->si_type == PERLSI_SORT
4287 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
4288 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
4291 #ifdef GV_UNIQUE_CHECK
4292 if (GvUNIQUE((GV*)dstr)) {
4293 Perl_croak(aTHX_ PL_no_modify);
4297 (void)SvOK_off(dstr);
4298 GvINTRO_off(dstr); /* one-shot flag */
4300 GvGP(dstr) = gp_ref(GvGP(sstr));
4301 if (SvTAINTED(sstr))
4303 if (GvIMPORTED(dstr) != GVf_IMPORTED
4304 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4306 GvIMPORTED_on(dstr);
4314 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
4316 if ((int)SvTYPE(sstr) != stype) {
4317 stype = SvTYPE(sstr);
4318 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
4322 if (stype == SVt_PVLV)
4323 (void)SvUPGRADE(dstr, SVt_PVNV);
4325 (void)SvUPGRADE(dstr, (U32)stype);
4328 sflags = SvFLAGS(sstr);
4330 if (sflags & SVf_ROK) {
4331 if (dtype >= SVt_PV) {
4332 if (dtype == SVt_PVGV) {
4333 SV *sref = SvREFCNT_inc(SvRV(sstr));
4335 int intro = GvINTRO(dstr);
4337 #ifdef GV_UNIQUE_CHECK
4338 if (GvUNIQUE((GV*)dstr)) {
4339 Perl_croak(aTHX_ PL_no_modify);
4344 GvINTRO_off(dstr); /* one-shot flag */
4345 GvLINE(dstr) = CopLINE(PL_curcop);
4346 GvEGV(dstr) = (GV*)dstr;
4349 switch (SvTYPE(sref)) {
4352 SAVEGENERICSV(GvAV(dstr));
4354 dref = (SV*)GvAV(dstr);
4355 GvAV(dstr) = (AV*)sref;
4356 if (!GvIMPORTED_AV(dstr)
4357 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4359 GvIMPORTED_AV_on(dstr);
4364 SAVEGENERICSV(GvHV(dstr));
4366 dref = (SV*)GvHV(dstr);
4367 GvHV(dstr) = (HV*)sref;
4368 if (!GvIMPORTED_HV(dstr)
4369 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4371 GvIMPORTED_HV_on(dstr);
4376 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
4377 SvREFCNT_dec(GvCV(dstr));
4378 GvCV(dstr) = Nullcv;
4379 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4380 PL_sub_generation++;
4382 SAVEGENERICSV(GvCV(dstr));
4385 dref = (SV*)GvCV(dstr);
4386 if (GvCV(dstr) != (CV*)sref) {
4387 CV* cv = GvCV(dstr);
4389 if (!GvCVGEN((GV*)dstr) &&
4390 (CvROOT(cv) || CvXSUB(cv)))
4392 /* ahem, death to those who redefine
4393 * active sort subs */
4394 if (PL_curstackinfo->si_type == PERLSI_SORT &&
4395 PL_sortcop == CvSTART(cv))
4397 "Can't redefine active sort subroutine %s",
4398 GvENAME((GV*)dstr));
4399 /* Redefining a sub - warning is mandatory if
4400 it was a const and its value changed. */
4401 if (ckWARN(WARN_REDEFINE)
4403 && (!CvCONST((CV*)sref)
4404 || sv_cmp(cv_const_sv(cv),
4405 cv_const_sv((CV*)sref)))))
4407 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
4409 ? "Constant subroutine %s::%s redefined"
4410 : "Subroutine %s::%s redefined",
4411 HvNAME(GvSTASH((GV*)dstr)),
4412 GvENAME((GV*)dstr));
4416 cv_ckproto(cv, (GV*)dstr,
4417 SvPOK(sref) ? SvPVX(sref) : Nullch);
4419 GvCV(dstr) = (CV*)sref;
4420 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
4421 GvASSUMECV_on(dstr);
4422 PL_sub_generation++;
4424 if (!GvIMPORTED_CV(dstr)
4425 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4427 GvIMPORTED_CV_on(dstr);
4432 SAVEGENERICSV(GvIOp(dstr));
4434 dref = (SV*)GvIOp(dstr);
4435 GvIOp(dstr) = (IO*)sref;
4439 SAVEGENERICSV(GvFORM(dstr));
4441 dref = (SV*)GvFORM(dstr);
4442 GvFORM(dstr) = (CV*)sref;
4446 SAVEGENERICSV(GvSV(dstr));
4448 dref = (SV*)GvSV(dstr);
4450 if (!GvIMPORTED_SV(dstr)
4451 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4453 GvIMPORTED_SV_on(dstr);
4459 if (SvTAINTED(sstr))
4464 (void)SvOOK_off(dstr); /* backoff */
4466 Safefree(SvPVX(dstr));
4467 SvLEN(dstr)=SvCUR(dstr)=0;
4470 (void)SvOK_off(dstr);
4471 SvRV(dstr) = SvREFCNT_inc(SvRV(sstr));
4473 if (sflags & SVp_NOK) {
4475 /* Only set the public OK flag if the source has public OK. */
4476 if (sflags & SVf_NOK)
4477 SvFLAGS(dstr) |= SVf_NOK;
4478 SvNVX(dstr) = SvNVX(sstr);
4480 if (sflags & SVp_IOK) {
4481 (void)SvIOKp_on(dstr);
4482 if (sflags & SVf_IOK)
4483 SvFLAGS(dstr) |= SVf_IOK;
4484 if (sflags & SVf_IVisUV)
4486 SvIVX(dstr) = SvIVX(sstr);
4488 if (SvAMAGIC(sstr)) {
4492 else if (sflags & SVp_POK) {
4496 * Check to see if we can just swipe the string. If so, it's a
4497 * possible small lose on short strings, but a big win on long ones.
4498 * It might even be a win on short strings if SvPVX(dstr)
4499 * has to be allocated and SvPVX(sstr) has to be freed.
4502 /* Whichever path we take through the next code, we want this true,
4503 and doing it now facilitates the COW check. */
4504 (void)SvPOK_only(dstr);
4507 #ifdef PERL_COPY_ON_WRITE
4508 (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4512 (sflags & SVs_TEMP) && /* slated for free anyway? */
4513 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
4514 (!(flags & SV_NOSTEAL)) &&
4515 /* and we're allowed to steal temps */
4516 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4517 SvLEN(sstr) && /* and really is a string */
4518 /* and won't be needed again, potentially */
4519 !(PL_op && PL_op->op_type == OP_AASSIGN))
4520 #ifdef PERL_COPY_ON_WRITE
4521 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
4522 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
4523 && SvTYPE(sstr) >= SVt_PVIV)
4526 /* Failed the swipe test, and it's not a shared hash key either.
4527 Have to copy the string. */
4528 STRLEN len = SvCUR(sstr);
4529 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4530 Move(SvPVX(sstr),SvPVX(dstr),len,char);
4531 SvCUR_set(dstr, len);
4532 *SvEND(dstr) = '\0';
4534 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
4536 #ifdef PERL_COPY_ON_WRITE
4537 /* Either it's a shared hash key, or it's suitable for
4538 copy-on-write or we can swipe the string. */
4540 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
4545 /* I believe I should acquire a global SV mutex if
4546 it's a COW sv (not a shared hash key) to stop
4547 it going un copy-on-write.
4548 If the source SV has gone un copy on write between up there
4549 and down here, then (assert() that) it is of the correct
4550 form to make it copy on write again */
4551 if ((sflags & (SVf_FAKE | SVf_READONLY))
4552 != (SVf_FAKE | SVf_READONLY)) {
4553 SvREADONLY_on(sstr);
4555 /* Make the source SV into a loop of 1.
4556 (about to become 2) */
4557 SV_COW_NEXT_SV_SET(sstr, sstr);
4561 /* Initial code is common. */
4562 if (SvPVX(dstr)) { /* we know that dtype >= SVt_PV */
4564 SvFLAGS(dstr) &= ~SVf_OOK;
4565 Safefree(SvPVX(dstr) - SvIVX(dstr));
4567 else if (SvLEN(dstr))
4568 Safefree(SvPVX(dstr));
4571 #ifdef PERL_COPY_ON_WRITE
4573 /* making another shared SV. */
4574 STRLEN cur = SvCUR(sstr);
4575 STRLEN len = SvLEN(sstr);
4576 assert (SvTYPE(dstr) >= SVt_PVIV);
4578 /* SvIsCOW_normal */
4579 /* splice us in between source and next-after-source. */
4580 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4581 SV_COW_NEXT_SV_SET(sstr, dstr);
4582 SvPV_set(dstr, SvPVX(sstr));
4584 /* SvIsCOW_shared_hash */
4585 UV hash = SvUVX(sstr);
4586 DEBUG_C(PerlIO_printf(Perl_debug_log,
4587 "Copy on write: Sharing hash\n"));
4589 sharepvn(SvPVX(sstr),
4590 (sflags & SVf_UTF8?-cur:cur), hash));
4595 SvREADONLY_on(dstr);
4597 /* Relesase a global SV mutex. */
4601 { /* Passes the swipe test. */
4602 SvPV_set(dstr, SvPVX(sstr));
4603 SvLEN_set(dstr, SvLEN(sstr));
4604 SvCUR_set(dstr, SvCUR(sstr));
4607 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4608 SvPV_set(sstr, Nullch);
4614 if (sflags & SVf_UTF8)
4617 if (sflags & SVp_NOK) {
4619 if (sflags & SVf_NOK)
4620 SvFLAGS(dstr) |= SVf_NOK;
4621 SvNVX(dstr) = SvNVX(sstr);
4623 if (sflags & SVp_IOK) {
4624 (void)SvIOKp_on(dstr);
4625 if (sflags & SVf_IOK)
4626 SvFLAGS(dstr) |= SVf_IOK;
4627 if (sflags & SVf_IVisUV)
4629 SvIVX(dstr) = SvIVX(sstr);
4632 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4633 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4634 smg->mg_ptr, smg->mg_len);
4635 SvRMAGICAL_on(dstr);
4638 else if (sflags & SVp_IOK) {
4639 if (sflags & SVf_IOK)
4640 (void)SvIOK_only(dstr);
4642 (void)SvOK_off(dstr);
4643 (void)SvIOKp_on(dstr);
4645 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
4646 if (sflags & SVf_IVisUV)
4648 SvIVX(dstr) = SvIVX(sstr);
4649 if (sflags & SVp_NOK) {
4650 if (sflags & SVf_NOK)
4651 (void)SvNOK_on(dstr);
4653 (void)SvNOKp_on(dstr);
4654 SvNVX(dstr) = SvNVX(sstr);
4657 else if (sflags & SVp_NOK) {
4658 if (sflags & SVf_NOK)
4659 (void)SvNOK_only(dstr);
4661 (void)SvOK_off(dstr);
4664 SvNVX(dstr) = SvNVX(sstr);
4667 if (dtype == SVt_PVGV) {
4668 if (ckWARN(WARN_MISC))
4669 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
4672 (void)SvOK_off(dstr);
4674 if (SvTAINTED(sstr))
4679 =for apidoc sv_setsv_mg
4681 Like C<sv_setsv>, but also handles 'set' magic.
4687 Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
4689 sv_setsv(dstr,sstr);
4693 #ifdef PERL_COPY_ON_WRITE
4695 Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4697 STRLEN cur = SvCUR(sstr);
4698 STRLEN len = SvLEN(sstr);
4699 register char *new_pv;
4702 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4710 if (SvTHINKFIRST(dstr))
4711 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4712 else if (SvPVX(dstr))
4713 Safefree(SvPVX(dstr));
4717 (void)SvUPGRADE (dstr, SVt_PVIV);
4719 assert (SvPOK(sstr));
4720 assert (SvPOKp(sstr));
4721 assert (!SvIOK(sstr));
4722 assert (!SvIOKp(sstr));
4723 assert (!SvNOK(sstr));
4724 assert (!SvNOKp(sstr));
4726 if (SvIsCOW(sstr)) {
4728 if (SvLEN(sstr) == 0) {
4729 /* source is a COW shared hash key. */
4730 UV hash = SvUVX(sstr);
4731 DEBUG_C(PerlIO_printf(Perl_debug_log,
4732 "Fast copy on write: Sharing hash\n"));
4734 new_pv = sharepvn(SvPVX(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4737 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4739 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
4740 (void)SvUPGRADE (sstr, SVt_PVIV);
4741 SvREADONLY_on(sstr);
4743 DEBUG_C(PerlIO_printf(Perl_debug_log,
4744 "Fast copy on write: Converting sstr to COW\n"));
4745 SV_COW_NEXT_SV_SET(dstr, sstr);
4747 SV_COW_NEXT_SV_SET(sstr, dstr);
4748 new_pv = SvPVX(sstr);
4751 SvPV_set(dstr, new_pv);
4752 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4765 =for apidoc sv_setpvn
4767 Copies a string into an SV. The C<len> parameter indicates the number of
4768 bytes to be copied. If the C<ptr> argument is NULL the SV will become
4769 undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4775 Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4777 register char *dptr;
4779 SV_CHECK_THINKFIRST_COW_DROP(sv);
4785 /* len is STRLEN which is unsigned, need to copy to signed */
4788 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
4790 (void)SvUPGRADE(sv, SVt_PV);
4792 SvGROW(sv, len + 1);
4794 Move(ptr,dptr,len,char);
4797 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4802 =for apidoc sv_setpvn_mg
4804 Like C<sv_setpvn>, but also handles 'set' magic.
4810 Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
4812 sv_setpvn(sv,ptr,len);
4817 =for apidoc sv_setpv
4819 Copies a string into an SV. The string must be null-terminated. Does not
4820 handle 'set' magic. See C<sv_setpv_mg>.
4826 Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
4828 register STRLEN len;
4830 SV_CHECK_THINKFIRST_COW_DROP(sv);
4836 (void)SvUPGRADE(sv, SVt_PV);
4838 SvGROW(sv, len + 1);
4839 Move(ptr,SvPVX(sv),len+1,char);
4841 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4846 =for apidoc sv_setpv_mg
4848 Like C<sv_setpv>, but also handles 'set' magic.
4854 Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
4861 =for apidoc sv_usepvn
4863 Tells an SV to use C<ptr> to find its string value. Normally the string is
4864 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4865 The C<ptr> should point to memory that was allocated by C<malloc>. The
4866 string length, C<len>, must be supplied. This function will realloc the
4867 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4868 the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4869 See C<sv_usepvn_mg>.
4875 Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4877 SV_CHECK_THINKFIRST_COW_DROP(sv);
4878 (void)SvUPGRADE(sv, SVt_PV);
4883 (void)SvOOK_off(sv);
4884 if (SvPVX(sv) && SvLEN(sv))
4885 Safefree(SvPVX(sv));
4886 Renew(ptr, len+1, char);
4889 SvLEN_set(sv, len+1);
4891 (void)SvPOK_only_UTF8(sv); /* validate pointer */
4896 =for apidoc sv_usepvn_mg
4898 Like C<sv_usepvn>, but also handles 'set' magic.
4904 Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
4906 sv_usepvn(sv,ptr,len);
4910 #ifdef PERL_COPY_ON_WRITE
4911 /* Need to do this *after* making the SV normal, as we need the buffer
4912 pointer to remain valid until after we've copied it. If we let go too early,
4913 another thread could invalidate it by unsharing last of the same hash key
4914 (which it can do by means other than releasing copy-on-write Svs)
4915 or by changing the other copy-on-write SVs in the loop. */
4917 S_sv_release_COW(pTHX_ register SV *sv, char *pvx, STRLEN cur, STRLEN len,
4918 U32 hash, SV *after)
4920 if (len) { /* this SV was SvIsCOW_normal(sv) */
4921 /* we need to find the SV pointing to us. */
4922 SV *current = SV_COW_NEXT_SV(after);
4924 if (current == sv) {
4925 /* The SV we point to points back to us (there were only two of us
4927 Hence other SV is no longer copy on write either. */
4929 SvREADONLY_off(after);
4931 /* We need to follow the pointers around the loop. */
4933 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4936 /* don't loop forever if the structure is bust, and we have
4937 a pointer into a closed loop. */
4938 assert (current != after);
4939 assert (SvPVX(current) == pvx);
4941 /* Make the SV before us point to the SV after us. */
4942 SV_COW_NEXT_SV_SET(current, after);
4945 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4950 Perl_sv_release_IVX(pTHX_ register SV *sv)
4953 sv_force_normal_flags(sv, 0);
4959 =for apidoc sv_force_normal_flags
4961 Undo various types of fakery on an SV: if the PV is a shared string, make
4962 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4963 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4964 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4965 then a copy-on-write scalar drops its PV buffer (if any) and becomes
4966 SvPOK_off rather than making a copy. (Used where this scalar is about to be
4967 set to some other value.) In addition, the C<flags> parameter gets passed to
4968 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4969 with flags set to 0.
4975 Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
4977 #ifdef PERL_COPY_ON_WRITE
4978 if (SvREADONLY(sv)) {
4979 /* At this point I believe I should acquire a global SV mutex. */
4981 char *pvx = SvPVX(sv);
4982 STRLEN len = SvLEN(sv);
4983 STRLEN cur = SvCUR(sv);
4984 U32 hash = SvUVX(sv);
4985 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
4987 PerlIO_printf(Perl_debug_log,
4988 "Copy on write: Force normal %ld\n",
4994 /* This SV doesn't own the buffer, so need to New() a new one: */
4997 if (flags & SV_COW_DROP_PV) {
4998 /* OK, so we don't need to copy our buffer. */
5001 SvGROW(sv, cur + 1);
5002 Move(pvx,SvPVX(sv),cur,char);
5006 sv_release_COW(sv, pvx, cur, len, hash, next);
5011 else if (IN_PERL_RUNTIME)
5012 Perl_croak(aTHX_ PL_no_modify);
5013 /* At this point I believe that I can drop the global SV mutex. */
5016 if (SvREADONLY(sv)) {
5018 char *pvx = SvPVX(sv);
5019 int is_utf8 = SvUTF8(sv);
5020 STRLEN len = SvCUR(sv);
5021 U32 hash = SvUVX(sv);
5026 SvGROW(sv, len + 1);
5027 Move(pvx,SvPVX(sv),len,char);
5029 unsharepvn(pvx, is_utf8 ? -(I32)len : len, hash);
5031 else if (IN_PERL_RUNTIME)
5032 Perl_croak(aTHX_ PL_no_modify);
5036 sv_unref_flags(sv, flags);
5037 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
5042 =for apidoc sv_force_normal
5044 Undo various types of fakery on an SV: if the PV is a shared string, make
5045 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5046 an xpvmg. See also C<sv_force_normal_flags>.
5052 Perl_sv_force_normal(pTHX_ register SV *sv)
5054 sv_force_normal_flags(sv, 0);
5060 Efficient removal of characters from the beginning of the string buffer.
5061 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5062 the string buffer. The C<ptr> becomes the first character of the adjusted
5063 string. Uses the "OOK hack".
5064 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
5065 refer to the same chunk of data.
5071 Perl_sv_chop(pTHX_ register SV *sv, register char *ptr)
5073 register STRLEN delta;
5074 if (!ptr || !SvPOKp(sv))
5076 delta = ptr - SvPVX(sv);
5077 SV_CHECK_THINKFIRST(sv);
5078 if (SvTYPE(sv) < SVt_PVIV)
5079 sv_upgrade(sv,SVt_PVIV);
5082 if (!SvLEN(sv)) { /* make copy of shared string */
5083 char *pvx = SvPVX(sv);
5084 STRLEN len = SvCUR(sv);
5085 SvGROW(sv, len + 1);
5086 Move(pvx,SvPVX(sv),len,char);
5090 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
5091 and we do that anyway inside the SvNIOK_off
5093 SvFLAGS(sv) |= SVf_OOK;
5102 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
5103 * this function provided for binary compatibility only
5107 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
5109 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
5113 =for apidoc sv_catpvn
5115 Concatenates the string onto the end of the string which is in the SV. The
5116 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5117 status set, then the bytes appended should be valid UTF-8.
5118 Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
5120 =for apidoc sv_catpvn_flags
5122 Concatenates the string onto the end of the string which is in the SV. The
5123 C<len> indicates number of bytes to copy. If the SV has the UTF-8
5124 status set, then the bytes appended should be valid UTF-8.
5125 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5126 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5127 in terms of this function.
5133 Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
5138 dstr = SvPV_force_flags(dsv, dlen, flags);
5139 SvGROW(dsv, dlen + slen + 1);
5142 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5145 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5150 =for apidoc sv_catpvn_mg
5152 Like C<sv_catpvn>, but also handles 'set' magic.
5158 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
5160 sv_catpvn(sv,ptr,len);
5164 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
5165 * this function provided for binary compatibility only
5169 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
5171 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
5175 =for apidoc sv_catsv
5177 Concatenates the string from SV C<ssv> onto the end of the string in
5178 SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5179 not 'set' magic. See C<sv_catsv_mg>.
5181 =for apidoc sv_catsv_flags
5183 Concatenates the string from SV C<ssv> onto the end of the string in
5184 SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5185 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5186 and C<sv_catsv_nomg> are implemented in terms of this function.
5191 Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
5197 if ((spv = SvPV(ssv, slen))) {
5198 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
5199 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
5200 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
5201 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
5202 dsv->sv_flags doesn't have that bit set.
5203 Andy Dougherty 12 Oct 2001
5205 I32 sutf8 = DO_UTF8(ssv);
5208 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5210 dutf8 = DO_UTF8(dsv);
5212 if (dutf8 != sutf8) {
5214 /* Not modifying source SV, so taking a temporary copy. */
5215 SV* csv = sv_2mortal(newSVpvn(spv, slen));
5217 sv_utf8_upgrade(csv);
5218 spv = SvPV(csv, slen);
5221 sv_utf8_upgrade_nomg(dsv);
5223 sv_catpvn_nomg(dsv, spv, slen);
5228 =for apidoc sv_catsv_mg
5230 Like C<sv_catsv>, but also handles 'set' magic.
5236 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
5243 =for apidoc sv_catpv
5245 Concatenates the string onto the end of the string which is in the SV.
5246 If the SV has the UTF-8 status set, then the bytes appended should be
5247 valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
5252 Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
5254 register STRLEN len;
5260 junk = SvPV_force(sv, tlen);
5262 SvGROW(sv, tlen + len + 1);
5265 Move(ptr,SvPVX(sv)+tlen,len+1,char);
5267 (void)SvPOK_only_UTF8(sv); /* validate pointer */
5272 =for apidoc sv_catpv_mg
5274 Like C<sv_catpv>, but also handles 'set' magic.
5280 Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
5289 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
5290 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
5297 Perl_newSV(pTHX_ STRLEN len)
5303 sv_upgrade(sv, SVt_PV);
5304 SvGROW(sv, len + 1);
5309 =for apidoc sv_magicext
5311 Adds magic to an SV, upgrading it if necessary. Applies the
5312 supplied vtable and returns a pointer to the magic added.
5314 Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5315 In particular, you can add magic to SvREADONLY SVs, and add more than
5316 one instance of the same 'how'.
5318 If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5319 stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5320 special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5321 to contain an C<SV*> and is stored as-is with its REFCNT incremented.
5323 (This is now used as a subroutine by C<sv_magic>.)
5328 Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
5329 const char* name, I32 namlen)
5333 if (SvTYPE(sv) < SVt_PVMG) {
5334 (void)SvUPGRADE(sv, SVt_PVMG);
5336 Newz(702,mg, 1, MAGIC);
5337 mg->mg_moremagic = SvMAGIC(sv);
5340 /* Sometimes a magic contains a reference loop, where the sv and
5341 object refer to each other. To prevent a reference loop that
5342 would prevent such objects being freed, we look for such loops
5343 and if we find one we avoid incrementing the object refcount.
5345 Note we cannot do this to avoid self-tie loops as intervening RV must
5346 have its REFCNT incremented to keep it in existence.
5349 if (!obj || obj == sv ||
5350 how == PERL_MAGIC_arylen ||
5351 how == PERL_MAGIC_qr ||
5352 (SvTYPE(obj) == SVt_PVGV &&
5353 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
5354 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
5355 GvFORM(obj) == (CV*)sv)))
5360 mg->mg_obj = SvREFCNT_inc(obj);
5361 mg->mg_flags |= MGf_REFCOUNTED;
5364 /* Normal self-ties simply pass a null object, and instead of
5365 using mg_obj directly, use the SvTIED_obj macro to produce a
5366 new RV as needed. For glob "self-ties", we are tieing the PVIO
5367 with an RV obj pointing to the glob containing the PVIO. In
5368 this case, to avoid a reference loop, we need to weaken the
5372 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5373 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
5379 mg->mg_len = namlen;
5382 mg->mg_ptr = savepvn(name, namlen);
5383 else if (namlen == HEf_SVKEY)
5384 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
5386 mg->mg_ptr = (char *) name;
5388 mg->mg_virtual = vtable;
5392 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5397 =for apidoc sv_magic
5399 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5400 then adds a new magic item of type C<how> to the head of the magic list.
5402 See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5403 handling of the C<name> and C<namlen> arguments.
5405 You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5406 to add more than one instance of the same 'how'.
5412 Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
5414 const MGVTBL *vtable = 0;
5417 #ifdef PERL_COPY_ON_WRITE
5419 sv_force_normal_flags(sv, 0);
5421 if (SvREADONLY(sv)) {
5423 && how != PERL_MAGIC_regex_global
5424 && how != PERL_MAGIC_bm
5425 && how != PERL_MAGIC_fm
5426 && how != PERL_MAGIC_sv
5427 && how != PERL_MAGIC_backref
5430 Perl_croak(aTHX_ PL_no_modify);
5433 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5434 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
5435 /* sv_magic() refuses to add a magic of the same 'how' as an
5438 if (how == PERL_MAGIC_taint)
5446 vtable = &PL_vtbl_sv;
5448 case PERL_MAGIC_overload:
5449 vtable = &PL_vtbl_amagic;
5451 case PERL_MAGIC_overload_elem:
5452 vtable = &PL_vtbl_amagicelem;
5454 case PERL_MAGIC_overload_table:
5455 vtable = &PL_vtbl_ovrld;
5458 vtable = &PL_vtbl_bm;
5460 case PERL_MAGIC_regdata:
5461 vtable = &PL_vtbl_regdata;
5463 case PERL_MAGIC_regdatum:
5464 vtable = &PL_vtbl_regdatum;
5466 case PERL_MAGIC_env:
5467 vtable = &PL_vtbl_env;
5470 vtable = &PL_vtbl_fm;
5472 case PERL_MAGIC_envelem:
5473 vtable = &PL_vtbl_envelem;
5475 case PERL_MAGIC_regex_global:
5476 vtable = &PL_vtbl_mglob;
5478 case PERL_MAGIC_isa:
5479 vtable = &PL_vtbl_isa;
5481 case PERL_MAGIC_isaelem:
5482 vtable = &PL_vtbl_isaelem;
5484 case PERL_MAGIC_nkeys:
5485 vtable = &PL_vtbl_nkeys;
5487 case PERL_MAGIC_dbfile:
5490 case PERL_MAGIC_dbline:
5491 vtable = &PL_vtbl_dbline;
5493 #ifdef USE_LOCALE_COLLATE
5494 case PERL_MAGIC_collxfrm:
5495 vtable = &PL_vtbl_collxfrm;
5497 #endif /* USE_LOCALE_COLLATE */
5498 case PERL_MAGIC_tied:
5499 vtable = &PL_vtbl_pack;
5501 case PERL_MAGIC_tiedelem:
5502 case PERL_MAGIC_tiedscalar:
5503 vtable = &PL_vtbl_packelem;
5506 vtable = &PL_vtbl_regexp;
5508 case PERL_MAGIC_sig:
5509 vtable = &PL_vtbl_sig;
5511 case PERL_MAGIC_sigelem:
5512 vtable = &PL_vtbl_sigelem;
5514 case PERL_MAGIC_taint:
5515 vtable = &PL_vtbl_taint;
5517 case PERL_MAGIC_uvar:
5518 vtable = &PL_vtbl_uvar;
5520 case PERL_MAGIC_vec:
5521 vtable = &PL_vtbl_vec;
5523 case PERL_MAGIC_vstring:
5526 case PERL_MAGIC_utf8:
5527 vtable = &PL_vtbl_utf8;
5529 case PERL_MAGIC_substr:
5530 vtable = &PL_vtbl_substr;
5532 case PERL_MAGIC_defelem:
5533 vtable = &PL_vtbl_defelem;
5535 case PERL_MAGIC_glob:
5536 vtable = &PL_vtbl_glob;
5538 case PERL_MAGIC_arylen:
5539 vtable = &PL_vtbl_arylen;
5541 case PERL_MAGIC_pos:
5542 vtable = &PL_vtbl_pos;
5544 case PERL_MAGIC_backref:
5545 vtable = &PL_vtbl_backref;
5547 case PERL_MAGIC_ext:
5548 /* Reserved for use by extensions not perl internals. */
5549 /* Useful for attaching extension internal data to perl vars. */
5550 /* Note that multiple extensions may clash if magical scalars */
5551 /* etc holding private data from one are passed to another. */
5554 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
5557 /* Rest of work is done else where */
5558 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
5561 case PERL_MAGIC_taint:
5564 case PERL_MAGIC_ext:
5565 case PERL_MAGIC_dbfile:
5572 =for apidoc sv_unmagic
5574 Removes all magic of type C<type> from an SV.
5580 Perl_sv_unmagic(pTHX_ SV *sv, int type)
5584 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
5587 for (mg = *mgp; mg; mg = *mgp) {
5588 if (mg->mg_type == type) {
5589 const MGVTBL* const vtbl = mg->mg_virtual;
5590 *mgp = mg->mg_moremagic;
5591 if (vtbl && vtbl->svt_free)
5592 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
5593 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
5595 Safefree(mg->mg_ptr);
5596 else if (mg->mg_len == HEf_SVKEY)
5597 SvREFCNT_dec((SV*)mg->mg_ptr);
5598 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5599 Safefree(mg->mg_ptr);
5601 if (mg->mg_flags & MGf_REFCOUNTED)
5602 SvREFCNT_dec(mg->mg_obj);
5606 mgp = &mg->mg_moremagic;
5610 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
5617 =for apidoc sv_rvweaken
5619 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5620 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5621 push a back-reference to this RV onto the array of backreferences
5622 associated with that magic.
5628 Perl_sv_rvweaken(pTHX_ SV *sv)
5631 if (!SvOK(sv)) /* let undefs pass */
5634 Perl_croak(aTHX_ "Can't weaken a nonreference");
5635 else if (SvWEAKREF(sv)) {
5636 if (ckWARN(WARN_MISC))
5637 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
5641 sv_add_backref(tsv, sv);
5647 /* Give tsv backref magic if it hasn't already got it, then push a
5648 * back-reference to sv onto the array associated with the backref magic.
5652 S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
5656 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
5657 av = (AV*)mg->mg_obj;
5660 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
5661 /* av now has a refcnt of 2, which avoids it getting freed
5662 * before us during global cleanup. The extra ref is removed
5663 * by magic_killbackrefs() when tsv is being freed */
5665 if (AvFILLp(av) >= AvMAX(av)) {
5667 SV **svp = AvARRAY(av);
5668 for (i = AvFILLp(av); i >= 0; i--)
5670 svp[i] = sv; /* reuse the slot */
5673 av_extend(av, AvFILLp(av)+1);
5675 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
5678 /* delete a back-reference to ourselves from the backref magic associated
5679 * with the SV we point to.
5683 S_sv_del_backref(pTHX_ SV *sv)
5690 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
5691 Perl_croak(aTHX_ "panic: del_backref");
5692 av = (AV *)mg->mg_obj;
5694 for (i = AvFILLp(av); i >= 0; i--)
5695 if (svp[i] == sv) svp[i] = Nullsv;
5699 =for apidoc sv_insert
5701 Inserts a string at the specified offset/length within the SV. Similar to
5702 the Perl substr() function.
5708 Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
5712 register char *midend;
5713 register char *bigend;
5719 Perl_croak(aTHX_ "Can't modify non-existent substring");
5720 SvPV_force(bigstr, curlen);
5721 (void)SvPOK_only_UTF8(bigstr);
5722 if (offset + len > curlen) {
5723 SvGROW(bigstr, offset+len+1);
5724 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5725 SvCUR_set(bigstr, offset+len);
5729 i = littlelen - len;
5730 if (i > 0) { /* string might grow */
5731 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
5732 mid = big + offset + len;
5733 midend = bigend = big + SvCUR(bigstr);
5736 while (midend > mid) /* shove everything down */
5737 *--bigend = *--midend;
5738 Move(little,big+offset,littlelen,char);
5744 Move(little,SvPVX(bigstr)+offset,len,char);
5749 big = SvPVX(bigstr);
5752 bigend = big + SvCUR(bigstr);
5754 if (midend > bigend)
5755 Perl_croak(aTHX_ "panic: sv_insert");
5757 if (mid - big > bigend - midend) { /* faster to shorten from end */
5759 Move(little, mid, littlelen,char);
5762 i = bigend - midend;
5764 Move(midend, mid, i,char);
5768 SvCUR_set(bigstr, mid - big);
5771 else if ((i = mid - big)) { /* faster from front */
5772 midend -= littlelen;
5774 sv_chop(bigstr,midend-i);
5779 Move(little, mid, littlelen,char);
5781 else if (littlelen) {
5782 midend -= littlelen;
5783 sv_chop(bigstr,midend);
5784 Move(little,midend,littlelen,char);
5787 sv_chop(bigstr,midend);
5793 =for apidoc sv_replace
5795 Make the first argument a copy of the second, then delete the original.
5796 The target SV physically takes over ownership of the body of the source SV
5797 and inherits its flags; however, the target keeps any magic it owns,
5798 and any magic in the source is discarded.
5799 Note that this is a rather specialist SV copying operation; most of the
5800 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
5806 Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
5808 U32 refcnt = SvREFCNT(sv);
5809 SV_CHECK_THINKFIRST_COW_DROP(sv);
5810 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
5811 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
5812 if (SvMAGICAL(sv)) {
5816 sv_upgrade(nsv, SVt_PVMG);
5817 SvMAGIC(nsv) = SvMAGIC(sv);
5818 SvFLAGS(nsv) |= SvMAGICAL(sv);
5824 assert(!SvREFCNT(sv));
5825 StructCopy(nsv,sv,SV);
5826 #ifdef PERL_COPY_ON_WRITE
5827 if (SvIsCOW_normal(nsv)) {
5828 /* We need to follow the pointers around the loop to make the
5829 previous SV point to sv, rather than nsv. */
5832 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5835 assert(SvPVX(current) == SvPVX(nsv));
5837 /* Make the SV before us point to the SV after us. */
5839 PerlIO_printf(Perl_debug_log, "previous is\n");
5841 PerlIO_printf(Perl_debug_log,
5842 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
5843 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5845 SV_COW_NEXT_SV_SET(current, sv);
5848 SvREFCNT(sv) = refcnt;
5849 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
5855 =for apidoc sv_clear
5857 Clear an SV: call any destructors, free up any memory used by the body,
5858 and free the body itself. The SV's head is I<not> freed, although
5859 its type is set to all 1's so that it won't inadvertently be assumed
5860 to be live during global destruction etc.
5861 This function should only be called when REFCNT is zero. Most of the time
5862 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5869 Perl_sv_clear(pTHX_ register SV *sv)
5873 assert(SvREFCNT(sv) == 0);
5876 if (PL_defstash) { /* Still have a symbol table? */
5883 stash = SvSTASH(sv);
5884 destructor = StashHANDLER(stash,DESTROY);
5886 SV* tmpref = newRV(sv);
5887 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
5889 PUSHSTACKi(PERLSI_DESTROY);
5894 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
5900 if(SvREFCNT(tmpref) < 2) {
5901 /* tmpref is not kept alive! */
5906 SvREFCNT_dec(tmpref);
5908 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
5912 if (PL_in_clean_objs)
5913 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
5915 /* DESTROY gave object new lease on life */
5921 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
5922 SvOBJECT_off(sv); /* Curse the object. */
5923 if (SvTYPE(sv) != SVt_PVIO)
5924 --PL_sv_objcount; /* XXX Might want something more general */
5927 if (SvTYPE(sv) >= SVt_PVMG) {
5930 if (SvFLAGS(sv) & SVpad_TYPED)
5931 SvREFCNT_dec(SvSTASH(sv));
5934 switch (SvTYPE(sv)) {
5937 IoIFP(sv) != PerlIO_stdin() &&
5938 IoIFP(sv) != PerlIO_stdout() &&
5939 IoIFP(sv) != PerlIO_stderr())
5941 io_close((IO*)sv, FALSE);
5943 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
5944 PerlDir_close(IoDIRP(sv));
5945 IoDIRP(sv) = (DIR*)NULL;
5946 Safefree(IoTOP_NAME(sv));
5947 Safefree(IoFMT_NAME(sv));
5948 Safefree(IoBOTTOM_NAME(sv));
5963 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5964 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5965 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5966 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5968 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5969 SvREFCNT_dec(LvTARG(sv));
5973 Safefree(GvNAME(sv));
5974 /* cannot decrease stash refcount yet, as we might recursively delete
5975 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5976 of stash until current sv is completely gone.
5977 -- JohnPC, 27 Mar 1998 */
5978 stash = GvSTASH(sv);
5992 SvREFCNT_dec(SvRV(sv));
5994 #ifdef PERL_COPY_ON_WRITE
5995 else if (SvPVX(sv)) {
5997 /* I believe I need to grab the global SV mutex here and
5998 then recheck the COW status. */
6000 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
6003 sv_release_COW(sv, SvPVX(sv), SvCUR(sv), SvLEN(sv),
6004 SvUVX(sv), SV_COW_NEXT_SV(sv));
6005 /* And drop it here. */
6007 } else if (SvLEN(sv)) {
6008 Safefree(SvPVX(sv));
6012 else if (SvPVX(sv) && SvLEN(sv))
6013 Safefree(SvPVX(sv));
6014 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
6015 unsharepvn(SvPVX(sv),
6016 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
6030 switch (SvTYPE(sv)) {
6046 del_XPVIV(SvANY(sv));
6049 del_XPVNV(SvANY(sv));
6052 del_XPVMG(SvANY(sv));
6055 del_XPVLV(SvANY(sv));
6058 del_XPVAV(SvANY(sv));
6061 del_XPVHV(SvANY(sv));
6064 del_XPVCV(SvANY(sv));
6067 del_XPVGV(SvANY(sv));
6068 /* code duplication for increased performance. */
6069 SvFLAGS(sv) &= SVf_BREAK;
6070 SvFLAGS(sv) |= SVTYPEMASK;
6071 /* decrease refcount of the stash that owns this GV, if any */
6073 SvREFCNT_dec(stash);
6074 return; /* not break, SvFLAGS reset already happened */
6076 del_XPVBM(SvANY(sv));
6079 del_XPVFM(SvANY(sv));
6082 del_XPVIO(SvANY(sv));
6085 SvFLAGS(sv) &= SVf_BREAK;
6086 SvFLAGS(sv) |= SVTYPEMASK;
6090 =for apidoc sv_newref
6092 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6099 Perl_sv_newref(pTHX_ SV *sv)
6109 Decrement an SV's reference count, and if it drops to zero, call
6110 C<sv_clear> to invoke destructors and free up any memory used by
6111 the body; finally, deallocate the SV's head itself.
6112 Normally called via a wrapper macro C<SvREFCNT_dec>.
6118 Perl_sv_free(pTHX_ SV *sv)
6122 if (SvREFCNT(sv) == 0) {
6123 if (SvFLAGS(sv) & SVf_BREAK)
6124 /* this SV's refcnt has been artificially decremented to
6125 * trigger cleanup */
6127 if (PL_in_clean_all) /* All is fair */
6129 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6130 /* make sure SvREFCNT(sv)==0 happens very seldom */
6131 SvREFCNT(sv) = (~(U32)0)/2;
6134 if (ckWARN_d(WARN_INTERNAL))
6135 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
6136 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6137 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6140 if (--(SvREFCNT(sv)) > 0)
6142 Perl_sv_free2(aTHX_ sv);
6146 Perl_sv_free2(pTHX_ SV *sv)
6150 if (ckWARN_d(WARN_DEBUGGING))
6151 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
6152 "Attempt to free temp prematurely: SV 0x%"UVxf
6153 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
6157 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6158 /* make sure SvREFCNT(sv)==0 happens very seldom */
6159 SvREFCNT(sv) = (~(U32)0)/2;
6170 Returns the length of the string in the SV. Handles magic and type
6171 coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
6177 Perl_sv_len(pTHX_ register SV *sv)
6185 len = mg_length(sv);
6187 (void)SvPV(sv, len);
6192 =for apidoc sv_len_utf8
6194 Returns the number of characters in the string in an SV, counting wide
6195 UTF-8 bytes as a single character. Handles magic and type coercion.
6201 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
6202 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
6203 * (Note that the mg_len is not the length of the mg_ptr field.)
6208 Perl_sv_len_utf8(pTHX_ register SV *sv)
6214 return mg_length(sv);
6218 U8 *s = (U8*)SvPV(sv, len);
6219 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
6221 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
6223 #ifdef PERL_UTF8_CACHE_ASSERT
6224 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
6228 ulen = Perl_utf8_length(aTHX_ s, s + len);
6229 if (!mg && !SvREADONLY(sv)) {
6230 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6231 mg = mg_find(sv, PERL_MAGIC_utf8);
6241 /* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
6242 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6243 * between UTF-8 and byte offsets. There are two (substr offset and substr
6244 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
6245 * and byte offset) cache positions.
6247 * The mg_len field is used by sv_len_utf8(), see its comments.
6248 * Note that the mg_len is not the length of the mg_ptr field.
6252 S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, U8 *s, U8 *start)
6256 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6258 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, &PL_vtbl_utf8, 0, 0);
6262 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6264 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6265 (*mgp)->mg_ptr = (char *) *cachep;
6269 (*cachep)[i] = *offsetp;
6270 (*cachep)[i+1] = s - start;
6278 * S_utf8_mg_pos() is used to query and update mg_ptr field of
6279 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6280 * between UTF-8 and byte offsets. See also the comments of
6281 * S_utf8_mg_pos_init().
6285 S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
6289 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6291 *mgp = mg_find(sv, PERL_MAGIC_utf8);
6292 if (*mgp && (*mgp)->mg_ptr) {
6293 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6294 ASSERT_UTF8_CACHE(*cachep);
6295 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
6297 else { /* We will skip to the right spot. */
6302 /* The assumption is that going backward is half
6303 * the speed of going forward (that's where the
6304 * 2 * backw in the below comes from). (The real
6305 * figure of course depends on the UTF-8 data.) */
6307 if ((*cachep)[i] > (STRLEN)uoff) {
6309 backw = (*cachep)[i] - (STRLEN)uoff;
6311 if (forw < 2 * backw)
6314 p = start + (*cachep)[i+1];
6316 /* Try this only for the substr offset (i == 0),
6317 * not for the substr length (i == 2). */
6318 else if (i == 0) { /* (*cachep)[i] < uoff */
6319 STRLEN ulen = sv_len_utf8(sv);
6321 if ((STRLEN)uoff < ulen) {
6322 forw = (STRLEN)uoff - (*cachep)[i];
6323 backw = ulen - (STRLEN)uoff;
6325 if (forw < 2 * backw)
6326 p = start + (*cachep)[i+1];
6331 /* If the string is not long enough for uoff,
6332 * we could extend it, but not at this low a level. */
6336 if (forw < 2 * backw) {
6343 while (UTF8_IS_CONTINUATION(*p))
6348 /* Update the cache. */
6349 (*cachep)[i] = (STRLEN)uoff;
6350 (*cachep)[i+1] = p - start;
6352 /* Drop the stale "length" cache */
6361 if (found) { /* Setup the return values. */
6362 *offsetp = (*cachep)[i+1];
6363 *sp = start + *offsetp;
6366 *offsetp = send - start;
6368 else if (*sp < start) {
6374 #ifdef PERL_UTF8_CACHE_ASSERT
6379 while (n-- && s < send)
6383 assert(*offsetp == s - start);
6384 assert((*cachep)[0] == (STRLEN)uoff);
6385 assert((*cachep)[1] == *offsetp);
6387 ASSERT_UTF8_CACHE(*cachep);
6396 =for apidoc sv_pos_u2b
6398 Converts the value pointed to by offsetp from a count of UTF-8 chars from
6399 the start of the string, to a count of the equivalent number of bytes; if
6400 lenp is non-zero, it does the same to lenp, but this time starting from
6401 the offset, rather than from the start of the string. Handles magic and
6408 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6409 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6410 * byte offsets. See also the comments of S_utf8_mg_pos().
6415 Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
6426 start = s = (U8*)SvPV(sv, len);
6428 I32 uoffset = *offsetp;
6433 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
6435 if (!found && uoffset > 0) {
6436 while (s < send && uoffset--)
6440 if (utf8_mg_pos_init(sv, &mg, &cache, 0, offsetp, s, start))
6442 *offsetp = s - start;
6447 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp + *offsetp, &s, start, send)) {
6451 if (!found && *lenp > 0) {
6454 while (s < send && ulen--)
6458 utf8_mg_pos_init(sv, &mg, &cache, 2, lenp, s, start);
6462 ASSERT_UTF8_CACHE(cache);
6474 =for apidoc sv_pos_b2u
6476 Converts the value pointed to by offsetp from a count of bytes from the
6477 start of the string, to a count of the equivalent number of UTF-8 chars.
6478 Handles magic and type coercion.
6484 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6485 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6486 * byte offsets. See also the comments of S_utf8_mg_pos().
6491 Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
6499 s = (U8*)SvPV(sv, len);
6500 if ((I32)len < *offsetp)
6501 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
6503 U8* send = s + *offsetp;
6505 STRLEN *cache = NULL;
6509 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6510 mg = mg_find(sv, PERL_MAGIC_utf8);
6511 if (mg && mg->mg_ptr) {
6512 cache = (STRLEN *) mg->mg_ptr;
6513 if (cache[1] == (STRLEN)*offsetp) {
6514 /* An exact match. */
6515 *offsetp = cache[0];
6519 else if (cache[1] < (STRLEN)*offsetp) {
6520 /* We already know part of the way. */
6523 /* Let the below loop do the rest. */
6525 else { /* cache[1] > *offsetp */
6526 /* We already know all of the way, now we may
6527 * be able to walk back. The same assumption
6528 * is made as in S_utf8_mg_pos(), namely that
6529 * walking backward is twice slower than
6530 * walking forward. */
6531 STRLEN forw = *offsetp;
6532 STRLEN backw = cache[1] - *offsetp;
6534 if (!(forw < 2 * backw)) {
6535 U8 *p = s + cache[1];
6542 while (UTF8_IS_CONTINUATION(*p)) {
6550 *offsetp = cache[0];
6552 /* Drop the stale "length" cache */
6560 ASSERT_UTF8_CACHE(cache);
6566 /* Call utf8n_to_uvchr() to validate the sequence
6567 * (unless a simple non-UTF character) */
6568 if (!UTF8_IS_INVARIANT(*s))
6569 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6578 if (!SvREADONLY(sv)) {
6580 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6581 mg = mg_find(sv, PERL_MAGIC_utf8);
6586 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6587 mg->mg_ptr = (char *) cache;
6592 cache[1] = *offsetp;
6593 /* Drop the stale "length" cache */
6606 Returns a boolean indicating whether the strings in the two SVs are
6607 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6608 coerce its args to strings if necessary.
6614 Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
6622 SV* svrecode = Nullsv;
6629 pv1 = SvPV(sv1, cur1);
6636 pv2 = SvPV(sv2, cur2);
6638 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6639 /* Differing utf8ness.
6640 * Do not UTF8size the comparands as a side-effect. */
6643 svrecode = newSVpvn(pv2, cur2);
6644 sv_recode_to_utf8(svrecode, PL_encoding);
6645 pv2 = SvPV(svrecode, cur2);
6648 svrecode = newSVpvn(pv1, cur1);
6649 sv_recode_to_utf8(svrecode, PL_encoding);
6650 pv1 = SvPV(svrecode, cur1);
6652 /* Now both are in UTF-8. */
6654 SvREFCNT_dec(svrecode);
6659 bool is_utf8 = TRUE;
6662 /* sv1 is the UTF-8 one,
6663 * if is equal it must be downgrade-able */
6664 char *pv = (char*)bytes_from_utf8((const U8*)pv1,
6670 /* sv2 is the UTF-8 one,
6671 * if is equal it must be downgrade-able */
6672 char *pv = (char *)bytes_from_utf8((const U8*)pv2,
6678 /* Downgrade not possible - cannot be eq */
6686 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
6689 SvREFCNT_dec(svrecode);
6700 Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6701 string in C<sv1> is less than, equal to, or greater than the string in
6702 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6703 coerce its args to strings if necessary. See also C<sv_cmp_locale>.
6709 Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
6712 const char *pv1, *pv2;
6715 SV *svrecode = Nullsv;
6722 pv1 = SvPV(sv1, cur1);
6729 pv2 = SvPV(sv2, cur2);
6731 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
6732 /* Differing utf8ness.
6733 * Do not UTF8size the comparands as a side-effect. */
6736 svrecode = newSVpvn(pv2, cur2);
6737 sv_recode_to_utf8(svrecode, PL_encoding);
6738 pv2 = SvPV(svrecode, cur2);
6741 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
6746 svrecode = newSVpvn(pv1, cur1);
6747 sv_recode_to_utf8(svrecode, PL_encoding);
6748 pv1 = SvPV(svrecode, cur1);
6751 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
6757 cmp = cur2 ? -1 : 0;
6761 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
6764 cmp = retval < 0 ? -1 : 1;
6765 } else if (cur1 == cur2) {
6768 cmp = cur1 < cur2 ? -1 : 1;
6773 SvREFCNT_dec(svrecode);
6782 =for apidoc sv_cmp_locale
6784 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6785 'use bytes' aware, handles get magic, and will coerce its args to strings
6786 if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
6792 Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
6794 #ifdef USE_LOCALE_COLLATE
6800 if (PL_collation_standard)
6804 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
6806 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
6808 if (!pv1 || !len1) {
6819 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
6822 return retval < 0 ? -1 : 1;
6825 * When the result of collation is equality, that doesn't mean
6826 * that there are no differences -- some locales exclude some
6827 * characters from consideration. So to avoid false equalities,
6828 * we use the raw string as a tiebreaker.
6834 #endif /* USE_LOCALE_COLLATE */
6836 return sv_cmp(sv1, sv2);
6840 #ifdef USE_LOCALE_COLLATE
6843 =for apidoc sv_collxfrm
6845 Add Collate Transform magic to an SV if it doesn't already have it.
6847 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6848 scalar data of the variable, but transformed to such a format that a normal
6849 memory comparison can be used to compare the data according to the locale
6856 Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
6860 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
6861 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
6866 Safefree(mg->mg_ptr);
6868 if ((xf = mem_collxfrm(s, len, &xlen))) {
6869 if (SvREADONLY(sv)) {
6872 return xf + sizeof(PL_collation_ix);
6875 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6876 mg = mg_find(sv, PERL_MAGIC_collxfrm);
6889 if (mg && mg->mg_ptr) {
6891 return mg->mg_ptr + sizeof(PL_collation_ix);
6899 #endif /* USE_LOCALE_COLLATE */
6904 Get a line from the filehandle and store it into the SV, optionally
6905 appending to the currently-stored string.
6911 Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
6915 register STDCHAR rslast;
6916 register STDCHAR *bp;
6922 if (SvTHINKFIRST(sv))
6923 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
6924 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6926 However, perlbench says it's slower, because the existing swipe code
6927 is faster than copy on write.
6928 Swings and roundabouts. */
6929 (void)SvUPGRADE(sv, SVt_PV);
6934 if (PerlIO_isutf8(fp)) {
6936 sv_utf8_upgrade_nomg(sv);
6937 sv_pos_u2b(sv,&append,0);
6939 } else if (SvUTF8(sv)) {
6940 SV *tsv = NEWSV(0,0);
6941 sv_gets(tsv, fp, 0);
6942 sv_utf8_upgrade_nomg(tsv);
6943 SvCUR_set(sv,append);
6946 goto return_string_or_null;
6951 if (PerlIO_isutf8(fp))
6954 if (IN_PERL_COMPILETIME) {
6955 /* we always read code in line mode */
6959 else if (RsSNARF(PL_rs)) {
6960 /* If it is a regular disk file use size from stat() as estimate
6961 of amount we are going to read - may result in malloc-ing
6962 more memory than we realy need if layers bellow reduce
6963 size we read (e.g. CRLF or a gzip layer)
6966 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6967 Off_t offset = PerlIO_tell(fp);
6968 if (offset != (Off_t) -1 && st.st_size + append > offset) {
6969 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6975 else if (RsRECORD(PL_rs)) {
6979 /* Grab the size of the record we're getting */
6980 recsize = SvIV(SvRV(PL_rs));
6981 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
6984 /* VMS wants read instead of fread, because fread doesn't respect */
6985 /* RMS record boundaries. This is not necessarily a good thing to be */
6986 /* doing, but we've got no other real choice - except avoid stdio
6987 as implementation - perhaps write a :vms layer ?
6989 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6991 bytesread = PerlIO_read(fp, buffer, recsize);
6995 SvCUR_set(sv, bytesread += append);
6996 buffer[bytesread] = '\0';
6997 goto return_string_or_null;
6999 else if (RsPARA(PL_rs)) {
7005 /* Get $/ i.e. PL_rs into same encoding as stream wants */
7006 if (PerlIO_isutf8(fp)) {
7007 rsptr = SvPVutf8(PL_rs, rslen);
7010 if (SvUTF8(PL_rs)) {
7011 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
7012 Perl_croak(aTHX_ "Wide character in $/");
7015 rsptr = SvPV(PL_rs, rslen);
7019 rslast = rslen ? rsptr[rslen - 1] : '\0';
7021 if (rspara) { /* have to do this both before and after */
7022 do { /* to make sure file boundaries work right */
7025 i = PerlIO_getc(fp);
7029 PerlIO_ungetc(fp,i);
7035 /* See if we know enough about I/O mechanism to cheat it ! */
7037 /* This used to be #ifdef test - it is made run-time test for ease
7038 of abstracting out stdio interface. One call should be cheap
7039 enough here - and may even be a macro allowing compile
7043 if (PerlIO_fast_gets(fp)) {
7046 * We're going to steal some values from the stdio struct
7047 * and put EVERYTHING in the innermost loop into registers.
7049 register STDCHAR *ptr;
7053 #if defined(VMS) && defined(PERLIO_IS_STDIO)
7054 /* An ungetc()d char is handled separately from the regular
7055 * buffer, so we getc() it back out and stuff it in the buffer.
7057 i = PerlIO_getc(fp);
7058 if (i == EOF) return 0;
7059 *(--((*fp)->_ptr)) = (unsigned char) i;
7063 /* Here is some breathtakingly efficient cheating */
7065 cnt = PerlIO_get_cnt(fp); /* get count into register */
7066 /* make sure we have the room */
7067 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
7068 /* Not room for all of it
7069 if we are looking for a separator and room for some
7071 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7072 /* just process what we have room for */
7073 shortbuffered = cnt - SvLEN(sv) + append + 1;
7074 cnt -= shortbuffered;
7078 /* remember that cnt can be negative */
7079 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
7084 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
7085 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
7086 DEBUG_P(PerlIO_printf(Perl_debug_log,
7087 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7088 DEBUG_P(PerlIO_printf(Perl_debug_log,
7089 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7090 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7091 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
7096 while (cnt > 0) { /* this | eat */
7098 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7099 goto thats_all_folks; /* screams | sed :-) */
7103 Copy(ptr, bp, cnt, char); /* this | eat */
7104 bp += cnt; /* screams | dust */
7105 ptr += cnt; /* louder | sed :-) */
7110 if (shortbuffered) { /* oh well, must extend */
7111 cnt = shortbuffered;
7113 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
7115 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
7116 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7120 DEBUG_P(PerlIO_printf(Perl_debug_log,
7121 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7122 PTR2UV(ptr),(long)cnt));
7123 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
7125 DEBUG_P(PerlIO_printf(Perl_debug_log,
7126 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7127 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7128 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7130 /* This used to call 'filbuf' in stdio form, but as that behaves like
7131 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7132 another abstraction. */
7133 i = PerlIO_getc(fp); /* get more characters */
7135 DEBUG_P(PerlIO_printf(Perl_debug_log,
7136 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7137 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7138 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7140 cnt = PerlIO_get_cnt(fp);
7141 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
7142 DEBUG_P(PerlIO_printf(Perl_debug_log,
7143 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7145 if (i == EOF) /* all done for ever? */
7146 goto thats_really_all_folks;
7148 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
7150 SvGROW(sv, bpx + cnt + 2);
7151 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7153 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
7155 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
7156 goto thats_all_folks;
7160 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
7161 memNE((char*)bp - rslen, rsptr, rslen))
7162 goto screamer; /* go back to the fray */
7163 thats_really_all_folks:
7165 cnt += shortbuffered;
7166 DEBUG_P(PerlIO_printf(Perl_debug_log,
7167 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
7168 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
7169 DEBUG_P(PerlIO_printf(Perl_debug_log,
7170 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
7171 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
7172 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
7174 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
7175 DEBUG_P(PerlIO_printf(Perl_debug_log,
7176 "Screamer: done, len=%ld, string=|%.*s|\n",
7177 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
7181 /*The big, slow, and stupid way. */
7183 /* Any stack-challenged places. */
7185 /* EPOC: need to work around SDK features. *
7186 * On WINS: MS VC5 generates calls to _chkstk, *
7187 * if a "large" stack frame is allocated. *
7188 * gcc on MARM does not generate calls like these. */
7189 # define USEHEAPINSTEADOFSTACK
7192 #ifdef USEHEAPINSTEADOFSTACK
7194 New(0, buf, 8192, STDCHAR);
7202 register STDCHAR *bpe = buf + sizeof(buf);
7204 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
7205 ; /* keep reading */
7209 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
7210 /* Accomodate broken VAXC compiler, which applies U8 cast to
7211 * both args of ?: operator, causing EOF to change into 255
7214 i = (U8)buf[cnt - 1];
7220 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7222 sv_catpvn(sv, (char *) buf, cnt);
7224 sv_setpvn(sv, (char *) buf, cnt);
7226 if (i != EOF && /* joy */
7228 SvCUR(sv) < rslen ||
7229 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
7233 * If we're reading from a TTY and we get a short read,
7234 * indicating that the user hit his EOF character, we need
7235 * to notice it now, because if we try to read from the TTY
7236 * again, the EOF condition will disappear.
7238 * The comparison of cnt to sizeof(buf) is an optimization
7239 * that prevents unnecessary calls to feof().
7243 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
7247 #ifdef USEHEAPINSTEADOFSTACK
7252 if (rspara) { /* have to do this both before and after */
7253 while (i != EOF) { /* to make sure file boundaries work right */
7254 i = PerlIO_getc(fp);
7256 PerlIO_ungetc(fp,i);
7262 return_string_or_null:
7263 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
7269 Auto-increment of the value in the SV, doing string to numeric conversion
7270 if necessary. Handles 'get' magic.
7276 Perl_sv_inc(pTHX_ register SV *sv)
7285 if (SvTHINKFIRST(sv)) {
7287 sv_force_normal_flags(sv, 0);
7288 if (SvREADONLY(sv)) {
7289 if (IN_PERL_RUNTIME)
7290 Perl_croak(aTHX_ PL_no_modify);
7294 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7296 i = PTR2IV(SvRV(sv));
7301 flags = SvFLAGS(sv);
7302 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7303 /* It's (privately or publicly) a float, but not tested as an
7304 integer, so test it to see. */
7306 flags = SvFLAGS(sv);
7308 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7309 /* It's publicly an integer, or privately an integer-not-float */
7310 #ifdef PERL_PRESERVE_IVUV
7314 if (SvUVX(sv) == UV_MAX)
7315 sv_setnv(sv, UV_MAX_P1);
7317 (void)SvIOK_only_UV(sv);
7320 if (SvIVX(sv) == IV_MAX)
7321 sv_setuv(sv, (UV)IV_MAX + 1);
7323 (void)SvIOK_only(sv);
7329 if (flags & SVp_NOK) {
7330 (void)SvNOK_only(sv);
7335 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
7336 if ((flags & SVTYPEMASK) < SVt_PVIV)
7337 sv_upgrade(sv, SVt_IV);
7338 (void)SvIOK_only(sv);
7343 while (isALPHA(*d)) d++;
7344 while (isDIGIT(*d)) d++;
7346 #ifdef PERL_PRESERVE_IVUV
7347 /* Got to punt this as an integer if needs be, but we don't issue
7348 warnings. Probably ought to make the sv_iv_please() that does
7349 the conversion if possible, and silently. */
7350 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
7351 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7352 /* Need to try really hard to see if it's an integer.
7353 9.22337203685478e+18 is an integer.
7354 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7355 so $a="9.22337203685478e+18"; $a+0; $a++
7356 needs to be the same as $a="9.22337203685478e+18"; $a++
7363 /* sv_2iv *should* have made this an NV */
7364 if (flags & SVp_NOK) {
7365 (void)SvNOK_only(sv);
7369 /* I don't think we can get here. Maybe I should assert this
7370 And if we do get here I suspect that sv_setnv will croak. NWC
7372 #if defined(USE_LONG_DOUBLE)
7373 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",
7374 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7376 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7377 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7380 #endif /* PERL_PRESERVE_IVUV */
7381 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
7385 while (d >= SvPVX(sv)) {
7393 /* MKS: The original code here died if letters weren't consecutive.
7394 * at least it didn't have to worry about non-C locales. The
7395 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
7396 * arranged in order (although not consecutively) and that only
7397 * [A-Za-z] are accepted by isALPHA in the C locale.
7399 if (*d != 'z' && *d != 'Z') {
7400 do { ++*d; } while (!isALPHA(*d));
7403 *(d--) -= 'z' - 'a';
7408 *(d--) -= 'z' - 'a' + 1;
7412 /* oh,oh, the number grew */
7413 SvGROW(sv, SvCUR(sv) + 2);
7415 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
7426 Auto-decrement of the value in the SV, doing string to numeric conversion
7427 if necessary. Handles 'get' magic.
7433 Perl_sv_dec(pTHX_ register SV *sv)
7441 if (SvTHINKFIRST(sv)) {
7443 sv_force_normal_flags(sv, 0);
7444 if (SvREADONLY(sv)) {
7445 if (IN_PERL_RUNTIME)
7446 Perl_croak(aTHX_ PL_no_modify);
7450 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7452 i = PTR2IV(SvRV(sv));
7457 /* Unlike sv_inc we don't have to worry about string-never-numbers
7458 and keeping them magic. But we mustn't warn on punting */
7459 flags = SvFLAGS(sv);
7460 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7461 /* It's publicly an integer, or privately an integer-not-float */
7462 #ifdef PERL_PRESERVE_IVUV
7466 if (SvUVX(sv) == 0) {
7467 (void)SvIOK_only(sv);
7471 (void)SvIOK_only_UV(sv);
7475 if (SvIVX(sv) == IV_MIN)
7476 sv_setnv(sv, (NV)IV_MIN - 1.0);
7478 (void)SvIOK_only(sv);
7484 if (flags & SVp_NOK) {
7486 (void)SvNOK_only(sv);
7489 if (!(flags & SVp_POK)) {
7490 if ((flags & SVTYPEMASK) < SVt_PVNV)
7491 sv_upgrade(sv, SVt_NV);
7493 (void)SvNOK_only(sv);
7496 #ifdef PERL_PRESERVE_IVUV
7498 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
7499 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7500 /* Need to try really hard to see if it's an integer.
7501 9.22337203685478e+18 is an integer.
7502 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7503 so $a="9.22337203685478e+18"; $a+0; $a--
7504 needs to be the same as $a="9.22337203685478e+18"; $a--
7511 /* sv_2iv *should* have made this an NV */
7512 if (flags & SVp_NOK) {
7513 (void)SvNOK_only(sv);
7517 /* I don't think we can get here. Maybe I should assert this
7518 And if we do get here I suspect that sv_setnv will croak. NWC
7520 #if defined(USE_LONG_DOUBLE)
7521 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",
7522 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7524 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
7525 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7529 #endif /* PERL_PRESERVE_IVUV */
7530 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
7534 =for apidoc sv_mortalcopy
7536 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
7537 The new SV is marked as mortal. It will be destroyed "soon", either by an
7538 explicit call to FREETMPS, or by an implicit call at places such as
7539 statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
7544 /* Make a string that will exist for the duration of the expression
7545 * evaluation. Actually, it may have to last longer than that, but
7546 * hopefully we won't free it until it has been assigned to a
7547 * permanent location. */
7550 Perl_sv_mortalcopy(pTHX_ SV *oldstr)
7555 sv_setsv(sv,oldstr);
7557 PL_tmps_stack[++PL_tmps_ix] = sv;
7563 =for apidoc sv_newmortal
7565 Creates a new null SV which is mortal. The reference count of the SV is
7566 set to 1. It will be destroyed "soon", either by an explicit call to
7567 FREETMPS, or by an implicit call at places such as statement boundaries.
7568 See also C<sv_mortalcopy> and C<sv_2mortal>.
7574 Perl_sv_newmortal(pTHX)
7579 SvFLAGS(sv) = SVs_TEMP;
7581 PL_tmps_stack[++PL_tmps_ix] = sv;
7586 =for apidoc sv_2mortal
7588 Marks an existing SV as mortal. The SV will be destroyed "soon", either
7589 by an explicit call to FREETMPS, or by an implicit call at places such as
7590 statement boundaries. SvTEMP() is turned on which means that the SV's
7591 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7592 and C<sv_mortalcopy>.
7598 Perl_sv_2mortal(pTHX_ register SV *sv)
7602 if (SvREADONLY(sv) && SvIMMORTAL(sv))
7605 PL_tmps_stack[++PL_tmps_ix] = sv;
7613 Creates a new SV and copies a string into it. The reference count for the
7614 SV is set to 1. If C<len> is zero, Perl will compute the length using
7615 strlen(). For efficiency, consider using C<newSVpvn> instead.
7621 Perl_newSVpv(pTHX_ const char *s, STRLEN len)
7628 sv_setpvn(sv,s,len);
7633 =for apidoc newSVpvn
7635 Creates a new SV and copies a string into it. The reference count for the
7636 SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
7637 string. You are responsible for ensuring that the source string is at least
7638 C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
7644 Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
7649 sv_setpvn(sv,s,len);
7654 =for apidoc newSVpvn_share
7656 Creates a new SV with its SvPVX pointing to a shared string in the string
7657 table. If the string does not already exist in the table, it is created
7658 first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7659 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7660 otherwise the hash is computed. The idea here is that as the string table
7661 is used for shared hash keys these strings will have SvPVX == HeKEY and
7662 hash lookup will avoid string compare.
7668 Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
7671 bool is_utf8 = FALSE;
7673 STRLEN tmplen = -len;
7675 /* See the note in hv.c:hv_fetch() --jhi */
7676 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
7680 PERL_HASH(hash, src, len);
7682 sv_upgrade(sv, SVt_PVIV);
7683 SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
7696 #if defined(PERL_IMPLICIT_CONTEXT)
7698 /* pTHX_ magic can't cope with varargs, so this is a no-context
7699 * version of the main function, (which may itself be aliased to us).
7700 * Don't access this version directly.
7704 Perl_newSVpvf_nocontext(const char* pat, ...)
7709 va_start(args, pat);
7710 sv = vnewSVpvf(pat, &args);
7717 =for apidoc newSVpvf
7719 Creates a new SV and initializes it with the string formatted like
7726 Perl_newSVpvf(pTHX_ const char* pat, ...)
7730 va_start(args, pat);
7731 sv = vnewSVpvf(pat, &args);
7736 /* backend for newSVpvf() and newSVpvf_nocontext() */
7739 Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7743 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7750 Creates a new SV and copies a floating point value into it.
7751 The reference count for the SV is set to 1.
7757 Perl_newSVnv(pTHX_ NV n)
7769 Creates a new SV and copies an integer into it. The reference count for the
7776 Perl_newSViv(pTHX_ IV i)
7788 Creates a new SV and copies an unsigned integer into it.
7789 The reference count for the SV is set to 1.
7795 Perl_newSVuv(pTHX_ UV u)
7805 =for apidoc newRV_noinc
7807 Creates an RV wrapper for an SV. The reference count for the original
7808 SV is B<not> incremented.
7814 Perl_newRV_noinc(pTHX_ SV *tmpRef)
7819 sv_upgrade(sv, SVt_RV);
7826 /* newRV_inc is the official function name to use now.
7827 * newRV_inc is in fact #defined to newRV in sv.h
7831 Perl_newRV(pTHX_ SV *tmpRef)
7833 return newRV_noinc(SvREFCNT_inc(tmpRef));
7839 Creates a new SV which is an exact duplicate of the original SV.
7846 Perl_newSVsv(pTHX_ register SV *old)
7852 if (SvTYPE(old) == SVTYPEMASK) {
7853 if (ckWARN_d(WARN_INTERNAL))
7854 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
7858 /* SV_GMAGIC is the default for sv_setv()
7859 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7860 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7861 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
7866 =for apidoc sv_reset
7868 Underlying implementation for the C<reset> Perl function.
7869 Note that the perl-level function is vaguely deprecated.
7875 Perl_sv_reset(pTHX_ register const char *s, HV *stash)
7883 char todo[PERL_UCHAR_MAX+1];
7888 if (!*s) { /* reset ?? searches */
7889 for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
7890 pm->op_pmdynflags &= ~PMdf_USED;
7895 /* reset variables */
7897 if (!HvARRAY(stash))
7900 Zero(todo, 256, char);
7902 i = (unsigned char)*s;
7906 max = (unsigned char)*s++;
7907 for ( ; i <= max; i++) {
7910 for (i = 0; i <= (I32) HvMAX(stash); i++) {
7911 for (entry = HvARRAY(stash)[i];
7913 entry = HeNEXT(entry))
7915 if (!todo[(U8)*HeKEY(entry)])
7917 gv = (GV*)HeVAL(entry);
7919 if (SvTHINKFIRST(sv)) {
7920 if (!SvREADONLY(sv) && SvROK(sv))
7925 if (SvTYPE(sv) >= SVt_PV) {
7927 if (SvPVX(sv) != Nullch)
7934 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
7937 #ifdef USE_ENVIRON_ARRAY
7939 # ifdef USE_ITHREADS
7940 && PL_curinterp == aTHX
7944 environ[0] = Nullch;
7947 #endif /* !PERL_MICRO */
7957 Using various gambits, try to get an IO from an SV: the IO slot if its a
7958 GV; or the recursive result if we're an RV; or the IO slot of the symbol
7959 named after the PV if we're a string.
7965 Perl_sv_2io(pTHX_ SV *sv)
7970 switch (SvTYPE(sv)) {
7978 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
7982 Perl_croak(aTHX_ PL_no_usym, "filehandle");
7984 return sv_2io(SvRV(sv));
7985 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
7991 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
8000 Using various gambits, try to get a CV from an SV; in addition, try if
8001 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8007 Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
8013 return *gvp = Nullgv, Nullcv;
8014 switch (SvTYPE(sv)) {
8033 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
8034 tryAMAGICunDEREF(to_cv);
8037 if (SvTYPE(sv) == SVt_PVCV) {
8046 Perl_croak(aTHX_ "Not a subroutine reference");
8051 gv = gv_fetchsv(sv, lref, SVt_PVCV);
8057 if (lref && !GvCVu(gv)) {
8060 tmpsv = NEWSV(704,0);
8061 gv_efullname3(tmpsv, gv, Nullch);
8062 /* XXX this is probably not what they think they're getting.
8063 * It has the same effect as "sub name;", i.e. just a forward
8065 newSUB(start_subparse(FALSE, 0),
8066 newSVOP(OP_CONST, 0, tmpsv),
8071 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8081 Returns true if the SV has a true value by Perl's rules.
8082 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8083 instead use an in-line version.
8089 Perl_sv_true(pTHX_ register SV *sv)
8094 const register XPV* tXpv;
8095 if ((tXpv = (XPV*)SvANY(sv)) &&
8096 (tXpv->xpv_cur > 1 ||
8097 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
8104 return SvIVX(sv) != 0;
8107 return SvNVX(sv) != 0.0;
8109 return sv_2bool(sv);
8117 A private implementation of the C<SvIVx> macro for compilers which can't
8118 cope with complex macro expressions. Always use the macro instead.
8124 Perl_sv_iv(pTHX_ register SV *sv)
8128 return (IV)SvUVX(sv);
8137 A private implementation of the C<SvUVx> macro for compilers which can't
8138 cope with complex macro expressions. Always use the macro instead.
8144 Perl_sv_uv(pTHX_ register SV *sv)
8149 return (UV)SvIVX(sv);
8157 A private implementation of the C<SvNVx> macro for compilers which can't
8158 cope with complex macro expressions. Always use the macro instead.
8164 Perl_sv_nv(pTHX_ register SV *sv)
8171 /* sv_pv() is now a macro using SvPV_nolen();
8172 * this function provided for binary compatibility only
8176 Perl_sv_pv(pTHX_ SV *sv)
8183 return sv_2pv(sv, &n_a);
8189 Use the C<SvPV_nolen> macro instead
8193 A private implementation of the C<SvPV> macro for compilers which can't
8194 cope with complex macro expressions. Always use the macro instead.
8200 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
8206 return sv_2pv(sv, lp);
8211 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
8217 return sv_2pv_flags(sv, lp, 0);
8220 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
8221 * this function provided for binary compatibility only
8225 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
8227 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
8231 =for apidoc sv_pvn_force
8233 Get a sensible string out of the SV somehow.
8234 A private implementation of the C<SvPV_force> macro for compilers which
8235 can't cope with complex macro expressions. Always use the macro instead.
8237 =for apidoc sv_pvn_force_flags
8239 Get a sensible string out of the SV somehow.
8240 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8241 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8242 implemented in terms of this function.
8243 You normally want to use the various wrapper macros instead: see
8244 C<SvPV_force> and C<SvPV_force_nomg>
8250 Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
8254 if (SvTHINKFIRST(sv) && !SvROK(sv))
8255 sv_force_normal_flags(sv, 0);
8261 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
8262 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
8266 s = sv_2pv_flags(sv, lp, flags);
8267 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
8272 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8273 SvGROW(sv, len + 1);
8274 Move(s,SvPVX(sv),len,char);
8279 SvPOK_on(sv); /* validate pointer */
8281 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8282 PTR2UV(sv),SvPVX(sv)));
8288 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
8289 * this function provided for binary compatibility only
8293 Perl_sv_pvbyte(pTHX_ SV *sv)
8295 sv_utf8_downgrade(sv,0);
8300 =for apidoc sv_pvbyte
8302 Use C<SvPVbyte_nolen> instead.
8304 =for apidoc sv_pvbyten
8306 A private implementation of the C<SvPVbyte> macro for compilers
8307 which can't cope with complex macro expressions. Always use the macro
8314 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
8316 sv_utf8_downgrade(sv,0);
8317 return sv_pvn(sv,lp);
8321 =for apidoc sv_pvbyten_force
8323 A private implementation of the C<SvPVbytex_force> macro for compilers
8324 which can't cope with complex macro expressions. Always use the macro
8331 Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8333 sv_pvn_force(sv,lp);
8334 sv_utf8_downgrade(sv,0);
8339 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8340 * this function provided for binary compatibility only
8344 Perl_sv_pvutf8(pTHX_ SV *sv)
8346 sv_utf8_upgrade(sv);
8351 =for apidoc sv_pvutf8
8353 Use the C<SvPVutf8_nolen> macro instead
8355 =for apidoc sv_pvutf8n
8357 A private implementation of the C<SvPVutf8> macro for compilers
8358 which can't cope with complex macro expressions. Always use the macro
8365 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8367 sv_utf8_upgrade(sv);
8368 return sv_pvn(sv,lp);
8372 =for apidoc sv_pvutf8n_force
8374 A private implementation of the C<SvPVutf8_force> macro for compilers
8375 which can't cope with complex macro expressions. Always use the macro
8382 Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8384 sv_pvn_force(sv,lp);
8385 sv_utf8_upgrade(sv);
8391 =for apidoc sv_reftype
8393 Returns a string describing what the SV is a reference to.
8399 Perl_sv_reftype(pTHX_ const SV *sv, int ob)
8401 if (ob && SvOBJECT(sv)) {
8402 const char *name = HvNAME(SvSTASH(sv));
8403 return name ? name : "__ANON__";
8406 switch (SvTYPE(sv)) {
8423 case SVt_PVLV: return SvROK(sv) ? "REF"
8424 /* tied lvalues should appear to be
8425 * scalars for backwards compatitbility */
8426 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8427 ? "SCALAR" : "LVALUE";
8428 case SVt_PVAV: return "ARRAY";
8429 case SVt_PVHV: return "HASH";
8430 case SVt_PVCV: return "CODE";
8431 case SVt_PVGV: return "GLOB";
8432 case SVt_PVFM: return "FORMAT";
8433 case SVt_PVIO: return "IO";
8434 default: return "UNKNOWN";
8440 =for apidoc sv_isobject
8442 Returns a boolean indicating whether the SV is an RV pointing to a blessed
8443 object. If the SV is not an RV, or if the object is not blessed, then this
8450 Perl_sv_isobject(pTHX_ SV *sv)
8467 Returns a boolean indicating whether the SV is blessed into the specified
8468 class. This does not check for subtypes; use C<sv_derived_from> to verify
8469 an inheritance relationship.
8475 Perl_sv_isa(pTHX_ SV *sv, const char *name)
8486 if (!HvNAME(SvSTASH(sv)))
8489 return strEQ(HvNAME(SvSTASH(sv)), name);
8495 Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8496 it will be upgraded to one. If C<classname> is non-null then the new SV will
8497 be blessed in the specified package. The new SV is returned and its
8498 reference count is 1.
8504 Perl_newSVrv(pTHX_ SV *rv, const char *classname)
8510 SV_CHECK_THINKFIRST_COW_DROP(rv);
8513 if (SvTYPE(rv) >= SVt_PVMG) {
8514 U32 refcnt = SvREFCNT(rv);
8518 SvREFCNT(rv) = refcnt;
8521 if (SvTYPE(rv) < SVt_RV)
8522 sv_upgrade(rv, SVt_RV);
8523 else if (SvTYPE(rv) > SVt_RV) {
8525 if (SvPVX(rv) && SvLEN(rv))
8526 Safefree(SvPVX(rv));
8536 HV* stash = gv_stashpv(classname, TRUE);
8537 (void)sv_bless(rv, stash);
8543 =for apidoc sv_setref_pv
8545 Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8546 argument will be upgraded to an RV. That RV will be modified to point to
8547 the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8548 into the SV. The C<classname> argument indicates the package for the
8549 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8550 will have a reference count of 1, and the RV will be returned.
8552 Do not use with other Perl types such as HV, AV, SV, CV, because those
8553 objects will become corrupted by the pointer copy process.
8555 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8561 Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
8564 sv_setsv(rv, &PL_sv_undef);
8568 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
8573 =for apidoc sv_setref_iv
8575 Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8576 argument will be upgraded to an RV. That RV will be modified to point to
8577 the new SV. The C<classname> argument indicates the package for the
8578 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8579 will have a reference count of 1, and the RV will be returned.
8585 Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
8587 sv_setiv(newSVrv(rv,classname), iv);
8592 =for apidoc sv_setref_uv
8594 Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8595 argument will be upgraded to an RV. That RV will be modified to point to
8596 the new SV. The C<classname> argument indicates the package for the
8597 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8598 will have a reference count of 1, and the RV will be returned.
8604 Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8606 sv_setuv(newSVrv(rv,classname), uv);
8611 =for apidoc sv_setref_nv
8613 Copies a double into a new SV, optionally blessing the SV. The C<rv>
8614 argument will be upgraded to an RV. That RV will be modified to point to
8615 the new SV. The C<classname> argument indicates the package for the
8616 blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
8617 will have a reference count of 1, and the RV will be returned.
8623 Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
8625 sv_setnv(newSVrv(rv,classname), nv);
8630 =for apidoc sv_setref_pvn
8632 Copies a string into a new SV, optionally blessing the SV. The length of the
8633 string must be specified with C<n>. The C<rv> argument will be upgraded to
8634 an RV. That RV will be modified to point to the new SV. The C<classname>
8635 argument indicates the package for the blessing. Set C<classname> to
8636 C<Nullch> to avoid the blessing. The new SV will have a reference count
8637 of 1, and the RV will be returned.
8639 Note that C<sv_setref_pv> copies the pointer while this copies the string.
8645 Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
8647 sv_setpvn(newSVrv(rv,classname), pv, n);
8652 =for apidoc sv_bless
8654 Blesses an SV into a specified package. The SV must be an RV. The package
8655 must be designated by its stash (see C<gv_stashpv()>). The reference count
8656 of the SV is unaffected.
8662 Perl_sv_bless(pTHX_ SV *sv, HV *stash)
8666 Perl_croak(aTHX_ "Can't bless non-reference value");
8668 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8669 if (SvREADONLY(tmpRef))
8670 Perl_croak(aTHX_ PL_no_modify);
8671 if (SvOBJECT(tmpRef)) {
8672 if (SvTYPE(tmpRef) != SVt_PVIO)
8674 SvREFCNT_dec(SvSTASH(tmpRef));
8677 SvOBJECT_on(tmpRef);
8678 if (SvTYPE(tmpRef) != SVt_PVIO)
8680 (void)SvUPGRADE(tmpRef, SVt_PVMG);
8681 SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
8688 if(SvSMAGICAL(tmpRef))
8689 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8697 /* Downgrades a PVGV to a PVMG.
8701 S_sv_unglob(pTHX_ SV *sv)
8705 assert(SvTYPE(sv) == SVt_PVGV);
8710 SvREFCNT_dec(GvSTASH(sv));
8711 GvSTASH(sv) = Nullhv;
8713 sv_unmagic(sv, PERL_MAGIC_glob);
8714 Safefree(GvNAME(sv));
8717 /* need to keep SvANY(sv) in the right arena */
8718 xpvmg = new_XPVMG();
8719 StructCopy(SvANY(sv), xpvmg, XPVMG);
8720 del_XPVGV(SvANY(sv));
8723 SvFLAGS(sv) &= ~SVTYPEMASK;
8724 SvFLAGS(sv) |= SVt_PVMG;
8728 =for apidoc sv_unref_flags
8730 Unsets the RV status of the SV, and decrements the reference count of
8731 whatever was being referenced by the RV. This can almost be thought of
8732 as a reversal of C<newSVrv>. The C<cflags> argument can contain
8733 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8734 (otherwise the decrementing is conditional on the reference count being
8735 different from one or the reference being a readonly SV).
8742 Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
8746 if (SvWEAKREF(sv)) {
8754 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8755 assigned to as BEGIN {$a = \"Foo"} will fail. */
8756 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
8758 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
8759 sv_2mortal(rv); /* Schedule for freeing later */
8763 =for apidoc sv_unref
8765 Unsets the RV status of the SV, and decrements the reference count of
8766 whatever was being referenced by the RV. This can almost be thought of
8767 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
8768 being zero. See C<SvROK_off>.
8774 Perl_sv_unref(pTHX_ SV *sv)
8776 sv_unref_flags(sv, 0);
8780 =for apidoc sv_taint
8782 Taint an SV. Use C<SvTAINTED_on> instead.
8787 Perl_sv_taint(pTHX_ SV *sv)
8789 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
8793 =for apidoc sv_untaint
8795 Untaint an SV. Use C<SvTAINTED_off> instead.
8800 Perl_sv_untaint(pTHX_ SV *sv)
8802 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8803 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8810 =for apidoc sv_tainted
8812 Test an SV for taintedness. Use C<SvTAINTED> instead.
8817 Perl_sv_tainted(pTHX_ SV *sv)
8819 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
8820 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
8821 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
8828 =for apidoc sv_setpviv
8830 Copies an integer into the given SV, also updating its string value.
8831 Does not handle 'set' magic. See C<sv_setpviv_mg>.
8837 Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8839 char buf[TYPE_CHARS(UV)];
8841 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8843 sv_setpvn(sv, ptr, ebuf - ptr);
8847 =for apidoc sv_setpviv_mg
8849 Like C<sv_setpviv>, but also handles 'set' magic.
8855 Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8857 char buf[TYPE_CHARS(UV)];
8859 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8861 sv_setpvn(sv, ptr, ebuf - ptr);
8865 #if defined(PERL_IMPLICIT_CONTEXT)
8867 /* pTHX_ magic can't cope with varargs, so this is a no-context
8868 * version of the main function, (which may itself be aliased to us).
8869 * Don't access this version directly.
8873 Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8877 va_start(args, pat);
8878 sv_vsetpvf(sv, pat, &args);
8882 /* pTHX_ magic can't cope with varargs, so this is a no-context
8883 * version of the main function, (which may itself be aliased to us).
8884 * Don't access this version directly.
8888 Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8892 va_start(args, pat);
8893 sv_vsetpvf_mg(sv, pat, &args);
8899 =for apidoc sv_setpvf
8901 Works like C<sv_catpvf> but copies the text into the SV instead of
8902 appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8908 Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
8911 va_start(args, pat);
8912 sv_vsetpvf(sv, pat, &args);
8917 =for apidoc sv_vsetpvf
8919 Works like C<sv_vcatpvf> but copies the text into the SV instead of
8920 appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8922 Usually used via its frontend C<sv_setpvf>.
8928 Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8930 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8934 =for apidoc sv_setpvf_mg
8936 Like C<sv_setpvf>, but also handles 'set' magic.
8942 Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
8945 va_start(args, pat);
8946 sv_vsetpvf_mg(sv, pat, &args);
8951 =for apidoc sv_vsetpvf_mg
8953 Like C<sv_vsetpvf>, but also handles 'set' magic.
8955 Usually used via its frontend C<sv_setpvf_mg>.
8961 Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8963 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8967 #if defined(PERL_IMPLICIT_CONTEXT)
8969 /* pTHX_ magic can't cope with varargs, so this is a no-context
8970 * version of the main function, (which may itself be aliased to us).
8971 * Don't access this version directly.
8975 Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8979 va_start(args, pat);
8980 sv_vcatpvf(sv, pat, &args);
8984 /* pTHX_ magic can't cope with varargs, so this is a no-context
8985 * version of the main function, (which may itself be aliased to us).
8986 * Don't access this version directly.
8990 Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8994 va_start(args, pat);
8995 sv_vcatpvf_mg(sv, pat, &args);
9001 =for apidoc sv_catpvf
9003 Processes its arguments like C<sprintf> and appends the formatted
9004 output to an SV. If the appended data contains "wide" characters
9005 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9006 and characters >255 formatted with %c), the original SV might get
9007 upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
9008 C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
9009 valid UTF-8; if the original SV was bytes, the pattern should be too.
9014 Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
9017 va_start(args, pat);
9018 sv_vcatpvf(sv, pat, &args);
9023 =for apidoc sv_vcatpvf
9025 Processes its arguments like C<vsprintf> and appends the formatted output
9026 to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9028 Usually used via its frontend C<sv_catpvf>.
9034 Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
9036 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9040 =for apidoc sv_catpvf_mg
9042 Like C<sv_catpvf>, but also handles 'set' magic.
9048 Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
9051 va_start(args, pat);
9052 sv_vcatpvf_mg(sv, pat, &args);
9057 =for apidoc sv_vcatpvf_mg
9059 Like C<sv_vcatpvf>, but also handles 'set' magic.
9061 Usually used via its frontend C<sv_catpvf_mg>.
9067 Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9069 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9074 =for apidoc sv_vsetpvfn
9076 Works like C<sv_vcatpvfn> but copies the text into the SV instead of
9079 Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
9085 Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9087 sv_setpvn(sv, "", 0);
9088 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
9091 /* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
9094 S_expect_number(pTHX_ char** pattern)
9097 switch (**pattern) {
9098 case '1': case '2': case '3':
9099 case '4': case '5': case '6':
9100 case '7': case '8': case '9':
9101 while (isDIGIT(**pattern))
9102 var = var * 10 + (*(*pattern)++ - '0');
9106 #define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
9109 F0convert(NV nv, char *endbuf, STRLEN *len)
9120 if (uv & 1 && uv == nv)
9121 uv--; /* Round to even */
9123 unsigned dig = uv % 10;
9136 =for apidoc sv_vcatpvfn
9138 Processes its arguments like C<vsprintf> and appends the formatted output
9139 to an SV. Uses an array of SVs if the C style variable argument list is
9140 missing (NULL). When running with taint checks enabled, indicates via
9141 C<maybe_tainted> if results are untrustworthy (often due to the use of
9144 Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
9149 /* XXX maybe_tainted is never assigned to, so the doc above is lying. */
9152 Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
9159 static char nullstr[] = "(null)";
9161 bool has_utf8; /* has the result utf8? */
9162 bool pat_utf8; /* the pattern is in utf8? */
9164 /* Times 4: a decimal digit takes more than 3 binary digits.
9165 * NV_DIG: mantissa takes than many decimal digits.
9166 * Plus 32: Playing safe. */
9167 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9168 /* large enough for "%#.#f" --chip */
9169 /* what about long double NVs? --jhi */
9171 has_utf8 = pat_utf8 = DO_UTF8(sv);
9173 /* no matter what, this is a string now */
9174 (void)SvPV_force(sv, origlen);
9176 /* special-case "", "%s", and "%_" */
9179 if (patlen == 2 && pat[0] == '%') {
9183 const char *s = va_arg(*args, char*);
9184 sv_catpv(sv, s ? s : nullstr);
9186 else if (svix < svmax) {
9187 sv_catsv(sv, *svargs);
9188 if (DO_UTF8(*svargs))
9194 argsv = va_arg(*args, SV*);
9195 sv_catsv(sv, argsv);
9200 /* See comment on '_' below */
9205 #ifndef USE_LONG_DOUBLE
9206 /* special-case "%.<number>[gf]" */
9207 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9208 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9209 unsigned digits = 0;
9213 while (*pp >= '0' && *pp <= '9')
9214 digits = 10 * digits + (*pp++ - '0');
9215 if (pp - pat == (int)patlen - 1) {
9219 nv = (NV)va_arg(*args, double);
9220 else if (svix < svmax)
9225 /* Add check for digits != 0 because it seems that some
9226 gconverts are buggy in this case, and we don't yet have
9227 a Configure test for this. */
9228 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9229 /* 0, point, slack */
9230 Gconvert(nv, (int)digits, 0, ebuf);
9232 if (*ebuf) /* May return an empty string for digits==0 */
9235 } else if (!digits) {
9238 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9239 sv_catpvn(sv, p, l);
9245 #endif /* !USE_LONG_DOUBLE */
9247 if (!args && svix < svmax && DO_UTF8(*svargs))
9250 patend = (char*)pat + patlen;
9251 for (p = (char*)pat; p < patend; p = q) {
9254 bool vectorize = FALSE;
9255 bool vectorarg = FALSE;
9256 bool vec_utf8 = FALSE;
9262 bool has_precis = FALSE;
9265 bool is_utf8 = FALSE; /* is this item utf8? */
9266 #ifdef HAS_LDBL_SPRINTF_BUG
9267 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9268 with sfio - Allen <allens@cpan.org> */
9269 bool fix_ldbl_sprintf_bug = FALSE;
9273 U8 utf8buf[UTF8_MAXBYTES+1];
9274 STRLEN esignlen = 0;
9276 char *eptr = Nullch;
9279 U8 *vecstr = Null(U8*);
9286 /* we need a long double target in case HAS_LONG_DOUBLE but
9289 #if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9297 const char *dotstr = ".";
9298 STRLEN dotstrlen = 1;
9299 I32 efix = 0; /* explicit format parameter index */
9300 I32 ewix = 0; /* explicit width index */
9301 I32 epix = 0; /* explicit precision index */
9302 I32 evix = 0; /* explicit vector index */
9303 bool asterisk = FALSE;
9305 /* echo everything up to the next format specification */
9306 for (q = p; q < patend && *q != '%'; ++q) ;
9308 if (has_utf8 && !pat_utf8)
9309 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9311 sv_catpvn(sv, p, q - p);
9318 We allow format specification elements in this order:
9319 \d+\$ explicit format parameter index
9321 v|\*(\d+\$)?v vector with optional (optionally specified) arg
9322 0 flag (as above): repeated to allow "v02"
9323 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9324 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9326 [%bcdefginopsux_DFOUX] format (mandatory)
9328 if (EXPECT_NUMBER(q, width)) {
9369 if (EXPECT_NUMBER(q, ewix))
9378 if ((vectorarg = asterisk)) {
9390 EXPECT_NUMBER(q, width);
9395 vecsv = va_arg(*args, SV*);
9397 vecsv = (evix ? evix <= svmax : svix < svmax) ?
9398 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
9399 dotstr = SvPVx(vecsv, dotstrlen);
9404 vecsv = va_arg(*args, SV*);
9405 vecstr = (U8*)SvPVx(vecsv,veclen);
9406 vec_utf8 = DO_UTF8(vecsv);
9408 else if (efix ? efix <= svmax : svix < svmax) {
9409 vecsv = svargs[efix ? efix-1 : svix++];
9410 vecstr = (U8*)SvPVx(vecsv,veclen);
9411 vec_utf8 = DO_UTF8(vecsv);
9412 /* if this is a version object, we need to return the
9413 * stringified representation (which the SvPVX has
9414 * already done for us), but not vectorize the args
9416 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9418 q++; /* skip past the rest of the %vd format */
9419 eptr = (char *) vecstr;
9420 elen = strlen(eptr);
9433 i = va_arg(*args, int);
9435 i = (ewix ? ewix <= svmax : svix < svmax) ?
9436 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9438 width = (i < 0) ? -i : i;
9448 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9450 /* XXX: todo, support specified precision parameter */
9454 i = va_arg(*args, int);
9456 i = (ewix ? ewix <= svmax : svix < svmax)
9457 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
9458 precis = (i < 0) ? 0 : i;
9463 precis = precis * 10 + (*q++ - '0');
9472 case 'I': /* Ix, I32x, and I64x */
9474 if (q[1] == '6' && q[2] == '4') {
9480 if (q[1] == '3' && q[2] == '2') {
9490 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9501 #if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
9502 if (*(q + 1) == 'l') { /* lld, llf */
9527 argsv = (efix ? efix <= svmax : svix < svmax) ?
9528 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9535 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
9537 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
9539 eptr = (char*)utf8buf;
9540 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
9551 if (args && !vectorize) {
9552 eptr = va_arg(*args, char*);
9554 #ifdef MACOS_TRADITIONAL
9555 /* On MacOS, %#s format is used for Pascal strings */
9560 elen = strlen(eptr);
9563 elen = sizeof nullstr - 1;
9567 eptr = SvPVx(argsv, elen);
9568 if (DO_UTF8(argsv)) {
9569 if (has_precis && precis < elen) {
9571 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
9574 if (width) { /* fudge width (can't fudge elen) */
9575 width += elen - sv_len_utf8(argsv);
9587 * The "%_" hack might have to be changed someday,
9588 * if ISO or ANSI decide to use '_' for something.
9589 * So we keep it hidden from users' code.
9591 if (!args || vectorize)
9593 argsv = va_arg(*args, SV*);
9594 eptr = SvPVx(argsv, elen);
9600 if (has_precis && elen > precis)
9611 goto format_sv; /* %-p -> %_ */
9615 goto format_sv; /* %-Np -> %.N_ */
9618 if (alt || vectorize)
9620 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
9638 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9647 esignbuf[esignlen++] = plus;
9651 case 'h': iv = (short)va_arg(*args, int); break;
9652 case 'l': iv = va_arg(*args, long); break;
9653 case 'V': iv = va_arg(*args, IV); break;
9654 default: iv = va_arg(*args, int); break;
9656 case 'q': iv = va_arg(*args, Quad_t); break;
9661 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
9663 case 'h': iv = (short)tiv; break;
9664 case 'l': iv = (long)tiv; break;
9666 default: iv = tiv; break;
9668 case 'q': iv = (Quad_t)tiv; break;
9672 if ( !vectorize ) /* we already set uv above */
9677 esignbuf[esignlen++] = plus;
9681 esignbuf[esignlen++] = '-';
9724 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9735 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
9736 case 'l': uv = va_arg(*args, unsigned long); break;
9737 case 'V': uv = va_arg(*args, UV); break;
9738 default: uv = va_arg(*args, unsigned); break;
9740 case 'q': uv = va_arg(*args, Uquad_t); break;
9745 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
9747 case 'h': uv = (unsigned short)tuv; break;
9748 case 'l': uv = (unsigned long)tuv; break;
9750 default: uv = tuv; break;
9752 case 'q': uv = (Uquad_t)tuv; break;
9758 eptr = ebuf + sizeof ebuf;
9764 p = (char*)((c == 'X')
9765 ? "0123456789ABCDEF" : "0123456789abcdef");
9771 esignbuf[esignlen++] = '0';
9772 esignbuf[esignlen++] = c; /* 'x' or 'X' */
9778 *--eptr = '0' + dig;
9780 if (alt && *eptr != '0')
9786 *--eptr = '0' + dig;
9789 esignbuf[esignlen++] = '0';
9790 esignbuf[esignlen++] = 'b';
9793 default: /* it had better be ten or less */
9794 #if defined(PERL_Y2KWARN)
9795 if (ckWARN(WARN_Y2K)) {
9797 char *s = SvPV(sv,n);
9798 if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
9799 && (n == 2 || !isDIGIT(s[n-3])))
9801 Perl_warner(aTHX_ packWARN(WARN_Y2K),
9802 "Possible Y2K bug: %%%c %s",
9803 c, "format string following '19'");
9809 *--eptr = '0' + dig;
9810 } while (uv /= base);
9813 elen = (ebuf + sizeof ebuf) - eptr;
9816 zeros = precis - elen;
9817 else if (precis == 0 && elen == 1 && *eptr == '0')
9822 /* FLOATING POINT */
9825 c = 'f'; /* maybe %F isn't supported here */
9831 /* This is evil, but floating point is even more evil */
9833 /* for SV-style calling, we can only get NV
9834 for C-style calling, we assume %f is double;
9835 for simplicity we allow any of %Lf, %llf, %qf for long double
9839 #if defined(USE_LONG_DOUBLE)
9843 /* [perl #20339] - we should accept and ignore %lf rather than die */
9847 #if defined(USE_LONG_DOUBLE)
9848 intsize = args ? 0 : 'q';
9852 #if defined(HAS_LONG_DOUBLE)
9861 /* now we need (long double) if intsize == 'q', else (double) */
9862 nv = (args && !vectorize) ?
9863 #if LONG_DOUBLESIZE > DOUBLESIZE
9865 va_arg(*args, long double) :
9866 va_arg(*args, double)
9868 va_arg(*args, double)
9874 if (c != 'e' && c != 'E') {
9876 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9877 will cast our (long double) to (double) */
9878 (void)Perl_frexp(nv, &i);
9879 if (i == PERL_INT_MIN)
9880 Perl_die(aTHX_ "panic: frexp");
9882 need = BIT_DIGITS(i);
9884 need += has_precis ? precis : 6; /* known default */
9889 #ifdef HAS_LDBL_SPRINTF_BUG
9890 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
9891 with sfio - Allen <allens@cpan.org> */
9894 # define MY_DBL_MAX DBL_MAX
9895 # else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9896 # if DOUBLESIZE >= 8
9897 # define MY_DBL_MAX 1.7976931348623157E+308L
9899 # define MY_DBL_MAX 3.40282347E+38L
9903 # ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9904 # define MY_DBL_MAX_BUG 1L
9906 # define MY_DBL_MAX_BUG MY_DBL_MAX
9910 # define MY_DBL_MIN DBL_MIN
9911 # else /* XXX guessing! -Allen */
9912 # if DOUBLESIZE >= 8
9913 # define MY_DBL_MIN 2.2250738585072014E-308L
9915 # define MY_DBL_MIN 1.17549435E-38L
9919 if ((intsize == 'q') && (c == 'f') &&
9920 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9922 /* it's going to be short enough that
9923 * long double precision is not needed */
9925 if ((nv <= 0L) && (nv >= -0L))
9926 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9928 /* would use Perl_fp_class as a double-check but not
9929 * functional on IRIX - see perl.h comments */
9931 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9932 /* It's within the range that a double can represent */
9933 #if defined(DBL_MAX) && !defined(DBL_MIN)
9934 if ((nv >= ((long double)1/DBL_MAX)) ||
9935 (nv <= (-(long double)1/DBL_MAX)))
9937 fix_ldbl_sprintf_bug = TRUE;
9940 if (fix_ldbl_sprintf_bug == TRUE) {
9950 # undef MY_DBL_MAX_BUG
9953 #endif /* HAS_LDBL_SPRINTF_BUG */
9955 need += 20; /* fudge factor */
9956 if (PL_efloatsize < need) {
9957 Safefree(PL_efloatbuf);
9958 PL_efloatsize = need + 20; /* more fudge */
9959 New(906, PL_efloatbuf, PL_efloatsize, char);
9960 PL_efloatbuf[0] = '\0';
9963 if ( !(width || left || plus || alt) && fill != '0'
9964 && has_precis && intsize != 'q' ) { /* Shortcuts */
9965 /* See earlier comment about buggy Gconvert when digits,
9967 if ( c == 'g' && precis) {
9968 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
9969 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9970 goto float_converted;
9971 } else if ( c == 'f' && !precis) {
9972 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9976 eptr = ebuf + sizeof ebuf;
9979 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9980 #if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9981 if (intsize == 'q') {
9982 /* Copy the one or more characters in a long double
9983 * format before the 'base' ([efgEFG]) character to
9984 * the format string. */
9985 static char const prifldbl[] = PERL_PRIfldbl;
9986 char const *p = prifldbl + sizeof(prifldbl) - 3;
9987 while (p >= prifldbl) { *--eptr = *p--; }
9992 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9997 do { *--eptr = '0' + (base % 10); } while (base /= 10);
10009 /* No taint. Otherwise we are in the strange situation
10010 * where printf() taints but print($float) doesn't.
10012 #if defined(HAS_LONG_DOUBLE)
10013 if (intsize == 'q')
10014 (void)sprintf(PL_efloatbuf, eptr, nv);
10016 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
10018 (void)sprintf(PL_efloatbuf, eptr, nv);
10021 eptr = PL_efloatbuf;
10022 elen = strlen(PL_efloatbuf);
10028 i = SvCUR(sv) - origlen;
10029 if (args && !vectorize) {
10031 case 'h': *(va_arg(*args, short*)) = i; break;
10032 default: *(va_arg(*args, int*)) = i; break;
10033 case 'l': *(va_arg(*args, long*)) = i; break;
10034 case 'V': *(va_arg(*args, IV*)) = i; break;
10036 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
10041 sv_setuv_mg(argsv, (UV)i);
10043 continue; /* not "break" */
10049 if (!args && ckWARN(WARN_PRINTF) &&
10050 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
10051 SV *msg = sv_newmortal();
10052 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
10053 (PL_op->op_type == OP_PRTF) ? "" : "s");
10056 Perl_sv_catpvf(aTHX_ msg,
10057 "\"%%%c\"", c & 0xFF);
10059 Perl_sv_catpvf(aTHX_ msg,
10060 "\"%%\\%03"UVof"\"",
10063 sv_catpv(msg, "end of string");
10064 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
10067 /* output mangled stuff ... */
10073 /* ... right here, because formatting flags should not apply */
10074 SvGROW(sv, SvCUR(sv) + elen + 1);
10076 Copy(eptr, p, elen, char);
10079 SvCUR(sv) = p - SvPVX(sv);
10081 continue; /* not "break" */
10084 /* calculate width before utf8_upgrade changes it */
10085 have = esignlen + zeros + elen;
10087 if (is_utf8 != has_utf8) {
10090 sv_utf8_upgrade(sv);
10093 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
10094 sv_utf8_upgrade(nsv);
10098 SvGROW(sv, SvCUR(sv) + elen + 1);
10103 need = (have > width ? have : width);
10106 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
10108 if (esignlen && fill == '0') {
10109 for (i = 0; i < (int)esignlen; i++)
10110 *p++ = esignbuf[i];
10112 if (gap && !left) {
10113 memset(p, fill, gap);
10116 if (esignlen && fill != '0') {
10117 for (i = 0; i < (int)esignlen; i++)
10118 *p++ = esignbuf[i];
10121 for (i = zeros; i; i--)
10125 Copy(eptr, p, elen, char);
10129 memset(p, ' ', gap);
10134 Copy(dotstr, p, dotstrlen, char);
10138 vectorize = FALSE; /* done iterating over vecstr */
10145 SvCUR(sv) = p - SvPVX(sv);
10153 /* =========================================================================
10155 =head1 Cloning an interpreter
10157 All the macros and functions in this section are for the private use of
10158 the main function, perl_clone().
10160 The foo_dup() functions make an exact copy of an existing foo thinngy.
10161 During the course of a cloning, a hash table is used to map old addresses
10162 to new addresses. The table is created and manipulated with the
10163 ptr_table_* functions.
10167 ============================================================================*/
10170 #if defined(USE_ITHREADS)
10172 #ifndef GpREFCNT_inc
10173 # define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10177 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10178 #define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10179 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10180 #define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10181 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10182 #define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10183 #define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10184 #define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10185 #define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10186 #define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10187 #define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10188 #define SAVEPV(p) (p ? savepv(p) : Nullch)
10189 #define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
10192 /* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
10193 regcomp.c. AMS 20010712 */
10196 Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
10200 struct reg_substr_datum *s;
10203 return (REGEXP *)NULL;
10205 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
10208 len = r->offsets[0];
10209 npar = r->nparens+1;
10211 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
10212 Copy(r->program, ret->program, len+1, regnode);
10214 New(0, ret->startp, npar, I32);
10215 Copy(r->startp, ret->startp, npar, I32);
10216 New(0, ret->endp, npar, I32);
10217 Copy(r->startp, ret->startp, npar, I32);
10219 New(0, ret->substrs, 1, struct reg_substr_data);
10220 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
10221 s->min_offset = r->substrs->data[i].min_offset;
10222 s->max_offset = r->substrs->data[i].max_offset;
10223 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
10224 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
10227 ret->regstclass = NULL;
10229 struct reg_data *d;
10230 const int count = r->data->count;
10232 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
10233 char, struct reg_data);
10234 New(0, d->what, count, U8);
10237 for (i = 0; i < count; i++) {
10238 d->what[i] = r->data->what[i];
10239 switch (d->what[i]) {
10240 /* legal options are one of: sfpont
10241 see also regcomp.h and pregfree() */
10243 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
10246 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
10249 /* This is cheating. */
10250 New(0, d->data[i], 1, struct regnode_charclass_class);
10251 StructCopy(r->data->data[i], d->data[i],
10252 struct regnode_charclass_class);
10253 ret->regstclass = (regnode*)d->data[i];
10256 /* Compiled op trees are readonly, and can thus be
10257 shared without duplication. */
10259 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
10263 d->data[i] = r->data->data[i];
10266 d->data[i] = r->data->data[i];
10268 ((reg_trie_data*)d->data[i])->refcount++;
10272 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
10281 New(0, ret->offsets, 2*len+1, U32);
10282 Copy(r->offsets, ret->offsets, 2*len+1, U32);
10284 ret->precomp = SAVEPVN(r->precomp, r->prelen);
10285 ret->refcnt = r->refcnt;
10286 ret->minlen = r->minlen;
10287 ret->prelen = r->prelen;
10288 ret->nparens = r->nparens;
10289 ret->lastparen = r->lastparen;
10290 ret->lastcloseparen = r->lastcloseparen;
10291 ret->reganch = r->reganch;
10293 ret->sublen = r->sublen;
10295 if (RX_MATCH_COPIED(ret))
10296 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
10298 ret->subbeg = Nullch;
10299 #ifdef PERL_COPY_ON_WRITE
10300 ret->saved_copy = Nullsv;
10303 ptr_table_store(PL_ptr_table, r, ret);
10307 /* duplicate a file handle */
10310 Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
10316 return (PerlIO*)NULL;
10318 /* look for it in the table first */
10319 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10323 /* create anew and remember what it is */
10324 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
10325 ptr_table_store(PL_ptr_table, fp, ret);
10329 /* duplicate a directory handle */
10332 Perl_dirp_dup(pTHX_ DIR *dp)
10340 /* duplicate a typeglob */
10343 Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
10348 /* look for it in the table first */
10349 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10353 /* create anew and remember what it is */
10354 Newz(0, ret, 1, GP);
10355 ptr_table_store(PL_ptr_table, gp, ret);
10358 ret->gp_refcnt = 0; /* must be before any other dups! */
10359 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10360 ret->gp_io = io_dup_inc(gp->gp_io, param);
10361 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10362 ret->gp_av = av_dup_inc(gp->gp_av, param);
10363 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10364 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10365 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
10366 ret->gp_cvgen = gp->gp_cvgen;
10367 ret->gp_flags = gp->gp_flags;
10368 ret->gp_line = gp->gp_line;
10369 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10373 /* duplicate a chain of magic */
10376 Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
10378 MAGIC *mgprev = (MAGIC*)NULL;
10381 return (MAGIC*)NULL;
10382 /* look for it in the table first */
10383 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10387 for (; mg; mg = mg->mg_moremagic) {
10389 Newz(0, nmg, 1, MAGIC);
10391 mgprev->mg_moremagic = nmg;
10394 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10395 nmg->mg_private = mg->mg_private;
10396 nmg->mg_type = mg->mg_type;
10397 nmg->mg_flags = mg->mg_flags;
10398 if (mg->mg_type == PERL_MAGIC_qr) {
10399 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
10401 else if(mg->mg_type == PERL_MAGIC_backref) {
10402 const AV * const av = (AV*) mg->mg_obj;
10405 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10407 for (i = AvFILLp(av); i >= 0; i--) {
10408 if (!svp[i]) continue;
10409 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10413 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
10414 ? sv_dup_inc(mg->mg_obj, param)
10415 : sv_dup(mg->mg_obj, param);
10417 nmg->mg_len = mg->mg_len;
10418 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
10419 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
10420 if (mg->mg_len > 0) {
10421 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
10422 if (mg->mg_type == PERL_MAGIC_overload_table &&
10423 AMT_AMAGIC((AMT*)mg->mg_ptr))
10425 AMT *amtp = (AMT*)mg->mg_ptr;
10426 AMT *namtp = (AMT*)nmg->mg_ptr;
10428 for (i = 1; i < NofAMmeth; i++) {
10429 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
10433 else if (mg->mg_len == HEf_SVKEY)
10434 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
10436 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10437 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10444 /* create a new pointer-mapping table */
10447 Perl_ptr_table_new(pTHX)
10450 Newz(0, tbl, 1, PTR_TBL_t);
10451 tbl->tbl_max = 511;
10452 tbl->tbl_items = 0;
10453 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10458 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10460 # define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10463 /* map an existing pointer using a table */
10466 Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10468 PTR_TBL_ENT_t *tblent;
10469 UV hash = PTR_TABLE_HASH(sv);
10471 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10472 for (; tblent; tblent = tblent->next) {
10473 if (tblent->oldval == sv)
10474 return tblent->newval;
10476 return (void*)NULL;
10479 /* add a new entry to a pointer-mapping table */
10482 Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10484 PTR_TBL_ENT_t *tblent, **otblent;
10485 /* XXX this may be pessimal on platforms where pointers aren't good
10486 * hash values e.g. if they grow faster in the most significant
10488 UV hash = PTR_TABLE_HASH(oldv);
10492 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
10493 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
10494 if (tblent->oldval == oldv) {
10495 tblent->newval = newv;
10499 Newz(0, tblent, 1, PTR_TBL_ENT_t);
10500 tblent->oldval = oldv;
10501 tblent->newval = newv;
10502 tblent->next = *otblent;
10505 if (!empty && tbl->tbl_items > tbl->tbl_max)
10506 ptr_table_split(tbl);
10509 /* double the hash bucket size of an existing ptr table */
10512 Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10514 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10515 UV oldsize = tbl->tbl_max + 1;
10516 UV newsize = oldsize * 2;
10519 Renew(ary, newsize, PTR_TBL_ENT_t*);
10520 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10521 tbl->tbl_max = --newsize;
10522 tbl->tbl_ary = ary;
10523 for (i=0; i < oldsize; i++, ary++) {
10524 PTR_TBL_ENT_t **curentp, **entp, *ent;
10527 curentp = ary + oldsize;
10528 for (entp = ary, ent = *ary; ent; ent = *entp) {
10529 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
10531 ent->next = *curentp;
10541 /* remove all the entries from a ptr table */
10544 Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10546 register PTR_TBL_ENT_t **array;
10547 register PTR_TBL_ENT_t *entry;
10548 register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
10552 if (!tbl || !tbl->tbl_items) {
10556 array = tbl->tbl_ary;
10558 max = tbl->tbl_max;
10563 entry = entry->next;
10567 if (++riter > max) {
10570 entry = array[riter];
10574 tbl->tbl_items = 0;
10577 /* clear and free a ptr table */
10580 Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10585 ptr_table_clear(tbl);
10586 Safefree(tbl->tbl_ary);
10591 char *PL_watch_pvx;
10594 /* attempt to make everything in the typeglob readonly */
10597 S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
10599 GV *gv = (GV*)sstr;
10600 SV *sv = ¶m->proto_perl->Isv_no; /* just need SvREADONLY-ness */
10602 if (GvIO(gv) || GvFORM(gv)) {
10603 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
10605 else if (!GvCV(gv)) {
10606 GvCV(gv) = (CV*)sv;
10609 /* CvPADLISTs cannot be shared */
10610 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
10615 if (!GvUNIQUE(gv)) {
10617 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10618 HvNAME(GvSTASH(gv)), GvNAME(gv));
10624 * write attempts will die with
10625 * "Modification of a read-only value attempted"
10631 SvREADONLY_on(GvSV(gv));
10635 GvAV(gv) = (AV*)sv;
10638 SvREADONLY_on(GvAV(gv));
10642 GvHV(gv) = (HV*)sv;
10645 SvREADONLY_on(GvHV(gv));
10648 return sstr; /* he_dup() will SvREFCNT_inc() */
10651 /* duplicate an SV of any type (including AV, HV etc) */
10654 Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10657 SvRV(dstr) = SvWEAKREF(sstr)
10658 ? sv_dup(SvRV(sstr), param)
10659 : sv_dup_inc(SvRV(sstr), param);
10661 else if (SvPVX(sstr)) {
10662 /* Has something there */
10664 /* Normal PV - clone whole allocated space */
10665 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
10666 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10667 /* Not that normal - actually sstr is copy on write.
10668 But we are a true, independant SV, so: */
10669 SvREADONLY_off(dstr);
10674 /* Special case - not normally malloced for some reason */
10675 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10676 /* A "shared" PV - clone it as unshared string */
10677 if(SvPADTMP(sstr)) {
10678 /* However, some of them live in the pad
10679 and they should not have these flags
10682 SvPVX(dstr) = sharepvn(SvPVX(sstr), SvCUR(sstr),
10684 SvUVX(dstr) = SvUVX(sstr);
10687 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
10689 SvREADONLY_off(dstr);
10693 /* Some other special case - random pointer */
10694 SvPVX(dstr) = SvPVX(sstr);
10699 /* Copy the Null */
10700 SvPVX(dstr) = SvPVX(sstr);
10705 Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
10709 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10711 /* look for it in the table first */
10712 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10716 if(param->flags & CLONEf_JOIN_IN) {
10717 /** We are joining here so we don't want do clone
10718 something that is bad **/
10720 if(SvTYPE(sstr) == SVt_PVHV &&
10722 /** don't clone stashes if they already exist **/
10723 HV* old_stash = gv_stashpv(HvNAME(sstr),0);
10724 return (SV*) old_stash;
10728 /* create anew and remember what it is */
10730 ptr_table_store(PL_ptr_table, sstr, dstr);
10733 SvFLAGS(dstr) = SvFLAGS(sstr);
10734 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10735 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10738 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
10739 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10740 PL_watch_pvx, SvPVX(sstr));
10743 switch (SvTYPE(sstr)) {
10745 SvANY(dstr) = NULL;
10748 SvANY(dstr) = new_XIV();
10749 SvIVX(dstr) = SvIVX(sstr);
10752 SvANY(dstr) = new_XNV();
10753 SvNVX(dstr) = SvNVX(sstr);
10756 SvANY(dstr) = new_XRV();
10757 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10760 SvANY(dstr) = new_XPV();
10761 SvCUR(dstr) = SvCUR(sstr);
10762 SvLEN(dstr) = SvLEN(sstr);
10763 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10766 SvANY(dstr) = new_XPVIV();
10767 SvCUR(dstr) = SvCUR(sstr);
10768 SvLEN(dstr) = SvLEN(sstr);
10769 SvIVX(dstr) = SvIVX(sstr);
10770 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10773 SvANY(dstr) = new_XPVNV();
10774 SvCUR(dstr) = SvCUR(sstr);
10775 SvLEN(dstr) = SvLEN(sstr);
10776 SvIVX(dstr) = SvIVX(sstr);
10777 SvNVX(dstr) = SvNVX(sstr);
10778 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10781 SvANY(dstr) = new_XPVMG();
10782 SvCUR(dstr) = SvCUR(sstr);
10783 SvLEN(dstr) = SvLEN(sstr);
10784 SvIVX(dstr) = SvIVX(sstr);
10785 SvNVX(dstr) = SvNVX(sstr);
10786 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10787 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10788 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10791 SvANY(dstr) = new_XPVBM();
10792 SvCUR(dstr) = SvCUR(sstr);
10793 SvLEN(dstr) = SvLEN(sstr);
10794 SvIVX(dstr) = SvIVX(sstr);
10795 SvNVX(dstr) = SvNVX(sstr);
10796 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10797 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10798 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10799 BmRARE(dstr) = BmRARE(sstr);
10800 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10801 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10804 SvANY(dstr) = new_XPVLV();
10805 SvCUR(dstr) = SvCUR(sstr);
10806 SvLEN(dstr) = SvLEN(sstr);
10807 SvIVX(dstr) = SvIVX(sstr);
10808 SvNVX(dstr) = SvNVX(sstr);
10809 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10810 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10811 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10812 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10813 LvTARGLEN(dstr) = LvTARGLEN(sstr);
10814 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10815 LvTARG(dstr) = dstr;
10816 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10817 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10819 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
10820 LvTYPE(dstr) = LvTYPE(sstr);
10823 if (GvUNIQUE((GV*)sstr)) {
10825 if ((share = gv_share(sstr, param))) {
10828 ptr_table_store(PL_ptr_table, sstr, dstr);
10830 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10831 HvNAME(GvSTASH(share)), GvNAME(share));
10836 SvANY(dstr) = new_XPVGV();
10837 SvCUR(dstr) = SvCUR(sstr);
10838 SvLEN(dstr) = SvLEN(sstr);
10839 SvIVX(dstr) = SvIVX(sstr);
10840 SvNVX(dstr) = SvNVX(sstr);
10841 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10842 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10843 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10844 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10845 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
10846 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
10847 GvFLAGS(dstr) = GvFLAGS(sstr);
10848 GvGP(dstr) = gp_dup(GvGP(sstr), param);
10849 (void)GpREFCNT_inc(GvGP(dstr));
10852 SvANY(dstr) = new_XPVIO();
10853 SvCUR(dstr) = SvCUR(sstr);
10854 SvLEN(dstr) = SvLEN(sstr);
10855 SvIVX(dstr) = SvIVX(sstr);
10856 SvNVX(dstr) = SvNVX(sstr);
10857 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10858 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10859 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10860 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
10861 if (IoOFP(sstr) == IoIFP(sstr))
10862 IoOFP(dstr) = IoIFP(dstr);
10864 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
10865 /* PL_rsfp_filters entries have fake IoDIRP() */
10866 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10867 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10869 IoDIRP(dstr) = IoDIRP(sstr);
10870 IoLINES(dstr) = IoLINES(sstr);
10871 IoPAGE(dstr) = IoPAGE(sstr);
10872 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10873 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
10874 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
10875 /* I have no idea why fake dirp (rsfps)
10876 should be treaded differently but otherwise
10877 we end up with leaks -- sky*/
10878 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10879 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10880 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10882 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10883 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10884 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10886 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
10887 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
10888 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
10889 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10890 IoTYPE(dstr) = IoTYPE(sstr);
10891 IoFLAGS(dstr) = IoFLAGS(sstr);
10894 SvANY(dstr) = new_XPVAV();
10895 SvCUR(dstr) = SvCUR(sstr);
10896 SvLEN(dstr) = SvLEN(sstr);
10897 SvIVX(dstr) = SvIVX(sstr);
10898 SvNVX(dstr) = SvNVX(sstr);
10899 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10900 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10901 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
10902 AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
10903 if (AvARRAY((AV*)sstr)) {
10904 SV **dst_ary, **src_ary;
10905 SSize_t items = AvFILLp((AV*)sstr) + 1;
10907 src_ary = AvARRAY((AV*)sstr);
10908 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10909 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10910 SvPVX(dstr) = (char*)dst_ary;
10911 AvALLOC((AV*)dstr) = dst_ary;
10912 if (AvREAL((AV*)sstr)) {
10913 while (items-- > 0)
10914 *dst_ary++ = sv_dup_inc(*src_ary++, param);
10917 while (items-- > 0)
10918 *dst_ary++ = sv_dup(*src_ary++, param);
10920 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10921 while (items-- > 0) {
10922 *dst_ary++ = &PL_sv_undef;
10926 SvPVX(dstr) = Nullch;
10927 AvALLOC((AV*)dstr) = (SV**)NULL;
10931 SvANY(dstr) = new_XPVHV();
10932 SvCUR(dstr) = SvCUR(sstr);
10933 SvLEN(dstr) = SvLEN(sstr);
10934 SvIVX(dstr) = SvIVX(sstr);
10935 SvNVX(dstr) = SvNVX(sstr);
10936 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10937 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10938 HvRITER((HV*)dstr) = HvRITER((HV*)sstr);
10939 if (HvARRAY((HV*)sstr)) {
10941 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
10942 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
10943 Newz(0, dxhv->xhv_array,
10944 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
10945 while (i <= sxhv->xhv_max) {
10946 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
10947 (bool)!!HvSHAREKEYS(sstr),
10951 dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter,
10952 (bool)!!HvSHAREKEYS(sstr), param);
10955 SvPVX(dstr) = Nullch;
10956 HvEITER((HV*)dstr) = (HE*)NULL;
10958 HvPMROOT((HV*)dstr) = HvPMROOT((HV*)sstr); /* XXX */
10959 HvNAME((HV*)dstr) = SAVEPV(HvNAME((HV*)sstr));
10960 /* Record stashes for possible cloning in Perl_clone(). */
10961 if(HvNAME((HV*)dstr))
10962 av_push(param->stashes, dstr);
10965 SvANY(dstr) = new_XPVFM();
10966 FmLINES(dstr) = FmLINES(sstr);
10970 SvANY(dstr) = new_XPVCV();
10972 SvCUR(dstr) = SvCUR(sstr);
10973 SvLEN(dstr) = SvLEN(sstr);
10974 SvIVX(dstr) = SvIVX(sstr);
10975 SvNVX(dstr) = SvNVX(sstr);
10976 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10977 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10978 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
10979 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
10980 CvSTART(dstr) = CvSTART(sstr);
10982 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
10984 CvXSUB(dstr) = CvXSUB(sstr);
10985 CvXSUBANY(dstr) = CvXSUBANY(sstr);
10986 if (CvCONST(sstr)) {
10987 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
10988 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
10989 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
10991 /* don't dup if copying back - CvGV isn't refcounted, so the
10992 * duped GV may never be freed. A bit of a hack! DAPM */
10993 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10994 Nullgv : gv_dup(CvGV(sstr), param) ;
10995 if (param->flags & CLONEf_COPY_STACKS) {
10996 CvDEPTH(dstr) = CvDEPTH(sstr);
11000 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
11001 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
11003 CvWEAKOUTSIDE(sstr)
11004 ? cv_dup( CvOUTSIDE(sstr), param)
11005 : cv_dup_inc(CvOUTSIDE(sstr), param);
11006 CvFLAGS(dstr) = CvFLAGS(sstr);
11007 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
11010 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
11014 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
11020 /* duplicate a context */
11023 Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
11025 PERL_CONTEXT *ncxs;
11028 return (PERL_CONTEXT*)NULL;
11030 /* look for it in the table first */
11031 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
11035 /* create anew and remember what it is */
11036 Newz(56, ncxs, max + 1, PERL_CONTEXT);
11037 ptr_table_store(PL_ptr_table, cxs, ncxs);
11040 PERL_CONTEXT *cx = &cxs[ix];
11041 PERL_CONTEXT *ncx = &ncxs[ix];
11042 ncx->cx_type = cx->cx_type;
11043 if (CxTYPE(cx) == CXt_SUBST) {
11044 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
11047 ncx->blk_oldsp = cx->blk_oldsp;
11048 ncx->blk_oldcop = cx->blk_oldcop;
11049 ncx->blk_oldmarksp = cx->blk_oldmarksp;
11050 ncx->blk_oldscopesp = cx->blk_oldscopesp;
11051 ncx->blk_oldpm = cx->blk_oldpm;
11052 ncx->blk_gimme = cx->blk_gimme;
11053 switch (CxTYPE(cx)) {
11055 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
11056 ? cv_dup_inc(cx->blk_sub.cv, param)
11057 : cv_dup(cx->blk_sub.cv,param));
11058 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
11059 ? av_dup_inc(cx->blk_sub.argarray, param)
11061 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
11062 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
11063 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11064 ncx->blk_sub.lval = cx->blk_sub.lval;
11065 ncx->blk_sub.retop = cx->blk_sub.retop;
11068 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
11069 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
11070 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
11071 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
11072 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
11073 ncx->blk_eval.retop = cx->blk_eval.retop;
11076 ncx->blk_loop.label = cx->blk_loop.label;
11077 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
11078 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
11079 ncx->blk_loop.next_op = cx->blk_loop.next_op;
11080 ncx->blk_loop.last_op = cx->blk_loop.last_op;
11081 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
11082 ? cx->blk_loop.iterdata
11083 : gv_dup((GV*)cx->blk_loop.iterdata, param));
11084 ncx->blk_loop.oldcomppad
11085 = (PAD*)ptr_table_fetch(PL_ptr_table,
11086 cx->blk_loop.oldcomppad);
11087 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
11088 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
11089 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
11090 ncx->blk_loop.iterix = cx->blk_loop.iterix;
11091 ncx->blk_loop.itermax = cx->blk_loop.itermax;
11094 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
11095 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
11096 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
11097 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11098 ncx->blk_sub.retop = cx->blk_sub.retop;
11110 /* duplicate a stack info structure */
11113 Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
11118 return (PERL_SI*)NULL;
11120 /* look for it in the table first */
11121 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11125 /* create anew and remember what it is */
11126 Newz(56, nsi, 1, PERL_SI);
11127 ptr_table_store(PL_ptr_table, si, nsi);
11129 nsi->si_stack = av_dup_inc(si->si_stack, param);
11130 nsi->si_cxix = si->si_cxix;
11131 nsi->si_cxmax = si->si_cxmax;
11132 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
11133 nsi->si_type = si->si_type;
11134 nsi->si_prev = si_dup(si->si_prev, param);
11135 nsi->si_next = si_dup(si->si_next, param);
11136 nsi->si_markoff = si->si_markoff;
11141 #define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11142 #define TOPINT(ss,ix) ((ss)[ix].any_i32)
11143 #define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11144 #define TOPLONG(ss,ix) ((ss)[ix].any_long)
11145 #define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11146 #define TOPIV(ss,ix) ((ss)[ix].any_iv)
11147 #define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11148 #define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
11149 #define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11150 #define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11151 #define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11152 #define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11153 #define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11154 #define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11157 #define pv_dup_inc(p) SAVEPV(p)
11158 #define pv_dup(p) SAVEPV(p)
11159 #define svp_dup_inc(p,pp) any_dup(p,pp)
11161 /* map any object to the new equivent - either something in the
11162 * ptr table, or something in the interpreter structure
11166 Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
11171 return (void*)NULL;
11173 /* look for it in the table first */
11174 ret = ptr_table_fetch(PL_ptr_table, v);
11178 /* see if it is part of the interpreter structure */
11179 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
11180 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
11188 /* duplicate the save stack */
11191 Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
11193 ANY *ss = proto_perl->Tsavestack;
11194 I32 ix = proto_perl->Tsavestack_ix;
11195 I32 max = proto_perl->Tsavestack_max;
11208 void (*dptr) (void*);
11209 void (*dxptr) (pTHX_ void*);
11212 Newz(54, nss, max, ANY);
11216 TOPINT(nss,ix) = i;
11218 case SAVEt_ITEM: /* normal string */
11219 sv = (SV*)POPPTR(ss,ix);
11220 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11221 sv = (SV*)POPPTR(ss,ix);
11222 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11224 case SAVEt_SV: /* scalar reference */
11225 sv = (SV*)POPPTR(ss,ix);
11226 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11227 gv = (GV*)POPPTR(ss,ix);
11228 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11230 case SAVEt_GENERIC_PVREF: /* generic char* */
11231 c = (char*)POPPTR(ss,ix);
11232 TOPPTR(nss,ix) = pv_dup(c);
11233 ptr = POPPTR(ss,ix);
11234 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11236 case SAVEt_SHARED_PVREF: /* char* in shared space */
11237 c = (char*)POPPTR(ss,ix);
11238 TOPPTR(nss,ix) = savesharedpv(c);
11239 ptr = POPPTR(ss,ix);
11240 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11242 case SAVEt_GENERIC_SVREF: /* generic sv */
11243 case SAVEt_SVREF: /* scalar reference */
11244 sv = (SV*)POPPTR(ss,ix);
11245 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11246 ptr = POPPTR(ss,ix);
11247 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11249 case SAVEt_AV: /* array reference */
11250 av = (AV*)POPPTR(ss,ix);
11251 TOPPTR(nss,ix) = av_dup_inc(av, param);
11252 gv = (GV*)POPPTR(ss,ix);
11253 TOPPTR(nss,ix) = gv_dup(gv, param);
11255 case SAVEt_HV: /* hash reference */
11256 hv = (HV*)POPPTR(ss,ix);
11257 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11258 gv = (GV*)POPPTR(ss,ix);
11259 TOPPTR(nss,ix) = gv_dup(gv, param);
11261 case SAVEt_INT: /* int reference */
11262 ptr = POPPTR(ss,ix);
11263 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11264 intval = (int)POPINT(ss,ix);
11265 TOPINT(nss,ix) = intval;
11267 case SAVEt_LONG: /* long reference */
11268 ptr = POPPTR(ss,ix);
11269 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11270 longval = (long)POPLONG(ss,ix);
11271 TOPLONG(nss,ix) = longval;
11273 case SAVEt_I32: /* I32 reference */
11274 case SAVEt_I16: /* I16 reference */
11275 case SAVEt_I8: /* I8 reference */
11276 ptr = POPPTR(ss,ix);
11277 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11279 TOPINT(nss,ix) = i;
11281 case SAVEt_IV: /* IV reference */
11282 ptr = POPPTR(ss,ix);
11283 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11285 TOPIV(nss,ix) = iv;
11287 case SAVEt_SPTR: /* SV* reference */
11288 ptr = POPPTR(ss,ix);
11289 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11290 sv = (SV*)POPPTR(ss,ix);
11291 TOPPTR(nss,ix) = sv_dup(sv, param);
11293 case SAVEt_VPTR: /* random* reference */
11294 ptr = POPPTR(ss,ix);
11295 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11296 ptr = POPPTR(ss,ix);
11297 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11299 case SAVEt_PPTR: /* char* reference */
11300 ptr = POPPTR(ss,ix);
11301 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11302 c = (char*)POPPTR(ss,ix);
11303 TOPPTR(nss,ix) = pv_dup(c);
11305 case SAVEt_HPTR: /* HV* reference */
11306 ptr = POPPTR(ss,ix);
11307 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11308 hv = (HV*)POPPTR(ss,ix);
11309 TOPPTR(nss,ix) = hv_dup(hv, param);
11311 case SAVEt_APTR: /* AV* reference */
11312 ptr = POPPTR(ss,ix);
11313 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11314 av = (AV*)POPPTR(ss,ix);
11315 TOPPTR(nss,ix) = av_dup(av, param);
11318 gv = (GV*)POPPTR(ss,ix);
11319 TOPPTR(nss,ix) = gv_dup(gv, param);
11321 case SAVEt_GP: /* scalar reference */
11322 gp = (GP*)POPPTR(ss,ix);
11323 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
11324 (void)GpREFCNT_inc(gp);
11325 gv = (GV*)POPPTR(ss,ix);
11326 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
11327 c = (char*)POPPTR(ss,ix);
11328 TOPPTR(nss,ix) = pv_dup(c);
11330 TOPIV(nss,ix) = iv;
11332 TOPIV(nss,ix) = iv;
11335 case SAVEt_MORTALIZESV:
11336 sv = (SV*)POPPTR(ss,ix);
11337 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11340 ptr = POPPTR(ss,ix);
11341 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11342 /* these are assumed to be refcounted properly */
11343 switch (((OP*)ptr)->op_type) {
11345 case OP_LEAVESUBLV:
11349 case OP_LEAVEWRITE:
11350 TOPPTR(nss,ix) = ptr;
11355 TOPPTR(nss,ix) = Nullop;
11360 TOPPTR(nss,ix) = Nullop;
11363 c = (char*)POPPTR(ss,ix);
11364 TOPPTR(nss,ix) = pv_dup_inc(c);
11366 case SAVEt_CLEARSV:
11367 longval = POPLONG(ss,ix);
11368 TOPLONG(nss,ix) = longval;
11371 hv = (HV*)POPPTR(ss,ix);
11372 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11373 c = (char*)POPPTR(ss,ix);
11374 TOPPTR(nss,ix) = pv_dup_inc(c);
11376 TOPINT(nss,ix) = i;
11378 case SAVEt_DESTRUCTOR:
11379 ptr = POPPTR(ss,ix);
11380 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11381 dptr = POPDPTR(ss,ix);
11382 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
11384 case SAVEt_DESTRUCTOR_X:
11385 ptr = POPPTR(ss,ix);
11386 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11387 dxptr = POPDXPTR(ss,ix);
11388 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
11390 case SAVEt_REGCONTEXT:
11393 TOPINT(nss,ix) = i;
11396 case SAVEt_STACK_POS: /* Position on Perl stack */
11398 TOPINT(nss,ix) = i;
11400 case SAVEt_AELEM: /* array element */
11401 sv = (SV*)POPPTR(ss,ix);
11402 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11404 TOPINT(nss,ix) = i;
11405 av = (AV*)POPPTR(ss,ix);
11406 TOPPTR(nss,ix) = av_dup_inc(av, param);
11408 case SAVEt_HELEM: /* hash element */
11409 sv = (SV*)POPPTR(ss,ix);
11410 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11411 sv = (SV*)POPPTR(ss,ix);
11412 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
11413 hv = (HV*)POPPTR(ss,ix);
11414 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
11417 ptr = POPPTR(ss,ix);
11418 TOPPTR(nss,ix) = ptr;
11422 TOPINT(nss,ix) = i;
11424 case SAVEt_COMPPAD:
11425 av = (AV*)POPPTR(ss,ix);
11426 TOPPTR(nss,ix) = av_dup(av, param);
11429 longval = (long)POPLONG(ss,ix);
11430 TOPLONG(nss,ix) = longval;
11431 ptr = POPPTR(ss,ix);
11432 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11433 sv = (SV*)POPPTR(ss,ix);
11434 TOPPTR(nss,ix) = sv_dup(sv, param);
11437 ptr = POPPTR(ss,ix);
11438 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11439 longval = (long)POPBOOL(ss,ix);
11440 TOPBOOL(nss,ix) = (bool)longval;
11442 case SAVEt_SET_SVFLAGS:
11444 TOPINT(nss,ix) = i;
11446 TOPINT(nss,ix) = i;
11447 sv = (SV*)POPPTR(ss,ix);
11448 TOPPTR(nss,ix) = sv_dup(sv, param);
11451 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11459 =for apidoc perl_clone
11461 Create and return a new interpreter by cloning the current one.
11463 perl_clone takes these flags as parameters:
11465 CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11466 without it we only clone the data and zero the stacks,
11467 with it we copy the stacks and the new perl interpreter is
11468 ready to run at the exact same point as the previous one.
11469 The pseudo-fork code uses COPY_STACKS while the
11470 threads->new doesn't.
11472 CLONEf_KEEP_PTR_TABLE
11473 perl_clone keeps a ptr_table with the pointer of the old
11474 variable as a key and the new variable as a value,
11475 this allows it to check if something has been cloned and not
11476 clone it again but rather just use the value and increase the
11477 refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11478 the ptr_table using the function
11479 C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11480 reason to keep it around is if you want to dup some of your own
11481 variable who are outside the graph perl scans, example of this
11482 code is in threads.xs create
11485 This is a win32 thing, it is ignored on unix, it tells perls
11486 win32host code (which is c++) to clone itself, this is needed on
11487 win32 if you want to run two threads at the same time,
11488 if you just want to do some stuff in a separate perl interpreter
11489 and then throw it away and return to the original one,
11490 you don't need to do anything.
11495 /* XXX the above needs expanding by someone who actually understands it ! */
11496 EXTERN_C PerlInterpreter *
11497 perl_clone_host(PerlInterpreter* proto_perl, UV flags);
11500 perl_clone(PerlInterpreter *proto_perl, UV flags)
11502 #ifdef PERL_IMPLICIT_SYS
11504 /* perlhost.h so we need to call into it
11505 to clone the host, CPerlHost should have a c interface, sky */
11507 if (flags & CLONEf_CLONE_HOST) {
11508 return perl_clone_host(proto_perl,flags);
11510 return perl_clone_using(proto_perl, flags,
11512 proto_perl->IMemShared,
11513 proto_perl->IMemParse,
11515 proto_perl->IStdIO,
11519 proto_perl->IProc);
11523 perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11524 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11525 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11526 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11527 struct IPerlDir* ipD, struct IPerlSock* ipS,
11528 struct IPerlProc* ipP)
11530 /* XXX many of the string copies here can be optimized if they're
11531 * constants; they need to be allocated as common memory and just
11532 * their pointers copied. */
11535 CLONE_PARAMS clone_params;
11536 CLONE_PARAMS* param = &clone_params;
11538 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
11539 PERL_SET_THX(my_perl);
11542 Poison(my_perl, 1, PerlInterpreter);
11546 PL_savestack_ix = 0;
11547 PL_savestack_max = -1;
11548 PL_sig_pending = 0;
11549 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11550 # else /* !DEBUGGING */
11551 Zero(my_perl, 1, PerlInterpreter);
11552 # endif /* DEBUGGING */
11554 /* host pointers */
11556 PL_MemShared = ipMS;
11557 PL_MemParse = ipMP;
11564 #else /* !PERL_IMPLICIT_SYS */
11566 CLONE_PARAMS clone_params;
11567 CLONE_PARAMS* param = &clone_params;
11568 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
11569 PERL_SET_THX(my_perl);
11574 Poison(my_perl, 1, PerlInterpreter);
11578 PL_savestack_ix = 0;
11579 PL_savestack_max = -1;
11580 PL_sig_pending = 0;
11581 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
11582 # else /* !DEBUGGING */
11583 Zero(my_perl, 1, PerlInterpreter);
11584 # endif /* DEBUGGING */
11585 #endif /* PERL_IMPLICIT_SYS */
11586 param->flags = flags;
11587 param->proto_perl = proto_perl;
11590 PL_xiv_arenaroot = NULL;
11591 PL_xiv_root = NULL;
11592 PL_xnv_arenaroot = NULL;
11593 PL_xnv_root = NULL;
11594 PL_xrv_arenaroot = NULL;
11595 PL_xrv_root = NULL;
11596 PL_xpv_arenaroot = NULL;
11597 PL_xpv_root = NULL;
11598 PL_xpviv_arenaroot = NULL;
11599 PL_xpviv_root = NULL;
11600 PL_xpvnv_arenaroot = NULL;
11601 PL_xpvnv_root = NULL;
11602 PL_xpvcv_arenaroot = NULL;
11603 PL_xpvcv_root = NULL;
11604 PL_xpvav_arenaroot = NULL;
11605 PL_xpvav_root = NULL;
11606 PL_xpvhv_arenaroot = NULL;
11607 PL_xpvhv_root = NULL;
11608 PL_xpvmg_arenaroot = NULL;
11609 PL_xpvmg_root = NULL;
11610 PL_xpvlv_arenaroot = NULL;
11611 PL_xpvlv_root = NULL;
11612 PL_xpvbm_arenaroot = NULL;
11613 PL_xpvbm_root = NULL;
11614 PL_he_arenaroot = NULL;
11616 PL_nice_chunk = NULL;
11617 PL_nice_chunk_size = 0;
11619 PL_sv_objcount = 0;
11620 PL_sv_root = Nullsv;
11621 PL_sv_arenaroot = Nullsv;
11623 PL_debug = proto_perl->Idebug;
11625 #ifdef USE_REENTRANT_API
11626 /* XXX: things like -Dm will segfault here in perlio, but doing
11627 * PERL_SET_CONTEXT(proto_perl);
11628 * breaks too many other things
11630 Perl_reentrant_init(aTHX);
11633 /* create SV map for pointer relocation */
11634 PL_ptr_table = ptr_table_new();
11636 /* initialize these special pointers as early as possible */
11637 SvANY(&PL_sv_undef) = NULL;
11638 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11639 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11640 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11642 SvANY(&PL_sv_no) = new_XPVNV();
11643 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
11644 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11645 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11646 SvPVX(&PL_sv_no) = SAVEPVN(PL_No, 0);
11647 SvCUR(&PL_sv_no) = 0;
11648 SvLEN(&PL_sv_no) = 1;
11649 SvIVX(&PL_sv_no) = 0;
11650 SvNVX(&PL_sv_no) = 0;
11651 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11653 SvANY(&PL_sv_yes) = new_XPVNV();
11654 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
11655 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11656 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
11657 SvPVX(&PL_sv_yes) = SAVEPVN(PL_Yes, 1);
11658 SvCUR(&PL_sv_yes) = 1;
11659 SvLEN(&PL_sv_yes) = 2;
11660 SvIVX(&PL_sv_yes) = 1;
11661 SvNVX(&PL_sv_yes) = 1;
11662 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11664 /* create (a non-shared!) shared string table */
11665 PL_strtab = newHV();
11666 HvSHAREKEYS_off(PL_strtab);
11667 hv_ksplit(PL_strtab, 512);
11668 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11670 PL_compiling = proto_perl->Icompiling;
11672 /* These two PVs will be free'd special way so must set them same way op.c does */
11673 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11674 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11676 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11677 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11679 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11680 if (!specialWARN(PL_compiling.cop_warnings))
11681 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
11682 if (!specialCopIO(PL_compiling.cop_io))
11683 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
11684 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11686 /* pseudo environmental stuff */
11687 PL_origargc = proto_perl->Iorigargc;
11688 PL_origargv = proto_perl->Iorigargv;
11690 param->stashes = newAV(); /* Setup array of objects to call clone on */
11692 #ifdef PERLIO_LAYERS
11693 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11694 PerlIO_clone(aTHX_ proto_perl, param);
11697 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11698 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11699 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
11700 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
11701 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11702 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
11705 PL_minus_c = proto_perl->Iminus_c;
11706 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
11707 PL_localpatches = proto_perl->Ilocalpatches;
11708 PL_splitstr = proto_perl->Isplitstr;
11709 PL_preprocess = proto_perl->Ipreprocess;
11710 PL_minus_n = proto_perl->Iminus_n;
11711 PL_minus_p = proto_perl->Iminus_p;
11712 PL_minus_l = proto_perl->Iminus_l;
11713 PL_minus_a = proto_perl->Iminus_a;
11714 PL_minus_F = proto_perl->Iminus_F;
11715 PL_doswitches = proto_perl->Idoswitches;
11716 PL_dowarn = proto_perl->Idowarn;
11717 PL_doextract = proto_perl->Idoextract;
11718 PL_sawampersand = proto_perl->Isawampersand;
11719 PL_unsafe = proto_perl->Iunsafe;
11720 PL_inplace = SAVEPV(proto_perl->Iinplace);
11721 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
11722 PL_perldb = proto_perl->Iperldb;
11723 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
11724 PL_exit_flags = proto_perl->Iexit_flags;
11726 /* magical thingies */
11727 /* XXX time(&PL_basetime) when asked for? */
11728 PL_basetime = proto_perl->Ibasetime;
11729 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
11731 PL_maxsysfd = proto_perl->Imaxsysfd;
11732 PL_multiline = proto_perl->Imultiline;
11733 PL_statusvalue = proto_perl->Istatusvalue;
11735 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11737 PL_encoding = sv_dup(proto_perl->Iencoding, param);
11739 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
11740 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11741 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
11743 /* Clone the regex array */
11744 PL_regex_padav = newAV();
11746 I32 len = av_len((AV*)proto_perl->Iregex_padav);
11747 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
11748 av_push(PL_regex_padav,
11749 sv_dup_inc(regexen[0],param));
11750 for(i = 1; i <= len; i++) {
11751 if(SvREPADTMP(regexen[i])) {
11752 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
11754 av_push(PL_regex_padav,
11756 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
11757 SvIVX(regexen[i])), param)))
11762 PL_regex_pad = AvARRAY(PL_regex_padav);
11764 /* shortcuts to various I/O objects */
11765 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11766 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11767 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11768 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11769 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11770 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
11772 /* shortcuts to regexp stuff */
11773 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
11775 /* shortcuts to misc objects */
11776 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
11778 /* shortcuts to debugging objects */
11779 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11780 PL_DBline = gv_dup(proto_perl->IDBline, param);
11781 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11782 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11783 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11784 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
11785 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
11786 PL_lineary = av_dup(proto_perl->Ilineary, param);
11787 PL_dbargs = av_dup(proto_perl->Idbargs, param);
11789 /* symbol tables */
11790 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11791 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
11792 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11793 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11794 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11796 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
11797 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
11798 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
11799 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11800 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11801 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
11803 PL_sub_generation = proto_perl->Isub_generation;
11805 /* funky return mechanisms */
11806 PL_forkprocess = proto_perl->Iforkprocess;
11808 /* subprocess state */
11809 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
11811 /* internal state */
11812 PL_tainting = proto_perl->Itainting;
11813 PL_taint_warn = proto_perl->Itaint_warn;
11814 PL_maxo = proto_perl->Imaxo;
11815 if (proto_perl->Iop_mask)
11816 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11818 PL_op_mask = Nullch;
11819 /* PL_asserting = proto_perl->Iasserting; */
11821 /* current interpreter roots */
11822 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
11823 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11824 PL_main_start = proto_perl->Imain_start;
11825 PL_eval_root = proto_perl->Ieval_root;
11826 PL_eval_start = proto_perl->Ieval_start;
11828 /* runtime control stuff */
11829 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11830 PL_copline = proto_perl->Icopline;
11832 PL_filemode = proto_perl->Ifilemode;
11833 PL_lastfd = proto_perl->Ilastfd;
11834 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11837 PL_gensym = proto_perl->Igensym;
11838 PL_preambled = proto_perl->Ipreambled;
11839 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
11840 PL_laststatval = proto_perl->Ilaststatval;
11841 PL_laststype = proto_perl->Ilaststype;
11842 PL_mess_sv = Nullsv;
11844 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
11845 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11847 /* interpreter atexit processing */
11848 PL_exitlistlen = proto_perl->Iexitlistlen;
11849 if (PL_exitlistlen) {
11850 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11851 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11854 PL_exitlist = (PerlExitListEntry*)NULL;
11855 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
11856 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11857 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
11859 PL_profiledata = NULL;
11860 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
11861 /* PL_rsfp_filters entries have fake IoDIRP() */
11862 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
11864 PL_compcv = cv_dup(proto_perl->Icompcv, param);
11866 PAD_CLONE_VARS(proto_perl, param);
11868 #ifdef HAVE_INTERP_INTERN
11869 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11872 /* more statics moved here */
11873 PL_generation = proto_perl->Igeneration;
11874 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
11876 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11877 PL_in_clean_all = proto_perl->Iin_clean_all;
11879 PL_uid = proto_perl->Iuid;
11880 PL_euid = proto_perl->Ieuid;
11881 PL_gid = proto_perl->Igid;
11882 PL_egid = proto_perl->Iegid;
11883 PL_nomemok = proto_perl->Inomemok;
11884 PL_an = proto_perl->Ian;
11885 PL_evalseq = proto_perl->Ievalseq;
11886 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11887 PL_origalen = proto_perl->Iorigalen;
11888 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11889 PL_osname = SAVEPV(proto_perl->Iosname);
11890 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
11891 PL_sighandlerp = proto_perl->Isighandlerp;
11894 PL_runops = proto_perl->Irunops;
11896 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11899 PL_cshlen = proto_perl->Icshlen;
11900 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
11903 PL_lex_state = proto_perl->Ilex_state;
11904 PL_lex_defer = proto_perl->Ilex_defer;
11905 PL_lex_expect = proto_perl->Ilex_expect;
11906 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11907 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11908 PL_lex_starts = proto_perl->Ilex_starts;
11909 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11910 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
11911 PL_lex_op = proto_perl->Ilex_op;
11912 PL_lex_inpat = proto_perl->Ilex_inpat;
11913 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11914 PL_lex_brackets = proto_perl->Ilex_brackets;
11915 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11916 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11917 PL_lex_casemods = proto_perl->Ilex_casemods;
11918 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11919 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11921 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11922 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11923 PL_nexttoke = proto_perl->Inexttoke;
11925 /* XXX This is probably masking the deeper issue of why
11926 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11927 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11928 * (A little debugging with a watchpoint on it may help.)
11930 if (SvANY(proto_perl->Ilinestr)) {
11931 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11932 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
11933 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11934 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
11935 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11936 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
11937 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11938 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
11939 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11942 PL_linestr = NEWSV(65,79);
11943 sv_upgrade(PL_linestr,SVt_PVIV);
11944 sv_setpvn(PL_linestr,"",0);
11945 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11947 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
11948 PL_pending_ident = proto_perl->Ipending_ident;
11949 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11951 PL_expect = proto_perl->Iexpect;
11953 PL_multi_start = proto_perl->Imulti_start;
11954 PL_multi_end = proto_perl->Imulti_end;
11955 PL_multi_open = proto_perl->Imulti_open;
11956 PL_multi_close = proto_perl->Imulti_close;
11958 PL_error_count = proto_perl->Ierror_count;
11959 PL_subline = proto_perl->Isubline;
11960 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
11962 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
11963 if (SvANY(proto_perl->Ilinestr)) {
11964 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
11965 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11966 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
11967 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11968 PL_last_lop_op = proto_perl->Ilast_lop_op;
11971 PL_last_uni = SvPVX(PL_linestr);
11972 PL_last_lop = SvPVX(PL_linestr);
11973 PL_last_lop_op = 0;
11975 PL_in_my = proto_perl->Iin_my;
11976 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
11978 PL_cryptseen = proto_perl->Icryptseen;
11981 PL_hints = proto_perl->Ihints;
11983 PL_amagic_generation = proto_perl->Iamagic_generation;
11985 #ifdef USE_LOCALE_COLLATE
11986 PL_collation_ix = proto_perl->Icollation_ix;
11987 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11988 PL_collation_standard = proto_perl->Icollation_standard;
11989 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11990 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11991 #endif /* USE_LOCALE_COLLATE */
11993 #ifdef USE_LOCALE_NUMERIC
11994 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11995 PL_numeric_standard = proto_perl->Inumeric_standard;
11996 PL_numeric_local = proto_perl->Inumeric_local;
11997 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
11998 #endif /* !USE_LOCALE_NUMERIC */
12000 /* utf8 character classes */
12001 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
12002 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
12003 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
12004 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
12005 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
12006 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
12007 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
12008 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
12009 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
12010 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
12011 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
12012 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
12013 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
12014 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
12015 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
12016 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
12017 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
12018 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
12019 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
12020 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
12022 /* Did the locale setup indicate UTF-8? */
12023 PL_utf8locale = proto_perl->Iutf8locale;
12024 /* Unicode features (see perlrun/-C) */
12025 PL_unicode = proto_perl->Iunicode;
12027 /* Pre-5.8 signals control */
12028 PL_signals = proto_perl->Isignals;
12030 /* times() ticks per second */
12031 PL_clocktick = proto_perl->Iclocktick;
12033 /* Recursion stopper for PerlIO_find_layer */
12034 PL_in_load_module = proto_perl->Iin_load_module;
12036 /* sort() routine */
12037 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
12039 /* Not really needed/useful since the reenrant_retint is "volatile",
12040 * but do it for consistency's sake. */
12041 PL_reentrant_retint = proto_perl->Ireentrant_retint;
12043 /* Hooks to shared SVs and locks. */
12044 PL_sharehook = proto_perl->Isharehook;
12045 PL_lockhook = proto_perl->Ilockhook;
12046 PL_unlockhook = proto_perl->Iunlockhook;
12047 PL_threadhook = proto_perl->Ithreadhook;
12049 PL_runops_std = proto_perl->Irunops_std;
12050 PL_runops_dbg = proto_perl->Irunops_dbg;
12052 #ifdef THREADS_HAVE_PIDS
12053 PL_ppid = proto_perl->Ippid;
12057 PL_last_swash_hv = Nullhv; /* reinits on demand */
12058 PL_last_swash_klen = 0;
12059 PL_last_swash_key[0]= '\0';
12060 PL_last_swash_tmps = (U8*)NULL;
12061 PL_last_swash_slen = 0;
12063 PL_glob_index = proto_perl->Iglob_index;
12064 PL_srand_called = proto_perl->Isrand_called;
12065 PL_hash_seed = proto_perl->Ihash_seed;
12066 PL_rehash_seed = proto_perl->Irehash_seed;
12067 PL_uudmap['M'] = 0; /* reinits on demand */
12068 PL_bitcount = Nullch; /* reinits on demand */
12070 if (proto_perl->Ipsig_pend) {
12071 Newz(0, PL_psig_pend, SIG_SIZE, int);
12074 PL_psig_pend = (int*)NULL;
12077 if (proto_perl->Ipsig_ptr) {
12078 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
12079 Newz(0, PL_psig_name, SIG_SIZE, SV*);
12080 for (i = 1; i < SIG_SIZE; i++) {
12081 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
12082 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
12086 PL_psig_ptr = (SV**)NULL;
12087 PL_psig_name = (SV**)NULL;
12090 /* thrdvar.h stuff */
12092 if (flags & CLONEf_COPY_STACKS) {
12093 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12094 PL_tmps_ix = proto_perl->Ttmps_ix;
12095 PL_tmps_max = proto_perl->Ttmps_max;
12096 PL_tmps_floor = proto_perl->Ttmps_floor;
12097 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
12099 while (i <= PL_tmps_ix) {
12100 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
12104 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
12105 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
12106 Newz(54, PL_markstack, i, I32);
12107 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
12108 - proto_perl->Tmarkstack);
12109 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
12110 - proto_perl->Tmarkstack);
12111 Copy(proto_perl->Tmarkstack, PL_markstack,
12112 PL_markstack_ptr - PL_markstack + 1, I32);
12114 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12115 * NOTE: unlike the others! */
12116 PL_scopestack_ix = proto_perl->Tscopestack_ix;
12117 PL_scopestack_max = proto_perl->Tscopestack_max;
12118 Newz(54, PL_scopestack, PL_scopestack_max, I32);
12119 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
12121 /* NOTE: si_dup() looks at PL_markstack */
12122 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
12124 /* PL_curstack = PL_curstackinfo->si_stack; */
12125 PL_curstack = av_dup(proto_perl->Tcurstack, param);
12126 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
12128 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12129 PL_stack_base = AvARRAY(PL_curstack);
12130 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
12131 - proto_perl->Tstack_base);
12132 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12134 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12135 * NOTE: unlike the others! */
12136 PL_savestack_ix = proto_perl->Tsavestack_ix;
12137 PL_savestack_max = proto_perl->Tsavestack_max;
12138 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
12139 PL_savestack = ss_dup(proto_perl, param);
12143 ENTER; /* perl_destruct() wants to LEAVE; */
12146 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
12147 PL_top_env = &PL_start_env;
12149 PL_op = proto_perl->Top;
12152 PL_Xpv = (XPV*)NULL;
12153 PL_na = proto_perl->Tna;
12155 PL_statbuf = proto_perl->Tstatbuf;
12156 PL_statcache = proto_perl->Tstatcache;
12157 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
12158 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
12160 PL_timesbuf = proto_perl->Ttimesbuf;
12163 PL_tainted = proto_perl->Ttainted;
12164 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
12165 PL_rs = sv_dup_inc(proto_perl->Trs, param);
12166 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
12167 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
12168 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
12169 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
12170 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
12171 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
12172 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
12174 PL_restartop = proto_perl->Trestartop;
12175 PL_in_eval = proto_perl->Tin_eval;
12176 PL_delaymagic = proto_perl->Tdelaymagic;
12177 PL_dirty = proto_perl->Tdirty;
12178 PL_localizing = proto_perl->Tlocalizing;
12180 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
12181 PL_hv_fetch_ent_mh = Nullhe;
12182 PL_modcount = proto_perl->Tmodcount;
12183 PL_lastgotoprobe = Nullop;
12184 PL_dumpindent = proto_perl->Tdumpindent;
12186 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
12187 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
12188 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
12189 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
12190 PL_sortcxix = proto_perl->Tsortcxix;
12191 PL_efloatbuf = Nullch; /* reinits on demand */
12192 PL_efloatsize = 0; /* reinits on demand */
12196 PL_screamfirst = NULL;
12197 PL_screamnext = NULL;
12198 PL_maxscream = -1; /* reinits on demand */
12199 PL_lastscream = Nullsv;
12201 PL_watchaddr = NULL;
12202 PL_watchok = Nullch;
12204 PL_regdummy = proto_perl->Tregdummy;
12205 PL_regprecomp = Nullch;
12208 PL_colorset = 0; /* reinits PL_colors[] */
12209 /*PL_colors[6] = {0,0,0,0,0,0};*/
12210 PL_reginput = Nullch;
12211 PL_regbol = Nullch;
12212 PL_regeol = Nullch;
12213 PL_regstartp = (I32*)NULL;
12214 PL_regendp = (I32*)NULL;
12215 PL_reglastparen = (U32*)NULL;
12216 PL_reglastcloseparen = (U32*)NULL;
12217 PL_regtill = Nullch;
12218 PL_reg_start_tmp = (char**)NULL;
12219 PL_reg_start_tmpl = 0;
12220 PL_regdata = (struct reg_data*)NULL;
12223 PL_reg_eval_set = 0;
12225 PL_regprogram = (regnode*)NULL;
12227 PL_regcc = (CURCUR*)NULL;
12228 PL_reg_call_cc = (struct re_cc_state*)NULL;
12229 PL_reg_re = (regexp*)NULL;
12230 PL_reg_ganch = Nullch;
12231 PL_reg_sv = Nullsv;
12232 PL_reg_match_utf8 = FALSE;
12233 PL_reg_magic = (MAGIC*)NULL;
12235 PL_reg_oldcurpm = (PMOP*)NULL;
12236 PL_reg_curpm = (PMOP*)NULL;
12237 PL_reg_oldsaved = Nullch;
12238 PL_reg_oldsavedlen = 0;
12239 #ifdef PERL_COPY_ON_WRITE
12242 PL_reg_maxiter = 0;
12243 PL_reg_leftiter = 0;
12244 PL_reg_poscache = Nullch;
12245 PL_reg_poscache_size= 0;
12247 /* RE engine - function pointers */
12248 PL_regcompp = proto_perl->Tregcompp;
12249 PL_regexecp = proto_perl->Tregexecp;
12250 PL_regint_start = proto_perl->Tregint_start;
12251 PL_regint_string = proto_perl->Tregint_string;
12252 PL_regfree = proto_perl->Tregfree;
12254 PL_reginterp_cnt = 0;
12255 PL_reg_starttry = 0;
12257 /* Pluggable optimizer */
12258 PL_peepp = proto_perl->Tpeepp;
12260 PL_stashcache = newHV();
12262 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12263 ptr_table_free(PL_ptr_table);
12264 PL_ptr_table = NULL;
12267 /* Call the ->CLONE method, if it exists, for each of the stashes
12268 identified by sv_dup() above.
12270 while(av_len(param->stashes) != -1) {
12271 HV* stash = (HV*) av_shift(param->stashes);
12272 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12273 if (cloner && GvCV(cloner)) {
12278 XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
12280 call_sv((SV*)GvCV(cloner), G_DISCARD);
12286 SvREFCNT_dec(param->stashes);
12291 #endif /* USE_ITHREADS */
12294 =head1 Unicode Support
12296 =for apidoc sv_recode_to_utf8
12298 The encoding is assumed to be an Encode object, on entry the PV
12299 of the sv is assumed to be octets in that encoding, and the sv
12300 will be converted into Unicode (and UTF-8).
12302 If the sv already is UTF-8 (or if it is not POK), or if the encoding
12303 is not a reference, nothing is done to the sv. If the encoding is not
12304 an C<Encode::XS> Encoding object, bad things will happen.
12305 (See F<lib/encoding.pm> and L<Encode>).
12307 The PV of the sv is returned.
12312 Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12314 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
12328 Passing sv_yes is wrong - it needs to be or'ed set of constants
12329 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
12330 remove converted chars from source.
12332 Both will default the value - let them.
12334 XPUSHs(&PL_sv_yes);
12337 call_method("decode", G_SCALAR);
12341 s = SvPV(uni, len);
12342 if (s != SvPVX(sv)) {
12343 SvGROW(sv, len + 1);
12344 Move(s, SvPVX(sv), len, char);
12345 SvCUR_set(sv, len);
12346 SvPVX(sv)[len] = 0;
12353 return SvPOKp(sv) ? SvPVX(sv) : NULL;
12357 =for apidoc sv_cat_decode
12359 The encoding is assumed to be an Encode object, the PV of the ssv is
12360 assumed to be octets in that encoding and decoding the input starts
12361 from the position which (PV + *offset) pointed to. The dsv will be
12362 concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12363 when the string tstr appears in decoding output or the input ends on
12364 the PV of the ssv. The value which the offset points will be modified
12365 to the last input position on the ssv.
12367 Returns TRUE if the terminator was found, else returns FALSE.
12372 Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12373 SV *ssv, int *offset, char *tstr, int tlen)
12376 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
12387 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12388 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12390 call_method("cat_decode", G_SCALAR);
12392 ret = SvTRUE(TOPs);
12393 *offset = SvIV(offsv);
12399 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12405 * c-indentation-style: bsd
12406 * c-basic-offset: 4
12407 * indent-tabs-mode: t
12410 * vim: shiftwidth=4: