This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
fix comment in change #18689
[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;
a4bfb290
AB
4420 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
4421 and we do that anyway inside the SvNIOK_off
4422 */
4423 SvFLAGS(sv) |= SVf_OOK;
79072805 4424 }
a4bfb290 4425 SvNIOK_off(sv);
463ee0b2 4426 delta = ptr - SvPVX(sv);
79072805
LW
4427 SvLEN(sv) -= delta;
4428 SvCUR(sv) -= delta;
463ee0b2
LW
4429 SvPVX(sv) += delta;
4430 SvIVX(sv) += delta;
79072805
LW
4431}
4432
954c1994
GS
4433/*
4434=for apidoc sv_catpvn
4435
4436Concatenates the string onto the end of the string which is in the SV. The
d5ce4a7c
GA
4437C<len> indicates number of bytes to copy. If the SV has the UTF8
4438status set, then the bytes appended should be valid UTF8.
4439Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
954c1994 4440
8d6d96c1
HS
4441=for apidoc sv_catpvn_flags
4442
4443Concatenates the string onto the end of the string which is in the SV. The
4444C<len> indicates number of bytes to copy. If the SV has the UTF8
4445status set, then the bytes appended should be valid UTF8.
4446If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
4447appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
4448in terms of this function.
4449
4450=cut
4451*/
4452
4453void
4454Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
4455{
4456 STRLEN dlen;
4457 char *dstr;
4458
4459 dstr = SvPV_force_flags(dsv, dlen, flags);
4460 SvGROW(dsv, dlen + slen + 1);
4461 if (sstr == dstr)
4462 sstr = SvPVX(dsv);
4463 Move(sstr, SvPVX(dsv) + dlen, slen, char);
4464 SvCUR(dsv) += slen;
4465 *SvEND(dsv) = '\0';
4466 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
4467 SvTAINT(dsv);
79072805
LW
4468}
4469
954c1994
GS
4470/*
4471=for apidoc sv_catpvn_mg
4472
4473Like C<sv_catpvn>, but also handles 'set' magic.
4474
4475=cut
4476*/
4477
79072805 4478void
864dbfa3 4479Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
ef50df4b
GS
4480{
4481 sv_catpvn(sv,ptr,len);
4482 SvSETMAGIC(sv);
4483}
4484
954c1994
GS
4485/*
4486=for apidoc sv_catsv
4487
13e8c8e3
JH
4488Concatenates the string from SV C<ssv> onto the end of the string in
4489SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
4490not 'set' magic. See C<sv_catsv_mg>.
954c1994 4491
8d6d96c1
HS
4492=for apidoc sv_catsv_flags
4493
4494Concatenates the string from SV C<ssv> onto the end of the string in
4495SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
4496bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
4497and C<sv_catsv_nomg> are implemented in terms of this function.
4498
4499=cut */
4500
ef50df4b 4501void
8d6d96c1 4502Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
79072805 4503{
13e8c8e3
JH
4504 char *spv;
4505 STRLEN slen;
46199a12 4506 if (!ssv)
79072805 4507 return;
46199a12 4508 if ((spv = SvPV(ssv, slen))) {
4fd84b44
AD
4509 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
4510 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
8cf8f3d1
NIS
4511 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
4512 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4fd84b44
AD
4513 dsv->sv_flags doesn't have that bit set.
4514 Andy Dougherty 12 Oct 2001
4515 */
4516 I32 sutf8 = DO_UTF8(ssv);
4517 I32 dutf8;
13e8c8e3 4518
8d6d96c1
HS
4519 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
4520 mg_get(dsv);
4521 dutf8 = DO_UTF8(dsv);
4522
4523 if (dutf8 != sutf8) {
13e8c8e3 4524 if (dutf8) {
46199a12 4525 /* Not modifying source SV, so taking a temporary copy. */
8d6d96c1 4526 SV* csv = sv_2mortal(newSVpvn(spv, slen));
13e8c8e3 4527
46199a12 4528 sv_utf8_upgrade(csv);
8d6d96c1 4529 spv = SvPV(csv, slen);
13e8c8e3 4530 }
8d6d96c1
HS
4531 else
4532 sv_utf8_upgrade_nomg(dsv);
e84ff256 4533 }
8d6d96c1 4534 sv_catpvn_nomg(dsv, spv, slen);
560a288e 4535 }
79072805
LW
4536}
4537
954c1994
GS
4538/*
4539=for apidoc sv_catsv_mg
4540
4541Like C<sv_catsv>, but also handles 'set' magic.
4542
4543=cut
4544*/
4545
79072805 4546void
46199a12 4547Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
ef50df4b 4548{
46199a12
JH
4549 sv_catsv(dsv,ssv);
4550 SvSETMAGIC(dsv);
ef50df4b
GS
4551}
4552
954c1994
GS
4553/*
4554=for apidoc sv_catpv
4555
4556Concatenates the string onto the end of the string which is in the SV.
d5ce4a7c
GA
4557If the SV has the UTF8 status set, then the bytes appended should be
4558valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
954c1994 4559
d5ce4a7c 4560=cut */
954c1994 4561
ef50df4b 4562void
0c981600 4563Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
79072805
LW
4564{
4565 register STRLEN len;
463ee0b2 4566 STRLEN tlen;
748a9306 4567 char *junk;
79072805 4568
0c981600 4569 if (!ptr)
79072805 4570 return;
748a9306 4571 junk = SvPV_force(sv, tlen);
0c981600 4572 len = strlen(ptr);
463ee0b2 4573 SvGROW(sv, tlen + len + 1);
0c981600
JH
4574 if (ptr == junk)
4575 ptr = SvPVX(sv);
4576 Move(ptr,SvPVX(sv)+tlen,len+1,char);
79072805 4577 SvCUR(sv) += len;
d41ff1b8 4578 (void)SvPOK_only_UTF8(sv); /* validate pointer */
463ee0b2 4579 SvTAINT(sv);
79072805
LW
4580}
4581
954c1994
GS
4582/*
4583=for apidoc sv_catpv_mg
4584
4585Like C<sv_catpv>, but also handles 'set' magic.
4586
4587=cut
4588*/
4589
ef50df4b 4590void
0c981600 4591Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
ef50df4b 4592{
0c981600 4593 sv_catpv(sv,ptr);
ef50df4b
GS
4594 SvSETMAGIC(sv);
4595}
4596
645c22ef
DM
4597/*
4598=for apidoc newSV
4599
4600Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
4601with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
4602macro.
4603
4604=cut
4605*/
4606
79072805 4607SV *
864dbfa3 4608Perl_newSV(pTHX_ STRLEN len)
79072805
LW
4609{
4610 register SV *sv;
1c846c1f 4611
4561caa4 4612 new_SV(sv);
79072805
LW
4613 if (len) {
4614 sv_upgrade(sv, SVt_PV);
4615 SvGROW(sv, len + 1);
4616 }
4617 return sv;
4618}
954c1994 4619/*
92110913 4620=for apidoc sv_magicext
954c1994 4621
68795e93 4622Adds magic to an SV, upgrading it if necessary. Applies the
92110913
NIS
4623supplied vtable and returns pointer to the magic added.
4624
4625Note that sv_magicext will allow things that sv_magic will not.
68795e93 4626In particular you can add magic to SvREADONLY SVs and and more than
92110913 4627one instance of the same 'how'
645c22ef 4628
92110913 4629I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
68795e93
NIS
4630if C<namelen> is zero then C<name> is stored as-is and - as another special
4631case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
92110913
NIS
4632an C<SV*> and has its REFCNT incremented
4633
4634(This is now used as a subroutine by sv_magic.)
954c1994
GS
4635
4636=cut
4637*/
92110913
NIS
4638MAGIC *
4639Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
4640 const char* name, I32 namlen)
79072805
LW
4641{
4642 MAGIC* mg;
68795e93 4643
92110913
NIS
4644 if (SvTYPE(sv) < SVt_PVMG) {
4645 (void)SvUPGRADE(sv, SVt_PVMG);
463ee0b2 4646 }
79072805
LW
4647 Newz(702,mg, 1, MAGIC);
4648 mg->mg_moremagic = SvMAGIC(sv);
79072805 4649 SvMAGIC(sv) = mg;
75f9d97a 4650
18808301 4651 /* Some magic sontains a reference loop, where the sv and object refer to
bb03859b
RS
4652 each other. To prevent a reference loop that would prevent such
4653 objects being freed, we look for such loops and if we find one we
87f0b213
JH
4654 avoid incrementing the object refcount.
4655
4656 Note we cannot do this to avoid self-tie loops as intervening RV must
b5ccf5f2 4657 have its REFCNT incremented to keep it in existence.
87f0b213
JH
4658
4659 */
14befaf4
DM
4660 if (!obj || obj == sv ||
4661 how == PERL_MAGIC_arylen ||
4662 how == PERL_MAGIC_qr ||
75f9d97a
JH
4663 (SvTYPE(obj) == SVt_PVGV &&
4664 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
4665 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
2628be26 4666 GvFORM(obj) == (CV*)sv)))
75f9d97a 4667 {
8990e307 4668 mg->mg_obj = obj;
75f9d97a 4669 }
85e6fe83 4670 else {
8990e307 4671 mg->mg_obj = SvREFCNT_inc(obj);
85e6fe83
LW
4672 mg->mg_flags |= MGf_REFCOUNTED;
4673 }
b5ccf5f2
YST
4674
4675 /* Normal self-ties simply pass a null object, and instead of
4676 using mg_obj directly, use the SvTIED_obj macro to produce a
4677 new RV as needed. For glob "self-ties", we are tieing the PVIO
4678 with an RV obj pointing to the glob containing the PVIO. In
4679 this case, to avoid a reference loop, we need to weaken the
4680 reference.
4681 */
4682
4683 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
4684 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
4685 {
4686 sv_rvweaken(obj);
4687 }
4688
79072805 4689 mg->mg_type = how;
565764a8 4690 mg->mg_len = namlen;
9cbac4c7 4691 if (name) {
92110913 4692 if (namlen > 0)
1edc1566 4693 mg->mg_ptr = savepvn(name, namlen);
c6ee37c5 4694 else if (namlen == HEf_SVKEY)
1edc1566 4695 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
68795e93 4696 else
92110913 4697 mg->mg_ptr = (char *) name;
9cbac4c7 4698 }
92110913 4699 mg->mg_virtual = vtable;
68795e93 4700
92110913
NIS
4701 mg_magical(sv);
4702 if (SvGMAGICAL(sv))
4703 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
4704 return mg;
4705}
4706
4707/*
4708=for apidoc sv_magic
1c846c1f 4709
92110913
NIS
4710Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4711then adds a new magic item of type C<how> to the head of the magic list.
4712
4713=cut
4714*/
4715
4716void
4717Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
68795e93 4718{
92110913
NIS
4719 MAGIC* mg;
4720 MGVTBL *vtable = 0;
4721
765f542d
NC
4722#ifdef PERL_COPY_ON_WRITE
4723 if (SvIsCOW(sv))
4724 sv_force_normal_flags(sv, 0);
4725#endif
92110913
NIS
4726 if (SvREADONLY(sv)) {
4727 if (PL_curcop != &PL_compiling
4728 && how != PERL_MAGIC_regex_global
4729 && how != PERL_MAGIC_bm
4730 && how != PERL_MAGIC_fm
4731 && how != PERL_MAGIC_sv
4732 )
4733 {
4734 Perl_croak(aTHX_ PL_no_modify);
4735 }
4736 }
4737 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
4738 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
68795e93
NIS
4739 /* sv_magic() refuses to add a magic of the same 'how' as an
4740 existing one
92110913
NIS
4741 */
4742 if (how == PERL_MAGIC_taint)
4743 mg->mg_len |= 1;
4744 return;
4745 }
4746 }
68795e93 4747
79072805 4748 switch (how) {
14befaf4 4749 case PERL_MAGIC_sv:
92110913 4750 vtable = &PL_vtbl_sv;
79072805 4751 break;
14befaf4 4752 case PERL_MAGIC_overload:
92110913 4753 vtable = &PL_vtbl_amagic;
a0d0e21e 4754 break;
14befaf4 4755 case PERL_MAGIC_overload_elem:
92110913 4756 vtable = &PL_vtbl_amagicelem;
a0d0e21e 4757 break;
14befaf4 4758 case PERL_MAGIC_overload_table:
92110913 4759 vtable = &PL_vtbl_ovrld;
a0d0e21e 4760 break;
14befaf4 4761 case PERL_MAGIC_bm:
92110913 4762 vtable = &PL_vtbl_bm;
79072805 4763 break;
14befaf4 4764 case PERL_MAGIC_regdata:
92110913 4765 vtable = &PL_vtbl_regdata;
6cef1e77 4766 break;
14befaf4 4767 case PERL_MAGIC_regdatum:
92110913 4768 vtable = &PL_vtbl_regdatum;
6cef1e77 4769 break;
14befaf4 4770 case PERL_MAGIC_env:
92110913 4771 vtable = &PL_vtbl_env;
79072805 4772 break;
14befaf4 4773 case PERL_MAGIC_fm:
92110913 4774 vtable = &PL_vtbl_fm;
55497cff 4775 break;
14befaf4 4776 case PERL_MAGIC_envelem:
92110913 4777 vtable = &PL_vtbl_envelem;
79072805 4778 break;
14befaf4 4779 case PERL_MAGIC_regex_global:
92110913 4780 vtable = &PL_vtbl_mglob;
93a17b20 4781 break;
14befaf4 4782 case PERL_MAGIC_isa:
92110913 4783 vtable = &PL_vtbl_isa;
463ee0b2 4784 break;
14befaf4 4785 case PERL_MAGIC_isaelem:
92110913 4786 vtable = &PL_vtbl_isaelem;
463ee0b2 4787 break;
14befaf4 4788 case PERL_MAGIC_nkeys:
92110913 4789 vtable = &PL_vtbl_nkeys;
16660edb 4790 break;
14befaf4 4791 case PERL_MAGIC_dbfile:
92110913 4792 vtable = 0;
93a17b20 4793 break;
14befaf4 4794 case PERL_MAGIC_dbline:
92110913 4795 vtable = &PL_vtbl_dbline;
79072805 4796 break;
36477c24 4797#ifdef USE_LOCALE_COLLATE
14befaf4 4798 case PERL_MAGIC_collxfrm:
92110913 4799 vtable = &PL_vtbl_collxfrm;
bbce6d69 4800 break;
36477c24 4801#endif /* USE_LOCALE_COLLATE */
14befaf4 4802 case PERL_MAGIC_tied:
92110913 4803 vtable = &PL_vtbl_pack;
463ee0b2 4804 break;
14befaf4
DM
4805 case PERL_MAGIC_tiedelem:
4806 case PERL_MAGIC_tiedscalar:
92110913 4807 vtable = &PL_vtbl_packelem;
463ee0b2 4808 break;
14befaf4 4809 case PERL_MAGIC_qr:
92110913 4810 vtable = &PL_vtbl_regexp;
c277df42 4811 break;
14befaf4 4812 case PERL_MAGIC_sig:
92110913 4813 vtable = &PL_vtbl_sig;
79072805 4814 break;
14befaf4 4815 case PERL_MAGIC_sigelem:
92110913 4816 vtable = &PL_vtbl_sigelem;
79072805 4817 break;
14befaf4 4818 case PERL_MAGIC_taint:
92110913 4819 vtable = &PL_vtbl_taint;
463ee0b2 4820 break;
14befaf4 4821 case PERL_MAGIC_uvar:
92110913 4822 vtable = &PL_vtbl_uvar;
79072805 4823 break;
14befaf4 4824 case PERL_MAGIC_vec:
92110913 4825 vtable = &PL_vtbl_vec;
79072805 4826 break;
ece467f9
JP
4827 case PERL_MAGIC_vstring:
4828 vtable = 0;
4829 break;
7e8c5dac
HS
4830 case PERL_MAGIC_utf8:
4831 vtable = &PL_vtbl_utf8;
4832 break;
14befaf4 4833 case PERL_MAGIC_substr:
92110913 4834 vtable = &PL_vtbl_substr;
79072805 4835 break;
14befaf4 4836 case PERL_MAGIC_defelem:
92110913 4837 vtable = &PL_vtbl_defelem;
5f05dabc 4838 break;
14befaf4 4839 case PERL_MAGIC_glob:
92110913 4840 vtable = &PL_vtbl_glob;
79072805 4841 break;
14befaf4 4842 case PERL_MAGIC_arylen:
92110913 4843 vtable = &PL_vtbl_arylen;
79072805 4844 break;
14befaf4 4845 case PERL_MAGIC_pos:
92110913 4846 vtable = &PL_vtbl_pos;
a0d0e21e 4847 break;
14befaf4 4848 case PERL_MAGIC_backref:
92110913 4849 vtable = &PL_vtbl_backref;
810b8aa5 4850 break;
14befaf4
DM
4851 case PERL_MAGIC_ext:
4852 /* Reserved for use by extensions not perl internals. */
4633a7c4
LW
4853 /* Useful for attaching extension internal data to perl vars. */
4854 /* Note that multiple extensions may clash if magical scalars */
4855 /* etc holding private data from one are passed to another. */
a0d0e21e 4856 break;
79072805 4857 default:
14befaf4 4858 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
463ee0b2 4859 }
68795e93 4860
92110913
NIS
4861 /* Rest of work is done else where */
4862 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
68795e93 4863
92110913
NIS
4864 switch (how) {
4865 case PERL_MAGIC_taint:
4866 mg->mg_len = 1;
4867 break;
4868 case PERL_MAGIC_ext:
4869 case PERL_MAGIC_dbfile:
4870 SvRMAGICAL_on(sv);
4871 break;
4872 }
463ee0b2
LW
4873}
4874
c461cf8f
JH
4875/*
4876=for apidoc sv_unmagic
4877
645c22ef 4878Removes all magic of type C<type> from an SV.
c461cf8f
JH
4879
4880=cut
4881*/
4882
463ee0b2 4883int
864dbfa3 4884Perl_sv_unmagic(pTHX_ SV *sv, int type)
463ee0b2
LW
4885{
4886 MAGIC* mg;
4887 MAGIC** mgp;
91bba347 4888 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
463ee0b2
LW
4889 return 0;
4890 mgp = &SvMAGIC(sv);
4891 for (mg = *mgp; mg; mg = *mgp) {
4892 if (mg->mg_type == type) {
4893 MGVTBL* vtbl = mg->mg_virtual;
4894 *mgp = mg->mg_moremagic;
1d7c1841 4895 if (vtbl && vtbl->svt_free)
fc0dc3b3 4896 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
14befaf4 4897 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
92110913 4898 if (mg->mg_len > 0)
1edc1566 4899 Safefree(mg->mg_ptr);
565764a8 4900 else if (mg->mg_len == HEf_SVKEY)
1edc1566 4901 SvREFCNT_dec((SV*)mg->mg_ptr);
7e8c5dac
HS
4902 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
4903 Safefree(mg->mg_ptr);
9cbac4c7 4904 }
a0d0e21e
LW
4905 if (mg->mg_flags & MGf_REFCOUNTED)
4906 SvREFCNT_dec(mg->mg_obj);
463ee0b2
LW
4907 Safefree(mg);
4908 }
4909 else
4910 mgp = &mg->mg_moremagic;
79072805 4911 }
91bba347 4912 if (!SvMAGIC(sv)) {
463ee0b2 4913 SvMAGICAL_off(sv);
06759ea0 4914 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
463ee0b2
LW
4915 }
4916
4917 return 0;
79072805
LW
4918}
4919
c461cf8f
JH
4920/*
4921=for apidoc sv_rvweaken
4922
645c22ef
DM
4923Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4924referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4925push a back-reference to this RV onto the array of backreferences
4926associated with that magic.
c461cf8f
JH
4927
4928=cut
4929*/
4930
810b8aa5 4931SV *
864dbfa3 4932Perl_sv_rvweaken(pTHX_ SV *sv)
810b8aa5
GS
4933{
4934 SV *tsv;
4935 if (!SvOK(sv)) /* let undefs pass */
4936 return sv;
4937 if (!SvROK(sv))
cea2e8a9 4938 Perl_croak(aTHX_ "Can't weaken a nonreference");
810b8aa5 4939 else if (SvWEAKREF(sv)) {
810b8aa5 4940 if (ckWARN(WARN_MISC))
9014280d 4941 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
810b8aa5
GS
4942 return sv;
4943 }
4944 tsv = SvRV(sv);
4945 sv_add_backref(tsv, sv);
4946 SvWEAKREF_on(sv);
1c846c1f 4947 SvREFCNT_dec(tsv);
810b8aa5
GS
4948 return sv;
4949}
4950
645c22ef
DM
4951/* Give tsv backref magic if it hasn't already got it, then push a
4952 * back-reference to sv onto the array associated with the backref magic.
4953 */
4954
810b8aa5 4955STATIC void
cea2e8a9 4956S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
810b8aa5
GS
4957{
4958 AV *av;
4959 MAGIC *mg;
14befaf4 4960 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
810b8aa5
GS
4961 av = (AV*)mg->mg_obj;
4962 else {
4963 av = newAV();
14befaf4 4964 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
810b8aa5
GS
4965 SvREFCNT_dec(av); /* for sv_magic */
4966 }
4967 av_push(av,sv);
4968}
4969
645c22ef
DM
4970/* delete a back-reference to ourselves from the backref magic associated
4971 * with the SV we point to.
4972 */
4973
1c846c1f 4974STATIC void
cea2e8a9 4975S_sv_del_backref(pTHX_ SV *sv)
810b8aa5
GS
4976{
4977 AV *av;
4978 SV **svp;
4979 I32 i;
4980 SV *tsv = SvRV(sv);
c04a4dfe 4981 MAGIC *mg = NULL;
14befaf4 4982 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
cea2e8a9 4983 Perl_croak(aTHX_ "panic: del_backref");
810b8aa5
GS
4984 av = (AV *)mg->mg_obj;
4985 svp = AvARRAY(av);
4986 i = AvFILLp(av);
4987 while (i >= 0) {
4988 if (svp[i] == sv) {
4989 svp[i] = &PL_sv_undef; /* XXX */
4990 }
4991 i--;
4992 }
4993}
4994
954c1994
GS
4995/*
4996=for apidoc sv_insert
4997
4998Inserts a string at the specified offset/length within the SV. Similar to
4999the Perl substr() function.
5000
5001=cut
5002*/
5003
79072805 5004void
864dbfa3 5005Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
79072805
LW
5006{
5007 register char *big;
5008 register char *mid;
5009 register char *midend;
5010 register char *bigend;
5011 register I32 i;
6ff81951 5012 STRLEN curlen;
1c846c1f 5013
79072805 5014
8990e307 5015 if (!bigstr)
cea2e8a9 5016 Perl_croak(aTHX_ "Can't modify non-existent substring");
6ff81951 5017 SvPV_force(bigstr, curlen);
60fa28ff 5018 (void)SvPOK_only_UTF8(bigstr);
6ff81951
GS
5019 if (offset + len > curlen) {
5020 SvGROW(bigstr, offset+len+1);
5021 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5022 SvCUR_set(bigstr, offset+len);
5023 }
79072805 5024
69b47968 5025 SvTAINT(bigstr);
79072805
LW
5026 i = littlelen - len;
5027 if (i > 0) { /* string might grow */
a0d0e21e 5028 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
79072805
LW
5029 mid = big + offset + len;
5030 midend = bigend = big + SvCUR(bigstr);
5031 bigend += i;
5032 *bigend = '\0';
5033 while (midend > mid) /* shove everything down */
5034 *--bigend = *--midend;
5035 Move(little,big+offset,littlelen,char);
5036 SvCUR(bigstr) += i;
5037 SvSETMAGIC(bigstr);
5038 return;
5039 }
5040 else if (i == 0) {
463ee0b2 5041 Move(little,SvPVX(bigstr)+offset,len,char);
79072805
LW
5042 SvSETMAGIC(bigstr);
5043 return;
5044 }
5045
463ee0b2 5046 big = SvPVX(bigstr);
79072805
LW
5047 mid = big + offset;
5048 midend = mid + len;
5049 bigend = big + SvCUR(bigstr);
5050
5051 if (midend > bigend)
cea2e8a9 5052 Perl_croak(aTHX_ "panic: sv_insert");
79072805
LW
5053
5054 if (mid - big > bigend - midend) { /* faster to shorten from end */
5055 if (littlelen) {
5056 Move(little, mid, littlelen,char);
5057 mid += littlelen;
5058 }
5059 i = bigend - midend;
5060 if (i > 0) {
5061 Move(midend, mid, i,char);
5062 mid += i;
5063 }
5064 *mid = '\0';
5065 SvCUR_set(bigstr, mid - big);
5066 }
5067 /*SUPPRESS 560*/
155aba94 5068 else if ((i = mid - big)) { /* faster from front */
79072805
LW
5069 midend -= littlelen;
5070 mid = midend;
5071 sv_chop(bigstr,midend-i);
5072 big += i;
5073 while (i--)
5074 *--midend = *--big;
5075 if (littlelen)
5076 Move(little, mid, littlelen,char);
5077 }
5078 else if (littlelen) {
5079 midend -= littlelen;
5080 sv_chop(bigstr,midend);
5081 Move(little,midend,littlelen,char);
5082 }
5083 else {
5084 sv_chop(bigstr,midend);
5085 }
5086 SvSETMAGIC(bigstr);
5087}
5088
c461cf8f
JH
5089/*
5090=for apidoc sv_replace
5091
5092Make the first argument a copy of the second, then delete the original.
645c22ef
DM
5093The target SV physically takes over ownership of the body of the source SV
5094and inherits its flags; however, the target keeps any magic it owns,
5095and any magic in the source is discarded.
ff276b08 5096Note that this is a rather specialist SV copying operation; most of the
645c22ef 5097time you'll want to use C<sv_setsv> or one of its many macro front-ends.
c461cf8f
JH
5098
5099=cut
5100*/
79072805
LW
5101
5102void
864dbfa3 5103Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
79072805
LW
5104{
5105 U32 refcnt = SvREFCNT(sv);
765f542d 5106 SV_CHECK_THINKFIRST_COW_DROP(sv);
0453d815 5107 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
9014280d 5108 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
93a17b20 5109 if (SvMAGICAL(sv)) {
a0d0e21e
LW
5110 if (SvMAGICAL(nsv))
5111 mg_free(nsv);
5112 else
5113 sv_upgrade(nsv, SVt_PVMG);
93a17b20 5114 SvMAGIC(nsv) = SvMAGIC(sv);
a0d0e21e 5115 SvFLAGS(nsv) |= SvMAGICAL(sv);
93a17b20
LW
5116 SvMAGICAL_off(sv);
5117 SvMAGIC(sv) = 0;
5118 }
79072805
LW
5119 SvREFCNT(sv) = 0;
5120 sv_clear(sv);
477f5d66 5121 assert(!SvREFCNT(sv));
79072805 5122 StructCopy(nsv,sv,SV);
d3d0e6f1
NC
5123#ifdef PERL_COPY_ON_WRITE
5124 if (SvIsCOW_normal(nsv)) {
5125 /* We need to follow the pointers around the loop to make the
5126 previous SV point to sv, rather than nsv. */
5127 SV *next;
5128 SV *current = nsv;
5129 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5130 assert(next);
5131 current = next;
5132 assert(SvPVX(current) == SvPVX(nsv));
5133 }
5134 /* Make the SV before us point to the SV after us. */
5135 if (DEBUG_C_TEST) {
5136 PerlIO_printf(Perl_debug_log, "previous is\n");
5137 sv_dump(current);
a29f6d03
NC
5138 PerlIO_printf(Perl_debug_log,
5139 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
d3d0e6f1
NC
5140 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5141 }
a29f6d03 5142 SV_COW_NEXT_SV_SET(current, sv);
d3d0e6f1
NC
5143 }
5144#endif
79072805 5145 SvREFCNT(sv) = refcnt;
1edc1566 5146 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
463ee0b2 5147 del_SV(nsv);
79072805
LW
5148}
5149
c461cf8f
JH
5150/*
5151=for apidoc sv_clear
5152
645c22ef
DM
5153Clear an SV: call any destructors, free up any memory used by the body,
5154and free the body itself. The SV's head is I<not> freed, although
5155its type is set to all 1's so that it won't inadvertently be assumed
5156to be live during global destruction etc.
5157This function should only be called when REFCNT is zero. Most of the time
5158you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5159instead.
c461cf8f
JH
5160
5161=cut
5162*/
5163
79072805 5164void
864dbfa3 5165Perl_sv_clear(pTHX_ register SV *sv)
79072805 5166{
ec12f114 5167 HV* stash;
79072805
LW
5168 assert(sv);
5169 assert(SvREFCNT(sv) == 0);
5170
ed6116ce 5171 if (SvOBJECT(sv)) {
3280af22 5172 if (PL_defstash) { /* Still have a symbol table? */
39644a26 5173 dSP;
32251b26 5174 CV* destructor;
837485b6 5175 SV tmpref;
a0d0e21e 5176
837485b6
GS
5177 Zero(&tmpref, 1, SV);
5178 sv_upgrade(&tmpref, SVt_RV);
5179 SvROK_on(&tmpref);
5180 SvREADONLY_on(&tmpref); /* DESTROY() could be naughty */
5181 SvREFCNT(&tmpref) = 1;
8ebc5c01 5182
d460ef45 5183 do {
4e8e7886 5184 stash = SvSTASH(sv);
32251b26 5185 destructor = StashHANDLER(stash,DESTROY);
4e8e7886
GS
5186 if (destructor) {
5187 ENTER;
e788e7d3 5188 PUSHSTACKi(PERLSI_DESTROY);
837485b6 5189 SvRV(&tmpref) = SvREFCNT_inc(sv);
4e8e7886
GS
5190 EXTEND(SP, 2);
5191 PUSHMARK(SP);
837485b6 5192 PUSHs(&tmpref);
4e8e7886 5193 PUTBACK;
44389ee9 5194 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
4e8e7886 5195 SvREFCNT(sv)--;
d3acc0f7 5196 POPSTACK;
3095d977 5197 SPAGAIN;
4e8e7886
GS
5198 LEAVE;
5199 }
5200 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
8ebc5c01 5201
837485b6 5202 del_XRV(SvANY(&tmpref));
6f44e0a4
JP
5203
5204 if (SvREFCNT(sv)) {
5205 if (PL_in_clean_objs)
cea2e8a9 5206 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
6f44e0a4
JP
5207 HvNAME(stash));
5208 /* DESTROY gave object new lease on life */
5209 return;
5210 }
a0d0e21e 5211 }
4e8e7886 5212
a0d0e21e 5213 if (SvOBJECT(sv)) {
4e8e7886 5214 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
a0d0e21e
LW
5215 SvOBJECT_off(sv); /* Curse the object. */
5216 if (SvTYPE(sv) != SVt_PVIO)
3280af22 5217 --PL_sv_objcount; /* XXX Might want something more general */
a0d0e21e 5218 }
463ee0b2 5219 }
524189f1
JH
5220 if (SvTYPE(sv) >= SVt_PVMG) {
5221 if (SvMAGIC(sv))
5222 mg_free(sv);
5223 if (SvFLAGS(sv) & SVpad_TYPED)
5224 SvREFCNT_dec(SvSTASH(sv));
5225 }
ec12f114 5226 stash = NULL;
79072805 5227 switch (SvTYPE(sv)) {
8990e307 5228 case SVt_PVIO:
df0bd2f4
GS
5229 if (IoIFP(sv) &&
5230 IoIFP(sv) != PerlIO_stdin() &&
5f05dabc 5231 IoIFP(sv) != PerlIO_stdout() &&
5232 IoIFP(sv) != PerlIO_stderr())
93578b34 5233 {
f2b5be74 5234 io_close((IO*)sv, FALSE);
93578b34 5235 }
1d7c1841 5236 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
1236053a 5237 PerlDir_close(IoDIRP(sv));
1d7c1841 5238 IoDIRP(sv) = (DIR*)NULL;
8990e307
LW
5239 Safefree(IoTOP_NAME(sv));
5240 Safefree(IoFMT_NAME(sv));
5241 Safefree(IoBOTTOM_NAME(sv));
a0d0e21e 5242 /* FALL THROUGH */
79072805 5243 case SVt_PVBM:
a0d0e21e 5244 goto freescalar;
79072805 5245 case SVt_PVCV:
748a9306 5246 case SVt_PVFM:
85e6fe83 5247 cv_undef((CV*)sv);
a0d0e21e 5248 goto freescalar;
79072805 5249 case SVt_PVHV:
85e6fe83 5250 hv_undef((HV*)sv);
a0d0e21e 5251 break;
79072805 5252 case SVt_PVAV:
85e6fe83 5253 av_undef((AV*)sv);
a0d0e21e 5254 break;
02270b4e
GS
5255 case SVt_PVLV:
5256 SvREFCNT_dec(LvTARG(sv));
5257 goto freescalar;
a0d0e21e 5258 case SVt_PVGV:
1edc1566 5259 gp_free((GV*)sv);
a0d0e21e 5260 Safefree(GvNAME(sv));
ec12f114
JPC
5261 /* cannot decrease stash refcount yet, as we might recursively delete
5262 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5263 of stash until current sv is completely gone.
5264 -- JohnPC, 27 Mar 1998 */
5265 stash = GvSTASH(sv);
a0d0e21e 5266 /* FALL THROUGH */
79072805 5267 case SVt_PVMG:
79072805
LW
5268 case SVt_PVNV:
5269 case SVt_PVIV:
a0d0e21e
LW
5270 freescalar:
5271 (void)SvOOK_off(sv);
79072805
LW
5272 /* FALL THROUGH */
5273 case SVt_PV:
a0d0e21e 5274 case SVt_RV:
810b8aa5
GS
5275 if (SvROK(sv)) {
5276 if (SvWEAKREF(sv))
5277 sv_del_backref(sv);
5278 else
5279 SvREFCNT_dec(SvRV(sv));
5280 }
765f542d
NC
5281#ifdef PERL_COPY_ON_WRITE
5282 else if (SvPVX(sv)) {
5283 if (SvIsCOW(sv)) {
5284 /* I believe I need to grab the global SV mutex here and
5285 then recheck the COW status. */
46187eeb
NC
5286 if (DEBUG_C_TEST) {
5287 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
e419cbc5 5288 sv_dump(sv);
46187eeb 5289 }
e419cbc5 5290 sv_release_COW(sv, SvPVX(sv), SvCUR(sv), SvLEN(sv),
765f542d
NC
5291 SvUVX(sv), SV_COW_NEXT_SV(sv));
5292 /* And drop it here. */
5293 SvFAKE_off(sv);
5294 } else if (SvLEN(sv)) {
5295 Safefree(SvPVX(sv));
5296 }
5297 }
5298#else
1edc1566 5299 else if (SvPVX(sv) && SvLEN(sv))
463ee0b2 5300 Safefree(SvPVX(sv));
1c846c1f 5301 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
25716404
GS
5302 unsharepvn(SvPVX(sv),
5303 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
5304 SvUVX(sv));
1c846c1f
NIS
5305 SvFAKE_off(sv);
5306 }
765f542d 5307#endif
79072805 5308 break;
a0d0e21e 5309/*
79072805 5310 case SVt_NV:
79072805 5311 case SVt_IV:
79072805
LW
5312 case SVt_NULL:
5313 break;
a0d0e21e 5314*/
79072805
LW
5315 }
5316
5317 switch (SvTYPE(sv)) {
5318 case SVt_NULL:
5319 break;
79072805
LW
5320 case SVt_IV:
5321 del_XIV(SvANY(sv));
5322 break;
5323 case SVt_NV:
5324 del_XNV(SvANY(sv));
5325 break;
ed6116ce
LW
5326 case SVt_RV:
5327 del_XRV(SvANY(sv));
5328 break;
79072805
LW
5329 case SVt_PV:
5330 del_XPV(SvANY(sv));
5331 break;
5332 case SVt_PVIV:
5333 del_XPVIV(SvANY(sv));
5334 break;
5335 case SVt_PVNV:
5336 del_XPVNV(SvANY(sv));
5337 break;
5338 case SVt_PVMG:
5339 del_XPVMG(SvANY(sv));
5340 break;
5341 case SVt_PVLV:
5342 del_XPVLV(SvANY(sv));
5343 break;
5344 case SVt_PVAV:
5345 del_XPVAV(SvANY(sv));
5346 break;
5347 case SVt_PVHV:
5348 del_XPVHV(SvANY(sv));
5349 break;
5350 case SVt_PVCV:
5351 del_XPVCV(SvANY(sv));
5352 break;
5353 case SVt_PVGV:
5354 del_XPVGV(SvANY(sv));
ec12f114
JPC
5355 /* code duplication for increased performance. */
5356 SvFLAGS(sv) &= SVf_BREAK;
5357 SvFLAGS(sv) |= SVTYPEMASK;
5358 /* decrease refcount of the stash that owns this GV, if any */
5359 if (stash)
5360 SvREFCNT_dec(stash);
5361 return; /* not break, SvFLAGS reset already happened */
79072805
LW
5362 case SVt_PVBM:
5363 del_XPVBM(SvANY(sv));
5364 break;
5365 case SVt_PVFM:
5366 del_XPVFM(SvANY(sv));
5367 break;
8990e307
LW
5368 case SVt_PVIO:
5369 del_XPVIO(SvANY(sv));
5370 break;
79072805 5371 }
a0d0e21e 5372 SvFLAGS(sv) &= SVf_BREAK;
8990e307 5373 SvFLAGS(sv) |= SVTYPEMASK;
79072805
LW
5374}
5375
645c22ef
DM
5376/*
5377=for apidoc sv_newref
5378
5379Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
5380instead.
5381
5382=cut
5383*/
5384
79072805 5385SV *
864dbfa3 5386Perl_sv_newref(pTHX_ SV *sv)
79072805 5387{
463ee0b2 5388 if (sv)
dce16143 5389 ATOMIC_INC(SvREFCNT(sv));
79072805
LW
5390 return sv;
5391}
5392
c461cf8f
JH
5393/*
5394=for apidoc sv_free
5395
645c22ef
DM
5396Decrement an SV's reference count, and if it drops to zero, call
5397C<sv_clear> to invoke destructors and free up any memory used by
5398the body; finally, deallocate the SV's head itself.
5399Normally called via a wrapper macro C<SvREFCNT_dec>.
c461cf8f
JH
5400
5401=cut
5402*/
5403
79072805 5404void
864dbfa3 5405Perl_sv_free(pTHX_ SV *sv)
79072805 5406{
dce16143
MB
5407 int refcount_is_zero;
5408
79072805
LW
5409 if (!sv)
5410 return;
a0d0e21e
LW
5411 if (SvREFCNT(sv) == 0) {
5412 if (SvFLAGS(sv) & SVf_BREAK)
645c22ef
DM
5413 /* this SV's refcnt has been artificially decremented to
5414 * trigger cleanup */
a0d0e21e 5415 return;
3280af22 5416 if (PL_in_clean_all) /* All is fair */
1edc1566 5417 return;
d689ffdd
JP
5418 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5419 /* make sure SvREFCNT(sv)==0 happens very seldom */
5420 SvREFCNT(sv) = (~(U32)0)/2;
5421 return;
5422 }
0453d815 5423 if (ckWARN_d(WARN_INTERNAL))
9014280d 5424 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Attempt to free unreferenced scalar");
79072805
LW
5425 return;
5426 }
dce16143 5427 ATOMIC_DEC_AND_TEST(refcount_is_zero, SvREFCNT(sv));
b881518d 5428 if (!refcount_is_zero)
8990e307 5429 return;
463ee0b2
LW
5430#ifdef DEBUGGING
5431 if (SvTEMP(sv)) {
0453d815 5432 if (ckWARN_d(WARN_DEBUGGING))
9014280d 5433 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
1d7c1841
GS
5434 "Attempt to free temp prematurely: SV 0x%"UVxf,
5435 PTR2UV(sv));
79072805 5436 return;
79072805 5437 }
463ee0b2 5438#endif
d689ffdd
JP
5439 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
5440 /* make sure SvREFCNT(sv)==0 happens very seldom */
5441 SvREFCNT(sv) = (~(U32)0)/2;
5442 return;
5443 }
79072805 5444 sv_clear(sv);
477f5d66
CS
5445 if (! SvREFCNT(sv))
5446 del_SV(sv);
79072805
LW
5447}
5448
954c1994
GS
5449/*
5450=for apidoc sv_len
5451
645c22ef
DM
5452Returns the length of the string in the SV. Handles magic and type
5453coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
954c1994
GS
5454
5455=cut
5456*/
5457
79072805 5458STRLEN
864dbfa3 5459Perl_sv_len(pTHX_ register SV *sv)
79072805 5460{
463ee0b2 5461 STRLEN len;
79072805
LW
5462
5463 if (!sv)
5464 return 0;
5465
8990e307 5466 if (SvGMAGICAL(sv))
565764a8 5467 len = mg_length(sv);
8990e307 5468 else
497b47a8 5469 (void)SvPV(sv, len);
463ee0b2 5470 return len;
79072805
LW
5471}
5472
c461cf8f
JH
5473/*
5474=for apidoc sv_len_utf8
5475
5476Returns the number of characters in the string in an SV, counting wide
645c22ef 5477UTF8 bytes as a single character. Handles magic and type coercion.
c461cf8f
JH
5478
5479=cut
5480*/
5481
7e8c5dac
HS
5482/*
5483 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
5484 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
5485 * (Note that the mg_len is not the length of the mg_ptr field.)
5486 *
5487 */
5488
a0ed51b3 5489STRLEN
864dbfa3 5490Perl_sv_len_utf8(pTHX_ register SV *sv)
a0ed51b3 5491{
a0ed51b3
LW
5492 if (!sv)
5493 return 0;
5494
a0ed51b3 5495 if (SvGMAGICAL(sv))
b76347f2 5496 return mg_length(sv);
a0ed51b3 5497 else
b76347f2 5498 {
7e8c5dac 5499 STRLEN len, ulen;
b76347f2 5500 U8 *s = (U8*)SvPV(sv, len);
7e8c5dac
HS
5501 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
5502
5503 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0))
5504 ulen = mg->mg_len;
5505 else {
5506 ulen = Perl_utf8_length(aTHX_ s, s + len);
5507 if (!mg && !SvREADONLY(sv)) {
5508 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5509 mg = mg_find(sv, PERL_MAGIC_utf8);
5510 assert(mg);
5511 }
5512 if (mg)
5513 mg->mg_len = ulen;
5514 }
5515 return ulen;
5516 }
5517}
5518
5519/* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
5520 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5521 * between UTF-8 and byte offsets. There are two (substr offset and substr
5522 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
5523 * and byte offset) cache positions.
5524 *
5525 * The mg_len field is used by sv_len_utf8(), see its comments.
5526 * Note that the mg_len is not the length of the mg_ptr field.
5527 *
5528 */
5529STATIC bool
6e551876 5530S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, U8 *s, U8 *start)
7e8c5dac
HS
5531{
5532 bool found = FALSE;
5533
5534 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5535 if (!*mgp) {
5536 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5537 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5538 }
5539 assert(*mgp);
b76347f2 5540
7e8c5dac
HS
5541 if ((*mgp)->mg_ptr)
5542 *cachep = (STRLEN *) (*mgp)->mg_ptr;
5543 else {
5544 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5545 (*mgp)->mg_ptr = (char *) *cachep;
5546 }
5547 assert(*cachep);
5548
5549 (*cachep)[i] = *offsetp;
5550 (*cachep)[i+1] = s - start;
5551 found = TRUE;
a0ed51b3 5552 }
7e8c5dac
HS
5553
5554 return found;
a0ed51b3
LW
5555}
5556
645c22ef 5557/*
7e8c5dac
HS
5558 * S_utf8_mg_pos() is used to query and update mg_ptr field of
5559 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
5560 * between UTF-8 and byte offsets. See also the comments of
5561 * S_utf8_mg_pos_init().
5562 *
5563 */
5564STATIC bool
6e551876 5565S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
7e8c5dac
HS
5566{
5567 bool found = FALSE;
5568
5569 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5570 if (!*mgp)
5571 *mgp = mg_find(sv, PERL_MAGIC_utf8);
5572 if (*mgp && (*mgp)->mg_ptr) {
5573 *cachep = (STRLEN *) (*mgp)->mg_ptr;
667208dd 5574 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
7e8c5dac
HS
5575 found = TRUE;
5576 else { /* We will skip to the right spot. */
5577 STRLEN forw = 0;
5578 STRLEN backw = 0;
5579 U8* p = NULL;
5580
5581 /* The assumption is that going backward is half
5582 * the speed of going forward (that's where the
5583 * 2 * backw in the below comes from). (The real
5584 * figure of course depends on the UTF-8 data.) */
5585
667208dd 5586 if ((*cachep)[i] > (STRLEN)uoff) {
7e8c5dac 5587 forw = uoff;
667208dd 5588 backw = (*cachep)[i] - (STRLEN)uoff;
7e8c5dac
HS
5589
5590 if (forw < 2 * backw)
5591 p = start;
5592 else
5593 p = start + (*cachep)[i+1];
5594 }
5595 /* Try this only for the substr offset (i == 0),
5596 * not for the substr length (i == 2). */
5597 else if (i == 0) { /* (*cachep)[i] < uoff */
5598 STRLEN ulen = sv_len_utf8(sv);
5599
667208dd
JH
5600 if ((STRLEN)uoff < ulen) {
5601 forw = (STRLEN)uoff - (*cachep)[i];
5602 backw = ulen - (STRLEN)uoff;
7e8c5dac
HS
5603
5604 if (forw < 2 * backw)
5605 p = start + (*cachep)[i+1];
5606 else
5607 p = send;
5608 }
5609
5610 /* If the string is not long enough for uoff,
5611 * we could extend it, but not at this low a level. */
5612 }
5613
5614 if (p) {
5615 if (forw < 2 * backw) {
5616 while (forw--)
5617 p += UTF8SKIP(p);
5618 }
5619 else {
5620 while (backw--) {
5621 p--;
5622 while (UTF8_IS_CONTINUATION(*p))
5623 p--;
5624 }
5625 }
5626
5627 /* Update the cache. */
667208dd 5628 (*cachep)[i] = (STRLEN)uoff;
7e8c5dac
HS
5629 (*cachep)[i+1] = p - start;
5630
5631 found = TRUE;
5632 }
5633 }
5634 if (found) { /* Setup the return values. */
5635 *offsetp = (*cachep)[i+1];
5636 *sp = start + *offsetp;
5637 if (*sp >= send) {
5638 *sp = send;
5639 *offsetp = send - start;
5640 }
5641 else if (*sp < start) {
5642 *sp = start;
5643 *offsetp = 0;
5644 }
5645 }
5646 }
5647 }
5648 return found;
5649}
5650
5651/*
645c22ef
DM
5652=for apidoc sv_pos_u2b
5653
5654Converts the value pointed to by offsetp from a count of UTF8 chars from
5655the start of the string, to a count of the equivalent number of bytes; if
5656lenp is non-zero, it does the same to lenp, but this time starting from
5657the offset, rather than from the start of the string. Handles magic and
5658type coercion.
5659
5660=cut
5661*/
5662
7e8c5dac
HS
5663/*
5664 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
5665 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5666 * byte offsets. See also the comments of S_utf8_mg_pos().
5667 *
5668 */
5669
a0ed51b3 5670void
864dbfa3 5671Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
a0ed51b3 5672{
dfe13c55
GS
5673 U8 *start;
5674 U8 *s;
a0ed51b3 5675 STRLEN len;
7e8c5dac
HS
5676 STRLEN *cache = 0;
5677 STRLEN boffset = 0;
a0ed51b3
LW
5678
5679 if (!sv)
5680 return;
5681
dfe13c55 5682 start = s = (U8*)SvPV(sv, len);
7e8c5dac
HS
5683 if (len) {
5684 I32 uoffset = *offsetp;
5685 U8 *send = s + len;
5686 MAGIC *mg = 0;
5687 bool found = FALSE;
5688
bdf77a2a 5689 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
7e8c5dac
HS
5690 found = TRUE;
5691 if (!found && uoffset > 0) {
5692 while (s < send && uoffset--)
5693 s += UTF8SKIP(s);
5694 if (s >= send)
5695 s = send;
bdf77a2a 5696 if (utf8_mg_pos_init(sv, &mg, &cache, 0, offsetp, s, start))
7e8c5dac
HS
5697 boffset = cache[1];
5698 *offsetp = s - start;
5699 }
5700 if (lenp) {
5701 found = FALSE;
5702 start = s;
bdf77a2a 5703 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp + *offsetp, &s, start, send)) {
7e8c5dac
HS
5704 *lenp -= boffset;
5705 found = TRUE;
5706 }
5707 if (!found && *lenp > 0) {
5708 I32 ulen = *lenp;
5709 if (ulen > 0)
5710 while (s < send && ulen--)
5711 s += UTF8SKIP(s);
5712 if (s >= send)
5713 s = send;
bdf77a2a 5714 if (utf8_mg_pos_init(sv, &mg, &cache, 2, lenp, s, start))
7e8c5dac
HS
5715 cache[2] += *offsetp;
5716 }
5717 *lenp = s - start;
5718 }
5719 }
5720 else {
5721 *offsetp = 0;
5722 if (lenp)
5723 *lenp = 0;
a0ed51b3
LW
5724 }
5725 return;
5726}
5727
645c22ef
DM
5728/*
5729=for apidoc sv_pos_b2u
5730
5731Converts the value pointed to by offsetp from a count of bytes from the
5732start of the string, to a count of the equivalent number of UTF8 chars.
5733Handles magic and type coercion.
5734
5735=cut
5736*/
5737
7e8c5dac
HS
5738/*
5739 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
5740 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
5741 * byte offsets. See also the comments of S_utf8_mg_pos().
5742 *
5743 */
5744
a0ed51b3 5745void
7e8c5dac 5746Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
a0ed51b3 5747{
7e8c5dac 5748 U8* s;
a0ed51b3
LW
5749 STRLEN len;
5750
5751 if (!sv)
5752 return;
5753
dfe13c55 5754 s = (U8*)SvPV(sv, len);
eb160463 5755 if ((I32)len < *offsetp)
a0dbb045 5756 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
7e8c5dac
HS
5757 else {
5758 U8* send = s + *offsetp;
5759 MAGIC* mg = NULL;
5760 STRLEN *cache = NULL;
5761
5762 len = 0;
5763
5764 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
5765 mg = mg_find(sv, PERL_MAGIC_utf8);
5766 if (mg && mg->mg_ptr) {
5767 cache = (STRLEN *) mg->mg_ptr;
5768 if (cache[1] == *offsetp) {
5769 /* An exact match. */
5770 *offsetp = cache[0];
5771
5772 return;
5773 }
5774 else if (cache[1] < *offsetp) {
5775 /* We already know part of the way. */
5776 len = cache[0];
5777 s += cache[1];
5778 /* Let the below loop do the rest. */
5779 }
5780 else { /* cache[1] > *offsetp */
5781 /* We already know all of the way, now we may
5782 * be able to walk back. The same assumption
5783 * is made as in S_utf8_mg_pos(), namely that
5784 * walking backward is twice slower than
5785 * walking forward. */
5786 STRLEN forw = *offsetp;
5787 STRLEN backw = cache[1] - *offsetp;
5788
5789 if (!(forw < 2 * backw)) {
5790 U8 *p = s + cache[1];
5791 STRLEN ubackw = 0;
5792
a5b510f2
AE
5793 cache[1] -= backw;
5794
7e8c5dac
HS
5795 while (backw--) {
5796 p--;
5797 while (UTF8_IS_CONTINUATION(*p))
5798 p--;
5799 ubackw++;
5800 }
5801
5802 cache[0] -= ubackw;
7e8c5dac
HS
5803
5804 return;
5805 }
5806 }
5807 }
a0dbb045 5808 }
7e8c5dac
HS
5809
5810 while (s < send) {
5811 STRLEN n = 1;
5812
5813 /* Call utf8n_to_uvchr() to validate the sequence
5814 * (unless a simple non-UTF character) */
5815 if (!UTF8_IS_INVARIANT(*s))
5816 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
5817 if (n > 0) {
5818 s += n;
5819 len++;
5820 }
5821 else
5822 break;
5823 }
5824
5825 if (!SvREADONLY(sv)) {
5826 if (!mg) {
5827 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
5828 mg = mg_find(sv, PERL_MAGIC_utf8);
5829 }
5830 assert(mg);
5831
5832 if (!mg->mg_ptr) {
5833 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
5834 mg->mg_ptr = (char *) cache;
5835 }
5836 assert(cache);
5837
5838 cache[0] = len;
5839 cache[1] = *offsetp;
5840 }
5841
5842 *offsetp = len;
a0ed51b3 5843 }
a0ed51b3
LW
5844 return;
5845}
5846
954c1994
GS
5847/*
5848=for apidoc sv_eq
5849
5850Returns a boolean indicating whether the strings in the two SVs are
645c22ef
DM
5851identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5852coerce its args to strings if necessary.
954c1994
GS
5853
5854=cut
5855*/
5856
79072805 5857I32
e01b9e88 5858Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
79072805
LW
5859{
5860 char *pv1;
463ee0b2 5861 STRLEN cur1;
79072805 5862 char *pv2;
463ee0b2 5863 STRLEN cur2;
e01b9e88 5864 I32 eq = 0;
553e1bcc
AT
5865 char *tpv = Nullch;
5866 SV* svrecode = Nullsv;
79072805 5867
e01b9e88 5868 if (!sv1) {
79072805
LW
5869 pv1 = "";
5870 cur1 = 0;
5871 }
463ee0b2 5872 else
e01b9e88 5873 pv1 = SvPV(sv1, cur1);
79072805 5874
e01b9e88
SC
5875 if (!sv2){
5876 pv2 = "";
5877 cur2 = 0;
92d29cee 5878 }
e01b9e88
SC
5879 else
5880 pv2 = SvPV(sv2, cur2);
79072805 5881
cf48d248 5882 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
799ef3cb
JH
5883 /* Differing utf8ness.
5884 * Do not UTF8size the comparands as a side-effect. */
5885 if (PL_encoding) {
5886 if (SvUTF8(sv1)) {
553e1bcc
AT
5887 svrecode = newSVpvn(pv2, cur2);
5888 sv_recode_to_utf8(svrecode, PL_encoding);
5889 pv2 = SvPV(svrecode, cur2);
799ef3cb
JH
5890 }
5891 else {
553e1bcc
AT
5892 svrecode = newSVpvn(pv1, cur1);
5893 sv_recode_to_utf8(svrecode, PL_encoding);
5894 pv1 = SvPV(svrecode, cur1);
799ef3cb
JH
5895 }
5896 /* Now both are in UTF-8. */
5897 if (cur1 != cur2)
5898 return FALSE;
5899 }
5900 else {
5901 bool is_utf8 = TRUE;
5902
5903 if (SvUTF8(sv1)) {
5904 /* sv1 is the UTF-8 one,
5905 * if is equal it must be downgrade-able */
5906 char *pv = (char*)bytes_from_utf8((U8*)pv1,
5907 &cur1, &is_utf8);
5908 if (pv != pv1)
553e1bcc 5909 pv1 = tpv = pv;
799ef3cb
JH
5910 }
5911 else {
5912 /* sv2 is the UTF-8 one,
5913 * if is equal it must be downgrade-able */
5914 char *pv = (char *)bytes_from_utf8((U8*)pv2,
5915 &cur2, &is_utf8);
5916 if (pv != pv2)
553e1bcc 5917 pv2 = tpv = pv;
799ef3cb
JH
5918 }
5919 if (is_utf8) {
5920 /* Downgrade not possible - cannot be eq */
5921 return FALSE;
5922 }
5923 }
cf48d248
JH
5924 }
5925
5926 if (cur1 == cur2)
765f542d 5927 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
e01b9e88 5928
553e1bcc
AT
5929 if (svrecode)
5930 SvREFCNT_dec(svrecode);
799ef3cb 5931
553e1bcc
AT
5932 if (tpv)
5933 Safefree(tpv);
cf48d248 5934
e01b9e88 5935 return eq;
79072805
LW
5936}
5937
954c1994
GS
5938/*
5939=for apidoc sv_cmp
5940
5941Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
5942string in C<sv1> is less than, equal to, or greater than the string in
645c22ef
DM
5943C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
5944coerce its args to strings if necessary. See also C<sv_cmp_locale>.
954c1994
GS
5945
5946=cut
5947*/
5948
79072805 5949I32
e01b9e88 5950Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
79072805 5951{
560a288e 5952 STRLEN cur1, cur2;
553e1bcc 5953 char *pv1, *pv2, *tpv = Nullch;
cf48d248 5954 I32 cmp;
553e1bcc 5955 SV *svrecode = Nullsv;
560a288e 5956
e01b9e88
SC
5957 if (!sv1) {
5958 pv1 = "";
560a288e
GS
5959 cur1 = 0;
5960 }
e01b9e88
SC
5961 else
5962 pv1 = SvPV(sv1, cur1);
560a288e 5963
553e1bcc 5964 if (!sv2) {
e01b9e88 5965 pv2 = "";
560a288e
GS
5966 cur2 = 0;
5967 }
e01b9e88
SC
5968 else
5969 pv2 = SvPV(sv2, cur2);
79072805 5970
cf48d248 5971 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
799ef3cb
JH
5972 /* Differing utf8ness.
5973 * Do not UTF8size the comparands as a side-effect. */
cf48d248 5974 if (SvUTF8(sv1)) {
799ef3cb 5975 if (PL_encoding) {
553e1bcc
AT
5976 svrecode = newSVpvn(pv2, cur2);
5977 sv_recode_to_utf8(svrecode, PL_encoding);
5978 pv2 = SvPV(svrecode, cur2);
799ef3cb
JH
5979 }
5980 else {
553e1bcc 5981 pv2 = tpv = (char*)bytes_to_utf8((U8*)pv2, &cur2);
799ef3cb 5982 }
cf48d248
JH
5983 }
5984 else {
799ef3cb 5985 if (PL_encoding) {
553e1bcc
AT
5986 svrecode = newSVpvn(pv1, cur1);
5987 sv_recode_to_utf8(svrecode, PL_encoding);
5988 pv1 = SvPV(svrecode, cur1);
799ef3cb
JH
5989 }
5990 else {
553e1bcc 5991 pv1 = tpv = (char*)bytes_to_utf8((U8*)pv1, &cur1);
799ef3cb 5992 }
cf48d248
JH
5993 }
5994 }
5995
e01b9e88 5996 if (!cur1) {
cf48d248 5997 cmp = cur2 ? -1 : 0;
e01b9e88 5998 } else if (!cur2) {
cf48d248
JH
5999 cmp = 1;
6000 } else {
6001 I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
e01b9e88
SC
6002
6003 if (retval) {
cf48d248 6004 cmp = retval < 0 ? -1 : 1;
e01b9e88 6005 } else if (cur1 == cur2) {
cf48d248
JH
6006 cmp = 0;
6007 } else {
6008 cmp = cur1 < cur2 ? -1 : 1;
e01b9e88 6009 }
cf48d248 6010 }
16660edb 6011
553e1bcc
AT
6012 if (svrecode)
6013 SvREFCNT_dec(svrecode);
799ef3cb 6014
553e1bcc
AT
6015 if (tpv)
6016 Safefree(tpv);
cf48d248
JH
6017
6018 return cmp;
bbce6d69 6019}
16660edb 6020
c461cf8f
JH
6021/*
6022=for apidoc sv_cmp_locale
6023
645c22ef
DM
6024Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6025'use bytes' aware, handles get magic, and will coerce its args to strings
6026if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
c461cf8f
JH
6027
6028=cut
6029*/
6030
bbce6d69 6031I32
864dbfa3 6032Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
bbce6d69 6033{
36477c24 6034#ifdef USE_LOCALE_COLLATE
16660edb 6035
bbce6d69 6036 char *pv1, *pv2;
6037 STRLEN len1, len2;
6038 I32 retval;
16660edb 6039
3280af22 6040 if (PL_collation_standard)
bbce6d69 6041 goto raw_compare;
16660edb 6042
bbce6d69 6043 len1 = 0;
8ac85365 6044 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
bbce6d69 6045 len2 = 0;
8ac85365 6046 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
16660edb 6047
bbce6d69 6048 if (!pv1 || !len1) {
6049 if (pv2 && len2)
6050 return -1;
6051 else
6052 goto raw_compare;
6053 }
6054 else {
6055 if (!pv2 || !len2)
6056 return 1;
6057 }
16660edb 6058
bbce6d69 6059 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
16660edb 6060
bbce6d69 6061 if (retval)
16660edb 6062 return retval < 0 ? -1 : 1;
6063
bbce6d69 6064 /*
6065 * When the result of collation is equality, that doesn't mean
6066 * that there are no differences -- some locales exclude some
6067 * characters from consideration. So to avoid false equalities,
6068 * we use the raw string as a tiebreaker.
6069 */
16660edb 6070
bbce6d69 6071 raw_compare:
6072 /* FALL THROUGH */
16660edb 6073
36477c24 6074#endif /* USE_LOCALE_COLLATE */
16660edb 6075
bbce6d69 6076 return sv_cmp(sv1, sv2);
6077}
79072805 6078
645c22ef 6079
36477c24 6080#ifdef USE_LOCALE_COLLATE
645c22ef 6081
7a4c00b4 6082/*
645c22ef
DM
6083=for apidoc sv_collxfrm
6084
6085Add Collate Transform magic to an SV if it doesn't already have it.
6086
6087Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6088scalar data of the variable, but transformed to such a format that a normal
6089memory comparison can be used to compare the data according to the locale
6090settings.
6091
6092=cut
6093*/
6094
bbce6d69 6095char *
864dbfa3 6096Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
bbce6d69 6097{
7a4c00b4 6098 MAGIC *mg;
16660edb 6099
14befaf4 6100 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
3280af22 6101 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
bbce6d69 6102 char *s, *xf;
6103 STRLEN len, xlen;
6104
7a4c00b4 6105 if (mg)
6106 Safefree(mg->mg_ptr);
bbce6d69 6107 s = SvPV(sv, len);
6108 if ((xf = mem_collxfrm(s, len, &xlen))) {
ff0cee69 6109 if (SvREADONLY(sv)) {
6110 SAVEFREEPV(xf);
6111 *nxp = xlen;
3280af22 6112 return xf + sizeof(PL_collation_ix);
ff0cee69 6113 }
7a4c00b4 6114 if (! mg) {
14befaf4
DM
6115 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6116 mg = mg_find(sv, PERL_MAGIC_collxfrm);
7a4c00b4 6117 assert(mg);
bbce6d69 6118 }
7a4c00b4 6119 mg->mg_ptr = xf;
565764a8 6120 mg->mg_len = xlen;
7a4c00b4 6121 }
6122 else {
ff0cee69 6123 if (mg) {
6124 mg->mg_ptr = NULL;
565764a8 6125 mg->mg_len = -1;
ff0cee69 6126 }
bbce6d69 6127 }
6128 }
7a4c00b4 6129 if (mg && mg->mg_ptr) {
565764a8 6130 *nxp = mg->mg_len;
3280af22 6131 return mg->mg_ptr + sizeof(PL_collation_ix);
bbce6d69 6132 }
6133 else {
6134 *nxp = 0;
6135 return NULL;
16660edb 6136 }
79072805
LW
6137}
6138
36477c24 6139#endif /* USE_LOCALE_COLLATE */
bbce6d69 6140
c461cf8f
JH
6141/*
6142=for apidoc sv_gets
6143
6144Get a line from the filehandle and store it into the SV, optionally
6145appending to the currently-stored string.
6146
6147=cut
6148*/
6149
79072805 6150char *
864dbfa3 6151Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
79072805 6152{
c07a80fd 6153 char *rsptr;
6154 STRLEN rslen;
6155 register STDCHAR rslast;
6156 register STDCHAR *bp;
6157 register I32 cnt;
9c5ffd7c 6158 I32 i = 0;
8bfdd7d9 6159 I32 rspara = 0;
e311fd51 6160 I32 recsize;
c07a80fd 6161
765f542d
NC
6162 SV_CHECK_THINKFIRST_COW_DROP(sv);
6163 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6164 from <>.
6165 However, perlbench says it's slower, because the existing swipe code
6166 is faster than copy on write.
6167 Swings and roundabouts. */
6fc92669 6168 (void)SvUPGRADE(sv, SVt_PV);
99491443 6169
ff68c719 6170 SvSCREAM_off(sv);
e311fd51 6171 SvPOK_only(sv); /* Validate pointer */
c07a80fd 6172
8bfdd7d9
HS
6173 if (PL_curcop == &PL_compiling) {
6174 /* we always read code in line mode */
6175 rsptr = "\n";
6176 rslen = 1;
6177 }
6178 else if (RsSNARF(PL_rs)) {
e468d35b
NIS
6179 /* If it is a regular disk file use size from stat() as estimate
6180 of amount we are going to read - may result in malloc-ing
6181 more memory than we realy need if layers bellow reduce
6182 size we read (e.g. CRLF or a gzip layer)
6183 */
e311fd51 6184 Stat_t st;
e468d35b
NIS
6185 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6186 Off_t offset = PerlIO_tell(fp);
6187 if (offset != (Off_t) -1) {
6188 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6189 }
6190 }
c07a80fd 6191 rsptr = NULL;
6192 rslen = 0;
6193 }
3280af22 6194 else if (RsRECORD(PL_rs)) {
e311fd51 6195 I32 bytesread;
5b2b9c68
HM
6196 char *buffer;
6197
6198 /* Grab the size of the record we're getting */
3280af22 6199 recsize = SvIV(SvRV(PL_rs));
e311fd51 6200 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5b2b9c68
HM
6201 /* Go yank in */
6202#ifdef VMS
6203 /* VMS wants read instead of fread, because fread doesn't respect */
6204 /* RMS record boundaries. This is not necessarily a good thing to be */
e468d35b
NIS
6205 /* doing, but we've got no other real choice - except avoid stdio
6206 as implementation - perhaps write a :vms layer ?
6207 */
5b2b9c68
HM
6208 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6209#else
6210 bytesread = PerlIO_read(fp, buffer, recsize);
6211#endif
e311fd51 6212 SvCUR_set(sv, bytesread += append);
e670df4e 6213 buffer[bytesread] = '\0';
e311fd51 6214 goto check_utf8_and_return;
5b2b9c68 6215 }
3280af22 6216 else if (RsPARA(PL_rs)) {
c07a80fd 6217 rsptr = "\n\n";
6218 rslen = 2;
8bfdd7d9 6219 rspara = 1;
c07a80fd 6220 }
7d59b7e4
NIS
6221 else {
6222 /* Get $/ i.e. PL_rs into same encoding as stream wants */
6223 if (PerlIO_isutf8(fp)) {
6224 rsptr = SvPVutf8(PL_rs, rslen);
6225 }
6226 else {
6227 if (SvUTF8(PL_rs)) {
6228 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
6229 Perl_croak(aTHX_ "Wide character in $/");
6230 }
6231 }
6232 rsptr = SvPV(PL_rs, rslen);
6233 }
6234 }
6235
c07a80fd 6236 rslast = rslen ? rsptr[rslen - 1] : '\0';
6237
8bfdd7d9 6238 if (rspara) { /* have to do this both before and after */
79072805 6239 do { /* to make sure file boundaries work right */
760ac839 6240 if (PerlIO_eof(fp))
a0d0e21e 6241 return 0;
760ac839 6242 i = PerlIO_getc(fp);
79072805 6243 if (i != '\n') {
a0d0e21e
LW
6244 if (i == -1)
6245 return 0;
760ac839 6246 PerlIO_ungetc(fp,i);
79072805
LW
6247 break;
6248 }
6249 } while (i != EOF);
6250 }
c07a80fd 6251
760ac839
LW
6252 /* See if we know enough about I/O mechanism to cheat it ! */
6253
6254 /* This used to be #ifdef test - it is made run-time test for ease
1c846c1f 6255 of abstracting out stdio interface. One call should be cheap
760ac839
LW
6256 enough here - and may even be a macro allowing compile
6257 time optimization.
6258 */
6259
6260 if (PerlIO_fast_gets(fp)) {
6261
6262 /*
6263 * We're going to steal some values from the stdio struct
6264 * and put EVERYTHING in the innermost loop into registers.
6265 */
6266 register STDCHAR *ptr;
6267 STRLEN bpx;
6268 I32 shortbuffered;
6269
16660edb 6270#if defined(VMS) && defined(PERLIO_IS_STDIO)
6271 /* An ungetc()d char is handled separately from the regular
6272 * buffer, so we getc() it back out and stuff it in the buffer.
6273 */
6274 i = PerlIO_getc(fp);
6275 if (i == EOF) return 0;
6276 *(--((*fp)->_ptr)) = (unsigned char) i;
6277 (*fp)->_cnt++;
6278#endif
c07a80fd 6279
c2960299 6280 /* Here is some breathtakingly efficient cheating */
c07a80fd 6281
a20bf0c3 6282 cnt = PerlIO_get_cnt(fp); /* get count into register */
e468d35b
NIS
6283 /* make sure we have the room */
6284 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
6285 /* Not room for all of it
6286 if we are looking for a separator and room for some
6287 */
6288 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
6289 /* just process what we have room for */
79072805
LW
6290 shortbuffered = cnt - SvLEN(sv) + append + 1;
6291 cnt -= shortbuffered;
6292 }
6293 else {
6294 shortbuffered = 0;
bbce6d69 6295 /* remember that cnt can be negative */
eb160463 6296 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
79072805
LW
6297 }
6298 }
e468d35b 6299 else
79072805 6300 shortbuffered = 0;
c07a80fd 6301 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
a20bf0c3 6302 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
16660edb 6303 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 6304 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
16660edb 6305 DEBUG_P(PerlIO_printf(Perl_debug_log,
ba7abf9d 6306 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
1c846c1f 6307 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
1d7c1841 6308 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
79072805
LW
6309 for (;;) {
6310 screamer:
93a17b20 6311 if (cnt > 0) {
c07a80fd 6312 if (rslen) {
760ac839
LW
6313 while (cnt > 0) { /* this | eat */
6314 cnt--;
c07a80fd 6315 if ((*bp++ = *ptr++) == rslast) /* really | dust */
6316 goto thats_all_folks; /* screams | sed :-) */
6317 }
6318 }
6319 else {
1c846c1f
NIS
6320 Copy(ptr, bp, cnt, char); /* this | eat */
6321 bp += cnt; /* screams | dust */
c07a80fd 6322 ptr += cnt; /* louder | sed :-) */
a5f75d66 6323 cnt = 0;
93a17b20 6324 }
79072805
LW
6325 }
6326
748a9306 6327 if (shortbuffered) { /* oh well, must extend */
79072805
LW
6328 cnt = shortbuffered;
6329 shortbuffered = 0;
c07a80fd 6330 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
79072805
LW
6331 SvCUR_set(sv, bpx);
6332 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
c07a80fd 6333 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
79072805
LW
6334 continue;
6335 }
6336
16660edb 6337 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841
GS
6338 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
6339 PTR2UV(ptr),(long)cnt));
cc00df79 6340 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
ba7abf9d 6341#if 0
16660edb 6342 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 6343 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
1c846c1f 6344 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
1d7c1841 6345 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
ba7abf9d 6346#endif
1c846c1f 6347 /* This used to call 'filbuf' in stdio form, but as that behaves like
774d564b 6348 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
6349 another abstraction. */
760ac839 6350 i = PerlIO_getc(fp); /* get more characters */
ba7abf9d 6351#if 0
16660edb 6352 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 6353 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
1c846c1f 6354 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
1d7c1841 6355 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
ba7abf9d 6356#endif
a20bf0c3
JH
6357 cnt = PerlIO_get_cnt(fp);
6358 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
16660edb 6359 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 6360 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
79072805 6361
748a9306
LW
6362 if (i == EOF) /* all done for ever? */
6363 goto thats_really_all_folks;
6364
c07a80fd 6365 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
79072805
LW
6366 SvCUR_set(sv, bpx);
6367 SvGROW(sv, bpx + cnt + 2);
c07a80fd 6368 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
6369
eb160463 6370 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
79072805 6371
c07a80fd 6372 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
79072805 6373 goto thats_all_folks;
79072805
LW
6374 }
6375
6376thats_all_folks:
eb160463 6377 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
36477c24 6378 memNE((char*)bp - rslen, rsptr, rslen))
760ac839 6379 goto screamer; /* go back to the fray */
79072805
LW
6380thats_really_all_folks:
6381 if (shortbuffered)
6382 cnt += shortbuffered;
16660edb 6383 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 6384 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
cc00df79 6385 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
16660edb 6386 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 6387 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
1c846c1f 6388 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
1d7c1841 6389 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
79072805 6390 *bp = '\0';
760ac839 6391 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
16660edb 6392 DEBUG_P(PerlIO_printf(Perl_debug_log,
fb73857a 6393 "Screamer: done, len=%ld, string=|%.*s|\n",
6394 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
760ac839
LW
6395 }
6396 else
79072805 6397 {
4d2c4e07 6398#ifndef EPOC
760ac839 6399 /*The big, slow, and stupid way */
c07a80fd 6400 STDCHAR buf[8192];
4d2c4e07
OF
6401#else
6402 /* Need to work around EPOC SDK features */
6403 /* On WINS: MS VC5 generates calls to _chkstk, */
6404 /* if a `large' stack frame is allocated */
6405 /* gcc on MARM does not generate calls like these */
6406 STDCHAR buf[1024];
6407#endif
79072805 6408
760ac839 6409screamer2:
c07a80fd 6410 if (rslen) {
760ac839
LW
6411 register STDCHAR *bpe = buf + sizeof(buf);
6412 bp = buf;
eb160463 6413 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
760ac839
LW
6414 ; /* keep reading */
6415 cnt = bp - buf;
c07a80fd 6416 }
6417 else {
760ac839 6418 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
16660edb 6419 /* Accomodate broken VAXC compiler, which applies U8 cast to
6420 * both args of ?: operator, causing EOF to change into 255
6421 */
37be0adf 6422 if (cnt > 0)
cbe9e203
JH
6423 i = (U8)buf[cnt - 1];
6424 else
37be0adf 6425 i = EOF;
c07a80fd 6426 }
79072805 6427
cbe9e203
JH
6428 if (cnt < 0)
6429 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
6430 if (append)
6431 sv_catpvn(sv, (char *) buf, cnt);
6432 else
6433 sv_setpvn(sv, (char *) buf, cnt);
c07a80fd 6434
6435 if (i != EOF && /* joy */
6436 (!rslen ||
6437 SvCUR(sv) < rslen ||
36477c24 6438 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
79072805
LW
6439 {
6440 append = -1;
63e4d877
CS
6441 /*
6442 * If we're reading from a TTY and we get a short read,
6443 * indicating that the user hit his EOF character, we need
6444 * to notice it now, because if we try to read from the TTY
6445 * again, the EOF condition will disappear.
6446 *
6447 * The comparison of cnt to sizeof(buf) is an optimization
6448 * that prevents unnecessary calls to feof().
6449 *
6450 * - jik 9/25/96
6451 */
6452 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
6453 goto screamer2;
79072805
LW
6454 }
6455 }
6456
8bfdd7d9 6457 if (rspara) { /* have to do this both before and after */
c07a80fd 6458 while (i != EOF) { /* to make sure file boundaries work right */
760ac839 6459 i = PerlIO_getc(fp);
79072805 6460 if (i != '\n') {
760ac839 6461 PerlIO_ungetc(fp,i);
79072805
LW
6462 break;
6463 }
6464 }
6465 }
c07a80fd 6466
e311fd51 6467check_utf8_and_return:
7d59b7e4
NIS
6468 if (PerlIO_isutf8(fp))
6469 SvUTF8_on(sv);
6470 else
6471 SvUTF8_off(sv);
6472
c07a80fd 6473 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
79072805
LW
6474}
6475
954c1994
GS
6476/*
6477=for apidoc sv_inc
6478
645c22ef
DM
6479Auto-increment of the value in the SV, doing string to numeric conversion
6480if necessary. Handles 'get' magic.
954c1994
GS
6481
6482=cut
6483*/
6484
79072805 6485void
864dbfa3 6486Perl_sv_inc(pTHX_ register SV *sv)
79072805
LW
6487{
6488 register char *d;
463ee0b2 6489 int flags;
79072805
LW
6490
6491 if (!sv)
6492 return;
b23a5f78
GB
6493 if (SvGMAGICAL(sv))
6494 mg_get(sv);
ed6116ce 6495 if (SvTHINKFIRST(sv)) {
765f542d
NC
6496 if (SvIsCOW(sv))
6497 sv_force_normal_flags(sv, 0);
0f15f207 6498 if (SvREADONLY(sv)) {
3280af22 6499 if (PL_curcop != &PL_compiling)
cea2e8a9 6500 Perl_croak(aTHX_ PL_no_modify);
0f15f207 6501 }
a0d0e21e 6502 if (SvROK(sv)) {
b5be31e9 6503 IV i;
9e7bc3e8
JD
6504 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
6505 return;
56431972 6506 i = PTR2IV(SvRV(sv));
b5be31e9
SM
6507 sv_unref(sv);
6508 sv_setiv(sv, i);
a0d0e21e 6509 }
ed6116ce 6510 }
8990e307 6511 flags = SvFLAGS(sv);
28e5dec8
JH
6512 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
6513 /* It's (privately or publicly) a float, but not tested as an
6514 integer, so test it to see. */
d460ef45 6515 (void) SvIV(sv);
28e5dec8
JH
6516 flags = SvFLAGS(sv);
6517 }
6518 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6519 /* It's publicly an integer, or privately an integer-not-float */
59d8ce62 6520#ifdef PERL_PRESERVE_IVUV
28e5dec8 6521 oops_its_int:
59d8ce62 6522#endif
25da4f38
IZ
6523 if (SvIsUV(sv)) {
6524 if (SvUVX(sv) == UV_MAX)
a1e868e7 6525 sv_setnv(sv, UV_MAX_P1);
25da4f38
IZ
6526 else
6527 (void)SvIOK_only_UV(sv);
6528 ++SvUVX(sv);
6529 } else {
6530 if (SvIVX(sv) == IV_MAX)
28e5dec8 6531 sv_setuv(sv, (UV)IV_MAX + 1);
25da4f38
IZ
6532 else {
6533 (void)SvIOK_only(sv);
6534 ++SvIVX(sv);
1c846c1f 6535 }
55497cff 6536 }
79072805
LW
6537 return;
6538 }
28e5dec8
JH
6539 if (flags & SVp_NOK) {
6540 (void)SvNOK_only(sv);
6541 SvNVX(sv) += 1.0;
6542 return;
6543 }
6544
8990e307 6545 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
28e5dec8
JH
6546 if ((flags & SVTYPEMASK) < SVt_PVIV)
6547 sv_upgrade(sv, SVt_IV);
6548 (void)SvIOK_only(sv);
6549 SvIVX(sv) = 1;
79072805
LW
6550 return;
6551 }
463ee0b2 6552 d = SvPVX(sv);
79072805
LW
6553 while (isALPHA(*d)) d++;
6554 while (isDIGIT(*d)) d++;
6555 if (*d) {
28e5dec8 6556#ifdef PERL_PRESERVE_IVUV
d1be9408 6557 /* Got to punt this as an integer if needs be, but we don't issue
28e5dec8
JH
6558 warnings. Probably ought to make the sv_iv_please() that does
6559 the conversion if possible, and silently. */
c2988b20 6560 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
28e5dec8
JH
6561 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6562 /* Need to try really hard to see if it's an integer.
6563 9.22337203685478e+18 is an integer.
6564 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6565 so $a="9.22337203685478e+18"; $a+0; $a++
6566 needs to be the same as $a="9.22337203685478e+18"; $a++
6567 or we go insane. */
d460ef45 6568
28e5dec8
JH
6569 (void) sv_2iv(sv);
6570 if (SvIOK(sv))
6571 goto oops_its_int;
6572
6573 /* sv_2iv *should* have made this an NV */
6574 if (flags & SVp_NOK) {
6575 (void)SvNOK_only(sv);
6576 SvNVX(sv) += 1.0;
6577 return;
6578 }
6579 /* I don't think we can get here. Maybe I should assert this
6580 And if we do get here I suspect that sv_setnv will croak. NWC
6581 Fall through. */
6582#if defined(USE_LONG_DOUBLE)
6583 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",
6584 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6585#else
1779d84d 6586 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
6587 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6588#endif
6589 }
6590#endif /* PERL_PRESERVE_IVUV */
6591 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
79072805
LW
6592 return;
6593 }
6594 d--;
463ee0b2 6595 while (d >= SvPVX(sv)) {
79072805
LW
6596 if (isDIGIT(*d)) {
6597 if (++*d <= '9')
6598 return;
6599 *(d--) = '0';
6600 }
6601 else {
9d116dd7
JH
6602#ifdef EBCDIC
6603 /* MKS: The original code here died if letters weren't consecutive.
6604 * at least it didn't have to worry about non-C locales. The
6605 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
1c846c1f 6606 * arranged in order (although not consecutively) and that only
9d116dd7
JH
6607 * [A-Za-z] are accepted by isALPHA in the C locale.
6608 */
6609 if (*d != 'z' && *d != 'Z') {
6610 do { ++*d; } while (!isALPHA(*d));
6611 return;
6612 }
6613 *(d--) -= 'z' - 'a';
6614#else
79072805
LW
6615 ++*d;
6616 if (isALPHA(*d))
6617 return;
6618 *(d--) -= 'z' - 'a' + 1;
9d116dd7 6619#endif
79072805
LW
6620 }
6621 }
6622 /* oh,oh, the number grew */
6623 SvGROW(sv, SvCUR(sv) + 2);
6624 SvCUR(sv)++;
463ee0b2 6625 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
79072805
LW
6626 *d = d[-1];
6627 if (isDIGIT(d[1]))
6628 *d = '1';
6629 else
6630 *d = d[1];
6631}
6632
954c1994
GS
6633/*
6634=for apidoc sv_dec
6635
645c22ef
DM
6636Auto-decrement of the value in the SV, doing string to numeric conversion
6637if necessary. Handles 'get' magic.
954c1994
GS
6638
6639=cut
6640*/
6641
79072805 6642void
864dbfa3 6643Perl_sv_dec(pTHX_ register SV *sv)
79072805 6644{
463ee0b2
LW
6645 int flags;
6646
79072805
LW
6647 if (!sv)
6648 return;
b23a5f78
GB
6649 if (SvGMAGICAL(sv))
6650 mg_get(sv);
ed6116ce 6651 if (SvTHINKFIRST(sv)) {
765f542d
NC
6652 if (SvIsCOW(sv))
6653 sv_force_normal_flags(sv, 0);
0f15f207 6654 if (SvREADONLY(sv)) {
3280af22 6655 if (PL_curcop != &PL_compiling)
cea2e8a9 6656 Perl_croak(aTHX_ PL_no_modify);
0f15f207 6657 }
a0d0e21e 6658 if (SvROK(sv)) {
b5be31e9 6659 IV i;
9e7bc3e8
JD
6660 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
6661 return;
56431972 6662 i = PTR2IV(SvRV(sv));
b5be31e9
SM
6663 sv_unref(sv);
6664 sv_setiv(sv, i);
a0d0e21e 6665 }
ed6116ce 6666 }
28e5dec8
JH
6667 /* Unlike sv_inc we don't have to worry about string-never-numbers
6668 and keeping them magic. But we mustn't warn on punting */
8990e307 6669 flags = SvFLAGS(sv);
28e5dec8
JH
6670 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
6671 /* It's publicly an integer, or privately an integer-not-float */
59d8ce62 6672#ifdef PERL_PRESERVE_IVUV
28e5dec8 6673 oops_its_int:
59d8ce62 6674#endif
25da4f38
IZ
6675 if (SvIsUV(sv)) {
6676 if (SvUVX(sv) == 0) {
6677 (void)SvIOK_only(sv);
6678 SvIVX(sv) = -1;
6679 }
6680 else {
6681 (void)SvIOK_only_UV(sv);
6682 --SvUVX(sv);
1c846c1f 6683 }
25da4f38
IZ
6684 } else {
6685 if (SvIVX(sv) == IV_MIN)
65202027 6686 sv_setnv(sv, (NV)IV_MIN - 1.0);
25da4f38
IZ
6687 else {
6688 (void)SvIOK_only(sv);
6689 --SvIVX(sv);
1c846c1f 6690 }
55497cff 6691 }
6692 return;
6693 }
28e5dec8
JH
6694 if (flags & SVp_NOK) {
6695 SvNVX(sv) -= 1.0;
6696 (void)SvNOK_only(sv);
6697 return;
6698 }
8990e307 6699 if (!(flags & SVp_POK)) {
4633a7c4
LW
6700 if ((flags & SVTYPEMASK) < SVt_PVNV)
6701 sv_upgrade(sv, SVt_NV);
463ee0b2 6702 SvNVX(sv) = -1.0;
a0d0e21e 6703 (void)SvNOK_only(sv);
79072805
LW
6704 return;
6705 }
28e5dec8
JH
6706#ifdef PERL_PRESERVE_IVUV
6707 {
c2988b20 6708 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
28e5dec8
JH
6709 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
6710 /* Need to try really hard to see if it's an integer.
6711 9.22337203685478e+18 is an integer.
6712 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
6713 so $a="9.22337203685478e+18"; $a+0; $a--
6714 needs to be the same as $a="9.22337203685478e+18"; $a--
6715 or we go insane. */
d460ef45 6716
28e5dec8
JH
6717 (void) sv_2iv(sv);
6718 if (SvIOK(sv))
6719 goto oops_its_int;
6720
6721 /* sv_2iv *should* have made this an NV */
6722 if (flags & SVp_NOK) {
6723 (void)SvNOK_only(sv);
6724 SvNVX(sv) -= 1.0;
6725 return;
6726 }
6727 /* I don't think we can get here. Maybe I should assert this
6728 And if we do get here I suspect that sv_setnv will croak. NWC
6729 Fall through. */
6730#if defined(USE_LONG_DOUBLE)
6731 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",
6732 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6733#else
1779d84d 6734 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
6735 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
6736#endif
6737 }
6738 }
6739#endif /* PERL_PRESERVE_IVUV */
097ee67d 6740 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
79072805
LW
6741}
6742
954c1994
GS
6743/*
6744=for apidoc sv_mortalcopy
6745
645c22ef 6746Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
d4236ebc
DM
6747The new SV is marked as mortal. It will be destroyed "soon", either by an
6748explicit call to FREETMPS, or by an implicit call at places such as
6749statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
954c1994
GS
6750
6751=cut
6752*/
6753
79072805
LW
6754/* Make a string that will exist for the duration of the expression
6755 * evaluation. Actually, it may have to last longer than that, but
6756 * hopefully we won't free it until it has been assigned to a
6757 * permanent location. */
6758
6759SV *
864dbfa3 6760Perl_sv_mortalcopy(pTHX_ SV *oldstr)
79072805 6761{
463ee0b2 6762 register SV *sv;
b881518d 6763
4561caa4 6764 new_SV(sv);
79072805 6765 sv_setsv(sv,oldstr);
677b06e3
GS
6766 EXTEND_MORTAL(1);
6767 PL_tmps_stack[++PL_tmps_ix] = sv;
8990e307
LW
6768 SvTEMP_on(sv);
6769 return sv;
6770}
6771
954c1994
GS
6772/*
6773=for apidoc sv_newmortal
6774
645c22ef 6775Creates a new null SV which is mortal. The reference count of the SV is
d4236ebc
DM
6776set to 1. It will be destroyed "soon", either by an explicit call to
6777FREETMPS, or by an implicit call at places such as statement boundaries.
6778See also C<sv_mortalcopy> and C<sv_2mortal>.
954c1994
GS
6779
6780=cut
6781*/
6782
8990e307 6783SV *
864dbfa3 6784Perl_sv_newmortal(pTHX)
8990e307
LW
6785{
6786 register SV *sv;
6787
4561caa4 6788 new_SV(sv);
8990e307 6789 SvFLAGS(sv) = SVs_TEMP;
677b06e3
GS
6790 EXTEND_MORTAL(1);
6791 PL_tmps_stack[++PL_tmps_ix] = sv;
79072805
LW
6792 return sv;
6793}
6794
954c1994
GS
6795/*
6796=for apidoc sv_2mortal
6797
d4236ebc
DM
6798Marks an existing SV as mortal. The SV will be destroyed "soon", either
6799by an explicit call to FREETMPS, or by an implicit call at places such as
6800statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
954c1994
GS
6801
6802=cut
6803*/
6804
79072805 6805SV *
864dbfa3 6806Perl_sv_2mortal(pTHX_ register SV *sv)
79072805
LW
6807{
6808 if (!sv)
6809 return sv;
d689ffdd 6810 if (SvREADONLY(sv) && SvIMMORTAL(sv))
11162842 6811 return sv;
677b06e3
GS
6812 EXTEND_MORTAL(1);
6813 PL_tmps_stack[++PL_tmps_ix] = sv;
8990e307 6814 SvTEMP_on(sv);
79072805
LW
6815 return sv;
6816}
6817
954c1994
GS
6818/*
6819=for apidoc newSVpv
6820
6821Creates a new SV and copies a string into it. The reference count for the
6822SV is set to 1. If C<len> is zero, Perl will compute the length using
6823strlen(). For efficiency, consider using C<newSVpvn> instead.
6824
6825=cut
6826*/
6827
79072805 6828SV *
864dbfa3 6829Perl_newSVpv(pTHX_ const char *s, STRLEN len)
79072805 6830{
463ee0b2 6831 register SV *sv;
79072805 6832
4561caa4 6833 new_SV(sv);
79072805
LW
6834 if (!len)
6835 len = strlen(s);
6836 sv_setpvn(sv,s,len);
6837 return sv;
6838}
6839
954c1994
GS
6840/*
6841=for apidoc newSVpvn
6842
6843Creates a new SV and copies a string into it. The reference count for the
1c846c1f 6844SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
954c1994
GS
6845string. You are responsible for ensuring that the source string is at least
6846C<len> bytes long.
6847
6848=cut
6849*/
6850
9da1e3b5 6851SV *
864dbfa3 6852Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
9da1e3b5
MUN
6853{
6854 register SV *sv;
6855
6856 new_SV(sv);
9da1e3b5
MUN
6857 sv_setpvn(sv,s,len);
6858 return sv;
6859}
6860
1c846c1f
NIS
6861/*
6862=for apidoc newSVpvn_share
6863
645c22ef
DM
6864Creates a new SV with its SvPVX pointing to a shared string in the string
6865table. If the string does not already exist in the table, it is created
6866first. Turns on READONLY and FAKE. The string's hash is stored in the UV
6867slot of the SV; if the C<hash> parameter is non-zero, that value is used;
6868otherwise the hash is computed. The idea here is that as the string table
6869is used for shared hash keys these strings will have SvPVX == HeKEY and
6870hash lookup will avoid string compare.
1c846c1f
NIS
6871
6872=cut
6873*/
6874
6875SV *
c3654f1a 6876Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
1c846c1f
NIS
6877{
6878 register SV *sv;
c3654f1a
IH
6879 bool is_utf8 = FALSE;
6880 if (len < 0) {
77caf834 6881 STRLEN tmplen = -len;
c3654f1a 6882 is_utf8 = TRUE;
75a54232
JH
6883 /* See the note in hv.c:hv_fetch() --jhi */
6884 src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
6885 len = tmplen;
6886 }
1c846c1f 6887 if (!hash)
5afd6d42 6888 PERL_HASH(hash, src, len);
1c846c1f
NIS
6889 new_SV(sv);
6890 sv_upgrade(sv, SVt_PVIV);
c3654f1a 6891 SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
1c846c1f
NIS
6892 SvCUR(sv) = len;
6893 SvUVX(sv) = hash;
6894 SvLEN(sv) = 0;
6895 SvREADONLY_on(sv);
6896 SvFAKE_on(sv);
6897 SvPOK_on(sv);
c3654f1a
IH
6898 if (is_utf8)
6899 SvUTF8_on(sv);
1c846c1f
NIS
6900 return sv;
6901}
6902
645c22ef 6903
cea2e8a9 6904#if defined(PERL_IMPLICIT_CONTEXT)
645c22ef
DM
6905
6906/* pTHX_ magic can't cope with varargs, so this is a no-context
6907 * version of the main function, (which may itself be aliased to us).
6908 * Don't access this version directly.
6909 */
6910
46fc3d4c 6911SV *
cea2e8a9 6912Perl_newSVpvf_nocontext(const char* pat, ...)
46fc3d4c 6913{
cea2e8a9 6914 dTHX;
46fc3d4c 6915 register SV *sv;
6916 va_list args;
46fc3d4c 6917 va_start(args, pat);
c5be433b 6918 sv = vnewSVpvf(pat, &args);
46fc3d4c 6919 va_end(args);
6920 return sv;
6921}
cea2e8a9 6922#endif
46fc3d4c 6923
954c1994
GS
6924/*
6925=for apidoc newSVpvf
6926
645c22ef 6927Creates a new SV and initializes it with the string formatted like
954c1994
GS
6928C<sprintf>.
6929
6930=cut
6931*/
6932
cea2e8a9
GS
6933SV *
6934Perl_newSVpvf(pTHX_ const char* pat, ...)
6935{
6936 register SV *sv;
6937 va_list args;
cea2e8a9 6938 va_start(args, pat);
c5be433b 6939 sv = vnewSVpvf(pat, &args);
cea2e8a9
GS
6940 va_end(args);
6941 return sv;
6942}
46fc3d4c 6943
645c22ef
DM
6944/* backend for newSVpvf() and newSVpvf_nocontext() */
6945
79072805 6946SV *
c5be433b
GS
6947Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
6948{
6949 register SV *sv;
6950 new_SV(sv);
6951 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
6952 return sv;
6953}
6954
954c1994
GS
6955/*
6956=for apidoc newSVnv
6957
6958Creates a new SV and copies a floating point value into it.
6959The reference count for the SV is set to 1.
6960
6961=cut
6962*/
6963
c5be433b 6964SV *
65202027 6965Perl_newSVnv(pTHX_ NV n)
79072805 6966{
463ee0b2 6967 register SV *sv;
79072805 6968
4561caa4 6969 new_SV(sv);
79072805
LW
6970 sv_setnv(sv,n);
6971 return sv;
6972}
6973
954c1994
GS
6974/*
6975=for apidoc newSViv
6976
6977Creates a new SV and copies an integer into it. The reference count for the
6978SV is set to 1.
6979
6980=cut
6981*/
6982
79072805 6983SV *
864dbfa3 6984Perl_newSViv(pTHX_ IV i)
79072805 6985{
463ee0b2 6986 register SV *sv;
79072805 6987
4561caa4 6988 new_SV(sv);
79072805
LW
6989 sv_setiv(sv,i);
6990 return sv;
6991}
6992
954c1994 6993/*
1a3327fb
JH
6994=for apidoc newSVuv
6995
6996Creates a new SV and copies an unsigned integer into it.
6997The reference count for the SV is set to 1.
6998
6999=cut
7000*/
7001
7002SV *
7003Perl_newSVuv(pTHX_ UV u)
7004{
7005 register SV *sv;
7006
7007 new_SV(sv);
7008 sv_setuv(sv,u);
7009 return sv;
7010}
7011
7012/*
954c1994
GS
7013=for apidoc newRV_noinc
7014
7015Creates an RV wrapper for an SV. The reference count for the original
7016SV is B<not> incremented.
7017
7018=cut
7019*/
7020
2304df62 7021SV *
864dbfa3 7022Perl_newRV_noinc(pTHX_ SV *tmpRef)
2304df62
AD
7023{
7024 register SV *sv;
7025
4561caa4 7026 new_SV(sv);
2304df62 7027 sv_upgrade(sv, SVt_RV);
76e3520e 7028 SvTEMP_off(tmpRef);
d689ffdd 7029 SvRV(sv) = tmpRef;
2304df62 7030 SvROK_on(sv);
2304df62
AD
7031 return sv;
7032}
7033
ff276b08 7034/* newRV_inc is the official function name to use now.
645c22ef
DM
7035 * newRV_inc is in fact #defined to newRV in sv.h
7036 */
7037
5f05dabc 7038SV *
864dbfa3 7039Perl_newRV(pTHX_ SV *tmpRef)
5f05dabc 7040{
5f6447b6 7041 return newRV_noinc(SvREFCNT_inc(tmpRef));
5f05dabc 7042}
5f05dabc 7043
954c1994
GS
7044/*
7045=for apidoc newSVsv
7046
7047Creates a new SV which is an exact duplicate of the original SV.
645c22ef 7048(Uses C<sv_setsv>).
954c1994
GS
7049
7050=cut
7051*/
7052
79072805 7053SV *
864dbfa3 7054Perl_newSVsv(pTHX_ register SV *old)
79072805 7055{
463ee0b2 7056 register SV *sv;
79072805
LW
7057
7058 if (!old)
7059 return Nullsv;
8990e307 7060 if (SvTYPE(old) == SVTYPEMASK) {
0453d815 7061 if (ckWARN_d(WARN_INTERNAL))
9014280d 7062 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
79072805
LW
7063 return Nullsv;
7064 }
4561caa4 7065 new_SV(sv);
ff68c719 7066 if (SvTEMP(old)) {
7067 SvTEMP_off(old);
463ee0b2 7068 sv_setsv(sv,old);
ff68c719 7069 SvTEMP_on(old);
79072805
LW
7070 }
7071 else
463ee0b2
LW
7072 sv_setsv(sv,old);
7073 return sv;
79072805
LW
7074}
7075
645c22ef
DM
7076/*
7077=for apidoc sv_reset
7078
7079Underlying implementation for the C<reset> Perl function.
7080Note that the perl-level function is vaguely deprecated.
7081
7082=cut
7083*/
7084
79072805 7085void
864dbfa3 7086Perl_sv_reset(pTHX_ register char *s, HV *stash)
79072805
LW
7087{
7088 register HE *entry;
7089 register GV *gv;
7090 register SV *sv;
7091 register I32 i;
7092 register PMOP *pm;
7093 register I32 max;
4802d5d7 7094 char todo[PERL_UCHAR_MAX+1];
79072805 7095
49d8d3a1
MB
7096 if (!stash)
7097 return;
7098
79072805
LW
7099 if (!*s) { /* reset ?? searches */
7100 for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
48c036b1 7101 pm->op_pmdynflags &= ~PMdf_USED;
79072805
LW
7102 }
7103 return;
7104 }
7105
7106 /* reset variables */
7107
7108 if (!HvARRAY(stash))
7109 return;
463ee0b2
LW
7110
7111 Zero(todo, 256, char);
79072805 7112 while (*s) {
4802d5d7 7113 i = (unsigned char)*s;
79072805
LW
7114 if (s[1] == '-') {
7115 s += 2;
7116 }
4802d5d7 7117 max = (unsigned char)*s++;
79072805 7118 for ( ; i <= max; i++) {
463ee0b2
LW
7119 todo[i] = 1;
7120 }
a0d0e21e 7121 for (i = 0; i <= (I32) HvMAX(stash); i++) {
79072805 7122 for (entry = HvARRAY(stash)[i];
9e35f4b3
GS
7123 entry;
7124 entry = HeNEXT(entry))
7125 {
1edc1566 7126 if (!todo[(U8)*HeKEY(entry)])
463ee0b2 7127 continue;
1edc1566 7128 gv = (GV*)HeVAL(entry);
79072805 7129 sv = GvSV(gv);
9e35f4b3
GS
7130 if (SvTHINKFIRST(sv)) {
7131 if (!SvREADONLY(sv) && SvROK(sv))
7132 sv_unref(sv);
7133 continue;
7134 }
a0d0e21e 7135 (void)SvOK_off(sv);
79072805
LW
7136 if (SvTYPE(sv) >= SVt_PV) {
7137 SvCUR_set(sv, 0);
463ee0b2
LW
7138 if (SvPVX(sv) != Nullch)
7139 *SvPVX(sv) = '\0';
44a8e56a 7140 SvTAINT(sv);
79072805
LW
7141 }
7142 if (GvAV(gv)) {
7143 av_clear(GvAV(gv));
7144 }
44a8e56a 7145 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
463ee0b2 7146 hv_clear(GvHV(gv));
fa6a1c44 7147#ifdef USE_ENVIRON_ARRAY
4efc5df6
GS
7148 if (gv == PL_envgv
7149# ifdef USE_ITHREADS
7150 && PL_curinterp == aTHX
7151# endif
7152 )
7153 {
79072805 7154 environ[0] = Nullch;
4efc5df6 7155 }
a0d0e21e 7156#endif
79072805
LW
7157 }
7158 }
7159 }
7160 }
7161}
7162
645c22ef
DM
7163/*
7164=for apidoc sv_2io
7165
7166Using various gambits, try to get an IO from an SV: the IO slot if its a
7167GV; or the recursive result if we're an RV; or the IO slot of the symbol
7168named after the PV if we're a string.
7169
7170=cut
7171*/
7172
46fc3d4c 7173IO*
864dbfa3 7174Perl_sv_2io(pTHX_ SV *sv)
46fc3d4c 7175{
7176 IO* io;
7177 GV* gv;
2d8e6c8d 7178 STRLEN n_a;
46fc3d4c 7179
7180 switch (SvTYPE(sv)) {
7181 case SVt_PVIO:
7182 io = (IO*)sv;
7183 break;
7184 case SVt_PVGV:
7185 gv = (GV*)sv;
7186 io = GvIO(gv);
7187 if (!io)
cea2e8a9 7188 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
46fc3d4c 7189 break;
7190 default:
7191 if (!SvOK(sv))
cea2e8a9 7192 Perl_croak(aTHX_ PL_no_usym, "filehandle");
46fc3d4c 7193 if (SvROK(sv))
7194 return sv_2io(SvRV(sv));
2d8e6c8d 7195 gv = gv_fetchpv(SvPV(sv,n_a), FALSE, SVt_PVIO);
46fc3d4c 7196 if (gv)
7197 io = GvIO(gv);
7198 else
7199 io = 0;
7200 if (!io)
35c1215d 7201 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
46fc3d4c 7202 break;
7203 }
7204 return io;
7205}
7206
645c22ef
DM
7207/*
7208=for apidoc sv_2cv
7209
7210Using various gambits, try to get a CV from an SV; in addition, try if
7211possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
7212
7213=cut
7214*/
7215
79072805 7216CV *
864dbfa3 7217Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
79072805 7218{
c04a4dfe
JH
7219 GV *gv = Nullgv;
7220 CV *cv = Nullcv;
2d8e6c8d 7221 STRLEN n_a;
79072805
LW
7222
7223 if (!sv)
93a17b20 7224 return *gvp = Nullgv, Nullcv;
79072805 7225 switch (SvTYPE(sv)) {
79072805
LW
7226 case SVt_PVCV:
7227 *st = CvSTASH(sv);
7228 *gvp = Nullgv;
7229 return (CV*)sv;
7230 case SVt_PVHV:
7231 case SVt_PVAV:
7232 *gvp = Nullgv;
7233 return Nullcv;
8990e307
LW
7234 case SVt_PVGV:
7235 gv = (GV*)sv;
a0d0e21e 7236 *gvp = gv;
8990e307
LW
7237 *st = GvESTASH(gv);
7238 goto fix_gv;
7239
79072805 7240 default:
a0d0e21e
LW
7241 if (SvGMAGICAL(sv))
7242 mg_get(sv);
7243 if (SvROK(sv)) {
f5284f61
IZ
7244 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
7245 tryAMAGICunDEREF(to_cv);
7246
62f274bf
GS
7247 sv = SvRV(sv);
7248 if (SvTYPE(sv) == SVt_PVCV) {
7249 cv = (CV*)sv;
7250 *gvp = Nullgv;
7251 *st = CvSTASH(cv);
7252 return cv;
7253 }
7254 else if(isGV(sv))
7255 gv = (GV*)sv;
7256 else
cea2e8a9 7257 Perl_croak(aTHX_ "Not a subroutine reference");
a0d0e21e 7258 }
62f274bf 7259 else if (isGV(sv))
79072805
LW
7260 gv = (GV*)sv;
7261 else
2d8e6c8d 7262 gv = gv_fetchpv(SvPV(sv, n_a), lref, SVt_PVCV);
79072805
LW
7263 *gvp = gv;
7264 if (!gv)
7265 return Nullcv;
7266 *st = GvESTASH(gv);
8990e307 7267 fix_gv:
8ebc5c01 7268 if (lref && !GvCVu(gv)) {
4633a7c4 7269 SV *tmpsv;
748a9306 7270 ENTER;
4633a7c4 7271 tmpsv = NEWSV(704,0);
16660edb 7272 gv_efullname3(tmpsv, gv, Nullch);
f6ec51f7
GS
7273 /* XXX this is probably not what they think they're getting.
7274 * It has the same effect as "sub name;", i.e. just a forward
7275 * declaration! */
774d564b 7276 newSUB(start_subparse(FALSE, 0),
4633a7c4
LW
7277 newSVOP(OP_CONST, 0, tmpsv),
7278 Nullop,
8990e307 7279 Nullop);
748a9306 7280 LEAVE;
8ebc5c01 7281 if (!GvCVu(gv))
35c1215d
NC
7282 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
7283 sv);
8990e307 7284 }
8ebc5c01 7285 return GvCVu(gv);
79072805
LW
7286 }
7287}
7288
c461cf8f
JH
7289/*
7290=for apidoc sv_true
7291
7292Returns true if the SV has a true value by Perl's rules.
645c22ef
DM
7293Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
7294instead use an in-line version.
c461cf8f
JH
7295
7296=cut
7297*/
7298
79072805 7299I32
864dbfa3 7300Perl_sv_true(pTHX_ register SV *sv)
79072805 7301{
8990e307
LW
7302 if (!sv)
7303 return 0;
79072805 7304 if (SvPOK(sv)) {
4e35701f
NIS
7305 register XPV* tXpv;
7306 if ((tXpv = (XPV*)SvANY(sv)) &&
c2f1de04 7307 (tXpv->xpv_cur > 1 ||
4e35701f 7308 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
79072805
LW
7309 return 1;
7310 else
7311 return 0;
7312 }
7313 else {
7314 if (SvIOK(sv))
463ee0b2 7315 return SvIVX(sv) != 0;
79072805
LW
7316 else {
7317 if (SvNOK(sv))
463ee0b2 7318 return SvNVX(sv) != 0.0;
79072805 7319 else
463ee0b2 7320 return sv_2bool(sv);
79072805
LW
7321 }
7322 }
7323}
79072805 7324
645c22ef
DM
7325/*
7326=for apidoc sv_iv
7327
7328A private implementation of the C<SvIVx> macro for compilers which can't
7329cope with complex macro expressions. Always use the macro instead.
7330
7331=cut
7332*/
7333
ff68c719 7334IV
864dbfa3 7335Perl_sv_iv(pTHX_ register SV *sv)
85e6fe83 7336{
25da4f38
IZ
7337 if (SvIOK(sv)) {
7338 if (SvIsUV(sv))
7339 return (IV)SvUVX(sv);
ff68c719 7340 return SvIVX(sv);
25da4f38 7341 }
ff68c719 7342 return sv_2iv(sv);
85e6fe83 7343}
85e6fe83 7344
645c22ef
DM
7345/*
7346=for apidoc sv_uv
7347
7348A private implementation of the C<SvUVx> macro for compilers which can't
7349cope with complex macro expressions. Always use the macro instead.
7350
7351=cut
7352*/
7353
ff68c719 7354UV
864dbfa3 7355Perl_sv_uv(pTHX_ register SV *sv)
ff68c719 7356{
25da4f38
IZ
7357 if (SvIOK(sv)) {
7358 if (SvIsUV(sv))
7359 return SvUVX(sv);
7360 return (UV)SvIVX(sv);
7361 }
ff68c719 7362 return sv_2uv(sv);
7363}
85e6fe83 7364
645c22ef
DM
7365/*
7366=for apidoc sv_nv
7367
7368A private implementation of the C<SvNVx> macro for compilers which can't
7369cope with complex macro expressions. Always use the macro instead.
7370
7371=cut
7372*/
7373
65202027 7374NV
864dbfa3 7375Perl_sv_nv(pTHX_ register SV *sv)
79072805 7376{
ff68c719 7377 if (SvNOK(sv))
7378 return SvNVX(sv);
7379 return sv_2nv(sv);
79072805 7380}
79072805 7381
645c22ef
DM
7382/*
7383=for apidoc sv_pv
7384
baca2b92 7385Use the C<SvPV_nolen> macro instead
645c22ef 7386
645c22ef
DM
7387=for apidoc sv_pvn
7388
7389A private implementation of the C<SvPV> macro for compilers which can't
7390cope with complex macro expressions. Always use the macro instead.
7391
7392=cut
7393*/
7394
1fa8b10d 7395char *
864dbfa3 7396Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
79072805 7397{
85e6fe83
LW
7398 if (SvPOK(sv)) {
7399 *lp = SvCUR(sv);
a0d0e21e 7400 return SvPVX(sv);
85e6fe83 7401 }
463ee0b2 7402 return sv_2pv(sv, lp);
79072805 7403}
79072805 7404
6e9d1081
NC
7405
7406char *
7407Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
7408{
7409 if (SvPOK(sv)) {
7410 *lp = SvCUR(sv);
7411 return SvPVX(sv);
7412 }
7413 return sv_2pv_flags(sv, lp, 0);
7414}
7415
c461cf8f
JH
7416/*
7417=for apidoc sv_pvn_force
7418
7419Get a sensible string out of the SV somehow.
645c22ef
DM
7420A private implementation of the C<SvPV_force> macro for compilers which
7421can't cope with complex macro expressions. Always use the macro instead.
c461cf8f 7422
8d6d96c1
HS
7423=for apidoc sv_pvn_force_flags
7424
7425Get a sensible string out of the SV somehow.
7426If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
7427appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
7428implemented in terms of this function.
645c22ef
DM
7429You normally want to use the various wrapper macros instead: see
7430C<SvPV_force> and C<SvPV_force_nomg>
8d6d96c1
HS
7431
7432=cut
7433*/
7434
7435char *
7436Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
7437{
c04a4dfe 7438 char *s = NULL;
a0d0e21e 7439
6fc92669 7440 if (SvTHINKFIRST(sv) && !SvROK(sv))
765f542d 7441 sv_force_normal_flags(sv, 0);
1c846c1f 7442
a0d0e21e
LW
7443 if (SvPOK(sv)) {
7444 *lp = SvCUR(sv);
7445 }
7446 else {
748a9306 7447 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
cea2e8a9 7448 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
53e06cf0 7449 OP_NAME(PL_op));
a0d0e21e 7450 }
4633a7c4 7451 else
8d6d96c1 7452 s = sv_2pv_flags(sv, lp, flags);
a0d0e21e
LW
7453 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
7454 STRLEN len = *lp;
1c846c1f 7455
a0d0e21e
LW
7456 if (SvROK(sv))
7457 sv_unref(sv);
7458 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
7459 SvGROW(sv, len + 1);
7460 Move(s,SvPVX(sv),len,char);
7461 SvCUR_set(sv, len);
7462 *SvEND(sv) = '\0';
7463 }
7464 if (!SvPOK(sv)) {
7465 SvPOK_on(sv); /* validate pointer */
7466 SvTAINT(sv);
1d7c1841
GS
7467 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
7468 PTR2UV(sv),SvPVX(sv)));
a0d0e21e
LW
7469 }
7470 }
7471 return SvPVX(sv);
7472}
7473
645c22ef
DM
7474/*
7475=for apidoc sv_pvbyte
7476
baca2b92 7477Use C<SvPVbyte_nolen> instead.
645c22ef 7478
645c22ef
DM
7479=for apidoc sv_pvbyten
7480
7481A private implementation of the C<SvPVbyte> macro for compilers
7482which can't cope with complex macro expressions. Always use the macro
7483instead.
7484
7485=cut
7486*/
7487
7340a771
GS
7488char *
7489Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
7490{
ffebcc3e 7491 sv_utf8_downgrade(sv,0);
7340a771
GS
7492 return sv_pvn(sv,lp);
7493}
7494
645c22ef
DM
7495/*
7496=for apidoc sv_pvbyten_force
7497
7498A private implementation of the C<SvPVbytex_force> macro for compilers
7499which can't cope with complex macro expressions. Always use the macro
7500instead.
7501
7502=cut
7503*/
7504
7340a771
GS
7505char *
7506Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
7507{
ffebcc3e 7508 sv_utf8_downgrade(sv,0);
7340a771
GS
7509 return sv_pvn_force(sv,lp);
7510}
7511
645c22ef
DM
7512/*
7513=for apidoc sv_pvutf8
7514
baca2b92 7515Use the C<SvPVutf8_nolen> macro instead
645c22ef 7516
645c22ef
DM
7517=for apidoc sv_pvutf8n
7518
7519A private implementation of the C<SvPVutf8> macro for compilers
7520which can't cope with complex macro expressions. Always use the macro
7521instead.
7522
7523=cut
7524*/
7525
7340a771
GS
7526char *
7527Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
7528{
560a288e 7529 sv_utf8_upgrade(sv);
7340a771
GS
7530 return sv_pvn(sv,lp);
7531}
7532
c461cf8f
JH
7533/*
7534=for apidoc sv_pvutf8n_force
7535
645c22ef
DM
7536A private implementation of the C<SvPVutf8_force> macro for compilers
7537which can't cope with complex macro expressions. Always use the macro
7538instead.
c461cf8f
JH
7539
7540=cut
7541*/
7542
7340a771
GS
7543char *
7544Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
7545{
560a288e 7546 sv_utf8_upgrade(sv);
7340a771
GS
7547 return sv_pvn_force(sv,lp);
7548}
7549
c461cf8f
JH
7550/*
7551=for apidoc sv_reftype
7552
7553Returns a string describing what the SV is a reference to.
7554
7555=cut
7556*/
7557
7340a771 7558char *
864dbfa3 7559Perl_sv_reftype(pTHX_ SV *sv, int ob)
a0d0e21e 7560{
c86bf373 7561 if (ob && SvOBJECT(sv)) {
de11ba31 7562 return HvNAME(SvSTASH(sv));
c86bf373 7563 }
a0d0e21e
LW
7564 else {
7565 switch (SvTYPE(sv)) {
7566 case SVt_NULL:
7567 case SVt_IV:
7568 case SVt_NV:
7569 case SVt_RV:
7570 case SVt_PV:
7571 case SVt_PVIV:
7572 case SVt_PVNV:
7573 case SVt_PVMG:
7574 case SVt_PVBM:
439cb1c4
JP
7575 if (SvVOK(sv))
7576 return "VSTRING";
a0d0e21e
LW
7577 if (SvROK(sv))
7578 return "REF";
7579 else
7580 return "SCALAR";
7581 case SVt_PVLV: return "LVALUE";
7582 case SVt_PVAV: return "ARRAY";
7583 case SVt_PVHV: return "HASH";
7584 case SVt_PVCV: return "CODE";
7585 case SVt_PVGV: return "GLOB";
1d2dff63 7586 case SVt_PVFM: return "FORMAT";
27f9d8f3 7587 case SVt_PVIO: return "IO";
a0d0e21e
LW
7588 default: return "UNKNOWN";
7589 }
7590 }
7591}
7592
954c1994
GS
7593/*
7594=for apidoc sv_isobject
7595
7596Returns a boolean indicating whether the SV is an RV pointing to a blessed
7597object. If the SV is not an RV, or if the object is not blessed, then this
7598will return false.
7599
7600=cut
7601*/
7602
463ee0b2 7603int
864dbfa3 7604Perl_sv_isobject(pTHX_ SV *sv)
85e6fe83 7605{
68dc0745 7606 if (!sv)
7607 return 0;
7608 if (SvGMAGICAL(sv))
7609 mg_get(sv);
85e6fe83
LW
7610 if (!SvROK(sv))
7611 return 0;
7612 sv = (SV*)SvRV(sv);
7613 if (!SvOBJECT(sv))
7614 return 0;
7615 return 1;
7616}
7617
954c1994
GS
7618/*
7619=for apidoc sv_isa
7620
7621Returns a boolean indicating whether the SV is blessed into the specified
7622class. This does not check for subtypes; use C<sv_derived_from> to verify
7623an inheritance relationship.
7624
7625=cut
7626*/
7627
85e6fe83 7628int
864dbfa3 7629Perl_sv_isa(pTHX_ SV *sv, const char *name)
463ee0b2 7630{
68dc0745 7631 if (!sv)
7632 return 0;
7633 if (SvGMAGICAL(sv))
7634 mg_get(sv);
ed6116ce 7635 if (!SvROK(sv))
463ee0b2 7636 return 0;
ed6116ce
LW
7637 sv = (SV*)SvRV(sv);
7638 if (!SvOBJECT(sv))
463ee0b2
LW
7639 return 0;
7640
7641 return strEQ(HvNAME(SvSTASH(sv)), name);
7642}
7643
954c1994
GS
7644/*
7645=for apidoc newSVrv
7646
7647Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
7648it will be upgraded to one. If C<classname> is non-null then the new SV will
7649be blessed in the specified package. The new SV is returned and its
7650reference count is 1.
7651
7652=cut
7653*/
7654
463ee0b2 7655SV*
864dbfa3 7656Perl_newSVrv(pTHX_ SV *rv, const char *classname)
463ee0b2 7657{
463ee0b2
LW
7658 SV *sv;
7659
4561caa4 7660 new_SV(sv);
51cf62d8 7661
765f542d 7662 SV_CHECK_THINKFIRST_COW_DROP(rv);
51cf62d8 7663 SvAMAGIC_off(rv);
51cf62d8 7664
0199fce9
JD
7665 if (SvTYPE(rv) >= SVt_PVMG) {
7666 U32 refcnt = SvREFCNT(rv);
7667 SvREFCNT(rv) = 0;
7668 sv_clear(rv);
7669 SvFLAGS(rv) = 0;
7670 SvREFCNT(rv) = refcnt;
7671 }
7672
51cf62d8 7673 if (SvTYPE(rv) < SVt_RV)
0199fce9
JD
7674 sv_upgrade(rv, SVt_RV);
7675 else if (SvTYPE(rv) > SVt_RV) {
7676 (void)SvOOK_off(rv);
7677 if (SvPVX(rv) && SvLEN(rv))
7678 Safefree(SvPVX(rv));
7679 SvCUR_set(rv, 0);
7680 SvLEN_set(rv, 0);
7681 }
51cf62d8
OT
7682
7683 (void)SvOK_off(rv);
053fc874 7684 SvRV(rv) = sv;
ed6116ce 7685 SvROK_on(rv);
463ee0b2 7686
a0d0e21e
LW
7687 if (classname) {
7688 HV* stash = gv_stashpv(classname, TRUE);
7689 (void)sv_bless(rv, stash);
7690 }
7691 return sv;
7692}
7693
954c1994
GS
7694/*
7695=for apidoc sv_setref_pv
7696
7697Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
7698argument will be upgraded to an RV. That RV will be modified to point to
7699the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
7700into the SV. The C<classname> argument indicates the package for the
7701blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7702will be returned and will have a reference count of 1.
7703
7704Do not use with other Perl types such as HV, AV, SV, CV, because those
7705objects will become corrupted by the pointer copy process.
7706
7707Note that C<sv_setref_pvn> copies the string while this copies the pointer.
7708
7709=cut
7710*/
7711
a0d0e21e 7712SV*
864dbfa3 7713Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
a0d0e21e 7714{
189b2af5 7715 if (!pv) {
3280af22 7716 sv_setsv(rv, &PL_sv_undef);
189b2af5
GS
7717 SvSETMAGIC(rv);
7718 }
a0d0e21e 7719 else
56431972 7720 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
a0d0e21e
LW
7721 return rv;
7722}
7723
954c1994
GS
7724/*
7725=for apidoc sv_setref_iv
7726
7727Copies an integer into a new SV, optionally blessing the SV. The C<rv>
7728argument will be upgraded to an RV. That RV will be modified to point to
7729the new SV. The C<classname> argument indicates the package for the
7730blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7731will be returned and will have a reference count of 1.
7732
7733=cut
7734*/
7735
a0d0e21e 7736SV*
864dbfa3 7737Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
a0d0e21e
LW
7738{
7739 sv_setiv(newSVrv(rv,classname), iv);
7740 return rv;
7741}
7742
954c1994 7743/*
e1c57cef
JH
7744=for apidoc sv_setref_uv
7745
7746Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
7747argument will be upgraded to an RV. That RV will be modified to point to
7748the new SV. The C<classname> argument indicates the package for the
7749blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7750will be returned and will have a reference count of 1.
7751
7752=cut
7753*/
7754
7755SV*
7756Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
7757{
7758 sv_setuv(newSVrv(rv,classname), uv);
7759 return rv;
7760}
7761
7762/*
954c1994
GS
7763=for apidoc sv_setref_nv
7764
7765Copies a double into a new SV, optionally blessing the SV. The C<rv>
7766argument will be upgraded to an RV. That RV will be modified to point to
7767the new SV. The C<classname> argument indicates the package for the
7768blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
7769will be returned and will have a reference count of 1.
7770
7771=cut
7772*/
7773
a0d0e21e 7774SV*
65202027 7775Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
a0d0e21e
LW
7776{
7777 sv_setnv(newSVrv(rv,classname), nv);
7778 return rv;
7779}
463ee0b2 7780
954c1994
GS
7781/*
7782=for apidoc sv_setref_pvn
7783
7784Copies a string into a new SV, optionally blessing the SV. The length of the
7785string must be specified with C<n>. The C<rv> argument will be upgraded to
7786an RV. That RV will be modified to point to the new SV. The C<classname>
7787argument indicates the package for the blessing. Set C<classname> to
7788C<Nullch> to avoid the blessing. The new SV will be returned and will have
7789a reference count of 1.
7790
7791Note that C<sv_setref_pv> copies the pointer while this copies the string.
7792
7793=cut
7794*/
7795
a0d0e21e 7796SV*
864dbfa3 7797Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
a0d0e21e
LW
7798{
7799 sv_setpvn(newSVrv(rv,classname), pv, n);
463ee0b2
LW
7800 return rv;
7801}
7802
954c1994
GS
7803/*
7804=for apidoc sv_bless
7805
7806Blesses an SV into a specified package. The SV must be an RV. The package
7807must be designated by its stash (see C<gv_stashpv()>). The reference count
7808of the SV is unaffected.
7809
7810=cut
7811*/
7812
a0d0e21e 7813SV*
864dbfa3 7814Perl_sv_bless(pTHX_ SV *sv, HV *stash)
a0d0e21e 7815{
76e3520e 7816 SV *tmpRef;
a0d0e21e 7817 if (!SvROK(sv))
cea2e8a9 7818 Perl_croak(aTHX_ "Can't bless non-reference value");
76e3520e
GS
7819 tmpRef = SvRV(sv);
7820 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
7821 if (SvREADONLY(tmpRef))
cea2e8a9 7822 Perl_croak(aTHX_ PL_no_modify);
76e3520e
GS
7823 if (SvOBJECT(tmpRef)) {
7824 if (SvTYPE(tmpRef) != SVt_PVIO)
3280af22 7825 --PL_sv_objcount;
76e3520e 7826 SvREFCNT_dec(SvSTASH(tmpRef));
2e3febc6 7827 }
a0d0e21e 7828 }
76e3520e
GS
7829 SvOBJECT_on(tmpRef);
7830 if (SvTYPE(tmpRef) != SVt_PVIO)
3280af22 7831 ++PL_sv_objcount;
76e3520e
GS
7832 (void)SvUPGRADE(tmpRef, SVt_PVMG);
7833 SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
a0d0e21e 7834
2e3febc6
CS
7835 if (Gv_AMG(stash))
7836 SvAMAGIC_on(sv);
7837 else
7838 SvAMAGIC_off(sv);
a0d0e21e 7839
1edbfb88
AB
7840 if(SvSMAGICAL(tmpRef))
7841 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
7842 mg_set(tmpRef);
7843
7844
ecdeb87c 7845
a0d0e21e
LW
7846 return sv;
7847}
7848
645c22ef 7849/* Downgrades a PVGV to a PVMG.
645c22ef
DM
7850 */
7851
76e3520e 7852STATIC void
cea2e8a9 7853S_sv_unglob(pTHX_ SV *sv)
a0d0e21e 7854{
850fabdf
GS
7855 void *xpvmg;
7856
a0d0e21e
LW
7857 assert(SvTYPE(sv) == SVt_PVGV);
7858 SvFAKE_off(sv);
7859 if (GvGP(sv))
1edc1566 7860 gp_free((GV*)sv);
e826b3c7
GS
7861 if (GvSTASH(sv)) {
7862 SvREFCNT_dec(GvSTASH(sv));
7863 GvSTASH(sv) = Nullhv;
7864 }
14befaf4 7865 sv_unmagic(sv, PERL_MAGIC_glob);
a0d0e21e 7866 Safefree(GvNAME(sv));
a5f75d66 7867 GvMULTI_off(sv);
850fabdf
GS
7868
7869 /* need to keep SvANY(sv) in the right arena */
7870 xpvmg = new_XPVMG();
7871 StructCopy(SvANY(sv), xpvmg, XPVMG);
7872 del_XPVGV(SvANY(sv));
7873 SvANY(sv) = xpvmg;
7874
a0d0e21e
LW
7875 SvFLAGS(sv) &= ~SVTYPEMASK;
7876 SvFLAGS(sv) |= SVt_PVMG;
7877}
7878
954c1994 7879/*
840a7b70 7880=for apidoc sv_unref_flags
954c1994
GS
7881
7882Unsets the RV status of the SV, and decrements the reference count of
7883whatever was being referenced by the RV. This can almost be thought of
840a7b70
IZ
7884as a reversal of C<newSVrv>. The C<cflags> argument can contain
7885C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
7886(otherwise the decrementing is conditional on the reference count being
7887different from one or the reference being a readonly SV).
7889fe52 7888See C<SvROK_off>.
954c1994
GS
7889
7890=cut
7891*/
7892
ed6116ce 7893void
840a7b70 7894Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
ed6116ce 7895{
a0d0e21e 7896 SV* rv = SvRV(sv);
810b8aa5
GS
7897
7898 if (SvWEAKREF(sv)) {
7899 sv_del_backref(sv);
7900 SvWEAKREF_off(sv);
7901 SvRV(sv) = 0;
7902 return;
7903 }
ed6116ce
LW
7904 SvRV(sv) = 0;
7905 SvROK_off(sv);
04ca4930
NC
7906 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
7907 assigned to as BEGIN {$a = \"Foo"} will fail. */
7908 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
4633a7c4 7909 SvREFCNT_dec(rv);
840a7b70 7910 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
4633a7c4 7911 sv_2mortal(rv); /* Schedule for freeing later */
ed6116ce 7912}
8990e307 7913
840a7b70
IZ
7914/*
7915=for apidoc sv_unref
7916
7917Unsets the RV status of the SV, and decrements the reference count of
7918whatever was being referenced by the RV. This can almost be thought of
7919as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
7889fe52 7920being zero. See C<SvROK_off>.
840a7b70
IZ
7921
7922=cut
7923*/
7924
7925void
7926Perl_sv_unref(pTHX_ SV *sv)
7927{
7928 sv_unref_flags(sv, 0);
7929}
7930
645c22ef
DM
7931/*
7932=for apidoc sv_taint
7933
7934Taint an SV. Use C<SvTAINTED_on> instead.
7935=cut
7936*/
7937
bbce6d69 7938void
864dbfa3 7939Perl_sv_taint(pTHX_ SV *sv)
bbce6d69 7940{
14befaf4 7941 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
bbce6d69 7942}
7943
645c22ef
DM
7944/*
7945=for apidoc sv_untaint
7946
7947Untaint an SV. Use C<SvTAINTED_off> instead.
7948=cut
7949*/
7950
bbce6d69 7951void
864dbfa3 7952Perl_sv_untaint(pTHX_ SV *sv)
bbce6d69 7953{
13f57bf8 7954 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
14befaf4 7955 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
36477c24 7956 if (mg)
565764a8 7957 mg->mg_len &= ~1;
36477c24 7958 }
bbce6d69 7959}
7960
645c22ef
DM
7961/*
7962=for apidoc sv_tainted
7963
7964Test an SV for taintedness. Use C<SvTAINTED> instead.
7965=cut
7966*/
7967
bbce6d69 7968bool
864dbfa3 7969Perl_sv_tainted(pTHX_ SV *sv)
bbce6d69 7970{
13f57bf8 7971 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
14befaf4 7972 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
155aba94 7973 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
36477c24 7974 return TRUE;
7975 }
7976 return FALSE;
bbce6d69 7977}
7978
cea2e8a9 7979#if defined(PERL_IMPLICIT_CONTEXT)
645c22ef
DM
7980
7981/* pTHX_ magic can't cope with varargs, so this is a no-context
7982 * version of the main function, (which may itself be aliased to us).
7983 * Don't access this version directly.
7984 */
7985
cea2e8a9
GS
7986void
7987Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
7988{
7989 dTHX;
7990 va_list args;
7991 va_start(args, pat);
c5be433b 7992 sv_vsetpvf(sv, pat, &args);
cea2e8a9
GS
7993 va_end(args);
7994}
7995
645c22ef
DM
7996/* pTHX_ magic can't cope with varargs, so this is a no-context
7997 * version of the main function, (which may itself be aliased to us).
7998 * Don't access this version directly.
7999 */
cea2e8a9
GS
8000
8001void
8002Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8003{
8004 dTHX;
8005 va_list args;
8006 va_start(args, pat);
c5be433b 8007 sv_vsetpvf_mg(sv, pat, &args);
cea2e8a9 8008 va_end(args);
cea2e8a9
GS
8009}
8010#endif
8011
954c1994
GS
8012/*
8013=for apidoc sv_setpvf
8014
8015Processes its arguments like C<sprintf> and sets an SV to the formatted
8016output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
8017
8018=cut
8019*/
8020
46fc3d4c 8021void
864dbfa3 8022Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
46fc3d4c 8023{
8024 va_list args;
46fc3d4c 8025 va_start(args, pat);
c5be433b 8026 sv_vsetpvf(sv, pat, &args);
46fc3d4c 8027 va_end(args);
8028}
8029
645c22ef
DM
8030/* backend for C<sv_setpvf> and C<sv_setpvf_nocontext> */
8031
c5be433b
GS
8032void
8033Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8034{
8035 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8036}
ef50df4b 8037
954c1994
GS
8038/*
8039=for apidoc sv_setpvf_mg
8040
8041Like C<sv_setpvf>, but also handles 'set' magic.
8042
8043=cut
8044*/
8045
ef50df4b 8046void
864dbfa3 8047Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
ef50df4b
GS
8048{
8049 va_list args;
ef50df4b 8050 va_start(args, pat);
c5be433b 8051 sv_vsetpvf_mg(sv, pat, &args);
ef50df4b 8052 va_end(args);
c5be433b
GS
8053}
8054
645c22ef
DM
8055/* backend for C<sv_setpvf_mg> C<setpvf_mg_nocontext> */
8056
c5be433b
GS
8057void
8058Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8059{
8060 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
ef50df4b
GS
8061 SvSETMAGIC(sv);
8062}
8063
cea2e8a9 8064#if defined(PERL_IMPLICIT_CONTEXT)
645c22ef
DM
8065
8066/* pTHX_ magic can't cope with varargs, so this is a no-context
8067 * version of the main function, (which may itself be aliased to us).
8068 * Don't access this version directly.
8069 */
8070
cea2e8a9
GS
8071void
8072Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8073{
8074 dTHX;
8075 va_list args;
8076 va_start(args, pat);
c5be433b 8077 sv_vcatpvf(sv, pat, &args);
cea2e8a9
GS
8078 va_end(args);
8079}
8080
645c22ef
DM
8081/* pTHX_ magic can't cope with varargs, so this is a no-context
8082 * version of the main function, (which may itself be aliased to us).
8083 * Don't access this version directly.
8084 */
8085
cea2e8a9
GS
8086void
8087Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8088{
8089 dTHX;
8090 va_list args;
8091 va_start(args, pat);
c5be433b 8092 sv_vcatpvf_mg(sv, pat, &args);
cea2e8a9 8093 va_end(args);
cea2e8a9
GS
8094}
8095#endif
8096
954c1994
GS
8097/*
8098=for apidoc sv_catpvf
8099
d5ce4a7c
GA
8100Processes its arguments like C<sprintf> and appends the formatted
8101output to an SV. If the appended data contains "wide" characters
8102(including, but not limited to, SVs with a UTF-8 PV formatted with %s,
8103and characters >255 formatted with %c), the original SV might get
8104upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
8105C<SvSETMAGIC()> must typically be called after calling this function
8106to handle 'set' magic.
954c1994 8107
d5ce4a7c 8108=cut */
954c1994 8109
46fc3d4c 8110void
864dbfa3 8111Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
46fc3d4c 8112{
8113 va_list args;
46fc3d4c 8114 va_start(args, pat);
c5be433b 8115 sv_vcatpvf(sv, pat, &args);
46fc3d4c 8116 va_end(args);
8117}
8118
645c22ef
DM
8119/* backend for C<sv_catpvf> and C<catpvf_mg_nocontext> */
8120
ef50df4b 8121void
c5be433b
GS
8122Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8123{
8124 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8125}
8126
954c1994
GS
8127/*
8128=for apidoc sv_catpvf_mg
8129
8130Like C<sv_catpvf>, but also handles 'set' magic.
8131
8132=cut
8133*/
8134
c5be433b 8135void
864dbfa3 8136Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
ef50df4b
GS
8137{
8138 va_list args;
ef50df4b 8139 va_start(args, pat);
c5be433b 8140 sv_vcatpvf_mg(sv, pat, &args);
ef50df4b 8141 va_end(args);
c5be433b
GS
8142}
8143
645c22ef
DM
8144/* backend for C<catpvf_mg> and C<catpvf_mg_nocontext> */
8145
c5be433b
GS
8146void
8147Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8148{
8149 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
ef50df4b
GS
8150 SvSETMAGIC(sv);
8151}
8152
954c1994
GS
8153/*
8154=for apidoc sv_vsetpvfn
8155
8156Works like C<vcatpvfn> but copies the text into the SV instead of
8157appending it.
8158
645c22ef
DM
8159Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
8160
954c1994
GS
8161=cut
8162*/
8163
46fc3d4c 8164void
7d5ea4e7 8165Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
46fc3d4c 8166{
8167 sv_setpvn(sv, "", 0);
7d5ea4e7 8168 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
46fc3d4c 8169}
8170
645c22ef
DM
8171/* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
8172
2d00ba3b 8173STATIC I32
9dd79c3f 8174S_expect_number(pTHX_ char** pattern)
211dfcf1
HS
8175{
8176 I32 var = 0;
8177 switch (**pattern) {
8178 case '1': case '2': case '3':
8179 case '4': case '5': case '6':
8180 case '7': case '8': case '9':
8181 while (isDIGIT(**pattern))
8182 var = var * 10 + (*(*pattern)++ - '0');
8183 }
8184 return var;
8185}
9dd79c3f 8186#define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
211dfcf1 8187
954c1994
GS
8188/*
8189=for apidoc sv_vcatpvfn
8190
8191Processes its arguments like C<vsprintf> and appends the formatted output
8192to an SV. Uses an array of SVs if the C style variable argument list is
8193missing (NULL). When running with taint checks enabled, indicates via
8194C<maybe_tainted> if results are untrustworthy (often due to the use of
8195locales).
8196
645c22ef
DM
8197Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
8198
954c1994
GS
8199=cut
8200*/
8201
46fc3d4c 8202void
7d5ea4e7 8203Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
46fc3d4c 8204{
8205 char *p;
8206 char *q;
8207 char *patend;
fc36a67e 8208 STRLEN origlen;
46fc3d4c 8209 I32 svix = 0;
c635e13b 8210 static char nullstr[] = "(null)";
9c5ffd7c 8211 SV *argsv = Nullsv;
2cf2cfc6 8212 bool has_utf8 = FALSE; /* has the result utf8? */
46fc3d4c 8213
8214 /* no matter what, this is a string now */
fc36a67e 8215 (void)SvPV_force(sv, origlen);
46fc3d4c 8216
fc36a67e 8217 /* special-case "", "%s", and "%_" */
46fc3d4c 8218 if (patlen == 0)
8219 return;
fc36a67e 8220 if (patlen == 2 && pat[0] == '%') {
8221 switch (pat[1]) {
8222 case 's':
c635e13b 8223 if (args) {
8224 char *s = va_arg(*args, char*);
8225 sv_catpv(sv, s ? s : nullstr);
8226 }
7e2040f0 8227 else if (svix < svmax) {
fc36a67e 8228 sv_catsv(sv, *svargs);
7e2040f0
GS
8229 if (DO_UTF8(*svargs))
8230 SvUTF8_on(sv);
8231 }
fc36a67e 8232 return;
8233 case '_':
8234 if (args) {
7e2040f0
GS
8235 argsv = va_arg(*args, SV*);
8236 sv_catsv(sv, argsv);
8237 if (DO_UTF8(argsv))
8238 SvUTF8_on(sv);
fc36a67e 8239 return;
8240 }
8241 /* See comment on '_' below */
8242 break;
8243 }
46fc3d4c 8244 }
8245
2cf2cfc6 8246 if (!args && svix < svmax && DO_UTF8(*svargs))
205f51d8 8247 has_utf8 = TRUE;
2cf2cfc6 8248
46fc3d4c 8249 patend = (char*)pat + patlen;
8250 for (p = (char*)pat; p < patend; p = q) {
8251 bool alt = FALSE;
8252 bool left = FALSE;
b22c7a20 8253 bool vectorize = FALSE;
211dfcf1 8254 bool vectorarg = FALSE;
2cf2cfc6 8255 bool vec_utf8 = FALSE;
46fc3d4c 8256 char fill = ' ';
8257 char plus = 0;
8258 char intsize = 0;
8259 STRLEN width = 0;
fc36a67e 8260 STRLEN zeros = 0;
46fc3d4c 8261 bool has_precis = FALSE;
8262 STRLEN precis = 0;
2cf2cfc6 8263 bool is_utf8 = FALSE; /* is this item utf8? */
20f6aaab
AS
8264#ifdef HAS_LDBL_SPRINTF_BUG
8265 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
205f51d8 8266 with sfio - Allen <allens@cpan.org> */
20f6aaab
AS
8267 bool fix_ldbl_sprintf_bug = FALSE;
8268#endif
205f51d8 8269
46fc3d4c 8270 char esignbuf[4];
ad391ad9 8271 U8 utf8buf[UTF8_MAXLEN+1];
46fc3d4c 8272 STRLEN esignlen = 0;
8273
8274 char *eptr = Nullch;
fc36a67e 8275 STRLEN elen = 0;
089c015b
JH
8276 /* Times 4: a decimal digit takes more than 3 binary digits.
8277 * NV_DIG: mantissa takes than many decimal digits.
8278 * Plus 32: Playing safe. */
8279 char ebuf[IV_DIG * 4 + NV_DIG + 32];
205f51d8 8280 /* large enough for "%#.#f" --chip */
2d4389e4 8281 /* what about long double NVs? --jhi */
b22c7a20 8282
81f715da 8283 SV *vecsv = Nullsv;
a05b299f 8284 U8 *vecstr = Null(U8*);
b22c7a20 8285 STRLEN veclen = 0;
934abaf1 8286 char c = 0;
46fc3d4c 8287 int i;
9c5ffd7c 8288 unsigned base = 0;
8c8eb53c
RB
8289 IV iv = 0;
8290 UV uv = 0;
9e5b023a
JH
8291 /* we need a long double target in case HAS_LONG_DOUBLE but
8292 not USE_LONG_DOUBLE
8293 */
35fff930 8294#if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9e5b023a
JH
8295 long double nv;
8296#else
65202027 8297 NV nv;
9e5b023a 8298#endif
46fc3d4c 8299 STRLEN have;
8300 STRLEN need;
8301 STRLEN gap;
b22c7a20
GS
8302 char *dotstr = ".";
8303 STRLEN dotstrlen = 1;
211dfcf1 8304 I32 efix = 0; /* explicit format parameter index */
eb3fce90 8305 I32 ewix = 0; /* explicit width index */
211dfcf1
HS
8306 I32 epix = 0; /* explicit precision index */
8307 I32 evix = 0; /* explicit vector index */
eb3fce90 8308 bool asterisk = FALSE;
46fc3d4c 8309
211dfcf1 8310 /* echo everything up to the next format specification */
46fc3d4c 8311 for (q = p; q < patend && *q != '%'; ++q) ;
8312 if (q > p) {
8313 sv_catpvn(sv, p, q - p);
8314 p = q;
8315 }
8316 if (q++ >= patend)
8317 break;
8318
211dfcf1
HS
8319/*
8320 We allow format specification elements in this order:
8321 \d+\$ explicit format parameter index
8322 [-+ 0#]+ flags
a472f209 8323 v|\*(\d+\$)?v vector with optional (optionally specified) arg
211dfcf1
HS
8324 \d+|\*(\d+\$)? width using optional (optionally specified) arg
8325 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
8326 [hlqLV] size
8327 [%bcdefginopsux_DFOUX] format (mandatory)
8328*/
8329 if (EXPECT_NUMBER(q, width)) {
8330 if (*q == '$') {
8331 ++q;
8332 efix = width;
8333 } else {
8334 goto gotwidth;
8335 }
8336 }
8337
fc36a67e 8338 /* FLAGS */
8339
46fc3d4c 8340 while (*q) {
8341 switch (*q) {
8342 case ' ':
8343 case '+':
8344 plus = *q++;
8345 continue;
8346
8347 case '-':
8348 left = TRUE;
8349 q++;
8350 continue;
8351
8352 case '0':
8353 fill = *q++;
8354 continue;
8355
8356 case '#':
8357 alt = TRUE;
8358 q++;
8359 continue;
8360
fc36a67e 8361 default:
8362 break;
8363 }
8364 break;
8365 }
46fc3d4c 8366
211dfcf1 8367 tryasterisk:
eb3fce90 8368 if (*q == '*') {
211dfcf1
HS
8369 q++;
8370 if (EXPECT_NUMBER(q, ewix))
8371 if (*q++ != '$')
8372 goto unknown;
eb3fce90 8373 asterisk = TRUE;
211dfcf1
HS
8374 }
8375 if (*q == 'v') {
eb3fce90 8376 q++;
211dfcf1
HS
8377 if (vectorize)
8378 goto unknown;
9cbac4c7 8379 if ((vectorarg = asterisk)) {
211dfcf1
HS
8380 evix = ewix;
8381 ewix = 0;
8382 asterisk = FALSE;
8383 }
8384 vectorize = TRUE;
8385 goto tryasterisk;
eb3fce90
JH
8386 }
8387
211dfcf1
HS
8388 if (!asterisk)
8389 EXPECT_NUMBER(q, width);
8390
8391 if (vectorize) {
8392 if (vectorarg) {
8393 if (args)
8394 vecsv = va_arg(*args, SV*);
8395 else
8396 vecsv = (evix ? evix <= svmax : svix < svmax) ?
8397 svargs[ewix ? ewix-1 : svix++] : &PL_sv_undef;
4459522c 8398 dotstr = SvPVx(vecsv, dotstrlen);
211dfcf1 8399 if (DO_UTF8(vecsv))
2cf2cfc6 8400 is_utf8 = TRUE;
211dfcf1
HS
8401 }
8402 if (args) {
8403 vecsv = va_arg(*args, SV*);
8404 vecstr = (U8*)SvPVx(vecsv,veclen);
2cf2cfc6 8405 vec_utf8 = DO_UTF8(vecsv);
eb3fce90 8406 }
211dfcf1
HS
8407 else if (efix ? efix <= svmax : svix < svmax) {
8408 vecsv = svargs[efix ? efix-1 : svix++];
8409 vecstr = (U8*)SvPVx(vecsv,veclen);
2cf2cfc6 8410 vec_utf8 = DO_UTF8(vecsv);
211dfcf1
HS
8411 }
8412 else {
8413 vecstr = (U8*)"";
8414 veclen = 0;
8415 }
eb3fce90 8416 }
fc36a67e 8417
eb3fce90 8418 if (asterisk) {
fc36a67e 8419 if (args)
8420 i = va_arg(*args, int);
8421 else
eb3fce90
JH
8422 i = (ewix ? ewix <= svmax : svix < svmax) ?
8423 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
fc36a67e 8424 left |= (i < 0);
8425 width = (i < 0) ? -i : i;
fc36a67e 8426 }
211dfcf1 8427 gotwidth:
fc36a67e 8428
8429 /* PRECISION */
46fc3d4c 8430
fc36a67e 8431 if (*q == '.') {
8432 q++;
8433 if (*q == '*') {
211dfcf1 8434 q++;
7b8dd722
HS
8435 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
8436 goto unknown;
8437 /* XXX: todo, support specified precision parameter */
8438 if (epix)
211dfcf1 8439 goto unknown;
46fc3d4c 8440 if (args)
8441 i = va_arg(*args, int);
8442 else
eb3fce90
JH
8443 i = (ewix ? ewix <= svmax : svix < svmax)
8444 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
fc36a67e 8445 precis = (i < 0) ? 0 : i;
fc36a67e 8446 }
8447 else {
8448 precis = 0;
8449 while (isDIGIT(*q))
8450 precis = precis * 10 + (*q++ - '0');
8451 }
8452 has_precis = TRUE;
8453 }
46fc3d4c 8454
fc36a67e 8455 /* SIZE */
46fc3d4c 8456
fc36a67e 8457 switch (*q) {
c623ac67
GS
8458#ifdef WIN32
8459 case 'I': /* Ix, I32x, and I64x */
8460# ifdef WIN64
8461 if (q[1] == '6' && q[2] == '4') {
8462 q += 3;
8463 intsize = 'q';
8464 break;
8465 }
8466# endif
8467 if (q[1] == '3' && q[2] == '2') {
8468 q += 3;
8469 break;
8470 }
8471# ifdef WIN64
8472 intsize = 'q';
8473# endif
8474 q++;
8475 break;
8476#endif
9e5b023a 8477#if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
6f9bb7fd 8478 case 'L': /* Ld */
e5c81feb 8479 /* FALL THROUGH */
e5c81feb 8480#ifdef HAS_QUAD
6f9bb7fd 8481 case 'q': /* qd */
9e5b023a 8482#endif
6f9bb7fd
GS
8483 intsize = 'q';
8484 q++;
8485 break;
8486#endif
fc36a67e 8487 case 'l':
9e5b023a 8488#if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
205f51d8 8489 if (*(q + 1) == 'l') { /* lld, llf */
fc36a67e 8490 intsize = 'q';
8491 q += 2;
46fc3d4c 8492 break;
cf2093f6 8493 }
fc36a67e 8494#endif
6f9bb7fd 8495 /* FALL THROUGH */
fc36a67e 8496 case 'h':
cf2093f6 8497 /* FALL THROUGH */
fc36a67e 8498 case 'V':
8499 intsize = *q++;
46fc3d4c 8500 break;
8501 }
8502
fc36a67e 8503 /* CONVERSION */
8504
211dfcf1
HS
8505 if (*q == '%') {
8506 eptr = q++;
8507 elen = 1;
8508 goto string;
8509 }
8510
be75b157
HS
8511 if (vectorize)
8512 argsv = vecsv;
8513 else if (!args)
211dfcf1
HS
8514 argsv = (efix ? efix <= svmax : svix < svmax) ?
8515 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
8516
46fc3d4c 8517 switch (c = *q++) {
8518
8519 /* STRINGS */
8520
46fc3d4c 8521 case 'c':
be75b157 8522 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
1bd104fb
JH
8523 if ((uv > 255 ||
8524 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
0064a8a9 8525 && !IN_BYTES) {
dfe13c55 8526 eptr = (char*)utf8buf;
9041c2e3 8527 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
2cf2cfc6 8528 is_utf8 = TRUE;
7e2040f0
GS
8529 }
8530 else {
8531 c = (char)uv;
8532 eptr = &c;
8533 elen = 1;
a0ed51b3 8534 }
46fc3d4c 8535 goto string;
8536
46fc3d4c 8537 case 's':
be75b157 8538 if (args && !vectorize) {
fc36a67e 8539 eptr = va_arg(*args, char*);
c635e13b 8540 if (eptr)
1d7c1841
GS
8541#ifdef MACOS_TRADITIONAL
8542 /* On MacOS, %#s format is used for Pascal strings */
8543 if (alt)
8544 elen = *eptr++;
8545 else
8546#endif
c635e13b 8547 elen = strlen(eptr);
8548 else {
8549 eptr = nullstr;
8550 elen = sizeof nullstr - 1;
8551 }
46fc3d4c 8552 }
211dfcf1 8553 else {
7e2040f0
GS
8554 eptr = SvPVx(argsv, elen);
8555 if (DO_UTF8(argsv)) {
a0ed51b3
LW
8556 if (has_precis && precis < elen) {
8557 I32 p = precis;
7e2040f0 8558 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
a0ed51b3
LW
8559 precis = p;
8560 }
8561 if (width) { /* fudge width (can't fudge elen) */
7e2040f0 8562 width += elen - sv_len_utf8(argsv);
a0ed51b3 8563 }
2cf2cfc6 8564 is_utf8 = TRUE;
a0ed51b3
LW
8565 }
8566 }
46fc3d4c 8567 goto string;
8568
fc36a67e 8569 case '_':
8570 /*
8571 * The "%_" hack might have to be changed someday,
8572 * if ISO or ANSI decide to use '_' for something.
8573 * So we keep it hidden from users' code.
8574 */
be75b157 8575 if (!args || vectorize)
fc36a67e 8576 goto unknown;
211dfcf1 8577 argsv = va_arg(*args, SV*);
7e2040f0
GS
8578 eptr = SvPVx(argsv, elen);
8579 if (DO_UTF8(argsv))
2cf2cfc6 8580 is_utf8 = TRUE;
fc36a67e 8581
46fc3d4c 8582 string:
b22c7a20 8583 vectorize = FALSE;
46fc3d4c 8584 if (has_precis && elen > precis)
8585 elen = precis;
8586 break;
8587
8588 /* INTEGERS */
8589
fc36a67e 8590 case 'p':
be75b157 8591 if (alt || vectorize)
c2e66d9e 8592 goto unknown;
211dfcf1 8593 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
fc36a67e 8594 base = 16;
8595 goto integer;
8596
46fc3d4c 8597 case 'D':
29fe7a80 8598#ifdef IV_IS_QUAD
22f3ae8c 8599 intsize = 'q';
29fe7a80 8600#else
46fc3d4c 8601 intsize = 'l';
29fe7a80 8602#endif
46fc3d4c 8603 /* FALL THROUGH */
8604 case 'd':
8605 case 'i':
b22c7a20 8606 if (vectorize) {
ba210ebe 8607 STRLEN ulen;
211dfcf1
HS
8608 if (!veclen)
8609 continue;
2cf2cfc6
A
8610 if (vec_utf8)
8611 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8612 UTF8_ALLOW_ANYUV);
b22c7a20 8613 else {
e83d50c9 8614 uv = *vecstr;
b22c7a20
GS
8615 ulen = 1;
8616 }
8617 vecstr += ulen;
8618 veclen -= ulen;
e83d50c9
JP
8619 if (plus)
8620 esignbuf[esignlen++] = plus;
b22c7a20
GS
8621 }
8622 else if (args) {
46fc3d4c 8623 switch (intsize) {
8624 case 'h': iv = (short)va_arg(*args, int); break;
8625 default: iv = va_arg(*args, int); break;
8626 case 'l': iv = va_arg(*args, long); break;
fc36a67e 8627 case 'V': iv = va_arg(*args, IV); break;
cf2093f6
JH
8628#ifdef HAS_QUAD
8629 case 'q': iv = va_arg(*args, Quad_t); break;
8630#endif
46fc3d4c 8631 }
8632 }
8633 else {
211dfcf1 8634 iv = SvIVx(argsv);
46fc3d4c 8635 switch (intsize) {
8636 case 'h': iv = (short)iv; break;
be28567c 8637 default: break;
46fc3d4c 8638 case 'l': iv = (long)iv; break;
fc36a67e 8639 case 'V': break;
cf2093f6
JH
8640#ifdef HAS_QUAD
8641 case 'q': iv = (Quad_t)iv; break;
8642#endif
46fc3d4c 8643 }
8644 }
e83d50c9
JP
8645 if ( !vectorize ) /* we already set uv above */
8646 {
8647 if (iv >= 0) {
8648 uv = iv;
8649 if (plus)
8650 esignbuf[esignlen++] = plus;
8651 }
8652 else {
8653 uv = -iv;
8654 esignbuf[esignlen++] = '-';
8655 }
46fc3d4c 8656 }
8657 base = 10;
8658 goto integer;
8659
fc36a67e 8660 case 'U':
29fe7a80 8661#ifdef IV_IS_QUAD
22f3ae8c 8662 intsize = 'q';
29fe7a80 8663#else
fc36a67e 8664 intsize = 'l';
29fe7a80 8665#endif
fc36a67e 8666 /* FALL THROUGH */
8667 case 'u':
8668 base = 10;
8669 goto uns_integer;
8670
4f19785b
WSI
8671 case 'b':
8672 base = 2;
8673 goto uns_integer;
8674
46fc3d4c 8675 case 'O':
29fe7a80 8676#ifdef IV_IS_QUAD
22f3ae8c 8677 intsize = 'q';
29fe7a80 8678#else
46fc3d4c 8679 intsize = 'l';
29fe7a80 8680#endif
46fc3d4c 8681 /* FALL THROUGH */
8682 case 'o':
8683 base = 8;
8684 goto uns_integer;
8685
8686 case 'X':
46fc3d4c 8687 case 'x':
8688 base = 16;
46fc3d4c 8689
8690 uns_integer:
b22c7a20 8691 if (vectorize) {
ba210ebe 8692 STRLEN ulen;
b22c7a20 8693 vector:
211dfcf1
HS
8694 if (!veclen)
8695 continue;
2cf2cfc6
A
8696 if (vec_utf8)
8697 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
8698 UTF8_ALLOW_ANYUV);
b22c7a20 8699 else {
a05b299f 8700 uv = *vecstr;
b22c7a20
GS
8701 ulen = 1;
8702 }
8703 vecstr += ulen;
8704 veclen -= ulen;
8705 }
8706 else if (args) {
46fc3d4c 8707 switch (intsize) {
8708 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
8709 default: uv = va_arg(*args, unsigned); break;
8710 case 'l': uv = va_arg(*args, unsigned long); break;
fc36a67e 8711 case 'V': uv = va_arg(*args, UV); break;
cf2093f6
JH
8712#ifdef HAS_QUAD
8713 case 'q': uv = va_arg(*args, Quad_t); break;
8714#endif
46fc3d4c 8715 }
8716 }
8717 else {
211dfcf1 8718 uv = SvUVx(argsv);
46fc3d4c 8719 switch (intsize) {
8720 case 'h': uv = (unsigned short)uv; break;
be28567c 8721 default: break;
46fc3d4c 8722 case 'l': uv = (unsigned long)uv; break;
fc36a67e 8723 case 'V': break;
cf2093f6
JH
8724#ifdef HAS_QUAD
8725 case 'q': uv = (Quad_t)uv; break;
8726#endif
46fc3d4c 8727 }
8728 }
8729
8730 integer:
46fc3d4c 8731 eptr = ebuf + sizeof ebuf;
fc36a67e 8732 switch (base) {
8733 unsigned dig;
8734 case 16:
c10ed8b9
HS
8735 if (!uv)
8736 alt = FALSE;
1d7c1841
GS
8737 p = (char*)((c == 'X')
8738 ? "0123456789ABCDEF" : "0123456789abcdef");
fc36a67e 8739 do {
8740 dig = uv & 15;
8741 *--eptr = p[dig];
8742 } while (uv >>= 4);
8743 if (alt) {
46fc3d4c 8744 esignbuf[esignlen++] = '0';
fc36a67e 8745 esignbuf[esignlen++] = c; /* 'x' or 'X' */
46fc3d4c 8746 }
fc36a67e 8747 break;
8748 case 8:
8749 do {
8750 dig = uv & 7;
8751 *--eptr = '0' + dig;
8752 } while (uv >>= 3);
8753 if (alt && *eptr != '0')
8754 *--eptr = '0';
8755 break;
4f19785b
WSI
8756 case 2:
8757 do {
8758 dig = uv & 1;
8759 *--eptr = '0' + dig;
8760 } while (uv >>= 1);
eda88b6d
JH
8761 if (alt) {
8762 esignbuf[esignlen++] = '0';
7481bb52 8763 esignbuf[esignlen++] = 'b';
eda88b6d 8764 }
4f19785b 8765 break;
fc36a67e 8766 default: /* it had better be ten or less */
6bc102ca 8767#if defined(PERL_Y2KWARN)
e476b1b5 8768 if (ckWARN(WARN_Y2K)) {
6bc102ca
GS
8769 STRLEN n;
8770 char *s = SvPV(sv,n);
8771 if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
8772 && (n == 2 || !isDIGIT(s[n-3])))
8773 {
9014280d 8774 Perl_warner(aTHX_ packWARN(WARN_Y2K),
6bc102ca
GS
8775 "Possible Y2K bug: %%%c %s",
8776 c, "format string following '19'");
8777 }
8778 }
8779#endif
fc36a67e 8780 do {
8781 dig = uv % base;
8782 *--eptr = '0' + dig;
8783 } while (uv /= base);
8784 break;
46fc3d4c 8785 }
8786 elen = (ebuf + sizeof ebuf) - eptr;
c10ed8b9
HS
8787 if (has_precis) {
8788 if (precis > elen)
8789 zeros = precis - elen;
8790 else if (precis == 0 && elen == 1 && *eptr == '0')
8791 elen = 0;
8792 }
46fc3d4c 8793 break;
8794
8795 /* FLOATING POINT */
8796
fc36a67e 8797 case 'F':
8798 c = 'f'; /* maybe %F isn't supported here */
8799 /* FALL THROUGH */
46fc3d4c 8800 case 'e': case 'E':
fc36a67e 8801 case 'f':
46fc3d4c 8802 case 'g': case 'G':
8803
8804 /* This is evil, but floating point is even more evil */
8805
9e5b023a
JH
8806 /* for SV-style calling, we can only get NV
8807 for C-style calling, we assume %f is double;
8808 for simplicity we allow any of %Lf, %llf, %qf for long double
8809 */
8810 switch (intsize) {
8811 case 'V':
8812#if defined(USE_LONG_DOUBLE)
8813 intsize = 'q';
8814#endif
8815 break;
8a2e3f14 8816/* [perl #20339] - we should accept and ignore %lf rather than die */
00e17364
HS
8817 case 'l':
8818 /* FALL THROUGH */
9e5b023a
JH
8819 default:
8820#if defined(USE_LONG_DOUBLE)
8821 intsize = args ? 0 : 'q';
8822#endif
8823 break;
8824 case 'q':
8825#if defined(HAS_LONG_DOUBLE)
8826 break;
8827#else
8828 /* FALL THROUGH */
8829#endif
8830 case 'h':
9e5b023a
JH
8831 goto unknown;
8832 }
8833
8834 /* now we need (long double) if intsize == 'q', else (double) */
be75b157 8835 nv = (args && !vectorize) ?
35fff930
JH
8836#if LONG_DOUBLESIZE > DOUBLESIZE
8837 intsize == 'q' ?
205f51d8
AS
8838 va_arg(*args, long double) :
8839 va_arg(*args, double)
35fff930 8840#else
205f51d8 8841 va_arg(*args, double)
35fff930 8842#endif
9e5b023a 8843 : SvNVx(argsv);
fc36a67e 8844
8845 need = 0;
be75b157 8846 vectorize = FALSE;
fc36a67e 8847 if (c != 'e' && c != 'E') {
8848 i = PERL_INT_MIN;
9e5b023a
JH
8849 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
8850 will cast our (long double) to (double) */
73b309ea 8851 (void)Perl_frexp(nv, &i);
fc36a67e 8852 if (i == PERL_INT_MIN)
cea2e8a9 8853 Perl_die(aTHX_ "panic: frexp");
c635e13b 8854 if (i > 0)
fc36a67e 8855 need = BIT_DIGITS(i);
8856 }
8857 need += has_precis ? precis : 6; /* known default */
20f6aaab 8858
fc36a67e 8859 if (need < width)
8860 need = width;
8861
20f6aaab
AS
8862#ifdef HAS_LDBL_SPRINTF_BUG
8863 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
205f51d8
AS
8864 with sfio - Allen <allens@cpan.org> */
8865
8866# ifdef DBL_MAX
8867# define MY_DBL_MAX DBL_MAX
8868# else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
8869# if DOUBLESIZE >= 8
8870# define MY_DBL_MAX 1.7976931348623157E+308L
8871# else
8872# define MY_DBL_MAX 3.40282347E+38L
8873# endif
8874# endif
8875
8876# ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
8877# define MY_DBL_MAX_BUG 1L
20f6aaab 8878# else
205f51d8 8879# define MY_DBL_MAX_BUG MY_DBL_MAX
20f6aaab 8880# endif
20f6aaab 8881
205f51d8
AS
8882# ifdef DBL_MIN
8883# define MY_DBL_MIN DBL_MIN
8884# else /* XXX guessing! -Allen */
8885# if DOUBLESIZE >= 8
8886# define MY_DBL_MIN 2.2250738585072014E-308L
8887# else
8888# define MY_DBL_MIN 1.17549435E-38L
8889# endif
8890# endif
20f6aaab 8891
205f51d8
AS
8892 if ((intsize == 'q') && (c == 'f') &&
8893 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
8894 (need < DBL_DIG)) {
8895 /* it's going to be short enough that
8896 * long double precision is not needed */
8897
8898 if ((nv <= 0L) && (nv >= -0L))
8899 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
8900 else {
8901 /* would use Perl_fp_class as a double-check but not
8902 * functional on IRIX - see perl.h comments */
8903
8904 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
8905 /* It's within the range that a double can represent */
8906#if defined(DBL_MAX) && !defined(DBL_MIN)
8907 if ((nv >= ((long double)1/DBL_MAX)) ||
8908 (nv <= (-(long double)1/DBL_MAX)))
20f6aaab 8909#endif
205f51d8 8910 fix_ldbl_sprintf_bug = TRUE;
20f6aaab 8911 }
205f51d8
AS
8912 }
8913 if (fix_ldbl_sprintf_bug == TRUE) {
8914 double temp;
8915
8916 intsize = 0;
8917 temp = (double)nv;
8918 nv = (NV)temp;
8919 }
20f6aaab 8920 }
205f51d8
AS
8921
8922# undef MY_DBL_MAX
8923# undef MY_DBL_MAX_BUG
8924# undef MY_DBL_MIN
8925
20f6aaab
AS
8926#endif /* HAS_LDBL_SPRINTF_BUG */
8927
46fc3d4c 8928 need += 20; /* fudge factor */
80252599
GS
8929 if (PL_efloatsize < need) {
8930 Safefree(PL_efloatbuf);
8931 PL_efloatsize = need + 20; /* more fudge */
8932 New(906, PL_efloatbuf, PL_efloatsize, char);
7d5ea4e7 8933 PL_efloatbuf[0] = '\0';
46fc3d4c 8934 }
8935
8936 eptr = ebuf + sizeof ebuf;
8937 *--eptr = '\0';
8938 *--eptr = c;
9e5b023a
JH
8939 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
8940#if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
8941 if (intsize == 'q') {
e5c81feb
JH
8942 /* Copy the one or more characters in a long double
8943 * format before the 'base' ([efgEFG]) character to
8944 * the format string. */
8945 static char const prifldbl[] = PERL_PRIfldbl;
8946 char const *p = prifldbl + sizeof(prifldbl) - 3;
8947 while (p >= prifldbl) { *--eptr = *p--; }
cf2093f6 8948 }
65202027 8949#endif
46fc3d4c 8950 if (has_precis) {
8951 base = precis;
8952 do { *--eptr = '0' + (base % 10); } while (base /= 10);
8953 *--eptr = '.';
8954 }
8955 if (width) {
8956 base = width;
8957 do { *--eptr = '0' + (base % 10); } while (base /= 10);
8958 }
8959 if (fill == '0')
8960 *--eptr = fill;
84902520
TB
8961 if (left)
8962 *--eptr = '-';
46fc3d4c 8963 if (plus)
8964 *--eptr = plus;
8965 if (alt)
8966 *--eptr = '#';
8967 *--eptr = '%';
8968
ff9121f8
JH
8969 /* No taint. Otherwise we are in the strange situation
8970 * where printf() taints but print($float) doesn't.
bda0f7a5 8971 * --jhi */
9e5b023a
JH
8972#if defined(HAS_LONG_DOUBLE)
8973 if (intsize == 'q')
8974 (void)sprintf(PL_efloatbuf, eptr, nv);
8975 else
8976 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
8977#else
dd8482fc 8978 (void)sprintf(PL_efloatbuf, eptr, nv);
9e5b023a 8979#endif
80252599
GS
8980 eptr = PL_efloatbuf;
8981 elen = strlen(PL_efloatbuf);
46fc3d4c 8982 break;
8983
fc36a67e 8984 /* SPECIAL */
8985
8986 case 'n':
8987 i = SvCUR(sv) - origlen;
be75b157 8988 if (args && !vectorize) {
c635e13b 8989 switch (intsize) {
8990 case 'h': *(va_arg(*args, short*)) = i; break;
8991 default: *(va_arg(*args, int*)) = i; break;
8992 case 'l': *(va_arg(*args, long*)) = i; break;
8993 case 'V': *(va_arg(*args, IV*)) = i; break;
cf2093f6
JH
8994#ifdef HAS_QUAD
8995 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
8996#endif
c635e13b 8997 }
fc36a67e 8998 }
9dd79c3f 8999 else
211dfcf1 9000 sv_setuv_mg(argsv, (UV)i);
be75b157 9001 vectorize = FALSE;
fc36a67e 9002 continue; /* not "break" */
9003
9004 /* UNKNOWN */
9005
46fc3d4c 9006 default:
fc36a67e 9007 unknown:
b22c7a20 9008 vectorize = FALSE;
599cee73 9009 if (!args && ckWARN(WARN_PRINTF) &&
533c011a 9010 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
c635e13b 9011 SV *msg = sv_newmortal();
35c1215d
NC
9012 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
9013 (PL_op->op_type == OP_PRTF) ? "" : "s");
0f4b6630 9014 if (c) {
0f4b6630 9015 if (isPRINT(c))
1c846c1f 9016 Perl_sv_catpvf(aTHX_ msg,
0f4b6630
JH
9017 "\"%%%c\"", c & 0xFF);
9018 else
9019 Perl_sv_catpvf(aTHX_ msg,
57def98f 9020 "\"%%\\%03"UVof"\"",
0f4b6630 9021 (UV)c & 0xFF);
0f4b6630 9022 } else
c635e13b 9023 sv_catpv(msg, "end of string");
9014280d 9024 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
c635e13b 9025 }
fb73857a 9026
9027 /* output mangled stuff ... */
9028 if (c == '\0')
9029 --q;
46fc3d4c 9030 eptr = p;
9031 elen = q - p;
fb73857a 9032
9033 /* ... right here, because formatting flags should not apply */
9034 SvGROW(sv, SvCUR(sv) + elen + 1);
9035 p = SvEND(sv);
4459522c 9036 Copy(eptr, p, elen, char);
fb73857a 9037 p += elen;
9038 *p = '\0';
9039 SvCUR(sv) = p - SvPVX(sv);
9040 continue; /* not "break" */
46fc3d4c 9041 }
9042
d2876be5
JH
9043 if (is_utf8 != has_utf8) {
9044 if (is_utf8) {
9045 if (SvCUR(sv))
9046 sv_utf8_upgrade(sv);
9047 }
9048 else {
9049 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
9050 sv_utf8_upgrade(nsv);
9051 eptr = SvPVX(nsv);
9052 elen = SvCUR(nsv);
9053 }
9054 SvGROW(sv, SvCUR(sv) + elen + 1);
9055 p = SvEND(sv);
9056 *p = '\0';
9057 }
9058
fc36a67e 9059 have = esignlen + zeros + elen;
46fc3d4c 9060 need = (have > width ? have : width);
9061 gap = need - have;
9062
b22c7a20 9063 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
46fc3d4c 9064 p = SvEND(sv);
9065 if (esignlen && fill == '0') {
eb160463 9066 for (i = 0; i < (int)esignlen; i++)
46fc3d4c 9067 *p++ = esignbuf[i];
9068 }
9069 if (gap && !left) {
9070 memset(p, fill, gap);
9071 p += gap;
9072 }
9073 if (esignlen && fill != '0') {
eb160463 9074 for (i = 0; i < (int)esignlen; i++)
46fc3d4c 9075 *p++ = esignbuf[i];
9076 }
fc36a67e 9077 if (zeros) {
9078 for (i = zeros; i; i--)
9079 *p++ = '0';
9080 }
46fc3d4c 9081 if (elen) {
4459522c 9082 Copy(eptr, p, elen, char);
46fc3d4c 9083 p += elen;
9084 }
9085 if (gap && left) {
9086 memset(p, ' ', gap);
9087 p += gap;
9088 }
b22c7a20
GS
9089 if (vectorize) {
9090 if (veclen) {
4459522c 9091 Copy(dotstr, p, dotstrlen, char);
b22c7a20
GS
9092 p += dotstrlen;
9093 }
9094 else
9095 vectorize = FALSE; /* done iterating over vecstr */
9096 }
2cf2cfc6
A
9097 if (is_utf8)
9098 has_utf8 = TRUE;
9099 if (has_utf8)
7e2040f0 9100 SvUTF8_on(sv);
46fc3d4c 9101 *p = '\0';
9102 SvCUR(sv) = p - SvPVX(sv);
b22c7a20
GS
9103 if (vectorize) {
9104 esignlen = 0;
9105 goto vector;
9106 }
46fc3d4c 9107 }
9108}
51371543 9109
645c22ef
DM
9110/* =========================================================================
9111
9112=head1 Cloning an interpreter
9113
9114All the macros and functions in this section are for the private use of
9115the main function, perl_clone().
9116
9117The foo_dup() functions make an exact copy of an existing foo thinngy.
9118During the course of a cloning, a hash table is used to map old addresses
9119to new addresses. The table is created and manipulated with the
9120ptr_table_* functions.
9121
9122=cut
9123
9124============================================================================*/
9125
9126
1d7c1841
GS
9127#if defined(USE_ITHREADS)
9128
1d7c1841
GS
9129#ifndef GpREFCNT_inc
9130# define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
9131#endif
9132
9133
d2d73c3e
AB
9134#define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9135#define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
9136#define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9137#define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
9138#define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9139#define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
9140#define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9141#define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
9142#define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
9143#define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
9144#define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
1d7c1841
GS
9145#define SAVEPV(p) (p ? savepv(p) : Nullch)
9146#define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8cf8f3d1 9147
d2d73c3e 9148
d2f185dc
AMS
9149/* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
9150 regcomp.c. AMS 20010712 */
645c22ef 9151
1d7c1841 9152REGEXP *
a8fc9800 9153Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
1d7c1841 9154{
d2f185dc
AMS
9155 REGEXP *ret;
9156 int i, len, npar;
9157 struct reg_substr_datum *s;
9158
9159 if (!r)
9160 return (REGEXP *)NULL;
9161
9162 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
9163 return ret;
9164
9165 len = r->offsets[0];
9166 npar = r->nparens+1;
9167
9168 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
9169 Copy(r->program, ret->program, len+1, regnode);
9170
9171 New(0, ret->startp, npar, I32);
9172 Copy(r->startp, ret->startp, npar, I32);
9173 New(0, ret->endp, npar, I32);
9174 Copy(r->startp, ret->startp, npar, I32);
9175
d2f185dc
AMS
9176 New(0, ret->substrs, 1, struct reg_substr_data);
9177 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
9178 s->min_offset = r->substrs->data[i].min_offset;
9179 s->max_offset = r->substrs->data[i].max_offset;
9180 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
33b8afdf 9181 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
d2f185dc
AMS
9182 }
9183
70612e96 9184 ret->regstclass = NULL;
d2f185dc
AMS
9185 if (r->data) {
9186 struct reg_data *d;
9187 int count = r->data->count;
9188
9189 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
9190 char, struct reg_data);
9191 New(0, d->what, count, U8);
9192
9193 d->count = count;
9194 for (i = 0; i < count; i++) {
9195 d->what[i] = r->data->what[i];
9196 switch (d->what[i]) {
9197 case 's':
9198 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
9199 break;
9200 case 'p':
9201 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
9202 break;
9203 case 'f':
9204 /* This is cheating. */
9205 New(0, d->data[i], 1, struct regnode_charclass_class);
9206 StructCopy(r->data->data[i], d->data[i],
9207 struct regnode_charclass_class);
70612e96 9208 ret->regstclass = (regnode*)d->data[i];
d2f185dc
AMS
9209 break;
9210 case 'o':
33773810
AMS
9211 /* Compiled op trees are readonly, and can thus be
9212 shared without duplication. */
9b978d73
DM
9213 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
9214 break;
d2f185dc
AMS
9215 case 'n':
9216 d->data[i] = r->data->data[i];
9217 break;
9218 }
9219 }
9220
9221 ret->data = d;
9222 }
9223 else
9224 ret->data = NULL;
9225
9226 New(0, ret->offsets, 2*len+1, U32);
9227 Copy(r->offsets, ret->offsets, 2*len+1, U32);
9228
9229 ret->precomp = SAVEPV(r->precomp);
d2f185dc
AMS
9230 ret->refcnt = r->refcnt;
9231 ret->minlen = r->minlen;
9232 ret->prelen = r->prelen;
9233 ret->nparens = r->nparens;
9234 ret->lastparen = r->lastparen;
9235 ret->lastcloseparen = r->lastcloseparen;
9236 ret->reganch = r->reganch;
9237
70612e96
RG
9238 ret->sublen = r->sublen;
9239
9240 if (RX_MATCH_COPIED(ret))
9241 ret->subbeg = SAVEPV(r->subbeg);
9242 else
9243 ret->subbeg = Nullch;
9244
d2f185dc
AMS
9245 ptr_table_store(PL_ptr_table, r, ret);
9246 return ret;
1d7c1841
GS
9247}
9248
d2d73c3e 9249/* duplicate a file handle */
645c22ef 9250
1d7c1841 9251PerlIO *
a8fc9800 9252Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
1d7c1841
GS
9253{
9254 PerlIO *ret;
9255 if (!fp)
9256 return (PerlIO*)NULL;
9257
9258 /* look for it in the table first */
9259 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
9260 if (ret)
9261 return ret;
9262
9263 /* create anew and remember what it is */
ecdeb87c 9264 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
1d7c1841
GS
9265 ptr_table_store(PL_ptr_table, fp, ret);
9266 return ret;
9267}
9268
645c22ef
DM
9269/* duplicate a directory handle */
9270
1d7c1841
GS
9271DIR *
9272Perl_dirp_dup(pTHX_ DIR *dp)
9273{
9274 if (!dp)
9275 return (DIR*)NULL;
9276 /* XXX TODO */
9277 return dp;
9278}
9279
ff276b08 9280/* duplicate a typeglob */
645c22ef 9281
1d7c1841 9282GP *
a8fc9800 9283Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
1d7c1841
GS
9284{
9285 GP *ret;
9286 if (!gp)
9287 return (GP*)NULL;
9288 /* look for it in the table first */
9289 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
9290 if (ret)
9291 return ret;
9292
9293 /* create anew and remember what it is */
9294 Newz(0, ret, 1, GP);
9295 ptr_table_store(PL_ptr_table, gp, ret);
9296
9297 /* clone */
9298 ret->gp_refcnt = 0; /* must be before any other dups! */
d2d73c3e
AB
9299 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
9300 ret->gp_io = io_dup_inc(gp->gp_io, param);
9301 ret->gp_form = cv_dup_inc(gp->gp_form, param);
9302 ret->gp_av = av_dup_inc(gp->gp_av, param);
9303 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
9304 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
9305 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
1d7c1841
GS
9306 ret->gp_cvgen = gp->gp_cvgen;
9307 ret->gp_flags = gp->gp_flags;
9308 ret->gp_line = gp->gp_line;
9309 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
9310 return ret;
9311}
9312
645c22ef
DM
9313/* duplicate a chain of magic */
9314
1d7c1841 9315MAGIC *
a8fc9800 9316Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
1d7c1841 9317{
cb359b41
JH
9318 MAGIC *mgprev = (MAGIC*)NULL;
9319 MAGIC *mgret;
1d7c1841
GS
9320 if (!mg)
9321 return (MAGIC*)NULL;
9322 /* look for it in the table first */
9323 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
9324 if (mgret)
9325 return mgret;
9326
9327 for (; mg; mg = mg->mg_moremagic) {
9328 MAGIC *nmg;
9329 Newz(0, nmg, 1, MAGIC);
cb359b41 9330 if (mgprev)
1d7c1841 9331 mgprev->mg_moremagic = nmg;
cb359b41
JH
9332 else
9333 mgret = nmg;
1d7c1841
GS
9334 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
9335 nmg->mg_private = mg->mg_private;
9336 nmg->mg_type = mg->mg_type;
9337 nmg->mg_flags = mg->mg_flags;
14befaf4 9338 if (mg->mg_type == PERL_MAGIC_qr) {
d2f185dc 9339 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
1d7c1841 9340 }
05bd4103
JH
9341 else if(mg->mg_type == PERL_MAGIC_backref) {
9342 AV *av = (AV*) mg->mg_obj;
9343 SV **svp;
9344 I32 i;
9345 nmg->mg_obj = (SV*)newAV();
9346 svp = AvARRAY(av);
9347 i = AvFILLp(av);
9348 while (i >= 0) {
9349 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
9350 i--;
9351 }
9352 }
1d7c1841
GS
9353 else {
9354 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
d2d73c3e
AB
9355 ? sv_dup_inc(mg->mg_obj, param)
9356 : sv_dup(mg->mg_obj, param);
1d7c1841
GS
9357 }
9358 nmg->mg_len = mg->mg_len;
9359 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
14befaf4 9360 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
68795e93 9361 if (mg->mg_len > 0) {
1d7c1841 9362 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
14befaf4
DM
9363 if (mg->mg_type == PERL_MAGIC_overload_table &&
9364 AMT_AMAGIC((AMT*)mg->mg_ptr))
9365 {
1d7c1841
GS
9366 AMT *amtp = (AMT*)mg->mg_ptr;
9367 AMT *namtp = (AMT*)nmg->mg_ptr;
9368 I32 i;
9369 for (i = 1; i < NofAMmeth; i++) {
d2d73c3e 9370 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
1d7c1841
GS
9371 }
9372 }
9373 }
9374 else if (mg->mg_len == HEf_SVKEY)
d2d73c3e 9375 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
1d7c1841 9376 }
68795e93
NIS
9377 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
9378 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
9379 }
1d7c1841
GS
9380 mgprev = nmg;
9381 }
9382 return mgret;
9383}
9384
645c22ef
DM
9385/* create a new pointer-mapping table */
9386
1d7c1841
GS
9387PTR_TBL_t *
9388Perl_ptr_table_new(pTHX)
9389{
9390 PTR_TBL_t *tbl;
9391 Newz(0, tbl, 1, PTR_TBL_t);
9392 tbl->tbl_max = 511;
9393 tbl->tbl_items = 0;
9394 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
9395 return tbl;
9396}
9397
645c22ef
DM
9398/* map an existing pointer using a table */
9399
1d7c1841
GS
9400void *
9401Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
9402{
9403 PTR_TBL_ENT_t *tblent;
d2a79402 9404 UV hash = PTR2UV(sv);
1d7c1841
GS
9405 assert(tbl);
9406 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
9407 for (; tblent; tblent = tblent->next) {
9408 if (tblent->oldval == sv)
9409 return tblent->newval;
9410 }
9411 return (void*)NULL;
9412}
9413
645c22ef
DM
9414/* add a new entry to a pointer-mapping table */
9415
1d7c1841
GS
9416void
9417Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
9418{
9419 PTR_TBL_ENT_t *tblent, **otblent;
9420 /* XXX this may be pessimal on platforms where pointers aren't good
9421 * hash values e.g. if they grow faster in the most significant
9422 * bits */
d2a79402 9423 UV hash = PTR2UV(oldv);
1d7c1841
GS
9424 bool i = 1;
9425
9426 assert(tbl);
9427 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
9428 for (tblent = *otblent; tblent; i=0, tblent = tblent->next) {
9429 if (tblent->oldval == oldv) {
9430 tblent->newval = newv;
1d7c1841
GS
9431 return;
9432 }
9433 }
9434 Newz(0, tblent, 1, PTR_TBL_ENT_t);
9435 tblent->oldval = oldv;
9436 tblent->newval = newv;
9437 tblent->next = *otblent;
9438 *otblent = tblent;
9439 tbl->tbl_items++;
9440 if (i && tbl->tbl_items > tbl->tbl_max)
9441 ptr_table_split(tbl);
9442}
9443
645c22ef
DM
9444/* double the hash bucket size of an existing ptr table */
9445
1d7c1841
GS
9446void
9447Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
9448{
9449 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
9450 UV oldsize = tbl->tbl_max + 1;
9451 UV newsize = oldsize * 2;
9452 UV i;
9453
9454 Renew(ary, newsize, PTR_TBL_ENT_t*);
9455 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
9456 tbl->tbl_max = --newsize;
9457 tbl->tbl_ary = ary;
9458 for (i=0; i < oldsize; i++, ary++) {
9459 PTR_TBL_ENT_t **curentp, **entp, *ent;
9460 if (!*ary)
9461 continue;
9462 curentp = ary + oldsize;
9463 for (entp = ary, ent = *ary; ent; ent = *entp) {
d2a79402 9464 if ((newsize & PTR2UV(ent->oldval)) != i) {
1d7c1841
GS
9465 *entp = ent->next;
9466 ent->next = *curentp;
9467 *curentp = ent;
9468 continue;
9469 }
9470 else
9471 entp = &ent->next;
9472 }
9473 }
9474}
9475
645c22ef
DM
9476/* remove all the entries from a ptr table */
9477
a0739874
DM
9478void
9479Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
9480{
9481 register PTR_TBL_ENT_t **array;
9482 register PTR_TBL_ENT_t *entry;
9483 register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
9484 UV riter = 0;
9485 UV max;
9486
9487 if (!tbl || !tbl->tbl_items) {
9488 return;
9489 }
9490
9491 array = tbl->tbl_ary;
9492 entry = array[0];
9493 max = tbl->tbl_max;
9494
9495 for (;;) {
9496 if (entry) {
9497 oentry = entry;
9498 entry = entry->next;
9499 Safefree(oentry);
9500 }
9501 if (!entry) {
9502 if (++riter > max) {
9503 break;
9504 }
9505 entry = array[riter];
9506 }
9507 }
9508
9509 tbl->tbl_items = 0;
9510}
9511
645c22ef
DM
9512/* clear and free a ptr table */
9513
a0739874
DM
9514void
9515Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
9516{
9517 if (!tbl) {
9518 return;
9519 }
9520 ptr_table_clear(tbl);
9521 Safefree(tbl->tbl_ary);
9522 Safefree(tbl);
9523}
9524
1d7c1841
GS
9525#ifdef DEBUGGING
9526char *PL_watch_pvx;
9527#endif
9528
645c22ef
DM
9529/* attempt to make everything in the typeglob readonly */
9530
5bd07a3d 9531STATIC SV *
59b40662 9532S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
5bd07a3d
DM
9533{
9534 GV *gv = (GV*)sstr;
59b40662 9535 SV *sv = &param->proto_perl->Isv_no; /* just need SvREADONLY-ness */
5bd07a3d
DM
9536
9537 if (GvIO(gv) || GvFORM(gv)) {
7fb37951 9538 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
5bd07a3d
DM
9539 }
9540 else if (!GvCV(gv)) {
9541 GvCV(gv) = (CV*)sv;
9542 }
9543 else {
9544 /* CvPADLISTs cannot be shared */
37e20706 9545 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
7fb37951 9546 GvUNIQUE_off(gv);
5bd07a3d
DM
9547 }
9548 }
9549
7fb37951 9550 if (!GvUNIQUE(gv)) {
5bd07a3d
DM
9551#if 0
9552 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
9553 HvNAME(GvSTASH(gv)), GvNAME(gv));
9554#endif
9555 return Nullsv;
9556 }
9557
4411f3b6 9558 /*
5bd07a3d
DM
9559 * write attempts will die with
9560 * "Modification of a read-only value attempted"
9561 */
9562 if (!GvSV(gv)) {
9563 GvSV(gv) = sv;
9564 }
9565 else {
9566 SvREADONLY_on(GvSV(gv));
9567 }
9568
9569 if (!GvAV(gv)) {
9570 GvAV(gv) = (AV*)sv;
9571 }
9572 else {
9573 SvREADONLY_on(GvAV(gv));
9574 }
9575
9576 if (!GvHV(gv)) {
9577 GvHV(gv) = (HV*)sv;
9578 }
9579 else {
9580 SvREADONLY_on(GvAV(gv));
9581 }
9582
9583 return sstr; /* he_dup() will SvREFCNT_inc() */
9584}
9585
645c22ef
DM
9586/* duplicate an SV of any type (including AV, HV etc) */
9587
83841fad
NIS
9588void
9589Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
9590{
9591 if (SvROK(sstr)) {
d3d0e6f1 9592 SvRV(dstr) = SvWEAKREF(sstr)
83841fad
NIS
9593 ? sv_dup(SvRV(sstr), param)
9594 : sv_dup_inc(SvRV(sstr), param);
9595 }
9596 else if (SvPVX(sstr)) {
9597 /* Has something there */
9598 if (SvLEN(sstr)) {
68795e93 9599 /* Normal PV - clone whole allocated space */
83841fad 9600 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
d3d0e6f1
NC
9601 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9602 /* Not that normal - actually sstr is copy on write.
9603 But we are a true, independant SV, so: */
9604 SvREADONLY_off(dstr);
9605 SvFAKE_off(dstr);
9606 }
68795e93 9607 }
83841fad
NIS
9608 else {
9609 /* Special case - not normally malloced for some reason */
9610 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
9611 /* A "shared" PV - clone it as unshared string */
9612 SvFAKE_off(dstr);
9613 SvREADONLY_off(dstr);
9614 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
9615 }
9616 else {
9617 /* Some other special case - random pointer */
9618 SvPVX(dstr) = SvPVX(sstr);
d3d0e6f1 9619 }
83841fad
NIS
9620 }
9621 }
9622 else {
9623 /* Copy the Null */
9624 SvPVX(dstr) = SvPVX(sstr);
9625 }
9626}
9627
1d7c1841 9628SV *
a8fc9800 9629Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
1d7c1841 9630{
1d7c1841
GS
9631 SV *dstr;
9632
9633 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
9634 return Nullsv;
9635 /* look for it in the table first */
9636 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
9637 if (dstr)
9638 return dstr;
9639
0405e91e
AB
9640 if(param->flags & CLONEf_JOIN_IN) {
9641 /** We are joining here so we don't want do clone
9642 something that is bad **/
9643
9644 if(SvTYPE(sstr) == SVt_PVHV &&
9645 HvNAME(sstr)) {
9646 /** don't clone stashes if they already exist **/
9647 HV* old_stash = gv_stashpv(HvNAME(sstr),0);
9648 return (SV*) old_stash;
9649 }
9650 }
9651
1d7c1841
GS
9652 /* create anew and remember what it is */
9653 new_SV(dstr);
9654 ptr_table_store(PL_ptr_table, sstr, dstr);
9655
9656 /* clone */
9657 SvFLAGS(dstr) = SvFLAGS(sstr);
9658 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
9659 SvREFCNT(dstr) = 0; /* must be before any other dups! */
9660
9661#ifdef DEBUGGING
9662 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
9663 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
9664 PL_watch_pvx, SvPVX(sstr));
9665#endif
9666
9667 switch (SvTYPE(sstr)) {
9668 case SVt_NULL:
9669 SvANY(dstr) = NULL;
9670 break;
9671 case SVt_IV:
9672 SvANY(dstr) = new_XIV();
9673 SvIVX(dstr) = SvIVX(sstr);
9674 break;
9675 case SVt_NV:
9676 SvANY(dstr) = new_XNV();
9677 SvNVX(dstr) = SvNVX(sstr);
9678 break;
9679 case SVt_RV:
9680 SvANY(dstr) = new_XRV();
83841fad 9681 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
9682 break;
9683 case SVt_PV:
9684 SvANY(dstr) = new_XPV();
9685 SvCUR(dstr) = SvCUR(sstr);
9686 SvLEN(dstr) = SvLEN(sstr);
83841fad 9687 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
9688 break;
9689 case SVt_PVIV:
9690 SvANY(dstr) = new_XPVIV();
9691 SvCUR(dstr) = SvCUR(sstr);
9692 SvLEN(dstr) = SvLEN(sstr);
9693 SvIVX(dstr) = SvIVX(sstr);
83841fad 9694 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
9695 break;
9696 case SVt_PVNV:
9697 SvANY(dstr) = new_XPVNV();
9698 SvCUR(dstr) = SvCUR(sstr);
9699 SvLEN(dstr) = SvLEN(sstr);
9700 SvIVX(dstr) = SvIVX(sstr);
9701 SvNVX(dstr) = SvNVX(sstr);
83841fad 9702 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
9703 break;
9704 case SVt_PVMG:
9705 SvANY(dstr) = new_XPVMG();
9706 SvCUR(dstr) = SvCUR(sstr);
9707 SvLEN(dstr) = SvLEN(sstr);
9708 SvIVX(dstr) = SvIVX(sstr);
9709 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
9710 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9711 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
83841fad 9712 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
9713 break;
9714 case SVt_PVBM:
9715 SvANY(dstr) = new_XPVBM();
9716 SvCUR(dstr) = SvCUR(sstr);
9717 SvLEN(dstr) = SvLEN(sstr);
9718 SvIVX(dstr) = SvIVX(sstr);
9719 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
9720 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9721 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
83841fad 9722 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
9723 BmRARE(dstr) = BmRARE(sstr);
9724 BmUSEFUL(dstr) = BmUSEFUL(sstr);
9725 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
9726 break;
9727 case SVt_PVLV:
9728 SvANY(dstr) = new_XPVLV();
9729 SvCUR(dstr) = SvCUR(sstr);
9730 SvLEN(dstr) = SvLEN(sstr);
9731 SvIVX(dstr) = SvIVX(sstr);
9732 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
9733 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9734 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
83841fad 9735 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
9736 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
9737 LvTARGLEN(dstr) = LvTARGLEN(sstr);
d2d73c3e 9738 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
1d7c1841
GS
9739 LvTYPE(dstr) = LvTYPE(sstr);
9740 break;
9741 case SVt_PVGV:
7fb37951 9742 if (GvUNIQUE((GV*)sstr)) {
5bd07a3d 9743 SV *share;
59b40662 9744 if ((share = gv_share(sstr, param))) {
5bd07a3d
DM
9745 del_SV(dstr);
9746 dstr = share;
37e20706 9747 ptr_table_store(PL_ptr_table, sstr, dstr);
5bd07a3d
DM
9748#if 0
9749 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
9750 HvNAME(GvSTASH(share)), GvNAME(share));
9751#endif
9752 break;
9753 }
9754 }
1d7c1841
GS
9755 SvANY(dstr) = new_XPVGV();
9756 SvCUR(dstr) = SvCUR(sstr);
9757 SvLEN(dstr) = SvLEN(sstr);
9758 SvIVX(dstr) = SvIVX(sstr);
9759 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
9760 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9761 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
83841fad 9762 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
9763 GvNAMELEN(dstr) = GvNAMELEN(sstr);
9764 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
d2d73c3e 9765 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
1d7c1841 9766 GvFLAGS(dstr) = GvFLAGS(sstr);
d2d73c3e 9767 GvGP(dstr) = gp_dup(GvGP(sstr), param);
1d7c1841
GS
9768 (void)GpREFCNT_inc(GvGP(dstr));
9769 break;
9770 case SVt_PVIO:
9771 SvANY(dstr) = new_XPVIO();
9772 SvCUR(dstr) = SvCUR(sstr);
9773 SvLEN(dstr) = SvLEN(sstr);
9774 SvIVX(dstr) = SvIVX(sstr);
9775 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
9776 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9777 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
83841fad 9778 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
a8fc9800 9779 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
1d7c1841
GS
9780 if (IoOFP(sstr) == IoIFP(sstr))
9781 IoOFP(dstr) = IoIFP(dstr);
9782 else
a8fc9800 9783 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
1d7c1841
GS
9784 /* PL_rsfp_filters entries have fake IoDIRP() */
9785 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
9786 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
9787 else
9788 IoDIRP(dstr) = IoDIRP(sstr);
9789 IoLINES(dstr) = IoLINES(sstr);
9790 IoPAGE(dstr) = IoPAGE(sstr);
9791 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
9792 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
9793 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
d2d73c3e 9794 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
1d7c1841 9795 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
d2d73c3e 9796 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
1d7c1841 9797 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
d2d73c3e 9798 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
1d7c1841
GS
9799 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
9800 IoTYPE(dstr) = IoTYPE(sstr);
9801 IoFLAGS(dstr) = IoFLAGS(sstr);
9802 break;
9803 case SVt_PVAV:
9804 SvANY(dstr) = new_XPVAV();
9805 SvCUR(dstr) = SvCUR(sstr);
9806 SvLEN(dstr) = SvLEN(sstr);
9807 SvIVX(dstr) = SvIVX(sstr);
9808 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
9809 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9810 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
9811 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
1d7c1841
GS
9812 AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
9813 if (AvARRAY((AV*)sstr)) {
9814 SV **dst_ary, **src_ary;
9815 SSize_t items = AvFILLp((AV*)sstr) + 1;
9816
9817 src_ary = AvARRAY((AV*)sstr);
9818 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
9819 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
9820 SvPVX(dstr) = (char*)dst_ary;
9821 AvALLOC((AV*)dstr) = dst_ary;
9822 if (AvREAL((AV*)sstr)) {
9823 while (items-- > 0)
d2d73c3e 9824 *dst_ary++ = sv_dup_inc(*src_ary++, param);
1d7c1841
GS
9825 }
9826 else {
9827 while (items-- > 0)
d2d73c3e 9828 *dst_ary++ = sv_dup(*src_ary++, param);
1d7c1841
GS
9829 }
9830 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
9831 while (items-- > 0) {
9832 *dst_ary++ = &PL_sv_undef;
9833 }
9834 }
9835 else {
9836 SvPVX(dstr) = Nullch;
9837 AvALLOC((AV*)dstr) = (SV**)NULL;
9838 }
9839 break;
9840 case SVt_PVHV:
9841 SvANY(dstr) = new_XPVHV();
9842 SvCUR(dstr) = SvCUR(sstr);
9843 SvLEN(dstr) = SvLEN(sstr);
9844 SvIVX(dstr) = SvIVX(sstr);
9845 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
9846 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9847 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
1d7c1841
GS
9848 HvRITER((HV*)dstr) = HvRITER((HV*)sstr);
9849 if (HvARRAY((HV*)sstr)) {
1d7c1841
GS
9850 STRLEN i = 0;
9851 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
9852 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
9853 Newz(0, dxhv->xhv_array,
9854 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
9855 while (i <= sxhv->xhv_max) {
9856 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
eb160463
GS
9857 (bool)!!HvSHAREKEYS(sstr),
9858 param);
1d7c1841
GS
9859 ++i;
9860 }
eb160463
GS
9861 dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter,
9862 (bool)!!HvSHAREKEYS(sstr), param);
1d7c1841
GS
9863 }
9864 else {
9865 SvPVX(dstr) = Nullch;
9866 HvEITER((HV*)dstr) = (HE*)NULL;
9867 }
9868 HvPMROOT((HV*)dstr) = HvPMROOT((HV*)sstr); /* XXX */
9869 HvNAME((HV*)dstr) = SAVEPV(HvNAME((HV*)sstr));
c43294b8 9870 /* Record stashes for possible cloning in Perl_clone(). */
6676db26 9871 if(HvNAME((HV*)dstr))
d2d73c3e 9872 av_push(param->stashes, dstr);
1d7c1841
GS
9873 break;
9874 case SVt_PVFM:
9875 SvANY(dstr) = new_XPVFM();
9876 FmLINES(dstr) = FmLINES(sstr);
9877 goto dup_pvcv;
9878 /* NOTREACHED */
9879 case SVt_PVCV:
9880 SvANY(dstr) = new_XPVCV();
d2d73c3e 9881 dup_pvcv:
1d7c1841
GS
9882 SvCUR(dstr) = SvCUR(sstr);
9883 SvLEN(dstr) = SvLEN(sstr);
9884 SvIVX(dstr) = SvIVX(sstr);
9885 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
9886 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
9887 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
83841fad 9888 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
d2d73c3e 9889 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
1d7c1841
GS
9890 CvSTART(dstr) = CvSTART(sstr);
9891 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
9892 CvXSUB(dstr) = CvXSUB(sstr);
9893 CvXSUBANY(dstr) = CvXSUBANY(sstr);
01485f8b
DM
9894 if (CvCONST(sstr)) {
9895 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
9896 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
9897 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
9898 }
d2d73c3e
AB
9899 CvGV(dstr) = gv_dup(CvGV(sstr), param);
9900 if (param->flags & CLONEf_COPY_STACKS) {
9901 CvDEPTH(dstr) = CvDEPTH(sstr);
9902 } else {
9903 CvDEPTH(dstr) = 0;
9904 }
dd2155a4 9905 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
7dafbf52
DM
9906 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
9907 CvOUTSIDE(dstr) =
9908 CvWEAKOUTSIDE(sstr)
9909 ? cv_dup( CvOUTSIDE(sstr), param)
9910 : cv_dup_inc(CvOUTSIDE(sstr), param);
1d7c1841 9911 CvFLAGS(dstr) = CvFLAGS(sstr);
54356c7d 9912 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
1d7c1841
GS
9913 break;
9914 default:
c803eecc 9915 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
1d7c1841
GS
9916 break;
9917 }
9918
9919 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
9920 ++PL_sv_objcount;
9921
9922 return dstr;
d2d73c3e 9923 }
1d7c1841 9924
645c22ef
DM
9925/* duplicate a context */
9926
1d7c1841 9927PERL_CONTEXT *
a8fc9800 9928Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
1d7c1841
GS
9929{
9930 PERL_CONTEXT *ncxs;
9931
9932 if (!cxs)
9933 return (PERL_CONTEXT*)NULL;
9934
9935 /* look for it in the table first */
9936 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
9937 if (ncxs)
9938 return ncxs;
9939
9940 /* create anew and remember what it is */
9941 Newz(56, ncxs, max + 1, PERL_CONTEXT);
9942 ptr_table_store(PL_ptr_table, cxs, ncxs);
9943
9944 while (ix >= 0) {
9945 PERL_CONTEXT *cx = &cxs[ix];
9946 PERL_CONTEXT *ncx = &ncxs[ix];
9947 ncx->cx_type = cx->cx_type;
9948 if (CxTYPE(cx) == CXt_SUBST) {
9949 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
9950 }
9951 else {
9952 ncx->blk_oldsp = cx->blk_oldsp;
9953 ncx->blk_oldcop = cx->blk_oldcop;
9954 ncx->blk_oldretsp = cx->blk_oldretsp;
9955 ncx->blk_oldmarksp = cx->blk_oldmarksp;
9956 ncx->blk_oldscopesp = cx->blk_oldscopesp;
9957 ncx->blk_oldpm = cx->blk_oldpm;
9958 ncx->blk_gimme = cx->blk_gimme;
9959 switch (CxTYPE(cx)) {
9960 case CXt_SUB:
9961 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
d2d73c3e
AB
9962 ? cv_dup_inc(cx->blk_sub.cv, param)
9963 : cv_dup(cx->blk_sub.cv,param));
1d7c1841 9964 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
d2d73c3e 9965 ? av_dup_inc(cx->blk_sub.argarray, param)
1d7c1841 9966 : Nullav);
d2d73c3e 9967 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
1d7c1841
GS
9968 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
9969 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
9970 ncx->blk_sub.lval = cx->blk_sub.lval;
9971 break;
9972 case CXt_EVAL:
9973 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
9974 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
b47cad08 9975 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
1d7c1841 9976 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
d2d73c3e 9977 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
1d7c1841
GS
9978 break;
9979 case CXt_LOOP:
9980 ncx->blk_loop.label = cx->blk_loop.label;
9981 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
9982 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
9983 ncx->blk_loop.next_op = cx->blk_loop.next_op;
9984 ncx->blk_loop.last_op = cx->blk_loop.last_op;
9985 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
9986 ? cx->blk_loop.iterdata
d2d73c3e 9987 : gv_dup((GV*)cx->blk_loop.iterdata, param));
f3548bdc
DM
9988 ncx->blk_loop.oldcomppad
9989 = (PAD*)ptr_table_fetch(PL_ptr_table,
9990 cx->blk_loop.oldcomppad);
d2d73c3e
AB
9991 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
9992 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
9993 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
1d7c1841
GS
9994 ncx->blk_loop.iterix = cx->blk_loop.iterix;
9995 ncx->blk_loop.itermax = cx->blk_loop.itermax;
9996 break;
9997 case CXt_FORMAT:
d2d73c3e
AB
9998 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
9999 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
10000 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
1d7c1841
GS
10001 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
10002 break;
10003 case CXt_BLOCK:
10004 case CXt_NULL:
10005 break;
10006 }
10007 }
10008 --ix;
10009 }
10010 return ncxs;
10011}
10012
645c22ef
DM
10013/* duplicate a stack info structure */
10014
1d7c1841 10015PERL_SI *
a8fc9800 10016Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
1d7c1841
GS
10017{
10018 PERL_SI *nsi;
10019
10020 if (!si)
10021 return (PERL_SI*)NULL;
10022
10023 /* look for it in the table first */
10024 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
10025 if (nsi)
10026 return nsi;
10027
10028 /* create anew and remember what it is */
10029 Newz(56, nsi, 1, PERL_SI);
10030 ptr_table_store(PL_ptr_table, si, nsi);
10031
d2d73c3e 10032 nsi->si_stack = av_dup_inc(si->si_stack, param);
1d7c1841
GS
10033 nsi->si_cxix = si->si_cxix;
10034 nsi->si_cxmax = si->si_cxmax;
d2d73c3e 10035 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
1d7c1841 10036 nsi->si_type = si->si_type;
d2d73c3e
AB
10037 nsi->si_prev = si_dup(si->si_prev, param);
10038 nsi->si_next = si_dup(si->si_next, param);
1d7c1841
GS
10039 nsi->si_markoff = si->si_markoff;
10040
10041 return nsi;
10042}
10043
10044#define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
10045#define TOPINT(ss,ix) ((ss)[ix].any_i32)
10046#define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
10047#define TOPLONG(ss,ix) ((ss)[ix].any_long)
10048#define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
10049#define TOPIV(ss,ix) ((ss)[ix].any_iv)
38d8b13e
HS
10050#define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
10051#define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
1d7c1841
GS
10052#define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
10053#define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
10054#define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
10055#define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
10056#define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
10057#define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
10058
10059/* XXXXX todo */
10060#define pv_dup_inc(p) SAVEPV(p)
10061#define pv_dup(p) SAVEPV(p)
10062#define svp_dup_inc(p,pp) any_dup(p,pp)
10063
645c22ef
DM
10064/* map any object to the new equivent - either something in the
10065 * ptr table, or something in the interpreter structure
10066 */
10067
1d7c1841
GS
10068void *
10069Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
10070{
10071 void *ret;
10072
10073 if (!v)
10074 return (void*)NULL;
10075
10076 /* look for it in the table first */
10077 ret = ptr_table_fetch(PL_ptr_table, v);
10078 if (ret)
10079 return ret;
10080
10081 /* see if it is part of the interpreter structure */
10082 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
acfe0abc 10083 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
05ec9bb3 10084 else {
1d7c1841 10085 ret = v;
05ec9bb3 10086 }
1d7c1841
GS
10087
10088 return ret;
10089}
10090
645c22ef
DM
10091/* duplicate the save stack */
10092
1d7c1841 10093ANY *
a8fc9800 10094Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
1d7c1841
GS
10095{
10096 ANY *ss = proto_perl->Tsavestack;
10097 I32 ix = proto_perl->Tsavestack_ix;
10098 I32 max = proto_perl->Tsavestack_max;
10099 ANY *nss;
10100 SV *sv;
10101 GV *gv;
10102 AV *av;
10103 HV *hv;
10104 void* ptr;
10105 int intval;
10106 long longval;
10107 GP *gp;
10108 IV iv;
10109 I32 i;
c4e33207 10110 char *c = NULL;
1d7c1841 10111 void (*dptr) (void*);
acfe0abc 10112 void (*dxptr) (pTHX_ void*);
e977893f 10113 OP *o;
1d7c1841
GS
10114
10115 Newz(54, nss, max, ANY);
10116
10117 while (ix > 0) {
10118 i = POPINT(ss,ix);
10119 TOPINT(nss,ix) = i;
10120 switch (i) {
10121 case SAVEt_ITEM: /* normal string */
10122 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 10123 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841 10124 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 10125 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841
GS
10126 break;
10127 case SAVEt_SV: /* scalar reference */
10128 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 10129 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841 10130 gv = (GV*)POPPTR(ss,ix);
d2d73c3e 10131 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
1d7c1841 10132 break;
f4dd75d9
GS
10133 case SAVEt_GENERIC_PVREF: /* generic char* */
10134 c = (char*)POPPTR(ss,ix);
10135 TOPPTR(nss,ix) = pv_dup(c);
10136 ptr = POPPTR(ss,ix);
10137 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10138 break;
05ec9bb3
NIS
10139 case SAVEt_SHARED_PVREF: /* char* in shared space */
10140 c = (char*)POPPTR(ss,ix);
10141 TOPPTR(nss,ix) = savesharedpv(c);
10142 ptr = POPPTR(ss,ix);
10143 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10144 break;
1d7c1841
GS
10145 case SAVEt_GENERIC_SVREF: /* generic sv */
10146 case SAVEt_SVREF: /* scalar reference */
10147 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 10148 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841
GS
10149 ptr = POPPTR(ss,ix);
10150 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
10151 break;
10152 case SAVEt_AV: /* array reference */
10153 av = (AV*)POPPTR(ss,ix);
d2d73c3e 10154 TOPPTR(nss,ix) = av_dup_inc(av, param);
1d7c1841 10155 gv = (GV*)POPPTR(ss,ix);
d2d73c3e 10156 TOPPTR(nss,ix) = gv_dup(gv, param);
1d7c1841
GS
10157 break;
10158 case SAVEt_HV: /* hash reference */
10159 hv = (HV*)POPPTR(ss,ix);
d2d73c3e 10160 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
1d7c1841 10161 gv = (GV*)POPPTR(ss,ix);
d2d73c3e 10162 TOPPTR(nss,ix) = gv_dup(gv, param);
1d7c1841
GS
10163 break;
10164 case SAVEt_INT: /* int reference */
10165 ptr = POPPTR(ss,ix);
10166 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10167 intval = (int)POPINT(ss,ix);
10168 TOPINT(nss,ix) = intval;
10169 break;
10170 case SAVEt_LONG: /* long reference */
10171 ptr = POPPTR(ss,ix);
10172 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10173 longval = (long)POPLONG(ss,ix);
10174 TOPLONG(nss,ix) = longval;
10175 break;
10176 case SAVEt_I32: /* I32 reference */
10177 case SAVEt_I16: /* I16 reference */
10178 case SAVEt_I8: /* I8 reference */
10179 ptr = POPPTR(ss,ix);
10180 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10181 i = POPINT(ss,ix);
10182 TOPINT(nss,ix) = i;
10183 break;
10184 case SAVEt_IV: /* IV reference */
10185 ptr = POPPTR(ss,ix);
10186 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10187 iv = POPIV(ss,ix);
10188 TOPIV(nss,ix) = iv;
10189 break;
10190 case SAVEt_SPTR: /* SV* reference */
10191 ptr = POPPTR(ss,ix);
10192 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10193 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 10194 TOPPTR(nss,ix) = sv_dup(sv, param);
1d7c1841
GS
10195 break;
10196 case SAVEt_VPTR: /* random* reference */
10197 ptr = POPPTR(ss,ix);
10198 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10199 ptr = POPPTR(ss,ix);
10200 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10201 break;
10202 case SAVEt_PPTR: /* char* reference */
10203 ptr = POPPTR(ss,ix);
10204 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10205 c = (char*)POPPTR(ss,ix);
10206 TOPPTR(nss,ix) = pv_dup(c);
10207 break;
10208 case SAVEt_HPTR: /* HV* reference */
10209 ptr = POPPTR(ss,ix);
10210 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10211 hv = (HV*)POPPTR(ss,ix);
d2d73c3e 10212 TOPPTR(nss,ix) = hv_dup(hv, param);
1d7c1841
GS
10213 break;
10214 case SAVEt_APTR: /* AV* reference */
10215 ptr = POPPTR(ss,ix);
10216 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10217 av = (AV*)POPPTR(ss,ix);
d2d73c3e 10218 TOPPTR(nss,ix) = av_dup(av, param);
1d7c1841
GS
10219 break;
10220 case SAVEt_NSTAB:
10221 gv = (GV*)POPPTR(ss,ix);
d2d73c3e 10222 TOPPTR(nss,ix) = gv_dup(gv, param);
1d7c1841
GS
10223 break;
10224 case SAVEt_GP: /* scalar reference */
10225 gp = (GP*)POPPTR(ss,ix);
d2d73c3e 10226 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
1d7c1841
GS
10227 (void)GpREFCNT_inc(gp);
10228 gv = (GV*)POPPTR(ss,ix);
2ed3c8fc 10229 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
1d7c1841
GS
10230 c = (char*)POPPTR(ss,ix);
10231 TOPPTR(nss,ix) = pv_dup(c);
10232 iv = POPIV(ss,ix);
10233 TOPIV(nss,ix) = iv;
10234 iv = POPIV(ss,ix);
10235 TOPIV(nss,ix) = iv;
10236 break;
10237 case SAVEt_FREESV:
26d9b02f 10238 case SAVEt_MORTALIZESV:
1d7c1841 10239 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 10240 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841
GS
10241 break;
10242 case SAVEt_FREEOP:
10243 ptr = POPPTR(ss,ix);
10244 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
10245 /* these are assumed to be refcounted properly */
10246 switch (((OP*)ptr)->op_type) {
10247 case OP_LEAVESUB:
10248 case OP_LEAVESUBLV:
10249 case OP_LEAVEEVAL:
10250 case OP_LEAVE:
10251 case OP_SCOPE:
10252 case OP_LEAVEWRITE:
e977893f
GS
10253 TOPPTR(nss,ix) = ptr;
10254 o = (OP*)ptr;
10255 OpREFCNT_inc(o);
1d7c1841
GS
10256 break;
10257 default:
10258 TOPPTR(nss,ix) = Nullop;
10259 break;
10260 }
10261 }
10262 else
10263 TOPPTR(nss,ix) = Nullop;
10264 break;
10265 case SAVEt_FREEPV:
10266 c = (char*)POPPTR(ss,ix);
10267 TOPPTR(nss,ix) = pv_dup_inc(c);
10268 break;
10269 case SAVEt_CLEARSV:
10270 longval = POPLONG(ss,ix);
10271 TOPLONG(nss,ix) = longval;
10272 break;
10273 case SAVEt_DELETE:
10274 hv = (HV*)POPPTR(ss,ix);
d2d73c3e 10275 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
1d7c1841
GS
10276 c = (char*)POPPTR(ss,ix);
10277 TOPPTR(nss,ix) = pv_dup_inc(c);
10278 i = POPINT(ss,ix);
10279 TOPINT(nss,ix) = i;
10280 break;
10281 case SAVEt_DESTRUCTOR:
10282 ptr = POPPTR(ss,ix);
10283 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10284 dptr = POPDPTR(ss,ix);
ef75a179 10285 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
1d7c1841
GS
10286 break;
10287 case SAVEt_DESTRUCTOR_X:
10288 ptr = POPPTR(ss,ix);
10289 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
10290 dxptr = POPDXPTR(ss,ix);
acfe0abc 10291 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
1d7c1841
GS
10292 break;
10293 case SAVEt_REGCONTEXT:
10294 case SAVEt_ALLOC:
10295 i = POPINT(ss,ix);
10296 TOPINT(nss,ix) = i;
10297 ix -= i;
10298 break;
10299 case SAVEt_STACK_POS: /* Position on Perl stack */
10300 i = POPINT(ss,ix);
10301 TOPINT(nss,ix) = i;
10302 break;
10303 case SAVEt_AELEM: /* array element */
10304 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 10305 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841
GS
10306 i = POPINT(ss,ix);
10307 TOPINT(nss,ix) = i;
10308 av = (AV*)POPPTR(ss,ix);
d2d73c3e 10309 TOPPTR(nss,ix) = av_dup_inc(av, param);
1d7c1841
GS
10310 break;
10311 case SAVEt_HELEM: /* hash element */
10312 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 10313 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841 10314 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 10315 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841 10316 hv = (HV*)POPPTR(ss,ix);
d2d73c3e 10317 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
1d7c1841
GS
10318 break;
10319 case SAVEt_OP:
10320 ptr = POPPTR(ss,ix);
10321 TOPPTR(nss,ix) = ptr;
10322 break;
10323 case SAVEt_HINTS:
10324 i = POPINT(ss,ix);
10325 TOPINT(nss,ix) = i;
10326 break;
c4410b1b
GS
10327 case SAVEt_COMPPAD:
10328 av = (AV*)POPPTR(ss,ix);
d2d73c3e 10329 TOPPTR(nss,ix) = av_dup(av, param);
c4410b1b 10330 break;
c3564e5c
GS
10331 case SAVEt_PADSV:
10332 longval = (long)POPLONG(ss,ix);
10333 TOPLONG(nss,ix) = longval;
10334 ptr = POPPTR(ss,ix);
10335 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
10336 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 10337 TOPPTR(nss,ix) = sv_dup(sv, param);
c3564e5c 10338 break;
a1bb4754 10339 case SAVEt_BOOL:
38d8b13e 10340 ptr = POPPTR(ss,ix);
b9609c01 10341 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
38d8b13e 10342 longval = (long)POPBOOL(ss,ix);
b9609c01 10343 TOPBOOL(nss,ix) = (bool)longval;
a1bb4754 10344 break;
1d7c1841
GS
10345 default:
10346 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
10347 }
10348 }
10349
10350 return nss;
10351}
10352
645c22ef
DM
10353/*
10354=for apidoc perl_clone
10355
10356Create and return a new interpreter by cloning the current one.
10357
6a78b4db
AB
10358perl_clone takes these flags as paramters:
10359
10360CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
10361without it we only clone the data and zero the stacks,
10362with it we copy the stacks and the new perl interpreter is
10363ready to run at the exact same point as the previous one.
10364The pseudo-fork code uses COPY_STACKS while the
10365threads->new doesn't.
10366
10367CLONEf_KEEP_PTR_TABLE
10368perl_clone keeps a ptr_table with the pointer of the old
10369variable as a key and the new variable as a value,
10370this allows it to check if something has been cloned and not
10371clone it again but rather just use the value and increase the
10372refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
10373the ptr_table using the function
10374C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
10375reason to keep it around is if you want to dup some of your own
10376variable who are outside the graph perl scans, example of this
10377code is in threads.xs create
10378
10379CLONEf_CLONE_HOST
10380This is a win32 thing, it is ignored on unix, it tells perls
10381win32host code (which is c++) to clone itself, this is needed on
10382win32 if you want to run two threads at the same time,
10383if you just want to do some stuff in a separate perl interpreter
10384and then throw it away and return to the original one,
10385you don't need to do anything.
10386
645c22ef
DM
10387=cut
10388*/
10389
10390/* XXX the above needs expanding by someone who actually understands it ! */
3fc56081
NK
10391EXTERN_C PerlInterpreter *
10392perl_clone_host(PerlInterpreter* proto_perl, UV flags);
645c22ef 10393
1d7c1841
GS
10394PerlInterpreter *
10395perl_clone(PerlInterpreter *proto_perl, UV flags)
10396{
1d7c1841 10397#ifdef PERL_IMPLICIT_SYS
c43294b8
AB
10398
10399 /* perlhost.h so we need to call into it
10400 to clone the host, CPerlHost should have a c interface, sky */
10401
10402 if (flags & CLONEf_CLONE_HOST) {
10403 return perl_clone_host(proto_perl,flags);
10404 }
10405 return perl_clone_using(proto_perl, flags,
1d7c1841
GS
10406 proto_perl->IMem,
10407 proto_perl->IMemShared,
10408 proto_perl->IMemParse,
10409 proto_perl->IEnv,
10410 proto_perl->IStdIO,
10411 proto_perl->ILIO,
10412 proto_perl->IDir,
10413 proto_perl->ISock,
10414 proto_perl->IProc);
10415}
10416
10417PerlInterpreter *
10418perl_clone_using(PerlInterpreter *proto_perl, UV flags,
10419 struct IPerlMem* ipM, struct IPerlMem* ipMS,
10420 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
10421 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
10422 struct IPerlDir* ipD, struct IPerlSock* ipS,
10423 struct IPerlProc* ipP)
10424{
10425 /* XXX many of the string copies here can be optimized if they're
10426 * constants; they need to be allocated as common memory and just
10427 * their pointers copied. */
10428
10429 IV i;
64aa0685
GS
10430 CLONE_PARAMS clone_params;
10431 CLONE_PARAMS* param = &clone_params;
d2d73c3e 10432
1d7c1841 10433 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
ba869deb 10434 PERL_SET_THX(my_perl);
1d7c1841 10435
acfe0abc 10436# ifdef DEBUGGING
a4530404 10437 Poison(my_perl, 1, PerlInterpreter);
1d7c1841
GS
10438 PL_markstack = 0;
10439 PL_scopestack = 0;
10440 PL_savestack = 0;
10441 PL_retstack = 0;
66fe0623 10442 PL_sig_pending = 0;
25596c82 10443 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
acfe0abc 10444# else /* !DEBUGGING */
1d7c1841 10445 Zero(my_perl, 1, PerlInterpreter);
acfe0abc 10446# endif /* DEBUGGING */
1d7c1841
GS
10447
10448 /* host pointers */
10449 PL_Mem = ipM;
10450 PL_MemShared = ipMS;
10451 PL_MemParse = ipMP;
10452 PL_Env = ipE;
10453 PL_StdIO = ipStd;
10454 PL_LIO = ipLIO;
10455 PL_Dir = ipD;
10456 PL_Sock = ipS;
10457 PL_Proc = ipP;
1d7c1841
GS
10458#else /* !PERL_IMPLICIT_SYS */
10459 IV i;
64aa0685
GS
10460 CLONE_PARAMS clone_params;
10461 CLONE_PARAMS* param = &clone_params;
1d7c1841 10462 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
ba869deb 10463 PERL_SET_THX(my_perl);
1d7c1841 10464
d2d73c3e
AB
10465
10466
1d7c1841 10467# ifdef DEBUGGING
a4530404 10468 Poison(my_perl, 1, PerlInterpreter);
1d7c1841
GS
10469 PL_markstack = 0;
10470 PL_scopestack = 0;
10471 PL_savestack = 0;
10472 PL_retstack = 0;
66fe0623 10473 PL_sig_pending = 0;
25596c82 10474 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
1d7c1841
GS
10475# else /* !DEBUGGING */
10476 Zero(my_perl, 1, PerlInterpreter);
10477# endif /* DEBUGGING */
10478#endif /* PERL_IMPLICIT_SYS */
83236556 10479 param->flags = flags;
59b40662 10480 param->proto_perl = proto_perl;
1d7c1841
GS
10481
10482 /* arena roots */
10483 PL_xiv_arenaroot = NULL;
10484 PL_xiv_root = NULL;
612f20c3 10485 PL_xnv_arenaroot = NULL;
1d7c1841 10486 PL_xnv_root = NULL;
612f20c3 10487 PL_xrv_arenaroot = NULL;
1d7c1841 10488 PL_xrv_root = NULL;
612f20c3 10489 PL_xpv_arenaroot = NULL;
1d7c1841 10490 PL_xpv_root = NULL;
612f20c3 10491 PL_xpviv_arenaroot = NULL;
1d7c1841 10492 PL_xpviv_root = NULL;
612f20c3 10493 PL_xpvnv_arenaroot = NULL;
1d7c1841 10494 PL_xpvnv_root = NULL;
612f20c3 10495 PL_xpvcv_arenaroot = NULL;
1d7c1841 10496 PL_xpvcv_root = NULL;
612f20c3 10497 PL_xpvav_arenaroot = NULL;
1d7c1841 10498 PL_xpvav_root = NULL;
612f20c3 10499 PL_xpvhv_arenaroot = NULL;
1d7c1841 10500 PL_xpvhv_root = NULL;
612f20c3 10501 PL_xpvmg_arenaroot = NULL;
1d7c1841 10502 PL_xpvmg_root = NULL;
612f20c3 10503 PL_xpvlv_arenaroot = NULL;
1d7c1841 10504 PL_xpvlv_root = NULL;
612f20c3 10505 PL_xpvbm_arenaroot = NULL;
1d7c1841 10506 PL_xpvbm_root = NULL;
612f20c3 10507 PL_he_arenaroot = NULL;
1d7c1841
GS
10508 PL_he_root = NULL;
10509 PL_nice_chunk = NULL;
10510 PL_nice_chunk_size = 0;
10511 PL_sv_count = 0;
10512 PL_sv_objcount = 0;
10513 PL_sv_root = Nullsv;
10514 PL_sv_arenaroot = Nullsv;
10515
10516 PL_debug = proto_perl->Idebug;
10517
e5dd39fc 10518#ifdef USE_REENTRANT_API
59bd0823 10519 Perl_reentrant_init(aTHX);
e5dd39fc
AB
10520#endif
10521
1d7c1841
GS
10522 /* create SV map for pointer relocation */
10523 PL_ptr_table = ptr_table_new();
10524
10525 /* initialize these special pointers as early as possible */
10526 SvANY(&PL_sv_undef) = NULL;
10527 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
10528 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
10529 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
10530
1d7c1841 10531 SvANY(&PL_sv_no) = new_XPVNV();
1d7c1841
GS
10532 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
10533 SvFLAGS(&PL_sv_no) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10534 SvPVX(&PL_sv_no) = SAVEPVN(PL_No, 0);
10535 SvCUR(&PL_sv_no) = 0;
10536 SvLEN(&PL_sv_no) = 1;
10537 SvNVX(&PL_sv_no) = 0;
10538 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
10539
1d7c1841 10540 SvANY(&PL_sv_yes) = new_XPVNV();
1d7c1841
GS
10541 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
10542 SvFLAGS(&PL_sv_yes) = SVp_NOK|SVf_NOK|SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
10543 SvPVX(&PL_sv_yes) = SAVEPVN(PL_Yes, 1);
10544 SvCUR(&PL_sv_yes) = 1;
10545 SvLEN(&PL_sv_yes) = 2;
10546 SvNVX(&PL_sv_yes) = 1;
10547 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
10548
05ec9bb3 10549 /* create (a non-shared!) shared string table */
1d7c1841
GS
10550 PL_strtab = newHV();
10551 HvSHAREKEYS_off(PL_strtab);
10552 hv_ksplit(PL_strtab, 512);
10553 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
10554
05ec9bb3
NIS
10555 PL_compiling = proto_perl->Icompiling;
10556
10557 /* These two PVs will be free'd special way so must set them same way op.c does */
10558 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
10559 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
10560
10561 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
10562 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
10563
1d7c1841
GS
10564 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
10565 if (!specialWARN(PL_compiling.cop_warnings))
d2d73c3e 10566 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
ac27b0f5 10567 if (!specialCopIO(PL_compiling.cop_io))
d2d73c3e 10568 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
1d7c1841
GS
10569 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
10570
10571 /* pseudo environmental stuff */
10572 PL_origargc = proto_perl->Iorigargc;
e2975953 10573 PL_origargv = proto_perl->Iorigargv;
d2d73c3e 10574
d2d73c3e
AB
10575 param->stashes = newAV(); /* Setup array of objects to call clone on */
10576
a1ea730d 10577#ifdef PERLIO_LAYERS
3a1ee7e8
NIS
10578 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
10579 PerlIO_clone(aTHX_ proto_perl, param);
a1ea730d 10580#endif
d2d73c3e
AB
10581
10582 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
10583 PL_incgv = gv_dup(proto_perl->Iincgv, param);
10584 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
1d7c1841 10585 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
d2d73c3e
AB
10586 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
10587 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
1d7c1841
GS
10588
10589 /* switches */
10590 PL_minus_c = proto_perl->Iminus_c;
d2d73c3e 10591 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
1d7c1841
GS
10592 PL_localpatches = proto_perl->Ilocalpatches;
10593 PL_splitstr = proto_perl->Isplitstr;
10594 PL_preprocess = proto_perl->Ipreprocess;
10595 PL_minus_n = proto_perl->Iminus_n;
10596 PL_minus_p = proto_perl->Iminus_p;
10597 PL_minus_l = proto_perl->Iminus_l;
10598 PL_minus_a = proto_perl->Iminus_a;
10599 PL_minus_F = proto_perl->Iminus_F;
10600 PL_doswitches = proto_perl->Idoswitches;
10601 PL_dowarn = proto_perl->Idowarn;
10602 PL_doextract = proto_perl->Idoextract;
10603 PL_sawampersand = proto_perl->Isawampersand;
10604 PL_unsafe = proto_perl->Iunsafe;
10605 PL_inplace = SAVEPV(proto_perl->Iinplace);
d2d73c3e 10606 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
1d7c1841
GS
10607 PL_perldb = proto_perl->Iperldb;
10608 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
1cbb0781 10609 PL_exit_flags = proto_perl->Iexit_flags;
1d7c1841
GS
10610
10611 /* magical thingies */
10612 /* XXX time(&PL_basetime) when asked for? */
10613 PL_basetime = proto_perl->Ibasetime;
d2d73c3e 10614 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
1d7c1841
GS
10615
10616 PL_maxsysfd = proto_perl->Imaxsysfd;
10617 PL_multiline = proto_perl->Imultiline;
10618 PL_statusvalue = proto_perl->Istatusvalue;
10619#ifdef VMS
10620 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
10621#endif
0a378802 10622 PL_encoding = sv_dup(proto_perl->Iencoding, param);
1d7c1841 10623
4a4c6fe3 10624 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
1f483ca1
JH
10625 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
10626 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
4a4c6fe3 10627
d2f185dc
AMS
10628 /* Clone the regex array */
10629 PL_regex_padav = newAV();
10630 {
10631 I32 len = av_len((AV*)proto_perl->Iregex_padav);
10632 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
0f95fc41
AB
10633 av_push(PL_regex_padav,
10634 sv_dup_inc(regexen[0],param));
10635 for(i = 1; i <= len; i++) {
10636 if(SvREPADTMP(regexen[i])) {
10637 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
8cf8f3d1 10638 } else {
0f95fc41
AB
10639 av_push(PL_regex_padav,
10640 SvREFCNT_inc(
8cf8f3d1 10641 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
cbfa9890 10642 SvIVX(regexen[i])), param)))
0f95fc41
AB
10643 ));
10644 }
d2f185dc
AMS
10645 }
10646 }
10647 PL_regex_pad = AvARRAY(PL_regex_padav);
1fcf4c12 10648
1d7c1841 10649 /* shortcuts to various I/O objects */
d2d73c3e
AB
10650 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
10651 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
10652 PL_defgv = gv_dup(proto_perl->Idefgv, param);
10653 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
10654 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
10655 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
1d7c1841
GS
10656
10657 /* shortcuts to regexp stuff */
d2d73c3e 10658 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
1d7c1841
GS
10659
10660 /* shortcuts to misc objects */
d2d73c3e 10661 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
1d7c1841
GS
10662
10663 /* shortcuts to debugging objects */
d2d73c3e
AB
10664 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
10665 PL_DBline = gv_dup(proto_perl->IDBline, param);
10666 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
10667 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
10668 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
10669 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
10670 PL_lineary = av_dup(proto_perl->Ilineary, param);
10671 PL_dbargs = av_dup(proto_perl->Idbargs, param);
1d7c1841
GS
10672
10673 /* symbol tables */
d2d73c3e
AB
10674 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
10675 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
d2d73c3e
AB
10676 PL_debstash = hv_dup(proto_perl->Idebstash, param);
10677 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
10678 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
10679
10680 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
ee1c5a4e 10681 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
ece599bd 10682 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
d2d73c3e
AB
10683 PL_endav = av_dup_inc(proto_perl->Iendav, param);
10684 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
10685 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
1d7c1841
GS
10686
10687 PL_sub_generation = proto_perl->Isub_generation;
10688
10689 /* funky return mechanisms */
10690 PL_forkprocess = proto_perl->Iforkprocess;
10691
10692 /* subprocess state */
d2d73c3e 10693 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
1d7c1841
GS
10694
10695 /* internal state */
10696 PL_tainting = proto_perl->Itainting;
10697 PL_maxo = proto_perl->Imaxo;
10698 if (proto_perl->Iop_mask)
10699 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
10700 else
10701 PL_op_mask = Nullch;
10702
10703 /* current interpreter roots */
d2d73c3e 10704 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
1d7c1841
GS
10705 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
10706 PL_main_start = proto_perl->Imain_start;
e977893f 10707 PL_eval_root = proto_perl->Ieval_root;
1d7c1841
GS
10708 PL_eval_start = proto_perl->Ieval_start;
10709
10710 /* runtime control stuff */
10711 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
10712 PL_copline = proto_perl->Icopline;
10713
10714 PL_filemode = proto_perl->Ifilemode;
10715 PL_lastfd = proto_perl->Ilastfd;
10716 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
10717 PL_Argv = NULL;
10718 PL_Cmd = Nullch;
10719 PL_gensym = proto_perl->Igensym;
10720 PL_preambled = proto_perl->Ipreambled;
d2d73c3e 10721 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
1d7c1841
GS
10722 PL_laststatval = proto_perl->Ilaststatval;
10723 PL_laststype = proto_perl->Ilaststype;
10724 PL_mess_sv = Nullsv;
10725
d2d73c3e 10726 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
1d7c1841
GS
10727 PL_ofmt = SAVEPV(proto_perl->Iofmt);
10728
10729 /* interpreter atexit processing */
10730 PL_exitlistlen = proto_perl->Iexitlistlen;
10731 if (PL_exitlistlen) {
10732 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10733 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
10734 }
10735 else
10736 PL_exitlist = (PerlExitListEntry*)NULL;
d2d73c3e 10737 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
19e8ce8e
AB
10738 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
10739 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
1d7c1841
GS
10740
10741 PL_profiledata = NULL;
a8fc9800 10742 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
1d7c1841 10743 /* PL_rsfp_filters entries have fake IoDIRP() */
d2d73c3e 10744 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
1d7c1841 10745
d2d73c3e 10746 PL_compcv = cv_dup(proto_perl->Icompcv, param);
dd2155a4
DM
10747
10748 PAD_CLONE_VARS(proto_perl, param);
1d7c1841
GS
10749
10750#ifdef HAVE_INTERP_INTERN
10751 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
10752#endif
10753
10754 /* more statics moved here */
10755 PL_generation = proto_perl->Igeneration;
d2d73c3e 10756 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
1d7c1841
GS
10757
10758 PL_in_clean_objs = proto_perl->Iin_clean_objs;
10759 PL_in_clean_all = proto_perl->Iin_clean_all;
10760
10761 PL_uid = proto_perl->Iuid;
10762 PL_euid = proto_perl->Ieuid;
10763 PL_gid = proto_perl->Igid;
10764 PL_egid = proto_perl->Iegid;
10765 PL_nomemok = proto_perl->Inomemok;
10766 PL_an = proto_perl->Ian;
1d7c1841
GS
10767 PL_op_seqmax = proto_perl->Iop_seqmax;
10768 PL_evalseq = proto_perl->Ievalseq;
10769 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
10770 PL_origalen = proto_perl->Iorigalen;
10771 PL_pidstatus = newHV(); /* XXX flag for cloning? */
10772 PL_osname = SAVEPV(proto_perl->Iosname);
0bb09c15 10773 PL_sh_path = proto_perl->Ish_path; /* XXX never deallocated */
1d7c1841
GS
10774 PL_sighandlerp = proto_perl->Isighandlerp;
10775
10776
10777 PL_runops = proto_perl->Irunops;
10778
10779 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
10780
10781#ifdef CSH
10782 PL_cshlen = proto_perl->Icshlen;
74f1b2b8 10783 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
1d7c1841
GS
10784#endif
10785
10786 PL_lex_state = proto_perl->Ilex_state;
10787 PL_lex_defer = proto_perl->Ilex_defer;
10788 PL_lex_expect = proto_perl->Ilex_expect;
10789 PL_lex_formbrack = proto_perl->Ilex_formbrack;
10790 PL_lex_dojoin = proto_perl->Ilex_dojoin;
10791 PL_lex_starts = proto_perl->Ilex_starts;
d2d73c3e
AB
10792 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
10793 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
1d7c1841
GS
10794 PL_lex_op = proto_perl->Ilex_op;
10795 PL_lex_inpat = proto_perl->Ilex_inpat;
10796 PL_lex_inwhat = proto_perl->Ilex_inwhat;
10797 PL_lex_brackets = proto_perl->Ilex_brackets;
10798 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
10799 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
10800 PL_lex_casemods = proto_perl->Ilex_casemods;
10801 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
10802 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
10803
10804 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
10805 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
10806 PL_nexttoke = proto_perl->Inexttoke;
10807
1d773130
TB
10808 /* XXX This is probably masking the deeper issue of why
10809 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
10810 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
10811 * (A little debugging with a watchpoint on it may help.)
10812 */
389edf32
TB
10813 if (SvANY(proto_perl->Ilinestr)) {
10814 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
10815 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
10816 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10817 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
10818 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10819 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
10820 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10821 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
10822 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10823 }
10824 else {
10825 PL_linestr = NEWSV(65,79);
10826 sv_upgrade(PL_linestr,SVt_PVIV);
10827 sv_setpvn(PL_linestr,"",0);
10828 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
10829 }
1d7c1841 10830 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
1d7c1841
GS
10831 PL_pending_ident = proto_perl->Ipending_ident;
10832 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
10833
10834 PL_expect = proto_perl->Iexpect;
10835
10836 PL_multi_start = proto_perl->Imulti_start;
10837 PL_multi_end = proto_perl->Imulti_end;
10838 PL_multi_open = proto_perl->Imulti_open;
10839 PL_multi_close = proto_perl->Imulti_close;
10840
10841 PL_error_count = proto_perl->Ierror_count;
10842 PL_subline = proto_perl->Isubline;
d2d73c3e 10843 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
1d7c1841 10844
1d773130 10845 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
389edf32
TB
10846 if (SvANY(proto_perl->Ilinestr)) {
10847 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
10848 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10849 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
10850 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
10851 PL_last_lop_op = proto_perl->Ilast_lop_op;
10852 }
10853 else {
10854 PL_last_uni = SvPVX(PL_linestr);
10855 PL_last_lop = SvPVX(PL_linestr);
10856 PL_last_lop_op = 0;
10857 }
1d7c1841 10858 PL_in_my = proto_perl->Iin_my;
d2d73c3e 10859 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
1d7c1841
GS
10860#ifdef FCRYPT
10861 PL_cryptseen = proto_perl->Icryptseen;
10862#endif
10863
10864 PL_hints = proto_perl->Ihints;
10865
10866 PL_amagic_generation = proto_perl->Iamagic_generation;
10867
10868#ifdef USE_LOCALE_COLLATE
10869 PL_collation_ix = proto_perl->Icollation_ix;
10870 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
10871 PL_collation_standard = proto_perl->Icollation_standard;
10872 PL_collxfrm_base = proto_perl->Icollxfrm_base;
10873 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
10874#endif /* USE_LOCALE_COLLATE */
10875
10876#ifdef USE_LOCALE_NUMERIC
10877 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
10878 PL_numeric_standard = proto_perl->Inumeric_standard;
10879 PL_numeric_local = proto_perl->Inumeric_local;
d2d73c3e 10880 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
1d7c1841
GS
10881#endif /* !USE_LOCALE_NUMERIC */
10882
10883 /* utf8 character classes */
d2d73c3e
AB
10884 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
10885 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
10886 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
10887 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
10888 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
10889 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
10890 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
10891 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
10892 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
10893 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
10894 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
10895 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
10896 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
10897 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
10898 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
10899 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
10900 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
b4e400f9 10901 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
82686b01
JH
10902 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
10903 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
1d7c1841
GS
10904
10905 /* swatch cache */
10906 PL_last_swash_hv = Nullhv; /* reinits on demand */
10907 PL_last_swash_klen = 0;
10908 PL_last_swash_key[0]= '\0';
10909 PL_last_swash_tmps = (U8*)NULL;
10910 PL_last_swash_slen = 0;
10911
10912 /* perly.c globals */
10913 PL_yydebug = proto_perl->Iyydebug;
10914 PL_yynerrs = proto_perl->Iyynerrs;
10915 PL_yyerrflag = proto_perl->Iyyerrflag;
10916 PL_yychar = proto_perl->Iyychar;
10917 PL_yyval = proto_perl->Iyyval;
10918 PL_yylval = proto_perl->Iyylval;
10919
10920 PL_glob_index = proto_perl->Iglob_index;
10921 PL_srand_called = proto_perl->Isrand_called;
10922 PL_uudmap['M'] = 0; /* reinits on demand */
10923 PL_bitcount = Nullch; /* reinits on demand */
10924
66fe0623
NIS
10925 if (proto_perl->Ipsig_pend) {
10926 Newz(0, PL_psig_pend, SIG_SIZE, int);
9dd79c3f 10927 }
66fe0623
NIS
10928 else {
10929 PL_psig_pend = (int*)NULL;
10930 }
10931
1d7c1841 10932 if (proto_perl->Ipsig_ptr) {
76d3c696
JH
10933 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
10934 Newz(0, PL_psig_name, SIG_SIZE, SV*);
76d3c696 10935 for (i = 1; i < SIG_SIZE; i++) {
d2d73c3e
AB
10936 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
10937 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
1d7c1841
GS
10938 }
10939 }
10940 else {
10941 PL_psig_ptr = (SV**)NULL;
10942 PL_psig_name = (SV**)NULL;
10943 }
10944
10945 /* thrdvar.h stuff */
10946
a0739874 10947 if (flags & CLONEf_COPY_STACKS) {
1d7c1841
GS
10948 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
10949 PL_tmps_ix = proto_perl->Ttmps_ix;
10950 PL_tmps_max = proto_perl->Ttmps_max;
10951 PL_tmps_floor = proto_perl->Ttmps_floor;
10952 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
10953 i = 0;
10954 while (i <= PL_tmps_ix) {
d2d73c3e 10955 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
1d7c1841
GS
10956 ++i;
10957 }
10958
10959 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
10960 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
10961 Newz(54, PL_markstack, i, I32);
10962 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
10963 - proto_perl->Tmarkstack);
10964 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
10965 - proto_perl->Tmarkstack);
10966 Copy(proto_perl->Tmarkstack, PL_markstack,
10967 PL_markstack_ptr - PL_markstack + 1, I32);
10968
10969 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
10970 * NOTE: unlike the others! */
10971 PL_scopestack_ix = proto_perl->Tscopestack_ix;
10972 PL_scopestack_max = proto_perl->Tscopestack_max;
10973 Newz(54, PL_scopestack, PL_scopestack_max, I32);
10974 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
10975
10976 /* next push_return() sets PL_retstack[PL_retstack_ix]
10977 * NOTE: unlike the others! */
10978 PL_retstack_ix = proto_perl->Tretstack_ix;
10979 PL_retstack_max = proto_perl->Tretstack_max;
10980 Newz(54, PL_retstack, PL_retstack_max, OP*);
ce0a1ae0 10981 Copy(proto_perl->Tretstack, PL_retstack, PL_retstack_ix, OP*);
1d7c1841
GS
10982
10983 /* NOTE: si_dup() looks at PL_markstack */
d2d73c3e 10984 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
1d7c1841
GS
10985
10986 /* PL_curstack = PL_curstackinfo->si_stack; */
d2d73c3e
AB
10987 PL_curstack = av_dup(proto_perl->Tcurstack, param);
10988 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
1d7c1841
GS
10989
10990 /* next PUSHs() etc. set *(PL_stack_sp+1) */
10991 PL_stack_base = AvARRAY(PL_curstack);
10992 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
10993 - proto_perl->Tstack_base);
10994 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
10995
10996 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
10997 * NOTE: unlike the others! */
10998 PL_savestack_ix = proto_perl->Tsavestack_ix;
10999 PL_savestack_max = proto_perl->Tsavestack_max;
11000 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
d2d73c3e 11001 PL_savestack = ss_dup(proto_perl, param);
1d7c1841
GS
11002 }
11003 else {
11004 init_stacks();
985e7056 11005 ENTER; /* perl_destruct() wants to LEAVE; */
1d7c1841
GS
11006 }
11007
11008 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
11009 PL_top_env = &PL_start_env;
11010
11011 PL_op = proto_perl->Top;
11012
11013 PL_Sv = Nullsv;
11014 PL_Xpv = (XPV*)NULL;
11015 PL_na = proto_perl->Tna;
11016
11017 PL_statbuf = proto_perl->Tstatbuf;
11018 PL_statcache = proto_perl->Tstatcache;
d2d73c3e
AB
11019 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
11020 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
1d7c1841
GS
11021#ifdef HAS_TIMES
11022 PL_timesbuf = proto_perl->Ttimesbuf;
11023#endif
11024
11025 PL_tainted = proto_perl->Ttainted;
11026 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
d2d73c3e
AB
11027 PL_rs = sv_dup_inc(proto_perl->Trs, param);
11028 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
11029 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
11030 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
1d7c1841 11031 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
d2d73c3e
AB
11032 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
11033 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
11034 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
1d7c1841
GS
11035
11036 PL_restartop = proto_perl->Trestartop;
11037 PL_in_eval = proto_perl->Tin_eval;
11038 PL_delaymagic = proto_perl->Tdelaymagic;
11039 PL_dirty = proto_perl->Tdirty;
11040 PL_localizing = proto_perl->Tlocalizing;
11041
14dd3ad8 11042#ifdef PERL_FLEXIBLE_EXCEPTIONS
1d7c1841 11043 PL_protect = proto_perl->Tprotect;
14dd3ad8 11044#endif
d2d73c3e 11045 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
1d7c1841
GS
11046 PL_av_fetch_sv = Nullsv;
11047 PL_hv_fetch_sv = Nullsv;
11048 Zero(&PL_hv_fetch_ent_mh, 1, HE); /* XXX */
11049 PL_modcount = proto_perl->Tmodcount;
11050 PL_lastgotoprobe = Nullop;
11051 PL_dumpindent = proto_perl->Tdumpindent;
11052
11053 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
d2d73c3e
AB
11054 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
11055 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
11056 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
1d7c1841
GS
11057 PL_sortcxix = proto_perl->Tsortcxix;
11058 PL_efloatbuf = Nullch; /* reinits on demand */
11059 PL_efloatsize = 0; /* reinits on demand */
11060
11061 /* regex stuff */
11062
11063 PL_screamfirst = NULL;
11064 PL_screamnext = NULL;
11065 PL_maxscream = -1; /* reinits on demand */
11066 PL_lastscream = Nullsv;
11067
11068 PL_watchaddr = NULL;
11069 PL_watchok = Nullch;
11070
11071 PL_regdummy = proto_perl->Tregdummy;
1d7c1841
GS
11072 PL_regprecomp = Nullch;
11073 PL_regnpar = 0;
11074 PL_regsize = 0;
1d7c1841
GS
11075 PL_colorset = 0; /* reinits PL_colors[] */
11076 /*PL_colors[6] = {0,0,0,0,0,0};*/
1d7c1841
GS
11077 PL_reginput = Nullch;
11078 PL_regbol = Nullch;
11079 PL_regeol = Nullch;
11080 PL_regstartp = (I32*)NULL;
11081 PL_regendp = (I32*)NULL;
11082 PL_reglastparen = (U32*)NULL;
11083 PL_regtill = Nullch;
1d7c1841
GS
11084 PL_reg_start_tmp = (char**)NULL;
11085 PL_reg_start_tmpl = 0;
11086 PL_regdata = (struct reg_data*)NULL;
11087 PL_bostr = Nullch;
11088 PL_reg_flags = 0;
11089 PL_reg_eval_set = 0;
11090 PL_regnarrate = 0;
11091 PL_regprogram = (regnode*)NULL;
11092 PL_regindent = 0;
11093 PL_regcc = (CURCUR*)NULL;
11094 PL_reg_call_cc = (struct re_cc_state*)NULL;
11095 PL_reg_re = (regexp*)NULL;
11096 PL_reg_ganch = Nullch;
11097 PL_reg_sv = Nullsv;
53c4c00c 11098 PL_reg_match_utf8 = FALSE;
1d7c1841
GS
11099 PL_reg_magic = (MAGIC*)NULL;
11100 PL_reg_oldpos = 0;
11101 PL_reg_oldcurpm = (PMOP*)NULL;
11102 PL_reg_curpm = (PMOP*)NULL;
11103 PL_reg_oldsaved = Nullch;
11104 PL_reg_oldsavedlen = 0;
11105 PL_reg_maxiter = 0;
11106 PL_reg_leftiter = 0;
11107 PL_reg_poscache = Nullch;
11108 PL_reg_poscache_size= 0;
11109
11110 /* RE engine - function pointers */
11111 PL_regcompp = proto_perl->Tregcompp;
11112 PL_regexecp = proto_perl->Tregexecp;
11113 PL_regint_start = proto_perl->Tregint_start;
11114 PL_regint_string = proto_perl->Tregint_string;
11115 PL_regfree = proto_perl->Tregfree;
11116
11117 PL_reginterp_cnt = 0;
11118 PL_reg_starttry = 0;
11119
a2efc822
SC
11120 /* Pluggable optimizer */
11121 PL_peepp = proto_perl->Tpeepp;
11122
a0739874
DM
11123 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
11124 ptr_table_free(PL_ptr_table);
11125 PL_ptr_table = NULL;
11126 }
8cf8f3d1 11127
f284b03f
AMS
11128 /* Call the ->CLONE method, if it exists, for each of the stashes
11129 identified by sv_dup() above.
11130 */
d2d73c3e
AB
11131 while(av_len(param->stashes) != -1) {
11132 HV* stash = (HV*) av_shift(param->stashes);
f284b03f
AMS
11133 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
11134 if (cloner && GvCV(cloner)) {
11135 dSP;
11136 ENTER;
11137 SAVETMPS;
11138 PUSHMARK(SP);
dc507217 11139 XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
f284b03f
AMS
11140 PUTBACK;
11141 call_sv((SV*)GvCV(cloner), G_DISCARD);
11142 FREETMPS;
11143 LEAVE;
11144 }
4a09accc 11145 }
a0739874 11146
dc507217 11147 SvREFCNT_dec(param->stashes);
dc507217 11148
1d7c1841 11149 return my_perl;
1d7c1841
GS
11150}
11151
1d7c1841 11152#endif /* USE_ITHREADS */
a0ae6670 11153
9f4817db 11154/*
ccfc67b7
JH
11155=head1 Unicode Support
11156
9f4817db
JH
11157=for apidoc sv_recode_to_utf8
11158
5d170f3a
JH
11159The encoding is assumed to be an Encode object, on entry the PV
11160of the sv is assumed to be octets in that encoding, and the sv
11161will be converted into Unicode (and UTF-8).
9f4817db 11162
5d170f3a
JH
11163If the sv already is UTF-8 (or if it is not POK), or if the encoding
11164is not a reference, nothing is done to the sv. If the encoding is not
1768d7eb
JH
11165an C<Encode::XS> Encoding object, bad things will happen.
11166(See F<lib/encoding.pm> and L<Encode>).
9f4817db 11167
5d170f3a 11168The PV of the sv is returned.
9f4817db 11169
5d170f3a
JH
11170=cut */
11171
11172char *
11173Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
11174{
220e2d4e 11175 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
d0063567
DK
11176 SV *uni;
11177 STRLEN len;
11178 char *s;
11179 dSP;
11180 ENTER;
11181 SAVETMPS;
220e2d4e 11182 save_re_context();
d0063567
DK
11183 PUSHMARK(sp);
11184 EXTEND(SP, 3);
11185 XPUSHs(encoding);
11186 XPUSHs(sv);
f9893866
NIS
11187/*
11188 NI-S 2002/07/09
11189 Passing sv_yes is wrong - it needs to be or'ed set of constants
11190 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
11191 remove converted chars from source.
11192
11193 Both will default the value - let them.
11194
d0063567 11195 XPUSHs(&PL_sv_yes);
f9893866 11196*/
d0063567
DK
11197 PUTBACK;
11198 call_method("decode", G_SCALAR);
11199 SPAGAIN;
11200 uni = POPs;
11201 PUTBACK;
11202 s = SvPV(uni, len);
d0063567
DK
11203 if (s != SvPVX(sv)) {
11204 SvGROW(sv, len + 1);
11205 Move(s, SvPVX(sv), len, char);
11206 SvCUR_set(sv, len);
11207 SvPVX(sv)[len] = 0;
11208 }
11209 FREETMPS;
11210 LEAVE;
d0063567 11211 SvUTF8_on(sv);
f9893866
NIS
11212 }
11213 return SvPVX(sv);
9f4817db
JH
11214}
11215
220e2d4e
IH
11216/*
11217=for apidoc sv_cat_decode
11218
11219The encoding is assumed to be an Encode object, the PV of the ssv is
11220assumed to be octets in that encoding and decoding the input starts
11221from the position which (PV + *offset) pointed to. The dsv will be
11222concatenated the decoded UTF-8 string from ssv. Decoding will terminate
11223when the string tstr appears in decoding output or the input ends on
11224the PV of the ssv. The value which the offset points will be modified
11225to the last input position on the ssv.
68795e93 11226
220e2d4e
IH
11227Returns TRUE if the terminator was found, else returns FALSE.
11228
11229=cut */
11230
11231bool
11232Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
11233 SV *ssv, int *offset, char *tstr, int tlen)
11234{
11235 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
11236 bool ret = FALSE;
11237 SV *offsv;
11238 dSP;
11239 ENTER;
11240 SAVETMPS;
11241 save_re_context();
11242 PUSHMARK(sp);
11243 EXTEND(SP, 6);
11244 XPUSHs(encoding);
11245 XPUSHs(dsv);
11246 XPUSHs(ssv);
11247 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
11248 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
11249 PUTBACK;
11250 call_method("cat_decode", G_SCALAR);
11251 SPAGAIN;
11252 ret = SvTRUE(TOPs);
11253 *offset = SvIV(offsv);
11254 PUTBACK;
11255 FREETMPS;
11256 LEAVE;
11257 return ret;
11258 }
11259 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode.");
11260}
f9893866 11261