This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
fix for PerlIO/Via compilation on VMS
[perl5.git] / sv.c
CommitLineData
a0d0e21e 1/* sv.c
79072805 2 *
eb1102fc 3 * Copyright (c) 1991-2002, Larry Wall
79072805
LW
4 *
5 * You may distribute under the terms of either the GNU General Public
6 * License or the Artistic License, as specified in the README file.
7 *
a0d0e21e 8 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
645c22ef
DM
9 *
10 *
5e045b90
AMS
11 * This file contains the code that creates, manipulates and destroys
12 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
13 * structure of an SV, so their creation and destruction is handled
14 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
15 * level functions (eg. substr, split, join) for each of the types are
16 * in the pp*.c files.
79072805
LW
17 */
18
19#include "EXTERN.h"
864dbfa3 20#define PERL_IN_SV_C
79072805 21#include "perl.h"
d2f185dc 22#include "regcomp.h"
79072805 23
51371543 24#define FCALL *f
2c5424a7 25
765f542d
NC
26#ifdef PERL_COPY_ON_WRITE
27#define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
a29f6d03 28#define SV_COW_NEXT_SV_SET(current,next) SvUVX(current) = PTR2UV(next)
b5ccf5f2 29/* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
765f542d 30 on-write. */
e419cbc5
NC
31#define CAN_COW_MASK (SVs_OBJECT|SVs_GMG|SVs_SMG|SVs_RMG|SVf_IOK|SVf_NOK| \
32 SVf_POK|SVf_ROK|SVp_IOK|SVp_NOK|SVp_POK|SVf_FAKE| \
33 SVf_OOK|SVf_BREAK|SVf_READONLY|SVf_AMAGIC)
765f542d
NC
34#define CAN_COW_FLAGS (SVp_POK|SVf_POK)
35#endif
645c22ef
DM
36
37/* ============================================================================
38
39=head1 Allocation and deallocation of SVs.
40
5e045b90
AMS
41An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
42av, hv...) contains type and reference count information, as well as a
43pointer to the body (struct xrv, xpv, xpviv...), which contains fields
44specific to each type.
45
46Normally, this allocation is done using arenas, which are approximately
471K chunks of memory parcelled up into N heads or bodies. The first slot
48in each arena is reserved, and is used to hold a link to the next arena.
49In the case of heads, the unused first slot also contains some flags and
50a note of the number of slots. Snaked through each arena chain is a
51linked list of free items; when this becomes empty, an extra arena is
52allocated and divided up into N items which are threaded into the free
53list.
645c22ef
DM
54
55The following global variables are associated with arenas:
56
57 PL_sv_arenaroot pointer to list of SV arenas
58 PL_sv_root pointer to list of free SV structures
59
60 PL_foo_arenaroot pointer to list of foo arenas,
61 PL_foo_root pointer to list of free foo bodies
62 ... for foo in xiv, xnv, xrv, xpv etc.
63
64Note that some of the larger and more rarely used body types (eg xpvio)
65are not allocated using arenas, but are instead just malloc()/free()ed as
66required. Also, if PURIFY is defined, arenas are abandoned altogether,
67with all items individually malloc()ed. In addition, a few SV heads are
68not allocated from an arena, but are instead directly created as static
69or auto variables, eg PL_sv_undef.
70
71The SV arena serves the secondary purpose of allowing still-live SVs
72to be located and destroyed during final cleanup.
73
74At the lowest level, the macros new_SV() and del_SV() grab and free
75an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
76to return the SV to the free list with error checking.) new_SV() calls
77more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
78SVs in the free list have their SvTYPE field set to all ones.
79
80Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
81that allocate and return individual body types. Normally these are mapped
ff276b08
RG
82to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
83instead mapped directly to malloc()/free() if PURIFY is defined. The
645c22ef
DM
84new/del functions remove from, or add to, the appropriate PL_foo_root
85list, and call more_xiv() etc to add a new arena if the list is empty.
86
ff276b08 87At the time of very final cleanup, sv_free_arenas() is called from
645c22ef
DM
88perl_destruct() to physically free all the arenas allocated since the
89start of the interpreter. Note that this also clears PL_he_arenaroot,
90which is otherwise dealt with in hv.c.
91
92Manipulation of any of the PL_*root pointers is protected by enclosing
93LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
94if threads are enabled.
95
96The function visit() scans the SV arenas list, and calls a specified
97function for each SV it finds which is still live - ie which has an SvTYPE
98other than all 1's, and a non-zero SvREFCNT. visit() is used by the
99following functions (specified as [function that calls visit()] / [function
100called by visit() for each SV]):
101
102 sv_report_used() / do_report_used()
103 dump all remaining SVs (debugging aid)
104
105 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
106 Attempt to free all objects pointed to by RVs,
107 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
108 try to do the same for all objects indirectly
109 referenced by typeglobs too. Called once from
110 perl_destruct(), prior to calling sv_clean_all()
111 below.
112
113 sv_clean_all() / do_clean_all()
114 SvREFCNT_dec(sv) each remaining SV, possibly
115 triggering an sv_free(). It also sets the
116 SVf_BREAK flag on the SV to indicate that the
117 refcnt has been artificially lowered, and thus
118 stopping sv_free() from giving spurious warnings
119 about SVs which unexpectedly have a refcnt
120 of zero. called repeatedly from perl_destruct()
121 until there are no SVs left.
122
123=head2 Summary
124
125Private API to rest of sv.c
126
127 new_SV(), del_SV(),
128
129 new_XIV(), del_XIV(),
130 new_XNV(), del_XNV(),
131 etc
132
133Public API:
134
8cf8f3d1 135 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
645c22ef
DM
136
137
138=cut
139
140============================================================================ */
141
142
51371543 143
4561caa4
CS
144/*
145 * "A time to plant, and a time to uproot what was planted..."
146 */
147
053fc874
GS
148#define plant_SV(p) \
149 STMT_START { \
150 SvANY(p) = (void *)PL_sv_root; \
151 SvFLAGS(p) = SVTYPEMASK; \
152 PL_sv_root = (p); \
153 --PL_sv_count; \
154 } STMT_END
a0d0e21e 155
fba3b22e 156/* sv_mutex must be held while calling uproot_SV() */
053fc874
GS
157#define uproot_SV(p) \
158 STMT_START { \
159 (p) = PL_sv_root; \
160 PL_sv_root = (SV*)SvANY(p); \
161 ++PL_sv_count; \
162 } STMT_END
163
645c22ef
DM
164
165/* new_SV(): return a new, empty SV head */
166
eba0f806
DM
167#ifdef DEBUG_LEAKING_SCALARS
168/* provide a real function for a debugger to play with */
169STATIC SV*
170S_new_SV(pTHX)
171{
172 SV* sv;
173
174 LOCK_SV_MUTEX;
175 if (PL_sv_root)
176 uproot_SV(sv);
177 else
178 sv = more_sv();
179 UNLOCK_SV_MUTEX;
180 SvANY(sv) = 0;
181 SvREFCNT(sv) = 1;
182 SvFLAGS(sv) = 0;
183 return sv;
184}
185# define new_SV(p) (p)=S_new_SV(aTHX)
186
187#else
188# define new_SV(p) \
053fc874
GS
189 STMT_START { \
190 LOCK_SV_MUTEX; \
191 if (PL_sv_root) \
192 uproot_SV(p); \
193 else \
194 (p) = more_sv(); \
195 UNLOCK_SV_MUTEX; \
196 SvANY(p) = 0; \
197 SvREFCNT(p) = 1; \
198 SvFLAGS(p) = 0; \
199 } STMT_END
eba0f806 200#endif
463ee0b2 201
645c22ef
DM
202
203/* del_SV(): return an empty SV head to the free list */
204
a0d0e21e 205#ifdef DEBUGGING
4561caa4 206
053fc874
GS
207#define del_SV(p) \
208 STMT_START { \
209 LOCK_SV_MUTEX; \
aea4f609 210 if (DEBUG_D_TEST) \
053fc874
GS
211 del_sv(p); \
212 else \
213 plant_SV(p); \
214 UNLOCK_SV_MUTEX; \
215 } STMT_END
a0d0e21e 216
76e3520e 217STATIC void
cea2e8a9 218S_del_sv(pTHX_ SV *p)
463ee0b2 219{
aea4f609 220 if (DEBUG_D_TEST) {
4633a7c4 221 SV* sva;
a0d0e21e
LW
222 SV* sv;
223 SV* svend;
224 int ok = 0;
3280af22 225 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
4633a7c4
LW
226 sv = sva + 1;
227 svend = &sva[SvREFCNT(sva)];
a0d0e21e
LW
228 if (p >= sv && p < svend)
229 ok = 1;
230 }
231 if (!ok) {
0453d815 232 if (ckWARN_d(WARN_INTERNAL))
9014280d 233 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
1d7c1841
GS
234 "Attempt to free non-arena SV: 0x%"UVxf,
235 PTR2UV(p));
a0d0e21e
LW
236 return;
237 }
238 }
4561caa4 239 plant_SV(p);
463ee0b2 240}
a0d0e21e 241
4561caa4
CS
242#else /* ! DEBUGGING */
243
244#define del_SV(p) plant_SV(p)
245
246#endif /* DEBUGGING */
463ee0b2 247
645c22ef
DM
248
249/*
ccfc67b7
JH
250=head1 SV Manipulation Functions
251
645c22ef
DM
252=for apidoc sv_add_arena
253
254Given a chunk of memory, link it to the head of the list of arenas,
255and split it into a list of free SVs.
256
257=cut
258*/
259
4633a7c4 260void
864dbfa3 261Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
463ee0b2 262{
4633a7c4 263 SV* sva = (SV*)ptr;
463ee0b2
LW
264 register SV* sv;
265 register SV* svend;
14dd3ad8 266 Zero(ptr, size, char);
4633a7c4
LW
267
268 /* The first SV in an arena isn't an SV. */
3280af22 269 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
4633a7c4
LW
270 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
271 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
272
3280af22
NIS
273 PL_sv_arenaroot = sva;
274 PL_sv_root = sva + 1;
4633a7c4
LW
275
276 svend = &sva[SvREFCNT(sva) - 1];
277 sv = sva + 1;
463ee0b2 278 while (sv < svend) {
a0d0e21e 279 SvANY(sv) = (void *)(SV*)(sv + 1);
8990e307 280 SvFLAGS(sv) = SVTYPEMASK;
463ee0b2
LW
281 sv++;
282 }
283 SvANY(sv) = 0;
4633a7c4
LW
284 SvFLAGS(sv) = SVTYPEMASK;
285}
286
645c22ef
DM
287/* make some more SVs by adding another arena */
288
fba3b22e 289/* sv_mutex must be held while calling more_sv() */
76e3520e 290STATIC SV*
cea2e8a9 291S_more_sv(pTHX)
4633a7c4 292{
4561caa4
CS
293 register SV* sv;
294
3280af22
NIS
295 if (PL_nice_chunk) {
296 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
297 PL_nice_chunk = Nullch;
30ad99e7 298 PL_nice_chunk_size = 0;
c07a80fd 299 }
1edc1566 300 else {
301 char *chunk; /* must use New here to match call to */
302 New(704,chunk,1008,char); /* Safefree() in sv_free_arenas() */
303 sv_add_arena(chunk, 1008, 0);
304 }
4561caa4
CS
305 uproot_SV(sv);
306 return sv;
463ee0b2
LW
307}
308
ff276b08 309/* visit(): call the named function for each non-free SV in the arenas. */
645c22ef 310
5226ed68 311STATIC I32
cea2e8a9 312S_visit(pTHX_ SVFUNC_t f)
8990e307 313{
4633a7c4 314 SV* sva;
8990e307
LW
315 SV* sv;
316 register SV* svend;
5226ed68 317 I32 visited = 0;
8990e307 318
3280af22 319 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
4633a7c4 320 svend = &sva[SvREFCNT(sva)];
4561caa4 321 for (sv = sva + 1; sv < svend; ++sv) {
f25c30a3 322 if (SvTYPE(sv) != SVTYPEMASK && SvREFCNT(sv)) {
acfe0abc 323 (FCALL)(aTHX_ sv);
5226ed68
JH
324 ++visited;
325 }
8990e307
LW
326 }
327 }
5226ed68 328 return visited;
8990e307
LW
329}
330
758a08c3
JH
331#ifdef DEBUGGING
332
645c22ef
DM
333/* called by sv_report_used() for each live SV */
334
335static void
acfe0abc 336do_report_used(pTHX_ SV *sv)
645c22ef
DM
337{
338 if (SvTYPE(sv) != SVTYPEMASK) {
339 PerlIO_printf(Perl_debug_log, "****\n");
340 sv_dump(sv);
341 }
342}
758a08c3 343#endif
645c22ef
DM
344
345/*
346=for apidoc sv_report_used
347
348Dump the contents of all SVs not yet freed. (Debugging aid).
349
350=cut
351*/
352
8990e307 353void
864dbfa3 354Perl_sv_report_used(pTHX)
4561caa4 355{
ff270d3a 356#ifdef DEBUGGING
0b94c7bb 357 visit(do_report_used);
ff270d3a 358#endif
4561caa4
CS
359}
360
645c22ef
DM
361/* called by sv_clean_objs() for each live SV */
362
363static void
acfe0abc 364do_clean_objs(pTHX_ SV *sv)
645c22ef
DM
365{
366 SV* rv;
367
368 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
369 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
370 if (SvWEAKREF(sv)) {
371 sv_del_backref(sv);
372 SvWEAKREF_off(sv);
373 SvRV(sv) = 0;
374 } else {
375 SvROK_off(sv);
376 SvRV(sv) = 0;
377 SvREFCNT_dec(rv);
378 }
379 }
380
381 /* XXX Might want to check arrays, etc. */
382}
383
384/* called by sv_clean_objs() for each live SV */
385
386#ifndef DISABLE_DESTRUCTOR_KLUDGE
387static void
acfe0abc 388do_clean_named_objs(pTHX_ SV *sv)
645c22ef
DM
389{
390 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
391 if ( SvOBJECT(GvSV(sv)) ||
392 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
393 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
394 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
395 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
396 {
397 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
398 SvREFCNT_dec(sv);
399 }
400 }
401}
402#endif
403
404/*
405=for apidoc sv_clean_objs
406
407Attempt to destroy all objects not yet freed
408
409=cut
410*/
411
4561caa4 412void
864dbfa3 413Perl_sv_clean_objs(pTHX)
4561caa4 414{
3280af22 415 PL_in_clean_objs = TRUE;
0b94c7bb 416 visit(do_clean_objs);
4561caa4 417#ifndef DISABLE_DESTRUCTOR_KLUDGE
2d0f3c12 418 /* some barnacles may yet remain, clinging to typeglobs */
0b94c7bb 419 visit(do_clean_named_objs);
4561caa4 420#endif
3280af22 421 PL_in_clean_objs = FALSE;
4561caa4
CS
422}
423
645c22ef
DM
424/* called by sv_clean_all() for each live SV */
425
426static void
acfe0abc 427do_clean_all(pTHX_ SV *sv)
645c22ef
DM
428{
429 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
430 SvFLAGS(sv) |= SVf_BREAK;
431 SvREFCNT_dec(sv);
432}
433
434/*
435=for apidoc sv_clean_all
436
437Decrement the refcnt of each remaining SV, possibly triggering a
438cleanup. This function may have to be called multiple times to free
ff276b08 439SVs which are in complex self-referential hierarchies.
645c22ef
DM
440
441=cut
442*/
443
5226ed68 444I32
864dbfa3 445Perl_sv_clean_all(pTHX)
8990e307 446{
5226ed68 447 I32 cleaned;
3280af22 448 PL_in_clean_all = TRUE;
5226ed68 449 cleaned = visit(do_clean_all);
3280af22 450 PL_in_clean_all = FALSE;
5226ed68 451 return cleaned;
8990e307 452}
463ee0b2 453
645c22ef
DM
454/*
455=for apidoc sv_free_arenas
456
457Deallocate the memory used by all arenas. Note that all the individual SV
458heads and bodies within the arenas must already have been freed.
459
460=cut
461*/
462
4633a7c4 463void
864dbfa3 464Perl_sv_free_arenas(pTHX)
4633a7c4
LW
465{
466 SV* sva;
467 SV* svanext;
612f20c3 468 XPV *arena, *arenanext;
4633a7c4
LW
469
470 /* Free arenas here, but be careful about fake ones. (We assume
471 contiguity of the fake ones with the corresponding real ones.) */
472
3280af22 473 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
4633a7c4
LW
474 svanext = (SV*) SvANY(sva);
475 while (svanext && SvFAKE(svanext))
476 svanext = (SV*) SvANY(svanext);
477
478 if (!SvFAKE(sva))
1edc1566 479 Safefree((void *)sva);
4633a7c4 480 }
5f05dabc 481
612f20c3
GS
482 for (arena = PL_xiv_arenaroot; arena; arena = arenanext) {
483 arenanext = (XPV*)arena->xpv_pv;
484 Safefree(arena);
485 }
486 PL_xiv_arenaroot = 0;
487
488 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
489 arenanext = (XPV*)arena->xpv_pv;
490 Safefree(arena);
491 }
492 PL_xnv_arenaroot = 0;
493
494 for (arena = PL_xrv_arenaroot; arena; arena = arenanext) {
495 arenanext = (XPV*)arena->xpv_pv;
496 Safefree(arena);
497 }
498 PL_xrv_arenaroot = 0;
499
500 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
501 arenanext = (XPV*)arena->xpv_pv;
502 Safefree(arena);
503 }
504 PL_xpv_arenaroot = 0;
505
506 for (arena = (XPV*)PL_xpviv_arenaroot; arena; arena = arenanext) {
507 arenanext = (XPV*)arena->xpv_pv;
508 Safefree(arena);
509 }
510 PL_xpviv_arenaroot = 0;
511
512 for (arena = (XPV*)PL_xpvnv_arenaroot; arena; arena = arenanext) {
513 arenanext = (XPV*)arena->xpv_pv;
514 Safefree(arena);
515 }
516 PL_xpvnv_arenaroot = 0;
517
518 for (arena = (XPV*)PL_xpvcv_arenaroot; arena; arena = arenanext) {
519 arenanext = (XPV*)arena->xpv_pv;
520 Safefree(arena);
521 }
522 PL_xpvcv_arenaroot = 0;
523
524 for (arena = (XPV*)PL_xpvav_arenaroot; arena; arena = arenanext) {
525 arenanext = (XPV*)arena->xpv_pv;
526 Safefree(arena);
527 }
528 PL_xpvav_arenaroot = 0;
529
530 for (arena = (XPV*)PL_xpvhv_arenaroot; arena; arena = arenanext) {
531 arenanext = (XPV*)arena->xpv_pv;
532 Safefree(arena);
533 }
534 PL_xpvhv_arenaroot = 0;
535
536 for (arena = (XPV*)PL_xpvmg_arenaroot; arena; arena = arenanext) {
537 arenanext = (XPV*)arena->xpv_pv;
538 Safefree(arena);
539 }
540 PL_xpvmg_arenaroot = 0;
541
542 for (arena = (XPV*)PL_xpvlv_arenaroot; arena; arena = arenanext) {
543 arenanext = (XPV*)arena->xpv_pv;
544 Safefree(arena);
545 }
546 PL_xpvlv_arenaroot = 0;
547
548 for (arena = (XPV*)PL_xpvbm_arenaroot; arena; arena = arenanext) {
549 arenanext = (XPV*)arena->xpv_pv;
550 Safefree(arena);
551 }
552 PL_xpvbm_arenaroot = 0;
553
554 for (arena = (XPV*)PL_he_arenaroot; arena; arena = arenanext) {
555 arenanext = (XPV*)arena->xpv_pv;
556 Safefree(arena);
557 }
558 PL_he_arenaroot = 0;
559
3280af22
NIS
560 if (PL_nice_chunk)
561 Safefree(PL_nice_chunk);
562 PL_nice_chunk = Nullch;
563 PL_nice_chunk_size = 0;
564 PL_sv_arenaroot = 0;
565 PL_sv_root = 0;
4633a7c4
LW
566}
567
645c22ef
DM
568/*
569=for apidoc report_uninit
570
571Print appropriate "Use of uninitialized variable" warning
572
573=cut
574*/
575
1d7c1841
GS
576void
577Perl_report_uninit(pTHX)
578{
579 if (PL_op)
9014280d 580 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
53e06cf0 581 " in ", OP_DESC(PL_op));
1d7c1841 582 else
9014280d 583 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit, "", "");
1d7c1841
GS
584}
585
645c22ef
DM
586/* grab a new IV body from the free list, allocating more if necessary */
587
76e3520e 588STATIC XPVIV*
cea2e8a9 589S_new_xiv(pTHX)
463ee0b2 590{
ea7c11a3 591 IV* xiv;
cbe51380
GS
592 LOCK_SV_MUTEX;
593 if (!PL_xiv_root)
594 more_xiv();
595 xiv = PL_xiv_root;
596 /*
597 * See comment in more_xiv() -- RAM.
598 */
599 PL_xiv_root = *(IV**)xiv;
600 UNLOCK_SV_MUTEX;
601 return (XPVIV*)((char*)xiv - STRUCT_OFFSET(XPVIV, xiv_iv));
463ee0b2
LW
602}
603
645c22ef
DM
604/* return an IV body to the free list */
605
76e3520e 606STATIC void
cea2e8a9 607S_del_xiv(pTHX_ XPVIV *p)
463ee0b2 608{
23e6a22f 609 IV* xiv = (IV*)((char*)(p) + STRUCT_OFFSET(XPVIV, xiv_iv));
cbe51380 610 LOCK_SV_MUTEX;
3280af22
NIS
611 *(IV**)xiv = PL_xiv_root;
612 PL_xiv_root = xiv;
cbe51380 613 UNLOCK_SV_MUTEX;
463ee0b2
LW
614}
615
645c22ef
DM
616/* allocate another arena's worth of IV bodies */
617
cbe51380 618STATIC void
cea2e8a9 619S_more_xiv(pTHX)
463ee0b2 620{
ea7c11a3
SM
621 register IV* xiv;
622 register IV* xivend;
8c52afec
IZ
623 XPV* ptr;
624 New(705, ptr, 1008/sizeof(XPV), XPV);
645c22ef 625 ptr->xpv_pv = (char*)PL_xiv_arenaroot; /* linked list of xiv arenas */
3280af22 626 PL_xiv_arenaroot = ptr; /* to keep Purify happy */
a0d0e21e 627
ea7c11a3
SM
628 xiv = (IV*) ptr;
629 xivend = &xiv[1008 / sizeof(IV) - 1];
645c22ef 630 xiv += (sizeof(XPV) - 1) / sizeof(IV) + 1; /* fudge by size of XPV */
3280af22 631 PL_xiv_root = xiv;
463ee0b2 632 while (xiv < xivend) {
ea7c11a3 633 *(IV**)xiv = (IV *)(xiv + 1);
463ee0b2
LW
634 xiv++;
635 }
ea7c11a3 636 *(IV**)xiv = 0;
463ee0b2
LW
637}
638
645c22ef
DM
639/* grab a new NV body from the free list, allocating more if necessary */
640
76e3520e 641STATIC XPVNV*
cea2e8a9 642S_new_xnv(pTHX)
463ee0b2 643{
65202027 644 NV* xnv;
cbe51380
GS
645 LOCK_SV_MUTEX;
646 if (!PL_xnv_root)
647 more_xnv();
648 xnv = PL_xnv_root;
65202027 649 PL_xnv_root = *(NV**)xnv;
cbe51380
GS
650 UNLOCK_SV_MUTEX;
651 return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
463ee0b2
LW
652}
653
645c22ef
DM
654/* return an NV body to the free list */
655
76e3520e 656STATIC void
cea2e8a9 657S_del_xnv(pTHX_ XPVNV *p)
463ee0b2 658{
65202027 659 NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
cbe51380 660 LOCK_SV_MUTEX;
65202027 661 *(NV**)xnv = PL_xnv_root;
3280af22 662 PL_xnv_root = xnv;
cbe51380 663 UNLOCK_SV_MUTEX;
463ee0b2
LW
664}
665
645c22ef
DM
666/* allocate another arena's worth of NV bodies */
667
cbe51380 668STATIC void
cea2e8a9 669S_more_xnv(pTHX)
463ee0b2 670{
65202027
DS
671 register NV* xnv;
672 register NV* xnvend;
612f20c3
GS
673 XPV *ptr;
674 New(711, ptr, 1008/sizeof(XPV), XPV);
675 ptr->xpv_pv = (char*)PL_xnv_arenaroot;
676 PL_xnv_arenaroot = ptr;
677
678 xnv = (NV*) ptr;
65202027
DS
679 xnvend = &xnv[1008 / sizeof(NV) - 1];
680 xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
3280af22 681 PL_xnv_root = xnv;
463ee0b2 682 while (xnv < xnvend) {
65202027 683 *(NV**)xnv = (NV*)(xnv + 1);
463ee0b2
LW
684 xnv++;
685 }
65202027 686 *(NV**)xnv = 0;
463ee0b2
LW
687}
688
645c22ef
DM
689/* grab a new struct xrv from the free list, allocating more if necessary */
690
76e3520e 691STATIC XRV*
cea2e8a9 692S_new_xrv(pTHX)
ed6116ce
LW
693{
694 XRV* xrv;
cbe51380
GS
695 LOCK_SV_MUTEX;
696 if (!PL_xrv_root)
697 more_xrv();
698 xrv = PL_xrv_root;
699 PL_xrv_root = (XRV*)xrv->xrv_rv;
700 UNLOCK_SV_MUTEX;
701 return xrv;
ed6116ce
LW
702}
703
645c22ef
DM
704/* return a struct xrv to the free list */
705
76e3520e 706STATIC void
cea2e8a9 707S_del_xrv(pTHX_ XRV *p)
ed6116ce 708{
cbe51380 709 LOCK_SV_MUTEX;
3280af22
NIS
710 p->xrv_rv = (SV*)PL_xrv_root;
711 PL_xrv_root = p;
cbe51380 712 UNLOCK_SV_MUTEX;
ed6116ce
LW
713}
714
645c22ef
DM
715/* allocate another arena's worth of struct xrv */
716
cbe51380 717STATIC void
cea2e8a9 718S_more_xrv(pTHX)
ed6116ce 719{
ed6116ce
LW
720 register XRV* xrv;
721 register XRV* xrvend;
612f20c3
GS
722 XPV *ptr;
723 New(712, ptr, 1008/sizeof(XPV), XPV);
724 ptr->xpv_pv = (char*)PL_xrv_arenaroot;
725 PL_xrv_arenaroot = ptr;
726
727 xrv = (XRV*) ptr;
ed6116ce 728 xrvend = &xrv[1008 / sizeof(XRV) - 1];
612f20c3
GS
729 xrv += (sizeof(XPV) - 1) / sizeof(XRV) + 1;
730 PL_xrv_root = xrv;
ed6116ce
LW
731 while (xrv < xrvend) {
732 xrv->xrv_rv = (SV*)(xrv + 1);
733 xrv++;
734 }
735 xrv->xrv_rv = 0;
ed6116ce
LW
736}
737
645c22ef
DM
738/* grab a new struct xpv from the free list, allocating more if necessary */
739
76e3520e 740STATIC XPV*
cea2e8a9 741S_new_xpv(pTHX)
463ee0b2
LW
742{
743 XPV* xpv;
cbe51380
GS
744 LOCK_SV_MUTEX;
745 if (!PL_xpv_root)
746 more_xpv();
747 xpv = PL_xpv_root;
748 PL_xpv_root = (XPV*)xpv->xpv_pv;
749 UNLOCK_SV_MUTEX;
750 return xpv;
463ee0b2
LW
751}
752
645c22ef
DM
753/* return a struct xpv to the free list */
754
76e3520e 755STATIC void
cea2e8a9 756S_del_xpv(pTHX_ XPV *p)
463ee0b2 757{
cbe51380 758 LOCK_SV_MUTEX;
3280af22
NIS
759 p->xpv_pv = (char*)PL_xpv_root;
760 PL_xpv_root = p;
cbe51380 761 UNLOCK_SV_MUTEX;
463ee0b2
LW
762}
763
645c22ef
DM
764/* allocate another arena's worth of struct xpv */
765
cbe51380 766STATIC void
cea2e8a9 767S_more_xpv(pTHX)
463ee0b2 768{
463ee0b2
LW
769 register XPV* xpv;
770 register XPV* xpvend;
612f20c3
GS
771 New(713, xpv, 1008/sizeof(XPV), XPV);
772 xpv->xpv_pv = (char*)PL_xpv_arenaroot;
773 PL_xpv_arenaroot = xpv;
774
463ee0b2 775 xpvend = &xpv[1008 / sizeof(XPV) - 1];
612f20c3 776 PL_xpv_root = ++xpv;
463ee0b2
LW
777 while (xpv < xpvend) {
778 xpv->xpv_pv = (char*)(xpv + 1);
779 xpv++;
780 }
781 xpv->xpv_pv = 0;
463ee0b2
LW
782}
783
645c22ef
DM
784/* grab a new struct xpviv from the free list, allocating more if necessary */
785
932e9ff9
VB
786STATIC XPVIV*
787S_new_xpviv(pTHX)
788{
789 XPVIV* xpviv;
790 LOCK_SV_MUTEX;
791 if (!PL_xpviv_root)
792 more_xpviv();
793 xpviv = PL_xpviv_root;
794 PL_xpviv_root = (XPVIV*)xpviv->xpv_pv;
795 UNLOCK_SV_MUTEX;
796 return xpviv;
797}
798
645c22ef
DM
799/* return a struct xpviv to the free list */
800
932e9ff9
VB
801STATIC void
802S_del_xpviv(pTHX_ XPVIV *p)
803{
804 LOCK_SV_MUTEX;
805 p->xpv_pv = (char*)PL_xpviv_root;
806 PL_xpviv_root = p;
807 UNLOCK_SV_MUTEX;
808}
809
645c22ef
DM
810/* allocate another arena's worth of struct xpviv */
811
932e9ff9
VB
812STATIC void
813S_more_xpviv(pTHX)
814{
815 register XPVIV* xpviv;
816 register XPVIV* xpvivend;
612f20c3
GS
817 New(714, xpviv, 1008/sizeof(XPVIV), XPVIV);
818 xpviv->xpv_pv = (char*)PL_xpviv_arenaroot;
819 PL_xpviv_arenaroot = xpviv;
820
932e9ff9 821 xpvivend = &xpviv[1008 / sizeof(XPVIV) - 1];
612f20c3 822 PL_xpviv_root = ++xpviv;
932e9ff9
VB
823 while (xpviv < xpvivend) {
824 xpviv->xpv_pv = (char*)(xpviv + 1);
825 xpviv++;
826 }
827 xpviv->xpv_pv = 0;
828}
829
645c22ef
DM
830/* grab a new struct xpvnv from the free list, allocating more if necessary */
831
932e9ff9
VB
832STATIC XPVNV*
833S_new_xpvnv(pTHX)
834{
835 XPVNV* xpvnv;
836 LOCK_SV_MUTEX;
837 if (!PL_xpvnv_root)
838 more_xpvnv();
839 xpvnv = PL_xpvnv_root;
840 PL_xpvnv_root = (XPVNV*)xpvnv->xpv_pv;
841 UNLOCK_SV_MUTEX;
842 return xpvnv;
843}
844
645c22ef
DM
845/* return a struct xpvnv to the free list */
846
932e9ff9
VB
847STATIC void
848S_del_xpvnv(pTHX_ XPVNV *p)
849{
850 LOCK_SV_MUTEX;
851 p->xpv_pv = (char*)PL_xpvnv_root;
852 PL_xpvnv_root = p;
853 UNLOCK_SV_MUTEX;
854}
855
645c22ef
DM
856/* allocate another arena's worth of struct xpvnv */
857
932e9ff9
VB
858STATIC void
859S_more_xpvnv(pTHX)
860{
861 register XPVNV* xpvnv;
862 register XPVNV* xpvnvend;
612f20c3
GS
863 New(715, xpvnv, 1008/sizeof(XPVNV), XPVNV);
864 xpvnv->xpv_pv = (char*)PL_xpvnv_arenaroot;
865 PL_xpvnv_arenaroot = xpvnv;
866
932e9ff9 867 xpvnvend = &xpvnv[1008 / sizeof(XPVNV) - 1];
612f20c3 868 PL_xpvnv_root = ++xpvnv;
932e9ff9
VB
869 while (xpvnv < xpvnvend) {
870 xpvnv->xpv_pv = (char*)(xpvnv + 1);
871 xpvnv++;
872 }
873 xpvnv->xpv_pv = 0;
874}
875
645c22ef
DM
876/* grab a new struct xpvcv from the free list, allocating more if necessary */
877
932e9ff9
VB
878STATIC XPVCV*
879S_new_xpvcv(pTHX)
880{
881 XPVCV* xpvcv;
882 LOCK_SV_MUTEX;
883 if (!PL_xpvcv_root)
884 more_xpvcv();
885 xpvcv = PL_xpvcv_root;
886 PL_xpvcv_root = (XPVCV*)xpvcv->xpv_pv;
887 UNLOCK_SV_MUTEX;
888 return xpvcv;
889}
890
645c22ef
DM
891/* return a struct xpvcv to the free list */
892
932e9ff9
VB
893STATIC void
894S_del_xpvcv(pTHX_ XPVCV *p)
895{
896 LOCK_SV_MUTEX;
897 p->xpv_pv = (char*)PL_xpvcv_root;
898 PL_xpvcv_root = p;
899 UNLOCK_SV_MUTEX;
900}
901
645c22ef
DM
902/* allocate another arena's worth of struct xpvcv */
903
932e9ff9
VB
904STATIC void
905S_more_xpvcv(pTHX)
906{
907 register XPVCV* xpvcv;
908 register XPVCV* xpvcvend;
612f20c3
GS
909 New(716, xpvcv, 1008/sizeof(XPVCV), XPVCV);
910 xpvcv->xpv_pv = (char*)PL_xpvcv_arenaroot;
911 PL_xpvcv_arenaroot = xpvcv;
912
932e9ff9 913 xpvcvend = &xpvcv[1008 / sizeof(XPVCV) - 1];
612f20c3 914 PL_xpvcv_root = ++xpvcv;
932e9ff9
VB
915 while (xpvcv < xpvcvend) {
916 xpvcv->xpv_pv = (char*)(xpvcv + 1);
917 xpvcv++;
918 }
919 xpvcv->xpv_pv = 0;
920}
921
645c22ef
DM
922/* grab a new struct xpvav from the free list, allocating more if necessary */
923
932e9ff9
VB
924STATIC XPVAV*
925S_new_xpvav(pTHX)
926{
927 XPVAV* xpvav;
928 LOCK_SV_MUTEX;
929 if (!PL_xpvav_root)
930 more_xpvav();
931 xpvav = PL_xpvav_root;
932 PL_xpvav_root = (XPVAV*)xpvav->xav_array;
933 UNLOCK_SV_MUTEX;
934 return xpvav;
935}
936
645c22ef
DM
937/* return a struct xpvav to the free list */
938
932e9ff9
VB
939STATIC void
940S_del_xpvav(pTHX_ XPVAV *p)
941{
942 LOCK_SV_MUTEX;
943 p->xav_array = (char*)PL_xpvav_root;
944 PL_xpvav_root = p;
945 UNLOCK_SV_MUTEX;
946}
947
645c22ef
DM
948/* allocate another arena's worth of struct xpvav */
949
932e9ff9
VB
950STATIC void
951S_more_xpvav(pTHX)
952{
953 register XPVAV* xpvav;
954 register XPVAV* xpvavend;
612f20c3
GS
955 New(717, xpvav, 1008/sizeof(XPVAV), XPVAV);
956 xpvav->xav_array = (char*)PL_xpvav_arenaroot;
957 PL_xpvav_arenaroot = xpvav;
958
932e9ff9 959 xpvavend = &xpvav[1008 / sizeof(XPVAV) - 1];
612f20c3 960 PL_xpvav_root = ++xpvav;
932e9ff9
VB
961 while (xpvav < xpvavend) {
962 xpvav->xav_array = (char*)(xpvav + 1);
963 xpvav++;
964 }
965 xpvav->xav_array = 0;
966}
967
645c22ef
DM
968/* grab a new struct xpvhv from the free list, allocating more if necessary */
969
932e9ff9
VB
970STATIC XPVHV*
971S_new_xpvhv(pTHX)
972{
973 XPVHV* xpvhv;
974 LOCK_SV_MUTEX;
975 if (!PL_xpvhv_root)
976 more_xpvhv();
977 xpvhv = PL_xpvhv_root;
978 PL_xpvhv_root = (XPVHV*)xpvhv->xhv_array;
979 UNLOCK_SV_MUTEX;
980 return xpvhv;
981}
982
645c22ef
DM
983/* return a struct xpvhv to the free list */
984
932e9ff9
VB
985STATIC void
986S_del_xpvhv(pTHX_ XPVHV *p)
987{
988 LOCK_SV_MUTEX;
989 p->xhv_array = (char*)PL_xpvhv_root;
990 PL_xpvhv_root = p;
991 UNLOCK_SV_MUTEX;
992}
993
645c22ef
DM
994/* allocate another arena's worth of struct xpvhv */
995
932e9ff9
VB
996STATIC void
997S_more_xpvhv(pTHX)
998{
999 register XPVHV* xpvhv;
1000 register XPVHV* xpvhvend;
612f20c3
GS
1001 New(718, xpvhv, 1008/sizeof(XPVHV), XPVHV);
1002 xpvhv->xhv_array = (char*)PL_xpvhv_arenaroot;
1003 PL_xpvhv_arenaroot = xpvhv;
1004
932e9ff9 1005 xpvhvend = &xpvhv[1008 / sizeof(XPVHV) - 1];
612f20c3 1006 PL_xpvhv_root = ++xpvhv;
932e9ff9
VB
1007 while (xpvhv < xpvhvend) {
1008 xpvhv->xhv_array = (char*)(xpvhv + 1);
1009 xpvhv++;
1010 }
1011 xpvhv->xhv_array = 0;
1012}
1013
645c22ef
DM
1014/* grab a new struct xpvmg from the free list, allocating more if necessary */
1015
932e9ff9
VB
1016STATIC XPVMG*
1017S_new_xpvmg(pTHX)
1018{
1019 XPVMG* xpvmg;
1020 LOCK_SV_MUTEX;
1021 if (!PL_xpvmg_root)
1022 more_xpvmg();
1023 xpvmg = PL_xpvmg_root;
1024 PL_xpvmg_root = (XPVMG*)xpvmg->xpv_pv;
1025 UNLOCK_SV_MUTEX;
1026 return xpvmg;
1027}
1028
645c22ef
DM
1029/* return a struct xpvmg to the free list */
1030
932e9ff9
VB
1031STATIC void
1032S_del_xpvmg(pTHX_ XPVMG *p)
1033{
1034 LOCK_SV_MUTEX;
1035 p->xpv_pv = (char*)PL_xpvmg_root;
1036 PL_xpvmg_root = p;
1037 UNLOCK_SV_MUTEX;
1038}
1039
645c22ef
DM
1040/* allocate another arena's worth of struct xpvmg */
1041
932e9ff9
VB
1042STATIC void
1043S_more_xpvmg(pTHX)
1044{
1045 register XPVMG* xpvmg;
1046 register XPVMG* xpvmgend;
612f20c3
GS
1047 New(719, xpvmg, 1008/sizeof(XPVMG), XPVMG);
1048 xpvmg->xpv_pv = (char*)PL_xpvmg_arenaroot;
1049 PL_xpvmg_arenaroot = xpvmg;
1050
932e9ff9 1051 xpvmgend = &xpvmg[1008 / sizeof(XPVMG) - 1];
612f20c3 1052 PL_xpvmg_root = ++xpvmg;
932e9ff9
VB
1053 while (xpvmg < xpvmgend) {
1054 xpvmg->xpv_pv = (char*)(xpvmg + 1);
1055 xpvmg++;
1056 }
1057 xpvmg->xpv_pv = 0;
1058}
1059
645c22ef
DM
1060/* grab a new struct xpvlv from the free list, allocating more if necessary */
1061
932e9ff9
VB
1062STATIC XPVLV*
1063S_new_xpvlv(pTHX)
1064{
1065 XPVLV* xpvlv;
1066 LOCK_SV_MUTEX;
1067 if (!PL_xpvlv_root)
1068 more_xpvlv();
1069 xpvlv = PL_xpvlv_root;
1070 PL_xpvlv_root = (XPVLV*)xpvlv->xpv_pv;
1071 UNLOCK_SV_MUTEX;
1072 return xpvlv;
1073}
1074
645c22ef
DM
1075/* return a struct xpvlv to the free list */
1076
932e9ff9
VB
1077STATIC void
1078S_del_xpvlv(pTHX_ XPVLV *p)
1079{
1080 LOCK_SV_MUTEX;
1081 p->xpv_pv = (char*)PL_xpvlv_root;
1082 PL_xpvlv_root = p;
1083 UNLOCK_SV_MUTEX;
1084}
1085
645c22ef
DM
1086/* allocate another arena's worth of struct xpvlv */
1087
932e9ff9
VB
1088STATIC void
1089S_more_xpvlv(pTHX)
1090{
1091 register XPVLV* xpvlv;
1092 register XPVLV* xpvlvend;
612f20c3
GS
1093 New(720, xpvlv, 1008/sizeof(XPVLV), XPVLV);
1094 xpvlv->xpv_pv = (char*)PL_xpvlv_arenaroot;
1095 PL_xpvlv_arenaroot = xpvlv;
1096
932e9ff9 1097 xpvlvend = &xpvlv[1008 / sizeof(XPVLV) - 1];
612f20c3 1098 PL_xpvlv_root = ++xpvlv;
932e9ff9
VB
1099 while (xpvlv < xpvlvend) {
1100 xpvlv->xpv_pv = (char*)(xpvlv + 1);
1101 xpvlv++;
1102 }
1103 xpvlv->xpv_pv = 0;
1104}
1105
645c22ef
DM
1106/* grab a new struct xpvbm from the free list, allocating more if necessary */
1107
932e9ff9
VB
1108STATIC XPVBM*
1109S_new_xpvbm(pTHX)
1110{
1111 XPVBM* xpvbm;
1112 LOCK_SV_MUTEX;
1113 if (!PL_xpvbm_root)
1114 more_xpvbm();
1115 xpvbm = PL_xpvbm_root;
1116 PL_xpvbm_root = (XPVBM*)xpvbm->xpv_pv;
1117 UNLOCK_SV_MUTEX;
1118 return xpvbm;
1119}
1120
645c22ef
DM
1121/* return a struct xpvbm to the free list */
1122
932e9ff9
VB
1123STATIC void
1124S_del_xpvbm(pTHX_ XPVBM *p)
1125{
1126 LOCK_SV_MUTEX;
1127 p->xpv_pv = (char*)PL_xpvbm_root;
1128 PL_xpvbm_root = p;
1129 UNLOCK_SV_MUTEX;
1130}
1131
645c22ef
DM
1132/* allocate another arena's worth of struct xpvbm */
1133
932e9ff9
VB
1134STATIC void
1135S_more_xpvbm(pTHX)
1136{
1137 register XPVBM* xpvbm;
1138 register XPVBM* xpvbmend;
612f20c3
GS
1139 New(721, xpvbm, 1008/sizeof(XPVBM), XPVBM);
1140 xpvbm->xpv_pv = (char*)PL_xpvbm_arenaroot;
1141 PL_xpvbm_arenaroot = xpvbm;
1142
932e9ff9 1143 xpvbmend = &xpvbm[1008 / sizeof(XPVBM) - 1];
612f20c3 1144 PL_xpvbm_root = ++xpvbm;
932e9ff9
VB
1145 while (xpvbm < xpvbmend) {
1146 xpvbm->xpv_pv = (char*)(xpvbm + 1);
1147 xpvbm++;
1148 }
1149 xpvbm->xpv_pv = 0;
1150}
1151
7bab3ede
MB
1152#define my_safemalloc(s) (void*)safemalloc(s)
1153#define my_safefree(p) safefree((char*)p)
463ee0b2 1154
d33b2eba 1155#ifdef PURIFY
463ee0b2 1156
d33b2eba
GS
1157#define new_XIV() my_safemalloc(sizeof(XPVIV))
1158#define del_XIV(p) my_safefree(p)
ed6116ce 1159
d33b2eba
GS
1160#define new_XNV() my_safemalloc(sizeof(XPVNV))
1161#define del_XNV(p) my_safefree(p)
463ee0b2 1162
d33b2eba
GS
1163#define new_XRV() my_safemalloc(sizeof(XRV))
1164#define del_XRV(p) my_safefree(p)
8c52afec 1165
d33b2eba
GS
1166#define new_XPV() my_safemalloc(sizeof(XPV))
1167#define del_XPV(p) my_safefree(p)
9b94d1dd 1168
d33b2eba
GS
1169#define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1170#define del_XPVIV(p) my_safefree(p)
932e9ff9 1171
d33b2eba
GS
1172#define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1173#define del_XPVNV(p) my_safefree(p)
932e9ff9 1174
d33b2eba
GS
1175#define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1176#define del_XPVCV(p) my_safefree(p)
932e9ff9 1177
d33b2eba
GS
1178#define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1179#define del_XPVAV(p) my_safefree(p)
1180
1181#define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1182#define del_XPVHV(p) my_safefree(p)
1c846c1f 1183
d33b2eba
GS
1184#define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1185#define del_XPVMG(p) my_safefree(p)
1186
1187#define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1188#define del_XPVLV(p) my_safefree(p)
1189
1190#define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1191#define del_XPVBM(p) my_safefree(p)
1192
1193#else /* !PURIFY */
1194
1195#define new_XIV() (void*)new_xiv()
1196#define del_XIV(p) del_xiv((XPVIV*) p)
1197
1198#define new_XNV() (void*)new_xnv()
1199#define del_XNV(p) del_xnv((XPVNV*) p)
9b94d1dd 1200
d33b2eba
GS
1201#define new_XRV() (void*)new_xrv()
1202#define del_XRV(p) del_xrv((XRV*) p)
9b94d1dd 1203
d33b2eba
GS
1204#define new_XPV() (void*)new_xpv()
1205#define del_XPV(p) del_xpv((XPV *)p)
1206
1207#define new_XPVIV() (void*)new_xpviv()
1208#define del_XPVIV(p) del_xpviv((XPVIV *)p)
1209
1210#define new_XPVNV() (void*)new_xpvnv()
1211#define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1212
1213#define new_XPVCV() (void*)new_xpvcv()
1214#define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1215
1216#define new_XPVAV() (void*)new_xpvav()
1217#define del_XPVAV(p) del_xpvav((XPVAV *)p)
1218
1219#define new_XPVHV() (void*)new_xpvhv()
1220#define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1c846c1f 1221
d33b2eba
GS
1222#define new_XPVMG() (void*)new_xpvmg()
1223#define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1224
1225#define new_XPVLV() (void*)new_xpvlv()
1226#define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1227
1228#define new_XPVBM() (void*)new_xpvbm()
1229#define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1230
1231#endif /* PURIFY */
9b94d1dd 1232
d33b2eba
GS
1233#define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1234#define del_XPVGV(p) my_safefree(p)
1c846c1f 1235
d33b2eba
GS
1236#define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1237#define del_XPVFM(p) my_safefree(p)
1c846c1f 1238
d33b2eba
GS
1239#define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1240#define del_XPVIO(p) my_safefree(p)
8990e307 1241
954c1994
GS
1242/*
1243=for apidoc sv_upgrade
1244
ff276b08 1245Upgrade an SV to a more complex form. Generally adds a new body type to the
645c22ef 1246SV, then copies across as much information as possible from the old body.
ff276b08 1247You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
954c1994
GS
1248
1249=cut
1250*/
1251
79072805 1252bool
864dbfa3 1253Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
79072805 1254{
c04a4dfe
JH
1255 char* pv = NULL;
1256 U32 cur = 0;
1257 U32 len = 0;
1258 IV iv = 0;
1259 NV nv = 0.0;
1260 MAGIC* magic = NULL;
1261 HV* stash = Nullhv;
79072805 1262
765f542d
NC
1263 if (mt != SVt_PV && SvIsCOW(sv)) {
1264 sv_force_normal_flags(sv, 0);
f130fd45
NIS
1265 }
1266
79072805
LW
1267 if (SvTYPE(sv) == mt)
1268 return TRUE;
1269
a5f75d66
AD
1270 if (mt < SVt_PVIV)
1271 (void)SvOOK_off(sv);
1272
79072805
LW
1273 switch (SvTYPE(sv)) {
1274 case SVt_NULL:
1275 pv = 0;
1276 cur = 0;
1277 len = 0;
1278 iv = 0;
1279 nv = 0.0;
1280 magic = 0;
1281 stash = 0;
1282 break;
79072805
LW
1283 case SVt_IV:
1284 pv = 0;
1285 cur = 0;
1286 len = 0;
463ee0b2 1287 iv = SvIVX(sv);
65202027 1288 nv = (NV)SvIVX(sv);
79072805
LW
1289 del_XIV(SvANY(sv));
1290 magic = 0;
1291 stash = 0;
ed6116ce 1292 if (mt == SVt_NV)
463ee0b2 1293 mt = SVt_PVNV;
ed6116ce
LW
1294 else if (mt < SVt_PVIV)
1295 mt = SVt_PVIV;
79072805
LW
1296 break;
1297 case SVt_NV:
1298 pv = 0;
1299 cur = 0;
1300 len = 0;
463ee0b2 1301 nv = SvNVX(sv);
1bd302c3 1302 iv = I_V(nv);
79072805
LW
1303 magic = 0;
1304 stash = 0;
1305 del_XNV(SvANY(sv));
1306 SvANY(sv) = 0;
ed6116ce 1307 if (mt < SVt_PVNV)
79072805
LW
1308 mt = SVt_PVNV;
1309 break;
ed6116ce
LW
1310 case SVt_RV:
1311 pv = (char*)SvRV(sv);
1312 cur = 0;
1313 len = 0;
56431972
RB
1314 iv = PTR2IV(pv);
1315 nv = PTR2NV(pv);
ed6116ce
LW
1316 del_XRV(SvANY(sv));
1317 magic = 0;
1318 stash = 0;
1319 break;
79072805 1320 case SVt_PV:
463ee0b2 1321 pv = SvPVX(sv);
79072805
LW
1322 cur = SvCUR(sv);
1323 len = SvLEN(sv);
1324 iv = 0;
1325 nv = 0.0;
1326 magic = 0;
1327 stash = 0;
1328 del_XPV(SvANY(sv));
748a9306
LW
1329 if (mt <= SVt_IV)
1330 mt = SVt_PVIV;
1331 else if (mt == SVt_NV)
1332 mt = SVt_PVNV;
79072805
LW
1333 break;
1334 case SVt_PVIV:
463ee0b2 1335 pv = SvPVX(sv);
79072805
LW
1336 cur = SvCUR(sv);
1337 len = SvLEN(sv);
463ee0b2 1338 iv = SvIVX(sv);
79072805
LW
1339 nv = 0.0;
1340 magic = 0;
1341 stash = 0;
1342 del_XPVIV(SvANY(sv));
1343 break;
1344 case SVt_PVNV:
463ee0b2 1345 pv = SvPVX(sv);
79072805
LW
1346 cur = SvCUR(sv);
1347 len = SvLEN(sv);
463ee0b2
LW
1348 iv = SvIVX(sv);
1349 nv = SvNVX(sv);
79072805
LW
1350 magic = 0;
1351 stash = 0;
1352 del_XPVNV(SvANY(sv));
1353 break;
1354 case SVt_PVMG:
463ee0b2 1355 pv = SvPVX(sv);
79072805
LW
1356 cur = SvCUR(sv);
1357 len = SvLEN(sv);
463ee0b2
LW
1358 iv = SvIVX(sv);
1359 nv = SvNVX(sv);
79072805
LW
1360 magic = SvMAGIC(sv);
1361 stash = SvSTASH(sv);
1362 del_XPVMG(SvANY(sv));
1363 break;
1364 default:
cea2e8a9 1365 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
79072805
LW
1366 }
1367
1368 switch (mt) {
1369 case SVt_NULL:
cea2e8a9 1370 Perl_croak(aTHX_ "Can't upgrade to undef");
79072805
LW
1371 case SVt_IV:
1372 SvANY(sv) = new_XIV();
463ee0b2 1373 SvIVX(sv) = iv;
79072805
LW
1374 break;
1375 case SVt_NV:
1376 SvANY(sv) = new_XNV();
463ee0b2 1377 SvNVX(sv) = nv;
79072805 1378 break;
ed6116ce
LW
1379 case SVt_RV:
1380 SvANY(sv) = new_XRV();
1381 SvRV(sv) = (SV*)pv;
ed6116ce 1382 break;
79072805
LW
1383 case SVt_PV:
1384 SvANY(sv) = new_XPV();
463ee0b2 1385 SvPVX(sv) = pv;
79072805
LW
1386 SvCUR(sv) = cur;
1387 SvLEN(sv) = len;
1388 break;
1389 case SVt_PVIV:
1390 SvANY(sv) = new_XPVIV();
463ee0b2 1391 SvPVX(sv) = pv;
79072805
LW
1392 SvCUR(sv) = cur;
1393 SvLEN(sv) = len;
463ee0b2 1394 SvIVX(sv) = iv;
79072805 1395 if (SvNIOK(sv))
a0d0e21e 1396 (void)SvIOK_on(sv);
79072805
LW
1397 SvNOK_off(sv);
1398 break;
1399 case SVt_PVNV:
1400 SvANY(sv) = new_XPVNV();
463ee0b2 1401 SvPVX(sv) = pv;
79072805
LW
1402 SvCUR(sv) = cur;
1403 SvLEN(sv) = len;
463ee0b2
LW
1404 SvIVX(sv) = iv;
1405 SvNVX(sv) = nv;
79072805
LW
1406 break;
1407 case SVt_PVMG:
1408 SvANY(sv) = new_XPVMG();
463ee0b2 1409 SvPVX(sv) = pv;
79072805
LW
1410 SvCUR(sv) = cur;
1411 SvLEN(sv) = len;
463ee0b2
LW
1412 SvIVX(sv) = iv;
1413 SvNVX(sv) = nv;
79072805
LW
1414 SvMAGIC(sv) = magic;
1415 SvSTASH(sv) = stash;
1416 break;
1417 case SVt_PVLV:
1418 SvANY(sv) = new_XPVLV();
463ee0b2 1419 SvPVX(sv) = pv;
79072805
LW
1420 SvCUR(sv) = cur;
1421 SvLEN(sv) = len;
463ee0b2
LW
1422 SvIVX(sv) = iv;
1423 SvNVX(sv) = nv;
79072805
LW
1424 SvMAGIC(sv) = magic;
1425 SvSTASH(sv) = stash;
1426 LvTARGOFF(sv) = 0;
1427 LvTARGLEN(sv) = 0;
1428 LvTARG(sv) = 0;
1429 LvTYPE(sv) = 0;
1430 break;
1431 case SVt_PVAV:
1432 SvANY(sv) = new_XPVAV();
463ee0b2
LW
1433 if (pv)
1434 Safefree(pv);
2304df62 1435 SvPVX(sv) = 0;
d1bf51dd 1436 AvMAX(sv) = -1;
93965878 1437 AvFILLp(sv) = -1;
463ee0b2
LW
1438 SvIVX(sv) = 0;
1439 SvNVX(sv) = 0.0;
1440 SvMAGIC(sv) = magic;
1441 SvSTASH(sv) = stash;
1442 AvALLOC(sv) = 0;
79072805
LW
1443 AvARYLEN(sv) = 0;
1444 AvFLAGS(sv) = 0;
1445 break;
1446 case SVt_PVHV:
1447 SvANY(sv) = new_XPVHV();
463ee0b2
LW
1448 if (pv)
1449 Safefree(pv);
1450 SvPVX(sv) = 0;
1451 HvFILL(sv) = 0;
1452 HvMAX(sv) = 0;
8aacddc1
NIS
1453 HvTOTALKEYS(sv) = 0;
1454 HvPLACEHOLDERS(sv) = 0;
79072805
LW
1455 SvMAGIC(sv) = magic;
1456 SvSTASH(sv) = stash;
79072805
LW
1457 HvRITER(sv) = 0;
1458 HvEITER(sv) = 0;
1459 HvPMROOT(sv) = 0;
1460 HvNAME(sv) = 0;
79072805
LW
1461 break;
1462 case SVt_PVCV:
1463 SvANY(sv) = new_XPVCV();
748a9306 1464 Zero(SvANY(sv), 1, XPVCV);
463ee0b2 1465 SvPVX(sv) = pv;
79072805
LW
1466 SvCUR(sv) = cur;
1467 SvLEN(sv) = len;
463ee0b2
LW
1468 SvIVX(sv) = iv;
1469 SvNVX(sv) = nv;
79072805
LW
1470 SvMAGIC(sv) = magic;
1471 SvSTASH(sv) = stash;
79072805
LW
1472 break;
1473 case SVt_PVGV:
1474 SvANY(sv) = new_XPVGV();
463ee0b2 1475 SvPVX(sv) = pv;
79072805
LW
1476 SvCUR(sv) = cur;
1477 SvLEN(sv) = len;
463ee0b2
LW
1478 SvIVX(sv) = iv;
1479 SvNVX(sv) = nv;
79072805
LW
1480 SvMAGIC(sv) = magic;
1481 SvSTASH(sv) = stash;
93a17b20 1482 GvGP(sv) = 0;
79072805
LW
1483 GvNAME(sv) = 0;
1484 GvNAMELEN(sv) = 0;
1485 GvSTASH(sv) = 0;
a5f75d66 1486 GvFLAGS(sv) = 0;
79072805
LW
1487 break;
1488 case SVt_PVBM:
1489 SvANY(sv) = new_XPVBM();
463ee0b2 1490 SvPVX(sv) = pv;
79072805
LW
1491 SvCUR(sv) = cur;
1492 SvLEN(sv) = len;
463ee0b2
LW
1493 SvIVX(sv) = iv;
1494 SvNVX(sv) = nv;
79072805
LW
1495 SvMAGIC(sv) = magic;
1496 SvSTASH(sv) = stash;
1497 BmRARE(sv) = 0;
1498 BmUSEFUL(sv) = 0;
1499 BmPREVIOUS(sv) = 0;
1500 break;
1501 case SVt_PVFM:
1502 SvANY(sv) = new_XPVFM();
748a9306 1503 Zero(SvANY(sv), 1, XPVFM);
463ee0b2 1504 SvPVX(sv) = pv;
79072805
LW
1505 SvCUR(sv) = cur;
1506 SvLEN(sv) = len;
463ee0b2
LW
1507 SvIVX(sv) = iv;
1508 SvNVX(sv) = nv;
79072805
LW
1509 SvMAGIC(sv) = magic;
1510 SvSTASH(sv) = stash;
79072805 1511 break;
8990e307
LW
1512 case SVt_PVIO:
1513 SvANY(sv) = new_XPVIO();
748a9306 1514 Zero(SvANY(sv), 1, XPVIO);
8990e307
LW
1515 SvPVX(sv) = pv;
1516 SvCUR(sv) = cur;
1517 SvLEN(sv) = len;
1518 SvIVX(sv) = iv;
1519 SvNVX(sv) = nv;
1520 SvMAGIC(sv) = magic;
1521 SvSTASH(sv) = stash;
85e6fe83 1522 IoPAGE_LEN(sv) = 60;
8990e307
LW
1523 break;
1524 }
1525 SvFLAGS(sv) &= ~SVTYPEMASK;
1526 SvFLAGS(sv) |= mt;
79072805
LW
1527 return TRUE;
1528}
1529
645c22ef
DM
1530/*
1531=for apidoc sv_backoff
1532
1533Remove any string offset. You should normally use the C<SvOOK_off> macro
1534wrapper instead.
1535
1536=cut
1537*/
1538
79072805 1539int
864dbfa3 1540Perl_sv_backoff(pTHX_ register SV *sv)
79072805
LW
1541{
1542 assert(SvOOK(sv));
463ee0b2
LW
1543 if (SvIVX(sv)) {
1544 char *s = SvPVX(sv);
1545 SvLEN(sv) += SvIVX(sv);
1546 SvPVX(sv) -= SvIVX(sv);
79072805 1547 SvIV_set(sv, 0);
463ee0b2 1548 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
79072805
LW
1549 }
1550 SvFLAGS(sv) &= ~SVf_OOK;
a0d0e21e 1551 return 0;
79072805
LW
1552}
1553
954c1994
GS
1554/*
1555=for apidoc sv_grow
1556
645c22ef
DM
1557Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
1558upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
1559Use the C<SvGROW> wrapper instead.
954c1994
GS
1560
1561=cut
1562*/
1563
79072805 1564char *
864dbfa3 1565Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
79072805
LW
1566{
1567 register char *s;
1568
54f0641b
NIS
1569
1570
55497cff 1571#ifdef HAS_64K_LIMIT
79072805 1572 if (newlen >= 0x10000) {
1d7c1841
GS
1573 PerlIO_printf(Perl_debug_log,
1574 "Allocation too large: %"UVxf"\n", (UV)newlen);
79072805
LW
1575 my_exit(1);
1576 }
55497cff 1577#endif /* HAS_64K_LIMIT */
a0d0e21e
LW
1578 if (SvROK(sv))
1579 sv_unref(sv);
79072805
LW
1580 if (SvTYPE(sv) < SVt_PV) {
1581 sv_upgrade(sv, SVt_PV);
463ee0b2 1582 s = SvPVX(sv);
79072805
LW
1583 }
1584 else if (SvOOK(sv)) { /* pv is offset? */
1585 sv_backoff(sv);
463ee0b2 1586 s = SvPVX(sv);
79072805
LW
1587 if (newlen > SvLEN(sv))
1588 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
c6f8c383
GA
1589#ifdef HAS_64K_LIMIT
1590 if (newlen >= 0x10000)
1591 newlen = 0xFFFF;
1592#endif
79072805
LW
1593 }
1594 else
463ee0b2 1595 s = SvPVX(sv);
54f0641b 1596
79072805 1597 if (newlen > SvLEN(sv)) { /* need more room? */
8d6dde3e 1598 if (SvLEN(sv) && s) {
7bab3ede 1599#ifdef MYMALLOC
8d6dde3e
IZ
1600 STRLEN l = malloced_size((void*)SvPVX(sv));
1601 if (newlen <= l) {
1602 SvLEN_set(sv, l);
1603 return s;
1604 } else
c70c8a0a 1605#endif
79072805 1606 Renew(s,newlen,char);
8d6dde3e 1607 }
4e83176d 1608 else {
4e83176d 1609 New(703, s, newlen, char);
40565179 1610 if (SvPVX(sv) && SvCUR(sv)) {
54f0641b 1611 Move(SvPVX(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
40565179 1612 }
4e83176d 1613 }
79072805
LW
1614 SvPV_set(sv, s);
1615 SvLEN_set(sv, newlen);
1616 }
1617 return s;
1618}
1619
954c1994
GS
1620/*
1621=for apidoc sv_setiv
1622
645c22ef
DM
1623Copies an integer into the given SV, upgrading first if necessary.
1624Does not handle 'set' magic. See also C<sv_setiv_mg>.
954c1994
GS
1625
1626=cut
1627*/
1628
79072805 1629void
864dbfa3 1630Perl_sv_setiv(pTHX_ register SV *sv, IV i)
79072805 1631{
765f542d 1632 SV_CHECK_THINKFIRST_COW_DROP(sv);
463ee0b2
LW
1633 switch (SvTYPE(sv)) {
1634 case SVt_NULL:
79072805 1635 sv_upgrade(sv, SVt_IV);
463ee0b2
LW
1636 break;
1637 case SVt_NV:
1638 sv_upgrade(sv, SVt_PVNV);
1639 break;
ed6116ce 1640 case SVt_RV:
463ee0b2 1641 case SVt_PV:
79072805 1642 sv_upgrade(sv, SVt_PVIV);
463ee0b2 1643 break;
a0d0e21e
LW
1644
1645 case SVt_PVGV:
a0d0e21e
LW
1646 case SVt_PVAV:
1647 case SVt_PVHV:
1648 case SVt_PVCV:
1649 case SVt_PVFM:
1650 case SVt_PVIO:
411caa50 1651 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
53e06cf0 1652 OP_DESC(PL_op));
463ee0b2 1653 }
a0d0e21e 1654 (void)SvIOK_only(sv); /* validate number */
a5f75d66 1655 SvIVX(sv) = i;
463ee0b2 1656 SvTAINT(sv);
79072805
LW
1657}
1658
954c1994
GS
1659/*
1660=for apidoc sv_setiv_mg
1661
1662Like C<sv_setiv>, but also handles 'set' magic.
1663
1664=cut
1665*/
1666
79072805 1667void
864dbfa3 1668Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
ef50df4b
GS
1669{
1670 sv_setiv(sv,i);
1671 SvSETMAGIC(sv);
1672}
1673
954c1994
GS
1674/*
1675=for apidoc sv_setuv
1676
645c22ef
DM
1677Copies an unsigned integer into the given SV, upgrading first if necessary.
1678Does not handle 'set' magic. See also C<sv_setuv_mg>.
954c1994
GS
1679
1680=cut
1681*/
1682
ef50df4b 1683void
864dbfa3 1684Perl_sv_setuv(pTHX_ register SV *sv, UV u)
55497cff 1685{
55ada374
NC
1686 /* With these two if statements:
1687 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
d460ef45 1688
55ada374
NC
1689 without
1690 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
d460ef45 1691
55ada374
NC
1692 If you wish to remove them, please benchmark to see what the effect is
1693 */
28e5dec8
JH
1694 if (u <= (UV)IV_MAX) {
1695 sv_setiv(sv, (IV)u);
1696 return;
1697 }
25da4f38
IZ
1698 sv_setiv(sv, 0);
1699 SvIsUV_on(sv);
1700 SvUVX(sv) = u;
55497cff 1701}
1702
954c1994
GS
1703/*
1704=for apidoc sv_setuv_mg
1705
1706Like C<sv_setuv>, but also handles 'set' magic.
1707
1708=cut
1709*/
1710
55497cff 1711void
864dbfa3 1712Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
ef50df4b 1713{
55ada374
NC
1714 /* With these two if statements:
1715 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
d460ef45 1716
55ada374
NC
1717 without
1718 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
d460ef45 1719
55ada374
NC
1720 If you wish to remove them, please benchmark to see what the effect is
1721 */
28e5dec8
JH
1722 if (u <= (UV)IV_MAX) {
1723 sv_setiv(sv, (IV)u);
1724 } else {
1725 sv_setiv(sv, 0);
1726 SvIsUV_on(sv);
1727 sv_setuv(sv,u);
1728 }
ef50df4b
GS
1729 SvSETMAGIC(sv);
1730}
1731
954c1994
GS
1732/*
1733=for apidoc sv_setnv
1734
645c22ef
DM
1735Copies a double into the given SV, upgrading first if necessary.
1736Does not handle 'set' magic. See also C<sv_setnv_mg>.
954c1994
GS
1737
1738=cut
1739*/
1740
ef50df4b 1741void
65202027 1742Perl_sv_setnv(pTHX_ register SV *sv, NV num)
79072805 1743{
765f542d 1744 SV_CHECK_THINKFIRST_COW_DROP(sv);
a0d0e21e
LW
1745 switch (SvTYPE(sv)) {
1746 case SVt_NULL:
1747 case SVt_IV:
79072805 1748 sv_upgrade(sv, SVt_NV);
a0d0e21e 1749 break;
a0d0e21e
LW
1750 case SVt_RV:
1751 case SVt_PV:
1752 case SVt_PVIV:
79072805 1753 sv_upgrade(sv, SVt_PVNV);
a0d0e21e 1754 break;
827b7e14 1755
a0d0e21e 1756 case SVt_PVGV:
a0d0e21e
LW
1757 case SVt_PVAV:
1758 case SVt_PVHV:
1759 case SVt_PVCV:
1760 case SVt_PVFM:
1761 case SVt_PVIO:
411caa50 1762 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
53e06cf0 1763 OP_NAME(PL_op));
79072805 1764 }
463ee0b2 1765 SvNVX(sv) = num;
a0d0e21e 1766 (void)SvNOK_only(sv); /* validate number */
463ee0b2 1767 SvTAINT(sv);
79072805
LW
1768}
1769
954c1994
GS
1770/*
1771=for apidoc sv_setnv_mg
1772
1773Like C<sv_setnv>, but also handles 'set' magic.
1774
1775=cut
1776*/
1777
ef50df4b 1778void
65202027 1779Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
ef50df4b
GS
1780{
1781 sv_setnv(sv,num);
1782 SvSETMAGIC(sv);
1783}
1784
645c22ef
DM
1785/* Print an "isn't numeric" warning, using a cleaned-up,
1786 * printable version of the offending string
1787 */
1788
76e3520e 1789STATIC void
cea2e8a9 1790S_not_a_number(pTHX_ SV *sv)
a0d0e21e 1791{
94463019
JH
1792 SV *dsv;
1793 char tmpbuf[64];
1794 char *pv;
1795
1796 if (DO_UTF8(sv)) {
1797 dsv = sv_2mortal(newSVpv("", 0));
1798 pv = sv_uni_display(dsv, sv, 10, 0);
1799 } else {
1800 char *d = tmpbuf;
1801 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
1802 /* each *s can expand to 4 chars + "...\0",
1803 i.e. need room for 8 chars */
ecdeb87c 1804
94463019
JH
1805 char *s, *end;
1806 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
1807 int ch = *s & 0xFF;
1808 if (ch & 128 && !isPRINT_LC(ch)) {
1809 *d++ = 'M';
1810 *d++ = '-';
1811 ch &= 127;
1812 }
1813 if (ch == '\n') {
1814 *d++ = '\\';
1815 *d++ = 'n';
1816 }
1817 else if (ch == '\r') {
1818 *d++ = '\\';
1819 *d++ = 'r';
1820 }
1821 else if (ch == '\f') {
1822 *d++ = '\\';
1823 *d++ = 'f';
1824 }
1825 else if (ch == '\\') {
1826 *d++ = '\\';
1827 *d++ = '\\';
1828 }
1829 else if (ch == '\0') {
1830 *d++ = '\\';
1831 *d++ = '0';
1832 }
1833 else if (isPRINT_LC(ch))
1834 *d++ = ch;
1835 else {
1836 *d++ = '^';
1837 *d++ = toCTRL(ch);
1838 }
1839 }
1840 if (s < end) {
1841 *d++ = '.';
1842 *d++ = '.';
1843 *d++ = '.';
1844 }
1845 *d = '\0';
1846 pv = tmpbuf;
a0d0e21e 1847 }
a0d0e21e 1848
533c011a 1849 if (PL_op)
9014280d 1850 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
94463019
JH
1851 "Argument \"%s\" isn't numeric in %s", pv,
1852 OP_DESC(PL_op));
a0d0e21e 1853 else
9014280d 1854 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
94463019 1855 "Argument \"%s\" isn't numeric", pv);
a0d0e21e
LW
1856}
1857
c2988b20
NC
1858/*
1859=for apidoc looks_like_number
1860
645c22ef
DM
1861Test if the content of an SV looks like a number (or is a number).
1862C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1863non-numeric warning), even if your atof() doesn't grok them.
c2988b20
NC
1864
1865=cut
1866*/
1867
1868I32
1869Perl_looks_like_number(pTHX_ SV *sv)
1870{
1871 register char *sbegin;
1872 STRLEN len;
1873
1874 if (SvPOK(sv)) {
1875 sbegin = SvPVX(sv);
1876 len = SvCUR(sv);
1877 }
1878 else if (SvPOKp(sv))
1879 sbegin = SvPV(sv, len);
1880 else
1881 return 1; /* Historic. Wrong? */
1882 return grok_number(sbegin, len, NULL);
1883}
25da4f38
IZ
1884
1885/* Actually, ISO C leaves conversion of UV to IV undefined, but
1886 until proven guilty, assume that things are not that bad... */
1887
645c22ef
DM
1888/*
1889 NV_PRESERVES_UV:
1890
1891 As 64 bit platforms often have an NV that doesn't preserve all bits of
28e5dec8
JH
1892 an IV (an assumption perl has been based on to date) it becomes necessary
1893 to remove the assumption that the NV always carries enough precision to
1894 recreate the IV whenever needed, and that the NV is the canonical form.
1895 Instead, IV/UV and NV need to be given equal rights. So as to not lose
645c22ef 1896 precision as a side effect of conversion (which would lead to insanity
28e5dec8
JH
1897 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
1898 1) to distinguish between IV/UV/NV slots that have cached a valid
1899 conversion where precision was lost and IV/UV/NV slots that have a
1900 valid conversion which has lost no precision
645c22ef 1901 2) to ensure that if a numeric conversion to one form is requested that
28e5dec8
JH
1902 would lose precision, the precise conversion (or differently
1903 imprecise conversion) is also performed and cached, to prevent
1904 requests for different numeric formats on the same SV causing
1905 lossy conversion chains. (lossless conversion chains are perfectly
1906 acceptable (still))
1907
1908
1909 flags are used:
1910 SvIOKp is true if the IV slot contains a valid value
1911 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
1912 SvNOKp is true if the NV slot contains a valid value
1913 SvNOK is true only if the NV value is accurate
1914
1915 so
645c22ef 1916 while converting from PV to NV, check to see if converting that NV to an
28e5dec8
JH
1917 IV(or UV) would lose accuracy over a direct conversion from PV to
1918 IV(or UV). If it would, cache both conversions, return NV, but mark
1919 SV as IOK NOKp (ie not NOK).
1920
645c22ef 1921 While converting from PV to IV, check to see if converting that IV to an
28e5dec8
JH
1922 NV would lose accuracy over a direct conversion from PV to NV. If it
1923 would, cache both conversions, flag similarly.
1924
1925 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
1926 correctly because if IV & NV were set NV *always* overruled.
645c22ef
DM
1927 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
1928 changes - now IV and NV together means that the two are interchangeable:
28e5dec8 1929 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
d460ef45 1930
645c22ef
DM
1931 The benefit of this is that operations such as pp_add know that if
1932 SvIOK is true for both left and right operands, then integer addition
1933 can be used instead of floating point (for cases where the result won't
1934 overflow). Before, floating point was always used, which could lead to
28e5dec8
JH
1935 loss of precision compared with integer addition.
1936
1937 * making IV and NV equal status should make maths accurate on 64 bit
1938 platforms
1939 * may speed up maths somewhat if pp_add and friends start to use
645c22ef 1940 integers when possible instead of fp. (Hopefully the overhead in
28e5dec8
JH
1941 looking for SvIOK and checking for overflow will not outweigh the
1942 fp to integer speedup)
1943 * will slow down integer operations (callers of SvIV) on "inaccurate"
1944 values, as the change from SvIOK to SvIOKp will cause a call into
1945 sv_2iv each time rather than a macro access direct to the IV slot
1946 * should speed up number->string conversion on integers as IV is
645c22ef 1947 favoured when IV and NV are equally accurate
28e5dec8
JH
1948
1949 ####################################################################
645c22ef
DM
1950 You had better be using SvIOK_notUV if you want an IV for arithmetic:
1951 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
1952 On the other hand, SvUOK is true iff UV.
28e5dec8
JH
1953 ####################################################################
1954
645c22ef 1955 Your mileage will vary depending your CPU's relative fp to integer
28e5dec8
JH
1956 performance ratio.
1957*/
1958
1959#ifndef NV_PRESERVES_UV
645c22ef
DM
1960# define IS_NUMBER_UNDERFLOW_IV 1
1961# define IS_NUMBER_UNDERFLOW_UV 2
1962# define IS_NUMBER_IV_AND_UV 2
1963# define IS_NUMBER_OVERFLOW_IV 4
1964# define IS_NUMBER_OVERFLOW_UV 5
1965
1966/* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
28e5dec8
JH
1967
1968/* For sv_2nv these three cases are "SvNOK and don't bother casting" */
1969STATIC int
645c22ef 1970S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
28e5dec8 1971{
1779d84d 1972 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_2iuv_non '%s', IV=0x%"UVxf" NV=%"NVgf" inttype=%"UVXf"\n", SvPVX(sv), SvIVX(sv), SvNVX(sv), (UV)numtype));
28e5dec8
JH
1973 if (SvNVX(sv) < (NV)IV_MIN) {
1974 (void)SvIOKp_on(sv);
1975 (void)SvNOK_on(sv);
1976 SvIVX(sv) = IV_MIN;
1977 return IS_NUMBER_UNDERFLOW_IV;
1978 }
1979 if (SvNVX(sv) > (NV)UV_MAX) {
1980 (void)SvIOKp_on(sv);
1981 (void)SvNOK_on(sv);
1982 SvIsUV_on(sv);
1983 SvUVX(sv) = UV_MAX;
1984 return IS_NUMBER_OVERFLOW_UV;
1985 }
c2988b20
NC
1986 (void)SvIOKp_on(sv);
1987 (void)SvNOK_on(sv);
1988 /* Can't use strtol etc to convert this string. (See truth table in
1989 sv_2iv */
1990 if (SvNVX(sv) <= (UV)IV_MAX) {
1991 SvIVX(sv) = I_V(SvNVX(sv));
1992 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
1993 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
1994 } else {
1995 /* Integer is imprecise. NOK, IOKp */
1996 }
1997 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
1998 }
1999 SvIsUV_on(sv);
2000 SvUVX(sv) = U_V(SvNVX(sv));
2001 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2002 if (SvUVX(sv) == UV_MAX) {
2003 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2004 possibly be preserved by NV. Hence, it must be overflow.
2005 NOK, IOKp */
2006 return IS_NUMBER_OVERFLOW_UV;
2007 }
2008 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2009 } else {
2010 /* Integer is imprecise. NOK, IOKp */
28e5dec8 2011 }
c2988b20 2012 return IS_NUMBER_OVERFLOW_IV;
28e5dec8 2013}
645c22ef
DM
2014#endif /* !NV_PRESERVES_UV*/
2015
2016/*
2017=for apidoc sv_2iv
2018
2019Return the integer value of an SV, doing any necessary string conversion,
2020magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
2021
2022=cut
2023*/
28e5dec8 2024
a0d0e21e 2025IV
864dbfa3 2026Perl_sv_2iv(pTHX_ register SV *sv)
79072805
LW
2027{
2028 if (!sv)
2029 return 0;
8990e307 2030 if (SvGMAGICAL(sv)) {
463ee0b2
LW
2031 mg_get(sv);
2032 if (SvIOKp(sv))
2033 return SvIVX(sv);
748a9306 2034 if (SvNOKp(sv)) {
25da4f38 2035 return I_V(SvNVX(sv));
748a9306 2036 }
36477c24 2037 if (SvPOKp(sv) && SvLEN(sv))
2038 return asIV(sv);
3fe9a6f1 2039 if (!SvROK(sv)) {
d008e5eb 2040 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 2041 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
1d7c1841 2042 report_uninit();
c6ee37c5 2043 }
36477c24 2044 return 0;
3fe9a6f1 2045 }
463ee0b2 2046 }
ed6116ce 2047 if (SvTHINKFIRST(sv)) {
a0d0e21e 2048 if (SvROK(sv)) {
a0d0e21e 2049 SV* tmpstr;
1554e226 2050 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
b4b9a328 2051 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
9e7bc3e8 2052 return SvIV(tmpstr);
56431972 2053 return PTR2IV(SvRV(sv));
a0d0e21e 2054 }
765f542d
NC
2055 if (SvIsCOW(sv)) {
2056 sv_force_normal_flags(sv, 0);
47deb5e7 2057 }
0336b60e 2058 if (SvREADONLY(sv) && !SvOK(sv)) {
0336b60e 2059 if (ckWARN(WARN_UNINITIALIZED))
1d7c1841 2060 report_uninit();
ed6116ce
LW
2061 return 0;
2062 }
79072805 2063 }
25da4f38
IZ
2064 if (SvIOKp(sv)) {
2065 if (SvIsUV(sv)) {
2066 return (IV)(SvUVX(sv));
2067 }
2068 else {
2069 return SvIVX(sv);
2070 }
463ee0b2 2071 }
748a9306 2072 if (SvNOKp(sv)) {
28e5dec8
JH
2073 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2074 * without also getting a cached IV/UV from it at the same time
2075 * (ie PV->NV conversion should detect loss of accuracy and cache
2076 * IV or UV at same time to avoid this. NWC */
25da4f38
IZ
2077
2078 if (SvTYPE(sv) == SVt_NV)
2079 sv_upgrade(sv, SVt_PVNV);
2080
28e5dec8
JH
2081 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2082 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2083 certainly cast into the IV range at IV_MAX, whereas the correct
2084 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2085 cases go to UV */
2086 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
748a9306 2087 SvIVX(sv) = I_V(SvNVX(sv));
28e5dec8
JH
2088 if (SvNVX(sv) == (NV) SvIVX(sv)
2089#ifndef NV_PRESERVES_UV
2090 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2091 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2092 /* Don't flag it as "accurately an integer" if the number
2093 came from a (by definition imprecise) NV operation, and
2094 we're outside the range of NV integer precision */
2095#endif
2096 ) {
2097 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2098 DEBUG_c(PerlIO_printf(Perl_debug_log,
7234c960 2099 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
28e5dec8
JH
2100 PTR2UV(sv),
2101 SvNVX(sv),
2102 SvIVX(sv)));
2103
2104 } else {
2105 /* IV not precise. No need to convert from PV, as NV
2106 conversion would already have cached IV if it detected
2107 that PV->IV would be better than PV->NV->IV
2108 flags already correct - don't set public IOK. */
2109 DEBUG_c(PerlIO_printf(Perl_debug_log,
7234c960 2110 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
28e5dec8
JH
2111 PTR2UV(sv),
2112 SvNVX(sv),
2113 SvIVX(sv)));
2114 }
2115 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2116 but the cast (NV)IV_MIN rounds to a the value less (more
2117 negative) than IV_MIN which happens to be equal to SvNVX ??
2118 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2119 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2120 (NV)UVX == NVX are both true, but the values differ. :-(
2121 Hopefully for 2s complement IV_MIN is something like
2122 0x8000000000000000 which will be exact. NWC */
d460ef45 2123 }
25da4f38 2124 else {
ff68c719 2125 SvUVX(sv) = U_V(SvNVX(sv));
28e5dec8
JH
2126 if (
2127 (SvNVX(sv) == (NV) SvUVX(sv))
2128#ifndef NV_PRESERVES_UV
2129 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2130 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2131 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2132 /* Don't flag it as "accurately an integer" if the number
2133 came from a (by definition imprecise) NV operation, and
2134 we're outside the range of NV integer precision */
2135#endif
2136 )
2137 SvIOK_on(sv);
25da4f38
IZ
2138 SvIsUV_on(sv);
2139 ret_iv_max:
1c846c1f 2140 DEBUG_c(PerlIO_printf(Perl_debug_log,
57def98f 2141 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
56431972 2142 PTR2UV(sv),
57def98f
JH
2143 SvUVX(sv),
2144 SvUVX(sv)));
25da4f38
IZ
2145 return (IV)SvUVX(sv);
2146 }
748a9306
LW
2147 }
2148 else if (SvPOKp(sv) && SvLEN(sv)) {
c2988b20
NC
2149 UV value;
2150 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
25da4f38
IZ
2151 /* We want to avoid a possible problem when we cache an IV which
2152 may be later translated to an NV, and the resulting NV is not
c2988b20
NC
2153 the same as the direct translation of the initial string
2154 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2155 be careful to ensure that the value with the .456 is around if the
2156 NV value is requested in the future).
1c846c1f 2157
25da4f38
IZ
2158 This means that if we cache such an IV, we need to cache the
2159 NV as well. Moreover, we trade speed for space, and do not
28e5dec8 2160 cache the NV if we are sure it's not needed.
25da4f38 2161 */
16b7a9a4 2162
c2988b20
NC
2163 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2164 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2165 == IS_NUMBER_IN_UV) {
5e045b90 2166 /* It's definitely an integer, only upgrade to PVIV */
28e5dec8
JH
2167 if (SvTYPE(sv) < SVt_PVIV)
2168 sv_upgrade(sv, SVt_PVIV);
f7bbb42a 2169 (void)SvIOK_on(sv);
c2988b20
NC
2170 } else if (SvTYPE(sv) < SVt_PVNV)
2171 sv_upgrade(sv, SVt_PVNV);
28e5dec8 2172
c2988b20
NC
2173 /* If NV preserves UV then we only use the UV value if we know that
2174 we aren't going to call atof() below. If NVs don't preserve UVs
2175 then the value returned may have more precision than atof() will
2176 return, even though value isn't perfectly accurate. */
2177 if ((numtype & (IS_NUMBER_IN_UV
2178#ifdef NV_PRESERVES_UV
2179 | IS_NUMBER_NOT_INT
2180#endif
2181 )) == IS_NUMBER_IN_UV) {
2182 /* This won't turn off the public IOK flag if it was set above */
2183 (void)SvIOKp_on(sv);
2184
2185 if (!(numtype & IS_NUMBER_NEG)) {
2186 /* positive */;
2187 if (value <= (UV)IV_MAX) {
2188 SvIVX(sv) = (IV)value;
2189 } else {
2190 SvUVX(sv) = value;
2191 SvIsUV_on(sv);
2192 }
2193 } else {
2194 /* 2s complement assumption */
2195 if (value <= (UV)IV_MIN) {
2196 SvIVX(sv) = -(IV)value;
2197 } else {
2198 /* Too negative for an IV. This is a double upgrade, but
d1be9408 2199 I'm assuming it will be rare. */
c2988b20
NC
2200 if (SvTYPE(sv) < SVt_PVNV)
2201 sv_upgrade(sv, SVt_PVNV);
2202 SvNOK_on(sv);
2203 SvIOK_off(sv);
2204 SvIOKp_on(sv);
2205 SvNVX(sv) = -(NV)value;
2206 SvIVX(sv) = IV_MIN;
2207 }
2208 }
2209 }
2210 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2211 will be in the previous block to set the IV slot, and the next
2212 block to set the NV slot. So no else here. */
2213
2214 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2215 != IS_NUMBER_IN_UV) {
2216 /* It wasn't an (integer that doesn't overflow the UV). */
2217 SvNVX(sv) = Atof(SvPVX(sv));
28e5dec8 2218
c2988b20
NC
2219 if (! numtype && ckWARN(WARN_NUMERIC))
2220 not_a_number(sv);
28e5dec8 2221
65202027 2222#if defined(USE_LONG_DOUBLE)
c2988b20
NC
2223 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2224 PTR2UV(sv), SvNVX(sv)));
65202027 2225#else
1779d84d 2226 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
c2988b20 2227 PTR2UV(sv), SvNVX(sv)));
65202027 2228#endif
28e5dec8
JH
2229
2230
2231#ifdef NV_PRESERVES_UV
c2988b20
NC
2232 (void)SvIOKp_on(sv);
2233 (void)SvNOK_on(sv);
2234 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2235 SvIVX(sv) = I_V(SvNVX(sv));
2236 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2237 SvIOK_on(sv);
28e5dec8 2238 } else {
c2988b20
NC
2239 /* Integer is imprecise. NOK, IOKp */
2240 }
2241 /* UV will not work better than IV */
2242 } else {
2243 if (SvNVX(sv) > (NV)UV_MAX) {
2244 SvIsUV_on(sv);
2245 /* Integer is inaccurate. NOK, IOKp, is UV */
2246 SvUVX(sv) = UV_MAX;
2247 SvIsUV_on(sv);
2248 } else {
2249 SvUVX(sv) = U_V(SvNVX(sv));
2250 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2251 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2252 SvIOK_on(sv);
28e5dec8
JH
2253 SvIsUV_on(sv);
2254 } else {
c2988b20
NC
2255 /* Integer is imprecise. NOK, IOKp, is UV */
2256 SvIsUV_on(sv);
28e5dec8 2257 }
28e5dec8 2258 }
c2988b20
NC
2259 goto ret_iv_max;
2260 }
28e5dec8 2261#else /* NV_PRESERVES_UV */
c2988b20
NC
2262 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2263 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2264 /* The IV slot will have been set from value returned by
2265 grok_number above. The NV slot has just been set using
2266 Atof. */
560b0c46 2267 SvNOK_on(sv);
c2988b20
NC
2268 assert (SvIOKp(sv));
2269 } else {
2270 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2271 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2272 /* Small enough to preserve all bits. */
2273 (void)SvIOKp_on(sv);
2274 SvNOK_on(sv);
2275 SvIVX(sv) = I_V(SvNVX(sv));
2276 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2277 SvIOK_on(sv);
2278 /* Assumption: first non-preserved integer is < IV_MAX,
2279 this NV is in the preserved range, therefore: */
2280 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2281 < (UV)IV_MAX)) {
1779d84d 2282 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs(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
2283 }
2284 } else {
2285 /* IN_UV NOT_INT
2286 0 0 already failed to read UV.
2287 0 1 already failed to read UV.
2288 1 0 you won't get here in this case. IV/UV
2289 slot set, public IOK, Atof() unneeded.
2290 1 1 already read UV.
2291 so there's no point in sv_2iuv_non_preserve() attempting
2292 to use atol, strtol, strtoul etc. */
2293 if (sv_2iuv_non_preserve (sv, numtype)
2294 >= IS_NUMBER_OVERFLOW_IV)
2295 goto ret_iv_max;
2296 }
2297 }
28e5dec8 2298#endif /* NV_PRESERVES_UV */
25da4f38 2299 }
28e5dec8 2300 } else {
599cee73 2301 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
1d7c1841 2302 report_uninit();
25da4f38
IZ
2303 if (SvTYPE(sv) < SVt_IV)
2304 /* Typically the caller expects that sv_any is not NULL now. */
2305 sv_upgrade(sv, SVt_IV);
a0d0e21e 2306 return 0;
79072805 2307 }
1d7c1841
GS
2308 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2309 PTR2UV(sv),SvIVX(sv)));
25da4f38 2310 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
79072805
LW
2311}
2312
645c22ef
DM
2313/*
2314=for apidoc sv_2uv
2315
2316Return the unsigned integer value of an SV, doing any necessary string
2317conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
2318macros.
2319
2320=cut
2321*/
2322
ff68c719 2323UV
864dbfa3 2324Perl_sv_2uv(pTHX_ register SV *sv)
ff68c719 2325{
2326 if (!sv)
2327 return 0;
2328 if (SvGMAGICAL(sv)) {
2329 mg_get(sv);
2330 if (SvIOKp(sv))
2331 return SvUVX(sv);
2332 if (SvNOKp(sv))
2333 return U_V(SvNVX(sv));
36477c24 2334 if (SvPOKp(sv) && SvLEN(sv))
2335 return asUV(sv);
3fe9a6f1 2336 if (!SvROK(sv)) {
d008e5eb 2337 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 2338 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
1d7c1841 2339 report_uninit();
c6ee37c5 2340 }
36477c24 2341 return 0;
3fe9a6f1 2342 }
ff68c719 2343 }
2344 if (SvTHINKFIRST(sv)) {
2345 if (SvROK(sv)) {
ff68c719 2346 SV* tmpstr;
1554e226 2347 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
b4b9a328 2348 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
9e7bc3e8 2349 return SvUV(tmpstr);
56431972 2350 return PTR2UV(SvRV(sv));
ff68c719 2351 }
765f542d
NC
2352 if (SvIsCOW(sv)) {
2353 sv_force_normal_flags(sv, 0);
8a818333 2354 }
0336b60e 2355 if (SvREADONLY(sv) && !SvOK(sv)) {
0336b60e 2356 if (ckWARN(WARN_UNINITIALIZED))
1d7c1841 2357 report_uninit();
ff68c719 2358 return 0;
2359 }
2360 }
25da4f38
IZ
2361 if (SvIOKp(sv)) {
2362 if (SvIsUV(sv)) {
2363 return SvUVX(sv);
2364 }
2365 else {
2366 return (UV)SvIVX(sv);
2367 }
ff68c719 2368 }
2369 if (SvNOKp(sv)) {
28e5dec8
JH
2370 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2371 * without also getting a cached IV/UV from it at the same time
2372 * (ie PV->NV conversion should detect loss of accuracy and cache
2373 * IV or UV at same time to avoid this. */
2374 /* IV-over-UV optimisation - choose to cache IV if possible */
2375
25da4f38
IZ
2376 if (SvTYPE(sv) == SVt_NV)
2377 sv_upgrade(sv, SVt_PVNV);
28e5dec8
JH
2378
2379 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2380 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
f7bbb42a 2381 SvIVX(sv) = I_V(SvNVX(sv));
28e5dec8
JH
2382 if (SvNVX(sv) == (NV) SvIVX(sv)
2383#ifndef NV_PRESERVES_UV
2384 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2385 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2386 /* Don't flag it as "accurately an integer" if the number
2387 came from a (by definition imprecise) NV operation, and
2388 we're outside the range of NV integer precision */
2389#endif
2390 ) {
2391 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2392 DEBUG_c(PerlIO_printf(Perl_debug_log,
7234c960 2393 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
28e5dec8
JH
2394 PTR2UV(sv),
2395 SvNVX(sv),
2396 SvIVX(sv)));
2397
2398 } else {
2399 /* IV not precise. No need to convert from PV, as NV
2400 conversion would already have cached IV if it detected
2401 that PV->IV would be better than PV->NV->IV
2402 flags already correct - don't set public IOK. */
2403 DEBUG_c(PerlIO_printf(Perl_debug_log,
7234c960 2404 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
28e5dec8
JH
2405 PTR2UV(sv),
2406 SvNVX(sv),
2407 SvIVX(sv)));
2408 }
2409 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2410 but the cast (NV)IV_MIN rounds to a the value less (more
2411 negative) than IV_MIN which happens to be equal to SvNVX ??
2412 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2413 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2414 (NV)UVX == NVX are both true, but the values differ. :-(
2415 Hopefully for 2s complement IV_MIN is something like
2416 0x8000000000000000 which will be exact. NWC */
d460ef45 2417 }
28e5dec8
JH
2418 else {
2419 SvUVX(sv) = U_V(SvNVX(sv));
2420 if (
2421 (SvNVX(sv) == (NV) SvUVX(sv))
2422#ifndef NV_PRESERVES_UV
2423 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2424 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2425 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2426 /* Don't flag it as "accurately an integer" if the number
2427 came from a (by definition imprecise) NV operation, and
2428 we're outside the range of NV integer precision */
2429#endif
2430 )
2431 SvIOK_on(sv);
2432 SvIsUV_on(sv);
1c846c1f 2433 DEBUG_c(PerlIO_printf(Perl_debug_log,
28e5dec8 2434 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
57def98f 2435 PTR2UV(sv),
28e5dec8
JH
2436 SvUVX(sv),
2437 SvUVX(sv)));
25da4f38 2438 }
ff68c719 2439 }
2440 else if (SvPOKp(sv) && SvLEN(sv)) {
c2988b20
NC
2441 UV value;
2442 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
25da4f38
IZ
2443
2444 /* We want to avoid a possible problem when we cache a UV which
2445 may be later translated to an NV, and the resulting NV is not
2446 the translation of the initial data.
1c846c1f 2447
25da4f38
IZ
2448 This means that if we cache such a UV, we need to cache the
2449 NV as well. Moreover, we trade speed for space, and do not
2450 cache the NV if not needed.
2451 */
16b7a9a4 2452
c2988b20
NC
2453 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2454 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2455 == IS_NUMBER_IN_UV) {
5e045b90 2456 /* It's definitely an integer, only upgrade to PVIV */
28e5dec8 2457 if (SvTYPE(sv) < SVt_PVIV)
f7bbb42a
JH
2458 sv_upgrade(sv, SVt_PVIV);
2459 (void)SvIOK_on(sv);
c2988b20
NC
2460 } else if (SvTYPE(sv) < SVt_PVNV)
2461 sv_upgrade(sv, SVt_PVNV);
d460ef45 2462
c2988b20
NC
2463 /* If NV preserves UV then we only use the UV value if we know that
2464 we aren't going to call atof() below. If NVs don't preserve UVs
2465 then the value returned may have more precision than atof() will
2466 return, even though it isn't accurate. */
2467 if ((numtype & (IS_NUMBER_IN_UV
2468#ifdef NV_PRESERVES_UV
2469 | IS_NUMBER_NOT_INT
2470#endif
2471 )) == IS_NUMBER_IN_UV) {
2472 /* This won't turn off the public IOK flag if it was set above */
2473 (void)SvIOKp_on(sv);
2474
2475 if (!(numtype & IS_NUMBER_NEG)) {
2476 /* positive */;
2477 if (value <= (UV)IV_MAX) {
2478 SvIVX(sv) = (IV)value;
28e5dec8
JH
2479 } else {
2480 /* it didn't overflow, and it was positive. */
c2988b20 2481 SvUVX(sv) = value;
28e5dec8
JH
2482 SvIsUV_on(sv);
2483 }
c2988b20
NC
2484 } else {
2485 /* 2s complement assumption */
2486 if (value <= (UV)IV_MIN) {
2487 SvIVX(sv) = -(IV)value;
2488 } else {
2489 /* Too negative for an IV. This is a double upgrade, but
d1be9408 2490 I'm assuming it will be rare. */
c2988b20
NC
2491 if (SvTYPE(sv) < SVt_PVNV)
2492 sv_upgrade(sv, SVt_PVNV);
2493 SvNOK_on(sv);
2494 SvIOK_off(sv);
2495 SvIOKp_on(sv);
2496 SvNVX(sv) = -(NV)value;
2497 SvIVX(sv) = IV_MIN;
2498 }
2499 }
2500 }
2501
2502 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2503 != IS_NUMBER_IN_UV) {
2504 /* It wasn't an integer, or it overflowed the UV. */
2505 SvNVX(sv) = Atof(SvPVX(sv));
28e5dec8 2506
c2988b20 2507 if (! numtype && ckWARN(WARN_NUMERIC))
28e5dec8
JH
2508 not_a_number(sv);
2509
2510#if defined(USE_LONG_DOUBLE)
c2988b20
NC
2511 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
2512 PTR2UV(sv), SvNVX(sv)));
28e5dec8 2513#else
1779d84d 2514 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
c2988b20 2515 PTR2UV(sv), SvNVX(sv)));
28e5dec8
JH
2516#endif
2517
2518#ifdef NV_PRESERVES_UV
c2988b20
NC
2519 (void)SvIOKp_on(sv);
2520 (void)SvNOK_on(sv);
2521 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2522 SvIVX(sv) = I_V(SvNVX(sv));
2523 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2524 SvIOK_on(sv);
2525 } else {
2526 /* Integer is imprecise. NOK, IOKp */
2527 }
2528 /* UV will not work better than IV */
2529 } else {
2530 if (SvNVX(sv) > (NV)UV_MAX) {
2531 SvIsUV_on(sv);
2532 /* Integer is inaccurate. NOK, IOKp, is UV */
2533 SvUVX(sv) = UV_MAX;
2534 SvIsUV_on(sv);
2535 } else {
2536 SvUVX(sv) = U_V(SvNVX(sv));
2537 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
2538 NV preservse UV so can do correct comparison. */
2539 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2540 SvIOK_on(sv);
2541 SvIsUV_on(sv);
2542 } else {
2543 /* Integer is imprecise. NOK, IOKp, is UV */
2544 SvIsUV_on(sv);
2545 }
2546 }
2547 }
28e5dec8 2548#else /* NV_PRESERVES_UV */
c2988b20
NC
2549 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2550 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2551 /* The UV slot will have been set from value returned by
2552 grok_number above. The NV slot has just been set using
2553 Atof. */
560b0c46 2554 SvNOK_on(sv);
c2988b20
NC
2555 assert (SvIOKp(sv));
2556 } else {
2557 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2558 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2559 /* Small enough to preserve all bits. */
2560 (void)SvIOKp_on(sv);
2561 SvNOK_on(sv);
2562 SvIVX(sv) = I_V(SvNVX(sv));
2563 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2564 SvIOK_on(sv);
2565 /* Assumption: first non-preserved integer is < IV_MAX,
2566 this NV is in the preserved range, therefore: */
2567 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2568 < (UV)IV_MAX)) {
1779d84d 2569 Perl_croak(aTHX_ "sv_2uv assumed (U_V(fabs(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
2570 }
2571 } else
2572 sv_2iuv_non_preserve (sv, numtype);
2573 }
28e5dec8 2574#endif /* NV_PRESERVES_UV */
f7bbb42a 2575 }
ff68c719 2576 }
2577 else {
d008e5eb 2578 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 2579 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
1d7c1841 2580 report_uninit();
c6ee37c5 2581 }
25da4f38
IZ
2582 if (SvTYPE(sv) < SVt_IV)
2583 /* Typically the caller expects that sv_any is not NULL now. */
2584 sv_upgrade(sv, SVt_IV);
ff68c719 2585 return 0;
2586 }
25da4f38 2587
1d7c1841
GS
2588 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
2589 PTR2UV(sv),SvUVX(sv)));
25da4f38 2590 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
ff68c719 2591}
2592
645c22ef
DM
2593/*
2594=for apidoc sv_2nv
2595
2596Return the num value of an SV, doing any necessary string or integer
2597conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
2598macros.
2599
2600=cut
2601*/
2602
65202027 2603NV
864dbfa3 2604Perl_sv_2nv(pTHX_ register SV *sv)
79072805
LW
2605{
2606 if (!sv)
2607 return 0.0;
8990e307 2608 if (SvGMAGICAL(sv)) {
463ee0b2
LW
2609 mg_get(sv);
2610 if (SvNOKp(sv))
2611 return SvNVX(sv);
a0d0e21e 2612 if (SvPOKp(sv) && SvLEN(sv)) {
c2988b20
NC
2613 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
2614 !grok_number(SvPVX(sv), SvCUR(sv), NULL))
a0d0e21e 2615 not_a_number(sv);
097ee67d 2616 return Atof(SvPVX(sv));
a0d0e21e 2617 }
25da4f38 2618 if (SvIOKp(sv)) {
1c846c1f 2619 if (SvIsUV(sv))
65202027 2620 return (NV)SvUVX(sv);
25da4f38 2621 else
65202027 2622 return (NV)SvIVX(sv);
25da4f38 2623 }
16d20bd9 2624 if (!SvROK(sv)) {
d008e5eb 2625 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 2626 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
1d7c1841 2627 report_uninit();
c6ee37c5 2628 }
16d20bd9
AD
2629 return 0;
2630 }
463ee0b2 2631 }
ed6116ce 2632 if (SvTHINKFIRST(sv)) {
a0d0e21e 2633 if (SvROK(sv)) {
a0d0e21e 2634 SV* tmpstr;
1554e226 2635 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
b4b9a328 2636 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
9e7bc3e8 2637 return SvNV(tmpstr);
56431972 2638 return PTR2NV(SvRV(sv));
a0d0e21e 2639 }
765f542d
NC
2640 if (SvIsCOW(sv)) {
2641 sv_force_normal_flags(sv, 0);
8a818333 2642 }
0336b60e 2643 if (SvREADONLY(sv) && !SvOK(sv)) {
599cee73 2644 if (ckWARN(WARN_UNINITIALIZED))
1d7c1841 2645 report_uninit();
ed6116ce
LW
2646 return 0.0;
2647 }
79072805
LW
2648 }
2649 if (SvTYPE(sv) < SVt_NV) {
463ee0b2
LW
2650 if (SvTYPE(sv) == SVt_IV)
2651 sv_upgrade(sv, SVt_PVNV);
2652 else
2653 sv_upgrade(sv, SVt_NV);
906f284f 2654#ifdef USE_LONG_DOUBLE
097ee67d 2655 DEBUG_c({
f93f4e46 2656 STORE_NUMERIC_LOCAL_SET_STANDARD();
1d7c1841
GS
2657 PerlIO_printf(Perl_debug_log,
2658 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
2659 PTR2UV(sv), SvNVX(sv));
572bbb43
GS
2660 RESTORE_NUMERIC_LOCAL();
2661 });
65202027 2662#else
572bbb43 2663 DEBUG_c({
f93f4e46 2664 STORE_NUMERIC_LOCAL_SET_STANDARD();
1779d84d 2665 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
1d7c1841 2666 PTR2UV(sv), SvNVX(sv));
097ee67d
JH
2667 RESTORE_NUMERIC_LOCAL();
2668 });
572bbb43 2669#endif
79072805
LW
2670 }
2671 else if (SvTYPE(sv) < SVt_PVNV)
2672 sv_upgrade(sv, SVt_PVNV);
59d8ce62
NC
2673 if (SvNOKp(sv)) {
2674 return SvNVX(sv);
61604483 2675 }
59d8ce62 2676 if (SvIOKp(sv)) {
65202027 2677 SvNVX(sv) = SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv);
28e5dec8
JH
2678#ifdef NV_PRESERVES_UV
2679 SvNOK_on(sv);
2680#else
2681 /* Only set the public NV OK flag if this NV preserves the IV */
2682 /* Check it's not 0xFFFFFFFFFFFFFFFF */
2683 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
2684 : (SvIVX(sv) == I_V(SvNVX(sv))))
2685 SvNOK_on(sv);
2686 else
2687 SvNOKp_on(sv);
2688#endif
93a17b20 2689 }
748a9306 2690 else if (SvPOKp(sv) && SvLEN(sv)) {
c2988b20
NC
2691 UV value;
2692 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2693 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
a0d0e21e 2694 not_a_number(sv);
28e5dec8 2695#ifdef NV_PRESERVES_UV
c2988b20
NC
2696 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2697 == IS_NUMBER_IN_UV) {
5e045b90 2698 /* It's definitely an integer */
c2988b20
NC
2699 SvNVX(sv) = (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value;
2700 } else
2701 SvNVX(sv) = Atof(SvPVX(sv));
28e5dec8
JH
2702 SvNOK_on(sv);
2703#else
c2988b20 2704 SvNVX(sv) = Atof(SvPVX(sv));
28e5dec8
JH
2705 /* Only set the public NV OK flag if this NV preserves the value in
2706 the PV at least as well as an IV/UV would.
2707 Not sure how to do this 100% reliably. */
2708 /* if that shift count is out of range then Configure's test is
2709 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
2710 UV_BITS */
2711 if (((UV)1 << NV_PRESERVES_UV_BITS) >
c2988b20 2712 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
28e5dec8 2713 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
c2988b20
NC
2714 } else if (!(numtype & IS_NUMBER_IN_UV)) {
2715 /* Can't use strtol etc to convert this string, so don't try.
2716 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
2717 SvNOK_on(sv);
2718 } else {
2719 /* value has been set. It may not be precise. */
2720 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
2721 /* 2s complement assumption for (UV)IV_MIN */
2722 SvNOK_on(sv); /* Integer is too negative. */
2723 } else {
2724 SvNOKp_on(sv);
2725 SvIOKp_on(sv);
6fa402ec 2726
c2988b20
NC
2727 if (numtype & IS_NUMBER_NEG) {
2728 SvIVX(sv) = -(IV)value;
2729 } else if (value <= (UV)IV_MAX) {
2730 SvIVX(sv) = (IV)value;
2731 } else {
2732 SvUVX(sv) = value;
2733 SvIsUV_on(sv);
2734 }
2735
2736 if (numtype & IS_NUMBER_NOT_INT) {
2737 /* I believe that even if the original PV had decimals,
2738 they are lost beyond the limit of the FP precision.
2739 However, neither is canonical, so both only get p
2740 flags. NWC, 2000/11/25 */
2741 /* Both already have p flags, so do nothing */
2742 } else {
2743 NV nv = SvNVX(sv);
2744 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2745 if (SvIVX(sv) == I_V(nv)) {
2746 SvNOK_on(sv);
2747 SvIOK_on(sv);
2748 } else {
2749 SvIOK_on(sv);
2750 /* It had no "." so it must be integer. */
2751 }
2752 } else {
2753 /* between IV_MAX and NV(UV_MAX).
2754 Could be slightly > UV_MAX */
6fa402ec 2755
c2988b20
NC
2756 if (numtype & IS_NUMBER_NOT_INT) {
2757 /* UV and NV both imprecise. */
2758 } else {
2759 UV nv_as_uv = U_V(nv);
2760
2761 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
2762 SvNOK_on(sv);
2763 SvIOK_on(sv);
2764 } else {
2765 SvIOK_on(sv);
2766 }
2767 }
2768 }
2769 }
2770 }
2771 }
28e5dec8 2772#endif /* NV_PRESERVES_UV */
93a17b20 2773 }
79072805 2774 else {
599cee73 2775 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
1d7c1841 2776 report_uninit();
25da4f38
IZ
2777 if (SvTYPE(sv) < SVt_NV)
2778 /* Typically the caller expects that sv_any is not NULL now. */
28e5dec8
JH
2779 /* XXX Ilya implies that this is a bug in callers that assume this
2780 and ideally should be fixed. */
25da4f38 2781 sv_upgrade(sv, SVt_NV);
a0d0e21e 2782 return 0.0;
79072805 2783 }
572bbb43 2784#if defined(USE_LONG_DOUBLE)
097ee67d 2785 DEBUG_c({
f93f4e46 2786 STORE_NUMERIC_LOCAL_SET_STANDARD();
1d7c1841
GS
2787 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
2788 PTR2UV(sv), SvNVX(sv));
572bbb43
GS
2789 RESTORE_NUMERIC_LOCAL();
2790 });
65202027 2791#else
572bbb43 2792 DEBUG_c({
f93f4e46 2793 STORE_NUMERIC_LOCAL_SET_STANDARD();
1779d84d 2794 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
1d7c1841 2795 PTR2UV(sv), SvNVX(sv));
097ee67d
JH
2796 RESTORE_NUMERIC_LOCAL();
2797 });
572bbb43 2798#endif
463ee0b2 2799 return SvNVX(sv);
79072805
LW
2800}
2801
645c22ef
DM
2802/* asIV(): extract an integer from the string value of an SV.
2803 * Caller must validate PVX */
2804
76e3520e 2805STATIC IV
cea2e8a9 2806S_asIV(pTHX_ SV *sv)
36477c24 2807{
c2988b20
NC
2808 UV value;
2809 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
2810
2811 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2812 == IS_NUMBER_IN_UV) {
645c22ef 2813 /* It's definitely an integer */
c2988b20
NC
2814 if (numtype & IS_NUMBER_NEG) {
2815 if (value < (UV)IV_MIN)
2816 return -(IV)value;
2817 } else {
2818 if (value < (UV)IV_MAX)
2819 return (IV)value;
2820 }
2821 }
d008e5eb 2822 if (!numtype) {
d008e5eb
GS
2823 if (ckWARN(WARN_NUMERIC))
2824 not_a_number(sv);
2825 }
c2988b20 2826 return I_V(Atof(SvPVX(sv)));
36477c24 2827}
2828
645c22ef
DM
2829/* asUV(): extract an unsigned integer from the string value of an SV
2830 * Caller must validate PVX */
2831
76e3520e 2832STATIC UV
cea2e8a9 2833S_asUV(pTHX_ SV *sv)
36477c24 2834{
c2988b20
NC
2835 UV value;
2836 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
36477c24 2837
c2988b20
NC
2838 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2839 == IS_NUMBER_IN_UV) {
645c22ef 2840 /* It's definitely an integer */
6fa402ec 2841 if (!(numtype & IS_NUMBER_NEG))
c2988b20
NC
2842 return value;
2843 }
d008e5eb 2844 if (!numtype) {
d008e5eb
GS
2845 if (ckWARN(WARN_NUMERIC))
2846 not_a_number(sv);
2847 }
097ee67d 2848 return U_V(Atof(SvPVX(sv)));
36477c24 2849}
2850
645c22ef
DM
2851/*
2852=for apidoc sv_2pv_nolen
2853
2854Like C<sv_2pv()>, but doesn't return the length too. You should usually
2855use the macro wrapper C<SvPV_nolen(sv)> instead.
2856=cut
2857*/
2858
79072805 2859char *
864dbfa3 2860Perl_sv_2pv_nolen(pTHX_ register SV *sv)
1fa8b10d
JD
2861{
2862 STRLEN n_a;
2863 return sv_2pv(sv, &n_a);
2864}
2865
645c22ef
DM
2866/* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
2867 * UV as a string towards the end of buf, and return pointers to start and
2868 * end of it.
2869 *
2870 * We assume that buf is at least TYPE_CHARS(UV) long.
2871 */
2872
864dbfa3 2873static char *
25da4f38
IZ
2874uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
2875{
25da4f38
IZ
2876 char *ptr = buf + TYPE_CHARS(UV);
2877 char *ebuf = ptr;
2878 int sign;
25da4f38
IZ
2879
2880 if (is_uv)
2881 sign = 0;
2882 else if (iv >= 0) {
2883 uv = iv;
2884 sign = 0;
2885 } else {
2886 uv = -iv;
2887 sign = 1;
2888 }
2889 do {
eb160463 2890 *--ptr = '0' + (char)(uv % 10);
25da4f38
IZ
2891 } while (uv /= 10);
2892 if (sign)
2893 *--ptr = '-';
2894 *peob = ebuf;
2895 return ptr;
2896}
2897
645c22ef
DM
2898/*
2899=for apidoc sv_2pv_flags
2900
ff276b08 2901Returns a pointer to the string value of an SV, and sets *lp to its length.
645c22ef
DM
2902If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
2903if necessary.
2904Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
2905usually end up here too.
2906
2907=cut
2908*/
2909
8d6d96c1
HS
2910char *
2911Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
2912{
79072805
LW
2913 register char *s;
2914 int olderrno;
cb50f42d 2915 SV *tsv, *origsv;
25da4f38
IZ
2916 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
2917 char *tmpbuf = tbuf;
79072805 2918
463ee0b2
LW
2919 if (!sv) {
2920 *lp = 0;
2921 return "";
2922 }
8990e307 2923 if (SvGMAGICAL(sv)) {
8d6d96c1
HS
2924 if (flags & SV_GMAGIC)
2925 mg_get(sv);
463ee0b2
LW
2926 if (SvPOKp(sv)) {
2927 *lp = SvCUR(sv);
2928 return SvPVX(sv);
2929 }
cf2093f6 2930 if (SvIOKp(sv)) {
1c846c1f 2931 if (SvIsUV(sv))
57def98f 2932 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
cf2093f6 2933 else
57def98f 2934 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
46fc3d4c 2935 tsv = Nullsv;
a0d0e21e 2936 goto tokensave;
463ee0b2
LW
2937 }
2938 if (SvNOKp(sv)) {
2d4389e4 2939 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
46fc3d4c 2940 tsv = Nullsv;
a0d0e21e 2941 goto tokensave;
463ee0b2 2942 }
16d20bd9 2943 if (!SvROK(sv)) {
d008e5eb 2944 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 2945 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
1d7c1841 2946 report_uninit();
c6ee37c5 2947 }
16d20bd9
AD
2948 *lp = 0;
2949 return "";
2950 }
463ee0b2 2951 }
ed6116ce
LW
2952 if (SvTHINKFIRST(sv)) {
2953 if (SvROK(sv)) {
a0d0e21e 2954 SV* tmpstr;
1554e226 2955 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
b4b9a328 2956 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
446eaa42
YST
2957 char *pv = SvPV(tmpstr, *lp);
2958 if (SvUTF8(tmpstr))
2959 SvUTF8_on(sv);
2960 else
2961 SvUTF8_off(sv);
2962 return pv;
2963 }
cb50f42d 2964 origsv = sv;
ed6116ce
LW
2965 sv = (SV*)SvRV(sv);
2966 if (!sv)
2967 s = "NULLREF";
2968 else {
f9277f47
IZ
2969 MAGIC *mg;
2970
ed6116ce 2971 switch (SvTYPE(sv)) {
f9277f47
IZ
2972 case SVt_PVMG:
2973 if ( ((SvFLAGS(sv) &
1c846c1f 2974 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
3149a8e4 2975 == (SVs_OBJECT|SVs_RMG))
14befaf4 2976 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
2cd61cdb 2977 regexp *re = (regexp *)mg->mg_obj;
1bd3ad17 2978
2cd61cdb 2979 if (!mg->mg_ptr) {
8782bef2
GB
2980 char *fptr = "msix";
2981 char reflags[6];
2982 char ch;
2983 int left = 0;
2984 int right = 4;
ff385a1b 2985 char need_newline = 0;
eb160463 2986 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
8782bef2 2987
155aba94 2988 while((ch = *fptr++)) {
8782bef2
GB
2989 if(reganch & 1) {
2990 reflags[left++] = ch;
2991 }
2992 else {
2993 reflags[right--] = ch;
2994 }
2995 reganch >>= 1;
2996 }
2997 if(left != 4) {
2998 reflags[left] = '-';
2999 left = 5;
3000 }
3001
3002 mg->mg_len = re->prelen + 4 + left;
ff385a1b
JF
3003 /*
3004 * If /x was used, we have to worry about a regex
3005 * ending with a comment later being embedded
3006 * within another regex. If so, we don't want this
3007 * regex's "commentization" to leak out to the
3008 * right part of the enclosing regex, we must cap
3009 * it with a newline.
3010 *
3011 * So, if /x was used, we scan backwards from the
3012 * end of the regex. If we find a '#' before we
3013 * find a newline, we need to add a newline
3014 * ourself. If we find a '\n' first (or if we
3015 * don't find '#' or '\n'), we don't need to add
3016 * anything. -jfriedl
3017 */
3018 if (PMf_EXTENDED & re->reganch)
3019 {
3020 char *endptr = re->precomp + re->prelen;
3021 while (endptr >= re->precomp)
3022 {
3023 char c = *(endptr--);
3024 if (c == '\n')
3025 break; /* don't need another */
3026 if (c == '#') {
3027 /* we end while in a comment, so we
3028 need a newline */
3029 mg->mg_len++; /* save space for it */
3030 need_newline = 1; /* note to add it */
ab01544f 3031 break;
ff385a1b
JF
3032 }
3033 }
3034 }
3035
8782bef2
GB
3036 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3037 Copy("(?", mg->mg_ptr, 2, char);
3038 Copy(reflags, mg->mg_ptr+2, left, char);
3039 Copy(":", mg->mg_ptr+left+2, 1, char);
3040 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
ff385a1b
JF
3041 if (need_newline)
3042 mg->mg_ptr[mg->mg_len - 2] = '\n';
1bd3ad17
IZ
3043 mg->mg_ptr[mg->mg_len - 1] = ')';
3044 mg->mg_ptr[mg->mg_len] = 0;
3045 }
3280af22 3046 PL_reginterp_cnt += re->program[0].next_off;
cb50f42d
YST
3047
3048 if (re->reganch & ROPT_UTF8)
3049 SvUTF8_on(origsv);
3050 else
3051 SvUTF8_off(origsv);
1bd3ad17
IZ
3052 *lp = mg->mg_len;
3053 return mg->mg_ptr;
f9277f47
IZ
3054 }
3055 /* Fall through */
ed6116ce
LW
3056 case SVt_NULL:
3057 case SVt_IV:
3058 case SVt_NV:
3059 case SVt_RV:
3060 case SVt_PV:
3061 case SVt_PVIV:
3062 case SVt_PVNV:
81689caa
HS
3063 case SVt_PVBM: if (SvROK(sv))
3064 s = "REF";
3065 else
3066 s = "SCALAR"; break;
ed6116ce
LW
3067 case SVt_PVLV: s = "LVALUE"; break;
3068 case SVt_PVAV: s = "ARRAY"; break;
3069 case SVt_PVHV: s = "HASH"; break;
3070 case SVt_PVCV: s = "CODE"; break;
3071 case SVt_PVGV: s = "GLOB"; break;
1d2dff63 3072 case SVt_PVFM: s = "FORMAT"; break;
36477c24 3073 case SVt_PVIO: s = "IO"; break;
ed6116ce
LW
3074 default: s = "UNKNOWN"; break;
3075 }
46fc3d4c 3076 tsv = NEWSV(0,0);
de11ba31
AMS
3077 if (SvOBJECT(sv))
3078 Perl_sv_setpvf(aTHX_ tsv, "%s=%s", HvNAME(SvSTASH(sv)), s);
ed6116ce 3079 else
46fc3d4c 3080 sv_setpv(tsv, s);
57def98f 3081 Perl_sv_catpvf(aTHX_ tsv, "(0x%"UVxf")", PTR2UV(sv));
a0d0e21e 3082 goto tokensaveref;
463ee0b2 3083 }
ed6116ce
LW
3084 *lp = strlen(s);
3085 return s;
79072805 3086 }
0336b60e 3087 if (SvREADONLY(sv) && !SvOK(sv)) {
0336b60e 3088 if (ckWARN(WARN_UNINITIALIZED))
1d7c1841 3089 report_uninit();
ed6116ce
LW
3090 *lp = 0;
3091 return "";
79072805 3092 }
79072805 3093 }
28e5dec8
JH
3094 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3095 /* I'm assuming that if both IV and NV are equally valid then
3096 converting the IV is going to be more efficient */
3097 U32 isIOK = SvIOK(sv);
3098 U32 isUIOK = SvIsUV(sv);
3099 char buf[TYPE_CHARS(UV)];
3100 char *ebuf, *ptr;
3101
3102 if (SvTYPE(sv) < SVt_PVIV)
3103 sv_upgrade(sv, SVt_PVIV);
3104 if (isUIOK)
3105 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3106 else
3107 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
eb160463 3108 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
28e5dec8
JH
3109 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3110 SvCUR_set(sv, ebuf - ptr);
3111 s = SvEND(sv);
3112 *s = '\0';
3113 if (isIOK)
3114 SvIOK_on(sv);
3115 else
3116 SvIOKp_on(sv);
3117 if (isUIOK)
3118 SvIsUV_on(sv);
3119 }
3120 else if (SvNOKp(sv)) {
79072805
LW
3121 if (SvTYPE(sv) < SVt_PVNV)
3122 sv_upgrade(sv, SVt_PVNV);
1c846c1f 3123 /* The +20 is pure guesswork. Configure test needed. --jhi */
59155cc0 3124 SvGROW(sv, NV_DIG + 20);
463ee0b2 3125 s = SvPVX(sv);
79072805 3126 olderrno = errno; /* some Xenix systems wipe out errno here */
79072805 3127#ifdef apollo
463ee0b2 3128 if (SvNVX(sv) == 0.0)
79072805
LW
3129 (void)strcpy(s,"0");
3130 else
3131#endif /*apollo*/
bbce6d69 3132 {
2d4389e4 3133 Gconvert(SvNVX(sv), NV_DIG, 0, s);
bbce6d69 3134 }
79072805 3135 errno = olderrno;
a0d0e21e
LW
3136#ifdef FIXNEGATIVEZERO
3137 if (*s == '-' && s[1] == '0' && !s[2])
3138 strcpy(s,"0");
3139#endif
79072805
LW
3140 while (*s) s++;
3141#ifdef hcx
3142 if (s[-1] == '.')
46fc3d4c 3143 *--s = '\0';
79072805
LW
3144#endif
3145 }
79072805 3146 else {
0336b60e
IZ
3147 if (ckWARN(WARN_UNINITIALIZED)
3148 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
1d7c1841 3149 report_uninit();
a0d0e21e 3150 *lp = 0;
25da4f38
IZ
3151 if (SvTYPE(sv) < SVt_PV)
3152 /* Typically the caller expects that sv_any is not NULL now. */
3153 sv_upgrade(sv, SVt_PV);
a0d0e21e 3154 return "";
79072805 3155 }
463ee0b2
LW
3156 *lp = s - SvPVX(sv);
3157 SvCUR_set(sv, *lp);
79072805 3158 SvPOK_on(sv);
1d7c1841
GS
3159 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3160 PTR2UV(sv),SvPVX(sv)));
463ee0b2 3161 return SvPVX(sv);
a0d0e21e
LW
3162
3163 tokensave:
3164 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3165 /* Sneaky stuff here */
3166
3167 tokensaveref:
46fc3d4c 3168 if (!tsv)
96827780 3169 tsv = newSVpv(tmpbuf, 0);
46fc3d4c 3170 sv_2mortal(tsv);
3171 *lp = SvCUR(tsv);
3172 return SvPVX(tsv);
a0d0e21e
LW
3173 }
3174 else {
3175 STRLEN len;
46fc3d4c 3176 char *t;
3177
3178 if (tsv) {
3179 sv_2mortal(tsv);
3180 t = SvPVX(tsv);
3181 len = SvCUR(tsv);
3182 }
3183 else {
96827780
MB
3184 t = tmpbuf;
3185 len = strlen(tmpbuf);
46fc3d4c 3186 }
a0d0e21e 3187#ifdef FIXNEGATIVEZERO
46fc3d4c 3188 if (len == 2 && t[0] == '-' && t[1] == '0') {
3189 t = "0";
3190 len = 1;
3191 }
a0d0e21e
LW
3192#endif
3193 (void)SvUPGRADE(sv, SVt_PV);
46fc3d4c 3194 *lp = len;
a0d0e21e
LW
3195 s = SvGROW(sv, len + 1);
3196 SvCUR_set(sv, len);
46fc3d4c 3197 (void)strcpy(s, t);
6bf554b4 3198 SvPOKp_on(sv);
a0d0e21e
LW
3199 return s;
3200 }
463ee0b2
LW
3201}
3202
645c22ef 3203/*
6050d10e
JP
3204=for apidoc sv_copypv
3205
3206Copies a stringified representation of the source SV into the
3207destination SV. Automatically performs any necessary mg_get and
54f0641b 3208coercion of numeric values into strings. Guaranteed to preserve
6050d10e 3209UTF-8 flag even from overloaded objects. Similar in nature to
54f0641b
NIS
3210sv_2pv[_flags] but operates directly on an SV instead of just the
3211string. Mostly uses sv_2pv_flags to do its work, except when that
6050d10e
JP
3212would lose the UTF-8'ness of the PV.
3213
3214=cut
3215*/
3216
3217void
3218Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3219{
446eaa42
YST
3220 STRLEN len;
3221 char *s;
3222 s = SvPV(ssv,len);
cb50f42d 3223 sv_setpvn(dsv,s,len);
446eaa42 3224 if (SvUTF8(ssv))
cb50f42d 3225 SvUTF8_on(dsv);
446eaa42 3226 else
cb50f42d 3227 SvUTF8_off(dsv);
6050d10e
JP
3228}
3229
3230/*
645c22ef
DM
3231=for apidoc sv_2pvbyte_nolen
3232
3233Return a pointer to the byte-encoded representation of the SV.
3234May cause the SV to be downgraded from UTF8 as a side-effect.
3235
3236Usually accessed via the C<SvPVbyte_nolen> macro.
3237
3238=cut
3239*/
3240
7340a771
GS
3241char *
3242Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3243{
560a288e
GS
3244 STRLEN n_a;
3245 return sv_2pvbyte(sv, &n_a);
7340a771
GS
3246}
3247
645c22ef
DM
3248/*
3249=for apidoc sv_2pvbyte
3250
3251Return a pointer to the byte-encoded representation of the SV, and set *lp
3252to its length. May cause the SV to be downgraded from UTF8 as a
3253side-effect.
3254
3255Usually accessed via the C<SvPVbyte> macro.
3256
3257=cut
3258*/
3259
7340a771
GS
3260char *
3261Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3262{
0875d2fe
NIS
3263 sv_utf8_downgrade(sv,0);
3264 return SvPV(sv,*lp);
7340a771
GS
3265}
3266
645c22ef
DM
3267/*
3268=for apidoc sv_2pvutf8_nolen
3269
3270Return a pointer to the UTF8-encoded representation of the SV.
3271May cause the SV to be upgraded to UTF8 as a side-effect.
3272
3273Usually accessed via the C<SvPVutf8_nolen> macro.
3274
3275=cut
3276*/
3277
7340a771
GS
3278char *
3279Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3280{
560a288e
GS
3281 STRLEN n_a;
3282 return sv_2pvutf8(sv, &n_a);
7340a771
GS
3283}
3284
645c22ef
DM
3285/*
3286=for apidoc sv_2pvutf8
3287
3288Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3289to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
3290
3291Usually accessed via the C<SvPVutf8> macro.
3292
3293=cut
3294*/
3295
7340a771
GS
3296char *
3297Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3298{
560a288e 3299 sv_utf8_upgrade(sv);
7d59b7e4 3300 return SvPV(sv,*lp);
7340a771 3301}
1c846c1f 3302
645c22ef
DM
3303/*
3304=for apidoc sv_2bool
3305
3306This function is only called on magical items, and is only used by
8cf8f3d1 3307sv_true() or its macro equivalent.
645c22ef
DM
3308
3309=cut
3310*/
3311
463ee0b2 3312bool
864dbfa3 3313Perl_sv_2bool(pTHX_ register SV *sv)
463ee0b2 3314{
8990e307 3315 if (SvGMAGICAL(sv))
463ee0b2
LW
3316 mg_get(sv);
3317
a0d0e21e
LW
3318 if (!SvOK(sv))
3319 return 0;
3320 if (SvROK(sv)) {
a0d0e21e 3321 SV* tmpsv;
1554e226 3322 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
9e3013b1 3323 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
8a31060d 3324 return (bool)SvTRUE(tmpsv);
a0d0e21e
LW
3325 return SvRV(sv) != 0;
3326 }
463ee0b2 3327 if (SvPOKp(sv)) {
11343788
MB
3328 register XPV* Xpvtmp;
3329 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3330 (*Xpvtmp->xpv_pv > '0' ||
3331 Xpvtmp->xpv_cur > 1 ||
3332 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
463ee0b2
LW
3333 return 1;
3334 else
3335 return 0;
3336 }
3337 else {
3338 if (SvIOKp(sv))
3339 return SvIVX(sv) != 0;
3340 else {
3341 if (SvNOKp(sv))
3342 return SvNVX(sv) != 0.0;
3343 else
3344 return FALSE;
3345 }
3346 }
79072805
LW
3347}
3348
c461cf8f
JH
3349/*
3350=for apidoc sv_utf8_upgrade
3351
3352Convert the PV of an SV to its UTF8-encoded form.
645c22ef 3353Forces the SV to string form if it is not already.
4411f3b6
NIS
3354Always sets the SvUTF8 flag to avoid future validity checks even
3355if all the bytes have hibit clear.
c461cf8f 3356
13a6c0e0
JH
3357This is not as a general purpose byte encoding to Unicode interface:
3358use the Encode extension for that.
3359
8d6d96c1
HS
3360=for apidoc sv_utf8_upgrade_flags
3361
3362Convert the PV of an SV to its UTF8-encoded form.
645c22ef 3363Forces the SV to string form if it is not already.
8d6d96c1
HS
3364Always sets the SvUTF8 flag to avoid future validity checks even
3365if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3366will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3367C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3368
13a6c0e0
JH
3369This is not as a general purpose byte encoding to Unicode interface:
3370use the Encode extension for that.
3371
8d6d96c1
HS
3372=cut
3373*/
3374
3375STRLEN
3376Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3377{
db42d148 3378 U8 *s, *t, *e;
511c2ff0 3379 int hibit = 0;
560a288e 3380
4411f3b6
NIS
3381 if (!sv)
3382 return 0;
3383
e0e62c2a
NIS
3384 if (!SvPOK(sv)) {
3385 STRLEN len = 0;
8d6d96c1 3386 (void) sv_2pv_flags(sv,&len, flags);
e0e62c2a
NIS
3387 if (!SvPOK(sv))
3388 return len;
3389 }
4411f3b6
NIS
3390
3391 if (SvUTF8(sv))
3392 return SvCUR(sv);
560a288e 3393
765f542d
NC
3394 if (SvIsCOW(sv)) {
3395 sv_force_normal_flags(sv, 0);
db42d148
NIS
3396 }
3397
88632417 3398 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
799ef3cb 3399 sv_recode_to_utf8(sv, PL_encoding);
9f4817db 3400 else { /* Assume Latin-1/EBCDIC */
0a378802
JH
3401 /* This function could be much more efficient if we
3402 * had a FLAG in SVs to signal if there are any hibit
3403 * chars in the PV. Given that there isn't such a flag
3404 * make the loop as fast as possible. */
3405 s = (U8 *) SvPVX(sv);
3406 e = (U8 *) SvEND(sv);
3407 t = s;
3408 while (t < e) {
3409 U8 ch = *t++;
3410 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3411 break;
3412 }
3413 if (hibit) {
3414 STRLEN len;
ecdeb87c 3415
0a378802
JH
3416 len = SvCUR(sv) + 1; /* Plus the \0 */
3417 SvPVX(sv) = (char*)bytes_to_utf8((U8*)s, &len);
3418 SvCUR(sv) = len - 1;
3419 if (SvLEN(sv) != 0)
3420 Safefree(s); /* No longer using what was there before. */
3421 SvLEN(sv) = len; /* No longer know the real size. */
3422 }
9f4817db
JH
3423 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3424 SvUTF8_on(sv);
560a288e 3425 }
4411f3b6 3426 return SvCUR(sv);
560a288e
GS
3427}
3428
c461cf8f
JH
3429/*
3430=for apidoc sv_utf8_downgrade
3431
3432Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
3433This may not be possible if the PV contains non-byte encoding characters;
3434if this is the case, either returns false or, if C<fail_ok> is not
3435true, croaks.
3436
13a6c0e0
JH
3437This is not as a general purpose Unicode to byte encoding interface:
3438use the Encode extension for that.
3439
c461cf8f
JH
3440=cut
3441*/
3442
560a288e
GS
3443bool
3444Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
3445{
3446 if (SvPOK(sv) && SvUTF8(sv)) {
fa301091 3447 if (SvCUR(sv)) {
03cfe0ae 3448 U8 *s;
652088fc 3449 STRLEN len;
fa301091 3450
765f542d
NC
3451 if (SvIsCOW(sv)) {
3452 sv_force_normal_flags(sv, 0);
3453 }
03cfe0ae
NIS
3454 s = (U8 *) SvPV(sv, len);
3455 if (!utf8_to_bytes(s, &len)) {
fa301091
JH
3456 if (fail_ok)
3457 return FALSE;
3458 else {
3459 if (PL_op)
3460 Perl_croak(aTHX_ "Wide character in %s",
53e06cf0 3461 OP_DESC(PL_op));
fa301091
JH
3462 else
3463 Perl_croak(aTHX_ "Wide character");
3464 }
4b3603a4 3465 }
fa301091 3466 SvCUR(sv) = len;
67e989fb 3467 }
560a288e 3468 }
ffebcc3e 3469 SvUTF8_off(sv);
560a288e
GS
3470 return TRUE;
3471}
3472
c461cf8f
JH
3473/*
3474=for apidoc sv_utf8_encode
3475
3476Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
4411f3b6
NIS
3477flag so that it looks like octets again. Used as a building block
3478for encode_utf8 in Encode.xs
c461cf8f
JH
3479
3480=cut
3481*/
3482
560a288e
GS
3483void
3484Perl_sv_utf8_encode(pTHX_ register SV *sv)
3485{
4411f3b6 3486 (void) sv_utf8_upgrade(sv);
560a288e
GS
3487 SvUTF8_off(sv);
3488}
3489
4411f3b6
NIS
3490/*
3491=for apidoc sv_utf8_decode
3492
3493Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
645c22ef 3494turn off SvUTF8 if needed so that we see characters. Used as a building block
4411f3b6
NIS
3495for decode_utf8 in Encode.xs
3496
3497=cut
3498*/
3499
560a288e
GS
3500bool
3501Perl_sv_utf8_decode(pTHX_ register SV *sv)
3502{
3503 if (SvPOK(sv)) {
63cd0674
NIS
3504 U8 *c;
3505 U8 *e;
9cbac4c7 3506
645c22ef
DM
3507 /* The octets may have got themselves encoded - get them back as
3508 * bytes
3509 */
3510 if (!sv_utf8_downgrade(sv, TRUE))
560a288e
GS
3511 return FALSE;
3512
3513 /* it is actually just a matter of turning the utf8 flag on, but
3514 * we want to make sure everything inside is valid utf8 first.
3515 */
63cd0674
NIS
3516 c = (U8 *) SvPVX(sv);
3517 if (!is_utf8_string(c, SvCUR(sv)+1))
67e989fb 3518 return FALSE;
63cd0674 3519 e = (U8 *) SvEND(sv);
511c2ff0 3520 while (c < e) {
c4d5f83a
NIS
3521 U8 ch = *c++;
3522 if (!UTF8_IS_INVARIANT(ch)) {
67e989fb
JH
3523 SvUTF8_on(sv);
3524 break;
3525 }
560a288e 3526 }
560a288e
GS
3527 }
3528 return TRUE;
3529}
3530
954c1994
GS
3531/*
3532=for apidoc sv_setsv
3533
645c22ef
DM
3534Copies the contents of the source SV C<ssv> into the destination SV
3535C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3536function if the source SV needs to be reused. Does not handle 'set' magic.
3537Loosely speaking, it performs a copy-by-value, obliterating any previous
3538content of the destination.
3539
3540You probably want to use one of the assortment of wrappers, such as
3541C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3542C<SvSetMagicSV_nosteal>.
3543
8d6d96c1
HS
3544=for apidoc sv_setsv_flags
3545
645c22ef
DM
3546Copies the contents of the source SV C<ssv> into the destination SV
3547C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
3548function if the source SV needs to be reused. Does not handle 'set' magic.
3549Loosely speaking, it performs a copy-by-value, obliterating any previous
3550content of the destination.
3551If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3552C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
3553implemented in terms of this function.
3554
3555You probably want to use one of the assortment of wrappers, such as
3556C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3557C<SvSetMagicSV_nosteal>.
3558
3559This is the primary function for copying scalars, and most other
3560copy-ish functions and macros use this underneath.
8d6d96c1
HS
3561
3562=cut
3563*/
3564
3565void
3566Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
3567{
8990e307
LW
3568 register U32 sflags;
3569 register int dtype;
3570 register int stype;
463ee0b2 3571
79072805
LW
3572 if (sstr == dstr)
3573 return;
765f542d 3574 SV_CHECK_THINKFIRST_COW_DROP(dstr);
79072805 3575 if (!sstr)
3280af22 3576 sstr = &PL_sv_undef;
8990e307
LW
3577 stype = SvTYPE(sstr);
3578 dtype = SvTYPE(dstr);
79072805 3579
a0d0e21e 3580 SvAMAGIC_off(dstr);
ece467f9
JP
3581 if ( SvVOK(dstr) )
3582 {
3583 /* need to nuke the magic */
3584 mg_free(dstr);
3585 SvRMAGICAL_off(dstr);
3586 }
9e7bc3e8 3587
463ee0b2 3588 /* There's a lot of redundancy below but we're going for speed here */
79072805 3589
8990e307 3590 switch (stype) {
79072805 3591 case SVt_NULL:
aece5585 3592 undef_sstr:
20408e3c
GS
3593 if (dtype != SVt_PVGV) {
3594 (void)SvOK_off(dstr);
3595 return;
3596 }
3597 break;
463ee0b2 3598 case SVt_IV:
aece5585
GA
3599 if (SvIOK(sstr)) {
3600 switch (dtype) {
3601 case SVt_NULL:
8990e307 3602 sv_upgrade(dstr, SVt_IV);
aece5585
GA
3603 break;
3604 case SVt_NV:
8990e307 3605 sv_upgrade(dstr, SVt_PVNV);
aece5585
GA
3606 break;
3607 case SVt_RV:
3608 case SVt_PV:
a0d0e21e 3609 sv_upgrade(dstr, SVt_PVIV);
aece5585
GA
3610 break;
3611 }
3612 (void)SvIOK_only(dstr);
3613 SvIVX(dstr) = SvIVX(sstr);
25da4f38
IZ
3614 if (SvIsUV(sstr))
3615 SvIsUV_on(dstr);
27c9684d
AP
3616 if (SvTAINTED(sstr))
3617 SvTAINT(dstr);
aece5585 3618 return;
8990e307 3619 }
aece5585
GA
3620 goto undef_sstr;
3621
463ee0b2 3622 case SVt_NV:
aece5585
GA
3623 if (SvNOK(sstr)) {
3624 switch (dtype) {
3625 case SVt_NULL:
3626 case SVt_IV:
8990e307 3627 sv_upgrade(dstr, SVt_NV);
aece5585
GA
3628 break;
3629 case SVt_RV:
3630 case SVt_PV:
3631 case SVt_PVIV:
a0d0e21e 3632 sv_upgrade(dstr, SVt_PVNV);
aece5585
GA
3633 break;
3634 }
3635 SvNVX(dstr) = SvNVX(sstr);
3636 (void)SvNOK_only(dstr);
27c9684d
AP
3637 if (SvTAINTED(sstr))
3638 SvTAINT(dstr);
aece5585 3639 return;
8990e307 3640 }
aece5585
GA
3641 goto undef_sstr;
3642
ed6116ce 3643 case SVt_RV:
8990e307 3644 if (dtype < SVt_RV)
ed6116ce 3645 sv_upgrade(dstr, SVt_RV);
c07a80fd 3646 else if (dtype == SVt_PVGV &&
3647 SvTYPE(SvRV(sstr)) == SVt_PVGV) {
3648 sstr = SvRV(sstr);
a5f75d66 3649 if (sstr == dstr) {
1d7c1841
GS
3650 if (GvIMPORTED(dstr) != GVf_IMPORTED
3651 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3652 {
a5f75d66 3653 GvIMPORTED_on(dstr);
1d7c1841 3654 }
a5f75d66
AD
3655 GvMULTI_on(dstr);
3656 return;
3657 }
c07a80fd 3658 goto glob_assign;
3659 }
ed6116ce 3660 break;
463ee0b2 3661 case SVt_PV:
fc36a67e 3662 case SVt_PVFM:
8990e307 3663 if (dtype < SVt_PV)
463ee0b2 3664 sv_upgrade(dstr, SVt_PV);
463ee0b2
LW
3665 break;
3666 case SVt_PVIV:
8990e307 3667 if (dtype < SVt_PVIV)
463ee0b2 3668 sv_upgrade(dstr, SVt_PVIV);
463ee0b2
LW
3669 break;
3670 case SVt_PVNV:
8990e307 3671 if (dtype < SVt_PVNV)
463ee0b2 3672 sv_upgrade(dstr, SVt_PVNV);
463ee0b2 3673 break;
4633a7c4
LW
3674 case SVt_PVAV:
3675 case SVt_PVHV:
3676 case SVt_PVCV:
4633a7c4 3677 case SVt_PVIO:
533c011a 3678 if (PL_op)
cea2e8a9 3679 Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
53e06cf0 3680 OP_NAME(PL_op));
4633a7c4 3681 else
cea2e8a9 3682 Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
4633a7c4
LW
3683 break;
3684
79072805 3685 case SVt_PVGV:
8990e307 3686 if (dtype <= SVt_PVGV) {
c07a80fd 3687 glob_assign:
a5f75d66 3688 if (dtype != SVt_PVGV) {
a0d0e21e
LW
3689 char *name = GvNAME(sstr);
3690 STRLEN len = GvNAMELEN(sstr);
463ee0b2 3691 sv_upgrade(dstr, SVt_PVGV);
14befaf4 3692 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
85aff577 3693 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
a0d0e21e
LW
3694 GvNAME(dstr) = savepvn(name, len);
3695 GvNAMELEN(dstr) = len;
3696 SvFAKE_on(dstr); /* can coerce to non-glob */
3697 }
7bac28a0 3698 /* ahem, death to those who redefine active sort subs */
3280af22
NIS
3699 else if (PL_curstackinfo->si_type == PERLSI_SORT
3700 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
cea2e8a9 3701 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
7bac28a0 3702 GvNAME(dstr));
5bd07a3d 3703
7fb37951
AMS
3704#ifdef GV_UNIQUE_CHECK
3705 if (GvUNIQUE((GV*)dstr)) {
5bd07a3d
DM
3706 Perl_croak(aTHX_ PL_no_modify);
3707 }
3708#endif
3709
a0d0e21e 3710 (void)SvOK_off(dstr);
a5f75d66 3711 GvINTRO_off(dstr); /* one-shot flag */
1edc1566 3712 gp_free((GV*)dstr);
79072805 3713 GvGP(dstr) = gp_ref(GvGP(sstr));
27c9684d
AP
3714 if (SvTAINTED(sstr))
3715 SvTAINT(dstr);
1d7c1841
GS
3716 if (GvIMPORTED(dstr) != GVf_IMPORTED
3717 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3718 {
a5f75d66 3719 GvIMPORTED_on(dstr);
1d7c1841 3720 }
a5f75d66 3721 GvMULTI_on(dstr);
79072805
LW
3722 return;
3723 }
3724 /* FALL THROUGH */
3725
3726 default:
8d6d96c1 3727 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
973f89ab 3728 mg_get(sstr);
eb160463 3729 if ((int)SvTYPE(sstr) != stype) {
973f89ab
CS
3730 stype = SvTYPE(sstr);
3731 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
3732 goto glob_assign;
3733 }
3734 }
ded42b9f 3735 if (stype == SVt_PVLV)
6fc92669 3736 (void)SvUPGRADE(dstr, SVt_PVNV);
ded42b9f 3737 else
eb160463 3738 (void)SvUPGRADE(dstr, (U32)stype);
79072805
LW
3739 }
3740
8990e307
LW
3741 sflags = SvFLAGS(sstr);
3742
3743 if (sflags & SVf_ROK) {
3744 if (dtype >= SVt_PV) {
3745 if (dtype == SVt_PVGV) {
3746 SV *sref = SvREFCNT_inc(SvRV(sstr));
3747 SV *dref = 0;
a5f75d66 3748 int intro = GvINTRO(dstr);
a0d0e21e 3749
7fb37951
AMS
3750#ifdef GV_UNIQUE_CHECK
3751 if (GvUNIQUE((GV*)dstr)) {
5bd07a3d
DM
3752 Perl_croak(aTHX_ PL_no_modify);
3753 }
3754#endif
3755
a0d0e21e 3756 if (intro) {
a5f75d66 3757 GvINTRO_off(dstr); /* one-shot flag */
1d7c1841 3758 GvLINE(dstr) = CopLINE(PL_curcop);
1edc1566 3759 GvEGV(dstr) = (GV*)dstr;
a0d0e21e 3760 }
a5f75d66 3761 GvMULTI_on(dstr);
8990e307
LW
3762 switch (SvTYPE(sref)) {
3763 case SVt_PVAV:
a0d0e21e 3764 if (intro)
890ed176 3765 SAVEGENERICSV(GvAV(dstr));
a0d0e21e
LW
3766 else
3767 dref = (SV*)GvAV(dstr);
8990e307 3768 GvAV(dstr) = (AV*)sref;
39bac7f7 3769 if (!GvIMPORTED_AV(dstr)
1d7c1841
GS
3770 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3771 {
a5f75d66 3772 GvIMPORTED_AV_on(dstr);
1d7c1841 3773 }
8990e307
LW
3774 break;
3775 case SVt_PVHV:
a0d0e21e 3776 if (intro)
890ed176 3777 SAVEGENERICSV(GvHV(dstr));
a0d0e21e
LW
3778 else
3779 dref = (SV*)GvHV(dstr);
8990e307 3780 GvHV(dstr) = (HV*)sref;
39bac7f7 3781 if (!GvIMPORTED_HV(dstr)
1d7c1841
GS
3782 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3783 {
a5f75d66 3784 GvIMPORTED_HV_on(dstr);
1d7c1841 3785 }
8990e307
LW
3786 break;
3787 case SVt_PVCV:
8ebc5c01 3788 if (intro) {
3789 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
3790 SvREFCNT_dec(GvCV(dstr));
3791 GvCV(dstr) = Nullcv;
68dc0745 3792 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3280af22 3793 PL_sub_generation++;
8ebc5c01 3794 }
890ed176 3795 SAVEGENERICSV(GvCV(dstr));
8ebc5c01 3796 }
68dc0745 3797 else
3798 dref = (SV*)GvCV(dstr);
3799 if (GvCV(dstr) != (CV*)sref) {
748a9306 3800 CV* cv = GvCV(dstr);
4633a7c4 3801 if (cv) {
68dc0745 3802 if (!GvCVGEN((GV*)dstr) &&
3803 (CvROOT(cv) || CvXSUB(cv)))
3804 {
7bac28a0 3805 /* ahem, death to those who redefine
3806 * active sort subs */
3280af22
NIS
3807 if (PL_curstackinfo->si_type == PERLSI_SORT &&
3808 PL_sortcop == CvSTART(cv))
1c846c1f 3809 Perl_croak(aTHX_
7bac28a0 3810 "Can't redefine active sort subroutine %s",
3811 GvENAME((GV*)dstr));
beab0874
JT
3812 /* Redefining a sub - warning is mandatory if
3813 it was a const and its value changed. */
3814 if (ckWARN(WARN_REDEFINE)
3815 || (CvCONST(cv)
3816 && (!CvCONST((CV*)sref)
3817 || sv_cmp(cv_const_sv(cv),
3818 cv_const_sv((CV*)sref)))))
3819 {
9014280d 3820 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
beab0874 3821 CvCONST(cv)
910764e6
RGS
3822 ? "Constant subroutine %s::%s redefined"
3823 : "Subroutine %s::%s redefined",
3824 HvNAME(GvSTASH((GV*)dstr)),
beab0874
JT
3825 GvENAME((GV*)dstr));
3826 }
9607fc9c 3827 }
fb24441d
RGS
3828 if (!intro)
3829 cv_ckproto(cv, (GV*)dstr,
3830 SvPOK(sref) ? SvPVX(sref) : Nullch);
4633a7c4 3831 }
a5f75d66 3832 GvCV(dstr) = (CV*)sref;
7a4c00b4 3833 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
a5f75d66 3834 GvASSUMECV_on(dstr);
3280af22 3835 PL_sub_generation++;
a5f75d66 3836 }
39bac7f7 3837 if (!GvIMPORTED_CV(dstr)
1d7c1841
GS
3838 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3839 {
a5f75d66 3840 GvIMPORTED_CV_on(dstr);
1d7c1841 3841 }
8990e307 3842 break;
91bba347
LW
3843 case SVt_PVIO:
3844 if (intro)
890ed176 3845 SAVEGENERICSV(GvIOp(dstr));
91bba347
LW
3846 else
3847 dref = (SV*)GvIOp(dstr);
3848 GvIOp(dstr) = (IO*)sref;
3849 break;
f4d13ee9
JH
3850 case SVt_PVFM:
3851 if (intro)
890ed176 3852 SAVEGENERICSV(GvFORM(dstr));
f4d13ee9
JH
3853 else
3854 dref = (SV*)GvFORM(dstr);
3855 GvFORM(dstr) = (CV*)sref;
3856 break;
8990e307 3857 default:
a0d0e21e 3858 if (intro)
890ed176 3859 SAVEGENERICSV(GvSV(dstr));
a0d0e21e
LW
3860 else
3861 dref = (SV*)GvSV(dstr);
8990e307 3862 GvSV(dstr) = sref;
39bac7f7 3863 if (!GvIMPORTED_SV(dstr)
1d7c1841
GS
3864 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
3865 {
a5f75d66 3866 GvIMPORTED_SV_on(dstr);
1d7c1841 3867 }
8990e307
LW
3868 break;
3869 }
3870 if (dref)
3871 SvREFCNT_dec(dref);
27c9684d
AP
3872 if (SvTAINTED(sstr))
3873 SvTAINT(dstr);
8990e307
LW
3874 return;
3875 }
a0d0e21e 3876 if (SvPVX(dstr)) {
760ac839 3877 (void)SvOOK_off(dstr); /* backoff */
50483b2c
JD
3878 if (SvLEN(dstr))
3879 Safefree(SvPVX(dstr));
a0d0e21e
LW
3880 SvLEN(dstr)=SvCUR(dstr)=0;
3881 }
8990e307 3882 }
a0d0e21e 3883 (void)SvOK_off(dstr);
8990e307 3884 SvRV(dstr) = SvREFCNT_inc(SvRV(sstr));
ed6116ce 3885 SvROK_on(dstr);
8990e307 3886 if (sflags & SVp_NOK) {
3332b3c1
JH
3887 SvNOKp_on(dstr);
3888 /* Only set the public OK flag if the source has public OK. */
3889 if (sflags & SVf_NOK)
3890 SvFLAGS(dstr) |= SVf_NOK;
ed6116ce
LW
3891 SvNVX(dstr) = SvNVX(sstr);
3892 }
8990e307 3893 if (sflags & SVp_IOK) {
3332b3c1
JH
3894 (void)SvIOKp_on(dstr);
3895 if (sflags & SVf_IOK)
3896 SvFLAGS(dstr) |= SVf_IOK;
2b1c7e3e 3897 if (sflags & SVf_IVisUV)
25da4f38 3898 SvIsUV_on(dstr);
3332b3c1 3899 SvIVX(dstr) = SvIVX(sstr);
ed6116ce 3900 }
a0d0e21e
LW
3901 if (SvAMAGIC(sstr)) {
3902 SvAMAGIC_on(dstr);
3903 }
ed6116ce 3904 }
8990e307 3905 else if (sflags & SVp_POK) {
765f542d 3906 bool isSwipe = 0;
79072805
LW
3907
3908 /*
3909 * Check to see if we can just swipe the string. If so, it's a
3910 * possible small lose on short strings, but a big win on long ones.
463ee0b2
LW
3911 * It might even be a win on short strings if SvPVX(dstr)
3912 * has to be allocated and SvPVX(sstr) has to be freed.
79072805
LW
3913 */
3914
765f542d
NC
3915 if (
3916#ifdef PERL_COPY_ON_WRITE
3917 (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
3918 &&
3919#endif
3920 !(isSwipe =
3921 (sflags & SVs_TEMP) && /* slated for free anyway? */
3922 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
3923 SvREFCNT(sstr) == 1 && /* and no other references to it? */
3924 SvLEN(sstr) && /* and really is a string */
645c22ef 3925 /* and won't be needed again, potentially */
765f542d
NC
3926 !(PL_op && PL_op->op_type == OP_AASSIGN))
3927#ifdef PERL_COPY_ON_WRITE
3928 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
3929 && SvTYPE(sstr) >= SVt_PVIV)
3930#endif
3931 ) {
3932 /* Failed the swipe test, and it's not a shared hash key either.
3933 Have to copy the string. */
3934 STRLEN len = SvCUR(sstr);
3935 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
3936 Move(SvPVX(sstr),SvPVX(dstr),len,char);
3937 SvCUR_set(dstr, len);
3938 *SvEND(dstr) = '\0';
3939 (void)SvPOK_only(dstr);
3940 } else {
3941 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
3942 be true in here. */
3943#ifdef PERL_COPY_ON_WRITE
3944 /* Either it's a shared hash key, or it's suitable for
3945 copy-on-write or we can swipe the string. */
46187eeb
NC
3946 if (DEBUG_C_TEST) {
3947 PerlIO_printf(Perl_debug_log,
3948 "Copy on write: sstr --> dstr\n");
e419cbc5
NC
3949 sv_dump(sstr);
3950 sv_dump(dstr);
46187eeb 3951 }
765f542d
NC
3952 if (!isSwipe) {
3953 /* I believe I should acquire a global SV mutex if
3954 it's a COW sv (not a shared hash key) to stop
3955 it going un copy-on-write.
3956 If the source SV has gone un copy on write between up there
3957 and down here, then (assert() that) it is of the correct
3958 form to make it copy on write again */
3959 if ((sflags & (SVf_FAKE | SVf_READONLY))
3960 != (SVf_FAKE | SVf_READONLY)) {
3961 SvREADONLY_on(sstr);
3962 SvFAKE_on(sstr);
3963 /* Make the source SV into a loop of 1.
3964 (about to become 2) */
a29f6d03 3965 SV_COW_NEXT_SV_SET(sstr, sstr);
765f542d
NC
3966 }
3967 }
3968#endif
3969 /* Initial code is common. */
adbc6bb1 3970 if (SvPVX(dstr)) { /* we know that dtype >= SVt_PV */
a5f75d66
AD
3971 if (SvOOK(dstr)) {
3972 SvFLAGS(dstr) &= ~SVf_OOK;
3973 Safefree(SvPVX(dstr) - SvIVX(dstr));
3974 }
50483b2c 3975 else if (SvLEN(dstr))
a5f75d66 3976 Safefree(SvPVX(dstr));
79072805 3977 }
a5f75d66 3978 (void)SvPOK_only(dstr);
765f542d
NC
3979
3980#ifdef PERL_COPY_ON_WRITE
3981 if (!isSwipe) {
3982 /* making another shared SV. */
3983 STRLEN cur = SvCUR(sstr);
3984 STRLEN len = SvLEN(sstr);
3985 if (len) {
3986 /* SvIsCOW_normal */
3987 /* splice us in between source and next-after-source. */
a29f6d03
NC
3988 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
3989 SV_COW_NEXT_SV_SET(sstr, dstr);
765f542d
NC
3990 SvPV_set(dstr, SvPVX(sstr));
3991 } else {
3992 /* SvIsCOW_shared_hash */
3993 UV hash = SvUVX(sstr);
46187eeb
NC
3994 DEBUG_C(PerlIO_printf(Perl_debug_log,
3995 "Copy on write: Sharing hash\n"));
765f542d
NC
3996 SvPV_set(dstr,
3997 sharepvn(SvPVX(sstr),
3998 (sflags & SVf_UTF8?-cur:cur), hash));
3999 SvUVX(dstr) = hash;
4000 }
4001 SvLEN(dstr) = len;
4002 SvCUR(dstr) = cur;
4003 SvREADONLY_on(dstr);
4004 SvFAKE_on(dstr);
4005 /* Relesase a global SV mutex. */
4006 }
4007 else
4008#endif
4009 { /* Passes the swipe test. */
4010 SvPV_set(dstr, SvPVX(sstr));
4011 SvLEN_set(dstr, SvLEN(sstr));
4012 SvCUR_set(dstr, SvCUR(sstr));
4013
4014 SvTEMP_off(dstr);
4015 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4016 SvPV_set(sstr, Nullch);
4017 SvLEN_set(sstr, 0);
4018 SvCUR_set(sstr, 0);
4019 SvTEMP_off(sstr);
4020 }
4021 }
9aa983d2 4022 if (sflags & SVf_UTF8)
a7cb1f99 4023 SvUTF8_on(dstr);
79072805 4024 /*SUPPRESS 560*/
8990e307 4025 if (sflags & SVp_NOK) {
3332b3c1
JH
4026 SvNOKp_on(dstr);
4027 if (sflags & SVf_NOK)
4028 SvFLAGS(dstr) |= SVf_NOK;
463ee0b2 4029 SvNVX(dstr) = SvNVX(sstr);
79072805 4030 }
8990e307 4031 if (sflags & SVp_IOK) {
3332b3c1
JH
4032 (void)SvIOKp_on(dstr);
4033 if (sflags & SVf_IOK)
4034 SvFLAGS(dstr) |= SVf_IOK;
2b1c7e3e 4035 if (sflags & SVf_IVisUV)
25da4f38 4036 SvIsUV_on(dstr);
463ee0b2 4037 SvIVX(dstr) = SvIVX(sstr);
79072805 4038 }
92f0c265 4039 if (SvVOK(sstr)) {
ece467f9
JP
4040 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
4041 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4042 smg->mg_ptr, smg->mg_len);
439cb1c4 4043 SvRMAGICAL_on(dstr);
92f0c265 4044 }
79072805 4045 }
8990e307 4046 else if (sflags & SVp_IOK) {
3332b3c1
JH
4047 if (sflags & SVf_IOK)
4048 (void)SvIOK_only(dstr);
4049 else {
9cbac4c7
DM
4050 (void)SvOK_off(dstr);
4051 (void)SvIOKp_on(dstr);
3332b3c1
JH
4052 }
4053 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
2b1c7e3e 4054 if (sflags & SVf_IVisUV)
25da4f38 4055 SvIsUV_on(dstr);
3332b3c1
JH
4056 SvIVX(dstr) = SvIVX(sstr);
4057 if (sflags & SVp_NOK) {
4058 if (sflags & SVf_NOK)
4059 (void)SvNOK_on(dstr);
4060 else
4061 (void)SvNOKp_on(dstr);
4062 SvNVX(dstr) = SvNVX(sstr);
4063 }
4064 }
4065 else if (sflags & SVp_NOK) {
4066 if (sflags & SVf_NOK)
4067 (void)SvNOK_only(dstr);
4068 else {
9cbac4c7 4069 (void)SvOK_off(dstr);
3332b3c1
JH
4070 SvNOKp_on(dstr);
4071 }
4072 SvNVX(dstr) = SvNVX(sstr);
79072805
LW
4073 }
4074 else {
20408e3c 4075 if (dtype == SVt_PVGV) {
e476b1b5 4076 if (ckWARN(WARN_MISC))
9014280d 4077 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
20408e3c
GS
4078 }
4079 else
4080 (void)SvOK_off(dstr);
a0d0e21e 4081 }
27c9684d
AP
4082 if (SvTAINTED(sstr))
4083 SvTAINT(dstr);
79072805
LW
4084}
4085
954c1994
GS
4086/*
4087=for apidoc sv_setsv_mg
4088
4089Like C<sv_setsv>, but also handles 'set' magic.
4090
4091=cut
4092*/
4093
79072805 4094void
864dbfa3 4095Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
ef50df4b
GS
4096{
4097 sv_setsv(dstr,sstr);
4098 SvSETMAGIC(dstr);
4099}
4100
954c1994
GS
4101/*
4102=for apidoc sv_setpvn
4103
4104Copies a string into an SV. The C<len> parameter indicates the number of
4105bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>.
4106
4107=cut
4108*/
4109
ef50df4b 4110void
864dbfa3 4111Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
79072805 4112{
c6f8c383 4113 register char *dptr;
22c522df 4114
765f542d 4115 SV_CHECK_THINKFIRST_COW_DROP(sv);
463ee0b2 4116 if (!ptr) {
a0d0e21e 4117 (void)SvOK_off(sv);
463ee0b2
LW
4118 return;
4119 }
22c522df
JH
4120 else {
4121 /* len is STRLEN which is unsigned, need to copy to signed */
4122 IV iv = len;
9c5ffd7c
JH
4123 if (iv < 0)
4124 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
22c522df 4125 }
6fc92669 4126 (void)SvUPGRADE(sv, SVt_PV);
c6f8c383 4127
79072805 4128 SvGROW(sv, len + 1);
c6f8c383
GA
4129 dptr = SvPVX(sv);
4130 Move(ptr,dptr,len,char);
4131 dptr[len] = '\0';
79072805 4132 SvCUR_set(sv, len);
1aa99e6b 4133 (void)SvPOK_only_UTF8(sv); /* validate pointer */
463ee0b2 4134 SvTAINT(sv);
79072805
LW
4135}
4136
954c1994
GS
4137/*
4138=for apidoc sv_setpvn_mg
4139
4140Like C<sv_setpvn>, but also handles 'set' magic.
4141
4142=cut
4143*/
4144
79072805 4145void
864dbfa3 4146Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
ef50df4b
GS
4147{
4148 sv_setpvn(sv,ptr,len);
4149 SvSETMAGIC(sv);
4150}
4151
954c1994
GS
4152/*
4153=for apidoc sv_setpv
4154
4155Copies a string into an SV. The string must be null-terminated. Does not
4156handle 'set' magic. See C<sv_setpv_mg>.
4157
4158=cut
4159*/
4160
ef50df4b 4161void
864dbfa3 4162Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
79072805
LW
4163{
4164 register STRLEN len;
4165
765f542d 4166 SV_CHECK_THINKFIRST_COW_DROP(sv);
463ee0b2 4167 if (!ptr) {
a0d0e21e 4168 (void)SvOK_off(sv);
463ee0b2
LW
4169 return;
4170 }
79072805 4171 len = strlen(ptr);
6fc92669 4172 (void)SvUPGRADE(sv, SVt_PV);
c6f8c383 4173
79072805 4174 SvGROW(sv, len + 1);
463ee0b2 4175 Move(ptr,SvPVX(sv),len+1,char);
79072805 4176 SvCUR_set(sv, len);
1aa99e6b 4177 (void)SvPOK_only_UTF8(sv); /* validate pointer */
463ee0b2
LW
4178 SvTAINT(sv);
4179}
4180
954c1994
GS
4181/*
4182=for apidoc sv_setpv_mg
4183
4184Like C<sv_setpv>, but also handles 'set' magic.
4185
4186=cut
4187*/
4188
463ee0b2 4189void
864dbfa3 4190Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
ef50df4b
GS
4191{
4192 sv_setpv(sv,ptr);
4193 SvSETMAGIC(sv);
4194}
4195
954c1994
GS
4196/*
4197=for apidoc sv_usepvn
4198
4199Tells an SV to use C<ptr> to find its string value. Normally the string is
1c846c1f 4200stored inside the SV but sv_usepvn allows the SV to use an outside string.
954c1994
GS
4201The C<ptr> should point to memory that was allocated by C<malloc>. The
4202string length, C<len>, must be supplied. This function will realloc the
4203memory pointed to by C<ptr>, so that pointer should not be freed or used by
4204the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4205See C<sv_usepvn_mg>.
4206
4207=cut
4208*/
4209
ef50df4b 4210void
864dbfa3 4211Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
463ee0b2 4212{
765f542d 4213 SV_CHECK_THINKFIRST_COW_DROP(sv);
c6f8c383 4214 (void)SvUPGRADE(sv, SVt_PV);
463ee0b2 4215 if (!ptr) {
a0d0e21e 4216 (void)SvOK_off(sv);
463ee0b2
LW
4217 return;
4218 }
a0ed51b3 4219 (void)SvOOK_off(sv);
50483b2c 4220 if (SvPVX(sv) && SvLEN(sv))
463ee0b2
LW
4221 Safefree(SvPVX(sv));
4222 Renew(ptr, len+1, char);
4223 SvPVX(sv) = ptr;
4224 SvCUR_set(sv, len);
4225 SvLEN_set(sv, len+1);
4226 *SvEND(sv) = '\0';
1aa99e6b 4227 (void)SvPOK_only_UTF8(sv); /* validate pointer */
463ee0b2 4228 SvTAINT(sv);
79072805
LW
4229}
4230
954c1994
GS
4231/*
4232=for apidoc sv_usepvn_mg
4233
4234Like C<sv_usepvn>, but also handles 'set' magic.
4235
4236=cut
4237*/
4238
ef50df4b 4239void
864dbfa3 4240Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
ef50df4b 4241{
51c1089b 4242 sv_usepvn(sv,ptr,len);
ef50df4b
GS
4243 SvSETMAGIC(sv);
4244}
4245
765f542d
NC
4246#ifdef PERL_COPY_ON_WRITE
4247/* Need to do this *after* making the SV normal, as we need the buffer
4248 pointer to remain valid until after we've copied it. If we let go too early,
4249 another thread could invalidate it by unsharing last of the same hash key
4250 (which it can do by means other than releasing copy-on-write Svs)
4251 or by changing the other copy-on-write SVs in the loop. */
4252STATIC void
4253S_sv_release_COW(pTHX_ register SV *sv, char *pvx, STRLEN cur, STRLEN len,
4254 U32 hash, SV *after)
4255{
4256 if (len) { /* this SV was SvIsCOW_normal(sv) */
4257 /* we need to find the SV pointing to us. */
4258 SV *current = SV_COW_NEXT_SV(after);
4259
4260 if (current == sv) {
4261 /* The SV we point to points back to us (there were only two of us
4262 in the loop.)
4263 Hence other SV is no longer copy on write either. */
4264 SvFAKE_off(after);
4265 SvREADONLY_off(after);
4266 } else {
4267 /* We need to follow the pointers around the loop. */
4268 SV *next;
4269 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4270 assert (next);
4271 current = next;
4272 /* don't loop forever if the structure is bust, and we have
4273 a pointer into a closed loop. */
4274 assert (current != after);
e419cbc5 4275 assert (SvPVX(current) == pvx);
765f542d
NC
4276 }
4277 /* Make the SV before us point to the SV after us. */
a29f6d03 4278 SV_COW_NEXT_SV_SET(current, after);
765f542d
NC
4279 }
4280 } else {
4281 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4282 }
4283}
4284
4285int
4286Perl_sv_release_IVX(pTHX_ register SV *sv)
4287{
4288 if (SvIsCOW(sv))
4289 sv_force_normal_flags(sv, 0);
4290 return SvOOK_off(sv);
4291}
4292#endif
645c22ef
DM
4293/*
4294=for apidoc sv_force_normal_flags
4295
4296Undo various types of fakery on an SV: if the PV is a shared string, make
4297a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
765f542d
NC
4298an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4299we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4300then a copy-on-write scalar drops its PV buffer (if any) and becomes
4301SvPOK_off rather than making a copy. (Used where this scalar is about to be
4302set to some other value. In addtion, the C<flags> parameter gets passed to
4303C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4304with flags set to 0.
645c22ef
DM
4305
4306=cut
4307*/
4308
6fc92669 4309void
840a7b70 4310Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
0f15f207 4311{
765f542d
NC
4312#ifdef PERL_COPY_ON_WRITE
4313 if (SvREADONLY(sv)) {
4314 /* At this point I believe I should acquire a global SV mutex. */
4315 if (SvFAKE(sv)) {
4316 char *pvx = SvPVX(sv);
4317 STRLEN len = SvLEN(sv);
4318 STRLEN cur = SvCUR(sv);
4319 U32 hash = SvUVX(sv);
4320 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
46187eeb
NC
4321 if (DEBUG_C_TEST) {
4322 PerlIO_printf(Perl_debug_log,
4323 "Copy on write: Force normal %ld\n",
4324 (long) flags);
e419cbc5 4325 sv_dump(sv);
46187eeb 4326 }
765f542d
NC
4327 SvFAKE_off(sv);
4328 SvREADONLY_off(sv);
4329 /* This SV doesn't own the buffer, so need to New() a new one: */
4330 SvPVX(sv) = 0;
4331 SvLEN(sv) = 0;
4332 if (flags & SV_COW_DROP_PV) {
4333 /* OK, so we don't need to copy our buffer. */
4334 SvPOK_off(sv);
4335 } else {
4336 SvGROW(sv, cur + 1);
4337 Move(pvx,SvPVX(sv),cur,char);
4338 SvCUR(sv) = cur;
4339 *SvEND(sv) = '\0';
4340 }
e419cbc5 4341 sv_release_COW(sv, pvx, cur, len, hash, next);
46187eeb 4342 if (DEBUG_C_TEST) {
e419cbc5 4343 sv_dump(sv);
46187eeb 4344 }
765f542d
NC
4345 }
4346 else if (PL_curcop != &PL_compiling)
4347 Perl_croak(aTHX_ PL_no_modify);
4348 /* At this point I believe that I can drop the global SV mutex. */
4349 }
4350#else
2213622d 4351 if (SvREADONLY(sv)) {
1c846c1f
NIS
4352 if (SvFAKE(sv)) {
4353 char *pvx = SvPVX(sv);
4354 STRLEN len = SvCUR(sv);
4355 U32 hash = SvUVX(sv);
4356 SvGROW(sv, len + 1);
4357 Move(pvx,SvPVX(sv),len,char);
4358 *SvEND(sv) = '\0';
4359 SvFAKE_off(sv);
4360 SvREADONLY_off(sv);
25716404 4361 unsharepvn(pvx, SvUTF8(sv) ? -(I32)len : len, hash);
1c846c1f
NIS
4362 }
4363 else if (PL_curcop != &PL_compiling)
cea2e8a9 4364 Perl_croak(aTHX_ PL_no_modify);
0f15f207 4365 }
765f542d 4366#endif
2213622d 4367 if (SvROK(sv))
840a7b70 4368 sv_unref_flags(sv, flags);
6fc92669
GS
4369 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
4370 sv_unglob(sv);
0f15f207 4371}
1c846c1f 4372
645c22ef
DM
4373/*
4374=for apidoc sv_force_normal
4375
4376Undo various types of fakery on an SV: if the PV is a shared string, make
4377a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
4378an xpvmg. See also C<sv_force_normal_flags>.
4379
4380=cut
4381*/
4382
840a7b70
IZ
4383void
4384Perl_sv_force_normal(pTHX_ register SV *sv)
4385{
4386 sv_force_normal_flags(sv, 0);
4387}
4388
954c1994
GS
4389/*
4390=for apidoc sv_chop
4391
1c846c1f 4392Efficient removal of characters from the beginning of the string buffer.
954c1994
GS
4393SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
4394the string buffer. The C<ptr> becomes the first character of the adjusted
645c22ef 4395string. Uses the "OOK hack".
954c1994
GS
4396
4397=cut
4398*/
4399
79072805 4400void
645c22ef 4401Perl_sv_chop(pTHX_ register SV *sv, register char *ptr)
79072805
LW
4402{
4403 register STRLEN delta;
4404
a0d0e21e 4405 if (!ptr || !SvPOKp(sv))
79072805 4406 return;
2213622d 4407 SV_CHECK_THINKFIRST(sv);
79072805
LW
4408 if (SvTYPE(sv) < SVt_PVIV)
4409 sv_upgrade(sv,SVt_PVIV);
4410
4411 if (!SvOOK(sv)) {
50483b2c
JD
4412 if (!SvLEN(sv)) { /* make copy of shared string */
4413 char *pvx = SvPVX(sv);
4414 STRLEN len = SvCUR(sv);
4415 SvGROW(sv, len + 1);
4416 Move(pvx,SvPVX(sv),len,char);
4417 *SvEND(sv) = '\0';
4418 }
463ee0b2 4419 SvIVX(sv) = 0;
79072805
LW
4420 SvFLAGS(sv) |= SVf_OOK;
4421 }
25da4f38 4422 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVp_IOK|SVp_NOK|SVf_IVisUV);
463ee0b2 4423 delta = ptr - SvPVX(sv);
79072805
LW
4424 SvLEN(sv) -= delta;
4425 SvCUR(sv) -= delta;
463ee0b2
LW
4426 SvPVX(sv) += delta;
4427 SvIVX(sv) += delta;
79072805
LW
4428}
4429
954c1994
GS
4430/*
4431=for apidoc sv_catpvn
4432
4433Concatenates the string onto the end of the string which is in the SV. The
d5ce4a7c
GA
4434C<len> indicates number of bytes to copy. If the SV has the UTF8
4435status set, then the bytes appended should be valid UTF8.
4436Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
954c1994 4437
8d6d96c1
HS
4438=for apidoc sv_catpvn_flags
4439
4440Concatenates the string onto the end of the string which is in the SV. The
4441C<len> indicates number of bytes to copy. If the SV has the UTF8
4442status set, then the bytes appended should be valid UTF8.
4443If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4444appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4445in terms of this function.
4446
4447=cut
4448*/
4449
4450void
4451Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4452{
4453 STRLEN dlen;
4454 char *dstr;
4455
4456 dstr = SvPV_force_flags(dsv, dlen, flags);
4457 SvGROW(dsv, dlen + slen + 1);
4458 if (sstr == dstr)
4459 sstr = SvPVX(dsv);
4460 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4461 SvCUR(dsv) += slen;
4462 *SvEND(dsv) = '\0';
4463 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4464 SvTAINT(dsv);
79072805
LW
4465}
4466
954c1994
GS
4467/*
4468=for apidoc sv_catpvn_mg
4469
4470Like C<sv_catpvn>, but also handles 'set' magic.
4471
4472=cut
4473*/
4474
79072805 4475void
864dbfa3 4476Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
ef50df4b
GS
4477{
4478 sv_catpvn(sv,ptr,len);
4479 SvSETMAGIC(sv);
4480}
4481
954c1994
GS
4482/*
4483=for apidoc sv_catsv
4484
13e8c8e3
JH
4485Concatenates the string from SV C<ssv> onto the end of the string in
4486SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4487not 'set' magic. See C<sv_catsv_mg>.
954c1994 4488
8d6d96c1
HS
4489=for apidoc sv_catsv_flags
4490
4491Concatenates the string from SV C<ssv> onto the end of the string in
4492SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4493bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4494and C<sv_catsv_nomg> are implemented in terms of this function.
4495
4496=cut */
4497
ef50df4b 4498void
8d6d96c1 4499Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
79072805 4500{
13e8c8e3
JH
4501 char *spv;
4502 STRLEN slen;
46199a12 4503 if (!ssv)
79072805 4504 return;
46199a12 4505 if ((spv = SvPV(ssv, slen))) {
4fd84b44
AD
4506 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4507 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
8cf8f3d1
NIS
4508 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4509 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4fd84b44
AD
4510 dsv->sv_flags doesn't have that bit set.
4511 Andy Dougherty 12 Oct 2001
4512 */
4513 I32 sutf8 = DO_UTF8(ssv);
4514 I32 dutf8;
13e8c8e3 4515
8d6d96c1
HS
4516 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4517 mg_get(dsv);
4518 dutf8 = DO_UTF8(dsv);
4519
4520 if (dutf8 != sutf8) {
13e8c8e3 4521 if (dutf8) {
46199a12 4522 /* Not modifying source SV, so taking a temporary copy. */
8d6d96c1 4523 SV* csv = sv_2mortal(newSVpvn(spv, slen));
13e8c8e3 4524
46199a12 4525 sv_utf8_upgrade(csv);
8d6d96c1 4526 spv = SvPV(csv, slen);
13e8c8e3 4527 }
8d6d96c1
HS
4528 else
4529 sv_utf8_upgrade_nomg(dsv);
e84ff256 4530 }
8d6d96c1 4531 sv_catpvn_nomg(dsv, spv, slen);
560a288e 4532 }
79072805
LW
4533}
4534
954c1994
GS
4535/*
4536=for apidoc sv_catsv_mg
4537
4538Like C<sv_catsv>, but also handles 'set' magic.
4539
4540=cut
4541*/
4542
79072805 4543void
46199a12 4544Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
ef50df4b 4545{
46199a12
JH
4546 sv_catsv(dsv,ssv);
4547 SvSETMAGIC(dsv);
ef50df4b
GS
4548}
4549
954c1994
GS
4550/*
4551=for apidoc sv_catpv
4552
4553Concatenates the string onto the end of the string which is in the SV.
d5ce4a7c
GA
4554If the SV has the UTF8 status set, then the bytes appended should be
4555valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
954c1994 4556
d5ce4a7c 4557=cut */
954c1994 4558
ef50df4b 4559void
0c981600 4560Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
79072805
LW
4561{
4562 register STRLEN len;
463ee0b2 4563 STRLEN tlen;
748a9306 4564 char *junk;
79072805 4565
0c981600 4566 if (!ptr)
79072805 4567 return;
748a9306 4568 junk = SvPV_force(sv, tlen);
0c981600 4569 len = strlen(ptr);
463ee0b2 4570 SvGROW(sv, tlen + len + 1);
0c981600
JH
4571 if (ptr == junk)
4572 ptr = SvPVX(sv);
4573 Move(ptr,SvPVX(sv)+tlen,len+1,char);
79072805 4574 SvCUR(sv) += len;
d41ff1b8 4575 (void)SvPOK_only_UTF8(sv); /* validate pointer */
463ee0b2 4576 SvTAINT(sv);
79072805
LW
4577}
4578
954c1994
GS
4579/*
4580=for apidoc sv_catpv_mg
4581
4582Like C<sv_catpv>, but also handles 'set' magic.
4583
4584=cut
4585*/
4586
ef50df4b 4587void
0c981600 4588Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
ef50df4b 4589{
0c981600 4590 sv_catpv(sv,ptr);
ef50df4b
GS
4591 SvSETMAGIC(sv);
4592}
4593
645c22ef
DM
4594/*
4595=for apidoc newSV
4596
4597Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4598with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4599macro.
4600
4601=cut
4602*/
4603
79072805 4604SV *
864dbfa3 4605Perl_newSV(pTHX_ STRLEN len)
79072805
LW
4606{
4607 register SV *sv;
1c846c1f 4608
4561caa4 4609 new_SV(sv);
79072805
LW
4610 if (len) {
4611 sv_upgrade(sv, SVt_PV);
4612 SvGROW(sv, len + 1);
4613 }
4614 return sv;
4615}
954c1994 4616/*
92110913 4617=for apidoc sv_magicext
954c1994 4618
68795e93 4619Adds magic to an SV, upgrading it if necessary. Applies the
92110913
NIS
4620supplied vtable and returns pointer to the magic added.
4621
4622Note that sv_magicext will allow things that sv_magic will not.
68795e93 4623In particular you can add magic to SvREADONLY SVs and and more than
92110913 4624one instance of the same 'how'
645c22ef 4625
92110913 4626I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
68795e93
NIS
4627if C<namelen> is zero then C<name> is stored as-is and - as another special
4628case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
92110913
NIS
4629an C<SV*> and has its REFCNT incremented
4630
4631(This is now used as a subroutine by sv_magic.)
954c1994
GS
4632
4633=cut
4634*/
92110913
NIS
4635MAGIC *
4636Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4637 const char* name, I32 namlen)
79072805
LW
4638{
4639 MAGIC* mg;
68795e93 4640
92110913
NIS
4641 if (SvTYPE(sv) < SVt_PVMG) {
4642 (void)SvUPGRADE(sv, SVt_PVMG);
463ee0b2 4643 }
79072805
LW
4644 Newz(702,mg, 1, MAGIC);
4645 mg->mg_moremagic = SvMAGIC(sv);
79072805 4646 SvMAGIC(sv) = mg;
75f9d97a 4647
18808301 4648 /* Some magic sontains a reference loop, where the sv and object refer to
bb03859b
RS
4649 each other. To prevent a reference loop that would prevent such
4650 objects being freed, we look for such loops and if we find one we
87f0b213
JH
4651 avoid incrementing the object refcount.
4652
4653 Note we cannot do this to avoid self-tie loops as intervening RV must
b5ccf5f2 4654 have its REFCNT incremented to keep it in existence.
87f0b213
JH
4655
4656 */
14befaf4
DM
4657 if (!obj || obj == sv ||
4658 how == PERL_MAGIC_arylen ||
4659 how == PERL_MAGIC_qr ||
75f9d97a
JH
4660 (SvTYPE(obj) == SVt_PVGV &&
4661 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4662 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
2628be26 4663 GvFORM(obj) == (CV*)sv)))
75f9d97a 4664 {
8990e307 4665 mg->mg_obj = obj;
75f9d97a 4666 }
85e6fe83 4667 else {
8990e307 4668 mg->mg_obj = SvREFCNT_inc(obj);
85e6fe83
LW
4669 mg->mg_flags |= MGf_REFCOUNTED;
4670 }
b5ccf5f2
YST
4671
4672 /* Normal self-ties simply pass a null object, and instead of
4673 using mg_obj directly, use the SvTIED_obj macro to produce a
4674 new RV as needed. For glob "self-ties", we are tieing the PVIO
4675 with an RV obj pointing to the glob containing the PVIO. In
4676 this case, to avoid a reference loop, we need to weaken the
4677 reference.
4678 */
4679
4680 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4681 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4682 {
4683 sv_rvweaken(obj);
4684 }
4685
79072805 4686 mg->mg_type = how;
565764a8 4687 mg->mg_len = namlen;
9cbac4c7 4688 if (name) {
92110913 4689 if (namlen > 0)
1edc1566 4690 mg->mg_ptr = savepvn(name, namlen);
c6ee37c5 4691 else if (namlen == HEf_SVKEY)
1edc1566 4692 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
68795e93 4693 else
92110913 4694 mg->mg_ptr = (char *) name;
9cbac4c7 4695 }
92110913 4696 mg->mg_virtual = vtable;
68795e93 4697
92110913
NIS
4698 mg_magical(sv);
4699 if (SvGMAGICAL(sv))
4700 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4701 return mg;
4702}
4703
4704/*
4705=for apidoc sv_magic
1c846c1f 4706
92110913
NIS
4707Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4708then adds a new magic item of type C<how> to the head of the magic list.
4709
4710=cut
4711*/
4712
4713void
4714Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
68795e93 4715{
92110913
NIS
4716 MAGIC* mg;
4717 MGVTBL *vtable = 0;
4718
765f542d
NC
4719#ifdef PERL_COPY_ON_WRITE
4720 if (SvIsCOW(sv))
4721 sv_force_normal_flags(sv, 0);
4722#endif
92110913
NIS
4723 if (SvREADONLY(sv)) {
4724 if (PL_curcop != &PL_compiling
4725 && how != PERL_MAGIC_regex_global
4726 && how != PERL_MAGIC_bm
4727 && how != PERL_MAGIC_fm
4728 && how != PERL_MAGIC_sv
4729 )
4730 {
4731 Perl_croak(aTHX_ PL_no_modify);
4732 }
4733 }
4734 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4735 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
68795e93
NIS
4736 /* sv_magic() refuses to add a magic of the same 'how' as an
4737 existing one
92110913
NIS
4738 */
4739 if (how == PERL_MAGIC_taint)
4740 mg->mg_len |= 1;
4741 return;
4742 }
4743 }
68795e93 4744
79072805 4745 switch (how) {
14befaf4 4746 case PERL_MAGIC_sv:
92110913 4747 vtable = &PL_vtbl_sv;
79072805 4748 break;
14befaf4 4749 case PERL_MAGIC_overload:
92110913 4750 vtable = &PL_vtbl_amagic;
a0d0e21e 4751 break;
14befaf4 4752 case PERL_MAGIC_overload_elem:
92110913 4753 vtable = &PL_vtbl_amagicelem;
a0d0e21e 4754 break;
14befaf4 4755 case PERL_MAGIC_overload_table:
92110913 4756 vtable = &PL_vtbl_ovrld;
a0d0e21e 4757 break;
14befaf4 4758 case PERL_MAGIC_bm:
92110913 4759 vtable = &PL_vtbl_bm;
79072805 4760 break;
14befaf4 4761 case PERL_MAGIC_regdata:
92110913 4762 vtable = &PL_vtbl_regdata;
6cef1e77 4763 break;
14befaf4 4764 case PERL_MAGIC_regdatum:
92110913 4765 vtable = &PL_vtbl_regdatum;
6cef1e77 4766 break;
14befaf4 4767 case PERL_MAGIC_env:
92110913 4768 vtable = &PL_vtbl_env;
79072805 4769 break;
14befaf4 4770 case PERL_MAGIC_fm:
92110913 4771 vtable = &PL_vtbl_fm;
55497cff 4772 break;
14befaf4 4773 case PERL_MAGIC_envelem:
92110913 4774 vtable = &PL_vtbl_envelem;
79072805 4775 break;
14befaf4 4776 case PERL_MAGIC_regex_global:
92110913 4777 vtable = &PL_vtbl_mglob;
93a17b20 4778 break;
14befaf4 4779 case PERL_MAGIC_isa:
92110913 4780 vtable = &PL_vtbl_isa;
463ee0b2 4781 break;
14befaf4 4782 case PERL_MAGIC_isaelem:
92110913 4783 vtable = &PL_vtbl_isaelem;
463ee0b2 4784 break;
14befaf4 4785 case PERL_MAGIC_nkeys:
92110913 4786 vtable = &PL_vtbl_nkeys;
16660edb 4787 break;
14befaf4 4788 case PERL_MAGIC_dbfile:
92110913 4789 vtable = 0;
93a17b20 4790 break;
14befaf4 4791 case PERL_MAGIC_dbline:
92110913 4792 vtable = &PL_vtbl_dbline;
79072805 4793 break;
36477c24 4794#ifdef USE_LOCALE_COLLATE
14befaf4 4795 case PERL_MAGIC_collxfrm:
92110913 4796 vtable = &PL_vtbl_collxfrm;
bbce6d69 4797 break;
36477c24 4798#endif /* USE_LOCALE_COLLATE */
14befaf4 4799 case PERL_MAGIC_tied:
92110913 4800 vtable = &PL_vtbl_pack;
463ee0b2 4801 break;
14befaf4
DM
4802 case PERL_MAGIC_tiedelem:
4803 case PERL_MAGIC_tiedscalar:
92110913 4804 vtable = &PL_vtbl_packelem;
463ee0b2 4805 break;
14befaf4 4806 case PERL_MAGIC_qr:
92110913 4807 vtable = &PL_vtbl_regexp;
c277df42 4808 break;
14befaf4 4809 case PERL_MAGIC_sig:
92110913 4810 vtable = &PL_vtbl_sig;
79072805 4811 break;
14befaf4 4812 case PERL_MAGIC_sigelem:
92110913 4813 vtable = &PL_vtbl_sigelem;
79072805 4814 break;
14befaf4 4815 case PERL_MAGIC_taint:
92110913 4816 vtable = &PL_vtbl_taint;
463ee0b2 4817 break;
14befaf4 4818 case PERL_MAGIC_uvar:
92110913 4819 vtable = &PL_vtbl_uvar;
79072805 4820 break;
14befaf4 4821 case PERL_MAGIC_vec:
92110913 4822 vtable = &PL_vtbl_vec;
79072805 4823 break;
ece467f9
JP
4824 case PERL_MAGIC_vstring:
4825 vtable = 0;
4826 break;
7e8c5dac
HS
4827 case PERL_MAGIC_utf8:
4828 vtable = &PL_vtbl_utf8;
4829 break;
14befaf4 4830 case PERL_MAGIC_substr:
92110913 4831 vtable = &PL_vtbl_substr;
79072805 4832 break;
14befaf4 4833 case PERL_MAGIC_defelem:
92110913 4834 vtable = &PL_vtbl_defelem;
5f05dabc 4835 break;
14befaf4 4836 case PERL_MAGIC_glob:
92110913 4837 vtable = &PL_vtbl_glob;
79072805 4838 break;
14befaf4 4839 case PERL_MAGIC_arylen:
92110913 4840 vtable = &PL_vtbl_arylen;
79072805 4841 break;
14befaf4 4842 case PERL_MAGIC_pos:
92110913 4843 vtable = &PL_vtbl_pos;
a0d0e21e 4844 break;
14befaf4 4845 case PERL_MAGIC_backref:
92110913 4846 vtable = &PL_vtbl_backref;
810b8aa5 4847 break;
14befaf4
DM
4848 case PERL_MAGIC_ext:
4849 /* Reserved for use by extensions not perl internals. */
4633a7c4
LW
4850 /* Useful for attaching extension internal data to perl vars. */
4851 /* Note that multiple extensions may clash if magical scalars */
4852 /* etc holding private data from one are passed to another. */
a0d0e21e 4853 break;
79072805 4854 default:
14befaf4 4855 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
463ee0b2 4856 }
68795e93 4857
92110913
NIS
4858 /* Rest of work is done else where */
4859 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
68795e93 4860
92110913
NIS
4861 switch (how) {
4862 case PERL_MAGIC_taint:
4863 mg->mg_len = 1;
4864 break;
4865 case PERL_MAGIC_ext:
4866 case PERL_MAGIC_dbfile:
4867 SvRMAGICAL_on(sv);
4868 break;
4869 }
463ee0b2
LW
4870}
4871
c461cf8f
JH
4872/*
4873=for apidoc sv_unmagic
4874
645c22ef 4875Removes all magic of type C<type> from an SV.
c461cf8f
JH
4876
4877=cut
4878*/
4879
463ee0b2 4880int
864dbfa3 4881Perl_sv_unmagic(pTHX_ SV *sv, int type)
463ee0b2
LW
4882{
4883 MAGIC* mg;
4884 MAGIC** mgp;
91bba347 4885 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
463ee0b2
LW
4886 return 0;
4887 mgp = &SvMAGIC(sv);
4888 for (mg = *mgp; mg; mg = *mgp) {
4889 if (mg->mg_type == type) {
4890 MGVTBL* vtbl = mg->mg_virtual;
4891 *mgp = mg->mg_moremagic;
1d7c1841 4892 if (vtbl && vtbl->svt_free)
fc0dc3b3 4893 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
14befaf4 4894 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
92110913 4895 if (mg->mg_len > 0)
1edc1566 4896 Safefree(mg->mg_ptr);
565764a8 4897 else if (mg->mg_len == HEf_SVKEY)
1edc1566 4898 SvREFCNT_dec((SV*)mg->mg_ptr);
7e8c5dac
HS
4899 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4900 Safefree(mg->mg_ptr);
9cbac4c7 4901 }
a0d0e21e
LW
4902 if (mg->mg_flags & MGf_REFCOUNTED)
4903 SvREFCNT_dec(mg->mg_obj);
463ee0b2
LW
4904 Safefree(mg);
4905 }
4906 else
4907 mgp = &mg->mg_moremagic;
79072805 4908 }
91bba347 4909 if (!SvMAGIC(sv)) {
463ee0b2 4910 SvMAGICAL_off(sv);
06759ea0 4911 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
463ee0b2
LW
4912 }
4913
4914 return 0;
79072805
LW
4915}
4916
c461cf8f
JH
4917/*
4918=for apidoc sv_rvweaken
4919
645c22ef
DM
4920Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4921referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4922push a back-reference to this RV onto the array of backreferences
4923associated with that magic.
c461cf8f
JH
4924
4925=cut
4926*/
4927
810b8aa5 4928SV *
864dbfa3 4929Perl_sv_rvweaken(pTHX_ SV *sv)
810b8aa5
GS
4930{
4931 SV *tsv;
4932 if (!SvOK(sv)) /* let undefs pass */
4933 return sv;
4934 if (!SvROK(sv))
cea2e8a9 4935 Perl_croak(aTHX_ "Can't weaken a nonreference");
810b8aa5 4936 else if (SvWEAKREF(sv)) {
810b8aa5 4937 if (ckWARN(WARN_MISC))
9014280d 4938 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
810b8aa5
GS
4939 return sv;
4940 }
4941 tsv = SvRV(sv);
4942 sv_add_backref(tsv, sv);
4943 SvWEAKREF_on(sv);
1c846c1f 4944 SvREFCNT_dec(tsv);
810b8aa5
GS
4945 return sv;
4946}
4947
645c22ef
DM
4948/* Give tsv backref magic if it hasn't already got it, then push a
4949 * back-reference to sv onto the array associated with the backref magic.
4950 */
4951
810b8aa5 4952STATIC void
cea2e8a9 4953S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
810b8aa5
GS
4954{
4955 AV *av;
4956 MAGIC *mg;
14befaf4 4957 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
810b8aa5
GS
4958 av = (AV*)mg->mg_obj;
4959 else {
4960 av = newAV();
14befaf4 4961 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
810b8aa5
GS
4962 SvREFCNT_dec(av); /* for sv_magic */
4963 }
4964 av_push(av,sv);
4965}
4966
645c22ef
DM
4967/* delete a back-reference to ourselves from the backref magic associated
4968 * with the SV we point to.
4969 */
4970
1c846c1f 4971STATIC void
cea2e8a9 4972S_sv_del_backref(pTHX_ SV *sv)
810b8aa5
GS
4973{
4974 AV *av;
4975 SV **svp;
4976 I32 i;
4977 SV *tsv = SvRV(sv);
c04a4dfe 4978 MAGIC *mg = NULL;
14befaf4 4979 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
cea2e8a9 4980 Perl_croak(aTHX_ "panic: del_backref");
810b8aa5
GS
4981 av = (AV *)mg->mg_obj;
4982 svp = AvARRAY(av);
4983 i = AvFILLp(av);
4984 while (i >= 0) {
4985 if (svp[i] == sv) {
4986 svp[i] = &PL_sv_undef; /* XXX */
4987 }
4988 i--;
4989 }
4990}
4991
954c1994
GS
4992/*
4993=for apidoc sv_insert
4994
4995Inserts a string at the specified offset/length within the SV. Similar to
4996the Perl substr() function.
4997
4998=cut
4999*/
5000
79072805 5001void
864dbfa3 5002Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
79072805
LW
5003{
5004 register char *big;
5005 register char *mid;
5006 register char *midend;
5007 register char *bigend;
5008 register I32 i;
6ff81951 5009 STRLEN curlen;
1c846c1f 5010
79072805 5011
8990e307 5012 if (!bigstr)
cea2e8a9 5013 Perl_croak(aTHX_ "Can't modify non-existent substring");
6ff81951 5014 SvPV_force(bigstr, curlen);
60fa28ff 5015 (void)SvPOK_only_UTF8(bigstr);
6ff81951
GS
5016 if (offset + len > curlen) {
5017 SvGROW(bigstr, offset+len+1);
5018 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5019 SvCUR_set(bigstr, offset+len);
5020 }
79072805 5021
69b47968 5022 SvTAINT(bigstr);
79072805
LW
5023 i = littlelen - len;
5024 if (i > 0) { /* string might grow */
a0d0e21e 5025 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
79072805
LW
5026 mid = big + offset + len;
5027 midend = bigend = big + SvCUR(bigstr);
5028 bigend += i;
5029 *bigend = '\0';
5030 while (midend > mid) /* shove everything down */
5031 *--bigend = *--midend;
5032 Move(little,big+offset,littlelen,char);
5033 SvCUR(bigstr) += i;
5034 SvSETMAGIC(bigstr);
5035 return;
5036 }
5037 else if (i == 0) {
463ee0b2 5038 Move(little,SvPVX(bigstr)+offset,len,char);
79072805
LW
5039 SvSETMAGIC(bigstr);
5040 return;
5041 }
5042
463ee0b2 5043 big = SvPVX(bigstr);
79072805
LW
5044 mid = big + offset;
5045 midend = mid + len;
5046 bigend = big + SvCUR(bigstr);
5047
5048 if (midend > bigend)
cea2e8a9 5049 Perl_croak(aTHX_ "panic: sv_insert");
79072805
LW
5050
5051 if (mid - big > bigend - midend) { /* faster to shorten from end */
5052 if (littlelen) {
5053 Move(little, mid, littlelen,char);
5054 mid += littlelen;
5055 }
5056 i = bigend - midend;
5057 if (i > 0) {
5058 Move(midend, mid, i,char);
5059 mid += i;
5060 }
5061 *mid = '\0';
5062 SvCUR_set(bigstr, mid - big);
5063 }
5064 /*SUPPRESS 560*/
155aba94 5065 else if ((i = mid - big)) { /* faster from front */
79072805
LW
5066 midend -= littlelen;
5067 mid = midend;
5068 sv_chop(bigstr,midend-i);
5069 big += i;
5070 while (i--)
5071 *--midend = *--big;
5072 if (littlelen)
5073 Move(little, mid, littlelen,char);
5074 }
5075 else if (littlelen) {
5076 midend -= littlelen;
5077 sv_chop(bigstr,midend);
5078 Move(little,midend,littlelen,char);
5079 }
5080 else {
5081 sv_chop(bigstr,midend);
5082 }
5083 SvSETMAGIC(bigstr);
5084}
5085
c461cf8f
JH
5086/*
5087=for apidoc sv_replace
5088
5089Make the first argument a copy of the second, then delete the original.
645c22ef
DM
5090The target SV physically takes over ownership of the body of the source SV
5091and inherits its flags; however, the target keeps any magic it owns,
5092and any magic in the source is discarded.
ff276b08 5093Note that this is a rather specialist SV copying operation; most of the
645c22ef 5094time you'll want to use C<sv_setsv> or one of its many macro front-ends.
c461cf8f
JH
5095
5096=cut
5097*/
79072805
LW
5098
5099void
864dbfa3 5100Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
79072805
LW
5101{
5102 U32 refcnt = SvREFCNT(sv);
765f542d 5103 SV_CHECK_THINKFIRST_COW_DROP(sv);
0453d815 5104 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
9014280d 5105 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
93a17b20 5106 if (SvMAGICAL(sv)) {
a0d0e21e
LW
5107 if (SvMAGICAL(nsv))
5108 mg_free(nsv);
5109 else
5110 sv_upgrade(nsv, SVt_PVMG);
93a17b20 5111 SvMAGIC(nsv) = SvMAGIC(sv);
a0d0e21e 5112 SvFLAGS(nsv) |= SvMAGICAL(sv);
93a17b20
LW
5113 SvMAGICAL_off(sv);
5114 SvMAGIC(sv) = 0;
5115 }
79072805
LW
5116 SvREFCNT(sv) = 0;
5117 sv_clear(sv);
477f5d66 5118 assert(!SvREFCNT(sv));
79072805 5119 StructCopy(nsv,sv,SV);
d3d0e6f1
NC
5120#ifdef PERL_COPY_ON_WRITE
5121 if (SvIsCOW_normal(nsv)) {
5122 /* We need to follow the pointers around the loop to make the
5123 previous SV point to sv, rather than nsv. */
5124 SV *next;
5125 SV *current = nsv;
5126 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5127 assert(next);
5128 current = next;
5129 assert(SvPVX(current) == SvPVX(nsv));
5130 }
5131 /* Make the SV before us point to the SV after us. */
5132 if (DEBUG_C_TEST) {
5133 PerlIO_printf(Perl_debug_log, "previous is\n");
5134 sv_dump(current);
a29f6d03
NC
5135 PerlIO_printf(Perl_debug_log,
5136 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
d3d0e6f1
NC
5137 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5138 }
a29f6d03 5139 SV_COW_NEXT_SV_SET(current, sv);
d3d0e6f1
NC
5140 }
5141#endif
79072805 5142 SvREFCNT(sv) = refcnt;
1edc1566 5143 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
463ee0b2 5144 del_SV(nsv);
79072805
LW
5145}
5146
c461cf8f
JH
5147/*
5148=for apidoc sv_clear
5149
645c22ef
DM
5150Clear an SV: call any destructors, free up any memory used by the body,
5151and free the body itself. The SV's head is I<not> freed, although
5152its type is set to all 1's so that it won't inadvertently be assumed
5153to be live during global destruction etc.
5154This function should only be called when REFCNT is zero. Most of the time
5155you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5156instead.
c461cf8f
JH
5157
5158=cut
5159*/
5160
79072805 5161void
864dbfa3 5162Perl_sv_clear(pTHX_ register SV *sv)
79072805 5163{
ec12f114 5164 HV* stash;
79072805
LW
5165 assert(sv);
5166 assert(SvREFCNT(sv) == 0);
5167
ed6116ce 5168 if (SvOBJECT(sv)) {
3280af22 5169 if (PL_defstash) { /* Still have a symbol table? */
39644a26 5170 dSP;
32251b26 5171 CV* destructor;
837485b6 5172 SV tmpref;
a0d0e21e 5173
837485b6
GS
5174 Zero(&tmpref, 1, SV);
5175 sv_upgrade(&tmpref, SVt_RV);
5176 SvROK_on(&tmpref);
5177 SvREADONLY_on(&tmpref); /* DESTROY() could be naughty */
5178 SvREFCNT(&tmpref) = 1;
8ebc5c01 5179
d460ef45 5180 do {
4e8e7886 5181 stash = SvSTASH(sv);
32251b26 5182 destructor = StashHANDLER(stash,DESTROY);
4e8e7886
GS
5183 if (destructor) {
5184 ENTER;
e788e7d3 5185 PUSHSTACKi(PERLSI_DESTROY);
837485b6 5186 SvRV(&tmpref) = SvREFCNT_inc(sv);
4e8e7886
GS
5187 EXTEND(SP, 2);
5188 PUSHMARK(SP);
837485b6 5189 PUSHs(&tmpref);
4e8e7886 5190 PUTBACK;
44389ee9 5191 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4e8e7886 5192 SvREFCNT(sv)--;
d3acc0f7 5193 POPSTACK;
3095d977 5194 SPAGAIN;
4e8e7886
GS
5195 LEAVE;
5196 }
5197 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
8ebc5c01 5198
837485b6 5199 del_XRV(SvANY(&tmpref));
6f44e0a4
JP
5200
5201 if (SvREFCNT(sv)) {
5202 if (PL_in_clean_objs)
cea2e8a9 5203 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
6f44e0a4
JP
5204 HvNAME(stash));
5205 /* DESTROY gave object new lease on life */
5206 return;
5207 }
a0d0e21e 5208 }
4e8e7886 5209
a0d0e21e 5210 if (SvOBJECT(sv)) {
4e8e7886 5211 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
a0d0e21e
LW
5212 SvOBJECT_off(sv); /* Curse the object. */
5213 if (SvTYPE(sv) != SVt_PVIO)
3280af22 5214 --PL_sv_objcount; /* XXX Might want something more general */
a0d0e21e 5215 }
463ee0b2 5216 }
524189f1
JH
5217 if (SvTYPE(sv) >= SVt_PVMG) {
5218 if (SvMAGIC(sv))
5219 mg_free(sv);
5220 if (SvFLAGS(sv) & SVpad_TYPED)
5221 SvREFCNT_dec(SvSTASH(sv));
5222 }
ec12f114 5223 stash = NULL;
79072805 5224 switch (SvTYPE(sv)) {
8990e307 5225 case SVt_PVIO:
df0bd2f4
GS
5226 if (IoIFP(sv) &&
5227 IoIFP(sv) != PerlIO_stdin() &&
5f05dabc 5228 IoIFP(sv) != PerlIO_stdout() &&
5229 IoIFP(sv) != PerlIO_stderr())
93578b34 5230 {
f2b5be74 5231 io_close((IO*)sv, FALSE);
93578b34 5232 }
1d7c1841 5233 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
1236053a 5234 PerlDir_close(IoDIRP(sv));
1d7c1841 5235 IoDIRP(sv) = (DIR*)NULL;
8990e307
LW
5236 Safefree(IoTOP_NAME(sv));
5237 Safefree(IoFMT_NAME(sv));
5238 Safefree(IoBOTTOM_NAME(sv));
a0d0e21e 5239 /* FALL THROUGH */
79072805 5240 case SVt_PVBM:
a0d0e21e 5241 goto freescalar;
79072805 5242 case SVt_PVCV:
748a9306 5243 case SVt_PVFM:
85e6fe83 5244 cv_undef((CV*)sv);
a0d0e21e 5245 goto freescalar;
79072805 5246 case SVt_PVHV:
85e6fe83 5247 hv_undef((HV*)sv);
a0d0e21e 5248 break;
79072805 5249 case SVt_PVAV:
85e6fe83 5250 av_undef((AV*)sv);
a0d0e21e 5251 break;
02270b4e
GS
5252 case SVt_PVLV:
5253 SvREFCNT_dec(LvTARG(sv));
5254 goto freescalar;
a0d0e21e 5255 case SVt_PVGV:
1edc1566 5256 gp_free((GV*)sv);
a0d0e21e 5257 Safefree(GvNAME(sv));
ec12f114
JPC
5258 /* cannot decrease stash refcount yet, as we might recursively delete
5259 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5260 of stash until current sv is completely gone.
5261 -- JohnPC, 27 Mar 1998 */
5262 stash = GvSTASH(sv);
a0d0e21e 5263 /* FALL THROUGH */
79072805 5264 case SVt_PVMG:
79072805
LW
5265 case SVt_PVNV:
5266 case SVt_PVIV:
a0d0e21e
LW
5267 freescalar:
5268 (void)SvOOK_off(sv);
79072805
LW
5269 /* FALL THROUGH */
5270 case SVt_PV:
a0d0e21e 5271 case SVt_RV:
810b8aa5
GS
5272 if (SvROK(sv)) {
5273 if (SvWEAKREF(sv))
5274 sv_del_backref(sv);
5275 else
5276 SvREFCNT_dec(SvRV(sv));
5277 }
765f542d
NC
5278#ifdef PERL_COPY_ON_WRITE
5279 else if (SvPVX(sv)) {
5280 if (SvIsCOW(sv)) {
5281 /* I believe I need to grab the global SV mutex here and
5282 then recheck the COW status. */
46187eeb
NC
5283 if (DEBUG_C_TEST) {
5284 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
e419cbc5 5285 sv_dump(sv);
46187eeb 5286 }
e419cbc5 5287 sv_release_COW(sv, SvPVX(sv), SvCUR(sv), SvLEN(sv),
765f542d
NC
5288 SvUVX(sv), SV_COW_NEXT_SV(sv));
5289 /* And drop it here. */
5290 SvFAKE_off(sv);
5291 } else if (SvLEN(sv)) {
5292 Safefree(SvPVX(sv));
5293 }
5294 }
5295#else
1edc1566 5296 else if (SvPVX(sv) && SvLEN(sv))
463ee0b2 5297 Safefree(SvPVX(sv));
1c846c1f 5298 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
25716404
GS
5299 unsharepvn(SvPVX(sv),
5300 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5301 SvUVX(sv));
1c846c1f
NIS
5302 SvFAKE_off(sv);
5303 }
765f542d 5304#endif
79072805 5305 break;
a0d0e21e 5306/*
79072805 5307 case SVt_NV:
79072805 5308 case SVt_IV:
79072805
LW
5309 case SVt_NULL:
5310 break;
a0d0e21e 5311*/
79072805
LW
5312 }
5313
5314 switch (SvTYPE(sv)) {
5315 case SVt_NULL:
5316 break;
79072805
LW
5317 case SVt_IV:
5318 del_XIV(SvANY(sv));
5319 break;
5320 case SVt_NV:
5321 del_XNV(SvANY(sv));
5322 break;
ed6116ce
LW
5323 case SVt_RV:
5324 del_XRV(SvANY(sv));
5325 break;
79072805
LW
5326 case SVt_PV:
5327 del_XPV(SvANY(sv));
5328 break;
5329 case SVt_PVIV:
5330 del_XPVIV(SvANY(sv));
5331 break;
5332 case SVt_PVNV:
5333 del_XPVNV(SvANY(sv));
5334 break;
5335 case SVt_PVMG:
5336 del_XPVMG(SvANY(sv));
5337 break;
5338 case SVt_PVLV:
5339 del_XPVLV(SvANY(sv));
5340 break;
5341 case SVt_PVAV:
5342 del_XPVAV(SvANY(sv));
5343 break;
5344 case SVt_PVHV:
5345 del_XPVHV(SvANY(sv));
5346 break;
5347 case SVt_PVCV:
5348 del_XPVCV(SvANY(sv));
5349 break;
5350 case SVt_PVGV:
5351 del_XPVGV(SvANY(sv));
ec12f114
JPC
5352 /* code duplication for increased performance. */
5353 SvFLAGS(sv) &= SVf_BREAK;
5354 SvFLAGS(sv) |= SVTYPEMASK;
5355 /* decrease refcount of the stash that owns this GV, if any */
5356 if (stash)
5357 SvREFCNT_dec(stash);
5358 return; /* not break, SvFLAGS reset already happened */
79072805
LW
5359 case SVt_PVBM:
5360 del_XPVBM(SvANY(sv));
5361 break;
5362 case SVt_PVFM:
5363 del_XPVFM(SvANY(sv));
5364 break;
8990e307
LW
5365 case SVt_PVIO:
5366 del_XPVIO(SvANY(sv));
5367 break;
79072805 5368 }
a0d0e21e 5369 SvFLAGS(sv) &= SVf_BREAK;
8990e307 5370 SvFLAGS(sv) |= SVTYPEMASK;
79072805
LW
5371}
5372
645c22ef
DM
5373/*
5374=for apidoc sv_newref
5375
5376Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5377instead.
5378
5379=cut
5380*/
5381
79072805 5382SV *
864dbfa3 5383Perl_sv_newref(pTHX_ SV *sv)
79072805 5384{
463ee0b2 5385 if (sv)
dce16143 5386 ATOMIC_INC(SvREFCNT(sv));
79072805
LW
5387 return sv;
5388}
5389
c461cf8f
JH
5390/*
5391=for apidoc sv_free
5392
645c22ef
DM
5393Decrement an SV's reference count, and if it drops to zero, call
5394C<sv_clear> to invoke destructors and free up any memory used by
5395the body; finally, deallocate the SV's head itself.
5396Normally called via a wrapper macro C<SvREFCNT_dec>.
c461cf8f
JH
5397
5398=cut
5399*/
5400
79072805 5401void
864dbfa3 5402Perl_sv_free(pTHX_ SV *sv)
79072805 5403{
dce16143
MB
5404 int refcount_is_zero;
5405
79072805
LW
5406 if (!sv)
5407 return;
a0d0e21e
LW
5408 if (SvREFCNT(sv) == 0) {
5409 if (SvFLAGS(sv) & SVf_BREAK)
645c22ef
DM
5410 /* this SV's refcnt has been artificially decremented to
5411 * trigger cleanup */
a0d0e21e 5412 return;
3280af22 5413 if (PL_in_clean_all) /* All is fair */
1edc1566 5414 return;
d689ffdd
JP
5415 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5416 /* make sure SvREFCNT(sv)==0 happens very seldom */
5417 SvREFCNT(sv) = (~(U32)0)/2;
5418 return;
5419 }
0453d815 5420 if (ckWARN_d(WARN_INTERNAL))
9014280d 5421 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Attempt to free unreferenced scalar");
79072805
LW
5422 return;
5423 }
dce16143 5424 ATOMIC_DEC_AND_TEST(refcount_is_zero, SvREFCNT(sv));
b881518d 5425 if (!refcount_is_zero)
8990e307 5426 return;
463ee0b2
LW
5427#ifdef DEBUGGING
5428 if (SvTEMP(sv)) {
0453d815 5429 if (ckWARN_d(WARN_DEBUGGING))
9014280d 5430 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
1d7c1841
GS
5431 "Attempt to free temp prematurely: SV 0x%"UVxf,
5432 PTR2UV(sv));
79072805 5433 return;
79072805 5434 }
463ee0b2 5435#endif
d689ffdd
JP
5436 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5437 /* make sure SvREFCNT(sv)==0 happens very seldom */
5438 SvREFCNT(sv) = (~(U32)0)/2;
5439 return;
5440 }
79072805 5441 sv_clear(sv);
477f5d66
CS
5442 if (! SvREFCNT(sv))
5443 del_SV(sv);
79072805
LW
5444}
5445
954c1994
GS
5446/*
5447=for apidoc sv_len
5448
645c22ef
DM
5449Returns the length of the string in the SV. Handles magic and type
5450coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
954c1994
GS
5451
5452=cut
5453*/
5454
79072805 5455STRLEN
864dbfa3 5456Perl_sv_len(pTHX_ register SV *sv)
79072805 5457{
463ee0b2 5458 STRLEN len;
79072805
LW
5459
5460 if (!sv)
5461 return 0;
5462
8990e307 5463 if (SvGMAGICAL(sv))
565764a8 5464 len = mg_length(sv);
8990e307 5465 else
497b47a8 5466 (void)SvPV(sv, len);
463ee0b2 5467 return len;
79072805
LW
5468}
5469
c461cf8f
JH
5470/*
5471=for apidoc sv_len_utf8
5472
5473Returns the number of characters in the string in an SV, counting wide
645c22ef 5474UTF8 bytes as a single character. Handles magic and type coercion.
c461cf8f
JH
5475
5476=cut
5477*/
5478
7e8c5dac
HS
5479/*
5480 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5481 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5482 * (Note that the mg_len is not the length of the mg_ptr field.)
5483 *
5484 */
5485
a0ed51b3 5486STRLEN
864dbfa3 5487Perl_sv_len_utf8(pTHX_ register SV *sv)
a0ed51b3 5488{
a0ed51b3
LW
5489 if (!sv)
5490 return 0;
5491
a0ed51b3 5492 if (SvGMAGICAL(sv))
b76347f2 5493 return mg_length(sv);
a0ed51b3 5494 else
b76347f2 5495 {
7e8c5dac 5496 STRLEN len, ulen;
b76347f2 5497 U8 *s = (U8*)SvPV(sv, len);
7e8c5dac
HS
5498 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5499
5500 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0))
5501 ulen = mg->mg_len;
5502 else {
5503 ulen = Perl_utf8_length(aTHX_ s, s + len);
5504 if (!mg && !SvREADONLY(sv)) {
5505 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5506 mg = mg_find(sv, PERL_MAGIC_utf8);
5507 assert(mg);
5508 }
5509 if (mg)
5510 mg->mg_len = ulen;
5511 }
5512 return ulen;
5513 }
5514}
5515
5516/* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5517 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5518 * between UTF-8 and byte offsets. There are two (substr offset and substr
5519 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5520 * and byte offset) cache positions.
5521 *
5522 * The mg_len field is used by sv_len_utf8(), see its comments.
5523 * Note that the mg_len is not the length of the mg_ptr field.
5524 *
5525 */
5526STATIC bool
6e551876 5527S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, U8 *s, U8 *start)
7e8c5dac
HS
5528{
5529 bool found = FALSE;
5530
5531 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5532 if (!*mgp) {
5533 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5534 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5535 }
5536 assert(*mgp);
b76347f2 5537
7e8c5dac
HS
5538 if ((*mgp)->mg_ptr)
5539 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5540 else {
5541 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5542 (*mgp)->mg_ptr = (char *) *cachep;
5543 }
5544 assert(*cachep);
5545
5546 (*cachep)[i] = *offsetp;
5547 (*cachep)[i+1] = s - start;
5548 found = TRUE;
a0ed51b3 5549 }
7e8c5dac
HS
5550
5551 return found;
a0ed51b3
LW
5552}
5553
645c22ef 5554/*
7e8c5dac
HS
5555 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5556 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5557 * between UTF-8 and byte offsets. See also the comments of
5558 * S_utf8_mg_pos_init().
5559 *
5560 */
5561STATIC bool
6e551876 5562S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
7e8c5dac
HS
5563{
5564 bool found = FALSE;
5565
5566 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5567 if (!*mgp)
5568 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5569 if (*mgp && (*mgp)->mg_ptr) {
5570 *cachep = (STRLEN *) (*mgp)->mg_ptr;
667208dd 5571 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
7e8c5dac
HS
5572 found = TRUE;
5573 else { /* We will skip to the right spot. */
5574 STRLEN forw = 0;
5575 STRLEN backw = 0;
5576 U8* p = NULL;
5577
5578 /* The assumption is that going backward is half
5579 * the speed of going forward (that's where the
5580 * 2 * backw in the below comes from). (The real
5581 * figure of course depends on the UTF-8 data.) */
5582
667208dd 5583 if ((*cachep)[i] > (STRLEN)uoff) {
7e8c5dac 5584 forw = uoff;
667208dd 5585 backw = (*cachep)[i] - (STRLEN)uoff;
7e8c5dac
HS
5586
5587 if (forw < 2 * backw)
5588 p = start;
5589 else
5590 p = start + (*cachep)[i+1];
5591 }
5592 /* Try this only for the substr offset (i == 0),
5593 * not for the substr length (i == 2). */
5594 else if (i == 0) { /* (*cachep)[i] < uoff */
5595 STRLEN ulen = sv_len_utf8(sv);
5596
667208dd
JH
5597 if ((STRLEN)uoff < ulen) {
5598 forw = (STRLEN)uoff - (*cachep)[i];
5599 backw = ulen - (STRLEN)uoff;
7e8c5dac
HS
5600
5601 if (forw < 2 * backw)
5602 p = start + (*cachep)[i+1];
5603 else
5604 p = send;
5605 }
5606
5607 /* If the string is not long enough for uoff,
5608 * we could extend it, but not at this low a level. */
5609 }
5610
5611 if (p) {
5612 if (forw < 2 * backw) {
5613 while (forw--)
5614 p += UTF8SKIP(p);
5615 }
5616 else {
5617 while (backw--) {
5618 p--;
5619 while (UTF8_IS_CONTINUATION(*p))
5620 p--;
5621 }
5622 }
5623
5624 /* Update the cache. */
667208dd 5625 (*cachep)[i] = (STRLEN)uoff;
7e8c5dac
HS
5626 (*cachep)[i+1] = p - start;
5627
5628 found = TRUE;
5629 }
5630 }
5631 if (found) { /* Setup the return values. */
5632 *offsetp = (*cachep)[i+1];
5633 *sp = start + *offsetp;
5634 if (*sp >= send) {
5635 *sp = send;
5636 *offsetp = send - start;
5637 }
5638 else if (*sp < start) {
5639 *sp = start;
5640 *offsetp = 0;
5641 }
5642 }
5643 }
5644 }
5645 return found;
5646}
5647
5648/*
645c22ef
DM
5649=for apidoc sv_pos_u2b
5650
5651Converts the value pointed to by offsetp from a count of UTF8 chars from
5652the start of the string, to a count of the equivalent number of bytes; if
5653lenp is non-zero, it does the same to lenp, but this time starting from
5654the offset, rather than from the start of the string. Handles magic and
5655type coercion.
5656
5657=cut
5658*/
5659
7e8c5dac
HS
5660/*
5661 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5662 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5663 * byte offsets. See also the comments of S_utf8_mg_pos().
5664 *
5665 */
5666
a0ed51b3 5667void
864dbfa3 5668Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
a0ed51b3 5669{
dfe13c55
GS
5670 U8 *start;
5671 U8 *s;
a0ed51b3 5672 STRLEN len;
7e8c5dac
HS
5673 STRLEN *cache = 0;
5674 STRLEN boffset = 0;
a0ed51b3
LW
5675
5676 if (!sv)
5677 return;
5678
dfe13c55 5679 start = s = (U8*)SvPV(sv, len);
7e8c5dac
HS
5680 if (len) {
5681 I32 uoffset = *offsetp;
5682 U8 *send = s + len;
5683 MAGIC *mg = 0;
5684 bool found = FALSE;
5685
bdf77a2a 5686 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
7e8c5dac
HS
5687 found = TRUE;
5688 if (!found && uoffset > 0) {
5689 while (s < send && uoffset--)
5690 s += UTF8SKIP(s);
5691 if (s >= send)
5692 s = send;
bdf77a2a 5693 if (utf8_mg_pos_init(sv, &mg, &cache, 0, offsetp, s, start))
7e8c5dac
HS
5694 boffset = cache[1];
5695 *offsetp = s - start;
5696 }
5697 if (lenp) {
5698 found = FALSE;
5699 start = s;
bdf77a2a 5700 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp + *offsetp, &s, start, send)) {
7e8c5dac
HS
5701 *lenp -= boffset;
5702 found = TRUE;
5703 }
5704 if (!found && *lenp > 0) {
5705 I32 ulen = *lenp;
5706 if (ulen > 0)
5707 while (s < send && ulen--)
5708 s += UTF8SKIP(s);
5709 if (s >= send)
5710 s = send;
bdf77a2a 5711 if (utf8_mg_pos_init(sv, &mg, &cache, 2, lenp, s, start))
7e8c5dac
HS
5712 cache[2] += *offsetp;
5713 }
5714 *lenp = s - start;
5715 }
5716 }
5717 else {
5718 *offsetp = 0;
5719 if (lenp)
5720 *lenp = 0;
a0ed51b3
LW
5721 }
5722 return;
5723}
5724
645c22ef
DM
5725/*
5726=for apidoc sv_pos_b2u
5727
5728Converts the value pointed to by offsetp from a count of bytes from the
5729start of the string, to a count of the equivalent number of UTF8 chars.
5730Handles magic and type coercion.
5731
5732=cut
5733*/
5734
7e8c5dac
HS
5735/*
5736 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5737 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5738 * byte offsets. See also the comments of S_utf8_mg_pos().
5739 *
5740 */
5741
a0ed51b3 5742void
7e8c5dac 5743Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
a0ed51b3 5744{
7e8c5dac 5745 U8* s;
a0ed51b3
LW
5746 STRLEN len;
5747
5748 if (!sv)
5749 return;
5750
dfe13c55 5751 s = (U8*)SvPV(sv, len);
eb160463 5752 if ((I32)len < *offsetp)
a0dbb045 5753 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
7e8c5dac
HS
5754 else {
5755 U8* send = s + *offsetp;
5756 MAGIC* mg = NULL;
5757 STRLEN *cache = NULL;
5758
5759 len = 0;
5760
5761 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5762 mg = mg_find(sv, PERL_MAGIC_utf8);
5763 if (mg && mg->mg_ptr) {
5764 cache = (STRLEN *) mg->mg_ptr;
5765 if (cache[1] == *offsetp) {
5766 /* An exact match. */
5767 *offsetp = cache[0];
5768
5769 return;
5770 }
5771 else if (cache[1] < *offsetp) {
5772 /* We already know part of the way. */
5773 len = cache[0];
5774 s += cache[1];
5775 /* Let the below loop do the rest. */
5776 }
5777 else { /* cache[1] > *offsetp */
5778 /* We already know all of the way, now we may
5779 * be able to walk back. The same assumption
5780 * is made as in S_utf8_mg_pos(), namely that
5781 * walking backward is twice slower than
5782 * walking forward. */
5783 STRLEN forw = *offsetp;
5784 STRLEN backw = cache[1] - *offsetp;
5785
5786 if (!(forw < 2 * backw)) {
5787 U8 *p = s + cache[1];
5788 STRLEN ubackw = 0;
5789
a5b510f2
AE
5790 cache[1] -= backw;
5791
7e8c5dac
HS
5792 while (backw--) {
5793 p--;
5794 while (UTF8_IS_CONTINUATION(*p))
5795 p--;
5796 ubackw++;
5797 }
5798
5799 cache[0] -= ubackw;
7e8c5dac
HS
5800
5801 return;
5802 }
5803 }
5804 }
a0dbb045 5805 }
7e8c5dac
HS
5806
5807 while (s < send) {
5808 STRLEN n = 1;
5809
5810 /* Call utf8n_to_uvchr() to validate the sequence
5811 * (unless a simple non-UTF character) */
5812 if (!UTF8_IS_INVARIANT(*s))
5813 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5814 if (n > 0) {
5815 s += n;
5816 len++;
5817 }
5818 else
5819 break;
5820 }
5821
5822 if (!SvREADONLY(sv)) {
5823 if (!mg) {
5824 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5825 mg = mg_find(sv, PERL_MAGIC_utf8);
5826 }
5827 assert(mg);
5828
5829 if (!mg->mg_ptr) {
5830 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5831 mg->mg_ptr = (char *) cache;
5832 }
5833 assert(cache);
5834
5835 cache[0] = len;
5836 cache[1] = *offsetp;
5837 }
5838
5839 *offsetp = len;
a0ed51b3 5840 }
a0ed51b3
LW
5841 return;
5842}
5843
954c1994
GS
5844/*
5845=for apidoc sv_eq
5846
5847Returns a boolean indicating whether the strings in the two SVs are
645c22ef
DM
5848identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5849coerce its args to strings if necessary.
954c1994
GS
5850
5851=cut
5852*/
5853
79072805 5854I32
e01b9e88 5855Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
79072805
LW
5856{
5857 char *pv1;
463ee0b2 5858 STRLEN cur1;
79072805 5859 char *pv2;
463ee0b2 5860 STRLEN cur2;
e01b9e88 5861 I32 eq = 0;
553e1bcc
AT
5862 char *tpv = Nullch;
5863 SV* svrecode = Nullsv;
79072805 5864
e01b9e88 5865 if (!sv1) {
79072805
LW
5866 pv1 = "";
5867 cur1 = 0;
5868 }
463ee0b2 5869 else
e01b9e88 5870 pv1 = SvPV(sv1, cur1);
79072805 5871
e01b9e88
SC
5872 if (!sv2){
5873 pv2 = "";
5874 cur2 = 0;
92d29cee 5875 }
e01b9e88
SC
5876 else
5877 pv2 = SvPV(sv2, cur2);
79072805 5878
cf48d248 5879 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
799ef3cb
JH
5880 /* Differing utf8ness.
5881 * Do not UTF8size the comparands as a side-effect. */
5882 if (PL_encoding) {
5883 if (SvUTF8(sv1)) {
553e1bcc
AT
5884 svrecode = newSVpvn(pv2, cur2);
5885 sv_recode_to_utf8(svrecode, PL_encoding);
5886 pv2 = SvPV(svrecode, cur2);
799ef3cb
JH
5887 }
5888 else {
553e1bcc
AT
5889 svrecode = newSVpvn(pv1, cur1);
5890 sv_recode_to_utf8(svrecode, PL_encoding);
5891 pv1 = SvPV(svrecode, cur1);
799ef3cb
JH
5892 }
5893 /* Now both are in UTF-8. */
5894 if (cur1 != cur2)
5895 return FALSE;
5896 }
5897 else {
5898 bool is_utf8 = TRUE;
5899
5900 if (SvUTF8(sv1)) {
5901 /* sv1 is the UTF-8 one,
5902 * if is equal it must be downgrade-able */
5903 char *pv = (char*)bytes_from_utf8((U8*)pv1,
5904 &cur1, &is_utf8);
5905 if (pv != pv1)
553e1bcc 5906 pv1 = tpv = pv;
799ef3cb
JH
5907 }
5908 else {
5909 /* sv2 is the UTF-8 one,
5910 * if is equal it must be downgrade-able */
5911 char *pv = (char *)bytes_from_utf8((U8*)pv2,
5912 &cur2, &is_utf8);
5913 if (pv != pv2)
553e1bcc 5914 pv2 = tpv = pv;
799ef3cb
JH
5915 }
5916 if (is_utf8) {
5917 /* Downgrade not possible - cannot be eq */
5918 return FALSE;
5919 }
5920 }
cf48d248
JH
5921 }
5922
5923 if (cur1 == cur2)
765f542d 5924 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
e01b9e88 5925
553e1bcc
AT
5926 if (svrecode)
5927 SvREFCNT_dec(svrecode);
799ef3cb 5928
553e1bcc
AT
5929 if (tpv)
5930 Safefree(tpv);
cf48d248 5931
e01b9e88 5932 return eq;
79072805
LW
5933}
5934
954c1994
GS
5935/*
5936=for apidoc sv_cmp
5937
5938Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5939string in C<sv1> is less than, equal to, or greater than the string in
645c22ef
DM
5940C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5941coerce its args to strings if necessary. See also C<sv_cmp_locale>.
954c1994
GS
5942
5943=cut
5944*/
5945
79072805 5946I32
e01b9e88 5947Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
79072805 5948{
560a288e 5949 STRLEN cur1, cur2;
553e1bcc 5950 char *pv1, *pv2, *tpv = Nullch;
cf48d248 5951 I32 cmp;
553e1bcc 5952 SV *svrecode = Nullsv;
560a288e 5953
e01b9e88
SC
5954 if (!sv1) {
5955 pv1 = "";
560a288e
GS
5956 cur1 = 0;
5957 }
e01b9e88
SC
5958 else
5959 pv1 = SvPV(sv1, cur1);
560a288e 5960
553e1bcc 5961 if (!sv2) {
e01b9e88 5962 pv2 = "";
560a288e
GS
5963 cur2 = 0;
5964 }
e01b9e88
SC
5965 else
5966 pv2 = SvPV(sv2, cur2);
79072805 5967
cf48d248 5968 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
799ef3cb
JH
5969 /* Differing utf8ness.
5970 * Do not UTF8size the comparands as a side-effect. */
cf48d248 5971 if (SvUTF8(sv1)) {
799ef3cb 5972 if (PL_encoding) {
553e1bcc
AT
5973 svrecode = newSVpvn(pv2, cur2);
5974 sv_recode_to_utf8(svrecode, PL_encoding);
5975 pv2 = SvPV(svrecode, cur2);
799ef3cb
JH
5976 }
5977 else {
553e1bcc 5978 pv2 = tpv = (char*)bytes_to_utf8((U8*)pv2, &cur2);
799ef3cb 5979 }
cf48d248
JH
5980 }
5981 else {
799ef3cb 5982 if (PL_encoding) {
553e1bcc
AT
5983 svrecode = newSVpvn(pv1, cur1);
5984 sv_recode_to_utf8(svrecode, PL_encoding);
5985 pv1 = SvPV(svrecode, cur1);
799ef3cb
JH
5986 }
5987 else {
553e1bcc 5988 pv1 = tpv = (char*)bytes_to_utf8((U8*)pv1, &cur1);
799ef3cb 5989 }
cf48d248
JH
5990 }
5991 }
5992
e01b9e88 5993 if (!cur1) {
cf48d248 5994 cmp = cur2 ? -1 : 0;
e01b9e88 5995 } else if (!cur2) {
cf48d248
JH
5996 cmp = 1;
5997 } else {
5998 I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
e01b9e88
SC
5999
6000 if (retval) {
cf48d248 6001 cmp = retval < 0 ? -1 : 1;
e01b9e88 6002 } else if (cur1 == cur2) {
cf48d248
JH
6003 cmp = 0;
6004 } else {
6005 cmp = cur1 < cur2 ? -1 : 1;
e01b9e88 6006 }
cf48d248 6007 }
16660edb 6008
553e1bcc
AT
6009 if (svrecode)
6010 SvREFCNT_dec(svrecode);
799ef3cb 6011
553e1bcc
AT
6012 if (tpv)
6013 Safefree(tpv);
cf48d248
JH
6014
6015 return cmp;
bbce6d69 6016}
16660edb 6017
c461cf8f
JH
6018/*
6019=for apidoc sv_cmp_locale
6020
645c22ef
DM
6021Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6022'use bytes' aware, handles get magic, and will coerce its args to strings
6023if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
c461cf8f
JH
6024
6025=cut
6026*/
6027
bbce6d69 6028I32
864dbfa3 6029Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
bbce6d69 6030{
36477c24 6031#ifdef USE_LOCALE_COLLATE
16660edb 6032
bbce6d69 6033 char *pv1, *pv2;
6034 STRLEN len1, len2;
6035 I32 retval;
16660edb 6036
3280af22 6037 if (PL_collation_standard)
bbce6d69 6038 goto raw_compare;
16660edb 6039
bbce6d69 6040 len1 = 0;
8ac85365 6041 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
bbce6d69 6042 len2 = 0;
8ac85365 6043 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
16660edb 6044
bbce6d69 6045 if (!pv1 || !len1) {
6046 if (pv2 && len2)
6047 return -1;
6048 else
6049 goto raw_compare;
6050 }
6051 else {
6052 if (!pv2 || !len2)
6053 return 1;
6054 }
16660edb 6055
bbce6d69 6056 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
16660edb 6057
bbce6d69 6058 if (retval)
16660edb 6059 return retval < 0 ? -1 : 1;
6060
bbce6d69 6061 /*
6062 * When the result of collation is equality, that doesn't mean
6063 * that there are no differences -- some locales exclude some
6064 * characters from consideration. So to avoid false equalities,
6065 * we use the raw string as a tiebreaker.
6066 */
16660edb 6067
bbce6d69 6068 raw_compare:
6069 /* FALL THROUGH */
16660edb 6070
36477c24 6071#endif /* USE_LOCALE_COLLATE */
16660edb 6072
bbce6d69 6073 return sv_cmp(sv1, sv2);
6074}
79072805 6075
645c22ef 6076
36477c24 6077#ifdef USE_LOCALE_COLLATE
645c22ef 6078
7a4c00b4 6079/*
645c22ef
DM
6080=for apidoc sv_collxfrm
6081
6082Add Collate Transform magic to an SV if it doesn't already have it.
6083
6084Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6085scalar data of the variable, but transformed to such a format that a normal
6086memory comparison can be used to compare the data according to the locale
6087settings.
6088
6089=cut
6090*/
6091
bbce6d69 6092char *
864dbfa3 6093Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
bbce6d69 6094{
7a4c00b4 6095 MAGIC *mg;
16660edb 6096
14befaf4 6097 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
3280af22 6098 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
bbce6d69 6099 char *s, *xf;
6100 STRLEN len, xlen;
6101
7a4c00b4 6102 if (mg)
6103 Safefree(mg->mg_ptr);
bbce6d69 6104 s = SvPV(sv, len);
6105 if ((xf = mem_collxfrm(s, len, &xlen))) {
ff0cee69 6106 if (SvREADONLY(sv)) {
6107 SAVEFREEPV(xf);
6108 *nxp = xlen;
3280af22 6109 return xf + sizeof(PL_collation_ix);
ff0cee69 6110 }
7a4c00b4 6111 if (! mg) {
14befaf4
DM
6112 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6113 mg = mg_find(sv, PERL_MAGIC_collxfrm);
7a4c00b4 6114 assert(mg);
bbce6d69 6115 }
7a4c00b4 6116 mg->mg_ptr = xf;
565764a8 6117 mg->mg_len = xlen;
7a4c00b4 6118 }
6119 else {
ff0cee69 6120 if (mg) {
6121 mg->mg_ptr = NULL;
565764a8 6122 mg->mg_len = -1;
ff0cee69 6123 }
bbce6d69 6124 }
6125 }
7a4c00b4 6126 if (mg && mg->mg_ptr) {
565764a8 6127 *nxp = mg->mg_len;
3280af22 6128 return mg->mg_ptr + sizeof(PL_collation_ix);
bbce6d69 6129 }
6130 else {
6131 *nxp = 0;
6132 return NULL;
16660edb 6133 }
79072805
LW
6134}
6135
36477c24 6136#endif /* USE_LOCALE_COLLATE */
bbce6d69 6137
c461cf8f
JH
6138/*
6139=for apidoc sv_gets
6140
6141Get a line from the filehandle and store it into the SV, optionally
6142appending to the currently-stored string.
6143
6144=cut
6145*/
6146
79072805 6147char *
864dbfa3 6148Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
79072805 6149{
c07a80fd 6150 char *rsptr;
6151 STRLEN rslen;
6152 register STDCHAR rslast;
6153 register STDCHAR *bp;
6154 register I32 cnt;
9c5ffd7c 6155 I32 i = 0;
8bfdd7d9 6156 I32 rspara = 0;
e311fd51 6157 I32 recsize;
c07a80fd 6158
765f542d
NC
6159 SV_CHECK_THINKFIRST_COW_DROP(sv);
6160 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6161 from <>.
6162 However, perlbench says it's slower, because the existing swipe code
6163 is faster than copy on write.
6164 Swings and roundabouts. */
6fc92669 6165 (void)SvUPGRADE(sv, SVt_PV);
99491443 6166
ff68c719 6167 SvSCREAM_off(sv);
e311fd51 6168 SvPOK_only(sv); /* Validate pointer */
c07a80fd 6169
8bfdd7d9
HS
6170 if (PL_curcop == &PL_compiling) {
6171 /* we always read code in line mode */
6172 rsptr = "\n";
6173 rslen = 1;
6174 }
6175 else if (RsSNARF(PL_rs)) {
e468d35b
NIS
6176 /* If it is a regular disk file use size from stat() as estimate
6177 of amount we are going to read - may result in malloc-ing
6178 more memory than we realy need if layers bellow reduce
6179 size we read (e.g. CRLF or a gzip layer)
6180 */
e311fd51 6181 Stat_t st;
e468d35b
NIS
6182 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6183 Off_t offset = PerlIO_tell(fp);
6184 if (offset != (Off_t) -1) {
6185 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6186 }
6187 }
c07a80fd 6188 rsptr = NULL;
6189 rslen = 0;
6190 }
3280af22 6191 else if (RsRECORD(PL_rs)) {
e311fd51 6192 I32 bytesread;
5b2b9c68
HM
6193 char *buffer;
6194
6195 /* Grab the size of the record we're getting */
3280af22 6196 recsize = SvIV(SvRV(PL_rs));
e311fd51 6197 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5b2b9c68
HM
6198 /* Go yank in */
6199#ifdef VMS
6200 /* VMS wants read instead of fread, because fread doesn't respect */
6201 /* RMS record boundaries. This is not necessarily a good thing to be */
e468d35b
NIS
6202 /* doing, but we've got no other real choice - except avoid stdio
6203 as implementation - perhaps write a :vms layer ?
6204 */
5b2b9c68
HM
6205 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6206#else
6207 bytesread = PerlIO_read(fp, buffer, recsize);
6208#endif
e311fd51 6209 SvCUR_set(sv, bytesread += append);
e670df4e 6210 buffer[bytesread] = '\0';
e311fd51 6211 goto check_utf8_and_return;
5b2b9c68 6212 }
3280af22 6213 else if (RsPARA(PL_rs)) {
c07a80fd 6214 rsptr = "\n\n";
6215 rslen = 2;
8bfdd7d9 6216 rspara = 1;
c07a80fd 6217 }
7d59b7e4
NIS
6218 else {
6219 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6220 if (PerlIO_isutf8(fp)) {
6221 rsptr = SvPVutf8(PL_rs, rslen);
6222 }
6223 else {
6224 if (SvUTF8(PL_rs)) {
6225 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6226 Perl_croak(aTHX_ "Wide character in $/");
6227 }
6228 }
6229 rsptr = SvPV(PL_rs, rslen);
6230 }
6231 }
6232
c07a80fd 6233 rslast = rslen ? rsptr[rslen - 1] : '\0';
6234
8bfdd7d9 6235 if (rspara) { /* have to do this both before and after */
79072805 6236 do { /* to make sure file boundaries work right */
760ac839 6237 if (PerlIO_eof(fp))
a0d0e21e 6238 return 0;
760ac839 6239 i = PerlIO_getc(fp);
79072805 6240 if (i != '\n') {
a0d0e21e
LW
6241 if (i == -1)
6242 return 0;
760ac839 6243 PerlIO_ungetc(fp,i);
79072805
LW
6244 break;
6245 }
6246 } while (i != EOF);
6247 }
c07a80fd 6248
760ac839
LW
6249 /* See if we know enough about I/O mechanism to cheat it ! */
6250
6251 /* This used to be #ifdef test - it is made run-time test for ease
1c846c1f 6252 of abstracting out stdio interface. One call should be cheap
760ac839
LW
6253 enough here - and may even be a macro allowing compile
6254 time optimization.
6255 */
6256
6257 if (PerlIO_fast_gets(fp)) {
6258
6259 /*
6260 * We're going to steal some values from the stdio struct
6261 * and put EVERYTHING in the innermost loop into registers.
6262 */
6263 register STDCHAR *ptr;
6264 STRLEN bpx;
6265 I32 shortbuffered;
6266
16660edb 6267#if defined(VMS) && defined(PERLIO_IS_STDIO)
6268 /* An ungetc()d char is handled separately from the regular
6269 * buffer, so we getc() it back out and stuff it in the buffer.
6270 */
6271 i = PerlIO_getc(fp);
6272 if (i == EOF) return 0;
6273 *(--((*fp)->_ptr)) = (unsigned char) i;
6274 (*fp)->_cnt++;
6275#endif
c07a80fd 6276
c2960299 6277 /* Here is some breathtakingly efficient cheating */
c07a80fd 6278
a20bf0c3 6279 cnt = PerlIO_get_cnt(fp); /* get count into register */
e468d35b
NIS
6280 /* make sure we have the room */
6281 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6282 /* Not room for all of it
6283 if we are looking for a separator and room for some
6284 */
6285 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6286 /* just process what we have room for */
79072805
LW
6287 shortbuffered = cnt - SvLEN(sv) + append + 1;
6288 cnt -= shortbuffered;
6289 }
6290 else {
6291 shortbuffered = 0;
bbce6d69 6292 /* remember that cnt can be negative */
eb160463 6293 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
79072805
LW
6294 }
6295 }
e468d35b 6296 else
79072805 6297 shortbuffered = 0;
c07a80fd 6298 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
a20bf0c3 6299 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
16660edb 6300 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 6301 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
16660edb 6302 DEBUG_P(PerlIO_printf(Perl_debug_log,
ba7abf9d 6303 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
1c846c1f 6304 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
1d7c1841 6305 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
79072805
LW
6306 for (;;) {
6307 screamer:
93a17b20 6308 if (cnt > 0) {
c07a80fd 6309 if (rslen) {
760ac839
LW
6310 while (cnt > 0) { /* this | eat */
6311 cnt--;
c07a80fd 6312 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6313 goto thats_all_folks; /* screams | sed :-) */
6314 }
6315 }
6316 else {
1c846c1f
NIS
6317 Copy(ptr, bp, cnt, char); /* this | eat */
6318 bp += cnt; /* screams | dust */
c07a80fd 6319 ptr += cnt; /* louder | sed :-) */
a5f75d66 6320 cnt = 0;
93a17b20 6321 }
79072805
LW
6322 }
6323
748a9306 6324 if (shortbuffered) { /* oh well, must extend */
79072805
LW
6325 cnt = shortbuffered;
6326 shortbuffered = 0;
c07a80fd 6327 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
79072805
LW
6328 SvCUR_set(sv, bpx);
6329 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
c07a80fd 6330 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
79072805
LW
6331 continue;
6332 }
6333
16660edb 6334 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841
GS
6335 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6336 PTR2UV(ptr),(long)cnt));
cc00df79 6337 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
ba7abf9d 6338#if 0
16660edb 6339 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 6340 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
1c846c1f 6341 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
1d7c1841 6342 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
ba7abf9d 6343#endif
1c846c1f 6344 /* This used to call 'filbuf' in stdio form, but as that behaves like
774d564b 6345 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6346 another abstraction. */
760ac839 6347 i = PerlIO_getc(fp); /* get more characters */
ba7abf9d 6348#if 0
16660edb 6349 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 6350 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
1c846c1f 6351 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
1d7c1841 6352 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
ba7abf9d 6353#endif
a20bf0c3
JH
6354 cnt = PerlIO_get_cnt(fp);
6355 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
16660edb 6356 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 6357 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
79072805 6358
748a9306
LW
6359 if (i == EOF) /* all done for ever? */
6360 goto thats_really_all_folks;
6361
c07a80fd 6362 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
79072805
LW
6363 SvCUR_set(sv, bpx);
6364 SvGROW(sv, bpx + cnt + 2);
c07a80fd 6365 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
6366
eb160463 6367 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
79072805 6368
c07a80fd 6369 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
79072805 6370 goto thats_all_folks;
79072805
LW
6371 }
6372
6373thats_all_folks:
eb160463 6374 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
36477c24 6375 memNE((char*)bp - rslen, rsptr, rslen))
760ac839 6376 goto screamer; /* go back to the fray */
79072805
LW
6377thats_really_all_folks:
6378 if (shortbuffered)
6379 cnt += shortbuffered;
16660edb 6380 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 6381 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
cc00df79 6382 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
16660edb 6383 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 6384 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
1c846c1f 6385 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
1d7c1841 6386 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
79072805 6387 *bp = '\0';
760ac839 6388 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
16660edb 6389 DEBUG_P(PerlIO_printf(Perl_debug_log,
fb73857a 6390 "Screamer: done, len=%ld, string=|%.*s|\n",
6391 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
760ac839
LW
6392 }
6393 else
79072805 6394 {
4d2c4e07 6395#ifndef EPOC
760ac839 6396 /*The big, slow, and stupid way */
c07a80fd 6397 STDCHAR buf[8192];
4d2c4e07
OF
6398#else
6399 /* Need to work around EPOC SDK features */
6400 /* On WINS: MS VC5 generates calls to _chkstk, */
6401 /* if a `large' stack frame is allocated */
6402 /* gcc on MARM does not generate calls like these */
6403 STDCHAR buf[1024];
6404#endif
79072805 6405
760ac839 6406screamer2:
c07a80fd 6407 if (rslen) {
760ac839
LW
6408 register STDCHAR *bpe = buf + sizeof(buf);
6409 bp = buf;
eb160463 6410 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
760ac839
LW
6411 ; /* keep reading */
6412 cnt = bp - buf;
c07a80fd 6413 }
6414 else {
760ac839 6415 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
16660edb 6416 /* Accomodate broken VAXC compiler, which applies U8 cast to
6417 * both args of ?: operator, causing EOF to change into 255
6418 */
37be0adf 6419 if (cnt > 0)
cbe9e203
JH
6420 i = (U8)buf[cnt - 1];
6421 else
37be0adf 6422 i = EOF;
c07a80fd 6423 }
79072805 6424
cbe9e203
JH
6425 if (cnt < 0)
6426 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6427 if (append)
6428 sv_catpvn(sv, (char *) buf, cnt);
6429 else
6430 sv_setpvn(sv, (char *) buf, cnt);
c07a80fd 6431
6432 if (i != EOF && /* joy */
6433 (!rslen ||
6434 SvCUR(sv) < rslen ||
36477c24 6435 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
79072805
LW
6436 {
6437 append = -1;
63e4d877
CS
6438 /*
6439 * If we're reading from a TTY and we get a short read,
6440 * indicating that the user hit his EOF character, we need
6441 * to notice it now, because if we try to read from the TTY
6442 * again, the EOF condition will disappear.
6443 *
6444 * The comparison of cnt to sizeof(buf) is an optimization
6445 * that prevents unnecessary calls to feof().
6446 *
6447 * - jik 9/25/96
6448 */
6449 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6450 goto screamer2;
79072805
LW
6451 }
6452 }
6453
8bfdd7d9 6454 if (rspara) { /* have to do this both before and after */
c07a80fd 6455 while (i != EOF) { /* to make sure file boundaries work right */
760ac839 6456 i = PerlIO_getc(fp);
79072805 6457 if (i != '\n') {
760ac839 6458 PerlIO_ungetc(fp,i);
79072805
LW
6459 break;
6460 }
6461 }
6462 }
c07a80fd 6463
e311fd51 6464check_utf8_and_return:
7d59b7e4
NIS
6465 if (PerlIO_isutf8(fp))
6466 SvUTF8_on(sv);
6467 else
6468 SvUTF8_off(sv);
6469
c07a80fd 6470 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
79072805
LW
6471}
6472
954c1994
GS
6473/*
6474=for apidoc sv_inc
6475
645c22ef
DM
6476Auto-increment of the value in the SV, doing string to numeric conversion
6477if necessary. Handles 'get' magic.
954c1994
GS
6478
6479=cut
6480*/
6481
79072805 6482void
864dbfa3 6483Perl_sv_inc(pTHX_ register SV *sv)
79072805
LW
6484{
6485 register char *d;
463ee0b2 6486 int flags;
79072805
LW
6487
6488 if (!sv)
6489 return;
b23a5f78
GB
6490 if (SvGMAGICAL(sv))
6491 mg_get(sv);
ed6116ce 6492 if (SvTHINKFIRST(sv)) {
765f542d
NC
6493 if (SvIsCOW(sv))
6494 sv_force_normal_flags(sv, 0);
0f15f207 6495 if (SvREADONLY(sv)) {
3280af22 6496 if (PL_curcop != &PL_compiling)
cea2e8a9 6497 Perl_croak(aTHX_ PL_no_modify);
0f15f207 6498 }
a0d0e21e 6499 if (SvROK(sv)) {
b5be31e9 6500 IV i;
9e7bc3e8
JD
6501 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6502 return;
56431972 6503 i = PTR2IV(SvRV(sv));
b5be31e9
SM
6504 sv_unref(sv);
6505 sv_setiv(sv, i);
a0d0e21e 6506 }
ed6116ce 6507 }
8990e307 6508 flags = SvFLAGS(sv);
28e5dec8
JH
6509 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6510 /* It's (privately or publicly) a float, but not tested as an
6511 integer, so test it to see. */
d460ef45 6512 (void) SvIV(sv);
28e5dec8
JH
6513 flags = SvFLAGS(sv);
6514 }
6515 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6516 /* It's publicly an integer, or privately an integer-not-float */
59d8ce62 6517#ifdef PERL_PRESERVE_IVUV
28e5dec8 6518 oops_its_int:
59d8ce62 6519#endif
25da4f38
IZ
6520 if (SvIsUV(sv)) {
6521 if (SvUVX(sv) == UV_MAX)
a1e868e7 6522 sv_setnv(sv, UV_MAX_P1);
25da4f38
IZ
6523 else
6524 (void)SvIOK_only_UV(sv);
6525 ++SvUVX(sv);
6526 } else {
6527 if (SvIVX(sv) == IV_MAX)
28e5dec8 6528 sv_setuv(sv, (UV)IV_MAX + 1);
25da4f38
IZ
6529 else {
6530 (void)SvIOK_only(sv);
6531 ++SvIVX(sv);
1c846c1f 6532 }
55497cff 6533 }
79072805
LW
6534 return;
6535 }
28e5dec8
JH
6536 if (flags & SVp_NOK) {
6537 (void)SvNOK_only(sv);
6538 SvNVX(sv) += 1.0;
6539 return;
6540 }
6541
8990e307 6542 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
28e5dec8
JH
6543 if ((flags & SVTYPEMASK) < SVt_PVIV)
6544 sv_upgrade(sv, SVt_IV);
6545 (void)SvIOK_only(sv);
6546 SvIVX(sv) = 1;
79072805
LW
6547 return;
6548 }
463ee0b2 6549 d = SvPVX(sv);
79072805
LW
6550 while (isALPHA(*d)) d++;
6551 while (isDIGIT(*d)) d++;
6552 if (*d) {
28e5dec8 6553#ifdef PERL_PRESERVE_IVUV
d1be9408 6554 /* Got to punt this as an integer if needs be, but we don't issue
28e5dec8
JH
6555 warnings. Probably ought to make the sv_iv_please() that does
6556 the conversion if possible, and silently. */
c2988b20 6557 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
28e5dec8
JH
6558 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6559 /* Need to try really hard to see if it's an integer.
6560 9.22337203685478e+18 is an integer.
6561 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6562 so $a="9.22337203685478e+18"; $a+0; $a++
6563 needs to be the same as $a="9.22337203685478e+18"; $a++
6564 or we go insane. */
d460ef45 6565
28e5dec8
JH
6566 (void) sv_2iv(sv);
6567 if (SvIOK(sv))
6568 goto oops_its_int;
6569
6570 /* sv_2iv *should* have made this an NV */
6571 if (flags & SVp_NOK) {
6572 (void)SvNOK_only(sv);
6573 SvNVX(sv) += 1.0;
6574 return;
6575 }
6576 /* I don't think we can get here. Maybe I should assert this
6577 And if we do get here I suspect that sv_setnv will croak. NWC
6578 Fall through. */
6579#if defined(USE_LONG_DOUBLE)
6580 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",
6581 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6582#else
1779d84d 6583 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_inc punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
28e5dec8
JH
6584 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6585#endif
6586 }
6587#endif /* PERL_PRESERVE_IVUV */
6588 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
79072805
LW
6589 return;
6590 }
6591 d--;
463ee0b2 6592 while (d >= SvPVX(sv)) {
79072805
LW
6593 if (isDIGIT(*d)) {
6594 if (++*d <= '9')
6595 return;
6596 *(d--) = '0';
6597 }
6598 else {
9d116dd7
JH
6599#ifdef EBCDIC
6600 /* MKS: The original code here died if letters weren't consecutive.
6601 * at least it didn't have to worry about non-C locales. The
6602 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
1c846c1f 6603 * arranged in order (although not consecutively) and that only
9d116dd7
JH
6604 * [A-Za-z] are accepted by isALPHA in the C locale.
6605 */
6606 if (*d != 'z' && *d != 'Z') {
6607 do { ++*d; } while (!isALPHA(*d));
6608 return;
6609 }
6610 *(d--) -= 'z' - 'a';
6611#else
79072805
LW
6612 ++*d;
6613 if (isALPHA(*d))
6614 return;
6615 *(d--) -= 'z' - 'a' + 1;
9d116dd7 6616#endif
79072805
LW
6617 }
6618 }
6619 /* oh,oh, the number grew */
6620 SvGROW(sv, SvCUR(sv) + 2);
6621 SvCUR(sv)++;
463ee0b2 6622 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
79072805
LW
6623 *d = d[-1];
6624 if (isDIGIT(d[1]))
6625 *d = '1';
6626 else
6627 *d = d[1];
6628}
6629
954c1994
GS
6630/*
6631=for apidoc sv_dec
6632
645c22ef
DM
6633Auto-decrement of the value in the SV, doing string to numeric conversion
6634if necessary. Handles 'get' magic.
954c1994
GS
6635
6636=cut
6637*/
6638
79072805 6639void
864dbfa3 6640Perl_sv_dec(pTHX_ register SV *sv)
79072805 6641{
463ee0b2
LW
6642 int flags;
6643
79072805
LW
6644 if (!sv)
6645 return;
b23a5f78
GB
6646 if (SvGMAGICAL(sv))
6647 mg_get(sv);
ed6116ce 6648 if (SvTHINKFIRST(sv)) {
765f542d
NC
6649 if (SvIsCOW(sv))
6650 sv_force_normal_flags(sv, 0);
0f15f207 6651 if (SvREADONLY(sv)) {
3280af22 6652 if (PL_curcop != &PL_compiling)
cea2e8a9 6653 Perl_croak(aTHX_ PL_no_modify);
0f15f207 6654 }
a0d0e21e 6655 if (SvROK(sv)) {
b5be31e9 6656 IV i;
9e7bc3e8
JD
6657 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6658 return;
56431972 6659 i = PTR2IV(SvRV(sv));
b5be31e9
SM
6660 sv_unref(sv);
6661 sv_setiv(sv, i);
a0d0e21e 6662 }
ed6116ce 6663 }
28e5dec8
JH
6664 /* Unlike sv_inc we don't have to worry about string-never-numbers
6665 and keeping them magic. But we mustn't warn on punting */
8990e307 6666 flags = SvFLAGS(sv);
28e5dec8
JH
6667 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6668 /* It's publicly an integer, or privately an integer-not-float */
59d8ce62 6669#ifdef PERL_PRESERVE_IVUV
28e5dec8 6670 oops_its_int:
59d8ce62 6671#endif
25da4f38
IZ
6672 if (SvIsUV(sv)) {
6673 if (SvUVX(sv) == 0) {
6674 (void)SvIOK_only(sv);
6675 SvIVX(sv) = -1;
6676 }
6677 else {
6678 (void)SvIOK_only_UV(sv);
6679 --SvUVX(sv);
1c846c1f 6680 }
25da4f38
IZ
6681 } else {
6682 if (SvIVX(sv) == IV_MIN)
65202027 6683 sv_setnv(sv, (NV)IV_MIN - 1.0);
25da4f38
IZ
6684 else {
6685 (void)SvIOK_only(sv);
6686 --SvIVX(sv);
1c846c1f 6687 }
55497cff 6688 }
6689 return;
6690 }
28e5dec8
JH
6691 if (flags & SVp_NOK) {
6692 SvNVX(sv) -= 1.0;
6693 (void)SvNOK_only(sv);
6694 return;
6695 }
8990e307 6696 if (!(flags & SVp_POK)) {
4633a7c4
LW
6697 if ((flags & SVTYPEMASK) < SVt_PVNV)
6698 sv_upgrade(sv, SVt_NV);
463ee0b2 6699 SvNVX(sv) = -1.0;
a0d0e21e 6700 (void)SvNOK_only(sv);
79072805
LW
6701 return;
6702 }
28e5dec8
JH
6703#ifdef PERL_PRESERVE_IVUV
6704 {
c2988b20 6705 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
28e5dec8
JH
6706 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6707 /* Need to try really hard to see if it's an integer.
6708 9.22337203685478e+18 is an integer.
6709 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6710 so $a="9.22337203685478e+18"; $a+0; $a--
6711 needs to be the same as $a="9.22337203685478e+18"; $a--
6712 or we go insane. */
d460ef45 6713
28e5dec8
JH
6714 (void) sv_2iv(sv);
6715 if (SvIOK(sv))
6716 goto oops_its_int;
6717
6718 /* sv_2iv *should* have made this an NV */
6719 if (flags & SVp_NOK) {
6720 (void)SvNOK_only(sv);
6721 SvNVX(sv) -= 1.0;
6722 return;
6723 }
6724 /* I don't think we can get here. Maybe I should assert this
6725 And if we do get here I suspect that sv_setnv will croak. NWC
6726 Fall through. */
6727#if defined(USE_LONG_DOUBLE)
6728 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",
6729 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6730#else
1779d84d 6731 DEBUG_c(PerlIO_printf(Perl_debug_log,"sv_dec punt failed to convert '%s' to IOK or NOKp, UV=0x%"UVxf" NV=%"NVgf"\n",
28e5dec8
JH
6732 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6733#endif
6734 }
6735 }
6736#endif /* PERL_PRESERVE_IVUV */
097ee67d 6737 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
79072805
LW
6738}
6739
954c1994
GS
6740/*
6741=for apidoc sv_mortalcopy
6742
645c22ef 6743Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
d4236ebc
DM
6744The new SV is marked as mortal. It will be destroyed "soon", either by an
6745explicit call to FREETMPS, or by an implicit call at places such as
6746statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
954c1994
GS
6747
6748=cut
6749*/
6750
79072805
LW
6751/* Make a string that will exist for the duration of the expression
6752 * evaluation. Actually, it may have to last longer than that, but
6753 * hopefully we won't free it until it has been assigned to a
6754 * permanent location. */
6755
6756SV *
864dbfa3 6757Perl_sv_mortalcopy(pTHX_ SV *oldstr)
79072805 6758{
463ee0b2 6759 register SV *sv;
b881518d 6760
4561caa4 6761 new_SV(sv);
79072805 6762 sv_setsv(sv,oldstr);
677b06e3
GS
6763 EXTEND_MORTAL(1);
6764 PL_tmps_stack[++PL_tmps_ix] = sv;
8990e307
LW
6765 SvTEMP_on(sv);
6766 return sv;
6767}
6768
954c1994
GS
6769/*
6770=for apidoc sv_newmortal
6771
645c22ef 6772Creates a new null SV which is mortal. The reference count of the SV is
d4236ebc
DM
6773set to 1. It will be destroyed "soon", either by an explicit call to
6774FREETMPS, or by an implicit call at places such as statement boundaries.
6775See also C<sv_mortalcopy> and C<sv_2mortal>.
954c1994
GS
6776
6777=cut
6778*/
6779
8990e307 6780SV *
864dbfa3 6781Perl_sv_newmortal(pTHX)
8990e307
LW
6782{
6783 register SV *sv;
6784
4561caa4 6785 new_SV(sv);
8990e307 6786 SvFLAGS(sv) = SVs_TEMP;
677b06e3
GS
6787 EXTEND_MORTAL(1);
6788 PL_tmps_stack[++PL_tmps_ix] = sv;
79072805
LW
6789 return sv;
6790}
6791
954c1994
GS
6792/*
6793=for apidoc sv_2mortal
6794
d4236ebc
DM
6795Marks an existing SV as mortal. The SV will be destroyed "soon", either
6796by an explicit call to FREETMPS, or by an implicit call at places such as
6797statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
954c1994
GS
6798
6799=cut
6800*/
6801
79072805 6802SV *
864dbfa3 6803Perl_sv_2mortal(pTHX_ register SV *sv)
79072805
LW
6804{
6805 if (!sv)
6806 return sv;
d689ffdd 6807 if (SvREADONLY(sv) && SvIMMORTAL(sv))
11162842 6808 return sv;
677b06e3
GS
6809 EXTEND_MORTAL(1);
6810 PL_tmps_stack[++PL_tmps_ix] = sv;
8990e307 6811 SvTEMP_on(sv);
79072805
LW
6812 return sv;
6813}
6814
954c1994
GS
6815/*
6816=for apidoc newSVpv
6817
6818Creates a new SV and copies a string into it. The reference count for the
6819SV is set to 1. If C<len> is zero, Perl will compute the length using
6820strlen(). For efficiency, consider using C<newSVpvn> instead.
6821
6822=cut
6823*/
6824
79072805 6825SV *
864dbfa3 6826Perl_newSVpv(pTHX_ const char *s, STRLEN len)
79072805 6827{
463ee0b2 6828 register SV *sv;
79072805 6829
4561caa4 6830 new_SV(sv);
79072805
LW
6831 if (!len)
6832 len = strlen(s);
6833 sv_setpvn(sv,s,len);
6834 return sv;
6835}
6836
954c1994
GS
6837/*
6838=for apidoc newSVpvn
6839
6840Creates a new SV and copies a string into it. The reference count for the
1c846c1f 6841SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
954c1994
GS
6842string. You are responsible for ensuring that the source string is at least
6843C<len> bytes long.
6844
6845=cut
6846*/
6847
9da1e3b5 6848SV *
864dbfa3 6849Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
9da1e3b5
MUN
6850{
6851 register SV *sv;
6852
6853 new_SV(sv);
9da1e3b5
MUN
6854 sv_setpvn(sv,s,len);
6855 return sv;
6856}
6857
1c846c1f
NIS
6858/*
6859=for apidoc newSVpvn_share
6860
645c22ef
DM
6861Creates a new SV with its SvPVX pointing to a shared string in the string
6862table. If the string does not already exist in the table, it is created
6863first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6864slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6865otherwise the hash is computed. The idea here is that as the string table
6866is used for shared hash keys these strings will have SvPVX == HeKEY and
6867hash lookup will avoid string compare.
1c846c1f
NIS
6868
6869=cut
6870*/
6871
6872SV *
c3654f1a 6873Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
1c846c1f
NIS
6874{
6875 register SV *sv;
c3654f1a
IH
6876 bool is_utf8 = FALSE;
6877 if (len < 0) {
77caf834 6878 STRLEN tmplen = -len;
c3654f1a 6879 is_utf8 = TRUE;
75a54232
JH
6880 /* See the note in hv.c:hv_fetch() --jhi */
6881 src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
6882 len = tmplen;
6883 }
1c846c1f 6884 if (!hash)
5afd6d42 6885 PERL_HASH(hash, src, len);
1c846c1f
NIS
6886 new_SV(sv);
6887 sv_upgrade(sv, SVt_PVIV);
c3654f1a 6888 SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
1c846c1f
NIS
6889 SvCUR(sv) = len;
6890 SvUVX(sv) = hash;
6891 SvLEN(sv) = 0;
6892 SvREADONLY_on(sv);
6893 SvFAKE_on(sv);
6894 SvPOK_on(sv);
c3654f1a
IH
6895 if (is_utf8)
6896 SvUTF8_on(sv);
1c846c1f
NIS
6897 return sv;
6898}
6899
645c22ef 6900
cea2e8a9 6901#if defined(PERL_IMPLICIT_CONTEXT)
645c22ef
DM
6902
6903/* pTHX_ magic can't cope with varargs, so this is a no-context
6904 * version of the main function, (which may itself be aliased to us).
6905 * Don't access this version directly.
6906 */
6907
46fc3d4c 6908SV *
cea2e8a9 6909Perl_newSVpvf_nocontext(const char* pat, ...)
46fc3d4c 6910{
cea2e8a9 6911 dTHX;
46fc3d4c 6912 register SV *sv;
6913 va_list args;
46fc3d4c 6914 va_start(args, pat);
c5be433b 6915 sv = vnewSVpvf(pat, &args);
46fc3d4c 6916 va_end(args);
6917 return sv;
6918}
cea2e8a9 6919#endif
46fc3d4c 6920
954c1994
GS
6921/*
6922=for apidoc newSVpvf
6923
645c22ef 6924Creates a new SV and initializes it with the string formatted like
954c1994
GS
6925C<sprintf>.
6926
6927=cut
6928*/
6929
cea2e8a9
GS
6930SV *
6931Perl_newSVpvf(pTHX_ const char* pat, ...)
6932{
6933 register SV *sv;
6934 va_list args;
cea2e8a9 6935 va_start(args, pat);
c5be433b 6936 sv = vnewSVpvf(pat, &args);
cea2e8a9
GS
6937 va_end(args);
6938 return sv;
6939}
46fc3d4c 6940
645c22ef
DM
6941/* backend for newSVpvf() and newSVpvf_nocontext() */
6942
79072805 6943SV *
c5be433b
GS
6944Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6945{
6946 register SV *sv;
6947 new_SV(sv);
6948 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6949 return sv;
6950}
6951
954c1994
GS
6952/*
6953=for apidoc newSVnv
6954
6955Creates a new SV and copies a floating point value into it.
6956The reference count for the SV is set to 1.
6957
6958=cut
6959*/
6960
c5be433b 6961SV *
65202027 6962Perl_newSVnv(pTHX_ NV n)
79072805 6963{
463ee0b2 6964 register SV *sv;
79072805 6965
4561caa4 6966 new_SV(sv);
79072805
LW
6967 sv_setnv(sv,n);
6968 return sv;
6969}
6970
954c1994
GS
6971/*
6972=for apidoc newSViv
6973
6974Creates a new SV and copies an integer into it. The reference count for the
6975SV is set to 1.
6976
6977=cut
6978*/
6979
79072805 6980SV *
864dbfa3 6981Perl_newSViv(pTHX_ IV i)
79072805 6982{
463ee0b2 6983 register SV *sv;
79072805 6984
4561caa4 6985 new_SV(sv);
79072805
LW
6986 sv_setiv(sv,i);
6987 return sv;
6988}
6989
954c1994 6990/*
1a3327fb
JH
6991=for apidoc newSVuv
6992
6993Creates a new SV and copies an unsigned integer into it.
6994The reference count for the SV is set to 1.
6995
6996=cut
6997*/
6998
6999SV *
7000Perl_newSVuv(pTHX_ UV u)
7001{
7002 register SV *sv;
7003
7004 new_SV(sv);
7005 sv_setuv(sv,u);
7006 return sv;
7007}
7008
7009/*
954c1994
GS
7010=for apidoc newRV_noinc
7011
7012Creates an RV wrapper for an SV. The reference count for the original
7013SV is B<not> incremented.
7014
7015=cut
7016*/
7017
2304df62 7018SV *
864dbfa3 7019Perl_newRV_noinc(pTHX_ SV *tmpRef)
2304df62
AD
7020{
7021 register SV *sv;
7022
4561caa4 7023 new_SV(sv);
2304df62 7024 sv_upgrade(sv, SVt_RV);
76e3520e 7025 SvTEMP_off(tmpRef);
d689ffdd 7026 SvRV(sv) = tmpRef;
2304df62 7027 SvROK_on(sv);
2304df62
AD
7028 return sv;
7029}
7030
ff276b08 7031/* newRV_inc is the official function name to use now.
645c22ef
DM
7032 * newRV_inc is in fact #defined to newRV in sv.h
7033 */
7034
5f05dabc 7035SV *
864dbfa3 7036Perl_newRV(pTHX_ SV *tmpRef)
5f05dabc 7037{
5f6447b6 7038 return newRV_noinc(SvREFCNT_inc(tmpRef));
5f05dabc 7039}
5f05dabc 7040
954c1994
GS
7041/*
7042=for apidoc newSVsv
7043
7044Creates a new SV which is an exact duplicate of the original SV.
645c22ef 7045(Uses C<sv_setsv>).
954c1994
GS
7046
7047=cut
7048*/
7049
79072805 7050SV *
864dbfa3 7051Perl_newSVsv(pTHX_ register SV *old)
79072805 7052{
463ee0b2 7053 register SV *sv;
79072805
LW
7054
7055 if (!old)
7056 return Nullsv;
8990e307 7057 if (SvTYPE(old) == SVTYPEMASK) {
0453d815 7058 if (ckWARN_d(WARN_INTERNAL))
9014280d 7059 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
79072805
LW
7060 return Nullsv;
7061 }
4561caa4 7062 new_SV(sv);
ff68c719 7063 if (SvTEMP(old)) {
7064 SvTEMP_off(old);
463ee0b2 7065 sv_setsv(sv,old);
ff68c719 7066 SvTEMP_on(old);
79072805
LW
7067 }
7068 else
463ee0b2
LW
7069 sv_setsv(sv,old);
7070 return sv;
79072805
LW
7071}
7072
645c22ef
DM
7073/*
7074=for apidoc sv_reset
7075
7076Underlying implementation for the C<reset> Perl function.
7077Note that the perl-level function is vaguely deprecated.
7078
7079=cut
7080*/
7081
79072805 7082void
864dbfa3 7083Perl_sv_reset(pTHX_ register char *s, HV *stash)
79072805
LW
7084{
7085 register HE *entry;
7086 register GV *gv;
7087 register SV *sv;
7088 register I32 i;
7089 register PMOP *pm;
7090 register I32 max;
4802d5d7 7091 char todo[PERL_UCHAR_MAX+1];
79072805 7092
49d8d3a1
MB
7093 if (!stash)
7094 return;
7095
79072805
LW
7096 if (!*s) { /* reset ?? searches */
7097 for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
48c036b1 7098 pm->op_pmdynflags &= ~PMdf_USED;
79072805
LW
7099 }
7100 return;
7101 }
7102
7103 /* reset variables */
7104
7105 if (!HvARRAY(stash))
7106 return;
463ee0b2
LW
7107
7108 Zero(todo, 256, char);
79072805 7109 while (*s) {
4802d5d7 7110 i = (unsigned char)*s;
79072805
LW
7111 if (s[1] == '-') {
7112 s += 2;
7113 }
4802d5d7 7114 max = (unsigned char)*s++;
79072805 7115 for ( ; i <= max; i++) {
463ee0b2
LW
7116 todo[i] = 1;
7117 }
a0d0e21e 7118 for (i = 0; i <= (I32) HvMAX(stash); i++) {
79072805 7119 for (entry = HvARRAY(stash)[i];
9e35f4b3
GS
7120 entry;
7121 entry = HeNEXT(entry))
7122 {
1edc1566 7123 if (!todo[(U8)*HeKEY(entry)])
463ee0b2 7124 continue;
1edc1566 7125 gv = (GV*)HeVAL(entry);
79072805 7126 sv = GvSV(gv);
9e35f4b3
GS
7127 if (SvTHINKFIRST(sv)) {
7128 if (!SvREADONLY(sv) && SvROK(sv))
7129 sv_unref(sv);
7130 continue;
7131 }
a0d0e21e 7132 (void)SvOK_off(sv);
79072805
LW
7133 if (SvTYPE(sv) >= SVt_PV) {
7134 SvCUR_set(sv, 0);
463ee0b2
LW
7135 if (SvPVX(sv) != Nullch)
7136 *SvPVX(sv) = '\0';
44a8e56a 7137 SvTAINT(sv);
79072805
LW
7138 }
7139 if (GvAV(gv)) {
7140 av_clear(GvAV(gv));
7141 }
44a8e56a 7142 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
463ee0b2 7143 hv_clear(GvHV(gv));
fa6a1c44 7144#ifdef USE_ENVIRON_ARRAY
4efc5df6
GS
7145 if (gv == PL_envgv
7146# ifdef USE_ITHREADS
7147 && PL_curinterp == aTHX
7148# endif
7149 )
7150 {
79072805 7151 environ[0] = Nullch;
4efc5df6 7152 }
a0d0e21e 7153#endif
79072805
LW
7154 }
7155 }
7156 }
7157 }
7158}
7159
645c22ef
DM
7160/*
7161=for apidoc sv_2io
7162
7163Using various gambits, try to get an IO from an SV: the IO slot if its a
7164GV; or the recursive result if we're an RV; or the IO slot of the symbol
7165named after the PV if we're a string.
7166
7167=cut
7168*/
7169
46fc3d4c 7170IO*
864dbfa3 7171Perl_sv_2io(pTHX_ SV *sv)
46fc3d4c 7172{
7173 IO* io;
7174 GV* gv;
2d8e6c8d 7175 STRLEN n_a;
46fc3d4c 7176
7177 switch (SvTYPE(sv)) {
7178 case SVt_PVIO:
7179 io = (IO*)sv;
7180 break;
7181 case SVt_PVGV:
7182 gv = (GV*)sv;
7183 io = GvIO(gv);
7184 if (!io)
cea2e8a9 7185 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
46fc3d4c 7186 break;
7187 default:
7188 if (!SvOK(sv))
cea2e8a9 7189 Perl_croak(aTHX_ PL_no_usym, "filehandle");
46fc3d4c 7190 if (SvROK(sv))
7191 return sv_2io(SvRV(sv));
2d8e6c8d 7192 gv = gv_fetchpv(SvPV(sv,n_a), FALSE, SVt_PVIO);
46fc3d4c 7193 if (gv)
7194 io = GvIO(gv);
7195 else
7196 io = 0;
7197 if (!io)
35c1215d 7198 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
46fc3d4c 7199 break;
7200 }
7201 return io;
7202}
7203
645c22ef
DM
7204/*
7205=for apidoc sv_2cv
7206
7207Using various gambits, try to get a CV from an SV; in addition, try if
7208possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7209
7210=cut
7211*/
7212
79072805 7213CV *
864dbfa3 7214Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
79072805 7215{
c04a4dfe
JH
7216 GV *gv = Nullgv;
7217 CV *cv = Nullcv;
2d8e6c8d 7218 STRLEN n_a;
79072805
LW
7219
7220 if (!sv)
93a17b20 7221 return *gvp = Nullgv, Nullcv;
79072805 7222 switch (SvTYPE(sv)) {
79072805
LW
7223 case SVt_PVCV:
7224 *st = CvSTASH(sv);
7225 *gvp = Nullgv;
7226 return (CV*)sv;
7227 case SVt_PVHV:
7228 case SVt_PVAV:
7229 *gvp = Nullgv;
7230 return Nullcv;
8990e307
LW
7231 case SVt_PVGV:
7232 gv = (GV*)sv;
a0d0e21e 7233 *gvp = gv;
8990e307
LW
7234 *st = GvESTASH(gv);
7235 goto fix_gv;
7236
79072805 7237 default:
a0d0e21e
LW
7238 if (SvGMAGICAL(sv))
7239 mg_get(sv);
7240 if (SvROK(sv)) {
f5284f61
IZ
7241 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7242 tryAMAGICunDEREF(to_cv);
7243
62f274bf
GS
7244 sv = SvRV(sv);
7245 if (SvTYPE(sv) == SVt_PVCV) {
7246 cv = (CV*)sv;
7247 *gvp = Nullgv;
7248 *st = CvSTASH(cv);
7249 return cv;
7250 }
7251 else if(isGV(sv))
7252 gv = (GV*)sv;
7253 else
cea2e8a9 7254 Perl_croak(aTHX_ "Not a subroutine reference");
a0d0e21e 7255 }
62f274bf 7256 else if (isGV(sv))
79072805
LW
7257 gv = (GV*)sv;
7258 else
2d8e6c8d 7259 gv = gv_fetchpv(SvPV(sv, n_a), lref, SVt_PVCV);
79072805
LW
7260 *gvp = gv;
7261 if (!gv)
7262 return Nullcv;
7263 *st = GvESTASH(gv);
8990e307 7264 fix_gv:
8ebc5c01 7265 if (lref && !GvCVu(gv)) {
4633a7c4 7266 SV *tmpsv;
748a9306 7267 ENTER;
4633a7c4 7268 tmpsv = NEWSV(704,0);
16660edb 7269 gv_efullname3(tmpsv, gv, Nullch);
f6ec51f7
GS
7270 /* XXX this is probably not what they think they're getting.
7271 * It has the same effect as "sub name;", i.e. just a forward
7272 * declaration! */
774d564b 7273 newSUB(start_subparse(FALSE, 0),
4633a7c4
LW
7274 newSVOP(OP_CONST, 0, tmpsv),
7275 Nullop,
8990e307 7276 Nullop);
748a9306 7277 LEAVE;
8ebc5c01 7278 if (!GvCVu(gv))
35c1215d
NC
7279 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7280 sv);
8990e307 7281 }
8ebc5c01 7282 return GvCVu(gv);
79072805
LW
7283 }
7284}
7285
c461cf8f
JH
7286/*
7287=for apidoc sv_true
7288
7289Returns true if the SV has a true value by Perl's rules.
645c22ef
DM
7290Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7291instead use an in-line version.
c461cf8f
JH
7292
7293=cut
7294*/
7295
79072805 7296I32
864dbfa3 7297Perl_sv_true(pTHX_ register SV *sv)
79072805 7298{
8990e307
LW
7299 if (!sv)
7300 return 0;
79072805 7301 if (SvPOK(sv)) {
4e35701f
NIS
7302 register XPV* tXpv;
7303 if ((tXpv = (XPV*)SvANY(sv)) &&
c2f1de04 7304 (tXpv->xpv_cur > 1 ||
4e35701f 7305 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
79072805
LW
7306 return 1;
7307 else
7308 return 0;
7309 }
7310 else {
7311 if (SvIOK(sv))
463ee0b2 7312 return SvIVX(sv) != 0;
79072805
LW
7313 else {
7314 if (SvNOK(sv))
463ee0b2 7315 return SvNVX(sv) != 0.0;
79072805 7316 else
463ee0b2 7317 return sv_2bool(sv);
79072805
LW
7318 }
7319 }
7320}
79072805 7321
645c22ef
DM
7322/*
7323=for apidoc sv_iv
7324
7325A private implementation of the C<SvIVx> macro for compilers which can't
7326cope with complex macro expressions. Always use the macro instead.
7327
7328=cut
7329*/
7330
ff68c719 7331IV
864dbfa3 7332Perl_sv_iv(pTHX_ register SV *sv)
85e6fe83 7333{
25da4f38
IZ
7334 if (SvIOK(sv)) {
7335 if (SvIsUV(sv))
7336 return (IV)SvUVX(sv);
ff68c719 7337 return SvIVX(sv);
25da4f38 7338 }
ff68c719 7339 return sv_2iv(sv);
85e6fe83 7340}
85e6fe83 7341
645c22ef
DM
7342/*
7343=for apidoc sv_uv
7344
7345A private implementation of the C<SvUVx> macro for compilers which can't
7346cope with complex macro expressions. Always use the macro instead.
7347
7348=cut
7349*/
7350
ff68c719 7351UV
864dbfa3 7352Perl_sv_uv(pTHX_ register SV *sv)
ff68c719 7353{
25da4f38
IZ
7354 if (SvIOK(sv)) {
7355 if (SvIsUV(sv))
7356 return SvUVX(sv);
7357 return (UV)SvIVX(sv);
7358 }
ff68c719 7359 return sv_2uv(sv);
7360}
85e6fe83 7361
645c22ef
DM
7362/*
7363=for apidoc sv_nv
7364
7365A private implementation of the C<SvNVx> macro for compilers which can't
7366cope with complex macro expressions. Always use the macro instead.
7367
7368=cut
7369*/
7370
65202027 7371NV
864dbfa3 7372Perl_sv_nv(pTHX_ register SV *sv)
79072805 7373{
ff68c719 7374 if (SvNOK(sv))
7375 return SvNVX(sv);
7376 return sv_2nv(sv);
79072805 7377}
79072805 7378
645c22ef
DM
7379/*
7380=for apidoc sv_pv
7381
baca2b92 7382Use the C<SvPV_nolen> macro instead
645c22ef 7383
645c22ef
DM
7384=for apidoc sv_pvn
7385
7386A private implementation of the C<SvPV> macro for compilers which can't
7387cope with complex macro expressions. Always use the macro instead.
7388
7389=cut
7390*/
7391
1fa8b10d 7392char *
864dbfa3 7393Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
79072805 7394{
85e6fe83
LW
7395 if (SvPOK(sv)) {
7396 *lp = SvCUR(sv);
a0d0e21e 7397 return SvPVX(sv);
85e6fe83 7398 }
463ee0b2 7399 return sv_2pv(sv, lp);
79072805 7400}
79072805 7401
6e9d1081
NC
7402
7403char *
7404Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7405{
7406 if (SvPOK(sv)) {
7407 *lp = SvCUR(sv);
7408 return SvPVX(sv);
7409 }
7410 return sv_2pv_flags(sv, lp, 0);
7411}
7412
c461cf8f
JH
7413/*
7414=for apidoc sv_pvn_force
7415
7416Get a sensible string out of the SV somehow.
645c22ef
DM
7417A private implementation of the C<SvPV_force> macro for compilers which
7418can't cope with complex macro expressions. Always use the macro instead.
c461cf8f 7419
8d6d96c1
HS
7420=for apidoc sv_pvn_force_flags
7421
7422Get a sensible string out of the SV somehow.
7423If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7424appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7425implemented in terms of this function.
645c22ef
DM
7426You normally want to use the various wrapper macros instead: see
7427C<SvPV_force> and C<SvPV_force_nomg>
8d6d96c1
HS
7428
7429=cut
7430*/
7431
7432char *
7433Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7434{
c04a4dfe 7435 char *s = NULL;
a0d0e21e 7436
6fc92669 7437 if (SvTHINKFIRST(sv) && !SvROK(sv))
765f542d 7438 sv_force_normal_flags(sv, 0);
1c846c1f 7439
a0d0e21e
LW
7440 if (SvPOK(sv)) {
7441 *lp = SvCUR(sv);
7442 }
7443 else {
748a9306 7444 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
cea2e8a9 7445 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
53e06cf0 7446 OP_NAME(PL_op));
a0d0e21e 7447 }
4633a7c4 7448 else
8d6d96c1 7449 s = sv_2pv_flags(sv, lp, flags);
a0d0e21e
LW
7450 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
7451 STRLEN len = *lp;
1c846c1f 7452
a0d0e21e
LW
7453 if (SvROK(sv))
7454 sv_unref(sv);
7455 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7456 SvGROW(sv, len + 1);
7457 Move(s,SvPVX(sv),len,char);
7458 SvCUR_set(sv, len);
7459 *SvEND(sv) = '\0';
7460 }
7461 if (!SvPOK(sv)) {
7462 SvPOK_on(sv); /* validate pointer */
7463 SvTAINT(sv);
1d7c1841
GS
7464 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7465 PTR2UV(sv),SvPVX(sv)));
a0d0e21e
LW
7466 }
7467 }
7468 return SvPVX(sv);
7469}
7470
645c22ef
DM
7471/*
7472=for apidoc sv_pvbyte
7473
baca2b92 7474Use C<SvPVbyte_nolen> instead.
645c22ef 7475
645c22ef
DM
7476=for apidoc sv_pvbyten
7477
7478A private implementation of the C<SvPVbyte> macro for compilers
7479which can't cope with complex macro expressions. Always use the macro
7480instead.
7481
7482=cut
7483*/
7484
7340a771
GS
7485char *
7486Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7487{
ffebcc3e 7488 sv_utf8_downgrade(sv,0);
7340a771
GS
7489 return sv_pvn(sv,lp);
7490}
7491
645c22ef
DM
7492/*
7493=for apidoc sv_pvbyten_force
7494
7495A private implementation of the C<SvPVbytex_force> macro for compilers
7496which can't cope with complex macro expressions. Always use the macro
7497instead.
7498
7499=cut
7500*/
7501
7340a771
GS
7502char *
7503Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7504{
ffebcc3e 7505 sv_utf8_downgrade(sv,0);
7340a771
GS
7506 return sv_pvn_force(sv,lp);
7507}
7508
645c22ef
DM
7509/*
7510=for apidoc sv_pvutf8
7511
baca2b92 7512Use the C<SvPVutf8_nolen> macro instead
645c22ef 7513
645c22ef
DM
7514=for apidoc sv_pvutf8n
7515
7516A private implementation of the C<SvPVutf8> macro for compilers
7517which can't cope with complex macro expressions. Always use the macro
7518instead.
7519
7520=cut
7521*/
7522
7340a771
GS
7523char *
7524Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
7525{
560a288e 7526 sv_utf8_upgrade(sv);
7340a771
GS
7527 return sv_pvn(sv,lp);
7528}
7529
c461cf8f
JH
7530/*
7531=for apidoc sv_pvutf8n_force
7532
645c22ef
DM
7533A private implementation of the C<SvPVutf8_force> macro for compilers
7534which can't cope with complex macro expressions. Always use the macro
7535instead.
c461cf8f
JH
7536
7537=cut
7538*/
7539
7340a771
GS
7540char *
7541Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7542{
560a288e 7543 sv_utf8_upgrade(sv);
7340a771
GS
7544 return sv_pvn_force(sv,lp);
7545}
7546
c461cf8f
JH
7547/*
7548=for apidoc sv_reftype
7549
7550Returns a string describing what the SV is a reference to.
7551
7552=cut
7553*/
7554
7340a771 7555char *
864dbfa3 7556Perl_sv_reftype(pTHX_ SV *sv, int ob)
a0d0e21e 7557{
c86bf373 7558 if (ob && SvOBJECT(sv)) {
de11ba31 7559 return HvNAME(SvSTASH(sv));
c86bf373 7560 }
a0d0e21e
LW
7561 else {
7562 switch (SvTYPE(sv)) {
7563 case SVt_NULL:
7564 case SVt_IV:
7565 case SVt_NV:
7566 case SVt_RV:
7567 case SVt_PV:
7568 case SVt_PVIV:
7569 case SVt_PVNV:
7570 case SVt_PVMG:
7571 case SVt_PVBM:
439cb1c4
JP
7572 if (SvVOK(sv))
7573 return "VSTRING";
a0d0e21e
LW
7574 if (SvROK(sv))
7575 return "REF";
7576 else
7577 return "SCALAR";
7578 case SVt_PVLV: return "LVALUE";
7579 case SVt_PVAV: return "ARRAY";
7580 case SVt_PVHV: return "HASH";
7581 case SVt_PVCV: return "CODE";
7582 case SVt_PVGV: return "GLOB";
1d2dff63 7583 case SVt_PVFM: return "FORMAT";
27f9d8f3 7584 case SVt_PVIO: return "IO";
a0d0e21e
LW
7585 default: return "UNKNOWN";
7586 }
7587 }
7588}
7589
954c1994
GS
7590/*
7591=for apidoc sv_isobject
7592
7593Returns a boolean indicating whether the SV is an RV pointing to a blessed
7594object. If the SV is not an RV, or if the object is not blessed, then this
7595will return false.
7596
7597=cut
7598*/
7599
463ee0b2 7600int
864dbfa3 7601Perl_sv_isobject(pTHX_ SV *sv)
85e6fe83 7602{
68dc0745 7603 if (!sv)
7604 return 0;
7605 if (SvGMAGICAL(sv))
7606 mg_get(sv);
85e6fe83
LW
7607 if (!SvROK(sv))
7608 return 0;
7609 sv = (SV*)SvRV(sv);
7610 if (!SvOBJECT(sv))
7611 return 0;
7612 return 1;
7613}
7614
954c1994
GS
7615/*
7616=for apidoc sv_isa
7617
7618Returns a boolean indicating whether the SV is blessed into the specified
7619class. This does not check for subtypes; use C<sv_derived_from> to verify
7620an inheritance relationship.
7621
7622=cut
7623*/
7624
85e6fe83 7625int
864dbfa3 7626Perl_sv_isa(pTHX_ SV *sv, const char *name)
463ee0b2 7627{
68dc0745 7628 if (!sv)
7629 return 0;
7630 if (SvGMAGICAL(sv))
7631 mg_get(sv);
ed6116ce 7632 if (!SvROK(sv))
463ee0b2 7633 return 0;
ed6116ce
LW
7634 sv = (SV*)SvRV(sv);
7635 if (!SvOBJECT(sv))
463ee0b2
LW
7636 return 0;
7637
7638 return strEQ(HvNAME(SvSTASH(sv)), name);
7639}
7640
954c1994
GS
7641/*
7642=for apidoc newSVrv
7643
7644Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7645it will be upgraded to one. If C<classname> is non-null then the new SV will
7646be blessed in the specified package. The new SV is returned and its
7647reference count is 1.
7648
7649=cut
7650*/
7651
463ee0b2 7652SV*
864dbfa3 7653Perl_newSVrv(pTHX_ SV *rv, const char *classname)
463ee0b2 7654{
463ee0b2
LW
7655 SV *sv;
7656
4561caa4 7657 new_SV(sv);
51cf62d8 7658
765f542d 7659 SV_CHECK_THINKFIRST_COW_DROP(rv);
51cf62d8 7660 SvAMAGIC_off(rv);
51cf62d8 7661
0199fce9
JD
7662 if (SvTYPE(rv) >= SVt_PVMG) {
7663 U32 refcnt = SvREFCNT(rv);
7664 SvREFCNT(rv) = 0;
7665 sv_clear(rv);
7666 SvFLAGS(rv) = 0;
7667 SvREFCNT(rv) = refcnt;
7668 }
7669
51cf62d8 7670 if (SvTYPE(rv) < SVt_RV)
0199fce9
JD
7671 sv_upgrade(rv, SVt_RV);
7672 else if (SvTYPE(rv) > SVt_RV) {
7673 (void)SvOOK_off(rv);
7674 if (SvPVX(rv) && SvLEN(rv))
7675 Safefree(SvPVX(rv));
7676 SvCUR_set(rv, 0);
7677 SvLEN_set(rv, 0);
7678 }
51cf62d8
OT
7679
7680 (void)SvOK_off(rv);
053fc874 7681 SvRV(rv) = sv;
ed6116ce 7682 SvROK_on(rv);
463ee0b2 7683
a0d0e21e
LW
7684 if (classname) {
7685 HV* stash = gv_stashpv(classname, TRUE);
7686 (void)sv_bless(rv, stash);
7687 }
7688 return sv;
7689}
7690
954c1994
GS
7691/*
7692=for apidoc sv_setref_pv
7693
7694Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7695argument will be upgraded to an RV. That RV will be modified to point to
7696the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7697into the SV. The C<classname> argument indicates the package for the
7698blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7699will be returned and will have a reference count of 1.
7700
7701Do not use with other Perl types such as HV, AV, SV, CV, because those
7702objects will become corrupted by the pointer copy process.
7703
7704Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7705
7706=cut
7707*/
7708
a0d0e21e 7709SV*
864dbfa3 7710Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
a0d0e21e 7711{
189b2af5 7712 if (!pv) {
3280af22 7713 sv_setsv(rv, &PL_sv_undef);
189b2af5
GS
7714 SvSETMAGIC(rv);
7715 }
a0d0e21e 7716 else
56431972 7717 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
a0d0e21e
LW
7718 return rv;
7719}
7720
954c1994
GS
7721/*
7722=for apidoc sv_setref_iv
7723
7724Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7725argument will be upgraded to an RV. That RV will be modified to point to
7726the new SV. The C<classname> argument indicates the package for the
7727blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7728will be returned and will have a reference count of 1.
7729
7730=cut
7731*/
7732
a0d0e21e 7733SV*
864dbfa3 7734Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
a0d0e21e
LW
7735{
7736 sv_setiv(newSVrv(rv,classname), iv);
7737 return rv;
7738}
7739
954c1994 7740/*
e1c57cef
JH
7741=for apidoc sv_setref_uv
7742
7743Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7744argument will be upgraded to an RV. That RV will be modified to point to
7745the new SV. The C<classname> argument indicates the package for the
7746blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7747will be returned and will have a reference count of 1.
7748
7749=cut
7750*/
7751
7752SV*
7753Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7754{
7755 sv_setuv(newSVrv(rv,classname), uv);
7756 return rv;
7757}
7758
7759/*
954c1994
GS
7760=for apidoc sv_setref_nv
7761
7762Copies a double into a new SV, optionally blessing the SV. The C<rv>
7763argument will be upgraded to an RV. That RV will be modified to point to
7764the new SV. The C<classname> argument indicates the package for the
7765blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7766will be returned and will have a reference count of 1.
7767
7768=cut
7769*/
7770
a0d0e21e 7771SV*
65202027 7772Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
a0d0e21e
LW
7773{
7774 sv_setnv(newSVrv(rv,classname), nv);
7775 return rv;
7776}
463ee0b2 7777
954c1994
GS
7778/*
7779=for apidoc sv_setref_pvn
7780
7781Copies a string into a new SV, optionally blessing the SV. The length of the
7782string must be specified with C<n>. The C<rv> argument will be upgraded to
7783an RV. That RV will be modified to point to the new SV. The C<classname>
7784argument indicates the package for the blessing. Set C<classname> to
7785C<Nullch> to avoid the blessing. The new SV will be returned and will have
7786a reference count of 1.
7787
7788Note that C<sv_setref_pv> copies the pointer while this copies the string.
7789
7790=cut
7791*/
7792
a0d0e21e 7793SV*
864dbfa3 7794Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
a0d0e21e
LW
7795{
7796 sv_setpvn(newSVrv(rv,classname), pv, n);
463ee0b2
LW
7797 return rv;
7798}
7799
954c1994
GS
7800/*
7801=for apidoc sv_bless
7802
7803Blesses an SV into a specified package. The SV must be an RV. The package
7804must be designated by its stash (see C<gv_stashpv()>). The reference count
7805of the SV is unaffected.
7806
7807=cut
7808*/
7809
a0d0e21e 7810SV*
864dbfa3 7811Perl_sv_bless(pTHX_ SV *sv, HV *stash)
a0d0e21e 7812{
76e3520e 7813 SV *tmpRef;
a0d0e21e 7814 if (!SvROK(sv))
cea2e8a9 7815 Perl_croak(aTHX_ "Can't bless non-reference value");
76e3520e
GS
7816 tmpRef = SvRV(sv);
7817 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7818 if (SvREADONLY(tmpRef))
cea2e8a9 7819 Perl_croak(aTHX_ PL_no_modify);
76e3520e
GS
7820 if (SvOBJECT(tmpRef)) {
7821 if (SvTYPE(tmpRef) != SVt_PVIO)
3280af22 7822 --PL_sv_objcount;
76e3520e 7823 SvREFCNT_dec(SvSTASH(tmpRef));
2e3febc6 7824 }
a0d0e21e 7825 }
76e3520e
GS
7826 SvOBJECT_on(tmpRef);
7827 if (SvTYPE(tmpRef) != SVt_PVIO)
3280af22 7828 ++PL_sv_objcount;
76e3520e
GS
7829 (void)SvUPGRADE(tmpRef, SVt_PVMG);
7830 SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
a0d0e21e 7831
2e3febc6
CS
7832 if (Gv_AMG(stash))
7833 SvAMAGIC_on(sv);
7834 else
7835 SvAMAGIC_off(sv);
a0d0e21e 7836
1edbfb88
AB
7837 if(SvSMAGICAL(tmpRef))
7838 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7839 mg_set(tmpRef);
7840
7841
ecdeb87c 7842
a0d0e21e
LW
7843 return sv;
7844}
7845
645c22ef 7846/* Downgrades a PVGV to a PVMG.
645c22ef
DM
7847 */
7848
76e3520e 7849STATIC void
cea2e8a9 7850S_sv_unglob(pTHX_ SV *sv)
a0d0e21e 7851{
850fabdf
GS
7852 void *xpvmg;
7853
a0d0e21e
LW
7854 assert(SvTYPE(sv) == SVt_PVGV);
7855 SvFAKE_off(sv);
7856 if (GvGP(sv))
1edc1566 7857 gp_free((GV*)sv);
e826b3c7
GS
7858 if (GvSTASH(sv)) {
7859 SvREFCNT_dec(GvSTASH(sv));
7860 GvSTASH(sv) = Nullhv;
7861 }
14befaf4 7862 sv_unmagic(sv, PERL_MAGIC_glob);
a0d0e21e 7863 Safefree(GvNAME(sv));
a5f75d66 7864 GvMULTI_off(sv);
850fabdf
GS
7865
7866 /* need to keep SvANY(sv) in the right arena */
7867 xpvmg = new_XPVMG();
7868 StructCopy(SvANY(sv), xpvmg, XPVMG);
7869 del_XPVGV(SvANY(sv));
7870 SvANY(sv) = xpvmg;
7871
a0d0e21e
LW
7872 SvFLAGS(sv) &= ~SVTYPEMASK;
7873 SvFLAGS(sv) |= SVt_PVMG;
7874}
7875
954c1994 7876/*
840a7b70 7877=for apidoc sv_unref_flags
954c1994
GS
7878
7879Unsets the RV status of the SV, and decrements the reference count of
7880whatever was being referenced by the RV. This can almost be thought of
840a7b70
IZ
7881as a reversal of C<newSVrv>. The C<cflags> argument can contain
7882C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7883(otherwise the decrementing is conditional on the reference count being
7884different from one or the reference being a readonly SV).
7889fe52 7885See C<SvROK_off>.
954c1994
GS
7886
7887=cut
7888*/
7889
ed6116ce 7890void
840a7b70 7891Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
ed6116ce 7892{
a0d0e21e 7893 SV* rv = SvRV(sv);
810b8aa5
GS
7894
7895 if (SvWEAKREF(sv)) {
7896 sv_del_backref(sv);
7897 SvWEAKREF_off(sv);
7898 SvRV(sv) = 0;
7899 return;
7900 }
ed6116ce
LW
7901 SvRV(sv) = 0;
7902 SvROK_off(sv);
04ca4930
NC
7903 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
7904 assigned to as BEGIN {$a = \"Foo"} will fail. */
7905 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
4633a7c4 7906 SvREFCNT_dec(rv);
840a7b70 7907 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
4633a7c4 7908 sv_2mortal(rv); /* Schedule for freeing later */
ed6116ce 7909}
8990e307 7910
840a7b70
IZ
7911/*
7912=for apidoc sv_unref
7913
7914Unsets the RV status of the SV, and decrements the reference count of
7915whatever was being referenced by the RV. This can almost be thought of
7916as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
7889fe52 7917being zero. See C<SvROK_off>.
840a7b70
IZ
7918
7919=cut
7920*/
7921
7922void
7923Perl_sv_unref(pTHX_ SV *sv)
7924{
7925 sv_unref_flags(sv, 0);
7926}
7927
645c22ef
DM
7928/*
7929=for apidoc sv_taint
7930
7931Taint an SV. Use C<SvTAINTED_on> instead.
7932=cut
7933*/
7934
bbce6d69 7935void
864dbfa3 7936Perl_sv_taint(pTHX_ SV *sv)
bbce6d69 7937{
14befaf4 7938 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
bbce6d69 7939}
7940
645c22ef
DM
7941/*
7942=for apidoc sv_untaint
7943
7944Untaint an SV. Use C<SvTAINTED_off> instead.
7945=cut
7946*/
7947
bbce6d69 7948void
864dbfa3 7949Perl_sv_untaint(pTHX_ SV *sv)
bbce6d69 7950{
13f57bf8 7951 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
14befaf4 7952 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
36477c24 7953 if (mg)
565764a8 7954 mg->mg_len &= ~1;
36477c24 7955 }
bbce6d69 7956}
7957
645c22ef
DM
7958/*
7959=for apidoc sv_tainted
7960
7961Test an SV for taintedness. Use C<SvTAINTED> instead.
7962=cut
7963*/
7964
bbce6d69 7965bool
864dbfa3 7966Perl_sv_tainted(pTHX_ SV *sv)
bbce6d69 7967{
13f57bf8 7968 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
14befaf4 7969 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
155aba94 7970 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
36477c24 7971 return TRUE;
7972 }
7973 return FALSE;
bbce6d69 7974}
7975
cea2e8a9 7976#if defined(PERL_IMPLICIT_CONTEXT)
645c22ef
DM
7977
7978/* pTHX_ magic can't cope with varargs, so this is a no-context
7979 * version of the main function, (which may itself be aliased to us).
7980 * Don't access this version directly.
7981 */
7982
cea2e8a9
GS
7983void
7984Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7985{
7986 dTHX;
7987 va_list args;
7988 va_start(args, pat);
c5be433b 7989 sv_vsetpvf(sv, pat, &args);
cea2e8a9
GS
7990 va_end(args);
7991}
7992
645c22ef
DM
7993/* pTHX_ magic can't cope with varargs, so this is a no-context
7994 * version of the main function, (which may itself be aliased to us).
7995 * Don't access this version directly.
7996 */
cea2e8a9
GS
7997
7998void
7999Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8000{
8001 dTHX;
8002 va_list args;
8003 va_start(args, pat);
c5be433b 8004 sv_vsetpvf_mg(sv, pat, &args);
cea2e8a9 8005 va_end(args);
cea2e8a9
GS
8006}
8007#endif
8008
954c1994
GS
8009/*
8010=for apidoc sv_setpvf
8011
8012Processes its arguments like C<sprintf> and sets an SV to the formatted
8013output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8014
8015=cut
8016*/
8017
46fc3d4c 8018void
864dbfa3 8019Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
46fc3d4c 8020{
8021 va_list args;
46fc3d4c 8022 va_start(args, pat);
c5be433b 8023 sv_vsetpvf(sv, pat, &args);
46fc3d4c 8024 va_end(args);
8025}
8026
645c22ef
DM
8027/* backend for C<sv_setpvf> and C<sv_setpvf_nocontext> */
8028
c5be433b
GS
8029void
8030Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8031{
8032 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8033}
ef50df4b 8034
954c1994
GS
8035/*
8036=for apidoc sv_setpvf_mg
8037
8038Like C<sv_setpvf>, but also handles 'set' magic.
8039
8040=cut
8041*/
8042
ef50df4b 8043void
864dbfa3 8044Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
ef50df4b
GS
8045{
8046 va_list args;
ef50df4b 8047 va_start(args, pat);
c5be433b 8048 sv_vsetpvf_mg(sv, pat, &args);
ef50df4b 8049 va_end(args);
c5be433b
GS
8050}
8051
645c22ef
DM
8052/* backend for C<sv_setpvf_mg> C<setpvf_mg_nocontext> */
8053
c5be433b
GS
8054void
8055Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8056{
8057 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
ef50df4b
GS
8058 SvSETMAGIC(sv);
8059}
8060
cea2e8a9 8061#if defined(PERL_IMPLICIT_CONTEXT)
645c22ef
DM
8062
8063/* pTHX_ magic can't cope with varargs, so this is a no-context
8064 * version of the main function, (which may itself be aliased to us).
8065 * Don't access this version directly.
8066 */
8067
cea2e8a9
GS
8068void
8069Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8070{
8071 dTHX;
8072 va_list args;
8073 va_start(args, pat);
c5be433b 8074 sv_vcatpvf(sv, pat, &args);
cea2e8a9
GS
8075 va_end(args);
8076}
8077
645c22ef
DM
8078/* pTHX_ magic can't cope with varargs, so this is a no-context
8079 * version of the main function, (which may itself be aliased to us).
8080 * Don't access this version directly.
8081 */
8082
cea2e8a9
GS
8083void
8084Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8085{
8086 dTHX;
8087 va_list args;
8088 va_start(args, pat);
c5be433b 8089 sv_vcatpvf_mg(sv, pat, &args);
cea2e8a9 8090 va_end(args);
cea2e8a9
GS
8091}
8092#endif
8093
954c1994
GS
8094/*
8095=for apidoc sv_catpvf
8096
d5ce4a7c
GA
8097Processes its arguments like C<sprintf> and appends the formatted
8098output to an SV. If the appended data contains "wide" characters
8099(including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8100and characters >255 formatted with %c), the original SV might get
8101upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
8102C<SvSETMAGIC()> must typically be called after calling this function
8103to handle 'set' magic.
954c1994 8104
d5ce4a7c 8105=cut */
954c1994 8106
46fc3d4c 8107void
864dbfa3 8108Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
46fc3d4c 8109{
8110 va_list args;
46fc3d4c 8111 va_start(args, pat);
c5be433b 8112 sv_vcatpvf(sv, pat, &args);
46fc3d4c 8113 va_end(args);
8114}
8115
645c22ef
DM
8116/* backend for C<sv_catpvf> and C<catpvf_mg_nocontext> */
8117
ef50df4b 8118void
c5be433b
GS
8119Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8120{
8121 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8122}
8123
954c1994
GS
8124/*
8125=for apidoc sv_catpvf_mg
8126
8127Like C<sv_catpvf>, but also handles 'set' magic.
8128
8129=cut
8130*/
8131
c5be433b 8132void
864dbfa3 8133Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
ef50df4b
GS
8134{
8135 va_list args;
ef50df4b 8136 va_start(args, pat);
c5be433b 8137 sv_vcatpvf_mg(sv, pat, &args);
ef50df4b 8138 va_end(args);
c5be433b
GS
8139}
8140
645c22ef
DM
8141/* backend for C<catpvf_mg> and C<catpvf_mg_nocontext> */
8142
c5be433b
GS
8143void
8144Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8145{
8146 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
ef50df4b
GS
8147 SvSETMAGIC(sv);
8148}
8149
954c1994
GS
8150/*
8151=for apidoc sv_vsetpvfn
8152
8153Works like C<vcatpvfn> but copies the text into the SV instead of
8154appending it.
8155
645c22ef
DM
8156Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
8157
954c1994
GS
8158=cut
8159*/
8160
46fc3d4c 8161void
7d5ea4e7 8162Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
46fc3d4c 8163{
8164 sv_setpvn(sv, "", 0);
7d5ea4e7 8165 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
46fc3d4c 8166}
8167
645c22ef
DM
8168/* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8169
2d00ba3b 8170STATIC I32
9dd79c3f 8171S_expect_number(pTHX_ char** pattern)
211dfcf1
HS
8172{
8173 I32 var = 0;
8174 switch (**pattern) {
8175 case '1': case '2': case '3':
8176 case '4': case '5': case '6':
8177 case '7': case '8': case '9':
8178 while (isDIGIT(**pattern))
8179 var = var * 10 + (*(*pattern)++ - '0');
8180 }
8181 return var;
8182}
9dd79c3f 8183#define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
211dfcf1 8184
954c1994
GS
8185/*
8186=for apidoc sv_vcatpvfn
8187
8188Processes its arguments like C<vsprintf> and appends the formatted output
8189to an SV. Uses an array of SVs if the C style variable argument list is
8190missing (NULL). When running with taint checks enabled, indicates via
8191C<maybe_tainted> if results are untrustworthy (often due to the use of
8192locales).
8193
645c22ef
DM
8194Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
8195
954c1994
GS
8196=cut
8197*/
8198
46fc3d4c 8199void
7d5ea4e7 8200Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
46fc3d4c 8201{
8202 char *p;
8203 char *q;
8204 char *patend;
fc36a67e 8205 STRLEN origlen;
46fc3d4c 8206 I32 svix = 0;
c635e13b 8207 static char nullstr[] = "(null)";
9c5ffd7c 8208 SV *argsv = Nullsv;
2cf2cfc6 8209 bool has_utf8 = FALSE; /* has the result utf8? */
46fc3d4c 8210
8211 /* no matter what, this is a string now */
fc36a67e 8212 (void)SvPV_force(sv, origlen);
46fc3d4c 8213
fc36a67e 8214 /* special-case "", "%s", and "%_" */
46fc3d4c 8215 if (patlen == 0)
8216 return;
fc36a67e 8217 if (patlen == 2 && pat[0] == '%') {
8218 switch (pat[1]) {
8219 case 's':
c635e13b 8220 if (args) {
8221 char *s = va_arg(*args, char*);
8222 sv_catpv(sv, s ? s : nullstr);
8223 }
7e2040f0 8224 else if (svix < svmax) {
fc36a67e 8225 sv_catsv(sv, *svargs);
7e2040f0
GS
8226 if (DO_UTF8(*svargs))
8227 SvUTF8_on(sv);
8228 }
fc36a67e 8229 return;
8230 case '_':
8231 if (args) {
7e2040f0
GS
8232 argsv = va_arg(*args, SV*);
8233 sv_catsv(sv, argsv);
8234 if (DO_UTF8(argsv))
8235 SvUTF8_on(sv);
fc36a67e 8236 return;
8237 }
8238 /* See comment on '_' below */
8239 break;
8240 }
46fc3d4c 8241 }
8242
2cf2cfc6 8243 if (!args && svix < svmax && DO_UTF8(*svargs))
205f51d8 8244 has_utf8 = TRUE;
2cf2cfc6 8245
46fc3d4c 8246 patend = (char*)pat + patlen;
8247 for (p = (char*)pat; p < patend; p = q) {
8248 bool alt = FALSE;
8249 bool left = FALSE;
b22c7a20 8250 bool vectorize = FALSE;
211dfcf1 8251 bool vectorarg = FALSE;
2cf2cfc6 8252 bool vec_utf8 = FALSE;
46fc3d4c 8253 char fill = ' ';
8254 char plus = 0;
8255 char intsize = 0;
8256 STRLEN width = 0;
fc36a67e 8257 STRLEN zeros = 0;
46fc3d4c 8258 bool has_precis = FALSE;
8259 STRLEN precis = 0;
2cf2cfc6 8260 bool is_utf8 = FALSE; /* is this item utf8? */
20f6aaab
AS
8261#ifdef HAS_LDBL_SPRINTF_BUG
8262 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
205f51d8 8263 with sfio - Allen <allens@cpan.org> */
20f6aaab
AS
8264 bool fix_ldbl_sprintf_bug = FALSE;
8265#endif
205f51d8 8266
46fc3d4c 8267 char esignbuf[4];
ad391ad9 8268 U8 utf8buf[UTF8_MAXLEN+1];
46fc3d4c 8269 STRLEN esignlen = 0;
8270
8271 char *eptr = Nullch;
fc36a67e 8272 STRLEN elen = 0;
089c015b
JH
8273 /* Times 4: a decimal digit takes more than 3 binary digits.
8274 * NV_DIG: mantissa takes than many decimal digits.
8275 * Plus 32: Playing safe. */
8276 char ebuf[IV_DIG * 4 + NV_DIG + 32];
205f51d8 8277 /* large enough for "%#.#f" --chip */
2d4389e4 8278 /* what about long double NVs? --jhi */
b22c7a20 8279
81f715da 8280 SV *vecsv = Nullsv;
a05b299f 8281 U8 *vecstr = Null(U8*);
b22c7a20 8282 STRLEN veclen = 0;
934abaf1 8283 char c = 0;
46fc3d4c 8284 int i;
9c5ffd7c 8285 unsigned base = 0;
8c8eb53c
RB
8286 IV iv = 0;
8287 UV uv = 0;
9e5b023a
JH
8288 /* we need a long double target in case HAS_LONG_DOUBLE but
8289 not USE_LONG_DOUBLE
8290 */
35fff930 8291#if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9e5b023a
JH
8292 long double nv;
8293#else
65202027 8294 NV nv;
9e5b023a 8295#endif
46fc3d4c 8296 STRLEN have;
8297 STRLEN need;
8298 STRLEN gap;
b22c7a20
GS
8299 char *dotstr = ".";
8300 STRLEN dotstrlen = 1;
211dfcf1 8301 I32 efix = 0; /* explicit format parameter index */
eb3fce90 8302 I32 ewix = 0; /* explicit width index */
211dfcf1
HS
8303 I32 epix = 0; /* explicit precision index */
8304 I32 evix = 0; /* explicit vector index */
eb3fce90 8305 bool asterisk = FALSE;
46fc3d4c 8306
211dfcf1 8307 /* echo everything up to the next format specification */
46fc3d4c 8308 for (q = p; q < patend && *q != '%'; ++q) ;
8309 if (q > p) {
8310 sv_catpvn(sv, p, q - p);
8311 p = q;
8312 }
8313 if (q++ >= patend)
8314 break;
8315
211dfcf1
HS
8316/*
8317 We allow format specification elements in this order:
8318 \d+\$ explicit format parameter index
8319 [-+ 0#]+ flags
a472f209 8320 v|\*(\d+\$)?v vector with optional (optionally specified) arg
211dfcf1
HS
8321 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8322 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8323 [hlqLV] size
8324 [%bcdefginopsux_DFOUX] format (mandatory)
8325*/
8326 if (EXPECT_NUMBER(q, width)) {
8327 if (*q == '$') {
8328 ++q;
8329 efix = width;
8330 } else {
8331 goto gotwidth;
8332 }
8333 }
8334
fc36a67e 8335 /* FLAGS */
8336
46fc3d4c 8337 while (*q) {
8338 switch (*q) {
8339 case ' ':
8340 case '+':
8341 plus = *q++;
8342 continue;
8343
8344 case '-':
8345 left = TRUE;
8346 q++;
8347 continue;
8348
8349 case '0':
8350 fill = *q++;
8351 continue;
8352
8353 case '#':
8354 alt = TRUE;
8355 q++;
8356 continue;
8357
fc36a67e 8358 default:
8359 break;
8360 }
8361 break;
8362 }
46fc3d4c 8363
211dfcf1 8364 tryasterisk:
eb3fce90 8365 if (*q == '*') {
211dfcf1
HS
8366 q++;
8367 if (EXPECT_NUMBER(q, ewix))
8368 if (*q++ != '$')
8369 goto unknown;
eb3fce90 8370 asterisk = TRUE;
211dfcf1
HS
8371 }
8372 if (*q == 'v') {
eb3fce90 8373 q++;
211dfcf1
HS
8374 if (vectorize)
8375 goto unknown;
9cbac4c7 8376 if ((vectorarg = asterisk)) {
211dfcf1
HS
8377 evix = ewix;
8378 ewix = 0;
8379 asterisk = FALSE;
8380 }
8381 vectorize = TRUE;
8382 goto tryasterisk;
eb3fce90
JH
8383 }
8384
211dfcf1
HS
8385 if (!asterisk)
8386 EXPECT_NUMBER(q, width);
8387
8388 if (vectorize) {
8389 if (vectorarg) {
8390 if (args)
8391 vecsv = va_arg(*args, SV*);
8392 else
8393 vecsv = (evix ? evix <= svmax : svix < svmax) ?
8394 svargs[ewix ? ewix-1 : svix++] : &PL_sv_undef;
4459522c 8395 dotstr = SvPVx(vecsv, dotstrlen);
211dfcf1 8396 if (DO_UTF8(vecsv))
2cf2cfc6 8397 is_utf8 = TRUE;
211dfcf1
HS
8398 }
8399 if (args) {
8400 vecsv = va_arg(*args, SV*);
8401 vecstr = (U8*)SvPVx(vecsv,veclen);
2cf2cfc6 8402 vec_utf8 = DO_UTF8(vecsv);
eb3fce90 8403 }
211dfcf1
HS
8404 else if (efix ? efix <= svmax : svix < svmax) {
8405 vecsv = svargs[efix ? efix-1 : svix++];
8406 vecstr = (U8*)SvPVx(vecsv,veclen);
2cf2cfc6 8407 vec_utf8 = DO_UTF8(vecsv);
211dfcf1
HS
8408 }
8409 else {
8410 vecstr = (U8*)"";
8411 veclen = 0;
8412 }
eb3fce90 8413 }
fc36a67e 8414
eb3fce90 8415 if (asterisk) {
fc36a67e 8416 if (args)
8417 i = va_arg(*args, int);
8418 else
eb3fce90
JH
8419 i = (ewix ? ewix <= svmax : svix < svmax) ?
8420 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
fc36a67e 8421 left |= (i < 0);
8422 width = (i < 0) ? -i : i;
fc36a67e 8423 }
211dfcf1 8424 gotwidth:
fc36a67e 8425
8426 /* PRECISION */
46fc3d4c 8427
fc36a67e 8428 if (*q == '.') {
8429 q++;
8430 if (*q == '*') {
211dfcf1 8431 q++;
7b8dd722
HS
8432 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8433 goto unknown;
8434 /* XXX: todo, support specified precision parameter */
8435 if (epix)
211dfcf1 8436 goto unknown;
46fc3d4c 8437 if (args)
8438 i = va_arg(*args, int);
8439 else
eb3fce90
JH
8440 i = (ewix ? ewix <= svmax : svix < svmax)
8441 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
fc36a67e 8442 precis = (i < 0) ? 0 : i;
fc36a67e 8443 }
8444 else {
8445 precis = 0;
8446 while (isDIGIT(*q))
8447 precis = precis * 10 + (*q++ - '0');
8448 }
8449 has_precis = TRUE;
8450 }
46fc3d4c 8451
fc36a67e 8452 /* SIZE */
46fc3d4c 8453
fc36a67e 8454 switch (*q) {
c623ac67
GS
8455#ifdef WIN32
8456 case 'I': /* Ix, I32x, and I64x */
8457# ifdef WIN64
8458 if (q[1] == '6' && q[2] == '4') {
8459 q += 3;
8460 intsize = 'q';
8461 break;
8462 }
8463# endif
8464 if (q[1] == '3' && q[2] == '2') {
8465 q += 3;
8466 break;
8467 }
8468# ifdef WIN64
8469 intsize = 'q';
8470# endif
8471 q++;
8472 break;
8473#endif
9e5b023a 8474#if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
6f9bb7fd 8475 case 'L': /* Ld */
e5c81feb 8476 /* FALL THROUGH */
e5c81feb 8477#ifdef HAS_QUAD
6f9bb7fd 8478 case 'q': /* qd */
9e5b023a 8479#endif
6f9bb7fd
GS
8480 intsize = 'q';
8481 q++;
8482 break;
8483#endif
fc36a67e 8484 case 'l':
9e5b023a 8485#if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
205f51d8 8486 if (*(q + 1) == 'l') { /* lld, llf */
fc36a67e 8487 intsize = 'q';
8488 q += 2;
46fc3d4c 8489 break;
cf2093f6 8490 }
fc36a67e 8491#endif
6f9bb7fd 8492 /* FALL THROUGH */
fc36a67e 8493 case 'h':
cf2093f6 8494 /* FALL THROUGH */
fc36a67e 8495 case 'V':
8496 intsize = *q++;
46fc3d4c 8497 break;
8498 }
8499
fc36a67e 8500 /* CONVERSION */
8501
211dfcf1
HS
8502 if (*q == '%') {
8503 eptr = q++;
8504 elen = 1;
8505 goto string;
8506 }
8507
be75b157
HS
8508 if (vectorize)
8509 argsv = vecsv;
8510 else if (!args)
211dfcf1
HS
8511 argsv = (efix ? efix <= svmax : svix < svmax) ?
8512 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
8513
46fc3d4c 8514 switch (c = *q++) {
8515
8516 /* STRINGS */
8517
46fc3d4c 8518 case 'c':
be75b157 8519 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
1bd104fb
JH
8520 if ((uv > 255 ||
8521 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
0064a8a9 8522 && !IN_BYTES) {
dfe13c55 8523 eptr = (char*)utf8buf;
9041c2e3 8524 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
2cf2cfc6 8525 is_utf8 = TRUE;
7e2040f0
GS
8526 }
8527 else {
8528 c = (char)uv;
8529 eptr = &c;
8530 elen = 1;
a0ed51b3 8531 }
46fc3d4c 8532 goto string;
8533
46fc3d4c 8534 case 's':
be75b157 8535 if (args && !vectorize) {
fc36a67e 8536 eptr = va_arg(*args, char*);
c635e13b 8537 if (eptr)
1d7c1841
GS
8538#ifdef MACOS_TRADITIONAL
8539 /* On MacOS, %#s format is used for Pascal strings */
8540 if (alt)
8541 elen = *eptr++;
8542 else
8543#endif
c635e13b 8544 elen = strlen(eptr);
8545 else {
8546 eptr = nullstr;
8547 elen = sizeof nullstr - 1;
8548 }
46fc3d4c 8549 }
211dfcf1 8550 else {
7e2040f0
GS
8551 eptr = SvPVx(argsv, elen);
8552 if (DO_UTF8(argsv)) {
a0ed51b3
LW
8553 if (has_precis && precis < elen) {
8554 I32 p = precis;
7e2040f0 8555 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
a0ed51b3
LW
8556 precis = p;
8557 }
8558 if (width) { /* fudge width (can't fudge elen) */
7e2040f0 8559 width += elen - sv_len_utf8(argsv);
a0ed51b3 8560 }
2cf2cfc6 8561 is_utf8 = TRUE;
a0ed51b3
LW
8562 }
8563 }
46fc3d4c 8564 goto string;
8565
fc36a67e 8566 case '_':
8567 /*
8568 * The "%_" hack might have to be changed someday,
8569 * if ISO or ANSI decide to use '_' for something.
8570 * So we keep it hidden from users' code.
8571 */
be75b157 8572 if (!args || vectorize)
fc36a67e 8573 goto unknown;
211dfcf1 8574 argsv = va_arg(*args, SV*);
7e2040f0
GS
8575 eptr = SvPVx(argsv, elen);
8576 if (DO_UTF8(argsv))
2cf2cfc6 8577 is_utf8 = TRUE;
fc36a67e 8578
46fc3d4c 8579 string:
b22c7a20 8580 vectorize = FALSE;
46fc3d4c 8581 if (has_precis && elen > precis)
8582 elen = precis;
8583 break;
8584
8585 /* INTEGERS */
8586
fc36a67e 8587 case 'p':
be75b157 8588 if (alt || vectorize)
c2e66d9e 8589 goto unknown;
211dfcf1 8590 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
fc36a67e 8591 base = 16;
8592 goto integer;
8593
46fc3d4c 8594 case 'D':
29fe7a80 8595#ifdef IV_IS_QUAD
22f3ae8c 8596 intsize = 'q';
29fe7a80 8597#else
46fc3d4c 8598 intsize = 'l';
29fe7a80 8599#endif
46fc3d4c 8600 /* FALL THROUGH */
8601 case 'd':
8602 case 'i':
b22c7a20 8603 if (vectorize) {
ba210ebe 8604 STRLEN ulen;
211dfcf1
HS
8605 if (!veclen)
8606 continue;
2cf2cfc6
A
8607 if (vec_utf8)
8608 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8609 UTF8_ALLOW_ANYUV);
b22c7a20 8610 else {
e83d50c9 8611 uv = *vecstr;
b22c7a20
GS
8612 ulen = 1;
8613 }
8614 vecstr += ulen;
8615 veclen -= ulen;
e83d50c9
JP
8616 if (plus)
8617 esignbuf[esignlen++] = plus;
b22c7a20
GS
8618 }
8619 else if (args) {
46fc3d4c 8620 switch (intsize) {
8621 case 'h': iv = (short)va_arg(*args, int); break;
8622 default: iv = va_arg(*args, int); break;
8623 case 'l': iv = va_arg(*args, long); break;
fc36a67e 8624 case 'V': iv = va_arg(*args, IV); break;
cf2093f6
JH
8625#ifdef HAS_QUAD
8626 case 'q': iv = va_arg(*args, Quad_t); break;
8627#endif
46fc3d4c 8628 }
8629 }
8630 else {
211dfcf1 8631 iv = SvIVx(argsv);
46fc3d4c 8632 switch (intsize) {
8633 case 'h': iv = (short)iv; break;
be28567c 8634 default: break;
46fc3d4c 8635 case 'l': iv = (long)iv; break;
fc36a67e 8636 case 'V': break;
cf2093f6
JH
8637#ifdef HAS_QUAD
8638 case 'q': iv = (Quad_t)iv; break;
8639#endif
46fc3d4c 8640 }
8641 }
e83d50c9
JP
8642 if ( !vectorize ) /* we already set uv above */
8643 {
8644 if (iv >= 0) {
8645 uv = iv;
8646 if (plus)
8647 esignbuf[esignlen++] = plus;
8648 }
8649 else {
8650 uv = -iv;
8651 esignbuf[esignlen++] = '-';
8652 }
46fc3d4c 8653 }
8654 base = 10;
8655 goto integer;
8656
fc36a67e 8657 case 'U':
29fe7a80 8658#ifdef IV_IS_QUAD
22f3ae8c 8659 intsize = 'q';
29fe7a80 8660#else
fc36a67e 8661 intsize = 'l';
29fe7a80 8662#endif
fc36a67e 8663 /* FALL THROUGH */
8664 case 'u':
8665 base = 10;
8666 goto uns_integer;
8667
4f19785b
WSI
8668 case 'b':
8669 base = 2;
8670 goto uns_integer;
8671
46fc3d4c 8672 case 'O':
29fe7a80 8673#ifdef IV_IS_QUAD
22f3ae8c 8674 intsize = 'q';
29fe7a80 8675#else
46fc3d4c 8676 intsize = 'l';
29fe7a80 8677#endif
46fc3d4c 8678 /* FALL THROUGH */
8679 case 'o':
8680 base = 8;
8681 goto uns_integer;
8682
8683 case 'X':
46fc3d4c 8684 case 'x':
8685 base = 16;
46fc3d4c 8686
8687 uns_integer:
b22c7a20 8688 if (vectorize) {
ba210ebe 8689 STRLEN ulen;
b22c7a20 8690 vector:
211dfcf1
HS
8691 if (!veclen)
8692 continue;
2cf2cfc6
A
8693 if (vec_utf8)
8694 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8695 UTF8_ALLOW_ANYUV);
b22c7a20 8696 else {
a05b299f 8697 uv = *vecstr;
b22c7a20
GS
8698 ulen = 1;
8699 }
8700 vecstr += ulen;
8701 veclen -= ulen;
8702 }
8703 else if (args) {
46fc3d4c 8704 switch (intsize) {
8705 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8706 default: uv = va_arg(*args, unsigned); break;
8707 case 'l': uv = va_arg(*args, unsigned long); break;
fc36a67e 8708 case 'V': uv = va_arg(*args, UV); break;
cf2093f6
JH
8709#ifdef HAS_QUAD
8710 case 'q': uv = va_arg(*args, Quad_t); break;
8711#endif
46fc3d4c 8712 }
8713 }
8714 else {
211dfcf1 8715 uv = SvUVx(argsv);
46fc3d4c 8716 switch (intsize) {
8717 case 'h': uv = (unsigned short)uv; break;
be28567c 8718 default: break;
46fc3d4c 8719 case 'l': uv = (unsigned long)uv; break;
fc36a67e 8720 case 'V': break;
cf2093f6
JH
8721#ifdef HAS_QUAD
8722 case 'q': uv = (Quad_t)uv; break;
8723#endif
46fc3d4c 8724 }
8725 }
8726
8727 integer:
46fc3d4c 8728 eptr = ebuf + sizeof ebuf;
fc36a67e 8729 switch (base) {
8730 unsigned dig;
8731 case 16:
c10ed8b9
HS
8732 if (!uv)
8733 alt = FALSE;
1d7c1841
GS
8734 p = (char*)((c == 'X')
8735 ? "0123456789ABCDEF" : "0123456789abcdef");
fc36a67e 8736 do {
8737 dig = uv & 15;
8738 *--eptr = p[dig];
8739 } while (uv >>= 4);
8740 if (alt) {
46fc3d4c 8741 esignbuf[esignlen++] = '0';
fc36a67e 8742 esignbuf[esignlen++] = c; /* 'x' or 'X' */
46fc3d4c 8743 }
fc36a67e 8744 break;
8745 case 8:
8746 do {
8747 dig = uv & 7;
8748 *--eptr = '0' + dig;
8749 } while (uv >>= 3);
8750 if (alt && *eptr != '0')
8751 *--eptr = '0';
8752 break;
4f19785b
WSI
8753 case 2:
8754 do {
8755 dig = uv & 1;
8756 *--eptr = '0' + dig;
8757 } while (uv >>= 1);
eda88b6d
JH
8758 if (alt) {
8759 esignbuf[esignlen++] = '0';
7481bb52 8760 esignbuf[esignlen++] = 'b';
eda88b6d 8761 }
4f19785b 8762 break;
fc36a67e 8763 default: /* it had better be ten or less */
6bc102ca 8764#if defined(PERL_Y2KWARN)
e476b1b5 8765 if (ckWARN(WARN_Y2K)) {
6bc102ca
GS
8766 STRLEN n;
8767 char *s = SvPV(sv,n);
8768 if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
8769 && (n == 2 || !isDIGIT(s[n-3])))
8770 {
9014280d 8771 Perl_warner(aTHX_ packWARN(WARN_Y2K),
6bc102ca
GS
8772 "Possible Y2K bug: %%%c %s",
8773 c, "format string following '19'");
8774 }
8775 }
8776#endif
fc36a67e 8777 do {
8778 dig = uv % base;
8779 *--eptr = '0' + dig;
8780 } while (uv /= base);
8781 break;
46fc3d4c 8782 }
8783 elen = (ebuf + sizeof ebuf) - eptr;
c10ed8b9
HS
8784 if (has_precis) {
8785 if (precis > elen)
8786 zeros = precis - elen;
8787 else if (precis == 0 && elen == 1 && *eptr == '0')
8788 elen = 0;
8789 }
46fc3d4c 8790 break;
8791
8792 /* FLOATING POINT */
8793
fc36a67e 8794 case 'F':
8795 c = 'f'; /* maybe %F isn't supported here */
8796 /* FALL THROUGH */
46fc3d4c 8797 case 'e': case 'E':
fc36a67e 8798 case 'f':
46fc3d4c 8799 case 'g': case 'G':
8800
8801 /* This is evil, but floating point is even more evil */
8802
9e5b023a
JH
8803 /* for SV-style calling, we can only get NV
8804 for C-style calling, we assume %f is double;
8805 for simplicity we allow any of %Lf, %llf, %qf for long double
8806 */
8807 switch (intsize) {
8808 case 'V':
8809#if defined(USE_LONG_DOUBLE)
8810 intsize = 'q';
8811#endif
8812 break;
8813 default:
8814#if defined(USE_LONG_DOUBLE)
8815 intsize = args ? 0 : 'q';
8816#endif
8817 break;
8818 case 'q':
8819#if defined(HAS_LONG_DOUBLE)
8820 break;
8821#else
8822 /* FALL THROUGH */
8823#endif
8824 case 'h':
8825 /* FALL THROUGH */
8826 case 'l':
8827 goto unknown;
8828 }
8829
8830 /* now we need (long double) if intsize == 'q', else (double) */
be75b157 8831 nv = (args && !vectorize) ?
35fff930
JH
8832#if LONG_DOUBLESIZE > DOUBLESIZE
8833 intsize == 'q' ?
205f51d8
AS
8834 va_arg(*args, long double) :
8835 va_arg(*args, double)
35fff930 8836#else
205f51d8 8837 va_arg(*args, double)
35fff930 8838#endif
9e5b023a 8839 : SvNVx(argsv);
fc36a67e 8840
8841 need = 0;
be75b157 8842 vectorize = FALSE;
fc36a67e 8843 if (c != 'e' && c != 'E') {
8844 i = PERL_INT_MIN;
9e5b023a
JH
8845 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8846 will cast our (long double) to (double) */
73b309ea 8847 (void)Perl_frexp(nv, &i);
fc36a67e 8848 if (i == PERL_INT_MIN)
cea2e8a9 8849 Perl_die(aTHX_ "panic: frexp");
c635e13b 8850 if (i > 0)
fc36a67e 8851 need = BIT_DIGITS(i);
8852 }
8853 need += has_precis ? precis : 6; /* known default */
20f6aaab 8854
fc36a67e 8855 if (need < width)
8856 need = width;
8857
20f6aaab
AS
8858#ifdef HAS_LDBL_SPRINTF_BUG
8859 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
205f51d8
AS
8860 with sfio - Allen <allens@cpan.org> */
8861
8862# ifdef DBL_MAX
8863# define MY_DBL_MAX DBL_MAX
8864# else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8865# if DOUBLESIZE >= 8
8866# define MY_DBL_MAX 1.7976931348623157E+308L
8867# else
8868# define MY_DBL_MAX 3.40282347E+38L
8869# endif
8870# endif
8871
8872# ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8873# define MY_DBL_MAX_BUG 1L
20f6aaab 8874# else
205f51d8 8875# define MY_DBL_MAX_BUG MY_DBL_MAX
20f6aaab 8876# endif
20f6aaab 8877
205f51d8
AS
8878# ifdef DBL_MIN
8879# define MY_DBL_MIN DBL_MIN
8880# else /* XXX guessing! -Allen */
8881# if DOUBLESIZE >= 8
8882# define MY_DBL_MIN 2.2250738585072014E-308L
8883# else
8884# define MY_DBL_MIN 1.17549435E-38L
8885# endif
8886# endif
20f6aaab 8887
205f51d8
AS
8888 if ((intsize == 'q') && (c == 'f') &&
8889 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8890 (need < DBL_DIG)) {
8891 /* it's going to be short enough that
8892 * long double precision is not needed */
8893
8894 if ((nv <= 0L) && (nv >= -0L))
8895 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8896 else {
8897 /* would use Perl_fp_class as a double-check but not
8898 * functional on IRIX - see perl.h comments */
8899
8900 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8901 /* It's within the range that a double can represent */
8902#if defined(DBL_MAX) && !defined(DBL_MIN)
8903 if ((nv >= ((long double)1/DBL_MAX)) ||
8904 (nv <= (-(long double)1/DBL_MAX)))
20f6aaab 8905#endif
205f51d8 8906 fix_ldbl_sprintf_bug = TRUE;
20f6aaab 8907 }
205f51d8
AS
8908 }
8909 if (fix_ldbl_sprintf_bug == TRUE) {
8910 double temp;
8911
8912 intsize = 0;
8913 temp = (double)nv;
8914 nv = (NV)temp;
8915 }
20f6aaab 8916 }
205f51d8
AS
8917
8918# undef MY_DBL_MAX
8919# undef MY_DBL_MAX_BUG
8920# undef MY_DBL_MIN
8921
20f6aaab
AS
8922#endif /* HAS_LDBL_SPRINTF_BUG */
8923
46fc3d4c 8924 need += 20; /* fudge factor */
80252599
GS
8925 if (PL_efloatsize < need) {
8926 Safefree(PL_efloatbuf);
8927 PL_efloatsize = need + 20; /* more fudge */
8928 New(906, PL_efloatbuf, PL_efloatsize, char);
7d5ea4e7 8929 PL_efloatbuf[0] = '\0';
46fc3d4c 8930 }
8931
8932 eptr = ebuf + sizeof ebuf;
8933 *--eptr = '\0';
8934 *--eptr = c;
9e5b023a
JH
8935 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8936#if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8937 if (intsize == 'q') {
e5c81feb
JH
8938 /* Copy the one or more characters in a long double
8939 * format before the 'base' ([efgEFG]) character to
8940 * the format string. */
8941 static char const prifldbl[] = PERL_PRIfldbl;
8942 char const *p = prifldbl + sizeof(prifldbl) - 3;
8943 while (p >= prifldbl) { *--eptr = *p--; }
cf2093f6 8944 }
65202027 8945#endif
46fc3d4c 8946 if (has_precis) {
8947 base = precis;
8948 do { *--eptr = '0' + (base % 10); } while (base /= 10);
8949 *--eptr = '.';
8950 }
8951 if (width) {
8952 base = width;
8953 do { *--eptr = '0' + (base % 10); } while (base /= 10);
8954 }
8955 if (fill == '0')
8956 *--eptr = fill;
84902520
TB
8957 if (left)
8958 *--eptr = '-';
46fc3d4c 8959 if (plus)
8960 *--eptr = plus;
8961 if (alt)
8962 *--eptr = '#';
8963 *--eptr = '%';
8964
ff9121f8
JH
8965 /* No taint. Otherwise we are in the strange situation
8966 * where printf() taints but print($float) doesn't.
bda0f7a5 8967 * --jhi */
9e5b023a
JH
8968#if defined(HAS_LONG_DOUBLE)
8969 if (intsize == 'q')
8970 (void)sprintf(PL_efloatbuf, eptr, nv);
8971 else
8972 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
8973#else
dd8482fc 8974 (void)sprintf(PL_efloatbuf, eptr, nv);
9e5b023a 8975#endif
80252599
GS
8976 eptr = PL_efloatbuf;
8977 elen = strlen(PL_efloatbuf);
46fc3d4c 8978 break;
8979
fc36a67e 8980 /* SPECIAL */
8981
8982 case 'n':
8983 i = SvCUR(sv) - origlen;
be75b157 8984 if (args && !vectorize) {
c635e13b 8985 switch (intsize) {
8986 case 'h': *(va_arg(*args, short*)) = i; break;
8987 default: *(va_arg(*args, int*)) = i; break;
8988 case 'l': *(va_arg(*args, long*)) = i; break;
8989 case 'V': *(va_arg(*args, IV*)) = i; break;
cf2093f6
JH
8990#ifdef HAS_QUAD
8991 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8992#endif
c635e13b 8993 }
fc36a67e 8994 }
9dd79c3f 8995 else
211dfcf1 8996 sv_setuv_mg(argsv, (UV)i);
be75b157 8997 vectorize = FALSE;
fc36a67e 8998 continue; /* not "break" */
8999
9000 /* UNKNOWN */
9001
46fc3d4c 9002 default:
fc36a67e 9003 unknown:
b22c7a20 9004 vectorize = FALSE;
599cee73 9005 if (!args && ckWARN(WARN_PRINTF) &&
533c011a 9006 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
c635e13b 9007 SV *msg = sv_newmortal();
35c1215d
NC
9008 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9009 (PL_op->op_type == OP_PRTF) ? "" : "s");
0f4b6630 9010 if (c) {
0f4b6630 9011 if (isPRINT(c))
1c846c1f 9012 Perl_sv_catpvf(aTHX_ msg,
0f4b6630
JH
9013 "\"%%%c\"", c & 0xFF);
9014 else
9015 Perl_sv_catpvf(aTHX_ msg,
57def98f 9016 "\"%%\\%03"UVof"\"",
0f4b6630 9017 (UV)c & 0xFF);
0f4b6630 9018 } else
c635e13b 9019 sv_catpv(msg, "end of string");
9014280d 9020 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
c635e13b 9021 }
fb73857a 9022
9023 /* output mangled stuff ... */
9024 if (c == '\0')
9025 --q;
46fc3d4c 9026 eptr = p;
9027 elen = q - p;
fb73857a 9028
9029 /* ... right here, because formatting flags should not apply */
9030 SvGROW(sv, SvCUR(sv) + elen + 1);
9031 p = SvEND(sv);
4459522c 9032 Copy(eptr, p, elen, char);
fb73857a 9033 p += elen;
9034 *p = '\0';
9035 SvCUR(sv) = p - SvPVX(sv);
9036 continue; /* not "break" */
46fc3d4c 9037 }
9038
d2876be5
JH
9039 if (is_utf8 != has_utf8) {
9040 if (is_utf8) {
9041 if (SvCUR(sv))
9042 sv_utf8_upgrade(sv);
9043 }
9044 else {
9045 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
9046 sv_utf8_upgrade(nsv);
9047 eptr = SvPVX(nsv);
9048 elen = SvCUR(nsv);
9049 }
9050 SvGROW(sv, SvCUR(sv) + elen + 1);
9051 p = SvEND(sv);
9052 *p = '\0';
9053 }
9054
fc36a67e 9055 have = esignlen + zeros + elen;
46fc3d4c 9056 need = (have > width ? have : width);
9057 gap = need - have;
9058
b22c7a20 9059 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
46fc3d4c 9060 p = SvEND(sv);
9061 if (esignlen && fill == '0') {
eb160463 9062 for (i = 0; i < (int)esignlen; i++)
46fc3d4c 9063 *p++ = esignbuf[i];
9064 }
9065 if (gap && !left) {
9066 memset(p, fill, gap);
9067 p += gap;
9068 }
9069 if (esignlen && fill != '0') {
eb160463 9070 for (i = 0; i < (int)esignlen; i++)
46fc3d4c 9071 *p++ = esignbuf[i];
9072 }
fc36a67e 9073 if (zeros) {
9074 for (i = zeros; i; i--)
9075 *p++ = '0';
9076 }
46fc3d4c 9077 if (elen) {
4459522c 9078 Copy(eptr, p, elen, char);
46fc3d4c 9079 p += elen;
9080 }
9081 if (gap && left) {
9082 memset(p, ' ', gap);
9083 p += gap;
9084 }
b22c7a20
GS
9085 if (vectorize) {
9086 if (veclen) {
4459522c 9087 Copy(dotstr, p, dotstrlen, char);
b22c7a20
GS
9088 p += dotstrlen;
9089 }
9090 else
9091 vectorize = FALSE; /* done iterating over vecstr */
9092 }
2cf2cfc6
A
9093 if (is_utf8)
9094 has_utf8 = TRUE;
9095 if (has_utf8)
7e2040f0 9096 SvUTF8_on(sv);
46fc3d4c 9097 *p = '\0';
9098 SvCUR(sv) = p - SvPVX(sv);
b22c7a20
GS
9099 if (vectorize) {
9100 esignlen = 0;
9101 goto vector;
9102 }
46fc3d4c 9103 }
9104}
51371543 9105
645c22ef
DM
9106/* =========================================================================
9107
9108=head1 Cloning an interpreter
9109
9110All the macros and functions in this section are for the private use of
9111the main function, perl_clone().
9112
9113The foo_dup() functions make an exact copy of an existing foo thinngy.
9114During the course of a cloning, a hash table is used to map old addresses
9115to new addresses. The table is created and manipulated with the
9116ptr_table_* functions.
9117
9118=cut
9119
9120============================================================================*/
9121
9122
1d7c1841
GS
9123#if defined(USE_ITHREADS)
9124
1d7c1841
GS
9125#ifndef GpREFCNT_inc
9126# define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9127#endif
9128
9129
d2d73c3e
AB
9130#define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9131#define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9132#define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9133#define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9134#define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9135#define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9136#define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9137#define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9138#define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9139#define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9140#define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
1d7c1841
GS
9141#define SAVEPV(p) (p ? savepv(p) : Nullch)
9142#define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8cf8f3d1 9143
d2d73c3e 9144
d2f185dc
AMS
9145/* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9146 regcomp.c. AMS 20010712 */
645c22ef 9147
1d7c1841 9148REGEXP *
a8fc9800 9149Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
1d7c1841 9150{
d2f185dc
AMS
9151 REGEXP *ret;
9152 int i, len, npar;
9153 struct reg_substr_datum *s;
9154
9155 if (!r)
9156 return (REGEXP *)NULL;
9157
9158 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9159 return ret;
9160
9161 len = r->offsets[0];
9162 npar = r->nparens+1;
9163
9164 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9165 Copy(r->program, ret->program, len+1, regnode);
9166
9167 New(0, ret->startp, npar, I32);
9168 Copy(r->startp, ret->startp, npar, I32);
9169 New(0, ret->endp, npar, I32);
9170 Copy(r->startp, ret->startp, npar, I32);
9171
d2f185dc
AMS
9172 New(0, ret->substrs, 1, struct reg_substr_data);
9173 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9174 s->min_offset = r->substrs->data[i].min_offset;
9175 s->max_offset = r->substrs->data[i].max_offset;
9176 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
33b8afdf 9177 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
d2f185dc
AMS
9178 }
9179
70612e96 9180 ret->regstclass = NULL;
d2f185dc
AMS
9181 if (r->data) {
9182 struct reg_data *d;
9183 int count = r->data->count;
9184
9185 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
9186 char, struct reg_data);
9187 New(0, d->what, count, U8);
9188
9189 d->count = count;
9190 for (i = 0; i < count; i++) {
9191 d->what[i] = r->data->what[i];
9192 switch (d->what[i]) {
9193 case 's':
9194 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9195 break;
9196 case 'p':
9197 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9198 break;
9199 case 'f':
9200 /* This is cheating. */
9201 New(0, d->data[i], 1, struct regnode_charclass_class);
9202 StructCopy(r->data->data[i], d->data[i],
9203 struct regnode_charclass_class);
70612e96 9204 ret->regstclass = (regnode*)d->data[i];
d2f185dc
AMS
9205 break;
9206 case 'o':
33773810
AMS
9207 /* Compiled op trees are readonly, and can thus be
9208 shared without duplication. */
9b978d73
DM
9209 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9210 break;
d2f185dc
AMS
9211 case 'n':
9212 d->data[i] = r->data->data[i];
9213 break;
9214 }
9215 }
9216
9217 ret->data = d;
9218 }
9219 else
9220 ret->data = NULL;
9221
9222 New(0, ret->offsets, 2*len+1, U32);
9223 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9224
9225 ret->precomp = SAVEPV(r->precomp);
d2f185dc
AMS
9226 ret->refcnt = r->refcnt;
9227 ret->minlen = r->minlen;
9228 ret->prelen = r->prelen;
9229 ret->nparens = r->nparens;
9230 ret->lastparen = r->lastparen;
9231 ret->lastcloseparen = r->lastcloseparen;
9232 ret->reganch = r->reganch;
9233
70612e96
RG
9234 ret->sublen = r->sublen;
9235
9236 if (RX_MATCH_COPIED(ret))
9237 ret->subbeg = SAVEPV(r->subbeg);
9238 else
9239 ret->subbeg = Nullch;
9240
d2f185dc
AMS
9241 ptr_table_store(PL_ptr_table, r, ret);
9242 return ret;
1d7c1841
GS
9243}
9244
d2d73c3e 9245/* duplicate a file handle */
645c22ef 9246
1d7c1841 9247PerlIO *
a8fc9800 9248Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
1d7c1841
GS
9249{
9250 PerlIO *ret;
9251 if (!fp)
9252 return (PerlIO*)NULL;
9253
9254 /* look for it in the table first */
9255 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9256 if (ret)
9257 return ret;
9258
9259 /* create anew and remember what it is */
ecdeb87c 9260 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
1d7c1841
GS
9261 ptr_table_store(PL_ptr_table, fp, ret);
9262 return ret;
9263}
9264
645c22ef
DM
9265/* duplicate a directory handle */
9266
1d7c1841
GS
9267DIR *
9268Perl_dirp_dup(pTHX_ DIR *dp)
9269{
9270 if (!dp)
9271 return (DIR*)NULL;
9272 /* XXX TODO */
9273 return dp;
9274}
9275
ff276b08 9276/* duplicate a typeglob */
645c22ef 9277
1d7c1841 9278GP *
a8fc9800 9279Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
1d7c1841
GS
9280{
9281 GP *ret;
9282 if (!gp)
9283 return (GP*)NULL;
9284 /* look for it in the table first */
9285 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9286 if (ret)
9287 return ret;
9288
9289 /* create anew and remember what it is */
9290 Newz(0, ret, 1, GP);
9291 ptr_table_store(PL_ptr_table, gp, ret);
9292
9293 /* clone */
9294 ret->gp_refcnt = 0; /* must be before any other dups! */
d2d73c3e
AB
9295 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9296 ret->gp_io = io_dup_inc(gp->gp_io, param);
9297 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9298 ret->gp_av = av_dup_inc(gp->gp_av, param);
9299 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9300 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9301 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
1d7c1841
GS
9302 ret->gp_cvgen = gp->gp_cvgen;
9303 ret->gp_flags = gp->gp_flags;
9304 ret->gp_line = gp->gp_line;
9305 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9306 return ret;
9307}
9308
645c22ef
DM
9309/* duplicate a chain of magic */
9310
1d7c1841 9311MAGIC *
a8fc9800 9312Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
1d7c1841 9313{
cb359b41
JH
9314 MAGIC *mgprev = (MAGIC*)NULL;
9315 MAGIC *mgret;
1d7c1841
GS
9316 if (!mg)
9317 return (MAGIC*)NULL;
9318 /* look for it in the table first */
9319 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9320 if (mgret)
9321 return mgret;
9322
9323 for (; mg; mg = mg->mg_moremagic) {
9324 MAGIC *nmg;
9325 Newz(0, nmg, 1, MAGIC);
cb359b41 9326 if (mgprev)
1d7c1841 9327 mgprev->mg_moremagic = nmg;
cb359b41
JH
9328 else
9329 mgret = nmg;
1d7c1841
GS
9330 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9331 nmg->mg_private = mg->mg_private;
9332 nmg->mg_type = mg->mg_type;
9333 nmg->mg_flags = mg->mg_flags;
14befaf4 9334 if (mg->mg_type == PERL_MAGIC_qr) {
d2f185dc 9335 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
1d7c1841 9336 }
05bd4103
JH
9337 else if(mg->mg_type == PERL_MAGIC_backref) {
9338 AV *av = (AV*) mg->mg_obj;
9339 SV **svp;
9340 I32 i;
9341 nmg->mg_obj = (SV*)newAV();
9342 svp = AvARRAY(av);
9343 i = AvFILLp(av);
9344 while (i >= 0) {
9345 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9346 i--;
9347 }
9348 }
1d7c1841
GS
9349 else {
9350 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
d2d73c3e
AB
9351 ? sv_dup_inc(mg->mg_obj, param)
9352 : sv_dup(mg->mg_obj, param);
1d7c1841
GS
9353 }
9354 nmg->mg_len = mg->mg_len;
9355 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
14befaf4 9356 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
68795e93 9357 if (mg->mg_len > 0) {
1d7c1841 9358 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
14befaf4
DM
9359 if (mg->mg_type == PERL_MAGIC_overload_table &&
9360 AMT_AMAGIC((AMT*)mg->mg_ptr))
9361 {
1d7c1841
GS
9362 AMT *amtp = (AMT*)mg->mg_ptr;
9363 AMT *namtp = (AMT*)nmg->mg_ptr;
9364 I32 i;
9365 for (i = 1; i < NofAMmeth; i++) {
d2d73c3e 9366 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
1d7c1841
GS
9367 }
9368 }
9369 }
9370 else if (mg->mg_len == HEf_SVKEY)
d2d73c3e 9371 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
1d7c1841 9372 }
68795e93
NIS
9373 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9374 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9375 }
1d7c1841
GS
9376 mgprev = nmg;
9377 }
9378 return mgret;
9379}
9380
645c22ef
DM
9381/* create a new pointer-mapping table */
9382
1d7c1841
GS
9383PTR_TBL_t *
9384Perl_ptr_table_new(pTHX)
9385{
9386 PTR_TBL_t *tbl;
9387 Newz(0, tbl, 1, PTR_TBL_t);
9388 tbl->tbl_max = 511;
9389 tbl->tbl_items = 0;
9390 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9391 return tbl;
9392}
9393
645c22ef
DM
9394/* map an existing pointer using a table */
9395
1d7c1841
GS
9396void *
9397Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
9398{
9399 PTR_TBL_ENT_t *tblent;
d2a79402 9400 UV hash = PTR2UV(sv);
1d7c1841
GS
9401 assert(tbl);
9402 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9403 for (; tblent; tblent = tblent->next) {
9404 if (tblent->oldval == sv)
9405 return tblent->newval;
9406 }
9407 return (void*)NULL;
9408}
9409
645c22ef
DM
9410/* add a new entry to a pointer-mapping table */
9411
1d7c1841
GS
9412void
9413Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
9414{
9415 PTR_TBL_ENT_t *tblent, **otblent;
9416 /* XXX this may be pessimal on platforms where pointers aren't good
9417 * hash values e.g. if they grow faster in the most significant
9418 * bits */
d2a79402 9419 UV hash = PTR2UV(oldv);
1d7c1841
GS
9420 bool i = 1;
9421
9422 assert(tbl);
9423 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9424 for (tblent = *otblent; tblent; i=0, tblent = tblent->next) {
9425 if (tblent->oldval == oldv) {
9426 tblent->newval = newv;
1d7c1841
GS
9427 return;
9428 }
9429 }
9430 Newz(0, tblent, 1, PTR_TBL_ENT_t);
9431 tblent->oldval = oldv;
9432 tblent->newval = newv;
9433 tblent->next = *otblent;
9434 *otblent = tblent;
9435 tbl->tbl_items++;
9436 if (i && tbl->tbl_items > tbl->tbl_max)
9437 ptr_table_split(tbl);
9438}
9439
645c22ef
DM
9440/* double the hash bucket size of an existing ptr table */
9441
1d7c1841
GS
9442void
9443Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9444{
9445 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9446 UV oldsize = tbl->tbl_max + 1;
9447 UV newsize = oldsize * 2;
9448 UV i;
9449
9450 Renew(ary, newsize, PTR_TBL_ENT_t*);
9451 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9452 tbl->tbl_max = --newsize;
9453 tbl->tbl_ary = ary;
9454 for (i=0; i < oldsize; i++, ary++) {
9455 PTR_TBL_ENT_t **curentp, **entp, *ent;
9456 if (!*ary)
9457 continue;
9458 curentp = ary + oldsize;
9459 for (entp = ary, ent = *ary; ent; ent = *entp) {
d2a79402 9460 if ((newsize & PTR2UV(ent->oldval)) != i) {
1d7c1841
GS
9461 *entp = ent->next;
9462 ent->next = *curentp;
9463 *curentp = ent;
9464 continue;
9465 }
9466 else
9467 entp = &ent->next;
9468 }
9469 }
9470}
9471
645c22ef
DM
9472/* remove all the entries from a ptr table */
9473
a0739874
DM
9474void
9475Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9476{
9477 register PTR_TBL_ENT_t **array;
9478 register PTR_TBL_ENT_t *entry;
9479 register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
9480 UV riter = 0;
9481 UV max;
9482
9483 if (!tbl || !tbl->tbl_items) {
9484 return;
9485 }
9486
9487 array = tbl->tbl_ary;
9488 entry = array[0];
9489 max = tbl->tbl_max;
9490
9491 for (;;) {
9492 if (entry) {
9493 oentry = entry;
9494 entry = entry->next;
9495 Safefree(oentry);
9496 }
9497 if (!entry) {
9498 if (++riter > max) {
9499 break;
9500 }
9501 entry = array[riter];
9502 }
9503 }
9504
9505 tbl->tbl_items = 0;
9506}
9507
645c22ef
DM
9508/* clear and free a ptr table */
9509
a0739874
DM
9510void
9511Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9512{
9513 if (!tbl) {
9514 return;
9515 }
9516 ptr_table_clear(tbl);
9517 Safefree(tbl->tbl_ary);
9518 Safefree(tbl);
9519}
9520
1d7c1841
GS
9521#ifdef DEBUGGING
9522char *PL_watch_pvx;
9523#endif
9524
645c22ef
DM
9525/* attempt to make everything in the typeglob readonly */
9526
5bd07a3d 9527STATIC SV *
59b40662 9528S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
5bd07a3d
DM
9529{
9530 GV *gv = (GV*)sstr;
59b40662 9531 SV *sv = &param->proto_perl->Isv_no; /* just need SvREADONLY-ness */
5bd07a3d
DM
9532
9533 if (GvIO(gv) || GvFORM(gv)) {
7fb37951 9534 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
5bd07a3d
DM
9535 }
9536 else if (!GvCV(gv)) {
9537 GvCV(gv) = (CV*)sv;
9538 }
9539 else {
9540 /* CvPADLISTs cannot be shared */
37e20706 9541 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
7fb37951 9542 GvUNIQUE_off(gv);
5bd07a3d
DM
9543 }
9544 }
9545
7fb37951 9546 if (!GvUNIQUE(gv)) {
5bd07a3d
DM
9547#if 0
9548 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
9549 HvNAME(GvSTASH(gv)), GvNAME(gv));
9550#endif
9551 return Nullsv;
9552 }
9553
4411f3b6 9554 /*
5bd07a3d
DM
9555 * write attempts will die with
9556 * "Modification of a read-only value attempted"
9557 */
9558 if (!GvSV(gv)) {
9559 GvSV(gv) = sv;
9560 }
9561 else {
9562 SvREADONLY_on(GvSV(gv));
9563 }
9564
9565 if (!GvAV(gv)) {
9566 GvAV(gv) = (AV*)sv;
9567 }
9568 else {
9569 SvREADONLY_on(GvAV(gv));
9570 }
9571
9572 if (!GvHV(gv)) {
9573 GvHV(gv) = (HV*)sv;
9574 }
9575 else {
9576 SvREADONLY_on(GvAV(gv));
9577 }
9578
9579 return sstr; /* he_dup() will SvREFCNT_inc() */
9580}
9581
645c22ef
DM
9582/* duplicate an SV of any type (including AV, HV etc) */
9583
83841fad
NIS
9584void
9585Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9586{
9587 if (SvROK(sstr)) {
d3d0e6f1 9588 SvRV(dstr) = SvWEAKREF(sstr)
83841fad
NIS
9589 ? sv_dup(SvRV(sstr), param)
9590 : sv_dup_inc(SvRV(sstr), param);
9591 }
9592 else if (SvPVX(sstr)) {
9593 /* Has something there */
9594 if (SvLEN(sstr)) {
68795e93 9595 /* Normal PV - clone whole allocated space */
83841fad 9596 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
d3d0e6f1
NC
9597 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9598 /* Not that normal - actually sstr is copy on write.
9599 But we are a true, independant SV, so: */
9600 SvREADONLY_off(dstr);
9601 SvFAKE_off(dstr);
9602 }
68795e93 9603 }
83841fad
NIS
9604 else {
9605 /* Special case - not normally malloced for some reason */
9606 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9607 /* A "shared" PV - clone it as unshared string */
9608 SvFAKE_off(dstr);
9609 SvREADONLY_off(dstr);
9610 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
9611 }
9612 else {
9613 /* Some other special case - random pointer */
9614 SvPVX(dstr) = SvPVX(sstr);
d3d0e6f1 9615 }
83841fad
NIS
9616 }
9617 }
9618 else {
9619 /* Copy the Null */
9620 SvPVX(dstr) = SvPVX(sstr);
9621 }
9622}
9623
1d7c1841 9624SV *
a8fc9800 9625Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
1d7c1841 9626{
1d7c1841
GS
9627 SV *dstr;
9628
9629 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9630 return Nullsv;
9631 /* look for it in the table first */
9632 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9633 if (dstr)
9634 return dstr;
9635
0405e91e
AB
9636 if(param->flags & CLONEf_JOIN_IN) {
9637 /** We are joining here so we don't want do clone
9638 something that is bad **/
9639
9640 if(SvTYPE(sstr) == SVt_PVHV &&
9641 HvNAME(sstr)) {
9642 /** don't clone stashes if they already exist **/
9643 HV* old_stash = gv_stashpv(HvNAME(sstr),0);
9644 return (SV*) old_stash;
9645 }
9646 }
9647
1d7c1841
GS
9648 /* create anew and remember what it is */
9649 new_SV(dstr);
9650 ptr_table_store(PL_ptr_table, sstr, dstr);
9651
9652 /* clone */
9653 SvFLAGS(dstr) = SvFLAGS(sstr);
9654 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9655 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9656
9657#ifdef DEBUGGING
9658 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
9659 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9660 PL_watch_pvx, SvPVX(sstr));
9661#endif
9662
9663 switch (SvTYPE(sstr)) {
9664 case SVt_NULL:
9665 SvANY(dstr) = NULL;
9666 break;
9667 case SVt_IV:
9668 SvANY(dstr) = new_XIV();
9669 SvIVX(dstr) = SvIVX(sstr);
9670 break;
9671 case SVt_NV:
9672 SvANY(dstr) = new_XNV();
9673 SvNVX(dstr) = SvNVX(sstr);
9674 break;
9675 case SVt_RV:
9676 SvANY(dstr) = new_XRV();
83841fad 9677 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
9678 break;
9679 case SVt_PV:
9680 SvANY(dstr) = new_XPV();
9681 SvCUR(dstr) = SvCUR(sstr);
9682 SvLEN(dstr) = SvLEN(sstr);
83841fad 9683 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
9684 break;
9685 case SVt_PVIV:
9686 SvANY(dstr) = new_XPVIV();
9687 SvCUR(dstr) = SvCUR(sstr);
9688 SvLEN(dstr) = SvLEN(sstr);
9689 SvIVX(dstr) = SvIVX(sstr);
83841fad 9690 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
9691 break;
9692 case SVt_PVNV:
9693 SvANY(dstr) = new_XPVNV();
9694 SvCUR(dstr) = SvCUR(sstr);
9695 SvLEN(dstr) = SvLEN(sstr);
9696 SvIVX(dstr) = SvIVX(sstr);
9697 SvNVX(dstr) = SvNVX(sstr);
83841fad 9698 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
9699 break;
9700 case SVt_PVMG:
9701 SvANY(dstr) = new_XPVMG();
9702 SvCUR(dstr) = SvCUR(sstr);
9703 SvLEN(dstr) = SvLEN(sstr);
9704 SvIVX(dstr) = SvIVX(sstr);
9705 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
9706 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9707 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
83841fad 9708 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
9709 break;
9710 case SVt_PVBM:
9711 SvANY(dstr) = new_XPVBM();
9712 SvCUR(dstr) = SvCUR(sstr);
9713 SvLEN(dstr) = SvLEN(sstr);
9714 SvIVX(dstr) = SvIVX(sstr);
9715 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
9716 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9717 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
83841fad 9718 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
9719 BmRARE(dstr) = BmRARE(sstr);
9720 BmUSEFUL(dstr) = BmUSEFUL(sstr);
9721 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
9722 break;
9723 case SVt_PVLV:
9724 SvANY(dstr) = new_XPVLV();
9725 SvCUR(dstr) = SvCUR(sstr);
9726 SvLEN(dstr) = SvLEN(sstr);
9727 SvIVX(dstr) = SvIVX(sstr);
9728 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
9729 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9730 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
83841fad 9731 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
9732 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
9733 LvTARGLEN(dstr) = LvTARGLEN(sstr);
d2d73c3e 9734 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
1d7c1841
GS
9735 LvTYPE(dstr) = LvTYPE(sstr);
9736 break;
9737 case SVt_PVGV:
7fb37951 9738 if (GvUNIQUE((GV*)sstr)) {
5bd07a3d 9739 SV *share;
59b40662 9740 if ((share = gv_share(sstr, param))) {
5bd07a3d
DM
9741 del_SV(dstr);
9742 dstr = share;
37e20706 9743 ptr_table_store(PL_ptr_table, sstr, dstr);
5bd07a3d
DM
9744#if 0
9745 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
9746 HvNAME(GvSTASH(share)), GvNAME(share));
9747#endif
9748 break;
9749 }
9750 }
1d7c1841
GS
9751 SvANY(dstr) = new_XPVGV();
9752 SvCUR(dstr) = SvCUR(sstr);
9753 SvLEN(dstr) = SvLEN(sstr);
9754 SvIVX(dstr) = SvIVX(sstr);
9755 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
9756 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9757 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
83841fad 9758 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
9759 GvNAMELEN(dstr) = GvNAMELEN(sstr);
9760 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
d2d73c3e 9761 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
1d7c1841 9762 GvFLAGS(dstr) = GvFLAGS(sstr);
d2d73c3e 9763 GvGP(dstr) = gp_dup(GvGP(sstr), param);
1d7c1841
GS
9764 (void)GpREFCNT_inc(GvGP(dstr));
9765 break;
9766 case SVt_PVIO:
9767 SvANY(dstr) = new_XPVIO();
9768 SvCUR(dstr) = SvCUR(sstr);
9769 SvLEN(dstr) = SvLEN(sstr);
9770 SvIVX(dstr) = SvIVX(sstr);
9771 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
9772 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9773 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
83841fad 9774 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
a8fc9800 9775 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
1d7c1841
GS
9776 if (IoOFP(sstr) == IoIFP(sstr))
9777 IoOFP(dstr) = IoIFP(dstr);
9778 else
a8fc9800 9779 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
1d7c1841
GS
9780 /* PL_rsfp_filters entries have fake IoDIRP() */
9781 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
9782 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
9783 else
9784 IoDIRP(dstr) = IoDIRP(sstr);
9785 IoLINES(dstr) = IoLINES(sstr);
9786 IoPAGE(dstr) = IoPAGE(sstr);
9787 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
9788 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
9789 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
d2d73c3e 9790 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
1d7c1841 9791 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
d2d73c3e 9792 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
1d7c1841 9793 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
d2d73c3e 9794 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
1d7c1841
GS
9795 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
9796 IoTYPE(dstr) = IoTYPE(sstr);
9797 IoFLAGS(dstr) = IoFLAGS(sstr);
9798 break;
9799 case SVt_PVAV:
9800 SvANY(dstr) = new_XPVAV();
9801 SvCUR(dstr) = SvCUR(sstr);
9802 SvLEN(dstr) = SvLEN(sstr);
9803 SvIVX(dstr) = SvIVX(sstr);
9804 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
9805 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9806 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9807 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
1d7c1841
GS
9808 AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
9809 if (AvARRAY((AV*)sstr)) {
9810 SV **dst_ary, **src_ary;
9811 SSize_t items = AvFILLp((AV*)sstr) + 1;
9812
9813 src_ary = AvARRAY((AV*)sstr);
9814 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
9815 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9816 SvPVX(dstr) = (char*)dst_ary;
9817 AvALLOC((AV*)dstr) = dst_ary;
9818 if (AvREAL((AV*)sstr)) {
9819 while (items-- > 0)
d2d73c3e 9820 *dst_ary++ = sv_dup_inc(*src_ary++, param);
1d7c1841
GS
9821 }
9822 else {
9823 while (items-- > 0)
d2d73c3e 9824 *dst_ary++ = sv_dup(*src_ary++, param);
1d7c1841
GS
9825 }
9826 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9827 while (items-- > 0) {
9828 *dst_ary++ = &PL_sv_undef;
9829 }
9830 }
9831 else {
9832 SvPVX(dstr) = Nullch;
9833 AvALLOC((AV*)dstr) = (SV**)NULL;
9834 }
9835 break;
9836 case SVt_PVHV:
9837 SvANY(dstr) = new_XPVHV();
9838 SvCUR(dstr) = SvCUR(sstr);
9839 SvLEN(dstr) = SvLEN(sstr);
9840 SvIVX(dstr) = SvIVX(sstr);
9841 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
9842 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9843 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
1d7c1841
GS
9844 HvRITER((HV*)dstr) = HvRITER((HV*)sstr);
9845 if (HvARRAY((HV*)sstr)) {
1d7c1841
GS
9846 STRLEN i = 0;
9847 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
9848 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
9849 Newz(0, dxhv->xhv_array,
9850 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
9851 while (i <= sxhv->xhv_max) {
9852 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
eb160463
GS
9853 (bool)!!HvSHAREKEYS(sstr),
9854 param);
1d7c1841
GS
9855 ++i;
9856 }
eb160463
GS
9857 dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter,
9858 (bool)!!HvSHAREKEYS(sstr), param);
1d7c1841
GS
9859 }
9860 else {
9861 SvPVX(dstr) = Nullch;
9862 HvEITER((HV*)dstr) = (HE*)NULL;
9863 }
9864 HvPMROOT((HV*)dstr) = HvPMROOT((HV*)sstr); /* XXX */
9865 HvNAME((HV*)dstr) = SAVEPV(HvNAME((HV*)sstr));
c43294b8 9866 /* Record stashes for possible cloning in Perl_clone(). */
6676db26 9867 if(HvNAME((HV*)dstr))
d2d73c3e 9868 av_push(param->stashes, dstr);
1d7c1841
GS
9869 break;
9870 case SVt_PVFM:
9871 SvANY(dstr) = new_XPVFM();
9872 FmLINES(dstr) = FmLINES(sstr);
9873 goto dup_pvcv;
9874 /* NOTREACHED */
9875 case SVt_PVCV:
9876 SvANY(dstr) = new_XPVCV();
d2d73c3e 9877 dup_pvcv:
1d7c1841
GS
9878 SvCUR(dstr) = SvCUR(sstr);
9879 SvLEN(dstr) = SvLEN(sstr);
9880 SvIVX(dstr) = SvIVX(sstr);
9881 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
9882 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9883 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
83841fad 9884 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
d2d73c3e 9885 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
1d7c1841
GS
9886 CvSTART(dstr) = CvSTART(sstr);
9887 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
9888 CvXSUB(dstr) = CvXSUB(sstr);
9889 CvXSUBANY(dstr) = CvXSUBANY(sstr);
01485f8b
DM
9890 if (CvCONST(sstr)) {
9891 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
9892 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
9893 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
9894 }
d2d73c3e
AB
9895 CvGV(dstr) = gv_dup(CvGV(sstr), param);
9896 if (param->flags & CLONEf_COPY_STACKS) {
9897 CvDEPTH(dstr) = CvDEPTH(sstr);
9898 } else {
9899 CvDEPTH(dstr) = 0;
9900 }
dd2155a4 9901 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
7dafbf52
DM
9902 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
9903 CvOUTSIDE(dstr) =
9904 CvWEAKOUTSIDE(sstr)
9905 ? cv_dup( CvOUTSIDE(sstr), param)
9906 : cv_dup_inc(CvOUTSIDE(sstr), param);
1d7c1841 9907 CvFLAGS(dstr) = CvFLAGS(sstr);
54356c7d 9908 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
1d7c1841
GS
9909 break;
9910 default:
c803eecc 9911 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
1d7c1841
GS
9912 break;
9913 }
9914
9915 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9916 ++PL_sv_objcount;
9917
9918 return dstr;
d2d73c3e 9919 }
1d7c1841 9920
645c22ef
DM
9921/* duplicate a context */
9922
1d7c1841 9923PERL_CONTEXT *
a8fc9800 9924Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
1d7c1841
GS
9925{
9926 PERL_CONTEXT *ncxs;
9927
9928 if (!cxs)
9929 return (PERL_CONTEXT*)NULL;
9930
9931 /* look for it in the table first */
9932 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9933 if (ncxs)
9934 return ncxs;
9935
9936 /* create anew and remember what it is */
9937 Newz(56, ncxs, max + 1, PERL_CONTEXT);
9938 ptr_table_store(PL_ptr_table, cxs, ncxs);
9939
9940 while (ix >= 0) {
9941 PERL_CONTEXT *cx = &cxs[ix];
9942 PERL_CONTEXT *ncx = &ncxs[ix];
9943 ncx->cx_type = cx->cx_type;
9944 if (CxTYPE(cx) == CXt_SUBST) {
9945 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9946 }
9947 else {
9948 ncx->blk_oldsp = cx->blk_oldsp;
9949 ncx->blk_oldcop = cx->blk_oldcop;
9950 ncx->blk_oldretsp = cx->blk_oldretsp;
9951 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9952 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9953 ncx->blk_oldpm = cx->blk_oldpm;
9954 ncx->blk_gimme = cx->blk_gimme;
9955 switch (CxTYPE(cx)) {
9956 case CXt_SUB:
9957 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
d2d73c3e
AB
9958 ? cv_dup_inc(cx->blk_sub.cv, param)
9959 : cv_dup(cx->blk_sub.cv,param));
1d7c1841 9960 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
d2d73c3e 9961 ? av_dup_inc(cx->blk_sub.argarray, param)
1d7c1841 9962 : Nullav);
d2d73c3e 9963 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
1d7c1841
GS
9964 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9965 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9966 ncx->blk_sub.lval = cx->blk_sub.lval;
9967 break;
9968 case CXt_EVAL:
9969 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9970 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
b47cad08 9971 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
1d7c1841 9972 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
d2d73c3e 9973 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
1d7c1841
GS
9974 break;
9975 case CXt_LOOP:
9976 ncx->blk_loop.label = cx->blk_loop.label;
9977 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9978 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9979 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9980 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9981 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9982 ? cx->blk_loop.iterdata
d2d73c3e 9983 : gv_dup((GV*)cx->blk_loop.iterdata, param));
f3548bdc
DM
9984 ncx->blk_loop.oldcomppad
9985 = (PAD*)ptr_table_fetch(PL_ptr_table,
9986 cx->blk_loop.oldcomppad);
d2d73c3e
AB
9987 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9988 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9989 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
1d7c1841
GS
9990 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9991 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9992 break;
9993 case CXt_FORMAT:
d2d73c3e
AB
9994 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9995 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
9996 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
1d7c1841
GS
9997 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9998 break;
9999 case CXt_BLOCK:
10000 case CXt_NULL:
10001 break;
10002 }
10003 }
10004 --ix;
10005 }
10006 return ncxs;
10007}
10008
645c22ef
DM
10009/* duplicate a stack info structure */
10010
1d7c1841 10011PERL_SI *
a8fc9800 10012Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
1d7c1841
GS
10013{
10014 PERL_SI *nsi;
10015
10016 if (!si)
10017 return (PERL_SI*)NULL;
10018
10019 /* look for it in the table first */
10020 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10021 if (nsi)
10022 return nsi;
10023
10024 /* create anew and remember what it is */
10025 Newz(56, nsi, 1, PERL_SI);
10026 ptr_table_store(PL_ptr_table, si, nsi);
10027
d2d73c3e 10028 nsi->si_stack = av_dup_inc(si->si_stack, param);
1d7c1841
GS
10029 nsi->si_cxix = si->si_cxix;
10030 nsi->si_cxmax = si->si_cxmax;
d2d73c3e 10031 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
1d7c1841 10032 nsi->si_type = si->si_type;
d2d73c3e
AB
10033 nsi->si_prev = si_dup(si->si_prev, param);
10034 nsi->si_next = si_dup(si->si_next, param);
1d7c1841
GS
10035 nsi->si_markoff = si->si_markoff;
10036
10037 return nsi;
10038}
10039
10040#define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10041#define TOPINT(ss,ix) ((ss)[ix].any_i32)
10042#define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10043#define TOPLONG(ss,ix) ((ss)[ix].any_long)
10044#define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10045#define TOPIV(ss,ix) ((ss)[ix].any_iv)
38d8b13e
HS
10046#define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10047#define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
1d7c1841
GS
10048#define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10049#define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10050#define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10051#define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10052#define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10053#define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10054
10055/* XXXXX todo */
10056#define pv_dup_inc(p) SAVEPV(p)
10057#define pv_dup(p) SAVEPV(p)
10058#define svp_dup_inc(p,pp) any_dup(p,pp)
10059
645c22ef
DM
10060/* map any object to the new equivent - either something in the
10061 * ptr table, or something in the interpreter structure
10062 */
10063
1d7c1841
GS
10064void *
10065Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
10066{
10067 void *ret;
10068
10069 if (!v)
10070 return (void*)NULL;
10071
10072 /* look for it in the table first */
10073 ret = ptr_table_fetch(PL_ptr_table, v);
10074 if (ret)
10075 return ret;
10076
10077 /* see if it is part of the interpreter structure */
10078 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
acfe0abc 10079 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
05ec9bb3 10080 else {
1d7c1841 10081 ret = v;
05ec9bb3 10082 }
1d7c1841
GS
10083
10084 return ret;
10085}
10086
645c22ef
DM
10087/* duplicate the save stack */
10088
1d7c1841 10089ANY *
a8fc9800 10090Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
1d7c1841
GS
10091{
10092 ANY *ss = proto_perl->Tsavestack;
10093 I32 ix = proto_perl->Tsavestack_ix;
10094 I32 max = proto_perl->Tsavestack_max;
10095 ANY *nss;
10096 SV *sv;
10097 GV *gv;
10098 AV *av;
10099 HV *hv;
10100 void* ptr;
10101 int intval;
10102 long longval;
10103 GP *gp;
10104 IV iv;
10105 I32 i;
c4e33207 10106 char *c = NULL;
1d7c1841 10107 void (*dptr) (void*);
acfe0abc 10108 void (*dxptr) (pTHX_ void*);
e977893f 10109 OP *o;
1d7c1841
GS
10110
10111 Newz(54, nss, max, ANY);
10112
10113 while (ix > 0) {
10114 i = POPINT(ss,ix);
10115 TOPINT(nss,ix) = i;
10116 switch (i) {
10117 case SAVEt_ITEM: /* normal string */
10118 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 10119 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841 10120 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 10121 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841
GS
10122 break;
10123 case SAVEt_SV: /* scalar reference */
10124 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 10125 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841 10126 gv = (GV*)POPPTR(ss,ix);
d2d73c3e 10127 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
1d7c1841 10128 break;
f4dd75d9
GS
10129 case SAVEt_GENERIC_PVREF: /* generic char* */
10130 c = (char*)POPPTR(ss,ix);
10131 TOPPTR(nss,ix) = pv_dup(c);
10132 ptr = POPPTR(ss,ix);
10133 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10134 break;
05ec9bb3
NIS
10135 case SAVEt_SHARED_PVREF: /* char* in shared space */
10136 c = (char*)POPPTR(ss,ix);
10137 TOPPTR(nss,ix) = savesharedpv(c);
10138 ptr = POPPTR(ss,ix);
10139 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10140 break;
1d7c1841
GS
10141 case SAVEt_GENERIC_SVREF: /* generic sv */
10142 case SAVEt_SVREF: /* scalar reference */
10143 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 10144 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841
GS
10145 ptr = POPPTR(ss,ix);
10146 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10147 break;
10148 case SAVEt_AV: /* array reference */
10149 av = (AV*)POPPTR(ss,ix);
d2d73c3e 10150 TOPPTR(nss,ix) = av_dup_inc(av, param);
1d7c1841 10151 gv = (GV*)POPPTR(ss,ix);
d2d73c3e 10152 TOPPTR(nss,ix) = gv_dup(gv, param);
1d7c1841
GS
10153 break;
10154 case SAVEt_HV: /* hash reference */
10155 hv = (HV*)POPPTR(ss,ix);
d2d73c3e 10156 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
1d7c1841 10157 gv = (GV*)POPPTR(ss,ix);
d2d73c3e 10158 TOPPTR(nss,ix) = gv_dup(gv, param);
1d7c1841
GS
10159 break;
10160 case SAVEt_INT: /* int reference */
10161 ptr = POPPTR(ss,ix);
10162 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10163 intval = (int)POPINT(ss,ix);
10164 TOPINT(nss,ix) = intval;
10165 break;
10166 case SAVEt_LONG: /* long reference */
10167 ptr = POPPTR(ss,ix);
10168 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10169 longval = (long)POPLONG(ss,ix);
10170 TOPLONG(nss,ix) = longval;
10171 break;
10172 case SAVEt_I32: /* I32 reference */
10173 case SAVEt_I16: /* I16 reference */
10174 case SAVEt_I8: /* I8 reference */
10175 ptr = POPPTR(ss,ix);
10176 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10177 i = POPINT(ss,ix);
10178 TOPINT(nss,ix) = i;
10179 break;
10180 case SAVEt_IV: /* IV reference */
10181 ptr = POPPTR(ss,ix);
10182 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10183 iv = POPIV(ss,ix);
10184 TOPIV(nss,ix) = iv;
10185 break;
10186 case SAVEt_SPTR: /* SV* reference */
10187 ptr = POPPTR(ss,ix);
10188 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10189 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 10190 TOPPTR(nss,ix) = sv_dup(sv, param);
1d7c1841
GS
10191 break;
10192 case SAVEt_VPTR: /* random* reference */
10193 ptr = POPPTR(ss,ix);
10194 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10195 ptr = POPPTR(ss,ix);
10196 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10197 break;
10198 case SAVEt_PPTR: /* char* reference */
10199 ptr = POPPTR(ss,ix);
10200 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10201 c = (char*)POPPTR(ss,ix);
10202 TOPPTR(nss,ix) = pv_dup(c);
10203 break;
10204 case SAVEt_HPTR: /* HV* reference */
10205 ptr = POPPTR(ss,ix);
10206 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10207 hv = (HV*)POPPTR(ss,ix);
d2d73c3e 10208 TOPPTR(nss,ix) = hv_dup(hv, param);
1d7c1841
GS
10209 break;
10210 case SAVEt_APTR: /* AV* reference */
10211 ptr = POPPTR(ss,ix);
10212 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10213 av = (AV*)POPPTR(ss,ix);
d2d73c3e 10214 TOPPTR(nss,ix) = av_dup(av, param);
1d7c1841
GS
10215 break;
10216 case SAVEt_NSTAB:
10217 gv = (GV*)POPPTR(ss,ix);
d2d73c3e 10218 TOPPTR(nss,ix) = gv_dup(gv, param);
1d7c1841
GS
10219 break;
10220 case SAVEt_GP: /* scalar reference */
10221 gp = (GP*)POPPTR(ss,ix);
d2d73c3e 10222 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
1d7c1841
GS
10223 (void)GpREFCNT_inc(gp);
10224 gv = (GV*)POPPTR(ss,ix);
2ed3c8fc 10225 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
1d7c1841
GS
10226 c = (char*)POPPTR(ss,ix);
10227 TOPPTR(nss,ix) = pv_dup(c);
10228 iv = POPIV(ss,ix);
10229 TOPIV(nss,ix) = iv;
10230 iv = POPIV(ss,ix);
10231 TOPIV(nss,ix) = iv;
10232 break;
10233 case SAVEt_FREESV:
26d9b02f 10234 case SAVEt_MORTALIZESV:
1d7c1841 10235 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 10236 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841
GS
10237 break;
10238 case SAVEt_FREEOP:
10239 ptr = POPPTR(ss,ix);
10240 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10241 /* these are assumed to be refcounted properly */
10242 switch (((OP*)ptr)->op_type) {
10243 case OP_LEAVESUB:
10244 case OP_LEAVESUBLV:
10245 case OP_LEAVEEVAL:
10246 case OP_LEAVE:
10247 case OP_SCOPE:
10248 case OP_LEAVEWRITE:
e977893f
GS
10249 TOPPTR(nss,ix) = ptr;
10250 o = (OP*)ptr;
10251 OpREFCNT_inc(o);
1d7c1841
GS
10252 break;
10253 default:
10254 TOPPTR(nss,ix) = Nullop;
10255 break;
10256 }
10257 }
10258 else
10259 TOPPTR(nss,ix) = Nullop;
10260 break;
10261 case SAVEt_FREEPV:
10262 c = (char*)POPPTR(ss,ix);
10263 TOPPTR(nss,ix) = pv_dup_inc(c);
10264 break;
10265 case SAVEt_CLEARSV:
10266 longval = POPLONG(ss,ix);
10267 TOPLONG(nss,ix) = longval;
10268 break;
10269 case SAVEt_DELETE:
10270 hv = (HV*)POPPTR(ss,ix);
d2d73c3e 10271 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
1d7c1841
GS
10272 c = (char*)POPPTR(ss,ix);
10273 TOPPTR(nss,ix) = pv_dup_inc(c);
10274 i = POPINT(ss,ix);
10275 TOPINT(nss,ix) = i;
10276 break;
10277 case SAVEt_DESTRUCTOR:
10278 ptr = POPPTR(ss,ix);
10279 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10280 dptr = POPDPTR(ss,ix);
ef75a179 10281 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
1d7c1841
GS
10282 break;
10283 case SAVEt_DESTRUCTOR_X:
10284 ptr = POPPTR(ss,ix);
10285 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10286 dxptr = POPDXPTR(ss,ix);
acfe0abc 10287 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
1d7c1841
GS
10288 break;
10289 case SAVEt_REGCONTEXT:
10290 case SAVEt_ALLOC:
10291 i = POPINT(ss,ix);
10292 TOPINT(nss,ix) = i;
10293 ix -= i;
10294 break;
10295 case SAVEt_STACK_POS: /* Position on Perl stack */
10296 i = POPINT(ss,ix);
10297 TOPINT(nss,ix) = i;
10298 break;
10299 case SAVEt_AELEM: /* array element */
10300 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 10301 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841
GS
10302 i = POPINT(ss,ix);
10303 TOPINT(nss,ix) = i;
10304 av = (AV*)POPPTR(ss,ix);
d2d73c3e 10305 TOPPTR(nss,ix) = av_dup_inc(av, param);
1d7c1841
GS
10306 break;
10307 case SAVEt_HELEM: /* hash element */
10308 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 10309 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841 10310 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 10311 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841 10312 hv = (HV*)POPPTR(ss,ix);
d2d73c3e 10313 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
1d7c1841
GS
10314 break;
10315 case SAVEt_OP:
10316 ptr = POPPTR(ss,ix);
10317 TOPPTR(nss,ix) = ptr;
10318 break;
10319 case SAVEt_HINTS:
10320 i = POPINT(ss,ix);
10321 TOPINT(nss,ix) = i;
10322 break;
c4410b1b
GS
10323 case SAVEt_COMPPAD:
10324 av = (AV*)POPPTR(ss,ix);
d2d73c3e 10325 TOPPTR(nss,ix) = av_dup(av, param);
c4410b1b 10326 break;
c3564e5c
GS
10327 case SAVEt_PADSV:
10328 longval = (long)POPLONG(ss,ix);
10329 TOPLONG(nss,ix) = longval;
10330 ptr = POPPTR(ss,ix);
10331 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10332 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 10333 TOPPTR(nss,ix) = sv_dup(sv, param);
c3564e5c 10334 break;
a1bb4754 10335 case SAVEt_BOOL:
38d8b13e 10336 ptr = POPPTR(ss,ix);
b9609c01 10337 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
38d8b13e 10338 longval = (long)POPBOOL(ss,ix);
b9609c01 10339 TOPBOOL(nss,ix) = (bool)longval;
a1bb4754 10340 break;
1d7c1841
GS
10341 default:
10342 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10343 }
10344 }
10345
10346 return nss;
10347}
10348
645c22ef
DM
10349/*
10350=for apidoc perl_clone
10351
10352Create and return a new interpreter by cloning the current one.
10353
6a78b4db
AB
10354perl_clone takes these flags as paramters:
10355
10356CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10357without it we only clone the data and zero the stacks,
10358with it we copy the stacks and the new perl interpreter is
10359ready to run at the exact same point as the previous one.
10360The pseudo-fork code uses COPY_STACKS while the
10361threads->new doesn't.
10362
10363CLONEf_KEEP_PTR_TABLE
10364perl_clone keeps a ptr_table with the pointer of the old
10365variable as a key and the new variable as a value,
10366this allows it to check if something has been cloned and not
10367clone it again but rather just use the value and increase the
10368refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10369the ptr_table using the function
10370C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10371reason to keep it around is if you want to dup some of your own
10372variable who are outside the graph perl scans, example of this
10373code is in threads.xs create
10374
10375CLONEf_CLONE_HOST
10376This is a win32 thing, it is ignored on unix, it tells perls
10377win32host code (which is c++) to clone itself, this is needed on
10378win32 if you want to run two threads at the same time,
10379if you just want to do some stuff in a separate perl interpreter
10380and then throw it away and return to the original one,
10381you don't need to do anything.
10382
645c22ef
DM
10383=cut
10384*/
10385
10386/* XXX the above needs expanding by someone who actually understands it ! */
3fc56081
NK
10387EXTERN_C PerlInterpreter *
10388perl_clone_host(PerlInterpreter* proto_perl, UV flags);
645c22ef 10389
1d7c1841
GS
10390PerlInterpreter *
10391perl_clone(PerlInterpreter *proto_perl, UV flags)
10392{
1d7c1841 10393#ifdef PERL_IMPLICIT_SYS
c43294b8
AB
10394
10395 /* perlhost.h so we need to call into it
10396 to clone the host, CPerlHost should have a c interface, sky */
10397
10398 if (flags & CLONEf_CLONE_HOST) {
10399 return perl_clone_host(proto_perl,flags);
10400 }
10401 return perl_clone_using(proto_perl, flags,
1d7c1841
GS
10402 proto_perl->IMem,
10403 proto_perl->IMemShared,
10404 proto_perl->IMemParse,
10405 proto_perl->IEnv,
10406 proto_perl->IStdIO,
10407 proto_perl->ILIO,
10408 proto_perl->IDir,
10409 proto_perl->ISock,
10410 proto_perl->IProc);
10411}
10412
10413PerlInterpreter *
10414perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10415 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10416 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10417 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10418 struct IPerlDir* ipD, struct IPerlSock* ipS,
10419 struct IPerlProc* ipP)
10420{
10421 /* XXX many of the string copies here can be optimized if they're
10422 * constants; they need to be allocated as common memory and just
10423 * their pointers copied. */
10424
10425 IV i;
64aa0685
GS
10426 CLONE_PARAMS clone_params;
10427 CLONE_PARAMS* param = &clone_params;
d2d73c3e 10428
1d7c1841 10429 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
ba869deb 10430 PERL_SET_THX(my_perl);
1d7c1841 10431
acfe0abc 10432# ifdef DEBUGGING
a4530404 10433 Poison(my_perl, 1, PerlInterpreter);
1d7c1841
GS
10434 PL_markstack = 0;
10435 PL_scopestack = 0;
10436 PL_savestack = 0;
10437 PL_retstack = 0;
66fe0623 10438 PL_sig_pending = 0;
25596c82 10439 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
acfe0abc 10440# else /* !DEBUGGING */
1d7c1841 10441 Zero(my_perl, 1, PerlInterpreter);
acfe0abc 10442# endif /* DEBUGGING */
1d7c1841
GS
10443
10444 /* host pointers */
10445 PL_Mem = ipM;
10446 PL_MemShared = ipMS;
10447 PL_MemParse = ipMP;
10448 PL_Env = ipE;
10449 PL_StdIO = ipStd;
10450 PL_LIO = ipLIO;
10451 PL_Dir = ipD;
10452 PL_Sock = ipS;
10453 PL_Proc = ipP;
1d7c1841
GS
10454#else /* !PERL_IMPLICIT_SYS */
10455 IV i;
64aa0685
GS
10456 CLONE_PARAMS clone_params;
10457 CLONE_PARAMS* param = &clone_params;
1d7c1841 10458 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
ba869deb 10459 PERL_SET_THX(my_perl);
1d7c1841 10460
d2d73c3e
AB
10461
10462
1d7c1841 10463# ifdef DEBUGGING
a4530404 10464 Poison(my_perl, 1, PerlInterpreter);
1d7c1841
GS
10465 PL_markstack = 0;
10466 PL_scopestack = 0;
10467 PL_savestack = 0;
10468 PL_retstack = 0;
66fe0623 10469 PL_sig_pending = 0;
25596c82 10470 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
1d7c1841
GS
10471# else /* !DEBUGGING */
10472 Zero(my_perl, 1, PerlInterpreter);
10473# endif /* DEBUGGING */
10474#endif /* PERL_IMPLICIT_SYS */
83236556 10475 param->flags = flags;
59b40662 10476 param->proto_perl = proto_perl;
1d7c1841
GS
10477
10478 /* arena roots */
10479 PL_xiv_arenaroot = NULL;
10480 PL_xiv_root = NULL;
612f20c3 10481 PL_xnv_arenaroot = NULL;
1d7c1841 10482 PL_xnv_root = NULL;
612f20c3 10483 PL_xrv_arenaroot = NULL;
1d7c1841 10484 PL_xrv_root = NULL;
612f20c3 10485 PL_xpv_arenaroot = NULL;
1d7c1841 10486 PL_xpv_root = NULL;
612f20c3 10487 PL_xpviv_arenaroot = NULL;
1d7c1841 10488 PL_xpviv_root = NULL;
612f20c3 10489 PL_xpvnv_arenaroot = NULL;
1d7c1841 10490 PL_xpvnv_root = NULL;
612f20c3 10491 PL_xpvcv_arenaroot = NULL;
1d7c1841 10492 PL_xpvcv_root = NULL;
612f20c3 10493 PL_xpvav_arenaroot = NULL;
1d7c1841 10494 PL_xpvav_root = NULL;
612f20c3 10495 PL_xpvhv_arenaroot = NULL;
1d7c1841 10496 PL_xpvhv_root = NULL;
612f20c3 10497 PL_xpvmg_arenaroot = NULL;
1d7c1841 10498 PL_xpvmg_root = NULL;
612f20c3 10499 PL_xpvlv_arenaroot = NULL;
1d7c1841 10500 PL_xpvlv_root = NULL;
612f20c3 10501 PL_xpvbm_arenaroot = NULL;
1d7c1841 10502 PL_xpvbm_root = NULL;
612f20c3 10503 PL_he_arenaroot = NULL;
1d7c1841
GS
10504 PL_he_root = NULL;
10505 PL_nice_chunk = NULL;
10506 PL_nice_chunk_size = 0;
10507 PL_sv_count = 0;
10508 PL_sv_objcount = 0;
10509 PL_sv_root = Nullsv;
10510 PL_sv_arenaroot = Nullsv;
10511
10512 PL_debug = proto_perl->Idebug;
10513
e5dd39fc 10514#ifdef USE_REENTRANT_API
59bd0823 10515 Perl_reentrant_init(aTHX);
e5dd39fc
AB
10516#endif
10517
1d7c1841
GS
10518 /* create SV map for pointer relocation */
10519 PL_ptr_table = ptr_table_new();
10520
10521 /* initialize these special pointers as early as possible */
10522 SvANY(&PL_sv_undef) = NULL;
10523 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10524 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10525 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10526
1d7c1841 10527 SvANY(&PL_sv_no) = new_XPVNV();
1d7c1841
GS
10528 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10529 SvFLAGS(&PL_sv_no) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10530 SvPVX(&PL_sv_no) = SAVEPVN(PL_No, 0);
10531 SvCUR(&PL_sv_no) = 0;
10532 SvLEN(&PL_sv_no) = 1;
10533 SvNVX(&PL_sv_no) = 0;
10534 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10535
1d7c1841 10536 SvANY(&PL_sv_yes) = new_XPVNV();
1d7c1841
GS
10537 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10538 SvFLAGS(&PL_sv_yes) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10539 SvPVX(&PL_sv_yes) = SAVEPVN(PL_Yes, 1);
10540 SvCUR(&PL_sv_yes) = 1;
10541 SvLEN(&PL_sv_yes) = 2;
10542 SvNVX(&PL_sv_yes) = 1;
10543 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10544
05ec9bb3 10545 /* create (a non-shared!) shared string table */
1d7c1841
GS
10546 PL_strtab = newHV();
10547 HvSHAREKEYS_off(PL_strtab);
10548 hv_ksplit(PL_strtab, 512);
10549 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10550
05ec9bb3
NIS
10551 PL_compiling = proto_perl->Icompiling;
10552
10553 /* These two PVs will be free'd special way so must set them same way op.c does */
10554 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10555 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10556
10557 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10558 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10559
1d7c1841
GS
10560 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10561 if (!specialWARN(PL_compiling.cop_warnings))
d2d73c3e 10562 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
ac27b0f5 10563 if (!specialCopIO(PL_compiling.cop_io))
d2d73c3e 10564 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
1d7c1841
GS
10565 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10566
10567 /* pseudo environmental stuff */
10568 PL_origargc = proto_perl->Iorigargc;
e2975953 10569 PL_origargv = proto_perl->Iorigargv;
d2d73c3e 10570
d2d73c3e
AB
10571 param->stashes = newAV(); /* Setup array of objects to call clone on */
10572
a1ea730d 10573#ifdef PERLIO_LAYERS
3a1ee7e8
NIS
10574 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10575 PerlIO_clone(aTHX_ proto_perl, param);
a1ea730d 10576#endif
d2d73c3e
AB
10577
10578 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10579 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10580 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
1d7c1841 10581 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
d2d73c3e
AB
10582 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10583 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
1d7c1841
GS
10584
10585 /* switches */
10586 PL_minus_c = proto_perl->Iminus_c;
d2d73c3e 10587 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
1d7c1841
GS
10588 PL_localpatches = proto_perl->Ilocalpatches;
10589 PL_splitstr = proto_perl->Isplitstr;
10590 PL_preprocess = proto_perl->Ipreprocess;
10591 PL_minus_n = proto_perl->Iminus_n;
10592 PL_minus_p = proto_perl->Iminus_p;
10593 PL_minus_l = proto_perl->Iminus_l;
10594 PL_minus_a = proto_perl->Iminus_a;
10595 PL_minus_F = proto_perl->Iminus_F;
10596 PL_doswitches = proto_perl->Idoswitches;
10597 PL_dowarn = proto_perl->Idowarn;
10598 PL_doextract = proto_perl->Idoextract;
10599 PL_sawampersand = proto_perl->Isawampersand;
10600 PL_unsafe = proto_perl->Iunsafe;
10601 PL_inplace = SAVEPV(proto_perl->Iinplace);
d2d73c3e 10602 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
1d7c1841
GS
10603 PL_perldb = proto_perl->Iperldb;
10604 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
1cbb0781 10605 PL_exit_flags = proto_perl->Iexit_flags;
1d7c1841
GS
10606
10607 /* magical thingies */
10608 /* XXX time(&PL_basetime) when asked for? */
10609 PL_basetime = proto_perl->Ibasetime;
d2d73c3e 10610 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
1d7c1841
GS
10611
10612 PL_maxsysfd = proto_perl->Imaxsysfd;
10613 PL_multiline = proto_perl->Imultiline;
10614 PL_statusvalue = proto_perl->Istatusvalue;
10615#ifdef VMS
10616 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10617#endif
0a378802 10618 PL_encoding = sv_dup(proto_perl->Iencoding, param);
1d7c1841 10619
4a4c6fe3 10620 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
1f483ca1
JH
10621 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10622 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
4a4c6fe3 10623
d2f185dc
AMS
10624 /* Clone the regex array */
10625 PL_regex_padav = newAV();
10626 {
10627 I32 len = av_len((AV*)proto_perl->Iregex_padav);
10628 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
0f95fc41
AB
10629 av_push(PL_regex_padav,
10630 sv_dup_inc(regexen[0],param));
10631 for(i = 1; i <= len; i++) {
10632 if(SvREPADTMP(regexen[i])) {
10633 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
8cf8f3d1 10634 } else {
0f95fc41
AB
10635 av_push(PL_regex_padav,
10636 SvREFCNT_inc(
8cf8f3d1 10637 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
cbfa9890 10638 SvIVX(regexen[i])), param)))
0f95fc41
AB
10639 ));
10640 }
d2f185dc
AMS
10641 }
10642 }
10643 PL_regex_pad = AvARRAY(PL_regex_padav);
1fcf4c12 10644
1d7c1841 10645 /* shortcuts to various I/O objects */
d2d73c3e
AB
10646 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10647 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10648 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10649 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10650 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10651 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
1d7c1841
GS
10652
10653 /* shortcuts to regexp stuff */
d2d73c3e 10654 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
1d7c1841
GS
10655
10656 /* shortcuts to misc objects */
d2d73c3e 10657 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
1d7c1841
GS
10658
10659 /* shortcuts to debugging objects */
d2d73c3e
AB
10660 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10661 PL_DBline = gv_dup(proto_perl->IDBline, param);
10662 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10663 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10664 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10665 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10666 PL_lineary = av_dup(proto_perl->Ilineary, param);
10667 PL_dbargs = av_dup(proto_perl->Idbargs, param);
1d7c1841
GS
10668
10669 /* symbol tables */
d2d73c3e
AB
10670 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10671 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
d2d73c3e
AB
10672 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10673 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10674 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10675
10676 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
ee1c5a4e 10677 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
ece599bd 10678 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
d2d73c3e
AB
10679 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10680 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10681 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
1d7c1841
GS
10682
10683 PL_sub_generation = proto_perl->Isub_generation;
10684
10685 /* funky return mechanisms */
10686 PL_forkprocess = proto_perl->Iforkprocess;
10687
10688 /* subprocess state */
d2d73c3e 10689 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
1d7c1841
GS
10690
10691 /* internal state */
10692 PL_tainting = proto_perl->Itainting;
10693 PL_maxo = proto_perl->Imaxo;
10694 if (proto_perl->Iop_mask)
10695 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10696 else
10697 PL_op_mask = Nullch;
10698
10699 /* current interpreter roots */
d2d73c3e 10700 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
1d7c1841
GS
10701 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10702 PL_main_start = proto_perl->Imain_start;
e977893f 10703 PL_eval_root = proto_perl->Ieval_root;
1d7c1841
GS
10704 PL_eval_start = proto_perl->Ieval_start;
10705
10706 /* runtime control stuff */
10707 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10708 PL_copline = proto_perl->Icopline;
10709
10710 PL_filemode = proto_perl->Ifilemode;
10711 PL_lastfd = proto_perl->Ilastfd;
10712 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10713 PL_Argv = NULL;
10714 PL_Cmd = Nullch;
10715 PL_gensym = proto_perl->Igensym;
10716 PL_preambled = proto_perl->Ipreambled;
d2d73c3e 10717 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
1d7c1841
GS
10718 PL_laststatval = proto_perl->Ilaststatval;
10719 PL_laststype = proto_perl->Ilaststype;
10720 PL_mess_sv = Nullsv;
10721
d2d73c3e 10722 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
1d7c1841
GS
10723 PL_ofmt = SAVEPV(proto_perl->Iofmt);
10724
10725 /* interpreter atexit processing */
10726 PL_exitlistlen = proto_perl->Iexitlistlen;
10727 if (PL_exitlistlen) {
10728 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10729 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10730 }
10731 else
10732 PL_exitlist = (PerlExitListEntry*)NULL;
d2d73c3e 10733 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
19e8ce8e
AB
10734 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10735 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
1d7c1841
GS
10736
10737 PL_profiledata = NULL;
a8fc9800 10738 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
1d7c1841 10739 /* PL_rsfp_filters entries have fake IoDIRP() */
d2d73c3e 10740 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
1d7c1841 10741
d2d73c3e 10742 PL_compcv = cv_dup(proto_perl->Icompcv, param);
dd2155a4
DM
10743
10744 PAD_CLONE_VARS(proto_perl, param);
1d7c1841
GS
10745
10746#ifdef HAVE_INTERP_INTERN
10747 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10748#endif
10749
10750 /* more statics moved here */
10751 PL_generation = proto_perl->Igeneration;
d2d73c3e 10752 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
1d7c1841
GS
10753
10754 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10755 PL_in_clean_all = proto_perl->Iin_clean_all;
10756
10757 PL_uid = proto_perl->Iuid;
10758 PL_euid = proto_perl->Ieuid;
10759 PL_gid = proto_perl->Igid;
10760 PL_egid = proto_perl->Iegid;
10761 PL_nomemok = proto_perl->Inomemok;
10762 PL_an = proto_perl->Ian;
1d7c1841
GS
10763 PL_op_seqmax = proto_perl->Iop_seqmax;
10764 PL_evalseq = proto_perl->Ievalseq;
10765 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10766 PL_origalen = proto_perl->Iorigalen;
10767 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10768 PL_osname = SAVEPV(proto_perl->Iosname);
0bb09c15 10769 PL_sh_path = proto_perl->Ish_path; /* XXX never deallocated */
1d7c1841
GS
10770 PL_sighandlerp = proto_perl->Isighandlerp;
10771
10772
10773 PL_runops = proto_perl->Irunops;
10774
10775 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10776
10777#ifdef CSH
10778 PL_cshlen = proto_perl->Icshlen;
74f1b2b8 10779 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
1d7c1841
GS
10780#endif
10781
10782 PL_lex_state = proto_perl->Ilex_state;
10783 PL_lex_defer = proto_perl->Ilex_defer;
10784 PL_lex_expect = proto_perl->Ilex_expect;
10785 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10786 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10787 PL_lex_starts = proto_perl->Ilex_starts;
d2d73c3e
AB
10788 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10789 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
1d7c1841
GS
10790 PL_lex_op = proto_perl->Ilex_op;
10791 PL_lex_inpat = proto_perl->Ilex_inpat;
10792 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10793 PL_lex_brackets = proto_perl->Ilex_brackets;
10794 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10795 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10796 PL_lex_casemods = proto_perl->Ilex_casemods;
10797 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10798 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10799
10800 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10801 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10802 PL_nexttoke = proto_perl->Inexttoke;
10803
1d773130
TB
10804 /* XXX This is probably masking the deeper issue of why
10805 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10806 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10807 * (A little debugging with a watchpoint on it may help.)
10808 */
389edf32
TB
10809 if (SvANY(proto_perl->Ilinestr)) {
10810 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10811 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
10812 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10813 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
10814 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10815 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
10816 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10817 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
10818 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10819 }
10820 else {
10821 PL_linestr = NEWSV(65,79);
10822 sv_upgrade(PL_linestr,SVt_PVIV);
10823 sv_setpvn(PL_linestr,"",0);
10824 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10825 }
1d7c1841 10826 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
1d7c1841
GS
10827 PL_pending_ident = proto_perl->Ipending_ident;
10828 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10829
10830 PL_expect = proto_perl->Iexpect;
10831
10832 PL_multi_start = proto_perl->Imulti_start;
10833 PL_multi_end = proto_perl->Imulti_end;
10834 PL_multi_open = proto_perl->Imulti_open;
10835 PL_multi_close = proto_perl->Imulti_close;
10836
10837 PL_error_count = proto_perl->Ierror_count;
10838 PL_subline = proto_perl->Isubline;
d2d73c3e 10839 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
1d7c1841 10840
1d773130 10841 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
389edf32
TB
10842 if (SvANY(proto_perl->Ilinestr)) {
10843 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
10844 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10845 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
10846 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10847 PL_last_lop_op = proto_perl->Ilast_lop_op;
10848 }
10849 else {
10850 PL_last_uni = SvPVX(PL_linestr);
10851 PL_last_lop = SvPVX(PL_linestr);
10852 PL_last_lop_op = 0;
10853 }
1d7c1841 10854 PL_in_my = proto_perl->Iin_my;
d2d73c3e 10855 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
1d7c1841
GS
10856#ifdef FCRYPT
10857 PL_cryptseen = proto_perl->Icryptseen;
10858#endif
10859
10860 PL_hints = proto_perl->Ihints;
10861
10862 PL_amagic_generation = proto_perl->Iamagic_generation;
10863
10864#ifdef USE_LOCALE_COLLATE
10865 PL_collation_ix = proto_perl->Icollation_ix;
10866 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10867 PL_collation_standard = proto_perl->Icollation_standard;
10868 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10869 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10870#endif /* USE_LOCALE_COLLATE */
10871
10872#ifdef USE_LOCALE_NUMERIC
10873 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10874 PL_numeric_standard = proto_perl->Inumeric_standard;
10875 PL_numeric_local = proto_perl->Inumeric_local;
d2d73c3e 10876 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
1d7c1841
GS
10877#endif /* !USE_LOCALE_NUMERIC */
10878
10879 /* utf8 character classes */
d2d73c3e
AB
10880 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10881 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10882 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10883 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10884 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10885 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10886 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10887 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10888 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10889 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10890 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10891 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10892 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10893 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10894 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10895 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10896 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
b4e400f9 10897 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
82686b01
JH
10898 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10899 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
1d7c1841
GS
10900
10901 /* swatch cache */
10902 PL_last_swash_hv = Nullhv; /* reinits on demand */
10903 PL_last_swash_klen = 0;
10904 PL_last_swash_key[0]= '\0';
10905 PL_last_swash_tmps = (U8*)NULL;
10906 PL_last_swash_slen = 0;
10907
10908 /* perly.c globals */
10909 PL_yydebug = proto_perl->Iyydebug;
10910 PL_yynerrs = proto_perl->Iyynerrs;
10911 PL_yyerrflag = proto_perl->Iyyerrflag;
10912 PL_yychar = proto_perl->Iyychar;
10913 PL_yyval = proto_perl->Iyyval;
10914 PL_yylval = proto_perl->Iyylval;
10915
10916 PL_glob_index = proto_perl->Iglob_index;
10917 PL_srand_called = proto_perl->Isrand_called;
10918 PL_uudmap['M'] = 0; /* reinits on demand */
10919 PL_bitcount = Nullch; /* reinits on demand */
10920
66fe0623
NIS
10921 if (proto_perl->Ipsig_pend) {
10922 Newz(0, PL_psig_pend, SIG_SIZE, int);
9dd79c3f 10923 }
66fe0623
NIS
10924 else {
10925 PL_psig_pend = (int*)NULL;
10926 }
10927
1d7c1841 10928 if (proto_perl->Ipsig_ptr) {
76d3c696
JH
10929 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
10930 Newz(0, PL_psig_name, SIG_SIZE, SV*);
76d3c696 10931 for (i = 1; i < SIG_SIZE; i++) {
d2d73c3e
AB
10932 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10933 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
1d7c1841
GS
10934 }
10935 }
10936 else {
10937 PL_psig_ptr = (SV**)NULL;
10938 PL_psig_name = (SV**)NULL;
10939 }
10940
10941 /* thrdvar.h stuff */
10942
a0739874 10943 if (flags & CLONEf_COPY_STACKS) {
1d7c1841
GS
10944 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10945 PL_tmps_ix = proto_perl->Ttmps_ix;
10946 PL_tmps_max = proto_perl->Ttmps_max;
10947 PL_tmps_floor = proto_perl->Ttmps_floor;
10948 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
10949 i = 0;
10950 while (i <= PL_tmps_ix) {
d2d73c3e 10951 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
1d7c1841
GS
10952 ++i;
10953 }
10954
10955 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10956 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10957 Newz(54, PL_markstack, i, I32);
10958 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10959 - proto_perl->Tmarkstack);
10960 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10961 - proto_perl->Tmarkstack);
10962 Copy(proto_perl->Tmarkstack, PL_markstack,
10963 PL_markstack_ptr - PL_markstack + 1, I32);
10964
10965 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10966 * NOTE: unlike the others! */
10967 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10968 PL_scopestack_max = proto_perl->Tscopestack_max;
10969 Newz(54, PL_scopestack, PL_scopestack_max, I32);
10970 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10971
10972 /* next push_return() sets PL_retstack[PL_retstack_ix]
10973 * NOTE: unlike the others! */
10974 PL_retstack_ix = proto_perl->Tretstack_ix;
10975 PL_retstack_max = proto_perl->Tretstack_max;
10976 Newz(54, PL_retstack, PL_retstack_max, OP*);
ce0a1ae0 10977 Copy(proto_perl->Tretstack, PL_retstack, PL_retstack_ix, OP*);
1d7c1841
GS
10978
10979 /* NOTE: si_dup() looks at PL_markstack */
d2d73c3e 10980 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
1d7c1841
GS
10981
10982 /* PL_curstack = PL_curstackinfo->si_stack; */
d2d73c3e
AB
10983 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10984 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
1d7c1841
GS
10985
10986 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10987 PL_stack_base = AvARRAY(PL_curstack);
10988 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10989 - proto_perl->Tstack_base);
10990 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10991
10992 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10993 * NOTE: unlike the others! */
10994 PL_savestack_ix = proto_perl->Tsavestack_ix;
10995 PL_savestack_max = proto_perl->Tsavestack_max;
10996 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
d2d73c3e 10997 PL_savestack = ss_dup(proto_perl, param);
1d7c1841
GS
10998 }
10999 else {
11000 init_stacks();
985e7056 11001 ENTER; /* perl_destruct() wants to LEAVE; */
1d7c1841
GS
11002 }
11003
11004 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11005 PL_top_env = &PL_start_env;
11006
11007 PL_op = proto_perl->Top;
11008
11009 PL_Sv = Nullsv;
11010 PL_Xpv = (XPV*)NULL;
11011 PL_na = proto_perl->Tna;
11012
11013 PL_statbuf = proto_perl->Tstatbuf;
11014 PL_statcache = proto_perl->Tstatcache;
d2d73c3e
AB
11015 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11016 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
1d7c1841
GS
11017#ifdef HAS_TIMES
11018 PL_timesbuf = proto_perl->Ttimesbuf;
11019#endif
11020
11021 PL_tainted = proto_perl->Ttainted;
11022 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
d2d73c3e
AB
11023 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11024 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11025 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11026 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
1d7c1841 11027 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
d2d73c3e
AB
11028 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11029 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11030 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
1d7c1841
GS
11031
11032 PL_restartop = proto_perl->Trestartop;
11033 PL_in_eval = proto_perl->Tin_eval;
11034 PL_delaymagic = proto_perl->Tdelaymagic;
11035 PL_dirty = proto_perl->Tdirty;
11036 PL_localizing = proto_perl->Tlocalizing;
11037
14dd3ad8 11038#ifdef PERL_FLEXIBLE_EXCEPTIONS
1d7c1841 11039 PL_protect = proto_perl->Tprotect;
14dd3ad8 11040#endif
d2d73c3e 11041 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
1d7c1841
GS
11042 PL_av_fetch_sv = Nullsv;
11043 PL_hv_fetch_sv = Nullsv;
11044 Zero(&PL_hv_fetch_ent_mh, 1, HE); /* XXX */
11045 PL_modcount = proto_perl->Tmodcount;
11046 PL_lastgotoprobe = Nullop;
11047 PL_dumpindent = proto_perl->Tdumpindent;
11048
11049 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
d2d73c3e
AB
11050 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11051 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11052 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
1d7c1841
GS
11053 PL_sortcxix = proto_perl->Tsortcxix;
11054 PL_efloatbuf = Nullch; /* reinits on demand */
11055 PL_efloatsize = 0; /* reinits on demand */
11056
11057 /* regex stuff */
11058
11059 PL_screamfirst = NULL;
11060 PL_screamnext = NULL;
11061 PL_maxscream = -1; /* reinits on demand */
11062 PL_lastscream = Nullsv;
11063
11064 PL_watchaddr = NULL;
11065 PL_watchok = Nullch;
11066
11067 PL_regdummy = proto_perl->Tregdummy;
1d7c1841
GS
11068 PL_regprecomp = Nullch;
11069 PL_regnpar = 0;
11070 PL_regsize = 0;
1d7c1841
GS
11071 PL_colorset = 0; /* reinits PL_colors[] */
11072 /*PL_colors[6] = {0,0,0,0,0,0};*/
1d7c1841
GS
11073 PL_reginput = Nullch;
11074 PL_regbol = Nullch;
11075 PL_regeol = Nullch;
11076 PL_regstartp = (I32*)NULL;
11077 PL_regendp = (I32*)NULL;
11078 PL_reglastparen = (U32*)NULL;
11079 PL_regtill = Nullch;
1d7c1841
GS
11080 PL_reg_start_tmp = (char**)NULL;
11081 PL_reg_start_tmpl = 0;
11082 PL_regdata = (struct reg_data*)NULL;
11083 PL_bostr = Nullch;
11084 PL_reg_flags = 0;
11085 PL_reg_eval_set = 0;
11086 PL_regnarrate = 0;
11087 PL_regprogram = (regnode*)NULL;
11088 PL_regindent = 0;
11089 PL_regcc = (CURCUR*)NULL;
11090 PL_reg_call_cc = (struct re_cc_state*)NULL;
11091 PL_reg_re = (regexp*)NULL;
11092 PL_reg_ganch = Nullch;
11093 PL_reg_sv = Nullsv;
53c4c00c 11094 PL_reg_match_utf8 = FALSE;
1d7c1841
GS
11095 PL_reg_magic = (MAGIC*)NULL;
11096 PL_reg_oldpos = 0;
11097 PL_reg_oldcurpm = (PMOP*)NULL;
11098 PL_reg_curpm = (PMOP*)NULL;
11099 PL_reg_oldsaved = Nullch;
11100 PL_reg_oldsavedlen = 0;
11101 PL_reg_maxiter = 0;
11102 PL_reg_leftiter = 0;
11103 PL_reg_poscache = Nullch;
11104 PL_reg_poscache_size= 0;
11105
11106 /* RE engine - function pointers */
11107 PL_regcompp = proto_perl->Tregcompp;
11108 PL_regexecp = proto_perl->Tregexecp;
11109 PL_regint_start = proto_perl->Tregint_start;
11110 PL_regint_string = proto_perl->Tregint_string;
11111 PL_regfree = proto_perl->Tregfree;
11112
11113 PL_reginterp_cnt = 0;
11114 PL_reg_starttry = 0;
11115
a2efc822
SC
11116 /* Pluggable optimizer */
11117 PL_peepp = proto_perl->Tpeepp;
11118
a0739874
DM
11119 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11120 ptr_table_free(PL_ptr_table);
11121 PL_ptr_table = NULL;
11122 }
8cf8f3d1 11123
f284b03f
AMS
11124 /* Call the ->CLONE method, if it exists, for each of the stashes
11125 identified by sv_dup() above.
11126 */
d2d73c3e
AB
11127 while(av_len(param->stashes) != -1) {
11128 HV* stash = (HV*) av_shift(param->stashes);
f284b03f
AMS
11129 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11130 if (cloner && GvCV(cloner)) {
11131 dSP;
11132 ENTER;
11133 SAVETMPS;
11134 PUSHMARK(SP);
dc507217 11135 XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
f284b03f
AMS
11136 PUTBACK;
11137 call_sv((SV*)GvCV(cloner), G_DISCARD);
11138 FREETMPS;
11139 LEAVE;
11140 }
4a09accc 11141 }
a0739874 11142
dc507217 11143 SvREFCNT_dec(param->stashes);
dc507217 11144
1d7c1841 11145 return my_perl;
1d7c1841
GS
11146}
11147
1d7c1841 11148#endif /* USE_ITHREADS */
a0ae6670 11149
9f4817db 11150/*
ccfc67b7
JH
11151=head1 Unicode Support
11152
9f4817db
JH
11153=for apidoc sv_recode_to_utf8
11154
5d170f3a
JH
11155The encoding is assumed to be an Encode object, on entry the PV
11156of the sv is assumed to be octets in that encoding, and the sv
11157will be converted into Unicode (and UTF-8).
9f4817db 11158
5d170f3a
JH
11159If the sv already is UTF-8 (or if it is not POK), or if the encoding
11160is not a reference, nothing is done to the sv. If the encoding is not
1768d7eb
JH
11161an C<Encode::XS> Encoding object, bad things will happen.
11162(See F<lib/encoding.pm> and L<Encode>).
9f4817db 11163
5d170f3a 11164The PV of the sv is returned.
9f4817db 11165
5d170f3a
JH
11166=cut */
11167
11168char *
11169Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11170{
f9893866 11171 if (SvPOK(sv) && !DO_UTF8(sv) && SvROK(encoding)) {
d0063567
DK
11172 int vary = FALSE;
11173 SV *uni;
11174 STRLEN len;
11175 char *s;
11176 dSP;
11177 ENTER;
11178 SAVETMPS;
11179 PUSHMARK(sp);
11180 EXTEND(SP, 3);
11181 XPUSHs(encoding);
11182 XPUSHs(sv);
f9893866
NIS
11183/*
11184 NI-S 2002/07/09
11185 Passing sv_yes is wrong - it needs to be or'ed set of constants
11186 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11187 remove converted chars from source.
11188
11189 Both will default the value - let them.
11190
d0063567 11191 XPUSHs(&PL_sv_yes);
f9893866 11192*/
d0063567
DK
11193 PUTBACK;
11194 call_method("decode", G_SCALAR);
11195 SPAGAIN;
11196 uni = POPs;
11197 PUTBACK;
11198 s = SvPV(uni, len);
11199 {
11200 U8 *t = (U8 *)s, *e = (U8 *)s + len;
11201 while (t < e) {
11202 if ((vary = !UTF8_IS_INVARIANT(*t++)))
11203 break;
11204 }
11205 }
11206 if (s != SvPVX(sv)) {
11207 SvGROW(sv, len + 1);
11208 Move(s, SvPVX(sv), len, char);
11209 SvCUR_set(sv, len);
11210 SvPVX(sv)[len] = 0;
11211 }
11212 FREETMPS;
11213 LEAVE;
11214 if (vary)
11215 SvUTF8_on(sv);
11216 SvUTF8_on(sv);
f9893866
NIS
11217 }
11218 return SvPVX(sv);
9f4817db
JH
11219}
11220
68795e93 11221
f9893866 11222