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