This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Improve FindBin discovery of current directory, based on :
[perl5.git] / sv.c
CommitLineData
a0d0e21e 1/* sv.c
79072805 2 *
4bb101f2 3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
241d1a3b 4 * 2000, 2001, 2002, 2003, 2004, 2005, by Larry Wall and others
79072805
LW
5 *
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.
8 *
a0d0e21e 9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
645c22ef
DM
10 *
11 *
5e045b90
AMS
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
17 * in the pp*.c files.
79072805
LW
18 */
19
20#include "EXTERN.h"
864dbfa3 21#define PERL_IN_SV_C
79072805 22#include "perl.h"
d2f185dc 23#include "regcomp.h"
79072805 24
51371543 25#define FCALL *f
2c5424a7 26
2f8ed50e
OS
27#ifdef __Lynx__
28/* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
30#endif
31
e23c8137
JH
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
42 * --jhi
43 */
44#define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
46#else
47#define ASSERT_UTF8_CACHE(cache) NOOP
48#endif
49
765f542d
NC
50#ifdef PERL_COPY_ON_WRITE
51#define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
607fa7f2 52#define SV_COW_NEXT_SV_SET(current,next) SvUV_set(current, PTR2UV(next))
b5ccf5f2 53/* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
765f542d 54 on-write. */
765f542d 55#endif
645c22ef
DM
56
57/* ============================================================================
58
59=head1 Allocation and deallocation of SVs.
60
5e045b90
AMS
61An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62av, hv...) contains type and reference count information, as well as a
63pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64specific to each type.
65
4977e971
NC
66Normally, this allocation is done using arenas, which by default are
67approximately 4K chunks of memory parcelled up into N heads or bodies. The
68first slot in each arena is reserved, and is used to hold a link to the next
69arena. In the case of heads, the unused first slot also contains some flags
70and a note of the number of slots. Snaked through each arena chain is a
5e045b90 71linked list of free items; when this becomes empty, an extra arena is
4977e971 72allocated and divided up into N items which are threaded into the free list.
645c22ef
DM
73
74The following global variables are associated with arenas:
75
76 PL_sv_arenaroot pointer to list of SV arenas
77 PL_sv_root pointer to list of free SV structures
78
79 PL_foo_arenaroot pointer to list of foo arenas,
80 PL_foo_root pointer to list of free foo bodies
81 ... for foo in xiv, xnv, xrv, xpv etc.
82
83Note that some of the larger and more rarely used body types (eg xpvio)
84are not allocated using arenas, but are instead just malloc()/free()ed as
85required. Also, if PURIFY is defined, arenas are abandoned altogether,
86with all items individually malloc()ed. In addition, a few SV heads are
87not allocated from an arena, but are instead directly created as static
4977e971
NC
88or auto variables, eg PL_sv_undef. The size of arenas can be changed from
89the default by setting PERL_ARENA_SIZE appropriately at compile time.
645c22ef
DM
90
91The SV arena serves the secondary purpose of allowing still-live SVs
92to be located and destroyed during final cleanup.
93
94At the lowest level, the macros new_SV() and del_SV() grab and free
95an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
96to return the SV to the free list with error checking.) new_SV() calls
97more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
98SVs in the free list have their SvTYPE field set to all ones.
99
100Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
101that allocate and return individual body types. Normally these are mapped
ff276b08
RG
102to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
103instead mapped directly to malloc()/free() if PURIFY is defined. The
645c22ef
DM
104new/del functions remove from, or add to, the appropriate PL_foo_root
105list, and call more_xiv() etc to add a new arena if the list is empty.
106
ff276b08 107At the time of very final cleanup, sv_free_arenas() is called from
645c22ef
DM
108perl_destruct() to physically free all the arenas allocated since the
109start of the interpreter. Note that this also clears PL_he_arenaroot,
110which is otherwise dealt with in hv.c.
111
112Manipulation of any of the PL_*root pointers is protected by enclosing
113LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
114if threads are enabled.
115
116The function visit() scans the SV arenas list, and calls a specified
117function for each SV it finds which is still live - ie which has an SvTYPE
118other than all 1's, and a non-zero SvREFCNT. visit() is used by the
119following functions (specified as [function that calls visit()] / [function
120called by visit() for each SV]):
121
122 sv_report_used() / do_report_used()
123 dump all remaining SVs (debugging aid)
124
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()
131 below.
132
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.
142
143=head2 Summary
144
145Private API to rest of sv.c
146
147 new_SV(), del_SV(),
148
149 new_XIV(), del_XIV(),
150 new_XNV(), del_XNV(),
151 etc
152
153Public API:
154
8cf8f3d1 155 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
645c22ef
DM
156
157
158=cut
159
160============================================================================ */
161
162
51371543 163
4561caa4
CS
164/*
165 * "A time to plant, and a time to uproot what was planted..."
166 */
167
cac9b346 168
fd0854ff
DM
169#ifdef DEBUG_LEAKING_SCALARS
170# ifdef NETWARE
171# define FREE_SV_DEBUG_FILE(sv) PerlMemfree((sv)->sv_debug_file)
172# else
173# define FREE_SV_DEBUG_FILE(sv) PerlMemShared_free((sv)->sv_debug_file)
174# endif
175#else
176# define FREE_SV_DEBUG_FILE(sv)
177#endif
178
053fc874
GS
179#define plant_SV(p) \
180 STMT_START { \
fd0854ff 181 FREE_SV_DEBUG_FILE(p); \
053fc874
GS
182 SvANY(p) = (void *)PL_sv_root; \
183 SvFLAGS(p) = SVTYPEMASK; \
184 PL_sv_root = (p); \
185 --PL_sv_count; \
186 } STMT_END
a0d0e21e 187
fba3b22e 188/* sv_mutex must be held while calling uproot_SV() */
053fc874
GS
189#define uproot_SV(p) \
190 STMT_START { \
191 (p) = PL_sv_root; \
192 PL_sv_root = (SV*)SvANY(p); \
193 ++PL_sv_count; \
194 } STMT_END
195
645c22ef 196
cac9b346
NC
197/* make some more SVs by adding another arena */
198
199/* sv_mutex must be held while calling more_sv() */
200STATIC SV*
201S_more_sv(pTHX)
202{
203 SV* sv;
204
205 if (PL_nice_chunk) {
206 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
207 PL_nice_chunk = Nullch;
208 PL_nice_chunk_size = 0;
209 }
210 else {
211 char *chunk; /* must use New here to match call to */
2e7ed132
NC
212 New(704,chunk,PERL_ARENA_SIZE,char); /* Safefree() in sv_free_arenas() */
213 sv_add_arena(chunk, PERL_ARENA_SIZE, 0);
cac9b346
NC
214 }
215 uproot_SV(sv);
216 return sv;
217}
218
645c22ef
DM
219/* new_SV(): return a new, empty SV head */
220
eba0f806
DM
221#ifdef DEBUG_LEAKING_SCALARS
222/* provide a real function for a debugger to play with */
223STATIC SV*
224S_new_SV(pTHX)
225{
226 SV* sv;
227
228 LOCK_SV_MUTEX;
229 if (PL_sv_root)
230 uproot_SV(sv);
231 else
cac9b346 232 sv = S_more_sv(aTHX);
eba0f806
DM
233 UNLOCK_SV_MUTEX;
234 SvANY(sv) = 0;
235 SvREFCNT(sv) = 1;
236 SvFLAGS(sv) = 0;
fd0854ff
DM
237 sv->sv_debug_optype = PL_op ? PL_op->op_type : 0;
238 sv->sv_debug_line = (U16) ((PL_copline == NOLINE) ?
239 (PL_curcop ? CopLINE(PL_curcop) : 0) : PL_copline);
240 sv->sv_debug_inpad = 0;
241 sv->sv_debug_cloned = 0;
242# ifdef NETWARE
243 sv->sv_debug_file = PL_curcop ? savepv(CopFILE(PL_curcop)): NULL;
244# else
245 sv->sv_debug_file = PL_curcop ? savesharedpv(CopFILE(PL_curcop)): NULL;
246# endif
247
eba0f806
DM
248 return sv;
249}
250# define new_SV(p) (p)=S_new_SV(aTHX)
251
252#else
253# define new_SV(p) \
053fc874
GS
254 STMT_START { \
255 LOCK_SV_MUTEX; \
256 if (PL_sv_root) \
257 uproot_SV(p); \
258 else \
cac9b346 259 (p) = S_more_sv(aTHX); \
053fc874
GS
260 UNLOCK_SV_MUTEX; \
261 SvANY(p) = 0; \
262 SvREFCNT(p) = 1; \
263 SvFLAGS(p) = 0; \
264 } STMT_END
eba0f806 265#endif
463ee0b2 266
645c22ef
DM
267
268/* del_SV(): return an empty SV head to the free list */
269
a0d0e21e 270#ifdef DEBUGGING
4561caa4 271
053fc874
GS
272#define del_SV(p) \
273 STMT_START { \
274 LOCK_SV_MUTEX; \
aea4f609 275 if (DEBUG_D_TEST) \
053fc874
GS
276 del_sv(p); \
277 else \
278 plant_SV(p); \
279 UNLOCK_SV_MUTEX; \
280 } STMT_END
a0d0e21e 281
76e3520e 282STATIC void
cea2e8a9 283S_del_sv(pTHX_ SV *p)
463ee0b2 284{
aea4f609 285 if (DEBUG_D_TEST) {
4633a7c4 286 SV* sva;
a3b680e6 287 bool ok = 0;
3280af22 288 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
a3b680e6
AL
289 SV *sv = sva + 1;
290 SV *svend = &sva[SvREFCNT(sva)];
c0ff570e 291 if (p >= sv && p < svend) {
a0d0e21e 292 ok = 1;
c0ff570e
NC
293 break;
294 }
a0d0e21e
LW
295 }
296 if (!ok) {
0453d815 297 if (ckWARN_d(WARN_INTERNAL))
9014280d 298 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
472d47bc
SB
299 "Attempt to free non-arena SV: 0x%"UVxf
300 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
a0d0e21e
LW
301 return;
302 }
303 }
4561caa4 304 plant_SV(p);
463ee0b2 305}
a0d0e21e 306
4561caa4
CS
307#else /* ! DEBUGGING */
308
309#define del_SV(p) plant_SV(p)
310
311#endif /* DEBUGGING */
463ee0b2 312
645c22ef
DM
313
314/*
ccfc67b7
JH
315=head1 SV Manipulation Functions
316
645c22ef
DM
317=for apidoc sv_add_arena
318
319Given a chunk of memory, link it to the head of the list of arenas,
320and split it into a list of free SVs.
321
322=cut
323*/
324
4633a7c4 325void
864dbfa3 326Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
463ee0b2 327{
4633a7c4 328 SV* sva = (SV*)ptr;
463ee0b2
LW
329 register SV* sv;
330 register SV* svend;
4633a7c4
LW
331
332 /* The first SV in an arena isn't an SV. */
3280af22 333 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
4633a7c4
LW
334 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
335 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
336
3280af22
NIS
337 PL_sv_arenaroot = sva;
338 PL_sv_root = sva + 1;
4633a7c4
LW
339
340 svend = &sva[SvREFCNT(sva) - 1];
341 sv = sva + 1;
463ee0b2 342 while (sv < svend) {
a0d0e21e 343 SvANY(sv) = (void *)(SV*)(sv + 1);
03e36789 344#ifdef DEBUGGING
978b032e 345 SvREFCNT(sv) = 0;
03e36789
NC
346#endif
347 /* Must always set typemask because it's awlays checked in on cleanup
348 when the arenas are walked looking for objects. */
8990e307 349 SvFLAGS(sv) = SVTYPEMASK;
463ee0b2
LW
350 sv++;
351 }
352 SvANY(sv) = 0;
03e36789
NC
353#ifdef DEBUGGING
354 SvREFCNT(sv) = 0;
355#endif
4633a7c4
LW
356 SvFLAGS(sv) = SVTYPEMASK;
357}
358
055972dc
DM
359/* visit(): call the named function for each non-free SV in the arenas
360 * whose flags field matches the flags/mask args. */
645c22ef 361
5226ed68 362STATIC I32
055972dc 363S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
8990e307 364{
4633a7c4 365 SV* sva;
5226ed68 366 I32 visited = 0;
8990e307 367
3280af22 368 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
a3b680e6
AL
369 register SV * const svend = &sva[SvREFCNT(sva)];
370 register SV* sv;
4561caa4 371 for (sv = sva + 1; sv < svend; ++sv) {
055972dc
DM
372 if (SvTYPE(sv) != SVTYPEMASK
373 && (sv->sv_flags & mask) == flags
374 && SvREFCNT(sv))
375 {
acfe0abc 376 (FCALL)(aTHX_ sv);
5226ed68
JH
377 ++visited;
378 }
8990e307
LW
379 }
380 }
5226ed68 381 return visited;
8990e307
LW
382}
383
758a08c3
JH
384#ifdef DEBUGGING
385
645c22ef
DM
386/* called by sv_report_used() for each live SV */
387
388static void
acfe0abc 389do_report_used(pTHX_ SV *sv)
645c22ef
DM
390{
391 if (SvTYPE(sv) != SVTYPEMASK) {
392 PerlIO_printf(Perl_debug_log, "****\n");
393 sv_dump(sv);
394 }
395}
758a08c3 396#endif
645c22ef
DM
397
398/*
399=for apidoc sv_report_used
400
401Dump the contents of all SVs not yet freed. (Debugging aid).
402
403=cut
404*/
405
8990e307 406void
864dbfa3 407Perl_sv_report_used(pTHX)
4561caa4 408{
ff270d3a 409#ifdef DEBUGGING
055972dc 410 visit(do_report_used, 0, 0);
ff270d3a 411#endif
4561caa4
CS
412}
413
645c22ef
DM
414/* called by sv_clean_objs() for each live SV */
415
416static void
acfe0abc 417do_clean_objs(pTHX_ SV *sv)
645c22ef
DM
418{
419 SV* rv;
420
421 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
422 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
423 if (SvWEAKREF(sv)) {
424 sv_del_backref(sv);
425 SvWEAKREF_off(sv);
b162af07 426 SvRV_set(sv, NULL);
645c22ef
DM
427 } else {
428 SvROK_off(sv);
b162af07 429 SvRV_set(sv, NULL);
645c22ef
DM
430 SvREFCNT_dec(rv);
431 }
432 }
433
434 /* XXX Might want to check arrays, etc. */
435}
436
437/* called by sv_clean_objs() for each live SV */
438
439#ifndef DISABLE_DESTRUCTOR_KLUDGE
440static void
acfe0abc 441do_clean_named_objs(pTHX_ SV *sv)
645c22ef
DM
442{
443 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
444 if ( SvOBJECT(GvSV(sv)) ||
445 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
446 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
447 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
448 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
449 {
450 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
ec5f3c78 451 SvFLAGS(sv) |= SVf_BREAK;
645c22ef
DM
452 SvREFCNT_dec(sv);
453 }
454 }
455}
456#endif
457
458/*
459=for apidoc sv_clean_objs
460
461Attempt to destroy all objects not yet freed
462
463=cut
464*/
465
4561caa4 466void
864dbfa3 467Perl_sv_clean_objs(pTHX)
4561caa4 468{
3280af22 469 PL_in_clean_objs = TRUE;
055972dc 470 visit(do_clean_objs, SVf_ROK, SVf_ROK);
4561caa4 471#ifndef DISABLE_DESTRUCTOR_KLUDGE
2d0f3c12 472 /* some barnacles may yet remain, clinging to typeglobs */
055972dc 473 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
4561caa4 474#endif
3280af22 475 PL_in_clean_objs = FALSE;
4561caa4
CS
476}
477
645c22ef
DM
478/* called by sv_clean_all() for each live SV */
479
480static void
acfe0abc 481do_clean_all(pTHX_ SV *sv)
645c22ef
DM
482{
483 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
484 SvFLAGS(sv) |= SVf_BREAK;
0e705b3b
DM
485 if (PL_comppad == (AV*)sv) {
486 PL_comppad = Nullav;
487 PL_curpad = Null(SV**);
488 }
645c22ef
DM
489 SvREFCNT_dec(sv);
490}
491
492/*
493=for apidoc sv_clean_all
494
495Decrement the refcnt of each remaining SV, possibly triggering a
496cleanup. This function may have to be called multiple times to free
ff276b08 497SVs which are in complex self-referential hierarchies.
645c22ef
DM
498
499=cut
500*/
501
5226ed68 502I32
864dbfa3 503Perl_sv_clean_all(pTHX)
8990e307 504{
5226ed68 505 I32 cleaned;
3280af22 506 PL_in_clean_all = TRUE;
055972dc 507 cleaned = visit(do_clean_all, 0,0);
3280af22 508 PL_in_clean_all = FALSE;
5226ed68 509 return cleaned;
8990e307 510}
463ee0b2 511
645c22ef
DM
512/*
513=for apidoc sv_free_arenas
514
515Deallocate the memory used by all arenas. Note that all the individual SV
516heads and bodies within the arenas must already have been freed.
517
518=cut
519*/
520
4633a7c4 521void
864dbfa3 522Perl_sv_free_arenas(pTHX)
4633a7c4
LW
523{
524 SV* sva;
525 SV* svanext;
7b2c381c 526 void *arena, *arenanext;
4633a7c4
LW
527
528 /* Free arenas here, but be careful about fake ones. (We assume
529 contiguity of the fake ones with the corresponding real ones.) */
530
3280af22 531 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
4633a7c4
LW
532 svanext = (SV*) SvANY(sva);
533 while (svanext && SvFAKE(svanext))
534 svanext = (SV*) SvANY(svanext);
535
536 if (!SvFAKE(sva))
1df70142 537 Safefree(sva);
4633a7c4 538 }
5f05dabc 539
612f20c3 540 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
7b2c381c 541 arenanext = *(void **)arena;
612f20c3
GS
542 Safefree(arena);
543 }
544 PL_xnv_arenaroot = 0;
bf9cdc68 545 PL_xnv_root = 0;
612f20c3 546
612f20c3 547 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
7b2c381c 548 arenanext = *(void **)arena;
612f20c3
GS
549 Safefree(arena);
550 }
551 PL_xpv_arenaroot = 0;
bf9cdc68 552 PL_xpv_root = 0;
612f20c3 553
7b2c381c
NC
554 for (arena = PL_xpviv_arenaroot; arena; arena = arenanext) {
555 arenanext = *(void **)arena;
612f20c3
GS
556 Safefree(arena);
557 }
558 PL_xpviv_arenaroot = 0;
bf9cdc68 559 PL_xpviv_root = 0;
612f20c3 560
7b2c381c
NC
561 for (arena = PL_xpvnv_arenaroot; arena; arena = arenanext) {
562 arenanext = *(void **)arena;
612f20c3
GS
563 Safefree(arena);
564 }
565 PL_xpvnv_arenaroot = 0;
bf9cdc68 566 PL_xpvnv_root = 0;
612f20c3 567
7b2c381c
NC
568 for (arena = PL_xpvcv_arenaroot; arena; arena = arenanext) {
569 arenanext = *(void **)arena;
612f20c3
GS
570 Safefree(arena);
571 }
572 PL_xpvcv_arenaroot = 0;
bf9cdc68 573 PL_xpvcv_root = 0;
612f20c3 574
7b2c381c
NC
575 for (arena = PL_xpvav_arenaroot; arena; arena = arenanext) {
576 arenanext = *(void **)arena;
612f20c3
GS
577 Safefree(arena);
578 }
579 PL_xpvav_arenaroot = 0;
bf9cdc68 580 PL_xpvav_root = 0;
612f20c3 581
7b2c381c
NC
582 for (arena = PL_xpvhv_arenaroot; arena; arena = arenanext) {
583 arenanext = *(void **)arena;
612f20c3
GS
584 Safefree(arena);
585 }
586 PL_xpvhv_arenaroot = 0;
bf9cdc68 587 PL_xpvhv_root = 0;
612f20c3 588
7b2c381c
NC
589 for (arena = PL_xpvmg_arenaroot; arena; arena = arenanext) {
590 arenanext = *(void **)arena;
612f20c3
GS
591 Safefree(arena);
592 }
593 PL_xpvmg_arenaroot = 0;
bf9cdc68 594 PL_xpvmg_root = 0;
612f20c3 595
7b2c381c
NC
596 for (arena = PL_xpvgv_arenaroot; arena; arena = arenanext) {
597 arenanext = *(void **)arena;
727879eb
NC
598 Safefree(arena);
599 }
600 PL_xpvgv_arenaroot = 0;
601 PL_xpvgv_root = 0;
602
7b2c381c
NC
603 for (arena = PL_xpvlv_arenaroot; arena; arena = arenanext) {
604 arenanext = *(void **)arena;
612f20c3
GS
605 Safefree(arena);
606 }
607 PL_xpvlv_arenaroot = 0;
bf9cdc68 608 PL_xpvlv_root = 0;
612f20c3 609
7b2c381c
NC
610 for (arena = PL_xpvbm_arenaroot; arena; arena = arenanext) {
611 arenanext = *(void **)arena;
612f20c3
GS
612 Safefree(arena);
613 }
614 PL_xpvbm_arenaroot = 0;
bf9cdc68 615 PL_xpvbm_root = 0;
612f20c3 616
b1135e3d
NC
617 {
618 HE *he;
619 HE *he_next;
620 for (he = PL_he_arenaroot; he; he = he_next) {
621 he_next = HeNEXT(he);
622 Safefree(he);
623 }
612f20c3
GS
624 }
625 PL_he_arenaroot = 0;
bf9cdc68 626 PL_he_root = 0;
612f20c3 627
892b45be 628#if defined(USE_ITHREADS)
b1135e3d
NC
629 {
630 struct ptr_tbl_ent *pte;
631 struct ptr_tbl_ent *pte_next;
632 for (pte = PL_pte_arenaroot; pte; pte = pte_next) {
633 pte_next = pte->next;
634 Safefree(pte);
635 }
32e691d0
NC
636 }
637 PL_pte_arenaroot = 0;
638 PL_pte_root = 0;
892b45be 639#endif
32e691d0 640
3280af22
NIS
641 if (PL_nice_chunk)
642 Safefree(PL_nice_chunk);
643 PL_nice_chunk = Nullch;
644 PL_nice_chunk_size = 0;
645 PL_sv_arenaroot = 0;
646 PL_sv_root = 0;
4633a7c4
LW
647}
648
29489e7c
DM
649/* ---------------------------------------------------------------------
650 *
651 * support functions for report_uninit()
652 */
653
654/* the maxiumum size of array or hash where we will scan looking
655 * for the undefined element that triggered the warning */
656
657#define FUV_MAX_SEARCH_SIZE 1000
658
659/* Look for an entry in the hash whose value has the same SV as val;
660 * If so, return a mortal copy of the key. */
661
662STATIC SV*
663S_find_hash_subscript(pTHX_ HV *hv, SV* val)
664{
27da23d5 665 dVAR;
29489e7c 666 register HE **array;
29489e7c
DM
667 I32 i;
668
669 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
670 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
671 return Nullsv;
672
673 array = HvARRAY(hv);
674
675 for (i=HvMAX(hv); i>0; i--) {
f54cb97a 676 register HE *entry;
29489e7c
DM
677 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
678 if (HeVAL(entry) != val)
679 continue;
680 if ( HeVAL(entry) == &PL_sv_undef ||
681 HeVAL(entry) == &PL_sv_placeholder)
682 continue;
683 if (!HeKEY(entry))
684 return Nullsv;
685 if (HeKLEN(entry) == HEf_SVKEY)
686 return sv_mortalcopy(HeKEY_sv(entry));
687 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
688 }
689 }
690 return Nullsv;
691}
692
693/* Look for an entry in the array whose value has the same SV as val;
694 * If so, return the index, otherwise return -1. */
695
696STATIC I32
697S_find_array_subscript(pTHX_ AV *av, SV* val)
698{
699 SV** svp;
700 I32 i;
701 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
702 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
703 return -1;
704
705 svp = AvARRAY(av);
706 for (i=AvFILLp(av); i>=0; i--) {
707 if (svp[i] == val && svp[i] != &PL_sv_undef)
708 return i;
709 }
710 return -1;
711}
712
713/* S_varname(): return the name of a variable, optionally with a subscript.
714 * If gv is non-zero, use the name of that global, along with gvtype (one
715 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
716 * targ. Depending on the value of the subscript_type flag, return:
717 */
718
719#define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
720#define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
721#define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
722#define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
723
724STATIC SV*
bfed75c6 725S_varname(pTHX_ GV *gv, const char *gvtype, PADOFFSET targ,
29489e7c
DM
726 SV* keyname, I32 aindex, int subscript_type)
727{
728 AV *av;
a3b680e6 729 SV *sv;
29489e7c 730
a3b680e6 731 SV * const name = sv_newmortal();
29489e7c
DM
732 if (gv) {
733
734 /* simulate gv_fullname4(), but add literal '^' for $^FOO names
735 * XXX get rid of all this if gv_fullnameX() ever supports this
736 * directly */
737
bfed75c6 738 const char *p;
29489e7c
DM
739 HV *hv = GvSTASH(gv);
740 sv_setpv(name, gvtype);
741 if (!hv)
742 p = "???";
bfcb3514 743 else if (!(p=HvNAME_get(hv)))
29489e7c 744 p = "__ANON__";
29489e7c
DM
745 if (strNE(p, "main")) {
746 sv_catpv(name,p);
747 sv_catpvn(name,"::", 2);
748 }
749 if (GvNAMELEN(gv)>= 1 &&
750 ((unsigned int)*GvNAME(gv)) <= 26)
751 { /* handle $^FOO */
752 Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
753 sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
754 }
755 else
756 sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
757 }
758 else {
759 U32 u;
760 CV *cv = find_runcv(&u);
616d8c9c
AL
761 STRLEN len;
762 const char *str;
29489e7c
DM
763 if (!cv || !CvPADLIST(cv))
764 return Nullsv;;
765 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
766 sv = *av_fetch(av, targ, FALSE);
767 /* SvLEN in a pad name is not to be trusted */
616d8c9c
AL
768 str = SvPV(sv,len);
769 sv_setpvn(name, str, len);
29489e7c
DM
770 }
771
772 if (subscript_type == FUV_SUBSCRIPT_HASH) {
773 *SvPVX(name) = '$';
774 sv = NEWSV(0,0);
775 Perl_sv_catpvf(aTHX_ name, "{%s}",
3f7c398e 776 pv_display(sv,SvPVX_const(keyname), SvCUR(keyname), 0, 32));
29489e7c
DM
777 SvREFCNT_dec(sv);
778 }
779 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
780 *SvPVX(name) = '$';
265a12b8 781 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
29489e7c
DM
782 }
783 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
784 sv_insert(name, 0, 0, "within ", 7);
785
786 return name;
787}
788
789
790/*
791=for apidoc find_uninit_var
792
793Find the name of the undefined variable (if any) that caused the operator o
794to issue a "Use of uninitialized value" warning.
795If match is true, only return a name if it's value matches uninit_sv.
796So roughly speaking, if a unary operator (such as OP_COS) generates a
797warning, then following the direct child of the op may yield an
798OP_PADSV or OP_GV that gives the name of the undefined variable. On the
799other hand, with OP_ADD there are two branches to follow, so we only print
800the variable name if we get an exact match.
801
802The name is returned as a mortal SV.
803
804Assumes that PL_op is the op that originally triggered the error, and that
805PL_comppad/PL_curpad points to the currently executing pad.
806
807=cut
808*/
809
810STATIC SV *
811S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
812{
27da23d5 813 dVAR;
29489e7c
DM
814 SV *sv;
815 AV *av;
816 SV **svp;
817 GV *gv;
818 OP *o, *o2, *kid;
819
820 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
821 uninit_sv == &PL_sv_placeholder)))
822 return Nullsv;
823
824 switch (obase->op_type) {
825
826 case OP_RV2AV:
827 case OP_RV2HV:
828 case OP_PADAV:
829 case OP_PADHV:
830 {
f54cb97a
AL
831 const bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
832 const bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
112dcc46
RGS
833 I32 index = 0;
834 SV *keysv = Nullsv;
29489e7c
DM
835 int subscript_type = FUV_SUBSCRIPT_WITHIN;
836
837 if (pad) { /* @lex, %lex */
838 sv = PAD_SVl(obase->op_targ);
839 gv = Nullgv;
840 }
841 else {
842 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
843 /* @global, %global */
844 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
845 if (!gv)
846 break;
847 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
848 }
849 else /* @{expr}, %{expr} */
850 return find_uninit_var(cUNOPx(obase)->op_first,
851 uninit_sv, match);
852 }
853
854 /* attempt to find a match within the aggregate */
855 if (hash) {
856 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
857 if (keysv)
858 subscript_type = FUV_SUBSCRIPT_HASH;
859 }
860 else {
861 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
862 if (index >= 0)
863 subscript_type = FUV_SUBSCRIPT_ARRAY;
864 }
865
866 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
867 break;
868
869 return S_varname(aTHX_ gv, hash ? "%" : "@", obase->op_targ,
870 keysv, index, subscript_type);
871 }
872
873 case OP_PADSV:
874 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
875 break;
876 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
877 Nullsv, 0, FUV_SUBSCRIPT_NONE);
878
879 case OP_GVSV:
880 gv = cGVOPx_gv(obase);
881 if (!gv || (match && GvSV(gv) != uninit_sv))
882 break;
883 return S_varname(aTHX_ gv, "$", 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
884
885 case OP_AELEMFAST:
886 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
887 if (match) {
888 av = (AV*)PAD_SV(obase->op_targ);
889 if (!av || SvRMAGICAL(av))
890 break;
891 svp = av_fetch(av, (I32)obase->op_private, FALSE);
892 if (!svp || *svp != uninit_sv)
893 break;
894 }
895 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
896 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
897 }
898 else {
899 gv = cGVOPx_gv(obase);
900 if (!gv)
901 break;
902 if (match) {
903 av = GvAV(gv);
904 if (!av || SvRMAGICAL(av))
905 break;
906 svp = av_fetch(av, (I32)obase->op_private, FALSE);
907 if (!svp || *svp != uninit_sv)
908 break;
909 }
910 return S_varname(aTHX_ gv, "$", 0,
911 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
912 }
913 break;
914
915 case OP_EXISTS:
916 o = cUNOPx(obase)->op_first;
917 if (!o || o->op_type != OP_NULL ||
918 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
919 break;
920 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
921
922 case OP_AELEM:
923 case OP_HELEM:
924 if (PL_op == obase)
925 /* $a[uninit_expr] or $h{uninit_expr} */
926 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
927
928 gv = Nullgv;
929 o = cBINOPx(obase)->op_first;
930 kid = cBINOPx(obase)->op_last;
931
932 /* get the av or hv, and optionally the gv */
933 sv = Nullsv;
934 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
935 sv = PAD_SV(o->op_targ);
936 }
937 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
938 && cUNOPo->op_first->op_type == OP_GV)
939 {
940 gv = cGVOPx_gv(cUNOPo->op_first);
941 if (!gv)
942 break;
943 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
944 }
945 if (!sv)
946 break;
947
948 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
949 /* index is constant */
950 if (match) {
951 if (SvMAGICAL(sv))
952 break;
953 if (obase->op_type == OP_HELEM) {
954 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
955 if (!he || HeVAL(he) != uninit_sv)
956 break;
957 }
958 else {
959 svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
960 if (!svp || *svp != uninit_sv)
961 break;
962 }
963 }
964 if (obase->op_type == OP_HELEM)
965 return S_varname(aTHX_ gv, "%", o->op_targ,
966 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
967 else
968 return S_varname(aTHX_ gv, "@", o->op_targ, Nullsv,
969 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
970 ;
971 }
972 else {
973 /* index is an expression;
974 * attempt to find a match within the aggregate */
975 if (obase->op_type == OP_HELEM) {
976 SV *keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
977 if (keysv)
978 return S_varname(aTHX_ gv, "%", o->op_targ,
979 keysv, 0, FUV_SUBSCRIPT_HASH);
980 }
981 else {
f54cb97a 982 const I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
29489e7c 983 if (index >= 0)
f54cb97a 984 return S_varname(aTHX_ gv, "@", o->op_targ,
29489e7c
DM
985 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
986 }
987 if (match)
988 break;
989 return S_varname(aTHX_ gv,
990 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
991 ? "@" : "%",
992 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
993 }
994
995 break;
996
997 case OP_AASSIGN:
998 /* only examine RHS */
999 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
1000
1001 case OP_OPEN:
1002 o = cUNOPx(obase)->op_first;
1003 if (o->op_type == OP_PUSHMARK)
1004 o = o->op_sibling;
1005
1006 if (!o->op_sibling) {
1007 /* one-arg version of open is highly magical */
1008
1009 if (o->op_type == OP_GV) { /* open FOO; */
1010 gv = cGVOPx_gv(o);
1011 if (match && GvSV(gv) != uninit_sv)
1012 break;
7a5fa8a2 1013 return S_varname(aTHX_ gv, "$", 0,
29489e7c
DM
1014 Nullsv, 0, FUV_SUBSCRIPT_NONE);
1015 }
1016 /* other possibilities not handled are:
1017 * open $x; or open my $x; should return '${*$x}'
1018 * open expr; should return '$'.expr ideally
1019 */
1020 break;
1021 }
1022 goto do_op;
1023
1024 /* ops where $_ may be an implicit arg */
1025 case OP_TRANS:
1026 case OP_SUBST:
1027 case OP_MATCH:
1028 if ( !(obase->op_flags & OPf_STACKED)) {
1029 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
1030 ? PAD_SVl(obase->op_targ)
1031 : DEFSV))
1032 {
1033 sv = sv_newmortal();
616d8c9c 1034 sv_setpvn(sv, "$_", 2);
29489e7c
DM
1035 return sv;
1036 }
1037 }
1038 goto do_op;
1039
1040 case OP_PRTF:
1041 case OP_PRINT:
1042 /* skip filehandle as it can't produce 'undef' warning */
1043 o = cUNOPx(obase)->op_first;
1044 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
1045 o = o->op_sibling->op_sibling;
1046 goto do_op2;
1047
1048
e21bd382 1049 case OP_RV2SV:
29489e7c
DM
1050 case OP_CUSTOM:
1051 case OP_ENTERSUB:
1052 match = 1; /* XS or custom code could trigger random warnings */
1053 goto do_op;
1054
1055 case OP_SCHOMP:
1056 case OP_CHOMP:
1057 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
1058 return sv_2mortal(newSVpv("${$/}", 0));
1059 /* FALL THROUGH */
1060
1061 default:
1062 do_op:
1063 if (!(obase->op_flags & OPf_KIDS))
1064 break;
1065 o = cUNOPx(obase)->op_first;
1066
1067 do_op2:
1068 if (!o)
1069 break;
1070
1071 /* if all except one arg are constant, or have no side-effects,
1072 * or are optimized away, then it's unambiguous */
1073 o2 = Nullop;
1074 for (kid=o; kid; kid = kid->op_sibling) {
1075 if (kid &&
1076 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1077 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1078 || (kid->op_type == OP_PUSHMARK)
1079 )
1080 )
1081 continue;
1082 if (o2) { /* more than one found */
1083 o2 = Nullop;
1084 break;
1085 }
1086 o2 = kid;
1087 }
1088 if (o2)
1089 return find_uninit_var(o2, uninit_sv, match);
1090
1091 /* scan all args */
1092 while (o) {
1093 sv = find_uninit_var(o, uninit_sv, 1);
1094 if (sv)
1095 return sv;
1096 o = o->op_sibling;
1097 }
1098 break;
1099 }
1100 return Nullsv;
1101}
1102
1103
645c22ef
DM
1104/*
1105=for apidoc report_uninit
1106
1107Print appropriate "Use of uninitialized variable" warning
1108
1109=cut
1110*/
1111
1d7c1841 1112void
29489e7c
DM
1113Perl_report_uninit(pTHX_ SV* uninit_sv)
1114{
1115 if (PL_op) {
112dcc46 1116 SV* varname = Nullsv;
29489e7c
DM
1117 if (uninit_sv) {
1118 varname = find_uninit_var(PL_op, uninit_sv,0);
1119 if (varname)
1120 sv_insert(varname, 0, 0, " ", 1);
1121 }
9014280d 1122 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
29489e7c
DM
1123 varname ? SvPV_nolen(varname) : "",
1124 " in ", OP_DESC(PL_op));
1125 }
1d7c1841 1126 else
29489e7c
DM
1127 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1128 "", "", "");
1d7c1841
GS
1129}
1130
645c22ef
DM
1131/* allocate another arena's worth of NV bodies */
1132
cbe51380 1133STATIC void
cea2e8a9 1134S_more_xnv(pTHX)
463ee0b2 1135{
cac9b346
NC
1136 NV* xnv;
1137 NV* xnvend;
7b2c381c
NC
1138 void *ptr;
1139 New(711, ptr, PERL_ARENA_SIZE/sizeof(NV), NV);
1140 *((void **) ptr) = (void *)PL_xnv_arenaroot;
612f20c3
GS
1141 PL_xnv_arenaroot = ptr;
1142
1143 xnv = (NV*) ptr;
9c17f24a 1144 xnvend = &xnv[PERL_ARENA_SIZE / sizeof(NV) - 1];
65202027 1145 xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
3280af22 1146 PL_xnv_root = xnv;
463ee0b2 1147 while (xnv < xnvend) {
65202027 1148 *(NV**)xnv = (NV*)(xnv + 1);
463ee0b2
LW
1149 xnv++;
1150 }
cac9b346
NC
1151 *(NV**)xnv = 0;
1152}
1153
1154/* allocate another arena's worth of struct xpv */
1155
1156STATIC void
1157S_more_xpv(pTHX)
1158{
59813432
NC
1159 xpv_allocated* xpv;
1160 xpv_allocated* xpvend;
1161 New(713, xpv, PERL_ARENA_SIZE/sizeof(xpv_allocated), xpv_allocated);
1162 *((xpv_allocated**)xpv) = PL_xpv_arenaroot;
cac9b346
NC
1163 PL_xpv_arenaroot = xpv;
1164
59813432 1165 xpvend = &xpv[PERL_ARENA_SIZE / sizeof(xpv_allocated) - 1];
cac9b346
NC
1166 PL_xpv_root = ++xpv;
1167 while (xpv < xpvend) {
59813432 1168 *((xpv_allocated**)xpv) = xpv + 1;
cac9b346
NC
1169 xpv++;
1170 }
59813432 1171 *((xpv_allocated**)xpv) = 0;
cac9b346
NC
1172}
1173
1174/* allocate another arena's worth of struct xpviv */
1175
1176STATIC void
1177S_more_xpviv(pTHX)
1178{
311a25d9
NC
1179 xpviv_allocated* xpviv;
1180 xpviv_allocated* xpvivend;
1181 New(713, xpviv, PERL_ARENA_SIZE/sizeof(xpviv_allocated), xpviv_allocated);
1182 *((xpviv_allocated**)xpviv) = PL_xpviv_arenaroot;
cac9b346
NC
1183 PL_xpviv_arenaroot = xpviv;
1184
311a25d9 1185 xpvivend = &xpviv[PERL_ARENA_SIZE / sizeof(xpviv_allocated) - 1];
cac9b346
NC
1186 PL_xpviv_root = ++xpviv;
1187 while (xpviv < xpvivend) {
311a25d9 1188 *((xpviv_allocated**)xpviv) = xpviv + 1;
cac9b346
NC
1189 xpviv++;
1190 }
311a25d9 1191 *((xpviv_allocated**)xpviv) = 0;
cac9b346
NC
1192}
1193
1194/* allocate another arena's worth of struct xpvnv */
1195
1196STATIC void
1197S_more_xpvnv(pTHX)
1198{
1199 XPVNV* xpvnv;
1200 XPVNV* xpvnvend;
1201 New(715, xpvnv, PERL_ARENA_SIZE/sizeof(XPVNV), XPVNV);
7b2c381c 1202 *((XPVNV**)xpvnv) = PL_xpvnv_arenaroot;
cac9b346
NC
1203 PL_xpvnv_arenaroot = xpvnv;
1204
1205 xpvnvend = &xpvnv[PERL_ARENA_SIZE / sizeof(XPVNV) - 1];
1206 PL_xpvnv_root = ++xpvnv;
1207 while (xpvnv < xpvnvend) {
7b2c381c 1208 *((XPVNV**)xpvnv) = xpvnv + 1;
cac9b346
NC
1209 xpvnv++;
1210 }
7b2c381c 1211 *((XPVNV**)xpvnv) = 0;
cac9b346
NC
1212}
1213
1214/* allocate another arena's worth of struct xpvcv */
1215
1216STATIC void
1217S_more_xpvcv(pTHX)
1218{
1219 XPVCV* xpvcv;
1220 XPVCV* xpvcvend;
1221 New(716, xpvcv, PERL_ARENA_SIZE/sizeof(XPVCV), XPVCV);
7b2c381c 1222 *((XPVCV**)xpvcv) = PL_xpvcv_arenaroot;
cac9b346
NC
1223 PL_xpvcv_arenaroot = xpvcv;
1224
1225 xpvcvend = &xpvcv[PERL_ARENA_SIZE / sizeof(XPVCV) - 1];
1226 PL_xpvcv_root = ++xpvcv;
1227 while (xpvcv < xpvcvend) {
7b2c381c 1228 *((XPVCV**)xpvcv) = xpvcv + 1;
cac9b346
NC
1229 xpvcv++;
1230 }
7b2c381c 1231 *((XPVCV**)xpvcv) = 0;
cac9b346
NC
1232}
1233
1234/* allocate another arena's worth of struct xpvav */
1235
1236STATIC void
1237S_more_xpvav(pTHX)
1238{
59813432
NC
1239 xpvav_allocated* xpvav;
1240 xpvav_allocated* xpvavend;
1241 New(717, xpvav, PERL_ARENA_SIZE/sizeof(xpvav_allocated),
1242 xpvav_allocated);
1243 *((xpvav_allocated**)xpvav) = PL_xpvav_arenaroot;
cac9b346
NC
1244 PL_xpvav_arenaroot = xpvav;
1245
59813432 1246 xpvavend = &xpvav[PERL_ARENA_SIZE / sizeof(xpvav_allocated) - 1];
cac9b346
NC
1247 PL_xpvav_root = ++xpvav;
1248 while (xpvav < xpvavend) {
59813432 1249 *((xpvav_allocated**)xpvav) = xpvav + 1;
cac9b346
NC
1250 xpvav++;
1251 }
59813432 1252 *((xpvav_allocated**)xpvav) = 0;
cac9b346
NC
1253}
1254
1255/* allocate another arena's worth of struct xpvhv */
1256
1257STATIC void
1258S_more_xpvhv(pTHX)
1259{
59813432
NC
1260 xpvhv_allocated* xpvhv;
1261 xpvhv_allocated* xpvhvend;
1262 New(718, xpvhv, PERL_ARENA_SIZE/sizeof(xpvhv_allocated),
1263 xpvhv_allocated);
1264 *((xpvhv_allocated**)xpvhv) = PL_xpvhv_arenaroot;
cac9b346
NC
1265 PL_xpvhv_arenaroot = xpvhv;
1266
59813432 1267 xpvhvend = &xpvhv[PERL_ARENA_SIZE / sizeof(xpvhv_allocated) - 1];
cac9b346
NC
1268 PL_xpvhv_root = ++xpvhv;
1269 while (xpvhv < xpvhvend) {
59813432 1270 *((xpvhv_allocated**)xpvhv) = xpvhv + 1;
cac9b346
NC
1271 xpvhv++;
1272 }
59813432 1273 *((xpvhv_allocated**)xpvhv) = 0;
cac9b346
NC
1274}
1275
1276/* allocate another arena's worth of struct xpvmg */
1277
1278STATIC void
1279S_more_xpvmg(pTHX)
1280{
1281 XPVMG* xpvmg;
1282 XPVMG* xpvmgend;
1283 New(719, xpvmg, PERL_ARENA_SIZE/sizeof(XPVMG), XPVMG);
7b2c381c 1284 *((XPVMG**)xpvmg) = PL_xpvmg_arenaroot;
cac9b346
NC
1285 PL_xpvmg_arenaroot = xpvmg;
1286
1287 xpvmgend = &xpvmg[PERL_ARENA_SIZE / sizeof(XPVMG) - 1];
1288 PL_xpvmg_root = ++xpvmg;
1289 while (xpvmg < xpvmgend) {
7b2c381c 1290 *((XPVMG**)xpvmg) = xpvmg + 1;
cac9b346
NC
1291 xpvmg++;
1292 }
7b2c381c 1293 *((XPVMG**)xpvmg) = 0;
cac9b346
NC
1294}
1295
1296/* allocate another arena's worth of struct xpvgv */
1297
1298STATIC void
1299S_more_xpvgv(pTHX)
1300{
1301 XPVGV* xpvgv;
1302 XPVGV* xpvgvend;
1303 New(720, xpvgv, PERL_ARENA_SIZE/sizeof(XPVGV), XPVGV);
7b2c381c 1304 *((XPVGV**)xpvgv) = PL_xpvgv_arenaroot;
cac9b346
NC
1305 PL_xpvgv_arenaroot = xpvgv;
1306
1307 xpvgvend = &xpvgv[PERL_ARENA_SIZE / sizeof(XPVGV) - 1];
1308 PL_xpvgv_root = ++xpvgv;
1309 while (xpvgv < xpvgvend) {
7b2c381c 1310 *((XPVGV**)xpvgv) = xpvgv + 1;
cac9b346
NC
1311 xpvgv++;
1312 }
7b2c381c 1313 *((XPVGV**)xpvgv) = 0;
cac9b346
NC
1314}
1315
1316/* allocate another arena's worth of struct xpvlv */
1317
1318STATIC void
1319S_more_xpvlv(pTHX)
1320{
1321 XPVLV* xpvlv;
1322 XPVLV* xpvlvend;
1323 New(720, xpvlv, PERL_ARENA_SIZE/sizeof(XPVLV), XPVLV);
7b2c381c 1324 *((XPVLV**)xpvlv) = PL_xpvlv_arenaroot;
cac9b346
NC
1325 PL_xpvlv_arenaroot = xpvlv;
1326
1327 xpvlvend = &xpvlv[PERL_ARENA_SIZE / sizeof(XPVLV) - 1];
1328 PL_xpvlv_root = ++xpvlv;
1329 while (xpvlv < xpvlvend) {
7b2c381c 1330 *((XPVLV**)xpvlv) = xpvlv + 1;
cac9b346
NC
1331 xpvlv++;
1332 }
7b2c381c 1333 *((XPVLV**)xpvlv) = 0;
cac9b346
NC
1334}
1335
1336/* allocate another arena's worth of struct xpvbm */
1337
1338STATIC void
1339S_more_xpvbm(pTHX)
1340{
1341 XPVBM* xpvbm;
1342 XPVBM* xpvbmend;
1343 New(721, xpvbm, PERL_ARENA_SIZE/sizeof(XPVBM), XPVBM);
7b2c381c 1344 *((XPVBM**)xpvbm) = PL_xpvbm_arenaroot;
cac9b346
NC
1345 PL_xpvbm_arenaroot = xpvbm;
1346
1347 xpvbmend = &xpvbm[PERL_ARENA_SIZE / sizeof(XPVBM) - 1];
1348 PL_xpvbm_root = ++xpvbm;
1349 while (xpvbm < xpvbmend) {
7b2c381c 1350 *((XPVBM**)xpvbm) = xpvbm + 1;
cac9b346
NC
1351 xpvbm++;
1352 }
7b2c381c 1353 *((XPVBM**)xpvbm) = 0;
cac9b346 1354}
612f20c3 1355
cac9b346
NC
1356/* grab a new NV body from the free list, allocating more if necessary */
1357
1358STATIC XPVNV*
1359S_new_xnv(pTHX)
1360{
1361 NV* xnv;
1362 LOCK_SV_MUTEX;
1363 if (!PL_xnv_root)
1364 S_more_xnv(aTHX);
1365 xnv = PL_xnv_root;
1366 PL_xnv_root = *(NV**)xnv;
1367 UNLOCK_SV_MUTEX;
1368 return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
1369}
1370
1371/* return an NV body to the free list */
1372
1373STATIC void
1374S_del_xnv(pTHX_ XPVNV *p)
1375{
1376 NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
1377 LOCK_SV_MUTEX;
1378 *(NV**)xnv = PL_xnv_root;
1379 PL_xnv_root = xnv;
1380 UNLOCK_SV_MUTEX;
ed6116ce
LW
1381}
1382
645c22ef
DM
1383/* grab a new struct xpv from the free list, allocating more if necessary */
1384
76e3520e 1385STATIC XPV*
cea2e8a9 1386S_new_xpv(pTHX)
463ee0b2 1387{
59813432 1388 xpv_allocated* xpv;
cbe51380
GS
1389 LOCK_SV_MUTEX;
1390 if (!PL_xpv_root)
cac9b346 1391 S_more_xpv(aTHX);
cbe51380 1392 xpv = PL_xpv_root;
59813432 1393 PL_xpv_root = *(xpv_allocated**)xpv;
cbe51380 1394 UNLOCK_SV_MUTEX;
59813432
NC
1395 /* If xpv_allocated is the same structure as XPV then the two OFFSETs
1396 sum to zero, and the pointer is unchanged. If the allocated structure
1397 is smaller (no initial IV actually allocated) then the net effect is
1398 to subtract the size of the IV from the pointer, to return a new pointer
1399 as if an initial IV were actually allocated. */
1400 return (XPV*)((char*)xpv - STRUCT_OFFSET(XPV, xpv_cur)
1401 + STRUCT_OFFSET(xpv_allocated, xpv_cur));
463ee0b2
LW
1402}
1403
645c22ef
DM
1404/* return a struct xpv to the free list */
1405
76e3520e 1406STATIC void
cea2e8a9 1407S_del_xpv(pTHX_ XPV *p)
463ee0b2 1408{
59813432
NC
1409 xpv_allocated* xpv
1410 = (xpv_allocated*)((char*)(p) + STRUCT_OFFSET(XPV, xpv_cur)
1411 - STRUCT_OFFSET(xpv_allocated, xpv_cur));
cbe51380 1412 LOCK_SV_MUTEX;
59813432
NC
1413 *(xpv_allocated**)xpv = PL_xpv_root;
1414 PL_xpv_root = xpv;
cbe51380 1415 UNLOCK_SV_MUTEX;
463ee0b2
LW
1416}
1417
645c22ef
DM
1418/* grab a new struct xpviv from the free list, allocating more if necessary */
1419
932e9ff9
VB
1420STATIC XPVIV*
1421S_new_xpviv(pTHX)
1422{
311a25d9 1423 xpviv_allocated* xpviv;
932e9ff9
VB
1424 LOCK_SV_MUTEX;
1425 if (!PL_xpviv_root)
cac9b346 1426 S_more_xpviv(aTHX);
932e9ff9 1427 xpviv = PL_xpviv_root;
311a25d9 1428 PL_xpviv_root = *(xpviv_allocated**)xpviv;
932e9ff9 1429 UNLOCK_SV_MUTEX;
311a25d9
NC
1430 /* If xpviv_allocated is the same structure as XPVIV then the two OFFSETs
1431 sum to zero, and the pointer is unchanged. If the allocated structure
1432 is smaller (no initial IV actually allocated) then the net effect is
1433 to subtract the size of the IV from the pointer, to return a new pointer
1434 as if an initial IV were actually allocated. */
1435 return (XPVIV*)((char*)xpviv - STRUCT_OFFSET(XPVIV, xpv_cur)
1436 + STRUCT_OFFSET(xpviv_allocated, xpv_cur));
932e9ff9
VB
1437}
1438
645c22ef
DM
1439/* return a struct xpviv to the free list */
1440
932e9ff9
VB
1441STATIC void
1442S_del_xpviv(pTHX_ XPVIV *p)
1443{
311a25d9
NC
1444 xpviv_allocated* xpviv
1445 = (xpviv_allocated*)((char*)(p) + STRUCT_OFFSET(XPVIV, xpv_cur)
1446 - STRUCT_OFFSET(xpviv_allocated, xpv_cur));
932e9ff9 1447 LOCK_SV_MUTEX;
311a25d9
NC
1448 *(xpviv_allocated**)xpviv = PL_xpviv_root;
1449 PL_xpviv_root = xpviv;
932e9ff9
VB
1450 UNLOCK_SV_MUTEX;
1451}
1452
645c22ef
DM
1453/* grab a new struct xpvnv from the free list, allocating more if necessary */
1454
932e9ff9
VB
1455STATIC XPVNV*
1456S_new_xpvnv(pTHX)
1457{
1458 XPVNV* xpvnv;
1459 LOCK_SV_MUTEX;
1460 if (!PL_xpvnv_root)
cac9b346 1461 S_more_xpvnv(aTHX);
932e9ff9 1462 xpvnv = PL_xpvnv_root;
7b2c381c 1463 PL_xpvnv_root = *(XPVNV**)xpvnv;
932e9ff9
VB
1464 UNLOCK_SV_MUTEX;
1465 return xpvnv;
1466}
1467
645c22ef
DM
1468/* return a struct xpvnv to the free list */
1469
932e9ff9
VB
1470STATIC void
1471S_del_xpvnv(pTHX_ XPVNV *p)
1472{
1473 LOCK_SV_MUTEX;
7b2c381c 1474 *(XPVNV**)p = PL_xpvnv_root;
932e9ff9
VB
1475 PL_xpvnv_root = p;
1476 UNLOCK_SV_MUTEX;
1477}
1478
645c22ef
DM
1479/* grab a new struct xpvcv from the free list, allocating more if necessary */
1480
932e9ff9
VB
1481STATIC XPVCV*
1482S_new_xpvcv(pTHX)
1483{
1484 XPVCV* xpvcv;
1485 LOCK_SV_MUTEX;
1486 if (!PL_xpvcv_root)
cac9b346 1487 S_more_xpvcv(aTHX);
932e9ff9 1488 xpvcv = PL_xpvcv_root;
7b2c381c 1489 PL_xpvcv_root = *(XPVCV**)xpvcv;
932e9ff9
VB
1490 UNLOCK_SV_MUTEX;
1491 return xpvcv;
1492}
1493
645c22ef
DM
1494/* return a struct xpvcv to the free list */
1495
932e9ff9
VB
1496STATIC void
1497S_del_xpvcv(pTHX_ XPVCV *p)
1498{
1499 LOCK_SV_MUTEX;
7b2c381c 1500 *(XPVCV**)p = PL_xpvcv_root;
932e9ff9
VB
1501 PL_xpvcv_root = p;
1502 UNLOCK_SV_MUTEX;
1503}
1504
645c22ef
DM
1505/* grab a new struct xpvav from the free list, allocating more if necessary */
1506
932e9ff9
VB
1507STATIC XPVAV*
1508S_new_xpvav(pTHX)
1509{
59813432 1510 xpvav_allocated* xpvav;
932e9ff9
VB
1511 LOCK_SV_MUTEX;
1512 if (!PL_xpvav_root)
cac9b346 1513 S_more_xpvav(aTHX);
932e9ff9 1514 xpvav = PL_xpvav_root;
59813432 1515 PL_xpvav_root = *(xpvav_allocated**)xpvav;
932e9ff9 1516 UNLOCK_SV_MUTEX;
59813432
NC
1517 return (XPVAV*)((char*)xpvav - STRUCT_OFFSET(XPVAV, xav_fill)
1518 + STRUCT_OFFSET(xpvav_allocated, xav_fill));
932e9ff9
VB
1519}
1520
645c22ef
DM
1521/* return a struct xpvav to the free list */
1522
932e9ff9
VB
1523STATIC void
1524S_del_xpvav(pTHX_ XPVAV *p)
1525{
59813432
NC
1526 xpvav_allocated* xpvav
1527 = (xpvav_allocated*)((char*)(p) + STRUCT_OFFSET(XPVAV, xav_fill)
1528 - STRUCT_OFFSET(xpvav_allocated, xav_fill));
932e9ff9 1529 LOCK_SV_MUTEX;
59813432
NC
1530 *(xpvav_allocated**)xpvav = PL_xpvav_root;
1531 PL_xpvav_root = xpvav;
932e9ff9
VB
1532 UNLOCK_SV_MUTEX;
1533}
1534
645c22ef
DM
1535/* grab a new struct xpvhv from the free list, allocating more if necessary */
1536
932e9ff9
VB
1537STATIC XPVHV*
1538S_new_xpvhv(pTHX)
1539{
59813432 1540 xpvhv_allocated* xpvhv;
932e9ff9
VB
1541 LOCK_SV_MUTEX;
1542 if (!PL_xpvhv_root)
cac9b346 1543 S_more_xpvhv(aTHX);
932e9ff9 1544 xpvhv = PL_xpvhv_root;
59813432 1545 PL_xpvhv_root = *(xpvhv_allocated**)xpvhv;
932e9ff9 1546 UNLOCK_SV_MUTEX;
59813432
NC
1547 return (XPVHV*)((char*)xpvhv - STRUCT_OFFSET(XPVHV, xhv_fill)
1548 + STRUCT_OFFSET(xpvhv_allocated, xhv_fill));
932e9ff9
VB
1549}
1550
645c22ef
DM
1551/* return a struct xpvhv to the free list */
1552
932e9ff9
VB
1553STATIC void
1554S_del_xpvhv(pTHX_ XPVHV *p)
1555{
59813432
NC
1556 xpvhv_allocated* xpvhv
1557 = (xpvhv_allocated*)((char*)(p) + STRUCT_OFFSET(XPVHV, xhv_fill)
1558 - STRUCT_OFFSET(xpvhv_allocated, xhv_fill));
932e9ff9 1559 LOCK_SV_MUTEX;
59813432
NC
1560 *(xpvhv_allocated**)xpvhv = PL_xpvhv_root;
1561 PL_xpvhv_root = xpvhv;
932e9ff9
VB
1562 UNLOCK_SV_MUTEX;
1563}
1564
645c22ef
DM
1565/* grab a new struct xpvmg from the free list, allocating more if necessary */
1566
932e9ff9
VB
1567STATIC XPVMG*
1568S_new_xpvmg(pTHX)
1569{
1570 XPVMG* xpvmg;
1571 LOCK_SV_MUTEX;
1572 if (!PL_xpvmg_root)
cac9b346 1573 S_more_xpvmg(aTHX);
932e9ff9 1574 xpvmg = PL_xpvmg_root;
7b2c381c 1575 PL_xpvmg_root = *(XPVMG**)xpvmg;
932e9ff9
VB
1576 UNLOCK_SV_MUTEX;
1577 return xpvmg;
1578}
1579
645c22ef
DM
1580/* return a struct xpvmg to the free list */
1581
932e9ff9
VB
1582STATIC void
1583S_del_xpvmg(pTHX_ XPVMG *p)
1584{
1585 LOCK_SV_MUTEX;
7b2c381c 1586 *(XPVMG**)p = PL_xpvmg_root;
932e9ff9
VB
1587 PL_xpvmg_root = p;
1588 UNLOCK_SV_MUTEX;
1589}
1590
727879eb
NC
1591/* grab a new struct xpvgv from the free list, allocating more if necessary */
1592
1593STATIC XPVGV*
1594S_new_xpvgv(pTHX)
1595{
1596 XPVGV* xpvgv;
1597 LOCK_SV_MUTEX;
1598 if (!PL_xpvgv_root)
cac9b346 1599 S_more_xpvgv(aTHX);
727879eb 1600 xpvgv = PL_xpvgv_root;
7b2c381c 1601 PL_xpvgv_root = *(XPVGV**)xpvgv;
727879eb
NC
1602 UNLOCK_SV_MUTEX;
1603 return xpvgv;
1604}
1605
1606/* return a struct xpvgv to the free list */
1607
1608STATIC void
1609S_del_xpvgv(pTHX_ XPVGV *p)
1610{
1611 LOCK_SV_MUTEX;
7b2c381c 1612 *(XPVGV**)p = PL_xpvgv_root;
727879eb
NC
1613 PL_xpvgv_root = p;
1614 UNLOCK_SV_MUTEX;
1615}
1616
645c22ef
DM
1617/* grab a new struct xpvlv from the free list, allocating more if necessary */
1618
932e9ff9
VB
1619STATIC XPVLV*
1620S_new_xpvlv(pTHX)
1621{
1622 XPVLV* xpvlv;
1623 LOCK_SV_MUTEX;
1624 if (!PL_xpvlv_root)
cac9b346 1625 S_more_xpvlv(aTHX);
932e9ff9 1626 xpvlv = PL_xpvlv_root;
7b2c381c 1627 PL_xpvlv_root = *(XPVLV**)xpvlv;
932e9ff9
VB
1628 UNLOCK_SV_MUTEX;
1629 return xpvlv;
1630}
1631
645c22ef
DM
1632/* return a struct xpvlv to the free list */
1633
932e9ff9
VB
1634STATIC void
1635S_del_xpvlv(pTHX_ XPVLV *p)
1636{
1637 LOCK_SV_MUTEX;
7b2c381c 1638 *(XPVLV**)p = PL_xpvlv_root;
932e9ff9
VB
1639 PL_xpvlv_root = p;
1640 UNLOCK_SV_MUTEX;
1641}
1642
645c22ef
DM
1643/* grab a new struct xpvbm from the free list, allocating more if necessary */
1644
932e9ff9
VB
1645STATIC XPVBM*
1646S_new_xpvbm(pTHX)
1647{
1648 XPVBM* xpvbm;
1649 LOCK_SV_MUTEX;
1650 if (!PL_xpvbm_root)
cac9b346 1651 S_more_xpvbm(aTHX);
932e9ff9 1652 xpvbm = PL_xpvbm_root;
7b2c381c 1653 PL_xpvbm_root = *(XPVBM**)xpvbm;
932e9ff9
VB
1654 UNLOCK_SV_MUTEX;
1655 return xpvbm;
1656}
1657
645c22ef
DM
1658/* return a struct xpvbm to the free list */
1659
932e9ff9
VB
1660STATIC void
1661S_del_xpvbm(pTHX_ XPVBM *p)
1662{
1663 LOCK_SV_MUTEX;
7b2c381c 1664 *(XPVBM**)p = PL_xpvbm_root;
932e9ff9
VB
1665 PL_xpvbm_root = p;
1666 UNLOCK_SV_MUTEX;
1667}
1668
7bab3ede
MB
1669#define my_safemalloc(s) (void*)safemalloc(s)
1670#define my_safefree(p) safefree((char*)p)
463ee0b2 1671
d33b2eba 1672#ifdef PURIFY
463ee0b2 1673
d33b2eba
GS
1674#define new_XNV() my_safemalloc(sizeof(XPVNV))
1675#define del_XNV(p) my_safefree(p)
463ee0b2 1676
d33b2eba
GS
1677#define new_XPV() my_safemalloc(sizeof(XPV))
1678#define del_XPV(p) my_safefree(p)
9b94d1dd 1679
d33b2eba
GS
1680#define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1681#define del_XPVIV(p) my_safefree(p)
932e9ff9 1682
d33b2eba
GS
1683#define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1684#define del_XPVNV(p) my_safefree(p)
932e9ff9 1685
d33b2eba
GS
1686#define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1687#define del_XPVCV(p) my_safefree(p)
932e9ff9 1688
d33b2eba
GS
1689#define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1690#define del_XPVAV(p) my_safefree(p)
1691
1692#define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1693#define del_XPVHV(p) my_safefree(p)
1c846c1f 1694
d33b2eba
GS
1695#define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1696#define del_XPVMG(p) my_safefree(p)
1697
727879eb
NC
1698#define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1699#define del_XPVGV(p) my_safefree(p)
1700
d33b2eba
GS
1701#define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1702#define del_XPVLV(p) my_safefree(p)
1703
1704#define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1705#define del_XPVBM(p) my_safefree(p)
1706
1707#else /* !PURIFY */
1708
d33b2eba
GS
1709#define new_XNV() (void*)new_xnv()
1710#define del_XNV(p) del_xnv((XPVNV*) p)
9b94d1dd 1711
d33b2eba
GS
1712#define new_XPV() (void*)new_xpv()
1713#define del_XPV(p) del_xpv((XPV *)p)
1714
1715#define new_XPVIV() (void*)new_xpviv()
1716#define del_XPVIV(p) del_xpviv((XPVIV *)p)
1717
1718#define new_XPVNV() (void*)new_xpvnv()
1719#define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1720
1721#define new_XPVCV() (void*)new_xpvcv()
1722#define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1723
1724#define new_XPVAV() (void*)new_xpvav()
1725#define del_XPVAV(p) del_xpvav((XPVAV *)p)
1726
1727#define new_XPVHV() (void*)new_xpvhv()
1728#define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1c846c1f 1729
d33b2eba
GS
1730#define new_XPVMG() (void*)new_xpvmg()
1731#define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1732
727879eb
NC
1733#define new_XPVGV() (void*)new_xpvgv()
1734#define del_XPVGV(p) del_xpvgv((XPVGV *)p)
1735
d33b2eba
GS
1736#define new_XPVLV() (void*)new_xpvlv()
1737#define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1738
1739#define new_XPVBM() (void*)new_xpvbm()
1740#define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1741
1742#endif /* PURIFY */
9b94d1dd 1743
d33b2eba
GS
1744#define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1745#define del_XPVFM(p) my_safefree(p)
1c846c1f 1746
d33b2eba
GS
1747#define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1748#define del_XPVIO(p) my_safefree(p)
8990e307 1749
954c1994
GS
1750/*
1751=for apidoc sv_upgrade
1752
ff276b08 1753Upgrade an SV to a more complex form. Generally adds a new body type to the
645c22ef 1754SV, then copies across as much information as possible from the old body.
ff276b08 1755You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
954c1994
GS
1756
1757=cut
1758*/
1759
79072805 1760bool
864dbfa3 1761Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
79072805 1762{
e763e3dc 1763
d2e56290
NC
1764 char* pv;
1765 U32 cur;
1766 U32 len;
1767 IV iv;
1768 NV nv;
1769 MAGIC* magic;
1770 HV* stash;
79072805 1771
765f542d
NC
1772 if (mt != SVt_PV && SvIsCOW(sv)) {
1773 sv_force_normal_flags(sv, 0);
f130fd45
NIS
1774 }
1775
79072805
LW
1776 if (SvTYPE(sv) == mt)
1777 return TRUE;
1778
d2e56290
NC
1779 pv = NULL;
1780 cur = 0;
1781 len = 0;
1782 iv = 0;
1783 nv = 0.0;
1784 magic = NULL;
1785 stash = Nullhv;
1786
79072805
LW
1787 switch (SvTYPE(sv)) {
1788 case SVt_NULL:
79072805 1789 break;
79072805 1790 case SVt_IV:
463ee0b2 1791 iv = SvIVX(sv);
ed6116ce 1792 if (mt == SVt_NV)
463ee0b2 1793 mt = SVt_PVNV;
ed6116ce
LW
1794 else if (mt < SVt_PVIV)
1795 mt = SVt_PVIV;
79072805
LW
1796 break;
1797 case SVt_NV:
463ee0b2 1798 nv = SvNVX(sv);
79072805 1799 del_XNV(SvANY(sv));
ed6116ce 1800 if (mt < SVt_PVNV)
79072805
LW
1801 mt = SVt_PVNV;
1802 break;
ed6116ce
LW
1803 case SVt_RV:
1804 pv = (char*)SvRV(sv);
ed6116ce 1805 break;
79072805 1806 case SVt_PV:
463ee0b2 1807 pv = SvPVX(sv);
79072805
LW
1808 cur = SvCUR(sv);
1809 len = SvLEN(sv);
79072805 1810 del_XPV(SvANY(sv));
748a9306
LW
1811 if (mt <= SVt_IV)
1812 mt = SVt_PVIV;
1813 else if (mt == SVt_NV)
1814 mt = SVt_PVNV;
79072805
LW
1815 break;
1816 case SVt_PVIV:
463ee0b2 1817 pv = SvPVX(sv);
79072805
LW
1818 cur = SvCUR(sv);
1819 len = SvLEN(sv);
463ee0b2 1820 iv = SvIVX(sv);
79072805
LW
1821 del_XPVIV(SvANY(sv));
1822 break;
1823 case SVt_PVNV:
463ee0b2 1824 pv = SvPVX(sv);
79072805
LW
1825 cur = SvCUR(sv);
1826 len = SvLEN(sv);
463ee0b2
LW
1827 iv = SvIVX(sv);
1828 nv = SvNVX(sv);
79072805
LW
1829 del_XPVNV(SvANY(sv));
1830 break;
1831 case SVt_PVMG:
0ec50a73
NC
1832 /* Because the XPVMG of PL_mess_sv isn't allocated from the arena,
1833 there's no way that it can be safely upgraded, because perl.c
1834 expects to Safefree(SvANY(PL_mess_sv)) */
1835 assert(sv != PL_mess_sv);
bce8f412
NC
1836 /* This flag bit is used to mean other things in other scalar types.
1837 Given that it only has meaning inside the pad, it shouldn't be set
1838 on anything that can get upgraded. */
1839 assert((SvFLAGS(sv) & SVpad_TYPED) == 0);
463ee0b2 1840 pv = SvPVX(sv);
79072805
LW
1841 cur = SvCUR(sv);
1842 len = SvLEN(sv);
463ee0b2
LW
1843 iv = SvIVX(sv);
1844 nv = SvNVX(sv);
79072805
LW
1845 magic = SvMAGIC(sv);
1846 stash = SvSTASH(sv);
1847 del_XPVMG(SvANY(sv));
1848 break;
1849 default:
cea2e8a9 1850 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
79072805
LW
1851 }
1852
ffb05e06
NC
1853 SvFLAGS(sv) &= ~SVTYPEMASK;
1854 SvFLAGS(sv) |= mt;
1855
79072805
LW
1856 switch (mt) {
1857 case SVt_NULL:
cea2e8a9 1858 Perl_croak(aTHX_ "Can't upgrade to undef");
79072805 1859 case SVt_IV:
339049b0 1860 SvANY(sv) = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
45977657 1861 SvIV_set(sv, iv);
79072805
LW
1862 break;
1863 case SVt_NV:
1864 SvANY(sv) = new_XNV();
9d6ce603 1865 SvNV_set(sv, nv);
79072805 1866 break;
ed6116ce 1867 case SVt_RV:
339049b0 1868 SvANY(sv) = &sv->sv_u.svu_rv;
b162af07 1869 SvRV_set(sv, (SV*)pv);
ed6116ce 1870 break;
79072805
LW
1871 case SVt_PVHV:
1872 SvANY(sv) = new_XPVHV();
463ee0b2
LW
1873 HvFILL(sv) = 0;
1874 HvMAX(sv) = 0;
8aacddc1 1875 HvTOTALKEYS(sv) = 0;
bd4b1eb5
NC
1876
1877 /* Fall through... */
1878 if (0) {
1879 case SVt_PVAV:
1880 SvANY(sv) = new_XPVAV();
1881 AvMAX(sv) = -1;
1882 AvFILLp(sv) = -1;
1883 AvALLOC(sv) = 0;
11ca45c0 1884 AvREAL_only(sv);
bd4b1eb5
NC
1885 }
1886 /* to here. */
c2bfdfaf
NC
1887 /* XXX? Only SVt_NULL is ever upgraded to AV or HV? */
1888 assert(!pv);
8bd4d4c5
NC
1889 /* FIXME. Should be able to remove all this if()... if the above
1890 assertion is genuinely always true. */
1891 if(SvOOK(sv)) {
1892 pv -= iv;
1893 SvFLAGS(sv) &= ~SVf_OOK;
1894 }
1895 Safefree(pv);
bd4b1eb5 1896 SvPV_set(sv, (char*)0);
b162af07
SP
1897 SvMAGIC_set(sv, magic);
1898 SvSTASH_set(sv, stash);
79072805 1899 break;
bd4b1eb5
NC
1900
1901 case SVt_PVIO:
1902 SvANY(sv) = new_XPVIO();
1903 Zero(SvANY(sv), 1, XPVIO);
1904 IoPAGE_LEN(sv) = 60;
1905 goto set_magic_common;
1906 case SVt_PVFM:
1907 SvANY(sv) = new_XPVFM();
1908 Zero(SvANY(sv), 1, XPVFM);
1909 goto set_magic_common;
1910 case SVt_PVBM:
1911 SvANY(sv) = new_XPVBM();
1912 BmRARE(sv) = 0;
1913 BmUSEFUL(sv) = 0;
1914 BmPREVIOUS(sv) = 0;
1915 goto set_magic_common;
1916 case SVt_PVGV:
1917 SvANY(sv) = new_XPVGV();
1918 GvGP(sv) = 0;
1919 GvNAME(sv) = 0;
1920 GvNAMELEN(sv) = 0;
1921 GvSTASH(sv) = 0;
1922 GvFLAGS(sv) = 0;
1923 goto set_magic_common;
79072805
LW
1924 case SVt_PVCV:
1925 SvANY(sv) = new_XPVCV();
748a9306 1926 Zero(SvANY(sv), 1, XPVCV);
bd4b1eb5
NC
1927 goto set_magic_common;
1928 case SVt_PVLV:
1929 SvANY(sv) = new_XPVLV();
1930 LvTARGOFF(sv) = 0;
1931 LvTARGLEN(sv) = 0;
1932 LvTARG(sv) = 0;
1933 LvTYPE(sv) = 0;
93a17b20 1934 GvGP(sv) = 0;
79072805
LW
1935 GvNAME(sv) = 0;
1936 GvNAMELEN(sv) = 0;
1937 GvSTASH(sv) = 0;
a5f75d66 1938 GvFLAGS(sv) = 0;
bd4b1eb5
NC
1939 /* Fall through. */
1940 if (0) {
1941 case SVt_PVMG:
1942 SvANY(sv) = new_XPVMG();
1943 }
1944 set_magic_common:
b162af07
SP
1945 SvMAGIC_set(sv, magic);
1946 SvSTASH_set(sv, stash);
bd4b1eb5
NC
1947 /* Fall through. */
1948 if (0) {
1949 case SVt_PVNV:
1950 SvANY(sv) = new_XPVNV();
1951 }
9d6ce603 1952 SvNV_set(sv, nv);
bd4b1eb5
NC
1953 /* Fall through. */
1954 if (0) {
1955 case SVt_PVIV:
1956 SvANY(sv) = new_XPVIV();
1957 if (SvNIOK(sv))
1958 (void)SvIOK_on(sv);
1959 SvNOK_off(sv);
1960 }
1961 SvIV_set(sv, iv);
1962 /* Fall through. */
1963 if (0) {
1964 case SVt_PV:
1965 SvANY(sv) = new_XPV();
1966 }
f880fe2f 1967 SvPV_set(sv, pv);
b162af07
SP
1968 SvCUR_set(sv, cur);
1969 SvLEN_set(sv, len);
8990e307
LW
1970 break;
1971 }
79072805
LW
1972 return TRUE;
1973}
1974
645c22ef
DM
1975/*
1976=for apidoc sv_backoff
1977
1978Remove any string offset. You should normally use the C<SvOOK_off> macro
1979wrapper instead.
1980
1981=cut
1982*/
1983
79072805 1984int
864dbfa3 1985Perl_sv_backoff(pTHX_ register SV *sv)
79072805
LW
1986{
1987 assert(SvOOK(sv));
b79f7545
NC
1988 assert(SvTYPE(sv) != SVt_PVHV);
1989 assert(SvTYPE(sv) != SVt_PVAV);
463ee0b2 1990 if (SvIVX(sv)) {
3f7c398e 1991 const char *s = SvPVX_const(sv);
b162af07 1992 SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
f880fe2f 1993 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
79072805 1994 SvIV_set(sv, 0);
463ee0b2 1995 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
79072805
LW
1996 }
1997 SvFLAGS(sv) &= ~SVf_OOK;
a0d0e21e 1998 return 0;
79072805
LW
1999}
2000
954c1994
GS
2001/*
2002=for apidoc sv_grow
2003
645c22ef
DM
2004Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
2005upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2006Use the C<SvGROW> wrapper instead.
954c1994
GS
2007
2008=cut
2009*/
2010
79072805 2011char *
864dbfa3 2012Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
79072805
LW
2013{
2014 register char *s;
2015
55497cff 2016#ifdef HAS_64K_LIMIT
79072805 2017 if (newlen >= 0x10000) {
1d7c1841
GS
2018 PerlIO_printf(Perl_debug_log,
2019 "Allocation too large: %"UVxf"\n", (UV)newlen);
79072805
LW
2020 my_exit(1);
2021 }
55497cff 2022#endif /* HAS_64K_LIMIT */
a0d0e21e
LW
2023 if (SvROK(sv))
2024 sv_unref(sv);
79072805
LW
2025 if (SvTYPE(sv) < SVt_PV) {
2026 sv_upgrade(sv, SVt_PV);
463ee0b2 2027 s = SvPVX(sv);
79072805
LW
2028 }
2029 else if (SvOOK(sv)) { /* pv is offset? */
2030 sv_backoff(sv);
463ee0b2 2031 s = SvPVX(sv);
79072805
LW
2032 if (newlen > SvLEN(sv))
2033 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
c6f8c383
GA
2034#ifdef HAS_64K_LIMIT
2035 if (newlen >= 0x10000)
2036 newlen = 0xFFFF;
2037#endif
79072805 2038 }
bc44a8a2 2039 else
463ee0b2 2040 s = SvPVX(sv);
54f0641b 2041
79072805 2042 if (newlen > SvLEN(sv)) { /* need more room? */
7a9b70e9 2043 newlen = PERL_STRLEN_ROUNDUP(newlen);
8d6dde3e 2044 if (SvLEN(sv) && s) {
7bab3ede 2045#ifdef MYMALLOC
a3b680e6 2046 const STRLEN l = malloced_size((void*)SvPVX(sv));
8d6dde3e
IZ
2047 if (newlen <= l) {
2048 SvLEN_set(sv, l);
2049 return s;
2050 } else
c70c8a0a 2051#endif
1936d2a7 2052 s = saferealloc(s, newlen);
8d6dde3e 2053 }
bfed75c6 2054 else {
1936d2a7 2055 s = safemalloc(newlen);
3f7c398e
SP
2056 if (SvPVX_const(sv) && SvCUR(sv)) {
2057 Move(SvPVX_const(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
40565179 2058 }
4e83176d 2059 }
79072805 2060 SvPV_set(sv, s);
e1ec3a88 2061 SvLEN_set(sv, newlen);
79072805
LW
2062 }
2063 return s;
2064}
2065
954c1994
GS
2066/*
2067=for apidoc sv_setiv
2068
645c22ef
DM
2069Copies an integer into the given SV, upgrading first if necessary.
2070Does not handle 'set' magic. See also C<sv_setiv_mg>.
954c1994
GS
2071
2072=cut
2073*/
2074
79072805 2075void
864dbfa3 2076Perl_sv_setiv(pTHX_ register SV *sv, IV i)
79072805 2077{
765f542d 2078 SV_CHECK_THINKFIRST_COW_DROP(sv);
463ee0b2
LW
2079 switch (SvTYPE(sv)) {
2080 case SVt_NULL:
79072805 2081 sv_upgrade(sv, SVt_IV);
463ee0b2
LW
2082 break;
2083 case SVt_NV:
2084 sv_upgrade(sv, SVt_PVNV);
2085 break;
ed6116ce 2086 case SVt_RV:
463ee0b2 2087 case SVt_PV:
79072805 2088 sv_upgrade(sv, SVt_PVIV);
463ee0b2 2089 break;
a0d0e21e
LW
2090
2091 case SVt_PVGV:
a0d0e21e
LW
2092 case SVt_PVAV:
2093 case SVt_PVHV:
2094 case SVt_PVCV:
2095 case SVt_PVFM:
2096 case SVt_PVIO:
411caa50 2097 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
53e06cf0 2098 OP_DESC(PL_op));
463ee0b2 2099 }
a0d0e21e 2100 (void)SvIOK_only(sv); /* validate number */
45977657 2101 SvIV_set(sv, i);
463ee0b2 2102 SvTAINT(sv);
79072805
LW
2103}
2104
954c1994
GS
2105/*
2106=for apidoc sv_setiv_mg
2107
2108Like C<sv_setiv>, but also handles 'set' magic.
2109
2110=cut
2111*/
2112
79072805 2113void
864dbfa3 2114Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
ef50df4b
GS
2115{
2116 sv_setiv(sv,i);
2117 SvSETMAGIC(sv);
2118}
2119
954c1994
GS
2120/*
2121=for apidoc sv_setuv
2122
645c22ef
DM
2123Copies an unsigned integer into the given SV, upgrading first if necessary.
2124Does not handle 'set' magic. See also C<sv_setuv_mg>.
954c1994
GS
2125
2126=cut
2127*/
2128
ef50df4b 2129void
864dbfa3 2130Perl_sv_setuv(pTHX_ register SV *sv, UV u)
55497cff 2131{
55ada374
NC
2132 /* With these two if statements:
2133 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
d460ef45 2134
55ada374
NC
2135 without
2136 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
d460ef45 2137
55ada374
NC
2138 If you wish to remove them, please benchmark to see what the effect is
2139 */
28e5dec8
JH
2140 if (u <= (UV)IV_MAX) {
2141 sv_setiv(sv, (IV)u);
2142 return;
2143 }
25da4f38
IZ
2144 sv_setiv(sv, 0);
2145 SvIsUV_on(sv);
607fa7f2 2146 SvUV_set(sv, u);
55497cff 2147}
2148
954c1994
GS
2149/*
2150=for apidoc sv_setuv_mg
2151
2152Like C<sv_setuv>, but also handles 'set' magic.
2153
2154=cut
2155*/
2156
55497cff 2157void
864dbfa3 2158Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
ef50df4b 2159{
55ada374
NC
2160 /* With these two if statements:
2161 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
d460ef45 2162
55ada374
NC
2163 without
2164 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
d460ef45 2165
55ada374
NC
2166 If you wish to remove them, please benchmark to see what the effect is
2167 */
28e5dec8
JH
2168 if (u <= (UV)IV_MAX) {
2169 sv_setiv(sv, (IV)u);
2170 } else {
2171 sv_setiv(sv, 0);
2172 SvIsUV_on(sv);
2173 sv_setuv(sv,u);
2174 }
ef50df4b
GS
2175 SvSETMAGIC(sv);
2176}
2177
954c1994
GS
2178/*
2179=for apidoc sv_setnv
2180
645c22ef
DM
2181Copies a double into the given SV, upgrading first if necessary.
2182Does not handle 'set' magic. See also C<sv_setnv_mg>.
954c1994
GS
2183
2184=cut
2185*/
2186
ef50df4b 2187void
65202027 2188Perl_sv_setnv(pTHX_ register SV *sv, NV num)
79072805 2189{
765f542d 2190 SV_CHECK_THINKFIRST_COW_DROP(sv);
a0d0e21e
LW
2191 switch (SvTYPE(sv)) {
2192 case SVt_NULL:
2193 case SVt_IV:
79072805 2194 sv_upgrade(sv, SVt_NV);
a0d0e21e 2195 break;
a0d0e21e
LW
2196 case SVt_RV:
2197 case SVt_PV:
2198 case SVt_PVIV:
79072805 2199 sv_upgrade(sv, SVt_PVNV);
a0d0e21e 2200 break;
827b7e14 2201
a0d0e21e 2202 case SVt_PVGV:
a0d0e21e
LW
2203 case SVt_PVAV:
2204 case SVt_PVHV:
2205 case SVt_PVCV:
2206 case SVt_PVFM:
2207 case SVt_PVIO:
411caa50 2208 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
53e06cf0 2209 OP_NAME(PL_op));
79072805 2210 }
9d6ce603 2211 SvNV_set(sv, num);
a0d0e21e 2212 (void)SvNOK_only(sv); /* validate number */
463ee0b2 2213 SvTAINT(sv);
79072805
LW
2214}
2215
954c1994
GS
2216/*
2217=for apidoc sv_setnv_mg
2218
2219Like C<sv_setnv>, but also handles 'set' magic.
2220
2221=cut
2222*/
2223
ef50df4b 2224void
65202027 2225Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
ef50df4b
GS
2226{
2227 sv_setnv(sv,num);
2228 SvSETMAGIC(sv);
2229}
2230
645c22ef
DM
2231/* Print an "isn't numeric" warning, using a cleaned-up,
2232 * printable version of the offending string
2233 */
2234
76e3520e 2235STATIC void
cea2e8a9 2236S_not_a_number(pTHX_ SV *sv)
a0d0e21e 2237{
94463019
JH
2238 SV *dsv;
2239 char tmpbuf[64];
2240 char *pv;
2241
2242 if (DO_UTF8(sv)) {
2243 dsv = sv_2mortal(newSVpv("", 0));
2244 pv = sv_uni_display(dsv, sv, 10, 0);
2245 } else {
2246 char *d = tmpbuf;
2247 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
2248 /* each *s can expand to 4 chars + "...\0",
2249 i.e. need room for 8 chars */
ecdeb87c 2250
94463019
JH
2251 char *s, *end;
2252 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
2253 int ch = *s & 0xFF;
2254 if (ch & 128 && !isPRINT_LC(ch)) {
2255 *d++ = 'M';
2256 *d++ = '-';
2257 ch &= 127;
2258 }
2259 if (ch == '\n') {
2260 *d++ = '\\';
2261 *d++ = 'n';
2262 }
2263 else if (ch == '\r') {
2264 *d++ = '\\';
2265 *d++ = 'r';
2266 }
2267 else if (ch == '\f') {
2268 *d++ = '\\';
2269 *d++ = 'f';
2270 }
2271 else if (ch == '\\') {
2272 *d++ = '\\';
2273 *d++ = '\\';
2274 }
2275 else if (ch == '\0') {
2276 *d++ = '\\';
2277 *d++ = '0';
2278 }
2279 else if (isPRINT_LC(ch))
2280 *d++ = ch;
2281 else {
2282 *d++ = '^';
2283 *d++ = toCTRL(ch);
2284 }
2285 }
2286 if (s < end) {
2287 *d++ = '.';
2288 *d++ = '.';
2289 *d++ = '.';
2290 }
2291 *d = '\0';
2292 pv = tmpbuf;
a0d0e21e 2293 }
a0d0e21e 2294
533c011a 2295 if (PL_op)
9014280d 2296 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
94463019
JH
2297 "Argument \"%s\" isn't numeric in %s", pv,
2298 OP_DESC(PL_op));
a0d0e21e 2299 else
9014280d 2300 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
94463019 2301 "Argument \"%s\" isn't numeric", pv);
a0d0e21e
LW
2302}
2303
c2988b20
NC
2304/*
2305=for apidoc looks_like_number
2306
645c22ef
DM
2307Test if the content of an SV looks like a number (or is a number).
2308C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2309non-numeric warning), even if your atof() doesn't grok them.
c2988b20
NC
2310
2311=cut
2312*/
2313
2314I32
2315Perl_looks_like_number(pTHX_ SV *sv)
2316{
a3b680e6 2317 register const char *sbegin;
c2988b20
NC
2318 STRLEN len;
2319
2320 if (SvPOK(sv)) {
3f7c398e 2321 sbegin = SvPVX_const(sv);
c2988b20
NC
2322 len = SvCUR(sv);
2323 }
2324 else if (SvPOKp(sv))
2325 sbegin = SvPV(sv, len);
2326 else
e0ab1c0e 2327 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
c2988b20
NC
2328 return grok_number(sbegin, len, NULL);
2329}
25da4f38
IZ
2330
2331/* Actually, ISO C leaves conversion of UV to IV undefined, but
2332 until proven guilty, assume that things are not that bad... */
2333
645c22ef
DM
2334/*
2335 NV_PRESERVES_UV:
2336
2337 As 64 bit platforms often have an NV that doesn't preserve all bits of
28e5dec8
JH
2338 an IV (an assumption perl has been based on to date) it becomes necessary
2339 to remove the assumption that the NV always carries enough precision to
2340 recreate the IV whenever needed, and that the NV is the canonical form.
2341 Instead, IV/UV and NV need to be given equal rights. So as to not lose
645c22ef 2342 precision as a side effect of conversion (which would lead to insanity
28e5dec8
JH
2343 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2344 1) to distinguish between IV/UV/NV slots that have cached a valid
2345 conversion where precision was lost and IV/UV/NV slots that have a
2346 valid conversion which has lost no precision
645c22ef 2347 2) to ensure that if a numeric conversion to one form is requested that
28e5dec8
JH
2348 would lose precision, the precise conversion (or differently
2349 imprecise conversion) is also performed and cached, to prevent
2350 requests for different numeric formats on the same SV causing
2351 lossy conversion chains. (lossless conversion chains are perfectly
2352 acceptable (still))
2353
2354
2355 flags are used:
2356 SvIOKp is true if the IV slot contains a valid value
2357 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
2358 SvNOKp is true if the NV slot contains a valid value
2359 SvNOK is true only if the NV value is accurate
2360
2361 so
645c22ef 2362 while converting from PV to NV, check to see if converting that NV to an
28e5dec8
JH
2363 IV(or UV) would lose accuracy over a direct conversion from PV to
2364 IV(or UV). If it would, cache both conversions, return NV, but mark
2365 SV as IOK NOKp (ie not NOK).
2366
645c22ef 2367 While converting from PV to IV, check to see if converting that IV to an
28e5dec8
JH
2368 NV would lose accuracy over a direct conversion from PV to NV. If it
2369 would, cache both conversions, flag similarly.
2370
2371 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2372 correctly because if IV & NV were set NV *always* overruled.
645c22ef
DM
2373 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2374 changes - now IV and NV together means that the two are interchangeable:
28e5dec8 2375 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
d460ef45 2376
645c22ef
DM
2377 The benefit of this is that operations such as pp_add know that if
2378 SvIOK is true for both left and right operands, then integer addition
2379 can be used instead of floating point (for cases where the result won't
2380 overflow). Before, floating point was always used, which could lead to
28e5dec8
JH
2381 loss of precision compared with integer addition.
2382
2383 * making IV and NV equal status should make maths accurate on 64 bit
2384 platforms
2385 * may speed up maths somewhat if pp_add and friends start to use
645c22ef 2386 integers when possible instead of fp. (Hopefully the overhead in
28e5dec8
JH
2387 looking for SvIOK and checking for overflow will not outweigh the
2388 fp to integer speedup)
2389 * will slow down integer operations (callers of SvIV) on "inaccurate"
2390 values, as the change from SvIOK to SvIOKp will cause a call into
2391 sv_2iv each time rather than a macro access direct to the IV slot
2392 * should speed up number->string conversion on integers as IV is
645c22ef 2393 favoured when IV and NV are equally accurate
28e5dec8
JH
2394
2395 ####################################################################
645c22ef
DM
2396 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2397 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2398 On the other hand, SvUOK is true iff UV.
28e5dec8
JH
2399 ####################################################################
2400
645c22ef 2401 Your mileage will vary depending your CPU's relative fp to integer
28e5dec8
JH
2402 performance ratio.
2403*/
2404
2405#ifndef NV_PRESERVES_UV
645c22ef
DM
2406# define IS_NUMBER_UNDERFLOW_IV 1
2407# define IS_NUMBER_UNDERFLOW_UV 2
2408# define IS_NUMBER_IV_AND_UV 2
2409# define IS_NUMBER_OVERFLOW_IV 4
2410# define IS_NUMBER_OVERFLOW_UV 5
2411
2412/* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
28e5dec8
JH
2413
2414/* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2415STATIC int
645c22ef 2416S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
28e5dec8 2417{
3f7c398e 2418 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX_const(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
28e5dec8
JH
2419 if (SvNVX(sv) < (NV)IV_MIN) {
2420 (void)SvIOKp_on(sv);
2421 (void)SvNOK_on(sv);
45977657 2422 SvIV_set(sv, IV_MIN);
28e5dec8
JH
2423 return IS_NUMBER_UNDERFLOW_IV;
2424 }
2425 if (SvNVX(sv) > (NV)UV_MAX) {
2426 (void)SvIOKp_on(sv);
2427 (void)SvNOK_on(sv);
2428 SvIsUV_on(sv);
607fa7f2 2429 SvUV_set(sv, UV_MAX);
28e5dec8
JH
2430 return IS_NUMBER_OVERFLOW_UV;
2431 }
c2988b20
NC
2432 (void)SvIOKp_on(sv);
2433 (void)SvNOK_on(sv);
2434 /* Can't use strtol etc to convert this string. (See truth table in
2435 sv_2iv */
2436 if (SvNVX(sv) <= (UV)IV_MAX) {
45977657 2437 SvIV_set(sv, I_V(SvNVX(sv)));
c2988b20
NC
2438 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2439 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2440 } else {
2441 /* Integer is imprecise. NOK, IOKp */
2442 }
2443 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2444 }
2445 SvIsUV_on(sv);
607fa7f2 2446 SvUV_set(sv, U_V(SvNVX(sv)));
c2988b20
NC
2447 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2448 if (SvUVX(sv) == UV_MAX) {
2449 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2450 possibly be preserved by NV. Hence, it must be overflow.
2451 NOK, IOKp */
2452 return IS_NUMBER_OVERFLOW_UV;
2453 }
2454 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2455 } else {
2456 /* Integer is imprecise. NOK, IOKp */
28e5dec8 2457 }
c2988b20 2458 return IS_NUMBER_OVERFLOW_IV;
28e5dec8 2459}
645c22ef
DM
2460#endif /* !NV_PRESERVES_UV*/
2461
891f9566
YST
2462/* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2463 * this function provided for binary compatibility only
2464 */
2465
2466IV
2467Perl_sv_2iv(pTHX_ register SV *sv)
2468{
2469 return sv_2iv_flags(sv, SV_GMAGIC);
2470}
2471
645c22ef 2472/*
891f9566 2473=for apidoc sv_2iv_flags
645c22ef 2474
891f9566
YST
2475Return the integer value of an SV, doing any necessary string
2476conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2477Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
645c22ef
DM
2478
2479=cut
2480*/
28e5dec8 2481
a0d0e21e 2482IV
891f9566 2483Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
79072805
LW
2484{
2485 if (!sv)
2486 return 0;
8990e307 2487 if (SvGMAGICAL(sv)) {
891f9566
YST
2488 if (flags & SV_GMAGIC)
2489 mg_get(sv);
463ee0b2
LW
2490 if (SvIOKp(sv))
2491 return SvIVX(sv);
748a9306 2492 if (SvNOKp(sv)) {
25da4f38 2493 return I_V(SvNVX(sv));
748a9306 2494 }
36477c24 2495 if (SvPOKp(sv) && SvLEN(sv))
2496 return asIV(sv);
3fe9a6f1 2497 if (!SvROK(sv)) {
d008e5eb 2498 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 2499 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
29489e7c 2500 report_uninit(sv);
c6ee37c5 2501 }
36477c24 2502 return 0;
3fe9a6f1 2503 }
463ee0b2 2504 }
ed6116ce 2505 if (SvTHINKFIRST(sv)) {
a0d0e21e 2506 if (SvROK(sv)) {
a0d0e21e 2507 SV* tmpstr;
1554e226 2508 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
b4b9a328 2509 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
9e7bc3e8 2510 return SvIV(tmpstr);
56431972 2511 return PTR2IV(SvRV(sv));
a0d0e21e 2512 }
765f542d
NC
2513 if (SvIsCOW(sv)) {
2514 sv_force_normal_flags(sv, 0);
47deb5e7 2515 }
0336b60e 2516 if (SvREADONLY(sv) && !SvOK(sv)) {
0336b60e 2517 if (ckWARN(WARN_UNINITIALIZED))
29489e7c 2518 report_uninit(sv);
ed6116ce
LW
2519 return 0;
2520 }
79072805 2521 }
25da4f38
IZ
2522 if (SvIOKp(sv)) {
2523 if (SvIsUV(sv)) {
2524 return (IV)(SvUVX(sv));
2525 }
2526 else {
2527 return SvIVX(sv);
2528 }
463ee0b2 2529 }
748a9306 2530 if (SvNOKp(sv)) {
28e5dec8
JH
2531 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2532 * without also getting a cached IV/UV from it at the same time
2533 * (ie PV->NV conversion should detect loss of accuracy and cache
2534 * IV or UV at same time to avoid this. NWC */
25da4f38
IZ
2535
2536 if (SvTYPE(sv) == SVt_NV)
2537 sv_upgrade(sv, SVt_PVNV);
2538
28e5dec8
JH
2539 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2540 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2541 certainly cast into the IV range at IV_MAX, whereas the correct
2542 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2543 cases go to UV */
2544 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
45977657 2545 SvIV_set(sv, I_V(SvNVX(sv)));
28e5dec8
JH
2546 if (SvNVX(sv) == (NV) SvIVX(sv)
2547#ifndef NV_PRESERVES_UV
2548 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2549 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2550 /* Don't flag it as "accurately an integer" if the number
2551 came from a (by definition imprecise) NV operation, and
2552 we're outside the range of NV integer precision */
2553#endif
2554 ) {
2555 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2556 DEBUG_c(PerlIO_printf(Perl_debug_log,
7234c960 2557 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
28e5dec8
JH
2558 PTR2UV(sv),
2559 SvNVX(sv),
2560 SvIVX(sv)));
2561
2562 } else {
2563 /* IV not precise. No need to convert from PV, as NV
2564 conversion would already have cached IV if it detected
2565 that PV->IV would be better than PV->NV->IV
2566 flags already correct - don't set public IOK. */
2567 DEBUG_c(PerlIO_printf(Perl_debug_log,
7234c960 2568 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
28e5dec8
JH
2569 PTR2UV(sv),
2570 SvNVX(sv),
2571 SvIVX(sv)));
2572 }
2573 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2574 but the cast (NV)IV_MIN rounds to a the value less (more
2575 negative) than IV_MIN which happens to be equal to SvNVX ??
2576 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2577 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2578 (NV)UVX == NVX are both true, but the values differ. :-(
2579 Hopefully for 2s complement IV_MIN is something like
2580 0x8000000000000000 which will be exact. NWC */
d460ef45 2581 }
25da4f38 2582 else {
607fa7f2 2583 SvUV_set(sv, U_V(SvNVX(sv)));
28e5dec8
JH
2584 if (
2585 (SvNVX(sv) == (NV) SvUVX(sv))
2586#ifndef NV_PRESERVES_UV
2587 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2588 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2589 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2590 /* Don't flag it as "accurately an integer" if the number
2591 came from a (by definition imprecise) NV operation, and
2592 we're outside the range of NV integer precision */
2593#endif
2594 )
2595 SvIOK_on(sv);
25da4f38
IZ
2596 SvIsUV_on(sv);
2597 ret_iv_max:
1c846c1f 2598 DEBUG_c(PerlIO_printf(Perl_debug_log,
57def98f 2599 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
56431972 2600 PTR2UV(sv),
57def98f
JH
2601 SvUVX(sv),
2602 SvUVX(sv)));
25da4f38
IZ
2603 return (IV)SvUVX(sv);
2604 }
748a9306
LW
2605 }
2606 else if (SvPOKp(sv) && SvLEN(sv)) {
c2988b20 2607 UV value;
504618e9 2608 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
25da4f38
IZ
2609 /* We want to avoid a possible problem when we cache an IV which
2610 may be later translated to an NV, and the resulting NV is not
c2988b20
NC
2611 the same as the direct translation of the initial string
2612 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2613 be careful to ensure that the value with the .456 is around if the
2614 NV value is requested in the future).
1c846c1f 2615
25da4f38
IZ
2616 This means that if we cache such an IV, we need to cache the
2617 NV as well. Moreover, we trade speed for space, and do not
28e5dec8 2618 cache the NV if we are sure it's not needed.
25da4f38 2619 */
16b7a9a4 2620
c2988b20
NC
2621 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2622 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2623 == IS_NUMBER_IN_UV) {
5e045b90 2624 /* It's definitely an integer, only upgrade to PVIV */
28e5dec8
JH
2625 if (SvTYPE(sv) < SVt_PVIV)
2626 sv_upgrade(sv, SVt_PVIV);
f7bbb42a 2627 (void)SvIOK_on(sv);
c2988b20
NC
2628 } else if (SvTYPE(sv) < SVt_PVNV)
2629 sv_upgrade(sv, SVt_PVNV);
28e5dec8 2630
c2988b20
NC
2631 /* If NV preserves UV then we only use the UV value if we know that
2632 we aren't going to call atof() below. If NVs don't preserve UVs
2633 then the value returned may have more precision than atof() will
2634 return, even though value isn't perfectly accurate. */
2635 if ((numtype & (IS_NUMBER_IN_UV
2636#ifdef NV_PRESERVES_UV
2637 | IS_NUMBER_NOT_INT
2638#endif
2639 )) == IS_NUMBER_IN_UV) {
2640 /* This won't turn off the public IOK flag if it was set above */
2641 (void)SvIOKp_on(sv);
2642
2643 if (!(numtype & IS_NUMBER_NEG)) {
2644 /* positive */;
2645 if (value <= (UV)IV_MAX) {
45977657 2646 SvIV_set(sv, (IV)value);
c2988b20 2647 } else {
607fa7f2 2648 SvUV_set(sv, value);
c2988b20
NC
2649 SvIsUV_on(sv);
2650 }
2651 } else {
2652 /* 2s complement assumption */
2653 if (value <= (UV)IV_MIN) {
45977657 2654 SvIV_set(sv, -(IV)value);
c2988b20
NC
2655 } else {
2656 /* Too negative for an IV. This is a double upgrade, but
d1be9408 2657 I'm assuming it will be rare. */
c2988b20
NC
2658 if (SvTYPE(sv) < SVt_PVNV)
2659 sv_upgrade(sv, SVt_PVNV);
2660 SvNOK_on(sv);
2661 SvIOK_off(sv);
2662 SvIOKp_on(sv);
9d6ce603 2663 SvNV_set(sv, -(NV)value);
45977657 2664 SvIV_set(sv, IV_MIN);
c2988b20
NC
2665 }
2666 }
2667 }
2668 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2669 will be in the previous block to set the IV slot, and the next
2670 block to set the NV slot. So no else here. */
2671
2672 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2673 != IS_NUMBER_IN_UV) {
2674 /* It wasn't an (integer that doesn't overflow the UV). */
3f7c398e 2675 SvNV_set(sv, Atof(SvPVX_const(sv)));
28e5dec8 2676
c2988b20
NC
2677 if (! numtype && ckWARN(WARN_NUMERIC))
2678 not_a_number(sv);
28e5dec8 2679
65202027 2680#if defined(USE_LONG_DOUBLE)
c2988b20
NC
2681 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2682 PTR2UV(sv), SvNVX(sv)));
65202027 2683#else
1779d84d 2684 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
c2988b20 2685 PTR2UV(sv), SvNVX(sv)));
65202027 2686#endif
28e5dec8
JH
2687
2688
2689#ifdef NV_PRESERVES_UV
c2988b20
NC
2690 (void)SvIOKp_on(sv);
2691 (void)SvNOK_on(sv);
2692 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
45977657 2693 SvIV_set(sv, I_V(SvNVX(sv)));
c2988b20
NC
2694 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2695 SvIOK_on(sv);
28e5dec8 2696 } else {
c2988b20
NC
2697 /* Integer is imprecise. NOK, IOKp */
2698 }
2699 /* UV will not work better than IV */
2700 } else {
2701 if (SvNVX(sv) > (NV)UV_MAX) {
2702 SvIsUV_on(sv);
2703 /* Integer is inaccurate. NOK, IOKp, is UV */
607fa7f2 2704 SvUV_set(sv, UV_MAX);
c2988b20
NC
2705 SvIsUV_on(sv);
2706 } else {
607fa7f2 2707 SvUV_set(sv, U_V(SvNVX(sv)));
c2988b20
NC
2708 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2709 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2710 SvIOK_on(sv);
28e5dec8
JH
2711 SvIsUV_on(sv);
2712 } else {
c2988b20
NC
2713 /* Integer is imprecise. NOK, IOKp, is UV */
2714 SvIsUV_on(sv);
28e5dec8 2715 }
28e5dec8 2716 }
c2988b20
NC
2717 goto ret_iv_max;
2718 }
28e5dec8 2719#else /* NV_PRESERVES_UV */
c2988b20
NC
2720 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2721 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2722 /* The IV slot will have been set from value returned by
2723 grok_number above. The NV slot has just been set using
2724 Atof. */
560b0c46 2725 SvNOK_on(sv);
c2988b20
NC
2726 assert (SvIOKp(sv));
2727 } else {
2728 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2729 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2730 /* Small enough to preserve all bits. */
2731 (void)SvIOKp_on(sv);
2732 SvNOK_on(sv);
45977657 2733 SvIV_set(sv, I_V(SvNVX(sv)));
c2988b20
NC
2734 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2735 SvIOK_on(sv);
2736 /* Assumption: first non-preserved integer is < IV_MAX,
2737 this NV is in the preserved range, therefore: */
2738 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2739 < (UV)IV_MAX)) {
32fdb065 2740 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);
c2988b20
NC
2741 }
2742 } else {
2743 /* IN_UV NOT_INT
2744 0 0 already failed to read UV.
2745 0 1 already failed to read UV.
2746 1 0 you won't get here in this case. IV/UV
2747 slot set, public IOK, Atof() unneeded.
2748 1 1 already read UV.
2749 so there's no point in sv_2iuv_non_preserve() attempting
2750 to use atol, strtol, strtoul etc. */
2751 if (sv_2iuv_non_preserve (sv, numtype)
2752 >= IS_NUMBER_OVERFLOW_IV)
2753 goto ret_iv_max;
2754 }
2755 }
28e5dec8 2756#endif /* NV_PRESERVES_UV */
25da4f38 2757 }
28e5dec8 2758 } else {
599cee73 2759 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
29489e7c 2760 report_uninit(sv);
25da4f38
IZ
2761 if (SvTYPE(sv) < SVt_IV)
2762 /* Typically the caller expects that sv_any is not NULL now. */
2763 sv_upgrade(sv, SVt_IV);
a0d0e21e 2764 return 0;
79072805 2765 }
1d7c1841
GS
2766 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2767 PTR2UV(sv),SvIVX(sv)));
25da4f38 2768 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
79072805
LW
2769}
2770
891f9566
YST
2771/* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2772 * this function provided for binary compatibility only
2773 */
2774
2775UV
2776Perl_sv_2uv(pTHX_ register SV *sv)
2777{
2778 return sv_2uv_flags(sv, SV_GMAGIC);
2779}
2780
645c22ef 2781/*
891f9566 2782=for apidoc sv_2uv_flags
645c22ef
DM
2783
2784Return the unsigned integer value of an SV, doing any necessary string
891f9566
YST
2785conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2786Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
645c22ef
DM
2787
2788=cut
2789*/
2790
ff68c719 2791UV
891f9566 2792Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
ff68c719 2793{
2794 if (!sv)
2795 return 0;
2796 if (SvGMAGICAL(sv)) {
891f9566
YST
2797 if (flags & SV_GMAGIC)
2798 mg_get(sv);
ff68c719 2799 if (SvIOKp(sv))
2800 return SvUVX(sv);
2801 if (SvNOKp(sv))
2802 return U_V(SvNVX(sv));
36477c24 2803 if (SvPOKp(sv) && SvLEN(sv))
2804 return asUV(sv);
3fe9a6f1 2805 if (!SvROK(sv)) {
d008e5eb 2806 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 2807 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
29489e7c 2808 report_uninit(sv);
c6ee37c5 2809 }
36477c24 2810 return 0;
3fe9a6f1 2811 }
ff68c719 2812 }
2813 if (SvTHINKFIRST(sv)) {
2814 if (SvROK(sv)) {
ff68c719 2815 SV* tmpstr;
1554e226 2816 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
b4b9a328 2817 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
9e7bc3e8 2818 return SvUV(tmpstr);
56431972 2819 return PTR2UV(SvRV(sv));
ff68c719 2820 }
765f542d
NC
2821 if (SvIsCOW(sv)) {
2822 sv_force_normal_flags(sv, 0);
8a818333 2823 }
0336b60e 2824 if (SvREADONLY(sv) && !SvOK(sv)) {
0336b60e 2825 if (ckWARN(WARN_UNINITIALIZED))
29489e7c 2826 report_uninit(sv);
ff68c719 2827 return 0;
2828 }
2829 }
25da4f38
IZ
2830 if (SvIOKp(sv)) {
2831 if (SvIsUV(sv)) {
2832 return SvUVX(sv);
2833 }
2834 else {
2835 return (UV)SvIVX(sv);
2836 }
ff68c719 2837 }
2838 if (SvNOKp(sv)) {
28e5dec8
JH
2839 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2840 * without also getting a cached IV/UV from it at the same time
2841 * (ie PV->NV conversion should detect loss of accuracy and cache
2842 * IV or UV at same time to avoid this. */
2843 /* IV-over-UV optimisation - choose to cache IV if possible */
2844
25da4f38
IZ
2845 if (SvTYPE(sv) == SVt_NV)
2846 sv_upgrade(sv, SVt_PVNV);
28e5dec8
JH
2847
2848 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2849 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
45977657 2850 SvIV_set(sv, I_V(SvNVX(sv)));
28e5dec8
JH
2851 if (SvNVX(sv) == (NV) SvIVX(sv)
2852#ifndef NV_PRESERVES_UV
2853 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2854 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2855 /* Don't flag it as "accurately an integer" if the number
2856 came from a (by definition imprecise) NV operation, and
2857 we're outside the range of NV integer precision */
2858#endif
2859 ) {
2860 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2861 DEBUG_c(PerlIO_printf(Perl_debug_log,
7234c960 2862 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
28e5dec8
JH
2863 PTR2UV(sv),
2864 SvNVX(sv),
2865 SvIVX(sv)));
2866
2867 } else {
2868 /* IV not precise. No need to convert from PV, as NV
2869 conversion would already have cached IV if it detected
2870 that PV->IV would be better than PV->NV->IV
2871 flags already correct - don't set public IOK. */
2872 DEBUG_c(PerlIO_printf(Perl_debug_log,
7234c960 2873 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
28e5dec8
JH
2874 PTR2UV(sv),
2875 SvNVX(sv),
2876 SvIVX(sv)));
2877 }
2878 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2879 but the cast (NV)IV_MIN rounds to a the value less (more
2880 negative) than IV_MIN which happens to be equal to SvNVX ??
2881 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2882 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2883 (NV)UVX == NVX are both true, but the values differ. :-(
2884 Hopefully for 2s complement IV_MIN is something like
2885 0x8000000000000000 which will be exact. NWC */
d460ef45 2886 }
28e5dec8 2887 else {
607fa7f2 2888 SvUV_set(sv, U_V(SvNVX(sv)));
28e5dec8
JH
2889 if (
2890 (SvNVX(sv) == (NV) SvUVX(sv))
2891#ifndef NV_PRESERVES_UV
2892 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2893 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2894 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2895 /* Don't flag it as "accurately an integer" if the number
2896 came from a (by definition imprecise) NV operation, and
2897 we're outside the range of NV integer precision */
2898#endif
2899 )
2900 SvIOK_on(sv);
2901 SvIsUV_on(sv);
1c846c1f 2902 DEBUG_c(PerlIO_printf(Perl_debug_log,
28e5dec8 2903 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
57def98f 2904 PTR2UV(sv),
28e5dec8
JH
2905 SvUVX(sv),
2906 SvUVX(sv)));
25da4f38 2907 }
ff68c719 2908 }
2909 else if (SvPOKp(sv) && SvLEN(sv)) {
c2988b20 2910 UV value;
504618e9 2911 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
25da4f38
IZ
2912
2913 /* We want to avoid a possible problem when we cache a UV which
2914 may be later translated to an NV, and the resulting NV is not
2915 the translation of the initial data.
1c846c1f 2916
25da4f38
IZ
2917 This means that if we cache such a UV, we need to cache the
2918 NV as well. Moreover, we trade speed for space, and do not
2919 cache the NV if not needed.
2920 */
16b7a9a4 2921
c2988b20
NC
2922 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2923 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2924 == IS_NUMBER_IN_UV) {
5e045b90 2925 /* It's definitely an integer, only upgrade to PVIV */
28e5dec8 2926 if (SvTYPE(sv) < SVt_PVIV)
f7bbb42a
JH
2927 sv_upgrade(sv, SVt_PVIV);
2928 (void)SvIOK_on(sv);
c2988b20
NC
2929 } else if (SvTYPE(sv) < SVt_PVNV)
2930 sv_upgrade(sv, SVt_PVNV);
d460ef45 2931
c2988b20
NC
2932 /* If NV preserves UV then we only use the UV value if we know that
2933 we aren't going to call atof() below. If NVs don't preserve UVs
2934 then the value returned may have more precision than atof() will
2935 return, even though it isn't accurate. */
2936 if ((numtype & (IS_NUMBER_IN_UV
2937#ifdef NV_PRESERVES_UV
2938 | IS_NUMBER_NOT_INT
2939#endif
2940 )) == IS_NUMBER_IN_UV) {
2941 /* This won't turn off the public IOK flag if it was set above */
2942 (void)SvIOKp_on(sv);
2943
2944 if (!(numtype & IS_NUMBER_NEG)) {
2945 /* positive */;
2946 if (value <= (UV)IV_MAX) {
45977657 2947 SvIV_set(sv, (IV)value);
28e5dec8
JH
2948 } else {
2949 /* it didn't overflow, and it was positive. */
607fa7f2 2950 SvUV_set(sv, value);
28e5dec8
JH
2951 SvIsUV_on(sv);
2952 }
c2988b20
NC
2953 } else {
2954 /* 2s complement assumption */
2955 if (value <= (UV)IV_MIN) {
45977657 2956 SvIV_set(sv, -(IV)value);
c2988b20
NC
2957 } else {
2958 /* Too negative for an IV. This is a double upgrade, but
d1be9408 2959 I'm assuming it will be rare. */
c2988b20
NC
2960 if (SvTYPE(sv) < SVt_PVNV)
2961 sv_upgrade(sv, SVt_PVNV);
2962 SvNOK_on(sv);
2963 SvIOK_off(sv);
2964 SvIOKp_on(sv);
9d6ce603 2965 SvNV_set(sv, -(NV)value);
45977657 2966 SvIV_set(sv, IV_MIN);
c2988b20
NC
2967 }
2968 }
2969 }
2970
2971 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2972 != IS_NUMBER_IN_UV) {
2973 /* It wasn't an integer, or it overflowed the UV. */
3f7c398e 2974 SvNV_set(sv, Atof(SvPVX_const(sv)));
28e5dec8 2975
c2988b20 2976 if (! numtype && ckWARN(WARN_NUMERIC))
28e5dec8
JH
2977 not_a_number(sv);
2978
2979#if defined(USE_LONG_DOUBLE)
c2988b20
NC
2980 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2981 PTR2UV(sv), SvNVX(sv)));
28e5dec8 2982#else
1779d84d 2983 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
c2988b20 2984 PTR2UV(sv), SvNVX(sv)));
28e5dec8
JH
2985#endif
2986
2987#ifdef NV_PRESERVES_UV
c2988b20
NC
2988 (void)SvIOKp_on(sv);
2989 (void)SvNOK_on(sv);
2990 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
45977657 2991 SvIV_set(sv, I_V(SvNVX(sv)));
c2988b20
NC
2992 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2993 SvIOK_on(sv);
2994 } else {
2995 /* Integer is imprecise. NOK, IOKp */
2996 }
2997 /* UV will not work better than IV */
2998 } else {
2999 if (SvNVX(sv) > (NV)UV_MAX) {
3000 SvIsUV_on(sv);
3001 /* Integer is inaccurate. NOK, IOKp, is UV */
607fa7f2 3002 SvUV_set(sv, UV_MAX);
c2988b20
NC
3003 SvIsUV_on(sv);
3004 } else {
607fa7f2 3005 SvUV_set(sv, U_V(SvNVX(sv)));
c2988b20
NC
3006 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
3007 NV preservse UV so can do correct comparison. */
3008 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
3009 SvIOK_on(sv);
3010 SvIsUV_on(sv);
3011 } else {
3012 /* Integer is imprecise. NOK, IOKp, is UV */
3013 SvIsUV_on(sv);
3014 }
3015 }
3016 }
28e5dec8 3017#else /* NV_PRESERVES_UV */
c2988b20
NC
3018 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3019 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
3020 /* The UV slot will have been set from value returned by
3021 grok_number above. The NV slot has just been set using
3022 Atof. */
560b0c46 3023 SvNOK_on(sv);
c2988b20
NC
3024 assert (SvIOKp(sv));
3025 } else {
3026 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3027 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3028 /* Small enough to preserve all bits. */
3029 (void)SvIOKp_on(sv);
3030 SvNOK_on(sv);
45977657 3031 SvIV_set(sv, I_V(SvNVX(sv)));
c2988b20
NC
3032 if ((NV)(SvIVX(sv)) == SvNVX(sv))
3033 SvIOK_on(sv);
3034 /* Assumption: first non-preserved integer is < IV_MAX,
3035 this NV is in the preserved range, therefore: */
3036 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
3037 < (UV)IV_MAX)) {
32fdb065 3038 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);
c2988b20
NC
3039 }
3040 } else
3041 sv_2iuv_non_preserve (sv, numtype);
3042 }
28e5dec8 3043#endif /* NV_PRESERVES_UV */
f7bbb42a 3044 }
ff68c719 3045 }
3046 else {
d008e5eb 3047 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 3048 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
29489e7c 3049 report_uninit(sv);
c6ee37c5 3050 }
25da4f38
IZ
3051 if (SvTYPE(sv) < SVt_IV)
3052 /* Typically the caller expects that sv_any is not NULL now. */
3053 sv_upgrade(sv, SVt_IV);
ff68c719 3054 return 0;
3055 }
25da4f38 3056
1d7c1841
GS
3057 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
3058 PTR2UV(sv),SvUVX(sv)));
25da4f38 3059 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
ff68c719 3060}
3061
645c22ef
DM
3062/*
3063=for apidoc sv_2nv
3064
3065Return the num value of an SV, doing any necessary string or integer
3066conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3067macros.
3068
3069=cut
3070*/
3071
65202027 3072NV
864dbfa3 3073Perl_sv_2nv(pTHX_ register SV *sv)
79072805
LW
3074{
3075 if (!sv)
3076 return 0.0;
8990e307 3077 if (SvGMAGICAL(sv)) {
463ee0b2
LW
3078 mg_get(sv);
3079 if (SvNOKp(sv))
3080 return SvNVX(sv);
a0d0e21e 3081 if (SvPOKp(sv) && SvLEN(sv)) {
c2988b20 3082 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
504618e9 3083 !grok_number(SvPVX_const(sv), SvCUR(sv), NULL))
a0d0e21e 3084 not_a_number(sv);
3f7c398e 3085 return Atof(SvPVX_const(sv));
a0d0e21e 3086 }
25da4f38 3087 if (SvIOKp(sv)) {
1c846c1f 3088 if (SvIsUV(sv))
65202027 3089 return (NV)SvUVX(sv);
25da4f38 3090 else
65202027 3091 return (NV)SvIVX(sv);
25da4f38 3092 }
16d20bd9 3093 if (!SvROK(sv)) {
d008e5eb 3094 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 3095 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
29489e7c 3096 report_uninit(sv);
c6ee37c5 3097 }
16d20bd9
AD
3098 return 0;
3099 }
463ee0b2 3100 }
ed6116ce 3101 if (SvTHINKFIRST(sv)) {
a0d0e21e 3102 if (SvROK(sv)) {
a0d0e21e 3103 SV* tmpstr;
1554e226 3104 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
b4b9a328 3105 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
9e7bc3e8 3106 return SvNV(tmpstr);
56431972 3107 return PTR2NV(SvRV(sv));
a0d0e21e 3108 }
765f542d
NC
3109 if (SvIsCOW(sv)) {
3110 sv_force_normal_flags(sv, 0);
8a818333 3111 }
0336b60e 3112 if (SvREADONLY(sv) && !SvOK(sv)) {
599cee73 3113 if (ckWARN(WARN_UNINITIALIZED))
29489e7c 3114 report_uninit(sv);
ed6116ce
LW
3115 return 0.0;
3116 }
79072805
LW
3117 }
3118 if (SvTYPE(sv) < SVt_NV) {
463ee0b2
LW
3119 if (SvTYPE(sv) == SVt_IV)
3120 sv_upgrade(sv, SVt_PVNV);
3121 else
3122 sv_upgrade(sv, SVt_NV);
906f284f 3123#ifdef USE_LONG_DOUBLE
097ee67d 3124 DEBUG_c({
f93f4e46 3125 STORE_NUMERIC_LOCAL_SET_STANDARD();
1d7c1841
GS
3126 PerlIO_printf(Perl_debug_log,
3127 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
3128 PTR2UV(sv), SvNVX(sv));
572bbb43
GS
3129 RESTORE_NUMERIC_LOCAL();
3130 });
65202027 3131#else
572bbb43 3132 DEBUG_c({
f93f4e46 3133 STORE_NUMERIC_LOCAL_SET_STANDARD();
1779d84d 3134 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
1d7c1841 3135 PTR2UV(sv), SvNVX(sv));
097ee67d
JH
3136 RESTORE_NUMERIC_LOCAL();
3137 });
572bbb43 3138#endif
79072805
LW
3139 }
3140 else if (SvTYPE(sv) < SVt_PVNV)
3141 sv_upgrade(sv, SVt_PVNV);
59d8ce62
NC
3142 if (SvNOKp(sv)) {
3143 return SvNVX(sv);
61604483 3144 }
59d8ce62 3145 if (SvIOKp(sv)) {
9d6ce603 3146 SvNV_set(sv, SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv));
28e5dec8
JH
3147#ifdef NV_PRESERVES_UV
3148 SvNOK_on(sv);
3149#else
3150 /* Only set the public NV OK flag if this NV preserves the IV */
3151 /* Check it's not 0xFFFFFFFFFFFFFFFF */
3152 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
3153 : (SvIVX(sv) == I_V(SvNVX(sv))))
3154 SvNOK_on(sv);
3155 else
3156 SvNOKp_on(sv);
3157#endif
93a17b20 3158 }
748a9306 3159 else if (SvPOKp(sv) && SvLEN(sv)) {
c2988b20 3160 UV value;
3f7c398e 3161 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
c2988b20 3162 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
a0d0e21e 3163 not_a_number(sv);
28e5dec8 3164#ifdef NV_PRESERVES_UV
c2988b20
NC
3165 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3166 == IS_NUMBER_IN_UV) {
5e045b90 3167 /* It's definitely an integer */
9d6ce603 3168 SvNV_set(sv, (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value);
c2988b20 3169 } else
3f7c398e 3170 SvNV_set(sv, Atof(SvPVX_const(sv)));
28e5dec8
JH
3171 SvNOK_on(sv);
3172#else
3f7c398e 3173 SvNV_set(sv, Atof(SvPVX_const(sv)));
28e5dec8
JH
3174 /* Only set the public NV OK flag if this NV preserves the value in
3175 the PV at least as well as an IV/UV would.
3176 Not sure how to do this 100% reliably. */
3177 /* if that shift count is out of range then Configure's test is
3178 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
3179 UV_BITS */
3180 if (((UV)1 << NV_PRESERVES_UV_BITS) >
c2988b20 3181 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
28e5dec8 3182 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
c2988b20
NC
3183 } else if (!(numtype & IS_NUMBER_IN_UV)) {
3184 /* Can't use strtol etc to convert this string, so don't try.
3185 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
3186 SvNOK_on(sv);
3187 } else {
3188 /* value has been set. It may not be precise. */
3189 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
3190 /* 2s complement assumption for (UV)IV_MIN */
3191 SvNOK_on(sv); /* Integer is too negative. */
3192 } else {
3193 SvNOKp_on(sv);
3194 SvIOKp_on(sv);
6fa402ec 3195
c2988b20 3196 if (numtype & IS_NUMBER_NEG) {
45977657 3197 SvIV_set(sv, -(IV)value);
c2988b20 3198 } else if (value <= (UV)IV_MAX) {
45977657 3199 SvIV_set(sv, (IV)value);
c2988b20 3200 } else {
607fa7f2 3201 SvUV_set(sv, value);
c2988b20
NC
3202 SvIsUV_on(sv);
3203 }
3204
3205 if (numtype & IS_NUMBER_NOT_INT) {
3206 /* I believe that even if the original PV had decimals,
3207 they are lost beyond the limit of the FP precision.
3208 However, neither is canonical, so both only get p
3209 flags. NWC, 2000/11/25 */
3210 /* Both already have p flags, so do nothing */
3211 } else {
3212 NV nv = SvNVX(sv);
3213 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3214 if (SvIVX(sv) == I_V(nv)) {
3215 SvNOK_on(sv);
3216 SvIOK_on(sv);
3217 } else {
3218 SvIOK_on(sv);
3219 /* It had no "." so it must be integer. */
3220 }
3221 } else {
3222 /* between IV_MAX and NV(UV_MAX).
3223 Could be slightly > UV_MAX */
6fa402ec 3224
c2988b20
NC
3225 if (numtype & IS_NUMBER_NOT_INT) {
3226 /* UV and NV both imprecise. */
3227 } else {
3228 UV nv_as_uv = U_V(nv);
3229
3230 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
3231 SvNOK_on(sv);
3232 SvIOK_on(sv);
3233 } else {
3234 SvIOK_on(sv);
3235 }
3236 }
3237 }
3238 }
3239 }
3240 }
28e5dec8 3241#endif /* NV_PRESERVES_UV */
93a17b20 3242 }
79072805 3243 else {
599cee73 3244 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
29489e7c 3245 report_uninit(sv);
25da4f38
IZ
3246 if (SvTYPE(sv) < SVt_NV)
3247 /* Typically the caller expects that sv_any is not NULL now. */
28e5dec8
JH
3248 /* XXX Ilya implies that this is a bug in callers that assume this
3249 and ideally should be fixed. */
25da4f38 3250 sv_upgrade(sv, SVt_NV);
a0d0e21e 3251 return 0.0;
79072805 3252 }
572bbb43 3253#if defined(USE_LONG_DOUBLE)
097ee67d 3254 DEBUG_c({
f93f4e46 3255 STORE_NUMERIC_LOCAL_SET_STANDARD();
1d7c1841
GS
3256 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
3257 PTR2UV(sv), SvNVX(sv));
572bbb43
GS
3258 RESTORE_NUMERIC_LOCAL();
3259 });
65202027 3260#else
572bbb43 3261 DEBUG_c({
f93f4e46 3262 STORE_NUMERIC_LOCAL_SET_STANDARD();
1779d84d 3263 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
1d7c1841 3264 PTR2UV(sv), SvNVX(sv));
097ee67d
JH
3265 RESTORE_NUMERIC_LOCAL();
3266 });
572bbb43 3267#endif
463ee0b2 3268 return SvNVX(sv);
79072805
LW
3269}
3270
645c22ef
DM
3271/* asIV(): extract an integer from the string value of an SV.
3272 * Caller must validate PVX */
3273
76e3520e 3274STATIC IV
cea2e8a9 3275S_asIV(pTHX_ SV *sv)
36477c24 3276{
c2988b20 3277 UV value;
3f7c398e 3278 int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
c2988b20
NC
3279
3280 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3281 == IS_NUMBER_IN_UV) {
645c22ef 3282 /* It's definitely an integer */
c2988b20
NC
3283 if (numtype & IS_NUMBER_NEG) {
3284 if (value < (UV)IV_MIN)
3285 return -(IV)value;
3286 } else {
3287 if (value < (UV)IV_MAX)
3288 return (IV)value;
3289 }
3290 }
d008e5eb 3291 if (!numtype) {
d008e5eb
GS
3292 if (ckWARN(WARN_NUMERIC))
3293 not_a_number(sv);
3294 }
3f7c398e 3295 return I_V(Atof(SvPVX_const(sv)));
36477c24 3296}
3297
645c22ef
DM
3298/* asUV(): extract an unsigned integer from the string value of an SV
3299 * Caller must validate PVX */
3300
76e3520e 3301STATIC UV
cea2e8a9 3302S_asUV(pTHX_ SV *sv)
36477c24 3303{
c2988b20 3304 UV value;
504618e9 3305 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), &value);
36477c24 3306
c2988b20
NC
3307 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3308 == IS_NUMBER_IN_UV) {
645c22ef 3309 /* It's definitely an integer */
6fa402ec 3310 if (!(numtype & IS_NUMBER_NEG))
c2988b20
NC
3311 return value;
3312 }
d008e5eb 3313 if (!numtype) {
d008e5eb
GS
3314 if (ckWARN(WARN_NUMERIC))
3315 not_a_number(sv);
3316 }
3f7c398e 3317 return U_V(Atof(SvPVX_const(sv)));
36477c24 3318}
3319
645c22ef
DM
3320/*
3321=for apidoc sv_2pv_nolen
3322
3323Like C<sv_2pv()>, but doesn't return the length too. You should usually
3324use the macro wrapper C<SvPV_nolen(sv)> instead.
3325=cut
3326*/
3327
79072805 3328char *
864dbfa3 3329Perl_sv_2pv_nolen(pTHX_ register SV *sv)
1fa8b10d
JD
3330{
3331 STRLEN n_a;
3332 return sv_2pv(sv, &n_a);
3333}
3334
645c22ef
DM
3335/* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
3336 * UV as a string towards the end of buf, and return pointers to start and
3337 * end of it.
3338 *
3339 * We assume that buf is at least TYPE_CHARS(UV) long.
3340 */
3341
864dbfa3 3342static char *
25da4f38
IZ
3343uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
3344{
25da4f38
IZ
3345 char *ptr = buf + TYPE_CHARS(UV);
3346 char *ebuf = ptr;
3347 int sign;
25da4f38
IZ
3348
3349 if (is_uv)
3350 sign = 0;
3351 else if (iv >= 0) {
3352 uv = iv;
3353 sign = 0;
3354 } else {
3355 uv = -iv;
3356 sign = 1;
3357 }
3358 do {
eb160463 3359 *--ptr = '0' + (char)(uv % 10);
25da4f38
IZ
3360 } while (uv /= 10);
3361 if (sign)
3362 *--ptr = '-';
3363 *peob = ebuf;
3364 return ptr;
3365}
3366
09540bc3
JH
3367/* sv_2pv() is now a macro using Perl_sv_2pv_flags();
3368 * this function provided for binary compatibility only
3369 */
3370
3371char *
3372Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
3373{
3374 return sv_2pv_flags(sv, lp, SV_GMAGIC);
3375}
3376
645c22ef
DM
3377/*
3378=for apidoc sv_2pv_flags
3379
ff276b08 3380Returns a pointer to the string value of an SV, and sets *lp to its length.
645c22ef
DM
3381If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3382if necessary.
3383Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3384usually end up here too.
3385
3386=cut
3387*/
3388
8d6d96c1
HS
3389char *
3390Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3391{
79072805
LW
3392 register char *s;
3393 int olderrno;
cb50f42d 3394 SV *tsv, *origsv;
25da4f38
IZ
3395 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3396 char *tmpbuf = tbuf;
79072805 3397
463ee0b2
LW
3398 if (!sv) {
3399 *lp = 0;
73d840c0 3400 return (char *)"";
463ee0b2 3401 }
8990e307 3402 if (SvGMAGICAL(sv)) {
8d6d96c1
HS
3403 if (flags & SV_GMAGIC)
3404 mg_get(sv);
463ee0b2
LW
3405 if (SvPOKp(sv)) {
3406 *lp = SvCUR(sv);
3407 return SvPVX(sv);
3408 }
cf2093f6 3409 if (SvIOKp(sv)) {
1c846c1f 3410 if (SvIsUV(sv))
57def98f 3411 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
cf2093f6 3412 else
57def98f 3413 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
46fc3d4c 3414 tsv = Nullsv;
a0d0e21e 3415 goto tokensave;
463ee0b2
LW
3416 }
3417 if (SvNOKp(sv)) {
2d4389e4 3418 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
46fc3d4c 3419 tsv = Nullsv;
a0d0e21e 3420 goto tokensave;
463ee0b2 3421 }
16d20bd9 3422 if (!SvROK(sv)) {
d008e5eb 3423 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 3424 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
29489e7c 3425 report_uninit(sv);
c6ee37c5 3426 }
16d20bd9 3427 *lp = 0;
73d840c0 3428 return (char *)"";
16d20bd9 3429 }
463ee0b2 3430 }
ed6116ce
LW
3431 if (SvTHINKFIRST(sv)) {
3432 if (SvROK(sv)) {
a0d0e21e 3433 SV* tmpstr;
e1ec3a88 3434 register const char *typestr;
1554e226 3435 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
b4b9a328 3436 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
446eaa42
YST
3437 char *pv = SvPV(tmpstr, *lp);
3438 if (SvUTF8(tmpstr))
3439 SvUTF8_on(sv);
3440 else
3441 SvUTF8_off(sv);
3442 return pv;
3443 }
cb50f42d 3444 origsv = sv;
ed6116ce
LW
3445 sv = (SV*)SvRV(sv);
3446 if (!sv)
e1ec3a88 3447 typestr = "NULLREF";
ed6116ce 3448 else {
f9277f47
IZ
3449 MAGIC *mg;
3450
ed6116ce 3451 switch (SvTYPE(sv)) {
f9277f47
IZ
3452 case SVt_PVMG:
3453 if ( ((SvFLAGS(sv) &
1c846c1f 3454 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
faf82a0b 3455 == (SVs_OBJECT|SVs_SMG))
14befaf4 3456 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
e1ec3a88 3457 const regexp *re = (regexp *)mg->mg_obj;
1bd3ad17 3458
2cd61cdb 3459 if (!mg->mg_ptr) {
e1ec3a88 3460 const char *fptr = "msix";
8782bef2
GB
3461 char reflags[6];
3462 char ch;
3463 int left = 0;
3464 int right = 4;
ff385a1b 3465 char need_newline = 0;
eb160463 3466 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
8782bef2 3467
155aba94 3468 while((ch = *fptr++)) {
8782bef2
GB
3469 if(reganch & 1) {
3470 reflags[left++] = ch;
3471 }
3472 else {
3473 reflags[right--] = ch;
3474 }
3475 reganch >>= 1;
3476 }
3477 if(left != 4) {
3478 reflags[left] = '-';
3479 left = 5;
3480 }
3481
3482 mg->mg_len = re->prelen + 4 + left;
ff385a1b
JF
3483 /*
3484 * If /x was used, we have to worry about a regex
3485 * ending with a comment later being embedded
3486 * within another regex. If so, we don't want this
3487 * regex's "commentization" to leak out to the
3488 * right part of the enclosing regex, we must cap
3489 * it with a newline.
3490 *
3491 * So, if /x was used, we scan backwards from the
3492 * end of the regex. If we find a '#' before we
3493 * find a newline, we need to add a newline
3494 * ourself. If we find a '\n' first (or if we
3495 * don't find '#' or '\n'), we don't need to add
3496 * anything. -jfriedl
3497 */
3498 if (PMf_EXTENDED & re->reganch)
3499 {
e1ec3a88 3500 const char *endptr = re->precomp + re->prelen;
ff385a1b
JF
3501 while (endptr >= re->precomp)
3502 {
e1ec3a88 3503 const char c = *(endptr--);
ff385a1b
JF
3504 if (c == '\n')
3505 break; /* don't need another */
3506 if (c == '#') {
3507 /* we end while in a comment, so we
3508 need a newline */
3509 mg->mg_len++; /* save space for it */
3510 need_newline = 1; /* note to add it */
ab01544f 3511 break;
ff385a1b
JF
3512 }
3513 }
3514 }
3515
8782bef2
GB
3516 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3517 Copy("(?", mg->mg_ptr, 2, char);
3518 Copy(reflags, mg->mg_ptr+2, left, char);
3519 Copy(":", mg->mg_ptr+left+2, 1, char);
3520 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
ff385a1b
JF
3521 if (need_newline)
3522 mg->mg_ptr[mg->mg_len - 2] = '\n';
1bd3ad17
IZ
3523 mg->mg_ptr[mg->mg_len - 1] = ')';
3524 mg->mg_ptr[mg->mg_len] = 0;
3525 }
3280af22 3526 PL_reginterp_cnt += re->program[0].next_off;
cb50f42d
YST
3527
3528 if (re->reganch & ROPT_UTF8)
3529 SvUTF8_on(origsv);
3530 else
3531 SvUTF8_off(origsv);
1bd3ad17
IZ
3532 *lp = mg->mg_len;
3533 return mg->mg_ptr;
f9277f47
IZ
3534 }
3535 /* Fall through */
ed6116ce
LW
3536 case SVt_NULL:
3537 case SVt_IV:
3538 case SVt_NV:
3539 case SVt_RV:
3540 case SVt_PV:
3541 case SVt_PVIV:
3542 case SVt_PVNV:
e1ec3a88
AL
3543 case SVt_PVBM: typestr = SvROK(sv) ? "REF" : "SCALAR"; break;
3544 case SVt_PVLV: typestr = SvROK(sv) ? "REF"
be65207d
DM
3545 /* tied lvalues should appear to be
3546 * scalars for backwards compatitbility */
3547 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3548 ? "SCALAR" : "LVALUE"; break;
e1ec3a88
AL
3549 case SVt_PVAV: typestr = "ARRAY"; break;
3550 case SVt_PVHV: typestr = "HASH"; break;
3551 case SVt_PVCV: typestr = "CODE"; break;
3552 case SVt_PVGV: typestr = "GLOB"; break;
3553 case SVt_PVFM: typestr = "FORMAT"; break;
3554 case SVt_PVIO: typestr = "IO"; break;
3555 default: typestr = "UNKNOWN"; break;
ed6116ce 3556 }
46fc3d4c 3557 tsv = NEWSV(0,0);
a5cb6b62 3558 if (SvOBJECT(sv)) {
bfcb3514 3559 const char *name = HvNAME_get(SvSTASH(sv));
a5cb6b62 3560 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
e1ec3a88 3561 name ? name : "__ANON__" , typestr, PTR2UV(sv));
a5cb6b62 3562 }
ed6116ce 3563 else
e1ec3a88 3564 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", typestr, PTR2UV(sv));
a0d0e21e 3565 goto tokensaveref;
463ee0b2 3566 }
e1ec3a88 3567 *lp = strlen(typestr);
73d840c0 3568 return (char *)typestr;
79072805 3569 }
0336b60e 3570 if (SvREADONLY(sv) && !SvOK(sv)) {
0336b60e 3571 if (ckWARN(WARN_UNINITIALIZED))
29489e7c 3572 report_uninit(sv);
ed6116ce 3573 *lp = 0;
73d840c0 3574 return (char *)"";
79072805 3575 }
79072805 3576 }
28e5dec8
JH
3577 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3578 /* I'm assuming that if both IV and NV are equally valid then
3579 converting the IV is going to be more efficient */
e1ec3a88
AL
3580 const U32 isIOK = SvIOK(sv);
3581 const U32 isUIOK = SvIsUV(sv);
28e5dec8
JH
3582 char buf[TYPE_CHARS(UV)];
3583 char *ebuf, *ptr;
3584
3585 if (SvTYPE(sv) < SVt_PVIV)
3586 sv_upgrade(sv, SVt_PVIV);
3587 if (isUIOK)
3588 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3589 else
3590 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
eb160463 3591 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
28e5dec8
JH
3592 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3593 SvCUR_set(sv, ebuf - ptr);
3594 s = SvEND(sv);
3595 *s = '\0';
3596 if (isIOK)
3597 SvIOK_on(sv);
3598 else
3599 SvIOKp_on(sv);
3600 if (isUIOK)
3601 SvIsUV_on(sv);
3602 }
3603 else if (SvNOKp(sv)) {
79072805
LW
3604 if (SvTYPE(sv) < SVt_PVNV)
3605 sv_upgrade(sv, SVt_PVNV);
1c846c1f 3606 /* The +20 is pure guesswork. Configure test needed. --jhi */
59155cc0 3607 SvGROW(sv, NV_DIG + 20);
463ee0b2 3608 s = SvPVX(sv);
79072805 3609 olderrno = errno; /* some Xenix systems wipe out errno here */
79072805 3610#ifdef apollo
463ee0b2 3611 if (SvNVX(sv) == 0.0)
79072805
LW
3612 (void)strcpy(s,"0");
3613 else
3614#endif /*apollo*/
bbce6d69 3615 {
2d4389e4 3616 Gconvert(SvNVX(sv), NV_DIG, 0, s);
bbce6d69 3617 }
79072805 3618 errno = olderrno;
a0d0e21e
LW
3619#ifdef FIXNEGATIVEZERO
3620 if (*s == '-' && s[1] == '0' && !s[2])
3621 strcpy(s,"0");
3622#endif
79072805
LW
3623 while (*s) s++;
3624#ifdef hcx
3625 if (s[-1] == '.')
46fc3d4c 3626 *--s = '\0';
79072805
LW
3627#endif
3628 }
79072805 3629 else {
0336b60e
IZ
3630 if (ckWARN(WARN_UNINITIALIZED)
3631 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
29489e7c 3632 report_uninit(sv);
a0d0e21e 3633 *lp = 0;
25da4f38
IZ
3634 if (SvTYPE(sv) < SVt_PV)
3635 /* Typically the caller expects that sv_any is not NULL now. */
3636 sv_upgrade(sv, SVt_PV);
73d840c0 3637 return (char *)"";
79072805 3638 }
3f7c398e 3639 *lp = s - SvPVX_const(sv);
463ee0b2 3640 SvCUR_set(sv, *lp);
79072805 3641 SvPOK_on(sv);
1d7c1841 3642 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3f7c398e 3643 PTR2UV(sv),SvPVX_const(sv)));
463ee0b2 3644 return SvPVX(sv);
a0d0e21e
LW
3645
3646 tokensave:
3647 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3648 /* Sneaky stuff here */
3649
3650 tokensaveref:
46fc3d4c 3651 if (!tsv)
96827780 3652 tsv = newSVpv(tmpbuf, 0);
46fc3d4c 3653 sv_2mortal(tsv);
3654 *lp = SvCUR(tsv);
3655 return SvPVX(tsv);
a0d0e21e
LW
3656 }
3657 else {
27da23d5 3658 dVAR;
a0d0e21e 3659 STRLEN len;
73d840c0 3660 const char *t;
46fc3d4c 3661
3662 if (tsv) {
3663 sv_2mortal(tsv);
3f7c398e 3664 t = SvPVX_const(tsv);
46fc3d4c 3665 len = SvCUR(tsv);
3666 }
3667 else {
96827780
MB
3668 t = tmpbuf;
3669 len = strlen(tmpbuf);
46fc3d4c 3670 }
a0d0e21e 3671#ifdef FIXNEGATIVEZERO
46fc3d4c 3672 if (len == 2 && t[0] == '-' && t[1] == '0') {
3673 t = "0";
3674 len = 1;
3675 }
a0d0e21e
LW
3676#endif
3677 (void)SvUPGRADE(sv, SVt_PV);
46fc3d4c 3678 *lp = len;
a0d0e21e
LW
3679 s = SvGROW(sv, len + 1);
3680 SvCUR_set(sv, len);
6bf554b4 3681 SvPOKp_on(sv);
e90e2364 3682 return strcpy(s, t);
a0d0e21e 3683 }
463ee0b2
LW
3684}
3685
645c22ef 3686/*
6050d10e
JP
3687=for apidoc sv_copypv
3688
3689Copies a stringified representation of the source SV into the
3690destination SV. Automatically performs any necessary mg_get and
54f0641b 3691coercion of numeric values into strings. Guaranteed to preserve
6050d10e 3692UTF-8 flag even from overloaded objects. Similar in nature to
54f0641b
NIS
3693sv_2pv[_flags] but operates directly on an SV instead of just the
3694string. Mostly uses sv_2pv_flags to do its work, except when that
6050d10e
JP
3695would lose the UTF-8'ness of the PV.
3696
3697=cut
3698*/
3699
3700void
3701Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3702{
446eaa42
YST
3703 STRLEN len;
3704 char *s;
3705 s = SvPV(ssv,len);
cb50f42d 3706 sv_setpvn(dsv,s,len);
446eaa42 3707 if (SvUTF8(ssv))
cb50f42d 3708 SvUTF8_on(dsv);
446eaa42 3709 else
cb50f42d 3710 SvUTF8_off(dsv);
6050d10e
JP
3711}
3712
3713/*
645c22ef
DM
3714=for apidoc sv_2pvbyte_nolen
3715
3716Return a pointer to the byte-encoded representation of the SV.
1e54db1a 3717May cause the SV to be downgraded from UTF-8 as a side-effect.
645c22ef
DM
3718
3719Usually accessed via the C<SvPVbyte_nolen> macro.
3720
3721=cut
3722*/
3723
7340a771
GS
3724char *
3725Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3726{
560a288e
GS
3727 STRLEN n_a;
3728 return sv_2pvbyte(sv, &n_a);
7340a771
GS
3729}
3730
645c22ef
DM
3731/*
3732=for apidoc sv_2pvbyte
3733
3734Return a pointer to the byte-encoded representation of the SV, and set *lp
1e54db1a 3735to its length. May cause the SV to be downgraded from UTF-8 as a
645c22ef
DM
3736side-effect.
3737
3738Usually accessed via the C<SvPVbyte> macro.
3739
3740=cut
3741*/
3742
7340a771
GS
3743char *
3744Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3745{
0875d2fe
NIS
3746 sv_utf8_downgrade(sv,0);
3747 return SvPV(sv,*lp);
7340a771
GS
3748}
3749
645c22ef
DM
3750/*
3751=for apidoc sv_2pvutf8_nolen
3752
1e54db1a
JH
3753Return a pointer to the UTF-8-encoded representation of the SV.
3754May cause the SV to be upgraded to UTF-8 as a side-effect.
645c22ef
DM
3755
3756Usually accessed via the C<SvPVutf8_nolen> macro.
3757
3758=cut
3759*/
3760
7340a771
GS
3761char *
3762Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3763{
560a288e
GS
3764 STRLEN n_a;
3765 return sv_2pvutf8(sv, &n_a);
7340a771
GS
3766}
3767
645c22ef
DM
3768/*
3769=for apidoc sv_2pvutf8
3770
1e54db1a
JH
3771Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3772to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
645c22ef
DM
3773
3774Usually accessed via the C<SvPVutf8> macro.
3775
3776=cut
3777*/
3778
7340a771
GS
3779char *
3780Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3781{
560a288e 3782 sv_utf8_upgrade(sv);
7d59b7e4 3783 return SvPV(sv,*lp);
7340a771 3784}
1c846c1f 3785
645c22ef
DM
3786/*
3787=for apidoc sv_2bool
3788
3789This function is only called on magical items, and is only used by
8cf8f3d1 3790sv_true() or its macro equivalent.
645c22ef
DM
3791
3792=cut
3793*/
3794
463ee0b2 3795bool
864dbfa3 3796Perl_sv_2bool(pTHX_ register SV *sv)
463ee0b2 3797{
8990e307 3798 if (SvGMAGICAL(sv))
463ee0b2
LW
3799 mg_get(sv);
3800
a0d0e21e
LW
3801 if (!SvOK(sv))
3802 return 0;
3803 if (SvROK(sv)) {
a0d0e21e 3804 SV* tmpsv;
1554e226 3805 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
9e3013b1 3806 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
8a31060d 3807 return (bool)SvTRUE(tmpsv);
a0d0e21e
LW
3808 return SvRV(sv) != 0;
3809 }
463ee0b2 3810 if (SvPOKp(sv)) {
11343788
MB
3811 register XPV* Xpvtmp;
3812 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
339049b0 3813 (*sv->sv_u.svu_pv > '0' ||
11343788 3814 Xpvtmp->xpv_cur > 1 ||
339049b0 3815 (Xpvtmp->xpv_cur && *sv->sv_u.svu_pv != '0')))
463ee0b2
LW
3816 return 1;
3817 else
3818 return 0;
3819 }
3820 else {
3821 if (SvIOKp(sv))
3822 return SvIVX(sv) != 0;
3823 else {
3824 if (SvNOKp(sv))
3825 return SvNVX(sv) != 0.0;
3826 else
3827 return FALSE;
3828 }
3829 }
79072805
LW
3830}
3831
09540bc3
JH
3832/* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3833 * this function provided for binary compatibility only
3834 */
3835
3836
3837STRLEN
3838Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3839{
3840 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3841}
3842
c461cf8f
JH
3843/*
3844=for apidoc sv_utf8_upgrade
3845
78ea37eb 3846Converts the PV of an SV to its UTF-8-encoded form.
645c22ef 3847Forces the SV to string form if it is not already.
4411f3b6
NIS
3848Always sets the SvUTF8 flag to avoid future validity checks even
3849if all the bytes have hibit clear.
c461cf8f 3850
13a6c0e0
JH
3851This is not as a general purpose byte encoding to Unicode interface:
3852use the Encode extension for that.
3853
8d6d96c1
HS
3854=for apidoc sv_utf8_upgrade_flags
3855
78ea37eb 3856Converts the PV of an SV to its UTF-8-encoded form.
645c22ef 3857Forces the SV to string form if it is not already.
8d6d96c1
HS
3858Always sets the SvUTF8 flag to avoid future validity checks even
3859if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3860will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3861C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3862
13a6c0e0
JH
3863This is not as a general purpose byte encoding to Unicode interface:
3864use the Encode extension for that.
3865
8d6d96c1
HS
3866=cut
3867*/
3868
3869STRLEN
3870Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3871{
808c356f
RGS
3872 if (sv == &PL_sv_undef)
3873 return 0;
e0e62c2a
NIS
3874 if (!SvPOK(sv)) {
3875 STRLEN len = 0;
d52b7888
NC
3876 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3877 (void) sv_2pv_flags(sv,&len, flags);
3878 if (SvUTF8(sv))
3879 return len;
3880 } else {
3881 (void) SvPV_force(sv,len);
3882 }
e0e62c2a 3883 }
4411f3b6 3884
f5cee72b 3885 if (SvUTF8(sv)) {
5fec3b1d 3886 return SvCUR(sv);
f5cee72b 3887 }
5fec3b1d 3888
765f542d
NC
3889 if (SvIsCOW(sv)) {
3890 sv_force_normal_flags(sv, 0);
db42d148
NIS
3891 }
3892
88632417 3893 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
799ef3cb 3894 sv_recode_to_utf8(sv, PL_encoding);
9f4817db 3895 else { /* Assume Latin-1/EBCDIC */
c4e7c712
NC
3896 /* This function could be much more efficient if we
3897 * had a FLAG in SVs to signal if there are any hibit
3898 * chars in the PV. Given that there isn't such a flag
3899 * make the loop as fast as possible. */
3900 U8 *s = (U8 *) SvPVX(sv);
3901 U8 *e = (U8 *) SvEND(sv);
3902 U8 *t = s;
3903 int hibit = 0;
3904
3905 while (t < e) {
3906 U8 ch = *t++;
3907 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3908 break;
3909 }
3910 if (hibit) {
3911 STRLEN len = SvCUR(sv) + 1; /* Plus the \0 */
3912 s = bytes_to_utf8((U8*)s, &len);
3913
3914 SvPV_free(sv); /* No longer using what was there before. */
3915
3916 SvPV_set(sv, (char*)s);
3917 SvCUR_set(sv, len - 1);
3918 SvLEN_set(sv, len); /* No longer know the real size. */
3919 }
3920 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3921 SvUTF8_on(sv);
560a288e 3922 }
4411f3b6 3923 return SvCUR(sv);
560a288e
GS
3924}
3925
c461cf8f
JH
3926/*
3927=for apidoc sv_utf8_downgrade
3928
78ea37eb
TS
3929Attempts to convert the PV of an SV from characters to bytes.
3930If the PV contains a character beyond byte, this conversion will fail;
3931in this case, either returns false or, if C<fail_ok> is not
c461cf8f
JH
3932true, croaks.
3933
13a6c0e0
JH
3934This is not as a general purpose Unicode to byte encoding interface:
3935use the Encode extension for that.
3936
c461cf8f
JH
3937=cut
3938*/
3939
560a288e
GS
3940bool
3941Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3942{
78ea37eb 3943 if (SvPOKp(sv) && SvUTF8(sv)) {
fa301091 3944 if (SvCUR(sv)) {
03cfe0ae 3945 U8 *s;
652088fc 3946 STRLEN len;
fa301091 3947
765f542d
NC
3948 if (SvIsCOW(sv)) {
3949 sv_force_normal_flags(sv, 0);
3950 }
03cfe0ae
NIS
3951 s = (U8 *) SvPV(sv, len);
3952 if (!utf8_to_bytes(s, &len)) {
fa301091
JH
3953 if (fail_ok)
3954 return FALSE;
3955 else {
3956 if (PL_op)
3957 Perl_croak(aTHX_ "Wide character in %s",
53e06cf0 3958 OP_DESC(PL_op));
fa301091
JH
3959 else
3960 Perl_croak(aTHX_ "Wide character");
3961 }
4b3603a4 3962 }
b162af07 3963 SvCUR_set(sv, len);
67e989fb 3964 }
560a288e 3965 }
ffebcc3e 3966 SvUTF8_off(sv);
560a288e
GS
3967 return TRUE;
3968}
3969
c461cf8f
JH
3970/*
3971=for apidoc sv_utf8_encode
3972
78ea37eb
TS
3973Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
3974flag off so that it looks like octets again.
c461cf8f
JH
3975
3976=cut
3977*/
3978
560a288e
GS
3979void
3980Perl_sv_utf8_encode(pTHX_ register SV *sv)
3981{
4411f3b6 3982 (void) sv_utf8_upgrade(sv);
4c94c214
NC
3983 if (SvIsCOW(sv)) {
3984 sv_force_normal_flags(sv, 0);
3985 }
3986 if (SvREADONLY(sv)) {
3987 Perl_croak(aTHX_ PL_no_modify);
3988 }
560a288e
GS
3989 SvUTF8_off(sv);
3990}
3991
4411f3b6
NIS
3992/*
3993=for apidoc sv_utf8_decode
3994
78ea37eb
TS
3995If the PV of the SV is an octet sequence in UTF-8
3996and contains a multiple-byte character, the C<SvUTF8> flag is turned on
3997so that it looks like a character. If the PV contains only single-byte
3998characters, the C<SvUTF8> flag stays being off.
3999Scans PV for validity and returns false if the PV is invalid UTF-8.
4411f3b6
NIS
4000
4001=cut
4002*/
4003
560a288e
GS
4004bool
4005Perl_sv_utf8_decode(pTHX_ register SV *sv)
4006{
78ea37eb 4007 if (SvPOKp(sv)) {
63cd0674
NIS
4008 U8 *c;
4009 U8 *e;
9cbac4c7 4010
645c22ef
DM
4011 /* The octets may have got themselves encoded - get them back as
4012 * bytes
4013 */
4014 if (!sv_utf8_downgrade(sv, TRUE))
560a288e
GS
4015 return FALSE;
4016
4017 /* it is actually just a matter of turning the utf8 flag on, but
4018 * we want to make sure everything inside is valid utf8 first.
4019 */
63cd0674
NIS
4020 c = (U8 *) SvPVX(sv);
4021 if (!is_utf8_string(c, SvCUR(sv)+1))
67e989fb 4022 return FALSE;
63cd0674 4023 e = (U8 *) SvEND(sv);
511c2ff0 4024 while (c < e) {
c4d5f83a
NIS
4025 U8 ch = *c++;
4026 if (!UTF8_IS_INVARIANT(ch)) {
67e989fb
JH
4027 SvUTF8_on(sv);
4028 break;
4029 }
560a288e 4030 }
560a288e
GS
4031 }
4032 return TRUE;
4033}
4034
09540bc3
JH
4035/* sv_setsv() is now a macro using Perl_sv_setsv_flags();
4036 * this function provided for binary compatibility only
4037 */
4038
4039void
4040Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
4041{
4042 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
4043}
4044
954c1994
GS
4045/*
4046=for apidoc sv_setsv
4047
645c22ef
DM
4048Copies the contents of the source SV C<ssv> into the destination SV
4049C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4050function if the source SV needs to be reused. Does not handle 'set' magic.
4051Loosely speaking, it performs a copy-by-value, obliterating any previous
4052content of the destination.
4053
4054You probably want to use one of the assortment of wrappers, such as
4055C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4056C<SvSetMagicSV_nosteal>.
4057
8d6d96c1
HS
4058=for apidoc sv_setsv_flags
4059
645c22ef
DM
4060Copies the contents of the source SV C<ssv> into the destination SV
4061C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4062function if the source SV needs to be reused. Does not handle 'set' magic.
4063Loosely speaking, it performs a copy-by-value, obliterating any previous
4064content of the destination.
4065If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
5fcdf167
NC
4066C<ssv> if appropriate, else not. If the C<flags> parameter has the
4067C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4068and C<sv_setsv_nomg> are implemented in terms of this function.
645c22ef
DM
4069
4070You probably want to use one of the assortment of wrappers, such as
4071C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4072C<SvSetMagicSV_nosteal>.
4073
4074This is the primary function for copying scalars, and most other
4075copy-ish functions and macros use this underneath.
8d6d96c1
HS
4076
4077=cut
4078*/
4079
4080void
4081Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
4082{
8990e307
LW
4083 register U32 sflags;
4084 register int dtype;
4085 register int stype;
463ee0b2 4086
79072805
LW
4087 if (sstr == dstr)
4088 return;
765f542d 4089 SV_CHECK_THINKFIRST_COW_DROP(dstr);
79072805 4090 if (!sstr)
3280af22 4091 sstr = &PL_sv_undef;
8990e307
LW
4092 stype = SvTYPE(sstr);
4093 dtype = SvTYPE(dstr);
79072805 4094
a0d0e21e 4095 SvAMAGIC_off(dstr);
7a5fa8a2 4096 if ( SvVOK(dstr) )
ece467f9
JP
4097 {
4098 /* need to nuke the magic */
4099 mg_free(dstr);
4100 SvRMAGICAL_off(dstr);
4101 }
9e7bc3e8 4102
463ee0b2 4103 /* There's a lot of redundancy below but we're going for speed here */
79072805 4104
8990e307 4105 switch (stype) {
79072805 4106 case SVt_NULL:
aece5585 4107 undef_sstr:
20408e3c
GS
4108 if (dtype != SVt_PVGV) {
4109 (void)SvOK_off(dstr);
4110 return;
4111 }
4112 break;
463ee0b2 4113 case SVt_IV:
aece5585
GA
4114 if (SvIOK(sstr)) {
4115 switch (dtype) {
4116 case SVt_NULL:
8990e307 4117 sv_upgrade(dstr, SVt_IV);
aece5585
GA
4118 break;
4119 case SVt_NV:
8990e307 4120 sv_upgrade(dstr, SVt_PVNV);
aece5585
GA
4121 break;
4122 case SVt_RV:
4123 case SVt_PV:
a0d0e21e 4124 sv_upgrade(dstr, SVt_PVIV);
aece5585
GA
4125 break;
4126 }
4127 (void)SvIOK_only(dstr);
45977657 4128 SvIV_set(dstr, SvIVX(sstr));
25da4f38
IZ
4129 if (SvIsUV(sstr))
4130 SvIsUV_on(dstr);
27c9684d
AP
4131 if (SvTAINTED(sstr))
4132 SvTAINT(dstr);
aece5585 4133 return;
8990e307 4134 }
aece5585
GA
4135 goto undef_sstr;
4136
463ee0b2 4137 case SVt_NV:
aece5585
GA
4138 if (SvNOK(sstr)) {
4139 switch (dtype) {
4140 case SVt_NULL:
4141 case SVt_IV:
8990e307 4142 sv_upgrade(dstr, SVt_NV);
aece5585
GA
4143 break;
4144 case SVt_RV:
4145 case SVt_PV:
4146 case SVt_PVIV:
a0d0e21e 4147 sv_upgrade(dstr, SVt_PVNV);
aece5585
GA
4148 break;
4149 }
9d6ce603 4150 SvNV_set(dstr, SvNVX(sstr));
aece5585 4151 (void)SvNOK_only(dstr);
27c9684d
AP
4152 if (SvTAINTED(sstr))
4153 SvTAINT(dstr);
aece5585 4154 return;
8990e307 4155 }
aece5585
GA
4156 goto undef_sstr;
4157
ed6116ce 4158 case SVt_RV:
8990e307 4159 if (dtype < SVt_RV)
ed6116ce 4160 sv_upgrade(dstr, SVt_RV);
c07a80fd 4161 else if (dtype == SVt_PVGV &&
23bb1b96 4162 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
c07a80fd 4163 sstr = SvRV(sstr);
a5f75d66 4164 if (sstr == dstr) {
1d7c1841
GS
4165 if (GvIMPORTED(dstr) != GVf_IMPORTED
4166 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4167 {
a5f75d66 4168 GvIMPORTED_on(dstr);
1d7c1841 4169 }
a5f75d66
AD
4170 GvMULTI_on(dstr);
4171 return;
4172 }
c07a80fd 4173 goto glob_assign;
4174 }
ed6116ce 4175 break;
fc36a67e 4176 case SVt_PVFM:
d89fc664
NC
4177#ifdef PERL_COPY_ON_WRITE
4178 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4179 if (dtype < SVt_PVIV)
4180 sv_upgrade(dstr, SVt_PVIV);
4181 break;
4182 }
4183 /* Fall through */
4184#endif
4185 case SVt_PV:
8990e307 4186 if (dtype < SVt_PV)
463ee0b2 4187 sv_upgrade(dstr, SVt_PV);
463ee0b2
LW
4188 break;
4189 case SVt_PVIV:
8990e307 4190 if (dtype < SVt_PVIV)
463ee0b2 4191 sv_upgrade(dstr, SVt_PVIV);
463ee0b2
LW
4192 break;
4193 case SVt_PVNV:
8990e307 4194 if (dtype < SVt_PVNV)
463ee0b2 4195 sv_upgrade(dstr, SVt_PVNV);
463ee0b2 4196 break;
4633a7c4
LW
4197 case SVt_PVAV:
4198 case SVt_PVHV:
4199 case SVt_PVCV:
4633a7c4 4200 case SVt_PVIO:
a3b680e6
AL
4201 {
4202 const char * const type = sv_reftype(sstr,0);
533c011a 4203 if (PL_op)
a3b680e6 4204 Perl_croak(aTHX_ "Bizarre copy of %s in %s", type, OP_NAME(PL_op));
4633a7c4 4205 else
a3b680e6
AL
4206 Perl_croak(aTHX_ "Bizarre copy of %s", type);
4207 }
4633a7c4
LW
4208 break;
4209
79072805 4210 case SVt_PVGV:
8990e307 4211 if (dtype <= SVt_PVGV) {
c07a80fd 4212 glob_assign:
a5f75d66 4213 if (dtype != SVt_PVGV) {
a3b680e6
AL
4214 const char * const name = GvNAME(sstr);
4215 const STRLEN len = GvNAMELEN(sstr);
b76195c2
DM
4216 /* don't upgrade SVt_PVLV: it can hold a glob */
4217 if (dtype != SVt_PVLV)
4218 sv_upgrade(dstr, SVt_PVGV);
14befaf4 4219 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
85aff577 4220 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
a0d0e21e
LW
4221 GvNAME(dstr) = savepvn(name, len);
4222 GvNAMELEN(dstr) = len;
4223 SvFAKE_on(dstr); /* can coerce to non-glob */
4224 }
7bac28a0 4225 /* ahem, death to those who redefine active sort subs */
3280af22
NIS
4226 else if (PL_curstackinfo->si_type == PERLSI_SORT
4227 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
cea2e8a9 4228 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
7bac28a0 4229 GvNAME(dstr));
5bd07a3d 4230
7fb37951
AMS
4231#ifdef GV_UNIQUE_CHECK
4232 if (GvUNIQUE((GV*)dstr)) {
5bd07a3d
DM
4233 Perl_croak(aTHX_ PL_no_modify);
4234 }
4235#endif
4236
a0d0e21e 4237 (void)SvOK_off(dstr);
a5f75d66 4238 GvINTRO_off(dstr); /* one-shot flag */
1edc1566 4239 gp_free((GV*)dstr);
79072805 4240 GvGP(dstr) = gp_ref(GvGP(sstr));
27c9684d
AP
4241 if (SvTAINTED(sstr))
4242 SvTAINT(dstr);
1d7c1841
GS
4243 if (GvIMPORTED(dstr) != GVf_IMPORTED
4244 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4245 {
a5f75d66 4246 GvIMPORTED_on(dstr);
1d7c1841 4247 }
a5f75d66 4248 GvMULTI_on(dstr);
79072805
LW
4249 return;
4250 }
4251 /* FALL THROUGH */
4252
4253 default:
8d6d96c1 4254 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
973f89ab 4255 mg_get(sstr);
eb160463 4256 if ((int)SvTYPE(sstr) != stype) {
973f89ab
CS
4257 stype = SvTYPE(sstr);
4258 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
4259 goto glob_assign;
4260 }
4261 }
ded42b9f 4262 if (stype == SVt_PVLV)
6fc92669 4263 (void)SvUPGRADE(dstr, SVt_PVNV);
ded42b9f 4264 else
eb160463 4265 (void)SvUPGRADE(dstr, (U32)stype);
79072805
LW
4266 }
4267
8990e307
LW
4268 sflags = SvFLAGS(sstr);
4269
4270 if (sflags & SVf_ROK) {
4271 if (dtype >= SVt_PV) {
4272 if (dtype == SVt_PVGV) {
4273 SV *sref = SvREFCNT_inc(SvRV(sstr));
4274 SV *dref = 0;
a3b680e6 4275 const int intro = GvINTRO(dstr);
a0d0e21e 4276
7fb37951
AMS
4277#ifdef GV_UNIQUE_CHECK
4278 if (GvUNIQUE((GV*)dstr)) {
5bd07a3d
DM
4279 Perl_croak(aTHX_ PL_no_modify);
4280 }
4281#endif
4282
a0d0e21e 4283 if (intro) {
a5f75d66 4284 GvINTRO_off(dstr); /* one-shot flag */
1d7c1841 4285 GvLINE(dstr) = CopLINE(PL_curcop);
1edc1566 4286 GvEGV(dstr) = (GV*)dstr;
a0d0e21e 4287 }
a5f75d66 4288 GvMULTI_on(dstr);
8990e307
LW
4289 switch (SvTYPE(sref)) {
4290 case SVt_PVAV:
a0d0e21e 4291 if (intro)
890ed176 4292 SAVEGENERICSV(GvAV(dstr));
a0d0e21e
LW
4293 else
4294 dref = (SV*)GvAV(dstr);
8990e307 4295 GvAV(dstr) = (AV*)sref;
39bac7f7 4296 if (!GvIMPORTED_AV(dstr)
1d7c1841
GS
4297 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4298 {
a5f75d66 4299 GvIMPORTED_AV_on(dstr);
1d7c1841 4300 }
8990e307
LW
4301 break;
4302 case SVt_PVHV:
a0d0e21e 4303 if (intro)
890ed176 4304 SAVEGENERICSV(GvHV(dstr));
a0d0e21e
LW
4305 else
4306 dref = (SV*)GvHV(dstr);
8990e307 4307 GvHV(dstr) = (HV*)sref;
39bac7f7 4308 if (!GvIMPORTED_HV(dstr)
1d7c1841
GS
4309 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4310 {
a5f75d66 4311 GvIMPORTED_HV_on(dstr);
1d7c1841 4312 }
8990e307
LW
4313 break;
4314 case SVt_PVCV:
8ebc5c01 4315 if (intro) {
4316 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
4317 SvREFCNT_dec(GvCV(dstr));
4318 GvCV(dstr) = Nullcv;
68dc0745 4319 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3280af22 4320 PL_sub_generation++;
8ebc5c01 4321 }
890ed176 4322 SAVEGENERICSV(GvCV(dstr));
8ebc5c01 4323 }
68dc0745 4324 else
4325 dref = (SV*)GvCV(dstr);
4326 if (GvCV(dstr) != (CV*)sref) {
748a9306 4327 CV* cv = GvCV(dstr);
4633a7c4 4328 if (cv) {
68dc0745 4329 if (!GvCVGEN((GV*)dstr) &&
4330 (CvROOT(cv) || CvXSUB(cv)))
4331 {
7bac28a0 4332 /* ahem, death to those who redefine
4333 * active sort subs */
3280af22
NIS
4334 if (PL_curstackinfo->si_type == PERLSI_SORT &&
4335 PL_sortcop == CvSTART(cv))
1c846c1f 4336 Perl_croak(aTHX_
7bac28a0 4337 "Can't redefine active sort subroutine %s",
4338 GvENAME((GV*)dstr));
beab0874
JT
4339 /* Redefining a sub - warning is mandatory if
4340 it was a const and its value changed. */
4341 if (ckWARN(WARN_REDEFINE)
4342 || (CvCONST(cv)
4343 && (!CvCONST((CV*)sref)
4344 || sv_cmp(cv_const_sv(cv),
4345 cv_const_sv((CV*)sref)))))
4346 {
9014280d 4347 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
beab0874 4348 CvCONST(cv)
910764e6
RGS
4349 ? "Constant subroutine %s::%s redefined"
4350 : "Subroutine %s::%s redefined",
bfcb3514 4351 HvNAME_get(GvSTASH((GV*)dstr)),
beab0874
JT
4352 GvENAME((GV*)dstr));
4353 }
9607fc9c 4354 }
fb24441d
RGS
4355 if (!intro)
4356 cv_ckproto(cv, (GV*)dstr,
4357 SvPOK(sref) ? SvPVX(sref) : Nullch);
4633a7c4 4358 }
a5f75d66 4359 GvCV(dstr) = (CV*)sref;
7a4c00b4 4360 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
a5f75d66 4361 GvASSUMECV_on(dstr);
3280af22 4362 PL_sub_generation++;
a5f75d66 4363 }
39bac7f7 4364 if (!GvIMPORTED_CV(dstr)
1d7c1841
GS
4365 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4366 {
a5f75d66 4367 GvIMPORTED_CV_on(dstr);
1d7c1841 4368 }
8990e307 4369 break;
91bba347
LW
4370 case SVt_PVIO:
4371 if (intro)
890ed176 4372 SAVEGENERICSV(GvIOp(dstr));
91bba347
LW
4373 else
4374 dref = (SV*)GvIOp(dstr);
4375 GvIOp(dstr) = (IO*)sref;
4376 break;
f4d13ee9
JH
4377 case SVt_PVFM:
4378 if (intro)
890ed176 4379 SAVEGENERICSV(GvFORM(dstr));
f4d13ee9
JH
4380 else
4381 dref = (SV*)GvFORM(dstr);
4382 GvFORM(dstr) = (CV*)sref;
4383 break;
8990e307 4384 default:
a0d0e21e 4385 if (intro)
890ed176 4386 SAVEGENERICSV(GvSV(dstr));
a0d0e21e
LW
4387 else
4388 dref = (SV*)GvSV(dstr);
8990e307 4389 GvSV(dstr) = sref;
39bac7f7 4390 if (!GvIMPORTED_SV(dstr)
1d7c1841
GS
4391 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4392 {
a5f75d66 4393 GvIMPORTED_SV_on(dstr);
1d7c1841 4394 }
8990e307
LW
4395 break;
4396 }
4397 if (dref)
4398 SvREFCNT_dec(dref);
27c9684d
AP
4399 if (SvTAINTED(sstr))
4400 SvTAINT(dstr);
8990e307
LW
4401 return;
4402 }
3f7c398e 4403 if (SvPVX_const(dstr)) {
8bd4d4c5 4404 SvPV_free(dstr);
b162af07
SP
4405 SvLEN_set(dstr, 0);
4406 SvCUR_set(dstr, 0);
a0d0e21e 4407 }
8990e307 4408 }
a0d0e21e 4409 (void)SvOK_off(dstr);
b162af07 4410 SvRV_set(dstr, SvREFCNT_inc(SvRV(sstr)));
ed6116ce 4411 SvROK_on(dstr);
8990e307 4412 if (sflags & SVp_NOK) {
3332b3c1
JH
4413 SvNOKp_on(dstr);
4414 /* Only set the public OK flag if the source has public OK. */
4415 if (sflags & SVf_NOK)
4416 SvFLAGS(dstr) |= SVf_NOK;
9d6ce603 4417 SvNV_set(dstr, SvNVX(sstr));
ed6116ce 4418 }
8990e307 4419 if (sflags & SVp_IOK) {
3332b3c1
JH
4420 (void)SvIOKp_on(dstr);
4421 if (sflags & SVf_IOK)
4422 SvFLAGS(dstr) |= SVf_IOK;
2b1c7e3e 4423 if (sflags & SVf_IVisUV)
25da4f38 4424 SvIsUV_on(dstr);
45977657 4425 SvIV_set(dstr, SvIVX(sstr));
ed6116ce 4426 }
a0d0e21e
LW
4427 if (SvAMAGIC(sstr)) {
4428 SvAMAGIC_on(dstr);
4429 }
ed6116ce 4430 }
8990e307 4431 else if (sflags & SVp_POK) {
765f542d 4432 bool isSwipe = 0;
79072805
LW
4433
4434 /*
4435 * Check to see if we can just swipe the string. If so, it's a
4436 * possible small lose on short strings, but a big win on long ones.
3f7c398e
SP
4437 * It might even be a win on short strings if SvPVX_const(dstr)
4438 * has to be allocated and SvPVX_const(sstr) has to be freed.
79072805
LW
4439 */
4440
120fac95
NC
4441 /* Whichever path we take through the next code, we want this true,
4442 and doing it now facilitates the COW check. */
4443 (void)SvPOK_only(dstr);
4444
765f542d
NC
4445 if (
4446#ifdef PERL_COPY_ON_WRITE
4447 (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4448 &&
4449#endif
4450 !(isSwipe =
4451 (sflags & SVs_TEMP) && /* slated for free anyway? */
4452 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
5fcdf167
NC
4453 (!(flags & SV_NOSTEAL)) &&
4454 /* and we're allowed to steal temps */
765f542d
NC
4455 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4456 SvLEN(sstr) && /* and really is a string */
645c22ef 4457 /* and won't be needed again, potentially */
765f542d
NC
4458 !(PL_op && PL_op->op_type == OP_AASSIGN))
4459#ifdef PERL_COPY_ON_WRITE
4460 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
120fac95 4461 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
765f542d
NC
4462 && SvTYPE(sstr) >= SVt_PVIV)
4463#endif
4464 ) {
4465 /* Failed the swipe test, and it's not a shared hash key either.
4466 Have to copy the string. */
4467 STRLEN len = SvCUR(sstr);
4468 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3f7c398e 4469 Move(SvPVX_const(sstr),SvPVX(dstr),len,char);
765f542d
NC
4470 SvCUR_set(dstr, len);
4471 *SvEND(dstr) = '\0';
765f542d
NC
4472 } else {
4473 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
4474 be true in here. */
4475#ifdef PERL_COPY_ON_WRITE
4476 /* Either it's a shared hash key, or it's suitable for
4477 copy-on-write or we can swipe the string. */
46187eeb 4478 if (DEBUG_C_TEST) {
ed252734 4479 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
e419cbc5
NC
4480 sv_dump(sstr);
4481 sv_dump(dstr);
46187eeb 4482 }
765f542d
NC
4483 if (!isSwipe) {
4484 /* I believe I should acquire a global SV mutex if
4485 it's a COW sv (not a shared hash key) to stop
4486 it going un copy-on-write.
4487 If the source SV has gone un copy on write between up there
4488 and down here, then (assert() that) it is of the correct
4489 form to make it copy on write again */
4490 if ((sflags & (SVf_FAKE | SVf_READONLY))
4491 != (SVf_FAKE | SVf_READONLY)) {
4492 SvREADONLY_on(sstr);
4493 SvFAKE_on(sstr);
4494 /* Make the source SV into a loop of 1.
4495 (about to become 2) */
a29f6d03 4496 SV_COW_NEXT_SV_SET(sstr, sstr);
765f542d
NC
4497 }
4498 }
4499#endif
4500 /* Initial code is common. */
3f7c398e 4501 if (SvPVX_const(dstr)) { /* we know that dtype >= SVt_PV */
a5f75d66
AD
4502 if (SvOOK(dstr)) {
4503 SvFLAGS(dstr) &= ~SVf_OOK;
3f7c398e 4504 Safefree(SvPVX_const(dstr) - SvIVX(dstr));
a5f75d66 4505 }
50483b2c 4506 else if (SvLEN(dstr))
3f7c398e 4507 Safefree(SvPVX_const(dstr));
79072805 4508 }
765f542d
NC
4509
4510#ifdef PERL_COPY_ON_WRITE
4511 if (!isSwipe) {
4512 /* making another shared SV. */
4513 STRLEN cur = SvCUR(sstr);
4514 STRLEN len = SvLEN(sstr);
d89fc664 4515 assert (SvTYPE(dstr) >= SVt_PVIV);
765f542d
NC
4516 if (len) {
4517 /* SvIsCOW_normal */
4518 /* splice us in between source and next-after-source. */
a29f6d03
NC
4519 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4520 SV_COW_NEXT_SV_SET(sstr, dstr);
765f542d
NC
4521 SvPV_set(dstr, SvPVX(sstr));
4522 } else {
4523 /* SvIsCOW_shared_hash */
4524 UV hash = SvUVX(sstr);
46187eeb
NC
4525 DEBUG_C(PerlIO_printf(Perl_debug_log,
4526 "Copy on write: Sharing hash\n"));
765f542d 4527 SvPV_set(dstr,
3f7c398e 4528 sharepvn(SvPVX_const(sstr),
765f542d 4529 (sflags & SVf_UTF8?-cur:cur), hash));
607fa7f2 4530 SvUV_set(dstr, hash);
765f542d 4531 }
87a1ef3d
SP
4532 SvLEN_set(dstr, len);
4533 SvCUR_set(dstr, cur);
765f542d
NC
4534 SvREADONLY_on(dstr);
4535 SvFAKE_on(dstr);
4536 /* Relesase a global SV mutex. */
4537 }
4538 else
4539#endif
4540 { /* Passes the swipe test. */
4541 SvPV_set(dstr, SvPVX(sstr));
4542 SvLEN_set(dstr, SvLEN(sstr));
4543 SvCUR_set(dstr, SvCUR(sstr));
4544
4545 SvTEMP_off(dstr);
4546 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4547 SvPV_set(sstr, Nullch);
4548 SvLEN_set(sstr, 0);
4549 SvCUR_set(sstr, 0);
4550 SvTEMP_off(sstr);
4551 }
4552 }
9aa983d2 4553 if (sflags & SVf_UTF8)
a7cb1f99 4554 SvUTF8_on(dstr);
79072805 4555 /*SUPPRESS 560*/
8990e307 4556 if (sflags & SVp_NOK) {
3332b3c1
JH
4557 SvNOKp_on(dstr);
4558 if (sflags & SVf_NOK)
4559 SvFLAGS(dstr) |= SVf_NOK;
9d6ce603 4560 SvNV_set(dstr, SvNVX(sstr));
79072805 4561 }
8990e307 4562 if (sflags & SVp_IOK) {
3332b3c1
JH
4563 (void)SvIOKp_on(dstr);
4564 if (sflags & SVf_IOK)
4565 SvFLAGS(dstr) |= SVf_IOK;
2b1c7e3e 4566 if (sflags & SVf_IVisUV)
25da4f38 4567 SvIsUV_on(dstr);
45977657 4568 SvIV_set(dstr, SvIVX(sstr));
79072805 4569 }
92f0c265 4570 if (SvVOK(sstr)) {
7a5fa8a2 4571 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
ece467f9
JP
4572 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4573 smg->mg_ptr, smg->mg_len);
439cb1c4 4574 SvRMAGICAL_on(dstr);
7a5fa8a2 4575 }
79072805 4576 }
8990e307 4577 else if (sflags & SVp_IOK) {
3332b3c1
JH
4578 if (sflags & SVf_IOK)
4579 (void)SvIOK_only(dstr);
4580 else {
9cbac4c7
DM
4581 (void)SvOK_off(dstr);
4582 (void)SvIOKp_on(dstr);
3332b3c1
JH
4583 }
4584 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
2b1c7e3e 4585 if (sflags & SVf_IVisUV)
25da4f38 4586 SvIsUV_on(dstr);
45977657 4587 SvIV_set(dstr, SvIVX(sstr));
3332b3c1
JH
4588 if (sflags & SVp_NOK) {
4589 if (sflags & SVf_NOK)
4590 (void)SvNOK_on(dstr);
4591 else
4592 (void)SvNOKp_on(dstr);
9d6ce603 4593 SvNV_set(dstr, SvNVX(sstr));
3332b3c1
JH
4594 }
4595 }
4596 else if (sflags & SVp_NOK) {
4597 if (sflags & SVf_NOK)
4598 (void)SvNOK_only(dstr);
4599 else {
9cbac4c7 4600 (void)SvOK_off(dstr);
3332b3c1
JH
4601 SvNOKp_on(dstr);
4602 }
9d6ce603 4603 SvNV_set(dstr, SvNVX(sstr));
79072805
LW
4604 }
4605 else {
20408e3c 4606 if (dtype == SVt_PVGV) {
e476b1b5 4607 if (ckWARN(WARN_MISC))
9014280d 4608 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
20408e3c
GS
4609 }
4610 else
4611 (void)SvOK_off(dstr);
a0d0e21e 4612 }
27c9684d
AP
4613 if (SvTAINTED(sstr))
4614 SvTAINT(dstr);
79072805
LW
4615}
4616
954c1994
GS
4617/*
4618=for apidoc sv_setsv_mg
4619
4620Like C<sv_setsv>, but also handles 'set' magic.
4621
4622=cut
4623*/
4624
79072805 4625void
864dbfa3 4626Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
ef50df4b
GS
4627{
4628 sv_setsv(dstr,sstr);
4629 SvSETMAGIC(dstr);
4630}
4631
ed252734
NC
4632#ifdef PERL_COPY_ON_WRITE
4633SV *
4634Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4635{
4636 STRLEN cur = SvCUR(sstr);
4637 STRLEN len = SvLEN(sstr);
4638 register char *new_pv;
4639
4640 if (DEBUG_C_TEST) {
4641 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4642 sstr, dstr);
4643 sv_dump(sstr);
4644 if (dstr)
4645 sv_dump(dstr);
4646 }
4647
4648 if (dstr) {
4649 if (SvTHINKFIRST(dstr))
4650 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
3f7c398e
SP
4651 else if (SvPVX_const(dstr))
4652 Safefree(SvPVX_const(dstr));
ed252734
NC
4653 }
4654 else
4655 new_SV(dstr);
b988aa42 4656 (void)SvUPGRADE (dstr, SVt_PVIV);
ed252734
NC
4657
4658 assert (SvPOK(sstr));
4659 assert (SvPOKp(sstr));
4660 assert (!SvIOK(sstr));
4661 assert (!SvIOKp(sstr));
4662 assert (!SvNOK(sstr));
4663 assert (!SvNOKp(sstr));
4664
4665 if (SvIsCOW(sstr)) {
4666
4667 if (SvLEN(sstr) == 0) {
4668 /* source is a COW shared hash key. */
4669 UV hash = SvUVX(sstr);
4670 DEBUG_C(PerlIO_printf(Perl_debug_log,
4671 "Fast copy on write: Sharing hash\n"));
607fa7f2 4672 SvUV_set(dstr, hash);
3f7c398e 4673 new_pv = sharepvn(SvPVX_const(sstr), (SvUTF8(sstr)?-cur:cur), hash);
ed252734
NC
4674 goto common_exit;
4675 }
4676 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4677 } else {
4678 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
b988aa42 4679 (void)SvUPGRADE (sstr, SVt_PVIV);
ed252734
NC
4680 SvREADONLY_on(sstr);
4681 SvFAKE_on(sstr);
4682 DEBUG_C(PerlIO_printf(Perl_debug_log,
4683 "Fast copy on write: Converting sstr to COW\n"));
4684 SV_COW_NEXT_SV_SET(dstr, sstr);
4685 }
4686 SV_COW_NEXT_SV_SET(sstr, dstr);
4687 new_pv = SvPVX(sstr);
4688
4689 common_exit:
4690 SvPV_set(dstr, new_pv);
4691 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4692 if (SvUTF8(sstr))
4693 SvUTF8_on(dstr);
87a1ef3d
SP
4694 SvLEN_set(dstr, len);
4695 SvCUR_set(dstr, cur);
ed252734
NC
4696 if (DEBUG_C_TEST) {
4697 sv_dump(dstr);
4698 }
4699 return dstr;
4700}
4701#endif
4702
954c1994
GS
4703/*
4704=for apidoc sv_setpvn
4705
4706Copies a string into an SV. The C<len> parameter indicates the number of
9e09f5f2
MHM
4707bytes to be copied. If the C<ptr> argument is NULL the SV will become
4708undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
954c1994
GS
4709
4710=cut
4711*/
4712
ef50df4b 4713void
864dbfa3 4714Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
79072805 4715{
c6f8c383 4716 register char *dptr;
22c522df 4717
765f542d 4718 SV_CHECK_THINKFIRST_COW_DROP(sv);
463ee0b2 4719 if (!ptr) {
a0d0e21e 4720 (void)SvOK_off(sv);
463ee0b2
LW
4721 return;
4722 }
22c522df
JH
4723 else {
4724 /* len is STRLEN which is unsigned, need to copy to signed */
a3b680e6 4725 const IV iv = len;
9c5ffd7c
JH
4726 if (iv < 0)
4727 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
22c522df 4728 }
6fc92669 4729 (void)SvUPGRADE(sv, SVt_PV);
c6f8c383 4730
79072805 4731 SvGROW(sv, len + 1);
c6f8c383
GA
4732 dptr = SvPVX(sv);
4733 Move(ptr,dptr,len,char);
4734 dptr[len] = '\0';
79072805 4735 SvCUR_set(sv, len);
1aa99e6b 4736 (void)SvPOK_only_UTF8(sv); /* validate pointer */
463ee0b2 4737 SvTAINT(sv);
79072805
LW
4738}
4739
954c1994
GS
4740/*
4741=for apidoc sv_setpvn_mg
4742
4743Like C<sv_setpvn>, but also handles 'set' magic.
4744
4745=cut
4746*/
4747
79072805 4748void
864dbfa3 4749Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
ef50df4b
GS
4750{
4751 sv_setpvn(sv,ptr,len);
4752 SvSETMAGIC(sv);
4753}
4754
954c1994
GS
4755/*
4756=for apidoc sv_setpv
4757
4758Copies a string into an SV. The string must be null-terminated. Does not
4759handle 'set' magic. See C<sv_setpv_mg>.
4760
4761=cut
4762*/
4763
ef50df4b 4764void
864dbfa3 4765Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
79072805
LW
4766{
4767 register STRLEN len;
4768
765f542d 4769 SV_CHECK_THINKFIRST_COW_DROP(sv);
463ee0b2 4770 if (!ptr) {
a0d0e21e 4771 (void)SvOK_off(sv);
463ee0b2
LW
4772 return;
4773 }
79072805 4774 len = strlen(ptr);
6fc92669 4775 (void)SvUPGRADE(sv, SVt_PV);
c6f8c383 4776
79072805 4777 SvGROW(sv, len + 1);
463ee0b2 4778 Move(ptr,SvPVX(sv),len+1,char);
79072805 4779 SvCUR_set(sv, len);
1aa99e6b 4780 (void)SvPOK_only_UTF8(sv); /* validate pointer */
463ee0b2
LW
4781 SvTAINT(sv);
4782}
4783
954c1994
GS
4784/*
4785=for apidoc sv_setpv_mg
4786
4787Like C<sv_setpv>, but also handles 'set' magic.
4788
4789=cut
4790*/
4791
463ee0b2 4792void
864dbfa3 4793Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
ef50df4b
GS
4794{
4795 sv_setpv(sv,ptr);
4796 SvSETMAGIC(sv);
4797}
4798
954c1994
GS
4799/*
4800=for apidoc sv_usepvn
4801
4802Tells an SV to use C<ptr> to find its string value. Normally the string is
1c846c1f 4803stored inside the SV but sv_usepvn allows the SV to use an outside string.
954c1994
GS
4804The C<ptr> should point to memory that was allocated by C<malloc>. The
4805string length, C<len>, must be supplied. This function will realloc the
4806memory pointed to by C<ptr>, so that pointer should not be freed or used by
4807the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4808See C<sv_usepvn_mg>.
4809
4810=cut
4811*/
4812
ef50df4b 4813void
864dbfa3 4814Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
463ee0b2 4815{
1936d2a7 4816 STRLEN allocate;
765f542d 4817 SV_CHECK_THINKFIRST_COW_DROP(sv);
c6f8c383 4818 (void)SvUPGRADE(sv, SVt_PV);
463ee0b2 4819 if (!ptr) {
a0d0e21e 4820 (void)SvOK_off(sv);
463ee0b2
LW
4821 return;
4822 }
3f7c398e 4823 if (SvPVX_const(sv))
8bd4d4c5 4824 SvPV_free(sv);
1936d2a7
NC
4825
4826 allocate = PERL_STRLEN_ROUNDUP(len + 1);
7a9b70e9 4827 ptr = saferealloc (ptr, allocate);
f880fe2f 4828 SvPV_set(sv, ptr);
463ee0b2 4829 SvCUR_set(sv, len);
1936d2a7 4830 SvLEN_set(sv, allocate);
463ee0b2 4831 *SvEND(sv) = '\0';
1aa99e6b 4832 (void)SvPOK_only_UTF8(sv); /* validate pointer */
463ee0b2 4833 SvTAINT(sv);
79072805
LW
4834}
4835
954c1994
GS
4836/*
4837=for apidoc sv_usepvn_mg
4838
4839Like C<sv_usepvn>, but also handles 'set' magic.
4840
4841=cut
4842*/
4843
ef50df4b 4844void
864dbfa3 4845Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
ef50df4b 4846{
51c1089b 4847 sv_usepvn(sv,ptr,len);
ef50df4b
GS
4848 SvSETMAGIC(sv);
4849}
4850
765f542d
NC
4851#ifdef PERL_COPY_ON_WRITE
4852/* Need to do this *after* making the SV normal, as we need the buffer
4853 pointer to remain valid until after we've copied it. If we let go too early,
4854 another thread could invalidate it by unsharing last of the same hash key
4855 (which it can do by means other than releasing copy-on-write Svs)
4856 or by changing the other copy-on-write SVs in the loop. */
4857STATIC void
3f7c398e 4858S_sv_release_COW(pTHX_ register SV *sv, const char *pvx, STRLEN cur, STRLEN len,
765f542d
NC
4859 U32 hash, SV *after)
4860{
4861 if (len) { /* this SV was SvIsCOW_normal(sv) */
4862 /* we need to find the SV pointing to us. */
4863 SV *current = SV_COW_NEXT_SV(after);
7a5fa8a2 4864
765f542d
NC
4865 if (current == sv) {
4866 /* The SV we point to points back to us (there were only two of us
4867 in the loop.)
4868 Hence other SV is no longer copy on write either. */
4869 SvFAKE_off(after);
4870 SvREADONLY_off(after);
4871 } else {
4872 /* We need to follow the pointers around the loop. */
4873 SV *next;
4874 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4875 assert (next);
4876 current = next;
4877 /* don't loop forever if the structure is bust, and we have
4878 a pointer into a closed loop. */
4879 assert (current != after);
3f7c398e 4880 assert (SvPVX_const(current) == pvx);
765f542d
NC
4881 }
4882 /* Make the SV before us point to the SV after us. */
a29f6d03 4883 SV_COW_NEXT_SV_SET(current, after);
765f542d
NC
4884 }
4885 } else {
4886 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4887 }
4888}
4889
4890int
4891Perl_sv_release_IVX(pTHX_ register SV *sv)
4892{
4893 if (SvIsCOW(sv))
4894 sv_force_normal_flags(sv, 0);
0c34ef67
MHM
4895 SvOOK_off(sv);
4896 return 0;
765f542d
NC
4897}
4898#endif
645c22ef
DM
4899/*
4900=for apidoc sv_force_normal_flags
4901
4902Undo various types of fakery on an SV: if the PV is a shared string, make
4903a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
765f542d
NC
4904an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4905we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4906then a copy-on-write scalar drops its PV buffer (if any) and becomes
4907SvPOK_off rather than making a copy. (Used where this scalar is about to be
d3050d9d 4908set to some other value.) In addition, the C<flags> parameter gets passed to
765f542d
NC
4909C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4910with flags set to 0.
645c22ef
DM
4911
4912=cut
4913*/
4914
6fc92669 4915void
840a7b70 4916Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
0f15f207 4917{
765f542d
NC
4918#ifdef PERL_COPY_ON_WRITE
4919 if (SvREADONLY(sv)) {
4920 /* At this point I believe I should acquire a global SV mutex. */
4921 if (SvFAKE(sv)) {
3f7c398e 4922 const char *pvx = SvPVX_const(sv);
765f542d
NC
4923 STRLEN len = SvLEN(sv);
4924 STRLEN cur = SvCUR(sv);
4925 U32 hash = SvUVX(sv);
4926 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
46187eeb
NC
4927 if (DEBUG_C_TEST) {
4928 PerlIO_printf(Perl_debug_log,
4929 "Copy on write: Force normal %ld\n",
4930 (long) flags);
e419cbc5 4931 sv_dump(sv);
46187eeb 4932 }
765f542d
NC
4933 SvFAKE_off(sv);
4934 SvREADONLY_off(sv);
4935 /* This SV doesn't own the buffer, so need to New() a new one: */
f880fe2f 4936 SvPV_set(sv, (char*)0);
87a1ef3d 4937 SvLEN_set(sv, 0);
765f542d
NC
4938 if (flags & SV_COW_DROP_PV) {
4939 /* OK, so we don't need to copy our buffer. */
4940 SvPOK_off(sv);
4941 } else {
4942 SvGROW(sv, cur + 1);
4943 Move(pvx,SvPVX(sv),cur,char);
87a1ef3d 4944 SvCUR_set(sv, cur);
765f542d
NC
4945 *SvEND(sv) = '\0';
4946 }
e419cbc5 4947 sv_release_COW(sv, pvx, cur, len, hash, next);
46187eeb 4948 if (DEBUG_C_TEST) {
e419cbc5 4949 sv_dump(sv);
46187eeb 4950 }
765f542d 4951 }
923e4eb5 4952 else if (IN_PERL_RUNTIME)
765f542d
NC
4953 Perl_croak(aTHX_ PL_no_modify);
4954 /* At this point I believe that I can drop the global SV mutex. */
4955 }
4956#else
2213622d 4957 if (SvREADONLY(sv)) {
1c846c1f 4958 if (SvFAKE(sv)) {
3f7c398e 4959 char *pvx = SvPVX_const(sv);
1df70142 4960 const int is_utf8 = SvUTF8(sv);
1c846c1f
NIS
4961 STRLEN len = SvCUR(sv);
4962 U32 hash = SvUVX(sv);
10bcdfd6
NC
4963 SvFAKE_off(sv);
4964 SvREADONLY_off(sv);
f880fe2f 4965 SvPV_set(sv, (char*)0);
b162af07 4966 SvLEN_set(sv, 0);
1c846c1f 4967 SvGROW(sv, len + 1);
3f7c398e 4968 Move(pvx,SvPVX_const(sv),len,char);
1c846c1f 4969 *SvEND(sv) = '\0';
5c98da1c 4970 unsharepvn(pvx, is_utf8 ? -(I32)len : len, hash);
1c846c1f 4971 }
923e4eb5 4972 else if (IN_PERL_RUNTIME)
cea2e8a9 4973 Perl_croak(aTHX_ PL_no_modify);
0f15f207 4974 }
765f542d 4975#endif
2213622d 4976 if (SvROK(sv))
840a7b70 4977 sv_unref_flags(sv, flags);
6fc92669
GS
4978 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4979 sv_unglob(sv);
0f15f207 4980}
1c846c1f 4981
645c22ef
DM
4982/*
4983=for apidoc sv_force_normal
4984
4985Undo various types of fakery on an SV: if the PV is a shared string, make
4986a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4987an xpvmg. See also C<sv_force_normal_flags>.
4988
4989=cut
4990*/
4991
840a7b70
IZ
4992void
4993Perl_sv_force_normal(pTHX_ register SV *sv)
4994{
4995 sv_force_normal_flags(sv, 0);
4996}
4997
954c1994
GS
4998/*
4999=for apidoc sv_chop
5000
1c846c1f 5001Efficient removal of characters from the beginning of the string buffer.
954c1994
GS
5002SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5003the string buffer. The C<ptr> becomes the first character of the adjusted
645c22ef 5004string. Uses the "OOK hack".
3f7c398e 5005Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
31869a79 5006refer to the same chunk of data.
954c1994
GS
5007
5008=cut
5009*/
5010
79072805 5011void
f54cb97a 5012Perl_sv_chop(pTHX_ register SV *sv, register const char *ptr)
79072805
LW
5013{
5014 register STRLEN delta;
a0d0e21e 5015 if (!ptr || !SvPOKp(sv))
79072805 5016 return;
3f7c398e 5017 delta = ptr - SvPVX_const(sv);
2213622d 5018 SV_CHECK_THINKFIRST(sv);
79072805
LW
5019 if (SvTYPE(sv) < SVt_PVIV)
5020 sv_upgrade(sv,SVt_PVIV);
5021
5022 if (!SvOOK(sv)) {
50483b2c 5023 if (!SvLEN(sv)) { /* make copy of shared string */
3f7c398e 5024 const char *pvx = SvPVX_const(sv);
50483b2c
JD
5025 STRLEN len = SvCUR(sv);
5026 SvGROW(sv, len + 1);
3f7c398e 5027 Move(pvx,SvPVX_const(sv),len,char);
50483b2c
JD
5028 *SvEND(sv) = '\0';
5029 }
45977657 5030 SvIV_set(sv, 0);
a4bfb290
AB
5031 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
5032 and we do that anyway inside the SvNIOK_off
5033 */
7a5fa8a2 5034 SvFLAGS(sv) |= SVf_OOK;
79072805 5035 }
a4bfb290 5036 SvNIOK_off(sv);
b162af07
SP
5037 SvLEN_set(sv, SvLEN(sv) - delta);
5038 SvCUR_set(sv, SvCUR(sv) - delta);
f880fe2f 5039 SvPV_set(sv, SvPVX(sv) + delta);
45977657 5040 SvIV_set(sv, SvIVX(sv) + delta);
79072805
LW
5041}
5042
09540bc3
JH
5043/* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
5044 * this function provided for binary compatibility only
5045 */
5046
5047void
5048Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
5049{
5050 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
5051}
5052
954c1994
GS
5053/*
5054=for apidoc sv_catpvn
5055
5056Concatenates the string onto the end of the string which is in the SV. The
1e54db1a
JH
5057C<len> indicates number of bytes to copy. If the SV has the UTF-8
5058status set, then the bytes appended should be valid UTF-8.
d5ce4a7c 5059Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
954c1994 5060
8d6d96c1
HS
5061=for apidoc sv_catpvn_flags
5062
5063Concatenates the string onto the end of the string which is in the SV. The
1e54db1a
JH
5064C<len> indicates number of bytes to copy. If the SV has the UTF-8
5065status set, then the bytes appended should be valid UTF-8.
8d6d96c1
HS
5066If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5067appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5068in terms of this function.
5069
5070=cut
5071*/
5072
5073void
5074Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
5075{
5076 STRLEN dlen;
f54cb97a 5077 const char *dstr = SvPV_force_flags(dsv, dlen, flags);
8d6d96c1 5078
8d6d96c1
HS
5079 SvGROW(dsv, dlen + slen + 1);
5080 if (sstr == dstr)
3f7c398e 5081 sstr = SvPVX_const(dsv);
8d6d96c1 5082 Move(sstr, SvPVX(dsv) + dlen, slen, char);
b162af07 5083 SvCUR_set(dsv, SvCUR(dsv) + slen);
8d6d96c1
HS
5084 *SvEND(dsv) = '\0';
5085 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5086 SvTAINT(dsv);
79072805
LW
5087}
5088
954c1994
GS
5089/*
5090=for apidoc sv_catpvn_mg
5091
5092Like C<sv_catpvn>, but also handles 'set' magic.
5093
5094=cut
5095*/
5096
79072805 5097void
864dbfa3 5098Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
ef50df4b
GS
5099{
5100 sv_catpvn(sv,ptr,len);
5101 SvSETMAGIC(sv);
5102}
5103
09540bc3
JH
5104/* sv_catsv() is now a macro using Perl_sv_catsv_flags();
5105 * this function provided for binary compatibility only
5106 */
5107
5108void
5109Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
5110{
5111 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
5112}
5113
954c1994
GS
5114/*
5115=for apidoc sv_catsv
5116
13e8c8e3
JH
5117Concatenates the string from SV C<ssv> onto the end of the string in
5118SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5119not 'set' magic. See C<sv_catsv_mg>.
954c1994 5120
8d6d96c1
HS
5121=for apidoc sv_catsv_flags
5122
5123Concatenates the string from SV C<ssv> onto the end of the string in
5124SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5125bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5126and C<sv_catsv_nomg> are implemented in terms of this function.
5127
5128=cut */
5129
ef50df4b 5130void
8d6d96c1 5131Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
79072805 5132{
13e8c8e3
JH
5133 char *spv;
5134 STRLEN slen;
46199a12 5135 if (!ssv)
79072805 5136 return;
46199a12 5137 if ((spv = SvPV(ssv, slen))) {
4fd84b44
AD
5138 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
5139 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
8cf8f3d1
NIS
5140 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
5141 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4fd84b44
AD
5142 dsv->sv_flags doesn't have that bit set.
5143 Andy Dougherty 12 Oct 2001
5144 */
b464bac0 5145 const I32 sutf8 = DO_UTF8(ssv);
4fd84b44 5146 I32 dutf8;
13e8c8e3 5147
8d6d96c1
HS
5148 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5149 mg_get(dsv);
5150 dutf8 = DO_UTF8(dsv);
5151
5152 if (dutf8 != sutf8) {
13e8c8e3 5153 if (dutf8) {
46199a12 5154 /* Not modifying source SV, so taking a temporary copy. */
8d6d96c1 5155 SV* csv = sv_2mortal(newSVpvn(spv, slen));
13e8c8e3 5156
46199a12 5157 sv_utf8_upgrade(csv);
8d6d96c1 5158 spv = SvPV(csv, slen);
13e8c8e3 5159 }
8d6d96c1
HS
5160 else
5161 sv_utf8_upgrade_nomg(dsv);
e84ff256 5162 }
8d6d96c1 5163 sv_catpvn_nomg(dsv, spv, slen);
560a288e 5164 }
79072805
LW
5165}
5166
954c1994
GS
5167/*
5168=for apidoc sv_catsv_mg
5169
5170Like C<sv_catsv>, but also handles 'set' magic.
5171
5172=cut
5173*/
5174
79072805 5175void
46199a12 5176Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
ef50df4b 5177{
46199a12
JH
5178 sv_catsv(dsv,ssv);
5179 SvSETMAGIC(dsv);
ef50df4b
GS
5180}
5181
954c1994
GS
5182/*
5183=for apidoc sv_catpv
5184
5185Concatenates the string onto the end of the string which is in the SV.
1e54db1a
JH
5186If the SV has the UTF-8 status set, then the bytes appended should be
5187valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
954c1994 5188
d5ce4a7c 5189=cut */
954c1994 5190
ef50df4b 5191void
0c981600 5192Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
79072805
LW
5193{
5194 register STRLEN len;
463ee0b2 5195 STRLEN tlen;
748a9306 5196 char *junk;
79072805 5197
0c981600 5198 if (!ptr)
79072805 5199 return;
748a9306 5200 junk = SvPV_force(sv, tlen);
0c981600 5201 len = strlen(ptr);
463ee0b2 5202 SvGROW(sv, tlen + len + 1);
0c981600 5203 if (ptr == junk)
3f7c398e 5204 ptr = SvPVX_const(sv);
0c981600 5205 Move(ptr,SvPVX(sv)+tlen,len+1,char);
b162af07 5206 SvCUR_set(sv, SvCUR(sv) + len);
d41ff1b8 5207 (void)SvPOK_only_UTF8(sv); /* validate pointer */
463ee0b2 5208 SvTAINT(sv);
79072805
LW
5209}
5210
954c1994
GS
5211/*
5212=for apidoc sv_catpv_mg
5213
5214Like C<sv_catpv>, but also handles 'set' magic.
5215
5216=cut
5217*/
5218
ef50df4b 5219void
0c981600 5220Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
ef50df4b 5221{
0c981600 5222 sv_catpv(sv,ptr);
ef50df4b
GS
5223 SvSETMAGIC(sv);
5224}
5225
645c22ef
DM
5226/*
5227=for apidoc newSV
5228
5229Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
5230with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
5231macro.
5232
5233=cut
5234*/
5235
79072805 5236SV *
864dbfa3 5237Perl_newSV(pTHX_ STRLEN len)
79072805
LW
5238{
5239 register SV *sv;
1c846c1f 5240
4561caa4 5241 new_SV(sv);
79072805
LW
5242 if (len) {
5243 sv_upgrade(sv, SVt_PV);
5244 SvGROW(sv, len + 1);
5245 }
5246 return sv;
5247}
954c1994 5248/*
92110913 5249=for apidoc sv_magicext
954c1994 5250
68795e93 5251Adds magic to an SV, upgrading it if necessary. Applies the
2d8d5d5a 5252supplied vtable and returns a pointer to the magic added.
92110913 5253
2d8d5d5a
SH
5254Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5255In particular, you can add magic to SvREADONLY SVs, and add more than
5256one instance of the same 'how'.
645c22ef 5257
2d8d5d5a
SH
5258If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5259stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5260special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5261to contain an C<SV*> and is stored as-is with its REFCNT incremented.
92110913 5262
2d8d5d5a 5263(This is now used as a subroutine by C<sv_magic>.)
954c1994
GS
5264
5265=cut
5266*/
92110913 5267MAGIC *
e1ec3a88 5268Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, const MGVTBL *vtable,
92110913 5269 const char* name, I32 namlen)
79072805
LW
5270{
5271 MAGIC* mg;
68795e93 5272
92110913
NIS
5273 if (SvTYPE(sv) < SVt_PVMG) {
5274 (void)SvUPGRADE(sv, SVt_PVMG);
463ee0b2 5275 }
79072805
LW
5276 Newz(702,mg, 1, MAGIC);
5277 mg->mg_moremagic = SvMAGIC(sv);
b162af07 5278 SvMAGIC_set(sv, mg);
75f9d97a 5279
05f95b08
SB
5280 /* Sometimes a magic contains a reference loop, where the sv and
5281 object refer to each other. To prevent a reference loop that
5282 would prevent such objects being freed, we look for such loops
5283 and if we find one we avoid incrementing the object refcount.
87f0b213
JH
5284
5285 Note we cannot do this to avoid self-tie loops as intervening RV must
b5ccf5f2 5286 have its REFCNT incremented to keep it in existence.
87f0b213
JH
5287
5288 */
14befaf4
DM
5289 if (!obj || obj == sv ||
5290 how == PERL_MAGIC_arylen ||
5291 how == PERL_MAGIC_qr ||
8d2f4536 5292 how == PERL_MAGIC_symtab ||
75f9d97a
JH
5293 (SvTYPE(obj) == SVt_PVGV &&
5294 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
5295 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
2628be26 5296 GvFORM(obj) == (CV*)sv)))
75f9d97a 5297 {
8990e307 5298 mg->mg_obj = obj;
75f9d97a 5299 }
85e6fe83 5300 else {
8990e307 5301 mg->mg_obj = SvREFCNT_inc(obj);
85e6fe83
LW
5302 mg->mg_flags |= MGf_REFCOUNTED;
5303 }
b5ccf5f2
YST
5304
5305 /* Normal self-ties simply pass a null object, and instead of
5306 using mg_obj directly, use the SvTIED_obj macro to produce a
5307 new RV as needed. For glob "self-ties", we are tieing the PVIO
5308 with an RV obj pointing to the glob containing the PVIO. In
5309 this case, to avoid a reference loop, we need to weaken the
5310 reference.
5311 */
5312
5313 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5314 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
5315 {
5316 sv_rvweaken(obj);
5317 }
5318
79072805 5319 mg->mg_type = how;
565764a8 5320 mg->mg_len = namlen;
9cbac4c7 5321 if (name) {
92110913 5322 if (namlen > 0)
1edc1566 5323 mg->mg_ptr = savepvn(name, namlen);
c6ee37c5 5324 else if (namlen == HEf_SVKEY)
1edc1566 5325 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
68795e93 5326 else
92110913 5327 mg->mg_ptr = (char *) name;
9cbac4c7 5328 }
92110913 5329 mg->mg_virtual = vtable;
68795e93 5330
92110913
NIS
5331 mg_magical(sv);
5332 if (SvGMAGICAL(sv))
5333 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5334 return mg;
5335}
5336
5337/*
5338=for apidoc sv_magic
1c846c1f 5339
92110913
NIS
5340Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5341then adds a new magic item of type C<how> to the head of the magic list.
5342
2d8d5d5a
SH
5343See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5344handling of the C<name> and C<namlen> arguments.
5345
4509d3fb
SB
5346You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5347to add more than one instance of the same 'how'.
5348
92110913
NIS
5349=cut
5350*/
5351
5352void
5353Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
68795e93 5354{
e1ec3a88 5355 const MGVTBL *vtable = 0;
92110913 5356 MAGIC* mg;
92110913 5357
765f542d
NC
5358#ifdef PERL_COPY_ON_WRITE
5359 if (SvIsCOW(sv))
5360 sv_force_normal_flags(sv, 0);
5361#endif
92110913 5362 if (SvREADONLY(sv)) {
923e4eb5 5363 if (IN_PERL_RUNTIME
92110913
NIS
5364 && how != PERL_MAGIC_regex_global
5365 && how != PERL_MAGIC_bm
5366 && how != PERL_MAGIC_fm
5367 && how != PERL_MAGIC_sv
e6469971 5368 && how != PERL_MAGIC_backref
92110913
NIS
5369 )
5370 {
5371 Perl_croak(aTHX_ PL_no_modify);
5372 }
5373 }
5374 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5375 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
68795e93
NIS
5376 /* sv_magic() refuses to add a magic of the same 'how' as an
5377 existing one
92110913
NIS
5378 */
5379 if (how == PERL_MAGIC_taint)
5380 mg->mg_len |= 1;
5381 return;
5382 }
5383 }
68795e93 5384
79072805 5385 switch (how) {
14befaf4 5386 case PERL_MAGIC_sv:
92110913 5387 vtable = &PL_vtbl_sv;
79072805 5388 break;
14befaf4 5389 case PERL_MAGIC_overload:
92110913 5390 vtable = &PL_vtbl_amagic;
a0d0e21e 5391 break;
14befaf4 5392 case PERL_MAGIC_overload_elem:
92110913 5393 vtable = &PL_vtbl_amagicelem;
a0d0e21e 5394 break;
14befaf4 5395 case PERL_MAGIC_overload_table:
92110913 5396 vtable = &PL_vtbl_ovrld;
a0d0e21e 5397 break;
14befaf4 5398 case PERL_MAGIC_bm:
92110913 5399 vtable = &PL_vtbl_bm;
79072805 5400 break;
14befaf4 5401 case PERL_MAGIC_regdata:
92110913 5402 vtable = &PL_vtbl_regdata;
6cef1e77 5403 break;
14befaf4 5404 case PERL_MAGIC_regdatum:
92110913 5405 vtable = &PL_vtbl_regdatum;
6cef1e77 5406 break;
14befaf4 5407 case PERL_MAGIC_env:
92110913 5408 vtable = &PL_vtbl_env;
79072805 5409 break;
14befaf4 5410 case PERL_MAGIC_fm:
92110913 5411 vtable = &PL_vtbl_fm;
55497cff 5412 break;
14befaf4 5413 case PERL_MAGIC_envelem:
92110913 5414 vtable = &PL_vtbl_envelem;
79072805 5415 break;
14befaf4 5416 case PERL_MAGIC_regex_global:
92110913 5417 vtable = &PL_vtbl_mglob;
93a17b20 5418 break;
14befaf4 5419 case PERL_MAGIC_isa:
92110913 5420 vtable = &PL_vtbl_isa;
463ee0b2 5421 break;
14befaf4 5422 case PERL_MAGIC_isaelem:
92110913 5423 vtable = &PL_vtbl_isaelem;
463ee0b2 5424 break;
14befaf4 5425 case PERL_MAGIC_nkeys:
92110913 5426 vtable = &PL_vtbl_nkeys;
16660edb 5427 break;
14befaf4 5428 case PERL_MAGIC_dbfile:
92110913 5429 vtable = 0;
93a17b20 5430 break;
14befaf4 5431 case PERL_MAGIC_dbline:
92110913 5432 vtable = &PL_vtbl_dbline;
79072805 5433 break;
36477c24 5434#ifdef USE_LOCALE_COLLATE
14befaf4 5435 case PERL_MAGIC_collxfrm:
92110913 5436 vtable = &PL_vtbl_collxfrm;
bbce6d69 5437 break;
36477c24 5438#endif /* USE_LOCALE_COLLATE */
14befaf4 5439 case PERL_MAGIC_tied:
92110913 5440 vtable = &PL_vtbl_pack;
463ee0b2 5441 break;
14befaf4
DM
5442 case PERL_MAGIC_tiedelem:
5443 case PERL_MAGIC_tiedscalar:
92110913 5444 vtable = &PL_vtbl_packelem;
463ee0b2 5445 break;
14befaf4 5446 case PERL_MAGIC_qr:
92110913 5447 vtable = &PL_vtbl_regexp;
c277df42 5448 break;
14befaf4 5449 case PERL_MAGIC_sig:
92110913 5450 vtable = &PL_vtbl_sig;
79072805 5451 break;
14befaf4 5452 case PERL_MAGIC_sigelem:
92110913 5453 vtable = &PL_vtbl_sigelem;
79072805 5454 break;
14befaf4 5455 case PERL_MAGIC_taint:
92110913 5456 vtable = &PL_vtbl_taint;
463ee0b2 5457 break;
14befaf4 5458 case PERL_MAGIC_uvar:
92110913 5459 vtable = &PL_vtbl_uvar;
79072805 5460 break;
14befaf4 5461 case PERL_MAGIC_vec:
92110913 5462 vtable = &PL_vtbl_vec;
79072805 5463 break;
a3874608 5464 case PERL_MAGIC_arylen_p:
bfcb3514 5465 case PERL_MAGIC_rhash:
8d2f4536 5466 case PERL_MAGIC_symtab:
ece467f9
JP
5467 case PERL_MAGIC_vstring:
5468 vtable = 0;
5469 break;
7e8c5dac
HS
5470 case PERL_MAGIC_utf8:
5471 vtable = &PL_vtbl_utf8;
5472 break;
14befaf4 5473 case PERL_MAGIC_substr:
92110913 5474 vtable = &PL_vtbl_substr;
79072805 5475 break;
14befaf4 5476 case PERL_MAGIC_defelem:
92110913 5477 vtable = &PL_vtbl_defelem;
5f05dabc 5478 break;
14befaf4 5479 case PERL_MAGIC_glob:
92110913 5480 vtable = &PL_vtbl_glob;
79072805 5481 break;
14befaf4 5482 case PERL_MAGIC_arylen:
92110913 5483 vtable = &PL_vtbl_arylen;
79072805 5484 break;
14befaf4 5485 case PERL_MAGIC_pos:
92110913 5486 vtable = &PL_vtbl_pos;
a0d0e21e 5487 break;
14befaf4 5488 case PERL_MAGIC_backref:
92110913 5489 vtable = &PL_vtbl_backref;
810b8aa5 5490 break;
14befaf4
DM
5491 case PERL_MAGIC_ext:
5492 /* Reserved for use by extensions not perl internals. */
4633a7c4
LW
5493 /* Useful for attaching extension internal data to perl vars. */
5494 /* Note that multiple extensions may clash if magical scalars */
5495 /* etc holding private data from one are passed to another. */
a0d0e21e 5496 break;
79072805 5497 default:
14befaf4 5498 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
463ee0b2 5499 }
68795e93 5500
92110913 5501 /* Rest of work is done else where */
27da23d5 5502 mg = sv_magicext(sv,obj,how,(MGVTBL*)vtable,name,namlen);
68795e93 5503
92110913
NIS
5504 switch (how) {
5505 case PERL_MAGIC_taint:
5506 mg->mg_len = 1;
5507 break;
5508 case PERL_MAGIC_ext:
5509 case PERL_MAGIC_dbfile:
5510 SvRMAGICAL_on(sv);
5511 break;
5512 }
463ee0b2
LW
5513}
5514
c461cf8f
JH
5515/*
5516=for apidoc sv_unmagic
5517
645c22ef 5518Removes all magic of type C<type> from an SV.
c461cf8f
JH
5519
5520=cut
5521*/
5522
463ee0b2 5523int
864dbfa3 5524Perl_sv_unmagic(pTHX_ SV *sv, int type)
463ee0b2
LW
5525{
5526 MAGIC* mg;
5527 MAGIC** mgp;
91bba347 5528 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
463ee0b2
LW
5529 return 0;
5530 mgp = &SvMAGIC(sv);
5531 for (mg = *mgp; mg; mg = *mgp) {
5532 if (mg->mg_type == type) {
e1ec3a88 5533 const MGVTBL* const vtbl = mg->mg_virtual;
463ee0b2 5534 *mgp = mg->mg_moremagic;
1d7c1841 5535 if (vtbl && vtbl->svt_free)
fc0dc3b3 5536 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
14befaf4 5537 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
92110913 5538 if (mg->mg_len > 0)
1edc1566 5539 Safefree(mg->mg_ptr);
565764a8 5540 else if (mg->mg_len == HEf_SVKEY)
1edc1566 5541 SvREFCNT_dec((SV*)mg->mg_ptr);
7e8c5dac
HS
5542 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5543 Safefree(mg->mg_ptr);
9cbac4c7 5544 }
a0d0e21e
LW
5545 if (mg->mg_flags & MGf_REFCOUNTED)
5546 SvREFCNT_dec(mg->mg_obj);
463ee0b2
LW
5547 Safefree(mg);
5548 }
5549 else
5550 mgp = &mg->mg_moremagic;
79072805 5551 }
91bba347 5552 if (!SvMAGIC(sv)) {
463ee0b2 5553 SvMAGICAL_off(sv);
06759ea0 5554 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
463ee0b2
LW
5555 }
5556
5557 return 0;
79072805
LW
5558}
5559
c461cf8f
JH
5560/*
5561=for apidoc sv_rvweaken
5562
645c22ef
DM
5563Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5564referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5565push a back-reference to this RV onto the array of backreferences
5566associated with that magic.
c461cf8f
JH
5567
5568=cut
5569*/
5570
810b8aa5 5571SV *
864dbfa3 5572Perl_sv_rvweaken(pTHX_ SV *sv)
810b8aa5
GS
5573{
5574 SV *tsv;
5575 if (!SvOK(sv)) /* let undefs pass */
5576 return sv;
5577 if (!SvROK(sv))
cea2e8a9 5578 Perl_croak(aTHX_ "Can't weaken a nonreference");
810b8aa5 5579 else if (SvWEAKREF(sv)) {
810b8aa5 5580 if (ckWARN(WARN_MISC))
9014280d 5581 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
810b8aa5
GS
5582 return sv;
5583 }
5584 tsv = SvRV(sv);
5585 sv_add_backref(tsv, sv);
5586 SvWEAKREF_on(sv);
1c846c1f 5587 SvREFCNT_dec(tsv);
810b8aa5
GS
5588 return sv;
5589}
5590
645c22ef
DM
5591/* Give tsv backref magic if it hasn't already got it, then push a
5592 * back-reference to sv onto the array associated with the backref magic.
5593 */
5594
810b8aa5 5595STATIC void
cea2e8a9 5596S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
810b8aa5
GS
5597{
5598 AV *av;
5599 MAGIC *mg;
14befaf4 5600 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
810b8aa5
GS
5601 av = (AV*)mg->mg_obj;
5602 else {
5603 av = newAV();
14befaf4 5604 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
d99b02a1
DM
5605 /* av now has a refcnt of 2, which avoids it getting freed
5606 * before us during global cleanup. The extra ref is removed
5607 * by magic_killbackrefs() when tsv is being freed */
810b8aa5 5608 }
d91d49e8 5609 if (AvFILLp(av) >= AvMAX(av)) {
fdc9a813 5610 I32 i;
d91d49e8 5611 SV **svp = AvARRAY(av);
fdc9a813
AE
5612 for (i = AvFILLp(av); i >= 0; i--)
5613 if (!svp[i]) {
d91d49e8
MM
5614 svp[i] = sv; /* reuse the slot */
5615 return;
5616 }
d91d49e8
MM
5617 av_extend(av, AvFILLp(av)+1);
5618 }
5619 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
810b8aa5
GS
5620}
5621
645c22ef
DM
5622/* delete a back-reference to ourselves from the backref magic associated
5623 * with the SV we point to.
5624 */
5625
1c846c1f 5626STATIC void
cea2e8a9 5627S_sv_del_backref(pTHX_ SV *sv)
810b8aa5
GS
5628{
5629 AV *av;
5630 SV **svp;
5631 I32 i;
5632 SV *tsv = SvRV(sv);
c04a4dfe 5633 MAGIC *mg = NULL;
14befaf4 5634 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
cea2e8a9 5635 Perl_croak(aTHX_ "panic: del_backref");
810b8aa5
GS
5636 av = (AV *)mg->mg_obj;
5637 svp = AvARRAY(av);
fdc9a813
AE
5638 for (i = AvFILLp(av); i >= 0; i--)
5639 if (svp[i] == sv) svp[i] = Nullsv;
810b8aa5
GS
5640}
5641
954c1994
GS
5642/*
5643=for apidoc sv_insert
5644
5645Inserts a string at the specified offset/length within the SV. Similar to
5646the Perl substr() function.
5647
5648=cut
5649*/
5650
79072805 5651void
e1ec3a88 5652Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)
79072805
LW
5653{
5654 register char *big;
5655 register char *mid;
5656 register char *midend;
5657 register char *bigend;
5658 register I32 i;
6ff81951 5659 STRLEN curlen;
1c846c1f 5660
79072805 5661
8990e307 5662 if (!bigstr)
cea2e8a9 5663 Perl_croak(aTHX_ "Can't modify non-existent substring");
6ff81951 5664 SvPV_force(bigstr, curlen);
60fa28ff 5665 (void)SvPOK_only_UTF8(bigstr);
6ff81951
GS
5666 if (offset + len > curlen) {
5667 SvGROW(bigstr, offset+len+1);
3f7c398e 5668 Zero(SvPVX_const(bigstr)+curlen, offset+len-curlen, char);
6ff81951
GS
5669 SvCUR_set(bigstr, offset+len);
5670 }
79072805 5671
69b47968 5672 SvTAINT(bigstr);
79072805
LW
5673 i = littlelen - len;
5674 if (i > 0) { /* string might grow */
a0d0e21e 5675 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
79072805
LW
5676 mid = big + offset + len;
5677 midend = bigend = big + SvCUR(bigstr);
5678 bigend += i;
5679 *bigend = '\0';
5680 while (midend > mid) /* shove everything down */
5681 *--bigend = *--midend;
5682 Move(little,big+offset,littlelen,char);
b162af07 5683 SvCUR_set(bigstr, SvCUR(bigstr) + i);
79072805
LW
5684 SvSETMAGIC(bigstr);
5685 return;
5686 }
5687 else if (i == 0) {
463ee0b2 5688 Move(little,SvPVX(bigstr)+offset,len,char);
79072805
LW
5689 SvSETMAGIC(bigstr);
5690 return;
5691 }
5692
463ee0b2 5693 big = SvPVX(bigstr);
79072805
LW
5694 mid = big + offset;
5695 midend = mid + len;
5696 bigend = big + SvCUR(bigstr);
5697
5698 if (midend > bigend)
cea2e8a9 5699 Perl_croak(aTHX_ "panic: sv_insert");
79072805
LW
5700
5701 if (mid - big > bigend - midend) { /* faster to shorten from end */
5702 if (littlelen) {
5703 Move(little, mid, littlelen,char);
5704 mid += littlelen;
5705 }
5706 i = bigend - midend;
5707 if (i > 0) {
5708 Move(midend, mid, i,char);
5709 mid += i;
5710 }
5711 *mid = '\0';
5712 SvCUR_set(bigstr, mid - big);
5713 }
5714 /*SUPPRESS 560*/
155aba94 5715 else if ((i = mid - big)) { /* faster from front */
79072805
LW
5716 midend -= littlelen;
5717 mid = midend;
5718 sv_chop(bigstr,midend-i);
5719 big += i;
5720 while (i--)
5721 *--midend = *--big;
5722 if (littlelen)
5723 Move(little, mid, littlelen,char);
5724 }
5725 else if (littlelen) {
5726 midend -= littlelen;
5727 sv_chop(bigstr,midend);
5728 Move(little,midend,littlelen,char);
5729 }
5730 else {
5731 sv_chop(bigstr,midend);
5732 }
5733 SvSETMAGIC(bigstr);
5734}
5735
c461cf8f
JH
5736/*
5737=for apidoc sv_replace
5738
5739Make the first argument a copy of the second, then delete the original.
645c22ef
DM
5740The target SV physically takes over ownership of the body of the source SV
5741and inherits its flags; however, the target keeps any magic it owns,
5742and any magic in the source is discarded.
ff276b08 5743Note that this is a rather specialist SV copying operation; most of the
645c22ef 5744time you'll want to use C<sv_setsv> or one of its many macro front-ends.
c461cf8f
JH
5745
5746=cut
5747*/
79072805
LW
5748
5749void
864dbfa3 5750Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
79072805 5751{
a3b680e6 5752 const U32 refcnt = SvREFCNT(sv);
765f542d 5753 SV_CHECK_THINKFIRST_COW_DROP(sv);
0453d815 5754 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
9014280d 5755 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
93a17b20 5756 if (SvMAGICAL(sv)) {
a0d0e21e
LW
5757 if (SvMAGICAL(nsv))
5758 mg_free(nsv);
5759 else
5760 sv_upgrade(nsv, SVt_PVMG);
b162af07 5761 SvMAGIC_set(nsv, SvMAGIC(sv));
a0d0e21e 5762 SvFLAGS(nsv) |= SvMAGICAL(sv);
93a17b20 5763 SvMAGICAL_off(sv);
b162af07 5764 SvMAGIC_set(sv, NULL);
93a17b20 5765 }
79072805
LW
5766 SvREFCNT(sv) = 0;
5767 sv_clear(sv);
477f5d66 5768 assert(!SvREFCNT(sv));
fd0854ff
DM
5769#ifdef DEBUG_LEAKING_SCALARS
5770 sv->sv_flags = nsv->sv_flags;
5771 sv->sv_any = nsv->sv_any;
5772 sv->sv_refcnt = nsv->sv_refcnt;
5773#else
79072805 5774 StructCopy(nsv,sv,SV);
fd0854ff 5775#endif
7b2c381c
NC
5776 /* Currently could join these into one piece of pointer arithmetic, but
5777 it would be unclear. */
5778 if(SvTYPE(sv) == SVt_IV)
5779 SvANY(sv)
339049b0 5780 = (XPVIV*)((char*)&(sv->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
7b2c381c 5781 else if (SvTYPE(sv) == SVt_RV) {
339049b0 5782 SvANY(sv) = &sv->sv_u.svu_rv;
7b2c381c
NC
5783 }
5784
fd0854ff 5785
d3d0e6f1
NC
5786#ifdef PERL_COPY_ON_WRITE
5787 if (SvIsCOW_normal(nsv)) {
5788 /* We need to follow the pointers around the loop to make the
5789 previous SV point to sv, rather than nsv. */
5790 SV *next;
5791 SV *current = nsv;
5792 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5793 assert(next);
5794 current = next;
3f7c398e 5795 assert(SvPVX_const(current) == SvPVX_const(nsv));
d3d0e6f1
NC
5796 }
5797 /* Make the SV before us point to the SV after us. */
5798 if (DEBUG_C_TEST) {
5799 PerlIO_printf(Perl_debug_log, "previous is\n");
5800 sv_dump(current);
a29f6d03
NC
5801 PerlIO_printf(Perl_debug_log,
5802 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
d3d0e6f1
NC
5803 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5804 }
a29f6d03 5805 SV_COW_NEXT_SV_SET(current, sv);
d3d0e6f1
NC
5806 }
5807#endif
79072805 5808 SvREFCNT(sv) = refcnt;
1edc1566 5809 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
39cf41c2 5810 SvREFCNT(nsv) = 0;
463ee0b2 5811 del_SV(nsv);
79072805
LW
5812}
5813
c461cf8f
JH
5814/*
5815=for apidoc sv_clear
5816
645c22ef
DM
5817Clear an SV: call any destructors, free up any memory used by the body,
5818and free the body itself. The SV's head is I<not> freed, although
5819its type is set to all 1's so that it won't inadvertently be assumed
5820to be live during global destruction etc.
5821This function should only be called when REFCNT is zero. Most of the time
5822you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5823instead.
c461cf8f
JH
5824
5825=cut
5826*/
5827
79072805 5828void
864dbfa3 5829Perl_sv_clear(pTHX_ register SV *sv)
79072805 5830{
27da23d5 5831 dVAR;
ec12f114 5832 HV* stash;
79072805
LW
5833 assert(sv);
5834 assert(SvREFCNT(sv) == 0);
5835
ed6116ce 5836 if (SvOBJECT(sv)) {
3280af22 5837 if (PL_defstash) { /* Still have a symbol table? */
39644a26 5838 dSP;
d460ef45 5839 do {
b464bac0 5840 CV* destructor;
4e8e7886 5841 stash = SvSTASH(sv);
32251b26 5842 destructor = StashHANDLER(stash,DESTROY);
4e8e7886 5843 if (destructor) {
5cc433a6
AB
5844 SV* tmpref = newRV(sv);
5845 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4e8e7886 5846 ENTER;
e788e7d3 5847 PUSHSTACKi(PERLSI_DESTROY);
4e8e7886
GS
5848 EXTEND(SP, 2);
5849 PUSHMARK(SP);
5cc433a6 5850 PUSHs(tmpref);
4e8e7886 5851 PUTBACK;
44389ee9 5852 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
7a5fa8a2
NIS
5853
5854
d3acc0f7 5855 POPSTACK;
3095d977 5856 SPAGAIN;
4e8e7886 5857 LEAVE;
5cc433a6
AB
5858 if(SvREFCNT(tmpref) < 2) {
5859 /* tmpref is not kept alive! */
5860 SvREFCNT(sv)--;
b162af07 5861 SvRV_set(tmpref, NULL);
5cc433a6
AB
5862 SvROK_off(tmpref);
5863 }
5864 SvREFCNT_dec(tmpref);
4e8e7886
GS
5865 }
5866 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
8ebc5c01 5867
6f44e0a4
JP
5868
5869 if (SvREFCNT(sv)) {
5870 if (PL_in_clean_objs)
cea2e8a9 5871 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
bfcb3514 5872 HvNAME_get(stash));
6f44e0a4
JP
5873 /* DESTROY gave object new lease on life */
5874 return;
5875 }
a0d0e21e 5876 }
4e8e7886 5877
a0d0e21e 5878 if (SvOBJECT(sv)) {
4e8e7886 5879 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
a0d0e21e
LW
5880 SvOBJECT_off(sv); /* Curse the object. */
5881 if (SvTYPE(sv) != SVt_PVIO)
3280af22 5882 --PL_sv_objcount; /* XXX Might want something more general */
a0d0e21e 5883 }
463ee0b2 5884 }
524189f1
JH
5885 if (SvTYPE(sv) >= SVt_PVMG) {
5886 if (SvMAGIC(sv))
5887 mg_free(sv);
bce8f412 5888 if (SvTYPE(sv) == SVt_PVMG && SvFLAGS(sv) & SVpad_TYPED)
524189f1
JH
5889 SvREFCNT_dec(SvSTASH(sv));
5890 }
ec12f114 5891 stash = NULL;
79072805 5892 switch (SvTYPE(sv)) {
8990e307 5893 case SVt_PVIO:
df0bd2f4
GS
5894 if (IoIFP(sv) &&
5895 IoIFP(sv) != PerlIO_stdin() &&
5f05dabc 5896 IoIFP(sv) != PerlIO_stdout() &&
5897 IoIFP(sv) != PerlIO_stderr())
93578b34 5898 {
f2b5be74 5899 io_close((IO*)sv, FALSE);
93578b34 5900 }
1d7c1841 5901 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
1236053a 5902 PerlDir_close(IoDIRP(sv));
1d7c1841 5903 IoDIRP(sv) = (DIR*)NULL;
8990e307
LW
5904 Safefree(IoTOP_NAME(sv));
5905 Safefree(IoFMT_NAME(sv));
5906 Safefree(IoBOTTOM_NAME(sv));
a0d0e21e 5907 /* FALL THROUGH */
79072805 5908 case SVt_PVBM:
a0d0e21e 5909 goto freescalar;
79072805 5910 case SVt_PVCV:
748a9306 5911 case SVt_PVFM:
85e6fe83 5912 cv_undef((CV*)sv);
a0d0e21e 5913 goto freescalar;
79072805 5914 case SVt_PVHV:
85e6fe83 5915 hv_undef((HV*)sv);
a0d0e21e 5916 break;
79072805 5917 case SVt_PVAV:
85e6fe83 5918 av_undef((AV*)sv);
a0d0e21e 5919 break;
02270b4e 5920 case SVt_PVLV:
dd28f7bb
DM
5921 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5922 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5923 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5924 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5925 }
5926 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5927 SvREFCNT_dec(LvTARG(sv));
02270b4e 5928 goto freescalar;
a0d0e21e 5929 case SVt_PVGV:
1edc1566 5930 gp_free((GV*)sv);
a0d0e21e 5931 Safefree(GvNAME(sv));
ec12f114
JPC
5932 /* cannot decrease stash refcount yet, as we might recursively delete
5933 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5934 of stash until current sv is completely gone.
5935 -- JohnPC, 27 Mar 1998 */
5936 stash = GvSTASH(sv);
a0d0e21e 5937 /* FALL THROUGH */
79072805 5938 case SVt_PVMG:
79072805
LW
5939 case SVt_PVNV:
5940 case SVt_PVIV:
a0d0e21e 5941 freescalar:
5228ca4e
NC
5942 /* Don't bother with SvOOK_off(sv); as we're only going to free it. */
5943 if (SvOOK(sv)) {
5944 SvPV_set(sv, SvPVX(sv) - SvIVX(sv));
5945 /* Don't even bother with turning off the OOK flag. */
5946 }
79072805
LW
5947 /* FALL THROUGH */
5948 case SVt_PV:
a0d0e21e 5949 case SVt_RV:
810b8aa5
GS
5950 if (SvROK(sv)) {
5951 if (SvWEAKREF(sv))
5952 sv_del_backref(sv);
5953 else
5954 SvREFCNT_dec(SvRV(sv));
5955 }
765f542d 5956#ifdef PERL_COPY_ON_WRITE
3f7c398e 5957 else if (SvPVX_const(sv)) {
765f542d
NC
5958 if (SvIsCOW(sv)) {
5959 /* I believe I need to grab the global SV mutex here and
5960 then recheck the COW status. */
46187eeb
NC
5961 if (DEBUG_C_TEST) {
5962 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
e419cbc5 5963 sv_dump(sv);
46187eeb 5964 }
3f7c398e 5965 sv_release_COW(sv, SvPVX_const(sv), SvCUR(sv), SvLEN(sv),
765f542d
NC
5966 SvUVX(sv), SV_COW_NEXT_SV(sv));
5967 /* And drop it here. */
5968 SvFAKE_off(sv);
5969 } else if (SvLEN(sv)) {
3f7c398e 5970 Safefree(SvPVX_const(sv));
765f542d
NC
5971 }
5972 }
5973#else
3f7c398e
SP
5974 else if (SvPVX_const(sv) && SvLEN(sv))
5975 Safefree(SvPVX_const(sv));
5976 else if (SvPVX_const(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
5977 unsharepvn(SvPVX_const(sv),
25716404
GS
5978 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5979 SvUVX(sv));
1c846c1f
NIS
5980 SvFAKE_off(sv);
5981 }
765f542d 5982#endif
79072805 5983 break;
a0d0e21e 5984/*
79072805 5985 case SVt_NV:
79072805 5986 case SVt_IV:
79072805
LW
5987 case SVt_NULL:
5988 break;
a0d0e21e 5989*/
79072805
LW
5990 }
5991
5992 switch (SvTYPE(sv)) {
5993 case SVt_NULL:
5994 break;
79072805 5995 case SVt_IV:
79072805
LW
5996 break;
5997 case SVt_NV:
5998 del_XNV(SvANY(sv));
5999 break;
ed6116ce 6000 case SVt_RV:
ed6116ce 6001 break;
79072805
LW
6002 case SVt_PV:
6003 del_XPV(SvANY(sv));
6004 break;
6005 case SVt_PVIV:
6006 del_XPVIV(SvANY(sv));
6007 break;
6008 case SVt_PVNV:
6009 del_XPVNV(SvANY(sv));
6010 break;
6011 case SVt_PVMG:
6012 del_XPVMG(SvANY(sv));
6013 break;
6014 case SVt_PVLV:
6015 del_XPVLV(SvANY(sv));
6016 break;
6017 case SVt_PVAV:
6018 del_XPVAV(SvANY(sv));
6019 break;
6020 case SVt_PVHV:
6021 del_XPVHV(SvANY(sv));
6022 break;
6023 case SVt_PVCV:
6024 del_XPVCV(SvANY(sv));
6025 break;
6026 case SVt_PVGV:
6027 del_XPVGV(SvANY(sv));
ec12f114
JPC
6028 /* code duplication for increased performance. */
6029 SvFLAGS(sv) &= SVf_BREAK;
6030 SvFLAGS(sv) |= SVTYPEMASK;
6031 /* decrease refcount of the stash that owns this GV, if any */
6032 if (stash)
6033 SvREFCNT_dec(stash);
6034 return; /* not break, SvFLAGS reset already happened */
79072805
LW
6035 case SVt_PVBM:
6036 del_XPVBM(SvANY(sv));
6037 break;
6038 case SVt_PVFM:
6039 del_XPVFM(SvANY(sv));
6040 break;
8990e307
LW
6041 case SVt_PVIO:
6042 del_XPVIO(SvANY(sv));
6043 break;
79072805 6044 }
a0d0e21e 6045 SvFLAGS(sv) &= SVf_BREAK;
8990e307 6046 SvFLAGS(sv) |= SVTYPEMASK;
79072805
LW
6047}
6048
645c22ef
DM
6049/*
6050=for apidoc sv_newref
6051
6052Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6053instead.
6054
6055=cut
6056*/
6057
79072805 6058SV *
864dbfa3 6059Perl_sv_newref(pTHX_ SV *sv)
79072805 6060{
463ee0b2 6061 if (sv)
4db098f4 6062 (SvREFCNT(sv))++;
79072805
LW
6063 return sv;
6064}
6065
c461cf8f
JH
6066/*
6067=for apidoc sv_free
6068
645c22ef
DM
6069Decrement an SV's reference count, and if it drops to zero, call
6070C<sv_clear> to invoke destructors and free up any memory used by
6071the body; finally, deallocate the SV's head itself.
6072Normally called via a wrapper macro C<SvREFCNT_dec>.
c461cf8f
JH
6073
6074=cut
6075*/
6076
79072805 6077void
864dbfa3 6078Perl_sv_free(pTHX_ SV *sv)
79072805 6079{
27da23d5 6080 dVAR;
79072805
LW
6081 if (!sv)
6082 return;
a0d0e21e
LW
6083 if (SvREFCNT(sv) == 0) {
6084 if (SvFLAGS(sv) & SVf_BREAK)
645c22ef
DM
6085 /* this SV's refcnt has been artificially decremented to
6086 * trigger cleanup */
a0d0e21e 6087 return;
3280af22 6088 if (PL_in_clean_all) /* All is fair */
1edc1566 6089 return;
d689ffdd
JP
6090 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6091 /* make sure SvREFCNT(sv)==0 happens very seldom */
6092 SvREFCNT(sv) = (~(U32)0)/2;
6093 return;
6094 }
0453d815 6095 if (ckWARN_d(WARN_INTERNAL))
d5dede04 6096 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
472d47bc
SB
6097 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6098 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
79072805
LW
6099 return;
6100 }
4db098f4 6101 if (--(SvREFCNT(sv)) > 0)
8990e307 6102 return;
8c4d3c90
NC
6103 Perl_sv_free2(aTHX_ sv);
6104}
6105
6106void
6107Perl_sv_free2(pTHX_ SV *sv)
6108{
27da23d5 6109 dVAR;
463ee0b2
LW
6110#ifdef DEBUGGING
6111 if (SvTEMP(sv)) {
0453d815 6112 if (ckWARN_d(WARN_DEBUGGING))
9014280d 6113 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
472d47bc
SB
6114 "Attempt to free temp prematurely: SV 0x%"UVxf
6115 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
79072805 6116 return;
79072805 6117 }
463ee0b2 6118#endif
d689ffdd
JP
6119 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6120 /* make sure SvREFCNT(sv)==0 happens very seldom */
6121 SvREFCNT(sv) = (~(U32)0)/2;
6122 return;
6123 }
79072805 6124 sv_clear(sv);
477f5d66
CS
6125 if (! SvREFCNT(sv))
6126 del_SV(sv);
79072805
LW
6127}
6128
954c1994
GS
6129/*
6130=for apidoc sv_len
6131
645c22ef
DM
6132Returns the length of the string in the SV. Handles magic and type
6133coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
954c1994
GS
6134
6135=cut
6136*/
6137
79072805 6138STRLEN
864dbfa3 6139Perl_sv_len(pTHX_ register SV *sv)
79072805 6140{
463ee0b2 6141 STRLEN len;
79072805
LW
6142
6143 if (!sv)
6144 return 0;
6145
8990e307 6146 if (SvGMAGICAL(sv))
565764a8 6147 len = mg_length(sv);
8990e307 6148 else
497b47a8 6149 (void)SvPV(sv, len);
463ee0b2 6150 return len;
79072805
LW
6151}
6152
c461cf8f
JH
6153/*
6154=for apidoc sv_len_utf8
6155
6156Returns the number of characters in the string in an SV, counting wide
1e54db1a 6157UTF-8 bytes as a single character. Handles magic and type coercion.
c461cf8f
JH
6158
6159=cut
6160*/
6161
7e8c5dac
HS
6162/*
6163 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
6164 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
6165 * (Note that the mg_len is not the length of the mg_ptr field.)
7a5fa8a2 6166 *
7e8c5dac
HS
6167 */
6168
a0ed51b3 6169STRLEN
864dbfa3 6170Perl_sv_len_utf8(pTHX_ register SV *sv)
a0ed51b3 6171{
a0ed51b3
LW
6172 if (!sv)
6173 return 0;
6174
a0ed51b3 6175 if (SvGMAGICAL(sv))
b76347f2 6176 return mg_length(sv);
a0ed51b3 6177 else
b76347f2 6178 {
7e8c5dac 6179 STRLEN len, ulen;
a3b680e6 6180 const U8 *s = (U8*)SvPV(sv, len);
7e8c5dac
HS
6181 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
6182
e23c8137 6183 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
7e8c5dac 6184 ulen = mg->mg_len;
e23c8137
JH
6185#ifdef PERL_UTF8_CACHE_ASSERT
6186 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
6187#endif
6188 }
7e8c5dac
HS
6189 else {
6190 ulen = Perl_utf8_length(aTHX_ s, s + len);
6191 if (!mg && !SvREADONLY(sv)) {
6192 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6193 mg = mg_find(sv, PERL_MAGIC_utf8);
6194 assert(mg);
6195 }
6196 if (mg)
6197 mg->mg_len = ulen;
6198 }
6199 return ulen;
6200 }
6201}
6202
6203/* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
6204 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6205 * between UTF-8 and byte offsets. There are two (substr offset and substr
6206 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
6207 * and byte offset) cache positions.
6208 *
6209 * The mg_len field is used by sv_len_utf8(), see its comments.
6210 * Note that the mg_len is not the length of the mg_ptr field.
6211 *
6212 */
6213STATIC bool
a3b680e6 6214S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 offsetp, U8 *s, U8 *start)
7e8c5dac 6215{
7a5fa8a2 6216 bool found = FALSE;
7e8c5dac
HS
6217
6218 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
8f78557a 6219 if (!*mgp)
27da23d5 6220 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, (MGVTBL*)&PL_vtbl_utf8, 0, 0);
7e8c5dac 6221 assert(*mgp);
b76347f2 6222
7e8c5dac
HS
6223 if ((*mgp)->mg_ptr)
6224 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6225 else {
6226 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6227 (*mgp)->mg_ptr = (char *) *cachep;
6228 }
6229 assert(*cachep);
6230
a3b680e6 6231 (*cachep)[i] = offsetp;
7e8c5dac
HS
6232 (*cachep)[i+1] = s - start;
6233 found = TRUE;
a0ed51b3 6234 }
7e8c5dac
HS
6235
6236 return found;
a0ed51b3
LW
6237}
6238
645c22ef 6239/*
7e8c5dac
HS
6240 * S_utf8_mg_pos() is used to query and update mg_ptr field of
6241 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6242 * between UTF-8 and byte offsets. See also the comments of
6243 * S_utf8_mg_pos_init().
6244 *
6245 */
6246STATIC bool
6e551876 6247S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
7e8c5dac
HS
6248{
6249 bool found = FALSE;
6250
6251 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6252 if (!*mgp)
6253 *mgp = mg_find(sv, PERL_MAGIC_utf8);
6254 if (*mgp && (*mgp)->mg_ptr) {
6255 *cachep = (STRLEN *) (*mgp)->mg_ptr;
e23c8137 6256 ASSERT_UTF8_CACHE(*cachep);
667208dd 6257 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
7a5fa8a2 6258 found = TRUE;
7e8c5dac
HS
6259 else { /* We will skip to the right spot. */
6260 STRLEN forw = 0;
6261 STRLEN backw = 0;
a3b680e6 6262 const U8* p = NULL;
7e8c5dac
HS
6263
6264 /* The assumption is that going backward is half
6265 * the speed of going forward (that's where the
6266 * 2 * backw in the below comes from). (The real
6267 * figure of course depends on the UTF-8 data.) */
6268
667208dd 6269 if ((*cachep)[i] > (STRLEN)uoff) {
7e8c5dac 6270 forw = uoff;
667208dd 6271 backw = (*cachep)[i] - (STRLEN)uoff;
7e8c5dac
HS
6272
6273 if (forw < 2 * backw)
6274 p = start;
6275 else
6276 p = start + (*cachep)[i+1];
6277 }
6278 /* Try this only for the substr offset (i == 0),
6279 * not for the substr length (i == 2). */
6280 else if (i == 0) { /* (*cachep)[i] < uoff */
a3b680e6 6281 const STRLEN ulen = sv_len_utf8(sv);
7e8c5dac 6282
667208dd
JH
6283 if ((STRLEN)uoff < ulen) {
6284 forw = (STRLEN)uoff - (*cachep)[i];
6285 backw = ulen - (STRLEN)uoff;
7e8c5dac
HS
6286
6287 if (forw < 2 * backw)
6288 p = start + (*cachep)[i+1];
6289 else
6290 p = send;
6291 }
6292
6293 /* If the string is not long enough for uoff,
6294 * we could extend it, but not at this low a level. */
6295 }
6296
6297 if (p) {
6298 if (forw < 2 * backw) {
6299 while (forw--)
6300 p += UTF8SKIP(p);
6301 }
6302 else {
6303 while (backw--) {
6304 p--;
6305 while (UTF8_IS_CONTINUATION(*p))
6306 p--;
6307 }
6308 }
6309
6310 /* Update the cache. */
667208dd 6311 (*cachep)[i] = (STRLEN)uoff;
7e8c5dac 6312 (*cachep)[i+1] = p - start;
8f78557a
AE
6313
6314 /* Drop the stale "length" cache */
6315 if (i == 0) {
6316 (*cachep)[2] = 0;
6317 (*cachep)[3] = 0;
6318 }
7a5fa8a2 6319
7e8c5dac
HS
6320 found = TRUE;
6321 }
6322 }
6323 if (found) { /* Setup the return values. */
6324 *offsetp = (*cachep)[i+1];
6325 *sp = start + *offsetp;
6326 if (*sp >= send) {
6327 *sp = send;
6328 *offsetp = send - start;
6329 }
6330 else if (*sp < start) {
6331 *sp = start;
6332 *offsetp = 0;
6333 }
6334 }
6335 }
e23c8137
JH
6336#ifdef PERL_UTF8_CACHE_ASSERT
6337 if (found) {
6338 U8 *s = start;
6339 I32 n = uoff;
6340
6341 while (n-- && s < send)
6342 s += UTF8SKIP(s);
6343
6344 if (i == 0) {
6345 assert(*offsetp == s - start);
6346 assert((*cachep)[0] == (STRLEN)uoff);
6347 assert((*cachep)[1] == *offsetp);
6348 }
6349 ASSERT_UTF8_CACHE(*cachep);
6350 }
6351#endif
7e8c5dac 6352 }
e23c8137 6353
7e8c5dac
HS
6354 return found;
6355}
7a5fa8a2 6356
7e8c5dac 6357/*
645c22ef
DM
6358=for apidoc sv_pos_u2b
6359
1e54db1a 6360Converts the value pointed to by offsetp from a count of UTF-8 chars from
645c22ef
DM
6361the start of the string, to a count of the equivalent number of bytes; if
6362lenp is non-zero, it does the same to lenp, but this time starting from
6363the offset, rather than from the start of the string. Handles magic and
6364type coercion.
6365
6366=cut
6367*/
6368
7e8c5dac
HS
6369/*
6370 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6371 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6372 * byte offsets. See also the comments of S_utf8_mg_pos().
6373 *
6374 */
6375
a0ed51b3 6376void
864dbfa3 6377Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
a0ed51b3 6378{
dfe13c55 6379 U8 *start;
a0ed51b3
LW
6380 STRLEN len;
6381
6382 if (!sv)
6383 return;
6384
b464bac0 6385 start = (U8*)SvPV(sv, len);
7e8c5dac 6386 if (len) {
b464bac0
AL
6387 STRLEN boffset = 0;
6388 STRLEN *cache = 0;
6389 U8 *s = start;
7e8c5dac
HS
6390 I32 uoffset = *offsetp;
6391 U8 *send = s + len;
6392 MAGIC *mg = 0;
6393 bool found = FALSE;
6394
bdf77a2a 6395 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
7e8c5dac
HS
6396 found = TRUE;
6397 if (!found && uoffset > 0) {
6398 while (s < send && uoffset--)
6399 s += UTF8SKIP(s);
6400 if (s >= send)
6401 s = send;
a3b680e6 6402 if (utf8_mg_pos_init(sv, &mg, &cache, 0, *offsetp, s, start))
7e8c5dac
HS
6403 boffset = cache[1];
6404 *offsetp = s - start;
6405 }
6406 if (lenp) {
6407 found = FALSE;
6408 start = s;
ec062429 6409 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp, &s, start, send)) {
7e8c5dac
HS
6410 *lenp -= boffset;
6411 found = TRUE;
6412 }
6413 if (!found && *lenp > 0) {
6414 I32 ulen = *lenp;
6415 if (ulen > 0)
6416 while (s < send && ulen--)
6417 s += UTF8SKIP(s);
6418 if (s >= send)
6419 s = send;
a3b680e6 6420 utf8_mg_pos_init(sv, &mg, &cache, 2, *lenp, s, start);
7e8c5dac
HS
6421 }
6422 *lenp = s - start;
6423 }
e23c8137 6424 ASSERT_UTF8_CACHE(cache);
7e8c5dac
HS
6425 }
6426 else {
6427 *offsetp = 0;
6428 if (lenp)
6429 *lenp = 0;
a0ed51b3 6430 }
e23c8137 6431
a0ed51b3
LW
6432 return;
6433}
6434
645c22ef
DM
6435/*
6436=for apidoc sv_pos_b2u
6437
6438Converts the value pointed to by offsetp from a count of bytes from the
1e54db1a 6439start of the string, to a count of the equivalent number of UTF-8 chars.
645c22ef
DM
6440Handles magic and type coercion.
6441
6442=cut
6443*/
6444
7e8c5dac
HS
6445/*
6446 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6447 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6448 * byte offsets. See also the comments of S_utf8_mg_pos().
6449 *
6450 */
6451
a0ed51b3 6452void
7e8c5dac 6453Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
a0ed51b3 6454{
7e8c5dac 6455 U8* s;
a0ed51b3
LW
6456 STRLEN len;
6457
6458 if (!sv)
6459 return;
6460
dfe13c55 6461 s = (U8*)SvPV(sv, len);
eb160463 6462 if ((I32)len < *offsetp)
a0dbb045 6463 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
7e8c5dac
HS
6464 else {
6465 U8* send = s + *offsetp;
6466 MAGIC* mg = NULL;
6467 STRLEN *cache = NULL;
6468
6469 len = 0;
6470
6471 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6472 mg = mg_find(sv, PERL_MAGIC_utf8);
6473 if (mg && mg->mg_ptr) {
6474 cache = (STRLEN *) mg->mg_ptr;
c5661c80 6475 if (cache[1] == (STRLEN)*offsetp) {
7e8c5dac
HS
6476 /* An exact match. */
6477 *offsetp = cache[0];
6478
6479 return;
6480 }
c5661c80 6481 else if (cache[1] < (STRLEN)*offsetp) {
7e8c5dac
HS
6482 /* We already know part of the way. */
6483 len = cache[0];
6484 s += cache[1];
7a5fa8a2 6485 /* Let the below loop do the rest. */
7e8c5dac
HS
6486 }
6487 else { /* cache[1] > *offsetp */
6488 /* We already know all of the way, now we may
6489 * be able to walk back. The same assumption
6490 * is made as in S_utf8_mg_pos(), namely that
6491 * walking backward is twice slower than
6492 * walking forward. */
6493 STRLEN forw = *offsetp;
6494 STRLEN backw = cache[1] - *offsetp;
6495
6496 if (!(forw < 2 * backw)) {
6497 U8 *p = s + cache[1];
6498 STRLEN ubackw = 0;
7a5fa8a2 6499
a5b510f2
AE
6500 cache[1] -= backw;
6501
7e8c5dac
HS
6502 while (backw--) {
6503 p--;
0aeb64d0 6504 while (UTF8_IS_CONTINUATION(*p)) {
7e8c5dac 6505 p--;
0aeb64d0
JH
6506 backw--;
6507 }
7e8c5dac
HS
6508 ubackw++;
6509 }
6510
6511 cache[0] -= ubackw;
0aeb64d0 6512 *offsetp = cache[0];
a67d7df9
TS
6513
6514 /* Drop the stale "length" cache */
6515 cache[2] = 0;
6516 cache[3] = 0;
6517
0aeb64d0 6518 return;
7e8c5dac
HS
6519 }
6520 }
6521 }
e23c8137 6522 ASSERT_UTF8_CACHE(cache);
a0dbb045 6523 }
7e8c5dac
HS
6524
6525 while (s < send) {
6526 STRLEN n = 1;
6527
6528 /* Call utf8n_to_uvchr() to validate the sequence
6529 * (unless a simple non-UTF character) */
6530 if (!UTF8_IS_INVARIANT(*s))
6531 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6532 if (n > 0) {
6533 s += n;
6534 len++;
6535 }
6536 else
6537 break;
6538 }
6539
6540 if (!SvREADONLY(sv)) {
6541 if (!mg) {
6542 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6543 mg = mg_find(sv, PERL_MAGIC_utf8);
6544 }
6545 assert(mg);
6546
6547 if (!mg->mg_ptr) {
979acdb5 6548 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
7e8c5dac
HS
6549 mg->mg_ptr = (char *) cache;
6550 }
6551 assert(cache);
6552
6553 cache[0] = len;
6554 cache[1] = *offsetp;
a67d7df9
TS
6555 /* Drop the stale "length" cache */
6556 cache[2] = 0;
6557 cache[3] = 0;
7e8c5dac
HS
6558 }
6559
6560 *offsetp = len;
a0ed51b3 6561 }
a0ed51b3
LW
6562 return;
6563}
6564
954c1994
GS
6565/*
6566=for apidoc sv_eq
6567
6568Returns a boolean indicating whether the strings in the two SVs are
645c22ef
DM
6569identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6570coerce its args to strings if necessary.
954c1994
GS
6571
6572=cut
6573*/
6574
79072805 6575I32
e01b9e88 6576Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
79072805 6577{
e1ec3a88 6578 const char *pv1;
463ee0b2 6579 STRLEN cur1;
e1ec3a88 6580 const char *pv2;
463ee0b2 6581 STRLEN cur2;
e01b9e88 6582 I32 eq = 0;
553e1bcc
AT
6583 char *tpv = Nullch;
6584 SV* svrecode = Nullsv;
79072805 6585
e01b9e88 6586 if (!sv1) {
79072805
LW
6587 pv1 = "";
6588 cur1 = 0;
6589 }
463ee0b2 6590 else
e01b9e88 6591 pv1 = SvPV(sv1, cur1);
79072805 6592
e01b9e88
SC
6593 if (!sv2){
6594 pv2 = "";
6595 cur2 = 0;
92d29cee 6596 }
e01b9e88
SC
6597 else
6598 pv2 = SvPV(sv2, cur2);
79072805 6599
cf48d248 6600 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
799ef3cb
JH
6601 /* Differing utf8ness.
6602 * Do not UTF8size the comparands as a side-effect. */
6603 if (PL_encoding) {
6604 if (SvUTF8(sv1)) {
553e1bcc
AT
6605 svrecode = newSVpvn(pv2, cur2);
6606 sv_recode_to_utf8(svrecode, PL_encoding);
6607 pv2 = SvPV(svrecode, cur2);
799ef3cb
JH
6608 }
6609 else {
553e1bcc
AT
6610 svrecode = newSVpvn(pv1, cur1);
6611 sv_recode_to_utf8(svrecode, PL_encoding);
6612 pv1 = SvPV(svrecode, cur1);
799ef3cb
JH
6613 }
6614 /* Now both are in UTF-8. */
0a1bd7ac
DM
6615 if (cur1 != cur2) {
6616 SvREFCNT_dec(svrecode);
799ef3cb 6617 return FALSE;
0a1bd7ac 6618 }
799ef3cb
JH
6619 }
6620 else {
6621 bool is_utf8 = TRUE;
6622
6623 if (SvUTF8(sv1)) {
6624 /* sv1 is the UTF-8 one,
6625 * if is equal it must be downgrade-able */
e1ec3a88 6626 char *pv = (char*)bytes_from_utf8((const U8*)pv1,
799ef3cb
JH
6627 &cur1, &is_utf8);
6628 if (pv != pv1)
553e1bcc 6629 pv1 = tpv = pv;
799ef3cb
JH
6630 }
6631 else {
6632 /* sv2 is the UTF-8 one,
6633 * if is equal it must be downgrade-able */
e1ec3a88 6634 char *pv = (char *)bytes_from_utf8((const U8*)pv2,
799ef3cb
JH
6635 &cur2, &is_utf8);
6636 if (pv != pv2)
553e1bcc 6637 pv2 = tpv = pv;
799ef3cb
JH
6638 }
6639 if (is_utf8) {
6640 /* Downgrade not possible - cannot be eq */
bf694877 6641 assert (tpv == 0);
799ef3cb
JH
6642 return FALSE;
6643 }
6644 }
cf48d248
JH
6645 }
6646
6647 if (cur1 == cur2)
765f542d 6648 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
e01b9e88 6649
553e1bcc
AT
6650 if (svrecode)
6651 SvREFCNT_dec(svrecode);
799ef3cb 6652
553e1bcc
AT
6653 if (tpv)
6654 Safefree(tpv);
cf48d248 6655
e01b9e88 6656 return eq;
79072805
LW
6657}
6658
954c1994
GS
6659/*
6660=for apidoc sv_cmp
6661
6662Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6663string in C<sv1> is less than, equal to, or greater than the string in
645c22ef
DM
6664C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6665coerce its args to strings if necessary. See also C<sv_cmp_locale>.
954c1994
GS
6666
6667=cut
6668*/
6669
79072805 6670I32
e01b9e88 6671Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
79072805 6672{
560a288e 6673 STRLEN cur1, cur2;
e1ec3a88
AL
6674 const char *pv1, *pv2;
6675 char *tpv = Nullch;
cf48d248 6676 I32 cmp;
553e1bcc 6677 SV *svrecode = Nullsv;
560a288e 6678
e01b9e88
SC
6679 if (!sv1) {
6680 pv1 = "";
560a288e
GS
6681 cur1 = 0;
6682 }
e01b9e88
SC
6683 else
6684 pv1 = SvPV(sv1, cur1);
560a288e 6685
553e1bcc 6686 if (!sv2) {
e01b9e88 6687 pv2 = "";
560a288e
GS
6688 cur2 = 0;
6689 }
e01b9e88
SC
6690 else
6691 pv2 = SvPV(sv2, cur2);
79072805 6692
cf48d248 6693 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
799ef3cb
JH
6694 /* Differing utf8ness.
6695 * Do not UTF8size the comparands as a side-effect. */
cf48d248 6696 if (SvUTF8(sv1)) {
799ef3cb 6697 if (PL_encoding) {
553e1bcc
AT
6698 svrecode = newSVpvn(pv2, cur2);
6699 sv_recode_to_utf8(svrecode, PL_encoding);
6700 pv2 = SvPV(svrecode, cur2);
799ef3cb
JH
6701 }
6702 else {
e1ec3a88 6703 pv2 = tpv = (char*)bytes_to_utf8((const U8*)pv2, &cur2);
799ef3cb 6704 }
cf48d248
JH
6705 }
6706 else {
799ef3cb 6707 if (PL_encoding) {
553e1bcc
AT
6708 svrecode = newSVpvn(pv1, cur1);
6709 sv_recode_to_utf8(svrecode, PL_encoding);
6710 pv1 = SvPV(svrecode, cur1);
799ef3cb
JH
6711 }
6712 else {
e1ec3a88 6713 pv1 = tpv = (char*)bytes_to_utf8((const U8*)pv1, &cur1);
799ef3cb 6714 }
cf48d248
JH
6715 }
6716 }
6717
e01b9e88 6718 if (!cur1) {
cf48d248 6719 cmp = cur2 ? -1 : 0;
e01b9e88 6720 } else if (!cur2) {
cf48d248
JH
6721 cmp = 1;
6722 } else {
e1ec3a88 6723 const I32 retval = memcmp((const void*)pv1, (const void*)pv2, cur1 < cur2 ? cur1 : cur2);
e01b9e88
SC
6724
6725 if (retval) {
cf48d248 6726 cmp = retval < 0 ? -1 : 1;
e01b9e88 6727 } else if (cur1 == cur2) {
cf48d248
JH
6728 cmp = 0;
6729 } else {
6730 cmp = cur1 < cur2 ? -1 : 1;
e01b9e88 6731 }
cf48d248 6732 }
16660edb 6733
553e1bcc
AT
6734 if (svrecode)
6735 SvREFCNT_dec(svrecode);
799ef3cb 6736
553e1bcc
AT
6737 if (tpv)
6738 Safefree(tpv);
cf48d248
JH
6739
6740 return cmp;
bbce6d69 6741}
16660edb 6742
c461cf8f
JH
6743/*
6744=for apidoc sv_cmp_locale
6745
645c22ef
DM
6746Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6747'use bytes' aware, handles get magic, and will coerce its args to strings
6748if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
c461cf8f
JH
6749
6750=cut
6751*/
6752
bbce6d69 6753I32
864dbfa3 6754Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
bbce6d69 6755{
36477c24 6756#ifdef USE_LOCALE_COLLATE
16660edb 6757
bbce6d69 6758 char *pv1, *pv2;
6759 STRLEN len1, len2;
6760 I32 retval;
16660edb 6761
3280af22 6762 if (PL_collation_standard)
bbce6d69 6763 goto raw_compare;
16660edb 6764
bbce6d69 6765 len1 = 0;
8ac85365 6766 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
bbce6d69 6767 len2 = 0;
8ac85365 6768 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
16660edb 6769
bbce6d69 6770 if (!pv1 || !len1) {
6771 if (pv2 && len2)
6772 return -1;
6773 else
6774 goto raw_compare;
6775 }
6776 else {
6777 if (!pv2 || !len2)
6778 return 1;
6779 }
16660edb 6780
bbce6d69 6781 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
16660edb 6782
bbce6d69 6783 if (retval)
16660edb 6784 return retval < 0 ? -1 : 1;
6785
bbce6d69 6786 /*
6787 * When the result of collation is equality, that doesn't mean
6788 * that there are no differences -- some locales exclude some
6789 * characters from consideration. So to avoid false equalities,
6790 * we use the raw string as a tiebreaker.
6791 */
16660edb 6792
bbce6d69 6793 raw_compare:
6794 /* FALL THROUGH */
16660edb 6795
36477c24 6796#endif /* USE_LOCALE_COLLATE */
16660edb 6797
bbce6d69 6798 return sv_cmp(sv1, sv2);
6799}
79072805 6800
645c22ef 6801
36477c24 6802#ifdef USE_LOCALE_COLLATE
645c22ef 6803
7a4c00b4 6804/*
645c22ef
DM
6805=for apidoc sv_collxfrm
6806
6807Add Collate Transform magic to an SV if it doesn't already have it.
6808
6809Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6810scalar data of the variable, but transformed to such a format that a normal
6811memory comparison can be used to compare the data according to the locale
6812settings.
6813
6814=cut
6815*/
6816
bbce6d69 6817char *
864dbfa3 6818Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
bbce6d69 6819{
7a4c00b4 6820 MAGIC *mg;
16660edb 6821
14befaf4 6822 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
3280af22 6823 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
bbce6d69 6824 char *s, *xf;
6825 STRLEN len, xlen;
6826
7a4c00b4 6827 if (mg)
6828 Safefree(mg->mg_ptr);
bbce6d69 6829 s = SvPV(sv, len);
6830 if ((xf = mem_collxfrm(s, len, &xlen))) {
ff0cee69 6831 if (SvREADONLY(sv)) {
6832 SAVEFREEPV(xf);
6833 *nxp = xlen;
3280af22 6834 return xf + sizeof(PL_collation_ix);
ff0cee69 6835 }
7a4c00b4 6836 if (! mg) {
14befaf4
DM
6837 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6838 mg = mg_find(sv, PERL_MAGIC_collxfrm);
7a4c00b4 6839 assert(mg);
bbce6d69 6840 }
7a4c00b4 6841 mg->mg_ptr = xf;
565764a8 6842 mg->mg_len = xlen;
7a4c00b4 6843 }
6844 else {
ff0cee69 6845 if (mg) {
6846 mg->mg_ptr = NULL;
565764a8 6847 mg->mg_len = -1;
ff0cee69 6848 }
bbce6d69 6849 }
6850 }
7a4c00b4 6851 if (mg && mg->mg_ptr) {
565764a8 6852 *nxp = mg->mg_len;
3280af22 6853 return mg->mg_ptr + sizeof(PL_collation_ix);
bbce6d69 6854 }
6855 else {
6856 *nxp = 0;
6857 return NULL;
16660edb 6858 }
79072805
LW
6859}
6860
36477c24 6861#endif /* USE_LOCALE_COLLATE */
bbce6d69 6862
c461cf8f
JH
6863/*
6864=for apidoc sv_gets
6865
6866Get a line from the filehandle and store it into the SV, optionally
6867appending to the currently-stored string.
6868
6869=cut
6870*/
6871
79072805 6872char *
864dbfa3 6873Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
79072805 6874{
e1ec3a88 6875 const char *rsptr;
c07a80fd 6876 STRLEN rslen;
6877 register STDCHAR rslast;
6878 register STDCHAR *bp;
6879 register I32 cnt;
9c5ffd7c 6880 I32 i = 0;
8bfdd7d9 6881 I32 rspara = 0;
e311fd51 6882 I32 recsize;
c07a80fd 6883
bc44a8a2
NC
6884 if (SvTHINKFIRST(sv))
6885 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
765f542d
NC
6886 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6887 from <>.
6888 However, perlbench says it's slower, because the existing swipe code
6889 is faster than copy on write.
6890 Swings and roundabouts. */
6fc92669 6891 (void)SvUPGRADE(sv, SVt_PV);
99491443 6892
ff68c719 6893 SvSCREAM_off(sv);
efd8b2ba
AE
6894
6895 if (append) {
6896 if (PerlIO_isutf8(fp)) {
6897 if (!SvUTF8(sv)) {
6898 sv_utf8_upgrade_nomg(sv);
6899 sv_pos_u2b(sv,&append,0);
6900 }
6901 } else if (SvUTF8(sv)) {
6902 SV *tsv = NEWSV(0,0);
6903 sv_gets(tsv, fp, 0);
6904 sv_utf8_upgrade_nomg(tsv);
6905 SvCUR_set(sv,append);
6906 sv_catsv(sv,tsv);
6907 sv_free(tsv);
6908 goto return_string_or_null;
6909 }
6910 }
6911
6912 SvPOK_only(sv);
6913 if (PerlIO_isutf8(fp))
6914 SvUTF8_on(sv);
c07a80fd 6915
923e4eb5 6916 if (IN_PERL_COMPILETIME) {
8bfdd7d9
HS
6917 /* we always read code in line mode */
6918 rsptr = "\n";
6919 rslen = 1;
6920 }
6921 else if (RsSNARF(PL_rs)) {
7a5fa8a2
NIS
6922 /* If it is a regular disk file use size from stat() as estimate
6923 of amount we are going to read - may result in malloc-ing
6924 more memory than we realy need if layers bellow reduce
e468d35b
NIS
6925 size we read (e.g. CRLF or a gzip layer)
6926 */
e311fd51 6927 Stat_t st;
e468d35b 6928 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
f54cb97a 6929 const Off_t offset = PerlIO_tell(fp);
58f1856e 6930 if (offset != (Off_t) -1 && st.st_size + append > offset) {
e468d35b
NIS
6931 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6932 }
6933 }
c07a80fd 6934 rsptr = NULL;
6935 rslen = 0;
6936 }
3280af22 6937 else if (RsRECORD(PL_rs)) {
e311fd51 6938 I32 bytesread;
5b2b9c68
HM
6939 char *buffer;
6940
6941 /* Grab the size of the record we're getting */
3280af22 6942 recsize = SvIV(SvRV(PL_rs));
e311fd51 6943 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5b2b9c68
HM
6944 /* Go yank in */
6945#ifdef VMS
6946 /* VMS wants read instead of fread, because fread doesn't respect */
6947 /* RMS record boundaries. This is not necessarily a good thing to be */
e468d35b
NIS
6948 /* doing, but we've got no other real choice - except avoid stdio
6949 as implementation - perhaps write a :vms layer ?
6950 */
5b2b9c68
HM
6951 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6952#else
6953 bytesread = PerlIO_read(fp, buffer, recsize);
6954#endif
27e6ca2d
AE
6955 if (bytesread < 0)
6956 bytesread = 0;
e311fd51 6957 SvCUR_set(sv, bytesread += append);
e670df4e 6958 buffer[bytesread] = '\0';
efd8b2ba 6959 goto return_string_or_null;
5b2b9c68 6960 }
3280af22 6961 else if (RsPARA(PL_rs)) {
c07a80fd 6962 rsptr = "\n\n";
6963 rslen = 2;
8bfdd7d9 6964 rspara = 1;
c07a80fd 6965 }
7d59b7e4
NIS
6966 else {
6967 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6968 if (PerlIO_isutf8(fp)) {
6969 rsptr = SvPVutf8(PL_rs, rslen);
6970 }
6971 else {
6972 if (SvUTF8(PL_rs)) {
6973 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6974 Perl_croak(aTHX_ "Wide character in $/");
6975 }
6976 }
6977 rsptr = SvPV(PL_rs, rslen);
6978 }
6979 }
6980
c07a80fd 6981 rslast = rslen ? rsptr[rslen - 1] : '\0';
6982
8bfdd7d9 6983 if (rspara) { /* have to do this both before and after */
79072805 6984 do { /* to make sure file boundaries work right */
760ac839 6985 if (PerlIO_eof(fp))
a0d0e21e 6986 return 0;
760ac839 6987 i = PerlIO_getc(fp);
79072805 6988 if (i != '\n') {
a0d0e21e
LW
6989 if (i == -1)
6990 return 0;
760ac839 6991 PerlIO_ungetc(fp,i);
79072805
LW
6992 break;
6993 }
6994 } while (i != EOF);
6995 }
c07a80fd 6996
760ac839
LW
6997 /* See if we know enough about I/O mechanism to cheat it ! */
6998
6999 /* This used to be #ifdef test - it is made run-time test for ease
1c846c1f 7000 of abstracting out stdio interface. One call should be cheap
760ac839
LW
7001 enough here - and may even be a macro allowing compile
7002 time optimization.
7003 */
7004
7005 if (PerlIO_fast_gets(fp)) {
7006
7007 /*
7008 * We're going to steal some values from the stdio struct
7009 * and put EVERYTHING in the innermost loop into registers.
7010 */
7011 register STDCHAR *ptr;
7012 STRLEN bpx;
7013 I32 shortbuffered;
7014
16660edb 7015#if defined(VMS) && defined(PERLIO_IS_STDIO)
7016 /* An ungetc()d char is handled separately from the regular
7017 * buffer, so we getc() it back out and stuff it in the buffer.
7018 */
7019 i = PerlIO_getc(fp);
7020 if (i == EOF) return 0;
7021 *(--((*fp)->_ptr)) = (unsigned char) i;
7022 (*fp)->_cnt++;
7023#endif
c07a80fd 7024
c2960299 7025 /* Here is some breathtakingly efficient cheating */
c07a80fd 7026
a20bf0c3 7027 cnt = PerlIO_get_cnt(fp); /* get count into register */
e468d35b 7028 /* make sure we have the room */
7a5fa8a2 7029 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
e468d35b 7030 /* Not room for all of it
7a5fa8a2 7031 if we are looking for a separator and room for some
e468d35b
NIS
7032 */
7033 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7a5fa8a2 7034 /* just process what we have room for */
79072805
LW
7035 shortbuffered = cnt - SvLEN(sv) + append + 1;
7036 cnt -= shortbuffered;
7037 }
7038 else {
7039 shortbuffered = 0;
bbce6d69 7040 /* remember that cnt can be negative */
eb160463 7041 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
79072805
LW
7042 }
7043 }
7a5fa8a2 7044 else
79072805 7045 shortbuffered = 0;
3f7c398e 7046 bp = (STDCHAR*)SvPVX_const(sv) + append; /* move these two too to registers */
a20bf0c3 7047 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
16660edb 7048 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 7049 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
16660edb 7050 DEBUG_P(PerlIO_printf(Perl_debug_log,
ba7abf9d 7051 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
1c846c1f 7052 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
1d7c1841 7053 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
79072805
LW
7054 for (;;) {
7055 screamer:
93a17b20 7056 if (cnt > 0) {
c07a80fd 7057 if (rslen) {
760ac839
LW
7058 while (cnt > 0) { /* this | eat */
7059 cnt--;
c07a80fd 7060 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7061 goto thats_all_folks; /* screams | sed :-) */
7062 }
7063 }
7064 else {
1c846c1f
NIS
7065 Copy(ptr, bp, cnt, char); /* this | eat */
7066 bp += cnt; /* screams | dust */
c07a80fd 7067 ptr += cnt; /* louder | sed :-) */
a5f75d66 7068 cnt = 0;
93a17b20 7069 }
79072805
LW
7070 }
7071
748a9306 7072 if (shortbuffered) { /* oh well, must extend */
79072805
LW
7073 cnt = shortbuffered;
7074 shortbuffered = 0;
3f7c398e 7075 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
79072805
LW
7076 SvCUR_set(sv, bpx);
7077 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
3f7c398e 7078 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
79072805
LW
7079 continue;
7080 }
7081
16660edb 7082 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841
GS
7083 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7084 PTR2UV(ptr),(long)cnt));
cc00df79 7085 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
ba7abf9d 7086#if 0
16660edb 7087 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 7088 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
1c846c1f 7089 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
1d7c1841 7090 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
ba7abf9d 7091#endif
1c846c1f 7092 /* This used to call 'filbuf' in stdio form, but as that behaves like
774d564b 7093 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7094 another abstraction. */
760ac839 7095 i = PerlIO_getc(fp); /* get more characters */
ba7abf9d 7096#if 0
16660edb 7097 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 7098 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
1c846c1f 7099 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
1d7c1841 7100 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
ba7abf9d 7101#endif
a20bf0c3
JH
7102 cnt = PerlIO_get_cnt(fp);
7103 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
16660edb 7104 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 7105 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
79072805 7106
748a9306
LW
7107 if (i == EOF) /* all done for ever? */
7108 goto thats_really_all_folks;
7109
3f7c398e 7110 bpx = bp - (STDCHAR*)SvPVX_const(sv); /* box up before relocation */
79072805
LW
7111 SvCUR_set(sv, bpx);
7112 SvGROW(sv, bpx + cnt + 2);
3f7c398e 7113 bp = (STDCHAR*)SvPVX_const(sv) + bpx; /* unbox after relocation */
c07a80fd 7114
eb160463 7115 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
79072805 7116
c07a80fd 7117 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
79072805 7118 goto thats_all_folks;
79072805
LW
7119 }
7120
7121thats_all_folks:
3f7c398e 7122 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX_const(sv)) < rslen) ||
36477c24 7123 memNE((char*)bp - rslen, rsptr, rslen))
760ac839 7124 goto screamer; /* go back to the fray */
79072805
LW
7125thats_really_all_folks:
7126 if (shortbuffered)
7127 cnt += shortbuffered;
16660edb 7128 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 7129 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
cc00df79 7130 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
16660edb 7131 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 7132 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
1c846c1f 7133 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
1d7c1841 7134 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
79072805 7135 *bp = '\0';
3f7c398e 7136 SvCUR_set(sv, bp - (STDCHAR*)SvPVX_const(sv)); /* set length */
16660edb 7137 DEBUG_P(PerlIO_printf(Perl_debug_log,
fb73857a 7138 "Screamer: done, len=%ld, string=|%.*s|\n",
3f7c398e 7139 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX_const(sv)));
760ac839
LW
7140 }
7141 else
79072805 7142 {
6edd2cd5 7143 /*The big, slow, and stupid way. */
27da23d5 7144#ifdef USE_HEAP_INSTEAD_OF_STACK /* Even slower way. */
6edd2cd5
JH
7145 STDCHAR *buf = 0;
7146 New(0, buf, 8192, STDCHAR);
7147 assert(buf);
4d2c4e07 7148#else
6edd2cd5 7149 STDCHAR buf[8192];
4d2c4e07 7150#endif
79072805 7151
760ac839 7152screamer2:
c07a80fd 7153 if (rslen) {
6867be6d 7154 const register STDCHAR *bpe = buf + sizeof(buf);
760ac839 7155 bp = buf;
eb160463 7156 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
760ac839
LW
7157 ; /* keep reading */
7158 cnt = bp - buf;
c07a80fd 7159 }
7160 else {
760ac839 7161 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
16660edb 7162 /* Accomodate broken VAXC compiler, which applies U8 cast to
7163 * both args of ?: operator, causing EOF to change into 255
7164 */
37be0adf 7165 if (cnt > 0)
cbe9e203
JH
7166 i = (U8)buf[cnt - 1];
7167 else
37be0adf 7168 i = EOF;
c07a80fd 7169 }
79072805 7170
cbe9e203
JH
7171 if (cnt < 0)
7172 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7173 if (append)
7174 sv_catpvn(sv, (char *) buf, cnt);
7175 else
7176 sv_setpvn(sv, (char *) buf, cnt);
c07a80fd 7177
7178 if (i != EOF && /* joy */
7179 (!rslen ||
7180 SvCUR(sv) < rslen ||
3f7c398e 7181 memNE(SvPVX_const(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
79072805
LW
7182 {
7183 append = -1;
63e4d877
CS
7184 /*
7185 * If we're reading from a TTY and we get a short read,
7186 * indicating that the user hit his EOF character, we need
7187 * to notice it now, because if we try to read from the TTY
7188 * again, the EOF condition will disappear.
7189 *
7190 * The comparison of cnt to sizeof(buf) is an optimization
7191 * that prevents unnecessary calls to feof().
7192 *
7193 * - jik 9/25/96
7194 */
7195 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
7196 goto screamer2;
79072805 7197 }
6edd2cd5 7198
27da23d5 7199#ifdef USE_HEAP_INSTEAD_OF_STACK
6edd2cd5
JH
7200 Safefree(buf);
7201#endif
79072805
LW
7202 }
7203
8bfdd7d9 7204 if (rspara) { /* have to do this both before and after */
c07a80fd 7205 while (i != EOF) { /* to make sure file boundaries work right */
760ac839 7206 i = PerlIO_getc(fp);
79072805 7207 if (i != '\n') {
760ac839 7208 PerlIO_ungetc(fp,i);
79072805
LW
7209 break;
7210 }
7211 }
7212 }
c07a80fd 7213
efd8b2ba 7214return_string_or_null:
c07a80fd 7215 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
79072805
LW
7216}
7217
954c1994
GS
7218/*
7219=for apidoc sv_inc
7220
645c22ef
DM
7221Auto-increment of the value in the SV, doing string to numeric conversion
7222if necessary. Handles 'get' magic.
954c1994
GS
7223
7224=cut
7225*/
7226
79072805 7227void
864dbfa3 7228Perl_sv_inc(pTHX_ register SV *sv)
79072805
LW
7229{
7230 register char *d;
463ee0b2 7231 int flags;
79072805
LW
7232
7233 if (!sv)
7234 return;
b23a5f78
GB
7235 if (SvGMAGICAL(sv))
7236 mg_get(sv);
ed6116ce 7237 if (SvTHINKFIRST(sv)) {
765f542d
NC
7238 if (SvIsCOW(sv))
7239 sv_force_normal_flags(sv, 0);
0f15f207 7240 if (SvREADONLY(sv)) {
923e4eb5 7241 if (IN_PERL_RUNTIME)
cea2e8a9 7242 Perl_croak(aTHX_ PL_no_modify);
0f15f207 7243 }
a0d0e21e 7244 if (SvROK(sv)) {
b5be31e9 7245 IV i;
9e7bc3e8
JD
7246 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7247 return;
56431972 7248 i = PTR2IV(SvRV(sv));
b5be31e9
SM
7249 sv_unref(sv);
7250 sv_setiv(sv, i);
a0d0e21e 7251 }
ed6116ce 7252 }
8990e307 7253 flags = SvFLAGS(sv);
28e5dec8
JH
7254 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7255 /* It's (privately or publicly) a float, but not tested as an
7256 integer, so test it to see. */
d460ef45 7257 (void) SvIV(sv);
28e5dec8
JH
7258 flags = SvFLAGS(sv);
7259 }
7260 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7261 /* It's publicly an integer, or privately an integer-not-float */
59d8ce62 7262#ifdef PERL_PRESERVE_IVUV
28e5dec8 7263 oops_its_int:
59d8ce62 7264#endif
25da4f38
IZ
7265 if (SvIsUV(sv)) {
7266 if (SvUVX(sv) == UV_MAX)
a1e868e7 7267 sv_setnv(sv, UV_MAX_P1);
25da4f38
IZ
7268 else
7269 (void)SvIOK_only_UV(sv);
607fa7f2 7270 SvUV_set(sv, SvUVX(sv) + 1);
25da4f38
IZ
7271 } else {
7272 if (SvIVX(sv) == IV_MAX)
28e5dec8 7273 sv_setuv(sv, (UV)IV_MAX + 1);
25da4f38
IZ
7274 else {
7275 (void)SvIOK_only(sv);
45977657 7276 SvIV_set(sv, SvIVX(sv) + 1);
1c846c1f 7277 }
55497cff 7278 }
79072805
LW
7279 return;
7280 }
28e5dec8
JH
7281 if (flags & SVp_NOK) {
7282 (void)SvNOK_only(sv);
9d6ce603 7283 SvNV_set(sv, SvNVX(sv) + 1.0);
28e5dec8
JH
7284 return;
7285 }
7286
3f7c398e 7287 if (!(flags & SVp_POK) || !*SvPVX_const(sv)) {
28e5dec8
JH
7288 if ((flags & SVTYPEMASK) < SVt_PVIV)
7289 sv_upgrade(sv, SVt_IV);
7290 (void)SvIOK_only(sv);
45977657 7291 SvIV_set(sv, 1);
79072805
LW
7292 return;
7293 }
463ee0b2 7294 d = SvPVX(sv);
79072805
LW
7295 while (isALPHA(*d)) d++;
7296 while (isDIGIT(*d)) d++;
7297 if (*d) {
28e5dec8 7298#ifdef PERL_PRESERVE_IVUV
d1be9408 7299 /* Got to punt this as an integer if needs be, but we don't issue
28e5dec8
JH
7300 warnings. Probably ought to make the sv_iv_please() that does
7301 the conversion if possible, and silently. */
504618e9 7302 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
28e5dec8
JH
7303 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7304 /* Need to try really hard to see if it's an integer.
7305 9.22337203685478e+18 is an integer.
7306 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7307 so $a="9.22337203685478e+18"; $a+0; $a++
7308 needs to be the same as $a="9.22337203685478e+18"; $a++
7309 or we go insane. */
d460ef45 7310
28e5dec8
JH
7311 (void) sv_2iv(sv);
7312 if (SvIOK(sv))
7313 goto oops_its_int;
7314
7315 /* sv_2iv *should* have made this an NV */
7316 if (flags & SVp_NOK) {
7317 (void)SvNOK_only(sv);
9d6ce603 7318 SvNV_set(sv, SvNVX(sv) + 1.0);
28e5dec8
JH
7319 return;
7320 }
7321 /* I don't think we can get here. Maybe I should assert this
7322 And if we do get here I suspect that sv_setnv will croak. NWC
7323 Fall through. */
7324#if defined(USE_LONG_DOUBLE)
7325 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",
3f7c398e 7326 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
28e5dec8 7327#else
1779d84d 7328 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
3f7c398e 7329 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
28e5dec8
JH
7330#endif
7331 }
7332#endif /* PERL_PRESERVE_IVUV */
3f7c398e 7333 sv_setnv(sv,Atof(SvPVX_const(sv)) + 1.0);
79072805
LW
7334 return;
7335 }
7336 d--;
3f7c398e 7337 while (d >= SvPVX_const(sv)) {
79072805
LW
7338 if (isDIGIT(*d)) {
7339 if (++*d <= '9')
7340 return;
7341 *(d--) = '0';
7342 }
7343 else {
9d116dd7
JH
7344#ifdef EBCDIC
7345 /* MKS: The original code here died if letters weren't consecutive.
7346 * at least it didn't have to worry about non-C locales. The
7347 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
1c846c1f 7348 * arranged in order (although not consecutively) and that only
9d116dd7
JH
7349 * [A-Za-z] are accepted by isALPHA in the C locale.
7350 */
7351 if (*d != 'z' && *d != 'Z') {
7352 do { ++*d; } while (!isALPHA(*d));
7353 return;
7354 }
7355 *(d--) -= 'z' - 'a';
7356#else
79072805
LW
7357 ++*d;
7358 if (isALPHA(*d))
7359 return;
7360 *(d--) -= 'z' - 'a' + 1;
9d116dd7 7361#endif
79072805
LW
7362 }
7363 }
7364 /* oh,oh, the number grew */
7365 SvGROW(sv, SvCUR(sv) + 2);
b162af07 7366 SvCUR_set(sv, SvCUR(sv) + 1);
3f7c398e 7367 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX_const(sv); d--)
79072805
LW
7368 *d = d[-1];
7369 if (isDIGIT(d[1]))
7370 *d = '1';
7371 else
7372 *d = d[1];
7373}
7374
954c1994
GS
7375/*
7376=for apidoc sv_dec
7377
645c22ef
DM
7378Auto-decrement of the value in the SV, doing string to numeric conversion
7379if necessary. Handles 'get' magic.
954c1994
GS
7380
7381=cut
7382*/
7383
79072805 7384void
864dbfa3 7385Perl_sv_dec(pTHX_ register SV *sv)
79072805 7386{
463ee0b2
LW
7387 int flags;
7388
79072805
LW
7389 if (!sv)
7390 return;
b23a5f78
GB
7391 if (SvGMAGICAL(sv))
7392 mg_get(sv);
ed6116ce 7393 if (SvTHINKFIRST(sv)) {
765f542d
NC
7394 if (SvIsCOW(sv))
7395 sv_force_normal_flags(sv, 0);
0f15f207 7396 if (SvREADONLY(sv)) {
923e4eb5 7397 if (IN_PERL_RUNTIME)
cea2e8a9 7398 Perl_croak(aTHX_ PL_no_modify);
0f15f207 7399 }
a0d0e21e 7400 if (SvROK(sv)) {
b5be31e9 7401 IV i;
9e7bc3e8
JD
7402 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7403 return;
56431972 7404 i = PTR2IV(SvRV(sv));
b5be31e9
SM
7405 sv_unref(sv);
7406 sv_setiv(sv, i);
a0d0e21e 7407 }
ed6116ce 7408 }
28e5dec8
JH
7409 /* Unlike sv_inc we don't have to worry about string-never-numbers
7410 and keeping them magic. But we mustn't warn on punting */
8990e307 7411 flags = SvFLAGS(sv);
28e5dec8
JH
7412 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7413 /* It's publicly an integer, or privately an integer-not-float */
59d8ce62 7414#ifdef PERL_PRESERVE_IVUV
28e5dec8 7415 oops_its_int:
59d8ce62 7416#endif
25da4f38
IZ
7417 if (SvIsUV(sv)) {
7418 if (SvUVX(sv) == 0) {
7419 (void)SvIOK_only(sv);
45977657 7420 SvIV_set(sv, -1);
25da4f38
IZ
7421 }
7422 else {
7423 (void)SvIOK_only_UV(sv);
607fa7f2 7424 SvUV_set(sv, SvUVX(sv) + 1);
1c846c1f 7425 }
25da4f38
IZ
7426 } else {
7427 if (SvIVX(sv) == IV_MIN)
65202027 7428 sv_setnv(sv, (NV)IV_MIN - 1.0);
25da4f38
IZ
7429 else {
7430 (void)SvIOK_only(sv);
45977657 7431 SvIV_set(sv, SvIVX(sv) - 1);
1c846c1f 7432 }
55497cff 7433 }
7434 return;
7435 }
28e5dec8 7436 if (flags & SVp_NOK) {
9d6ce603 7437 SvNV_set(sv, SvNVX(sv) - 1.0);
28e5dec8
JH
7438 (void)SvNOK_only(sv);
7439 return;
7440 }
8990e307 7441 if (!(flags & SVp_POK)) {
4633a7c4
LW
7442 if ((flags & SVTYPEMASK) < SVt_PVNV)
7443 sv_upgrade(sv, SVt_NV);
f599b64b 7444 SvNV_set(sv, 1.0);
a0d0e21e 7445 (void)SvNOK_only(sv);
79072805
LW
7446 return;
7447 }
28e5dec8
JH
7448#ifdef PERL_PRESERVE_IVUV
7449 {
504618e9 7450 const int numtype = grok_number(SvPVX_const(sv), SvCUR(sv), NULL);
28e5dec8
JH
7451 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7452 /* Need to try really hard to see if it's an integer.
7453 9.22337203685478e+18 is an integer.
7454 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7455 so $a="9.22337203685478e+18"; $a+0; $a--
7456 needs to be the same as $a="9.22337203685478e+18"; $a--
7457 or we go insane. */
d460ef45 7458
28e5dec8
JH
7459 (void) sv_2iv(sv);
7460 if (SvIOK(sv))
7461 goto oops_its_int;
7462
7463 /* sv_2iv *should* have made this an NV */
7464 if (flags & SVp_NOK) {
7465 (void)SvNOK_only(sv);
9d6ce603 7466 SvNV_set(sv, SvNVX(sv) - 1.0);
28e5dec8
JH
7467 return;
7468 }
7469 /* I don't think we can get here. Maybe I should assert this
7470 And if we do get here I suspect that sv_setnv will croak. NWC
7471 Fall through. */
7472#if defined(USE_LONG_DOUBLE)
7473 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",
3f7c398e 7474 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
28e5dec8 7475#else
1779d84d 7476 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
3f7c398e 7477 SvPVX_const(sv), SvIVX(sv), SvNVX(sv)));
28e5dec8
JH
7478#endif
7479 }
7480 }
7481#endif /* PERL_PRESERVE_IVUV */
3f7c398e 7482 sv_setnv(sv,Atof(SvPVX_const(sv)) - 1.0); /* punt */
79072805
LW
7483}
7484
954c1994
GS
7485/*
7486=for apidoc sv_mortalcopy
7487
645c22ef 7488Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
d4236ebc
DM
7489The new SV is marked as mortal. It will be destroyed "soon", either by an
7490explicit call to FREETMPS, or by an implicit call at places such as
7491statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
954c1994
GS
7492
7493=cut
7494*/
7495
79072805
LW
7496/* Make a string that will exist for the duration of the expression
7497 * evaluation. Actually, it may have to last longer than that, but
7498 * hopefully we won't free it until it has been assigned to a
7499 * permanent location. */
7500
7501SV *
864dbfa3 7502Perl_sv_mortalcopy(pTHX_ SV *oldstr)
79072805 7503{
463ee0b2 7504 register SV *sv;
b881518d 7505
4561caa4 7506 new_SV(sv);
79072805 7507 sv_setsv(sv,oldstr);
677b06e3
GS
7508 EXTEND_MORTAL(1);
7509 PL_tmps_stack[++PL_tmps_ix] = sv;
8990e307
LW
7510 SvTEMP_on(sv);
7511 return sv;
7512}
7513
954c1994
GS
7514/*
7515=for apidoc sv_newmortal
7516
645c22ef 7517Creates a new null SV which is mortal. The reference count of the SV is
d4236ebc
DM
7518set to 1. It will be destroyed "soon", either by an explicit call to
7519FREETMPS, or by an implicit call at places such as statement boundaries.
7520See also C<sv_mortalcopy> and C<sv_2mortal>.
954c1994
GS
7521
7522=cut
7523*/
7524
8990e307 7525SV *
864dbfa3 7526Perl_sv_newmortal(pTHX)
8990e307
LW
7527{
7528 register SV *sv;
7529
4561caa4 7530 new_SV(sv);
8990e307 7531 SvFLAGS(sv) = SVs_TEMP;
677b06e3
GS
7532 EXTEND_MORTAL(1);
7533 PL_tmps_stack[++PL_tmps_ix] = sv;
79072805
LW
7534 return sv;
7535}
7536
954c1994
GS
7537/*
7538=for apidoc sv_2mortal
7539
d4236ebc
DM
7540Marks an existing SV as mortal. The SV will be destroyed "soon", either
7541by an explicit call to FREETMPS, or by an implicit call at places such as
37d2ac18
NC
7542statement boundaries. SvTEMP() is turned on which means that the SV's
7543string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7544and C<sv_mortalcopy>.
954c1994
GS
7545
7546=cut
7547*/
7548
79072805 7549SV *
864dbfa3 7550Perl_sv_2mortal(pTHX_ register SV *sv)
79072805 7551{
27da23d5 7552 dVAR;
79072805
LW
7553 if (!sv)
7554 return sv;
d689ffdd 7555 if (SvREADONLY(sv) && SvIMMORTAL(sv))
11162842 7556 return sv;
677b06e3
GS
7557 EXTEND_MORTAL(1);
7558 PL_tmps_stack[++PL_tmps_ix] = sv;
8990e307 7559 SvTEMP_on(sv);
79072805
LW
7560 return sv;
7561}
7562
954c1994
GS
7563/*
7564=for apidoc newSVpv
7565
7566Creates a new SV and copies a string into it. The reference count for the
7567SV is set to 1. If C<len> is zero, Perl will compute the length using
7568strlen(). For efficiency, consider using C<newSVpvn> instead.
7569
7570=cut
7571*/
7572
79072805 7573SV *
864dbfa3 7574Perl_newSVpv(pTHX_ const char *s, STRLEN len)
79072805 7575{
463ee0b2 7576 register SV *sv;
79072805 7577
4561caa4 7578 new_SV(sv);
616d8c9c 7579 sv_setpvn(sv,s,len ? len : strlen(s));
79072805
LW
7580 return sv;
7581}
7582
954c1994
GS
7583/*
7584=for apidoc newSVpvn
7585
7586Creates a new SV and copies a string into it. The reference count for the
1c846c1f 7587SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
954c1994 7588string. You are responsible for ensuring that the source string is at least
9e09f5f2 7589C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
954c1994
GS
7590
7591=cut
7592*/
7593
9da1e3b5 7594SV *
864dbfa3 7595Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
9da1e3b5
MUN
7596{
7597 register SV *sv;
7598
7599 new_SV(sv);
9da1e3b5
MUN
7600 sv_setpvn(sv,s,len);
7601 return sv;
7602}
7603
bd08039b
NC
7604
7605/*
7606=for apidoc newSVpv_hek
7607
7608Creates a new SV from the hash key structure. It will generate scalars that
5aaec2b4
NC
7609point to the shared string table where possible. Returns a new (undefined)
7610SV if the hek is NULL.
bd08039b
NC
7611
7612=cut
7613*/
7614
7615SV *
c1b02ed8 7616Perl_newSVhek(pTHX_ const HEK *hek)
bd08039b 7617{
5aaec2b4
NC
7618 if (!hek) {
7619 SV *sv;
7620
7621 new_SV(sv);
7622 return sv;
7623 }
7624
bd08039b
NC
7625 if (HEK_LEN(hek) == HEf_SVKEY) {
7626 return newSVsv(*(SV**)HEK_KEY(hek));
7627 } else {
7628 const int flags = HEK_FLAGS(hek);
7629 if (flags & HVhek_WASUTF8) {
7630 /* Trouble :-)
7631 Andreas would like keys he put in as utf8 to come back as utf8
7632 */
7633 STRLEN utf8_len = HEK_LEN(hek);
7634 U8 *as_utf8 = bytes_to_utf8 ((U8*)HEK_KEY(hek), &utf8_len);
7635 SV *sv = newSVpvn ((char*)as_utf8, utf8_len);
7636
7637 SvUTF8_on (sv);
7638 Safefree (as_utf8); /* bytes_to_utf8() allocates a new string */
7639 return sv;
7640 } else if (flags & HVhek_REHASH) {
7641 /* We don't have a pointer to the hv, so we have to replicate the
7642 flag into every HEK. This hv is using custom a hasing
7643 algorithm. Hence we can't return a shared string scalar, as
7644 that would contain the (wrong) hash value, and might get passed
7645 into an hv routine with a regular hash */
7646
7647 SV *sv = newSVpvn (HEK_KEY(hek), HEK_LEN(hek));
7648 if (HEK_UTF8(hek))
7649 SvUTF8_on (sv);
7650 return sv;
7651 }
7652 /* This will be overwhelminly the most common case. */
7653 return newSVpvn_share(HEK_KEY(hek),
7654 (HEK_UTF8(hek) ? -HEK_LEN(hek) : HEK_LEN(hek)),
7655 HEK_HASH(hek));
7656 }
7657}
7658
1c846c1f
NIS
7659/*
7660=for apidoc newSVpvn_share
7661
3f7c398e 7662Creates a new SV with its SvPVX_const pointing to a shared string in the string
645c22ef
DM
7663table. If the string does not already exist in the table, it is created
7664first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7665slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7666otherwise the hash is computed. The idea here is that as the string table
3f7c398e 7667is used for shared hash keys these strings will have SvPVX_const == HeKEY and
645c22ef 7668hash lookup will avoid string compare.
1c846c1f
NIS
7669
7670=cut
7671*/
7672
7673SV *
c3654f1a 7674Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
1c846c1f
NIS
7675{
7676 register SV *sv;
c3654f1a
IH
7677 bool is_utf8 = FALSE;
7678 if (len < 0) {
77caf834 7679 STRLEN tmplen = -len;
c3654f1a 7680 is_utf8 = TRUE;
75a54232 7681 /* See the note in hv.c:hv_fetch() --jhi */
e1ec3a88 7682 src = (char*)bytes_from_utf8((const U8*)src, &tmplen, &is_utf8);
75a54232
JH
7683 len = tmplen;
7684 }
1c846c1f 7685 if (!hash)
5afd6d42 7686 PERL_HASH(hash, src, len);
1c846c1f
NIS
7687 new_SV(sv);
7688 sv_upgrade(sv, SVt_PVIV);
f880fe2f 7689 SvPV_set(sv, sharepvn(src, is_utf8?-len:len, hash));
b162af07 7690 SvCUR_set(sv, len);
607fa7f2 7691 SvUV_set(sv, hash);
b162af07 7692 SvLEN_set(sv, 0);
1c846c1f
NIS
7693 SvREADONLY_on(sv);
7694 SvFAKE_on(sv);
7695 SvPOK_on(sv);
c3654f1a
IH
7696 if (is_utf8)
7697 SvUTF8_on(sv);
1c846c1f
NIS
7698 return sv;
7699}
7700
645c22ef 7701
cea2e8a9 7702#if defined(PERL_IMPLICIT_CONTEXT)
645c22ef
DM
7703
7704/* pTHX_ magic can't cope with varargs, so this is a no-context
7705 * version of the main function, (which may itself be aliased to us).
7706 * Don't access this version directly.
7707 */
7708
46fc3d4c 7709SV *
cea2e8a9 7710Perl_newSVpvf_nocontext(const char* pat, ...)
46fc3d4c 7711{
cea2e8a9 7712 dTHX;
46fc3d4c 7713 register SV *sv;
7714 va_list args;
46fc3d4c 7715 va_start(args, pat);
c5be433b 7716 sv = vnewSVpvf(pat, &args);
46fc3d4c 7717 va_end(args);
7718 return sv;
7719}
cea2e8a9 7720#endif
46fc3d4c 7721
954c1994
GS
7722/*
7723=for apidoc newSVpvf
7724
645c22ef 7725Creates a new SV and initializes it with the string formatted like
954c1994
GS
7726C<sprintf>.
7727
7728=cut
7729*/
7730
cea2e8a9
GS
7731SV *
7732Perl_newSVpvf(pTHX_ const char* pat, ...)
7733{
7734 register SV *sv;
7735 va_list args;
cea2e8a9 7736 va_start(args, pat);
c5be433b 7737 sv = vnewSVpvf(pat, &args);
cea2e8a9
GS
7738 va_end(args);
7739 return sv;
7740}
46fc3d4c 7741
645c22ef
DM
7742/* backend for newSVpvf() and newSVpvf_nocontext() */
7743
79072805 7744SV *
c5be433b
GS
7745Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7746{
7747 register SV *sv;
7748 new_SV(sv);
7749 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7750 return sv;
7751}
7752
954c1994
GS
7753/*
7754=for apidoc newSVnv
7755
7756Creates a new SV and copies a floating point value into it.
7757The reference count for the SV is set to 1.
7758
7759=cut
7760*/
7761
c5be433b 7762SV *
65202027 7763Perl_newSVnv(pTHX_ NV n)
79072805 7764{
463ee0b2 7765 register SV *sv;
79072805 7766
4561caa4 7767 new_SV(sv);
79072805
LW
7768 sv_setnv(sv,n);
7769 return sv;
7770}
7771
954c1994
GS
7772/*
7773=for apidoc newSViv
7774
7775Creates a new SV and copies an integer into it. The reference count for the
7776SV is set to 1.
7777
7778=cut
7779*/
7780
79072805 7781SV *
864dbfa3 7782Perl_newSViv(pTHX_ IV i)
79072805 7783{
463ee0b2 7784 register SV *sv;
79072805 7785
4561caa4 7786 new_SV(sv);
79072805
LW
7787 sv_setiv(sv,i);
7788 return sv;
7789}
7790
954c1994 7791/*
1a3327fb
JH
7792=for apidoc newSVuv
7793
7794Creates a new SV and copies an unsigned integer into it.
7795The reference count for the SV is set to 1.
7796
7797=cut
7798*/
7799
7800SV *
7801Perl_newSVuv(pTHX_ UV u)
7802{
7803 register SV *sv;
7804
7805 new_SV(sv);
7806 sv_setuv(sv,u);
7807 return sv;
7808}
7809
7810/*
954c1994
GS
7811=for apidoc newRV_noinc
7812
7813Creates an RV wrapper for an SV. The reference count for the original
7814SV is B<not> incremented.
7815
7816=cut
7817*/
7818
2304df62 7819SV *
864dbfa3 7820Perl_newRV_noinc(pTHX_ SV *tmpRef)
2304df62
AD
7821{
7822 register SV *sv;
7823
4561caa4 7824 new_SV(sv);
2304df62 7825 sv_upgrade(sv, SVt_RV);
76e3520e 7826 SvTEMP_off(tmpRef);
b162af07 7827 SvRV_set(sv, tmpRef);
2304df62 7828 SvROK_on(sv);
2304df62
AD
7829 return sv;
7830}
7831
ff276b08 7832/* newRV_inc is the official function name to use now.
645c22ef
DM
7833 * newRV_inc is in fact #defined to newRV in sv.h
7834 */
7835
5f05dabc 7836SV *
864dbfa3 7837Perl_newRV(pTHX_ SV *tmpRef)
5f05dabc 7838{
5f6447b6 7839 return newRV_noinc(SvREFCNT_inc(tmpRef));
5f05dabc 7840}
5f05dabc 7841
954c1994
GS
7842/*
7843=for apidoc newSVsv
7844
7845Creates a new SV which is an exact duplicate of the original SV.
645c22ef 7846(Uses C<sv_setsv>).
954c1994
GS
7847
7848=cut
7849*/
7850
79072805 7851SV *
864dbfa3 7852Perl_newSVsv(pTHX_ register SV *old)
79072805 7853{
463ee0b2 7854 register SV *sv;
79072805
LW
7855
7856 if (!old)
7857 return Nullsv;
8990e307 7858 if (SvTYPE(old) == SVTYPEMASK) {
0453d815 7859 if (ckWARN_d(WARN_INTERNAL))
9014280d 7860 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
79072805
LW
7861 return Nullsv;
7862 }
4561caa4 7863 new_SV(sv);
e90aabeb
NC
7864 /* SV_GMAGIC is the default for sv_setv()
7865 SV_NOSTEAL prevents TEMP buffers being, well, stolen, and saves games
7866 with SvTEMP_off and SvTEMP_on round a call to sv_setsv. */
7867 sv_setsv_flags(sv, old, SV_GMAGIC | SV_NOSTEAL);
463ee0b2 7868 return sv;
79072805
LW
7869}
7870
645c22ef
DM
7871/*
7872=for apidoc sv_reset
7873
7874Underlying implementation for the C<reset> Perl function.
7875Note that the perl-level function is vaguely deprecated.
7876
7877=cut
7878*/
7879
79072805 7880void
e1ec3a88 7881Perl_sv_reset(pTHX_ register const char *s, HV *stash)
79072805 7882{
27da23d5 7883 dVAR;
4802d5d7 7884 char todo[PERL_UCHAR_MAX+1];
79072805 7885
49d8d3a1
MB
7886 if (!stash)
7887 return;
7888
79072805 7889 if (!*s) { /* reset ?? searches */
8d2f4536
NC
7890 MAGIC *mg = mg_find((SV *)stash, PERL_MAGIC_symtab);
7891 if (mg) {
7892 PMOP *pm = (PMOP *) mg->mg_obj;
7893 while (pm) {
7894 pm->op_pmdynflags &= ~PMdf_USED;
7895 pm = pm->op_pmnext;
7896 }
79072805
LW
7897 }
7898 return;
7899 }
7900
7901 /* reset variables */
7902
7903 if (!HvARRAY(stash))
7904 return;
463ee0b2
LW
7905
7906 Zero(todo, 256, char);
79072805 7907 while (*s) {
b464bac0
AL
7908 I32 max;
7909 I32 i = (unsigned char)*s;
79072805
LW
7910 if (s[1] == '-') {
7911 s += 2;
7912 }
4802d5d7 7913 max = (unsigned char)*s++;
79072805 7914 for ( ; i <= max; i++) {
463ee0b2
LW
7915 todo[i] = 1;
7916 }
a0d0e21e 7917 for (i = 0; i <= (I32) HvMAX(stash); i++) {
b464bac0 7918 HE *entry;
79072805 7919 for (entry = HvARRAY(stash)[i];
9e35f4b3
GS
7920 entry;
7921 entry = HeNEXT(entry))
7922 {
b464bac0
AL
7923 register GV *gv;
7924 register SV *sv;
7925
1edc1566 7926 if (!todo[(U8)*HeKEY(entry)])
463ee0b2 7927 continue;
1edc1566 7928 gv = (GV*)HeVAL(entry);
79072805 7929 sv = GvSV(gv);
9e35f4b3
GS
7930 if (SvTHINKFIRST(sv)) {
7931 if (!SvREADONLY(sv) && SvROK(sv))
7932 sv_unref(sv);
7933 continue;
7934 }
0c34ef67 7935 SvOK_off(sv);
79072805
LW
7936 if (SvTYPE(sv) >= SVt_PV) {
7937 SvCUR_set(sv, 0);
3f7c398e 7938 if (SvPVX_const(sv) != Nullch)
463ee0b2 7939 *SvPVX(sv) = '\0';
44a8e56a 7940 SvTAINT(sv);
79072805
LW
7941 }
7942 if (GvAV(gv)) {
7943 av_clear(GvAV(gv));
7944 }
bfcb3514 7945 if (GvHV(gv) && !HvNAME_get(GvHV(gv))) {
463ee0b2 7946 hv_clear(GvHV(gv));
2f42fcb0 7947#ifndef PERL_MICRO
fa6a1c44 7948#ifdef USE_ENVIRON_ARRAY
4efc5df6
GS
7949 if (gv == PL_envgv
7950# ifdef USE_ITHREADS
7951 && PL_curinterp == aTHX
7952# endif
7953 )
7954 {
79072805 7955 environ[0] = Nullch;
4efc5df6 7956 }
a0d0e21e 7957#endif
2f42fcb0 7958#endif /* !PERL_MICRO */
79072805
LW
7959 }
7960 }
7961 }
7962 }
7963}
7964
645c22ef
DM
7965/*
7966=for apidoc sv_2io
7967
7968Using various gambits, try to get an IO from an SV: the IO slot if its a
7969GV; or the recursive result if we're an RV; or the IO slot of the symbol
7970named after the PV if we're a string.
7971
7972=cut
7973*/
7974
46fc3d4c 7975IO*
864dbfa3 7976Perl_sv_2io(pTHX_ SV *sv)
46fc3d4c 7977{
7978 IO* io;
7979 GV* gv;
7980
7981 switch (SvTYPE(sv)) {
7982 case SVt_PVIO:
7983 io = (IO*)sv;
7984 break;
7985 case SVt_PVGV:
7986 gv = (GV*)sv;
7987 io = GvIO(gv);
7988 if (!io)
cea2e8a9 7989 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
46fc3d4c 7990 break;
7991 default:
7992 if (!SvOK(sv))
cea2e8a9 7993 Perl_croak(aTHX_ PL_no_usym, "filehandle");
46fc3d4c 7994 if (SvROK(sv))
7995 return sv_2io(SvRV(sv));
7a5fd60d 7996 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
46fc3d4c 7997 if (gv)
7998 io = GvIO(gv);
7999 else
8000 io = 0;
8001 if (!io)
35c1215d 8002 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
46fc3d4c 8003 break;
8004 }
8005 return io;
8006}
8007
645c22ef
DM
8008/*
8009=for apidoc sv_2cv
8010
8011Using various gambits, try to get a CV from an SV; in addition, try if
8012possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8013
8014=cut
8015*/
8016
79072805 8017CV *
864dbfa3 8018Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
79072805 8019{
27da23d5 8020 dVAR;
c04a4dfe
JH
8021 GV *gv = Nullgv;
8022 CV *cv = Nullcv;
79072805
LW
8023
8024 if (!sv)
93a17b20 8025 return *gvp = Nullgv, Nullcv;
79072805 8026 switch (SvTYPE(sv)) {
79072805
LW
8027 case SVt_PVCV:
8028 *st = CvSTASH(sv);
8029 *gvp = Nullgv;
8030 return (CV*)sv;
8031 case SVt_PVHV:
8032 case SVt_PVAV:
8033 *gvp = Nullgv;
8034 return Nullcv;
8990e307
LW
8035 case SVt_PVGV:
8036 gv = (GV*)sv;
a0d0e21e 8037 *gvp = gv;
8990e307
LW
8038 *st = GvESTASH(gv);
8039 goto fix_gv;
8040
79072805 8041 default:
a0d0e21e
LW
8042 if (SvGMAGICAL(sv))
8043 mg_get(sv);
8044 if (SvROK(sv)) {
f5284f61
IZ
8045 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
8046 tryAMAGICunDEREF(to_cv);
8047
62f274bf
GS
8048 sv = SvRV(sv);
8049 if (SvTYPE(sv) == SVt_PVCV) {
8050 cv = (CV*)sv;
8051 *gvp = Nullgv;
8052 *st = CvSTASH(cv);
8053 return cv;
8054 }
8055 else if(isGV(sv))
8056 gv = (GV*)sv;
8057 else
cea2e8a9 8058 Perl_croak(aTHX_ "Not a subroutine reference");
a0d0e21e 8059 }
62f274bf 8060 else if (isGV(sv))
79072805
LW
8061 gv = (GV*)sv;
8062 else
7a5fd60d 8063 gv = gv_fetchsv(sv, lref, SVt_PVCV);
79072805
LW
8064 *gvp = gv;
8065 if (!gv)
8066 return Nullcv;
8067 *st = GvESTASH(gv);
8990e307 8068 fix_gv:
8ebc5c01 8069 if (lref && !GvCVu(gv)) {
4633a7c4 8070 SV *tmpsv;
748a9306 8071 ENTER;
4633a7c4 8072 tmpsv = NEWSV(704,0);
16660edb 8073 gv_efullname3(tmpsv, gv, Nullch);
f6ec51f7
GS
8074 /* XXX this is probably not what they think they're getting.
8075 * It has the same effect as "sub name;", i.e. just a forward
8076 * declaration! */
774d564b 8077 newSUB(start_subparse(FALSE, 0),
4633a7c4
LW
8078 newSVOP(OP_CONST, 0, tmpsv),
8079 Nullop,
8990e307 8080 Nullop);
748a9306 8081 LEAVE;
8ebc5c01 8082 if (!GvCVu(gv))
35c1215d
NC
8083 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8084 sv);
8990e307 8085 }
8ebc5c01 8086 return GvCVu(gv);
79072805
LW
8087 }
8088}
8089
c461cf8f
JH
8090/*
8091=for apidoc sv_true
8092
8093Returns true if the SV has a true value by Perl's rules.
645c22ef
DM
8094Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8095instead use an in-line version.
c461cf8f
JH
8096
8097=cut
8098*/
8099
79072805 8100I32
864dbfa3 8101Perl_sv_true(pTHX_ register SV *sv)
79072805 8102{
8990e307
LW
8103 if (!sv)
8104 return 0;
79072805 8105 if (SvPOK(sv)) {
e1ec3a88 8106 const register XPV* tXpv;
4e35701f 8107 if ((tXpv = (XPV*)SvANY(sv)) &&
c2f1de04 8108 (tXpv->xpv_cur > 1 ||
339049b0 8109 (tXpv->xpv_cur && *sv->sv_u.svu_pv != '0')))
79072805
LW
8110 return 1;
8111 else
8112 return 0;
8113 }
8114 else {
8115 if (SvIOK(sv))
463ee0b2 8116 return SvIVX(sv) != 0;
79072805
LW
8117 else {
8118 if (SvNOK(sv))
463ee0b2 8119 return SvNVX(sv) != 0.0;
79072805 8120 else
463ee0b2 8121 return sv_2bool(sv);
79072805
LW
8122 }
8123 }
8124}
79072805 8125
645c22ef
DM
8126/*
8127=for apidoc sv_iv
8128
8129A private implementation of the C<SvIVx> macro for compilers which can't
8130cope with complex macro expressions. Always use the macro instead.
8131
8132=cut
8133*/
8134
ff68c719 8135IV
864dbfa3 8136Perl_sv_iv(pTHX_ register SV *sv)
85e6fe83 8137{
25da4f38
IZ
8138 if (SvIOK(sv)) {
8139 if (SvIsUV(sv))
8140 return (IV)SvUVX(sv);
ff68c719 8141 return SvIVX(sv);
25da4f38 8142 }
ff68c719 8143 return sv_2iv(sv);
85e6fe83 8144}
85e6fe83 8145
645c22ef
DM
8146/*
8147=for apidoc sv_uv
8148
8149A private implementation of the C<SvUVx> macro for compilers which can't
8150cope with complex macro expressions. Always use the macro instead.
8151
8152=cut
8153*/
8154
ff68c719 8155UV
864dbfa3 8156Perl_sv_uv(pTHX_ register SV *sv)
ff68c719 8157{
25da4f38
IZ
8158 if (SvIOK(sv)) {
8159 if (SvIsUV(sv))
8160 return SvUVX(sv);
8161 return (UV)SvIVX(sv);
8162 }
ff68c719 8163 return sv_2uv(sv);
8164}
85e6fe83 8165
645c22ef
DM
8166/*
8167=for apidoc sv_nv
8168
8169A private implementation of the C<SvNVx> macro for compilers which can't
8170cope with complex macro expressions. Always use the macro instead.
8171
8172=cut
8173*/
8174
65202027 8175NV
864dbfa3 8176Perl_sv_nv(pTHX_ register SV *sv)
79072805 8177{
ff68c719 8178 if (SvNOK(sv))
8179 return SvNVX(sv);
8180 return sv_2nv(sv);
79072805 8181}
79072805 8182
09540bc3
JH
8183/* sv_pv() is now a macro using SvPV_nolen();
8184 * this function provided for binary compatibility only
8185 */
8186
8187char *
8188Perl_sv_pv(pTHX_ SV *sv)
8189{
8190 STRLEN n_a;
8191
8192 if (SvPOK(sv))
8193 return SvPVX(sv);
8194
8195 return sv_2pv(sv, &n_a);
8196}
8197
645c22ef
DM
8198/*
8199=for apidoc sv_pv
8200
baca2b92 8201Use the C<SvPV_nolen> macro instead
645c22ef 8202
645c22ef
DM
8203=for apidoc sv_pvn
8204
8205A private implementation of the C<SvPV> macro for compilers which can't
8206cope with complex macro expressions. Always use the macro instead.
8207
8208=cut
8209*/
8210
1fa8b10d 8211char *
864dbfa3 8212Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
79072805 8213{
85e6fe83
LW
8214 if (SvPOK(sv)) {
8215 *lp = SvCUR(sv);
a0d0e21e 8216 return SvPVX(sv);
85e6fe83 8217 }
463ee0b2 8218 return sv_2pv(sv, lp);
79072805 8219}
79072805 8220
6e9d1081
NC
8221
8222char *
8223Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
8224{
8225 if (SvPOK(sv)) {
8226 *lp = SvCUR(sv);
8227 return SvPVX(sv);
8228 }
8229 return sv_2pv_flags(sv, lp, 0);
8230}
8231
09540bc3
JH
8232/* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
8233 * this function provided for binary compatibility only
8234 */
8235
8236char *
8237Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
8238{
8239 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
8240}
8241
c461cf8f
JH
8242/*
8243=for apidoc sv_pvn_force
8244
8245Get a sensible string out of the SV somehow.
645c22ef
DM
8246A private implementation of the C<SvPV_force> macro for compilers which
8247can't cope with complex macro expressions. Always use the macro instead.
c461cf8f 8248
8d6d96c1
HS
8249=for apidoc sv_pvn_force_flags
8250
8251Get a sensible string out of the SV somehow.
8252If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8253appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8254implemented in terms of this function.
645c22ef
DM
8255You normally want to use the various wrapper macros instead: see
8256C<SvPV_force> and C<SvPV_force_nomg>
8d6d96c1
HS
8257
8258=cut
8259*/
8260
8261char *
8262Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
8263{
a0d0e21e 8264
6fc92669 8265 if (SvTHINKFIRST(sv) && !SvROK(sv))
765f542d 8266 sv_force_normal_flags(sv, 0);
1c846c1f 8267
a0d0e21e
LW
8268 if (SvPOK(sv)) {
8269 *lp = SvCUR(sv);
8270 }
8271 else {
a3b680e6 8272 char *s;
748a9306 8273 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
cea2e8a9 8274 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
53e06cf0 8275 OP_NAME(PL_op));
a0d0e21e 8276 }
4633a7c4 8277 else
8d6d96c1 8278 s = sv_2pv_flags(sv, lp, flags);
3f7c398e 8279 if (s != SvPVX_const(sv)) { /* Almost, but not quite, sv_setpvn() */
a3b680e6 8280 const STRLEN len = *lp;
1c846c1f 8281
a0d0e21e
LW
8282 if (SvROK(sv))
8283 sv_unref(sv);
8284 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8285 SvGROW(sv, len + 1);
3f7c398e 8286 Move(s,SvPVX_const(sv),len,char);
a0d0e21e
LW
8287 SvCUR_set(sv, len);
8288 *SvEND(sv) = '\0';
8289 }
8290 if (!SvPOK(sv)) {
8291 SvPOK_on(sv); /* validate pointer */
8292 SvTAINT(sv);
1d7c1841 8293 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3f7c398e 8294 PTR2UV(sv),SvPVX_const(sv)));
a0d0e21e
LW
8295 }
8296 }
8297 return SvPVX(sv);
8298}
8299
09540bc3
JH
8300/* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
8301 * this function provided for binary compatibility only
8302 */
8303
8304char *
8305Perl_sv_pvbyte(pTHX_ SV *sv)
8306{
8307 sv_utf8_downgrade(sv,0);
8308 return sv_pv(sv);
8309}
8310
645c22ef
DM
8311/*
8312=for apidoc sv_pvbyte
8313
baca2b92 8314Use C<SvPVbyte_nolen> instead.
645c22ef 8315
645c22ef
DM
8316=for apidoc sv_pvbyten
8317
8318A private implementation of the C<SvPVbyte> macro for compilers
8319which can't cope with complex macro expressions. Always use the macro
8320instead.
8321
8322=cut
8323*/
8324
7340a771
GS
8325char *
8326Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
8327{
ffebcc3e 8328 sv_utf8_downgrade(sv,0);
7340a771
GS
8329 return sv_pvn(sv,lp);
8330}
8331
645c22ef
DM
8332/*
8333=for apidoc sv_pvbyten_force
8334
8335A private implementation of the C<SvPVbytex_force> macro for compilers
8336which can't cope with complex macro expressions. Always use the macro
8337instead.
8338
8339=cut
8340*/
8341
7340a771
GS
8342char *
8343Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8344{
46ec2f14 8345 sv_pvn_force(sv,lp);
ffebcc3e 8346 sv_utf8_downgrade(sv,0);
46ec2f14
TS
8347 *lp = SvCUR(sv);
8348 return SvPVX(sv);
7340a771
GS
8349}
8350
09540bc3
JH
8351/* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8352 * this function provided for binary compatibility only
8353 */
8354
8355char *
8356Perl_sv_pvutf8(pTHX_ SV *sv)
8357{
8358 sv_utf8_upgrade(sv);
8359 return sv_pv(sv);
8360}
8361
645c22ef
DM
8362/*
8363=for apidoc sv_pvutf8
8364
baca2b92 8365Use the C<SvPVutf8_nolen> macro instead
645c22ef 8366
645c22ef
DM
8367=for apidoc sv_pvutf8n
8368
8369A private implementation of the C<SvPVutf8> macro for compilers
8370which can't cope with complex macro expressions. Always use the macro
8371instead.
8372
8373=cut
8374*/
8375
7340a771
GS
8376char *
8377Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8378{
560a288e 8379 sv_utf8_upgrade(sv);
7340a771
GS
8380 return sv_pvn(sv,lp);
8381}
8382
c461cf8f
JH
8383/*
8384=for apidoc sv_pvutf8n_force
8385
645c22ef
DM
8386A private implementation of the C<SvPVutf8_force> macro for compilers
8387which can't cope with complex macro expressions. Always use the macro
8388instead.
c461cf8f
JH
8389
8390=cut
8391*/
8392
7340a771
GS
8393char *
8394Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8395{
46ec2f14 8396 sv_pvn_force(sv,lp);
560a288e 8397 sv_utf8_upgrade(sv);
46ec2f14
TS
8398 *lp = SvCUR(sv);
8399 return SvPVX(sv);
7340a771
GS
8400}
8401
c461cf8f
JH
8402/*
8403=for apidoc sv_reftype
8404
8405Returns a string describing what the SV is a reference to.
8406
8407=cut
8408*/
8409
1cb0ed9b 8410char *
bfed75c6 8411Perl_sv_reftype(pTHX_ const SV *sv, int ob)
a0d0e21e 8412{
07409e01
NC
8413 /* The fact that I don't need to downcast to char * everywhere, only in ?:
8414 inside return suggests a const propagation bug in g++. */
c86bf373 8415 if (ob && SvOBJECT(sv)) {
bfcb3514 8416 char *name = HvNAME_get(SvSTASH(sv));
07409e01 8417 return name ? name : (char *) "__ANON__";
c86bf373 8418 }
a0d0e21e
LW
8419 else {
8420 switch (SvTYPE(sv)) {
8421 case SVt_NULL:
8422 case SVt_IV:
8423 case SVt_NV:
8424 case SVt_RV:
8425 case SVt_PV:
8426 case SVt_PVIV:
8427 case SVt_PVNV:
8428 case SVt_PVMG:
8429 case SVt_PVBM:
1cb0ed9b 8430 if (SvVOK(sv))
439cb1c4 8431 return "VSTRING";
a0d0e21e
LW
8432 if (SvROK(sv))
8433 return "REF";
8434 else
8435 return "SCALAR";
1cb0ed9b 8436
07409e01 8437 case SVt_PVLV: return (char *) (SvROK(sv) ? "REF"
be65207d
DM
8438 /* tied lvalues should appear to be
8439 * scalars for backwards compatitbility */
8440 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
07409e01 8441 ? "SCALAR" : "LVALUE");
a0d0e21e
LW
8442 case SVt_PVAV: return "ARRAY";
8443 case SVt_PVHV: return "HASH";
8444 case SVt_PVCV: return "CODE";
8445 case SVt_PVGV: return "GLOB";
1d2dff63 8446 case SVt_PVFM: return "FORMAT";
27f9d8f3 8447 case SVt_PVIO: return "IO";
a0d0e21e
LW
8448 default: return "UNKNOWN";
8449 }
8450 }
8451}
8452
954c1994
GS
8453/*
8454=for apidoc sv_isobject
8455
8456Returns a boolean indicating whether the SV is an RV pointing to a blessed
8457object. If the SV is not an RV, or if the object is not blessed, then this
8458will return false.
8459
8460=cut
8461*/
8462
463ee0b2 8463int
864dbfa3 8464Perl_sv_isobject(pTHX_ SV *sv)
85e6fe83 8465{
68dc0745 8466 if (!sv)
8467 return 0;
8468 if (SvGMAGICAL(sv))
8469 mg_get(sv);
85e6fe83
LW
8470 if (!SvROK(sv))
8471 return 0;
8472 sv = (SV*)SvRV(sv);
8473 if (!SvOBJECT(sv))
8474 return 0;
8475 return 1;
8476}
8477
954c1994
GS
8478/*
8479=for apidoc sv_isa
8480
8481Returns a boolean indicating whether the SV is blessed into the specified
8482class. This does not check for subtypes; use C<sv_derived_from> to verify
8483an inheritance relationship.
8484
8485=cut
8486*/
8487
85e6fe83 8488int
864dbfa3 8489Perl_sv_isa(pTHX_ SV *sv, const char *name)
463ee0b2 8490{
bfcb3514 8491 const char *hvname;
68dc0745 8492 if (!sv)
8493 return 0;
8494 if (SvGMAGICAL(sv))
8495 mg_get(sv);
ed6116ce 8496 if (!SvROK(sv))
463ee0b2 8497 return 0;
ed6116ce
LW
8498 sv = (SV*)SvRV(sv);
8499 if (!SvOBJECT(sv))
463ee0b2 8500 return 0;
bfcb3514
NC
8501 hvname = HvNAME_get(SvSTASH(sv));
8502 if (!hvname)
e27ad1f2 8503 return 0;
463ee0b2 8504
bfcb3514 8505 return strEQ(hvname, name);
463ee0b2
LW
8506}
8507
954c1994
GS
8508/*
8509=for apidoc newSVrv
8510
8511Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8512it will be upgraded to one. If C<classname> is non-null then the new SV will
8513be blessed in the specified package. The new SV is returned and its
8514reference count is 1.
8515
8516=cut
8517*/
8518
463ee0b2 8519SV*
864dbfa3 8520Perl_newSVrv(pTHX_ SV *rv, const char *classname)
463ee0b2 8521{
463ee0b2
LW
8522 SV *sv;
8523
4561caa4 8524 new_SV(sv);
51cf62d8 8525
765f542d 8526 SV_CHECK_THINKFIRST_COW_DROP(rv);
51cf62d8 8527 SvAMAGIC_off(rv);
51cf62d8 8528
0199fce9 8529 if (SvTYPE(rv) >= SVt_PVMG) {
a3b680e6 8530 const U32 refcnt = SvREFCNT(rv);
0199fce9
JD
8531 SvREFCNT(rv) = 0;
8532 sv_clear(rv);
8533 SvFLAGS(rv) = 0;
8534 SvREFCNT(rv) = refcnt;
8535 }
8536
51cf62d8 8537 if (SvTYPE(rv) < SVt_RV)
0199fce9
JD
8538 sv_upgrade(rv, SVt_RV);
8539 else if (SvTYPE(rv) > SVt_RV) {
8bd4d4c5 8540 SvPV_free(rv);
0199fce9
JD
8541 SvCUR_set(rv, 0);
8542 SvLEN_set(rv, 0);
8543 }
51cf62d8 8544
0c34ef67 8545 SvOK_off(rv);
b162af07 8546 SvRV_set(rv, sv);
ed6116ce 8547 SvROK_on(rv);
463ee0b2 8548
a0d0e21e
LW
8549 if (classname) {
8550 HV* stash = gv_stashpv(classname, TRUE);
8551 (void)sv_bless(rv, stash);
8552 }
8553 return sv;
8554}
8555
954c1994
GS
8556/*
8557=for apidoc sv_setref_pv
8558
8559Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8560argument will be upgraded to an RV. That RV will be modified to point to
8561the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8562into the SV. The C<classname> argument indicates the package for the
8563blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
d34c2299 8564will have a reference count of 1, and the RV will be returned.
954c1994
GS
8565
8566Do not use with other Perl types such as HV, AV, SV, CV, because those
8567objects will become corrupted by the pointer copy process.
8568
8569Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8570
8571=cut
8572*/
8573
a0d0e21e 8574SV*
864dbfa3 8575Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
a0d0e21e 8576{
189b2af5 8577 if (!pv) {
3280af22 8578 sv_setsv(rv, &PL_sv_undef);
189b2af5
GS
8579 SvSETMAGIC(rv);
8580 }
a0d0e21e 8581 else
56431972 8582 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
a0d0e21e
LW
8583 return rv;
8584}
8585
954c1994
GS
8586/*
8587=for apidoc sv_setref_iv
8588
8589Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8590argument will be upgraded to an RV. That RV will be modified to point to
8591the new SV. The C<classname> argument indicates the package for the
8592blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
d34c2299 8593will have a reference count of 1, and the RV will be returned.
954c1994
GS
8594
8595=cut
8596*/
8597
a0d0e21e 8598SV*
864dbfa3 8599Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
a0d0e21e
LW
8600{
8601 sv_setiv(newSVrv(rv,classname), iv);
8602 return rv;
8603}
8604
954c1994 8605/*
e1c57cef
JH
8606=for apidoc sv_setref_uv
8607
8608Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8609argument will be upgraded to an RV. That RV will be modified to point to
8610the new SV. The C<classname> argument indicates the package for the
8611blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
d34c2299 8612will have a reference count of 1, and the RV will be returned.
e1c57cef
JH
8613
8614=cut
8615*/
8616
8617SV*
8618Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8619{
8620 sv_setuv(newSVrv(rv,classname), uv);
8621 return rv;
8622}
8623
8624/*
954c1994
GS
8625=for apidoc sv_setref_nv
8626
8627Copies a double into a new SV, optionally blessing the SV. The C<rv>
8628argument will be upgraded to an RV. That RV will be modified to point to
8629the new SV. The C<classname> argument indicates the package for the
8630blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
d34c2299 8631will have a reference count of 1, and the RV will be returned.
954c1994
GS
8632
8633=cut
8634*/
8635
a0d0e21e 8636SV*
65202027 8637Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
a0d0e21e
LW
8638{
8639 sv_setnv(newSVrv(rv,classname), nv);
8640 return rv;
8641}
463ee0b2 8642
954c1994
GS
8643/*
8644=for apidoc sv_setref_pvn
8645
8646Copies a string into a new SV, optionally blessing the SV. The length of the
8647string must be specified with C<n>. The C<rv> argument will be upgraded to
8648an RV. That RV will be modified to point to the new SV. The C<classname>
8649argument indicates the package for the blessing. Set C<classname> to
7a5fa8a2 8650C<Nullch> to avoid the blessing. The new SV will have a reference count
d34c2299 8651of 1, and the RV will be returned.
954c1994
GS
8652
8653Note that C<sv_setref_pv> copies the pointer while this copies the string.
8654
8655=cut
8656*/
8657
a0d0e21e 8658SV*
864dbfa3 8659Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
a0d0e21e
LW
8660{
8661 sv_setpvn(newSVrv(rv,classname), pv, n);
463ee0b2
LW
8662 return rv;
8663}
8664
954c1994
GS
8665/*
8666=for apidoc sv_bless
8667
8668Blesses an SV into a specified package. The SV must be an RV. The package
8669must be designated by its stash (see C<gv_stashpv()>). The reference count
8670of the SV is unaffected.
8671
8672=cut
8673*/
8674
a0d0e21e 8675SV*
864dbfa3 8676Perl_sv_bless(pTHX_ SV *sv, HV *stash)
a0d0e21e 8677{
76e3520e 8678 SV *tmpRef;
a0d0e21e 8679 if (!SvROK(sv))
cea2e8a9 8680 Perl_croak(aTHX_ "Can't bless non-reference value");
76e3520e
GS
8681 tmpRef = SvRV(sv);
8682 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8683 if (SvREADONLY(tmpRef))
cea2e8a9 8684 Perl_croak(aTHX_ PL_no_modify);
76e3520e
GS
8685 if (SvOBJECT(tmpRef)) {
8686 if (SvTYPE(tmpRef) != SVt_PVIO)
3280af22 8687 --PL_sv_objcount;
76e3520e 8688 SvREFCNT_dec(SvSTASH(tmpRef));
2e3febc6 8689 }
a0d0e21e 8690 }
76e3520e
GS
8691 SvOBJECT_on(tmpRef);
8692 if (SvTYPE(tmpRef) != SVt_PVIO)
3280af22 8693 ++PL_sv_objcount;
76e3520e 8694 (void)SvUPGRADE(tmpRef, SVt_PVMG);
b162af07 8695 SvSTASH_set(tmpRef, (HV*)SvREFCNT_inc(stash));
a0d0e21e 8696
2e3febc6
CS
8697 if (Gv_AMG(stash))
8698 SvAMAGIC_on(sv);
8699 else
8700 SvAMAGIC_off(sv);
a0d0e21e 8701
1edbfb88
AB
8702 if(SvSMAGICAL(tmpRef))
8703 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8704 mg_set(tmpRef);
8705
8706
ecdeb87c 8707
a0d0e21e
LW
8708 return sv;
8709}
8710
645c22ef 8711/* Downgrades a PVGV to a PVMG.
645c22ef
DM
8712 */
8713
76e3520e 8714STATIC void
cea2e8a9 8715S_sv_unglob(pTHX_ SV *sv)
a0d0e21e 8716{
850fabdf
GS
8717 void *xpvmg;
8718
a0d0e21e
LW
8719 assert(SvTYPE(sv) == SVt_PVGV);
8720 SvFAKE_off(sv);
8721 if (GvGP(sv))
1edc1566 8722 gp_free((GV*)sv);
e826b3c7
GS
8723 if (GvSTASH(sv)) {
8724 SvREFCNT_dec(GvSTASH(sv));
8725 GvSTASH(sv) = Nullhv;
8726 }
14befaf4 8727 sv_unmagic(sv, PERL_MAGIC_glob);
a0d0e21e 8728 Safefree(GvNAME(sv));
a5f75d66 8729 GvMULTI_off(sv);
850fabdf
GS
8730
8731 /* need to keep SvANY(sv) in the right arena */
8732 xpvmg = new_XPVMG();
8733 StructCopy(SvANY(sv), xpvmg, XPVMG);
8734 del_XPVGV(SvANY(sv));
8735 SvANY(sv) = xpvmg;
8736
a0d0e21e
LW
8737 SvFLAGS(sv) &= ~SVTYPEMASK;
8738 SvFLAGS(sv) |= SVt_PVMG;
8739}
8740
954c1994 8741/*
840a7b70 8742=for apidoc sv_unref_flags
954c1994
GS
8743
8744Unsets the RV status of the SV, and decrements the reference count of
8745whatever was being referenced by the RV. This can almost be thought of
840a7b70
IZ
8746as a reversal of C<newSVrv>. The C<cflags> argument can contain
8747C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8748(otherwise the decrementing is conditional on the reference count being
8749different from one or the reference being a readonly SV).
7889fe52 8750See C<SvROK_off>.
954c1994
GS
8751
8752=cut
8753*/
8754
ed6116ce 8755void
840a7b70 8756Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
ed6116ce 8757{
a0d0e21e 8758 SV* rv = SvRV(sv);
810b8aa5
GS
8759
8760 if (SvWEAKREF(sv)) {
8761 sv_del_backref(sv);
8762 SvWEAKREF_off(sv);
b162af07 8763 SvRV_set(sv, NULL);
810b8aa5
GS
8764 return;
8765 }
b162af07 8766 SvRV_set(sv, NULL);
ed6116ce 8767 SvROK_off(sv);
04ca4930
NC
8768 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8769 assigned to as BEGIN {$a = \"Foo"} will fail. */
8770 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
4633a7c4 8771 SvREFCNT_dec(rv);
840a7b70 8772 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
4633a7c4 8773 sv_2mortal(rv); /* Schedule for freeing later */
ed6116ce 8774}
8990e307 8775
840a7b70
IZ
8776/*
8777=for apidoc sv_unref
8778
8779Unsets the RV status of the SV, and decrements the reference count of
8780whatever was being referenced by the RV. This can almost be thought of
8781as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
7889fe52 8782being zero. See C<SvROK_off>.
840a7b70
IZ
8783
8784=cut
8785*/
8786
8787void
8788Perl_sv_unref(pTHX_ SV *sv)
8789{
8790 sv_unref_flags(sv, 0);
8791}
8792
645c22ef
DM
8793/*
8794=for apidoc sv_taint
8795
8796Taint an SV. Use C<SvTAINTED_on> instead.
8797=cut
8798*/
8799
bbce6d69 8800void
864dbfa3 8801Perl_sv_taint(pTHX_ SV *sv)
bbce6d69 8802{
14befaf4 8803 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
bbce6d69 8804}
8805
645c22ef
DM
8806/*
8807=for apidoc sv_untaint
8808
8809Untaint an SV. Use C<SvTAINTED_off> instead.
8810=cut
8811*/
8812
bbce6d69 8813void
864dbfa3 8814Perl_sv_untaint(pTHX_ SV *sv)
bbce6d69 8815{
13f57bf8 8816 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
14befaf4 8817 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
36477c24 8818 if (mg)
565764a8 8819 mg->mg_len &= ~1;
36477c24 8820 }
bbce6d69 8821}
8822
645c22ef
DM
8823/*
8824=for apidoc sv_tainted
8825
8826Test an SV for taintedness. Use C<SvTAINTED> instead.
8827=cut
8828*/
8829
bbce6d69 8830bool
864dbfa3 8831Perl_sv_tainted(pTHX_ SV *sv)
bbce6d69 8832{
13f57bf8 8833 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
14befaf4 8834 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
155aba94 8835 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
36477c24 8836 return TRUE;
8837 }
8838 return FALSE;
bbce6d69 8839}
8840
09540bc3
JH
8841/*
8842=for apidoc sv_setpviv
8843
8844Copies an integer into the given SV, also updating its string value.
8845Does not handle 'set' magic. See C<sv_setpviv_mg>.
8846
8847=cut
8848*/
8849
8850void
8851Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8852{
8853 char buf[TYPE_CHARS(UV)];
8854 char *ebuf;
8855 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8856
8857 sv_setpvn(sv, ptr, ebuf - ptr);
8858}
8859
8860/*
8861=for apidoc sv_setpviv_mg
8862
8863Like C<sv_setpviv>, but also handles 'set' magic.
8864
8865=cut
8866*/
8867
8868void
8869Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8870{
8871 char buf[TYPE_CHARS(UV)];
8872 char *ebuf;
8873 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8874
8875 sv_setpvn(sv, ptr, ebuf - ptr);
8876 SvSETMAGIC(sv);
8877}
8878
cea2e8a9 8879#if defined(PERL_IMPLICIT_CONTEXT)
645c22ef
DM
8880
8881/* pTHX_ magic can't cope with varargs, so this is a no-context
8882 * version of the main function, (which may itself be aliased to us).
8883 * Don't access this version directly.
8884 */
8885
cea2e8a9
GS
8886void
8887Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8888{
8889 dTHX;
8890 va_list args;
8891 va_start(args, pat);
c5be433b 8892 sv_vsetpvf(sv, pat, &args);
cea2e8a9
GS
8893 va_end(args);
8894}
8895
645c22ef
DM
8896/* pTHX_ magic can't cope with varargs, so this is a no-context
8897 * version of the main function, (which may itself be aliased to us).
8898 * Don't access this version directly.
8899 */
cea2e8a9
GS
8900
8901void
8902Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8903{
8904 dTHX;
8905 va_list args;
8906 va_start(args, pat);
c5be433b 8907 sv_vsetpvf_mg(sv, pat, &args);
cea2e8a9 8908 va_end(args);
cea2e8a9
GS
8909}
8910#endif
8911
954c1994
GS
8912/*
8913=for apidoc sv_setpvf
8914
bffc3d17
SH
8915Works like C<sv_catpvf> but copies the text into the SV instead of
8916appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
954c1994
GS
8917
8918=cut
8919*/
8920
46fc3d4c 8921void
864dbfa3 8922Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
46fc3d4c 8923{
8924 va_list args;
46fc3d4c 8925 va_start(args, pat);
c5be433b 8926 sv_vsetpvf(sv, pat, &args);
46fc3d4c 8927 va_end(args);
8928}
8929
bffc3d17
SH
8930/*
8931=for apidoc sv_vsetpvf
8932
8933Works like C<sv_vcatpvf> but copies the text into the SV instead of
8934appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8935
8936Usually used via its frontend C<sv_setpvf>.
8937
8938=cut
8939*/
645c22ef 8940
c5be433b
GS
8941void
8942Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8943{
8944 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8945}
ef50df4b 8946
954c1994
GS
8947/*
8948=for apidoc sv_setpvf_mg
8949
8950Like C<sv_setpvf>, but also handles 'set' magic.
8951
8952=cut
8953*/
8954
ef50df4b 8955void
864dbfa3 8956Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
ef50df4b
GS
8957{
8958 va_list args;
ef50df4b 8959 va_start(args, pat);
c5be433b 8960 sv_vsetpvf_mg(sv, pat, &args);
ef50df4b 8961 va_end(args);
c5be433b
GS
8962}
8963
bffc3d17
SH
8964/*
8965=for apidoc sv_vsetpvf_mg
8966
8967Like C<sv_vsetpvf>, but also handles 'set' magic.
8968
8969Usually used via its frontend C<sv_setpvf_mg>.
8970
8971=cut
8972*/
645c22ef 8973
c5be433b
GS
8974void
8975Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8976{
8977 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
ef50df4b
GS
8978 SvSETMAGIC(sv);
8979}
8980
cea2e8a9 8981#if defined(PERL_IMPLICIT_CONTEXT)
645c22ef
DM
8982
8983/* pTHX_ magic can't cope with varargs, so this is a no-context
8984 * version of the main function, (which may itself be aliased to us).
8985 * Don't access this version directly.
8986 */
8987
cea2e8a9
GS
8988void
8989Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8990{
8991 dTHX;
8992 va_list args;
8993 va_start(args, pat);
c5be433b 8994 sv_vcatpvf(sv, pat, &args);
cea2e8a9
GS
8995 va_end(args);
8996}
8997
645c22ef
DM
8998/* pTHX_ magic can't cope with varargs, so this is a no-context
8999 * version of the main function, (which may itself be aliased to us).
9000 * Don't access this version directly.
9001 */
9002
cea2e8a9
GS
9003void
9004Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
9005{
9006 dTHX;
9007 va_list args;
9008 va_start(args, pat);
c5be433b 9009 sv_vcatpvf_mg(sv, pat, &args);
cea2e8a9 9010 va_end(args);
cea2e8a9
GS
9011}
9012#endif
9013
954c1994
GS
9014/*
9015=for apidoc sv_catpvf
9016
d5ce4a7c
GA
9017Processes its arguments like C<sprintf> and appends the formatted
9018output to an SV. If the appended data contains "wide" characters
9019(including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9020and characters >255 formatted with %c), the original SV might get
bffc3d17 9021upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
cdd94ca7
NC
9022C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
9023valid UTF-8; if the original SV was bytes, the pattern should be too.
954c1994 9024
d5ce4a7c 9025=cut */
954c1994 9026
46fc3d4c 9027void
864dbfa3 9028Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
46fc3d4c 9029{
9030 va_list args;
46fc3d4c 9031 va_start(args, pat);
c5be433b 9032 sv_vcatpvf(sv, pat, &args);
46fc3d4c 9033 va_end(args);
9034}
9035
bffc3d17
SH
9036/*
9037=for apidoc sv_vcatpvf
9038
9039Processes its arguments like C<vsprintf> and appends the formatted output
9040to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9041
9042Usually used via its frontend C<sv_catpvf>.
9043
9044=cut
9045*/
645c22ef 9046
ef50df4b 9047void
c5be433b
GS
9048Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
9049{
9050 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9051}
9052
954c1994
GS
9053/*
9054=for apidoc sv_catpvf_mg
9055
9056Like C<sv_catpvf>, but also handles 'set' magic.
9057
9058=cut
9059*/
9060
c5be433b 9061void
864dbfa3 9062Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
ef50df4b
GS
9063{
9064 va_list args;
ef50df4b 9065 va_start(args, pat);
c5be433b 9066 sv_vcatpvf_mg(sv, pat, &args);
ef50df4b 9067 va_end(args);
c5be433b
GS
9068}
9069
bffc3d17
SH
9070/*
9071=for apidoc sv_vcatpvf_mg
9072
9073Like C<sv_vcatpvf>, but also handles 'set' magic.
9074
9075Usually used via its frontend C<sv_catpvf_mg>.
9076
9077=cut
9078*/
645c22ef 9079
c5be433b
GS
9080void
9081Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9082{
9083 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
ef50df4b
GS
9084 SvSETMAGIC(sv);
9085}
9086
954c1994
GS
9087/*
9088=for apidoc sv_vsetpvfn
9089
bffc3d17 9090Works like C<sv_vcatpvfn> but copies the text into the SV instead of
954c1994
GS
9091appending it.
9092
bffc3d17 9093Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
645c22ef 9094
954c1994
GS
9095=cut
9096*/
9097
46fc3d4c 9098void
7d5ea4e7 9099Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
46fc3d4c 9100{
9101 sv_setpvn(sv, "", 0);
7d5ea4e7 9102 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
46fc3d4c 9103}
9104
645c22ef
DM
9105/* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
9106
2d00ba3b 9107STATIC I32
9dd79c3f 9108S_expect_number(pTHX_ char** pattern)
211dfcf1
HS
9109{
9110 I32 var = 0;
9111 switch (**pattern) {
9112 case '1': case '2': case '3':
9113 case '4': case '5': case '6':
9114 case '7': case '8': case '9':
9115 while (isDIGIT(**pattern))
9116 var = var * 10 + (*(*pattern)++ - '0');
9117 }
9118 return var;
9119}
9dd79c3f 9120#define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
211dfcf1 9121
4151a5fe
IZ
9122static char *
9123F0convert(NV nv, char *endbuf, STRLEN *len)
9124{
a3b680e6 9125 const int neg = nv < 0;
4151a5fe 9126 UV uv;
4151a5fe
IZ
9127
9128 if (neg)
9129 nv = -nv;
9130 if (nv < UV_MAX) {
b464bac0 9131 char *p = endbuf;
4151a5fe 9132 nv += 0.5;
028f8eaa 9133 uv = (UV)nv;
4151a5fe
IZ
9134 if (uv & 1 && uv == nv)
9135 uv--; /* Round to even */
9136 do {
a3b680e6 9137 const unsigned dig = uv % 10;
4151a5fe
IZ
9138 *--p = '0' + dig;
9139 } while (uv /= 10);
9140 if (neg)
9141 *--p = '-';
9142 *len = endbuf - p;
9143 return p;
9144 }
9145 return Nullch;
9146}
9147
9148
954c1994
GS
9149/*
9150=for apidoc sv_vcatpvfn
9151
9152Processes its arguments like C<vsprintf> and appends the formatted output
9153to an SV. Uses an array of SVs if the C style variable argument list is
9154missing (NULL). When running with taint checks enabled, indicates via
9155C<maybe_tainted> if results are untrustworthy (often due to the use of
9156locales).
9157
bffc3d17 9158Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
645c22ef 9159
954c1994
GS
9160=cut
9161*/
9162
1ef29b0e
RGS
9163/* XXX maybe_tainted is never assigned to, so the doc above is lying. */
9164
46fc3d4c 9165void
7d5ea4e7 9166Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
46fc3d4c 9167{
9168 char *p;
9169 char *q;
a3b680e6 9170 const char *patend;
fc36a67e 9171 STRLEN origlen;
46fc3d4c 9172 I32 svix = 0;
27da23d5 9173 static const char nullstr[] = "(null)";
9c5ffd7c 9174 SV *argsv = Nullsv;
b464bac0
AL
9175 bool has_utf8 = DO_UTF8(sv); /* has the result utf8? */
9176 const bool pat_utf8 = has_utf8; /* the pattern is in utf8? */
db79b45b 9177 SV *nsv = Nullsv;
4151a5fe
IZ
9178 /* Times 4: a decimal digit takes more than 3 binary digits.
9179 * NV_DIG: mantissa takes than many decimal digits.
9180 * Plus 32: Playing safe. */
9181 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9182 /* large enough for "%#.#f" --chip */
9183 /* what about long double NVs? --jhi */
db79b45b 9184
46fc3d4c 9185 /* no matter what, this is a string now */
fc36a67e 9186 (void)SvPV_force(sv, origlen);
46fc3d4c 9187
0dbb1585 9188 /* special-case "", "%s", and "%-p" (SVf) */
46fc3d4c 9189 if (patlen == 0)
9190 return;
0dbb1585 9191 if (patlen == 2 && pat[0] == '%' && pat[1] == 's') {
c635e13b 9192 if (args) {
73d840c0 9193 const char *s = va_arg(*args, char*);
c635e13b 9194 sv_catpv(sv, s ? s : nullstr);
9195 }
7e2040f0 9196 else if (svix < svmax) {
fc36a67e 9197 sv_catsv(sv, *svargs);
7e2040f0
GS
9198 if (DO_UTF8(*svargs))
9199 SvUTF8_on(sv);
9200 }
fc36a67e 9201 return;
0dbb1585
AL
9202 }
9203 if (patlen == 3 && pat[0] == '%' &&
9204 pat[1] == '-' && pat[2] == 'p') {
fc36a67e 9205 if (args) {
7e2040f0
GS
9206 argsv = va_arg(*args, SV*);
9207 sv_catsv(sv, argsv);
9208 if (DO_UTF8(argsv))
9209 SvUTF8_on(sv);
fc36a67e 9210 return;
9211 }
46fc3d4c 9212 }
9213
1d917b39 9214#ifndef USE_LONG_DOUBLE
4151a5fe
IZ
9215 /* special-case "%.<number>[gf]" */
9216 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9217 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9218 unsigned digits = 0;
9219 const char *pp;
9220
9221 pp = pat + 2;
9222 while (*pp >= '0' && *pp <= '9')
9223 digits = 10 * digits + (*pp++ - '0');
028f8eaa 9224 if (pp - pat == (int)patlen - 1) {
4151a5fe
IZ
9225 NV nv;
9226
9227 if (args)
9228 nv = (NV)va_arg(*args, double);
9229 else if (svix < svmax)
9230 nv = SvNV(*svargs);
9231 else
9232 return;
9233 if (*pp == 'g') {
2873255c
NC
9234 /* Add check for digits != 0 because it seems that some
9235 gconverts are buggy in this case, and we don't yet have
9236 a Configure test for this. */
9237 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9238 /* 0, point, slack */
2e59c212 9239 Gconvert(nv, (int)digits, 0, ebuf);
4151a5fe
IZ
9240 sv_catpv(sv, ebuf);
9241 if (*ebuf) /* May return an empty string for digits==0 */
9242 return;
9243 }
9244 } else if (!digits) {
9245 STRLEN l;
9246
9247 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9248 sv_catpvn(sv, p, l);
9249 return;
9250 }
9251 }
9252 }
9253 }
1d917b39 9254#endif /* !USE_LONG_DOUBLE */
4151a5fe 9255
2cf2cfc6 9256 if (!args && svix < svmax && DO_UTF8(*svargs))
205f51d8 9257 has_utf8 = TRUE;
2cf2cfc6 9258
46fc3d4c 9259 patend = (char*)pat + patlen;
9260 for (p = (char*)pat; p < patend; p = q) {
9261 bool alt = FALSE;
9262 bool left = FALSE;
b22c7a20 9263 bool vectorize = FALSE;
211dfcf1 9264 bool vectorarg = FALSE;
2cf2cfc6 9265 bool vec_utf8 = FALSE;
46fc3d4c 9266 char fill = ' ';
9267 char plus = 0;
9268 char intsize = 0;
9269 STRLEN width = 0;
fc36a67e 9270 STRLEN zeros = 0;
46fc3d4c 9271 bool has_precis = FALSE;
9272 STRLEN precis = 0;
58e33a90 9273 I32 osvix = svix;
2cf2cfc6 9274 bool is_utf8 = FALSE; /* is this item utf8? */
20f6aaab
AS
9275#ifdef HAS_LDBL_SPRINTF_BUG
9276 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
205f51d8 9277 with sfio - Allen <allens@cpan.org> */
20f6aaab
AS
9278 bool fix_ldbl_sprintf_bug = FALSE;
9279#endif
205f51d8 9280
46fc3d4c 9281 char esignbuf[4];
89ebb4a3 9282 U8 utf8buf[UTF8_MAXBYTES+1];
46fc3d4c 9283 STRLEN esignlen = 0;
9284
9285 char *eptr = Nullch;
fc36a67e 9286 STRLEN elen = 0;
81f715da 9287 SV *vecsv = Nullsv;
a05b299f 9288 U8 *vecstr = Null(U8*);
b22c7a20 9289 STRLEN veclen = 0;
934abaf1 9290 char c = 0;
46fc3d4c 9291 int i;
9c5ffd7c 9292 unsigned base = 0;
8c8eb53c
RB
9293 IV iv = 0;
9294 UV uv = 0;
9e5b023a
JH
9295 /* we need a long double target in case HAS_LONG_DOUBLE but
9296 not USE_LONG_DOUBLE
9297 */
35fff930 9298#if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9e5b023a
JH
9299 long double nv;
9300#else
65202027 9301 NV nv;
9e5b023a 9302#endif
46fc3d4c 9303 STRLEN have;
9304 STRLEN need;
9305 STRLEN gap;
e1ec3a88 9306 const char *dotstr = ".";
b22c7a20 9307 STRLEN dotstrlen = 1;
211dfcf1 9308 I32 efix = 0; /* explicit format parameter index */
eb3fce90 9309 I32 ewix = 0; /* explicit width index */
211dfcf1
HS
9310 I32 epix = 0; /* explicit precision index */
9311 I32 evix = 0; /* explicit vector index */
eb3fce90 9312 bool asterisk = FALSE;
46fc3d4c 9313
211dfcf1 9314 /* echo everything up to the next format specification */
46fc3d4c 9315 for (q = p; q < patend && *q != '%'; ++q) ;
9316 if (q > p) {
db79b45b
JH
9317 if (has_utf8 && !pat_utf8)
9318 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9319 else
9320 sv_catpvn(sv, p, q - p);
46fc3d4c 9321 p = q;
9322 }
9323 if (q++ >= patend)
9324 break;
9325
211dfcf1
HS
9326/*
9327 We allow format specification elements in this order:
9328 \d+\$ explicit format parameter index
9329 [-+ 0#]+ flags
a472f209 9330 v|\*(\d+\$)?v vector with optional (optionally specified) arg
f3583277 9331 0 flag (as above): repeated to allow "v02"
211dfcf1
HS
9332 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9333 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9334 [hlqLV] size
9335 [%bcdefginopsux_DFOUX] format (mandatory)
9336*/
9337 if (EXPECT_NUMBER(q, width)) {
9338 if (*q == '$') {
9339 ++q;
9340 efix = width;
9341 } else {
9342 goto gotwidth;
9343 }
9344 }
9345
fc36a67e 9346 /* FLAGS */
9347
46fc3d4c 9348 while (*q) {
9349 switch (*q) {
9350 case ' ':
9351 case '+':
9352 plus = *q++;
9353 continue;
9354
9355 case '-':
9356 left = TRUE;
9357 q++;
9358 continue;
9359
9360 case '0':
9361 fill = *q++;
9362 continue;
9363
9364 case '#':
9365 alt = TRUE;
9366 q++;
9367 continue;
9368
fc36a67e 9369 default:
9370 break;
9371 }
9372 break;
9373 }
46fc3d4c 9374
211dfcf1 9375 tryasterisk:
eb3fce90 9376 if (*q == '*') {
211dfcf1
HS
9377 q++;
9378 if (EXPECT_NUMBER(q, ewix))
9379 if (*q++ != '$')
9380 goto unknown;
eb3fce90 9381 asterisk = TRUE;
211dfcf1
HS
9382 }
9383 if (*q == 'v') {
eb3fce90 9384 q++;
211dfcf1
HS
9385 if (vectorize)
9386 goto unknown;
9cbac4c7 9387 if ((vectorarg = asterisk)) {
211dfcf1
HS
9388 evix = ewix;
9389 ewix = 0;
9390 asterisk = FALSE;
9391 }
9392 vectorize = TRUE;
9393 goto tryasterisk;
eb3fce90
JH
9394 }
9395
211dfcf1 9396 if (!asterisk)
7a5fa8a2 9397 if( *q == '0' )
f3583277 9398 fill = *q++;
211dfcf1
HS
9399 EXPECT_NUMBER(q, width);
9400
9401 if (vectorize) {
9402 if (vectorarg) {
9403 if (args)
9404 vecsv = va_arg(*args, SV*);
9405 else
9406 vecsv = (evix ? evix <= svmax : svix < svmax) ?
3a7a539e 9407 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
4459522c 9408 dotstr = SvPVx(vecsv, dotstrlen);
211dfcf1 9409 if (DO_UTF8(vecsv))
2cf2cfc6 9410 is_utf8 = TRUE;
211dfcf1
HS
9411 }
9412 if (args) {
9413 vecsv = va_arg(*args, SV*);
9414 vecstr = (U8*)SvPVx(vecsv,veclen);
2cf2cfc6 9415 vec_utf8 = DO_UTF8(vecsv);
eb3fce90 9416 }
211dfcf1
HS
9417 else if (efix ? efix <= svmax : svix < svmax) {
9418 vecsv = svargs[efix ? efix-1 : svix++];
9419 vecstr = (U8*)SvPVx(vecsv,veclen);
2cf2cfc6 9420 vec_utf8 = DO_UTF8(vecsv);
d7aa5382 9421 /* if this is a version object, we need to return the
3f7c398e 9422 * stringified representation (which the SvPVX_const has
d7aa5382
JP
9423 * already done for us), but not vectorize the args
9424 */
9425 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9426 {
9427 q++; /* skip past the rest of the %vd format */
da6068d9 9428 eptr = (char *) vecstr;
d7aa5382
JP
9429 elen = strlen(eptr);
9430 vectorize=FALSE;
9431 goto string;
9432 }
211dfcf1
HS
9433 }
9434 else {
9435 vecstr = (U8*)"";
9436 veclen = 0;
9437 }
eb3fce90 9438 }
fc36a67e 9439
eb3fce90 9440 if (asterisk) {
fc36a67e 9441 if (args)
9442 i = va_arg(*args, int);
9443 else
eb3fce90
JH
9444 i = (ewix ? ewix <= svmax : svix < svmax) ?
9445 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
fc36a67e 9446 left |= (i < 0);
9447 width = (i < 0) ? -i : i;
fc36a67e 9448 }
211dfcf1 9449 gotwidth:
fc36a67e 9450
9451 /* PRECISION */
46fc3d4c 9452
fc36a67e 9453 if (*q == '.') {
9454 q++;
9455 if (*q == '*') {
211dfcf1 9456 q++;
7b8dd722
HS
9457 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9458 goto unknown;
9459 /* XXX: todo, support specified precision parameter */
9460 if (epix)
211dfcf1 9461 goto unknown;
46fc3d4c 9462 if (args)
9463 i = va_arg(*args, int);
9464 else
eb3fce90
JH
9465 i = (ewix ? ewix <= svmax : svix < svmax)
9466 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
fc36a67e 9467 precis = (i < 0) ? 0 : i;
fc36a67e 9468 }
9469 else {
9470 precis = 0;
9471 while (isDIGIT(*q))
9472 precis = precis * 10 + (*q++ - '0');
9473 }
9474 has_precis = TRUE;
9475 }
46fc3d4c 9476
fc36a67e 9477 /* SIZE */
46fc3d4c 9478
fc36a67e 9479 switch (*q) {
c623ac67
GS
9480#ifdef WIN32
9481 case 'I': /* Ix, I32x, and I64x */
9482# ifdef WIN64
9483 if (q[1] == '6' && q[2] == '4') {
9484 q += 3;
9485 intsize = 'q';
9486 break;
9487 }
9488# endif
9489 if (q[1] == '3' && q[2] == '2') {
9490 q += 3;
9491 break;
9492 }
9493# ifdef WIN64
9494 intsize = 'q';
9495# endif
9496 q++;
9497 break;
9498#endif
9e5b023a 9499#if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
6f9bb7fd 9500 case 'L': /* Ld */
e5c81feb 9501 /* FALL THROUGH */
e5c81feb 9502#ifdef HAS_QUAD
6f9bb7fd 9503 case 'q': /* qd */
9e5b023a 9504#endif
6f9bb7fd
GS
9505 intsize = 'q';
9506 q++;
9507 break;
9508#endif
fc36a67e 9509 case 'l':
9e5b023a 9510#if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
205f51d8 9511 if (*(q + 1) == 'l') { /* lld, llf */
fc36a67e 9512 intsize = 'q';
9513 q += 2;
46fc3d4c 9514 break;
cf2093f6 9515 }
fc36a67e 9516#endif
6f9bb7fd 9517 /* FALL THROUGH */
fc36a67e 9518 case 'h':
cf2093f6 9519 /* FALL THROUGH */
fc36a67e 9520 case 'V':
9521 intsize = *q++;
46fc3d4c 9522 break;
9523 }
9524
fc36a67e 9525 /* CONVERSION */
9526
211dfcf1
HS
9527 if (*q == '%') {
9528 eptr = q++;
9529 elen = 1;
9530 goto string;
9531 }
9532
be75b157
HS
9533 if (vectorize)
9534 argsv = vecsv;
9535 else if (!args)
211dfcf1
HS
9536 argsv = (efix ? efix <= svmax : svix < svmax) ?
9537 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9538
46fc3d4c 9539 switch (c = *q++) {
9540
9541 /* STRINGS */
9542
46fc3d4c 9543 case 'c':
be75b157 9544 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
1bd104fb
JH
9545 if ((uv > 255 ||
9546 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
0064a8a9 9547 && !IN_BYTES) {
dfe13c55 9548 eptr = (char*)utf8buf;
9041c2e3 9549 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
2cf2cfc6 9550 is_utf8 = TRUE;
7e2040f0
GS
9551 }
9552 else {
9553 c = (char)uv;
9554 eptr = &c;
9555 elen = 1;
a0ed51b3 9556 }
46fc3d4c 9557 goto string;
9558
46fc3d4c 9559 case 's':
be75b157 9560 if (args && !vectorize) {
fc36a67e 9561 eptr = va_arg(*args, char*);
c635e13b 9562 if (eptr)
1d7c1841
GS
9563#ifdef MACOS_TRADITIONAL
9564 /* On MacOS, %#s format is used for Pascal strings */
9565 if (alt)
9566 elen = *eptr++;
9567 else
9568#endif
c635e13b 9569 elen = strlen(eptr);
9570 else {
27da23d5 9571 eptr = (char *)nullstr;
c635e13b 9572 elen = sizeof nullstr - 1;
9573 }
46fc3d4c 9574 }
211dfcf1 9575 else {
7e2040f0
GS
9576 eptr = SvPVx(argsv, elen);
9577 if (DO_UTF8(argsv)) {
a0ed51b3
LW
9578 if (has_precis && precis < elen) {
9579 I32 p = precis;
7e2040f0 9580 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
a0ed51b3
LW
9581 precis = p;
9582 }
9583 if (width) { /* fudge width (can't fudge elen) */
7e2040f0 9584 width += elen - sv_len_utf8(argsv);
a0ed51b3 9585 }
2cf2cfc6 9586 is_utf8 = TRUE;
a0ed51b3
LW
9587 }
9588 }
fc36a67e 9589
46fc3d4c 9590 string:
b22c7a20 9591 vectorize = FALSE;
46fc3d4c 9592 if (has_precis && elen > precis)
9593 elen = precis;
9594 break;
9595
9596 /* INTEGERS */
9597
fc36a67e 9598 case 'p':
0dbb1585 9599 if (left && args) { /* SVf */
5df617be 9600 left = FALSE;
0dbb1585
AL
9601 if (width) {
9602 precis = width;
9603 has_precis = TRUE;
9604 width = 0;
9605 }
9606 if (vectorize)
9607 goto unknown;
9608 argsv = va_arg(*args, SV*);
9609 eptr = SvPVx(argsv, elen);
9610 if (DO_UTF8(argsv))
9611 is_utf8 = TRUE;
9612 goto string;
5df617be 9613 }
be75b157 9614 if (alt || vectorize)
c2e66d9e 9615 goto unknown;
211dfcf1 9616 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
fc36a67e 9617 base = 16;
9618 goto integer;
9619
46fc3d4c 9620 case 'D':
29fe7a80 9621#ifdef IV_IS_QUAD
22f3ae8c 9622 intsize = 'q';
29fe7a80 9623#else
46fc3d4c 9624 intsize = 'l';
29fe7a80 9625#endif
46fc3d4c 9626 /* FALL THROUGH */
9627 case 'd':
9628 case 'i':
b22c7a20 9629 if (vectorize) {
ba210ebe 9630 STRLEN ulen;
211dfcf1
HS
9631 if (!veclen)
9632 continue;
2cf2cfc6
A
9633 if (vec_utf8)
9634 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9635 UTF8_ALLOW_ANYUV);
b22c7a20 9636 else {
e83d50c9 9637 uv = *vecstr;
b22c7a20
GS
9638 ulen = 1;
9639 }
9640 vecstr += ulen;
9641 veclen -= ulen;
e83d50c9
JP
9642 if (plus)
9643 esignbuf[esignlen++] = plus;
b22c7a20
GS
9644 }
9645 else if (args) {
46fc3d4c 9646 switch (intsize) {
9647 case 'h': iv = (short)va_arg(*args, int); break;
46fc3d4c 9648 case 'l': iv = va_arg(*args, long); break;
fc36a67e 9649 case 'V': iv = va_arg(*args, IV); break;
b10c0dba 9650 default: iv = va_arg(*args, int); break;
cf2093f6
JH
9651#ifdef HAS_QUAD
9652 case 'q': iv = va_arg(*args, Quad_t); break;
9653#endif
46fc3d4c 9654 }
9655 }
9656 else {
b10c0dba 9657 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
46fc3d4c 9658 switch (intsize) {
b10c0dba
MHM
9659 case 'h': iv = (short)tiv; break;
9660 case 'l': iv = (long)tiv; break;
9661 case 'V':
9662 default: iv = tiv; break;
cf2093f6 9663#ifdef HAS_QUAD
b10c0dba 9664 case 'q': iv = (Quad_t)tiv; break;
cf2093f6 9665#endif
46fc3d4c 9666 }
9667 }
e83d50c9
JP
9668 if ( !vectorize ) /* we already set uv above */
9669 {
9670 if (iv >= 0) {
9671 uv = iv;
9672 if (plus)
9673 esignbuf[esignlen++] = plus;
9674 }
9675 else {
9676 uv = -iv;
9677 esignbuf[esignlen++] = '-';
9678 }
46fc3d4c 9679 }
9680 base = 10;
9681 goto integer;
9682
fc36a67e 9683 case 'U':
29fe7a80 9684#ifdef IV_IS_QUAD
22f3ae8c 9685 intsize = 'q';
29fe7a80 9686#else
fc36a67e 9687 intsize = 'l';
29fe7a80 9688#endif
fc36a67e 9689 /* FALL THROUGH */
9690 case 'u':
9691 base = 10;
9692 goto uns_integer;
9693
4f19785b
WSI
9694 case 'b':
9695 base = 2;
9696 goto uns_integer;
9697
46fc3d4c 9698 case 'O':
29fe7a80 9699#ifdef IV_IS_QUAD
22f3ae8c 9700 intsize = 'q';
29fe7a80 9701#else
46fc3d4c 9702 intsize = 'l';
29fe7a80 9703#endif
46fc3d4c 9704 /* FALL THROUGH */
9705 case 'o':
9706 base = 8;
9707 goto uns_integer;
9708
9709 case 'X':
46fc3d4c 9710 case 'x':
9711 base = 16;
46fc3d4c 9712
9713 uns_integer:
b22c7a20 9714 if (vectorize) {
ba210ebe 9715 STRLEN ulen;
b22c7a20 9716 vector:
211dfcf1
HS
9717 if (!veclen)
9718 continue;
2cf2cfc6
A
9719 if (vec_utf8)
9720 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9721 UTF8_ALLOW_ANYUV);
b22c7a20 9722 else {
a05b299f 9723 uv = *vecstr;
b22c7a20
GS
9724 ulen = 1;
9725 }
9726 vecstr += ulen;
9727 veclen -= ulen;
9728 }
9729 else if (args) {
46fc3d4c 9730 switch (intsize) {
9731 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
46fc3d4c 9732 case 'l': uv = va_arg(*args, unsigned long); break;
fc36a67e 9733 case 'V': uv = va_arg(*args, UV); break;
b10c0dba 9734 default: uv = va_arg(*args, unsigned); break;
cf2093f6 9735#ifdef HAS_QUAD
9e3321a5 9736 case 'q': uv = va_arg(*args, Uquad_t); break;
cf2093f6 9737#endif
46fc3d4c 9738 }
9739 }
9740 else {
b10c0dba 9741 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
46fc3d4c 9742 switch (intsize) {
b10c0dba
MHM
9743 case 'h': uv = (unsigned short)tuv; break;
9744 case 'l': uv = (unsigned long)tuv; break;
9745 case 'V':
9746 default: uv = tuv; break;
cf2093f6 9747#ifdef HAS_QUAD
b10c0dba 9748 case 'q': uv = (Uquad_t)tuv; break;
cf2093f6 9749#endif
46fc3d4c 9750 }
9751 }
9752
9753 integer:
46fc3d4c 9754 eptr = ebuf + sizeof ebuf;
fc36a67e 9755 switch (base) {
9756 unsigned dig;
9757 case 16:
c10ed8b9
HS
9758 if (!uv)
9759 alt = FALSE;
1d7c1841
GS
9760 p = (char*)((c == 'X')
9761 ? "0123456789ABCDEF" : "0123456789abcdef");
fc36a67e 9762 do {
9763 dig = uv & 15;
9764 *--eptr = p[dig];
9765 } while (uv >>= 4);
9766 if (alt) {
46fc3d4c 9767 esignbuf[esignlen++] = '0';
fc36a67e 9768 esignbuf[esignlen++] = c; /* 'x' or 'X' */
46fc3d4c 9769 }
fc36a67e 9770 break;
9771 case 8:
9772 do {
9773 dig = uv & 7;
9774 *--eptr = '0' + dig;
9775 } while (uv >>= 3);
9776 if (alt && *eptr != '0')
9777 *--eptr = '0';
9778 break;
4f19785b
WSI
9779 case 2:
9780 do {
9781 dig = uv & 1;
9782 *--eptr = '0' + dig;
9783 } while (uv >>= 1);
eda88b6d
JH
9784 if (alt) {
9785 esignbuf[esignlen++] = '0';
7481bb52 9786 esignbuf[esignlen++] = 'b';
eda88b6d 9787 }
4f19785b 9788 break;
fc36a67e 9789 default: /* it had better be ten or less */
9790 do {
9791 dig = uv % base;
9792 *--eptr = '0' + dig;
9793 } while (uv /= base);
9794 break;
46fc3d4c 9795 }
9796 elen = (ebuf + sizeof ebuf) - eptr;
c10ed8b9
HS
9797 if (has_precis) {
9798 if (precis > elen)
9799 zeros = precis - elen;
9800 else if (precis == 0 && elen == 1 && *eptr == '0')
9801 elen = 0;
9802 }
46fc3d4c 9803 break;
9804
9805 /* FLOATING POINT */
9806
fc36a67e 9807 case 'F':
9808 c = 'f'; /* maybe %F isn't supported here */
9809 /* FALL THROUGH */
46fc3d4c 9810 case 'e': case 'E':
fc36a67e 9811 case 'f':
46fc3d4c 9812 case 'g': case 'G':
9813
9814 /* This is evil, but floating point is even more evil */
9815
9e5b023a
JH
9816 /* for SV-style calling, we can only get NV
9817 for C-style calling, we assume %f is double;
9818 for simplicity we allow any of %Lf, %llf, %qf for long double
9819 */
9820 switch (intsize) {
9821 case 'V':
9822#if defined(USE_LONG_DOUBLE)
9823 intsize = 'q';
9824#endif
9825 break;
8a2e3f14 9826/* [perl #20339] - we should accept and ignore %lf rather than die */
00e17364
HS
9827 case 'l':
9828 /* FALL THROUGH */
9e5b023a
JH
9829 default:
9830#if defined(USE_LONG_DOUBLE)
9831 intsize = args ? 0 : 'q';
9832#endif
9833 break;
9834 case 'q':
9835#if defined(HAS_LONG_DOUBLE)
9836 break;
9837#else
9838 /* FALL THROUGH */
9839#endif
9840 case 'h':
9e5b023a
JH
9841 goto unknown;
9842 }
9843
9844 /* now we need (long double) if intsize == 'q', else (double) */
be75b157 9845 nv = (args && !vectorize) ?
35fff930
JH
9846#if LONG_DOUBLESIZE > DOUBLESIZE
9847 intsize == 'q' ?
205f51d8
AS
9848 va_arg(*args, long double) :
9849 va_arg(*args, double)
35fff930 9850#else
205f51d8 9851 va_arg(*args, double)
35fff930 9852#endif
9e5b023a 9853 : SvNVx(argsv);
fc36a67e 9854
9855 need = 0;
be75b157 9856 vectorize = FALSE;
fc36a67e 9857 if (c != 'e' && c != 'E') {
9858 i = PERL_INT_MIN;
9e5b023a
JH
9859 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9860 will cast our (long double) to (double) */
73b309ea 9861 (void)Perl_frexp(nv, &i);
fc36a67e 9862 if (i == PERL_INT_MIN)
cea2e8a9 9863 Perl_die(aTHX_ "panic: frexp");
c635e13b 9864 if (i > 0)
fc36a67e 9865 need = BIT_DIGITS(i);
9866 }
9867 need += has_precis ? precis : 6; /* known default */
20f6aaab 9868
fc36a67e 9869 if (need < width)
9870 need = width;
9871
20f6aaab
AS
9872#ifdef HAS_LDBL_SPRINTF_BUG
9873 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
205f51d8
AS
9874 with sfio - Allen <allens@cpan.org> */
9875
9876# ifdef DBL_MAX
9877# define MY_DBL_MAX DBL_MAX
9878# else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9879# if DOUBLESIZE >= 8
9880# define MY_DBL_MAX 1.7976931348623157E+308L
9881# else
9882# define MY_DBL_MAX 3.40282347E+38L
9883# endif
9884# endif
9885
9886# ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9887# define MY_DBL_MAX_BUG 1L
20f6aaab 9888# else
205f51d8 9889# define MY_DBL_MAX_BUG MY_DBL_MAX
20f6aaab 9890# endif
20f6aaab 9891
205f51d8
AS
9892# ifdef DBL_MIN
9893# define MY_DBL_MIN DBL_MIN
9894# else /* XXX guessing! -Allen */
9895# if DOUBLESIZE >= 8
9896# define MY_DBL_MIN 2.2250738585072014E-308L
9897# else
9898# define MY_DBL_MIN 1.17549435E-38L
9899# endif
9900# endif
20f6aaab 9901
205f51d8
AS
9902 if ((intsize == 'q') && (c == 'f') &&
9903 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9904 (need < DBL_DIG)) {
9905 /* it's going to be short enough that
9906 * long double precision is not needed */
9907
9908 if ((nv <= 0L) && (nv >= -0L))
9909 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9910 else {
9911 /* would use Perl_fp_class as a double-check but not
9912 * functional on IRIX - see perl.h comments */
9913
9914 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9915 /* It's within the range that a double can represent */
9916#if defined(DBL_MAX) && !defined(DBL_MIN)
9917 if ((nv >= ((long double)1/DBL_MAX)) ||
9918 (nv <= (-(long double)1/DBL_MAX)))
20f6aaab 9919#endif
205f51d8 9920 fix_ldbl_sprintf_bug = TRUE;
20f6aaab 9921 }
205f51d8
AS
9922 }
9923 if (fix_ldbl_sprintf_bug == TRUE) {
9924 double temp;
9925
9926 intsize = 0;
9927 temp = (double)nv;
9928 nv = (NV)temp;
9929 }
20f6aaab 9930 }
205f51d8
AS
9931
9932# undef MY_DBL_MAX
9933# undef MY_DBL_MAX_BUG
9934# undef MY_DBL_MIN
9935
20f6aaab
AS
9936#endif /* HAS_LDBL_SPRINTF_BUG */
9937
46fc3d4c 9938 need += 20; /* fudge factor */
80252599
GS
9939 if (PL_efloatsize < need) {
9940 Safefree(PL_efloatbuf);
9941 PL_efloatsize = need + 20; /* more fudge */
9942 New(906, PL_efloatbuf, PL_efloatsize, char);
7d5ea4e7 9943 PL_efloatbuf[0] = '\0';
46fc3d4c 9944 }
9945
4151a5fe
IZ
9946 if ( !(width || left || plus || alt) && fill != '0'
9947 && has_precis && intsize != 'q' ) { /* Shortcuts */
2873255c
NC
9948 /* See earlier comment about buggy Gconvert when digits,
9949 aka precis is 0 */
9950 if ( c == 'g' && precis) {
2e59c212 9951 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
4151a5fe
IZ
9952 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9953 goto float_converted;
9954 } else if ( c == 'f' && !precis) {
9955 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9956 break;
9957 }
9958 }
46fc3d4c 9959 eptr = ebuf + sizeof ebuf;
9960 *--eptr = '\0';
9961 *--eptr = c;
9e5b023a
JH
9962 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9963#if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9964 if (intsize == 'q') {
e5c81feb
JH
9965 /* Copy the one or more characters in a long double
9966 * format before the 'base' ([efgEFG]) character to
9967 * the format string. */
9968 static char const prifldbl[] = PERL_PRIfldbl;
9969 char const *p = prifldbl + sizeof(prifldbl) - 3;
9970 while (p >= prifldbl) { *--eptr = *p--; }
cf2093f6 9971 }
65202027 9972#endif
46fc3d4c 9973 if (has_precis) {
9974 base = precis;
9975 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9976 *--eptr = '.';
9977 }
9978 if (width) {
9979 base = width;
9980 do { *--eptr = '0' + (base % 10); } while (base /= 10);
9981 }
9982 if (fill == '0')
9983 *--eptr = fill;
84902520
TB
9984 if (left)
9985 *--eptr = '-';
46fc3d4c 9986 if (plus)
9987 *--eptr = plus;
9988 if (alt)
9989 *--eptr = '#';
9990 *--eptr = '%';
9991
ff9121f8
JH
9992 /* No taint. Otherwise we are in the strange situation
9993 * where printf() taints but print($float) doesn't.
bda0f7a5 9994 * --jhi */
9e5b023a
JH
9995#if defined(HAS_LONG_DOUBLE)
9996 if (intsize == 'q')
9997 (void)sprintf(PL_efloatbuf, eptr, nv);
9998 else
9999 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
10000#else
dd8482fc 10001 (void)sprintf(PL_efloatbuf, eptr, nv);
9e5b023a 10002#endif
4151a5fe 10003 float_converted:
80252599
GS
10004 eptr = PL_efloatbuf;
10005 elen = strlen(PL_efloatbuf);
46fc3d4c 10006 break;
10007
fc36a67e 10008 /* SPECIAL */
10009
10010 case 'n':
10011 i = SvCUR(sv) - origlen;
be75b157 10012 if (args && !vectorize) {
c635e13b 10013 switch (intsize) {
10014 case 'h': *(va_arg(*args, short*)) = i; break;
10015 default: *(va_arg(*args, int*)) = i; break;
10016 case 'l': *(va_arg(*args, long*)) = i; break;
10017 case 'V': *(va_arg(*args, IV*)) = i; break;
cf2093f6
JH
10018#ifdef HAS_QUAD
10019 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
10020#endif
c635e13b 10021 }
fc36a67e 10022 }
9dd79c3f 10023 else
211dfcf1 10024 sv_setuv_mg(argsv, (UV)i);
be75b157 10025 vectorize = FALSE;
fc36a67e 10026 continue; /* not "break" */
10027
10028 /* UNKNOWN */
10029
46fc3d4c 10030 default:
fc36a67e 10031 unknown:
599cee73 10032 if (!args && ckWARN(WARN_PRINTF) &&
533c011a 10033 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
c635e13b 10034 SV *msg = sv_newmortal();
35c1215d
NC
10035 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
10036 (PL_op->op_type == OP_PRTF) ? "" : "s");
0f4b6630 10037 if (c) {
0f4b6630 10038 if (isPRINT(c))
1c846c1f 10039 Perl_sv_catpvf(aTHX_ msg,
0f4b6630
JH
10040 "\"%%%c\"", c & 0xFF);
10041 else
10042 Perl_sv_catpvf(aTHX_ msg,
57def98f 10043 "\"%%\\%03"UVof"\"",
0f4b6630 10044 (UV)c & 0xFF);
0f4b6630 10045 } else
c635e13b 10046 sv_catpv(msg, "end of string");
9014280d 10047 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
c635e13b 10048 }
fb73857a 10049
10050 /* output mangled stuff ... */
10051 if (c == '\0')
10052 --q;
46fc3d4c 10053 eptr = p;
10054 elen = q - p;
fb73857a 10055
10056 /* ... right here, because formatting flags should not apply */
10057 SvGROW(sv, SvCUR(sv) + elen + 1);
10058 p = SvEND(sv);
4459522c 10059 Copy(eptr, p, elen, char);
fb73857a 10060 p += elen;
10061 *p = '\0';
3f7c398e 10062 SvCUR_set(sv, p - SvPVX_const(sv));
58e33a90 10063 svix = osvix;
fb73857a 10064 continue; /* not "break" */
46fc3d4c 10065 }
10066
6c94ec8b
HS
10067 /* calculate width before utf8_upgrade changes it */
10068 have = esignlen + zeros + elen;
10069
d2876be5
JH
10070 if (is_utf8 != has_utf8) {
10071 if (is_utf8) {
10072 if (SvCUR(sv))
10073 sv_utf8_upgrade(sv);
10074 }
10075 else {
10076 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
10077 sv_utf8_upgrade(nsv);
10078 eptr = SvPVX(nsv);
10079 elen = SvCUR(nsv);
10080 }
10081 SvGROW(sv, SvCUR(sv) + elen + 1);
10082 p = SvEND(sv);
10083 *p = '\0';
10084 }
6af65485 10085
46fc3d4c 10086 need = (have > width ? have : width);
10087 gap = need - have;
10088
b22c7a20 10089 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
46fc3d4c 10090 p = SvEND(sv);
10091 if (esignlen && fill == '0') {
eb160463 10092 for (i = 0; i < (int)esignlen; i++)
46fc3d4c 10093 *p++ = esignbuf[i];
10094 }
10095 if (gap && !left) {
10096 memset(p, fill, gap);
10097 p += gap;
10098 }
10099 if (esignlen && fill != '0') {
eb160463 10100 for (i = 0; i < (int)esignlen; i++)
46fc3d4c 10101 *p++ = esignbuf[i];
10102 }
fc36a67e 10103 if (zeros) {
10104 for (i = zeros; i; i--)
10105 *p++ = '0';
10106 }
46fc3d4c 10107 if (elen) {
4459522c 10108 Copy(eptr, p, elen, char);
46fc3d4c 10109 p += elen;
10110 }
10111 if (gap && left) {
10112 memset(p, ' ', gap);
10113 p += gap;
10114 }
b22c7a20
GS
10115 if (vectorize) {
10116 if (veclen) {
4459522c 10117 Copy(dotstr, p, dotstrlen, char);
b22c7a20
GS
10118 p += dotstrlen;
10119 }
10120 else
10121 vectorize = FALSE; /* done iterating over vecstr */
10122 }
2cf2cfc6
A
10123 if (is_utf8)
10124 has_utf8 = TRUE;
10125 if (has_utf8)
7e2040f0 10126 SvUTF8_on(sv);
46fc3d4c 10127 *p = '\0';
3f7c398e 10128 SvCUR_set(sv, p - SvPVX_const(sv));
b22c7a20
GS
10129 if (vectorize) {
10130 esignlen = 0;
10131 goto vector;
10132 }
46fc3d4c 10133 }
10134}
51371543 10135
645c22ef
DM
10136/* =========================================================================
10137
10138=head1 Cloning an interpreter
10139
10140All the macros and functions in this section are for the private use of
10141the main function, perl_clone().
10142
10143The foo_dup() functions make an exact copy of an existing foo thinngy.
10144During the course of a cloning, a hash table is used to map old addresses
10145to new addresses. The table is created and manipulated with the
10146ptr_table_* functions.
10147
10148=cut
10149
10150============================================================================*/
10151
10152
1d7c1841
GS
10153#if defined(USE_ITHREADS)
10154
1d7c1841
GS
10155#ifndef GpREFCNT_inc
10156# define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10157#endif
10158
10159
d2d73c3e
AB
10160#define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10161#define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10162#define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10163#define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10164#define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10165#define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10166#define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10167#define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10168#define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10169#define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10170#define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
1d7c1841
GS
10171#define SAVEPV(p) (p ? savepv(p) : Nullch)
10172#define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8cf8f3d1 10173
d2d73c3e 10174
d2f185dc
AMS
10175/* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
10176 regcomp.c. AMS 20010712 */
645c22ef 10177
1d7c1841 10178REGEXP *
a8fc9800 10179Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
1d7c1841 10180{
27da23d5 10181 dVAR;
d2f185dc
AMS
10182 REGEXP *ret;
10183 int i, len, npar;
10184 struct reg_substr_datum *s;
10185
10186 if (!r)
10187 return (REGEXP *)NULL;
10188
10189 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
10190 return ret;
10191
10192 len = r->offsets[0];
10193 npar = r->nparens+1;
10194
10195 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
10196 Copy(r->program, ret->program, len+1, regnode);
10197
10198 New(0, ret->startp, npar, I32);
10199 Copy(r->startp, ret->startp, npar, I32);
10200 New(0, ret->endp, npar, I32);
10201 Copy(r->startp, ret->startp, npar, I32);
10202
d2f185dc
AMS
10203 New(0, ret->substrs, 1, struct reg_substr_data);
10204 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
10205 s->min_offset = r->substrs->data[i].min_offset;
10206 s->max_offset = r->substrs->data[i].max_offset;
10207 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
33b8afdf 10208 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
d2f185dc
AMS
10209 }
10210
70612e96 10211 ret->regstclass = NULL;
d2f185dc
AMS
10212 if (r->data) {
10213 struct reg_data *d;
e1ec3a88 10214 const int count = r->data->count;
d2f185dc
AMS
10215
10216 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
10217 char, struct reg_data);
10218 New(0, d->what, count, U8);
10219
10220 d->count = count;
10221 for (i = 0; i < count; i++) {
10222 d->what[i] = r->data->what[i];
10223 switch (d->what[i]) {
a3621e74
YO
10224 /* legal options are one of: sfpont
10225 see also regcomp.h and pregfree() */
d2f185dc
AMS
10226 case 's':
10227 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
10228 break;
10229 case 'p':
10230 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
10231 break;
10232 case 'f':
10233 /* This is cheating. */
10234 New(0, d->data[i], 1, struct regnode_charclass_class);
10235 StructCopy(r->data->data[i], d->data[i],
10236 struct regnode_charclass_class);
70612e96 10237 ret->regstclass = (regnode*)d->data[i];
d2f185dc
AMS
10238 break;
10239 case 'o':
33773810
AMS
10240 /* Compiled op trees are readonly, and can thus be
10241 shared without duplication. */
b34c0dd4 10242 OP_REFCNT_LOCK;
9b978d73 10243 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
b34c0dd4 10244 OP_REFCNT_UNLOCK;
9b978d73 10245 break;
d2f185dc
AMS
10246 case 'n':
10247 d->data[i] = r->data->data[i];
10248 break;
a3621e74
YO
10249 case 't':
10250 d->data[i] = r->data->data[i];
10251 OP_REFCNT_LOCK;
10252 ((reg_trie_data*)d->data[i])->refcount++;
10253 OP_REFCNT_UNLOCK;
10254 break;
10255 default:
10256 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
d2f185dc
AMS
10257 }
10258 }
10259
10260 ret->data = d;
10261 }
10262 else
10263 ret->data = NULL;
10264
10265 New(0, ret->offsets, 2*len+1, U32);
10266 Copy(r->offsets, ret->offsets, 2*len+1, U32);
10267
e01c5899 10268 ret->precomp = SAVEPVN(r->precomp, r->prelen);
d2f185dc
AMS
10269 ret->refcnt = r->refcnt;
10270 ret->minlen = r->minlen;
10271 ret->prelen = r->prelen;
10272 ret->nparens = r->nparens;
10273 ret->lastparen = r->lastparen;
10274 ret->lastcloseparen = r->lastcloseparen;
10275 ret->reganch = r->reganch;
10276
70612e96
RG
10277 ret->sublen = r->sublen;
10278
10279 if (RX_MATCH_COPIED(ret))
e01c5899 10280 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
70612e96
RG
10281 else
10282 ret->subbeg = Nullch;
9a26048b
NC
10283#ifdef PERL_COPY_ON_WRITE
10284 ret->saved_copy = Nullsv;
10285#endif
70612e96 10286
d2f185dc
AMS
10287 ptr_table_store(PL_ptr_table, r, ret);
10288 return ret;
1d7c1841
GS
10289}
10290
d2d73c3e 10291/* duplicate a file handle */
645c22ef 10292
1d7c1841 10293PerlIO *
a8fc9800 10294Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
1d7c1841
GS
10295{
10296 PerlIO *ret;
73d840c0
AL
10297 (void)type;
10298
1d7c1841
GS
10299 if (!fp)
10300 return (PerlIO*)NULL;
10301
10302 /* look for it in the table first */
10303 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10304 if (ret)
10305 return ret;
10306
10307 /* create anew and remember what it is */
ecdeb87c 10308 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
1d7c1841
GS
10309 ptr_table_store(PL_ptr_table, fp, ret);
10310 return ret;
10311}
10312
645c22ef
DM
10313/* duplicate a directory handle */
10314
1d7c1841
GS
10315DIR *
10316Perl_dirp_dup(pTHX_ DIR *dp)
10317{
10318 if (!dp)
10319 return (DIR*)NULL;
10320 /* XXX TODO */
10321 return dp;
10322}
10323
ff276b08 10324/* duplicate a typeglob */
645c22ef 10325
1d7c1841 10326GP *
a8fc9800 10327Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
1d7c1841
GS
10328{
10329 GP *ret;
10330 if (!gp)
10331 return (GP*)NULL;
10332 /* look for it in the table first */
10333 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10334 if (ret)
10335 return ret;
10336
10337 /* create anew and remember what it is */
10338 Newz(0, ret, 1, GP);
10339 ptr_table_store(PL_ptr_table, gp, ret);
10340
10341 /* clone */
10342 ret->gp_refcnt = 0; /* must be before any other dups! */
d2d73c3e
AB
10343 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10344 ret->gp_io = io_dup_inc(gp->gp_io, param);
10345 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10346 ret->gp_av = av_dup_inc(gp->gp_av, param);
10347 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10348 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10349 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
1d7c1841
GS
10350 ret->gp_cvgen = gp->gp_cvgen;
10351 ret->gp_flags = gp->gp_flags;
10352 ret->gp_line = gp->gp_line;
10353 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10354 return ret;
10355}
10356
645c22ef
DM
10357/* duplicate a chain of magic */
10358
1d7c1841 10359MAGIC *
a8fc9800 10360Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
1d7c1841 10361{
cb359b41
JH
10362 MAGIC *mgprev = (MAGIC*)NULL;
10363 MAGIC *mgret;
1d7c1841
GS
10364 if (!mg)
10365 return (MAGIC*)NULL;
10366 /* look for it in the table first */
10367 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10368 if (mgret)
10369 return mgret;
10370
10371 for (; mg; mg = mg->mg_moremagic) {
10372 MAGIC *nmg;
10373 Newz(0, nmg, 1, MAGIC);
cb359b41 10374 if (mgprev)
1d7c1841 10375 mgprev->mg_moremagic = nmg;
cb359b41
JH
10376 else
10377 mgret = nmg;
1d7c1841
GS
10378 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10379 nmg->mg_private = mg->mg_private;
10380 nmg->mg_type = mg->mg_type;
10381 nmg->mg_flags = mg->mg_flags;
14befaf4 10382 if (mg->mg_type == PERL_MAGIC_qr) {
d2f185dc 10383 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
1d7c1841 10384 }
05bd4103 10385 else if(mg->mg_type == PERL_MAGIC_backref) {
7fc63493 10386 const AV * const av = (AV*) mg->mg_obj;
fdc9a813
AE
10387 SV **svp;
10388 I32 i;
7fc63493 10389 (void)SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
fdc9a813
AE
10390 svp = AvARRAY(av);
10391 for (i = AvFILLp(av); i >= 0; i--) {
3a81978b 10392 if (!svp[i]) continue;
fdc9a813
AE
10393 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10394 }
05bd4103 10395 }
8d2f4536
NC
10396 else if (mg->mg_type == PERL_MAGIC_symtab) {
10397 nmg->mg_obj = mg->mg_obj;
10398 }
1d7c1841
GS
10399 else {
10400 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
d2d73c3e
AB
10401 ? sv_dup_inc(mg->mg_obj, param)
10402 : sv_dup(mg->mg_obj, param);
1d7c1841
GS
10403 }
10404 nmg->mg_len = mg->mg_len;
10405 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
14befaf4 10406 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
68795e93 10407 if (mg->mg_len > 0) {
1d7c1841 10408 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
14befaf4
DM
10409 if (mg->mg_type == PERL_MAGIC_overload_table &&
10410 AMT_AMAGIC((AMT*)mg->mg_ptr))
10411 {
1d7c1841
GS
10412 AMT *amtp = (AMT*)mg->mg_ptr;
10413 AMT *namtp = (AMT*)nmg->mg_ptr;
10414 I32 i;
10415 for (i = 1; i < NofAMmeth; i++) {
d2d73c3e 10416 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
1d7c1841
GS
10417 }
10418 }
10419 }
10420 else if (mg->mg_len == HEf_SVKEY)
d2d73c3e 10421 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
1d7c1841 10422 }
68795e93
NIS
10423 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10424 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10425 }
1d7c1841
GS
10426 mgprev = nmg;
10427 }
10428 return mgret;
10429}
10430
645c22ef
DM
10431/* create a new pointer-mapping table */
10432
1d7c1841
GS
10433PTR_TBL_t *
10434Perl_ptr_table_new(pTHX)
10435{
10436 PTR_TBL_t *tbl;
10437 Newz(0, tbl, 1, PTR_TBL_t);
10438 tbl->tbl_max = 511;
10439 tbl->tbl_items = 0;
10440 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10441 return tbl;
10442}
10443
134ca3d6
DM
10444#if (PTRSIZE == 8)
10445# define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10446#else
10447# define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10448#endif
10449
32e691d0
NC
10450
10451
10452STATIC void
10453S_more_pte(pTHX)
10454{
cac9b346
NC
10455 struct ptr_tbl_ent* pte;
10456 struct ptr_tbl_ent* pteend;
c3929b72
NC
10457 New(0, pte, PERL_ARENA_SIZE/sizeof(struct ptr_tbl_ent), struct ptr_tbl_ent);
10458 pte->next = PL_pte_arenaroot;
10459 PL_pte_arenaroot = pte;
32e691d0 10460
9c17f24a 10461 pteend = &pte[PERL_ARENA_SIZE / sizeof(struct ptr_tbl_ent) - 1];
32e691d0
NC
10462 PL_pte_root = ++pte;
10463 while (pte < pteend) {
10464 pte->next = pte + 1;
10465 pte++;
10466 }
10467 pte->next = 0;
10468}
10469
10470STATIC struct ptr_tbl_ent*
10471S_new_pte(pTHX)
10472{
10473 struct ptr_tbl_ent* pte;
10474 if (!PL_pte_root)
10475 S_more_pte(aTHX);
10476 pte = PL_pte_root;
10477 PL_pte_root = pte->next;
10478 return pte;
10479}
10480
10481STATIC void
10482S_del_pte(pTHX_ struct ptr_tbl_ent*p)
10483{
10484 p->next = PL_pte_root;
10485 PL_pte_root = p;
10486}
10487
645c22ef
DM
10488/* map an existing pointer using a table */
10489
1d7c1841
GS
10490void *
10491Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10492{
10493 PTR_TBL_ENT_t *tblent;
4373e329 10494 const UV hash = PTR_TABLE_HASH(sv);
1d7c1841
GS
10495 assert(tbl);
10496 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10497 for (; tblent; tblent = tblent->next) {
10498 if (tblent->oldval == sv)
10499 return tblent->newval;
10500 }
10501 return (void*)NULL;
10502}
10503
645c22ef
DM
10504/* add a new entry to a pointer-mapping table */
10505
1d7c1841
GS
10506void
10507Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10508{
10509 PTR_TBL_ENT_t *tblent, **otblent;
10510 /* XXX this may be pessimal on platforms where pointers aren't good
10511 * hash values e.g. if they grow faster in the most significant
10512 * bits */
4373e329 10513 const UV hash = PTR_TABLE_HASH(oldv);
14cade97 10514 bool empty = 1;
1d7c1841
GS
10515
10516 assert(tbl);
10517 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
14cade97 10518 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
1d7c1841
GS
10519 if (tblent->oldval == oldv) {
10520 tblent->newval = newv;
1d7c1841
GS
10521 return;
10522 }
10523 }
32e691d0 10524 tblent = S_new_pte(aTHX);
1d7c1841
GS
10525 tblent->oldval = oldv;
10526 tblent->newval = newv;
10527 tblent->next = *otblent;
10528 *otblent = tblent;
10529 tbl->tbl_items++;
14cade97 10530 if (!empty && tbl->tbl_items > tbl->tbl_max)
1d7c1841
GS
10531 ptr_table_split(tbl);
10532}
10533
645c22ef
DM
10534/* double the hash bucket size of an existing ptr table */
10535
1d7c1841
GS
10536void
10537Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10538{
10539 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
4373e329 10540 const UV oldsize = tbl->tbl_max + 1;
1d7c1841
GS
10541 UV newsize = oldsize * 2;
10542 UV i;
10543
10544 Renew(ary, newsize, PTR_TBL_ENT_t*);
10545 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10546 tbl->tbl_max = --newsize;
10547 tbl->tbl_ary = ary;
10548 for (i=0; i < oldsize; i++, ary++) {
10549 PTR_TBL_ENT_t **curentp, **entp, *ent;
10550 if (!*ary)
10551 continue;
10552 curentp = ary + oldsize;
10553 for (entp = ary, ent = *ary; ent; ent = *entp) {
134ca3d6 10554 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
1d7c1841
GS
10555 *entp = ent->next;
10556 ent->next = *curentp;
10557 *curentp = ent;
10558 continue;
10559 }
10560 else
10561 entp = &ent->next;
10562 }
10563 }
10564}
10565
645c22ef
DM
10566/* remove all the entries from a ptr table */
10567
a0739874
DM
10568void
10569Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10570{
10571 register PTR_TBL_ENT_t **array;
10572 register PTR_TBL_ENT_t *entry;
a0739874
DM
10573 UV riter = 0;
10574 UV max;
10575
10576 if (!tbl || !tbl->tbl_items) {
10577 return;
10578 }
10579
10580 array = tbl->tbl_ary;
10581 entry = array[0];
10582 max = tbl->tbl_max;
10583
10584 for (;;) {
10585 if (entry) {
4373e329 10586 PTR_TBL_ENT_t *oentry = entry;
a0739874 10587 entry = entry->next;
32e691d0 10588 S_del_pte(aTHX_ oentry);
a0739874
DM
10589 }
10590 if (!entry) {
10591 if (++riter > max) {
10592 break;
10593 }
10594 entry = array[riter];
10595 }
10596 }
10597
10598 tbl->tbl_items = 0;
10599}
10600
645c22ef
DM
10601/* clear and free a ptr table */
10602
a0739874
DM
10603void
10604Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10605{
10606 if (!tbl) {
10607 return;
10608 }
10609 ptr_table_clear(tbl);
10610 Safefree(tbl->tbl_ary);
10611 Safefree(tbl);
10612}
10613
645c22ef
DM
10614/* attempt to make everything in the typeglob readonly */
10615
5bd07a3d 10616STATIC SV *
59b40662 10617S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
5bd07a3d
DM
10618{
10619 GV *gv = (GV*)sstr;
59b40662 10620 SV *sv = &param->proto_perl->Isv_no; /* just need SvREADONLY-ness */
5bd07a3d
DM
10621
10622 if (GvIO(gv) || GvFORM(gv)) {
7fb37951 10623 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
5bd07a3d
DM
10624 }
10625 else if (!GvCV(gv)) {
10626 GvCV(gv) = (CV*)sv;
10627 }
10628 else {
10629 /* CvPADLISTs cannot be shared */
37e20706 10630 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
7fb37951 10631 GvUNIQUE_off(gv);
5bd07a3d
DM
10632 }
10633 }
10634
7fb37951 10635 if (!GvUNIQUE(gv)) {
5bd07a3d
DM
10636#if 0
10637 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
bfcb3514 10638 HvNAME_get(GvSTASH(gv)), GvNAME(gv));
5bd07a3d
DM
10639#endif
10640 return Nullsv;
10641 }
10642
4411f3b6 10643 /*
5bd07a3d
DM
10644 * write attempts will die with
10645 * "Modification of a read-only value attempted"
10646 */
10647 if (!GvSV(gv)) {
10648 GvSV(gv) = sv;
10649 }
10650 else {
10651 SvREADONLY_on(GvSV(gv));
10652 }
10653
10654 if (!GvAV(gv)) {
10655 GvAV(gv) = (AV*)sv;
10656 }
10657 else {
10658 SvREADONLY_on(GvAV(gv));
10659 }
10660
10661 if (!GvHV(gv)) {
10662 GvHV(gv) = (HV*)sv;
10663 }
10664 else {
53c33732 10665 SvREADONLY_on(GvHV(gv));
5bd07a3d
DM
10666 }
10667
10668 return sstr; /* he_dup() will SvREFCNT_inc() */
10669}
10670
645c22ef
DM
10671/* duplicate an SV of any type (including AV, HV etc) */
10672
83841fad
NIS
10673void
10674Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10675{
10676 if (SvROK(sstr)) {
b162af07
SP
10677 SvRV_set(dstr, SvWEAKREF(sstr)
10678 ? sv_dup(SvRV(sstr), param)
10679 : sv_dup_inc(SvRV(sstr), param));
f880fe2f 10680
83841fad 10681 }
3f7c398e 10682 else if (SvPVX_const(sstr)) {
83841fad
NIS
10683 /* Has something there */
10684 if (SvLEN(sstr)) {
68795e93 10685 /* Normal PV - clone whole allocated space */
3f7c398e 10686 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvLEN(sstr)-1));
d3d0e6f1
NC
10687 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10688 /* Not that normal - actually sstr is copy on write.
10689 But we are a true, independant SV, so: */
10690 SvREADONLY_off(dstr);
10691 SvFAKE_off(dstr);
10692 }
68795e93 10693 }
83841fad
NIS
10694 else {
10695 /* Special case - not normally malloced for some reason */
10696 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10697 /* A "shared" PV - clone it as unshared string */
281b2760 10698 if(SvPADTMP(sstr)) {
5e6160dc
AB
10699 /* However, some of them live in the pad
10700 and they should not have these flags
10701 turned off */
281b2760 10702
3f7c398e 10703 SvPV_set(dstr, sharepvn(SvPVX_const(sstr), SvCUR(sstr),
f880fe2f 10704 SvUVX(sstr)));
607fa7f2 10705 SvUV_set(dstr, SvUVX(sstr));
281b2760
AB
10706 } else {
10707
3f7c398e 10708 SvPV_set(dstr, SAVEPVN(SvPVX_const(sstr), SvCUR(sstr)));
281b2760
AB
10709 SvFAKE_off(dstr);
10710 SvREADONLY_off(dstr);
5e6160dc 10711 }
83841fad
NIS
10712 }
10713 else {
10714 /* Some other special case - random pointer */
f880fe2f 10715 SvPV_set(dstr, SvPVX(sstr));
d3d0e6f1 10716 }
83841fad
NIS
10717 }
10718 }
10719 else {
10720 /* Copy the Null */
f880fe2f 10721 if (SvTYPE(dstr) == SVt_RV)
b162af07 10722 SvRV_set(dstr, NULL);
f880fe2f
SP
10723 else
10724 SvPV_set(dstr, 0);
83841fad
NIS
10725 }
10726}
10727
1d7c1841 10728SV *
a8fc9800 10729Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
1d7c1841 10730{
27da23d5 10731 dVAR;
1d7c1841
GS
10732 SV *dstr;
10733
10734 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10735 return Nullsv;
10736 /* look for it in the table first */
10737 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10738 if (dstr)
10739 return dstr;
10740
0405e91e
AB
10741 if(param->flags & CLONEf_JOIN_IN) {
10742 /** We are joining here so we don't want do clone
10743 something that is bad **/
bfcb3514 10744 const char *hvname;
0405e91e
AB
10745
10746 if(SvTYPE(sstr) == SVt_PVHV &&
bfcb3514 10747 (hvname = HvNAME_get(sstr))) {
0405e91e 10748 /** don't clone stashes if they already exist **/
bfcb3514 10749 HV* old_stash = gv_stashpv(hvname,0);
0405e91e
AB
10750 return (SV*) old_stash;
10751 }
10752 }
10753
1d7c1841
GS
10754 /* create anew and remember what it is */
10755 new_SV(dstr);
fd0854ff
DM
10756
10757#ifdef DEBUG_LEAKING_SCALARS
10758 dstr->sv_debug_optype = sstr->sv_debug_optype;
10759 dstr->sv_debug_line = sstr->sv_debug_line;
10760 dstr->sv_debug_inpad = sstr->sv_debug_inpad;
10761 dstr->sv_debug_cloned = 1;
10762# ifdef NETWARE
10763 dstr->sv_debug_file = savepv(sstr->sv_debug_file);
10764# else
10765 dstr->sv_debug_file = savesharedpv(sstr->sv_debug_file);
10766# endif
10767#endif
10768
1d7c1841
GS
10769 ptr_table_store(PL_ptr_table, sstr, dstr);
10770
10771 /* clone */
10772 SvFLAGS(dstr) = SvFLAGS(sstr);
10773 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10774 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10775
10776#ifdef DEBUGGING
3f7c398e 10777 if (SvANY(sstr) && PL_watch_pvx && SvPVX_const(sstr) == PL_watch_pvx)
1d7c1841 10778 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
3f7c398e 10779 PL_watch_pvx, SvPVX_const(sstr));
1d7c1841
GS
10780#endif
10781
9660f481
DM
10782 /* don't clone objects whose class has asked us not to */
10783 if (SvOBJECT(sstr) && ! (SvFLAGS(SvSTASH(sstr)) & SVphv_CLONEABLE)) {
10784 SvFLAGS(dstr) &= ~SVTYPEMASK;
10785 SvOBJECT_off(dstr);
10786 return dstr;
10787 }
10788
1d7c1841
GS
10789 switch (SvTYPE(sstr)) {
10790 case SVt_NULL:
10791 SvANY(dstr) = NULL;
10792 break;
10793 case SVt_IV:
339049b0 10794 SvANY(dstr) = (XPVIV*)((char*)&(dstr->sv_u.svu_iv) - STRUCT_OFFSET(XPVIV, xiv_iv));
45977657 10795 SvIV_set(dstr, SvIVX(sstr));
1d7c1841
GS
10796 break;
10797 case SVt_NV:
10798 SvANY(dstr) = new_XNV();
9d6ce603 10799 SvNV_set(dstr, SvNVX(sstr));
1d7c1841
GS
10800 break;
10801 case SVt_RV:
339049b0 10802 SvANY(dstr) = &(dstr->sv_u.svu_rv);
83841fad 10803 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
10804 break;
10805 case SVt_PV:
10806 SvANY(dstr) = new_XPV();
b162af07
SP
10807 SvCUR_set(dstr, SvCUR(sstr));
10808 SvLEN_set(dstr, SvLEN(sstr));
83841fad 10809 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
10810 break;
10811 case SVt_PVIV:
10812 SvANY(dstr) = new_XPVIV();
b162af07
SP
10813 SvCUR_set(dstr, SvCUR(sstr));
10814 SvLEN_set(dstr, SvLEN(sstr));
45977657 10815 SvIV_set(dstr, SvIVX(sstr));
83841fad 10816 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
10817 break;
10818 case SVt_PVNV:
10819 SvANY(dstr) = new_XPVNV();
b162af07
SP
10820 SvCUR_set(dstr, SvCUR(sstr));
10821 SvLEN_set(dstr, SvLEN(sstr));
45977657 10822 SvIV_set(dstr, SvIVX(sstr));
9d6ce603 10823 SvNV_set(dstr, SvNVX(sstr));
83841fad 10824 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
10825 break;
10826 case SVt_PVMG:
10827 SvANY(dstr) = new_XPVMG();
b162af07
SP
10828 SvCUR_set(dstr, SvCUR(sstr));
10829 SvLEN_set(dstr, SvLEN(sstr));
45977657 10830 SvIV_set(dstr, SvIVX(sstr));
9d6ce603 10831 SvNV_set(dstr, SvNVX(sstr));
b162af07
SP
10832 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10833 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
83841fad 10834 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
10835 break;
10836 case SVt_PVBM:
10837 SvANY(dstr) = new_XPVBM();
b162af07
SP
10838 SvCUR_set(dstr, SvCUR(sstr));
10839 SvLEN_set(dstr, SvLEN(sstr));
45977657 10840 SvIV_set(dstr, SvIVX(sstr));
9d6ce603 10841 SvNV_set(dstr, SvNVX(sstr));
b162af07
SP
10842 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10843 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
83841fad 10844 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
10845 BmRARE(dstr) = BmRARE(sstr);
10846 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10847 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10848 break;
10849 case SVt_PVLV:
10850 SvANY(dstr) = new_XPVLV();
b162af07
SP
10851 SvCUR_set(dstr, SvCUR(sstr));
10852 SvLEN_set(dstr, SvLEN(sstr));
45977657 10853 SvIV_set(dstr, SvIVX(sstr));
9d6ce603 10854 SvNV_set(dstr, SvNVX(sstr));
b162af07
SP
10855 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10856 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
83841fad 10857 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
10858 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10859 LvTARGLEN(dstr) = LvTARGLEN(sstr);
dd28f7bb
DM
10860 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10861 LvTARG(dstr) = dstr;
10862 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10863 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10864 else
10865 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
1d7c1841
GS
10866 LvTYPE(dstr) = LvTYPE(sstr);
10867 break;
10868 case SVt_PVGV:
7fb37951 10869 if (GvUNIQUE((GV*)sstr)) {
5bd07a3d 10870 SV *share;
59b40662 10871 if ((share = gv_share(sstr, param))) {
5bd07a3d
DM
10872 del_SV(dstr);
10873 dstr = share;
37e20706 10874 ptr_table_store(PL_ptr_table, sstr, dstr);
5bd07a3d
DM
10875#if 0
10876 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
bfcb3514 10877 HvNAME_get(GvSTASH(share)), GvNAME(share));
5bd07a3d
DM
10878#endif
10879 break;
10880 }
10881 }
1d7c1841 10882 SvANY(dstr) = new_XPVGV();
b162af07
SP
10883 SvCUR_set(dstr, SvCUR(sstr));
10884 SvLEN_set(dstr, SvLEN(sstr));
45977657 10885 SvIV_set(dstr, SvIVX(sstr));
9d6ce603 10886 SvNV_set(dstr, SvNVX(sstr));
b162af07
SP
10887 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10888 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
83841fad 10889 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
10890 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10891 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
d2d73c3e 10892 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
1d7c1841 10893 GvFLAGS(dstr) = GvFLAGS(sstr);
d2d73c3e 10894 GvGP(dstr) = gp_dup(GvGP(sstr), param);
1d7c1841
GS
10895 (void)GpREFCNT_inc(GvGP(dstr));
10896 break;
10897 case SVt_PVIO:
10898 SvANY(dstr) = new_XPVIO();
b162af07
SP
10899 SvCUR_set(dstr, SvCUR(sstr));
10900 SvLEN_set(dstr, SvLEN(sstr));
45977657 10901 SvIV_set(dstr, SvIVX(sstr));
9d6ce603 10902 SvNV_set(dstr, SvNVX(sstr));
b162af07
SP
10903 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10904 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
83841fad 10905 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
a8fc9800 10906 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
1d7c1841
GS
10907 if (IoOFP(sstr) == IoIFP(sstr))
10908 IoOFP(dstr) = IoIFP(dstr);
10909 else
a8fc9800 10910 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
1d7c1841
GS
10911 /* PL_rsfp_filters entries have fake IoDIRP() */
10912 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10913 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10914 else
10915 IoDIRP(dstr) = IoDIRP(sstr);
10916 IoLINES(dstr) = IoLINES(sstr);
10917 IoPAGE(dstr) = IoPAGE(sstr);
10918 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10919 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
7a5fa8a2 10920 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
5a37521b
AB
10921 /* I have no idea why fake dirp (rsfps)
10922 should be treaded differently but otherwise
10923 we end up with leaks -- sky*/
10924 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10925 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10926 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10927 } else {
10928 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10929 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10930 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10931 }
1d7c1841 10932 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
1d7c1841 10933 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
1d7c1841 10934 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
1d7c1841
GS
10935 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10936 IoTYPE(dstr) = IoTYPE(sstr);
10937 IoFLAGS(dstr) = IoFLAGS(sstr);
10938 break;
10939 case SVt_PVAV:
10940 SvANY(dstr) = new_XPVAV();
b162af07
SP
10941 SvCUR_set(dstr, SvCUR(sstr));
10942 SvLEN_set(dstr, SvLEN(sstr));
b162af07
SP
10943 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10944 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
1d7c1841
GS
10945 if (AvARRAY((AV*)sstr)) {
10946 SV **dst_ary, **src_ary;
10947 SSize_t items = AvFILLp((AV*)sstr) + 1;
10948
10949 src_ary = AvARRAY((AV*)sstr);
10950 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10951 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
f880fe2f 10952 SvPV_set(dstr, (char*)dst_ary);
1d7c1841
GS
10953 AvALLOC((AV*)dstr) = dst_ary;
10954 if (AvREAL((AV*)sstr)) {
10955 while (items-- > 0)
d2d73c3e 10956 *dst_ary++ = sv_dup_inc(*src_ary++, param);
1d7c1841
GS
10957 }
10958 else {
10959 while (items-- > 0)
d2d73c3e 10960 *dst_ary++ = sv_dup(*src_ary++, param);
1d7c1841
GS
10961 }
10962 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10963 while (items-- > 0) {
10964 *dst_ary++ = &PL_sv_undef;
10965 }
10966 }
10967 else {
f880fe2f 10968 SvPV_set(dstr, Nullch);
1d7c1841
GS
10969 AvALLOC((AV*)dstr) = (SV**)NULL;
10970 }
10971 break;
10972 case SVt_PVHV:
10973 SvANY(dstr) = new_XPVHV();
b162af07
SP
10974 SvCUR_set(dstr, SvCUR(sstr));
10975 SvLEN_set(dstr, SvLEN(sstr));
94a66813 10976 HvTOTALKEYS(dstr) = HvTOTALKEYS(sstr);
b162af07
SP
10977 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
10978 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
bfcb3514 10979 {
7423f6db 10980 HEK *hvname = 0;
bfcb3514 10981
bfcb3514
NC
10982 if (HvARRAY((HV*)sstr)) {
10983 STRLEN i = 0;
616d8c9c
AL
10984 const bool sharekeys = !!HvSHAREKEYS(sstr);
10985 XPVHV * const dxhv = (XPVHV*)SvANY(dstr);
10986 XPVHV * const sxhv = (XPVHV*)SvANY(sstr);
7b2c381c 10987 char *darray;
a1cfa1c6 10988 New(0, darray,
b79f7545
NC
10989 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1)
10990 + (SvOOK(sstr) ? sizeof(struct xpvhv_aux) : 0), char);
7b2c381c 10991 HvARRAY(dstr) = (HE**)darray;
bfcb3514 10992 while (i <= sxhv->xhv_max) {
a1cfa1c6 10993 HE *source = HvARRAY(sstr)[i];
7b2c381c 10994 HvARRAY(dstr)[i]
a1cfa1c6 10995 = source ? he_dup(source, sharekeys, param) : 0;
bfcb3514
NC
10996 ++i;
10997 }
b79f7545
NC
10998 if (SvOOK(sstr)) {
10999 struct xpvhv_aux *saux = HvAUX(sstr);
11000 struct xpvhv_aux *daux = HvAUX(dstr);
11001 /* This flag isn't copied. */
11002 /* SvOOK_on(hv) attacks the IV flags. */
11003 SvFLAGS(dstr) |= SVf_OOK;
11004
11005 hvname = saux->xhv_name;
11006 daux->xhv_name = hvname ? hek_dup(hvname, param) : hvname;
11007
11008 daux->xhv_riter = saux->xhv_riter;
11009 daux->xhv_eiter = saux->xhv_eiter
11010 ? he_dup(saux->xhv_eiter, (bool)!!HvSHAREKEYS(sstr),
11011 param) : 0;
11012 }
bfcb3514
NC
11013 }
11014 else {
11015 SvPV_set(dstr, Nullch);
bfcb3514
NC
11016 }
11017 /* Record stashes for possible cloning in Perl_clone(). */
11018 if(hvname)
11019 av_push(param->stashes, dstr);
1d7c1841 11020 }
1d7c1841
GS
11021 break;
11022 case SVt_PVFM:
11023 SvANY(dstr) = new_XPVFM();
11024 FmLINES(dstr) = FmLINES(sstr);
11025 goto dup_pvcv;
11026 /* NOTREACHED */
11027 case SVt_PVCV:
11028 SvANY(dstr) = new_XPVCV();
d2d73c3e 11029 dup_pvcv:
b162af07
SP
11030 SvCUR_set(dstr, SvCUR(sstr));
11031 SvLEN_set(dstr, SvLEN(sstr));
45977657 11032 SvIV_set(dstr, SvIVX(sstr));
9d6ce603 11033 SvNV_set(dstr, SvNVX(sstr));
b162af07
SP
11034 SvMAGIC_set(dstr, mg_dup(SvMAGIC(sstr), param));
11035 SvSTASH_set(dstr, hv_dup_inc(SvSTASH(sstr), param));
83841fad 11036 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
d2d73c3e 11037 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
1d7c1841 11038 CvSTART(dstr) = CvSTART(sstr);
b34c0dd4 11039 OP_REFCNT_LOCK;
1d7c1841 11040 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
b34c0dd4 11041 OP_REFCNT_UNLOCK;
1d7c1841
GS
11042 CvXSUB(dstr) = CvXSUB(sstr);
11043 CvXSUBANY(dstr) = CvXSUBANY(sstr);
01485f8b
DM
11044 if (CvCONST(sstr)) {
11045 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
11046 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
8f77bfdb 11047 sv_dup_inc((SV *)CvXSUBANY(sstr).any_ptr, param);
01485f8b 11048 }
b23f1a86
DM
11049 /* don't dup if copying back - CvGV isn't refcounted, so the
11050 * duped GV may never be freed. A bit of a hack! DAPM */
11051 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
11052 Nullgv : gv_dup(CvGV(sstr), param) ;
d2d73c3e
AB
11053 if (param->flags & CLONEf_COPY_STACKS) {
11054 CvDEPTH(dstr) = CvDEPTH(sstr);
11055 } else {
11056 CvDEPTH(dstr) = 0;
11057 }
dd2155a4 11058 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
7dafbf52
DM
11059 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
11060 CvOUTSIDE(dstr) =
11061 CvWEAKOUTSIDE(sstr)
11062 ? cv_dup( CvOUTSIDE(sstr), param)
11063 : cv_dup_inc(CvOUTSIDE(sstr), param);
1d7c1841 11064 CvFLAGS(dstr) = CvFLAGS(sstr);
54356c7d 11065 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
1d7c1841
GS
11066 break;
11067 default:
c803eecc 11068 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
1d7c1841
GS
11069 break;
11070 }
11071
11072 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
11073 ++PL_sv_objcount;
11074
11075 return dstr;
d2d73c3e 11076 }
1d7c1841 11077
645c22ef
DM
11078/* duplicate a context */
11079
1d7c1841 11080PERL_CONTEXT *
a8fc9800 11081Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
1d7c1841
GS
11082{
11083 PERL_CONTEXT *ncxs;
11084
11085 if (!cxs)
11086 return (PERL_CONTEXT*)NULL;
11087
11088 /* look for it in the table first */
11089 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
11090 if (ncxs)
11091 return ncxs;
11092
11093 /* create anew and remember what it is */
11094 Newz(56, ncxs, max + 1, PERL_CONTEXT);
11095 ptr_table_store(PL_ptr_table, cxs, ncxs);
11096
11097 while (ix >= 0) {
11098 PERL_CONTEXT *cx = &cxs[ix];
11099 PERL_CONTEXT *ncx = &ncxs[ix];
11100 ncx->cx_type = cx->cx_type;
11101 if (CxTYPE(cx) == CXt_SUBST) {
11102 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
11103 }
11104 else {
11105 ncx->blk_oldsp = cx->blk_oldsp;
11106 ncx->blk_oldcop = cx->blk_oldcop;
1d7c1841
GS
11107 ncx->blk_oldmarksp = cx->blk_oldmarksp;
11108 ncx->blk_oldscopesp = cx->blk_oldscopesp;
11109 ncx->blk_oldpm = cx->blk_oldpm;
11110 ncx->blk_gimme = cx->blk_gimme;
11111 switch (CxTYPE(cx)) {
11112 case CXt_SUB:
11113 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
d2d73c3e
AB
11114 ? cv_dup_inc(cx->blk_sub.cv, param)
11115 : cv_dup(cx->blk_sub.cv,param));
1d7c1841 11116 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
d2d73c3e 11117 ? av_dup_inc(cx->blk_sub.argarray, param)
1d7c1841 11118 : Nullav);
d2d73c3e 11119 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
1d7c1841
GS
11120 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
11121 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11122 ncx->blk_sub.lval = cx->blk_sub.lval;
f39bc417 11123 ncx->blk_sub.retop = cx->blk_sub.retop;
1d7c1841
GS
11124 break;
11125 case CXt_EVAL:
11126 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
11127 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
b47cad08 11128 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
1d7c1841 11129 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
d2d73c3e 11130 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
f39bc417 11131 ncx->blk_eval.retop = cx->blk_eval.retop;
1d7c1841
GS
11132 break;
11133 case CXt_LOOP:
11134 ncx->blk_loop.label = cx->blk_loop.label;
11135 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
11136 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
11137 ncx->blk_loop.next_op = cx->blk_loop.next_op;
11138 ncx->blk_loop.last_op = cx->blk_loop.last_op;
11139 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
11140 ? cx->blk_loop.iterdata
d2d73c3e 11141 : gv_dup((GV*)cx->blk_loop.iterdata, param));
f3548bdc
DM
11142 ncx->blk_loop.oldcomppad
11143 = (PAD*)ptr_table_fetch(PL_ptr_table,
11144 cx->blk_loop.oldcomppad);
d2d73c3e
AB
11145 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
11146 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
11147 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
1d7c1841
GS
11148 ncx->blk_loop.iterix = cx->blk_loop.iterix;
11149 ncx->blk_loop.itermax = cx->blk_loop.itermax;
11150 break;
11151 case CXt_FORMAT:
d2d73c3e
AB
11152 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
11153 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
11154 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
1d7c1841 11155 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
f39bc417 11156 ncx->blk_sub.retop = cx->blk_sub.retop;
1d7c1841
GS
11157 break;
11158 case CXt_BLOCK:
11159 case CXt_NULL:
11160 break;
11161 }
11162 }
11163 --ix;
11164 }
11165 return ncxs;
11166}
11167
645c22ef
DM
11168/* duplicate a stack info structure */
11169
1d7c1841 11170PERL_SI *
a8fc9800 11171Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
1d7c1841
GS
11172{
11173 PERL_SI *nsi;
11174
11175 if (!si)
11176 return (PERL_SI*)NULL;
11177
11178 /* look for it in the table first */
11179 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11180 if (nsi)
11181 return nsi;
11182
11183 /* create anew and remember what it is */
11184 Newz(56, nsi, 1, PERL_SI);
11185 ptr_table_store(PL_ptr_table, si, nsi);
11186
d2d73c3e 11187 nsi->si_stack = av_dup_inc(si->si_stack, param);
1d7c1841
GS
11188 nsi->si_cxix = si->si_cxix;
11189 nsi->si_cxmax = si->si_cxmax;
d2d73c3e 11190 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
1d7c1841 11191 nsi->si_type = si->si_type;
d2d73c3e
AB
11192 nsi->si_prev = si_dup(si->si_prev, param);
11193 nsi->si_next = si_dup(si->si_next, param);
1d7c1841
GS
11194 nsi->si_markoff = si->si_markoff;
11195
11196 return nsi;
11197}
11198
11199#define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11200#define TOPINT(ss,ix) ((ss)[ix].any_i32)
11201#define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11202#define TOPLONG(ss,ix) ((ss)[ix].any_long)
11203#define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11204#define TOPIV(ss,ix) ((ss)[ix].any_iv)
38d8b13e
HS
11205#define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11206#define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
1d7c1841
GS
11207#define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11208#define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11209#define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11210#define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11211#define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11212#define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11213
11214/* XXXXX todo */
11215#define pv_dup_inc(p) SAVEPV(p)
11216#define pv_dup(p) SAVEPV(p)
11217#define svp_dup_inc(p,pp) any_dup(p,pp)
11218
645c22ef
DM
11219/* map any object to the new equivent - either something in the
11220 * ptr table, or something in the interpreter structure
11221 */
11222
1d7c1841
GS
11223void *
11224Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
11225{
11226 void *ret;
11227
11228 if (!v)
11229 return (void*)NULL;
11230
11231 /* look for it in the table first */
11232 ret = ptr_table_fetch(PL_ptr_table, v);
11233 if (ret)
11234 return ret;
11235
11236 /* see if it is part of the interpreter structure */
11237 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
acfe0abc 11238 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
05ec9bb3 11239 else {
1d7c1841 11240 ret = v;
05ec9bb3 11241 }
1d7c1841
GS
11242
11243 return ret;
11244}
11245
645c22ef
DM
11246/* duplicate the save stack */
11247
1d7c1841 11248ANY *
a8fc9800 11249Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
1d7c1841
GS
11250{
11251 ANY *ss = proto_perl->Tsavestack;
11252 I32 ix = proto_perl->Tsavestack_ix;
11253 I32 max = proto_perl->Tsavestack_max;
11254 ANY *nss;
11255 SV *sv;
11256 GV *gv;
11257 AV *av;
11258 HV *hv;
11259 void* ptr;
11260 int intval;
11261 long longval;
11262 GP *gp;
11263 IV iv;
c4e33207 11264 char *c = NULL;
1d7c1841 11265 void (*dptr) (void*);
acfe0abc 11266 void (*dxptr) (pTHX_ void*);
e977893f 11267 OP *o;
3c0f78ca
JH
11268 /* Unions for circumventing strict ANSI C89 casting rules. */
11269 union { void *vptr; void (*dptr)(void*); } u1, u2;
11270 union { void *vptr; void (*dxptr)(pTHX_ void*); } u3, u4;
1d7c1841
GS
11271
11272 Newz(54, nss, max, ANY);
11273
11274 while (ix > 0) {
b464bac0 11275 I32 i = POPINT(ss,ix);
1d7c1841
GS
11276 TOPINT(nss,ix) = i;
11277 switch (i) {
11278 case SAVEt_ITEM: /* normal string */
11279 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 11280 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841 11281 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 11282 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841
GS
11283 break;
11284 case SAVEt_SV: /* scalar reference */
11285 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 11286 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841 11287 gv = (GV*)POPPTR(ss,ix);
d2d73c3e 11288 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
1d7c1841 11289 break;
f4dd75d9
GS
11290 case SAVEt_GENERIC_PVREF: /* generic char* */
11291 c = (char*)POPPTR(ss,ix);
11292 TOPPTR(nss,ix) = pv_dup(c);
11293 ptr = POPPTR(ss,ix);
11294 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11295 break;
05ec9bb3
NIS
11296 case SAVEt_SHARED_PVREF: /* char* in shared space */
11297 c = (char*)POPPTR(ss,ix);
11298 TOPPTR(nss,ix) = savesharedpv(c);
11299 ptr = POPPTR(ss,ix);
11300 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11301 break;
1d7c1841
GS
11302 case SAVEt_GENERIC_SVREF: /* generic sv */
11303 case SAVEt_SVREF: /* scalar reference */
11304 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 11305 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841
GS
11306 ptr = POPPTR(ss,ix);
11307 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11308 break;
11309 case SAVEt_AV: /* array reference */
11310 av = (AV*)POPPTR(ss,ix);
d2d73c3e 11311 TOPPTR(nss,ix) = av_dup_inc(av, param);
1d7c1841 11312 gv = (GV*)POPPTR(ss,ix);
d2d73c3e 11313 TOPPTR(nss,ix) = gv_dup(gv, param);
1d7c1841
GS
11314 break;
11315 case SAVEt_HV: /* hash reference */
11316 hv = (HV*)POPPTR(ss,ix);
d2d73c3e 11317 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
1d7c1841 11318 gv = (GV*)POPPTR(ss,ix);
d2d73c3e 11319 TOPPTR(nss,ix) = gv_dup(gv, param);
1d7c1841
GS
11320 break;
11321 case SAVEt_INT: /* int reference */
11322 ptr = POPPTR(ss,ix);
11323 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11324 intval = (int)POPINT(ss,ix);
11325 TOPINT(nss,ix) = intval;
11326 break;
11327 case SAVEt_LONG: /* long reference */
11328 ptr = POPPTR(ss,ix);
11329 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11330 longval = (long)POPLONG(ss,ix);
11331 TOPLONG(nss,ix) = longval;
11332 break;
11333 case SAVEt_I32: /* I32 reference */
11334 case SAVEt_I16: /* I16 reference */
11335 case SAVEt_I8: /* I8 reference */
11336 ptr = POPPTR(ss,ix);
11337 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11338 i = POPINT(ss,ix);
11339 TOPINT(nss,ix) = i;
11340 break;
11341 case SAVEt_IV: /* IV reference */
11342 ptr = POPPTR(ss,ix);
11343 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11344 iv = POPIV(ss,ix);
11345 TOPIV(nss,ix) = iv;
11346 break;
11347 case SAVEt_SPTR: /* SV* reference */
11348 ptr = POPPTR(ss,ix);
11349 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11350 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 11351 TOPPTR(nss,ix) = sv_dup(sv, param);
1d7c1841
GS
11352 break;
11353 case SAVEt_VPTR: /* random* reference */
11354 ptr = POPPTR(ss,ix);
11355 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11356 ptr = POPPTR(ss,ix);
11357 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11358 break;
11359 case SAVEt_PPTR: /* char* reference */
11360 ptr = POPPTR(ss,ix);
11361 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11362 c = (char*)POPPTR(ss,ix);
11363 TOPPTR(nss,ix) = pv_dup(c);
11364 break;
11365 case SAVEt_HPTR: /* HV* reference */
11366 ptr = POPPTR(ss,ix);
11367 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11368 hv = (HV*)POPPTR(ss,ix);
d2d73c3e 11369 TOPPTR(nss,ix) = hv_dup(hv, param);
1d7c1841
GS
11370 break;
11371 case SAVEt_APTR: /* AV* reference */
11372 ptr = POPPTR(ss,ix);
11373 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11374 av = (AV*)POPPTR(ss,ix);
d2d73c3e 11375 TOPPTR(nss,ix) = av_dup(av, param);
1d7c1841
GS
11376 break;
11377 case SAVEt_NSTAB:
11378 gv = (GV*)POPPTR(ss,ix);
d2d73c3e 11379 TOPPTR(nss,ix) = gv_dup(gv, param);
1d7c1841
GS
11380 break;
11381 case SAVEt_GP: /* scalar reference */
11382 gp = (GP*)POPPTR(ss,ix);
d2d73c3e 11383 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
1d7c1841
GS
11384 (void)GpREFCNT_inc(gp);
11385 gv = (GV*)POPPTR(ss,ix);
2ed3c8fc 11386 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
1d7c1841
GS
11387 c = (char*)POPPTR(ss,ix);
11388 TOPPTR(nss,ix) = pv_dup(c);
11389 iv = POPIV(ss,ix);
11390 TOPIV(nss,ix) = iv;
11391 iv = POPIV(ss,ix);
11392 TOPIV(nss,ix) = iv;
11393 break;
11394 case SAVEt_FREESV:
26d9b02f 11395 case SAVEt_MORTALIZESV:
1d7c1841 11396 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 11397 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841
GS
11398 break;
11399 case SAVEt_FREEOP:
11400 ptr = POPPTR(ss,ix);
11401 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11402 /* these are assumed to be refcounted properly */
11403 switch (((OP*)ptr)->op_type) {
11404 case OP_LEAVESUB:
11405 case OP_LEAVESUBLV:
11406 case OP_LEAVEEVAL:
11407 case OP_LEAVE:
11408 case OP_SCOPE:
11409 case OP_LEAVEWRITE:
e977893f
GS
11410 TOPPTR(nss,ix) = ptr;
11411 o = (OP*)ptr;
11412 OpREFCNT_inc(o);
1d7c1841
GS
11413 break;
11414 default:
11415 TOPPTR(nss,ix) = Nullop;
11416 break;
11417 }
11418 }
11419 else
11420 TOPPTR(nss,ix) = Nullop;
11421 break;
11422 case SAVEt_FREEPV:
11423 c = (char*)POPPTR(ss,ix);
11424 TOPPTR(nss,ix) = pv_dup_inc(c);
11425 break;
11426 case SAVEt_CLEARSV:
11427 longval = POPLONG(ss,ix);
11428 TOPLONG(nss,ix) = longval;
11429 break;
11430 case SAVEt_DELETE:
11431 hv = (HV*)POPPTR(ss,ix);
d2d73c3e 11432 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
1d7c1841
GS
11433 c = (char*)POPPTR(ss,ix);
11434 TOPPTR(nss,ix) = pv_dup_inc(c);
11435 i = POPINT(ss,ix);
11436 TOPINT(nss,ix) = i;
11437 break;
11438 case SAVEt_DESTRUCTOR:
11439 ptr = POPPTR(ss,ix);
11440 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11441 dptr = POPDPTR(ss,ix);
3c0f78ca
JH
11442 u1.dptr = dptr;
11443 u2.vptr = any_dup(u1.vptr, proto_perl);
11444 TOPDPTR(nss,ix) = u2.dptr;
1d7c1841
GS
11445 break;
11446 case SAVEt_DESTRUCTOR_X:
11447 ptr = POPPTR(ss,ix);
11448 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11449 dxptr = POPDXPTR(ss,ix);
3c0f78ca
JH
11450 u3.dxptr = dxptr;
11451 u4.vptr = any_dup(u3.vptr, proto_perl);;
11452 TOPDXPTR(nss,ix) = u4.dxptr;
1d7c1841
GS
11453 break;
11454 case SAVEt_REGCONTEXT:
11455 case SAVEt_ALLOC:
11456 i = POPINT(ss,ix);
11457 TOPINT(nss,ix) = i;
11458 ix -= i;
11459 break;
11460 case SAVEt_STACK_POS: /* Position on Perl stack */
11461 i = POPINT(ss,ix);
11462 TOPINT(nss,ix) = i;
11463 break;
11464 case SAVEt_AELEM: /* array element */
11465 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 11466 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841
GS
11467 i = POPINT(ss,ix);
11468 TOPINT(nss,ix) = i;
11469 av = (AV*)POPPTR(ss,ix);
d2d73c3e 11470 TOPPTR(nss,ix) = av_dup_inc(av, param);
1d7c1841
GS
11471 break;
11472 case SAVEt_HELEM: /* hash element */
11473 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 11474 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841 11475 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 11476 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841 11477 hv = (HV*)POPPTR(ss,ix);
d2d73c3e 11478 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
1d7c1841
GS
11479 break;
11480 case SAVEt_OP:
11481 ptr = POPPTR(ss,ix);
11482 TOPPTR(nss,ix) = ptr;
11483 break;
11484 case SAVEt_HINTS:
11485 i = POPINT(ss,ix);
11486 TOPINT(nss,ix) = i;
11487 break;
c4410b1b
GS
11488 case SAVEt_COMPPAD:
11489 av = (AV*)POPPTR(ss,ix);
58ed4fbe 11490 TOPPTR(nss,ix) = av_dup(av, param);
c4410b1b 11491 break;
c3564e5c
GS
11492 case SAVEt_PADSV:
11493 longval = (long)POPLONG(ss,ix);
11494 TOPLONG(nss,ix) = longval;
11495 ptr = POPPTR(ss,ix);
11496 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11497 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 11498 TOPPTR(nss,ix) = sv_dup(sv, param);
c3564e5c 11499 break;
a1bb4754 11500 case SAVEt_BOOL:
38d8b13e 11501 ptr = POPPTR(ss,ix);
b9609c01 11502 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
38d8b13e 11503 longval = (long)POPBOOL(ss,ix);
b9609c01 11504 TOPBOOL(nss,ix) = (bool)longval;
a1bb4754 11505 break;
8bd2680e
MHM
11506 case SAVEt_SET_SVFLAGS:
11507 i = POPINT(ss,ix);
11508 TOPINT(nss,ix) = i;
11509 i = POPINT(ss,ix);
11510 TOPINT(nss,ix) = i;
11511 sv = (SV*)POPPTR(ss,ix);
11512 TOPPTR(nss,ix) = sv_dup(sv, param);
11513 break;
1d7c1841
GS
11514 default:
11515 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11516 }
11517 }
11518
11519 return nss;
11520}
11521
9660f481
DM
11522
11523/* if sv is a stash, call $class->CLONE_SKIP(), and set the SVphv_CLONEABLE
11524 * flag to the result. This is done for each stash before cloning starts,
11525 * so we know which stashes want their objects cloned */
11526
11527static void
11528do_mark_cloneable_stash(pTHX_ SV *sv)
11529{
84bda14a 11530 const HEK *hvname = HvNAME_HEK((HV*)sv);
bfcb3514 11531 if (hvname) {
9660f481
DM
11532 GV* cloner = gv_fetchmethod_autoload((HV*)sv, "CLONE_SKIP", 0);
11533 SvFLAGS(sv) |= SVphv_CLONEABLE; /* clone objects by default */
11534 if (cloner && GvCV(cloner)) {
11535 dSP;
11536 UV status;
11537
11538 ENTER;
11539 SAVETMPS;
11540 PUSHMARK(SP);
84bda14a 11541 XPUSHs(sv_2mortal(newSVhek(hvname)));
9660f481
DM
11542 PUTBACK;
11543 call_sv((SV*)GvCV(cloner), G_SCALAR);
11544 SPAGAIN;
11545 status = POPu;
11546 PUTBACK;
11547 FREETMPS;
11548 LEAVE;
11549 if (status)
11550 SvFLAGS(sv) &= ~SVphv_CLONEABLE;
11551 }
11552 }
11553}
11554
11555
11556
645c22ef
DM
11557/*
11558=for apidoc perl_clone
11559
11560Create and return a new interpreter by cloning the current one.
11561
4be49ee6 11562perl_clone takes these flags as parameters:
6a78b4db 11563
7a5fa8a2
NIS
11564CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11565without it we only clone the data and zero the stacks,
11566with it we copy the stacks and the new perl interpreter is
11567ready to run at the exact same point as the previous one.
11568The pseudo-fork code uses COPY_STACKS while the
6a78b4db
AB
11569threads->new doesn't.
11570
11571CLONEf_KEEP_PTR_TABLE
7a5fa8a2
NIS
11572perl_clone keeps a ptr_table with the pointer of the old
11573variable as a key and the new variable as a value,
11574this allows it to check if something has been cloned and not
11575clone it again but rather just use the value and increase the
11576refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11577the ptr_table using the function
11578C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11579reason to keep it around is if you want to dup some of your own
11580variable who are outside the graph perl scans, example of this
6a78b4db
AB
11581code is in threads.xs create
11582
11583CLONEf_CLONE_HOST
7a5fa8a2
NIS
11584This is a win32 thing, it is ignored on unix, it tells perls
11585win32host code (which is c++) to clone itself, this is needed on
11586win32 if you want to run two threads at the same time,
11587if you just want to do some stuff in a separate perl interpreter
11588and then throw it away and return to the original one,
6a78b4db
AB
11589you don't need to do anything.
11590
645c22ef
DM
11591=cut
11592*/
11593
11594/* XXX the above needs expanding by someone who actually understands it ! */
3fc56081
NK
11595EXTERN_C PerlInterpreter *
11596perl_clone_host(PerlInterpreter* proto_perl, UV flags);
645c22ef 11597
1d7c1841
GS
11598PerlInterpreter *
11599perl_clone(PerlInterpreter *proto_perl, UV flags)
11600{
27da23d5 11601 dVAR;
1d7c1841 11602#ifdef PERL_IMPLICIT_SYS
c43294b8
AB
11603
11604 /* perlhost.h so we need to call into it
11605 to clone the host, CPerlHost should have a c interface, sky */
11606
11607 if (flags & CLONEf_CLONE_HOST) {
11608 return perl_clone_host(proto_perl,flags);
11609 }
11610 return perl_clone_using(proto_perl, flags,
1d7c1841
GS
11611 proto_perl->IMem,
11612 proto_perl->IMemShared,
11613 proto_perl->IMemParse,
11614 proto_perl->IEnv,
11615 proto_perl->IStdIO,
11616 proto_perl->ILIO,
11617 proto_perl->IDir,
11618 proto_perl->ISock,
11619 proto_perl->IProc);
11620}
11621
11622PerlInterpreter *
11623perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11624 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11625 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11626 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11627 struct IPerlDir* ipD, struct IPerlSock* ipS,
11628 struct IPerlProc* ipP)
11629{
11630 /* XXX many of the string copies here can be optimized if they're
11631 * constants; they need to be allocated as common memory and just
11632 * their pointers copied. */
11633
64aa0685
GS
11634 CLONE_PARAMS clone_params;
11635 CLONE_PARAMS* param = &clone_params;
d2d73c3e 11636
1d7c1841 11637 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
9660f481
DM
11638 /* for each stash, determine whether its objects should be cloned */
11639 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
ba869deb 11640 PERL_SET_THX(my_perl);
1d7c1841 11641
acfe0abc 11642# ifdef DEBUGGING
a4530404 11643 Poison(my_perl, 1, PerlInterpreter);
fd0854ff 11644 PL_op = Nullop;
c008732b 11645 PL_curcop = (COP *)Nullop;
1d7c1841
GS
11646 PL_markstack = 0;
11647 PL_scopestack = 0;
11648 PL_savestack = 0;
22f7c9c9
JH
11649 PL_savestack_ix = 0;
11650 PL_savestack_max = -1;
66fe0623 11651 PL_sig_pending = 0;
25596c82 11652 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
acfe0abc 11653# else /* !DEBUGGING */
1d7c1841 11654 Zero(my_perl, 1, PerlInterpreter);
acfe0abc 11655# endif /* DEBUGGING */
1d7c1841
GS
11656
11657 /* host pointers */
11658 PL_Mem = ipM;
11659 PL_MemShared = ipMS;
11660 PL_MemParse = ipMP;
11661 PL_Env = ipE;
11662 PL_StdIO = ipStd;
11663 PL_LIO = ipLIO;
11664 PL_Dir = ipD;
11665 PL_Sock = ipS;
11666 PL_Proc = ipP;
1d7c1841
GS
11667#else /* !PERL_IMPLICIT_SYS */
11668 IV i;
64aa0685
GS
11669 CLONE_PARAMS clone_params;
11670 CLONE_PARAMS* param = &clone_params;
1d7c1841 11671 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
9660f481
DM
11672 /* for each stash, determine whether its objects should be cloned */
11673 S_visit(proto_perl, do_mark_cloneable_stash, SVt_PVHV, SVTYPEMASK);
ba869deb 11674 PERL_SET_THX(my_perl);
1d7c1841
GS
11675
11676# ifdef DEBUGGING
a4530404 11677 Poison(my_perl, 1, PerlInterpreter);
fd0854ff 11678 PL_op = Nullop;
c008732b 11679 PL_curcop = (COP *)Nullop;
1d7c1841
GS
11680 PL_markstack = 0;
11681 PL_scopestack = 0;
11682 PL_savestack = 0;
22f7c9c9
JH
11683 PL_savestack_ix = 0;
11684 PL_savestack_max = -1;
66fe0623 11685 PL_sig_pending = 0;
25596c82 11686 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
1d7c1841
GS
11687# else /* !DEBUGGING */
11688 Zero(my_perl, 1, PerlInterpreter);
11689# endif /* DEBUGGING */
11690#endif /* PERL_IMPLICIT_SYS */
83236556 11691 param->flags = flags;
59b40662 11692 param->proto_perl = proto_perl;
1d7c1841
GS
11693
11694 /* arena roots */
612f20c3 11695 PL_xnv_arenaroot = NULL;
1d7c1841 11696 PL_xnv_root = NULL;
612f20c3 11697 PL_xpv_arenaroot = NULL;
1d7c1841 11698 PL_xpv_root = NULL;
612f20c3 11699 PL_xpviv_arenaroot = NULL;
1d7c1841 11700 PL_xpviv_root = NULL;
612f20c3 11701 PL_xpvnv_arenaroot = NULL;
1d7c1841 11702 PL_xpvnv_root = NULL;
612f20c3 11703 PL_xpvcv_arenaroot = NULL;
1d7c1841 11704 PL_xpvcv_root = NULL;
612f20c3 11705 PL_xpvav_arenaroot = NULL;
1d7c1841 11706 PL_xpvav_root = NULL;
612f20c3 11707 PL_xpvhv_arenaroot = NULL;
1d7c1841 11708 PL_xpvhv_root = NULL;
612f20c3 11709 PL_xpvmg_arenaroot = NULL;
1d7c1841 11710 PL_xpvmg_root = NULL;
7552b40b
DM
11711 PL_xpvgv_arenaroot = NULL;
11712 PL_xpvgv_root = NULL;
612f20c3 11713 PL_xpvlv_arenaroot = NULL;
1d7c1841 11714 PL_xpvlv_root = NULL;
612f20c3 11715 PL_xpvbm_arenaroot = NULL;
1d7c1841 11716 PL_xpvbm_root = NULL;
612f20c3 11717 PL_he_arenaroot = NULL;
1d7c1841 11718 PL_he_root = NULL;
892b45be 11719#if defined(USE_ITHREADS)
32e691d0
NC
11720 PL_pte_arenaroot = NULL;
11721 PL_pte_root = NULL;
892b45be 11722#endif
1d7c1841
GS
11723 PL_nice_chunk = NULL;
11724 PL_nice_chunk_size = 0;
11725 PL_sv_count = 0;
11726 PL_sv_objcount = 0;
11727 PL_sv_root = Nullsv;
11728 PL_sv_arenaroot = Nullsv;
11729
11730 PL_debug = proto_perl->Idebug;
11731
8df990a8
NC
11732 PL_hash_seed = proto_perl->Ihash_seed;
11733 PL_rehash_seed = proto_perl->Irehash_seed;
11734
e5dd39fc 11735#ifdef USE_REENTRANT_API
68853529
SB
11736 /* XXX: things like -Dm will segfault here in perlio, but doing
11737 * PERL_SET_CONTEXT(proto_perl);
11738 * breaks too many other things
11739 */
59bd0823 11740 Perl_reentrant_init(aTHX);
e5dd39fc
AB
11741#endif
11742
1d7c1841
GS
11743 /* create SV map for pointer relocation */
11744 PL_ptr_table = ptr_table_new();
c21d1a0f
NC
11745 /* and one for finding shared hash keys quickly */
11746 PL_shared_hek_table = ptr_table_new();
1d7c1841
GS
11747
11748 /* initialize these special pointers as early as possible */
11749 SvANY(&PL_sv_undef) = NULL;
11750 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11751 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11752 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11753
1d7c1841 11754 SvANY(&PL_sv_no) = new_XPVNV();
1d7c1841 11755 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
0309f36e
NC
11756 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11757 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
f880fe2f 11758 SvPV_set(&PL_sv_no, SAVEPVN(PL_No, 0));
b162af07
SP
11759 SvCUR_set(&PL_sv_no, 0);
11760 SvLEN_set(&PL_sv_no, 1);
45977657 11761 SvIV_set(&PL_sv_no, 0);
9d6ce603 11762 SvNV_set(&PL_sv_no, 0);
1d7c1841
GS
11763 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11764
1d7c1841 11765 SvANY(&PL_sv_yes) = new_XPVNV();
1d7c1841 11766 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
0309f36e
NC
11767 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11768 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
f880fe2f 11769 SvPV_set(&PL_sv_yes, SAVEPVN(PL_Yes, 1));
b162af07
SP
11770 SvCUR_set(&PL_sv_yes, 1);
11771 SvLEN_set(&PL_sv_yes, 2);
45977657 11772 SvIV_set(&PL_sv_yes, 1);
9d6ce603 11773 SvNV_set(&PL_sv_yes, 1);
1d7c1841
GS
11774 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11775
05ec9bb3 11776 /* create (a non-shared!) shared string table */
1d7c1841
GS
11777 PL_strtab = newHV();
11778 HvSHAREKEYS_off(PL_strtab);
c4a9c09d 11779 hv_ksplit(PL_strtab, HvTOTALKEYS(proto_perl->Istrtab));
1d7c1841
GS
11780 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11781
05ec9bb3
NIS
11782 PL_compiling = proto_perl->Icompiling;
11783
11784 /* These two PVs will be free'd special way so must set them same way op.c does */
11785 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11786 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11787
11788 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11789 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11790
1d7c1841
GS
11791 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11792 if (!specialWARN(PL_compiling.cop_warnings))
d2d73c3e 11793 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
ac27b0f5 11794 if (!specialCopIO(PL_compiling.cop_io))
d2d73c3e 11795 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
1d7c1841
GS
11796 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11797
11798 /* pseudo environmental stuff */
11799 PL_origargc = proto_perl->Iorigargc;
e2975953 11800 PL_origargv = proto_perl->Iorigargv;
d2d73c3e 11801
d2d73c3e
AB
11802 param->stashes = newAV(); /* Setup array of objects to call clone on */
11803
a1ea730d 11804#ifdef PERLIO_LAYERS
3a1ee7e8
NIS
11805 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11806 PerlIO_clone(aTHX_ proto_perl, param);
a1ea730d 11807#endif
d2d73c3e
AB
11808
11809 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11810 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11811 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
1d7c1841 11812 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
d2d73c3e
AB
11813 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11814 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
1d7c1841
GS
11815
11816 /* switches */
11817 PL_minus_c = proto_perl->Iminus_c;
d2d73c3e 11818 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
1d7c1841
GS
11819 PL_localpatches = proto_perl->Ilocalpatches;
11820 PL_splitstr = proto_perl->Isplitstr;
11821 PL_preprocess = proto_perl->Ipreprocess;
11822 PL_minus_n = proto_perl->Iminus_n;
11823 PL_minus_p = proto_perl->Iminus_p;
11824 PL_minus_l = proto_perl->Iminus_l;
11825 PL_minus_a = proto_perl->Iminus_a;
11826 PL_minus_F = proto_perl->Iminus_F;
11827 PL_doswitches = proto_perl->Idoswitches;
11828 PL_dowarn = proto_perl->Idowarn;
11829 PL_doextract = proto_perl->Idoextract;
11830 PL_sawampersand = proto_perl->Isawampersand;
11831 PL_unsafe = proto_perl->Iunsafe;
11832 PL_inplace = SAVEPV(proto_perl->Iinplace);
d2d73c3e 11833 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
1d7c1841
GS
11834 PL_perldb = proto_perl->Iperldb;
11835 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
1cbb0781 11836 PL_exit_flags = proto_perl->Iexit_flags;
1d7c1841
GS
11837
11838 /* magical thingies */
11839 /* XXX time(&PL_basetime) when asked for? */
11840 PL_basetime = proto_perl->Ibasetime;
d2d73c3e 11841 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
1d7c1841
GS
11842
11843 PL_maxsysfd = proto_perl->Imaxsysfd;
11844 PL_multiline = proto_perl->Imultiline;
11845 PL_statusvalue = proto_perl->Istatusvalue;
11846#ifdef VMS
11847 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11848#endif
0a378802 11849 PL_encoding = sv_dup(proto_perl->Iencoding, param);
1d7c1841 11850
4a4c6fe3 11851 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
1f483ca1
JH
11852 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11853 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
4a4c6fe3 11854
d2f185dc
AMS
11855 /* Clone the regex array */
11856 PL_regex_padav = newAV();
11857 {
a3b680e6 11858 const I32 len = av_len((AV*)proto_perl->Iregex_padav);
d2f185dc 11859 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
b464bac0 11860 IV i;
0f95fc41
AB
11861 av_push(PL_regex_padav,
11862 sv_dup_inc(regexen[0],param));
11863 for(i = 1; i <= len; i++) {
11864 if(SvREPADTMP(regexen[i])) {
11865 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
8cf8f3d1 11866 } else {
0f95fc41
AB
11867 av_push(PL_regex_padav,
11868 SvREFCNT_inc(
8cf8f3d1 11869 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
cbfa9890 11870 SvIVX(regexen[i])), param)))
0f95fc41
AB
11871 ));
11872 }
d2f185dc
AMS
11873 }
11874 }
11875 PL_regex_pad = AvARRAY(PL_regex_padav);
1fcf4c12 11876
1d7c1841 11877 /* shortcuts to various I/O objects */
d2d73c3e
AB
11878 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11879 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11880 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11881 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11882 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11883 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
1d7c1841
GS
11884
11885 /* shortcuts to regexp stuff */
d2d73c3e 11886 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
1d7c1841
GS
11887
11888 /* shortcuts to misc objects */
d2d73c3e 11889 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
1d7c1841
GS
11890
11891 /* shortcuts to debugging objects */
d2d73c3e
AB
11892 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11893 PL_DBline = gv_dup(proto_perl->IDBline, param);
11894 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11895 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11896 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11897 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
06492da6 11898 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
d2d73c3e
AB
11899 PL_lineary = av_dup(proto_perl->Ilineary, param);
11900 PL_dbargs = av_dup(proto_perl->Idbargs, param);
1d7c1841
GS
11901
11902 /* symbol tables */
d2d73c3e
AB
11903 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11904 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
d2d73c3e
AB
11905 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11906 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11907 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11908
11909 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
ee1c5a4e 11910 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
ece599bd 11911 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
d2d73c3e
AB
11912 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11913 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11914 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
1d7c1841
GS
11915
11916 PL_sub_generation = proto_perl->Isub_generation;
11917
11918 /* funky return mechanisms */
11919 PL_forkprocess = proto_perl->Iforkprocess;
11920
11921 /* subprocess state */
d2d73c3e 11922 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
1d7c1841
GS
11923
11924 /* internal state */
11925 PL_tainting = proto_perl->Itainting;
7135f00b 11926 PL_taint_warn = proto_perl->Itaint_warn;
1d7c1841
GS
11927 PL_maxo = proto_perl->Imaxo;
11928 if (proto_perl->Iop_mask)
11929 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11930 else
11931 PL_op_mask = Nullch;
06492da6 11932 /* PL_asserting = proto_perl->Iasserting; */
1d7c1841
GS
11933
11934 /* current interpreter roots */
d2d73c3e 11935 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
1d7c1841
GS
11936 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11937 PL_main_start = proto_perl->Imain_start;
e977893f 11938 PL_eval_root = proto_perl->Ieval_root;
1d7c1841
GS
11939 PL_eval_start = proto_perl->Ieval_start;
11940
11941 /* runtime control stuff */
11942 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11943 PL_copline = proto_perl->Icopline;
11944
11945 PL_filemode = proto_perl->Ifilemode;
11946 PL_lastfd = proto_perl->Ilastfd;
11947 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11948 PL_Argv = NULL;
11949 PL_Cmd = Nullch;
11950 PL_gensym = proto_perl->Igensym;
11951 PL_preambled = proto_perl->Ipreambled;
d2d73c3e 11952 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
1d7c1841
GS
11953 PL_laststatval = proto_perl->Ilaststatval;
11954 PL_laststype = proto_perl->Ilaststype;
11955 PL_mess_sv = Nullsv;
11956
d2d73c3e 11957 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
1d7c1841
GS
11958 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11959
11960 /* interpreter atexit processing */
11961 PL_exitlistlen = proto_perl->Iexitlistlen;
11962 if (PL_exitlistlen) {
11963 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11964 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11965 }
11966 else
11967 PL_exitlist = (PerlExitListEntry*)NULL;
d2d73c3e 11968 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
19e8ce8e
AB
11969 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11970 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
1d7c1841
GS
11971
11972 PL_profiledata = NULL;
a8fc9800 11973 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
1d7c1841 11974 /* PL_rsfp_filters entries have fake IoDIRP() */
d2d73c3e 11975 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
1d7c1841 11976
d2d73c3e 11977 PL_compcv = cv_dup(proto_perl->Icompcv, param);
dd2155a4
DM
11978
11979 PAD_CLONE_VARS(proto_perl, param);
1d7c1841
GS
11980
11981#ifdef HAVE_INTERP_INTERN
11982 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11983#endif
11984
11985 /* more statics moved here */
11986 PL_generation = proto_perl->Igeneration;
d2d73c3e 11987 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
1d7c1841
GS
11988
11989 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11990 PL_in_clean_all = proto_perl->Iin_clean_all;
11991
11992 PL_uid = proto_perl->Iuid;
11993 PL_euid = proto_perl->Ieuid;
11994 PL_gid = proto_perl->Igid;
11995 PL_egid = proto_perl->Iegid;
11996 PL_nomemok = proto_perl->Inomemok;
11997 PL_an = proto_perl->Ian;
1d7c1841
GS
11998 PL_evalseq = proto_perl->Ievalseq;
11999 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
12000 PL_origalen = proto_perl->Iorigalen;
12001 PL_pidstatus = newHV(); /* XXX flag for cloning? */
12002 PL_osname = SAVEPV(proto_perl->Iosname);
5c728af0 12003 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
1d7c1841
GS
12004 PL_sighandlerp = proto_perl->Isighandlerp;
12005
12006
12007 PL_runops = proto_perl->Irunops;
12008
12009 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
12010
12011#ifdef CSH
12012 PL_cshlen = proto_perl->Icshlen;
74f1b2b8 12013 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
1d7c1841
GS
12014#endif
12015
12016 PL_lex_state = proto_perl->Ilex_state;
12017 PL_lex_defer = proto_perl->Ilex_defer;
12018 PL_lex_expect = proto_perl->Ilex_expect;
12019 PL_lex_formbrack = proto_perl->Ilex_formbrack;
12020 PL_lex_dojoin = proto_perl->Ilex_dojoin;
12021 PL_lex_starts = proto_perl->Ilex_starts;
d2d73c3e
AB
12022 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
12023 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
1d7c1841
GS
12024 PL_lex_op = proto_perl->Ilex_op;
12025 PL_lex_inpat = proto_perl->Ilex_inpat;
12026 PL_lex_inwhat = proto_perl->Ilex_inwhat;
12027 PL_lex_brackets = proto_perl->Ilex_brackets;
12028 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
12029 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
12030 PL_lex_casemods = proto_perl->Ilex_casemods;
12031 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
12032 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
12033
12034 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
12035 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
12036 PL_nexttoke = proto_perl->Inexttoke;
12037
1d773130
TB
12038 /* XXX This is probably masking the deeper issue of why
12039 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
12040 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
12041 * (A little debugging with a watchpoint on it may help.)
12042 */
389edf32
TB
12043 if (SvANY(proto_perl->Ilinestr)) {
12044 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
3f7c398e 12045 i = proto_perl->Ibufptr - SvPVX_const(proto_perl->Ilinestr);
389edf32 12046 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
3f7c398e 12047 i = proto_perl->Ioldbufptr - SvPVX_const(proto_perl->Ilinestr);
389edf32 12048 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
3f7c398e 12049 i = proto_perl->Ioldoldbufptr - SvPVX_const(proto_perl->Ilinestr);
389edf32 12050 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
3f7c398e 12051 i = proto_perl->Ilinestart - SvPVX_const(proto_perl->Ilinestr);
389edf32
TB
12052 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12053 }
12054 else {
12055 PL_linestr = NEWSV(65,79);
12056 sv_upgrade(PL_linestr,SVt_PVIV);
12057 sv_setpvn(PL_linestr,"",0);
12058 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
12059 }
1d7c1841 12060 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
1d7c1841
GS
12061 PL_pending_ident = proto_perl->Ipending_ident;
12062 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
12063
12064 PL_expect = proto_perl->Iexpect;
12065
12066 PL_multi_start = proto_perl->Imulti_start;
12067 PL_multi_end = proto_perl->Imulti_end;
12068 PL_multi_open = proto_perl->Imulti_open;
12069 PL_multi_close = proto_perl->Imulti_close;
12070
12071 PL_error_count = proto_perl->Ierror_count;
12072 PL_subline = proto_perl->Isubline;
d2d73c3e 12073 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
1d7c1841 12074
1d773130 12075 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
389edf32 12076 if (SvANY(proto_perl->Ilinestr)) {
3f7c398e 12077 i = proto_perl->Ilast_uni - SvPVX_const(proto_perl->Ilinestr);
389edf32 12078 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
3f7c398e 12079 i = proto_perl->Ilast_lop - SvPVX_const(proto_perl->Ilinestr);
389edf32
TB
12080 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
12081 PL_last_lop_op = proto_perl->Ilast_lop_op;
12082 }
12083 else {
12084 PL_last_uni = SvPVX(PL_linestr);
12085 PL_last_lop = SvPVX(PL_linestr);
12086 PL_last_lop_op = 0;
12087 }
1d7c1841 12088 PL_in_my = proto_perl->Iin_my;
d2d73c3e 12089 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
1d7c1841
GS
12090#ifdef FCRYPT
12091 PL_cryptseen = proto_perl->Icryptseen;
12092#endif
12093
12094 PL_hints = proto_perl->Ihints;
12095
12096 PL_amagic_generation = proto_perl->Iamagic_generation;
12097
12098#ifdef USE_LOCALE_COLLATE
12099 PL_collation_ix = proto_perl->Icollation_ix;
12100 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
12101 PL_collation_standard = proto_perl->Icollation_standard;
12102 PL_collxfrm_base = proto_perl->Icollxfrm_base;
12103 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
12104#endif /* USE_LOCALE_COLLATE */
12105
12106#ifdef USE_LOCALE_NUMERIC
12107 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
12108 PL_numeric_standard = proto_perl->Inumeric_standard;
12109 PL_numeric_local = proto_perl->Inumeric_local;
d2d73c3e 12110 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
1d7c1841
GS
12111#endif /* !USE_LOCALE_NUMERIC */
12112
12113 /* utf8 character classes */
d2d73c3e
AB
12114 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
12115 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
12116 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
12117 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
12118 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
12119 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
12120 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
12121 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
12122 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
12123 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
12124 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
12125 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
12126 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
12127 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
12128 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
12129 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
12130 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
b4e400f9 12131 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
82686b01
JH
12132 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
12133 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
1d7c1841 12134
6c3182a5 12135 /* Did the locale setup indicate UTF-8? */
9769094f 12136 PL_utf8locale = proto_perl->Iutf8locale;
6c3182a5
JH
12137 /* Unicode features (see perlrun/-C) */
12138 PL_unicode = proto_perl->Iunicode;
12139
12140 /* Pre-5.8 signals control */
12141 PL_signals = proto_perl->Isignals;
12142
12143 /* times() ticks per second */
12144 PL_clocktick = proto_perl->Iclocktick;
12145
12146 /* Recursion stopper for PerlIO_find_layer */
12147 PL_in_load_module = proto_perl->Iin_load_module;
12148
12149 /* sort() routine */
12150 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
12151
57c6e6d2
JH
12152 /* Not really needed/useful since the reenrant_retint is "volatile",
12153 * but do it for consistency's sake. */
12154 PL_reentrant_retint = proto_perl->Ireentrant_retint;
12155
15a5279a
JH
12156 /* Hooks to shared SVs and locks. */
12157 PL_sharehook = proto_perl->Isharehook;
12158 PL_lockhook = proto_perl->Ilockhook;
12159 PL_unlockhook = proto_perl->Iunlockhook;
12160 PL_threadhook = proto_perl->Ithreadhook;
12161
bce260cd
JH
12162 PL_runops_std = proto_perl->Irunops_std;
12163 PL_runops_dbg = proto_perl->Irunops_dbg;
12164
12165#ifdef THREADS_HAVE_PIDS
12166 PL_ppid = proto_perl->Ippid;
12167#endif
12168
1d7c1841
GS
12169 /* swatch cache */
12170 PL_last_swash_hv = Nullhv; /* reinits on demand */
12171 PL_last_swash_klen = 0;
12172 PL_last_swash_key[0]= '\0';
12173 PL_last_swash_tmps = (U8*)NULL;
12174 PL_last_swash_slen = 0;
12175
1d7c1841
GS
12176 PL_glob_index = proto_perl->Iglob_index;
12177 PL_srand_called = proto_perl->Isrand_called;
12178 PL_uudmap['M'] = 0; /* reinits on demand */
12179 PL_bitcount = Nullch; /* reinits on demand */
12180
66fe0623
NIS
12181 if (proto_perl->Ipsig_pend) {
12182 Newz(0, PL_psig_pend, SIG_SIZE, int);
9dd79c3f 12183 }
66fe0623
NIS
12184 else {
12185 PL_psig_pend = (int*)NULL;
12186 }
12187
1d7c1841 12188 if (proto_perl->Ipsig_ptr) {
76d3c696
JH
12189 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
12190 Newz(0, PL_psig_name, SIG_SIZE, SV*);
76d3c696 12191 for (i = 1; i < SIG_SIZE; i++) {
d2d73c3e
AB
12192 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
12193 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
1d7c1841
GS
12194 }
12195 }
12196 else {
12197 PL_psig_ptr = (SV**)NULL;
12198 PL_psig_name = (SV**)NULL;
12199 }
12200
12201 /* thrdvar.h stuff */
12202
a0739874 12203 if (flags & CLONEf_COPY_STACKS) {
1d7c1841
GS
12204 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12205 PL_tmps_ix = proto_perl->Ttmps_ix;
12206 PL_tmps_max = proto_perl->Ttmps_max;
12207 PL_tmps_floor = proto_perl->Ttmps_floor;
12208 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
12209 i = 0;
12210 while (i <= PL_tmps_ix) {
d2d73c3e 12211 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
1d7c1841
GS
12212 ++i;
12213 }
12214
12215 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
12216 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
12217 Newz(54, PL_markstack, i, I32);
12218 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
12219 - proto_perl->Tmarkstack);
12220 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
12221 - proto_perl->Tmarkstack);
12222 Copy(proto_perl->Tmarkstack, PL_markstack,
12223 PL_markstack_ptr - PL_markstack + 1, I32);
12224
12225 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12226 * NOTE: unlike the others! */
12227 PL_scopestack_ix = proto_perl->Tscopestack_ix;
12228 PL_scopestack_max = proto_perl->Tscopestack_max;
12229 Newz(54, PL_scopestack, PL_scopestack_max, I32);
12230 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
12231
1d7c1841 12232 /* NOTE: si_dup() looks at PL_markstack */
d2d73c3e 12233 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
1d7c1841
GS
12234
12235 /* PL_curstack = PL_curstackinfo->si_stack; */
d2d73c3e
AB
12236 PL_curstack = av_dup(proto_perl->Tcurstack, param);
12237 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
1d7c1841
GS
12238
12239 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12240 PL_stack_base = AvARRAY(PL_curstack);
12241 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
12242 - proto_perl->Tstack_base);
12243 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12244
12245 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12246 * NOTE: unlike the others! */
12247 PL_savestack_ix = proto_perl->Tsavestack_ix;
12248 PL_savestack_max = proto_perl->Tsavestack_max;
12249 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
d2d73c3e 12250 PL_savestack = ss_dup(proto_perl, param);
1d7c1841
GS
12251 }
12252 else {
12253 init_stacks();
985e7056 12254 ENTER; /* perl_destruct() wants to LEAVE; */
1d7c1841
GS
12255 }
12256
12257 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
12258 PL_top_env = &PL_start_env;
12259
12260 PL_op = proto_perl->Top;
12261
12262 PL_Sv = Nullsv;
12263 PL_Xpv = (XPV*)NULL;
12264 PL_na = proto_perl->Tna;
12265
12266 PL_statbuf = proto_perl->Tstatbuf;
12267 PL_statcache = proto_perl->Tstatcache;
d2d73c3e
AB
12268 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
12269 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
1d7c1841
GS
12270#ifdef HAS_TIMES
12271 PL_timesbuf = proto_perl->Ttimesbuf;
12272#endif
12273
12274 PL_tainted = proto_perl->Ttainted;
12275 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
d2d73c3e
AB
12276 PL_rs = sv_dup_inc(proto_perl->Trs, param);
12277 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
12278 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
12279 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
1d7c1841 12280 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
d2d73c3e
AB
12281 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
12282 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
12283 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
1d7c1841
GS
12284
12285 PL_restartop = proto_perl->Trestartop;
12286 PL_in_eval = proto_perl->Tin_eval;
12287 PL_delaymagic = proto_perl->Tdelaymagic;
12288 PL_dirty = proto_perl->Tdirty;
12289 PL_localizing = proto_perl->Tlocalizing;
12290
d2d73c3e 12291 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
dd28f7bb 12292 PL_hv_fetch_ent_mh = Nullhe;
1d7c1841
GS
12293 PL_modcount = proto_perl->Tmodcount;
12294 PL_lastgotoprobe = Nullop;
12295 PL_dumpindent = proto_perl->Tdumpindent;
12296
12297 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
d2d73c3e
AB
12298 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
12299 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
12300 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
1d7c1841
GS
12301 PL_sortcxix = proto_perl->Tsortcxix;
12302 PL_efloatbuf = Nullch; /* reinits on demand */
12303 PL_efloatsize = 0; /* reinits on demand */
12304
12305 /* regex stuff */
12306
12307 PL_screamfirst = NULL;
12308 PL_screamnext = NULL;
12309 PL_maxscream = -1; /* reinits on demand */
12310 PL_lastscream = Nullsv;
12311
12312 PL_watchaddr = NULL;
12313 PL_watchok = Nullch;
12314
12315 PL_regdummy = proto_perl->Tregdummy;
1d7c1841
GS
12316 PL_regprecomp = Nullch;
12317 PL_regnpar = 0;
12318 PL_regsize = 0;
1d7c1841
GS
12319 PL_colorset = 0; /* reinits PL_colors[] */
12320 /*PL_colors[6] = {0,0,0,0,0,0};*/
1d7c1841
GS
12321 PL_reginput = Nullch;
12322 PL_regbol = Nullch;
12323 PL_regeol = Nullch;
12324 PL_regstartp = (I32*)NULL;
12325 PL_regendp = (I32*)NULL;
12326 PL_reglastparen = (U32*)NULL;
2d862feb 12327 PL_reglastcloseparen = (U32*)NULL;
1d7c1841 12328 PL_regtill = Nullch;
1d7c1841
GS
12329 PL_reg_start_tmp = (char**)NULL;
12330 PL_reg_start_tmpl = 0;
12331 PL_regdata = (struct reg_data*)NULL;
12332 PL_bostr = Nullch;
12333 PL_reg_flags = 0;
12334 PL_reg_eval_set = 0;
12335 PL_regnarrate = 0;
12336 PL_regprogram = (regnode*)NULL;
12337 PL_regindent = 0;
12338 PL_regcc = (CURCUR*)NULL;
12339 PL_reg_call_cc = (struct re_cc_state*)NULL;
12340 PL_reg_re = (regexp*)NULL;
12341 PL_reg_ganch = Nullch;
12342 PL_reg_sv = Nullsv;
53c4c00c 12343 PL_reg_match_utf8 = FALSE;
1d7c1841
GS
12344 PL_reg_magic = (MAGIC*)NULL;
12345 PL_reg_oldpos = 0;
12346 PL_reg_oldcurpm = (PMOP*)NULL;
12347 PL_reg_curpm = (PMOP*)NULL;
12348 PL_reg_oldsaved = Nullch;
12349 PL_reg_oldsavedlen = 0;
ed252734 12350#ifdef PERL_COPY_ON_WRITE
504cff3b 12351 PL_nrs = Nullsv;
ed252734 12352#endif
1d7c1841
GS
12353 PL_reg_maxiter = 0;
12354 PL_reg_leftiter = 0;
12355 PL_reg_poscache = Nullch;
12356 PL_reg_poscache_size= 0;
12357
12358 /* RE engine - function pointers */
12359 PL_regcompp = proto_perl->Tregcompp;
12360 PL_regexecp = proto_perl->Tregexecp;
12361 PL_regint_start = proto_perl->Tregint_start;
12362 PL_regint_string = proto_perl->Tregint_string;
12363 PL_regfree = proto_perl->Tregfree;
12364
12365 PL_reginterp_cnt = 0;
12366 PL_reg_starttry = 0;
12367
a2efc822
SC
12368 /* Pluggable optimizer */
12369 PL_peepp = proto_perl->Tpeepp;
12370
081fc587
AB
12371 PL_stashcache = newHV();
12372
a0739874
DM
12373 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12374 ptr_table_free(PL_ptr_table);
12375 PL_ptr_table = NULL;
c21d1a0f
NC
12376 ptr_table_free(PL_shared_hek_table);
12377 PL_shared_hek_table = NULL;
a0739874 12378 }
8cf8f3d1 12379
f284b03f
AMS
12380 /* Call the ->CLONE method, if it exists, for each of the stashes
12381 identified by sv_dup() above.
12382 */
d2d73c3e
AB
12383 while(av_len(param->stashes) != -1) {
12384 HV* stash = (HV*) av_shift(param->stashes);
f284b03f
AMS
12385 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12386 if (cloner && GvCV(cloner)) {
12387 dSP;
12388 ENTER;
12389 SAVETMPS;
12390 PUSHMARK(SP);
84bda14a 12391 XPUSHs(sv_2mortal(newSVhek(HvNAME_HEK(stash))));
f284b03f
AMS
12392 PUTBACK;
12393 call_sv((SV*)GvCV(cloner), G_DISCARD);
12394 FREETMPS;
12395 LEAVE;
12396 }
4a09accc 12397 }
a0739874 12398
dc507217 12399 SvREFCNT_dec(param->stashes);
dc507217 12400
6d26897e
DM
12401 /* orphaned? eg threads->new inside BEGIN or use */
12402 if (PL_compcv && ! SvREFCNT(PL_compcv)) {
a3b680e6 12403 (void)SvREFCNT_inc(PL_compcv);
6d26897e
DM
12404 SAVEFREESV(PL_compcv);
12405 }
12406
1d7c1841 12407 return my_perl;
1d7c1841
GS
12408}
12409
1d7c1841 12410#endif /* USE_ITHREADS */
a0ae6670 12411
9f4817db 12412/*
ccfc67b7
JH
12413=head1 Unicode Support
12414
9f4817db
JH
12415=for apidoc sv_recode_to_utf8
12416
5d170f3a
JH
12417The encoding is assumed to be an Encode object, on entry the PV
12418of the sv is assumed to be octets in that encoding, and the sv
12419will be converted into Unicode (and UTF-8).
9f4817db 12420
5d170f3a
JH
12421If the sv already is UTF-8 (or if it is not POK), or if the encoding
12422is not a reference, nothing is done to the sv. If the encoding is not
1768d7eb
JH
12423an C<Encode::XS> Encoding object, bad things will happen.
12424(See F<lib/encoding.pm> and L<Encode>).
9f4817db 12425
5d170f3a 12426The PV of the sv is returned.
9f4817db 12427
5d170f3a
JH
12428=cut */
12429
12430char *
12431Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12432{
27da23d5 12433 dVAR;
220e2d4e 12434 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
d0063567
DK
12435 SV *uni;
12436 STRLEN len;
12437 char *s;
12438 dSP;
12439 ENTER;
12440 SAVETMPS;
220e2d4e 12441 save_re_context();
d0063567
DK
12442 PUSHMARK(sp);
12443 EXTEND(SP, 3);
12444 XPUSHs(encoding);
12445 XPUSHs(sv);
7a5fa8a2 12446/*
f9893866
NIS
12447 NI-S 2002/07/09
12448 Passing sv_yes is wrong - it needs to be or'ed set of constants
7a5fa8a2 12449 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
f9893866
NIS
12450 remove converted chars from source.
12451
12452 Both will default the value - let them.
7a5fa8a2 12453
d0063567 12454 XPUSHs(&PL_sv_yes);
f9893866 12455*/
d0063567
DK
12456 PUTBACK;
12457 call_method("decode", G_SCALAR);
12458 SPAGAIN;
12459 uni = POPs;
12460 PUTBACK;
12461 s = SvPV(uni, len);
3f7c398e 12462 if (s != SvPVX_const(sv)) {
d0063567 12463 SvGROW(sv, len + 1);
3f7c398e 12464 Move(s, SvPVX_const(sv), len, char);
d0063567
DK
12465 SvCUR_set(sv, len);
12466 SvPVX(sv)[len] = 0;
12467 }
12468 FREETMPS;
12469 LEAVE;
d0063567 12470 SvUTF8_on(sv);
95899a2a 12471 return SvPVX(sv);
f9893866 12472 }
95899a2a 12473 return SvPOKp(sv) ? SvPVX(sv) : NULL;
9f4817db
JH
12474}
12475
220e2d4e
IH
12476/*
12477=for apidoc sv_cat_decode
12478
12479The encoding is assumed to be an Encode object, the PV of the ssv is
12480assumed to be octets in that encoding and decoding the input starts
12481from the position which (PV + *offset) pointed to. The dsv will be
12482concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12483when the string tstr appears in decoding output or the input ends on
12484the PV of the ssv. The value which the offset points will be modified
12485to the last input position on the ssv.
68795e93 12486
220e2d4e
IH
12487Returns TRUE if the terminator was found, else returns FALSE.
12488
12489=cut */
12490
12491bool
12492Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12493 SV *ssv, int *offset, char *tstr, int tlen)
12494{
27da23d5 12495 dVAR;
a73e8557 12496 bool ret = FALSE;
220e2d4e 12497 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
220e2d4e
IH
12498 SV *offsv;
12499 dSP;
12500 ENTER;
12501 SAVETMPS;
12502 save_re_context();
12503 PUSHMARK(sp);
12504 EXTEND(SP, 6);
12505 XPUSHs(encoding);
12506 XPUSHs(dsv);
12507 XPUSHs(ssv);
12508 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12509 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12510 PUTBACK;
12511 call_method("cat_decode", G_SCALAR);
12512 SPAGAIN;
12513 ret = SvTRUE(TOPs);
12514 *offset = SvIV(offsv);
12515 PUTBACK;
12516 FREETMPS;
12517 LEAVE;
220e2d4e 12518 }
a73e8557
JH
12519 else
12520 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12521 return ret;
220e2d4e 12522}
f9893866 12523
241d1a3b
NC
12524/*
12525 * Local variables:
12526 * c-indentation-style: bsd
12527 * c-basic-offset: 4
12528 * indent-tabs-mode: t
12529 * End:
12530 *
37442d52
RGS
12531 * ex: set ts=8 sts=4 sw=4 noet:
12532 */