This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
to improve -DCHECK_FORMAT
[perl5.git] / sv.c
CommitLineData
a0d0e21e 1/* sv.c
79072805 2 *
4bb101f2 3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
b5f8cc5c 4 * 2000, 2001, 2002, 2003, 2004, by Larry Wall and others
79072805
LW
5 *
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
8 *
a0d0e21e 9 * "I wonder what the Entish is for 'yes' and 'no'," he thought.
645c22ef
DM
10 *
11 *
5e045b90
AMS
12 * This file contains the code that creates, manipulates and destroys
13 * scalar values (SVs). The other types (AV, HV, GV, etc.) reuse the
14 * structure of an SV, so their creation and destruction is handled
15 * here; higher-level functions are in av.c, hv.c, and so on. Opcode
16 * level functions (eg. substr, split, join) for each of the types are
17 * in the pp*.c files.
79072805
LW
18 */
19
20#include "EXTERN.h"
864dbfa3 21#define PERL_IN_SV_C
79072805 22#include "perl.h"
d2f185dc 23#include "regcomp.h"
79072805 24
51371543 25#define FCALL *f
2c5424a7 26
2f8ed50e
OS
27#ifdef __Lynx__
28/* Missing proto on LynxOS */
29 char *gconvert(double, int, int, char *);
30#endif
31
e23c8137
JH
32#ifdef PERL_UTF8_CACHE_ASSERT
33/* The cache element 0 is the Unicode offset;
34 * the cache element 1 is the byte offset of the element 0;
35 * the cache element 2 is the Unicode length of the substring;
36 * the cache element 3 is the byte length of the substring;
37 * The checking of the substring side would be good
38 * but substr() has enough code paths to make my head spin;
39 * if adding more checks watch out for the following tests:
40 * t/op/index.t t/op/length.t t/op/pat.t t/op/substr.t
41 * lib/utf8.t lib/Unicode/Collate/t/index.t
42 * --jhi
43 */
44#define ASSERT_UTF8_CACHE(cache) \
45 STMT_START { if (cache) { assert((cache)[0] <= (cache)[1]); } } STMT_END
46#else
47#define ASSERT_UTF8_CACHE(cache) NOOP
48#endif
49
765f542d
NC
50#ifdef PERL_COPY_ON_WRITE
51#define SV_COW_NEXT_SV(sv) INT2PTR(SV *,SvUVX(sv))
a29f6d03 52#define SV_COW_NEXT_SV_SET(current,next) SvUVX(current) = PTR2UV(next)
b5ccf5f2 53/* This is a pessimistic view. Scalar must be purely a read-write PV to copy-
765f542d 54 on-write. */
765f542d 55#endif
645c22ef
DM
56
57/* ============================================================================
58
59=head1 Allocation and deallocation of SVs.
60
5e045b90
AMS
61An SV (or AV, HV, etc.) is allocated in two parts: the head (struct sv,
62av, hv...) contains type and reference count information, as well as a
63pointer to the body (struct xrv, xpv, xpviv...), which contains fields
64specific to each type.
65
66Normally, this allocation is done using arenas, which are approximately
671K chunks of memory parcelled up into N heads or bodies. The first slot
68in each arena is reserved, and is used to hold a link to the next arena.
69In the case of heads, the unused first slot also contains some flags and
70a note of the number of slots. Snaked through each arena chain is a
71linked list of free items; when this becomes empty, an extra arena is
72allocated and divided up into N items which are threaded into the free
73list.
645c22ef
DM
74
75The following global variables are associated with arenas:
76
77 PL_sv_arenaroot pointer to list of SV arenas
78 PL_sv_root pointer to list of free SV structures
79
80 PL_foo_arenaroot pointer to list of foo arenas,
81 PL_foo_root pointer to list of free foo bodies
82 ... for foo in xiv, xnv, xrv, xpv etc.
83
84Note that some of the larger and more rarely used body types (eg xpvio)
85are not allocated using arenas, but are instead just malloc()/free()ed as
86required. Also, if PURIFY is defined, arenas are abandoned altogether,
87with all items individually malloc()ed. In addition, a few SV heads are
88not allocated from an arena, but are instead directly created as static
89or auto variables, eg PL_sv_undef.
90
91The SV arena serves the secondary purpose of allowing still-live SVs
92to be located and destroyed during final cleanup.
93
94At the lowest level, the macros new_SV() and del_SV() grab and free
95an SV head. (If debugging with -DD, del_SV() calls the function S_del_sv()
96to return the SV to the free list with error checking.) new_SV() calls
97more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
98SVs in the free list have their SvTYPE field set to all ones.
99
100Similarly, there are macros new_XIV()/del_XIV(), new_XNV()/del_XNV() etc
101that allocate and return individual body types. Normally these are mapped
ff276b08
RG
102to the arena-manipulating functions new_xiv()/del_xiv() etc, but may be
103instead mapped directly to malloc()/free() if PURIFY is defined. The
645c22ef
DM
104new/del functions remove from, or add to, the appropriate PL_foo_root
105list, and call more_xiv() etc to add a new arena if the list is empty.
106
ff276b08 107At the time of very final cleanup, sv_free_arenas() is called from
645c22ef
DM
108perl_destruct() to physically free all the arenas allocated since the
109start of the interpreter. Note that this also clears PL_he_arenaroot,
110which is otherwise dealt with in hv.c.
111
112Manipulation of any of the PL_*root pointers is protected by enclosing
113LOCK_SV_MUTEX; ... UNLOCK_SV_MUTEX calls which should Do the Right Thing
114if threads are enabled.
115
116The function visit() scans the SV arenas list, and calls a specified
117function for each SV it finds which is still live - ie which has an SvTYPE
118other than all 1's, and a non-zero SvREFCNT. visit() is used by the
119following functions (specified as [function that calls visit()] / [function
120called by visit() for each SV]):
121
122 sv_report_used() / do_report_used()
123 dump all remaining SVs (debugging aid)
124
125 sv_clean_objs() / do_clean_objs(),do_clean_named_objs()
126 Attempt to free all objects pointed to by RVs,
127 and, unless DISABLE_DESTRUCTOR_KLUDGE is defined,
128 try to do the same for all objects indirectly
129 referenced by typeglobs too. Called once from
130 perl_destruct(), prior to calling sv_clean_all()
131 below.
132
133 sv_clean_all() / do_clean_all()
134 SvREFCNT_dec(sv) each remaining SV, possibly
135 triggering an sv_free(). It also sets the
136 SVf_BREAK flag on the SV to indicate that the
137 refcnt has been artificially lowered, and thus
138 stopping sv_free() from giving spurious warnings
139 about SVs which unexpectedly have a refcnt
140 of zero. called repeatedly from perl_destruct()
141 until there are no SVs left.
142
143=head2 Summary
144
145Private API to rest of sv.c
146
147 new_SV(), del_SV(),
148
149 new_XIV(), del_XIV(),
150 new_XNV(), del_XNV(),
151 etc
152
153Public API:
154
8cf8f3d1 155 sv_report_used(), sv_clean_objs(), sv_clean_all(), sv_free_arenas()
645c22ef
DM
156
157
158=cut
159
160============================================================================ */
161
162
51371543 163
4561caa4
CS
164/*
165 * "A time to plant, and a time to uproot what was planted..."
166 */
167
053fc874
GS
168#define plant_SV(p) \
169 STMT_START { \
170 SvANY(p) = (void *)PL_sv_root; \
171 SvFLAGS(p) = SVTYPEMASK; \
172 PL_sv_root = (p); \
173 --PL_sv_count; \
174 } STMT_END
a0d0e21e 175
fba3b22e 176/* sv_mutex must be held while calling uproot_SV() */
053fc874
GS
177#define uproot_SV(p) \
178 STMT_START { \
179 (p) = PL_sv_root; \
180 PL_sv_root = (SV*)SvANY(p); \
181 ++PL_sv_count; \
182 } STMT_END
183
645c22ef
DM
184
185/* new_SV(): return a new, empty SV head */
186
eba0f806
DM
187#ifdef DEBUG_LEAKING_SCALARS
188/* provide a real function for a debugger to play with */
189STATIC SV*
190S_new_SV(pTHX)
191{
192 SV* sv;
193
194 LOCK_SV_MUTEX;
195 if (PL_sv_root)
196 uproot_SV(sv);
197 else
198 sv = more_sv();
199 UNLOCK_SV_MUTEX;
200 SvANY(sv) = 0;
201 SvREFCNT(sv) = 1;
202 SvFLAGS(sv) = 0;
203 return sv;
204}
205# define new_SV(p) (p)=S_new_SV(aTHX)
206
207#else
208# define new_SV(p) \
053fc874
GS
209 STMT_START { \
210 LOCK_SV_MUTEX; \
211 if (PL_sv_root) \
212 uproot_SV(p); \
213 else \
214 (p) = more_sv(); \
215 UNLOCK_SV_MUTEX; \
216 SvANY(p) = 0; \
217 SvREFCNT(p) = 1; \
218 SvFLAGS(p) = 0; \
219 } STMT_END
eba0f806 220#endif
463ee0b2 221
645c22ef
DM
222
223/* del_SV(): return an empty SV head to the free list */
224
a0d0e21e 225#ifdef DEBUGGING
4561caa4 226
053fc874
GS
227#define del_SV(p) \
228 STMT_START { \
229 LOCK_SV_MUTEX; \
aea4f609 230 if (DEBUG_D_TEST) \
053fc874
GS
231 del_sv(p); \
232 else \
233 plant_SV(p); \
234 UNLOCK_SV_MUTEX; \
235 } STMT_END
a0d0e21e 236
76e3520e 237STATIC void
cea2e8a9 238S_del_sv(pTHX_ SV *p)
463ee0b2 239{
aea4f609 240 if (DEBUG_D_TEST) {
4633a7c4 241 SV* sva;
a0d0e21e
LW
242 SV* sv;
243 SV* svend;
244 int ok = 0;
3280af22 245 for (sva = PL_sv_arenaroot; sva; sva = (SV *) SvANY(sva)) {
4633a7c4
LW
246 sv = sva + 1;
247 svend = &sva[SvREFCNT(sva)];
a0d0e21e
LW
248 if (p >= sv && p < svend)
249 ok = 1;
250 }
251 if (!ok) {
0453d815 252 if (ckWARN_d(WARN_INTERNAL))
9014280d 253 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
472d47bc
SB
254 "Attempt to free non-arena SV: 0x%"UVxf
255 pTHX__FORMAT, PTR2UV(p) pTHX__VALUE);
a0d0e21e
LW
256 return;
257 }
258 }
4561caa4 259 plant_SV(p);
463ee0b2 260}
a0d0e21e 261
4561caa4
CS
262#else /* ! DEBUGGING */
263
264#define del_SV(p) plant_SV(p)
265
266#endif /* DEBUGGING */
463ee0b2 267
645c22ef
DM
268
269/*
ccfc67b7
JH
270=head1 SV Manipulation Functions
271
645c22ef
DM
272=for apidoc sv_add_arena
273
274Given a chunk of memory, link it to the head of the list of arenas,
275and split it into a list of free SVs.
276
277=cut
278*/
279
4633a7c4 280void
864dbfa3 281Perl_sv_add_arena(pTHX_ char *ptr, U32 size, U32 flags)
463ee0b2 282{
4633a7c4 283 SV* sva = (SV*)ptr;
463ee0b2
LW
284 register SV* sv;
285 register SV* svend;
4633a7c4
LW
286
287 /* The first SV in an arena isn't an SV. */
3280af22 288 SvANY(sva) = (void *) PL_sv_arenaroot; /* ptr to next arena */
4633a7c4
LW
289 SvREFCNT(sva) = size / sizeof(SV); /* number of SV slots */
290 SvFLAGS(sva) = flags; /* FAKE if not to be freed */
291
3280af22
NIS
292 PL_sv_arenaroot = sva;
293 PL_sv_root = sva + 1;
4633a7c4
LW
294
295 svend = &sva[SvREFCNT(sva) - 1];
296 sv = sva + 1;
463ee0b2 297 while (sv < svend) {
a0d0e21e 298 SvANY(sv) = (void *)(SV*)(sv + 1);
978b032e 299 SvREFCNT(sv) = 0;
8990e307 300 SvFLAGS(sv) = SVTYPEMASK;
463ee0b2
LW
301 sv++;
302 }
303 SvANY(sv) = 0;
4633a7c4
LW
304 SvFLAGS(sv) = SVTYPEMASK;
305}
306
645c22ef
DM
307/* make some more SVs by adding another arena */
308
fba3b22e 309/* sv_mutex must be held while calling more_sv() */
76e3520e 310STATIC SV*
cea2e8a9 311S_more_sv(pTHX)
4633a7c4 312{
4561caa4
CS
313 register SV* sv;
314
3280af22
NIS
315 if (PL_nice_chunk) {
316 sv_add_arena(PL_nice_chunk, PL_nice_chunk_size, 0);
317 PL_nice_chunk = Nullch;
30ad99e7 318 PL_nice_chunk_size = 0;
c07a80fd 319 }
1edc1566 320 else {
321 char *chunk; /* must use New here to match call to */
322 New(704,chunk,1008,char); /* Safefree() in sv_free_arenas() */
323 sv_add_arena(chunk, 1008, 0);
324 }
4561caa4
CS
325 uproot_SV(sv);
326 return sv;
463ee0b2
LW
327}
328
055972dc
DM
329/* visit(): call the named function for each non-free SV in the arenas
330 * whose flags field matches the flags/mask args. */
645c22ef 331
5226ed68 332STATIC I32
055972dc 333S_visit(pTHX_ SVFUNC_t f, U32 flags, U32 mask)
8990e307 334{
4633a7c4 335 SV* sva;
8990e307
LW
336 SV* sv;
337 register SV* svend;
5226ed68 338 I32 visited = 0;
8990e307 339
3280af22 340 for (sva = PL_sv_arenaroot; sva; sva = (SV*)SvANY(sva)) {
4633a7c4 341 svend = &sva[SvREFCNT(sva)];
4561caa4 342 for (sv = sva + 1; sv < svend; ++sv) {
055972dc
DM
343 if (SvTYPE(sv) != SVTYPEMASK
344 && (sv->sv_flags & mask) == flags
345 && SvREFCNT(sv))
346 {
acfe0abc 347 (FCALL)(aTHX_ sv);
5226ed68
JH
348 ++visited;
349 }
8990e307
LW
350 }
351 }
5226ed68 352 return visited;
8990e307
LW
353}
354
758a08c3
JH
355#ifdef DEBUGGING
356
645c22ef
DM
357/* called by sv_report_used() for each live SV */
358
359static void
acfe0abc 360do_report_used(pTHX_ SV *sv)
645c22ef
DM
361{
362 if (SvTYPE(sv) != SVTYPEMASK) {
363 PerlIO_printf(Perl_debug_log, "****\n");
364 sv_dump(sv);
365 }
366}
758a08c3 367#endif
645c22ef
DM
368
369/*
370=for apidoc sv_report_used
371
372Dump the contents of all SVs not yet freed. (Debugging aid).
373
374=cut
375*/
376
8990e307 377void
864dbfa3 378Perl_sv_report_used(pTHX)
4561caa4 379{
ff270d3a 380#ifdef DEBUGGING
055972dc 381 visit(do_report_used, 0, 0);
ff270d3a 382#endif
4561caa4
CS
383}
384
645c22ef
DM
385/* called by sv_clean_objs() for each live SV */
386
387static void
acfe0abc 388do_clean_objs(pTHX_ SV *sv)
645c22ef
DM
389{
390 SV* rv;
391
392 if (SvROK(sv) && SvOBJECT(rv = SvRV(sv))) {
393 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning object ref:\n "), sv_dump(sv)));
394 if (SvWEAKREF(sv)) {
395 sv_del_backref(sv);
396 SvWEAKREF_off(sv);
397 SvRV(sv) = 0;
398 } else {
399 SvROK_off(sv);
400 SvRV(sv) = 0;
401 SvREFCNT_dec(rv);
402 }
403 }
404
405 /* XXX Might want to check arrays, etc. */
406}
407
408/* called by sv_clean_objs() for each live SV */
409
410#ifndef DISABLE_DESTRUCTOR_KLUDGE
411static void
acfe0abc 412do_clean_named_objs(pTHX_ SV *sv)
645c22ef
DM
413{
414 if (SvTYPE(sv) == SVt_PVGV && GvGP(sv)) {
415 if ( SvOBJECT(GvSV(sv)) ||
416 (GvAV(sv) && SvOBJECT(GvAV(sv))) ||
417 (GvHV(sv) && SvOBJECT(GvHV(sv))) ||
418 (GvIO(sv) && SvOBJECT(GvIO(sv))) ||
419 (GvCV(sv) && SvOBJECT(GvCV(sv))) )
420 {
421 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning named glob object:\n "), sv_dump(sv)));
ec5f3c78 422 SvFLAGS(sv) |= SVf_BREAK;
645c22ef
DM
423 SvREFCNT_dec(sv);
424 }
425 }
426}
427#endif
428
429/*
430=for apidoc sv_clean_objs
431
432Attempt to destroy all objects not yet freed
433
434=cut
435*/
436
4561caa4 437void
864dbfa3 438Perl_sv_clean_objs(pTHX)
4561caa4 439{
3280af22 440 PL_in_clean_objs = TRUE;
055972dc 441 visit(do_clean_objs, SVf_ROK, SVf_ROK);
4561caa4 442#ifndef DISABLE_DESTRUCTOR_KLUDGE
2d0f3c12 443 /* some barnacles may yet remain, clinging to typeglobs */
055972dc 444 visit(do_clean_named_objs, SVt_PVGV, SVTYPEMASK);
4561caa4 445#endif
3280af22 446 PL_in_clean_objs = FALSE;
4561caa4
CS
447}
448
645c22ef
DM
449/* called by sv_clean_all() for each live SV */
450
451static void
acfe0abc 452do_clean_all(pTHX_ SV *sv)
645c22ef
DM
453{
454 DEBUG_D((PerlIO_printf(Perl_debug_log, "Cleaning loops: SV at 0x%"UVxf"\n", PTR2UV(sv)) ));
455 SvFLAGS(sv) |= SVf_BREAK;
0e705b3b
DM
456 if (PL_comppad == (AV*)sv) {
457 PL_comppad = Nullav;
458 PL_curpad = Null(SV**);
459 }
645c22ef
DM
460 SvREFCNT_dec(sv);
461}
462
463/*
464=for apidoc sv_clean_all
465
466Decrement the refcnt of each remaining SV, possibly triggering a
467cleanup. This function may have to be called multiple times to free
ff276b08 468SVs which are in complex self-referential hierarchies.
645c22ef
DM
469
470=cut
471*/
472
5226ed68 473I32
864dbfa3 474Perl_sv_clean_all(pTHX)
8990e307 475{
5226ed68 476 I32 cleaned;
3280af22 477 PL_in_clean_all = TRUE;
055972dc 478 cleaned = visit(do_clean_all, 0,0);
3280af22 479 PL_in_clean_all = FALSE;
5226ed68 480 return cleaned;
8990e307 481}
463ee0b2 482
645c22ef
DM
483/*
484=for apidoc sv_free_arenas
485
486Deallocate the memory used by all arenas. Note that all the individual SV
487heads and bodies within the arenas must already have been freed.
488
489=cut
490*/
491
4633a7c4 492void
864dbfa3 493Perl_sv_free_arenas(pTHX)
4633a7c4
LW
494{
495 SV* sva;
496 SV* svanext;
612f20c3 497 XPV *arena, *arenanext;
4633a7c4
LW
498
499 /* Free arenas here, but be careful about fake ones. (We assume
500 contiguity of the fake ones with the corresponding real ones.) */
501
3280af22 502 for (sva = PL_sv_arenaroot; sva; sva = svanext) {
4633a7c4
LW
503 svanext = (SV*) SvANY(sva);
504 while (svanext && SvFAKE(svanext))
505 svanext = (SV*) SvANY(svanext);
506
507 if (!SvFAKE(sva))
1edc1566 508 Safefree((void *)sva);
4633a7c4 509 }
5f05dabc 510
612f20c3
GS
511 for (arena = PL_xiv_arenaroot; arena; arena = arenanext) {
512 arenanext = (XPV*)arena->xpv_pv;
513 Safefree(arena);
514 }
515 PL_xiv_arenaroot = 0;
bf9cdc68 516 PL_xiv_root = 0;
612f20c3
GS
517
518 for (arena = PL_xnv_arenaroot; arena; arena = arenanext) {
519 arenanext = (XPV*)arena->xpv_pv;
520 Safefree(arena);
521 }
522 PL_xnv_arenaroot = 0;
bf9cdc68 523 PL_xnv_root = 0;
612f20c3
GS
524
525 for (arena = PL_xrv_arenaroot; arena; arena = arenanext) {
526 arenanext = (XPV*)arena->xpv_pv;
527 Safefree(arena);
528 }
529 PL_xrv_arenaroot = 0;
bf9cdc68 530 PL_xrv_root = 0;
612f20c3
GS
531
532 for (arena = PL_xpv_arenaroot; arena; arena = arenanext) {
533 arenanext = (XPV*)arena->xpv_pv;
534 Safefree(arena);
535 }
536 PL_xpv_arenaroot = 0;
bf9cdc68 537 PL_xpv_root = 0;
612f20c3
GS
538
539 for (arena = (XPV*)PL_xpviv_arenaroot; arena; arena = arenanext) {
540 arenanext = (XPV*)arena->xpv_pv;
541 Safefree(arena);
542 }
543 PL_xpviv_arenaroot = 0;
bf9cdc68 544 PL_xpviv_root = 0;
612f20c3
GS
545
546 for (arena = (XPV*)PL_xpvnv_arenaroot; arena; arena = arenanext) {
547 arenanext = (XPV*)arena->xpv_pv;
548 Safefree(arena);
549 }
550 PL_xpvnv_arenaroot = 0;
bf9cdc68 551 PL_xpvnv_root = 0;
612f20c3
GS
552
553 for (arena = (XPV*)PL_xpvcv_arenaroot; arena; arena = arenanext) {
554 arenanext = (XPV*)arena->xpv_pv;
555 Safefree(arena);
556 }
557 PL_xpvcv_arenaroot = 0;
bf9cdc68 558 PL_xpvcv_root = 0;
612f20c3
GS
559
560 for (arena = (XPV*)PL_xpvav_arenaroot; arena; arena = arenanext) {
561 arenanext = (XPV*)arena->xpv_pv;
562 Safefree(arena);
563 }
564 PL_xpvav_arenaroot = 0;
bf9cdc68 565 PL_xpvav_root = 0;
612f20c3
GS
566
567 for (arena = (XPV*)PL_xpvhv_arenaroot; arena; arena = arenanext) {
568 arenanext = (XPV*)arena->xpv_pv;
569 Safefree(arena);
570 }
571 PL_xpvhv_arenaroot = 0;
bf9cdc68 572 PL_xpvhv_root = 0;
612f20c3
GS
573
574 for (arena = (XPV*)PL_xpvmg_arenaroot; arena; arena = arenanext) {
575 arenanext = (XPV*)arena->xpv_pv;
576 Safefree(arena);
577 }
578 PL_xpvmg_arenaroot = 0;
bf9cdc68 579 PL_xpvmg_root = 0;
612f20c3
GS
580
581 for (arena = (XPV*)PL_xpvlv_arenaroot; arena; arena = arenanext) {
582 arenanext = (XPV*)arena->xpv_pv;
583 Safefree(arena);
584 }
585 PL_xpvlv_arenaroot = 0;
bf9cdc68 586 PL_xpvlv_root = 0;
612f20c3
GS
587
588 for (arena = (XPV*)PL_xpvbm_arenaroot; arena; arena = arenanext) {
589 arenanext = (XPV*)arena->xpv_pv;
590 Safefree(arena);
591 }
592 PL_xpvbm_arenaroot = 0;
bf9cdc68 593 PL_xpvbm_root = 0;
612f20c3
GS
594
595 for (arena = (XPV*)PL_he_arenaroot; arena; arena = arenanext) {
596 arenanext = (XPV*)arena->xpv_pv;
597 Safefree(arena);
598 }
599 PL_he_arenaroot = 0;
bf9cdc68 600 PL_he_root = 0;
612f20c3 601
3280af22
NIS
602 if (PL_nice_chunk)
603 Safefree(PL_nice_chunk);
604 PL_nice_chunk = Nullch;
605 PL_nice_chunk_size = 0;
606 PL_sv_arenaroot = 0;
607 PL_sv_root = 0;
4633a7c4
LW
608}
609
29489e7c
DM
610/* ---------------------------------------------------------------------
611 *
612 * support functions for report_uninit()
613 */
614
615/* the maxiumum size of array or hash where we will scan looking
616 * for the undefined element that triggered the warning */
617
618#define FUV_MAX_SEARCH_SIZE 1000
619
620/* Look for an entry in the hash whose value has the same SV as val;
621 * If so, return a mortal copy of the key. */
622
623STATIC SV*
624S_find_hash_subscript(pTHX_ HV *hv, SV* val)
625{
626 register HE **array;
627 register HE *entry;
628 I32 i;
629
630 if (!hv || SvMAGICAL(hv) || !HvARRAY(hv) ||
631 (HvTOTALKEYS(hv) > FUV_MAX_SEARCH_SIZE))
632 return Nullsv;
633
634 array = HvARRAY(hv);
635
636 for (i=HvMAX(hv); i>0; i--) {
637 for (entry = array[i]; entry; entry = HeNEXT(entry)) {
638 if (HeVAL(entry) != val)
639 continue;
640 if ( HeVAL(entry) == &PL_sv_undef ||
641 HeVAL(entry) == &PL_sv_placeholder)
642 continue;
643 if (!HeKEY(entry))
644 return Nullsv;
645 if (HeKLEN(entry) == HEf_SVKEY)
646 return sv_mortalcopy(HeKEY_sv(entry));
647 return sv_2mortal(newSVpvn(HeKEY(entry), HeKLEN(entry)));
648 }
649 }
650 return Nullsv;
651}
652
653/* Look for an entry in the array whose value has the same SV as val;
654 * If so, return the index, otherwise return -1. */
655
656STATIC I32
657S_find_array_subscript(pTHX_ AV *av, SV* val)
658{
659 SV** svp;
660 I32 i;
661 if (!av || SvMAGICAL(av) || !AvARRAY(av) ||
662 (AvFILLp(av) > FUV_MAX_SEARCH_SIZE))
663 return -1;
664
665 svp = AvARRAY(av);
666 for (i=AvFILLp(av); i>=0; i--) {
667 if (svp[i] == val && svp[i] != &PL_sv_undef)
668 return i;
669 }
670 return -1;
671}
672
673/* S_varname(): return the name of a variable, optionally with a subscript.
674 * If gv is non-zero, use the name of that global, along with gvtype (one
675 * of "$", "@", "%"); otherwise use the name of the lexical at pad offset
676 * targ. Depending on the value of the subscript_type flag, return:
677 */
678
679#define FUV_SUBSCRIPT_NONE 1 /* "@foo" */
680#define FUV_SUBSCRIPT_ARRAY 2 /* "$foo[aindex]" */
681#define FUV_SUBSCRIPT_HASH 3 /* "$foo{keyname}" */
682#define FUV_SUBSCRIPT_WITHIN 4 /* "within @foo" */
683
684STATIC SV*
685S_varname(pTHX_ GV *gv, char *gvtype, PADOFFSET targ,
686 SV* keyname, I32 aindex, int subscript_type)
687{
688 AV *av;
689
690 SV *sv, *name;
691
692 name = sv_newmortal();
693 if (gv) {
694
695 /* simulate gv_fullname4(), but add literal '^' for $^FOO names
696 * XXX get rid of all this if gv_fullnameX() ever supports this
697 * directly */
698
699 char *p;
700 HV *hv = GvSTASH(gv);
701 sv_setpv(name, gvtype);
702 if (!hv)
703 p = "???";
704 else if (!HvNAME(hv))
705 p = "__ANON__";
7a5fa8a2 706 else
29489e7c
DM
707 p = HvNAME(hv);
708 if (strNE(p, "main")) {
709 sv_catpv(name,p);
710 sv_catpvn(name,"::", 2);
711 }
712 if (GvNAMELEN(gv)>= 1 &&
713 ((unsigned int)*GvNAME(gv)) <= 26)
714 { /* handle $^FOO */
715 Perl_sv_catpvf(aTHX_ name,"^%c", *GvNAME(gv) + 'A' - 1);
716 sv_catpvn(name,GvNAME(gv)+1,GvNAMELEN(gv)-1);
717 }
718 else
719 sv_catpvn(name,GvNAME(gv),GvNAMELEN(gv));
720 }
721 else {
722 U32 u;
723 CV *cv = find_runcv(&u);
724 if (!cv || !CvPADLIST(cv))
725 return Nullsv;;
726 av = (AV*)(*av_fetch(CvPADLIST(cv), 0, FALSE));
727 sv = *av_fetch(av, targ, FALSE);
728 /* SvLEN in a pad name is not to be trusted */
729 sv_setpv(name, SvPV_nolen(sv));
730 }
731
732 if (subscript_type == FUV_SUBSCRIPT_HASH) {
733 *SvPVX(name) = '$';
734 sv = NEWSV(0,0);
735 Perl_sv_catpvf(aTHX_ name, "{%s}",
736 pv_display(sv,SvPVX(keyname), SvCUR(keyname), 0, 32));
737 SvREFCNT_dec(sv);
738 }
739 else if (subscript_type == FUV_SUBSCRIPT_ARRAY) {
740 *SvPVX(name) = '$';
265a12b8 741 Perl_sv_catpvf(aTHX_ name, "[%"IVdf"]", (IV)aindex);
29489e7c
DM
742 }
743 else if (subscript_type == FUV_SUBSCRIPT_WITHIN)
744 sv_insert(name, 0, 0, "within ", 7);
745
746 return name;
747}
748
749
750/*
751=for apidoc find_uninit_var
752
753Find the name of the undefined variable (if any) that caused the operator o
754to issue a "Use of uninitialized value" warning.
755If match is true, only return a name if it's value matches uninit_sv.
756So roughly speaking, if a unary operator (such as OP_COS) generates a
757warning, then following the direct child of the op may yield an
758OP_PADSV or OP_GV that gives the name of the undefined variable. On the
759other hand, with OP_ADD there are two branches to follow, so we only print
760the variable name if we get an exact match.
761
762The name is returned as a mortal SV.
763
764Assumes that PL_op is the op that originally triggered the error, and that
765PL_comppad/PL_curpad points to the currently executing pad.
766
767=cut
768*/
769
770STATIC SV *
771S_find_uninit_var(pTHX_ OP* obase, SV* uninit_sv, bool match)
772{
773 SV *sv;
774 AV *av;
775 SV **svp;
776 GV *gv;
777 OP *o, *o2, *kid;
778
779 if (!obase || (match && (!uninit_sv || uninit_sv == &PL_sv_undef ||
780 uninit_sv == &PL_sv_placeholder)))
781 return Nullsv;
782
783 switch (obase->op_type) {
784
785 case OP_RV2AV:
786 case OP_RV2HV:
787 case OP_PADAV:
788 case OP_PADHV:
789 {
790 bool pad = (obase->op_type == OP_PADAV || obase->op_type == OP_PADHV);
791 bool hash = (obase->op_type == OP_PADHV || obase->op_type == OP_RV2HV);
112dcc46
RGS
792 I32 index = 0;
793 SV *keysv = Nullsv;
29489e7c
DM
794 int subscript_type = FUV_SUBSCRIPT_WITHIN;
795
796 if (pad) { /* @lex, %lex */
797 sv = PAD_SVl(obase->op_targ);
798 gv = Nullgv;
799 }
800 else {
801 if (cUNOPx(obase)->op_first->op_type == OP_GV) {
802 /* @global, %global */
803 gv = cGVOPx_gv(cUNOPx(obase)->op_first);
804 if (!gv)
805 break;
806 sv = hash ? (SV*)GvHV(gv): (SV*)GvAV(gv);
807 }
808 else /* @{expr}, %{expr} */
809 return find_uninit_var(cUNOPx(obase)->op_first,
810 uninit_sv, match);
811 }
812
813 /* attempt to find a match within the aggregate */
814 if (hash) {
815 keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
816 if (keysv)
817 subscript_type = FUV_SUBSCRIPT_HASH;
818 }
819 else {
820 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
821 if (index >= 0)
822 subscript_type = FUV_SUBSCRIPT_ARRAY;
823 }
824
825 if (match && subscript_type == FUV_SUBSCRIPT_WITHIN)
826 break;
827
828 return S_varname(aTHX_ gv, hash ? "%" : "@", obase->op_targ,
829 keysv, index, subscript_type);
830 }
831
832 case OP_PADSV:
833 if (match && PAD_SVl(obase->op_targ) != uninit_sv)
834 break;
835 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
836 Nullsv, 0, FUV_SUBSCRIPT_NONE);
837
838 case OP_GVSV:
839 gv = cGVOPx_gv(obase);
840 if (!gv || (match && GvSV(gv) != uninit_sv))
841 break;
842 return S_varname(aTHX_ gv, "$", 0, Nullsv, 0, FUV_SUBSCRIPT_NONE);
843
844 case OP_AELEMFAST:
845 if (obase->op_flags & OPf_SPECIAL) { /* lexical array */
846 if (match) {
847 av = (AV*)PAD_SV(obase->op_targ);
848 if (!av || SvRMAGICAL(av))
849 break;
850 svp = av_fetch(av, (I32)obase->op_private, FALSE);
851 if (!svp || *svp != uninit_sv)
852 break;
853 }
854 return S_varname(aTHX_ Nullgv, "$", obase->op_targ,
855 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
856 }
857 else {
858 gv = cGVOPx_gv(obase);
859 if (!gv)
860 break;
861 if (match) {
862 av = GvAV(gv);
863 if (!av || SvRMAGICAL(av))
864 break;
865 svp = av_fetch(av, (I32)obase->op_private, FALSE);
866 if (!svp || *svp != uninit_sv)
867 break;
868 }
869 return S_varname(aTHX_ gv, "$", 0,
870 Nullsv, (I32)obase->op_private, FUV_SUBSCRIPT_ARRAY);
871 }
872 break;
873
874 case OP_EXISTS:
875 o = cUNOPx(obase)->op_first;
876 if (!o || o->op_type != OP_NULL ||
877 ! (o->op_targ == OP_AELEM || o->op_targ == OP_HELEM))
878 break;
879 return find_uninit_var(cBINOPo->op_last, uninit_sv, match);
880
881 case OP_AELEM:
882 case OP_HELEM:
883 if (PL_op == obase)
884 /* $a[uninit_expr] or $h{uninit_expr} */
885 return find_uninit_var(cBINOPx(obase)->op_last, uninit_sv, match);
886
887 gv = Nullgv;
888 o = cBINOPx(obase)->op_first;
889 kid = cBINOPx(obase)->op_last;
890
891 /* get the av or hv, and optionally the gv */
892 sv = Nullsv;
893 if (o->op_type == OP_PADAV || o->op_type == OP_PADHV) {
894 sv = PAD_SV(o->op_targ);
895 }
896 else if ((o->op_type == OP_RV2AV || o->op_type == OP_RV2HV)
897 && cUNOPo->op_first->op_type == OP_GV)
898 {
899 gv = cGVOPx_gv(cUNOPo->op_first);
900 if (!gv)
901 break;
902 sv = o->op_type == OP_RV2HV ? (SV*)GvHV(gv) : (SV*)GvAV(gv);
903 }
904 if (!sv)
905 break;
906
907 if (kid && kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid))) {
908 /* index is constant */
909 if (match) {
910 if (SvMAGICAL(sv))
911 break;
912 if (obase->op_type == OP_HELEM) {
913 HE* he = hv_fetch_ent((HV*)sv, cSVOPx_sv(kid), 0, 0);
914 if (!he || HeVAL(he) != uninit_sv)
915 break;
916 }
917 else {
918 svp = av_fetch((AV*)sv, SvIV(cSVOPx_sv(kid)), FALSE);
919 if (!svp || *svp != uninit_sv)
920 break;
921 }
922 }
923 if (obase->op_type == OP_HELEM)
924 return S_varname(aTHX_ gv, "%", o->op_targ,
925 cSVOPx_sv(kid), 0, FUV_SUBSCRIPT_HASH);
926 else
927 return S_varname(aTHX_ gv, "@", o->op_targ, Nullsv,
928 SvIV(cSVOPx_sv(kid)), FUV_SUBSCRIPT_ARRAY);
929 ;
930 }
931 else {
932 /* index is an expression;
933 * attempt to find a match within the aggregate */
934 if (obase->op_type == OP_HELEM) {
935 SV *keysv = S_find_hash_subscript(aTHX_ (HV*)sv, uninit_sv);
936 if (keysv)
937 return S_varname(aTHX_ gv, "%", o->op_targ,
938 keysv, 0, FUV_SUBSCRIPT_HASH);
939 }
940 else {
941 I32 index = S_find_array_subscript(aTHX_ (AV*)sv, uninit_sv);
942 if (index >= 0)
943 return S_varname(aTHX_ gv, "@", o->op_targ,
944 Nullsv, index, FUV_SUBSCRIPT_ARRAY);
945 }
946 if (match)
947 break;
948 return S_varname(aTHX_ gv,
949 (o->op_type == OP_PADAV || o->op_type == OP_RV2AV)
950 ? "@" : "%",
951 o->op_targ, Nullsv, 0, FUV_SUBSCRIPT_WITHIN);
952 }
953
954 break;
955
956 case OP_AASSIGN:
957 /* only examine RHS */
958 return find_uninit_var(cBINOPx(obase)->op_first, uninit_sv, match);
959
960 case OP_OPEN:
961 o = cUNOPx(obase)->op_first;
962 if (o->op_type == OP_PUSHMARK)
963 o = o->op_sibling;
964
965 if (!o->op_sibling) {
966 /* one-arg version of open is highly magical */
967
968 if (o->op_type == OP_GV) { /* open FOO; */
969 gv = cGVOPx_gv(o);
970 if (match && GvSV(gv) != uninit_sv)
971 break;
7a5fa8a2 972 return S_varname(aTHX_ gv, "$", 0,
29489e7c
DM
973 Nullsv, 0, FUV_SUBSCRIPT_NONE);
974 }
975 /* other possibilities not handled are:
976 * open $x; or open my $x; should return '${*$x}'
977 * open expr; should return '$'.expr ideally
978 */
979 break;
980 }
981 goto do_op;
982
983 /* ops where $_ may be an implicit arg */
984 case OP_TRANS:
985 case OP_SUBST:
986 case OP_MATCH:
987 if ( !(obase->op_flags & OPf_STACKED)) {
988 if (uninit_sv == ((obase->op_private & OPpTARGET_MY)
989 ? PAD_SVl(obase->op_targ)
990 : DEFSV))
991 {
992 sv = sv_newmortal();
993 sv_setpv(sv, "$_");
994 return sv;
995 }
996 }
997 goto do_op;
998
999 case OP_PRTF:
1000 case OP_PRINT:
1001 /* skip filehandle as it can't produce 'undef' warning */
1002 o = cUNOPx(obase)->op_first;
1003 if ((obase->op_flags & OPf_STACKED) && o->op_type == OP_PUSHMARK)
1004 o = o->op_sibling->op_sibling;
1005 goto do_op2;
1006
1007
e21bd382 1008 case OP_RV2SV:
29489e7c
DM
1009 case OP_CUSTOM:
1010 case OP_ENTERSUB:
1011 match = 1; /* XS or custom code could trigger random warnings */
1012 goto do_op;
1013
1014 case OP_SCHOMP:
1015 case OP_CHOMP:
1016 if (SvROK(PL_rs) && uninit_sv == SvRV(PL_rs))
1017 return sv_2mortal(newSVpv("${$/}", 0));
1018 /* FALL THROUGH */
1019
1020 default:
1021 do_op:
1022 if (!(obase->op_flags & OPf_KIDS))
1023 break;
1024 o = cUNOPx(obase)->op_first;
1025
1026 do_op2:
1027 if (!o)
1028 break;
1029
1030 /* if all except one arg are constant, or have no side-effects,
1031 * or are optimized away, then it's unambiguous */
1032 o2 = Nullop;
1033 for (kid=o; kid; kid = kid->op_sibling) {
1034 if (kid &&
1035 ( (kid->op_type == OP_CONST && SvOK(cSVOPx_sv(kid)))
1036 || (kid->op_type == OP_NULL && ! (kid->op_flags & OPf_KIDS))
1037 || (kid->op_type == OP_PUSHMARK)
1038 )
1039 )
1040 continue;
1041 if (o2) { /* more than one found */
1042 o2 = Nullop;
1043 break;
1044 }
1045 o2 = kid;
1046 }
1047 if (o2)
1048 return find_uninit_var(o2, uninit_sv, match);
1049
1050 /* scan all args */
1051 while (o) {
1052 sv = find_uninit_var(o, uninit_sv, 1);
1053 if (sv)
1054 return sv;
1055 o = o->op_sibling;
1056 }
1057 break;
1058 }
1059 return Nullsv;
1060}
1061
1062
645c22ef
DM
1063/*
1064=for apidoc report_uninit
1065
1066Print appropriate "Use of uninitialized variable" warning
1067
1068=cut
1069*/
1070
1d7c1841 1071void
29489e7c
DM
1072Perl_report_uninit(pTHX_ SV* uninit_sv)
1073{
1074 if (PL_op) {
112dcc46 1075 SV* varname = Nullsv;
29489e7c
DM
1076 if (uninit_sv) {
1077 varname = find_uninit_var(PL_op, uninit_sv,0);
1078 if (varname)
1079 sv_insert(varname, 0, 0, " ", 1);
1080 }
9014280d 1081 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
29489e7c
DM
1082 varname ? SvPV_nolen(varname) : "",
1083 " in ", OP_DESC(PL_op));
1084 }
1d7c1841 1085 else
29489e7c
DM
1086 Perl_warner(aTHX_ packWARN(WARN_UNINITIALIZED), PL_warn_uninit,
1087 "", "", "");
1d7c1841
GS
1088}
1089
645c22ef
DM
1090/* grab a new IV body from the free list, allocating more if necessary */
1091
76e3520e 1092STATIC XPVIV*
cea2e8a9 1093S_new_xiv(pTHX)
463ee0b2 1094{
ea7c11a3 1095 IV* xiv;
cbe51380
GS
1096 LOCK_SV_MUTEX;
1097 if (!PL_xiv_root)
1098 more_xiv();
1099 xiv = PL_xiv_root;
1100 /*
1101 * See comment in more_xiv() -- RAM.
1102 */
1103 PL_xiv_root = *(IV**)xiv;
1104 UNLOCK_SV_MUTEX;
1105 return (XPVIV*)((char*)xiv - STRUCT_OFFSET(XPVIV, xiv_iv));
463ee0b2
LW
1106}
1107
645c22ef
DM
1108/* return an IV body to the free list */
1109
76e3520e 1110STATIC void
cea2e8a9 1111S_del_xiv(pTHX_ XPVIV *p)
463ee0b2 1112{
23e6a22f 1113 IV* xiv = (IV*)((char*)(p) + STRUCT_OFFSET(XPVIV, xiv_iv));
cbe51380 1114 LOCK_SV_MUTEX;
3280af22
NIS
1115 *(IV**)xiv = PL_xiv_root;
1116 PL_xiv_root = xiv;
cbe51380 1117 UNLOCK_SV_MUTEX;
463ee0b2
LW
1118}
1119
645c22ef
DM
1120/* allocate another arena's worth of IV bodies */
1121
cbe51380 1122STATIC void
cea2e8a9 1123S_more_xiv(pTHX)
463ee0b2 1124{
ea7c11a3
SM
1125 register IV* xiv;
1126 register IV* xivend;
8c52afec
IZ
1127 XPV* ptr;
1128 New(705, ptr, 1008/sizeof(XPV), XPV);
645c22ef 1129 ptr->xpv_pv = (char*)PL_xiv_arenaroot; /* linked list of xiv arenas */
3280af22 1130 PL_xiv_arenaroot = ptr; /* to keep Purify happy */
a0d0e21e 1131
ea7c11a3
SM
1132 xiv = (IV*) ptr;
1133 xivend = &xiv[1008 / sizeof(IV) - 1];
645c22ef 1134 xiv += (sizeof(XPV) - 1) / sizeof(IV) + 1; /* fudge by size of XPV */
3280af22 1135 PL_xiv_root = xiv;
463ee0b2 1136 while (xiv < xivend) {
ea7c11a3 1137 *(IV**)xiv = (IV *)(xiv + 1);
463ee0b2
LW
1138 xiv++;
1139 }
ea7c11a3 1140 *(IV**)xiv = 0;
463ee0b2
LW
1141}
1142
645c22ef
DM
1143/* grab a new NV body from the free list, allocating more if necessary */
1144
76e3520e 1145STATIC XPVNV*
cea2e8a9 1146S_new_xnv(pTHX)
463ee0b2 1147{
65202027 1148 NV* xnv;
cbe51380
GS
1149 LOCK_SV_MUTEX;
1150 if (!PL_xnv_root)
1151 more_xnv();
1152 xnv = PL_xnv_root;
65202027 1153 PL_xnv_root = *(NV**)xnv;
cbe51380
GS
1154 UNLOCK_SV_MUTEX;
1155 return (XPVNV*)((char*)xnv - STRUCT_OFFSET(XPVNV, xnv_nv));
463ee0b2
LW
1156}
1157
645c22ef
DM
1158/* return an NV body to the free list */
1159
76e3520e 1160STATIC void
cea2e8a9 1161S_del_xnv(pTHX_ XPVNV *p)
463ee0b2 1162{
65202027 1163 NV* xnv = (NV*)((char*)(p) + STRUCT_OFFSET(XPVNV, xnv_nv));
cbe51380 1164 LOCK_SV_MUTEX;
65202027 1165 *(NV**)xnv = PL_xnv_root;
3280af22 1166 PL_xnv_root = xnv;
cbe51380 1167 UNLOCK_SV_MUTEX;
463ee0b2
LW
1168}
1169
645c22ef
DM
1170/* allocate another arena's worth of NV bodies */
1171
cbe51380 1172STATIC void
cea2e8a9 1173S_more_xnv(pTHX)
463ee0b2 1174{
65202027
DS
1175 register NV* xnv;
1176 register NV* xnvend;
612f20c3
GS
1177 XPV *ptr;
1178 New(711, ptr, 1008/sizeof(XPV), XPV);
1179 ptr->xpv_pv = (char*)PL_xnv_arenaroot;
1180 PL_xnv_arenaroot = ptr;
1181
1182 xnv = (NV*) ptr;
65202027
DS
1183 xnvend = &xnv[1008 / sizeof(NV) - 1];
1184 xnv += (sizeof(XPVIV) - 1) / sizeof(NV) + 1; /* fudge by sizeof XPVIV */
3280af22 1185 PL_xnv_root = xnv;
463ee0b2 1186 while (xnv < xnvend) {
65202027 1187 *(NV**)xnv = (NV*)(xnv + 1);
463ee0b2
LW
1188 xnv++;
1189 }
65202027 1190 *(NV**)xnv = 0;
463ee0b2
LW
1191}
1192
645c22ef
DM
1193/* grab a new struct xrv from the free list, allocating more if necessary */
1194
76e3520e 1195STATIC XRV*
cea2e8a9 1196S_new_xrv(pTHX)
ed6116ce
LW
1197{
1198 XRV* xrv;
cbe51380
GS
1199 LOCK_SV_MUTEX;
1200 if (!PL_xrv_root)
1201 more_xrv();
1202 xrv = PL_xrv_root;
1203 PL_xrv_root = (XRV*)xrv->xrv_rv;
1204 UNLOCK_SV_MUTEX;
1205 return xrv;
ed6116ce
LW
1206}
1207
645c22ef
DM
1208/* return a struct xrv to the free list */
1209
76e3520e 1210STATIC void
cea2e8a9 1211S_del_xrv(pTHX_ XRV *p)
ed6116ce 1212{
cbe51380 1213 LOCK_SV_MUTEX;
3280af22
NIS
1214 p->xrv_rv = (SV*)PL_xrv_root;
1215 PL_xrv_root = p;
cbe51380 1216 UNLOCK_SV_MUTEX;
ed6116ce
LW
1217}
1218
645c22ef
DM
1219/* allocate another arena's worth of struct xrv */
1220
cbe51380 1221STATIC void
cea2e8a9 1222S_more_xrv(pTHX)
ed6116ce 1223{
ed6116ce
LW
1224 register XRV* xrv;
1225 register XRV* xrvend;
612f20c3
GS
1226 XPV *ptr;
1227 New(712, ptr, 1008/sizeof(XPV), XPV);
1228 ptr->xpv_pv = (char*)PL_xrv_arenaroot;
1229 PL_xrv_arenaroot = ptr;
1230
1231 xrv = (XRV*) ptr;
ed6116ce 1232 xrvend = &xrv[1008 / sizeof(XRV) - 1];
612f20c3
GS
1233 xrv += (sizeof(XPV) - 1) / sizeof(XRV) + 1;
1234 PL_xrv_root = xrv;
ed6116ce
LW
1235 while (xrv < xrvend) {
1236 xrv->xrv_rv = (SV*)(xrv + 1);
1237 xrv++;
1238 }
1239 xrv->xrv_rv = 0;
ed6116ce
LW
1240}
1241
645c22ef
DM
1242/* grab a new struct xpv from the free list, allocating more if necessary */
1243
76e3520e 1244STATIC XPV*
cea2e8a9 1245S_new_xpv(pTHX)
463ee0b2
LW
1246{
1247 XPV* xpv;
cbe51380
GS
1248 LOCK_SV_MUTEX;
1249 if (!PL_xpv_root)
1250 more_xpv();
1251 xpv = PL_xpv_root;
1252 PL_xpv_root = (XPV*)xpv->xpv_pv;
1253 UNLOCK_SV_MUTEX;
1254 return xpv;
463ee0b2
LW
1255}
1256
645c22ef
DM
1257/* return a struct xpv to the free list */
1258
76e3520e 1259STATIC void
cea2e8a9 1260S_del_xpv(pTHX_ XPV *p)
463ee0b2 1261{
cbe51380 1262 LOCK_SV_MUTEX;
3280af22
NIS
1263 p->xpv_pv = (char*)PL_xpv_root;
1264 PL_xpv_root = p;
cbe51380 1265 UNLOCK_SV_MUTEX;
463ee0b2
LW
1266}
1267
645c22ef
DM
1268/* allocate another arena's worth of struct xpv */
1269
cbe51380 1270STATIC void
cea2e8a9 1271S_more_xpv(pTHX)
463ee0b2 1272{
463ee0b2
LW
1273 register XPV* xpv;
1274 register XPV* xpvend;
612f20c3
GS
1275 New(713, xpv, 1008/sizeof(XPV), XPV);
1276 xpv->xpv_pv = (char*)PL_xpv_arenaroot;
1277 PL_xpv_arenaroot = xpv;
1278
463ee0b2 1279 xpvend = &xpv[1008 / sizeof(XPV) - 1];
612f20c3 1280 PL_xpv_root = ++xpv;
463ee0b2
LW
1281 while (xpv < xpvend) {
1282 xpv->xpv_pv = (char*)(xpv + 1);
1283 xpv++;
1284 }
1285 xpv->xpv_pv = 0;
463ee0b2
LW
1286}
1287
645c22ef
DM
1288/* grab a new struct xpviv from the free list, allocating more if necessary */
1289
932e9ff9
VB
1290STATIC XPVIV*
1291S_new_xpviv(pTHX)
1292{
1293 XPVIV* xpviv;
1294 LOCK_SV_MUTEX;
1295 if (!PL_xpviv_root)
1296 more_xpviv();
1297 xpviv = PL_xpviv_root;
1298 PL_xpviv_root = (XPVIV*)xpviv->xpv_pv;
1299 UNLOCK_SV_MUTEX;
1300 return xpviv;
1301}
1302
645c22ef
DM
1303/* return a struct xpviv to the free list */
1304
932e9ff9
VB
1305STATIC void
1306S_del_xpviv(pTHX_ XPVIV *p)
1307{
1308 LOCK_SV_MUTEX;
1309 p->xpv_pv = (char*)PL_xpviv_root;
1310 PL_xpviv_root = p;
1311 UNLOCK_SV_MUTEX;
1312}
1313
645c22ef
DM
1314/* allocate another arena's worth of struct xpviv */
1315
932e9ff9
VB
1316STATIC void
1317S_more_xpviv(pTHX)
1318{
1319 register XPVIV* xpviv;
1320 register XPVIV* xpvivend;
612f20c3
GS
1321 New(714, xpviv, 1008/sizeof(XPVIV), XPVIV);
1322 xpviv->xpv_pv = (char*)PL_xpviv_arenaroot;
1323 PL_xpviv_arenaroot = xpviv;
1324
932e9ff9 1325 xpvivend = &xpviv[1008 / sizeof(XPVIV) - 1];
612f20c3 1326 PL_xpviv_root = ++xpviv;
932e9ff9
VB
1327 while (xpviv < xpvivend) {
1328 xpviv->xpv_pv = (char*)(xpviv + 1);
1329 xpviv++;
1330 }
1331 xpviv->xpv_pv = 0;
1332}
1333
645c22ef
DM
1334/* grab a new struct xpvnv from the free list, allocating more if necessary */
1335
932e9ff9
VB
1336STATIC XPVNV*
1337S_new_xpvnv(pTHX)
1338{
1339 XPVNV* xpvnv;
1340 LOCK_SV_MUTEX;
1341 if (!PL_xpvnv_root)
1342 more_xpvnv();
1343 xpvnv = PL_xpvnv_root;
1344 PL_xpvnv_root = (XPVNV*)xpvnv->xpv_pv;
1345 UNLOCK_SV_MUTEX;
1346 return xpvnv;
1347}
1348
645c22ef
DM
1349/* return a struct xpvnv to the free list */
1350
932e9ff9
VB
1351STATIC void
1352S_del_xpvnv(pTHX_ XPVNV *p)
1353{
1354 LOCK_SV_MUTEX;
1355 p->xpv_pv = (char*)PL_xpvnv_root;
1356 PL_xpvnv_root = p;
1357 UNLOCK_SV_MUTEX;
1358}
1359
645c22ef
DM
1360/* allocate another arena's worth of struct xpvnv */
1361
932e9ff9
VB
1362STATIC void
1363S_more_xpvnv(pTHX)
1364{
1365 register XPVNV* xpvnv;
1366 register XPVNV* xpvnvend;
612f20c3
GS
1367 New(715, xpvnv, 1008/sizeof(XPVNV), XPVNV);
1368 xpvnv->xpv_pv = (char*)PL_xpvnv_arenaroot;
1369 PL_xpvnv_arenaroot = xpvnv;
1370
932e9ff9 1371 xpvnvend = &xpvnv[1008 / sizeof(XPVNV) - 1];
612f20c3 1372 PL_xpvnv_root = ++xpvnv;
932e9ff9
VB
1373 while (xpvnv < xpvnvend) {
1374 xpvnv->xpv_pv = (char*)(xpvnv + 1);
1375 xpvnv++;
1376 }
1377 xpvnv->xpv_pv = 0;
1378}
1379
645c22ef
DM
1380/* grab a new struct xpvcv from the free list, allocating more if necessary */
1381
932e9ff9
VB
1382STATIC XPVCV*
1383S_new_xpvcv(pTHX)
1384{
1385 XPVCV* xpvcv;
1386 LOCK_SV_MUTEX;
1387 if (!PL_xpvcv_root)
1388 more_xpvcv();
1389 xpvcv = PL_xpvcv_root;
1390 PL_xpvcv_root = (XPVCV*)xpvcv->xpv_pv;
1391 UNLOCK_SV_MUTEX;
1392 return xpvcv;
1393}
1394
645c22ef
DM
1395/* return a struct xpvcv to the free list */
1396
932e9ff9
VB
1397STATIC void
1398S_del_xpvcv(pTHX_ XPVCV *p)
1399{
1400 LOCK_SV_MUTEX;
1401 p->xpv_pv = (char*)PL_xpvcv_root;
1402 PL_xpvcv_root = p;
1403 UNLOCK_SV_MUTEX;
1404}
1405
645c22ef
DM
1406/* allocate another arena's worth of struct xpvcv */
1407
932e9ff9
VB
1408STATIC void
1409S_more_xpvcv(pTHX)
1410{
1411 register XPVCV* xpvcv;
1412 register XPVCV* xpvcvend;
612f20c3
GS
1413 New(716, xpvcv, 1008/sizeof(XPVCV), XPVCV);
1414 xpvcv->xpv_pv = (char*)PL_xpvcv_arenaroot;
1415 PL_xpvcv_arenaroot = xpvcv;
1416
932e9ff9 1417 xpvcvend = &xpvcv[1008 / sizeof(XPVCV) - 1];
612f20c3 1418 PL_xpvcv_root = ++xpvcv;
932e9ff9
VB
1419 while (xpvcv < xpvcvend) {
1420 xpvcv->xpv_pv = (char*)(xpvcv + 1);
1421 xpvcv++;
1422 }
1423 xpvcv->xpv_pv = 0;
1424}
1425
645c22ef
DM
1426/* grab a new struct xpvav from the free list, allocating more if necessary */
1427
932e9ff9
VB
1428STATIC XPVAV*
1429S_new_xpvav(pTHX)
1430{
1431 XPVAV* xpvav;
1432 LOCK_SV_MUTEX;
1433 if (!PL_xpvav_root)
1434 more_xpvav();
1435 xpvav = PL_xpvav_root;
1436 PL_xpvav_root = (XPVAV*)xpvav->xav_array;
1437 UNLOCK_SV_MUTEX;
1438 return xpvav;
1439}
1440
645c22ef
DM
1441/* return a struct xpvav to the free list */
1442
932e9ff9
VB
1443STATIC void
1444S_del_xpvav(pTHX_ XPVAV *p)
1445{
1446 LOCK_SV_MUTEX;
1447 p->xav_array = (char*)PL_xpvav_root;
1448 PL_xpvav_root = p;
1449 UNLOCK_SV_MUTEX;
1450}
1451
645c22ef
DM
1452/* allocate another arena's worth of struct xpvav */
1453
932e9ff9
VB
1454STATIC void
1455S_more_xpvav(pTHX)
1456{
1457 register XPVAV* xpvav;
1458 register XPVAV* xpvavend;
612f20c3
GS
1459 New(717, xpvav, 1008/sizeof(XPVAV), XPVAV);
1460 xpvav->xav_array = (char*)PL_xpvav_arenaroot;
1461 PL_xpvav_arenaroot = xpvav;
1462
932e9ff9 1463 xpvavend = &xpvav[1008 / sizeof(XPVAV) - 1];
612f20c3 1464 PL_xpvav_root = ++xpvav;
932e9ff9
VB
1465 while (xpvav < xpvavend) {
1466 xpvav->xav_array = (char*)(xpvav + 1);
1467 xpvav++;
1468 }
1469 xpvav->xav_array = 0;
1470}
1471
645c22ef
DM
1472/* grab a new struct xpvhv from the free list, allocating more if necessary */
1473
932e9ff9
VB
1474STATIC XPVHV*
1475S_new_xpvhv(pTHX)
1476{
1477 XPVHV* xpvhv;
1478 LOCK_SV_MUTEX;
1479 if (!PL_xpvhv_root)
1480 more_xpvhv();
1481 xpvhv = PL_xpvhv_root;
1482 PL_xpvhv_root = (XPVHV*)xpvhv->xhv_array;
1483 UNLOCK_SV_MUTEX;
1484 return xpvhv;
1485}
1486
645c22ef
DM
1487/* return a struct xpvhv to the free list */
1488
932e9ff9
VB
1489STATIC void
1490S_del_xpvhv(pTHX_ XPVHV *p)
1491{
1492 LOCK_SV_MUTEX;
1493 p->xhv_array = (char*)PL_xpvhv_root;
1494 PL_xpvhv_root = p;
1495 UNLOCK_SV_MUTEX;
1496}
1497
645c22ef
DM
1498/* allocate another arena's worth of struct xpvhv */
1499
932e9ff9
VB
1500STATIC void
1501S_more_xpvhv(pTHX)
1502{
1503 register XPVHV* xpvhv;
1504 register XPVHV* xpvhvend;
612f20c3
GS
1505 New(718, xpvhv, 1008/sizeof(XPVHV), XPVHV);
1506 xpvhv->xhv_array = (char*)PL_xpvhv_arenaroot;
1507 PL_xpvhv_arenaroot = xpvhv;
1508
932e9ff9 1509 xpvhvend = &xpvhv[1008 / sizeof(XPVHV) - 1];
612f20c3 1510 PL_xpvhv_root = ++xpvhv;
932e9ff9
VB
1511 while (xpvhv < xpvhvend) {
1512 xpvhv->xhv_array = (char*)(xpvhv + 1);
1513 xpvhv++;
1514 }
1515 xpvhv->xhv_array = 0;
1516}
1517
645c22ef
DM
1518/* grab a new struct xpvmg from the free list, allocating more if necessary */
1519
932e9ff9
VB
1520STATIC XPVMG*
1521S_new_xpvmg(pTHX)
1522{
1523 XPVMG* xpvmg;
1524 LOCK_SV_MUTEX;
1525 if (!PL_xpvmg_root)
1526 more_xpvmg();
1527 xpvmg = PL_xpvmg_root;
1528 PL_xpvmg_root = (XPVMG*)xpvmg->xpv_pv;
1529 UNLOCK_SV_MUTEX;
1530 return xpvmg;
1531}
1532
645c22ef
DM
1533/* return a struct xpvmg to the free list */
1534
932e9ff9
VB
1535STATIC void
1536S_del_xpvmg(pTHX_ XPVMG *p)
1537{
1538 LOCK_SV_MUTEX;
1539 p->xpv_pv = (char*)PL_xpvmg_root;
1540 PL_xpvmg_root = p;
1541 UNLOCK_SV_MUTEX;
1542}
1543
645c22ef
DM
1544/* allocate another arena's worth of struct xpvmg */
1545
932e9ff9
VB
1546STATIC void
1547S_more_xpvmg(pTHX)
1548{
1549 register XPVMG* xpvmg;
1550 register XPVMG* xpvmgend;
612f20c3
GS
1551 New(719, xpvmg, 1008/sizeof(XPVMG), XPVMG);
1552 xpvmg->xpv_pv = (char*)PL_xpvmg_arenaroot;
1553 PL_xpvmg_arenaroot = xpvmg;
1554
932e9ff9 1555 xpvmgend = &xpvmg[1008 / sizeof(XPVMG) - 1];
612f20c3 1556 PL_xpvmg_root = ++xpvmg;
932e9ff9
VB
1557 while (xpvmg < xpvmgend) {
1558 xpvmg->xpv_pv = (char*)(xpvmg + 1);
1559 xpvmg++;
1560 }
1561 xpvmg->xpv_pv = 0;
1562}
1563
645c22ef
DM
1564/* grab a new struct xpvlv from the free list, allocating more if necessary */
1565
932e9ff9
VB
1566STATIC XPVLV*
1567S_new_xpvlv(pTHX)
1568{
1569 XPVLV* xpvlv;
1570 LOCK_SV_MUTEX;
1571 if (!PL_xpvlv_root)
1572 more_xpvlv();
1573 xpvlv = PL_xpvlv_root;
1574 PL_xpvlv_root = (XPVLV*)xpvlv->xpv_pv;
1575 UNLOCK_SV_MUTEX;
1576 return xpvlv;
1577}
1578
645c22ef
DM
1579/* return a struct xpvlv to the free list */
1580
932e9ff9
VB
1581STATIC void
1582S_del_xpvlv(pTHX_ XPVLV *p)
1583{
1584 LOCK_SV_MUTEX;
1585 p->xpv_pv = (char*)PL_xpvlv_root;
1586 PL_xpvlv_root = p;
1587 UNLOCK_SV_MUTEX;
1588}
1589
645c22ef
DM
1590/* allocate another arena's worth of struct xpvlv */
1591
932e9ff9
VB
1592STATIC void
1593S_more_xpvlv(pTHX)
1594{
1595 register XPVLV* xpvlv;
1596 register XPVLV* xpvlvend;
612f20c3
GS
1597 New(720, xpvlv, 1008/sizeof(XPVLV), XPVLV);
1598 xpvlv->xpv_pv = (char*)PL_xpvlv_arenaroot;
1599 PL_xpvlv_arenaroot = xpvlv;
1600
932e9ff9 1601 xpvlvend = &xpvlv[1008 / sizeof(XPVLV) - 1];
612f20c3 1602 PL_xpvlv_root = ++xpvlv;
932e9ff9
VB
1603 while (xpvlv < xpvlvend) {
1604 xpvlv->xpv_pv = (char*)(xpvlv + 1);
1605 xpvlv++;
1606 }
1607 xpvlv->xpv_pv = 0;
1608}
1609
645c22ef
DM
1610/* grab a new struct xpvbm from the free list, allocating more if necessary */
1611
932e9ff9
VB
1612STATIC XPVBM*
1613S_new_xpvbm(pTHX)
1614{
1615 XPVBM* xpvbm;
1616 LOCK_SV_MUTEX;
1617 if (!PL_xpvbm_root)
1618 more_xpvbm();
1619 xpvbm = PL_xpvbm_root;
1620 PL_xpvbm_root = (XPVBM*)xpvbm->xpv_pv;
1621 UNLOCK_SV_MUTEX;
1622 return xpvbm;
1623}
1624
645c22ef
DM
1625/* return a struct xpvbm to the free list */
1626
932e9ff9
VB
1627STATIC void
1628S_del_xpvbm(pTHX_ XPVBM *p)
1629{
1630 LOCK_SV_MUTEX;
1631 p->xpv_pv = (char*)PL_xpvbm_root;
1632 PL_xpvbm_root = p;
1633 UNLOCK_SV_MUTEX;
1634}
1635
645c22ef
DM
1636/* allocate another arena's worth of struct xpvbm */
1637
932e9ff9
VB
1638STATIC void
1639S_more_xpvbm(pTHX)
1640{
1641 register XPVBM* xpvbm;
1642 register XPVBM* xpvbmend;
612f20c3
GS
1643 New(721, xpvbm, 1008/sizeof(XPVBM), XPVBM);
1644 xpvbm->xpv_pv = (char*)PL_xpvbm_arenaroot;
1645 PL_xpvbm_arenaroot = xpvbm;
1646
932e9ff9 1647 xpvbmend = &xpvbm[1008 / sizeof(XPVBM) - 1];
612f20c3 1648 PL_xpvbm_root = ++xpvbm;
932e9ff9
VB
1649 while (xpvbm < xpvbmend) {
1650 xpvbm->xpv_pv = (char*)(xpvbm + 1);
1651 xpvbm++;
1652 }
1653 xpvbm->xpv_pv = 0;
1654}
1655
7bab3ede
MB
1656#define my_safemalloc(s) (void*)safemalloc(s)
1657#define my_safefree(p) safefree((char*)p)
463ee0b2 1658
d33b2eba 1659#ifdef PURIFY
463ee0b2 1660
d33b2eba
GS
1661#define new_XIV() my_safemalloc(sizeof(XPVIV))
1662#define del_XIV(p) my_safefree(p)
ed6116ce 1663
d33b2eba
GS
1664#define new_XNV() my_safemalloc(sizeof(XPVNV))
1665#define del_XNV(p) my_safefree(p)
463ee0b2 1666
d33b2eba
GS
1667#define new_XRV() my_safemalloc(sizeof(XRV))
1668#define del_XRV(p) my_safefree(p)
8c52afec 1669
d33b2eba
GS
1670#define new_XPV() my_safemalloc(sizeof(XPV))
1671#define del_XPV(p) my_safefree(p)
9b94d1dd 1672
d33b2eba
GS
1673#define new_XPVIV() my_safemalloc(sizeof(XPVIV))
1674#define del_XPVIV(p) my_safefree(p)
932e9ff9 1675
d33b2eba
GS
1676#define new_XPVNV() my_safemalloc(sizeof(XPVNV))
1677#define del_XPVNV(p) my_safefree(p)
932e9ff9 1678
d33b2eba
GS
1679#define new_XPVCV() my_safemalloc(sizeof(XPVCV))
1680#define del_XPVCV(p) my_safefree(p)
932e9ff9 1681
d33b2eba
GS
1682#define new_XPVAV() my_safemalloc(sizeof(XPVAV))
1683#define del_XPVAV(p) my_safefree(p)
1684
1685#define new_XPVHV() my_safemalloc(sizeof(XPVHV))
1686#define del_XPVHV(p) my_safefree(p)
1c846c1f 1687
d33b2eba
GS
1688#define new_XPVMG() my_safemalloc(sizeof(XPVMG))
1689#define del_XPVMG(p) my_safefree(p)
1690
1691#define new_XPVLV() my_safemalloc(sizeof(XPVLV))
1692#define del_XPVLV(p) my_safefree(p)
1693
1694#define new_XPVBM() my_safemalloc(sizeof(XPVBM))
1695#define del_XPVBM(p) my_safefree(p)
1696
1697#else /* !PURIFY */
1698
1699#define new_XIV() (void*)new_xiv()
1700#define del_XIV(p) del_xiv((XPVIV*) p)
1701
1702#define new_XNV() (void*)new_xnv()
1703#define del_XNV(p) del_xnv((XPVNV*) p)
9b94d1dd 1704
d33b2eba
GS
1705#define new_XRV() (void*)new_xrv()
1706#define del_XRV(p) del_xrv((XRV*) p)
9b94d1dd 1707
d33b2eba
GS
1708#define new_XPV() (void*)new_xpv()
1709#define del_XPV(p) del_xpv((XPV *)p)
1710
1711#define new_XPVIV() (void*)new_xpviv()
1712#define del_XPVIV(p) del_xpviv((XPVIV *)p)
1713
1714#define new_XPVNV() (void*)new_xpvnv()
1715#define del_XPVNV(p) del_xpvnv((XPVNV *)p)
1716
1717#define new_XPVCV() (void*)new_xpvcv()
1718#define del_XPVCV(p) del_xpvcv((XPVCV *)p)
1719
1720#define new_XPVAV() (void*)new_xpvav()
1721#define del_XPVAV(p) del_xpvav((XPVAV *)p)
1722
1723#define new_XPVHV() (void*)new_xpvhv()
1724#define del_XPVHV(p) del_xpvhv((XPVHV *)p)
1c846c1f 1725
d33b2eba
GS
1726#define new_XPVMG() (void*)new_xpvmg()
1727#define del_XPVMG(p) del_xpvmg((XPVMG *)p)
1728
1729#define new_XPVLV() (void*)new_xpvlv()
1730#define del_XPVLV(p) del_xpvlv((XPVLV *)p)
1731
1732#define new_XPVBM() (void*)new_xpvbm()
1733#define del_XPVBM(p) del_xpvbm((XPVBM *)p)
1734
1735#endif /* PURIFY */
9b94d1dd 1736
d33b2eba
GS
1737#define new_XPVGV() my_safemalloc(sizeof(XPVGV))
1738#define del_XPVGV(p) my_safefree(p)
1c846c1f 1739
d33b2eba
GS
1740#define new_XPVFM() my_safemalloc(sizeof(XPVFM))
1741#define del_XPVFM(p) my_safefree(p)
1c846c1f 1742
d33b2eba
GS
1743#define new_XPVIO() my_safemalloc(sizeof(XPVIO))
1744#define del_XPVIO(p) my_safefree(p)
8990e307 1745
954c1994
GS
1746/*
1747=for apidoc sv_upgrade
1748
ff276b08 1749Upgrade an SV to a more complex form. Generally adds a new body type to the
645c22ef 1750SV, then copies across as much information as possible from the old body.
ff276b08 1751You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
954c1994
GS
1752
1753=cut
1754*/
1755
79072805 1756bool
864dbfa3 1757Perl_sv_upgrade(pTHX_ register SV *sv, U32 mt)
79072805 1758{
e763e3dc 1759
c04a4dfe
JH
1760 char* pv = NULL;
1761 U32 cur = 0;
1762 U32 len = 0;
1763 IV iv = 0;
1764 NV nv = 0.0;
1765 MAGIC* magic = NULL;
1766 HV* stash = Nullhv;
79072805 1767
765f542d
NC
1768 if (mt != SVt_PV && SvIsCOW(sv)) {
1769 sv_force_normal_flags(sv, 0);
f130fd45
NIS
1770 }
1771
79072805
LW
1772 if (SvTYPE(sv) == mt)
1773 return TRUE;
1774
a5f75d66
AD
1775 if (mt < SVt_PVIV)
1776 (void)SvOOK_off(sv);
1777
79072805
LW
1778 switch (SvTYPE(sv)) {
1779 case SVt_NULL:
1780 pv = 0;
1781 cur = 0;
1782 len = 0;
1783 iv = 0;
1784 nv = 0.0;
1785 magic = 0;
1786 stash = 0;
1787 break;
79072805
LW
1788 case SVt_IV:
1789 pv = 0;
1790 cur = 0;
1791 len = 0;
463ee0b2 1792 iv = SvIVX(sv);
65202027 1793 nv = (NV)SvIVX(sv);
79072805
LW
1794 del_XIV(SvANY(sv));
1795 magic = 0;
1796 stash = 0;
ed6116ce 1797 if (mt == SVt_NV)
463ee0b2 1798 mt = SVt_PVNV;
ed6116ce
LW
1799 else if (mt < SVt_PVIV)
1800 mt = SVt_PVIV;
79072805
LW
1801 break;
1802 case SVt_NV:
1803 pv = 0;
1804 cur = 0;
1805 len = 0;
463ee0b2 1806 nv = SvNVX(sv);
1bd302c3 1807 iv = I_V(nv);
79072805
LW
1808 magic = 0;
1809 stash = 0;
1810 del_XNV(SvANY(sv));
1811 SvANY(sv) = 0;
ed6116ce 1812 if (mt < SVt_PVNV)
79072805
LW
1813 mt = SVt_PVNV;
1814 break;
ed6116ce
LW
1815 case SVt_RV:
1816 pv = (char*)SvRV(sv);
1817 cur = 0;
1818 len = 0;
56431972
RB
1819 iv = PTR2IV(pv);
1820 nv = PTR2NV(pv);
ed6116ce
LW
1821 del_XRV(SvANY(sv));
1822 magic = 0;
1823 stash = 0;
1824 break;
79072805 1825 case SVt_PV:
463ee0b2 1826 pv = SvPVX(sv);
79072805
LW
1827 cur = SvCUR(sv);
1828 len = SvLEN(sv);
1829 iv = 0;
1830 nv = 0.0;
1831 magic = 0;
1832 stash = 0;
1833 del_XPV(SvANY(sv));
748a9306
LW
1834 if (mt <= SVt_IV)
1835 mt = SVt_PVIV;
1836 else if (mt == SVt_NV)
1837 mt = SVt_PVNV;
79072805
LW
1838 break;
1839 case SVt_PVIV:
463ee0b2 1840 pv = SvPVX(sv);
79072805
LW
1841 cur = SvCUR(sv);
1842 len = SvLEN(sv);
463ee0b2 1843 iv = SvIVX(sv);
79072805
LW
1844 nv = 0.0;
1845 magic = 0;
1846 stash = 0;
1847 del_XPVIV(SvANY(sv));
1848 break;
1849 case SVt_PVNV:
463ee0b2 1850 pv = SvPVX(sv);
79072805
LW
1851 cur = SvCUR(sv);
1852 len = SvLEN(sv);
463ee0b2
LW
1853 iv = SvIVX(sv);
1854 nv = SvNVX(sv);
79072805
LW
1855 magic = 0;
1856 stash = 0;
1857 del_XPVNV(SvANY(sv));
1858 break;
1859 case SVt_PVMG:
463ee0b2 1860 pv = SvPVX(sv);
79072805
LW
1861 cur = SvCUR(sv);
1862 len = SvLEN(sv);
463ee0b2
LW
1863 iv = SvIVX(sv);
1864 nv = SvNVX(sv);
79072805
LW
1865 magic = SvMAGIC(sv);
1866 stash = SvSTASH(sv);
1867 del_XPVMG(SvANY(sv));
1868 break;
1869 default:
cea2e8a9 1870 Perl_croak(aTHX_ "Can't upgrade that kind of scalar");
79072805
LW
1871 }
1872
ffb05e06
NC
1873 SvFLAGS(sv) &= ~SVTYPEMASK;
1874 SvFLAGS(sv) |= mt;
1875
79072805
LW
1876 switch (mt) {
1877 case SVt_NULL:
cea2e8a9 1878 Perl_croak(aTHX_ "Can't upgrade to undef");
79072805
LW
1879 case SVt_IV:
1880 SvANY(sv) = new_XIV();
463ee0b2 1881 SvIVX(sv) = iv;
79072805
LW
1882 break;
1883 case SVt_NV:
1884 SvANY(sv) = new_XNV();
463ee0b2 1885 SvNVX(sv) = nv;
79072805 1886 break;
ed6116ce
LW
1887 case SVt_RV:
1888 SvANY(sv) = new_XRV();
1889 SvRV(sv) = (SV*)pv;
ed6116ce 1890 break;
79072805
LW
1891 case SVt_PV:
1892 SvANY(sv) = new_XPV();
463ee0b2 1893 SvPVX(sv) = pv;
79072805
LW
1894 SvCUR(sv) = cur;
1895 SvLEN(sv) = len;
1896 break;
1897 case SVt_PVIV:
1898 SvANY(sv) = new_XPVIV();
463ee0b2 1899 SvPVX(sv) = pv;
79072805
LW
1900 SvCUR(sv) = cur;
1901 SvLEN(sv) = len;
463ee0b2 1902 SvIVX(sv) = iv;
79072805 1903 if (SvNIOK(sv))
a0d0e21e 1904 (void)SvIOK_on(sv);
79072805
LW
1905 SvNOK_off(sv);
1906 break;
1907 case SVt_PVNV:
1908 SvANY(sv) = new_XPVNV();
463ee0b2 1909 SvPVX(sv) = pv;
79072805
LW
1910 SvCUR(sv) = cur;
1911 SvLEN(sv) = len;
463ee0b2
LW
1912 SvIVX(sv) = iv;
1913 SvNVX(sv) = nv;
79072805
LW
1914 break;
1915 case SVt_PVMG:
1916 SvANY(sv) = new_XPVMG();
463ee0b2 1917 SvPVX(sv) = pv;
79072805
LW
1918 SvCUR(sv) = cur;
1919 SvLEN(sv) = len;
463ee0b2
LW
1920 SvIVX(sv) = iv;
1921 SvNVX(sv) = nv;
79072805
LW
1922 SvMAGIC(sv) = magic;
1923 SvSTASH(sv) = stash;
1924 break;
1925 case SVt_PVLV:
1926 SvANY(sv) = new_XPVLV();
463ee0b2 1927 SvPVX(sv) = pv;
79072805
LW
1928 SvCUR(sv) = cur;
1929 SvLEN(sv) = len;
463ee0b2
LW
1930 SvIVX(sv) = iv;
1931 SvNVX(sv) = nv;
79072805
LW
1932 SvMAGIC(sv) = magic;
1933 SvSTASH(sv) = stash;
1934 LvTARGOFF(sv) = 0;
1935 LvTARGLEN(sv) = 0;
1936 LvTARG(sv) = 0;
1937 LvTYPE(sv) = 0;
b76195c2
DM
1938 GvGP(sv) = 0;
1939 GvNAME(sv) = 0;
1940 GvNAMELEN(sv) = 0;
1941 GvSTASH(sv) = 0;
1942 GvFLAGS(sv) = 0;
79072805
LW
1943 break;
1944 case SVt_PVAV:
1945 SvANY(sv) = new_XPVAV();
463ee0b2
LW
1946 if (pv)
1947 Safefree(pv);
2304df62 1948 SvPVX(sv) = 0;
d1bf51dd 1949 AvMAX(sv) = -1;
93965878 1950 AvFILLp(sv) = -1;
463ee0b2
LW
1951 SvIVX(sv) = 0;
1952 SvNVX(sv) = 0.0;
1953 SvMAGIC(sv) = magic;
1954 SvSTASH(sv) = stash;
1955 AvALLOC(sv) = 0;
79072805 1956 AvARYLEN(sv) = 0;
e763e3dc 1957 AvFLAGS(sv) = AVf_REAL;
79072805
LW
1958 break;
1959 case SVt_PVHV:
1960 SvANY(sv) = new_XPVHV();
463ee0b2
LW
1961 if (pv)
1962 Safefree(pv);
1963 SvPVX(sv) = 0;
1964 HvFILL(sv) = 0;
1965 HvMAX(sv) = 0;
8aacddc1
NIS
1966 HvTOTALKEYS(sv) = 0;
1967 HvPLACEHOLDERS(sv) = 0;
79072805
LW
1968 SvMAGIC(sv) = magic;
1969 SvSTASH(sv) = stash;
79072805
LW
1970 HvRITER(sv) = 0;
1971 HvEITER(sv) = 0;
1972 HvPMROOT(sv) = 0;
1973 HvNAME(sv) = 0;
79072805
LW
1974 break;
1975 case SVt_PVCV:
1976 SvANY(sv) = new_XPVCV();
748a9306 1977 Zero(SvANY(sv), 1, XPVCV);
463ee0b2 1978 SvPVX(sv) = pv;
79072805
LW
1979 SvCUR(sv) = cur;
1980 SvLEN(sv) = len;
463ee0b2
LW
1981 SvIVX(sv) = iv;
1982 SvNVX(sv) = nv;
79072805
LW
1983 SvMAGIC(sv) = magic;
1984 SvSTASH(sv) = stash;
79072805
LW
1985 break;
1986 case SVt_PVGV:
1987 SvANY(sv) = new_XPVGV();
463ee0b2 1988 SvPVX(sv) = pv;
79072805
LW
1989 SvCUR(sv) = cur;
1990 SvLEN(sv) = len;
463ee0b2
LW
1991 SvIVX(sv) = iv;
1992 SvNVX(sv) = nv;
79072805
LW
1993 SvMAGIC(sv) = magic;
1994 SvSTASH(sv) = stash;
93a17b20 1995 GvGP(sv) = 0;
79072805
LW
1996 GvNAME(sv) = 0;
1997 GvNAMELEN(sv) = 0;
1998 GvSTASH(sv) = 0;
a5f75d66 1999 GvFLAGS(sv) = 0;
79072805
LW
2000 break;
2001 case SVt_PVBM:
2002 SvANY(sv) = new_XPVBM();
463ee0b2 2003 SvPVX(sv) = pv;
79072805
LW
2004 SvCUR(sv) = cur;
2005 SvLEN(sv) = len;
463ee0b2
LW
2006 SvIVX(sv) = iv;
2007 SvNVX(sv) = nv;
79072805
LW
2008 SvMAGIC(sv) = magic;
2009 SvSTASH(sv) = stash;
2010 BmRARE(sv) = 0;
2011 BmUSEFUL(sv) = 0;
2012 BmPREVIOUS(sv) = 0;
2013 break;
2014 case SVt_PVFM:
2015 SvANY(sv) = new_XPVFM();
748a9306 2016 Zero(SvANY(sv), 1, XPVFM);
463ee0b2 2017 SvPVX(sv) = pv;
79072805
LW
2018 SvCUR(sv) = cur;
2019 SvLEN(sv) = len;
463ee0b2
LW
2020 SvIVX(sv) = iv;
2021 SvNVX(sv) = nv;
79072805
LW
2022 SvMAGIC(sv) = magic;
2023 SvSTASH(sv) = stash;
79072805 2024 break;
8990e307
LW
2025 case SVt_PVIO:
2026 SvANY(sv) = new_XPVIO();
748a9306 2027 Zero(SvANY(sv), 1, XPVIO);
8990e307
LW
2028 SvPVX(sv) = pv;
2029 SvCUR(sv) = cur;
2030 SvLEN(sv) = len;
2031 SvIVX(sv) = iv;
2032 SvNVX(sv) = nv;
2033 SvMAGIC(sv) = magic;
2034 SvSTASH(sv) = stash;
85e6fe83 2035 IoPAGE_LEN(sv) = 60;
8990e307
LW
2036 break;
2037 }
79072805
LW
2038 return TRUE;
2039}
2040
645c22ef
DM
2041/*
2042=for apidoc sv_backoff
2043
2044Remove any string offset. You should normally use the C<SvOOK_off> macro
2045wrapper instead.
2046
2047=cut
2048*/
2049
79072805 2050int
864dbfa3 2051Perl_sv_backoff(pTHX_ register SV *sv)
79072805
LW
2052{
2053 assert(SvOOK(sv));
463ee0b2
LW
2054 if (SvIVX(sv)) {
2055 char *s = SvPVX(sv);
2056 SvLEN(sv) += SvIVX(sv);
2057 SvPVX(sv) -= SvIVX(sv);
79072805 2058 SvIV_set(sv, 0);
463ee0b2 2059 Move(s, SvPVX(sv), SvCUR(sv)+1, char);
79072805
LW
2060 }
2061 SvFLAGS(sv) &= ~SVf_OOK;
a0d0e21e 2062 return 0;
79072805
LW
2063}
2064
954c1994
GS
2065/*
2066=for apidoc sv_grow
2067
645c22ef
DM
2068Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
2069upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
2070Use the C<SvGROW> wrapper instead.
954c1994
GS
2071
2072=cut
2073*/
2074
79072805 2075char *
864dbfa3 2076Perl_sv_grow(pTHX_ register SV *sv, register STRLEN newlen)
79072805
LW
2077{
2078 register char *s;
2079
55497cff 2080#ifdef HAS_64K_LIMIT
79072805 2081 if (newlen >= 0x10000) {
1d7c1841
GS
2082 PerlIO_printf(Perl_debug_log,
2083 "Allocation too large: %"UVxf"\n", (UV)newlen);
79072805
LW
2084 my_exit(1);
2085 }
55497cff 2086#endif /* HAS_64K_LIMIT */
a0d0e21e
LW
2087 if (SvROK(sv))
2088 sv_unref(sv);
79072805
LW
2089 if (SvTYPE(sv) < SVt_PV) {
2090 sv_upgrade(sv, SVt_PV);
463ee0b2 2091 s = SvPVX(sv);
79072805
LW
2092 }
2093 else if (SvOOK(sv)) { /* pv is offset? */
2094 sv_backoff(sv);
463ee0b2 2095 s = SvPVX(sv);
79072805
LW
2096 if (newlen > SvLEN(sv))
2097 newlen += 10 * (newlen - SvCUR(sv)); /* avoid copy each time */
c6f8c383
GA
2098#ifdef HAS_64K_LIMIT
2099 if (newlen >= 0x10000)
2100 newlen = 0xFFFF;
2101#endif
79072805 2102 }
bc44a8a2 2103 else
463ee0b2 2104 s = SvPVX(sv);
54f0641b 2105
79072805 2106 if (newlen > SvLEN(sv)) { /* need more room? */
8d6dde3e 2107 if (SvLEN(sv) && s) {
7bab3ede 2108#ifdef MYMALLOC
8d6dde3e
IZ
2109 STRLEN l = malloced_size((void*)SvPVX(sv));
2110 if (newlen <= l) {
2111 SvLEN_set(sv, l);
2112 return s;
2113 } else
c70c8a0a 2114#endif
79072805 2115 Renew(s,newlen,char);
8d6dde3e 2116 }
4e83176d 2117 else {
4e83176d 2118 New(703, s, newlen, char);
40565179 2119 if (SvPVX(sv) && SvCUR(sv)) {
54f0641b 2120 Move(SvPVX(sv), s, (newlen < SvCUR(sv)) ? newlen : SvCUR(sv), char);
40565179 2121 }
4e83176d 2122 }
79072805
LW
2123 SvPV_set(sv, s);
2124 SvLEN_set(sv, newlen);
2125 }
2126 return s;
2127}
2128
954c1994
GS
2129/*
2130=for apidoc sv_setiv
2131
645c22ef
DM
2132Copies an integer into the given SV, upgrading first if necessary.
2133Does not handle 'set' magic. See also C<sv_setiv_mg>.
954c1994
GS
2134
2135=cut
2136*/
2137
79072805 2138void
864dbfa3 2139Perl_sv_setiv(pTHX_ register SV *sv, IV i)
79072805 2140{
765f542d 2141 SV_CHECK_THINKFIRST_COW_DROP(sv);
463ee0b2
LW
2142 switch (SvTYPE(sv)) {
2143 case SVt_NULL:
79072805 2144 sv_upgrade(sv, SVt_IV);
463ee0b2
LW
2145 break;
2146 case SVt_NV:
2147 sv_upgrade(sv, SVt_PVNV);
2148 break;
ed6116ce 2149 case SVt_RV:
463ee0b2 2150 case SVt_PV:
79072805 2151 sv_upgrade(sv, SVt_PVIV);
463ee0b2 2152 break;
a0d0e21e
LW
2153
2154 case SVt_PVGV:
a0d0e21e
LW
2155 case SVt_PVAV:
2156 case SVt_PVHV:
2157 case SVt_PVCV:
2158 case SVt_PVFM:
2159 case SVt_PVIO:
411caa50 2160 Perl_croak(aTHX_ "Can't coerce %s to integer in %s", sv_reftype(sv,0),
53e06cf0 2161 OP_DESC(PL_op));
463ee0b2 2162 }
a0d0e21e 2163 (void)SvIOK_only(sv); /* validate number */
a5f75d66 2164 SvIVX(sv) = i;
463ee0b2 2165 SvTAINT(sv);
79072805
LW
2166}
2167
954c1994
GS
2168/*
2169=for apidoc sv_setiv_mg
2170
2171Like C<sv_setiv>, but also handles 'set' magic.
2172
2173=cut
2174*/
2175
79072805 2176void
864dbfa3 2177Perl_sv_setiv_mg(pTHX_ register SV *sv, IV i)
ef50df4b
GS
2178{
2179 sv_setiv(sv,i);
2180 SvSETMAGIC(sv);
2181}
2182
954c1994
GS
2183/*
2184=for apidoc sv_setuv
2185
645c22ef
DM
2186Copies an unsigned integer into the given SV, upgrading first if necessary.
2187Does not handle 'set' magic. See also C<sv_setuv_mg>.
954c1994
GS
2188
2189=cut
2190*/
2191
ef50df4b 2192void
864dbfa3 2193Perl_sv_setuv(pTHX_ register SV *sv, UV u)
55497cff 2194{
55ada374
NC
2195 /* With these two if statements:
2196 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
d460ef45 2197
55ada374
NC
2198 without
2199 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
d460ef45 2200
55ada374
NC
2201 If you wish to remove them, please benchmark to see what the effect is
2202 */
28e5dec8
JH
2203 if (u <= (UV)IV_MAX) {
2204 sv_setiv(sv, (IV)u);
2205 return;
2206 }
25da4f38
IZ
2207 sv_setiv(sv, 0);
2208 SvIsUV_on(sv);
2209 SvUVX(sv) = u;
55497cff 2210}
2211
954c1994
GS
2212/*
2213=for apidoc sv_setuv_mg
2214
2215Like C<sv_setuv>, but also handles 'set' magic.
2216
2217=cut
2218*/
2219
55497cff 2220void
864dbfa3 2221Perl_sv_setuv_mg(pTHX_ register SV *sv, UV u)
ef50df4b 2222{
55ada374
NC
2223 /* With these two if statements:
2224 u=1.49 s=0.52 cu=72.49 cs=10.64 scripts=270 tests=20865
d460ef45 2225
55ada374
NC
2226 without
2227 u=1.35 s=0.47 cu=73.45 cs=11.43 scripts=270 tests=20865
d460ef45 2228
55ada374
NC
2229 If you wish to remove them, please benchmark to see what the effect is
2230 */
28e5dec8
JH
2231 if (u <= (UV)IV_MAX) {
2232 sv_setiv(sv, (IV)u);
2233 } else {
2234 sv_setiv(sv, 0);
2235 SvIsUV_on(sv);
2236 sv_setuv(sv,u);
2237 }
ef50df4b
GS
2238 SvSETMAGIC(sv);
2239}
2240
954c1994
GS
2241/*
2242=for apidoc sv_setnv
2243
645c22ef
DM
2244Copies a double into the given SV, upgrading first if necessary.
2245Does not handle 'set' magic. See also C<sv_setnv_mg>.
954c1994
GS
2246
2247=cut
2248*/
2249
ef50df4b 2250void
65202027 2251Perl_sv_setnv(pTHX_ register SV *sv, NV num)
79072805 2252{
765f542d 2253 SV_CHECK_THINKFIRST_COW_DROP(sv);
a0d0e21e
LW
2254 switch (SvTYPE(sv)) {
2255 case SVt_NULL:
2256 case SVt_IV:
79072805 2257 sv_upgrade(sv, SVt_NV);
a0d0e21e 2258 break;
a0d0e21e
LW
2259 case SVt_RV:
2260 case SVt_PV:
2261 case SVt_PVIV:
79072805 2262 sv_upgrade(sv, SVt_PVNV);
a0d0e21e 2263 break;
827b7e14 2264
a0d0e21e 2265 case SVt_PVGV:
a0d0e21e
LW
2266 case SVt_PVAV:
2267 case SVt_PVHV:
2268 case SVt_PVCV:
2269 case SVt_PVFM:
2270 case SVt_PVIO:
411caa50 2271 Perl_croak(aTHX_ "Can't coerce %s to number in %s", sv_reftype(sv,0),
53e06cf0 2272 OP_NAME(PL_op));
79072805 2273 }
463ee0b2 2274 SvNVX(sv) = num;
a0d0e21e 2275 (void)SvNOK_only(sv); /* validate number */
463ee0b2 2276 SvTAINT(sv);
79072805
LW
2277}
2278
954c1994
GS
2279/*
2280=for apidoc sv_setnv_mg
2281
2282Like C<sv_setnv>, but also handles 'set' magic.
2283
2284=cut
2285*/
2286
ef50df4b 2287void
65202027 2288Perl_sv_setnv_mg(pTHX_ register SV *sv, NV num)
ef50df4b
GS
2289{
2290 sv_setnv(sv,num);
2291 SvSETMAGIC(sv);
2292}
2293
645c22ef
DM
2294/* Print an "isn't numeric" warning, using a cleaned-up,
2295 * printable version of the offending string
2296 */
2297
76e3520e 2298STATIC void
cea2e8a9 2299S_not_a_number(pTHX_ SV *sv)
a0d0e21e 2300{
94463019
JH
2301 SV *dsv;
2302 char tmpbuf[64];
2303 char *pv;
2304
2305 if (DO_UTF8(sv)) {
2306 dsv = sv_2mortal(newSVpv("", 0));
2307 pv = sv_uni_display(dsv, sv, 10, 0);
2308 } else {
2309 char *d = tmpbuf;
2310 char *limit = tmpbuf + sizeof(tmpbuf) - 8;
2311 /* each *s can expand to 4 chars + "...\0",
2312 i.e. need room for 8 chars */
ecdeb87c 2313
94463019
JH
2314 char *s, *end;
2315 for (s = SvPVX(sv), end = s + SvCUR(sv); s < end && d < limit; s++) {
2316 int ch = *s & 0xFF;
2317 if (ch & 128 && !isPRINT_LC(ch)) {
2318 *d++ = 'M';
2319 *d++ = '-';
2320 ch &= 127;
2321 }
2322 if (ch == '\n') {
2323 *d++ = '\\';
2324 *d++ = 'n';
2325 }
2326 else if (ch == '\r') {
2327 *d++ = '\\';
2328 *d++ = 'r';
2329 }
2330 else if (ch == '\f') {
2331 *d++ = '\\';
2332 *d++ = 'f';
2333 }
2334 else if (ch == '\\') {
2335 *d++ = '\\';
2336 *d++ = '\\';
2337 }
2338 else if (ch == '\0') {
2339 *d++ = '\\';
2340 *d++ = '0';
2341 }
2342 else if (isPRINT_LC(ch))
2343 *d++ = ch;
2344 else {
2345 *d++ = '^';
2346 *d++ = toCTRL(ch);
2347 }
2348 }
2349 if (s < end) {
2350 *d++ = '.';
2351 *d++ = '.';
2352 *d++ = '.';
2353 }
2354 *d = '\0';
2355 pv = tmpbuf;
a0d0e21e 2356 }
a0d0e21e 2357
533c011a 2358 if (PL_op)
9014280d 2359 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
94463019
JH
2360 "Argument \"%s\" isn't numeric in %s", pv,
2361 OP_DESC(PL_op));
a0d0e21e 2362 else
9014280d 2363 Perl_warner(aTHX_ packWARN(WARN_NUMERIC),
94463019 2364 "Argument \"%s\" isn't numeric", pv);
a0d0e21e
LW
2365}
2366
c2988b20
NC
2367/*
2368=for apidoc looks_like_number
2369
645c22ef
DM
2370Test if the content of an SV looks like a number (or is a number).
2371C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2372non-numeric warning), even if your atof() doesn't grok them.
c2988b20
NC
2373
2374=cut
2375*/
2376
2377I32
2378Perl_looks_like_number(pTHX_ SV *sv)
2379{
2380 register char *sbegin;
2381 STRLEN len;
2382
2383 if (SvPOK(sv)) {
2384 sbegin = SvPVX(sv);
2385 len = SvCUR(sv);
2386 }
2387 else if (SvPOKp(sv))
2388 sbegin = SvPV(sv, len);
2389 else
e0ab1c0e 2390 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
c2988b20
NC
2391 return grok_number(sbegin, len, NULL);
2392}
25da4f38
IZ
2393
2394/* Actually, ISO C leaves conversion of UV to IV undefined, but
2395 until proven guilty, assume that things are not that bad... */
2396
645c22ef
DM
2397/*
2398 NV_PRESERVES_UV:
2399
2400 As 64 bit platforms often have an NV that doesn't preserve all bits of
28e5dec8
JH
2401 an IV (an assumption perl has been based on to date) it becomes necessary
2402 to remove the assumption that the NV always carries enough precision to
2403 recreate the IV whenever needed, and that the NV is the canonical form.
2404 Instead, IV/UV and NV need to be given equal rights. So as to not lose
645c22ef 2405 precision as a side effect of conversion (which would lead to insanity
28e5dec8
JH
2406 and the dragon(s) in t/op/numconvert.t getting very angry) the intent is
2407 1) to distinguish between IV/UV/NV slots that have cached a valid
2408 conversion where precision was lost and IV/UV/NV slots that have a
2409 valid conversion which has lost no precision
645c22ef 2410 2) to ensure that if a numeric conversion to one form is requested that
28e5dec8
JH
2411 would lose precision, the precise conversion (or differently
2412 imprecise conversion) is also performed and cached, to prevent
2413 requests for different numeric formats on the same SV causing
2414 lossy conversion chains. (lossless conversion chains are perfectly
2415 acceptable (still))
2416
2417
2418 flags are used:
2419 SvIOKp is true if the IV slot contains a valid value
2420 SvIOK is true only if the IV value is accurate (UV if SvIOK_UV true)
2421 SvNOKp is true if the NV slot contains a valid value
2422 SvNOK is true only if the NV value is accurate
2423
2424 so
645c22ef 2425 while converting from PV to NV, check to see if converting that NV to an
28e5dec8
JH
2426 IV(or UV) would lose accuracy over a direct conversion from PV to
2427 IV(or UV). If it would, cache both conversions, return NV, but mark
2428 SV as IOK NOKp (ie not NOK).
2429
645c22ef 2430 While converting from PV to IV, check to see if converting that IV to an
28e5dec8
JH
2431 NV would lose accuracy over a direct conversion from PV to NV. If it
2432 would, cache both conversions, flag similarly.
2433
2434 Before, the SV value "3.2" could become NV=3.2 IV=3 NOK, IOK quite
2435 correctly because if IV & NV were set NV *always* overruled.
645c22ef
DM
2436 Now, "3.2" will become NV=3.2 IV=3 NOK, IOKp, because the flag's meaning
2437 changes - now IV and NV together means that the two are interchangeable:
28e5dec8 2438 SvIVX == (IV) SvNVX && SvNVX == (NV) SvIVX;
d460ef45 2439
645c22ef
DM
2440 The benefit of this is that operations such as pp_add know that if
2441 SvIOK is true for both left and right operands, then integer addition
2442 can be used instead of floating point (for cases where the result won't
2443 overflow). Before, floating point was always used, which could lead to
28e5dec8
JH
2444 loss of precision compared with integer addition.
2445
2446 * making IV and NV equal status should make maths accurate on 64 bit
2447 platforms
2448 * may speed up maths somewhat if pp_add and friends start to use
645c22ef 2449 integers when possible instead of fp. (Hopefully the overhead in
28e5dec8
JH
2450 looking for SvIOK and checking for overflow will not outweigh the
2451 fp to integer speedup)
2452 * will slow down integer operations (callers of SvIV) on "inaccurate"
2453 values, as the change from SvIOK to SvIOKp will cause a call into
2454 sv_2iv each time rather than a macro access direct to the IV slot
2455 * should speed up number->string conversion on integers as IV is
645c22ef 2456 favoured when IV and NV are equally accurate
28e5dec8
JH
2457
2458 ####################################################################
645c22ef
DM
2459 You had better be using SvIOK_notUV if you want an IV for arithmetic:
2460 SvIOK is true if (IV or UV), so you might be getting (IV)SvUV.
2461 On the other hand, SvUOK is true iff UV.
28e5dec8
JH
2462 ####################################################################
2463
645c22ef 2464 Your mileage will vary depending your CPU's relative fp to integer
28e5dec8
JH
2465 performance ratio.
2466*/
2467
2468#ifndef NV_PRESERVES_UV
645c22ef
DM
2469# define IS_NUMBER_UNDERFLOW_IV 1
2470# define IS_NUMBER_UNDERFLOW_UV 2
2471# define IS_NUMBER_IV_AND_UV 2
2472# define IS_NUMBER_OVERFLOW_IV 4
2473# define IS_NUMBER_OVERFLOW_UV 5
2474
2475/* sv_2iuv_non_preserve(): private routine for use by sv_2iv() and sv_2uv() */
28e5dec8
JH
2476
2477/* For sv_2nv these three cases are "SvNOK and don't bother casting" */
2478STATIC int
645c22ef 2479S_sv_2iuv_non_preserve(pTHX_ register SV *sv, I32 numtype)
28e5dec8 2480{
1779d84d 2481 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
2482 if (SvNVX(sv) < (NV)IV_MIN) {
2483 (void)SvIOKp_on(sv);
2484 (void)SvNOK_on(sv);
2485 SvIVX(sv) = IV_MIN;
2486 return IS_NUMBER_UNDERFLOW_IV;
2487 }
2488 if (SvNVX(sv) > (NV)UV_MAX) {
2489 (void)SvIOKp_on(sv);
2490 (void)SvNOK_on(sv);
2491 SvIsUV_on(sv);
2492 SvUVX(sv) = UV_MAX;
2493 return IS_NUMBER_OVERFLOW_UV;
2494 }
c2988b20
NC
2495 (void)SvIOKp_on(sv);
2496 (void)SvNOK_on(sv);
2497 /* Can't use strtol etc to convert this string. (See truth table in
2498 sv_2iv */
2499 if (SvNVX(sv) <= (UV)IV_MAX) {
2500 SvIVX(sv) = I_V(SvNVX(sv));
2501 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2502 SvIOK_on(sv); /* Integer is precise. NOK, IOK */
2503 } else {
2504 /* Integer is imprecise. NOK, IOKp */
2505 }
2506 return SvNVX(sv) < 0 ? IS_NUMBER_UNDERFLOW_UV : IS_NUMBER_IV_AND_UV;
2507 }
2508 SvIsUV_on(sv);
2509 SvUVX(sv) = U_V(SvNVX(sv));
2510 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2511 if (SvUVX(sv) == UV_MAX) {
2512 /* As we know that NVs don't preserve UVs, UV_MAX cannot
2513 possibly be preserved by NV. Hence, it must be overflow.
2514 NOK, IOKp */
2515 return IS_NUMBER_OVERFLOW_UV;
2516 }
2517 SvIOK_on(sv); /* Integer is precise. NOK, UOK */
2518 } else {
2519 /* Integer is imprecise. NOK, IOKp */
28e5dec8 2520 }
c2988b20 2521 return IS_NUMBER_OVERFLOW_IV;
28e5dec8 2522}
645c22ef
DM
2523#endif /* !NV_PRESERVES_UV*/
2524
891f9566
YST
2525/* sv_2iv() is now a macro using Perl_sv_2iv_flags();
2526 * this function provided for binary compatibility only
2527 */
2528
2529IV
2530Perl_sv_2iv(pTHX_ register SV *sv)
2531{
2532 return sv_2iv_flags(sv, SV_GMAGIC);
2533}
2534
645c22ef 2535/*
891f9566 2536=for apidoc sv_2iv_flags
645c22ef 2537
891f9566
YST
2538Return the integer value of an SV, doing any necessary string
2539conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2540Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
645c22ef
DM
2541
2542=cut
2543*/
28e5dec8 2544
a0d0e21e 2545IV
891f9566 2546Perl_sv_2iv_flags(pTHX_ register SV *sv, I32 flags)
79072805
LW
2547{
2548 if (!sv)
2549 return 0;
8990e307 2550 if (SvGMAGICAL(sv)) {
891f9566
YST
2551 if (flags & SV_GMAGIC)
2552 mg_get(sv);
463ee0b2
LW
2553 if (SvIOKp(sv))
2554 return SvIVX(sv);
748a9306 2555 if (SvNOKp(sv)) {
25da4f38 2556 return I_V(SvNVX(sv));
748a9306 2557 }
36477c24 2558 if (SvPOKp(sv) && SvLEN(sv))
2559 return asIV(sv);
3fe9a6f1 2560 if (!SvROK(sv)) {
d008e5eb 2561 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 2562 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
29489e7c 2563 report_uninit(sv);
c6ee37c5 2564 }
36477c24 2565 return 0;
3fe9a6f1 2566 }
463ee0b2 2567 }
ed6116ce 2568 if (SvTHINKFIRST(sv)) {
a0d0e21e 2569 if (SvROK(sv)) {
a0d0e21e 2570 SV* tmpstr;
1554e226 2571 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
b4b9a328 2572 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
9e7bc3e8 2573 return SvIV(tmpstr);
56431972 2574 return PTR2IV(SvRV(sv));
a0d0e21e 2575 }
765f542d
NC
2576 if (SvIsCOW(sv)) {
2577 sv_force_normal_flags(sv, 0);
47deb5e7 2578 }
0336b60e 2579 if (SvREADONLY(sv) && !SvOK(sv)) {
0336b60e 2580 if (ckWARN(WARN_UNINITIALIZED))
29489e7c 2581 report_uninit(sv);
ed6116ce
LW
2582 return 0;
2583 }
79072805 2584 }
25da4f38
IZ
2585 if (SvIOKp(sv)) {
2586 if (SvIsUV(sv)) {
2587 return (IV)(SvUVX(sv));
2588 }
2589 else {
2590 return SvIVX(sv);
2591 }
463ee0b2 2592 }
748a9306 2593 if (SvNOKp(sv)) {
28e5dec8
JH
2594 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2595 * without also getting a cached IV/UV from it at the same time
2596 * (ie PV->NV conversion should detect loss of accuracy and cache
2597 * IV or UV at same time to avoid this. NWC */
25da4f38
IZ
2598
2599 if (SvTYPE(sv) == SVt_NV)
2600 sv_upgrade(sv, SVt_PVNV);
2601
28e5dec8
JH
2602 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2603 /* < not <= as for NV doesn't preserve UV, ((NV)IV_MAX+1) will almost
2604 certainly cast into the IV range at IV_MAX, whereas the correct
2605 answer is the UV IV_MAX +1. Hence < ensures that dodgy boundary
2606 cases go to UV */
2607 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
748a9306 2608 SvIVX(sv) = I_V(SvNVX(sv));
28e5dec8
JH
2609 if (SvNVX(sv) == (NV) SvIVX(sv)
2610#ifndef NV_PRESERVES_UV
2611 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2612 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2613 /* Don't flag it as "accurately an integer" if the number
2614 came from a (by definition imprecise) NV operation, and
2615 we're outside the range of NV integer precision */
2616#endif
2617 ) {
2618 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2619 DEBUG_c(PerlIO_printf(Perl_debug_log,
7234c960 2620 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (precise)\n",
28e5dec8
JH
2621 PTR2UV(sv),
2622 SvNVX(sv),
2623 SvIVX(sv)));
2624
2625 } else {
2626 /* IV not precise. No need to convert from PV, as NV
2627 conversion would already have cached IV if it detected
2628 that PV->IV would be better than PV->NV->IV
2629 flags already correct - don't set public IOK. */
2630 DEBUG_c(PerlIO_printf(Perl_debug_log,
7234c960 2631 "0x%"UVxf" iv(%"NVgf" => %"IVdf") (imprecise)\n",
28e5dec8
JH
2632 PTR2UV(sv),
2633 SvNVX(sv),
2634 SvIVX(sv)));
2635 }
2636 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2637 but the cast (NV)IV_MIN rounds to a the value less (more
2638 negative) than IV_MIN which happens to be equal to SvNVX ??
2639 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2640 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2641 (NV)UVX == NVX are both true, but the values differ. :-(
2642 Hopefully for 2s complement IV_MIN is something like
2643 0x8000000000000000 which will be exact. NWC */
d460ef45 2644 }
25da4f38 2645 else {
ff68c719 2646 SvUVX(sv) = U_V(SvNVX(sv));
28e5dec8
JH
2647 if (
2648 (SvNVX(sv) == (NV) SvUVX(sv))
2649#ifndef NV_PRESERVES_UV
2650 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2651 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2652 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2653 /* Don't flag it as "accurately an integer" if the number
2654 came from a (by definition imprecise) NV operation, and
2655 we're outside the range of NV integer precision */
2656#endif
2657 )
2658 SvIOK_on(sv);
25da4f38
IZ
2659 SvIsUV_on(sv);
2660 ret_iv_max:
1c846c1f 2661 DEBUG_c(PerlIO_printf(Perl_debug_log,
57def98f 2662 "0x%"UVxf" 2iv(%"UVuf" => %"IVdf") (as unsigned)\n",
56431972 2663 PTR2UV(sv),
57def98f
JH
2664 SvUVX(sv),
2665 SvUVX(sv)));
25da4f38
IZ
2666 return (IV)SvUVX(sv);
2667 }
748a9306
LW
2668 }
2669 else if (SvPOKp(sv) && SvLEN(sv)) {
c2988b20
NC
2670 UV value;
2671 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
25da4f38
IZ
2672 /* We want to avoid a possible problem when we cache an IV which
2673 may be later translated to an NV, and the resulting NV is not
c2988b20
NC
2674 the same as the direct translation of the initial string
2675 (eg 123.456 can shortcut to the IV 123 with atol(), but we must
2676 be careful to ensure that the value with the .456 is around if the
2677 NV value is requested in the future).
1c846c1f 2678
25da4f38
IZ
2679 This means that if we cache such an IV, we need to cache the
2680 NV as well. Moreover, we trade speed for space, and do not
28e5dec8 2681 cache the NV if we are sure it's not needed.
25da4f38 2682 */
16b7a9a4 2683
c2988b20
NC
2684 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2685 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2686 == IS_NUMBER_IN_UV) {
5e045b90 2687 /* It's definitely an integer, only upgrade to PVIV */
28e5dec8
JH
2688 if (SvTYPE(sv) < SVt_PVIV)
2689 sv_upgrade(sv, SVt_PVIV);
f7bbb42a 2690 (void)SvIOK_on(sv);
c2988b20
NC
2691 } else if (SvTYPE(sv) < SVt_PVNV)
2692 sv_upgrade(sv, SVt_PVNV);
28e5dec8 2693
c2988b20
NC
2694 /* If NV preserves UV then we only use the UV value if we know that
2695 we aren't going to call atof() below. If NVs don't preserve UVs
2696 then the value returned may have more precision than atof() will
2697 return, even though value isn't perfectly accurate. */
2698 if ((numtype & (IS_NUMBER_IN_UV
2699#ifdef NV_PRESERVES_UV
2700 | IS_NUMBER_NOT_INT
2701#endif
2702 )) == IS_NUMBER_IN_UV) {
2703 /* This won't turn off the public IOK flag if it was set above */
2704 (void)SvIOKp_on(sv);
2705
2706 if (!(numtype & IS_NUMBER_NEG)) {
2707 /* positive */;
2708 if (value <= (UV)IV_MAX) {
2709 SvIVX(sv) = (IV)value;
2710 } else {
2711 SvUVX(sv) = value;
2712 SvIsUV_on(sv);
2713 }
2714 } else {
2715 /* 2s complement assumption */
2716 if (value <= (UV)IV_MIN) {
2717 SvIVX(sv) = -(IV)value;
2718 } else {
2719 /* Too negative for an IV. This is a double upgrade, but
d1be9408 2720 I'm assuming it will be rare. */
c2988b20
NC
2721 if (SvTYPE(sv) < SVt_PVNV)
2722 sv_upgrade(sv, SVt_PVNV);
2723 SvNOK_on(sv);
2724 SvIOK_off(sv);
2725 SvIOKp_on(sv);
2726 SvNVX(sv) = -(NV)value;
2727 SvIVX(sv) = IV_MIN;
2728 }
2729 }
2730 }
2731 /* For !NV_PRESERVES_UV and IS_NUMBER_IN_UV and IS_NUMBER_NOT_INT we
2732 will be in the previous block to set the IV slot, and the next
2733 block to set the NV slot. So no else here. */
2734
2735 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2736 != IS_NUMBER_IN_UV) {
2737 /* It wasn't an (integer that doesn't overflow the UV). */
2738 SvNVX(sv) = Atof(SvPVX(sv));
28e5dec8 2739
c2988b20
NC
2740 if (! numtype && ckWARN(WARN_NUMERIC))
2741 not_a_number(sv);
28e5dec8 2742
65202027 2743#if defined(USE_LONG_DOUBLE)
c2988b20
NC
2744 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%" PERL_PRIgldbl ")\n",
2745 PTR2UV(sv), SvNVX(sv)));
65202027 2746#else
1779d84d 2747 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"NVgf")\n",
c2988b20 2748 PTR2UV(sv), SvNVX(sv)));
65202027 2749#endif
28e5dec8
JH
2750
2751
2752#ifdef NV_PRESERVES_UV
c2988b20
NC
2753 (void)SvIOKp_on(sv);
2754 (void)SvNOK_on(sv);
2755 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
2756 SvIVX(sv) = I_V(SvNVX(sv));
2757 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
2758 SvIOK_on(sv);
28e5dec8 2759 } else {
c2988b20
NC
2760 /* Integer is imprecise. NOK, IOKp */
2761 }
2762 /* UV will not work better than IV */
2763 } else {
2764 if (SvNVX(sv) > (NV)UV_MAX) {
2765 SvIsUV_on(sv);
2766 /* Integer is inaccurate. NOK, IOKp, is UV */
2767 SvUVX(sv) = UV_MAX;
2768 SvIsUV_on(sv);
2769 } else {
2770 SvUVX(sv) = U_V(SvNVX(sv));
2771 /* 0xFFFFFFFFFFFFFFFF not an issue in here */
2772 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
2773 SvIOK_on(sv);
28e5dec8
JH
2774 SvIsUV_on(sv);
2775 } else {
c2988b20
NC
2776 /* Integer is imprecise. NOK, IOKp, is UV */
2777 SvIsUV_on(sv);
28e5dec8 2778 }
28e5dec8 2779 }
c2988b20
NC
2780 goto ret_iv_max;
2781 }
28e5dec8 2782#else /* NV_PRESERVES_UV */
c2988b20
NC
2783 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2784 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
2785 /* The IV slot will have been set from value returned by
2786 grok_number above. The NV slot has just been set using
2787 Atof. */
560b0c46 2788 SvNOK_on(sv);
c2988b20
NC
2789 assert (SvIOKp(sv));
2790 } else {
2791 if (((UV)1 << NV_PRESERVES_UV_BITS) >
2792 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
2793 /* Small enough to preserve all bits. */
2794 (void)SvIOKp_on(sv);
2795 SvNOK_on(sv);
2796 SvIVX(sv) = I_V(SvNVX(sv));
2797 if ((NV)(SvIVX(sv)) == SvNVX(sv))
2798 SvIOK_on(sv);
2799 /* Assumption: first non-preserved integer is < IV_MAX,
2800 this NV is in the preserved range, therefore: */
2801 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
2802 < (UV)IV_MAX)) {
32fdb065 2803 Perl_croak(aTHX_ "sv_2iv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
c2988b20
NC
2804 }
2805 } else {
2806 /* IN_UV NOT_INT
2807 0 0 already failed to read UV.
2808 0 1 already failed to read UV.
2809 1 0 you won't get here in this case. IV/UV
2810 slot set, public IOK, Atof() unneeded.
2811 1 1 already read UV.
2812 so there's no point in sv_2iuv_non_preserve() attempting
2813 to use atol, strtol, strtoul etc. */
2814 if (sv_2iuv_non_preserve (sv, numtype)
2815 >= IS_NUMBER_OVERFLOW_IV)
2816 goto ret_iv_max;
2817 }
2818 }
28e5dec8 2819#endif /* NV_PRESERVES_UV */
25da4f38 2820 }
28e5dec8 2821 } else {
599cee73 2822 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
29489e7c 2823 report_uninit(sv);
25da4f38
IZ
2824 if (SvTYPE(sv) < SVt_IV)
2825 /* Typically the caller expects that sv_any is not NULL now. */
2826 sv_upgrade(sv, SVt_IV);
a0d0e21e 2827 return 0;
79072805 2828 }
1d7c1841
GS
2829 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2iv(%"IVdf")\n",
2830 PTR2UV(sv),SvIVX(sv)));
25da4f38 2831 return SvIsUV(sv) ? (IV)SvUVX(sv) : SvIVX(sv);
79072805
LW
2832}
2833
891f9566
YST
2834/* sv_2uv() is now a macro using Perl_sv_2uv_flags();
2835 * this function provided for binary compatibility only
2836 */
2837
2838UV
2839Perl_sv_2uv(pTHX_ register SV *sv)
2840{
2841 return sv_2uv_flags(sv, SV_GMAGIC);
2842}
2843
645c22ef 2844/*
891f9566 2845=for apidoc sv_2uv_flags
645c22ef
DM
2846
2847Return the unsigned integer value of an SV, doing any necessary string
891f9566
YST
2848conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2849Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
645c22ef
DM
2850
2851=cut
2852*/
2853
ff68c719 2854UV
891f9566 2855Perl_sv_2uv_flags(pTHX_ register SV *sv, I32 flags)
ff68c719 2856{
2857 if (!sv)
2858 return 0;
2859 if (SvGMAGICAL(sv)) {
891f9566
YST
2860 if (flags & SV_GMAGIC)
2861 mg_get(sv);
ff68c719 2862 if (SvIOKp(sv))
2863 return SvUVX(sv);
2864 if (SvNOKp(sv))
2865 return U_V(SvNVX(sv));
36477c24 2866 if (SvPOKp(sv) && SvLEN(sv))
2867 return asUV(sv);
3fe9a6f1 2868 if (!SvROK(sv)) {
d008e5eb 2869 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 2870 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
29489e7c 2871 report_uninit(sv);
c6ee37c5 2872 }
36477c24 2873 return 0;
3fe9a6f1 2874 }
ff68c719 2875 }
2876 if (SvTHINKFIRST(sv)) {
2877 if (SvROK(sv)) {
ff68c719 2878 SV* tmpstr;
1554e226 2879 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
b4b9a328 2880 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
9e7bc3e8 2881 return SvUV(tmpstr);
56431972 2882 return PTR2UV(SvRV(sv));
ff68c719 2883 }
765f542d
NC
2884 if (SvIsCOW(sv)) {
2885 sv_force_normal_flags(sv, 0);
8a818333 2886 }
0336b60e 2887 if (SvREADONLY(sv) && !SvOK(sv)) {
0336b60e 2888 if (ckWARN(WARN_UNINITIALIZED))
29489e7c 2889 report_uninit(sv);
ff68c719 2890 return 0;
2891 }
2892 }
25da4f38
IZ
2893 if (SvIOKp(sv)) {
2894 if (SvIsUV(sv)) {
2895 return SvUVX(sv);
2896 }
2897 else {
2898 return (UV)SvIVX(sv);
2899 }
ff68c719 2900 }
2901 if (SvNOKp(sv)) {
28e5dec8
JH
2902 /* erm. not sure. *should* never get NOKp (without NOK) from sv_2nv
2903 * without also getting a cached IV/UV from it at the same time
2904 * (ie PV->NV conversion should detect loss of accuracy and cache
2905 * IV or UV at same time to avoid this. */
2906 /* IV-over-UV optimisation - choose to cache IV if possible */
2907
25da4f38
IZ
2908 if (SvTYPE(sv) == SVt_NV)
2909 sv_upgrade(sv, SVt_PVNV);
28e5dec8
JH
2910
2911 (void)SvIOKp_on(sv); /* Must do this first, to clear any SvOOK */
2912 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
f7bbb42a 2913 SvIVX(sv) = I_V(SvNVX(sv));
28e5dec8
JH
2914 if (SvNVX(sv) == (NV) SvIVX(sv)
2915#ifndef NV_PRESERVES_UV
2916 && (((UV)1 << NV_PRESERVES_UV_BITS) >
2917 (UV)(SvIVX(sv) > 0 ? SvIVX(sv) : -SvIVX(sv)))
2918 /* Don't flag it as "accurately an integer" if the number
2919 came from a (by definition imprecise) NV operation, and
2920 we're outside the range of NV integer precision */
2921#endif
2922 ) {
2923 SvIOK_on(sv); /* Can this go wrong with rounding? NWC */
2924 DEBUG_c(PerlIO_printf(Perl_debug_log,
7234c960 2925 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (precise)\n",
28e5dec8
JH
2926 PTR2UV(sv),
2927 SvNVX(sv),
2928 SvIVX(sv)));
2929
2930 } else {
2931 /* IV not precise. No need to convert from PV, as NV
2932 conversion would already have cached IV if it detected
2933 that PV->IV would be better than PV->NV->IV
2934 flags already correct - don't set public IOK. */
2935 DEBUG_c(PerlIO_printf(Perl_debug_log,
7234c960 2936 "0x%"UVxf" uv(%"NVgf" => %"IVdf") (imprecise)\n",
28e5dec8
JH
2937 PTR2UV(sv),
2938 SvNVX(sv),
2939 SvIVX(sv)));
2940 }
2941 /* Can the above go wrong if SvIVX == IV_MIN and SvNVX < IV_MIN,
2942 but the cast (NV)IV_MIN rounds to a the value less (more
2943 negative) than IV_MIN which happens to be equal to SvNVX ??
2944 Analogous to 0xFFFFFFFFFFFFFFFF rounding up to NV (2**64) and
2945 NV rounding back to 0xFFFFFFFFFFFFFFFF, so UVX == UV(NVX) and
2946 (NV)UVX == NVX are both true, but the values differ. :-(
2947 Hopefully for 2s complement IV_MIN is something like
2948 0x8000000000000000 which will be exact. NWC */
d460ef45 2949 }
28e5dec8
JH
2950 else {
2951 SvUVX(sv) = U_V(SvNVX(sv));
2952 if (
2953 (SvNVX(sv) == (NV) SvUVX(sv))
2954#ifndef NV_PRESERVES_UV
2955 /* Make sure it's not 0xFFFFFFFFFFFFFFFF */
2956 /*&& (SvUVX(sv) != UV_MAX) irrelevant with code below */
2957 && (((UV)1 << NV_PRESERVES_UV_BITS) > SvUVX(sv))
2958 /* Don't flag it as "accurately an integer" if the number
2959 came from a (by definition imprecise) NV operation, and
2960 we're outside the range of NV integer precision */
2961#endif
2962 )
2963 SvIOK_on(sv);
2964 SvIsUV_on(sv);
1c846c1f 2965 DEBUG_c(PerlIO_printf(Perl_debug_log,
28e5dec8 2966 "0x%"UVxf" 2uv(%"UVuf" => %"IVdf") (as unsigned)\n",
57def98f 2967 PTR2UV(sv),
28e5dec8
JH
2968 SvUVX(sv),
2969 SvUVX(sv)));
25da4f38 2970 }
ff68c719 2971 }
2972 else if (SvPOKp(sv) && SvLEN(sv)) {
c2988b20
NC
2973 UV value;
2974 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
25da4f38
IZ
2975
2976 /* We want to avoid a possible problem when we cache a UV which
2977 may be later translated to an NV, and the resulting NV is not
2978 the translation of the initial data.
1c846c1f 2979
25da4f38
IZ
2980 This means that if we cache such a UV, we need to cache the
2981 NV as well. Moreover, we trade speed for space, and do not
2982 cache the NV if not needed.
2983 */
16b7a9a4 2984
c2988b20
NC
2985 /* SVt_PVNV is one higher than SVt_PVIV, hence this order */
2986 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
2987 == IS_NUMBER_IN_UV) {
5e045b90 2988 /* It's definitely an integer, only upgrade to PVIV */
28e5dec8 2989 if (SvTYPE(sv) < SVt_PVIV)
f7bbb42a
JH
2990 sv_upgrade(sv, SVt_PVIV);
2991 (void)SvIOK_on(sv);
c2988b20
NC
2992 } else if (SvTYPE(sv) < SVt_PVNV)
2993 sv_upgrade(sv, SVt_PVNV);
d460ef45 2994
c2988b20
NC
2995 /* If NV preserves UV then we only use the UV value if we know that
2996 we aren't going to call atof() below. If NVs don't preserve UVs
2997 then the value returned may have more precision than atof() will
2998 return, even though it isn't accurate. */
2999 if ((numtype & (IS_NUMBER_IN_UV
3000#ifdef NV_PRESERVES_UV
3001 | IS_NUMBER_NOT_INT
3002#endif
3003 )) == IS_NUMBER_IN_UV) {
3004 /* This won't turn off the public IOK flag if it was set above */
3005 (void)SvIOKp_on(sv);
3006
3007 if (!(numtype & IS_NUMBER_NEG)) {
3008 /* positive */;
3009 if (value <= (UV)IV_MAX) {
3010 SvIVX(sv) = (IV)value;
28e5dec8
JH
3011 } else {
3012 /* it didn't overflow, and it was positive. */
c2988b20 3013 SvUVX(sv) = value;
28e5dec8
JH
3014 SvIsUV_on(sv);
3015 }
c2988b20
NC
3016 } else {
3017 /* 2s complement assumption */
3018 if (value <= (UV)IV_MIN) {
3019 SvIVX(sv) = -(IV)value;
3020 } else {
3021 /* Too negative for an IV. This is a double upgrade, but
d1be9408 3022 I'm assuming it will be rare. */
c2988b20
NC
3023 if (SvTYPE(sv) < SVt_PVNV)
3024 sv_upgrade(sv, SVt_PVNV);
3025 SvNOK_on(sv);
3026 SvIOK_off(sv);
3027 SvIOKp_on(sv);
3028 SvNVX(sv) = -(NV)value;
3029 SvIVX(sv) = IV_MIN;
3030 }
3031 }
3032 }
3033
3034 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3035 != IS_NUMBER_IN_UV) {
3036 /* It wasn't an integer, or it overflowed the UV. */
3037 SvNVX(sv) = Atof(SvPVX(sv));
28e5dec8 3038
c2988b20 3039 if (! numtype && ckWARN(WARN_NUMERIC))
28e5dec8
JH
3040 not_a_number(sv);
3041
3042#if defined(USE_LONG_DOUBLE)
c2988b20
NC
3043 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%" PERL_PRIgldbl ")\n",
3044 PTR2UV(sv), SvNVX(sv)));
28e5dec8 3045#else
1779d84d 3046 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"NVgf")\n",
c2988b20 3047 PTR2UV(sv), SvNVX(sv)));
28e5dec8
JH
3048#endif
3049
3050#ifdef NV_PRESERVES_UV
c2988b20
NC
3051 (void)SvIOKp_on(sv);
3052 (void)SvNOK_on(sv);
3053 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3054 SvIVX(sv) = I_V(SvNVX(sv));
3055 if ((NV)(SvIVX(sv)) == SvNVX(sv)) {
3056 SvIOK_on(sv);
3057 } else {
3058 /* Integer is imprecise. NOK, IOKp */
3059 }
3060 /* UV will not work better than IV */
3061 } else {
3062 if (SvNVX(sv) > (NV)UV_MAX) {
3063 SvIsUV_on(sv);
3064 /* Integer is inaccurate. NOK, IOKp, is UV */
3065 SvUVX(sv) = UV_MAX;
3066 SvIsUV_on(sv);
3067 } else {
3068 SvUVX(sv) = U_V(SvNVX(sv));
3069 /* 0xFFFFFFFFFFFFFFFF not an issue in here, NVs
3070 NV preservse UV so can do correct comparison. */
3071 if ((NV)(SvUVX(sv)) == SvNVX(sv)) {
3072 SvIOK_on(sv);
3073 SvIsUV_on(sv);
3074 } else {
3075 /* Integer is imprecise. NOK, IOKp, is UV */
3076 SvIsUV_on(sv);
3077 }
3078 }
3079 }
28e5dec8 3080#else /* NV_PRESERVES_UV */
c2988b20
NC
3081 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3082 == (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT)) {
3083 /* The UV slot will have been set from value returned by
3084 grok_number above. The NV slot has just been set using
3085 Atof. */
560b0c46 3086 SvNOK_on(sv);
c2988b20
NC
3087 assert (SvIOKp(sv));
3088 } else {
3089 if (((UV)1 << NV_PRESERVES_UV_BITS) >
3090 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
3091 /* Small enough to preserve all bits. */
3092 (void)SvIOKp_on(sv);
3093 SvNOK_on(sv);
3094 SvIVX(sv) = I_V(SvNVX(sv));
3095 if ((NV)(SvIVX(sv)) == SvNVX(sv))
3096 SvIOK_on(sv);
3097 /* Assumption: first non-preserved integer is < IV_MAX,
3098 this NV is in the preserved range, therefore: */
3099 if (!(U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))
3100 < (UV)IV_MAX)) {
32fdb065 3101 Perl_croak(aTHX_ "sv_2uv assumed (U_V(fabs((double)SvNVX(sv))) < (UV)IV_MAX) but SvNVX(sv)=%"NVgf" U_V is 0x%"UVxf", IV_MAX is 0x%"UVxf"\n", SvNVX(sv), U_V(SvNVX(sv)), (UV)IV_MAX);
c2988b20
NC
3102 }
3103 } else
3104 sv_2iuv_non_preserve (sv, numtype);
3105 }
28e5dec8 3106#endif /* NV_PRESERVES_UV */
f7bbb42a 3107 }
ff68c719 3108 }
3109 else {
d008e5eb 3110 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 3111 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
29489e7c 3112 report_uninit(sv);
c6ee37c5 3113 }
25da4f38
IZ
3114 if (SvTYPE(sv) < SVt_IV)
3115 /* Typically the caller expects that sv_any is not NULL now. */
3116 sv_upgrade(sv, SVt_IV);
ff68c719 3117 return 0;
3118 }
25da4f38 3119
1d7c1841
GS
3120 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2uv(%"UVuf")\n",
3121 PTR2UV(sv),SvUVX(sv)));
25da4f38 3122 return SvIsUV(sv) ? SvUVX(sv) : (UV)SvIVX(sv);
ff68c719 3123}
3124
645c22ef
DM
3125/*
3126=for apidoc sv_2nv
3127
3128Return the num value of an SV, doing any necessary string or integer
3129conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3130macros.
3131
3132=cut
3133*/
3134
65202027 3135NV
864dbfa3 3136Perl_sv_2nv(pTHX_ register SV *sv)
79072805
LW
3137{
3138 if (!sv)
3139 return 0.0;
8990e307 3140 if (SvGMAGICAL(sv)) {
463ee0b2
LW
3141 mg_get(sv);
3142 if (SvNOKp(sv))
3143 return SvNVX(sv);
a0d0e21e 3144 if (SvPOKp(sv) && SvLEN(sv)) {
c2988b20
NC
3145 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) &&
3146 !grok_number(SvPVX(sv), SvCUR(sv), NULL))
a0d0e21e 3147 not_a_number(sv);
097ee67d 3148 return Atof(SvPVX(sv));
a0d0e21e 3149 }
25da4f38 3150 if (SvIOKp(sv)) {
1c846c1f 3151 if (SvIsUV(sv))
65202027 3152 return (NV)SvUVX(sv);
25da4f38 3153 else
65202027 3154 return (NV)SvIVX(sv);
25da4f38 3155 }
16d20bd9 3156 if (!SvROK(sv)) {
d008e5eb 3157 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 3158 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
29489e7c 3159 report_uninit(sv);
c6ee37c5 3160 }
16d20bd9
AD
3161 return 0;
3162 }
463ee0b2 3163 }
ed6116ce 3164 if (SvTHINKFIRST(sv)) {
a0d0e21e 3165 if (SvROK(sv)) {
a0d0e21e 3166 SV* tmpstr;
1554e226 3167 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,numer)) &&
b4b9a328 3168 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv))))
9e7bc3e8 3169 return SvNV(tmpstr);
56431972 3170 return PTR2NV(SvRV(sv));
a0d0e21e 3171 }
765f542d
NC
3172 if (SvIsCOW(sv)) {
3173 sv_force_normal_flags(sv, 0);
8a818333 3174 }
0336b60e 3175 if (SvREADONLY(sv) && !SvOK(sv)) {
599cee73 3176 if (ckWARN(WARN_UNINITIALIZED))
29489e7c 3177 report_uninit(sv);
ed6116ce
LW
3178 return 0.0;
3179 }
79072805
LW
3180 }
3181 if (SvTYPE(sv) < SVt_NV) {
463ee0b2
LW
3182 if (SvTYPE(sv) == SVt_IV)
3183 sv_upgrade(sv, SVt_PVNV);
3184 else
3185 sv_upgrade(sv, SVt_NV);
906f284f 3186#ifdef USE_LONG_DOUBLE
097ee67d 3187 DEBUG_c({
f93f4e46 3188 STORE_NUMERIC_LOCAL_SET_STANDARD();
1d7c1841
GS
3189 PerlIO_printf(Perl_debug_log,
3190 "0x%"UVxf" num(%" PERL_PRIgldbl ")\n",
3191 PTR2UV(sv), SvNVX(sv));
572bbb43
GS
3192 RESTORE_NUMERIC_LOCAL();
3193 });
65202027 3194#else
572bbb43 3195 DEBUG_c({
f93f4e46 3196 STORE_NUMERIC_LOCAL_SET_STANDARD();
1779d84d 3197 PerlIO_printf(Perl_debug_log, "0x%"UVxf" num(%"NVgf")\n",
1d7c1841 3198 PTR2UV(sv), SvNVX(sv));
097ee67d
JH
3199 RESTORE_NUMERIC_LOCAL();
3200 });
572bbb43 3201#endif
79072805
LW
3202 }
3203 else if (SvTYPE(sv) < SVt_PVNV)
3204 sv_upgrade(sv, SVt_PVNV);
59d8ce62
NC
3205 if (SvNOKp(sv)) {
3206 return SvNVX(sv);
61604483 3207 }
59d8ce62 3208 if (SvIOKp(sv)) {
65202027 3209 SvNVX(sv) = SvIsUV(sv) ? (NV)SvUVX(sv) : (NV)SvIVX(sv);
28e5dec8
JH
3210#ifdef NV_PRESERVES_UV
3211 SvNOK_on(sv);
3212#else
3213 /* Only set the public NV OK flag if this NV preserves the IV */
3214 /* Check it's not 0xFFFFFFFFFFFFFFFF */
3215 if (SvIsUV(sv) ? ((SvUVX(sv) != UV_MAX)&&(SvUVX(sv) == U_V(SvNVX(sv))))
3216 : (SvIVX(sv) == I_V(SvNVX(sv))))
3217 SvNOK_on(sv);
3218 else
3219 SvNOKp_on(sv);
3220#endif
93a17b20 3221 }
748a9306 3222 else if (SvPOKp(sv) && SvLEN(sv)) {
c2988b20
NC
3223 UV value;
3224 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3225 if (ckWARN(WARN_NUMERIC) && !SvIOKp(sv) && !numtype)
a0d0e21e 3226 not_a_number(sv);
28e5dec8 3227#ifdef NV_PRESERVES_UV
c2988b20
NC
3228 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3229 == IS_NUMBER_IN_UV) {
5e045b90 3230 /* It's definitely an integer */
c2988b20
NC
3231 SvNVX(sv) = (numtype & IS_NUMBER_NEG) ? -(NV)value : (NV)value;
3232 } else
3233 SvNVX(sv) = Atof(SvPVX(sv));
28e5dec8
JH
3234 SvNOK_on(sv);
3235#else
c2988b20 3236 SvNVX(sv) = Atof(SvPVX(sv));
28e5dec8
JH
3237 /* Only set the public NV OK flag if this NV preserves the value in
3238 the PV at least as well as an IV/UV would.
3239 Not sure how to do this 100% reliably. */
3240 /* if that shift count is out of range then Configure's test is
3241 wonky. We shouldn't be in here with NV_PRESERVES_UV_BITS ==
3242 UV_BITS */
3243 if (((UV)1 << NV_PRESERVES_UV_BITS) >
c2988b20 3244 U_V(SvNVX(sv) > 0 ? SvNVX(sv) : -SvNVX(sv))) {
28e5dec8 3245 SvNOK_on(sv); /* Definitely small enough to preserve all bits */
c2988b20
NC
3246 } else if (!(numtype & IS_NUMBER_IN_UV)) {
3247 /* Can't use strtol etc to convert this string, so don't try.
3248 sv_2iv and sv_2uv will use the NV to convert, not the PV. */
3249 SvNOK_on(sv);
3250 } else {
3251 /* value has been set. It may not be precise. */
3252 if ((numtype & IS_NUMBER_NEG) && (value > (UV)IV_MIN)) {
3253 /* 2s complement assumption for (UV)IV_MIN */
3254 SvNOK_on(sv); /* Integer is too negative. */
3255 } else {
3256 SvNOKp_on(sv);
3257 SvIOKp_on(sv);
6fa402ec 3258
c2988b20
NC
3259 if (numtype & IS_NUMBER_NEG) {
3260 SvIVX(sv) = -(IV)value;
3261 } else if (value <= (UV)IV_MAX) {
3262 SvIVX(sv) = (IV)value;
3263 } else {
3264 SvUVX(sv) = value;
3265 SvIsUV_on(sv);
3266 }
3267
3268 if (numtype & IS_NUMBER_NOT_INT) {
3269 /* I believe that even if the original PV had decimals,
3270 they are lost beyond the limit of the FP precision.
3271 However, neither is canonical, so both only get p
3272 flags. NWC, 2000/11/25 */
3273 /* Both already have p flags, so do nothing */
3274 } else {
3275 NV nv = SvNVX(sv);
3276 if (SvNVX(sv) < (NV)IV_MAX + 0.5) {
3277 if (SvIVX(sv) == I_V(nv)) {
3278 SvNOK_on(sv);
3279 SvIOK_on(sv);
3280 } else {
3281 SvIOK_on(sv);
3282 /* It had no "." so it must be integer. */
3283 }
3284 } else {
3285 /* between IV_MAX and NV(UV_MAX).
3286 Could be slightly > UV_MAX */
6fa402ec 3287
c2988b20
NC
3288 if (numtype & IS_NUMBER_NOT_INT) {
3289 /* UV and NV both imprecise. */
3290 } else {
3291 UV nv_as_uv = U_V(nv);
3292
3293 if (value == nv_as_uv && SvUVX(sv) != UV_MAX) {
3294 SvNOK_on(sv);
3295 SvIOK_on(sv);
3296 } else {
3297 SvIOK_on(sv);
3298 }
3299 }
3300 }
3301 }
3302 }
3303 }
28e5dec8 3304#endif /* NV_PRESERVES_UV */
93a17b20 3305 }
79072805 3306 else {
599cee73 3307 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
29489e7c 3308 report_uninit(sv);
25da4f38
IZ
3309 if (SvTYPE(sv) < SVt_NV)
3310 /* Typically the caller expects that sv_any is not NULL now. */
28e5dec8
JH
3311 /* XXX Ilya implies that this is a bug in callers that assume this
3312 and ideally should be fixed. */
25da4f38 3313 sv_upgrade(sv, SVt_NV);
a0d0e21e 3314 return 0.0;
79072805 3315 }
572bbb43 3316#if defined(USE_LONG_DOUBLE)
097ee67d 3317 DEBUG_c({
f93f4e46 3318 STORE_NUMERIC_LOCAL_SET_STANDARD();
1d7c1841
GS
3319 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2nv(%" PERL_PRIgldbl ")\n",
3320 PTR2UV(sv), SvNVX(sv));
572bbb43
GS
3321 RESTORE_NUMERIC_LOCAL();
3322 });
65202027 3323#else
572bbb43 3324 DEBUG_c({
f93f4e46 3325 STORE_NUMERIC_LOCAL_SET_STANDARD();
1779d84d 3326 PerlIO_printf(Perl_debug_log, "0x%"UVxf" 1nv(%"NVgf")\n",
1d7c1841 3327 PTR2UV(sv), SvNVX(sv));
097ee67d
JH
3328 RESTORE_NUMERIC_LOCAL();
3329 });
572bbb43 3330#endif
463ee0b2 3331 return SvNVX(sv);
79072805
LW
3332}
3333
645c22ef
DM
3334/* asIV(): extract an integer from the string value of an SV.
3335 * Caller must validate PVX */
3336
76e3520e 3337STATIC IV
cea2e8a9 3338S_asIV(pTHX_ SV *sv)
36477c24 3339{
c2988b20
NC
3340 UV value;
3341 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
3342
3343 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3344 == IS_NUMBER_IN_UV) {
645c22ef 3345 /* It's definitely an integer */
c2988b20
NC
3346 if (numtype & IS_NUMBER_NEG) {
3347 if (value < (UV)IV_MIN)
3348 return -(IV)value;
3349 } else {
3350 if (value < (UV)IV_MAX)
3351 return (IV)value;
3352 }
3353 }
d008e5eb 3354 if (!numtype) {
d008e5eb
GS
3355 if (ckWARN(WARN_NUMERIC))
3356 not_a_number(sv);
3357 }
c2988b20 3358 return I_V(Atof(SvPVX(sv)));
36477c24 3359}
3360
645c22ef
DM
3361/* asUV(): extract an unsigned integer from the string value of an SV
3362 * Caller must validate PVX */
3363
76e3520e 3364STATIC UV
cea2e8a9 3365S_asUV(pTHX_ SV *sv)
36477c24 3366{
c2988b20
NC
3367 UV value;
3368 int numtype = grok_number(SvPVX(sv), SvCUR(sv), &value);
36477c24 3369
c2988b20
NC
3370 if ((numtype & (IS_NUMBER_IN_UV | IS_NUMBER_NOT_INT))
3371 == IS_NUMBER_IN_UV) {
645c22ef 3372 /* It's definitely an integer */
6fa402ec 3373 if (!(numtype & IS_NUMBER_NEG))
c2988b20
NC
3374 return value;
3375 }
d008e5eb 3376 if (!numtype) {
d008e5eb
GS
3377 if (ckWARN(WARN_NUMERIC))
3378 not_a_number(sv);
3379 }
097ee67d 3380 return U_V(Atof(SvPVX(sv)));
36477c24 3381}
3382
645c22ef
DM
3383/*
3384=for apidoc sv_2pv_nolen
3385
3386Like C<sv_2pv()>, but doesn't return the length too. You should usually
3387use the macro wrapper C<SvPV_nolen(sv)> instead.
3388=cut
3389*/
3390
79072805 3391char *
864dbfa3 3392Perl_sv_2pv_nolen(pTHX_ register SV *sv)
1fa8b10d
JD
3393{
3394 STRLEN n_a;
3395 return sv_2pv(sv, &n_a);
3396}
3397
645c22ef
DM
3398/* uiv_2buf(): private routine for use by sv_2pv_flags(): print an IV or
3399 * UV as a string towards the end of buf, and return pointers to start and
3400 * end of it.
3401 *
3402 * We assume that buf is at least TYPE_CHARS(UV) long.
3403 */
3404
864dbfa3 3405static char *
25da4f38
IZ
3406uiv_2buf(char *buf, IV iv, UV uv, int is_uv, char **peob)
3407{
25da4f38
IZ
3408 char *ptr = buf + TYPE_CHARS(UV);
3409 char *ebuf = ptr;
3410 int sign;
25da4f38
IZ
3411
3412 if (is_uv)
3413 sign = 0;
3414 else if (iv >= 0) {
3415 uv = iv;
3416 sign = 0;
3417 } else {
3418 uv = -iv;
3419 sign = 1;
3420 }
3421 do {
eb160463 3422 *--ptr = '0' + (char)(uv % 10);
25da4f38
IZ
3423 } while (uv /= 10);
3424 if (sign)
3425 *--ptr = '-';
3426 *peob = ebuf;
3427 return ptr;
3428}
3429
09540bc3
JH
3430/* sv_2pv() is now a macro using Perl_sv_2pv_flags();
3431 * this function provided for binary compatibility only
3432 */
3433
3434char *
3435Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
3436{
3437 return sv_2pv_flags(sv, lp, SV_GMAGIC);
3438}
3439
645c22ef
DM
3440/*
3441=for apidoc sv_2pv_flags
3442
ff276b08 3443Returns a pointer to the string value of an SV, and sets *lp to its length.
645c22ef
DM
3444If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3445if necessary.
3446Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3447usually end up here too.
3448
3449=cut
3450*/
3451
8d6d96c1
HS
3452char *
3453Perl_sv_2pv_flags(pTHX_ register SV *sv, STRLEN *lp, I32 flags)
3454{
79072805
LW
3455 register char *s;
3456 int olderrno;
cb50f42d 3457 SV *tsv, *origsv;
25da4f38
IZ
3458 char tbuf[64]; /* Must fit sprintf/Gconvert of longest IV/NV */
3459 char *tmpbuf = tbuf;
79072805 3460
463ee0b2
LW
3461 if (!sv) {
3462 *lp = 0;
3463 return "";
3464 }
8990e307 3465 if (SvGMAGICAL(sv)) {
8d6d96c1
HS
3466 if (flags & SV_GMAGIC)
3467 mg_get(sv);
463ee0b2
LW
3468 if (SvPOKp(sv)) {
3469 *lp = SvCUR(sv);
3470 return SvPVX(sv);
3471 }
cf2093f6 3472 if (SvIOKp(sv)) {
1c846c1f 3473 if (SvIsUV(sv))
57def98f 3474 (void)sprintf(tmpbuf,"%"UVuf, (UV)SvUVX(sv));
cf2093f6 3475 else
57def98f 3476 (void)sprintf(tmpbuf,"%"IVdf, (IV)SvIVX(sv));
46fc3d4c 3477 tsv = Nullsv;
a0d0e21e 3478 goto tokensave;
463ee0b2
LW
3479 }
3480 if (SvNOKp(sv)) {
2d4389e4 3481 Gconvert(SvNVX(sv), NV_DIG, 0, tmpbuf);
46fc3d4c 3482 tsv = Nullsv;
a0d0e21e 3483 goto tokensave;
463ee0b2 3484 }
16d20bd9 3485 if (!SvROK(sv)) {
d008e5eb 3486 if (!(SvFLAGS(sv) & SVs_PADTMP)) {
d008e5eb 3487 if (ckWARN(WARN_UNINITIALIZED) && !PL_localizing)
29489e7c 3488 report_uninit(sv);
c6ee37c5 3489 }
16d20bd9
AD
3490 *lp = 0;
3491 return "";
3492 }
463ee0b2 3493 }
ed6116ce
LW
3494 if (SvTHINKFIRST(sv)) {
3495 if (SvROK(sv)) {
a0d0e21e 3496 SV* tmpstr;
1554e226 3497 if (SvAMAGIC(sv) && (tmpstr=AMG_CALLun(sv,string)) &&
b4b9a328 3498 (!SvROK(tmpstr) || (SvRV(tmpstr) != SvRV(sv)))) {
446eaa42
YST
3499 char *pv = SvPV(tmpstr, *lp);
3500 if (SvUTF8(tmpstr))
3501 SvUTF8_on(sv);
3502 else
3503 SvUTF8_off(sv);
3504 return pv;
3505 }
cb50f42d 3506 origsv = sv;
ed6116ce
LW
3507 sv = (SV*)SvRV(sv);
3508 if (!sv)
3509 s = "NULLREF";
3510 else {
f9277f47
IZ
3511 MAGIC *mg;
3512
ed6116ce 3513 switch (SvTYPE(sv)) {
f9277f47
IZ
3514 case SVt_PVMG:
3515 if ( ((SvFLAGS(sv) &
1c846c1f 3516 (SVs_OBJECT|SVf_OK|SVs_GMG|SVs_SMG|SVs_RMG))
faf82a0b 3517 == (SVs_OBJECT|SVs_SMG))
14befaf4 3518 && (mg = mg_find(sv, PERL_MAGIC_qr))) {
2cd61cdb 3519 regexp *re = (regexp *)mg->mg_obj;
1bd3ad17 3520
2cd61cdb 3521 if (!mg->mg_ptr) {
8782bef2
GB
3522 char *fptr = "msix";
3523 char reflags[6];
3524 char ch;
3525 int left = 0;
3526 int right = 4;
ff385a1b 3527 char need_newline = 0;
eb160463 3528 U16 reganch = (U16)((re->reganch & PMf_COMPILETIME) >> 12);
8782bef2 3529
155aba94 3530 while((ch = *fptr++)) {
8782bef2
GB
3531 if(reganch & 1) {
3532 reflags[left++] = ch;
3533 }
3534 else {
3535 reflags[right--] = ch;
3536 }
3537 reganch >>= 1;
3538 }
3539 if(left != 4) {
3540 reflags[left] = '-';
3541 left = 5;
3542 }
3543
3544 mg->mg_len = re->prelen + 4 + left;
ff385a1b
JF
3545 /*
3546 * If /x was used, we have to worry about a regex
3547 * ending with a comment later being embedded
3548 * within another regex. If so, we don't want this
3549 * regex's "commentization" to leak out to the
3550 * right part of the enclosing regex, we must cap
3551 * it with a newline.
3552 *
3553 * So, if /x was used, we scan backwards from the
3554 * end of the regex. If we find a '#' before we
3555 * find a newline, we need to add a newline
3556 * ourself. If we find a '\n' first (or if we
3557 * don't find '#' or '\n'), we don't need to add
3558 * anything. -jfriedl
3559 */
3560 if (PMf_EXTENDED & re->reganch)
3561 {
3562 char *endptr = re->precomp + re->prelen;
3563 while (endptr >= re->precomp)
3564 {
3565 char c = *(endptr--);
3566 if (c == '\n')
3567 break; /* don't need another */
3568 if (c == '#') {
3569 /* we end while in a comment, so we
3570 need a newline */
3571 mg->mg_len++; /* save space for it */
3572 need_newline = 1; /* note to add it */
ab01544f 3573 break;
ff385a1b
JF
3574 }
3575 }
3576 }
3577
8782bef2
GB
3578 New(616, mg->mg_ptr, mg->mg_len + 1 + left, char);
3579 Copy("(?", mg->mg_ptr, 2, char);
3580 Copy(reflags, mg->mg_ptr+2, left, char);
3581 Copy(":", mg->mg_ptr+left+2, 1, char);
3582 Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
ff385a1b
JF
3583 if (need_newline)
3584 mg->mg_ptr[mg->mg_len - 2] = '\n';
1bd3ad17
IZ
3585 mg->mg_ptr[mg->mg_len - 1] = ')';
3586 mg->mg_ptr[mg->mg_len] = 0;
3587 }
3280af22 3588 PL_reginterp_cnt += re->program[0].next_off;
cb50f42d
YST
3589
3590 if (re->reganch & ROPT_UTF8)
3591 SvUTF8_on(origsv);
3592 else
3593 SvUTF8_off(origsv);
1bd3ad17
IZ
3594 *lp = mg->mg_len;
3595 return mg->mg_ptr;
f9277f47
IZ
3596 }
3597 /* Fall through */
ed6116ce
LW
3598 case SVt_NULL:
3599 case SVt_IV:
3600 case SVt_NV:
3601 case SVt_RV:
3602 case SVt_PV:
3603 case SVt_PVIV:
3604 case SVt_PVNV:
81689caa
HS
3605 case SVt_PVBM: if (SvROK(sv))
3606 s = "REF";
3607 else
3608 s = "SCALAR"; break;
be65207d
DM
3609 case SVt_PVLV: s = SvROK(sv) ? "REF"
3610 /* tied lvalues should appear to be
3611 * scalars for backwards compatitbility */
3612 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
3613 ? "SCALAR" : "LVALUE"; break;
ed6116ce
LW
3614 case SVt_PVAV: s = "ARRAY"; break;
3615 case SVt_PVHV: s = "HASH"; break;
3616 case SVt_PVCV: s = "CODE"; break;
3617 case SVt_PVGV: s = "GLOB"; break;
1d2dff63 3618 case SVt_PVFM: s = "FORMAT"; break;
36477c24 3619 case SVt_PVIO: s = "IO"; break;
ed6116ce
LW
3620 default: s = "UNKNOWN"; break;
3621 }
46fc3d4c 3622 tsv = NEWSV(0,0);
a5cb6b62
NC
3623 if (SvOBJECT(sv)) {
3624 const char *name = HvNAME(SvSTASH(sv));
3625 Perl_sv_setpvf(aTHX_ tsv, "%s=%s(0x%"UVxf")",
3626 name ? name : "__ANON__" , s, PTR2UV(sv));
3627 }
ed6116ce 3628 else
a5cb6b62 3629 Perl_sv_setpvf(aTHX_ tsv, "%s(0x%"UVxf")", s, PTR2UV(sv));
a0d0e21e 3630 goto tokensaveref;
463ee0b2 3631 }
ed6116ce
LW
3632 *lp = strlen(s);
3633 return s;
79072805 3634 }
0336b60e 3635 if (SvREADONLY(sv) && !SvOK(sv)) {
0336b60e 3636 if (ckWARN(WARN_UNINITIALIZED))
29489e7c 3637 report_uninit(sv);
ed6116ce
LW
3638 *lp = 0;
3639 return "";
79072805 3640 }
79072805 3641 }
28e5dec8
JH
3642 if (SvIOK(sv) || ((SvIOKp(sv) && !SvNOKp(sv)))) {
3643 /* I'm assuming that if both IV and NV are equally valid then
3644 converting the IV is going to be more efficient */
3645 U32 isIOK = SvIOK(sv);
3646 U32 isUIOK = SvIsUV(sv);
3647 char buf[TYPE_CHARS(UV)];
3648 char *ebuf, *ptr;
3649
3650 if (SvTYPE(sv) < SVt_PVIV)
3651 sv_upgrade(sv, SVt_PVIV);
3652 if (isUIOK)
3653 ptr = uiv_2buf(buf, 0, SvUVX(sv), 1, &ebuf);
3654 else
3655 ptr = uiv_2buf(buf, SvIVX(sv), 0, 0, &ebuf);
eb160463 3656 SvGROW(sv, (STRLEN)(ebuf - ptr + 1)); /* inlined from sv_setpvn */
28e5dec8
JH
3657 Move(ptr,SvPVX(sv),ebuf - ptr,char);
3658 SvCUR_set(sv, ebuf - ptr);
3659 s = SvEND(sv);
3660 *s = '\0';
3661 if (isIOK)
3662 SvIOK_on(sv);
3663 else
3664 SvIOKp_on(sv);
3665 if (isUIOK)
3666 SvIsUV_on(sv);
3667 }
3668 else if (SvNOKp(sv)) {
79072805
LW
3669 if (SvTYPE(sv) < SVt_PVNV)
3670 sv_upgrade(sv, SVt_PVNV);
1c846c1f 3671 /* The +20 is pure guesswork. Configure test needed. --jhi */
59155cc0 3672 SvGROW(sv, NV_DIG + 20);
463ee0b2 3673 s = SvPVX(sv);
79072805 3674 olderrno = errno; /* some Xenix systems wipe out errno here */
79072805 3675#ifdef apollo
463ee0b2 3676 if (SvNVX(sv) == 0.0)
79072805
LW
3677 (void)strcpy(s,"0");
3678 else
3679#endif /*apollo*/
bbce6d69 3680 {
2d4389e4 3681 Gconvert(SvNVX(sv), NV_DIG, 0, s);
bbce6d69 3682 }
79072805 3683 errno = olderrno;
a0d0e21e
LW
3684#ifdef FIXNEGATIVEZERO
3685 if (*s == '-' && s[1] == '0' && !s[2])
3686 strcpy(s,"0");
3687#endif
79072805
LW
3688 while (*s) s++;
3689#ifdef hcx
3690 if (s[-1] == '.')
46fc3d4c 3691 *--s = '\0';
79072805
LW
3692#endif
3693 }
79072805 3694 else {
0336b60e
IZ
3695 if (ckWARN(WARN_UNINITIALIZED)
3696 && !PL_localizing && !(SvFLAGS(sv) & SVs_PADTMP))
29489e7c 3697 report_uninit(sv);
a0d0e21e 3698 *lp = 0;
25da4f38
IZ
3699 if (SvTYPE(sv) < SVt_PV)
3700 /* Typically the caller expects that sv_any is not NULL now. */
3701 sv_upgrade(sv, SVt_PV);
a0d0e21e 3702 return "";
79072805 3703 }
463ee0b2
LW
3704 *lp = s - SvPVX(sv);
3705 SvCUR_set(sv, *lp);
79072805 3706 SvPOK_on(sv);
1d7c1841
GS
3707 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
3708 PTR2UV(sv),SvPVX(sv)));
463ee0b2 3709 return SvPVX(sv);
a0d0e21e
LW
3710
3711 tokensave:
3712 if (SvROK(sv)) { /* XXX Skip this when sv_pvn_force calls */
3713 /* Sneaky stuff here */
3714
3715 tokensaveref:
46fc3d4c 3716 if (!tsv)
96827780 3717 tsv = newSVpv(tmpbuf, 0);
46fc3d4c 3718 sv_2mortal(tsv);
3719 *lp = SvCUR(tsv);
3720 return SvPVX(tsv);
a0d0e21e
LW
3721 }
3722 else {
3723 STRLEN len;
46fc3d4c 3724 char *t;
3725
3726 if (tsv) {
3727 sv_2mortal(tsv);
3728 t = SvPVX(tsv);
3729 len = SvCUR(tsv);
3730 }
3731 else {
96827780
MB
3732 t = tmpbuf;
3733 len = strlen(tmpbuf);
46fc3d4c 3734 }
a0d0e21e 3735#ifdef FIXNEGATIVEZERO
46fc3d4c 3736 if (len == 2 && t[0] == '-' && t[1] == '0') {
3737 t = "0";
3738 len = 1;
3739 }
a0d0e21e
LW
3740#endif
3741 (void)SvUPGRADE(sv, SVt_PV);
46fc3d4c 3742 *lp = len;
a0d0e21e
LW
3743 s = SvGROW(sv, len + 1);
3744 SvCUR_set(sv, len);
6bf554b4 3745 SvPOKp_on(sv);
e90e2364 3746 return strcpy(s, t);
a0d0e21e 3747 }
463ee0b2
LW
3748}
3749
645c22ef 3750/*
6050d10e
JP
3751=for apidoc sv_copypv
3752
3753Copies a stringified representation of the source SV into the
3754destination SV. Automatically performs any necessary mg_get and
54f0641b 3755coercion of numeric values into strings. Guaranteed to preserve
6050d10e 3756UTF-8 flag even from overloaded objects. Similar in nature to
54f0641b
NIS
3757sv_2pv[_flags] but operates directly on an SV instead of just the
3758string. Mostly uses sv_2pv_flags to do its work, except when that
6050d10e
JP
3759would lose the UTF-8'ness of the PV.
3760
3761=cut
3762*/
3763
3764void
3765Perl_sv_copypv(pTHX_ SV *dsv, register SV *ssv)
3766{
446eaa42
YST
3767 STRLEN len;
3768 char *s;
3769 s = SvPV(ssv,len);
cb50f42d 3770 sv_setpvn(dsv,s,len);
446eaa42 3771 if (SvUTF8(ssv))
cb50f42d 3772 SvUTF8_on(dsv);
446eaa42 3773 else
cb50f42d 3774 SvUTF8_off(dsv);
6050d10e
JP
3775}
3776
3777/*
645c22ef
DM
3778=for apidoc sv_2pvbyte_nolen
3779
3780Return a pointer to the byte-encoded representation of the SV.
1e54db1a 3781May cause the SV to be downgraded from UTF-8 as a side-effect.
645c22ef
DM
3782
3783Usually accessed via the C<SvPVbyte_nolen> macro.
3784
3785=cut
3786*/
3787
7340a771
GS
3788char *
3789Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
3790{
560a288e
GS
3791 STRLEN n_a;
3792 return sv_2pvbyte(sv, &n_a);
7340a771
GS
3793}
3794
645c22ef
DM
3795/*
3796=for apidoc sv_2pvbyte
3797
3798Return a pointer to the byte-encoded representation of the SV, and set *lp
1e54db1a 3799to its length. May cause the SV to be downgraded from UTF-8 as a
645c22ef
DM
3800side-effect.
3801
3802Usually accessed via the C<SvPVbyte> macro.
3803
3804=cut
3805*/
3806
7340a771
GS
3807char *
3808Perl_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
3809{
0875d2fe
NIS
3810 sv_utf8_downgrade(sv,0);
3811 return SvPV(sv,*lp);
7340a771
GS
3812}
3813
645c22ef
DM
3814/*
3815=for apidoc sv_2pvutf8_nolen
3816
1e54db1a
JH
3817Return a pointer to the UTF-8-encoded representation of the SV.
3818May cause the SV to be upgraded to UTF-8 as a side-effect.
645c22ef
DM
3819
3820Usually accessed via the C<SvPVutf8_nolen> macro.
3821
3822=cut
3823*/
3824
7340a771
GS
3825char *
3826Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
3827{
560a288e
GS
3828 STRLEN n_a;
3829 return sv_2pvutf8(sv, &n_a);
7340a771
GS
3830}
3831
645c22ef
DM
3832/*
3833=for apidoc sv_2pvutf8
3834
1e54db1a
JH
3835Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3836to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
645c22ef
DM
3837
3838Usually accessed via the C<SvPVutf8> macro.
3839
3840=cut
3841*/
3842
7340a771
GS
3843char *
3844Perl_sv_2pvutf8(pTHX_ register SV *sv, STRLEN *lp)
3845{
560a288e 3846 sv_utf8_upgrade(sv);
7d59b7e4 3847 return SvPV(sv,*lp);
7340a771 3848}
1c846c1f 3849
645c22ef
DM
3850/*
3851=for apidoc sv_2bool
3852
3853This function is only called on magical items, and is only used by
8cf8f3d1 3854sv_true() or its macro equivalent.
645c22ef
DM
3855
3856=cut
3857*/
3858
463ee0b2 3859bool
864dbfa3 3860Perl_sv_2bool(pTHX_ register SV *sv)
463ee0b2 3861{
8990e307 3862 if (SvGMAGICAL(sv))
463ee0b2
LW
3863 mg_get(sv);
3864
a0d0e21e
LW
3865 if (!SvOK(sv))
3866 return 0;
3867 if (SvROK(sv)) {
a0d0e21e 3868 SV* tmpsv;
1554e226 3869 if (SvAMAGIC(sv) && (tmpsv=AMG_CALLun(sv,bool_)) &&
9e3013b1 3870 (!SvROK(tmpsv) || (SvRV(tmpsv) != SvRV(sv))))
8a31060d 3871 return (bool)SvTRUE(tmpsv);
a0d0e21e
LW
3872 return SvRV(sv) != 0;
3873 }
463ee0b2 3874 if (SvPOKp(sv)) {
11343788
MB
3875 register XPV* Xpvtmp;
3876 if ((Xpvtmp = (XPV*)SvANY(sv)) &&
3877 (*Xpvtmp->xpv_pv > '0' ||
3878 Xpvtmp->xpv_cur > 1 ||
3879 (Xpvtmp->xpv_cur && *Xpvtmp->xpv_pv != '0')))
463ee0b2
LW
3880 return 1;
3881 else
3882 return 0;
3883 }
3884 else {
3885 if (SvIOKp(sv))
3886 return SvIVX(sv) != 0;
3887 else {
3888 if (SvNOKp(sv))
3889 return SvNVX(sv) != 0.0;
3890 else
3891 return FALSE;
3892 }
3893 }
79072805
LW
3894}
3895
09540bc3
JH
3896/* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
3897 * this function provided for binary compatibility only
3898 */
3899
3900
3901STRLEN
3902Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
3903{
3904 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
3905}
3906
c461cf8f
JH
3907/*
3908=for apidoc sv_utf8_upgrade
3909
78ea37eb 3910Converts the PV of an SV to its UTF-8-encoded form.
645c22ef 3911Forces the SV to string form if it is not already.
4411f3b6
NIS
3912Always sets the SvUTF8 flag to avoid future validity checks even
3913if all the bytes have hibit clear.
c461cf8f 3914
13a6c0e0
JH
3915This is not as a general purpose byte encoding to Unicode interface:
3916use the Encode extension for that.
3917
8d6d96c1
HS
3918=for apidoc sv_utf8_upgrade_flags
3919
78ea37eb 3920Converts the PV of an SV to its UTF-8-encoded form.
645c22ef 3921Forces the SV to string form if it is not already.
8d6d96c1
HS
3922Always sets the SvUTF8 flag to avoid future validity checks even
3923if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
3924will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
3925C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
3926
13a6c0e0
JH
3927This is not as a general purpose byte encoding to Unicode interface:
3928use the Encode extension for that.
3929
8d6d96c1
HS
3930=cut
3931*/
3932
3933STRLEN
3934Perl_sv_utf8_upgrade_flags(pTHX_ register SV *sv, I32 flags)
3935{
db42d148 3936 U8 *s, *t, *e;
511c2ff0 3937 int hibit = 0;
560a288e 3938
808c356f
RGS
3939 if (sv == &PL_sv_undef)
3940 return 0;
e0e62c2a
NIS
3941 if (!SvPOK(sv)) {
3942 STRLEN len = 0;
d52b7888
NC
3943 if (SvREADONLY(sv) && (SvPOKp(sv) || SvIOKp(sv) || SvNOKp(sv))) {
3944 (void) sv_2pv_flags(sv,&len, flags);
3945 if (SvUTF8(sv))
3946 return len;
3947 } else {
3948 (void) SvPV_force(sv,len);
3949 }
e0e62c2a 3950 }
4411f3b6 3951
f5cee72b 3952 if (SvUTF8(sv)) {
5fec3b1d 3953 return SvCUR(sv);
f5cee72b 3954 }
5fec3b1d 3955
765f542d
NC
3956 if (SvIsCOW(sv)) {
3957 sv_force_normal_flags(sv, 0);
db42d148
NIS
3958 }
3959
88632417 3960 if (PL_encoding && !(flags & SV_UTF8_NO_ENCODING))
799ef3cb 3961 sv_recode_to_utf8(sv, PL_encoding);
9f4817db 3962 else { /* Assume Latin-1/EBCDIC */
0a378802
JH
3963 /* This function could be much more efficient if we
3964 * had a FLAG in SVs to signal if there are any hibit
3965 * chars in the PV. Given that there isn't such a flag
3966 * make the loop as fast as possible. */
3967 s = (U8 *) SvPVX(sv);
3968 e = (U8 *) SvEND(sv);
3969 t = s;
3970 while (t < e) {
3971 U8 ch = *t++;
3972 if ((hibit = !NATIVE_IS_INVARIANT(ch)))
3973 break;
3974 }
3975 if (hibit) {
3976 STRLEN len;
cc2578a4 3977 (void)SvOOK_off(sv);
06a45632 3978 s = (U8*)SvPVX(sv);
0a378802
JH
3979 len = SvCUR(sv) + 1; /* Plus the \0 */
3980 SvPVX(sv) = (char*)bytes_to_utf8((U8*)s, &len);
3981 SvCUR(sv) = len - 1;
3982 if (SvLEN(sv) != 0)
3983 Safefree(s); /* No longer using what was there before. */
3984 SvLEN(sv) = len; /* No longer know the real size. */
3985 }
9f4817db
JH
3986 /* Mark as UTF-8 even if no hibit - saves scanning loop */
3987 SvUTF8_on(sv);
560a288e 3988 }
4411f3b6 3989 return SvCUR(sv);
560a288e
GS
3990}
3991
c461cf8f
JH
3992/*
3993=for apidoc sv_utf8_downgrade
3994
78ea37eb
TS
3995Attempts to convert the PV of an SV from characters to bytes.
3996If the PV contains a character beyond byte, this conversion will fail;
3997in this case, either returns false or, if C<fail_ok> is not
c461cf8f
JH
3998true, croaks.
3999
13a6c0e0
JH
4000This is not as a general purpose Unicode to byte encoding interface:
4001use the Encode extension for that.
4002
c461cf8f
JH
4003=cut
4004*/
4005
560a288e
GS
4006bool
4007Perl_sv_utf8_downgrade(pTHX_ register SV* sv, bool fail_ok)
4008{
78ea37eb 4009 if (SvPOKp(sv) && SvUTF8(sv)) {
fa301091 4010 if (SvCUR(sv)) {
03cfe0ae 4011 U8 *s;
652088fc 4012 STRLEN len;
fa301091 4013
765f542d
NC
4014 if (SvIsCOW(sv)) {
4015 sv_force_normal_flags(sv, 0);
4016 }
03cfe0ae
NIS
4017 s = (U8 *) SvPV(sv, len);
4018 if (!utf8_to_bytes(s, &len)) {
fa301091
JH
4019 if (fail_ok)
4020 return FALSE;
4021 else {
4022 if (PL_op)
4023 Perl_croak(aTHX_ "Wide character in %s",
53e06cf0 4024 OP_DESC(PL_op));
fa301091
JH
4025 else
4026 Perl_croak(aTHX_ "Wide character");
4027 }
4b3603a4 4028 }
fa301091 4029 SvCUR(sv) = len;
67e989fb 4030 }
560a288e 4031 }
ffebcc3e 4032 SvUTF8_off(sv);
560a288e
GS
4033 return TRUE;
4034}
4035
c461cf8f
JH
4036/*
4037=for apidoc sv_utf8_encode
4038
78ea37eb
TS
4039Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
4040flag off so that it looks like octets again.
c461cf8f
JH
4041
4042=cut
4043*/
4044
560a288e
GS
4045void
4046Perl_sv_utf8_encode(pTHX_ register SV *sv)
4047{
4411f3b6 4048 (void) sv_utf8_upgrade(sv);
4c94c214
NC
4049 if (SvIsCOW(sv)) {
4050 sv_force_normal_flags(sv, 0);
4051 }
4052 if (SvREADONLY(sv)) {
4053 Perl_croak(aTHX_ PL_no_modify);
4054 }
560a288e
GS
4055 SvUTF8_off(sv);
4056}
4057
4411f3b6
NIS
4058/*
4059=for apidoc sv_utf8_decode
4060
78ea37eb
TS
4061If the PV of the SV is an octet sequence in UTF-8
4062and contains a multiple-byte character, the C<SvUTF8> flag is turned on
4063so that it looks like a character. If the PV contains only single-byte
4064characters, the C<SvUTF8> flag stays being off.
4065Scans PV for validity and returns false if the PV is invalid UTF-8.
4411f3b6
NIS
4066
4067=cut
4068*/
4069
560a288e
GS
4070bool
4071Perl_sv_utf8_decode(pTHX_ register SV *sv)
4072{
78ea37eb 4073 if (SvPOKp(sv)) {
63cd0674
NIS
4074 U8 *c;
4075 U8 *e;
9cbac4c7 4076
645c22ef
DM
4077 /* The octets may have got themselves encoded - get them back as
4078 * bytes
4079 */
4080 if (!sv_utf8_downgrade(sv, TRUE))
560a288e
GS
4081 return FALSE;
4082
4083 /* it is actually just a matter of turning the utf8 flag on, but
4084 * we want to make sure everything inside is valid utf8 first.
4085 */
63cd0674
NIS
4086 c = (U8 *) SvPVX(sv);
4087 if (!is_utf8_string(c, SvCUR(sv)+1))
67e989fb 4088 return FALSE;
63cd0674 4089 e = (U8 *) SvEND(sv);
511c2ff0 4090 while (c < e) {
c4d5f83a
NIS
4091 U8 ch = *c++;
4092 if (!UTF8_IS_INVARIANT(ch)) {
67e989fb
JH
4093 SvUTF8_on(sv);
4094 break;
4095 }
560a288e 4096 }
560a288e
GS
4097 }
4098 return TRUE;
4099}
4100
09540bc3
JH
4101/* sv_setsv() is now a macro using Perl_sv_setsv_flags();
4102 * this function provided for binary compatibility only
4103 */
4104
4105void
4106Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
4107{
4108 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
4109}
4110
954c1994
GS
4111/*
4112=for apidoc sv_setsv
4113
645c22ef
DM
4114Copies the contents of the source SV C<ssv> into the destination SV
4115C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4116function if the source SV needs to be reused. Does not handle 'set' magic.
4117Loosely speaking, it performs a copy-by-value, obliterating any previous
4118content of the destination.
4119
4120You probably want to use one of the assortment of wrappers, such as
4121C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4122C<SvSetMagicSV_nosteal>.
4123
8d6d96c1
HS
4124=for apidoc sv_setsv_flags
4125
645c22ef
DM
4126Copies the contents of the source SV C<ssv> into the destination SV
4127C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
4128function if the source SV needs to be reused. Does not handle 'set' magic.
4129Loosely speaking, it performs a copy-by-value, obliterating any previous
4130content of the destination.
4131If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
5fcdf167
NC
4132C<ssv> if appropriate, else not. If the C<flags> parameter has the
4133C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
4134and C<sv_setsv_nomg> are implemented in terms of this function.
645c22ef
DM
4135
4136You probably want to use one of the assortment of wrappers, such as
4137C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4138C<SvSetMagicSV_nosteal>.
4139
4140This is the primary function for copying scalars, and most other
4141copy-ish functions and macros use this underneath.
8d6d96c1
HS
4142
4143=cut
4144*/
4145
4146void
4147Perl_sv_setsv_flags(pTHX_ SV *dstr, register SV *sstr, I32 flags)
4148{
8990e307
LW
4149 register U32 sflags;
4150 register int dtype;
4151 register int stype;
463ee0b2 4152
79072805
LW
4153 if (sstr == dstr)
4154 return;
765f542d 4155 SV_CHECK_THINKFIRST_COW_DROP(dstr);
79072805 4156 if (!sstr)
3280af22 4157 sstr = &PL_sv_undef;
8990e307
LW
4158 stype = SvTYPE(sstr);
4159 dtype = SvTYPE(dstr);
79072805 4160
a0d0e21e 4161 SvAMAGIC_off(dstr);
7a5fa8a2 4162 if ( SvVOK(dstr) )
ece467f9
JP
4163 {
4164 /* need to nuke the magic */
4165 mg_free(dstr);
4166 SvRMAGICAL_off(dstr);
4167 }
9e7bc3e8 4168
463ee0b2 4169 /* There's a lot of redundancy below but we're going for speed here */
79072805 4170
8990e307 4171 switch (stype) {
79072805 4172 case SVt_NULL:
aece5585 4173 undef_sstr:
20408e3c
GS
4174 if (dtype != SVt_PVGV) {
4175 (void)SvOK_off(dstr);
4176 return;
4177 }
4178 break;
463ee0b2 4179 case SVt_IV:
aece5585
GA
4180 if (SvIOK(sstr)) {
4181 switch (dtype) {
4182 case SVt_NULL:
8990e307 4183 sv_upgrade(dstr, SVt_IV);
aece5585
GA
4184 break;
4185 case SVt_NV:
8990e307 4186 sv_upgrade(dstr, SVt_PVNV);
aece5585
GA
4187 break;
4188 case SVt_RV:
4189 case SVt_PV:
a0d0e21e 4190 sv_upgrade(dstr, SVt_PVIV);
aece5585
GA
4191 break;
4192 }
4193 (void)SvIOK_only(dstr);
4194 SvIVX(dstr) = SvIVX(sstr);
25da4f38
IZ
4195 if (SvIsUV(sstr))
4196 SvIsUV_on(dstr);
27c9684d
AP
4197 if (SvTAINTED(sstr))
4198 SvTAINT(dstr);
aece5585 4199 return;
8990e307 4200 }
aece5585
GA
4201 goto undef_sstr;
4202
463ee0b2 4203 case SVt_NV:
aece5585
GA
4204 if (SvNOK(sstr)) {
4205 switch (dtype) {
4206 case SVt_NULL:
4207 case SVt_IV:
8990e307 4208 sv_upgrade(dstr, SVt_NV);
aece5585
GA
4209 break;
4210 case SVt_RV:
4211 case SVt_PV:
4212 case SVt_PVIV:
a0d0e21e 4213 sv_upgrade(dstr, SVt_PVNV);
aece5585
GA
4214 break;
4215 }
4216 SvNVX(dstr) = SvNVX(sstr);
4217 (void)SvNOK_only(dstr);
27c9684d
AP
4218 if (SvTAINTED(sstr))
4219 SvTAINT(dstr);
aece5585 4220 return;
8990e307 4221 }
aece5585
GA
4222 goto undef_sstr;
4223
ed6116ce 4224 case SVt_RV:
8990e307 4225 if (dtype < SVt_RV)
ed6116ce 4226 sv_upgrade(dstr, SVt_RV);
c07a80fd 4227 else if (dtype == SVt_PVGV &&
23bb1b96 4228 SvROK(sstr) && SvTYPE(SvRV(sstr)) == SVt_PVGV) {
c07a80fd 4229 sstr = SvRV(sstr);
a5f75d66 4230 if (sstr == dstr) {
1d7c1841
GS
4231 if (GvIMPORTED(dstr) != GVf_IMPORTED
4232 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4233 {
a5f75d66 4234 GvIMPORTED_on(dstr);
1d7c1841 4235 }
a5f75d66
AD
4236 GvMULTI_on(dstr);
4237 return;
4238 }
c07a80fd 4239 goto glob_assign;
4240 }
ed6116ce 4241 break;
fc36a67e 4242 case SVt_PVFM:
d89fc664
NC
4243#ifdef PERL_COPY_ON_WRITE
4244 if ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS) {
4245 if (dtype < SVt_PVIV)
4246 sv_upgrade(dstr, SVt_PVIV);
4247 break;
4248 }
4249 /* Fall through */
4250#endif
4251 case SVt_PV:
8990e307 4252 if (dtype < SVt_PV)
463ee0b2 4253 sv_upgrade(dstr, SVt_PV);
463ee0b2
LW
4254 break;
4255 case SVt_PVIV:
8990e307 4256 if (dtype < SVt_PVIV)
463ee0b2 4257 sv_upgrade(dstr, SVt_PVIV);
463ee0b2
LW
4258 break;
4259 case SVt_PVNV:
8990e307 4260 if (dtype < SVt_PVNV)
463ee0b2 4261 sv_upgrade(dstr, SVt_PVNV);
463ee0b2 4262 break;
4633a7c4
LW
4263 case SVt_PVAV:
4264 case SVt_PVHV:
4265 case SVt_PVCV:
4633a7c4 4266 case SVt_PVIO:
533c011a 4267 if (PL_op)
cea2e8a9 4268 Perl_croak(aTHX_ "Bizarre copy of %s in %s", sv_reftype(sstr, 0),
53e06cf0 4269 OP_NAME(PL_op));
4633a7c4 4270 else
cea2e8a9 4271 Perl_croak(aTHX_ "Bizarre copy of %s", sv_reftype(sstr, 0));
4633a7c4
LW
4272 break;
4273
79072805 4274 case SVt_PVGV:
8990e307 4275 if (dtype <= SVt_PVGV) {
c07a80fd 4276 glob_assign:
a5f75d66 4277 if (dtype != SVt_PVGV) {
a0d0e21e
LW
4278 char *name = GvNAME(sstr);
4279 STRLEN len = GvNAMELEN(sstr);
b76195c2
DM
4280 /* don't upgrade SVt_PVLV: it can hold a glob */
4281 if (dtype != SVt_PVLV)
4282 sv_upgrade(dstr, SVt_PVGV);
14befaf4 4283 sv_magic(dstr, dstr, PERL_MAGIC_glob, Nullch, 0);
85aff577 4284 GvSTASH(dstr) = (HV*)SvREFCNT_inc(GvSTASH(sstr));
a0d0e21e
LW
4285 GvNAME(dstr) = savepvn(name, len);
4286 GvNAMELEN(dstr) = len;
4287 SvFAKE_on(dstr); /* can coerce to non-glob */
4288 }
7bac28a0 4289 /* ahem, death to those who redefine active sort subs */
3280af22
NIS
4290 else if (PL_curstackinfo->si_type == PERLSI_SORT
4291 && GvCV(dstr) && PL_sortcop == CvSTART(GvCV(dstr)))
cea2e8a9 4292 Perl_croak(aTHX_ "Can't redefine active sort subroutine %s",
7bac28a0 4293 GvNAME(dstr));
5bd07a3d 4294
7fb37951
AMS
4295#ifdef GV_UNIQUE_CHECK
4296 if (GvUNIQUE((GV*)dstr)) {
5bd07a3d
DM
4297 Perl_croak(aTHX_ PL_no_modify);
4298 }
4299#endif
4300
a0d0e21e 4301 (void)SvOK_off(dstr);
a5f75d66 4302 GvINTRO_off(dstr); /* one-shot flag */
1edc1566 4303 gp_free((GV*)dstr);
79072805 4304 GvGP(dstr) = gp_ref(GvGP(sstr));
27c9684d
AP
4305 if (SvTAINTED(sstr))
4306 SvTAINT(dstr);
1d7c1841
GS
4307 if (GvIMPORTED(dstr) != GVf_IMPORTED
4308 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4309 {
a5f75d66 4310 GvIMPORTED_on(dstr);
1d7c1841 4311 }
a5f75d66 4312 GvMULTI_on(dstr);
79072805
LW
4313 return;
4314 }
4315 /* FALL THROUGH */
4316
4317 default:
8d6d96c1 4318 if (SvGMAGICAL(sstr) && (flags & SV_GMAGIC)) {
973f89ab 4319 mg_get(sstr);
eb160463 4320 if ((int)SvTYPE(sstr) != stype) {
973f89ab
CS
4321 stype = SvTYPE(sstr);
4322 if (stype == SVt_PVGV && dtype <= SVt_PVGV)
4323 goto glob_assign;
4324 }
4325 }
ded42b9f 4326 if (stype == SVt_PVLV)
6fc92669 4327 (void)SvUPGRADE(dstr, SVt_PVNV);
ded42b9f 4328 else
eb160463 4329 (void)SvUPGRADE(dstr, (U32)stype);
79072805
LW
4330 }
4331
8990e307
LW
4332 sflags = SvFLAGS(sstr);
4333
4334 if (sflags & SVf_ROK) {
4335 if (dtype >= SVt_PV) {
4336 if (dtype == SVt_PVGV) {
4337 SV *sref = SvREFCNT_inc(SvRV(sstr));
4338 SV *dref = 0;
a5f75d66 4339 int intro = GvINTRO(dstr);
a0d0e21e 4340
7fb37951
AMS
4341#ifdef GV_UNIQUE_CHECK
4342 if (GvUNIQUE((GV*)dstr)) {
5bd07a3d
DM
4343 Perl_croak(aTHX_ PL_no_modify);
4344 }
4345#endif
4346
a0d0e21e 4347 if (intro) {
a5f75d66 4348 GvINTRO_off(dstr); /* one-shot flag */
1d7c1841 4349 GvLINE(dstr) = CopLINE(PL_curcop);
1edc1566 4350 GvEGV(dstr) = (GV*)dstr;
a0d0e21e 4351 }
a5f75d66 4352 GvMULTI_on(dstr);
8990e307
LW
4353 switch (SvTYPE(sref)) {
4354 case SVt_PVAV:
a0d0e21e 4355 if (intro)
890ed176 4356 SAVEGENERICSV(GvAV(dstr));
a0d0e21e
LW
4357 else
4358 dref = (SV*)GvAV(dstr);
8990e307 4359 GvAV(dstr) = (AV*)sref;
39bac7f7 4360 if (!GvIMPORTED_AV(dstr)
1d7c1841
GS
4361 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4362 {
a5f75d66 4363 GvIMPORTED_AV_on(dstr);
1d7c1841 4364 }
8990e307
LW
4365 break;
4366 case SVt_PVHV:
a0d0e21e 4367 if (intro)
890ed176 4368 SAVEGENERICSV(GvHV(dstr));
a0d0e21e
LW
4369 else
4370 dref = (SV*)GvHV(dstr);
8990e307 4371 GvHV(dstr) = (HV*)sref;
39bac7f7 4372 if (!GvIMPORTED_HV(dstr)
1d7c1841
GS
4373 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4374 {
a5f75d66 4375 GvIMPORTED_HV_on(dstr);
1d7c1841 4376 }
8990e307
LW
4377 break;
4378 case SVt_PVCV:
8ebc5c01 4379 if (intro) {
4380 if (GvCVGEN(dstr) && GvCV(dstr) != (CV*)sref) {
4381 SvREFCNT_dec(GvCV(dstr));
4382 GvCV(dstr) = Nullcv;
68dc0745 4383 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
3280af22 4384 PL_sub_generation++;
8ebc5c01 4385 }
890ed176 4386 SAVEGENERICSV(GvCV(dstr));
8ebc5c01 4387 }
68dc0745 4388 else
4389 dref = (SV*)GvCV(dstr);
4390 if (GvCV(dstr) != (CV*)sref) {
748a9306 4391 CV* cv = GvCV(dstr);
4633a7c4 4392 if (cv) {
68dc0745 4393 if (!GvCVGEN((GV*)dstr) &&
4394 (CvROOT(cv) || CvXSUB(cv)))
4395 {
7bac28a0 4396 /* ahem, death to those who redefine
4397 * active sort subs */
3280af22
NIS
4398 if (PL_curstackinfo->si_type == PERLSI_SORT &&
4399 PL_sortcop == CvSTART(cv))
1c846c1f 4400 Perl_croak(aTHX_
7bac28a0 4401 "Can't redefine active sort subroutine %s",
4402 GvENAME((GV*)dstr));
beab0874
JT
4403 /* Redefining a sub - warning is mandatory if
4404 it was a const and its value changed. */
4405 if (ckWARN(WARN_REDEFINE)
4406 || (CvCONST(cv)
4407 && (!CvCONST((CV*)sref)
4408 || sv_cmp(cv_const_sv(cv),
4409 cv_const_sv((CV*)sref)))))
4410 {
9014280d 4411 Perl_warner(aTHX_ packWARN(WARN_REDEFINE),
beab0874 4412 CvCONST(cv)
910764e6
RGS
4413 ? "Constant subroutine %s::%s redefined"
4414 : "Subroutine %s::%s redefined",
4415 HvNAME(GvSTASH((GV*)dstr)),
beab0874
JT
4416 GvENAME((GV*)dstr));
4417 }
9607fc9c 4418 }
fb24441d
RGS
4419 if (!intro)
4420 cv_ckproto(cv, (GV*)dstr,
4421 SvPOK(sref) ? SvPVX(sref) : Nullch);
4633a7c4 4422 }
a5f75d66 4423 GvCV(dstr) = (CV*)sref;
7a4c00b4 4424 GvCVGEN(dstr) = 0; /* Switch off cacheness. */
a5f75d66 4425 GvASSUMECV_on(dstr);
3280af22 4426 PL_sub_generation++;
a5f75d66 4427 }
39bac7f7 4428 if (!GvIMPORTED_CV(dstr)
1d7c1841
GS
4429 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4430 {
a5f75d66 4431 GvIMPORTED_CV_on(dstr);
1d7c1841 4432 }
8990e307 4433 break;
91bba347
LW
4434 case SVt_PVIO:
4435 if (intro)
890ed176 4436 SAVEGENERICSV(GvIOp(dstr));
91bba347
LW
4437 else
4438 dref = (SV*)GvIOp(dstr);
4439 GvIOp(dstr) = (IO*)sref;
4440 break;
f4d13ee9
JH
4441 case SVt_PVFM:
4442 if (intro)
890ed176 4443 SAVEGENERICSV(GvFORM(dstr));
f4d13ee9
JH
4444 else
4445 dref = (SV*)GvFORM(dstr);
4446 GvFORM(dstr) = (CV*)sref;
4447 break;
8990e307 4448 default:
a0d0e21e 4449 if (intro)
890ed176 4450 SAVEGENERICSV(GvSV(dstr));
a0d0e21e
LW
4451 else
4452 dref = (SV*)GvSV(dstr);
8990e307 4453 GvSV(dstr) = sref;
39bac7f7 4454 if (!GvIMPORTED_SV(dstr)
1d7c1841
GS
4455 && CopSTASH_ne(PL_curcop, GvSTASH(dstr)))
4456 {
a5f75d66 4457 GvIMPORTED_SV_on(dstr);
1d7c1841 4458 }
8990e307
LW
4459 break;
4460 }
4461 if (dref)
4462 SvREFCNT_dec(dref);
27c9684d
AP
4463 if (SvTAINTED(sstr))
4464 SvTAINT(dstr);
8990e307
LW
4465 return;
4466 }
a0d0e21e 4467 if (SvPVX(dstr)) {
760ac839 4468 (void)SvOOK_off(dstr); /* backoff */
50483b2c
JD
4469 if (SvLEN(dstr))
4470 Safefree(SvPVX(dstr));
a0d0e21e
LW
4471 SvLEN(dstr)=SvCUR(dstr)=0;
4472 }
8990e307 4473 }
a0d0e21e 4474 (void)SvOK_off(dstr);
8990e307 4475 SvRV(dstr) = SvREFCNT_inc(SvRV(sstr));
ed6116ce 4476 SvROK_on(dstr);
8990e307 4477 if (sflags & SVp_NOK) {
3332b3c1
JH
4478 SvNOKp_on(dstr);
4479 /* Only set the public OK flag if the source has public OK. */
4480 if (sflags & SVf_NOK)
4481 SvFLAGS(dstr) |= SVf_NOK;
ed6116ce
LW
4482 SvNVX(dstr) = SvNVX(sstr);
4483 }
8990e307 4484 if (sflags & SVp_IOK) {
3332b3c1
JH
4485 (void)SvIOKp_on(dstr);
4486 if (sflags & SVf_IOK)
4487 SvFLAGS(dstr) |= SVf_IOK;
2b1c7e3e 4488 if (sflags & SVf_IVisUV)
25da4f38 4489 SvIsUV_on(dstr);
3332b3c1 4490 SvIVX(dstr) = SvIVX(sstr);
ed6116ce 4491 }
a0d0e21e
LW
4492 if (SvAMAGIC(sstr)) {
4493 SvAMAGIC_on(dstr);
4494 }
ed6116ce 4495 }
8990e307 4496 else if (sflags & SVp_POK) {
765f542d 4497 bool isSwipe = 0;
79072805
LW
4498
4499 /*
4500 * Check to see if we can just swipe the string. If so, it's a
4501 * possible small lose on short strings, but a big win on long ones.
463ee0b2
LW
4502 * It might even be a win on short strings if SvPVX(dstr)
4503 * has to be allocated and SvPVX(sstr) has to be freed.
79072805
LW
4504 */
4505
120fac95
NC
4506 /* Whichever path we take through the next code, we want this true,
4507 and doing it now facilitates the COW check. */
4508 (void)SvPOK_only(dstr);
4509
765f542d
NC
4510 if (
4511#ifdef PERL_COPY_ON_WRITE
4512 (sflags & (SVf_FAKE | SVf_READONLY)) != (SVf_FAKE | SVf_READONLY)
4513 &&
4514#endif
4515 !(isSwipe =
4516 (sflags & SVs_TEMP) && /* slated for free anyway? */
4517 !(sflags & SVf_OOK) && /* and not involved in OOK hack? */
5fcdf167
NC
4518 (!(flags & SV_NOSTEAL)) &&
4519 /* and we're allowed to steal temps */
765f542d
NC
4520 SvREFCNT(sstr) == 1 && /* and no other references to it? */
4521 SvLEN(sstr) && /* and really is a string */
645c22ef 4522 /* and won't be needed again, potentially */
765f542d
NC
4523 !(PL_op && PL_op->op_type == OP_AASSIGN))
4524#ifdef PERL_COPY_ON_WRITE
4525 && !((sflags & CAN_COW_MASK) == CAN_COW_FLAGS
120fac95 4526 && (SvFLAGS(dstr) & CAN_COW_MASK) == CAN_COW_FLAGS
765f542d
NC
4527 && SvTYPE(sstr) >= SVt_PVIV)
4528#endif
4529 ) {
4530 /* Failed the swipe test, and it's not a shared hash key either.
4531 Have to copy the string. */
4532 STRLEN len = SvCUR(sstr);
4533 SvGROW(dstr, len + 1); /* inlined from sv_setpvn */
4534 Move(SvPVX(sstr),SvPVX(dstr),len,char);
4535 SvCUR_set(dstr, len);
4536 *SvEND(dstr) = '\0';
765f542d
NC
4537 } else {
4538 /* If PERL_COPY_ON_WRITE is not defined, then isSwipe will always
4539 be true in here. */
4540#ifdef PERL_COPY_ON_WRITE
4541 /* Either it's a shared hash key, or it's suitable for
4542 copy-on-write or we can swipe the string. */
46187eeb 4543 if (DEBUG_C_TEST) {
ed252734 4544 PerlIO_printf(Perl_debug_log, "Copy on write: sstr --> dstr\n");
e419cbc5
NC
4545 sv_dump(sstr);
4546 sv_dump(dstr);
46187eeb 4547 }
765f542d
NC
4548 if (!isSwipe) {
4549 /* I believe I should acquire a global SV mutex if
4550 it's a COW sv (not a shared hash key) to stop
4551 it going un copy-on-write.
4552 If the source SV has gone un copy on write between up there
4553 and down here, then (assert() that) it is of the correct
4554 form to make it copy on write again */
4555 if ((sflags & (SVf_FAKE | SVf_READONLY))
4556 != (SVf_FAKE | SVf_READONLY)) {
4557 SvREADONLY_on(sstr);
4558 SvFAKE_on(sstr);
4559 /* Make the source SV into a loop of 1.
4560 (about to become 2) */
a29f6d03 4561 SV_COW_NEXT_SV_SET(sstr, sstr);
765f542d
NC
4562 }
4563 }
4564#endif
4565 /* Initial code is common. */
adbc6bb1 4566 if (SvPVX(dstr)) { /* we know that dtype >= SVt_PV */
a5f75d66
AD
4567 if (SvOOK(dstr)) {
4568 SvFLAGS(dstr) &= ~SVf_OOK;
4569 Safefree(SvPVX(dstr) - SvIVX(dstr));
4570 }
50483b2c 4571 else if (SvLEN(dstr))
a5f75d66 4572 Safefree(SvPVX(dstr));
79072805 4573 }
765f542d
NC
4574
4575#ifdef PERL_COPY_ON_WRITE
4576 if (!isSwipe) {
4577 /* making another shared SV. */
4578 STRLEN cur = SvCUR(sstr);
4579 STRLEN len = SvLEN(sstr);
d89fc664 4580 assert (SvTYPE(dstr) >= SVt_PVIV);
765f542d
NC
4581 if (len) {
4582 /* SvIsCOW_normal */
4583 /* splice us in between source and next-after-source. */
a29f6d03
NC
4584 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4585 SV_COW_NEXT_SV_SET(sstr, dstr);
765f542d
NC
4586 SvPV_set(dstr, SvPVX(sstr));
4587 } else {
4588 /* SvIsCOW_shared_hash */
4589 UV hash = SvUVX(sstr);
46187eeb
NC
4590 DEBUG_C(PerlIO_printf(Perl_debug_log,
4591 "Copy on write: Sharing hash\n"));
765f542d
NC
4592 SvPV_set(dstr,
4593 sharepvn(SvPVX(sstr),
4594 (sflags & SVf_UTF8?-cur:cur), hash));
4595 SvUVX(dstr) = hash;
4596 }
4597 SvLEN(dstr) = len;
4598 SvCUR(dstr) = cur;
4599 SvREADONLY_on(dstr);
4600 SvFAKE_on(dstr);
4601 /* Relesase a global SV mutex. */
4602 }
4603 else
4604#endif
4605 { /* Passes the swipe test. */
4606 SvPV_set(dstr, SvPVX(sstr));
4607 SvLEN_set(dstr, SvLEN(sstr));
4608 SvCUR_set(dstr, SvCUR(sstr));
4609
4610 SvTEMP_off(dstr);
4611 (void)SvOK_off(sstr); /* NOTE: nukes most SvFLAGS on sstr */
4612 SvPV_set(sstr, Nullch);
4613 SvLEN_set(sstr, 0);
4614 SvCUR_set(sstr, 0);
4615 SvTEMP_off(sstr);
4616 }
4617 }
9aa983d2 4618 if (sflags & SVf_UTF8)
a7cb1f99 4619 SvUTF8_on(dstr);
79072805 4620 /*SUPPRESS 560*/
8990e307 4621 if (sflags & SVp_NOK) {
3332b3c1
JH
4622 SvNOKp_on(dstr);
4623 if (sflags & SVf_NOK)
4624 SvFLAGS(dstr) |= SVf_NOK;
463ee0b2 4625 SvNVX(dstr) = SvNVX(sstr);
79072805 4626 }
8990e307 4627 if (sflags & SVp_IOK) {
3332b3c1
JH
4628 (void)SvIOKp_on(dstr);
4629 if (sflags & SVf_IOK)
4630 SvFLAGS(dstr) |= SVf_IOK;
2b1c7e3e 4631 if (sflags & SVf_IVisUV)
25da4f38 4632 SvIsUV_on(dstr);
463ee0b2 4633 SvIVX(dstr) = SvIVX(sstr);
79072805 4634 }
92f0c265 4635 if (SvVOK(sstr)) {
7a5fa8a2 4636 MAGIC *smg = mg_find(sstr,PERL_MAGIC_vstring);
ece467f9
JP
4637 sv_magic(dstr, NULL, PERL_MAGIC_vstring,
4638 smg->mg_ptr, smg->mg_len);
439cb1c4 4639 SvRMAGICAL_on(dstr);
7a5fa8a2 4640 }
79072805 4641 }
8990e307 4642 else if (sflags & SVp_IOK) {
3332b3c1
JH
4643 if (sflags & SVf_IOK)
4644 (void)SvIOK_only(dstr);
4645 else {
9cbac4c7
DM
4646 (void)SvOK_off(dstr);
4647 (void)SvIOKp_on(dstr);
3332b3c1
JH
4648 }
4649 /* XXXX Do we want to set IsUV for IV(ROK)? Be extra safe... */
2b1c7e3e 4650 if (sflags & SVf_IVisUV)
25da4f38 4651 SvIsUV_on(dstr);
3332b3c1
JH
4652 SvIVX(dstr) = SvIVX(sstr);
4653 if (sflags & SVp_NOK) {
4654 if (sflags & SVf_NOK)
4655 (void)SvNOK_on(dstr);
4656 else
4657 (void)SvNOKp_on(dstr);
4658 SvNVX(dstr) = SvNVX(sstr);
4659 }
4660 }
4661 else if (sflags & SVp_NOK) {
4662 if (sflags & SVf_NOK)
4663 (void)SvNOK_only(dstr);
4664 else {
9cbac4c7 4665 (void)SvOK_off(dstr);
3332b3c1
JH
4666 SvNOKp_on(dstr);
4667 }
4668 SvNVX(dstr) = SvNVX(sstr);
79072805
LW
4669 }
4670 else {
20408e3c 4671 if (dtype == SVt_PVGV) {
e476b1b5 4672 if (ckWARN(WARN_MISC))
9014280d 4673 Perl_warner(aTHX_ packWARN(WARN_MISC), "Undefined value assigned to typeglob");
20408e3c
GS
4674 }
4675 else
4676 (void)SvOK_off(dstr);
a0d0e21e 4677 }
27c9684d
AP
4678 if (SvTAINTED(sstr))
4679 SvTAINT(dstr);
79072805
LW
4680}
4681
954c1994
GS
4682/*
4683=for apidoc sv_setsv_mg
4684
4685Like C<sv_setsv>, but also handles 'set' magic.
4686
4687=cut
4688*/
4689
79072805 4690void
864dbfa3 4691Perl_sv_setsv_mg(pTHX_ SV *dstr, register SV *sstr)
ef50df4b
GS
4692{
4693 sv_setsv(dstr,sstr);
4694 SvSETMAGIC(dstr);
4695}
4696
ed252734
NC
4697#ifdef PERL_COPY_ON_WRITE
4698SV *
4699Perl_sv_setsv_cow(pTHX_ SV *dstr, SV *sstr)
4700{
4701 STRLEN cur = SvCUR(sstr);
4702 STRLEN len = SvLEN(sstr);
4703 register char *new_pv;
4704
4705 if (DEBUG_C_TEST) {
4706 PerlIO_printf(Perl_debug_log, "Fast copy on write: %p -> %p\n",
4707 sstr, dstr);
4708 sv_dump(sstr);
4709 if (dstr)
4710 sv_dump(dstr);
4711 }
4712
4713 if (dstr) {
4714 if (SvTHINKFIRST(dstr))
4715 sv_force_normal_flags(dstr, SV_COW_DROP_PV);
4716 else if (SvPVX(dstr))
4717 Safefree(SvPVX(dstr));
4718 }
4719 else
4720 new_SV(dstr);
b988aa42 4721 (void)SvUPGRADE (dstr, SVt_PVIV);
ed252734
NC
4722
4723 assert (SvPOK(sstr));
4724 assert (SvPOKp(sstr));
4725 assert (!SvIOK(sstr));
4726 assert (!SvIOKp(sstr));
4727 assert (!SvNOK(sstr));
4728 assert (!SvNOKp(sstr));
4729
4730 if (SvIsCOW(sstr)) {
4731
4732 if (SvLEN(sstr) == 0) {
4733 /* source is a COW shared hash key. */
4734 UV hash = SvUVX(sstr);
4735 DEBUG_C(PerlIO_printf(Perl_debug_log,
4736 "Fast copy on write: Sharing hash\n"));
4737 SvUVX(dstr) = hash;
4738 new_pv = sharepvn(SvPVX(sstr), (SvUTF8(sstr)?-cur:cur), hash);
4739 goto common_exit;
4740 }
4741 SV_COW_NEXT_SV_SET(dstr, SV_COW_NEXT_SV(sstr));
4742 } else {
4743 assert ((SvFLAGS(sstr) & CAN_COW_MASK) == CAN_COW_FLAGS);
b988aa42 4744 (void)SvUPGRADE (sstr, SVt_PVIV);
ed252734
NC
4745 SvREADONLY_on(sstr);
4746 SvFAKE_on(sstr);
4747 DEBUG_C(PerlIO_printf(Perl_debug_log,
4748 "Fast copy on write: Converting sstr to COW\n"));
4749 SV_COW_NEXT_SV_SET(dstr, sstr);
4750 }
4751 SV_COW_NEXT_SV_SET(sstr, dstr);
4752 new_pv = SvPVX(sstr);
4753
4754 common_exit:
4755 SvPV_set(dstr, new_pv);
4756 SvFLAGS(dstr) = (SVt_PVIV|SVf_POK|SVp_POK|SVf_FAKE|SVf_READONLY);
4757 if (SvUTF8(sstr))
4758 SvUTF8_on(dstr);
4759 SvLEN(dstr) = len;
4760 SvCUR(dstr) = cur;
4761 if (DEBUG_C_TEST) {
4762 sv_dump(dstr);
4763 }
4764 return dstr;
4765}
4766#endif
4767
954c1994
GS
4768/*
4769=for apidoc sv_setpvn
4770
4771Copies a string into an SV. The C<len> parameter indicates the number of
9e09f5f2
MHM
4772bytes to be copied. If the C<ptr> argument is NULL the SV will become
4773undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
954c1994
GS
4774
4775=cut
4776*/
4777
ef50df4b 4778void
864dbfa3 4779Perl_sv_setpvn(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
79072805 4780{
c6f8c383 4781 register char *dptr;
22c522df 4782
765f542d 4783 SV_CHECK_THINKFIRST_COW_DROP(sv);
463ee0b2 4784 if (!ptr) {
a0d0e21e 4785 (void)SvOK_off(sv);
463ee0b2
LW
4786 return;
4787 }
22c522df
JH
4788 else {
4789 /* len is STRLEN which is unsigned, need to copy to signed */
4790 IV iv = len;
9c5ffd7c
JH
4791 if (iv < 0)
4792 Perl_croak(aTHX_ "panic: sv_setpvn called with negative strlen");
22c522df 4793 }
6fc92669 4794 (void)SvUPGRADE(sv, SVt_PV);
c6f8c383 4795
79072805 4796 SvGROW(sv, len + 1);
c6f8c383
GA
4797 dptr = SvPVX(sv);
4798 Move(ptr,dptr,len,char);
4799 dptr[len] = '\0';
79072805 4800 SvCUR_set(sv, len);
1aa99e6b 4801 (void)SvPOK_only_UTF8(sv); /* validate pointer */
463ee0b2 4802 SvTAINT(sv);
79072805
LW
4803}
4804
954c1994
GS
4805/*
4806=for apidoc sv_setpvn_mg
4807
4808Like C<sv_setpvn>, but also handles 'set' magic.
4809
4810=cut
4811*/
4812
79072805 4813void
864dbfa3 4814Perl_sv_setpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
ef50df4b
GS
4815{
4816 sv_setpvn(sv,ptr,len);
4817 SvSETMAGIC(sv);
4818}
4819
954c1994
GS
4820/*
4821=for apidoc sv_setpv
4822
4823Copies a string into an SV. The string must be null-terminated. Does not
4824handle 'set' magic. See C<sv_setpv_mg>.
4825
4826=cut
4827*/
4828
ef50df4b 4829void
864dbfa3 4830Perl_sv_setpv(pTHX_ register SV *sv, register const char *ptr)
79072805
LW
4831{
4832 register STRLEN len;
4833
765f542d 4834 SV_CHECK_THINKFIRST_COW_DROP(sv);
463ee0b2 4835 if (!ptr) {
a0d0e21e 4836 (void)SvOK_off(sv);
463ee0b2
LW
4837 return;
4838 }
79072805 4839 len = strlen(ptr);
6fc92669 4840 (void)SvUPGRADE(sv, SVt_PV);
c6f8c383 4841
79072805 4842 SvGROW(sv, len + 1);
463ee0b2 4843 Move(ptr,SvPVX(sv),len+1,char);
79072805 4844 SvCUR_set(sv, len);
1aa99e6b 4845 (void)SvPOK_only_UTF8(sv); /* validate pointer */
463ee0b2
LW
4846 SvTAINT(sv);
4847}
4848
954c1994
GS
4849/*
4850=for apidoc sv_setpv_mg
4851
4852Like C<sv_setpv>, but also handles 'set' magic.
4853
4854=cut
4855*/
4856
463ee0b2 4857void
864dbfa3 4858Perl_sv_setpv_mg(pTHX_ register SV *sv, register const char *ptr)
ef50df4b
GS
4859{
4860 sv_setpv(sv,ptr);
4861 SvSETMAGIC(sv);
4862}
4863
954c1994
GS
4864/*
4865=for apidoc sv_usepvn
4866
4867Tells an SV to use C<ptr> to find its string value. Normally the string is
1c846c1f 4868stored inside the SV but sv_usepvn allows the SV to use an outside string.
954c1994
GS
4869The C<ptr> should point to memory that was allocated by C<malloc>. The
4870string length, C<len>, must be supplied. This function will realloc the
4871memory pointed to by C<ptr>, so that pointer should not be freed or used by
4872the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
4873See C<sv_usepvn_mg>.
4874
4875=cut
4876*/
4877
ef50df4b 4878void
864dbfa3 4879Perl_sv_usepvn(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
463ee0b2 4880{
765f542d 4881 SV_CHECK_THINKFIRST_COW_DROP(sv);
c6f8c383 4882 (void)SvUPGRADE(sv, SVt_PV);
463ee0b2 4883 if (!ptr) {
a0d0e21e 4884 (void)SvOK_off(sv);
463ee0b2
LW
4885 return;
4886 }
a0ed51b3 4887 (void)SvOOK_off(sv);
50483b2c 4888 if (SvPVX(sv) && SvLEN(sv))
463ee0b2
LW
4889 Safefree(SvPVX(sv));
4890 Renew(ptr, len+1, char);
4891 SvPVX(sv) = ptr;
4892 SvCUR_set(sv, len);
4893 SvLEN_set(sv, len+1);
4894 *SvEND(sv) = '\0';
1aa99e6b 4895 (void)SvPOK_only_UTF8(sv); /* validate pointer */
463ee0b2 4896 SvTAINT(sv);
79072805
LW
4897}
4898
954c1994
GS
4899/*
4900=for apidoc sv_usepvn_mg
4901
4902Like C<sv_usepvn>, but also handles 'set' magic.
4903
4904=cut
4905*/
4906
ef50df4b 4907void
864dbfa3 4908Perl_sv_usepvn_mg(pTHX_ register SV *sv, register char *ptr, register STRLEN len)
ef50df4b 4909{
51c1089b 4910 sv_usepvn(sv,ptr,len);
ef50df4b
GS
4911 SvSETMAGIC(sv);
4912}
4913
765f542d
NC
4914#ifdef PERL_COPY_ON_WRITE
4915/* Need to do this *after* making the SV normal, as we need the buffer
4916 pointer to remain valid until after we've copied it. If we let go too early,
4917 another thread could invalidate it by unsharing last of the same hash key
4918 (which it can do by means other than releasing copy-on-write Svs)
4919 or by changing the other copy-on-write SVs in the loop. */
4920STATIC void
4921S_sv_release_COW(pTHX_ register SV *sv, char *pvx, STRLEN cur, STRLEN len,
4922 U32 hash, SV *after)
4923{
4924 if (len) { /* this SV was SvIsCOW_normal(sv) */
4925 /* we need to find the SV pointing to us. */
4926 SV *current = SV_COW_NEXT_SV(after);
7a5fa8a2 4927
765f542d
NC
4928 if (current == sv) {
4929 /* The SV we point to points back to us (there were only two of us
4930 in the loop.)
4931 Hence other SV is no longer copy on write either. */
4932 SvFAKE_off(after);
4933 SvREADONLY_off(after);
4934 } else {
4935 /* We need to follow the pointers around the loop. */
4936 SV *next;
4937 while ((next = SV_COW_NEXT_SV(current)) != sv) {
4938 assert (next);
4939 current = next;
4940 /* don't loop forever if the structure is bust, and we have
4941 a pointer into a closed loop. */
4942 assert (current != after);
e419cbc5 4943 assert (SvPVX(current) == pvx);
765f542d
NC
4944 }
4945 /* Make the SV before us point to the SV after us. */
a29f6d03 4946 SV_COW_NEXT_SV_SET(current, after);
765f542d
NC
4947 }
4948 } else {
4949 unsharepvn(pvx, SvUTF8(sv) ? -(I32)cur : cur, hash);
4950 }
4951}
4952
4953int
4954Perl_sv_release_IVX(pTHX_ register SV *sv)
4955{
4956 if (SvIsCOW(sv))
4957 sv_force_normal_flags(sv, 0);
0c34ef67
MHM
4958 SvOOK_off(sv);
4959 return 0;
765f542d
NC
4960}
4961#endif
645c22ef
DM
4962/*
4963=for apidoc sv_force_normal_flags
4964
4965Undo various types of fakery on an SV: if the PV is a shared string, make
4966a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
765f542d
NC
4967an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
4968we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
4969then a copy-on-write scalar drops its PV buffer (if any) and becomes
4970SvPOK_off rather than making a copy. (Used where this scalar is about to be
d3050d9d 4971set to some other value.) In addition, the C<flags> parameter gets passed to
765f542d
NC
4972C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
4973with flags set to 0.
645c22ef
DM
4974
4975=cut
4976*/
4977
6fc92669 4978void
840a7b70 4979Perl_sv_force_normal_flags(pTHX_ register SV *sv, U32 flags)
0f15f207 4980{
765f542d
NC
4981#ifdef PERL_COPY_ON_WRITE
4982 if (SvREADONLY(sv)) {
4983 /* At this point I believe I should acquire a global SV mutex. */
4984 if (SvFAKE(sv)) {
4985 char *pvx = SvPVX(sv);
4986 STRLEN len = SvLEN(sv);
4987 STRLEN cur = SvCUR(sv);
4988 U32 hash = SvUVX(sv);
4989 SV *next = SV_COW_NEXT_SV(sv); /* next COW sv in the loop. */
46187eeb
NC
4990 if (DEBUG_C_TEST) {
4991 PerlIO_printf(Perl_debug_log,
4992 "Copy on write: Force normal %ld\n",
4993 (long) flags);
e419cbc5 4994 sv_dump(sv);
46187eeb 4995 }
765f542d
NC
4996 SvFAKE_off(sv);
4997 SvREADONLY_off(sv);
4998 /* This SV doesn't own the buffer, so need to New() a new one: */
4999 SvPVX(sv) = 0;
5000 SvLEN(sv) = 0;
5001 if (flags & SV_COW_DROP_PV) {
5002 /* OK, so we don't need to copy our buffer. */
5003 SvPOK_off(sv);
5004 } else {
5005 SvGROW(sv, cur + 1);
5006 Move(pvx,SvPVX(sv),cur,char);
5007 SvCUR(sv) = cur;
5008 *SvEND(sv) = '\0';
5009 }
e419cbc5 5010 sv_release_COW(sv, pvx, cur, len, hash, next);
46187eeb 5011 if (DEBUG_C_TEST) {
e419cbc5 5012 sv_dump(sv);
46187eeb 5013 }
765f542d 5014 }
923e4eb5 5015 else if (IN_PERL_RUNTIME)
765f542d
NC
5016 Perl_croak(aTHX_ PL_no_modify);
5017 /* At this point I believe that I can drop the global SV mutex. */
5018 }
5019#else
2213622d 5020 if (SvREADONLY(sv)) {
1c846c1f
NIS
5021 if (SvFAKE(sv)) {
5022 char *pvx = SvPVX(sv);
5c98da1c 5023 int is_utf8 = SvUTF8(sv);
1c846c1f
NIS
5024 STRLEN len = SvCUR(sv);
5025 U32 hash = SvUVX(sv);
10bcdfd6
NC
5026 SvFAKE_off(sv);
5027 SvREADONLY_off(sv);
5c98da1c
NC
5028 SvPVX(sv) = 0;
5029 SvLEN(sv) = 0;
1c846c1f
NIS
5030 SvGROW(sv, len + 1);
5031 Move(pvx,SvPVX(sv),len,char);
5032 *SvEND(sv) = '\0';
5c98da1c 5033 unsharepvn(pvx, is_utf8 ? -(I32)len : len, hash);
1c846c1f 5034 }
923e4eb5 5035 else if (IN_PERL_RUNTIME)
cea2e8a9 5036 Perl_croak(aTHX_ PL_no_modify);
0f15f207 5037 }
765f542d 5038#endif
2213622d 5039 if (SvROK(sv))
840a7b70 5040 sv_unref_flags(sv, flags);
6fc92669
GS
5041 else if (SvFAKE(sv) && SvTYPE(sv) == SVt_PVGV)
5042 sv_unglob(sv);
0f15f207 5043}
1c846c1f 5044
645c22ef
DM
5045/*
5046=for apidoc sv_force_normal
5047
5048Undo various types of fakery on an SV: if the PV is a shared string, make
5049a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
5050an xpvmg. See also C<sv_force_normal_flags>.
5051
5052=cut
5053*/
5054
840a7b70
IZ
5055void
5056Perl_sv_force_normal(pTHX_ register SV *sv)
5057{
5058 sv_force_normal_flags(sv, 0);
5059}
5060
954c1994
GS
5061/*
5062=for apidoc sv_chop
5063
1c846c1f 5064Efficient removal of characters from the beginning of the string buffer.
954c1994
GS
5065SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
5066the string buffer. The C<ptr> becomes the first character of the adjusted
645c22ef 5067string. Uses the "OOK hack".
31869a79
AE
5068Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
5069refer to the same chunk of data.
954c1994
GS
5070
5071=cut
5072*/
5073
79072805 5074void
645c22ef 5075Perl_sv_chop(pTHX_ register SV *sv, register char *ptr)
79072805
LW
5076{
5077 register STRLEN delta;
a0d0e21e 5078 if (!ptr || !SvPOKp(sv))
79072805 5079 return;
31869a79 5080 delta = ptr - SvPVX(sv);
2213622d 5081 SV_CHECK_THINKFIRST(sv);
79072805
LW
5082 if (SvTYPE(sv) < SVt_PVIV)
5083 sv_upgrade(sv,SVt_PVIV);
5084
5085 if (!SvOOK(sv)) {
50483b2c
JD
5086 if (!SvLEN(sv)) { /* make copy of shared string */
5087 char *pvx = SvPVX(sv);
5088 STRLEN len = SvCUR(sv);
5089 SvGROW(sv, len + 1);
5090 Move(pvx,SvPVX(sv),len,char);
5091 *SvEND(sv) = '\0';
5092 }
463ee0b2 5093 SvIVX(sv) = 0;
a4bfb290
AB
5094 /* Same SvOOK_on but SvOOK_on does a SvIOK_off
5095 and we do that anyway inside the SvNIOK_off
5096 */
7a5fa8a2 5097 SvFLAGS(sv) |= SVf_OOK;
79072805 5098 }
a4bfb290 5099 SvNIOK_off(sv);
79072805
LW
5100 SvLEN(sv) -= delta;
5101 SvCUR(sv) -= delta;
463ee0b2
LW
5102 SvPVX(sv) += delta;
5103 SvIVX(sv) += delta;
79072805
LW
5104}
5105
09540bc3
JH
5106/* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
5107 * this function provided for binary compatibility only
5108 */
5109
5110void
5111Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
5112{
5113 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
5114}
5115
954c1994
GS
5116/*
5117=for apidoc sv_catpvn
5118
5119Concatenates the string onto the end of the string which is in the SV. The
1e54db1a
JH
5120C<len> indicates number of bytes to copy. If the SV has the UTF-8
5121status set, then the bytes appended should be valid UTF-8.
d5ce4a7c 5122Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
954c1994 5123
8d6d96c1
HS
5124=for apidoc sv_catpvn_flags
5125
5126Concatenates the string onto the end of the string which is in the SV. The
1e54db1a
JH
5127C<len> indicates number of bytes to copy. If the SV has the UTF-8
5128status set, then the bytes appended should be valid UTF-8.
8d6d96c1
HS
5129If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
5130appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
5131in terms of this function.
5132
5133=cut
5134*/
5135
5136void
5137Perl_sv_catpvn_flags(pTHX_ register SV *dsv, register const char *sstr, register STRLEN slen, I32 flags)
5138{
5139 STRLEN dlen;
5140 char *dstr;
5141
5142 dstr = SvPV_force_flags(dsv, dlen, flags);
5143 SvGROW(dsv, dlen + slen + 1);
5144 if (sstr == dstr)
5145 sstr = SvPVX(dsv);
5146 Move(sstr, SvPVX(dsv) + dlen, slen, char);
5147 SvCUR(dsv) += slen;
5148 *SvEND(dsv) = '\0';
5149 (void)SvPOK_only_UTF8(dsv); /* validate pointer */
5150 SvTAINT(dsv);
79072805
LW
5151}
5152
954c1994
GS
5153/*
5154=for apidoc sv_catpvn_mg
5155
5156Like C<sv_catpvn>, but also handles 'set' magic.
5157
5158=cut
5159*/
5160
79072805 5161void
864dbfa3 5162Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
ef50df4b
GS
5163{
5164 sv_catpvn(sv,ptr,len);
5165 SvSETMAGIC(sv);
5166}
5167
09540bc3
JH
5168/* sv_catsv() is now a macro using Perl_sv_catsv_flags();
5169 * this function provided for binary compatibility only
5170 */
5171
5172void
5173Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
5174{
5175 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
5176}
5177
954c1994
GS
5178/*
5179=for apidoc sv_catsv
5180
13e8c8e3
JH
5181Concatenates the string from SV C<ssv> onto the end of the string in
5182SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
5183not 'set' magic. See C<sv_catsv_mg>.
954c1994 5184
8d6d96c1
HS
5185=for apidoc sv_catsv_flags
5186
5187Concatenates the string from SV C<ssv> onto the end of the string in
5188SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
5189bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
5190and C<sv_catsv_nomg> are implemented in terms of this function.
5191
5192=cut */
5193
ef50df4b 5194void
8d6d96c1 5195Perl_sv_catsv_flags(pTHX_ SV *dsv, register SV *ssv, I32 flags)
79072805 5196{
13e8c8e3
JH
5197 char *spv;
5198 STRLEN slen;
46199a12 5199 if (!ssv)
79072805 5200 return;
46199a12 5201 if ((spv = SvPV(ssv, slen))) {
4fd84b44
AD
5202 /* sutf8 and dutf8 were type bool, but under USE_ITHREADS,
5203 gcc version 2.95.2 20000220 (Debian GNU/Linux) for
8cf8f3d1
NIS
5204 Linux xxx 2.2.17 on sparc64 with gcc -O2, we erroneously
5205 get dutf8 = 0x20000000, (i.e. SVf_UTF8) even though
4fd84b44
AD
5206 dsv->sv_flags doesn't have that bit set.
5207 Andy Dougherty 12 Oct 2001
5208 */
5209 I32 sutf8 = DO_UTF8(ssv);
5210 I32 dutf8;
13e8c8e3 5211
8d6d96c1
HS
5212 if (SvGMAGICAL(dsv) && (flags & SV_GMAGIC))
5213 mg_get(dsv);
5214 dutf8 = DO_UTF8(dsv);
5215
5216 if (dutf8 != sutf8) {
13e8c8e3 5217 if (dutf8) {
46199a12 5218 /* Not modifying source SV, so taking a temporary copy. */
8d6d96c1 5219 SV* csv = sv_2mortal(newSVpvn(spv, slen));
13e8c8e3 5220
46199a12 5221 sv_utf8_upgrade(csv);
8d6d96c1 5222 spv = SvPV(csv, slen);
13e8c8e3 5223 }
8d6d96c1
HS
5224 else
5225 sv_utf8_upgrade_nomg(dsv);
e84ff256 5226 }
8d6d96c1 5227 sv_catpvn_nomg(dsv, spv, slen);
560a288e 5228 }
79072805
LW
5229}
5230
954c1994
GS
5231/*
5232=for apidoc sv_catsv_mg
5233
5234Like C<sv_catsv>, but also handles 'set' magic.
5235
5236=cut
5237*/
5238
79072805 5239void
46199a12 5240Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
ef50df4b 5241{
46199a12
JH
5242 sv_catsv(dsv,ssv);
5243 SvSETMAGIC(dsv);
ef50df4b
GS
5244}
5245
954c1994
GS
5246/*
5247=for apidoc sv_catpv
5248
5249Concatenates the string onto the end of the string which is in the SV.
1e54db1a
JH
5250If the SV has the UTF-8 status set, then the bytes appended should be
5251valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
954c1994 5252
d5ce4a7c 5253=cut */
954c1994 5254
ef50df4b 5255void
0c981600 5256Perl_sv_catpv(pTHX_ register SV *sv, register const char *ptr)
79072805
LW
5257{
5258 register STRLEN len;
463ee0b2 5259 STRLEN tlen;
748a9306 5260 char *junk;
79072805 5261
0c981600 5262 if (!ptr)
79072805 5263 return;
748a9306 5264 junk = SvPV_force(sv, tlen);
0c981600 5265 len = strlen(ptr);
463ee0b2 5266 SvGROW(sv, tlen + len + 1);
0c981600
JH
5267 if (ptr == junk)
5268 ptr = SvPVX(sv);
5269 Move(ptr,SvPVX(sv)+tlen,len+1,char);
79072805 5270 SvCUR(sv) += len;
d41ff1b8 5271 (void)SvPOK_only_UTF8(sv); /* validate pointer */
463ee0b2 5272 SvTAINT(sv);
79072805
LW
5273}
5274
954c1994
GS
5275/*
5276=for apidoc sv_catpv_mg
5277
5278Like C<sv_catpv>, but also handles 'set' magic.
5279
5280=cut
5281*/
5282
ef50df4b 5283void
0c981600 5284Perl_sv_catpv_mg(pTHX_ register SV *sv, register const char *ptr)
ef50df4b 5285{
0c981600 5286 sv_catpv(sv,ptr);
ef50df4b
GS
5287 SvSETMAGIC(sv);
5288}
5289
645c22ef
DM
5290/*
5291=for apidoc newSV
5292
5293Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
5294with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
5295macro.
5296
5297=cut
5298*/
5299
79072805 5300SV *
864dbfa3 5301Perl_newSV(pTHX_ STRLEN len)
79072805
LW
5302{
5303 register SV *sv;
1c846c1f 5304
4561caa4 5305 new_SV(sv);
79072805
LW
5306 if (len) {
5307 sv_upgrade(sv, SVt_PV);
5308 SvGROW(sv, len + 1);
5309 }
5310 return sv;
5311}
954c1994 5312/*
92110913 5313=for apidoc sv_magicext
954c1994 5314
68795e93 5315Adds magic to an SV, upgrading it if necessary. Applies the
2d8d5d5a 5316supplied vtable and returns a pointer to the magic added.
92110913 5317
2d8d5d5a
SH
5318Note that C<sv_magicext> will allow things that C<sv_magic> will not.
5319In particular, you can add magic to SvREADONLY SVs, and add more than
5320one instance of the same 'how'.
645c22ef 5321
2d8d5d5a
SH
5322If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
5323stored, if C<namlen> is zero then C<name> is stored as-is and - as another
5324special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
5325to contain an C<SV*> and is stored as-is with its REFCNT incremented.
92110913 5326
2d8d5d5a 5327(This is now used as a subroutine by C<sv_magic>.)
954c1994
GS
5328
5329=cut
5330*/
92110913
NIS
5331MAGIC *
5332Perl_sv_magicext(pTHX_ SV* sv, SV* obj, int how, MGVTBL *vtable,
5333 const char* name, I32 namlen)
79072805
LW
5334{
5335 MAGIC* mg;
68795e93 5336
92110913
NIS
5337 if (SvTYPE(sv) < SVt_PVMG) {
5338 (void)SvUPGRADE(sv, SVt_PVMG);
463ee0b2 5339 }
79072805
LW
5340 Newz(702,mg, 1, MAGIC);
5341 mg->mg_moremagic = SvMAGIC(sv);
79072805 5342 SvMAGIC(sv) = mg;
75f9d97a 5343
05f95b08
SB
5344 /* Sometimes a magic contains a reference loop, where the sv and
5345 object refer to each other. To prevent a reference loop that
5346 would prevent such objects being freed, we look for such loops
5347 and if we find one we avoid incrementing the object refcount.
87f0b213
JH
5348
5349 Note we cannot do this to avoid self-tie loops as intervening RV must
b5ccf5f2 5350 have its REFCNT incremented to keep it in existence.
87f0b213
JH
5351
5352 */
14befaf4
DM
5353 if (!obj || obj == sv ||
5354 how == PERL_MAGIC_arylen ||
5355 how == PERL_MAGIC_qr ||
75f9d97a
JH
5356 (SvTYPE(obj) == SVt_PVGV &&
5357 (GvSV(obj) == sv || GvHV(obj) == (HV*)sv || GvAV(obj) == (AV*)sv ||
5358 GvCV(obj) == (CV*)sv || GvIOp(obj) == (IO*)sv ||
2628be26 5359 GvFORM(obj) == (CV*)sv)))
75f9d97a 5360 {
8990e307 5361 mg->mg_obj = obj;
75f9d97a 5362 }
85e6fe83 5363 else {
8990e307 5364 mg->mg_obj = SvREFCNT_inc(obj);
85e6fe83
LW
5365 mg->mg_flags |= MGf_REFCOUNTED;
5366 }
b5ccf5f2
YST
5367
5368 /* Normal self-ties simply pass a null object, and instead of
5369 using mg_obj directly, use the SvTIED_obj macro to produce a
5370 new RV as needed. For glob "self-ties", we are tieing the PVIO
5371 with an RV obj pointing to the glob containing the PVIO. In
5372 this case, to avoid a reference loop, we need to weaken the
5373 reference.
5374 */
5375
5376 if (how == PERL_MAGIC_tiedscalar && SvTYPE(sv) == SVt_PVIO &&
5377 obj && SvROK(obj) && GvIO(SvRV(obj)) == (IO*)sv)
5378 {
5379 sv_rvweaken(obj);
5380 }
5381
79072805 5382 mg->mg_type = how;
565764a8 5383 mg->mg_len = namlen;
9cbac4c7 5384 if (name) {
92110913 5385 if (namlen > 0)
1edc1566 5386 mg->mg_ptr = savepvn(name, namlen);
c6ee37c5 5387 else if (namlen == HEf_SVKEY)
1edc1566 5388 mg->mg_ptr = (char*)SvREFCNT_inc((SV*)name);
68795e93 5389 else
92110913 5390 mg->mg_ptr = (char *) name;
9cbac4c7 5391 }
92110913 5392 mg->mg_virtual = vtable;
68795e93 5393
92110913
NIS
5394 mg_magical(sv);
5395 if (SvGMAGICAL(sv))
5396 SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK|SVf_POK);
5397 return mg;
5398}
5399
5400/*
5401=for apidoc sv_magic
1c846c1f 5402
92110913
NIS
5403Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
5404then adds a new magic item of type C<how> to the head of the magic list.
5405
2d8d5d5a
SH
5406See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
5407handling of the C<name> and C<namlen> arguments.
5408
4509d3fb
SB
5409You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
5410to add more than one instance of the same 'how'.
5411
92110913
NIS
5412=cut
5413*/
5414
5415void
5416Perl_sv_magic(pTHX_ register SV *sv, SV *obj, int how, const char *name, I32 namlen)
68795e93 5417{
92110913
NIS
5418 MAGIC* mg;
5419 MGVTBL *vtable = 0;
5420
765f542d
NC
5421#ifdef PERL_COPY_ON_WRITE
5422 if (SvIsCOW(sv))
5423 sv_force_normal_flags(sv, 0);
5424#endif
92110913 5425 if (SvREADONLY(sv)) {
923e4eb5 5426 if (IN_PERL_RUNTIME
92110913
NIS
5427 && how != PERL_MAGIC_regex_global
5428 && how != PERL_MAGIC_bm
5429 && how != PERL_MAGIC_fm
5430 && how != PERL_MAGIC_sv
e6469971 5431 && how != PERL_MAGIC_backref
92110913
NIS
5432 )
5433 {
5434 Perl_croak(aTHX_ PL_no_modify);
5435 }
5436 }
5437 if (SvMAGICAL(sv) || (how == PERL_MAGIC_taint && SvTYPE(sv) >= SVt_PVMG)) {
5438 if (SvMAGIC(sv) && (mg = mg_find(sv, how))) {
68795e93
NIS
5439 /* sv_magic() refuses to add a magic of the same 'how' as an
5440 existing one
92110913
NIS
5441 */
5442 if (how == PERL_MAGIC_taint)
5443 mg->mg_len |= 1;
5444 return;
5445 }
5446 }
68795e93 5447
79072805 5448 switch (how) {
14befaf4 5449 case PERL_MAGIC_sv:
92110913 5450 vtable = &PL_vtbl_sv;
79072805 5451 break;
14befaf4 5452 case PERL_MAGIC_overload:
92110913 5453 vtable = &PL_vtbl_amagic;
a0d0e21e 5454 break;
14befaf4 5455 case PERL_MAGIC_overload_elem:
92110913 5456 vtable = &PL_vtbl_amagicelem;
a0d0e21e 5457 break;
14befaf4 5458 case PERL_MAGIC_overload_table:
92110913 5459 vtable = &PL_vtbl_ovrld;
a0d0e21e 5460 break;
14befaf4 5461 case PERL_MAGIC_bm:
92110913 5462 vtable = &PL_vtbl_bm;
79072805 5463 break;
14befaf4 5464 case PERL_MAGIC_regdata:
92110913 5465 vtable = &PL_vtbl_regdata;
6cef1e77 5466 break;
14befaf4 5467 case PERL_MAGIC_regdatum:
92110913 5468 vtable = &PL_vtbl_regdatum;
6cef1e77 5469 break;
14befaf4 5470 case PERL_MAGIC_env:
92110913 5471 vtable = &PL_vtbl_env;
79072805 5472 break;
14befaf4 5473 case PERL_MAGIC_fm:
92110913 5474 vtable = &PL_vtbl_fm;
55497cff 5475 break;
14befaf4 5476 case PERL_MAGIC_envelem:
92110913 5477 vtable = &PL_vtbl_envelem;
79072805 5478 break;
14befaf4 5479 case PERL_MAGIC_regex_global:
92110913 5480 vtable = &PL_vtbl_mglob;
93a17b20 5481 break;
14befaf4 5482 case PERL_MAGIC_isa:
92110913 5483 vtable = &PL_vtbl_isa;
463ee0b2 5484 break;
14befaf4 5485 case PERL_MAGIC_isaelem:
92110913 5486 vtable = &PL_vtbl_isaelem;
463ee0b2 5487 break;
14befaf4 5488 case PERL_MAGIC_nkeys:
92110913 5489 vtable = &PL_vtbl_nkeys;
16660edb 5490 break;
14befaf4 5491 case PERL_MAGIC_dbfile:
92110913 5492 vtable = 0;
93a17b20 5493 break;
14befaf4 5494 case PERL_MAGIC_dbline:
92110913 5495 vtable = &PL_vtbl_dbline;
79072805 5496 break;
36477c24 5497#ifdef USE_LOCALE_COLLATE
14befaf4 5498 case PERL_MAGIC_collxfrm:
92110913 5499 vtable = &PL_vtbl_collxfrm;
bbce6d69 5500 break;
36477c24 5501#endif /* USE_LOCALE_COLLATE */
14befaf4 5502 case PERL_MAGIC_tied:
92110913 5503 vtable = &PL_vtbl_pack;
463ee0b2 5504 break;
14befaf4
DM
5505 case PERL_MAGIC_tiedelem:
5506 case PERL_MAGIC_tiedscalar:
92110913 5507 vtable = &PL_vtbl_packelem;
463ee0b2 5508 break;
14befaf4 5509 case PERL_MAGIC_qr:
92110913 5510 vtable = &PL_vtbl_regexp;
c277df42 5511 break;
14befaf4 5512 case PERL_MAGIC_sig:
92110913 5513 vtable = &PL_vtbl_sig;
79072805 5514 break;
14befaf4 5515 case PERL_MAGIC_sigelem:
92110913 5516 vtable = &PL_vtbl_sigelem;
79072805 5517 break;
14befaf4 5518 case PERL_MAGIC_taint:
92110913 5519 vtable = &PL_vtbl_taint;
463ee0b2 5520 break;
14befaf4 5521 case PERL_MAGIC_uvar:
92110913 5522 vtable = &PL_vtbl_uvar;
79072805 5523 break;
14befaf4 5524 case PERL_MAGIC_vec:
92110913 5525 vtable = &PL_vtbl_vec;
79072805 5526 break;
ece467f9
JP
5527 case PERL_MAGIC_vstring:
5528 vtable = 0;
5529 break;
7e8c5dac
HS
5530 case PERL_MAGIC_utf8:
5531 vtable = &PL_vtbl_utf8;
5532 break;
14befaf4 5533 case PERL_MAGIC_substr:
92110913 5534 vtable = &PL_vtbl_substr;
79072805 5535 break;
14befaf4 5536 case PERL_MAGIC_defelem:
92110913 5537 vtable = &PL_vtbl_defelem;
5f05dabc 5538 break;
14befaf4 5539 case PERL_MAGIC_glob:
92110913 5540 vtable = &PL_vtbl_glob;
79072805 5541 break;
14befaf4 5542 case PERL_MAGIC_arylen:
92110913 5543 vtable = &PL_vtbl_arylen;
79072805 5544 break;
14befaf4 5545 case PERL_MAGIC_pos:
92110913 5546 vtable = &PL_vtbl_pos;
a0d0e21e 5547 break;
14befaf4 5548 case PERL_MAGIC_backref:
92110913 5549 vtable = &PL_vtbl_backref;
810b8aa5 5550 break;
14befaf4
DM
5551 case PERL_MAGIC_ext:
5552 /* Reserved for use by extensions not perl internals. */
4633a7c4
LW
5553 /* Useful for attaching extension internal data to perl vars. */
5554 /* Note that multiple extensions may clash if magical scalars */
5555 /* etc holding private data from one are passed to another. */
a0d0e21e 5556 break;
79072805 5557 default:
14befaf4 5558 Perl_croak(aTHX_ "Don't know how to handle magic of type \\%o", how);
463ee0b2 5559 }
68795e93 5560
92110913
NIS
5561 /* Rest of work is done else where */
5562 mg = sv_magicext(sv,obj,how,vtable,name,namlen);
68795e93 5563
92110913
NIS
5564 switch (how) {
5565 case PERL_MAGIC_taint:
5566 mg->mg_len = 1;
5567 break;
5568 case PERL_MAGIC_ext:
5569 case PERL_MAGIC_dbfile:
5570 SvRMAGICAL_on(sv);
5571 break;
5572 }
463ee0b2
LW
5573}
5574
c461cf8f
JH
5575/*
5576=for apidoc sv_unmagic
5577
645c22ef 5578Removes all magic of type C<type> from an SV.
c461cf8f
JH
5579
5580=cut
5581*/
5582
463ee0b2 5583int
864dbfa3 5584Perl_sv_unmagic(pTHX_ SV *sv, int type)
463ee0b2
LW
5585{
5586 MAGIC* mg;
5587 MAGIC** mgp;
91bba347 5588 if (SvTYPE(sv) < SVt_PVMG || !SvMAGIC(sv))
463ee0b2
LW
5589 return 0;
5590 mgp = &SvMAGIC(sv);
5591 for (mg = *mgp; mg; mg = *mgp) {
5592 if (mg->mg_type == type) {
5593 MGVTBL* vtbl = mg->mg_virtual;
5594 *mgp = mg->mg_moremagic;
1d7c1841 5595 if (vtbl && vtbl->svt_free)
fc0dc3b3 5596 CALL_FPTR(vtbl->svt_free)(aTHX_ sv, mg);
14befaf4 5597 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
92110913 5598 if (mg->mg_len > 0)
1edc1566 5599 Safefree(mg->mg_ptr);
565764a8 5600 else if (mg->mg_len == HEf_SVKEY)
1edc1566 5601 SvREFCNT_dec((SV*)mg->mg_ptr);
7e8c5dac
HS
5602 else if (mg->mg_type == PERL_MAGIC_utf8 && mg->mg_ptr)
5603 Safefree(mg->mg_ptr);
9cbac4c7 5604 }
a0d0e21e
LW
5605 if (mg->mg_flags & MGf_REFCOUNTED)
5606 SvREFCNT_dec(mg->mg_obj);
463ee0b2
LW
5607 Safefree(mg);
5608 }
5609 else
5610 mgp = &mg->mg_moremagic;
79072805 5611 }
91bba347 5612 if (!SvMAGIC(sv)) {
463ee0b2 5613 SvMAGICAL_off(sv);
06759ea0 5614 SvFLAGS(sv) |= (SvFLAGS(sv) & (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
463ee0b2
LW
5615 }
5616
5617 return 0;
79072805
LW
5618}
5619
c461cf8f
JH
5620/*
5621=for apidoc sv_rvweaken
5622
645c22ef
DM
5623Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
5624referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
5625push a back-reference to this RV onto the array of backreferences
5626associated with that magic.
c461cf8f
JH
5627
5628=cut
5629*/
5630
810b8aa5 5631SV *
864dbfa3 5632Perl_sv_rvweaken(pTHX_ SV *sv)
810b8aa5
GS
5633{
5634 SV *tsv;
5635 if (!SvOK(sv)) /* let undefs pass */
5636 return sv;
5637 if (!SvROK(sv))
cea2e8a9 5638 Perl_croak(aTHX_ "Can't weaken a nonreference");
810b8aa5 5639 else if (SvWEAKREF(sv)) {
810b8aa5 5640 if (ckWARN(WARN_MISC))
9014280d 5641 Perl_warner(aTHX_ packWARN(WARN_MISC), "Reference is already weak");
810b8aa5
GS
5642 return sv;
5643 }
5644 tsv = SvRV(sv);
5645 sv_add_backref(tsv, sv);
5646 SvWEAKREF_on(sv);
1c846c1f 5647 SvREFCNT_dec(tsv);
810b8aa5
GS
5648 return sv;
5649}
5650
645c22ef
DM
5651/* Give tsv backref magic if it hasn't already got it, then push a
5652 * back-reference to sv onto the array associated with the backref magic.
5653 */
5654
810b8aa5 5655STATIC void
cea2e8a9 5656S_sv_add_backref(pTHX_ SV *tsv, SV *sv)
810b8aa5
GS
5657{
5658 AV *av;
5659 MAGIC *mg;
14befaf4 5660 if (SvMAGICAL(tsv) && (mg = mg_find(tsv, PERL_MAGIC_backref)))
810b8aa5
GS
5661 av = (AV*)mg->mg_obj;
5662 else {
5663 av = newAV();
14befaf4 5664 sv_magic(tsv, (SV*)av, PERL_MAGIC_backref, NULL, 0);
d99b02a1
DM
5665 /* av now has a refcnt of 2, which avoids it getting freed
5666 * before us during global cleanup. The extra ref is removed
5667 * by magic_killbackrefs() when tsv is being freed */
810b8aa5 5668 }
d91d49e8 5669 if (AvFILLp(av) >= AvMAX(av)) {
fdc9a813 5670 I32 i;
d91d49e8 5671 SV **svp = AvARRAY(av);
fdc9a813
AE
5672 for (i = AvFILLp(av); i >= 0; i--)
5673 if (!svp[i]) {
d91d49e8
MM
5674 svp[i] = sv; /* reuse the slot */
5675 return;
5676 }
d91d49e8
MM
5677 av_extend(av, AvFILLp(av)+1);
5678 }
5679 AvARRAY(av)[++AvFILLp(av)] = sv; /* av_push() */
810b8aa5
GS
5680}
5681
645c22ef
DM
5682/* delete a back-reference to ourselves from the backref magic associated
5683 * with the SV we point to.
5684 */
5685
1c846c1f 5686STATIC void
cea2e8a9 5687S_sv_del_backref(pTHX_ SV *sv)
810b8aa5
GS
5688{
5689 AV *av;
5690 SV **svp;
5691 I32 i;
5692 SV *tsv = SvRV(sv);
c04a4dfe 5693 MAGIC *mg = NULL;
14befaf4 5694 if (!SvMAGICAL(tsv) || !(mg = mg_find(tsv, PERL_MAGIC_backref)))
cea2e8a9 5695 Perl_croak(aTHX_ "panic: del_backref");
810b8aa5
GS
5696 av = (AV *)mg->mg_obj;
5697 svp = AvARRAY(av);
fdc9a813
AE
5698 for (i = AvFILLp(av); i >= 0; i--)
5699 if (svp[i] == sv) svp[i] = Nullsv;
810b8aa5
GS
5700}
5701
954c1994
GS
5702/*
5703=for apidoc sv_insert
5704
5705Inserts a string at the specified offset/length within the SV. Similar to
5706the Perl substr() function.
5707
5708=cut
5709*/
5710
79072805 5711void
864dbfa3 5712Perl_sv_insert(pTHX_ SV *bigstr, STRLEN offset, STRLEN len, char *little, STRLEN littlelen)
79072805
LW
5713{
5714 register char *big;
5715 register char *mid;
5716 register char *midend;
5717 register char *bigend;
5718 register I32 i;
6ff81951 5719 STRLEN curlen;
1c846c1f 5720
79072805 5721
8990e307 5722 if (!bigstr)
cea2e8a9 5723 Perl_croak(aTHX_ "Can't modify non-existent substring");
6ff81951 5724 SvPV_force(bigstr, curlen);
60fa28ff 5725 (void)SvPOK_only_UTF8(bigstr);
6ff81951
GS
5726 if (offset + len > curlen) {
5727 SvGROW(bigstr, offset+len+1);
5728 Zero(SvPVX(bigstr)+curlen, offset+len-curlen, char);
5729 SvCUR_set(bigstr, offset+len);
5730 }
79072805 5731
69b47968 5732 SvTAINT(bigstr);
79072805
LW
5733 i = littlelen - len;
5734 if (i > 0) { /* string might grow */
a0d0e21e 5735 big = SvGROW(bigstr, SvCUR(bigstr) + i + 1);
79072805
LW
5736 mid = big + offset + len;
5737 midend = bigend = big + SvCUR(bigstr);
5738 bigend += i;
5739 *bigend = '\0';
5740 while (midend > mid) /* shove everything down */
5741 *--bigend = *--midend;
5742 Move(little,big+offset,littlelen,char);
5743 SvCUR(bigstr) += i;
5744 SvSETMAGIC(bigstr);
5745 return;
5746 }
5747 else if (i == 0) {
463ee0b2 5748 Move(little,SvPVX(bigstr)+offset,len,char);
79072805
LW
5749 SvSETMAGIC(bigstr);
5750 return;
5751 }
5752
463ee0b2 5753 big = SvPVX(bigstr);
79072805
LW
5754 mid = big + offset;
5755 midend = mid + len;
5756 bigend = big + SvCUR(bigstr);
5757
5758 if (midend > bigend)
cea2e8a9 5759 Perl_croak(aTHX_ "panic: sv_insert");
79072805
LW
5760
5761 if (mid - big > bigend - midend) { /* faster to shorten from end */
5762 if (littlelen) {
5763 Move(little, mid, littlelen,char);
5764 mid += littlelen;
5765 }
5766 i = bigend - midend;
5767 if (i > 0) {
5768 Move(midend, mid, i,char);
5769 mid += i;
5770 }
5771 *mid = '\0';
5772 SvCUR_set(bigstr, mid - big);
5773 }
5774 /*SUPPRESS 560*/
155aba94 5775 else if ((i = mid - big)) { /* faster from front */
79072805
LW
5776 midend -= littlelen;
5777 mid = midend;
5778 sv_chop(bigstr,midend-i);
5779 big += i;
5780 while (i--)
5781 *--midend = *--big;
5782 if (littlelen)
5783 Move(little, mid, littlelen,char);
5784 }
5785 else if (littlelen) {
5786 midend -= littlelen;
5787 sv_chop(bigstr,midend);
5788 Move(little,midend,littlelen,char);
5789 }
5790 else {
5791 sv_chop(bigstr,midend);
5792 }
5793 SvSETMAGIC(bigstr);
5794}
5795
c461cf8f
JH
5796/*
5797=for apidoc sv_replace
5798
5799Make the first argument a copy of the second, then delete the original.
645c22ef
DM
5800The target SV physically takes over ownership of the body of the source SV
5801and inherits its flags; however, the target keeps any magic it owns,
5802and any magic in the source is discarded.
ff276b08 5803Note that this is a rather specialist SV copying operation; most of the
645c22ef 5804time you'll want to use C<sv_setsv> or one of its many macro front-ends.
c461cf8f
JH
5805
5806=cut
5807*/
79072805
LW
5808
5809void
864dbfa3 5810Perl_sv_replace(pTHX_ register SV *sv, register SV *nsv)
79072805
LW
5811{
5812 U32 refcnt = SvREFCNT(sv);
765f542d 5813 SV_CHECK_THINKFIRST_COW_DROP(sv);
0453d815 5814 if (SvREFCNT(nsv) != 1 && ckWARN_d(WARN_INTERNAL))
9014280d 5815 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "Reference miscount in sv_replace()");
93a17b20 5816 if (SvMAGICAL(sv)) {
a0d0e21e
LW
5817 if (SvMAGICAL(nsv))
5818 mg_free(nsv);
5819 else
5820 sv_upgrade(nsv, SVt_PVMG);
93a17b20 5821 SvMAGIC(nsv) = SvMAGIC(sv);
a0d0e21e 5822 SvFLAGS(nsv) |= SvMAGICAL(sv);
93a17b20
LW
5823 SvMAGICAL_off(sv);
5824 SvMAGIC(sv) = 0;
5825 }
79072805
LW
5826 SvREFCNT(sv) = 0;
5827 sv_clear(sv);
477f5d66 5828 assert(!SvREFCNT(sv));
79072805 5829 StructCopy(nsv,sv,SV);
d3d0e6f1
NC
5830#ifdef PERL_COPY_ON_WRITE
5831 if (SvIsCOW_normal(nsv)) {
5832 /* We need to follow the pointers around the loop to make the
5833 previous SV point to sv, rather than nsv. */
5834 SV *next;
5835 SV *current = nsv;
5836 while ((next = SV_COW_NEXT_SV(current)) != nsv) {
5837 assert(next);
5838 current = next;
5839 assert(SvPVX(current) == SvPVX(nsv));
5840 }
5841 /* Make the SV before us point to the SV after us. */
5842 if (DEBUG_C_TEST) {
5843 PerlIO_printf(Perl_debug_log, "previous is\n");
5844 sv_dump(current);
a29f6d03
NC
5845 PerlIO_printf(Perl_debug_log,
5846 "move it from 0x%"UVxf" to 0x%"UVxf"\n",
d3d0e6f1
NC
5847 (UV) SV_COW_NEXT_SV(current), (UV) sv);
5848 }
a29f6d03 5849 SV_COW_NEXT_SV_SET(current, sv);
d3d0e6f1
NC
5850 }
5851#endif
79072805 5852 SvREFCNT(sv) = refcnt;
1edc1566 5853 SvFLAGS(nsv) |= SVTYPEMASK; /* Mark as freed */
39cf41c2 5854 SvREFCNT(nsv) = 0;
463ee0b2 5855 del_SV(nsv);
79072805
LW
5856}
5857
c461cf8f
JH
5858/*
5859=for apidoc sv_clear
5860
645c22ef
DM
5861Clear an SV: call any destructors, free up any memory used by the body,
5862and free the body itself. The SV's head is I<not> freed, although
5863its type is set to all 1's so that it won't inadvertently be assumed
5864to be live during global destruction etc.
5865This function should only be called when REFCNT is zero. Most of the time
5866you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
5867instead.
c461cf8f
JH
5868
5869=cut
5870*/
5871
79072805 5872void
864dbfa3 5873Perl_sv_clear(pTHX_ register SV *sv)
79072805 5874{
ec12f114 5875 HV* stash;
79072805
LW
5876 assert(sv);
5877 assert(SvREFCNT(sv) == 0);
5878
ed6116ce 5879 if (SvOBJECT(sv)) {
3280af22 5880 if (PL_defstash) { /* Still have a symbol table? */
39644a26 5881 dSP;
32251b26 5882 CV* destructor;
a0d0e21e 5883
5cc433a6 5884
8ebc5c01 5885
d460ef45 5886 do {
4e8e7886 5887 stash = SvSTASH(sv);
32251b26 5888 destructor = StashHANDLER(stash,DESTROY);
4e8e7886 5889 if (destructor) {
5cc433a6
AB
5890 SV* tmpref = newRV(sv);
5891 SvREADONLY_on(tmpref); /* DESTROY() could be naughty */
4e8e7886 5892 ENTER;
e788e7d3 5893 PUSHSTACKi(PERLSI_DESTROY);
4e8e7886
GS
5894 EXTEND(SP, 2);
5895 PUSHMARK(SP);
5cc433a6 5896 PUSHs(tmpref);
4e8e7886 5897 PUTBACK;
44389ee9 5898 call_sv((SV*)destructor, G_DISCARD|G_EVAL|G_KEEPERR|G_VOID);
7a5fa8a2
NIS
5899
5900
d3acc0f7 5901 POPSTACK;
3095d977 5902 SPAGAIN;
4e8e7886 5903 LEAVE;
5cc433a6
AB
5904 if(SvREFCNT(tmpref) < 2) {
5905 /* tmpref is not kept alive! */
5906 SvREFCNT(sv)--;
5907 SvRV(tmpref) = 0;
5908 SvROK_off(tmpref);
5909 }
5910 SvREFCNT_dec(tmpref);
4e8e7886
GS
5911 }
5912 } while (SvOBJECT(sv) && SvSTASH(sv) != stash);
8ebc5c01 5913
6f44e0a4
JP
5914
5915 if (SvREFCNT(sv)) {
5916 if (PL_in_clean_objs)
cea2e8a9 5917 Perl_croak(aTHX_ "DESTROY created new reference to dead object '%s'",
6f44e0a4
JP
5918 HvNAME(stash));
5919 /* DESTROY gave object new lease on life */
5920 return;
5921 }
a0d0e21e 5922 }
4e8e7886 5923
a0d0e21e 5924 if (SvOBJECT(sv)) {
4e8e7886 5925 SvREFCNT_dec(SvSTASH(sv)); /* possibly of changed persuasion */
a0d0e21e
LW
5926 SvOBJECT_off(sv); /* Curse the object. */
5927 if (SvTYPE(sv) != SVt_PVIO)
3280af22 5928 --PL_sv_objcount; /* XXX Might want something more general */
a0d0e21e 5929 }
463ee0b2 5930 }
524189f1
JH
5931 if (SvTYPE(sv) >= SVt_PVMG) {
5932 if (SvMAGIC(sv))
5933 mg_free(sv);
5934 if (SvFLAGS(sv) & SVpad_TYPED)
5935 SvREFCNT_dec(SvSTASH(sv));
5936 }
ec12f114 5937 stash = NULL;
79072805 5938 switch (SvTYPE(sv)) {
8990e307 5939 case SVt_PVIO:
df0bd2f4
GS
5940 if (IoIFP(sv) &&
5941 IoIFP(sv) != PerlIO_stdin() &&
5f05dabc 5942 IoIFP(sv) != PerlIO_stdout() &&
5943 IoIFP(sv) != PerlIO_stderr())
93578b34 5944 {
f2b5be74 5945 io_close((IO*)sv, FALSE);
93578b34 5946 }
1d7c1841 5947 if (IoDIRP(sv) && !(IoFLAGS(sv) & IOf_FAKE_DIRP))
1236053a 5948 PerlDir_close(IoDIRP(sv));
1d7c1841 5949 IoDIRP(sv) = (DIR*)NULL;
8990e307
LW
5950 Safefree(IoTOP_NAME(sv));
5951 Safefree(IoFMT_NAME(sv));
5952 Safefree(IoBOTTOM_NAME(sv));
a0d0e21e 5953 /* FALL THROUGH */
79072805 5954 case SVt_PVBM:
a0d0e21e 5955 goto freescalar;
79072805 5956 case SVt_PVCV:
748a9306 5957 case SVt_PVFM:
85e6fe83 5958 cv_undef((CV*)sv);
a0d0e21e 5959 goto freescalar;
79072805 5960 case SVt_PVHV:
85e6fe83 5961 hv_undef((HV*)sv);
a0d0e21e 5962 break;
79072805 5963 case SVt_PVAV:
85e6fe83 5964 av_undef((AV*)sv);
a0d0e21e 5965 break;
02270b4e 5966 case SVt_PVLV:
dd28f7bb
DM
5967 if (LvTYPE(sv) == 'T') { /* for tie: return HE to pool */
5968 SvREFCNT_dec(HeKEY_sv((HE*)LvTARG(sv)));
5969 HeNEXT((HE*)LvTARG(sv)) = PL_hv_fetch_ent_mh;
5970 PL_hv_fetch_ent_mh = (HE*)LvTARG(sv);
5971 }
5972 else if (LvTYPE(sv) != 't') /* unless tie: unrefcnted fake SV** */
5973 SvREFCNT_dec(LvTARG(sv));
02270b4e 5974 goto freescalar;
a0d0e21e 5975 case SVt_PVGV:
1edc1566 5976 gp_free((GV*)sv);
a0d0e21e 5977 Safefree(GvNAME(sv));
ec12f114
JPC
5978 /* cannot decrease stash refcount yet, as we might recursively delete
5979 ourselves when the refcnt drops to zero. Delay SvREFCNT_dec
5980 of stash until current sv is completely gone.
5981 -- JohnPC, 27 Mar 1998 */
5982 stash = GvSTASH(sv);
a0d0e21e 5983 /* FALL THROUGH */
79072805 5984 case SVt_PVMG:
79072805
LW
5985 case SVt_PVNV:
5986 case SVt_PVIV:
a0d0e21e 5987 freescalar:
0c34ef67 5988 SvOOK_off(sv);
79072805
LW
5989 /* FALL THROUGH */
5990 case SVt_PV:
a0d0e21e 5991 case SVt_RV:
810b8aa5
GS
5992 if (SvROK(sv)) {
5993 if (SvWEAKREF(sv))
5994 sv_del_backref(sv);
5995 else
5996 SvREFCNT_dec(SvRV(sv));
5997 }
765f542d
NC
5998#ifdef PERL_COPY_ON_WRITE
5999 else if (SvPVX(sv)) {
6000 if (SvIsCOW(sv)) {
6001 /* I believe I need to grab the global SV mutex here and
6002 then recheck the COW status. */
46187eeb
NC
6003 if (DEBUG_C_TEST) {
6004 PerlIO_printf(Perl_debug_log, "Copy on write: clear\n");
e419cbc5 6005 sv_dump(sv);
46187eeb 6006 }
e419cbc5 6007 sv_release_COW(sv, SvPVX(sv), SvCUR(sv), SvLEN(sv),
765f542d
NC
6008 SvUVX(sv), SV_COW_NEXT_SV(sv));
6009 /* And drop it here. */
6010 SvFAKE_off(sv);
6011 } else if (SvLEN(sv)) {
6012 Safefree(SvPVX(sv));
6013 }
6014 }
6015#else
1edc1566 6016 else if (SvPVX(sv) && SvLEN(sv))
463ee0b2 6017 Safefree(SvPVX(sv));
1c846c1f 6018 else if (SvPVX(sv) && SvREADONLY(sv) && SvFAKE(sv)) {
25716404
GS
6019 unsharepvn(SvPVX(sv),
6020 SvUTF8(sv) ? -(I32)SvCUR(sv) : SvCUR(sv),
6021 SvUVX(sv));
1c846c1f
NIS
6022 SvFAKE_off(sv);
6023 }
765f542d 6024#endif
79072805 6025 break;
a0d0e21e 6026/*
79072805 6027 case SVt_NV:
79072805 6028 case SVt_IV:
79072805
LW
6029 case SVt_NULL:
6030 break;
a0d0e21e 6031*/
79072805
LW
6032 }
6033
6034 switch (SvTYPE(sv)) {
6035 case SVt_NULL:
6036 break;
79072805
LW
6037 case SVt_IV:
6038 del_XIV(SvANY(sv));
6039 break;
6040 case SVt_NV:
6041 del_XNV(SvANY(sv));
6042 break;
ed6116ce
LW
6043 case SVt_RV:
6044 del_XRV(SvANY(sv));
6045 break;
79072805
LW
6046 case SVt_PV:
6047 del_XPV(SvANY(sv));
6048 break;
6049 case SVt_PVIV:
6050 del_XPVIV(SvANY(sv));
6051 break;
6052 case SVt_PVNV:
6053 del_XPVNV(SvANY(sv));
6054 break;
6055 case SVt_PVMG:
6056 del_XPVMG(SvANY(sv));
6057 break;
6058 case SVt_PVLV:
6059 del_XPVLV(SvANY(sv));
6060 break;
6061 case SVt_PVAV:
6062 del_XPVAV(SvANY(sv));
6063 break;
6064 case SVt_PVHV:
6065 del_XPVHV(SvANY(sv));
6066 break;
6067 case SVt_PVCV:
6068 del_XPVCV(SvANY(sv));
6069 break;
6070 case SVt_PVGV:
6071 del_XPVGV(SvANY(sv));
ec12f114
JPC
6072 /* code duplication for increased performance. */
6073 SvFLAGS(sv) &= SVf_BREAK;
6074 SvFLAGS(sv) |= SVTYPEMASK;
6075 /* decrease refcount of the stash that owns this GV, if any */
6076 if (stash)
6077 SvREFCNT_dec(stash);
6078 return; /* not break, SvFLAGS reset already happened */
79072805
LW
6079 case SVt_PVBM:
6080 del_XPVBM(SvANY(sv));
6081 break;
6082 case SVt_PVFM:
6083 del_XPVFM(SvANY(sv));
6084 break;
8990e307
LW
6085 case SVt_PVIO:
6086 del_XPVIO(SvANY(sv));
6087 break;
79072805 6088 }
a0d0e21e 6089 SvFLAGS(sv) &= SVf_BREAK;
8990e307 6090 SvFLAGS(sv) |= SVTYPEMASK;
79072805
LW
6091}
6092
645c22ef
DM
6093/*
6094=for apidoc sv_newref
6095
6096Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
6097instead.
6098
6099=cut
6100*/
6101
79072805 6102SV *
864dbfa3 6103Perl_sv_newref(pTHX_ SV *sv)
79072805 6104{
463ee0b2 6105 if (sv)
4db098f4 6106 (SvREFCNT(sv))++;
79072805
LW
6107 return sv;
6108}
6109
c461cf8f
JH
6110/*
6111=for apidoc sv_free
6112
645c22ef
DM
6113Decrement an SV's reference count, and if it drops to zero, call
6114C<sv_clear> to invoke destructors and free up any memory used by
6115the body; finally, deallocate the SV's head itself.
6116Normally called via a wrapper macro C<SvREFCNT_dec>.
c461cf8f
JH
6117
6118=cut
6119*/
6120
79072805 6121void
864dbfa3 6122Perl_sv_free(pTHX_ SV *sv)
79072805
LW
6123{
6124 if (!sv)
6125 return;
a0d0e21e
LW
6126 if (SvREFCNT(sv) == 0) {
6127 if (SvFLAGS(sv) & SVf_BREAK)
645c22ef
DM
6128 /* this SV's refcnt has been artificially decremented to
6129 * trigger cleanup */
a0d0e21e 6130 return;
3280af22 6131 if (PL_in_clean_all) /* All is fair */
1edc1566 6132 return;
d689ffdd
JP
6133 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6134 /* make sure SvREFCNT(sv)==0 happens very seldom */
6135 SvREFCNT(sv) = (~(U32)0)/2;
6136 return;
6137 }
0453d815 6138 if (ckWARN_d(WARN_INTERNAL))
d5dede04 6139 Perl_warner(aTHX_ packWARN(WARN_INTERNAL),
472d47bc
SB
6140 "Attempt to free unreferenced scalar: SV 0x%"UVxf
6141 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
79072805
LW
6142 return;
6143 }
4db098f4 6144 if (--(SvREFCNT(sv)) > 0)
8990e307 6145 return;
8c4d3c90
NC
6146 Perl_sv_free2(aTHX_ sv);
6147}
6148
6149void
6150Perl_sv_free2(pTHX_ SV *sv)
6151{
463ee0b2
LW
6152#ifdef DEBUGGING
6153 if (SvTEMP(sv)) {
0453d815 6154 if (ckWARN_d(WARN_DEBUGGING))
9014280d 6155 Perl_warner(aTHX_ packWARN(WARN_DEBUGGING),
472d47bc
SB
6156 "Attempt to free temp prematurely: SV 0x%"UVxf
6157 pTHX__FORMAT, PTR2UV(sv) pTHX__VALUE);
79072805 6158 return;
79072805 6159 }
463ee0b2 6160#endif
d689ffdd
JP
6161 if (SvREADONLY(sv) && SvIMMORTAL(sv)) {
6162 /* make sure SvREFCNT(sv)==0 happens very seldom */
6163 SvREFCNT(sv) = (~(U32)0)/2;
6164 return;
6165 }
79072805 6166 sv_clear(sv);
477f5d66
CS
6167 if (! SvREFCNT(sv))
6168 del_SV(sv);
79072805
LW
6169}
6170
954c1994
GS
6171/*
6172=for apidoc sv_len
6173
645c22ef
DM
6174Returns the length of the string in the SV. Handles magic and type
6175coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
954c1994
GS
6176
6177=cut
6178*/
6179
79072805 6180STRLEN
864dbfa3 6181Perl_sv_len(pTHX_ register SV *sv)
79072805 6182{
463ee0b2 6183 STRLEN len;
79072805
LW
6184
6185 if (!sv)
6186 return 0;
6187
8990e307 6188 if (SvGMAGICAL(sv))
565764a8 6189 len = mg_length(sv);
8990e307 6190 else
497b47a8 6191 (void)SvPV(sv, len);
463ee0b2 6192 return len;
79072805
LW
6193}
6194
c461cf8f
JH
6195/*
6196=for apidoc sv_len_utf8
6197
6198Returns the number of characters in the string in an SV, counting wide
1e54db1a 6199UTF-8 bytes as a single character. Handles magic and type coercion.
c461cf8f
JH
6200
6201=cut
6202*/
6203
7e8c5dac
HS
6204/*
6205 * The length is cached in PERL_UTF8_magic, in the mg_len field. Also the
6206 * mg_ptr is used, by sv_pos_u2b(), see the comments of S_utf8_mg_pos_init().
6207 * (Note that the mg_len is not the length of the mg_ptr field.)
7a5fa8a2 6208 *
7e8c5dac
HS
6209 */
6210
a0ed51b3 6211STRLEN
864dbfa3 6212Perl_sv_len_utf8(pTHX_ register SV *sv)
a0ed51b3 6213{
a0ed51b3
LW
6214 if (!sv)
6215 return 0;
6216
a0ed51b3 6217 if (SvGMAGICAL(sv))
b76347f2 6218 return mg_length(sv);
a0ed51b3 6219 else
b76347f2 6220 {
7e8c5dac 6221 STRLEN len, ulen;
b76347f2 6222 U8 *s = (U8*)SvPV(sv, len);
7e8c5dac
HS
6223 MAGIC *mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_utf8) : 0;
6224
e23c8137 6225 if (mg && mg->mg_len != -1 && (mg->mg_len > 0 || len == 0)) {
7e8c5dac 6226 ulen = mg->mg_len;
e23c8137
JH
6227#ifdef PERL_UTF8_CACHE_ASSERT
6228 assert(ulen == Perl_utf8_length(aTHX_ s, s + len));
6229#endif
6230 }
7e8c5dac
HS
6231 else {
6232 ulen = Perl_utf8_length(aTHX_ s, s + len);
6233 if (!mg && !SvREADONLY(sv)) {
6234 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6235 mg = mg_find(sv, PERL_MAGIC_utf8);
6236 assert(mg);
6237 }
6238 if (mg)
6239 mg->mg_len = ulen;
6240 }
6241 return ulen;
6242 }
6243}
6244
6245/* S_utf8_mg_pos_init() is used to initialize the mg_ptr field of
6246 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6247 * between UTF-8 and byte offsets. There are two (substr offset and substr
6248 * length, the i offset, PERL_MAGIC_UTF8_CACHESIZE) times two (UTF-8 offset
6249 * and byte offset) cache positions.
6250 *
6251 * The mg_len field is used by sv_len_utf8(), see its comments.
6252 * Note that the mg_len is not the length of the mg_ptr field.
6253 *
6254 */
6255STATIC bool
6e551876 6256S_utf8_mg_pos_init(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, U8 *s, U8 *start)
7e8c5dac 6257{
7a5fa8a2 6258 bool found = FALSE;
7e8c5dac
HS
6259
6260 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
8f78557a
AE
6261 if (!*mgp)
6262 *mgp = sv_magicext(sv, 0, PERL_MAGIC_utf8, &PL_vtbl_utf8, 0, 0);
7e8c5dac 6263 assert(*mgp);
b76347f2 6264
7e8c5dac
HS
6265 if ((*mgp)->mg_ptr)
6266 *cachep = (STRLEN *) (*mgp)->mg_ptr;
6267 else {
6268 Newz(0, *cachep, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
6269 (*mgp)->mg_ptr = (char *) *cachep;
6270 }
6271 assert(*cachep);
6272
6273 (*cachep)[i] = *offsetp;
6274 (*cachep)[i+1] = s - start;
6275 found = TRUE;
a0ed51b3 6276 }
7e8c5dac
HS
6277
6278 return found;
a0ed51b3
LW
6279}
6280
645c22ef 6281/*
7e8c5dac
HS
6282 * S_utf8_mg_pos() is used to query and update mg_ptr field of
6283 * a PERL_UTF8_magic. The mg_ptr is used to store the mapping
6284 * between UTF-8 and byte offsets. See also the comments of
6285 * S_utf8_mg_pos_init().
6286 *
6287 */
6288STATIC bool
6e551876 6289S_utf8_mg_pos(pTHX_ SV *sv, MAGIC **mgp, STRLEN **cachep, I32 i, I32 *offsetp, I32 uoff, U8 **sp, U8 *start, U8 *send)
7e8c5dac
HS
6290{
6291 bool found = FALSE;
6292
6293 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6294 if (!*mgp)
6295 *mgp = mg_find(sv, PERL_MAGIC_utf8);
6296 if (*mgp && (*mgp)->mg_ptr) {
6297 *cachep = (STRLEN *) (*mgp)->mg_ptr;
e23c8137 6298 ASSERT_UTF8_CACHE(*cachep);
667208dd 6299 if ((*cachep)[i] == (STRLEN)uoff) /* An exact match. */
7a5fa8a2 6300 found = TRUE;
7e8c5dac
HS
6301 else { /* We will skip to the right spot. */
6302 STRLEN forw = 0;
6303 STRLEN backw = 0;
6304 U8* p = NULL;
6305
6306 /* The assumption is that going backward is half
6307 * the speed of going forward (that's where the
6308 * 2 * backw in the below comes from). (The real
6309 * figure of course depends on the UTF-8 data.) */
6310
667208dd 6311 if ((*cachep)[i] > (STRLEN)uoff) {
7e8c5dac 6312 forw = uoff;
667208dd 6313 backw = (*cachep)[i] - (STRLEN)uoff;
7e8c5dac
HS
6314
6315 if (forw < 2 * backw)
6316 p = start;
6317 else
6318 p = start + (*cachep)[i+1];
6319 }
6320 /* Try this only for the substr offset (i == 0),
6321 * not for the substr length (i == 2). */
6322 else if (i == 0) { /* (*cachep)[i] < uoff */
6323 STRLEN ulen = sv_len_utf8(sv);
6324
667208dd
JH
6325 if ((STRLEN)uoff < ulen) {
6326 forw = (STRLEN)uoff - (*cachep)[i];
6327 backw = ulen - (STRLEN)uoff;
7e8c5dac
HS
6328
6329 if (forw < 2 * backw)
6330 p = start + (*cachep)[i+1];
6331 else
6332 p = send;
6333 }
6334
6335 /* If the string is not long enough for uoff,
6336 * we could extend it, but not at this low a level. */
6337 }
6338
6339 if (p) {
6340 if (forw < 2 * backw) {
6341 while (forw--)
6342 p += UTF8SKIP(p);
6343 }
6344 else {
6345 while (backw--) {
6346 p--;
6347 while (UTF8_IS_CONTINUATION(*p))
6348 p--;
6349 }
6350 }
6351
6352 /* Update the cache. */
667208dd 6353 (*cachep)[i] = (STRLEN)uoff;
7e8c5dac 6354 (*cachep)[i+1] = p - start;
8f78557a
AE
6355
6356 /* Drop the stale "length" cache */
6357 if (i == 0) {
6358 (*cachep)[2] = 0;
6359 (*cachep)[3] = 0;
6360 }
7a5fa8a2 6361
7e8c5dac
HS
6362 found = TRUE;
6363 }
6364 }
6365 if (found) { /* Setup the return values. */
6366 *offsetp = (*cachep)[i+1];
6367 *sp = start + *offsetp;
6368 if (*sp >= send) {
6369 *sp = send;
6370 *offsetp = send - start;
6371 }
6372 else if (*sp < start) {
6373 *sp = start;
6374 *offsetp = 0;
6375 }
6376 }
6377 }
e23c8137
JH
6378#ifdef PERL_UTF8_CACHE_ASSERT
6379 if (found) {
6380 U8 *s = start;
6381 I32 n = uoff;
6382
6383 while (n-- && s < send)
6384 s += UTF8SKIP(s);
6385
6386 if (i == 0) {
6387 assert(*offsetp == s - start);
6388 assert((*cachep)[0] == (STRLEN)uoff);
6389 assert((*cachep)[1] == *offsetp);
6390 }
6391 ASSERT_UTF8_CACHE(*cachep);
6392 }
6393#endif
7e8c5dac 6394 }
e23c8137 6395
7e8c5dac
HS
6396 return found;
6397}
7a5fa8a2 6398
7e8c5dac 6399/*
645c22ef
DM
6400=for apidoc sv_pos_u2b
6401
1e54db1a 6402Converts the value pointed to by offsetp from a count of UTF-8 chars from
645c22ef
DM
6403the start of the string, to a count of the equivalent number of bytes; if
6404lenp is non-zero, it does the same to lenp, but this time starting from
6405the offset, rather than from the start of the string. Handles magic and
6406type coercion.
6407
6408=cut
6409*/
6410
7e8c5dac
HS
6411/*
6412 * sv_pos_u2b() uses, like sv_pos_b2u(), the mg_ptr of the potential
6413 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6414 * byte offsets. See also the comments of S_utf8_mg_pos().
6415 *
6416 */
6417
a0ed51b3 6418void
864dbfa3 6419Perl_sv_pos_u2b(pTHX_ register SV *sv, I32* offsetp, I32* lenp)
a0ed51b3 6420{
dfe13c55
GS
6421 U8 *start;
6422 U8 *s;
a0ed51b3 6423 STRLEN len;
7e8c5dac
HS
6424 STRLEN *cache = 0;
6425 STRLEN boffset = 0;
a0ed51b3
LW
6426
6427 if (!sv)
6428 return;
6429
dfe13c55 6430 start = s = (U8*)SvPV(sv, len);
7e8c5dac
HS
6431 if (len) {
6432 I32 uoffset = *offsetp;
6433 U8 *send = s + len;
6434 MAGIC *mg = 0;
6435 bool found = FALSE;
6436
bdf77a2a 6437 if (utf8_mg_pos(sv, &mg, &cache, 0, offsetp, *offsetp, &s, start, send))
7e8c5dac
HS
6438 found = TRUE;
6439 if (!found && uoffset > 0) {
6440 while (s < send && uoffset--)
6441 s += UTF8SKIP(s);
6442 if (s >= send)
6443 s = send;
bdf77a2a 6444 if (utf8_mg_pos_init(sv, &mg, &cache, 0, offsetp, s, start))
7e8c5dac
HS
6445 boffset = cache[1];
6446 *offsetp = s - start;
6447 }
6448 if (lenp) {
6449 found = FALSE;
6450 start = s;
bdf77a2a 6451 if (utf8_mg_pos(sv, &mg, &cache, 2, lenp, *lenp + *offsetp, &s, start, send)) {
7e8c5dac
HS
6452 *lenp -= boffset;
6453 found = TRUE;
6454 }
6455 if (!found && *lenp > 0) {
6456 I32 ulen = *lenp;
6457 if (ulen > 0)
6458 while (s < send && ulen--)
6459 s += UTF8SKIP(s);
6460 if (s >= send)
6461 s = send;
a67d7df9 6462 utf8_mg_pos_init(sv, &mg, &cache, 2, lenp, s, start);
7e8c5dac
HS
6463 }
6464 *lenp = s - start;
6465 }
e23c8137 6466 ASSERT_UTF8_CACHE(cache);
7e8c5dac
HS
6467 }
6468 else {
6469 *offsetp = 0;
6470 if (lenp)
6471 *lenp = 0;
a0ed51b3 6472 }
e23c8137 6473
a0ed51b3
LW
6474 return;
6475}
6476
645c22ef
DM
6477/*
6478=for apidoc sv_pos_b2u
6479
6480Converts the value pointed to by offsetp from a count of bytes from the
1e54db1a 6481start of the string, to a count of the equivalent number of UTF-8 chars.
645c22ef
DM
6482Handles magic and type coercion.
6483
6484=cut
6485*/
6486
7e8c5dac
HS
6487/*
6488 * sv_pos_b2u() uses, like sv_pos_u2b(), the mg_ptr of the potential
6489 * PERL_UTF8_magic of the sv to store the mapping between UTF-8 and
6490 * byte offsets. See also the comments of S_utf8_mg_pos().
6491 *
6492 */
6493
a0ed51b3 6494void
7e8c5dac 6495Perl_sv_pos_b2u(pTHX_ register SV* sv, I32* offsetp)
a0ed51b3 6496{
7e8c5dac 6497 U8* s;
a0ed51b3
LW
6498 STRLEN len;
6499
6500 if (!sv)
6501 return;
6502
dfe13c55 6503 s = (U8*)SvPV(sv, len);
eb160463 6504 if ((I32)len < *offsetp)
a0dbb045 6505 Perl_croak(aTHX_ "panic: sv_pos_b2u: bad byte offset");
7e8c5dac
HS
6506 else {
6507 U8* send = s + *offsetp;
6508 MAGIC* mg = NULL;
6509 STRLEN *cache = NULL;
6510
6511 len = 0;
6512
6513 if (SvMAGICAL(sv) && !SvREADONLY(sv)) {
6514 mg = mg_find(sv, PERL_MAGIC_utf8);
6515 if (mg && mg->mg_ptr) {
6516 cache = (STRLEN *) mg->mg_ptr;
c5661c80 6517 if (cache[1] == (STRLEN)*offsetp) {
7e8c5dac
HS
6518 /* An exact match. */
6519 *offsetp = cache[0];
6520
6521 return;
6522 }
c5661c80 6523 else if (cache[1] < (STRLEN)*offsetp) {
7e8c5dac
HS
6524 /* We already know part of the way. */
6525 len = cache[0];
6526 s += cache[1];
7a5fa8a2 6527 /* Let the below loop do the rest. */
7e8c5dac
HS
6528 }
6529 else { /* cache[1] > *offsetp */
6530 /* We already know all of the way, now we may
6531 * be able to walk back. The same assumption
6532 * is made as in S_utf8_mg_pos(), namely that
6533 * walking backward is twice slower than
6534 * walking forward. */
6535 STRLEN forw = *offsetp;
6536 STRLEN backw = cache[1] - *offsetp;
6537
6538 if (!(forw < 2 * backw)) {
6539 U8 *p = s + cache[1];
6540 STRLEN ubackw = 0;
7a5fa8a2 6541
a5b510f2
AE
6542 cache[1] -= backw;
6543
7e8c5dac
HS
6544 while (backw--) {
6545 p--;
0aeb64d0 6546 while (UTF8_IS_CONTINUATION(*p)) {
7e8c5dac 6547 p--;
0aeb64d0
JH
6548 backw--;
6549 }
7e8c5dac
HS
6550 ubackw++;
6551 }
6552
6553 cache[0] -= ubackw;
0aeb64d0 6554 *offsetp = cache[0];
a67d7df9
TS
6555
6556 /* Drop the stale "length" cache */
6557 cache[2] = 0;
6558 cache[3] = 0;
6559
0aeb64d0 6560 return;
7e8c5dac
HS
6561 }
6562 }
6563 }
e23c8137 6564 ASSERT_UTF8_CACHE(cache);
a0dbb045 6565 }
7e8c5dac
HS
6566
6567 while (s < send) {
6568 STRLEN n = 1;
6569
6570 /* Call utf8n_to_uvchr() to validate the sequence
6571 * (unless a simple non-UTF character) */
6572 if (!UTF8_IS_INVARIANT(*s))
6573 utf8n_to_uvchr(s, UTF8SKIP(s), &n, 0);
6574 if (n > 0) {
6575 s += n;
6576 len++;
6577 }
6578 else
6579 break;
6580 }
6581
6582 if (!SvREADONLY(sv)) {
6583 if (!mg) {
6584 sv_magic(sv, 0, PERL_MAGIC_utf8, 0, 0);
6585 mg = mg_find(sv, PERL_MAGIC_utf8);
6586 }
6587 assert(mg);
6588
6589 if (!mg->mg_ptr) {
979acdb5 6590 Newz(0, cache, PERL_MAGIC_UTF8_CACHESIZE * 2, STRLEN);
7e8c5dac
HS
6591 mg->mg_ptr = (char *) cache;
6592 }
6593 assert(cache);
6594
6595 cache[0] = len;
6596 cache[1] = *offsetp;
a67d7df9
TS
6597 /* Drop the stale "length" cache */
6598 cache[2] = 0;
6599 cache[3] = 0;
7e8c5dac
HS
6600 }
6601
6602 *offsetp = len;
a0ed51b3 6603 }
a0ed51b3
LW
6604 return;
6605}
6606
954c1994
GS
6607/*
6608=for apidoc sv_eq
6609
6610Returns a boolean indicating whether the strings in the two SVs are
645c22ef
DM
6611identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6612coerce its args to strings if necessary.
954c1994
GS
6613
6614=cut
6615*/
6616
79072805 6617I32
e01b9e88 6618Perl_sv_eq(pTHX_ register SV *sv1, register SV *sv2)
79072805
LW
6619{
6620 char *pv1;
463ee0b2 6621 STRLEN cur1;
79072805 6622 char *pv2;
463ee0b2 6623 STRLEN cur2;
e01b9e88 6624 I32 eq = 0;
553e1bcc
AT
6625 char *tpv = Nullch;
6626 SV* svrecode = Nullsv;
79072805 6627
e01b9e88 6628 if (!sv1) {
79072805
LW
6629 pv1 = "";
6630 cur1 = 0;
6631 }
463ee0b2 6632 else
e01b9e88 6633 pv1 = SvPV(sv1, cur1);
79072805 6634
e01b9e88
SC
6635 if (!sv2){
6636 pv2 = "";
6637 cur2 = 0;
92d29cee 6638 }
e01b9e88
SC
6639 else
6640 pv2 = SvPV(sv2, cur2);
79072805 6641
cf48d248 6642 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
799ef3cb
JH
6643 /* Differing utf8ness.
6644 * Do not UTF8size the comparands as a side-effect. */
6645 if (PL_encoding) {
6646 if (SvUTF8(sv1)) {
553e1bcc
AT
6647 svrecode = newSVpvn(pv2, cur2);
6648 sv_recode_to_utf8(svrecode, PL_encoding);
6649 pv2 = SvPV(svrecode, cur2);
799ef3cb
JH
6650 }
6651 else {
553e1bcc
AT
6652 svrecode = newSVpvn(pv1, cur1);
6653 sv_recode_to_utf8(svrecode, PL_encoding);
6654 pv1 = SvPV(svrecode, cur1);
799ef3cb
JH
6655 }
6656 /* Now both are in UTF-8. */
0a1bd7ac
DM
6657 if (cur1 != cur2) {
6658 SvREFCNT_dec(svrecode);
799ef3cb 6659 return FALSE;
0a1bd7ac 6660 }
799ef3cb
JH
6661 }
6662 else {
6663 bool is_utf8 = TRUE;
6664
6665 if (SvUTF8(sv1)) {
6666 /* sv1 is the UTF-8 one,
6667 * if is equal it must be downgrade-able */
6668 char *pv = (char*)bytes_from_utf8((U8*)pv1,
6669 &cur1, &is_utf8);
6670 if (pv != pv1)
553e1bcc 6671 pv1 = tpv = pv;
799ef3cb
JH
6672 }
6673 else {
6674 /* sv2 is the UTF-8 one,
6675 * if is equal it must be downgrade-able */
6676 char *pv = (char *)bytes_from_utf8((U8*)pv2,
6677 &cur2, &is_utf8);
6678 if (pv != pv2)
553e1bcc 6679 pv2 = tpv = pv;
799ef3cb
JH
6680 }
6681 if (is_utf8) {
6682 /* Downgrade not possible - cannot be eq */
bf694877 6683 assert (tpv == 0);
799ef3cb
JH
6684 return FALSE;
6685 }
6686 }
cf48d248
JH
6687 }
6688
6689 if (cur1 == cur2)
765f542d 6690 eq = (pv1 == pv2) || memEQ(pv1, pv2, cur1);
e01b9e88 6691
553e1bcc
AT
6692 if (svrecode)
6693 SvREFCNT_dec(svrecode);
799ef3cb 6694
553e1bcc
AT
6695 if (tpv)
6696 Safefree(tpv);
cf48d248 6697
e01b9e88 6698 return eq;
79072805
LW
6699}
6700
954c1994
GS
6701/*
6702=for apidoc sv_cmp
6703
6704Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
6705string in C<sv1> is less than, equal to, or greater than the string in
645c22ef
DM
6706C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
6707coerce its args to strings if necessary. See also C<sv_cmp_locale>.
954c1994
GS
6708
6709=cut
6710*/
6711
79072805 6712I32
e01b9e88 6713Perl_sv_cmp(pTHX_ register SV *sv1, register SV *sv2)
79072805 6714{
560a288e 6715 STRLEN cur1, cur2;
553e1bcc 6716 char *pv1, *pv2, *tpv = Nullch;
cf48d248 6717 I32 cmp;
553e1bcc 6718 SV *svrecode = Nullsv;
560a288e 6719
e01b9e88
SC
6720 if (!sv1) {
6721 pv1 = "";
560a288e
GS
6722 cur1 = 0;
6723 }
e01b9e88
SC
6724 else
6725 pv1 = SvPV(sv1, cur1);
560a288e 6726
553e1bcc 6727 if (!sv2) {
e01b9e88 6728 pv2 = "";
560a288e
GS
6729 cur2 = 0;
6730 }
e01b9e88
SC
6731 else
6732 pv2 = SvPV(sv2, cur2);
79072805 6733
cf48d248 6734 if (cur1 && cur2 && SvUTF8(sv1) != SvUTF8(sv2) && !IN_BYTES) {
799ef3cb
JH
6735 /* Differing utf8ness.
6736 * Do not UTF8size the comparands as a side-effect. */
cf48d248 6737 if (SvUTF8(sv1)) {
799ef3cb 6738 if (PL_encoding) {
553e1bcc
AT
6739 svrecode = newSVpvn(pv2, cur2);
6740 sv_recode_to_utf8(svrecode, PL_encoding);
6741 pv2 = SvPV(svrecode, cur2);
799ef3cb
JH
6742 }
6743 else {
553e1bcc 6744 pv2 = tpv = (char*)bytes_to_utf8((U8*)pv2, &cur2);
799ef3cb 6745 }
cf48d248
JH
6746 }
6747 else {
799ef3cb 6748 if (PL_encoding) {
553e1bcc
AT
6749 svrecode = newSVpvn(pv1, cur1);
6750 sv_recode_to_utf8(svrecode, PL_encoding);
6751 pv1 = SvPV(svrecode, cur1);
799ef3cb
JH
6752 }
6753 else {
553e1bcc 6754 pv1 = tpv = (char*)bytes_to_utf8((U8*)pv1, &cur1);
799ef3cb 6755 }
cf48d248
JH
6756 }
6757 }
6758
e01b9e88 6759 if (!cur1) {
cf48d248 6760 cmp = cur2 ? -1 : 0;
e01b9e88 6761 } else if (!cur2) {
cf48d248
JH
6762 cmp = 1;
6763 } else {
6764 I32 retval = memcmp((void*)pv1, (void*)pv2, cur1 < cur2 ? cur1 : cur2);
e01b9e88
SC
6765
6766 if (retval) {
cf48d248 6767 cmp = retval < 0 ? -1 : 1;
e01b9e88 6768 } else if (cur1 == cur2) {
cf48d248
JH
6769 cmp = 0;
6770 } else {
6771 cmp = cur1 < cur2 ? -1 : 1;
e01b9e88 6772 }
cf48d248 6773 }
16660edb 6774
553e1bcc
AT
6775 if (svrecode)
6776 SvREFCNT_dec(svrecode);
799ef3cb 6777
553e1bcc
AT
6778 if (tpv)
6779 Safefree(tpv);
cf48d248
JH
6780
6781 return cmp;
bbce6d69 6782}
16660edb 6783
c461cf8f
JH
6784/*
6785=for apidoc sv_cmp_locale
6786
645c22ef
DM
6787Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
6788'use bytes' aware, handles get magic, and will coerce its args to strings
6789if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
c461cf8f
JH
6790
6791=cut
6792*/
6793
bbce6d69 6794I32
864dbfa3 6795Perl_sv_cmp_locale(pTHX_ register SV *sv1, register SV *sv2)
bbce6d69 6796{
36477c24 6797#ifdef USE_LOCALE_COLLATE
16660edb 6798
bbce6d69 6799 char *pv1, *pv2;
6800 STRLEN len1, len2;
6801 I32 retval;
16660edb 6802
3280af22 6803 if (PL_collation_standard)
bbce6d69 6804 goto raw_compare;
16660edb 6805
bbce6d69 6806 len1 = 0;
8ac85365 6807 pv1 = sv1 ? sv_collxfrm(sv1, &len1) : (char *) NULL;
bbce6d69 6808 len2 = 0;
8ac85365 6809 pv2 = sv2 ? sv_collxfrm(sv2, &len2) : (char *) NULL;
16660edb 6810
bbce6d69 6811 if (!pv1 || !len1) {
6812 if (pv2 && len2)
6813 return -1;
6814 else
6815 goto raw_compare;
6816 }
6817 else {
6818 if (!pv2 || !len2)
6819 return 1;
6820 }
16660edb 6821
bbce6d69 6822 retval = memcmp((void*)pv1, (void*)pv2, len1 < len2 ? len1 : len2);
16660edb 6823
bbce6d69 6824 if (retval)
16660edb 6825 return retval < 0 ? -1 : 1;
6826
bbce6d69 6827 /*
6828 * When the result of collation is equality, that doesn't mean
6829 * that there are no differences -- some locales exclude some
6830 * characters from consideration. So to avoid false equalities,
6831 * we use the raw string as a tiebreaker.
6832 */
16660edb 6833
bbce6d69 6834 raw_compare:
6835 /* FALL THROUGH */
16660edb 6836
36477c24 6837#endif /* USE_LOCALE_COLLATE */
16660edb 6838
bbce6d69 6839 return sv_cmp(sv1, sv2);
6840}
79072805 6841
645c22ef 6842
36477c24 6843#ifdef USE_LOCALE_COLLATE
645c22ef 6844
7a4c00b4 6845/*
645c22ef
DM
6846=for apidoc sv_collxfrm
6847
6848Add Collate Transform magic to an SV if it doesn't already have it.
6849
6850Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
6851scalar data of the variable, but transformed to such a format that a normal
6852memory comparison can be used to compare the data according to the locale
6853settings.
6854
6855=cut
6856*/
6857
bbce6d69 6858char *
864dbfa3 6859Perl_sv_collxfrm(pTHX_ SV *sv, STRLEN *nxp)
bbce6d69 6860{
7a4c00b4 6861 MAGIC *mg;
16660edb 6862
14befaf4 6863 mg = SvMAGICAL(sv) ? mg_find(sv, PERL_MAGIC_collxfrm) : (MAGIC *) NULL;
3280af22 6864 if (!mg || !mg->mg_ptr || *(U32*)mg->mg_ptr != PL_collation_ix) {
bbce6d69 6865 char *s, *xf;
6866 STRLEN len, xlen;
6867
7a4c00b4 6868 if (mg)
6869 Safefree(mg->mg_ptr);
bbce6d69 6870 s = SvPV(sv, len);
6871 if ((xf = mem_collxfrm(s, len, &xlen))) {
ff0cee69 6872 if (SvREADONLY(sv)) {
6873 SAVEFREEPV(xf);
6874 *nxp = xlen;
3280af22 6875 return xf + sizeof(PL_collation_ix);
ff0cee69 6876 }
7a4c00b4 6877 if (! mg) {
14befaf4
DM
6878 sv_magic(sv, 0, PERL_MAGIC_collxfrm, 0, 0);
6879 mg = mg_find(sv, PERL_MAGIC_collxfrm);
7a4c00b4 6880 assert(mg);
bbce6d69 6881 }
7a4c00b4 6882 mg->mg_ptr = xf;
565764a8 6883 mg->mg_len = xlen;
7a4c00b4 6884 }
6885 else {
ff0cee69 6886 if (mg) {
6887 mg->mg_ptr = NULL;
565764a8 6888 mg->mg_len = -1;
ff0cee69 6889 }
bbce6d69 6890 }
6891 }
7a4c00b4 6892 if (mg && mg->mg_ptr) {
565764a8 6893 *nxp = mg->mg_len;
3280af22 6894 return mg->mg_ptr + sizeof(PL_collation_ix);
bbce6d69 6895 }
6896 else {
6897 *nxp = 0;
6898 return NULL;
16660edb 6899 }
79072805
LW
6900}
6901
36477c24 6902#endif /* USE_LOCALE_COLLATE */
bbce6d69 6903
c461cf8f
JH
6904/*
6905=for apidoc sv_gets
6906
6907Get a line from the filehandle and store it into the SV, optionally
6908appending to the currently-stored string.
6909
6910=cut
6911*/
6912
79072805 6913char *
864dbfa3 6914Perl_sv_gets(pTHX_ register SV *sv, register PerlIO *fp, I32 append)
79072805 6915{
c07a80fd 6916 char *rsptr;
6917 STRLEN rslen;
6918 register STDCHAR rslast;
6919 register STDCHAR *bp;
6920 register I32 cnt;
9c5ffd7c 6921 I32 i = 0;
8bfdd7d9 6922 I32 rspara = 0;
e311fd51 6923 I32 recsize;
c07a80fd 6924
bc44a8a2
NC
6925 if (SvTHINKFIRST(sv))
6926 sv_force_normal_flags(sv, append ? 0 : SV_COW_DROP_PV);
765f542d
NC
6927 /* XXX. If you make this PVIV, then copy on write can copy scalars read
6928 from <>.
6929 However, perlbench says it's slower, because the existing swipe code
6930 is faster than copy on write.
6931 Swings and roundabouts. */
6fc92669 6932 (void)SvUPGRADE(sv, SVt_PV);
99491443 6933
ff68c719 6934 SvSCREAM_off(sv);
efd8b2ba
AE
6935
6936 if (append) {
6937 if (PerlIO_isutf8(fp)) {
6938 if (!SvUTF8(sv)) {
6939 sv_utf8_upgrade_nomg(sv);
6940 sv_pos_u2b(sv,&append,0);
6941 }
6942 } else if (SvUTF8(sv)) {
6943 SV *tsv = NEWSV(0,0);
6944 sv_gets(tsv, fp, 0);
6945 sv_utf8_upgrade_nomg(tsv);
6946 SvCUR_set(sv,append);
6947 sv_catsv(sv,tsv);
6948 sv_free(tsv);
6949 goto return_string_or_null;
6950 }
6951 }
6952
6953 SvPOK_only(sv);
6954 if (PerlIO_isutf8(fp))
6955 SvUTF8_on(sv);
c07a80fd 6956
923e4eb5 6957 if (IN_PERL_COMPILETIME) {
8bfdd7d9
HS
6958 /* we always read code in line mode */
6959 rsptr = "\n";
6960 rslen = 1;
6961 }
6962 else if (RsSNARF(PL_rs)) {
7a5fa8a2
NIS
6963 /* If it is a regular disk file use size from stat() as estimate
6964 of amount we are going to read - may result in malloc-ing
6965 more memory than we realy need if layers bellow reduce
e468d35b
NIS
6966 size we read (e.g. CRLF or a gzip layer)
6967 */
e311fd51 6968 Stat_t st;
e468d35b
NIS
6969 if (!PerlLIO_fstat(PerlIO_fileno(fp), &st) && S_ISREG(st.st_mode)) {
6970 Off_t offset = PerlIO_tell(fp);
58f1856e 6971 if (offset != (Off_t) -1 && st.st_size + append > offset) {
e468d35b
NIS
6972 (void) SvGROW(sv, (STRLEN)((st.st_size - offset) + append + 1));
6973 }
6974 }
c07a80fd 6975 rsptr = NULL;
6976 rslen = 0;
6977 }
3280af22 6978 else if (RsRECORD(PL_rs)) {
e311fd51 6979 I32 bytesread;
5b2b9c68
HM
6980 char *buffer;
6981
6982 /* Grab the size of the record we're getting */
3280af22 6983 recsize = SvIV(SvRV(PL_rs));
e311fd51 6984 buffer = SvGROW(sv, (STRLEN)(recsize + append + 1)) + append;
5b2b9c68
HM
6985 /* Go yank in */
6986#ifdef VMS
6987 /* VMS wants read instead of fread, because fread doesn't respect */
6988 /* RMS record boundaries. This is not necessarily a good thing to be */
e468d35b
NIS
6989 /* doing, but we've got no other real choice - except avoid stdio
6990 as implementation - perhaps write a :vms layer ?
6991 */
5b2b9c68
HM
6992 bytesread = PerlLIO_read(PerlIO_fileno(fp), buffer, recsize);
6993#else
6994 bytesread = PerlIO_read(fp, buffer, recsize);
6995#endif
27e6ca2d
AE
6996 if (bytesread < 0)
6997 bytesread = 0;
e311fd51 6998 SvCUR_set(sv, bytesread += append);
e670df4e 6999 buffer[bytesread] = '\0';
efd8b2ba 7000 goto return_string_or_null;
5b2b9c68 7001 }
3280af22 7002 else if (RsPARA(PL_rs)) {
c07a80fd 7003 rsptr = "\n\n";
7004 rslen = 2;
8bfdd7d9 7005 rspara = 1;
c07a80fd 7006 }
7d59b7e4
NIS
7007 else {
7008 /* Get $/ i.e. PL_rs into same encoding as stream wants */
7009 if (PerlIO_isutf8(fp)) {
7010 rsptr = SvPVutf8(PL_rs, rslen);
7011 }
7012 else {
7013 if (SvUTF8(PL_rs)) {
7014 if (!sv_utf8_downgrade(PL_rs, TRUE)) {
7015 Perl_croak(aTHX_ "Wide character in $/");
7016 }
7017 }
7018 rsptr = SvPV(PL_rs, rslen);
7019 }
7020 }
7021
c07a80fd 7022 rslast = rslen ? rsptr[rslen - 1] : '\0';
7023
8bfdd7d9 7024 if (rspara) { /* have to do this both before and after */
79072805 7025 do { /* to make sure file boundaries work right */
760ac839 7026 if (PerlIO_eof(fp))
a0d0e21e 7027 return 0;
760ac839 7028 i = PerlIO_getc(fp);
79072805 7029 if (i != '\n') {
a0d0e21e
LW
7030 if (i == -1)
7031 return 0;
760ac839 7032 PerlIO_ungetc(fp,i);
79072805
LW
7033 break;
7034 }
7035 } while (i != EOF);
7036 }
c07a80fd 7037
760ac839
LW
7038 /* See if we know enough about I/O mechanism to cheat it ! */
7039
7040 /* This used to be #ifdef test - it is made run-time test for ease
1c846c1f 7041 of abstracting out stdio interface. One call should be cheap
760ac839
LW
7042 enough here - and may even be a macro allowing compile
7043 time optimization.
7044 */
7045
7046 if (PerlIO_fast_gets(fp)) {
7047
7048 /*
7049 * We're going to steal some values from the stdio struct
7050 * and put EVERYTHING in the innermost loop into registers.
7051 */
7052 register STDCHAR *ptr;
7053 STRLEN bpx;
7054 I32 shortbuffered;
7055
16660edb 7056#if defined(VMS) && defined(PERLIO_IS_STDIO)
7057 /* An ungetc()d char is handled separately from the regular
7058 * buffer, so we getc() it back out and stuff it in the buffer.
7059 */
7060 i = PerlIO_getc(fp);
7061 if (i == EOF) return 0;
7062 *(--((*fp)->_ptr)) = (unsigned char) i;
7063 (*fp)->_cnt++;
7064#endif
c07a80fd 7065
c2960299 7066 /* Here is some breathtakingly efficient cheating */
c07a80fd 7067
a20bf0c3 7068 cnt = PerlIO_get_cnt(fp); /* get count into register */
e468d35b 7069 /* make sure we have the room */
7a5fa8a2 7070 if ((I32)(SvLEN(sv) - append) <= cnt + 1) {
e468d35b 7071 /* Not room for all of it
7a5fa8a2 7072 if we are looking for a separator and room for some
e468d35b
NIS
7073 */
7074 if (rslen && cnt > 80 && (I32)SvLEN(sv) > append) {
7a5fa8a2 7075 /* just process what we have room for */
79072805
LW
7076 shortbuffered = cnt - SvLEN(sv) + append + 1;
7077 cnt -= shortbuffered;
7078 }
7079 else {
7080 shortbuffered = 0;
bbce6d69 7081 /* remember that cnt can be negative */
eb160463 7082 SvGROW(sv, (STRLEN)(append + (cnt <= 0 ? 2 : (cnt + 1))));
79072805
LW
7083 }
7084 }
7a5fa8a2 7085 else
79072805 7086 shortbuffered = 0;
c07a80fd 7087 bp = (STDCHAR*)SvPVX(sv) + append; /* move these two too to registers */
a20bf0c3 7088 ptr = (STDCHAR*)PerlIO_get_ptr(fp);
16660edb 7089 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 7090 "Screamer: entering, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
16660edb 7091 DEBUG_P(PerlIO_printf(Perl_debug_log,
ba7abf9d 7092 "Screamer: entering: PerlIO * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
1c846c1f 7093 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
1d7c1841 7094 PTR2UV(PerlIO_has_base(fp) ? PerlIO_get_base(fp) : 0)));
79072805
LW
7095 for (;;) {
7096 screamer:
93a17b20 7097 if (cnt > 0) {
c07a80fd 7098 if (rslen) {
760ac839
LW
7099 while (cnt > 0) { /* this | eat */
7100 cnt--;
c07a80fd 7101 if ((*bp++ = *ptr++) == rslast) /* really | dust */
7102 goto thats_all_folks; /* screams | sed :-) */
7103 }
7104 }
7105 else {
1c846c1f
NIS
7106 Copy(ptr, bp, cnt, char); /* this | eat */
7107 bp += cnt; /* screams | dust */
c07a80fd 7108 ptr += cnt; /* louder | sed :-) */
a5f75d66 7109 cnt = 0;
93a17b20 7110 }
79072805
LW
7111 }
7112
748a9306 7113 if (shortbuffered) { /* oh well, must extend */
79072805
LW
7114 cnt = shortbuffered;
7115 shortbuffered = 0;
c07a80fd 7116 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
79072805
LW
7117 SvCUR_set(sv, bpx);
7118 SvGROW(sv, SvLEN(sv) + append + cnt + 2);
c07a80fd 7119 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
79072805
LW
7120 continue;
7121 }
7122
16660edb 7123 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841
GS
7124 "Screamer: going to getc, ptr=%"UVuf", cnt=%ld\n",
7125 PTR2UV(ptr),(long)cnt));
cc00df79 7126 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* deregisterize cnt and ptr */
ba7abf9d 7127#if 0
16660edb 7128 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 7129 "Screamer: pre: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
1c846c1f 7130 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
1d7c1841 7131 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
ba7abf9d 7132#endif
1c846c1f 7133 /* This used to call 'filbuf' in stdio form, but as that behaves like
774d564b 7134 getc when cnt <= 0 we use PerlIO_getc here to avoid introducing
7135 another abstraction. */
760ac839 7136 i = PerlIO_getc(fp); /* get more characters */
ba7abf9d 7137#if 0
16660edb 7138 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 7139 "Screamer: post: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
1c846c1f 7140 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
1d7c1841 7141 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
ba7abf9d 7142#endif
a20bf0c3
JH
7143 cnt = PerlIO_get_cnt(fp);
7144 ptr = (STDCHAR*)PerlIO_get_ptr(fp); /* reregisterize cnt and ptr */
16660edb 7145 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 7146 "Screamer: after getc, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
79072805 7147
748a9306
LW
7148 if (i == EOF) /* all done for ever? */
7149 goto thats_really_all_folks;
7150
c07a80fd 7151 bpx = bp - (STDCHAR*)SvPVX(sv); /* box up before relocation */
79072805
LW
7152 SvCUR_set(sv, bpx);
7153 SvGROW(sv, bpx + cnt + 2);
c07a80fd 7154 bp = (STDCHAR*)SvPVX(sv) + bpx; /* unbox after relocation */
7155
eb160463 7156 *bp++ = (STDCHAR)i; /* store character from PerlIO_getc */
79072805 7157
c07a80fd 7158 if (rslen && (STDCHAR)i == rslast) /* all done for now? */
79072805 7159 goto thats_all_folks;
79072805
LW
7160 }
7161
7162thats_all_folks:
eb160463 7163 if ((rslen > 1 && (STRLEN)(bp - (STDCHAR*)SvPVX(sv)) < rslen) ||
36477c24 7164 memNE((char*)bp - rslen, rsptr, rslen))
760ac839 7165 goto screamer; /* go back to the fray */
79072805
LW
7166thats_really_all_folks:
7167 if (shortbuffered)
7168 cnt += shortbuffered;
16660edb 7169 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 7170 "Screamer: quitting, ptr=%"UVuf", cnt=%ld\n",PTR2UV(ptr),(long)cnt));
cc00df79 7171 PerlIO_set_ptrcnt(fp, (STDCHAR*)ptr, cnt); /* put these back or we're in trouble */
16660edb 7172 DEBUG_P(PerlIO_printf(Perl_debug_log,
1d7c1841 7173 "Screamer: end: FILE * thinks ptr=%"UVuf", cnt=%ld, base=%"UVuf"\n",
1c846c1f 7174 PTR2UV(PerlIO_get_ptr(fp)), (long)PerlIO_get_cnt(fp),
1d7c1841 7175 PTR2UV(PerlIO_has_base (fp) ? PerlIO_get_base(fp) : 0)));
79072805 7176 *bp = '\0';
760ac839 7177 SvCUR_set(sv, bp - (STDCHAR*)SvPVX(sv)); /* set length */
16660edb 7178 DEBUG_P(PerlIO_printf(Perl_debug_log,
fb73857a 7179 "Screamer: done, len=%ld, string=|%.*s|\n",
7180 (long)SvCUR(sv),(int)SvCUR(sv),SvPVX(sv)));
760ac839
LW
7181 }
7182 else
79072805 7183 {
6edd2cd5
JH
7184 /*The big, slow, and stupid way. */
7185
7186 /* Any stack-challenged places. */
33d5f59c 7187#if defined(EPOC)
6edd2cd5
JH
7188 /* EPOC: need to work around SDK features. *
7189 * On WINS: MS VC5 generates calls to _chkstk, *
7190 * if a "large" stack frame is allocated. *
7191 * gcc on MARM does not generate calls like these. */
7192# define USEHEAPINSTEADOFSTACK
7193#endif
7194
7195#ifdef USEHEAPINSTEADOFSTACK
7196 STDCHAR *buf = 0;
7197 New(0, buf, 8192, STDCHAR);
7198 assert(buf);
4d2c4e07 7199#else
6edd2cd5 7200 STDCHAR buf[8192];
4d2c4e07 7201#endif
79072805 7202
760ac839 7203screamer2:
c07a80fd 7204 if (rslen) {
760ac839
LW
7205 register STDCHAR *bpe = buf + sizeof(buf);
7206 bp = buf;
eb160463 7207 while ((i = PerlIO_getc(fp)) != EOF && (*bp++ = (STDCHAR)i) != rslast && bp < bpe)
760ac839
LW
7208 ; /* keep reading */
7209 cnt = bp - buf;
c07a80fd 7210 }
7211 else {
760ac839 7212 cnt = PerlIO_read(fp,(char*)buf, sizeof(buf));
16660edb 7213 /* Accomodate broken VAXC compiler, which applies U8 cast to
7214 * both args of ?: operator, causing EOF to change into 255
7215 */
37be0adf 7216 if (cnt > 0)
cbe9e203
JH
7217 i = (U8)buf[cnt - 1];
7218 else
37be0adf 7219 i = EOF;
c07a80fd 7220 }
79072805 7221
cbe9e203
JH
7222 if (cnt < 0)
7223 cnt = 0; /* we do need to re-set the sv even when cnt <= 0 */
7224 if (append)
7225 sv_catpvn(sv, (char *) buf, cnt);
7226 else
7227 sv_setpvn(sv, (char *) buf, cnt);
c07a80fd 7228
7229 if (i != EOF && /* joy */
7230 (!rslen ||
7231 SvCUR(sv) < rslen ||
36477c24 7232 memNE(SvPVX(sv) + SvCUR(sv) - rslen, rsptr, rslen)))
79072805
LW
7233 {
7234 append = -1;
63e4d877
CS
7235 /*
7236 * If we're reading from a TTY and we get a short read,
7237 * indicating that the user hit his EOF character, we need
7238 * to notice it now, because if we try to read from the TTY
7239 * again, the EOF condition will disappear.
7240 *
7241 * The comparison of cnt to sizeof(buf) is an optimization
7242 * that prevents unnecessary calls to feof().
7243 *
7244 * - jik 9/25/96
7245 */
7246 if (!(cnt < sizeof(buf) && PerlIO_eof(fp)))
7247 goto screamer2;
79072805 7248 }
6edd2cd5
JH
7249
7250#ifdef USEHEAPINSTEADOFSTACK
7251 Safefree(buf);
7252#endif
79072805
LW
7253 }
7254
8bfdd7d9 7255 if (rspara) { /* have to do this both before and after */
c07a80fd 7256 while (i != EOF) { /* to make sure file boundaries work right */
760ac839 7257 i = PerlIO_getc(fp);
79072805 7258 if (i != '\n') {
760ac839 7259 PerlIO_ungetc(fp,i);
79072805
LW
7260 break;
7261 }
7262 }
7263 }
c07a80fd 7264
efd8b2ba 7265return_string_or_null:
c07a80fd 7266 return (SvCUR(sv) - append) ? SvPVX(sv) : Nullch;
79072805
LW
7267}
7268
954c1994
GS
7269/*
7270=for apidoc sv_inc
7271
645c22ef
DM
7272Auto-increment of the value in the SV, doing string to numeric conversion
7273if necessary. Handles 'get' magic.
954c1994
GS
7274
7275=cut
7276*/
7277
79072805 7278void
864dbfa3 7279Perl_sv_inc(pTHX_ register SV *sv)
79072805
LW
7280{
7281 register char *d;
463ee0b2 7282 int flags;
79072805
LW
7283
7284 if (!sv)
7285 return;
b23a5f78
GB
7286 if (SvGMAGICAL(sv))
7287 mg_get(sv);
ed6116ce 7288 if (SvTHINKFIRST(sv)) {
765f542d
NC
7289 if (SvIsCOW(sv))
7290 sv_force_normal_flags(sv, 0);
0f15f207 7291 if (SvREADONLY(sv)) {
923e4eb5 7292 if (IN_PERL_RUNTIME)
cea2e8a9 7293 Perl_croak(aTHX_ PL_no_modify);
0f15f207 7294 }
a0d0e21e 7295 if (SvROK(sv)) {
b5be31e9 7296 IV i;
9e7bc3e8
JD
7297 if (SvAMAGIC(sv) && AMG_CALLun(sv,inc))
7298 return;
56431972 7299 i = PTR2IV(SvRV(sv));
b5be31e9
SM
7300 sv_unref(sv);
7301 sv_setiv(sv, i);
a0d0e21e 7302 }
ed6116ce 7303 }
8990e307 7304 flags = SvFLAGS(sv);
28e5dec8
JH
7305 if ((flags & (SVp_NOK|SVp_IOK)) == SVp_NOK) {
7306 /* It's (privately or publicly) a float, but not tested as an
7307 integer, so test it to see. */
d460ef45 7308 (void) SvIV(sv);
28e5dec8
JH
7309 flags = SvFLAGS(sv);
7310 }
7311 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7312 /* It's publicly an integer, or privately an integer-not-float */
59d8ce62 7313#ifdef PERL_PRESERVE_IVUV
28e5dec8 7314 oops_its_int:
59d8ce62 7315#endif
25da4f38
IZ
7316 if (SvIsUV(sv)) {
7317 if (SvUVX(sv) == UV_MAX)
a1e868e7 7318 sv_setnv(sv, UV_MAX_P1);
25da4f38
IZ
7319 else
7320 (void)SvIOK_only_UV(sv);
7321 ++SvUVX(sv);
7322 } else {
7323 if (SvIVX(sv) == IV_MAX)
28e5dec8 7324 sv_setuv(sv, (UV)IV_MAX + 1);
25da4f38
IZ
7325 else {
7326 (void)SvIOK_only(sv);
7327 ++SvIVX(sv);
1c846c1f 7328 }
55497cff 7329 }
79072805
LW
7330 return;
7331 }
28e5dec8
JH
7332 if (flags & SVp_NOK) {
7333 (void)SvNOK_only(sv);
7334 SvNVX(sv) += 1.0;
7335 return;
7336 }
7337
8990e307 7338 if (!(flags & SVp_POK) || !*SvPVX(sv)) {
28e5dec8
JH
7339 if ((flags & SVTYPEMASK) < SVt_PVIV)
7340 sv_upgrade(sv, SVt_IV);
7341 (void)SvIOK_only(sv);
7342 SvIVX(sv) = 1;
79072805
LW
7343 return;
7344 }
463ee0b2 7345 d = SvPVX(sv);
79072805
LW
7346 while (isALPHA(*d)) d++;
7347 while (isDIGIT(*d)) d++;
7348 if (*d) {
28e5dec8 7349#ifdef PERL_PRESERVE_IVUV
d1be9408 7350 /* Got to punt this as an integer if needs be, but we don't issue
28e5dec8
JH
7351 warnings. Probably ought to make the sv_iv_please() that does
7352 the conversion if possible, and silently. */
c2988b20 7353 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
28e5dec8
JH
7354 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7355 /* Need to try really hard to see if it's an integer.
7356 9.22337203685478e+18 is an integer.
7357 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7358 so $a="9.22337203685478e+18"; $a+0; $a++
7359 needs to be the same as $a="9.22337203685478e+18"; $a++
7360 or we go insane. */
d460ef45 7361
28e5dec8
JH
7362 (void) sv_2iv(sv);
7363 if (SvIOK(sv))
7364 goto oops_its_int;
7365
7366 /* sv_2iv *should* have made this an NV */
7367 if (flags & SVp_NOK) {
7368 (void)SvNOK_only(sv);
7369 SvNVX(sv) += 1.0;
7370 return;
7371 }
7372 /* I don't think we can get here. Maybe I should assert this
7373 And if we do get here I suspect that sv_setnv will croak. NWC
7374 Fall through. */
7375#if defined(USE_LONG_DOUBLE)
7376 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",
7377 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7378#else
1779d84d 7379 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
7380 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7381#endif
7382 }
7383#endif /* PERL_PRESERVE_IVUV */
7384 sv_setnv(sv,Atof(SvPVX(sv)) + 1.0);
79072805
LW
7385 return;
7386 }
7387 d--;
463ee0b2 7388 while (d >= SvPVX(sv)) {
79072805
LW
7389 if (isDIGIT(*d)) {
7390 if (++*d <= '9')
7391 return;
7392 *(d--) = '0';
7393 }
7394 else {
9d116dd7
JH
7395#ifdef EBCDIC
7396 /* MKS: The original code here died if letters weren't consecutive.
7397 * at least it didn't have to worry about non-C locales. The
7398 * new code assumes that ('z'-'a')==('Z'-'A'), letters are
1c846c1f 7399 * arranged in order (although not consecutively) and that only
9d116dd7
JH
7400 * [A-Za-z] are accepted by isALPHA in the C locale.
7401 */
7402 if (*d != 'z' && *d != 'Z') {
7403 do { ++*d; } while (!isALPHA(*d));
7404 return;
7405 }
7406 *(d--) -= 'z' - 'a';
7407#else
79072805
LW
7408 ++*d;
7409 if (isALPHA(*d))
7410 return;
7411 *(d--) -= 'z' - 'a' + 1;
9d116dd7 7412#endif
79072805
LW
7413 }
7414 }
7415 /* oh,oh, the number grew */
7416 SvGROW(sv, SvCUR(sv) + 2);
7417 SvCUR(sv)++;
463ee0b2 7418 for (d = SvPVX(sv) + SvCUR(sv); d > SvPVX(sv); d--)
79072805
LW
7419 *d = d[-1];
7420 if (isDIGIT(d[1]))
7421 *d = '1';
7422 else
7423 *d = d[1];
7424}
7425
954c1994
GS
7426/*
7427=for apidoc sv_dec
7428
645c22ef
DM
7429Auto-decrement of the value in the SV, doing string to numeric conversion
7430if necessary. Handles 'get' magic.
954c1994
GS
7431
7432=cut
7433*/
7434
79072805 7435void
864dbfa3 7436Perl_sv_dec(pTHX_ register SV *sv)
79072805 7437{
463ee0b2
LW
7438 int flags;
7439
79072805
LW
7440 if (!sv)
7441 return;
b23a5f78
GB
7442 if (SvGMAGICAL(sv))
7443 mg_get(sv);
ed6116ce 7444 if (SvTHINKFIRST(sv)) {
765f542d
NC
7445 if (SvIsCOW(sv))
7446 sv_force_normal_flags(sv, 0);
0f15f207 7447 if (SvREADONLY(sv)) {
923e4eb5 7448 if (IN_PERL_RUNTIME)
cea2e8a9 7449 Perl_croak(aTHX_ PL_no_modify);
0f15f207 7450 }
a0d0e21e 7451 if (SvROK(sv)) {
b5be31e9 7452 IV i;
9e7bc3e8
JD
7453 if (SvAMAGIC(sv) && AMG_CALLun(sv,dec))
7454 return;
56431972 7455 i = PTR2IV(SvRV(sv));
b5be31e9
SM
7456 sv_unref(sv);
7457 sv_setiv(sv, i);
a0d0e21e 7458 }
ed6116ce 7459 }
28e5dec8
JH
7460 /* Unlike sv_inc we don't have to worry about string-never-numbers
7461 and keeping them magic. But we mustn't warn on punting */
8990e307 7462 flags = SvFLAGS(sv);
28e5dec8
JH
7463 if ((flags & SVf_IOK) || ((flags & (SVp_IOK | SVp_NOK)) == SVp_IOK)) {
7464 /* It's publicly an integer, or privately an integer-not-float */
59d8ce62 7465#ifdef PERL_PRESERVE_IVUV
28e5dec8 7466 oops_its_int:
59d8ce62 7467#endif
25da4f38
IZ
7468 if (SvIsUV(sv)) {
7469 if (SvUVX(sv) == 0) {
7470 (void)SvIOK_only(sv);
7471 SvIVX(sv) = -1;
7472 }
7473 else {
7474 (void)SvIOK_only_UV(sv);
7475 --SvUVX(sv);
1c846c1f 7476 }
25da4f38
IZ
7477 } else {
7478 if (SvIVX(sv) == IV_MIN)
65202027 7479 sv_setnv(sv, (NV)IV_MIN - 1.0);
25da4f38
IZ
7480 else {
7481 (void)SvIOK_only(sv);
7482 --SvIVX(sv);
1c846c1f 7483 }
55497cff 7484 }
7485 return;
7486 }
28e5dec8
JH
7487 if (flags & SVp_NOK) {
7488 SvNVX(sv) -= 1.0;
7489 (void)SvNOK_only(sv);
7490 return;
7491 }
8990e307 7492 if (!(flags & SVp_POK)) {
4633a7c4
LW
7493 if ((flags & SVTYPEMASK) < SVt_PVNV)
7494 sv_upgrade(sv, SVt_NV);
463ee0b2 7495 SvNVX(sv) = -1.0;
a0d0e21e 7496 (void)SvNOK_only(sv);
79072805
LW
7497 return;
7498 }
28e5dec8
JH
7499#ifdef PERL_PRESERVE_IVUV
7500 {
c2988b20 7501 int numtype = grok_number(SvPVX(sv), SvCUR(sv), NULL);
28e5dec8
JH
7502 if (numtype && !(numtype & IS_NUMBER_INFINITY)) {
7503 /* Need to try really hard to see if it's an integer.
7504 9.22337203685478e+18 is an integer.
7505 but "9.22337203685478e+18" + 0 is UV=9223372036854779904
7506 so $a="9.22337203685478e+18"; $a+0; $a--
7507 needs to be the same as $a="9.22337203685478e+18"; $a--
7508 or we go insane. */
d460ef45 7509
28e5dec8
JH
7510 (void) sv_2iv(sv);
7511 if (SvIOK(sv))
7512 goto oops_its_int;
7513
7514 /* sv_2iv *should* have made this an NV */
7515 if (flags & SVp_NOK) {
7516 (void)SvNOK_only(sv);
7517 SvNVX(sv) -= 1.0;
7518 return;
7519 }
7520 /* I don't think we can get here. Maybe I should assert this
7521 And if we do get here I suspect that sv_setnv will croak. NWC
7522 Fall through. */
7523#if defined(USE_LONG_DOUBLE)
7524 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",
7525 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7526#else
1779d84d 7527 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
7528 SvPVX(sv), SvIVX(sv), SvNVX(sv)));
7529#endif
7530 }
7531 }
7532#endif /* PERL_PRESERVE_IVUV */
097ee67d 7533 sv_setnv(sv,Atof(SvPVX(sv)) - 1.0); /* punt */
79072805
LW
7534}
7535
954c1994
GS
7536/*
7537=for apidoc sv_mortalcopy
7538
645c22ef 7539Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
d4236ebc
DM
7540The new SV is marked as mortal. It will be destroyed "soon", either by an
7541explicit call to FREETMPS, or by an implicit call at places such as
7542statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
954c1994
GS
7543
7544=cut
7545*/
7546
79072805
LW
7547/* Make a string that will exist for the duration of the expression
7548 * evaluation. Actually, it may have to last longer than that, but
7549 * hopefully we won't free it until it has been assigned to a
7550 * permanent location. */
7551
7552SV *
864dbfa3 7553Perl_sv_mortalcopy(pTHX_ SV *oldstr)
79072805 7554{
463ee0b2 7555 register SV *sv;
b881518d 7556
4561caa4 7557 new_SV(sv);
79072805 7558 sv_setsv(sv,oldstr);
677b06e3
GS
7559 EXTEND_MORTAL(1);
7560 PL_tmps_stack[++PL_tmps_ix] = sv;
8990e307
LW
7561 SvTEMP_on(sv);
7562 return sv;
7563}
7564
954c1994
GS
7565/*
7566=for apidoc sv_newmortal
7567
645c22ef 7568Creates a new null SV which is mortal. The reference count of the SV is
d4236ebc
DM
7569set to 1. It will be destroyed "soon", either by an explicit call to
7570FREETMPS, or by an implicit call at places such as statement boundaries.
7571See also C<sv_mortalcopy> and C<sv_2mortal>.
954c1994
GS
7572
7573=cut
7574*/
7575
8990e307 7576SV *
864dbfa3 7577Perl_sv_newmortal(pTHX)
8990e307
LW
7578{
7579 register SV *sv;
7580
4561caa4 7581 new_SV(sv);
8990e307 7582 SvFLAGS(sv) = SVs_TEMP;
677b06e3
GS
7583 EXTEND_MORTAL(1);
7584 PL_tmps_stack[++PL_tmps_ix] = sv;
79072805
LW
7585 return sv;
7586}
7587
954c1994
GS
7588/*
7589=for apidoc sv_2mortal
7590
d4236ebc
DM
7591Marks an existing SV as mortal. The SV will be destroyed "soon", either
7592by an explicit call to FREETMPS, or by an implicit call at places such as
37d2ac18
NC
7593statement boundaries. SvTEMP() is turned on which means that the SV's
7594string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
7595and C<sv_mortalcopy>.
954c1994
GS
7596
7597=cut
7598*/
7599
79072805 7600SV *
864dbfa3 7601Perl_sv_2mortal(pTHX_ register SV *sv)
79072805
LW
7602{
7603 if (!sv)
7604 return sv;
d689ffdd 7605 if (SvREADONLY(sv) && SvIMMORTAL(sv))
11162842 7606 return sv;
677b06e3
GS
7607 EXTEND_MORTAL(1);
7608 PL_tmps_stack[++PL_tmps_ix] = sv;
8990e307 7609 SvTEMP_on(sv);
79072805
LW
7610 return sv;
7611}
7612
954c1994
GS
7613/*
7614=for apidoc newSVpv
7615
7616Creates a new SV and copies a string into it. The reference count for the
7617SV is set to 1. If C<len> is zero, Perl will compute the length using
7618strlen(). For efficiency, consider using C<newSVpvn> instead.
7619
7620=cut
7621*/
7622
79072805 7623SV *
864dbfa3 7624Perl_newSVpv(pTHX_ const char *s, STRLEN len)
79072805 7625{
463ee0b2 7626 register SV *sv;
79072805 7627
4561caa4 7628 new_SV(sv);
79072805
LW
7629 if (!len)
7630 len = strlen(s);
7631 sv_setpvn(sv,s,len);
7632 return sv;
7633}
7634
954c1994
GS
7635/*
7636=for apidoc newSVpvn
7637
7638Creates a new SV and copies a string into it. The reference count for the
1c846c1f 7639SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
954c1994 7640string. You are responsible for ensuring that the source string is at least
9e09f5f2 7641C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
954c1994
GS
7642
7643=cut
7644*/
7645
9da1e3b5 7646SV *
864dbfa3 7647Perl_newSVpvn(pTHX_ const char *s, STRLEN len)
9da1e3b5
MUN
7648{
7649 register SV *sv;
7650
7651 new_SV(sv);
9da1e3b5
MUN
7652 sv_setpvn(sv,s,len);
7653 return sv;
7654}
7655
1c846c1f
NIS
7656/*
7657=for apidoc newSVpvn_share
7658
645c22ef
DM
7659Creates a new SV with its SvPVX pointing to a shared string in the string
7660table. If the string does not already exist in the table, it is created
7661first. Turns on READONLY and FAKE. The string's hash is stored in the UV
7662slot of the SV; if the C<hash> parameter is non-zero, that value is used;
7663otherwise the hash is computed. The idea here is that as the string table
7664is used for shared hash keys these strings will have SvPVX == HeKEY and
7665hash lookup will avoid string compare.
1c846c1f
NIS
7666
7667=cut
7668*/
7669
7670SV *
c3654f1a 7671Perl_newSVpvn_share(pTHX_ const char *src, I32 len, U32 hash)
1c846c1f
NIS
7672{
7673 register SV *sv;
c3654f1a
IH
7674 bool is_utf8 = FALSE;
7675 if (len < 0) {
77caf834 7676 STRLEN tmplen = -len;
c3654f1a 7677 is_utf8 = TRUE;
75a54232
JH
7678 /* See the note in hv.c:hv_fetch() --jhi */
7679 src = (char*)bytes_from_utf8((U8*)src, &tmplen, &is_utf8);
7680 len = tmplen;
7681 }
1c846c1f 7682 if (!hash)
5afd6d42 7683 PERL_HASH(hash, src, len);
1c846c1f
NIS
7684 new_SV(sv);
7685 sv_upgrade(sv, SVt_PVIV);
c3654f1a 7686 SvPVX(sv) = sharepvn(src, is_utf8?-len:len, hash);
1c846c1f
NIS
7687 SvCUR(sv) = len;
7688 SvUVX(sv) = hash;
7689 SvLEN(sv) = 0;
7690 SvREADONLY_on(sv);
7691 SvFAKE_on(sv);
7692 SvPOK_on(sv);
c3654f1a
IH
7693 if (is_utf8)
7694 SvUTF8_on(sv);
1c846c1f
NIS
7695 return sv;
7696}
7697
645c22ef 7698
cea2e8a9 7699#if defined(PERL_IMPLICIT_CONTEXT)
645c22ef
DM
7700
7701/* pTHX_ magic can't cope with varargs, so this is a no-context
7702 * version of the main function, (which may itself be aliased to us).
7703 * Don't access this version directly.
7704 */
7705
46fc3d4c 7706SV *
cea2e8a9 7707Perl_newSVpvf_nocontext(const char* pat, ...)
46fc3d4c 7708{
cea2e8a9 7709 dTHX;
46fc3d4c 7710 register SV *sv;
7711 va_list args;
46fc3d4c 7712 va_start(args, pat);
c5be433b 7713 sv = vnewSVpvf(pat, &args);
46fc3d4c 7714 va_end(args);
7715 return sv;
7716}
cea2e8a9 7717#endif
46fc3d4c 7718
954c1994
GS
7719/*
7720=for apidoc newSVpvf
7721
645c22ef 7722Creates a new SV and initializes it with the string formatted like
954c1994
GS
7723C<sprintf>.
7724
7725=cut
7726*/
7727
cea2e8a9
GS
7728SV *
7729Perl_newSVpvf(pTHX_ const char* pat, ...)
7730{
7731 register SV *sv;
7732 va_list args;
cea2e8a9 7733 va_start(args, pat);
c5be433b 7734 sv = vnewSVpvf(pat, &args);
cea2e8a9
GS
7735 va_end(args);
7736 return sv;
7737}
46fc3d4c 7738
645c22ef
DM
7739/* backend for newSVpvf() and newSVpvf_nocontext() */
7740
79072805 7741SV *
c5be433b
GS
7742Perl_vnewSVpvf(pTHX_ const char* pat, va_list* args)
7743{
7744 register SV *sv;
7745 new_SV(sv);
7746 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
7747 return sv;
7748}
7749
954c1994
GS
7750/*
7751=for apidoc newSVnv
7752
7753Creates a new SV and copies a floating point value into it.
7754The reference count for the SV is set to 1.
7755
7756=cut
7757*/
7758
c5be433b 7759SV *
65202027 7760Perl_newSVnv(pTHX_ NV n)
79072805 7761{
463ee0b2 7762 register SV *sv;
79072805 7763
4561caa4 7764 new_SV(sv);
79072805
LW
7765 sv_setnv(sv,n);
7766 return sv;
7767}
7768
954c1994
GS
7769/*
7770=for apidoc newSViv
7771
7772Creates a new SV and copies an integer into it. The reference count for the
7773SV is set to 1.
7774
7775=cut
7776*/
7777
79072805 7778SV *
864dbfa3 7779Perl_newSViv(pTHX_ IV i)
79072805 7780{
463ee0b2 7781 register SV *sv;
79072805 7782
4561caa4 7783 new_SV(sv);
79072805
LW
7784 sv_setiv(sv,i);
7785 return sv;
7786}
7787
954c1994 7788/*
1a3327fb
JH
7789=for apidoc newSVuv
7790
7791Creates a new SV and copies an unsigned integer into it.
7792The reference count for the SV is set to 1.
7793
7794=cut
7795*/
7796
7797SV *
7798Perl_newSVuv(pTHX_ UV u)
7799{
7800 register SV *sv;
7801
7802 new_SV(sv);
7803 sv_setuv(sv,u);
7804 return sv;
7805}
7806
7807/*
954c1994
GS
7808=for apidoc newRV_noinc
7809
7810Creates an RV wrapper for an SV. The reference count for the original
7811SV is B<not> incremented.
7812
7813=cut
7814*/
7815
2304df62 7816SV *
864dbfa3 7817Perl_newRV_noinc(pTHX_ SV *tmpRef)
2304df62
AD
7818{
7819 register SV *sv;
7820
4561caa4 7821 new_SV(sv);
2304df62 7822 sv_upgrade(sv, SVt_RV);
76e3520e 7823 SvTEMP_off(tmpRef);
d689ffdd 7824 SvRV(sv) = tmpRef;
2304df62 7825 SvROK_on(sv);
2304df62
AD
7826 return sv;
7827}
7828
ff276b08 7829/* newRV_inc is the official function name to use now.
645c22ef
DM
7830 * newRV_inc is in fact #defined to newRV in sv.h
7831 */
7832
5f05dabc 7833SV *
864dbfa3 7834Perl_newRV(pTHX_ SV *tmpRef)
5f05dabc 7835{
5f6447b6 7836 return newRV_noinc(SvREFCNT_inc(tmpRef));
5f05dabc 7837}
5f05dabc 7838
954c1994
GS
7839/*
7840=for apidoc newSVsv
7841
7842Creates a new SV which is an exact duplicate of the original SV.
645c22ef 7843(Uses C<sv_setsv>).
954c1994
GS
7844
7845=cut
7846*/
7847
79072805 7848SV *
864dbfa3 7849Perl_newSVsv(pTHX_ register SV *old)
79072805 7850{
463ee0b2 7851 register SV *sv;
79072805
LW
7852
7853 if (!old)
7854 return Nullsv;
8990e307 7855 if (SvTYPE(old) == SVTYPEMASK) {
0453d815 7856 if (ckWARN_d(WARN_INTERNAL))
9014280d 7857 Perl_warner(aTHX_ packWARN(WARN_INTERNAL), "semi-panic: attempt to dup freed string");
79072805
LW
7858 return Nullsv;
7859 }
4561caa4 7860 new_SV(sv);
ff68c719 7861 if (SvTEMP(old)) {
7862 SvTEMP_off(old);
463ee0b2 7863 sv_setsv(sv,old);
ff68c719 7864 SvTEMP_on(old);
79072805
LW
7865 }
7866 else
463ee0b2
LW
7867 sv_setsv(sv,old);
7868 return sv;
79072805
LW
7869}
7870
645c22ef
DM
7871/*
7872=for apidoc sv_reset
7873
7874Underlying implementation for the C<reset> Perl function.
7875Note that the perl-level function is vaguely deprecated.
7876
7877=cut
7878*/
7879
79072805 7880void
864dbfa3 7881Perl_sv_reset(pTHX_ register char *s, HV *stash)
79072805
LW
7882{
7883 register HE *entry;
7884 register GV *gv;
7885 register SV *sv;
7886 register I32 i;
7887 register PMOP *pm;
7888 register I32 max;
4802d5d7 7889 char todo[PERL_UCHAR_MAX+1];
79072805 7890
49d8d3a1
MB
7891 if (!stash)
7892 return;
7893
79072805
LW
7894 if (!*s) { /* reset ?? searches */
7895 for (pm = HvPMROOT(stash); pm; pm = pm->op_pmnext) {
48c036b1 7896 pm->op_pmdynflags &= ~PMdf_USED;
79072805
LW
7897 }
7898 return;
7899 }
7900
7901 /* reset variables */
7902
7903 if (!HvARRAY(stash))
7904 return;
463ee0b2
LW
7905
7906 Zero(todo, 256, char);
79072805 7907 while (*s) {
4802d5d7 7908 i = (unsigned char)*s;
79072805
LW
7909 if (s[1] == '-') {
7910 s += 2;
7911 }
4802d5d7 7912 max = (unsigned char)*s++;
79072805 7913 for ( ; i <= max; i++) {
463ee0b2
LW
7914 todo[i] = 1;
7915 }
a0d0e21e 7916 for (i = 0; i <= (I32) HvMAX(stash); i++) {
79072805 7917 for (entry = HvARRAY(stash)[i];
9e35f4b3
GS
7918 entry;
7919 entry = HeNEXT(entry))
7920 {
1edc1566 7921 if (!todo[(U8)*HeKEY(entry)])
463ee0b2 7922 continue;
1edc1566 7923 gv = (GV*)HeVAL(entry);
79072805 7924 sv = GvSV(gv);
9e35f4b3
GS
7925 if (SvTHINKFIRST(sv)) {
7926 if (!SvREADONLY(sv) && SvROK(sv))
7927 sv_unref(sv);
7928 continue;
7929 }
0c34ef67 7930 SvOK_off(sv);
79072805
LW
7931 if (SvTYPE(sv) >= SVt_PV) {
7932 SvCUR_set(sv, 0);
463ee0b2
LW
7933 if (SvPVX(sv) != Nullch)
7934 *SvPVX(sv) = '\0';
44a8e56a 7935 SvTAINT(sv);
79072805
LW
7936 }
7937 if (GvAV(gv)) {
7938 av_clear(GvAV(gv));
7939 }
44a8e56a 7940 if (GvHV(gv) && !HvNAME(GvHV(gv))) {
463ee0b2 7941 hv_clear(GvHV(gv));
2f42fcb0 7942#ifndef PERL_MICRO
fa6a1c44 7943#ifdef USE_ENVIRON_ARRAY
4efc5df6
GS
7944 if (gv == PL_envgv
7945# ifdef USE_ITHREADS
7946 && PL_curinterp == aTHX
7947# endif
7948 )
7949 {
79072805 7950 environ[0] = Nullch;
4efc5df6 7951 }
a0d0e21e 7952#endif
2f42fcb0 7953#endif /* !PERL_MICRO */
79072805
LW
7954 }
7955 }
7956 }
7957 }
7958}
7959
645c22ef
DM
7960/*
7961=for apidoc sv_2io
7962
7963Using various gambits, try to get an IO from an SV: the IO slot if its a
7964GV; or the recursive result if we're an RV; or the IO slot of the symbol
7965named after the PV if we're a string.
7966
7967=cut
7968*/
7969
46fc3d4c 7970IO*
864dbfa3 7971Perl_sv_2io(pTHX_ SV *sv)
46fc3d4c 7972{
7973 IO* io;
7974 GV* gv;
7975
7976 switch (SvTYPE(sv)) {
7977 case SVt_PVIO:
7978 io = (IO*)sv;
7979 break;
7980 case SVt_PVGV:
7981 gv = (GV*)sv;
7982 io = GvIO(gv);
7983 if (!io)
cea2e8a9 7984 Perl_croak(aTHX_ "Bad filehandle: %s", GvNAME(gv));
46fc3d4c 7985 break;
7986 default:
7987 if (!SvOK(sv))
cea2e8a9 7988 Perl_croak(aTHX_ PL_no_usym, "filehandle");
46fc3d4c 7989 if (SvROK(sv))
7990 return sv_2io(SvRV(sv));
7a5fd60d 7991 gv = gv_fetchsv(sv, FALSE, SVt_PVIO);
46fc3d4c 7992 if (gv)
7993 io = GvIO(gv);
7994 else
7995 io = 0;
7996 if (!io)
35c1215d 7997 Perl_croak(aTHX_ "Bad filehandle: %"SVf, sv);
46fc3d4c 7998 break;
7999 }
8000 return io;
8001}
8002
645c22ef
DM
8003/*
8004=for apidoc sv_2cv
8005
8006Using various gambits, try to get a CV from an SV; in addition, try if
8007possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
8008
8009=cut
8010*/
8011
79072805 8012CV *
864dbfa3 8013Perl_sv_2cv(pTHX_ SV *sv, HV **st, GV **gvp, I32 lref)
79072805 8014{
c04a4dfe
JH
8015 GV *gv = Nullgv;
8016 CV *cv = Nullcv;
79072805
LW
8017
8018 if (!sv)
93a17b20 8019 return *gvp = Nullgv, Nullcv;
79072805 8020 switch (SvTYPE(sv)) {
79072805
LW
8021 case SVt_PVCV:
8022 *st = CvSTASH(sv);
8023 *gvp = Nullgv;
8024 return (CV*)sv;
8025 case SVt_PVHV:
8026 case SVt_PVAV:
8027 *gvp = Nullgv;
8028 return Nullcv;
8990e307
LW
8029 case SVt_PVGV:
8030 gv = (GV*)sv;
a0d0e21e 8031 *gvp = gv;
8990e307
LW
8032 *st = GvESTASH(gv);
8033 goto fix_gv;
8034
79072805 8035 default:
a0d0e21e
LW
8036 if (SvGMAGICAL(sv))
8037 mg_get(sv);
8038 if (SvROK(sv)) {
f5284f61
IZ
8039 SV **sp = &sv; /* Used in tryAMAGICunDEREF macro. */
8040 tryAMAGICunDEREF(to_cv);
8041
62f274bf
GS
8042 sv = SvRV(sv);
8043 if (SvTYPE(sv) == SVt_PVCV) {
8044 cv = (CV*)sv;
8045 *gvp = Nullgv;
8046 *st = CvSTASH(cv);
8047 return cv;
8048 }
8049 else if(isGV(sv))
8050 gv = (GV*)sv;
8051 else
cea2e8a9 8052 Perl_croak(aTHX_ "Not a subroutine reference");
a0d0e21e 8053 }
62f274bf 8054 else if (isGV(sv))
79072805
LW
8055 gv = (GV*)sv;
8056 else
7a5fd60d 8057 gv = gv_fetchsv(sv, lref, SVt_PVCV);
79072805
LW
8058 *gvp = gv;
8059 if (!gv)
8060 return Nullcv;
8061 *st = GvESTASH(gv);
8990e307 8062 fix_gv:
8ebc5c01 8063 if (lref && !GvCVu(gv)) {
4633a7c4 8064 SV *tmpsv;
748a9306 8065 ENTER;
4633a7c4 8066 tmpsv = NEWSV(704,0);
16660edb 8067 gv_efullname3(tmpsv, gv, Nullch);
f6ec51f7
GS
8068 /* XXX this is probably not what they think they're getting.
8069 * It has the same effect as "sub name;", i.e. just a forward
8070 * declaration! */
774d564b 8071 newSUB(start_subparse(FALSE, 0),
4633a7c4
LW
8072 newSVOP(OP_CONST, 0, tmpsv),
8073 Nullop,
8990e307 8074 Nullop);
748a9306 8075 LEAVE;
8ebc5c01 8076 if (!GvCVu(gv))
35c1215d
NC
8077 Perl_croak(aTHX_ "Unable to create sub named \"%"SVf"\"",
8078 sv);
8990e307 8079 }
8ebc5c01 8080 return GvCVu(gv);
79072805
LW
8081 }
8082}
8083
c461cf8f
JH
8084/*
8085=for apidoc sv_true
8086
8087Returns true if the SV has a true value by Perl's rules.
645c22ef
DM
8088Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
8089instead use an in-line version.
c461cf8f
JH
8090
8091=cut
8092*/
8093
79072805 8094I32
864dbfa3 8095Perl_sv_true(pTHX_ register SV *sv)
79072805 8096{
8990e307
LW
8097 if (!sv)
8098 return 0;
79072805 8099 if (SvPOK(sv)) {
4e35701f
NIS
8100 register XPV* tXpv;
8101 if ((tXpv = (XPV*)SvANY(sv)) &&
c2f1de04 8102 (tXpv->xpv_cur > 1 ||
4e35701f 8103 (tXpv->xpv_cur && *tXpv->xpv_pv != '0')))
79072805
LW
8104 return 1;
8105 else
8106 return 0;
8107 }
8108 else {
8109 if (SvIOK(sv))
463ee0b2 8110 return SvIVX(sv) != 0;
79072805
LW
8111 else {
8112 if (SvNOK(sv))
463ee0b2 8113 return SvNVX(sv) != 0.0;
79072805 8114 else
463ee0b2 8115 return sv_2bool(sv);
79072805
LW
8116 }
8117 }
8118}
79072805 8119
645c22ef
DM
8120/*
8121=for apidoc sv_iv
8122
8123A private implementation of the C<SvIVx> macro for compilers which can't
8124cope with complex macro expressions. Always use the macro instead.
8125
8126=cut
8127*/
8128
ff68c719 8129IV
864dbfa3 8130Perl_sv_iv(pTHX_ register SV *sv)
85e6fe83 8131{
25da4f38
IZ
8132 if (SvIOK(sv)) {
8133 if (SvIsUV(sv))
8134 return (IV)SvUVX(sv);
ff68c719 8135 return SvIVX(sv);
25da4f38 8136 }
ff68c719 8137 return sv_2iv(sv);
85e6fe83 8138}
85e6fe83 8139
645c22ef
DM
8140/*
8141=for apidoc sv_uv
8142
8143A private implementation of the C<SvUVx> macro for compilers which can't
8144cope with complex macro expressions. Always use the macro instead.
8145
8146=cut
8147*/
8148
ff68c719 8149UV
864dbfa3 8150Perl_sv_uv(pTHX_ register SV *sv)
ff68c719 8151{
25da4f38
IZ
8152 if (SvIOK(sv)) {
8153 if (SvIsUV(sv))
8154 return SvUVX(sv);
8155 return (UV)SvIVX(sv);
8156 }
ff68c719 8157 return sv_2uv(sv);
8158}
85e6fe83 8159
645c22ef
DM
8160/*
8161=for apidoc sv_nv
8162
8163A private implementation of the C<SvNVx> macro for compilers which can't
8164cope with complex macro expressions. Always use the macro instead.
8165
8166=cut
8167*/
8168
65202027 8169NV
864dbfa3 8170Perl_sv_nv(pTHX_ register SV *sv)
79072805 8171{
ff68c719 8172 if (SvNOK(sv))
8173 return SvNVX(sv);
8174 return sv_2nv(sv);
79072805 8175}
79072805 8176
09540bc3
JH
8177/* sv_pv() is now a macro using SvPV_nolen();
8178 * this function provided for binary compatibility only
8179 */
8180
8181char *
8182Perl_sv_pv(pTHX_ SV *sv)
8183{
8184 STRLEN n_a;
8185
8186 if (SvPOK(sv))
8187 return SvPVX(sv);
8188
8189 return sv_2pv(sv, &n_a);
8190}
8191
645c22ef
DM
8192/*
8193=for apidoc sv_pv
8194
baca2b92 8195Use the C<SvPV_nolen> macro instead
645c22ef 8196
645c22ef
DM
8197=for apidoc sv_pvn
8198
8199A private implementation of the C<SvPV> macro for compilers which can't
8200cope with complex macro expressions. Always use the macro instead.
8201
8202=cut
8203*/
8204
1fa8b10d 8205char *
864dbfa3 8206Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
79072805 8207{
85e6fe83
LW
8208 if (SvPOK(sv)) {
8209 *lp = SvCUR(sv);
a0d0e21e 8210 return SvPVX(sv);
85e6fe83 8211 }
463ee0b2 8212 return sv_2pv(sv, lp);
79072805 8213}
79072805 8214
6e9d1081
NC
8215
8216char *
8217Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
8218{
8219 if (SvPOK(sv)) {
8220 *lp = SvCUR(sv);
8221 return SvPVX(sv);
8222 }
8223 return sv_2pv_flags(sv, lp, 0);
8224}
8225
09540bc3
JH
8226/* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
8227 * this function provided for binary compatibility only
8228 */
8229
8230char *
8231Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
8232{
8233 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
8234}
8235
c461cf8f
JH
8236/*
8237=for apidoc sv_pvn_force
8238
8239Get a sensible string out of the SV somehow.
645c22ef
DM
8240A private implementation of the C<SvPV_force> macro for compilers which
8241can't cope with complex macro expressions. Always use the macro instead.
c461cf8f 8242
8d6d96c1
HS
8243=for apidoc sv_pvn_force_flags
8244
8245Get a sensible string out of the SV somehow.
8246If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
8247appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
8248implemented in terms of this function.
645c22ef
DM
8249You normally want to use the various wrapper macros instead: see
8250C<SvPV_force> and C<SvPV_force_nomg>
8d6d96c1
HS
8251
8252=cut
8253*/
8254
8255char *
8256Perl_sv_pvn_force_flags(pTHX_ SV *sv, STRLEN *lp, I32 flags)
8257{
c04a4dfe 8258 char *s = NULL;
a0d0e21e 8259
6fc92669 8260 if (SvTHINKFIRST(sv) && !SvROK(sv))
765f542d 8261 sv_force_normal_flags(sv, 0);
1c846c1f 8262
a0d0e21e
LW
8263 if (SvPOK(sv)) {
8264 *lp = SvCUR(sv);
8265 }
8266 else {
748a9306 8267 if (SvTYPE(sv) > SVt_PVLV && SvTYPE(sv) != SVt_PVFM) {
cea2e8a9 8268 Perl_croak(aTHX_ "Can't coerce %s to string in %s", sv_reftype(sv,0),
53e06cf0 8269 OP_NAME(PL_op));
a0d0e21e 8270 }
4633a7c4 8271 else
8d6d96c1 8272 s = sv_2pv_flags(sv, lp, flags);
a0d0e21e
LW
8273 if (s != SvPVX(sv)) { /* Almost, but not quite, sv_setpvn() */
8274 STRLEN len = *lp;
1c846c1f 8275
a0d0e21e
LW
8276 if (SvROK(sv))
8277 sv_unref(sv);
8278 (void)SvUPGRADE(sv, SVt_PV); /* Never FALSE */
8279 SvGROW(sv, len + 1);
8280 Move(s,SvPVX(sv),len,char);
8281 SvCUR_set(sv, len);
8282 *SvEND(sv) = '\0';
8283 }
8284 if (!SvPOK(sv)) {
8285 SvPOK_on(sv); /* validate pointer */
8286 SvTAINT(sv);
1d7c1841
GS
8287 DEBUG_c(PerlIO_printf(Perl_debug_log, "0x%"UVxf" 2pv(%s)\n",
8288 PTR2UV(sv),SvPVX(sv)));
a0d0e21e
LW
8289 }
8290 }
8291 return SvPVX(sv);
8292}
8293
09540bc3
JH
8294/* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
8295 * this function provided for binary compatibility only
8296 */
8297
8298char *
8299Perl_sv_pvbyte(pTHX_ SV *sv)
8300{
8301 sv_utf8_downgrade(sv,0);
8302 return sv_pv(sv);
8303}
8304
645c22ef
DM
8305/*
8306=for apidoc sv_pvbyte
8307
baca2b92 8308Use C<SvPVbyte_nolen> instead.
645c22ef 8309
645c22ef
DM
8310=for apidoc sv_pvbyten
8311
8312A private implementation of the C<SvPVbyte> macro for compilers
8313which can't cope with complex macro expressions. Always use the macro
8314instead.
8315
8316=cut
8317*/
8318
7340a771
GS
8319char *
8320Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
8321{
ffebcc3e 8322 sv_utf8_downgrade(sv,0);
7340a771
GS
8323 return sv_pvn(sv,lp);
8324}
8325
645c22ef
DM
8326/*
8327=for apidoc sv_pvbyten_force
8328
8329A private implementation of the C<SvPVbytex_force> macro for compilers
8330which can't cope with complex macro expressions. Always use the macro
8331instead.
8332
8333=cut
8334*/
8335
7340a771
GS
8336char *
8337Perl_sv_pvbyten_force(pTHX_ SV *sv, STRLEN *lp)
8338{
46ec2f14 8339 sv_pvn_force(sv,lp);
ffebcc3e 8340 sv_utf8_downgrade(sv,0);
46ec2f14
TS
8341 *lp = SvCUR(sv);
8342 return SvPVX(sv);
7340a771
GS
8343}
8344
09540bc3
JH
8345/* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
8346 * this function provided for binary compatibility only
8347 */
8348
8349char *
8350Perl_sv_pvutf8(pTHX_ SV *sv)
8351{
8352 sv_utf8_upgrade(sv);
8353 return sv_pv(sv);
8354}
8355
645c22ef
DM
8356/*
8357=for apidoc sv_pvutf8
8358
baca2b92 8359Use the C<SvPVutf8_nolen> macro instead
645c22ef 8360
645c22ef
DM
8361=for apidoc sv_pvutf8n
8362
8363A private implementation of the C<SvPVutf8> macro for compilers
8364which can't cope with complex macro expressions. Always use the macro
8365instead.
8366
8367=cut
8368*/
8369
7340a771
GS
8370char *
8371Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
8372{
560a288e 8373 sv_utf8_upgrade(sv);
7340a771
GS
8374 return sv_pvn(sv,lp);
8375}
8376
c461cf8f
JH
8377/*
8378=for apidoc sv_pvutf8n_force
8379
645c22ef
DM
8380A private implementation of the C<SvPVutf8_force> macro for compilers
8381which can't cope with complex macro expressions. Always use the macro
8382instead.
c461cf8f
JH
8383
8384=cut
8385*/
8386
7340a771
GS
8387char *
8388Perl_sv_pvutf8n_force(pTHX_ SV *sv, STRLEN *lp)
8389{
46ec2f14 8390 sv_pvn_force(sv,lp);
560a288e 8391 sv_utf8_upgrade(sv);
46ec2f14
TS
8392 *lp = SvCUR(sv);
8393 return SvPVX(sv);
7340a771
GS
8394}
8395
c461cf8f
JH
8396/*
8397=for apidoc sv_reftype
8398
8399Returns a string describing what the SV is a reference to.
8400
8401=cut
8402*/
8403
7340a771 8404char *
864dbfa3 8405Perl_sv_reftype(pTHX_ SV *sv, int ob)
a0d0e21e 8406{
c86bf373 8407 if (ob && SvOBJECT(sv)) {
b7a91edc
NC
8408 char *name = HvNAME(SvSTASH(sv));
8409 return name ? name : "__ANON__";
c86bf373 8410 }
a0d0e21e
LW
8411 else {
8412 switch (SvTYPE(sv)) {
8413 case SVt_NULL:
8414 case SVt_IV:
8415 case SVt_NV:
8416 case SVt_RV:
8417 case SVt_PV:
8418 case SVt_PVIV:
8419 case SVt_PVNV:
8420 case SVt_PVMG:
8421 case SVt_PVBM:
439cb1c4
JP
8422 if (SvVOK(sv))
8423 return "VSTRING";
a0d0e21e
LW
8424 if (SvROK(sv))
8425 return "REF";
8426 else
8427 return "SCALAR";
be65207d
DM
8428
8429 case SVt_PVLV: return SvROK(sv) ? "REF"
8430 /* tied lvalues should appear to be
8431 * scalars for backwards compatitbility */
8432 : (LvTYPE(sv) == 't' || LvTYPE(sv) == 'T')
8433 ? "SCALAR" : "LVALUE";
a0d0e21e
LW
8434 case SVt_PVAV: return "ARRAY";
8435 case SVt_PVHV: return "HASH";
8436 case SVt_PVCV: return "CODE";
8437 case SVt_PVGV: return "GLOB";
1d2dff63 8438 case SVt_PVFM: return "FORMAT";
27f9d8f3 8439 case SVt_PVIO: return "IO";
a0d0e21e
LW
8440 default: return "UNKNOWN";
8441 }
8442 }
8443}
8444
954c1994
GS
8445/*
8446=for apidoc sv_isobject
8447
8448Returns a boolean indicating whether the SV is an RV pointing to a blessed
8449object. If the SV is not an RV, or if the object is not blessed, then this
8450will return false.
8451
8452=cut
8453*/
8454
463ee0b2 8455int
864dbfa3 8456Perl_sv_isobject(pTHX_ SV *sv)
85e6fe83 8457{
68dc0745 8458 if (!sv)
8459 return 0;
8460 if (SvGMAGICAL(sv))
8461 mg_get(sv);
85e6fe83
LW
8462 if (!SvROK(sv))
8463 return 0;
8464 sv = (SV*)SvRV(sv);
8465 if (!SvOBJECT(sv))
8466 return 0;
8467 return 1;
8468}
8469
954c1994
GS
8470/*
8471=for apidoc sv_isa
8472
8473Returns a boolean indicating whether the SV is blessed into the specified
8474class. This does not check for subtypes; use C<sv_derived_from> to verify
8475an inheritance relationship.
8476
8477=cut
8478*/
8479
85e6fe83 8480int
864dbfa3 8481Perl_sv_isa(pTHX_ SV *sv, const char *name)
463ee0b2 8482{
68dc0745 8483 if (!sv)
8484 return 0;
8485 if (SvGMAGICAL(sv))
8486 mg_get(sv);
ed6116ce 8487 if (!SvROK(sv))
463ee0b2 8488 return 0;
ed6116ce
LW
8489 sv = (SV*)SvRV(sv);
8490 if (!SvOBJECT(sv))
463ee0b2 8491 return 0;
e27ad1f2
AV
8492 if (!HvNAME(SvSTASH(sv)))
8493 return 0;
463ee0b2
LW
8494
8495 return strEQ(HvNAME(SvSTASH(sv)), name);
8496}
8497
954c1994
GS
8498/*
8499=for apidoc newSVrv
8500
8501Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
8502it will be upgraded to one. If C<classname> is non-null then the new SV will
8503be blessed in the specified package. The new SV is returned and its
8504reference count is 1.
8505
8506=cut
8507*/
8508
463ee0b2 8509SV*
864dbfa3 8510Perl_newSVrv(pTHX_ SV *rv, const char *classname)
463ee0b2 8511{
463ee0b2
LW
8512 SV *sv;
8513
4561caa4 8514 new_SV(sv);
51cf62d8 8515
765f542d 8516 SV_CHECK_THINKFIRST_COW_DROP(rv);
51cf62d8 8517 SvAMAGIC_off(rv);
51cf62d8 8518
0199fce9
JD
8519 if (SvTYPE(rv) >= SVt_PVMG) {
8520 U32 refcnt = SvREFCNT(rv);
8521 SvREFCNT(rv) = 0;
8522 sv_clear(rv);
8523 SvFLAGS(rv) = 0;
8524 SvREFCNT(rv) = refcnt;
8525 }
8526
51cf62d8 8527 if (SvTYPE(rv) < SVt_RV)
0199fce9
JD
8528 sv_upgrade(rv, SVt_RV);
8529 else if (SvTYPE(rv) > SVt_RV) {
0c34ef67 8530 SvOOK_off(rv);
0199fce9
JD
8531 if (SvPVX(rv) && SvLEN(rv))
8532 Safefree(SvPVX(rv));
8533 SvCUR_set(rv, 0);
8534 SvLEN_set(rv, 0);
8535 }
51cf62d8 8536
0c34ef67 8537 SvOK_off(rv);
053fc874 8538 SvRV(rv) = sv;
ed6116ce 8539 SvROK_on(rv);
463ee0b2 8540
a0d0e21e
LW
8541 if (classname) {
8542 HV* stash = gv_stashpv(classname, TRUE);
8543 (void)sv_bless(rv, stash);
8544 }
8545 return sv;
8546}
8547
954c1994
GS
8548/*
8549=for apidoc sv_setref_pv
8550
8551Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
8552argument will be upgraded to an RV. That RV will be modified to point to
8553the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
8554into the SV. The C<classname> argument indicates the package for the
8555blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
d34c2299 8556will have a reference count of 1, and the RV will be returned.
954c1994
GS
8557
8558Do not use with other Perl types such as HV, AV, SV, CV, because those
8559objects will become corrupted by the pointer copy process.
8560
8561Note that C<sv_setref_pvn> copies the string while this copies the pointer.
8562
8563=cut
8564*/
8565
a0d0e21e 8566SV*
864dbfa3 8567Perl_sv_setref_pv(pTHX_ SV *rv, const char *classname, void *pv)
a0d0e21e 8568{
189b2af5 8569 if (!pv) {
3280af22 8570 sv_setsv(rv, &PL_sv_undef);
189b2af5
GS
8571 SvSETMAGIC(rv);
8572 }
a0d0e21e 8573 else
56431972 8574 sv_setiv(newSVrv(rv,classname), PTR2IV(pv));
a0d0e21e
LW
8575 return rv;
8576}
8577
954c1994
GS
8578/*
8579=for apidoc sv_setref_iv
8580
8581Copies an integer into a new SV, optionally blessing the SV. The C<rv>
8582argument will be upgraded to an RV. That RV will be modified to point to
8583the new SV. The C<classname> argument indicates the package for the
8584blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
d34c2299 8585will have a reference count of 1, and the RV will be returned.
954c1994
GS
8586
8587=cut
8588*/
8589
a0d0e21e 8590SV*
864dbfa3 8591Perl_sv_setref_iv(pTHX_ SV *rv, const char *classname, IV iv)
a0d0e21e
LW
8592{
8593 sv_setiv(newSVrv(rv,classname), iv);
8594 return rv;
8595}
8596
954c1994 8597/*
e1c57cef
JH
8598=for apidoc sv_setref_uv
8599
8600Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
8601argument will be upgraded to an RV. That RV will be modified to point to
8602the new SV. The C<classname> argument indicates the package for the
8603blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
d34c2299 8604will have a reference count of 1, and the RV will be returned.
e1c57cef
JH
8605
8606=cut
8607*/
8608
8609SV*
8610Perl_sv_setref_uv(pTHX_ SV *rv, const char *classname, UV uv)
8611{
8612 sv_setuv(newSVrv(rv,classname), uv);
8613 return rv;
8614}
8615
8616/*
954c1994
GS
8617=for apidoc sv_setref_nv
8618
8619Copies a double into a new SV, optionally blessing the SV. The C<rv>
8620argument will be upgraded to an RV. That RV will be modified to point to
8621the new SV. The C<classname> argument indicates the package for the
8622blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
d34c2299 8623will have a reference count of 1, and the RV will be returned.
954c1994
GS
8624
8625=cut
8626*/
8627
a0d0e21e 8628SV*
65202027 8629Perl_sv_setref_nv(pTHX_ SV *rv, const char *classname, NV nv)
a0d0e21e
LW
8630{
8631 sv_setnv(newSVrv(rv,classname), nv);
8632 return rv;
8633}
463ee0b2 8634
954c1994
GS
8635/*
8636=for apidoc sv_setref_pvn
8637
8638Copies a string into a new SV, optionally blessing the SV. The length of the
8639string must be specified with C<n>. The C<rv> argument will be upgraded to
8640an RV. That RV will be modified to point to the new SV. The C<classname>
8641argument indicates the package for the blessing. Set C<classname> to
7a5fa8a2 8642C<Nullch> to avoid the blessing. The new SV will have a reference count
d34c2299 8643of 1, and the RV will be returned.
954c1994
GS
8644
8645Note that C<sv_setref_pv> copies the pointer while this copies the string.
8646
8647=cut
8648*/
8649
a0d0e21e 8650SV*
864dbfa3 8651Perl_sv_setref_pvn(pTHX_ SV *rv, const char *classname, char *pv, STRLEN n)
a0d0e21e
LW
8652{
8653 sv_setpvn(newSVrv(rv,classname), pv, n);
463ee0b2
LW
8654 return rv;
8655}
8656
954c1994
GS
8657/*
8658=for apidoc sv_bless
8659
8660Blesses an SV into a specified package. The SV must be an RV. The package
8661must be designated by its stash (see C<gv_stashpv()>). The reference count
8662of the SV is unaffected.
8663
8664=cut
8665*/
8666
a0d0e21e 8667SV*
864dbfa3 8668Perl_sv_bless(pTHX_ SV *sv, HV *stash)
a0d0e21e 8669{
76e3520e 8670 SV *tmpRef;
a0d0e21e 8671 if (!SvROK(sv))
cea2e8a9 8672 Perl_croak(aTHX_ "Can't bless non-reference value");
76e3520e
GS
8673 tmpRef = SvRV(sv);
8674 if (SvFLAGS(tmpRef) & (SVs_OBJECT|SVf_READONLY)) {
8675 if (SvREADONLY(tmpRef))
cea2e8a9 8676 Perl_croak(aTHX_ PL_no_modify);
76e3520e
GS
8677 if (SvOBJECT(tmpRef)) {
8678 if (SvTYPE(tmpRef) != SVt_PVIO)
3280af22 8679 --PL_sv_objcount;
76e3520e 8680 SvREFCNT_dec(SvSTASH(tmpRef));
2e3febc6 8681 }
a0d0e21e 8682 }
76e3520e
GS
8683 SvOBJECT_on(tmpRef);
8684 if (SvTYPE(tmpRef) != SVt_PVIO)
3280af22 8685 ++PL_sv_objcount;
76e3520e
GS
8686 (void)SvUPGRADE(tmpRef, SVt_PVMG);
8687 SvSTASH(tmpRef) = (HV*)SvREFCNT_inc(stash);
a0d0e21e 8688
2e3febc6
CS
8689 if (Gv_AMG(stash))
8690 SvAMAGIC_on(sv);
8691 else
8692 SvAMAGIC_off(sv);
a0d0e21e 8693
1edbfb88
AB
8694 if(SvSMAGICAL(tmpRef))
8695 if(mg_find(tmpRef, PERL_MAGIC_ext) || mg_find(tmpRef, PERL_MAGIC_uvar))
8696 mg_set(tmpRef);
8697
8698
ecdeb87c 8699
a0d0e21e
LW
8700 return sv;
8701}
8702
645c22ef 8703/* Downgrades a PVGV to a PVMG.
645c22ef
DM
8704 */
8705
76e3520e 8706STATIC void
cea2e8a9 8707S_sv_unglob(pTHX_ SV *sv)
a0d0e21e 8708{
850fabdf
GS
8709 void *xpvmg;
8710
a0d0e21e
LW
8711 assert(SvTYPE(sv) == SVt_PVGV);
8712 SvFAKE_off(sv);
8713 if (GvGP(sv))
1edc1566 8714 gp_free((GV*)sv);
e826b3c7
GS
8715 if (GvSTASH(sv)) {
8716 SvREFCNT_dec(GvSTASH(sv));
8717 GvSTASH(sv) = Nullhv;
8718 }
14befaf4 8719 sv_unmagic(sv, PERL_MAGIC_glob);
a0d0e21e 8720 Safefree(GvNAME(sv));
a5f75d66 8721 GvMULTI_off(sv);
850fabdf
GS
8722
8723 /* need to keep SvANY(sv) in the right arena */
8724 xpvmg = new_XPVMG();
8725 StructCopy(SvANY(sv), xpvmg, XPVMG);
8726 del_XPVGV(SvANY(sv));
8727 SvANY(sv) = xpvmg;
8728
a0d0e21e
LW
8729 SvFLAGS(sv) &= ~SVTYPEMASK;
8730 SvFLAGS(sv) |= SVt_PVMG;
8731}
8732
954c1994 8733/*
840a7b70 8734=for apidoc sv_unref_flags
954c1994
GS
8735
8736Unsets the RV status of the SV, and decrements the reference count of
8737whatever was being referenced by the RV. This can almost be thought of
840a7b70
IZ
8738as a reversal of C<newSVrv>. The C<cflags> argument can contain
8739C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
8740(otherwise the decrementing is conditional on the reference count being
8741different from one or the reference being a readonly SV).
7889fe52 8742See C<SvROK_off>.
954c1994
GS
8743
8744=cut
8745*/
8746
ed6116ce 8747void
840a7b70 8748Perl_sv_unref_flags(pTHX_ SV *sv, U32 flags)
ed6116ce 8749{
a0d0e21e 8750 SV* rv = SvRV(sv);
810b8aa5
GS
8751
8752 if (SvWEAKREF(sv)) {
8753 sv_del_backref(sv);
8754 SvWEAKREF_off(sv);
8755 SvRV(sv) = 0;
8756 return;
8757 }
ed6116ce
LW
8758 SvRV(sv) = 0;
8759 SvROK_off(sv);
04ca4930
NC
8760 /* You can't have a || SvREADONLY(rv) here, as $a = $$a, where $a was
8761 assigned to as BEGIN {$a = \"Foo"} will fail. */
8762 if (SvREFCNT(rv) != 1 || (flags & SV_IMMEDIATE_UNREF))
4633a7c4 8763 SvREFCNT_dec(rv);
840a7b70 8764 else /* XXX Hack, but hard to make $a=$a->[1] work otherwise */
4633a7c4 8765 sv_2mortal(rv); /* Schedule for freeing later */
ed6116ce 8766}
8990e307 8767
840a7b70
IZ
8768/*
8769=for apidoc sv_unref
8770
8771Unsets the RV status of the SV, and decrements the reference count of
8772whatever was being referenced by the RV. This can almost be thought of
8773as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
7889fe52 8774being zero. See C<SvROK_off>.
840a7b70
IZ
8775
8776=cut
8777*/
8778
8779void
8780Perl_sv_unref(pTHX_ SV *sv)
8781{
8782 sv_unref_flags(sv, 0);
8783}
8784
645c22ef
DM
8785/*
8786=for apidoc sv_taint
8787
8788Taint an SV. Use C<SvTAINTED_on> instead.
8789=cut
8790*/
8791
bbce6d69 8792void
864dbfa3 8793Perl_sv_taint(pTHX_ SV *sv)
bbce6d69 8794{
14befaf4 8795 sv_magic((sv), Nullsv, PERL_MAGIC_taint, Nullch, 0);
bbce6d69 8796}
8797
645c22ef
DM
8798/*
8799=for apidoc sv_untaint
8800
8801Untaint an SV. Use C<SvTAINTED_off> instead.
8802=cut
8803*/
8804
bbce6d69 8805void
864dbfa3 8806Perl_sv_untaint(pTHX_ SV *sv)
bbce6d69 8807{
13f57bf8 8808 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
14befaf4 8809 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
36477c24 8810 if (mg)
565764a8 8811 mg->mg_len &= ~1;
36477c24 8812 }
bbce6d69 8813}
8814
645c22ef
DM
8815/*
8816=for apidoc sv_tainted
8817
8818Test an SV for taintedness. Use C<SvTAINTED> instead.
8819=cut
8820*/
8821
bbce6d69 8822bool
864dbfa3 8823Perl_sv_tainted(pTHX_ SV *sv)
bbce6d69 8824{
13f57bf8 8825 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
14befaf4 8826 MAGIC *mg = mg_find(sv, PERL_MAGIC_taint);
155aba94 8827 if (mg && ((mg->mg_len & 1) || ((mg->mg_len & 2) && mg->mg_obj == sv)))
36477c24 8828 return TRUE;
8829 }
8830 return FALSE;
bbce6d69 8831}
8832
09540bc3
JH
8833/*
8834=for apidoc sv_setpviv
8835
8836Copies an integer into the given SV, also updating its string value.
8837Does not handle 'set' magic. See C<sv_setpviv_mg>.
8838
8839=cut
8840*/
8841
8842void
8843Perl_sv_setpviv(pTHX_ SV *sv, IV iv)
8844{
8845 char buf[TYPE_CHARS(UV)];
8846 char *ebuf;
8847 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8848
8849 sv_setpvn(sv, ptr, ebuf - ptr);
8850}
8851
8852/*
8853=for apidoc sv_setpviv_mg
8854
8855Like C<sv_setpviv>, but also handles 'set' magic.
8856
8857=cut
8858*/
8859
8860void
8861Perl_sv_setpviv_mg(pTHX_ SV *sv, IV iv)
8862{
8863 char buf[TYPE_CHARS(UV)];
8864 char *ebuf;
8865 char *ptr = uiv_2buf(buf, iv, 0, 0, &ebuf);
8866
8867 sv_setpvn(sv, ptr, ebuf - ptr);
8868 SvSETMAGIC(sv);
8869}
8870
cea2e8a9 8871#if defined(PERL_IMPLICIT_CONTEXT)
645c22ef
DM
8872
8873/* pTHX_ magic can't cope with varargs, so this is a no-context
8874 * version of the main function, (which may itself be aliased to us).
8875 * Don't access this version directly.
8876 */
8877
cea2e8a9
GS
8878void
8879Perl_sv_setpvf_nocontext(SV *sv, const char* pat, ...)
8880{
8881 dTHX;
8882 va_list args;
8883 va_start(args, pat);
c5be433b 8884 sv_vsetpvf(sv, pat, &args);
cea2e8a9
GS
8885 va_end(args);
8886}
8887
645c22ef
DM
8888/* pTHX_ magic can't cope with varargs, so this is a no-context
8889 * version of the main function, (which may itself be aliased to us).
8890 * Don't access this version directly.
8891 */
cea2e8a9
GS
8892
8893void
8894Perl_sv_setpvf_mg_nocontext(SV *sv, const char* pat, ...)
8895{
8896 dTHX;
8897 va_list args;
8898 va_start(args, pat);
c5be433b 8899 sv_vsetpvf_mg(sv, pat, &args);
cea2e8a9 8900 va_end(args);
cea2e8a9
GS
8901}
8902#endif
8903
954c1994
GS
8904/*
8905=for apidoc sv_setpvf
8906
bffc3d17
SH
8907Works like C<sv_catpvf> but copies the text into the SV instead of
8908appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
954c1994
GS
8909
8910=cut
8911*/
8912
46fc3d4c 8913void
864dbfa3 8914Perl_sv_setpvf(pTHX_ SV *sv, const char* pat, ...)
46fc3d4c 8915{
8916 va_list args;
46fc3d4c 8917 va_start(args, pat);
c5be433b 8918 sv_vsetpvf(sv, pat, &args);
46fc3d4c 8919 va_end(args);
8920}
8921
bffc3d17
SH
8922/*
8923=for apidoc sv_vsetpvf
8924
8925Works like C<sv_vcatpvf> but copies the text into the SV instead of
8926appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
8927
8928Usually used via its frontend C<sv_setpvf>.
8929
8930=cut
8931*/
645c22ef 8932
c5be433b
GS
8933void
8934Perl_sv_vsetpvf(pTHX_ SV *sv, const char* pat, va_list* args)
8935{
8936 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
8937}
ef50df4b 8938
954c1994
GS
8939/*
8940=for apidoc sv_setpvf_mg
8941
8942Like C<sv_setpvf>, but also handles 'set' magic.
8943
8944=cut
8945*/
8946
ef50df4b 8947void
864dbfa3 8948Perl_sv_setpvf_mg(pTHX_ SV *sv, const char* pat, ...)
ef50df4b
GS
8949{
8950 va_list args;
ef50df4b 8951 va_start(args, pat);
c5be433b 8952 sv_vsetpvf_mg(sv, pat, &args);
ef50df4b 8953 va_end(args);
c5be433b
GS
8954}
8955
bffc3d17
SH
8956/*
8957=for apidoc sv_vsetpvf_mg
8958
8959Like C<sv_vsetpvf>, but also handles 'set' magic.
8960
8961Usually used via its frontend C<sv_setpvf_mg>.
8962
8963=cut
8964*/
645c22ef 8965
c5be433b
GS
8966void
8967Perl_sv_vsetpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
8968{
8969 sv_vsetpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
ef50df4b
GS
8970 SvSETMAGIC(sv);
8971}
8972
cea2e8a9 8973#if defined(PERL_IMPLICIT_CONTEXT)
645c22ef
DM
8974
8975/* pTHX_ magic can't cope with varargs, so this is a no-context
8976 * version of the main function, (which may itself be aliased to us).
8977 * Don't access this version directly.
8978 */
8979
cea2e8a9
GS
8980void
8981Perl_sv_catpvf_nocontext(SV *sv, const char* pat, ...)
8982{
8983 dTHX;
8984 va_list args;
8985 va_start(args, pat);
c5be433b 8986 sv_vcatpvf(sv, pat, &args);
cea2e8a9
GS
8987 va_end(args);
8988}
8989
645c22ef
DM
8990/* pTHX_ magic can't cope with varargs, so this is a no-context
8991 * version of the main function, (which may itself be aliased to us).
8992 * Don't access this version directly.
8993 */
8994
cea2e8a9
GS
8995void
8996Perl_sv_catpvf_mg_nocontext(SV *sv, const char* pat, ...)
8997{
8998 dTHX;
8999 va_list args;
9000 va_start(args, pat);
c5be433b 9001 sv_vcatpvf_mg(sv, pat, &args);
cea2e8a9 9002 va_end(args);
cea2e8a9
GS
9003}
9004#endif
9005
954c1994
GS
9006/*
9007=for apidoc sv_catpvf
9008
d5ce4a7c
GA
9009Processes its arguments like C<sprintf> and appends the formatted
9010output to an SV. If the appended data contains "wide" characters
9011(including, but not limited to, SVs with a UTF-8 PV formatted with %s,
9012and characters >255 formatted with %c), the original SV might get
bffc3d17
SH
9013upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
9014C<sv_catpvf_mg>.
954c1994 9015
d5ce4a7c 9016=cut */
954c1994 9017
46fc3d4c 9018void
864dbfa3 9019Perl_sv_catpvf(pTHX_ SV *sv, const char* pat, ...)
46fc3d4c 9020{
9021 va_list args;
46fc3d4c 9022 va_start(args, pat);
c5be433b 9023 sv_vcatpvf(sv, pat, &args);
46fc3d4c 9024 va_end(args);
9025}
9026
bffc3d17
SH
9027/*
9028=for apidoc sv_vcatpvf
9029
9030Processes its arguments like C<vsprintf> and appends the formatted output
9031to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
9032
9033Usually used via its frontend C<sv_catpvf>.
9034
9035=cut
9036*/
645c22ef 9037
ef50df4b 9038void
c5be433b
GS
9039Perl_sv_vcatpvf(pTHX_ SV *sv, const char* pat, va_list* args)
9040{
9041 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
9042}
9043
954c1994
GS
9044/*
9045=for apidoc sv_catpvf_mg
9046
9047Like C<sv_catpvf>, but also handles 'set' magic.
9048
9049=cut
9050*/
9051
c5be433b 9052void
864dbfa3 9053Perl_sv_catpvf_mg(pTHX_ SV *sv, const char* pat, ...)
ef50df4b
GS
9054{
9055 va_list args;
ef50df4b 9056 va_start(args, pat);
c5be433b 9057 sv_vcatpvf_mg(sv, pat, &args);
ef50df4b 9058 va_end(args);
c5be433b
GS
9059}
9060
bffc3d17
SH
9061/*
9062=for apidoc sv_vcatpvf_mg
9063
9064Like C<sv_vcatpvf>, but also handles 'set' magic.
9065
9066Usually used via its frontend C<sv_catpvf_mg>.
9067
9068=cut
9069*/
645c22ef 9070
c5be433b
GS
9071void
9072Perl_sv_vcatpvf_mg(pTHX_ SV *sv, const char* pat, va_list* args)
9073{
9074 sv_vcatpvfn(sv, pat, strlen(pat), args, Null(SV**), 0, Null(bool*));
ef50df4b
GS
9075 SvSETMAGIC(sv);
9076}
9077
954c1994
GS
9078/*
9079=for apidoc sv_vsetpvfn
9080
bffc3d17 9081Works like C<sv_vcatpvfn> but copies the text into the SV instead of
954c1994
GS
9082appending it.
9083
bffc3d17 9084Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
645c22ef 9085
954c1994
GS
9086=cut
9087*/
9088
46fc3d4c 9089void
7d5ea4e7 9090Perl_sv_vsetpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
46fc3d4c 9091{
9092 sv_setpvn(sv, "", 0);
7d5ea4e7 9093 sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, maybe_tainted);
46fc3d4c 9094}
9095
645c22ef
DM
9096/* private function for use in sv_vcatpvfn via the EXPECT_NUMBER macro */
9097
2d00ba3b 9098STATIC I32
9dd79c3f 9099S_expect_number(pTHX_ char** pattern)
211dfcf1
HS
9100{
9101 I32 var = 0;
9102 switch (**pattern) {
9103 case '1': case '2': case '3':
9104 case '4': case '5': case '6':
9105 case '7': case '8': case '9':
9106 while (isDIGIT(**pattern))
9107 var = var * 10 + (*(*pattern)++ - '0');
9108 }
9109 return var;
9110}
9dd79c3f 9111#define EXPECT_NUMBER(pattern, var) (var = S_expect_number(aTHX_ &pattern))
211dfcf1 9112
4151a5fe
IZ
9113static char *
9114F0convert(NV nv, char *endbuf, STRLEN *len)
9115{
9116 int neg = nv < 0;
9117 UV uv;
9118 char *p = endbuf;
9119
9120 if (neg)
9121 nv = -nv;
9122 if (nv < UV_MAX) {
9123 nv += 0.5;
028f8eaa 9124 uv = (UV)nv;
4151a5fe
IZ
9125 if (uv & 1 && uv == nv)
9126 uv--; /* Round to even */
9127 do {
9128 unsigned dig = uv % 10;
9129 *--p = '0' + dig;
9130 } while (uv /= 10);
9131 if (neg)
9132 *--p = '-';
9133 *len = endbuf - p;
9134 return p;
9135 }
9136 return Nullch;
9137}
9138
9139
954c1994
GS
9140/*
9141=for apidoc sv_vcatpvfn
9142
9143Processes its arguments like C<vsprintf> and appends the formatted output
9144to an SV. Uses an array of SVs if the C style variable argument list is
9145missing (NULL). When running with taint checks enabled, indicates via
9146C<maybe_tainted> if results are untrustworthy (often due to the use of
9147locales).
9148
bffc3d17 9149Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
645c22ef 9150
954c1994
GS
9151=cut
9152*/
9153
46fc3d4c 9154void
7d5ea4e7 9155Perl_sv_vcatpvfn(pTHX_ SV *sv, const char *pat, STRLEN patlen, va_list *args, SV **svargs, I32 svmax, bool *maybe_tainted)
46fc3d4c 9156{
9157 char *p;
9158 char *q;
9159 char *patend;
fc36a67e 9160 STRLEN origlen;
46fc3d4c 9161 I32 svix = 0;
c635e13b 9162 static char nullstr[] = "(null)";
9c5ffd7c 9163 SV *argsv = Nullsv;
db79b45b
JH
9164 bool has_utf8; /* has the result utf8? */
9165 bool pat_utf8; /* the pattern is in utf8? */
9166 SV *nsv = Nullsv;
4151a5fe
IZ
9167 /* Times 4: a decimal digit takes more than 3 binary digits.
9168 * NV_DIG: mantissa takes than many decimal digits.
9169 * Plus 32: Playing safe. */
9170 char ebuf[IV_DIG * 4 + NV_DIG + 32];
9171 /* large enough for "%#.#f" --chip */
9172 /* what about long double NVs? --jhi */
db79b45b
JH
9173
9174 has_utf8 = pat_utf8 = DO_UTF8(sv);
46fc3d4c 9175
9176 /* no matter what, this is a string now */
fc36a67e 9177 (void)SvPV_force(sv, origlen);
46fc3d4c 9178
fc36a67e 9179 /* special-case "", "%s", and "%_" */
46fc3d4c 9180 if (patlen == 0)
9181 return;
fc36a67e 9182 if (patlen == 2 && pat[0] == '%') {
9183 switch (pat[1]) {
9184 case 's':
c635e13b 9185 if (args) {
9186 char *s = va_arg(*args, char*);
9187 sv_catpv(sv, s ? s : nullstr);
9188 }
7e2040f0 9189 else if (svix < svmax) {
fc36a67e 9190 sv_catsv(sv, *svargs);
7e2040f0
GS
9191 if (DO_UTF8(*svargs))
9192 SvUTF8_on(sv);
9193 }
fc36a67e 9194 return;
9195 case '_':
9196 if (args) {
7e2040f0
GS
9197 argsv = va_arg(*args, SV*);
9198 sv_catsv(sv, argsv);
9199 if (DO_UTF8(argsv))
9200 SvUTF8_on(sv);
fc36a67e 9201 return;
9202 }
9203 /* See comment on '_' below */
9204 break;
9205 }
46fc3d4c 9206 }
9207
1d917b39 9208#ifndef USE_LONG_DOUBLE
4151a5fe
IZ
9209 /* special-case "%.<number>[gf]" */
9210 if ( patlen <= 5 && pat[0] == '%' && pat[1] == '.'
9211 && (pat[patlen-1] == 'g' || pat[patlen-1] == 'f') ) {
9212 unsigned digits = 0;
9213 const char *pp;
9214
9215 pp = pat + 2;
9216 while (*pp >= '0' && *pp <= '9')
9217 digits = 10 * digits + (*pp++ - '0');
028f8eaa 9218 if (pp - pat == (int)patlen - 1) {
4151a5fe
IZ
9219 NV nv;
9220
9221 if (args)
9222 nv = (NV)va_arg(*args, double);
9223 else if (svix < svmax)
9224 nv = SvNV(*svargs);
9225 else
9226 return;
9227 if (*pp == 'g') {
2873255c
NC
9228 /* Add check for digits != 0 because it seems that some
9229 gconverts are buggy in this case, and we don't yet have
9230 a Configure test for this. */
9231 if (digits && digits < sizeof(ebuf) - NV_DIG - 10) {
9232 /* 0, point, slack */
2e59c212 9233 Gconvert(nv, (int)digits, 0, ebuf);
4151a5fe
IZ
9234 sv_catpv(sv, ebuf);
9235 if (*ebuf) /* May return an empty string for digits==0 */
9236 return;
9237 }
9238 } else if (!digits) {
9239 STRLEN l;
9240
9241 if ((p = F0convert(nv, ebuf + sizeof ebuf, &l))) {
9242 sv_catpvn(sv, p, l);
9243 return;
9244 }
9245 }
9246 }
9247 }
1d917b39 9248#endif /* !USE_LONG_DOUBLE */
4151a5fe 9249
2cf2cfc6 9250 if (!args && svix < svmax && DO_UTF8(*svargs))
205f51d8 9251 has_utf8 = TRUE;
2cf2cfc6 9252
46fc3d4c 9253 patend = (char*)pat + patlen;
9254 for (p = (char*)pat; p < patend; p = q) {
9255 bool alt = FALSE;
9256 bool left = FALSE;
b22c7a20 9257 bool vectorize = FALSE;
211dfcf1 9258 bool vectorarg = FALSE;
2cf2cfc6 9259 bool vec_utf8 = FALSE;
46fc3d4c 9260 char fill = ' ';
9261 char plus = 0;
9262 char intsize = 0;
9263 STRLEN width = 0;
fc36a67e 9264 STRLEN zeros = 0;
46fc3d4c 9265 bool has_precis = FALSE;
9266 STRLEN precis = 0;
58e33a90 9267 I32 osvix = svix;
2cf2cfc6 9268 bool is_utf8 = FALSE; /* is this item utf8? */
20f6aaab
AS
9269#ifdef HAS_LDBL_SPRINTF_BUG
9270 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
205f51d8 9271 with sfio - Allen <allens@cpan.org> */
20f6aaab
AS
9272 bool fix_ldbl_sprintf_bug = FALSE;
9273#endif
205f51d8 9274
46fc3d4c 9275 char esignbuf[4];
ad391ad9 9276 U8 utf8buf[UTF8_MAXLEN+1];
46fc3d4c 9277 STRLEN esignlen = 0;
9278
9279 char *eptr = Nullch;
fc36a67e 9280 STRLEN elen = 0;
81f715da 9281 SV *vecsv = Nullsv;
a05b299f 9282 U8 *vecstr = Null(U8*);
b22c7a20 9283 STRLEN veclen = 0;
934abaf1 9284 char c = 0;
46fc3d4c 9285 int i;
9c5ffd7c 9286 unsigned base = 0;
8c8eb53c
RB
9287 IV iv = 0;
9288 UV uv = 0;
9e5b023a
JH
9289 /* we need a long double target in case HAS_LONG_DOUBLE but
9290 not USE_LONG_DOUBLE
9291 */
35fff930 9292#if defined(HAS_LONG_DOUBLE) && LONG_DOUBLESIZE > DOUBLESIZE
9e5b023a
JH
9293 long double nv;
9294#else
65202027 9295 NV nv;
9e5b023a 9296#endif
46fc3d4c 9297 STRLEN have;
9298 STRLEN need;
9299 STRLEN gap;
b22c7a20
GS
9300 char *dotstr = ".";
9301 STRLEN dotstrlen = 1;
211dfcf1 9302 I32 efix = 0; /* explicit format parameter index */
eb3fce90 9303 I32 ewix = 0; /* explicit width index */
211dfcf1
HS
9304 I32 epix = 0; /* explicit precision index */
9305 I32 evix = 0; /* explicit vector index */
eb3fce90 9306 bool asterisk = FALSE;
46fc3d4c 9307
211dfcf1 9308 /* echo everything up to the next format specification */
46fc3d4c 9309 for (q = p; q < patend && *q != '%'; ++q) ;
9310 if (q > p) {
db79b45b
JH
9311 if (has_utf8 && !pat_utf8)
9312 sv_catpvn_utf8_upgrade(sv, p, q - p, nsv);
9313 else
9314 sv_catpvn(sv, p, q - p);
46fc3d4c 9315 p = q;
9316 }
9317 if (q++ >= patend)
9318 break;
9319
211dfcf1
HS
9320/*
9321 We allow format specification elements in this order:
9322 \d+\$ explicit format parameter index
9323 [-+ 0#]+ flags
a472f209 9324 v|\*(\d+\$)?v vector with optional (optionally specified) arg
f3583277 9325 0 flag (as above): repeated to allow "v02"
211dfcf1
HS
9326 \d+|\*(\d+\$)? width using optional (optionally specified) arg
9327 \.(\d*|\*(\d+\$)?) precision using optional (optionally specified) arg
9328 [hlqLV] size
9329 [%bcdefginopsux_DFOUX] format (mandatory)
9330*/
9331 if (EXPECT_NUMBER(q, width)) {
9332 if (*q == '$') {
9333 ++q;
9334 efix = width;
9335 } else {
9336 goto gotwidth;
9337 }
9338 }
9339
fc36a67e 9340 /* FLAGS */
9341
46fc3d4c 9342 while (*q) {
9343 switch (*q) {
9344 case ' ':
9345 case '+':
9346 plus = *q++;
9347 continue;
9348
9349 case '-':
9350 left = TRUE;
9351 q++;
9352 continue;
9353
9354 case '0':
9355 fill = *q++;
9356 continue;
9357
9358 case '#':
9359 alt = TRUE;
9360 q++;
9361 continue;
9362
fc36a67e 9363 default:
9364 break;
9365 }
9366 break;
9367 }
46fc3d4c 9368
211dfcf1 9369 tryasterisk:
eb3fce90 9370 if (*q == '*') {
211dfcf1
HS
9371 q++;
9372 if (EXPECT_NUMBER(q, ewix))
9373 if (*q++ != '$')
9374 goto unknown;
eb3fce90 9375 asterisk = TRUE;
211dfcf1
HS
9376 }
9377 if (*q == 'v') {
eb3fce90 9378 q++;
211dfcf1
HS
9379 if (vectorize)
9380 goto unknown;
9cbac4c7 9381 if ((vectorarg = asterisk)) {
211dfcf1
HS
9382 evix = ewix;
9383 ewix = 0;
9384 asterisk = FALSE;
9385 }
9386 vectorize = TRUE;
9387 goto tryasterisk;
eb3fce90
JH
9388 }
9389
211dfcf1 9390 if (!asterisk)
7a5fa8a2 9391 if( *q == '0' )
f3583277 9392 fill = *q++;
211dfcf1
HS
9393 EXPECT_NUMBER(q, width);
9394
5df617be
RB
9395#ifdef CHECK_FORMAT
9396 if ((*q == 'p') && left) {
9397 vectorize = (width == 1);
9398 }
9399#endif
211dfcf1
HS
9400 if (vectorize) {
9401 if (vectorarg) {
9402 if (args)
9403 vecsv = va_arg(*args, SV*);
9404 else
9405 vecsv = (evix ? evix <= svmax : svix < svmax) ?
3a7a539e 9406 svargs[evix ? evix-1 : svix++] : &PL_sv_undef;
4459522c 9407 dotstr = SvPVx(vecsv, dotstrlen);
211dfcf1 9408 if (DO_UTF8(vecsv))
2cf2cfc6 9409 is_utf8 = TRUE;
211dfcf1
HS
9410 }
9411 if (args) {
9412 vecsv = va_arg(*args, SV*);
9413 vecstr = (U8*)SvPVx(vecsv,veclen);
2cf2cfc6 9414 vec_utf8 = DO_UTF8(vecsv);
eb3fce90 9415 }
211dfcf1
HS
9416 else if (efix ? efix <= svmax : svix < svmax) {
9417 vecsv = svargs[efix ? efix-1 : svix++];
9418 vecstr = (U8*)SvPVx(vecsv,veclen);
2cf2cfc6 9419 vec_utf8 = DO_UTF8(vecsv);
d7aa5382
JP
9420 /* if this is a version object, we need to return the
9421 * stringified representation (which the SvPVX has
9422 * already done for us), but not vectorize the args
9423 */
9424 if ( *q == 'd' && sv_derived_from(vecsv,"version") )
9425 {
9426 q++; /* skip past the rest of the %vd format */
da6068d9 9427 eptr = (char *) vecstr;
d7aa5382
JP
9428 elen = strlen(eptr);
9429 vectorize=FALSE;
9430 goto string;
9431 }
211dfcf1
HS
9432 }
9433 else {
9434 vecstr = (U8*)"";
9435 veclen = 0;
9436 }
eb3fce90 9437 }
fc36a67e 9438
eb3fce90 9439 if (asterisk) {
fc36a67e 9440 if (args)
9441 i = va_arg(*args, int);
9442 else
eb3fce90
JH
9443 i = (ewix ? ewix <= svmax : svix < svmax) ?
9444 SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
fc36a67e 9445 left |= (i < 0);
9446 width = (i < 0) ? -i : i;
fc36a67e 9447 }
211dfcf1 9448 gotwidth:
fc36a67e 9449
9450 /* PRECISION */
46fc3d4c 9451
fc36a67e 9452 if (*q == '.') {
9453 q++;
9454 if (*q == '*') {
211dfcf1 9455 q++;
7b8dd722
HS
9456 if (EXPECT_NUMBER(q, epix) && *q++ != '$')
9457 goto unknown;
9458 /* XXX: todo, support specified precision parameter */
9459 if (epix)
211dfcf1 9460 goto unknown;
46fc3d4c 9461 if (args)
9462 i = va_arg(*args, int);
9463 else
eb3fce90
JH
9464 i = (ewix ? ewix <= svmax : svix < svmax)
9465 ? SvIVx(svargs[ewix ? ewix-1 : svix++]) : 0;
fc36a67e 9466 precis = (i < 0) ? 0 : i;
fc36a67e 9467 }
9468 else {
9469 precis = 0;
9470 while (isDIGIT(*q))
9471 precis = precis * 10 + (*q++ - '0');
9472 }
9473 has_precis = TRUE;
9474 }
46fc3d4c 9475
fc36a67e 9476 /* SIZE */
46fc3d4c 9477
fc36a67e 9478 switch (*q) {
c623ac67
GS
9479#ifdef WIN32
9480 case 'I': /* Ix, I32x, and I64x */
9481# ifdef WIN64
9482 if (q[1] == '6' && q[2] == '4') {
9483 q += 3;
9484 intsize = 'q';
9485 break;
9486 }
9487# endif
9488 if (q[1] == '3' && q[2] == '2') {
9489 q += 3;
9490 break;
9491 }
9492# ifdef WIN64
9493 intsize = 'q';
9494# endif
9495 q++;
9496 break;
9497#endif
9e5b023a 9498#if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
6f9bb7fd 9499 case 'L': /* Ld */
e5c81feb 9500 /* FALL THROUGH */
e5c81feb 9501#ifdef HAS_QUAD
6f9bb7fd 9502 case 'q': /* qd */
9e5b023a 9503#endif
6f9bb7fd
GS
9504 intsize = 'q';
9505 q++;
9506 break;
9507#endif
fc36a67e 9508 case 'l':
9e5b023a 9509#if defined(HAS_QUAD) || defined(HAS_LONG_DOUBLE)
205f51d8 9510 if (*(q + 1) == 'l') { /* lld, llf */
fc36a67e 9511 intsize = 'q';
9512 q += 2;
46fc3d4c 9513 break;
cf2093f6 9514 }
fc36a67e 9515#endif
6f9bb7fd 9516 /* FALL THROUGH */
fc36a67e 9517 case 'h':
cf2093f6 9518 /* FALL THROUGH */
fc36a67e 9519 case 'V':
9520 intsize = *q++;
46fc3d4c 9521 break;
9522 }
9523
fc36a67e 9524 /* CONVERSION */
9525
211dfcf1
HS
9526 if (*q == '%') {
9527 eptr = q++;
9528 elen = 1;
9529 goto string;
9530 }
9531
be75b157
HS
9532 if (vectorize)
9533 argsv = vecsv;
9534 else if (!args)
211dfcf1
HS
9535 argsv = (efix ? efix <= svmax : svix < svmax) ?
9536 svargs[efix ? efix-1 : svix++] : &PL_sv_undef;
9537
46fc3d4c 9538 switch (c = *q++) {
9539
9540 /* STRINGS */
9541
46fc3d4c 9542 case 'c':
be75b157 9543 uv = (args && !vectorize) ? va_arg(*args, int) : SvIVx(argsv);
1bd104fb
JH
9544 if ((uv > 255 ||
9545 (!UNI_IS_INVARIANT(uv) && SvUTF8(sv)))
0064a8a9 9546 && !IN_BYTES) {
dfe13c55 9547 eptr = (char*)utf8buf;
9041c2e3 9548 elen = uvchr_to_utf8((U8*)eptr, uv) - utf8buf;
2cf2cfc6 9549 is_utf8 = TRUE;
7e2040f0
GS
9550 }
9551 else {
9552 c = (char)uv;
9553 eptr = &c;
9554 elen = 1;
a0ed51b3 9555 }
46fc3d4c 9556 goto string;
9557
46fc3d4c 9558 case 's':
be75b157 9559 if (args && !vectorize) {
fc36a67e 9560 eptr = va_arg(*args, char*);
c635e13b 9561 if (eptr)
1d7c1841
GS
9562#ifdef MACOS_TRADITIONAL
9563 /* On MacOS, %#s format is used for Pascal strings */
9564 if (alt)
9565 elen = *eptr++;
9566 else
9567#endif
c635e13b 9568 elen = strlen(eptr);
9569 else {
9570 eptr = nullstr;
9571 elen = sizeof nullstr - 1;
9572 }
46fc3d4c 9573 }
211dfcf1 9574 else {
7e2040f0
GS
9575 eptr = SvPVx(argsv, elen);
9576 if (DO_UTF8(argsv)) {
a0ed51b3
LW
9577 if (has_precis && precis < elen) {
9578 I32 p = precis;
7e2040f0 9579 sv_pos_u2b(argsv, &p, 0); /* sticks at end */
a0ed51b3
LW
9580 precis = p;
9581 }
9582 if (width) { /* fudge width (can't fudge elen) */
7e2040f0 9583 width += elen - sv_len_utf8(argsv);
a0ed51b3 9584 }
2cf2cfc6 9585 is_utf8 = TRUE;
a0ed51b3
LW
9586 }
9587 }
46fc3d4c 9588 goto string;
9589
fc36a67e 9590 case '_':
5df617be
RB
9591#ifdef CHECK_FORMAT
9592 format_sv:
9593#endif
fc36a67e 9594 /*
9595 * The "%_" hack might have to be changed someday,
9596 * if ISO or ANSI decide to use '_' for something.
9597 * So we keep it hidden from users' code.
9598 */
be75b157 9599 if (!args || vectorize)
fc36a67e 9600 goto unknown;
211dfcf1 9601 argsv = va_arg(*args, SV*);
7e2040f0
GS
9602 eptr = SvPVx(argsv, elen);
9603 if (DO_UTF8(argsv))
2cf2cfc6 9604 is_utf8 = TRUE;
fc36a67e 9605
46fc3d4c 9606 string:
b22c7a20 9607 vectorize = FALSE;
46fc3d4c 9608 if (has_precis && elen > precis)
9609 elen = precis;
9610 break;
9611
9612 /* INTEGERS */
9613
fc36a67e 9614 case 'p':
5df617be
RB
9615#ifdef CHECK_FORMAT
9616 if (left) {
9617 left = FALSE;
9618 if (width > 0) {
9619 width = 0;
9620 if (vectorize)
9621 goto format_d;
9622 precis = width;
9623 has_precis = TRUE;
9624 }
9625 goto format_sv;
9626 }
9627#endif
be75b157 9628 if (alt || vectorize)
c2e66d9e 9629 goto unknown;
211dfcf1 9630 uv = PTR2UV(args ? va_arg(*args, void*) : argsv);
fc36a67e 9631 base = 16;
9632 goto integer;
9633
46fc3d4c 9634 case 'D':
29fe7a80 9635#ifdef IV_IS_QUAD
22f3ae8c 9636 intsize = 'q';
29fe7a80 9637#else
46fc3d4c 9638 intsize = 'l';
29fe7a80 9639#endif
5df617be
RB
9640#ifdef CHECK_FORMAT
9641 format_d:
9642#endif
46fc3d4c 9643 /* FALL THROUGH */
9644 case 'd':
9645 case 'i':
b22c7a20 9646 if (vectorize) {
ba210ebe 9647 STRLEN ulen;
211dfcf1
HS
9648 if (!veclen)
9649 continue;
2cf2cfc6
A
9650 if (vec_utf8)
9651 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9652 UTF8_ALLOW_ANYUV);
b22c7a20 9653 else {
e83d50c9 9654 uv = *vecstr;
b22c7a20
GS
9655 ulen = 1;
9656 }
9657 vecstr += ulen;
9658 veclen -= ulen;
e83d50c9
JP
9659 if (plus)
9660 esignbuf[esignlen++] = plus;
b22c7a20
GS
9661 }
9662 else if (args) {
46fc3d4c 9663 switch (intsize) {
9664 case 'h': iv = (short)va_arg(*args, int); break;
46fc3d4c 9665 case 'l': iv = va_arg(*args, long); break;
fc36a67e 9666 case 'V': iv = va_arg(*args, IV); break;
b10c0dba 9667 default: iv = va_arg(*args, int); break;
cf2093f6
JH
9668#ifdef HAS_QUAD
9669 case 'q': iv = va_arg(*args, Quad_t); break;
9670#endif
46fc3d4c 9671 }
9672 }
9673 else {
b10c0dba 9674 IV tiv = SvIVx(argsv); /* work around GCC bug #13488 */
46fc3d4c 9675 switch (intsize) {
b10c0dba
MHM
9676 case 'h': iv = (short)tiv; break;
9677 case 'l': iv = (long)tiv; break;
9678 case 'V':
9679 default: iv = tiv; break;
cf2093f6 9680#ifdef HAS_QUAD
b10c0dba 9681 case 'q': iv = (Quad_t)tiv; break;
cf2093f6 9682#endif
46fc3d4c 9683 }
9684 }
e83d50c9
JP
9685 if ( !vectorize ) /* we already set uv above */
9686 {
9687 if (iv >= 0) {
9688 uv = iv;
9689 if (plus)
9690 esignbuf[esignlen++] = plus;
9691 }
9692 else {
9693 uv = -iv;
9694 esignbuf[esignlen++] = '-';
9695 }
46fc3d4c 9696 }
9697 base = 10;
9698 goto integer;
9699
fc36a67e 9700 case 'U':
29fe7a80 9701#ifdef IV_IS_QUAD
22f3ae8c 9702 intsize = 'q';
29fe7a80 9703#else
fc36a67e 9704 intsize = 'l';
29fe7a80 9705#endif
fc36a67e 9706 /* FALL THROUGH */
9707 case 'u':
9708 base = 10;
9709 goto uns_integer;
9710
4f19785b
WSI
9711 case 'b':
9712 base = 2;
9713 goto uns_integer;
9714
46fc3d4c 9715 case 'O':
29fe7a80 9716#ifdef IV_IS_QUAD
22f3ae8c 9717 intsize = 'q';
29fe7a80 9718#else
46fc3d4c 9719 intsize = 'l';
29fe7a80 9720#endif
46fc3d4c 9721 /* FALL THROUGH */
9722 case 'o':
9723 base = 8;
9724 goto uns_integer;
9725
9726 case 'X':
46fc3d4c 9727 case 'x':
9728 base = 16;
46fc3d4c 9729
9730 uns_integer:
b22c7a20 9731 if (vectorize) {
ba210ebe 9732 STRLEN ulen;
b22c7a20 9733 vector:
211dfcf1
HS
9734 if (!veclen)
9735 continue;
2cf2cfc6
A
9736 if (vec_utf8)
9737 uv = utf8n_to_uvchr(vecstr, veclen, &ulen,
9738 UTF8_ALLOW_ANYUV);
b22c7a20 9739 else {
a05b299f 9740 uv = *vecstr;
b22c7a20
GS
9741 ulen = 1;
9742 }
9743 vecstr += ulen;
9744 veclen -= ulen;
9745 }
9746 else if (args) {
46fc3d4c 9747 switch (intsize) {
9748 case 'h': uv = (unsigned short)va_arg(*args, unsigned); break;
46fc3d4c 9749 case 'l': uv = va_arg(*args, unsigned long); break;
fc36a67e 9750 case 'V': uv = va_arg(*args, UV); break;
b10c0dba 9751 default: uv = va_arg(*args, unsigned); break;
cf2093f6 9752#ifdef HAS_QUAD
9e3321a5 9753 case 'q': uv = va_arg(*args, Uquad_t); break;
cf2093f6 9754#endif
46fc3d4c 9755 }
9756 }
9757 else {
b10c0dba 9758 UV tuv = SvUVx(argsv); /* work around GCC bug #13488 */
46fc3d4c 9759 switch (intsize) {
b10c0dba
MHM
9760 case 'h': uv = (unsigned short)tuv; break;
9761 case 'l': uv = (unsigned long)tuv; break;
9762 case 'V':
9763 default: uv = tuv; break;
cf2093f6 9764#ifdef HAS_QUAD
b10c0dba 9765 case 'q': uv = (Uquad_t)tuv; break;
cf2093f6 9766#endif
46fc3d4c 9767 }
9768 }
9769
9770 integer:
46fc3d4c 9771 eptr = ebuf + sizeof ebuf;
fc36a67e 9772 switch (base) {
9773 unsigned dig;
9774 case 16:
c10ed8b9
HS
9775 if (!uv)
9776 alt = FALSE;
1d7c1841
GS
9777 p = (char*)((c == 'X')
9778 ? "0123456789ABCDEF" : "0123456789abcdef");
fc36a67e 9779 do {
9780 dig = uv & 15;
9781 *--eptr = p[dig];
9782 } while (uv >>= 4);
9783 if (alt) {
46fc3d4c 9784 esignbuf[esignlen++] = '0';
fc36a67e 9785 esignbuf[esignlen++] = c; /* 'x' or 'X' */
46fc3d4c 9786 }
fc36a67e 9787 break;
9788 case 8:
9789 do {
9790 dig = uv & 7;
9791 *--eptr = '0' + dig;
9792 } while (uv >>= 3);
9793 if (alt && *eptr != '0')
9794 *--eptr = '0';
9795 break;
4f19785b
WSI
9796 case 2:
9797 do {
9798 dig = uv & 1;
9799 *--eptr = '0' + dig;
9800 } while (uv >>= 1);
eda88b6d
JH
9801 if (alt) {
9802 esignbuf[esignlen++] = '0';
7481bb52 9803 esignbuf[esignlen++] = 'b';
eda88b6d 9804 }
4f19785b 9805 break;
fc36a67e 9806 default: /* it had better be ten or less */
6bc102ca 9807#if defined(PERL_Y2KWARN)
e476b1b5 9808 if (ckWARN(WARN_Y2K)) {
6bc102ca
GS
9809 STRLEN n;
9810 char *s = SvPV(sv,n);
9811 if (n >= 2 && s[n-2] == '1' && s[n-1] == '9'
9812 && (n == 2 || !isDIGIT(s[n-3])))
9813 {
9014280d 9814 Perl_warner(aTHX_ packWARN(WARN_Y2K),
6bc102ca
GS
9815 "Possible Y2K bug: %%%c %s",
9816 c, "format string following '19'");
9817 }
9818 }
9819#endif
fc36a67e 9820 do {
9821 dig = uv % base;
9822 *--eptr = '0' + dig;
9823 } while (uv /= base);
9824 break;
46fc3d4c 9825 }
9826 elen = (ebuf + sizeof ebuf) - eptr;
c10ed8b9
HS
9827 if (has_precis) {
9828 if (precis > elen)
9829 zeros = precis - elen;
9830 else if (precis == 0 && elen == 1 && *eptr == '0')
9831 elen = 0;
9832 }
46fc3d4c 9833 break;
9834
9835 /* FLOATING POINT */
9836
fc36a67e 9837 case 'F':
9838 c = 'f'; /* maybe %F isn't supported here */
9839 /* FALL THROUGH */
46fc3d4c 9840 case 'e': case 'E':
fc36a67e 9841 case 'f':
46fc3d4c 9842 case 'g': case 'G':
9843
9844 /* This is evil, but floating point is even more evil */
9845
9e5b023a
JH
9846 /* for SV-style calling, we can only get NV
9847 for C-style calling, we assume %f is double;
9848 for simplicity we allow any of %Lf, %llf, %qf for long double
9849 */
9850 switch (intsize) {
9851 case 'V':
9852#if defined(USE_LONG_DOUBLE)
9853 intsize = 'q';
9854#endif
9855 break;
8a2e3f14 9856/* [perl #20339] - we should accept and ignore %lf rather than die */
00e17364
HS
9857 case 'l':
9858 /* FALL THROUGH */
9e5b023a
JH
9859 default:
9860#if defined(USE_LONG_DOUBLE)
9861 intsize = args ? 0 : 'q';
9862#endif
9863 break;
9864 case 'q':
9865#if defined(HAS_LONG_DOUBLE)
9866 break;
9867#else
9868 /* FALL THROUGH */
9869#endif
9870 case 'h':
9e5b023a
JH
9871 goto unknown;
9872 }
9873
9874 /* now we need (long double) if intsize == 'q', else (double) */
be75b157 9875 nv = (args && !vectorize) ?
35fff930
JH
9876#if LONG_DOUBLESIZE > DOUBLESIZE
9877 intsize == 'q' ?
205f51d8
AS
9878 va_arg(*args, long double) :
9879 va_arg(*args, double)
35fff930 9880#else
205f51d8 9881 va_arg(*args, double)
35fff930 9882#endif
9e5b023a 9883 : SvNVx(argsv);
fc36a67e 9884
9885 need = 0;
be75b157 9886 vectorize = FALSE;
fc36a67e 9887 if (c != 'e' && c != 'E') {
9888 i = PERL_INT_MIN;
9e5b023a
JH
9889 /* FIXME: if HAS_LONG_DOUBLE but not USE_LONG_DOUBLE this
9890 will cast our (long double) to (double) */
73b309ea 9891 (void)Perl_frexp(nv, &i);
fc36a67e 9892 if (i == PERL_INT_MIN)
cea2e8a9 9893 Perl_die(aTHX_ "panic: frexp");
c635e13b 9894 if (i > 0)
fc36a67e 9895 need = BIT_DIGITS(i);
9896 }
9897 need += has_precis ? precis : 6; /* known default */
20f6aaab 9898
fc36a67e 9899 if (need < width)
9900 need = width;
9901
20f6aaab
AS
9902#ifdef HAS_LDBL_SPRINTF_BUG
9903 /* This is to try to fix a bug with irix/nonstop-ux/powerux and
205f51d8
AS
9904 with sfio - Allen <allens@cpan.org> */
9905
9906# ifdef DBL_MAX
9907# define MY_DBL_MAX DBL_MAX
9908# else /* XXX guessing! HUGE_VAL may be defined as infinity, so not using */
9909# if DOUBLESIZE >= 8
9910# define MY_DBL_MAX 1.7976931348623157E+308L
9911# else
9912# define MY_DBL_MAX 3.40282347E+38L
9913# endif
9914# endif
9915
9916# ifdef HAS_LDBL_SPRINTF_BUG_LESS1 /* only between -1L & 1L - Allen */
9917# define MY_DBL_MAX_BUG 1L
20f6aaab 9918# else
205f51d8 9919# define MY_DBL_MAX_BUG MY_DBL_MAX
20f6aaab 9920# endif
20f6aaab 9921
205f51d8
AS
9922# ifdef DBL_MIN
9923# define MY_DBL_MIN DBL_MIN
9924# else /* XXX guessing! -Allen */
9925# if DOUBLESIZE >= 8
9926# define MY_DBL_MIN 2.2250738585072014E-308L
9927# else
9928# define MY_DBL_MIN 1.17549435E-38L
9929# endif
9930# endif
20f6aaab 9931
205f51d8
AS
9932 if ((intsize == 'q') && (c == 'f') &&
9933 ((nv < MY_DBL_MAX_BUG) && (nv > -MY_DBL_MAX_BUG)) &&
9934 (need < DBL_DIG)) {
9935 /* it's going to be short enough that
9936 * long double precision is not needed */
9937
9938 if ((nv <= 0L) && (nv >= -0L))
9939 fix_ldbl_sprintf_bug = TRUE; /* 0 is 0 - easiest */
9940 else {
9941 /* would use Perl_fp_class as a double-check but not
9942 * functional on IRIX - see perl.h comments */
9943
9944 if ((nv >= MY_DBL_MIN) || (nv <= -MY_DBL_MIN)) {
9945 /* It's within the range that a double can represent */
9946#if defined(DBL_MAX) && !defined(DBL_MIN)
9947 if ((nv >= ((long double)1/DBL_MAX)) ||
9948 (nv <= (-(long double)1/DBL_MAX)))
20f6aaab 9949#endif
205f51d8 9950 fix_ldbl_sprintf_bug = TRUE;
20f6aaab 9951 }
205f51d8
AS
9952 }
9953 if (fix_ldbl_sprintf_bug == TRUE) {
9954 double temp;
9955
9956 intsize = 0;
9957 temp = (double)nv;
9958 nv = (NV)temp;
9959 }
20f6aaab 9960 }
205f51d8
AS
9961
9962# undef MY_DBL_MAX
9963# undef MY_DBL_MAX_BUG
9964# undef MY_DBL_MIN
9965
20f6aaab
AS
9966#endif /* HAS_LDBL_SPRINTF_BUG */
9967
46fc3d4c 9968 need += 20; /* fudge factor */
80252599
GS
9969 if (PL_efloatsize < need) {
9970 Safefree(PL_efloatbuf);
9971 PL_efloatsize = need + 20; /* more fudge */
9972 New(906, PL_efloatbuf, PL_efloatsize, char);
7d5ea4e7 9973 PL_efloatbuf[0] = '\0';
46fc3d4c 9974 }
9975
4151a5fe
IZ
9976 if ( !(width || left || plus || alt) && fill != '0'
9977 && has_precis && intsize != 'q' ) { /* Shortcuts */
2873255c
NC
9978 /* See earlier comment about buggy Gconvert when digits,
9979 aka precis is 0 */
9980 if ( c == 'g' && precis) {
2e59c212 9981 Gconvert((NV)nv, (int)precis, 0, PL_efloatbuf);
4151a5fe
IZ
9982 if (*PL_efloatbuf) /* May return an empty string for digits==0 */
9983 goto float_converted;
9984 } else if ( c == 'f' && !precis) {
9985 if ((eptr = F0convert(nv, ebuf + sizeof ebuf, &elen)))
9986 break;
9987 }
9988 }
46fc3d4c 9989 eptr = ebuf + sizeof ebuf;
9990 *--eptr = '\0';
9991 *--eptr = c;
9e5b023a
JH
9992 /* FIXME: what to do if HAS_LONG_DOUBLE but not PERL_PRIfldbl? */
9993#if defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
9994 if (intsize == 'q') {
e5c81feb
JH
9995 /* Copy the one or more characters in a long double
9996 * format before the 'base' ([efgEFG]) character to
9997 * the format string. */
9998 static char const prifldbl[] = PERL_PRIfldbl;
9999 char const *p = prifldbl + sizeof(prifldbl) - 3;
10000 while (p >= prifldbl) { *--eptr = *p--; }
cf2093f6 10001 }
65202027 10002#endif
46fc3d4c 10003 if (has_precis) {
10004 base = precis;
10005 do { *--eptr = '0' + (base % 10); } while (base /= 10);
10006 *--eptr = '.';
10007 }
10008 if (width) {
10009 base = width;
10010 do { *--eptr = '0' + (base % 10); } while (base /= 10);
10011 }
10012 if (fill == '0')
10013 *--eptr = fill;
84902520
TB
10014 if (left)
10015 *--eptr = '-';
46fc3d4c 10016 if (plus)
10017 *--eptr = plus;
10018 if (alt)
10019 *--eptr = '#';
10020 *--eptr = '%';
10021
ff9121f8
JH
10022 /* No taint. Otherwise we are in the strange situation
10023 * where printf() taints but print($float) doesn't.
bda0f7a5 10024 * --jhi */
9e5b023a
JH
10025#if defined(HAS_LONG_DOUBLE)
10026 if (intsize == 'q')
10027 (void)sprintf(PL_efloatbuf, eptr, nv);
10028 else
10029 (void)sprintf(PL_efloatbuf, eptr, (double)nv);
10030#else
dd8482fc 10031 (void)sprintf(PL_efloatbuf, eptr, nv);
9e5b023a 10032#endif
4151a5fe 10033 float_converted:
80252599
GS
10034 eptr = PL_efloatbuf;
10035 elen = strlen(PL_efloatbuf);
46fc3d4c 10036 break;
10037
fc36a67e 10038 /* SPECIAL */
10039
10040 case 'n':
10041 i = SvCUR(sv) - origlen;
be75b157 10042 if (args && !vectorize) {
c635e13b 10043 switch (intsize) {
10044 case 'h': *(va_arg(*args, short*)) = i; break;
10045 default: *(va_arg(*args, int*)) = i; break;
10046 case 'l': *(va_arg(*args, long*)) = i; break;
10047 case 'V': *(va_arg(*args, IV*)) = i; break;
cf2093f6
JH
10048#ifdef HAS_QUAD
10049 case 'q': *(va_arg(*args, Quad_t*)) = i; break;
10050#endif
c635e13b 10051 }
fc36a67e 10052 }
9dd79c3f 10053 else
211dfcf1 10054 sv_setuv_mg(argsv, (UV)i);
be75b157 10055 vectorize = FALSE;
fc36a67e 10056 continue; /* not "break" */
10057
10058 /* UNKNOWN */
10059
46fc3d4c 10060 default:
fc36a67e 10061 unknown:
599cee73 10062 if (!args && ckWARN(WARN_PRINTF) &&
533c011a 10063 (PL_op->op_type == OP_PRTF || PL_op->op_type == OP_SPRINTF)) {
c635e13b 10064 SV *msg = sv_newmortal();
35c1215d
NC
10065 Perl_sv_setpvf(aTHX_ msg, "Invalid conversion in %sprintf: ",
10066 (PL_op->op_type == OP_PRTF) ? "" : "s");
0f4b6630 10067 if (c) {
0f4b6630 10068 if (isPRINT(c))
1c846c1f 10069 Perl_sv_catpvf(aTHX_ msg,
0f4b6630
JH
10070 "\"%%%c\"", c & 0xFF);
10071 else
10072 Perl_sv_catpvf(aTHX_ msg,
57def98f 10073 "\"%%\\%03"UVof"\"",
0f4b6630 10074 (UV)c & 0xFF);
0f4b6630 10075 } else
c635e13b 10076 sv_catpv(msg, "end of string");
9014280d 10077 Perl_warner(aTHX_ packWARN(WARN_PRINTF), "%"SVf, msg); /* yes, this is reentrant */
c635e13b 10078 }
fb73857a 10079
10080 /* output mangled stuff ... */
10081 if (c == '\0')
10082 --q;
46fc3d4c 10083 eptr = p;
10084 elen = q - p;
fb73857a 10085
10086 /* ... right here, because formatting flags should not apply */
10087 SvGROW(sv, SvCUR(sv) + elen + 1);
10088 p = SvEND(sv);
4459522c 10089 Copy(eptr, p, elen, char);
fb73857a 10090 p += elen;
10091 *p = '\0';
10092 SvCUR(sv) = p - SvPVX(sv);
58e33a90 10093 svix = osvix;
fb73857a 10094 continue; /* not "break" */
46fc3d4c 10095 }
10096
6c94ec8b
HS
10097 /* calculate width before utf8_upgrade changes it */
10098 have = esignlen + zeros + elen;
10099
d2876be5
JH
10100 if (is_utf8 != has_utf8) {
10101 if (is_utf8) {
10102 if (SvCUR(sv))
10103 sv_utf8_upgrade(sv);
10104 }
10105 else {
10106 SV *nsv = sv_2mortal(newSVpvn(eptr, elen));
10107 sv_utf8_upgrade(nsv);
10108 eptr = SvPVX(nsv);
10109 elen = SvCUR(nsv);
10110 }
10111 SvGROW(sv, SvCUR(sv) + elen + 1);
10112 p = SvEND(sv);
10113 *p = '\0';
10114 }
6af65485 10115
46fc3d4c 10116 need = (have > width ? have : width);
10117 gap = need - have;
10118
b22c7a20 10119 SvGROW(sv, SvCUR(sv) + need + dotstrlen + 1);
46fc3d4c 10120 p = SvEND(sv);
10121 if (esignlen && fill == '0') {
eb160463 10122 for (i = 0; i < (int)esignlen; i++)
46fc3d4c 10123 *p++ = esignbuf[i];
10124 }
10125 if (gap && !left) {
10126 memset(p, fill, gap);
10127 p += gap;
10128 }
10129 if (esignlen && fill != '0') {
eb160463 10130 for (i = 0; i < (int)esignlen; i++)
46fc3d4c 10131 *p++ = esignbuf[i];
10132 }
fc36a67e 10133 if (zeros) {
10134 for (i = zeros; i; i--)
10135 *p++ = '0';
10136 }
46fc3d4c 10137 if (elen) {
4459522c 10138 Copy(eptr, p, elen, char);
46fc3d4c 10139 p += elen;
10140 }
10141 if (gap && left) {
10142 memset(p, ' ', gap);
10143 p += gap;
10144 }
b22c7a20
GS
10145 if (vectorize) {
10146 if (veclen) {
4459522c 10147 Copy(dotstr, p, dotstrlen, char);
b22c7a20
GS
10148 p += dotstrlen;
10149 }
10150 else
10151 vectorize = FALSE; /* done iterating over vecstr */
10152 }
2cf2cfc6
A
10153 if (is_utf8)
10154 has_utf8 = TRUE;
10155 if (has_utf8)
7e2040f0 10156 SvUTF8_on(sv);
46fc3d4c 10157 *p = '\0';
10158 SvCUR(sv) = p - SvPVX(sv);
b22c7a20
GS
10159 if (vectorize) {
10160 esignlen = 0;
10161 goto vector;
10162 }
46fc3d4c 10163 }
10164}
51371543 10165
645c22ef
DM
10166/* =========================================================================
10167
10168=head1 Cloning an interpreter
10169
10170All the macros and functions in this section are for the private use of
10171the main function, perl_clone().
10172
10173The foo_dup() functions make an exact copy of an existing foo thinngy.
10174During the course of a cloning, a hash table is used to map old addresses
10175to new addresses. The table is created and manipulated with the
10176ptr_table_* functions.
10177
10178=cut
10179
10180============================================================================*/
10181
10182
1d7c1841
GS
10183#if defined(USE_ITHREADS)
10184
1d7c1841
GS
10185#ifndef GpREFCNT_inc
10186# define GpREFCNT_inc(gp) ((gp) ? (++(gp)->gp_refcnt, (gp)) : (GP*)NULL)
10187#endif
10188
10189
d2d73c3e
AB
10190#define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
10191#define av_dup(s,t) (AV*)sv_dup((SV*)s,t)
10192#define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10193#define hv_dup(s,t) (HV*)sv_dup((SV*)s,t)
10194#define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10195#define cv_dup(s,t) (CV*)sv_dup((SV*)s,t)
10196#define cv_dup_inc(s,t) (CV*)SvREFCNT_inc(sv_dup((SV*)s,t))
10197#define io_dup(s,t) (IO*)sv_dup((SV*)s,t)
10198#define io_dup_inc(s,t) (IO*)SvREFCNT_inc(sv_dup((SV*)s,t))
10199#define gv_dup(s,t) (GV*)sv_dup((SV*)s,t)
10200#define gv_dup_inc(s,t) (GV*)SvREFCNT_inc(sv_dup((SV*)s,t))
1d7c1841
GS
10201#define SAVEPV(p) (p ? savepv(p) : Nullch)
10202#define SAVEPVN(p,n) (p ? savepvn(p,n) : Nullch)
8cf8f3d1 10203
d2d73c3e 10204
d2f185dc
AMS
10205/* Duplicate a regexp. Required reading: pregcomp() and pregfree() in
10206 regcomp.c. AMS 20010712 */
645c22ef 10207
1d7c1841 10208REGEXP *
a8fc9800 10209Perl_re_dup(pTHX_ REGEXP *r, CLONE_PARAMS *param)
1d7c1841 10210{
d2f185dc
AMS
10211 REGEXP *ret;
10212 int i, len, npar;
10213 struct reg_substr_datum *s;
10214
10215 if (!r)
10216 return (REGEXP *)NULL;
10217
10218 if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
10219 return ret;
10220
10221 len = r->offsets[0];
10222 npar = r->nparens+1;
10223
10224 Newc(0, ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
10225 Copy(r->program, ret->program, len+1, regnode);
10226
10227 New(0, ret->startp, npar, I32);
10228 Copy(r->startp, ret->startp, npar, I32);
10229 New(0, ret->endp, npar, I32);
10230 Copy(r->startp, ret->startp, npar, I32);
10231
d2f185dc
AMS
10232 New(0, ret->substrs, 1, struct reg_substr_data);
10233 for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
10234 s->min_offset = r->substrs->data[i].min_offset;
10235 s->max_offset = r->substrs->data[i].max_offset;
10236 s->substr = sv_dup_inc(r->substrs->data[i].substr, param);
33b8afdf 10237 s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
d2f185dc
AMS
10238 }
10239
70612e96 10240 ret->regstclass = NULL;
d2f185dc
AMS
10241 if (r->data) {
10242 struct reg_data *d;
10243 int count = r->data->count;
10244
10245 Newc(0, d, sizeof(struct reg_data) + count*sizeof(void *),
10246 char, struct reg_data);
10247 New(0, d->what, count, U8);
10248
10249 d->count = count;
10250 for (i = 0; i < count; i++) {
10251 d->what[i] = r->data->what[i];
10252 switch (d->what[i]) {
10253 case 's':
10254 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
10255 break;
10256 case 'p':
10257 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
10258 break;
10259 case 'f':
10260 /* This is cheating. */
10261 New(0, d->data[i], 1, struct regnode_charclass_class);
10262 StructCopy(r->data->data[i], d->data[i],
10263 struct regnode_charclass_class);
70612e96 10264 ret->regstclass = (regnode*)d->data[i];
d2f185dc
AMS
10265 break;
10266 case 'o':
33773810
AMS
10267 /* Compiled op trees are readonly, and can thus be
10268 shared without duplication. */
b34c0dd4 10269 OP_REFCNT_LOCK;
9b978d73 10270 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
b34c0dd4 10271 OP_REFCNT_UNLOCK;
9b978d73 10272 break;
d2f185dc
AMS
10273 case 'n':
10274 d->data[i] = r->data->data[i];
10275 break;
10276 }
10277 }
10278
10279 ret->data = d;
10280 }
10281 else
10282 ret->data = NULL;
10283
10284 New(0, ret->offsets, 2*len+1, U32);
10285 Copy(r->offsets, ret->offsets, 2*len+1, U32);
10286
e01c5899 10287 ret->precomp = SAVEPVN(r->precomp, r->prelen);
d2f185dc
AMS
10288 ret->refcnt = r->refcnt;
10289 ret->minlen = r->minlen;
10290 ret->prelen = r->prelen;
10291 ret->nparens = r->nparens;
10292 ret->lastparen = r->lastparen;
10293 ret->lastcloseparen = r->lastcloseparen;
10294 ret->reganch = r->reganch;
10295
70612e96
RG
10296 ret->sublen = r->sublen;
10297
10298 if (RX_MATCH_COPIED(ret))
e01c5899 10299 ret->subbeg = SAVEPVN(r->subbeg, r->sublen);
70612e96
RG
10300 else
10301 ret->subbeg = Nullch;
9a26048b
NC
10302#ifdef PERL_COPY_ON_WRITE
10303 ret->saved_copy = Nullsv;
10304#endif
70612e96 10305
d2f185dc
AMS
10306 ptr_table_store(PL_ptr_table, r, ret);
10307 return ret;
1d7c1841
GS
10308}
10309
d2d73c3e 10310/* duplicate a file handle */
645c22ef 10311
1d7c1841 10312PerlIO *
a8fc9800 10313Perl_fp_dup(pTHX_ PerlIO *fp, char type, CLONE_PARAMS *param)
1d7c1841
GS
10314{
10315 PerlIO *ret;
10316 if (!fp)
10317 return (PerlIO*)NULL;
10318
10319 /* look for it in the table first */
10320 ret = (PerlIO*)ptr_table_fetch(PL_ptr_table, fp);
10321 if (ret)
10322 return ret;
10323
10324 /* create anew and remember what it is */
ecdeb87c 10325 ret = PerlIO_fdupopen(aTHX_ fp, param, PERLIO_DUP_CLONE);
1d7c1841
GS
10326 ptr_table_store(PL_ptr_table, fp, ret);
10327 return ret;
10328}
10329
645c22ef
DM
10330/* duplicate a directory handle */
10331
1d7c1841
GS
10332DIR *
10333Perl_dirp_dup(pTHX_ DIR *dp)
10334{
10335 if (!dp)
10336 return (DIR*)NULL;
10337 /* XXX TODO */
10338 return dp;
10339}
10340
ff276b08 10341/* duplicate a typeglob */
645c22ef 10342
1d7c1841 10343GP *
a8fc9800 10344Perl_gp_dup(pTHX_ GP *gp, CLONE_PARAMS* param)
1d7c1841
GS
10345{
10346 GP *ret;
10347 if (!gp)
10348 return (GP*)NULL;
10349 /* look for it in the table first */
10350 ret = (GP*)ptr_table_fetch(PL_ptr_table, gp);
10351 if (ret)
10352 return ret;
10353
10354 /* create anew and remember what it is */
10355 Newz(0, ret, 1, GP);
10356 ptr_table_store(PL_ptr_table, gp, ret);
10357
10358 /* clone */
10359 ret->gp_refcnt = 0; /* must be before any other dups! */
d2d73c3e
AB
10360 ret->gp_sv = sv_dup_inc(gp->gp_sv, param);
10361 ret->gp_io = io_dup_inc(gp->gp_io, param);
10362 ret->gp_form = cv_dup_inc(gp->gp_form, param);
10363 ret->gp_av = av_dup_inc(gp->gp_av, param);
10364 ret->gp_hv = hv_dup_inc(gp->gp_hv, param);
10365 ret->gp_egv = gv_dup(gp->gp_egv, param);/* GvEGV is not refcounted */
10366 ret->gp_cv = cv_dup_inc(gp->gp_cv, param);
1d7c1841
GS
10367 ret->gp_cvgen = gp->gp_cvgen;
10368 ret->gp_flags = gp->gp_flags;
10369 ret->gp_line = gp->gp_line;
10370 ret->gp_file = gp->gp_file; /* points to COP.cop_file */
10371 return ret;
10372}
10373
645c22ef
DM
10374/* duplicate a chain of magic */
10375
1d7c1841 10376MAGIC *
a8fc9800 10377Perl_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS* param)
1d7c1841 10378{
cb359b41
JH
10379 MAGIC *mgprev = (MAGIC*)NULL;
10380 MAGIC *mgret;
1d7c1841
GS
10381 if (!mg)
10382 return (MAGIC*)NULL;
10383 /* look for it in the table first */
10384 mgret = (MAGIC*)ptr_table_fetch(PL_ptr_table, mg);
10385 if (mgret)
10386 return mgret;
10387
10388 for (; mg; mg = mg->mg_moremagic) {
10389 MAGIC *nmg;
10390 Newz(0, nmg, 1, MAGIC);
cb359b41 10391 if (mgprev)
1d7c1841 10392 mgprev->mg_moremagic = nmg;
cb359b41
JH
10393 else
10394 mgret = nmg;
1d7c1841
GS
10395 nmg->mg_virtual = mg->mg_virtual; /* XXX copy dynamic vtable? */
10396 nmg->mg_private = mg->mg_private;
10397 nmg->mg_type = mg->mg_type;
10398 nmg->mg_flags = mg->mg_flags;
14befaf4 10399 if (mg->mg_type == PERL_MAGIC_qr) {
d2f185dc 10400 nmg->mg_obj = (SV*)re_dup((REGEXP*)mg->mg_obj, param);
1d7c1841 10401 }
05bd4103 10402 else if(mg->mg_type == PERL_MAGIC_backref) {
fdc9a813
AE
10403 AV *av = (AV*) mg->mg_obj;
10404 SV **svp;
10405 I32 i;
10406 SvREFCNT_inc(nmg->mg_obj = (SV*)newAV());
10407 svp = AvARRAY(av);
10408 for (i = AvFILLp(av); i >= 0; i--) {
3a81978b 10409 if (!svp[i]) continue;
fdc9a813
AE
10410 av_push((AV*)nmg->mg_obj,sv_dup(svp[i],param));
10411 }
05bd4103 10412 }
1d7c1841
GS
10413 else {
10414 nmg->mg_obj = (mg->mg_flags & MGf_REFCOUNTED)
d2d73c3e
AB
10415 ? sv_dup_inc(mg->mg_obj, param)
10416 : sv_dup(mg->mg_obj, param);
1d7c1841
GS
10417 }
10418 nmg->mg_len = mg->mg_len;
10419 nmg->mg_ptr = mg->mg_ptr; /* XXX random ptr? */
14befaf4 10420 if (mg->mg_ptr && mg->mg_type != PERL_MAGIC_regex_global) {
68795e93 10421 if (mg->mg_len > 0) {
1d7c1841 10422 nmg->mg_ptr = SAVEPVN(mg->mg_ptr, mg->mg_len);
14befaf4
DM
10423 if (mg->mg_type == PERL_MAGIC_overload_table &&
10424 AMT_AMAGIC((AMT*)mg->mg_ptr))
10425 {
1d7c1841
GS
10426 AMT *amtp = (AMT*)mg->mg_ptr;
10427 AMT *namtp = (AMT*)nmg->mg_ptr;
10428 I32 i;
10429 for (i = 1; i < NofAMmeth; i++) {
d2d73c3e 10430 namtp->table[i] = cv_dup_inc(amtp->table[i], param);
1d7c1841
GS
10431 }
10432 }
10433 }
10434 else if (mg->mg_len == HEf_SVKEY)
d2d73c3e 10435 nmg->mg_ptr = (char*)sv_dup_inc((SV*)mg->mg_ptr, param);
1d7c1841 10436 }
68795e93
NIS
10437 if ((mg->mg_flags & MGf_DUP) && mg->mg_virtual && mg->mg_virtual->svt_dup) {
10438 CALL_FPTR(nmg->mg_virtual->svt_dup)(aTHX_ nmg, param);
10439 }
1d7c1841
GS
10440 mgprev = nmg;
10441 }
10442 return mgret;
10443}
10444
645c22ef
DM
10445/* create a new pointer-mapping table */
10446
1d7c1841
GS
10447PTR_TBL_t *
10448Perl_ptr_table_new(pTHX)
10449{
10450 PTR_TBL_t *tbl;
10451 Newz(0, tbl, 1, PTR_TBL_t);
10452 tbl->tbl_max = 511;
10453 tbl->tbl_items = 0;
10454 Newz(0, tbl->tbl_ary, tbl->tbl_max + 1, PTR_TBL_ENT_t*);
10455 return tbl;
10456}
10457
134ca3d6
DM
10458#if (PTRSIZE == 8)
10459# define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 3)
10460#else
10461# define PTR_TABLE_HASH(ptr) (PTR2UV(ptr) >> 2)
10462#endif
10463
645c22ef
DM
10464/* map an existing pointer using a table */
10465
1d7c1841
GS
10466void *
10467Perl_ptr_table_fetch(pTHX_ PTR_TBL_t *tbl, void *sv)
10468{
10469 PTR_TBL_ENT_t *tblent;
134ca3d6 10470 UV hash = PTR_TABLE_HASH(sv);
1d7c1841
GS
10471 assert(tbl);
10472 tblent = tbl->tbl_ary[hash & tbl->tbl_max];
10473 for (; tblent; tblent = tblent->next) {
10474 if (tblent->oldval == sv)
10475 return tblent->newval;
10476 }
10477 return (void*)NULL;
10478}
10479
645c22ef
DM
10480/* add a new entry to a pointer-mapping table */
10481
1d7c1841
GS
10482void
10483Perl_ptr_table_store(pTHX_ PTR_TBL_t *tbl, void *oldv, void *newv)
10484{
10485 PTR_TBL_ENT_t *tblent, **otblent;
10486 /* XXX this may be pessimal on platforms where pointers aren't good
10487 * hash values e.g. if they grow faster in the most significant
10488 * bits */
134ca3d6 10489 UV hash = PTR_TABLE_HASH(oldv);
14cade97 10490 bool empty = 1;
1d7c1841
GS
10491
10492 assert(tbl);
10493 otblent = &tbl->tbl_ary[hash & tbl->tbl_max];
14cade97 10494 for (tblent = *otblent; tblent; empty=0, tblent = tblent->next) {
1d7c1841
GS
10495 if (tblent->oldval == oldv) {
10496 tblent->newval = newv;
1d7c1841
GS
10497 return;
10498 }
10499 }
10500 Newz(0, tblent, 1, PTR_TBL_ENT_t);
10501 tblent->oldval = oldv;
10502 tblent->newval = newv;
10503 tblent->next = *otblent;
10504 *otblent = tblent;
10505 tbl->tbl_items++;
14cade97 10506 if (!empty && tbl->tbl_items > tbl->tbl_max)
1d7c1841
GS
10507 ptr_table_split(tbl);
10508}
10509
645c22ef
DM
10510/* double the hash bucket size of an existing ptr table */
10511
1d7c1841
GS
10512void
10513Perl_ptr_table_split(pTHX_ PTR_TBL_t *tbl)
10514{
10515 PTR_TBL_ENT_t **ary = tbl->tbl_ary;
10516 UV oldsize = tbl->tbl_max + 1;
10517 UV newsize = oldsize * 2;
10518 UV i;
10519
10520 Renew(ary, newsize, PTR_TBL_ENT_t*);
10521 Zero(&ary[oldsize], newsize-oldsize, PTR_TBL_ENT_t*);
10522 tbl->tbl_max = --newsize;
10523 tbl->tbl_ary = ary;
10524 for (i=0; i < oldsize; i++, ary++) {
10525 PTR_TBL_ENT_t **curentp, **entp, *ent;
10526 if (!*ary)
10527 continue;
10528 curentp = ary + oldsize;
10529 for (entp = ary, ent = *ary; ent; ent = *entp) {
134ca3d6 10530 if ((newsize & PTR_TABLE_HASH(ent->oldval)) != i) {
1d7c1841
GS
10531 *entp = ent->next;
10532 ent->next = *curentp;
10533 *curentp = ent;
10534 continue;
10535 }
10536 else
10537 entp = &ent->next;
10538 }
10539 }
10540}
10541
645c22ef
DM
10542/* remove all the entries from a ptr table */
10543
a0739874
DM
10544void
10545Perl_ptr_table_clear(pTHX_ PTR_TBL_t *tbl)
10546{
10547 register PTR_TBL_ENT_t **array;
10548 register PTR_TBL_ENT_t *entry;
10549 register PTR_TBL_ENT_t *oentry = Null(PTR_TBL_ENT_t*);
10550 UV riter = 0;
10551 UV max;
10552
10553 if (!tbl || !tbl->tbl_items) {
10554 return;
10555 }
10556
10557 array = tbl->tbl_ary;
10558 entry = array[0];
10559 max = tbl->tbl_max;
10560
10561 for (;;) {
10562 if (entry) {
10563 oentry = entry;
10564 entry = entry->next;
10565 Safefree(oentry);
10566 }
10567 if (!entry) {
10568 if (++riter > max) {
10569 break;
10570 }
10571 entry = array[riter];
10572 }
10573 }
10574
10575 tbl->tbl_items = 0;
10576}
10577
645c22ef
DM
10578/* clear and free a ptr table */
10579
a0739874
DM
10580void
10581Perl_ptr_table_free(pTHX_ PTR_TBL_t *tbl)
10582{
10583 if (!tbl) {
10584 return;
10585 }
10586 ptr_table_clear(tbl);
10587 Safefree(tbl->tbl_ary);
10588 Safefree(tbl);
10589}
10590
1d7c1841
GS
10591#ifdef DEBUGGING
10592char *PL_watch_pvx;
10593#endif
10594
645c22ef
DM
10595/* attempt to make everything in the typeglob readonly */
10596
5bd07a3d 10597STATIC SV *
59b40662 10598S_gv_share(pTHX_ SV *sstr, CLONE_PARAMS *param)
5bd07a3d
DM
10599{
10600 GV *gv = (GV*)sstr;
59b40662 10601 SV *sv = &param->proto_perl->Isv_no; /* just need SvREADONLY-ness */
5bd07a3d
DM
10602
10603 if (GvIO(gv) || GvFORM(gv)) {
7fb37951 10604 GvUNIQUE_off(gv); /* GvIOs cannot be shared. nor can GvFORMs */
5bd07a3d
DM
10605 }
10606 else if (!GvCV(gv)) {
10607 GvCV(gv) = (CV*)sv;
10608 }
10609 else {
10610 /* CvPADLISTs cannot be shared */
37e20706 10611 if (!SvREADONLY(GvCV(gv)) && !CvXSUB(GvCV(gv))) {
7fb37951 10612 GvUNIQUE_off(gv);
5bd07a3d
DM
10613 }
10614 }
10615
7fb37951 10616 if (!GvUNIQUE(gv)) {
5bd07a3d
DM
10617#if 0
10618 PerlIO_printf(Perl_debug_log, "gv_share: unable to share %s::%s\n",
10619 HvNAME(GvSTASH(gv)), GvNAME(gv));
10620#endif
10621 return Nullsv;
10622 }
10623
4411f3b6 10624 /*
5bd07a3d
DM
10625 * write attempts will die with
10626 * "Modification of a read-only value attempted"
10627 */
10628 if (!GvSV(gv)) {
10629 GvSV(gv) = sv;
10630 }
10631 else {
10632 SvREADONLY_on(GvSV(gv));
10633 }
10634
10635 if (!GvAV(gv)) {
10636 GvAV(gv) = (AV*)sv;
10637 }
10638 else {
10639 SvREADONLY_on(GvAV(gv));
10640 }
10641
10642 if (!GvHV(gv)) {
10643 GvHV(gv) = (HV*)sv;
10644 }
10645 else {
53c33732 10646 SvREADONLY_on(GvHV(gv));
5bd07a3d
DM
10647 }
10648
10649 return sstr; /* he_dup() will SvREFCNT_inc() */
10650}
10651
645c22ef
DM
10652/* duplicate an SV of any type (including AV, HV etc) */
10653
83841fad
NIS
10654void
10655Perl_rvpv_dup(pTHX_ SV *dstr, SV *sstr, CLONE_PARAMS* param)
10656{
10657 if (SvROK(sstr)) {
d3d0e6f1 10658 SvRV(dstr) = SvWEAKREF(sstr)
83841fad
NIS
10659 ? sv_dup(SvRV(sstr), param)
10660 : sv_dup_inc(SvRV(sstr), param);
10661 }
10662 else if (SvPVX(sstr)) {
10663 /* Has something there */
10664 if (SvLEN(sstr)) {
68795e93 10665 /* Normal PV - clone whole allocated space */
83841fad 10666 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvLEN(sstr)-1);
d3d0e6f1
NC
10667 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10668 /* Not that normal - actually sstr is copy on write.
10669 But we are a true, independant SV, so: */
10670 SvREADONLY_off(dstr);
10671 SvFAKE_off(dstr);
10672 }
68795e93 10673 }
83841fad
NIS
10674 else {
10675 /* Special case - not normally malloced for some reason */
10676 if (SvREADONLY(sstr) && SvFAKE(sstr)) {
10677 /* A "shared" PV - clone it as unshared string */
281b2760 10678 if(SvPADTMP(sstr)) {
5e6160dc
AB
10679 /* However, some of them live in the pad
10680 and they should not have these flags
10681 turned off */
281b2760
AB
10682
10683 SvPVX(dstr) = sharepvn(SvPVX(sstr), SvCUR(sstr),
10684 SvUVX(sstr));
10685 SvUVX(dstr) = SvUVX(sstr);
10686 } else {
10687
10688 SvPVX(dstr) = SAVEPVN(SvPVX(sstr), SvCUR(sstr));
10689 SvFAKE_off(dstr);
10690 SvREADONLY_off(dstr);
5e6160dc 10691 }
83841fad
NIS
10692 }
10693 else {
10694 /* Some other special case - random pointer */
10695 SvPVX(dstr) = SvPVX(sstr);
d3d0e6f1 10696 }
83841fad
NIS
10697 }
10698 }
10699 else {
10700 /* Copy the Null */
10701 SvPVX(dstr) = SvPVX(sstr);
10702 }
10703}
10704
1d7c1841 10705SV *
a8fc9800 10706Perl_sv_dup(pTHX_ SV *sstr, CLONE_PARAMS* param)
1d7c1841 10707{
1d7c1841
GS
10708 SV *dstr;
10709
10710 if (!sstr || SvTYPE(sstr) == SVTYPEMASK)
10711 return Nullsv;
10712 /* look for it in the table first */
10713 dstr = (SV*)ptr_table_fetch(PL_ptr_table, sstr);
10714 if (dstr)
10715 return dstr;
10716
0405e91e
AB
10717 if(param->flags & CLONEf_JOIN_IN) {
10718 /** We are joining here so we don't want do clone
10719 something that is bad **/
10720
10721 if(SvTYPE(sstr) == SVt_PVHV &&
10722 HvNAME(sstr)) {
10723 /** don't clone stashes if they already exist **/
10724 HV* old_stash = gv_stashpv(HvNAME(sstr),0);
10725 return (SV*) old_stash;
10726 }
10727 }
10728
1d7c1841
GS
10729 /* create anew and remember what it is */
10730 new_SV(dstr);
10731 ptr_table_store(PL_ptr_table, sstr, dstr);
10732
10733 /* clone */
10734 SvFLAGS(dstr) = SvFLAGS(sstr);
10735 SvFLAGS(dstr) &= ~SVf_OOK; /* don't propagate OOK hack */
10736 SvREFCNT(dstr) = 0; /* must be before any other dups! */
10737
10738#ifdef DEBUGGING
10739 if (SvANY(sstr) && PL_watch_pvx && SvPVX(sstr) == PL_watch_pvx)
10740 PerlIO_printf(Perl_debug_log, "watch at %p hit, found string \"%s\"\n",
10741 PL_watch_pvx, SvPVX(sstr));
10742#endif
10743
10744 switch (SvTYPE(sstr)) {
10745 case SVt_NULL:
10746 SvANY(dstr) = NULL;
10747 break;
10748 case SVt_IV:
10749 SvANY(dstr) = new_XIV();
10750 SvIVX(dstr) = SvIVX(sstr);
10751 break;
10752 case SVt_NV:
10753 SvANY(dstr) = new_XNV();
10754 SvNVX(dstr) = SvNVX(sstr);
10755 break;
10756 case SVt_RV:
10757 SvANY(dstr) = new_XRV();
83841fad 10758 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
10759 break;
10760 case SVt_PV:
10761 SvANY(dstr) = new_XPV();
10762 SvCUR(dstr) = SvCUR(sstr);
10763 SvLEN(dstr) = SvLEN(sstr);
83841fad 10764 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
10765 break;
10766 case SVt_PVIV:
10767 SvANY(dstr) = new_XPVIV();
10768 SvCUR(dstr) = SvCUR(sstr);
10769 SvLEN(dstr) = SvLEN(sstr);
10770 SvIVX(dstr) = SvIVX(sstr);
83841fad 10771 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
10772 break;
10773 case SVt_PVNV:
10774 SvANY(dstr) = new_XPVNV();
10775 SvCUR(dstr) = SvCUR(sstr);
10776 SvLEN(dstr) = SvLEN(sstr);
10777 SvIVX(dstr) = SvIVX(sstr);
10778 SvNVX(dstr) = SvNVX(sstr);
83841fad 10779 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
10780 break;
10781 case SVt_PVMG:
10782 SvANY(dstr) = new_XPVMG();
10783 SvCUR(dstr) = SvCUR(sstr);
10784 SvLEN(dstr) = SvLEN(sstr);
10785 SvIVX(dstr) = SvIVX(sstr);
10786 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
10787 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10788 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
83841fad 10789 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
10790 break;
10791 case SVt_PVBM:
10792 SvANY(dstr) = new_XPVBM();
10793 SvCUR(dstr) = SvCUR(sstr);
10794 SvLEN(dstr) = SvLEN(sstr);
10795 SvIVX(dstr) = SvIVX(sstr);
10796 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
10797 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10798 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
83841fad 10799 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
10800 BmRARE(dstr) = BmRARE(sstr);
10801 BmUSEFUL(dstr) = BmUSEFUL(sstr);
10802 BmPREVIOUS(dstr)= BmPREVIOUS(sstr);
10803 break;
10804 case SVt_PVLV:
10805 SvANY(dstr) = new_XPVLV();
10806 SvCUR(dstr) = SvCUR(sstr);
10807 SvLEN(dstr) = SvLEN(sstr);
10808 SvIVX(dstr) = SvIVX(sstr);
10809 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
10810 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10811 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
83841fad 10812 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
10813 LvTARGOFF(dstr) = LvTARGOFF(sstr); /* XXX sometimes holds PMOP* when DEBUGGING */
10814 LvTARGLEN(dstr) = LvTARGLEN(sstr);
dd28f7bb
DM
10815 if (LvTYPE(sstr) == 't') /* for tie: unrefcnted fake (SV**) */
10816 LvTARG(dstr) = dstr;
10817 else if (LvTYPE(sstr) == 'T') /* for tie: fake HE */
10818 LvTARG(dstr) = (SV*)he_dup((HE*)LvTARG(sstr), 0, param);
10819 else
10820 LvTARG(dstr) = sv_dup_inc(LvTARG(sstr), param);
1d7c1841
GS
10821 LvTYPE(dstr) = LvTYPE(sstr);
10822 break;
10823 case SVt_PVGV:
7fb37951 10824 if (GvUNIQUE((GV*)sstr)) {
5bd07a3d 10825 SV *share;
59b40662 10826 if ((share = gv_share(sstr, param))) {
5bd07a3d
DM
10827 del_SV(dstr);
10828 dstr = share;
37e20706 10829 ptr_table_store(PL_ptr_table, sstr, dstr);
5bd07a3d
DM
10830#if 0
10831 PerlIO_printf(Perl_debug_log, "sv_dup: sharing %s::%s\n",
10832 HvNAME(GvSTASH(share)), GvNAME(share));
10833#endif
10834 break;
10835 }
10836 }
1d7c1841
GS
10837 SvANY(dstr) = new_XPVGV();
10838 SvCUR(dstr) = SvCUR(sstr);
10839 SvLEN(dstr) = SvLEN(sstr);
10840 SvIVX(dstr) = SvIVX(sstr);
10841 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
10842 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10843 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
83841fad 10844 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
1d7c1841
GS
10845 GvNAMELEN(dstr) = GvNAMELEN(sstr);
10846 GvNAME(dstr) = SAVEPVN(GvNAME(sstr), GvNAMELEN(sstr));
d2d73c3e 10847 GvSTASH(dstr) = hv_dup_inc(GvSTASH(sstr), param);
1d7c1841 10848 GvFLAGS(dstr) = GvFLAGS(sstr);
d2d73c3e 10849 GvGP(dstr) = gp_dup(GvGP(sstr), param);
1d7c1841
GS
10850 (void)GpREFCNT_inc(GvGP(dstr));
10851 break;
10852 case SVt_PVIO:
10853 SvANY(dstr) = new_XPVIO();
10854 SvCUR(dstr) = SvCUR(sstr);
10855 SvLEN(dstr) = SvLEN(sstr);
10856 SvIVX(dstr) = SvIVX(sstr);
10857 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
10858 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10859 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
83841fad 10860 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
a8fc9800 10861 IoIFP(dstr) = fp_dup(IoIFP(sstr), IoTYPE(sstr), param);
1d7c1841
GS
10862 if (IoOFP(sstr) == IoIFP(sstr))
10863 IoOFP(dstr) = IoIFP(dstr);
10864 else
a8fc9800 10865 IoOFP(dstr) = fp_dup(IoOFP(sstr), IoTYPE(sstr), param);
1d7c1841
GS
10866 /* PL_rsfp_filters entries have fake IoDIRP() */
10867 if (IoDIRP(sstr) && !(IoFLAGS(sstr) & IOf_FAKE_DIRP))
10868 IoDIRP(dstr) = dirp_dup(IoDIRP(sstr));
10869 else
10870 IoDIRP(dstr) = IoDIRP(sstr);
10871 IoLINES(dstr) = IoLINES(sstr);
10872 IoPAGE(dstr) = IoPAGE(sstr);
10873 IoPAGE_LEN(dstr) = IoPAGE_LEN(sstr);
10874 IoLINES_LEFT(dstr) = IoLINES_LEFT(sstr);
7a5fa8a2 10875 if(IoFLAGS(sstr) & IOf_FAKE_DIRP) {
5a37521b
AB
10876 /* I have no idea why fake dirp (rsfps)
10877 should be treaded differently but otherwise
10878 we end up with leaks -- sky*/
10879 IoTOP_GV(dstr) = gv_dup_inc(IoTOP_GV(sstr), param);
10880 IoFMT_GV(dstr) = gv_dup_inc(IoFMT_GV(sstr), param);
10881 IoBOTTOM_GV(dstr) = gv_dup_inc(IoBOTTOM_GV(sstr), param);
10882 } else {
10883 IoTOP_GV(dstr) = gv_dup(IoTOP_GV(sstr), param);
10884 IoFMT_GV(dstr) = gv_dup(IoFMT_GV(sstr), param);
10885 IoBOTTOM_GV(dstr) = gv_dup(IoBOTTOM_GV(sstr), param);
10886 }
1d7c1841 10887 IoTOP_NAME(dstr) = SAVEPV(IoTOP_NAME(sstr));
1d7c1841 10888 IoFMT_NAME(dstr) = SAVEPV(IoFMT_NAME(sstr));
1d7c1841 10889 IoBOTTOM_NAME(dstr) = SAVEPV(IoBOTTOM_NAME(sstr));
1d7c1841
GS
10890 IoSUBPROCESS(dstr) = IoSUBPROCESS(sstr);
10891 IoTYPE(dstr) = IoTYPE(sstr);
10892 IoFLAGS(dstr) = IoFLAGS(sstr);
10893 break;
10894 case SVt_PVAV:
10895 SvANY(dstr) = new_XPVAV();
10896 SvCUR(dstr) = SvCUR(sstr);
10897 SvLEN(dstr) = SvLEN(sstr);
10898 SvIVX(dstr) = SvIVX(sstr);
10899 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
10900 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10901 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
10902 AvARYLEN((AV*)dstr) = sv_dup_inc(AvARYLEN((AV*)sstr), param);
1d7c1841
GS
10903 AvFLAGS((AV*)dstr) = AvFLAGS((AV*)sstr);
10904 if (AvARRAY((AV*)sstr)) {
10905 SV **dst_ary, **src_ary;
10906 SSize_t items = AvFILLp((AV*)sstr) + 1;
10907
10908 src_ary = AvARRAY((AV*)sstr);
10909 Newz(0, dst_ary, AvMAX((AV*)sstr)+1, SV*);
10910 ptr_table_store(PL_ptr_table, src_ary, dst_ary);
10911 SvPVX(dstr) = (char*)dst_ary;
10912 AvALLOC((AV*)dstr) = dst_ary;
10913 if (AvREAL((AV*)sstr)) {
10914 while (items-- > 0)
d2d73c3e 10915 *dst_ary++ = sv_dup_inc(*src_ary++, param);
1d7c1841
GS
10916 }
10917 else {
10918 while (items-- > 0)
d2d73c3e 10919 *dst_ary++ = sv_dup(*src_ary++, param);
1d7c1841
GS
10920 }
10921 items = AvMAX((AV*)sstr) - AvFILLp((AV*)sstr);
10922 while (items-- > 0) {
10923 *dst_ary++ = &PL_sv_undef;
10924 }
10925 }
10926 else {
10927 SvPVX(dstr) = Nullch;
10928 AvALLOC((AV*)dstr) = (SV**)NULL;
10929 }
10930 break;
10931 case SVt_PVHV:
10932 SvANY(dstr) = new_XPVHV();
10933 SvCUR(dstr) = SvCUR(sstr);
10934 SvLEN(dstr) = SvLEN(sstr);
10935 SvIVX(dstr) = SvIVX(sstr);
10936 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
10937 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10938 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
1d7c1841
GS
10939 HvRITER((HV*)dstr) = HvRITER((HV*)sstr);
10940 if (HvARRAY((HV*)sstr)) {
1d7c1841
GS
10941 STRLEN i = 0;
10942 XPVHV *dxhv = (XPVHV*)SvANY(dstr);
10943 XPVHV *sxhv = (XPVHV*)SvANY(sstr);
10944 Newz(0, dxhv->xhv_array,
10945 PERL_HV_ARRAY_ALLOC_BYTES(dxhv->xhv_max+1), char);
10946 while (i <= sxhv->xhv_max) {
10947 ((HE**)dxhv->xhv_array)[i] = he_dup(((HE**)sxhv->xhv_array)[i],
eb160463
GS
10948 (bool)!!HvSHAREKEYS(sstr),
10949 param);
1d7c1841
GS
10950 ++i;
10951 }
eb160463
GS
10952 dxhv->xhv_eiter = he_dup(sxhv->xhv_eiter,
10953 (bool)!!HvSHAREKEYS(sstr), param);
1d7c1841
GS
10954 }
10955 else {
10956 SvPVX(dstr) = Nullch;
10957 HvEITER((HV*)dstr) = (HE*)NULL;
10958 }
10959 HvPMROOT((HV*)dstr) = HvPMROOT((HV*)sstr); /* XXX */
10960 HvNAME((HV*)dstr) = SAVEPV(HvNAME((HV*)sstr));
c43294b8 10961 /* Record stashes for possible cloning in Perl_clone(). */
6676db26 10962 if(HvNAME((HV*)dstr))
d2d73c3e 10963 av_push(param->stashes, dstr);
1d7c1841
GS
10964 break;
10965 case SVt_PVFM:
10966 SvANY(dstr) = new_XPVFM();
10967 FmLINES(dstr) = FmLINES(sstr);
10968 goto dup_pvcv;
10969 /* NOTREACHED */
10970 case SVt_PVCV:
10971 SvANY(dstr) = new_XPVCV();
d2d73c3e 10972 dup_pvcv:
1d7c1841
GS
10973 SvCUR(dstr) = SvCUR(sstr);
10974 SvLEN(dstr) = SvLEN(sstr);
10975 SvIVX(dstr) = SvIVX(sstr);
10976 SvNVX(dstr) = SvNVX(sstr);
d2d73c3e
AB
10977 SvMAGIC(dstr) = mg_dup(SvMAGIC(sstr), param);
10978 SvSTASH(dstr) = hv_dup_inc(SvSTASH(sstr), param);
83841fad 10979 Perl_rvpv_dup(aTHX_ dstr, sstr, param);
d2d73c3e 10980 CvSTASH(dstr) = hv_dup(CvSTASH(sstr), param); /* NOTE: not refcounted */
1d7c1841 10981 CvSTART(dstr) = CvSTART(sstr);
b34c0dd4 10982 OP_REFCNT_LOCK;
1d7c1841 10983 CvROOT(dstr) = OpREFCNT_inc(CvROOT(sstr));
b34c0dd4 10984 OP_REFCNT_UNLOCK;
1d7c1841
GS
10985 CvXSUB(dstr) = CvXSUB(sstr);
10986 CvXSUBANY(dstr) = CvXSUBANY(sstr);
01485f8b
DM
10987 if (CvCONST(sstr)) {
10988 CvXSUBANY(dstr).any_ptr = GvUNIQUE(CvGV(sstr)) ?
10989 SvREFCNT_inc(CvXSUBANY(sstr).any_ptr) :
10990 sv_dup_inc(CvXSUBANY(sstr).any_ptr, param);
10991 }
b23f1a86
DM
10992 /* don't dup if copying back - CvGV isn't refcounted, so the
10993 * duped GV may never be freed. A bit of a hack! DAPM */
10994 CvGV(dstr) = (param->flags & CLONEf_JOIN_IN) ?
10995 Nullgv : gv_dup(CvGV(sstr), param) ;
d2d73c3e
AB
10996 if (param->flags & CLONEf_COPY_STACKS) {
10997 CvDEPTH(dstr) = CvDEPTH(sstr);
10998 } else {
10999 CvDEPTH(dstr) = 0;
11000 }
dd2155a4 11001 PAD_DUP(CvPADLIST(dstr), CvPADLIST(sstr), param);
7dafbf52
DM
11002 CvOUTSIDE_SEQ(dstr) = CvOUTSIDE_SEQ(sstr);
11003 CvOUTSIDE(dstr) =
11004 CvWEAKOUTSIDE(sstr)
11005 ? cv_dup( CvOUTSIDE(sstr), param)
11006 : cv_dup_inc(CvOUTSIDE(sstr), param);
1d7c1841 11007 CvFLAGS(dstr) = CvFLAGS(sstr);
54356c7d 11008 CvFILE(dstr) = CvXSUB(sstr) ? CvFILE(sstr) : SAVEPV(CvFILE(sstr));
1d7c1841
GS
11009 break;
11010 default:
c803eecc 11011 Perl_croak(aTHX_ "Bizarre SvTYPE [%" IVdf "]", (IV)SvTYPE(sstr));
1d7c1841
GS
11012 break;
11013 }
11014
11015 if (SvOBJECT(dstr) && SvTYPE(dstr) != SVt_PVIO)
11016 ++PL_sv_objcount;
11017
11018 return dstr;
d2d73c3e 11019 }
1d7c1841 11020
645c22ef
DM
11021/* duplicate a context */
11022
1d7c1841 11023PERL_CONTEXT *
a8fc9800 11024Perl_cx_dup(pTHX_ PERL_CONTEXT *cxs, I32 ix, I32 max, CLONE_PARAMS* param)
1d7c1841
GS
11025{
11026 PERL_CONTEXT *ncxs;
11027
11028 if (!cxs)
11029 return (PERL_CONTEXT*)NULL;
11030
11031 /* look for it in the table first */
11032 ncxs = (PERL_CONTEXT*)ptr_table_fetch(PL_ptr_table, cxs);
11033 if (ncxs)
11034 return ncxs;
11035
11036 /* create anew and remember what it is */
11037 Newz(56, ncxs, max + 1, PERL_CONTEXT);
11038 ptr_table_store(PL_ptr_table, cxs, ncxs);
11039
11040 while (ix >= 0) {
11041 PERL_CONTEXT *cx = &cxs[ix];
11042 PERL_CONTEXT *ncx = &ncxs[ix];
11043 ncx->cx_type = cx->cx_type;
11044 if (CxTYPE(cx) == CXt_SUBST) {
11045 Perl_croak(aTHX_ "Cloning substitution context is unimplemented");
11046 }
11047 else {
11048 ncx->blk_oldsp = cx->blk_oldsp;
11049 ncx->blk_oldcop = cx->blk_oldcop;
1d7c1841
GS
11050 ncx->blk_oldmarksp = cx->blk_oldmarksp;
11051 ncx->blk_oldscopesp = cx->blk_oldscopesp;
11052 ncx->blk_oldpm = cx->blk_oldpm;
11053 ncx->blk_gimme = cx->blk_gimme;
11054 switch (CxTYPE(cx)) {
11055 case CXt_SUB:
11056 ncx->blk_sub.cv = (cx->blk_sub.olddepth == 0
d2d73c3e
AB
11057 ? cv_dup_inc(cx->blk_sub.cv, param)
11058 : cv_dup(cx->blk_sub.cv,param));
1d7c1841 11059 ncx->blk_sub.argarray = (cx->blk_sub.hasargs
d2d73c3e 11060 ? av_dup_inc(cx->blk_sub.argarray, param)
1d7c1841 11061 : Nullav);
d2d73c3e 11062 ncx->blk_sub.savearray = av_dup_inc(cx->blk_sub.savearray, param);
1d7c1841
GS
11063 ncx->blk_sub.olddepth = cx->blk_sub.olddepth;
11064 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
11065 ncx->blk_sub.lval = cx->blk_sub.lval;
f39bc417 11066 ncx->blk_sub.retop = cx->blk_sub.retop;
1d7c1841
GS
11067 break;
11068 case CXt_EVAL:
11069 ncx->blk_eval.old_in_eval = cx->blk_eval.old_in_eval;
11070 ncx->blk_eval.old_op_type = cx->blk_eval.old_op_type;
b47cad08 11071 ncx->blk_eval.old_namesv = sv_dup_inc(cx->blk_eval.old_namesv, param);
1d7c1841 11072 ncx->blk_eval.old_eval_root = cx->blk_eval.old_eval_root;
d2d73c3e 11073 ncx->blk_eval.cur_text = sv_dup(cx->blk_eval.cur_text, param);
f39bc417 11074 ncx->blk_eval.retop = cx->blk_eval.retop;
1d7c1841
GS
11075 break;
11076 case CXt_LOOP:
11077 ncx->blk_loop.label = cx->blk_loop.label;
11078 ncx->blk_loop.resetsp = cx->blk_loop.resetsp;
11079 ncx->blk_loop.redo_op = cx->blk_loop.redo_op;
11080 ncx->blk_loop.next_op = cx->blk_loop.next_op;
11081 ncx->blk_loop.last_op = cx->blk_loop.last_op;
11082 ncx->blk_loop.iterdata = (CxPADLOOP(cx)
11083 ? cx->blk_loop.iterdata
d2d73c3e 11084 : gv_dup((GV*)cx->blk_loop.iterdata, param));
f3548bdc
DM
11085 ncx->blk_loop.oldcomppad
11086 = (PAD*)ptr_table_fetch(PL_ptr_table,
11087 cx->blk_loop.oldcomppad);
d2d73c3e
AB
11088 ncx->blk_loop.itersave = sv_dup_inc(cx->blk_loop.itersave, param);
11089 ncx->blk_loop.iterlval = sv_dup_inc(cx->blk_loop.iterlval, param);
11090 ncx->blk_loop.iterary = av_dup_inc(cx->blk_loop.iterary, param);
1d7c1841
GS
11091 ncx->blk_loop.iterix = cx->blk_loop.iterix;
11092 ncx->blk_loop.itermax = cx->blk_loop.itermax;
11093 break;
11094 case CXt_FORMAT:
d2d73c3e
AB
11095 ncx->blk_sub.cv = cv_dup(cx->blk_sub.cv, param);
11096 ncx->blk_sub.gv = gv_dup(cx->blk_sub.gv, param);
11097 ncx->blk_sub.dfoutgv = gv_dup_inc(cx->blk_sub.dfoutgv, param);
1d7c1841 11098 ncx->blk_sub.hasargs = cx->blk_sub.hasargs;
f39bc417 11099 ncx->blk_sub.retop = cx->blk_sub.retop;
1d7c1841
GS
11100 break;
11101 case CXt_BLOCK:
11102 case CXt_NULL:
11103 break;
11104 }
11105 }
11106 --ix;
11107 }
11108 return ncxs;
11109}
11110
645c22ef
DM
11111/* duplicate a stack info structure */
11112
1d7c1841 11113PERL_SI *
a8fc9800 11114Perl_si_dup(pTHX_ PERL_SI *si, CLONE_PARAMS* param)
1d7c1841
GS
11115{
11116 PERL_SI *nsi;
11117
11118 if (!si)
11119 return (PERL_SI*)NULL;
11120
11121 /* look for it in the table first */
11122 nsi = (PERL_SI*)ptr_table_fetch(PL_ptr_table, si);
11123 if (nsi)
11124 return nsi;
11125
11126 /* create anew and remember what it is */
11127 Newz(56, nsi, 1, PERL_SI);
11128 ptr_table_store(PL_ptr_table, si, nsi);
11129
d2d73c3e 11130 nsi->si_stack = av_dup_inc(si->si_stack, param);
1d7c1841
GS
11131 nsi->si_cxix = si->si_cxix;
11132 nsi->si_cxmax = si->si_cxmax;
d2d73c3e 11133 nsi->si_cxstack = cx_dup(si->si_cxstack, si->si_cxix, si->si_cxmax, param);
1d7c1841 11134 nsi->si_type = si->si_type;
d2d73c3e
AB
11135 nsi->si_prev = si_dup(si->si_prev, param);
11136 nsi->si_next = si_dup(si->si_next, param);
1d7c1841
GS
11137 nsi->si_markoff = si->si_markoff;
11138
11139 return nsi;
11140}
11141
11142#define POPINT(ss,ix) ((ss)[--(ix)].any_i32)
11143#define TOPINT(ss,ix) ((ss)[ix].any_i32)
11144#define POPLONG(ss,ix) ((ss)[--(ix)].any_long)
11145#define TOPLONG(ss,ix) ((ss)[ix].any_long)
11146#define POPIV(ss,ix) ((ss)[--(ix)].any_iv)
11147#define TOPIV(ss,ix) ((ss)[ix].any_iv)
38d8b13e
HS
11148#define POPBOOL(ss,ix) ((ss)[--(ix)].any_bool)
11149#define TOPBOOL(ss,ix) ((ss)[ix].any_bool)
1d7c1841
GS
11150#define POPPTR(ss,ix) ((ss)[--(ix)].any_ptr)
11151#define TOPPTR(ss,ix) ((ss)[ix].any_ptr)
11152#define POPDPTR(ss,ix) ((ss)[--(ix)].any_dptr)
11153#define TOPDPTR(ss,ix) ((ss)[ix].any_dptr)
11154#define POPDXPTR(ss,ix) ((ss)[--(ix)].any_dxptr)
11155#define TOPDXPTR(ss,ix) ((ss)[ix].any_dxptr)
11156
11157/* XXXXX todo */
11158#define pv_dup_inc(p) SAVEPV(p)
11159#define pv_dup(p) SAVEPV(p)
11160#define svp_dup_inc(p,pp) any_dup(p,pp)
11161
645c22ef
DM
11162/* map any object to the new equivent - either something in the
11163 * ptr table, or something in the interpreter structure
11164 */
11165
1d7c1841
GS
11166void *
11167Perl_any_dup(pTHX_ void *v, PerlInterpreter *proto_perl)
11168{
11169 void *ret;
11170
11171 if (!v)
11172 return (void*)NULL;
11173
11174 /* look for it in the table first */
11175 ret = ptr_table_fetch(PL_ptr_table, v);
11176 if (ret)
11177 return ret;
11178
11179 /* see if it is part of the interpreter structure */
11180 if (v >= (void*)proto_perl && v < (void*)(proto_perl+1))
acfe0abc 11181 ret = (void*)(((char*)aTHX) + (((char*)v) - (char*)proto_perl));
05ec9bb3 11182 else {
1d7c1841 11183 ret = v;
05ec9bb3 11184 }
1d7c1841
GS
11185
11186 return ret;
11187}
11188
645c22ef
DM
11189/* duplicate the save stack */
11190
1d7c1841 11191ANY *
a8fc9800 11192Perl_ss_dup(pTHX_ PerlInterpreter *proto_perl, CLONE_PARAMS* param)
1d7c1841
GS
11193{
11194 ANY *ss = proto_perl->Tsavestack;
11195 I32 ix = proto_perl->Tsavestack_ix;
11196 I32 max = proto_perl->Tsavestack_max;
11197 ANY *nss;
11198 SV *sv;
11199 GV *gv;
11200 AV *av;
11201 HV *hv;
11202 void* ptr;
11203 int intval;
11204 long longval;
11205 GP *gp;
11206 IV iv;
11207 I32 i;
c4e33207 11208 char *c = NULL;
1d7c1841 11209 void (*dptr) (void*);
acfe0abc 11210 void (*dxptr) (pTHX_ void*);
e977893f 11211 OP *o;
1d7c1841
GS
11212
11213 Newz(54, nss, max, ANY);
11214
11215 while (ix > 0) {
11216 i = POPINT(ss,ix);
11217 TOPINT(nss,ix) = i;
11218 switch (i) {
11219 case SAVEt_ITEM: /* normal string */
11220 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 11221 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841 11222 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 11223 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841
GS
11224 break;
11225 case SAVEt_SV: /* scalar reference */
11226 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 11227 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841 11228 gv = (GV*)POPPTR(ss,ix);
d2d73c3e 11229 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
1d7c1841 11230 break;
f4dd75d9
GS
11231 case SAVEt_GENERIC_PVREF: /* generic char* */
11232 c = (char*)POPPTR(ss,ix);
11233 TOPPTR(nss,ix) = pv_dup(c);
11234 ptr = POPPTR(ss,ix);
11235 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11236 break;
05ec9bb3
NIS
11237 case SAVEt_SHARED_PVREF: /* char* in shared space */
11238 c = (char*)POPPTR(ss,ix);
11239 TOPPTR(nss,ix) = savesharedpv(c);
11240 ptr = POPPTR(ss,ix);
11241 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11242 break;
1d7c1841
GS
11243 case SAVEt_GENERIC_SVREF: /* generic sv */
11244 case SAVEt_SVREF: /* scalar reference */
11245 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 11246 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841
GS
11247 ptr = POPPTR(ss,ix);
11248 TOPPTR(nss,ix) = svp_dup_inc((SV**)ptr, proto_perl);/* XXXXX */
11249 break;
11250 case SAVEt_AV: /* array reference */
11251 av = (AV*)POPPTR(ss,ix);
d2d73c3e 11252 TOPPTR(nss,ix) = av_dup_inc(av, param);
1d7c1841 11253 gv = (GV*)POPPTR(ss,ix);
d2d73c3e 11254 TOPPTR(nss,ix) = gv_dup(gv, param);
1d7c1841
GS
11255 break;
11256 case SAVEt_HV: /* hash reference */
11257 hv = (HV*)POPPTR(ss,ix);
d2d73c3e 11258 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
1d7c1841 11259 gv = (GV*)POPPTR(ss,ix);
d2d73c3e 11260 TOPPTR(nss,ix) = gv_dup(gv, param);
1d7c1841
GS
11261 break;
11262 case SAVEt_INT: /* int reference */
11263 ptr = POPPTR(ss,ix);
11264 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11265 intval = (int)POPINT(ss,ix);
11266 TOPINT(nss,ix) = intval;
11267 break;
11268 case SAVEt_LONG: /* long reference */
11269 ptr = POPPTR(ss,ix);
11270 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11271 longval = (long)POPLONG(ss,ix);
11272 TOPLONG(nss,ix) = longval;
11273 break;
11274 case SAVEt_I32: /* I32 reference */
11275 case SAVEt_I16: /* I16 reference */
11276 case SAVEt_I8: /* I8 reference */
11277 ptr = POPPTR(ss,ix);
11278 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11279 i = POPINT(ss,ix);
11280 TOPINT(nss,ix) = i;
11281 break;
11282 case SAVEt_IV: /* IV reference */
11283 ptr = POPPTR(ss,ix);
11284 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11285 iv = POPIV(ss,ix);
11286 TOPIV(nss,ix) = iv;
11287 break;
11288 case SAVEt_SPTR: /* SV* reference */
11289 ptr = POPPTR(ss,ix);
11290 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11291 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 11292 TOPPTR(nss,ix) = sv_dup(sv, param);
1d7c1841
GS
11293 break;
11294 case SAVEt_VPTR: /* random* reference */
11295 ptr = POPPTR(ss,ix);
11296 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11297 ptr = POPPTR(ss,ix);
11298 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11299 break;
11300 case SAVEt_PPTR: /* char* reference */
11301 ptr = POPPTR(ss,ix);
11302 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11303 c = (char*)POPPTR(ss,ix);
11304 TOPPTR(nss,ix) = pv_dup(c);
11305 break;
11306 case SAVEt_HPTR: /* HV* reference */
11307 ptr = POPPTR(ss,ix);
11308 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11309 hv = (HV*)POPPTR(ss,ix);
d2d73c3e 11310 TOPPTR(nss,ix) = hv_dup(hv, param);
1d7c1841
GS
11311 break;
11312 case SAVEt_APTR: /* AV* reference */
11313 ptr = POPPTR(ss,ix);
11314 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11315 av = (AV*)POPPTR(ss,ix);
d2d73c3e 11316 TOPPTR(nss,ix) = av_dup(av, param);
1d7c1841
GS
11317 break;
11318 case SAVEt_NSTAB:
11319 gv = (GV*)POPPTR(ss,ix);
d2d73c3e 11320 TOPPTR(nss,ix) = gv_dup(gv, param);
1d7c1841
GS
11321 break;
11322 case SAVEt_GP: /* scalar reference */
11323 gp = (GP*)POPPTR(ss,ix);
d2d73c3e 11324 TOPPTR(nss,ix) = gp = gp_dup(gp, param);
1d7c1841
GS
11325 (void)GpREFCNT_inc(gp);
11326 gv = (GV*)POPPTR(ss,ix);
2ed3c8fc 11327 TOPPTR(nss,ix) = gv_dup_inc(gv, param);
1d7c1841
GS
11328 c = (char*)POPPTR(ss,ix);
11329 TOPPTR(nss,ix) = pv_dup(c);
11330 iv = POPIV(ss,ix);
11331 TOPIV(nss,ix) = iv;
11332 iv = POPIV(ss,ix);
11333 TOPIV(nss,ix) = iv;
11334 break;
11335 case SAVEt_FREESV:
26d9b02f 11336 case SAVEt_MORTALIZESV:
1d7c1841 11337 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 11338 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841
GS
11339 break;
11340 case SAVEt_FREEOP:
11341 ptr = POPPTR(ss,ix);
11342 if (ptr && (((OP*)ptr)->op_private & OPpREFCOUNTED)) {
11343 /* these are assumed to be refcounted properly */
11344 switch (((OP*)ptr)->op_type) {
11345 case OP_LEAVESUB:
11346 case OP_LEAVESUBLV:
11347 case OP_LEAVEEVAL:
11348 case OP_LEAVE:
11349 case OP_SCOPE:
11350 case OP_LEAVEWRITE:
e977893f
GS
11351 TOPPTR(nss,ix) = ptr;
11352 o = (OP*)ptr;
11353 OpREFCNT_inc(o);
1d7c1841
GS
11354 break;
11355 default:
11356 TOPPTR(nss,ix) = Nullop;
11357 break;
11358 }
11359 }
11360 else
11361 TOPPTR(nss,ix) = Nullop;
11362 break;
11363 case SAVEt_FREEPV:
11364 c = (char*)POPPTR(ss,ix);
11365 TOPPTR(nss,ix) = pv_dup_inc(c);
11366 break;
11367 case SAVEt_CLEARSV:
11368 longval = POPLONG(ss,ix);
11369 TOPLONG(nss,ix) = longval;
11370 break;
11371 case SAVEt_DELETE:
11372 hv = (HV*)POPPTR(ss,ix);
d2d73c3e 11373 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
1d7c1841
GS
11374 c = (char*)POPPTR(ss,ix);
11375 TOPPTR(nss,ix) = pv_dup_inc(c);
11376 i = POPINT(ss,ix);
11377 TOPINT(nss,ix) = i;
11378 break;
11379 case SAVEt_DESTRUCTOR:
11380 ptr = POPPTR(ss,ix);
11381 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11382 dptr = POPDPTR(ss,ix);
ef75a179 11383 TOPDPTR(nss,ix) = (void (*)(void*))any_dup((void *)dptr, proto_perl);
1d7c1841
GS
11384 break;
11385 case SAVEt_DESTRUCTOR_X:
11386 ptr = POPPTR(ss,ix);
11387 TOPPTR(nss,ix) = any_dup(ptr, proto_perl); /* XXX quite arbitrary */
11388 dxptr = POPDXPTR(ss,ix);
acfe0abc 11389 TOPDXPTR(nss,ix) = (void (*)(pTHX_ void*))any_dup((void *)dxptr, proto_perl);
1d7c1841
GS
11390 break;
11391 case SAVEt_REGCONTEXT:
11392 case SAVEt_ALLOC:
11393 i = POPINT(ss,ix);
11394 TOPINT(nss,ix) = i;
11395 ix -= i;
11396 break;
11397 case SAVEt_STACK_POS: /* Position on Perl stack */
11398 i = POPINT(ss,ix);
11399 TOPINT(nss,ix) = i;
11400 break;
11401 case SAVEt_AELEM: /* array element */
11402 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 11403 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841
GS
11404 i = POPINT(ss,ix);
11405 TOPINT(nss,ix) = i;
11406 av = (AV*)POPPTR(ss,ix);
d2d73c3e 11407 TOPPTR(nss,ix) = av_dup_inc(av, param);
1d7c1841
GS
11408 break;
11409 case SAVEt_HELEM: /* hash element */
11410 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 11411 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841 11412 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 11413 TOPPTR(nss,ix) = sv_dup_inc(sv, param);
1d7c1841 11414 hv = (HV*)POPPTR(ss,ix);
d2d73c3e 11415 TOPPTR(nss,ix) = hv_dup_inc(hv, param);
1d7c1841
GS
11416 break;
11417 case SAVEt_OP:
11418 ptr = POPPTR(ss,ix);
11419 TOPPTR(nss,ix) = ptr;
11420 break;
11421 case SAVEt_HINTS:
11422 i = POPINT(ss,ix);
11423 TOPINT(nss,ix) = i;
11424 break;
c4410b1b
GS
11425 case SAVEt_COMPPAD:
11426 av = (AV*)POPPTR(ss,ix);
58ed4fbe 11427 TOPPTR(nss,ix) = av_dup(av, param);
c4410b1b 11428 break;
c3564e5c
GS
11429 case SAVEt_PADSV:
11430 longval = (long)POPLONG(ss,ix);
11431 TOPLONG(nss,ix) = longval;
11432 ptr = POPPTR(ss,ix);
11433 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
11434 sv = (SV*)POPPTR(ss,ix);
d2d73c3e 11435 TOPPTR(nss,ix) = sv_dup(sv, param);
c3564e5c 11436 break;
a1bb4754 11437 case SAVEt_BOOL:
38d8b13e 11438 ptr = POPPTR(ss,ix);
b9609c01 11439 TOPPTR(nss,ix) = any_dup(ptr, proto_perl);
38d8b13e 11440 longval = (long)POPBOOL(ss,ix);
b9609c01 11441 TOPBOOL(nss,ix) = (bool)longval;
a1bb4754 11442 break;
8bd2680e
MHM
11443 case SAVEt_SET_SVFLAGS:
11444 i = POPINT(ss,ix);
11445 TOPINT(nss,ix) = i;
11446 i = POPINT(ss,ix);
11447 TOPINT(nss,ix) = i;
11448 sv = (SV*)POPPTR(ss,ix);
11449 TOPPTR(nss,ix) = sv_dup(sv, param);
11450 break;
1d7c1841
GS
11451 default:
11452 Perl_croak(aTHX_ "panic: ss_dup inconsistency");
11453 }
11454 }
11455
11456 return nss;
11457}
11458
645c22ef
DM
11459/*
11460=for apidoc perl_clone
11461
11462Create and return a new interpreter by cloning the current one.
11463
4be49ee6 11464perl_clone takes these flags as parameters:
6a78b4db 11465
7a5fa8a2
NIS
11466CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
11467without it we only clone the data and zero the stacks,
11468with it we copy the stacks and the new perl interpreter is
11469ready to run at the exact same point as the previous one.
11470The pseudo-fork code uses COPY_STACKS while the
6a78b4db
AB
11471threads->new doesn't.
11472
11473CLONEf_KEEP_PTR_TABLE
7a5fa8a2
NIS
11474perl_clone keeps a ptr_table with the pointer of the old
11475variable as a key and the new variable as a value,
11476this allows it to check if something has been cloned and not
11477clone it again but rather just use the value and increase the
11478refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
11479the ptr_table using the function
11480C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
11481reason to keep it around is if you want to dup some of your own
11482variable who are outside the graph perl scans, example of this
6a78b4db
AB
11483code is in threads.xs create
11484
11485CLONEf_CLONE_HOST
7a5fa8a2
NIS
11486This is a win32 thing, it is ignored on unix, it tells perls
11487win32host code (which is c++) to clone itself, this is needed on
11488win32 if you want to run two threads at the same time,
11489if you just want to do some stuff in a separate perl interpreter
11490and then throw it away and return to the original one,
6a78b4db
AB
11491you don't need to do anything.
11492
645c22ef
DM
11493=cut
11494*/
11495
11496/* XXX the above needs expanding by someone who actually understands it ! */
3fc56081
NK
11497EXTERN_C PerlInterpreter *
11498perl_clone_host(PerlInterpreter* proto_perl, UV flags);
645c22ef 11499
1d7c1841
GS
11500PerlInterpreter *
11501perl_clone(PerlInterpreter *proto_perl, UV flags)
11502{
1d7c1841 11503#ifdef PERL_IMPLICIT_SYS
c43294b8
AB
11504
11505 /* perlhost.h so we need to call into it
11506 to clone the host, CPerlHost should have a c interface, sky */
11507
11508 if (flags & CLONEf_CLONE_HOST) {
11509 return perl_clone_host(proto_perl,flags);
11510 }
11511 return perl_clone_using(proto_perl, flags,
1d7c1841
GS
11512 proto_perl->IMem,
11513 proto_perl->IMemShared,
11514 proto_perl->IMemParse,
11515 proto_perl->IEnv,
11516 proto_perl->IStdIO,
11517 proto_perl->ILIO,
11518 proto_perl->IDir,
11519 proto_perl->ISock,
11520 proto_perl->IProc);
11521}
11522
11523PerlInterpreter *
11524perl_clone_using(PerlInterpreter *proto_perl, UV flags,
11525 struct IPerlMem* ipM, struct IPerlMem* ipMS,
11526 struct IPerlMem* ipMP, struct IPerlEnv* ipE,
11527 struct IPerlStdIO* ipStd, struct IPerlLIO* ipLIO,
11528 struct IPerlDir* ipD, struct IPerlSock* ipS,
11529 struct IPerlProc* ipP)
11530{
11531 /* XXX many of the string copies here can be optimized if they're
11532 * constants; they need to be allocated as common memory and just
11533 * their pointers copied. */
11534
11535 IV i;
64aa0685
GS
11536 CLONE_PARAMS clone_params;
11537 CLONE_PARAMS* param = &clone_params;
d2d73c3e 11538
1d7c1841 11539 PerlInterpreter *my_perl = (PerlInterpreter*)(*ipM->pMalloc)(ipM, sizeof(PerlInterpreter));
ba869deb 11540 PERL_SET_THX(my_perl);
1d7c1841 11541
acfe0abc 11542# ifdef DEBUGGING
a4530404 11543 Poison(my_perl, 1, PerlInterpreter);
1d7c1841
GS
11544 PL_markstack = 0;
11545 PL_scopestack = 0;
11546 PL_savestack = 0;
22f7c9c9
JH
11547 PL_savestack_ix = 0;
11548 PL_savestack_max = -1;
66fe0623 11549 PL_sig_pending = 0;
25596c82 11550 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
acfe0abc 11551# else /* !DEBUGGING */
1d7c1841 11552 Zero(my_perl, 1, PerlInterpreter);
acfe0abc 11553# endif /* DEBUGGING */
1d7c1841
GS
11554
11555 /* host pointers */
11556 PL_Mem = ipM;
11557 PL_MemShared = ipMS;
11558 PL_MemParse = ipMP;
11559 PL_Env = ipE;
11560 PL_StdIO = ipStd;
11561 PL_LIO = ipLIO;
11562 PL_Dir = ipD;
11563 PL_Sock = ipS;
11564 PL_Proc = ipP;
1d7c1841
GS
11565#else /* !PERL_IMPLICIT_SYS */
11566 IV i;
64aa0685
GS
11567 CLONE_PARAMS clone_params;
11568 CLONE_PARAMS* param = &clone_params;
1d7c1841 11569 PerlInterpreter *my_perl = (PerlInterpreter*)PerlMem_malloc(sizeof(PerlInterpreter));
ba869deb 11570 PERL_SET_THX(my_perl);
1d7c1841 11571
d2d73c3e
AB
11572
11573
1d7c1841 11574# ifdef DEBUGGING
a4530404 11575 Poison(my_perl, 1, PerlInterpreter);
1d7c1841
GS
11576 PL_markstack = 0;
11577 PL_scopestack = 0;
11578 PL_savestack = 0;
22f7c9c9
JH
11579 PL_savestack_ix = 0;
11580 PL_savestack_max = -1;
66fe0623 11581 PL_sig_pending = 0;
25596c82 11582 Zero(&PL_debug_pad, 1, struct perl_debug_pad);
1d7c1841
GS
11583# else /* !DEBUGGING */
11584 Zero(my_perl, 1, PerlInterpreter);
11585# endif /* DEBUGGING */
11586#endif /* PERL_IMPLICIT_SYS */
83236556 11587 param->flags = flags;
59b40662 11588 param->proto_perl = proto_perl;
1d7c1841
GS
11589
11590 /* arena roots */
11591 PL_xiv_arenaroot = NULL;
11592 PL_xiv_root = NULL;
612f20c3 11593 PL_xnv_arenaroot = NULL;
1d7c1841 11594 PL_xnv_root = NULL;
612f20c3 11595 PL_xrv_arenaroot = NULL;
1d7c1841 11596 PL_xrv_root = NULL;
612f20c3 11597 PL_xpv_arenaroot = NULL;
1d7c1841 11598 PL_xpv_root = NULL;
612f20c3 11599 PL_xpviv_arenaroot = NULL;
1d7c1841 11600 PL_xpviv_root = NULL;
612f20c3 11601 PL_xpvnv_arenaroot = NULL;
1d7c1841 11602 PL_xpvnv_root = NULL;
612f20c3 11603 PL_xpvcv_arenaroot = NULL;
1d7c1841 11604 PL_xpvcv_root = NULL;
612f20c3 11605 PL_xpvav_arenaroot = NULL;
1d7c1841 11606 PL_xpvav_root = NULL;
612f20c3 11607 PL_xpvhv_arenaroot = NULL;
1d7c1841 11608 PL_xpvhv_root = NULL;
612f20c3 11609 PL_xpvmg_arenaroot = NULL;
1d7c1841 11610 PL_xpvmg_root = NULL;
612f20c3 11611 PL_xpvlv_arenaroot = NULL;
1d7c1841 11612 PL_xpvlv_root = NULL;
612f20c3 11613 PL_xpvbm_arenaroot = NULL;
1d7c1841 11614 PL_xpvbm_root = NULL;
612f20c3 11615 PL_he_arenaroot = NULL;
1d7c1841
GS
11616 PL_he_root = NULL;
11617 PL_nice_chunk = NULL;
11618 PL_nice_chunk_size = 0;
11619 PL_sv_count = 0;
11620 PL_sv_objcount = 0;
11621 PL_sv_root = Nullsv;
11622 PL_sv_arenaroot = Nullsv;
11623
11624 PL_debug = proto_perl->Idebug;
11625
e5dd39fc 11626#ifdef USE_REENTRANT_API
68853529
SB
11627 /* XXX: things like -Dm will segfault here in perlio, but doing
11628 * PERL_SET_CONTEXT(proto_perl);
11629 * breaks too many other things
11630 */
59bd0823 11631 Perl_reentrant_init(aTHX);
e5dd39fc
AB
11632#endif
11633
1d7c1841
GS
11634 /* create SV map for pointer relocation */
11635 PL_ptr_table = ptr_table_new();
11636
11637 /* initialize these special pointers as early as possible */
11638 SvANY(&PL_sv_undef) = NULL;
11639 SvREFCNT(&PL_sv_undef) = (~(U32)0)/2;
11640 SvFLAGS(&PL_sv_undef) = SVf_READONLY|SVt_NULL;
11641 ptr_table_store(PL_ptr_table, &proto_perl->Isv_undef, &PL_sv_undef);
11642
1d7c1841 11643 SvANY(&PL_sv_no) = new_XPVNV();
1d7c1841 11644 SvREFCNT(&PL_sv_no) = (~(U32)0)/2;
0309f36e
NC
11645 SvFLAGS(&PL_sv_no) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11646 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
1d7c1841
GS
11647 SvPVX(&PL_sv_no) = SAVEPVN(PL_No, 0);
11648 SvCUR(&PL_sv_no) = 0;
11649 SvLEN(&PL_sv_no) = 1;
0309f36e 11650 SvIVX(&PL_sv_no) = 0;
1d7c1841
GS
11651 SvNVX(&PL_sv_no) = 0;
11652 ptr_table_store(PL_ptr_table, &proto_perl->Isv_no, &PL_sv_no);
11653
1d7c1841 11654 SvANY(&PL_sv_yes) = new_XPVNV();
1d7c1841 11655 SvREFCNT(&PL_sv_yes) = (~(U32)0)/2;
0309f36e
NC
11656 SvFLAGS(&PL_sv_yes) = SVp_IOK|SVf_IOK|SVp_NOK|SVf_NOK
11657 |SVp_POK|SVf_POK|SVf_READONLY|SVt_PVNV;
1d7c1841
GS
11658 SvPVX(&PL_sv_yes) = SAVEPVN(PL_Yes, 1);
11659 SvCUR(&PL_sv_yes) = 1;
11660 SvLEN(&PL_sv_yes) = 2;
0309f36e 11661 SvIVX(&PL_sv_yes) = 1;
1d7c1841
GS
11662 SvNVX(&PL_sv_yes) = 1;
11663 ptr_table_store(PL_ptr_table, &proto_perl->Isv_yes, &PL_sv_yes);
11664
05ec9bb3 11665 /* create (a non-shared!) shared string table */
1d7c1841
GS
11666 PL_strtab = newHV();
11667 HvSHAREKEYS_off(PL_strtab);
11668 hv_ksplit(PL_strtab, 512);
11669 ptr_table_store(PL_ptr_table, proto_perl->Istrtab, PL_strtab);
11670
05ec9bb3
NIS
11671 PL_compiling = proto_perl->Icompiling;
11672
11673 /* These two PVs will be free'd special way so must set them same way op.c does */
11674 PL_compiling.cop_stashpv = savesharedpv(PL_compiling.cop_stashpv);
11675 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_stashpv, PL_compiling.cop_stashpv);
11676
11677 PL_compiling.cop_file = savesharedpv(PL_compiling.cop_file);
11678 ptr_table_store(PL_ptr_table, proto_perl->Icompiling.cop_file, PL_compiling.cop_file);
11679
1d7c1841
GS
11680 ptr_table_store(PL_ptr_table, &proto_perl->Icompiling, &PL_compiling);
11681 if (!specialWARN(PL_compiling.cop_warnings))
d2d73c3e 11682 PL_compiling.cop_warnings = sv_dup_inc(PL_compiling.cop_warnings, param);
ac27b0f5 11683 if (!specialCopIO(PL_compiling.cop_io))
d2d73c3e 11684 PL_compiling.cop_io = sv_dup_inc(PL_compiling.cop_io, param);
1d7c1841
GS
11685 PL_curcop = (COP*)any_dup(proto_perl->Tcurcop, proto_perl);
11686
11687 /* pseudo environmental stuff */
11688 PL_origargc = proto_perl->Iorigargc;
e2975953 11689 PL_origargv = proto_perl->Iorigargv;
d2d73c3e 11690
d2d73c3e
AB
11691 param->stashes = newAV(); /* Setup array of objects to call clone on */
11692
a1ea730d 11693#ifdef PERLIO_LAYERS
3a1ee7e8
NIS
11694 /* Clone PerlIO tables as soon as we can handle general xx_dup() */
11695 PerlIO_clone(aTHX_ proto_perl, param);
a1ea730d 11696#endif
d2d73c3e
AB
11697
11698 PL_envgv = gv_dup(proto_perl->Ienvgv, param);
11699 PL_incgv = gv_dup(proto_perl->Iincgv, param);
11700 PL_hintgv = gv_dup(proto_perl->Ihintgv, param);
1d7c1841 11701 PL_origfilename = SAVEPV(proto_perl->Iorigfilename);
d2d73c3e
AB
11702 PL_diehook = sv_dup_inc(proto_perl->Idiehook, param);
11703 PL_warnhook = sv_dup_inc(proto_perl->Iwarnhook, param);
1d7c1841
GS
11704
11705 /* switches */
11706 PL_minus_c = proto_perl->Iminus_c;
d2d73c3e 11707 PL_patchlevel = sv_dup_inc(proto_perl->Ipatchlevel, param);
1d7c1841
GS
11708 PL_localpatches = proto_perl->Ilocalpatches;
11709 PL_splitstr = proto_perl->Isplitstr;
11710 PL_preprocess = proto_perl->Ipreprocess;
11711 PL_minus_n = proto_perl->Iminus_n;
11712 PL_minus_p = proto_perl->Iminus_p;
11713 PL_minus_l = proto_perl->Iminus_l;
11714 PL_minus_a = proto_perl->Iminus_a;
11715 PL_minus_F = proto_perl->Iminus_F;
11716 PL_doswitches = proto_perl->Idoswitches;
11717 PL_dowarn = proto_perl->Idowarn;
11718 PL_doextract = proto_perl->Idoextract;
11719 PL_sawampersand = proto_perl->Isawampersand;
11720 PL_unsafe = proto_perl->Iunsafe;
11721 PL_inplace = SAVEPV(proto_perl->Iinplace);
d2d73c3e 11722 PL_e_script = sv_dup_inc(proto_perl->Ie_script, param);
1d7c1841
GS
11723 PL_perldb = proto_perl->Iperldb;
11724 PL_perl_destruct_level = proto_perl->Iperl_destruct_level;
1cbb0781 11725 PL_exit_flags = proto_perl->Iexit_flags;
1d7c1841
GS
11726
11727 /* magical thingies */
11728 /* XXX time(&PL_basetime) when asked for? */
11729 PL_basetime = proto_perl->Ibasetime;
d2d73c3e 11730 PL_formfeed = sv_dup(proto_perl->Iformfeed, param);
1d7c1841
GS
11731
11732 PL_maxsysfd = proto_perl->Imaxsysfd;
11733 PL_multiline = proto_perl->Imultiline;
11734 PL_statusvalue = proto_perl->Istatusvalue;
11735#ifdef VMS
11736 PL_statusvalue_vms = proto_perl->Istatusvalue_vms;
11737#endif
0a378802 11738 PL_encoding = sv_dup(proto_perl->Iencoding, param);
1d7c1841 11739
4a4c6fe3 11740 sv_setpvn(PERL_DEBUG_PAD(0), "", 0); /* For regex debugging. */
1f483ca1
JH
11741 sv_setpvn(PERL_DEBUG_PAD(1), "", 0); /* ext/re needs these */
11742 sv_setpvn(PERL_DEBUG_PAD(2), "", 0); /* even without DEBUGGING. */
4a4c6fe3 11743
d2f185dc
AMS
11744 /* Clone the regex array */
11745 PL_regex_padav = newAV();
11746 {
11747 I32 len = av_len((AV*)proto_perl->Iregex_padav);
11748 SV** regexen = AvARRAY((AV*)proto_perl->Iregex_padav);
0f95fc41
AB
11749 av_push(PL_regex_padav,
11750 sv_dup_inc(regexen[0],param));
11751 for(i = 1; i <= len; i++) {
11752 if(SvREPADTMP(regexen[i])) {
11753 av_push(PL_regex_padav, sv_dup_inc(regexen[i], param));
8cf8f3d1 11754 } else {
0f95fc41
AB
11755 av_push(PL_regex_padav,
11756 SvREFCNT_inc(
8cf8f3d1 11757 newSViv(PTR2IV(re_dup(INT2PTR(REGEXP *,
cbfa9890 11758 SvIVX(regexen[i])), param)))
0f95fc41
AB
11759 ));
11760 }
d2f185dc
AMS
11761 }
11762 }
11763 PL_regex_pad = AvARRAY(PL_regex_padav);
1fcf4c12 11764
1d7c1841 11765 /* shortcuts to various I/O objects */
d2d73c3e
AB
11766 PL_stdingv = gv_dup(proto_perl->Istdingv, param);
11767 PL_stderrgv = gv_dup(proto_perl->Istderrgv, param);
11768 PL_defgv = gv_dup(proto_perl->Idefgv, param);
11769 PL_argvgv = gv_dup(proto_perl->Iargvgv, param);
11770 PL_argvoutgv = gv_dup(proto_perl->Iargvoutgv, param);
11771 PL_argvout_stack = av_dup_inc(proto_perl->Iargvout_stack, param);
1d7c1841
GS
11772
11773 /* shortcuts to regexp stuff */
d2d73c3e 11774 PL_replgv = gv_dup(proto_perl->Ireplgv, param);
1d7c1841
GS
11775
11776 /* shortcuts to misc objects */
d2d73c3e 11777 PL_errgv = gv_dup(proto_perl->Ierrgv, param);
1d7c1841
GS
11778
11779 /* shortcuts to debugging objects */
d2d73c3e
AB
11780 PL_DBgv = gv_dup(proto_perl->IDBgv, param);
11781 PL_DBline = gv_dup(proto_perl->IDBline, param);
11782 PL_DBsub = gv_dup(proto_perl->IDBsub, param);
11783 PL_DBsingle = sv_dup(proto_perl->IDBsingle, param);
11784 PL_DBtrace = sv_dup(proto_perl->IDBtrace, param);
11785 PL_DBsignal = sv_dup(proto_perl->IDBsignal, param);
06492da6 11786 PL_DBassertion = sv_dup(proto_perl->IDBassertion, param);
d2d73c3e
AB
11787 PL_lineary = av_dup(proto_perl->Ilineary, param);
11788 PL_dbargs = av_dup(proto_perl->Idbargs, param);
1d7c1841
GS
11789
11790 /* symbol tables */
d2d73c3e
AB
11791 PL_defstash = hv_dup_inc(proto_perl->Tdefstash, param);
11792 PL_curstash = hv_dup(proto_perl->Tcurstash, param);
d2d73c3e
AB
11793 PL_debstash = hv_dup(proto_perl->Idebstash, param);
11794 PL_globalstash = hv_dup(proto_perl->Iglobalstash, param);
11795 PL_curstname = sv_dup_inc(proto_perl->Icurstname, param);
11796
11797 PL_beginav = av_dup_inc(proto_perl->Ibeginav, param);
ee1c5a4e 11798 PL_beginav_save = av_dup_inc(proto_perl->Ibeginav_save, param);
ece599bd 11799 PL_checkav_save = av_dup_inc(proto_perl->Icheckav_save, param);
d2d73c3e
AB
11800 PL_endav = av_dup_inc(proto_perl->Iendav, param);
11801 PL_checkav = av_dup_inc(proto_perl->Icheckav, param);
11802 PL_initav = av_dup_inc(proto_perl->Iinitav, param);
1d7c1841
GS
11803
11804 PL_sub_generation = proto_perl->Isub_generation;
11805
11806 /* funky return mechanisms */
11807 PL_forkprocess = proto_perl->Iforkprocess;
11808
11809 /* subprocess state */
d2d73c3e 11810 PL_fdpid = av_dup_inc(proto_perl->Ifdpid, param);
1d7c1841
GS
11811
11812 /* internal state */
11813 PL_tainting = proto_perl->Itainting;
7135f00b 11814 PL_taint_warn = proto_perl->Itaint_warn;
1d7c1841
GS
11815 PL_maxo = proto_perl->Imaxo;
11816 if (proto_perl->Iop_mask)
11817 PL_op_mask = SAVEPVN(proto_perl->Iop_mask, PL_maxo);
11818 else
11819 PL_op_mask = Nullch;
06492da6 11820 /* PL_asserting = proto_perl->Iasserting; */
1d7c1841
GS
11821
11822 /* current interpreter roots */
d2d73c3e 11823 PL_main_cv = cv_dup_inc(proto_perl->Imain_cv, param);
1d7c1841
GS
11824 PL_main_root = OpREFCNT_inc(proto_perl->Imain_root);
11825 PL_main_start = proto_perl->Imain_start;
e977893f 11826 PL_eval_root = proto_perl->Ieval_root;
1d7c1841
GS
11827 PL_eval_start = proto_perl->Ieval_start;
11828
11829 /* runtime control stuff */
11830 PL_curcopdb = (COP*)any_dup(proto_perl->Icurcopdb, proto_perl);
11831 PL_copline = proto_perl->Icopline;
11832
11833 PL_filemode = proto_perl->Ifilemode;
11834 PL_lastfd = proto_perl->Ilastfd;
11835 PL_oldname = proto_perl->Ioldname; /* XXX not quite right */
11836 PL_Argv = NULL;
11837 PL_Cmd = Nullch;
11838 PL_gensym = proto_perl->Igensym;
11839 PL_preambled = proto_perl->Ipreambled;
d2d73c3e 11840 PL_preambleav = av_dup_inc(proto_perl->Ipreambleav, param);
1d7c1841
GS
11841 PL_laststatval = proto_perl->Ilaststatval;
11842 PL_laststype = proto_perl->Ilaststype;
11843 PL_mess_sv = Nullsv;
11844
d2d73c3e 11845 PL_ors_sv = sv_dup_inc(proto_perl->Iors_sv, param);
1d7c1841
GS
11846 PL_ofmt = SAVEPV(proto_perl->Iofmt);
11847
11848 /* interpreter atexit processing */
11849 PL_exitlistlen = proto_perl->Iexitlistlen;
11850 if (PL_exitlistlen) {
11851 New(0, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11852 Copy(proto_perl->Iexitlist, PL_exitlist, PL_exitlistlen, PerlExitListEntry);
11853 }
11854 else
11855 PL_exitlist = (PerlExitListEntry*)NULL;
d2d73c3e 11856 PL_modglobal = hv_dup_inc(proto_perl->Imodglobal, param);
19e8ce8e
AB
11857 PL_custom_op_names = hv_dup_inc(proto_perl->Icustom_op_names,param);
11858 PL_custom_op_descs = hv_dup_inc(proto_perl->Icustom_op_descs,param);
1d7c1841
GS
11859
11860 PL_profiledata = NULL;
a8fc9800 11861 PL_rsfp = fp_dup(proto_perl->Irsfp, '<', param);
1d7c1841 11862 /* PL_rsfp_filters entries have fake IoDIRP() */
d2d73c3e 11863 PL_rsfp_filters = av_dup_inc(proto_perl->Irsfp_filters, param);
1d7c1841 11864
d2d73c3e 11865 PL_compcv = cv_dup(proto_perl->Icompcv, param);
dd2155a4
DM
11866
11867 PAD_CLONE_VARS(proto_perl, param);
1d7c1841
GS
11868
11869#ifdef HAVE_INTERP_INTERN
11870 sys_intern_dup(&proto_perl->Isys_intern, &PL_sys_intern);
11871#endif
11872
11873 /* more statics moved here */
11874 PL_generation = proto_perl->Igeneration;
d2d73c3e 11875 PL_DBcv = cv_dup(proto_perl->IDBcv, param);
1d7c1841
GS
11876
11877 PL_in_clean_objs = proto_perl->Iin_clean_objs;
11878 PL_in_clean_all = proto_perl->Iin_clean_all;
11879
11880 PL_uid = proto_perl->Iuid;
11881 PL_euid = proto_perl->Ieuid;
11882 PL_gid = proto_perl->Igid;
11883 PL_egid = proto_perl->Iegid;
11884 PL_nomemok = proto_perl->Inomemok;
11885 PL_an = proto_perl->Ian;
1d7c1841
GS
11886 PL_evalseq = proto_perl->Ievalseq;
11887 PL_origenviron = proto_perl->Iorigenviron; /* XXX not quite right */
11888 PL_origalen = proto_perl->Iorigalen;
11889 PL_pidstatus = newHV(); /* XXX flag for cloning? */
11890 PL_osname = SAVEPV(proto_perl->Iosname);
5c728af0 11891 PL_sh_path_compat = proto_perl->Ish_path_compat; /* XXX never deallocated */
1d7c1841
GS
11892 PL_sighandlerp = proto_perl->Isighandlerp;
11893
11894
11895 PL_runops = proto_perl->Irunops;
11896
11897 Copy(proto_perl->Itokenbuf, PL_tokenbuf, 256, char);
11898
11899#ifdef CSH
11900 PL_cshlen = proto_perl->Icshlen;
74f1b2b8 11901 PL_cshname = proto_perl->Icshname; /* XXX never deallocated */
1d7c1841
GS
11902#endif
11903
11904 PL_lex_state = proto_perl->Ilex_state;
11905 PL_lex_defer = proto_perl->Ilex_defer;
11906 PL_lex_expect = proto_perl->Ilex_expect;
11907 PL_lex_formbrack = proto_perl->Ilex_formbrack;
11908 PL_lex_dojoin = proto_perl->Ilex_dojoin;
11909 PL_lex_starts = proto_perl->Ilex_starts;
d2d73c3e
AB
11910 PL_lex_stuff = sv_dup_inc(proto_perl->Ilex_stuff, param);
11911 PL_lex_repl = sv_dup_inc(proto_perl->Ilex_repl, param);
1d7c1841
GS
11912 PL_lex_op = proto_perl->Ilex_op;
11913 PL_lex_inpat = proto_perl->Ilex_inpat;
11914 PL_lex_inwhat = proto_perl->Ilex_inwhat;
11915 PL_lex_brackets = proto_perl->Ilex_brackets;
11916 i = (PL_lex_brackets < 120 ? 120 : PL_lex_brackets);
11917 PL_lex_brackstack = SAVEPVN(proto_perl->Ilex_brackstack,i);
11918 PL_lex_casemods = proto_perl->Ilex_casemods;
11919 i = (PL_lex_casemods < 12 ? 12 : PL_lex_casemods);
11920 PL_lex_casestack = SAVEPVN(proto_perl->Ilex_casestack,i);
11921
11922 Copy(proto_perl->Inextval, PL_nextval, 5, YYSTYPE);
11923 Copy(proto_perl->Inexttype, PL_nexttype, 5, I32);
11924 PL_nexttoke = proto_perl->Inexttoke;
11925
1d773130
TB
11926 /* XXX This is probably masking the deeper issue of why
11927 * SvANY(proto_perl->Ilinestr) can be NULL at this point. For test case:
11928 * http://archive.develooper.com/perl5-porters%40perl.org/msg83298.html
11929 * (A little debugging with a watchpoint on it may help.)
11930 */
389edf32
TB
11931 if (SvANY(proto_perl->Ilinestr)) {
11932 PL_linestr = sv_dup_inc(proto_perl->Ilinestr, param);
11933 i = proto_perl->Ibufptr - SvPVX(proto_perl->Ilinestr);
11934 PL_bufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11935 i = proto_perl->Ioldbufptr - SvPVX(proto_perl->Ilinestr);
11936 PL_oldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11937 i = proto_perl->Ioldoldbufptr - SvPVX(proto_perl->Ilinestr);
11938 PL_oldoldbufptr = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11939 i = proto_perl->Ilinestart - SvPVX(proto_perl->Ilinestr);
11940 PL_linestart = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11941 }
11942 else {
11943 PL_linestr = NEWSV(65,79);
11944 sv_upgrade(PL_linestr,SVt_PVIV);
11945 sv_setpvn(PL_linestr,"",0);
11946 PL_bufptr = PL_oldbufptr = PL_oldoldbufptr = PL_linestart = SvPVX(PL_linestr);
11947 }
1d7c1841 11948 PL_bufend = SvPVX(PL_linestr) + SvCUR(PL_linestr);
1d7c1841
GS
11949 PL_pending_ident = proto_perl->Ipending_ident;
11950 PL_sublex_info = proto_perl->Isublex_info; /* XXX not quite right */
11951
11952 PL_expect = proto_perl->Iexpect;
11953
11954 PL_multi_start = proto_perl->Imulti_start;
11955 PL_multi_end = proto_perl->Imulti_end;
11956 PL_multi_open = proto_perl->Imulti_open;
11957 PL_multi_close = proto_perl->Imulti_close;
11958
11959 PL_error_count = proto_perl->Ierror_count;
11960 PL_subline = proto_perl->Isubline;
d2d73c3e 11961 PL_subname = sv_dup_inc(proto_perl->Isubname, param);
1d7c1841 11962
1d773130 11963 /* XXX See comment on SvANY(proto_perl->Ilinestr) above */
389edf32
TB
11964 if (SvANY(proto_perl->Ilinestr)) {
11965 i = proto_perl->Ilast_uni - SvPVX(proto_perl->Ilinestr);
11966 PL_last_uni = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11967 i = proto_perl->Ilast_lop - SvPVX(proto_perl->Ilinestr);
11968 PL_last_lop = SvPVX(PL_linestr) + (i < 0 ? 0 : i);
11969 PL_last_lop_op = proto_perl->Ilast_lop_op;
11970 }
11971 else {
11972 PL_last_uni = SvPVX(PL_linestr);
11973 PL_last_lop = SvPVX(PL_linestr);
11974 PL_last_lop_op = 0;
11975 }
1d7c1841 11976 PL_in_my = proto_perl->Iin_my;
d2d73c3e 11977 PL_in_my_stash = hv_dup(proto_perl->Iin_my_stash, param);
1d7c1841
GS
11978#ifdef FCRYPT
11979 PL_cryptseen = proto_perl->Icryptseen;
11980#endif
11981
11982 PL_hints = proto_perl->Ihints;
11983
11984 PL_amagic_generation = proto_perl->Iamagic_generation;
11985
11986#ifdef USE_LOCALE_COLLATE
11987 PL_collation_ix = proto_perl->Icollation_ix;
11988 PL_collation_name = SAVEPV(proto_perl->Icollation_name);
11989 PL_collation_standard = proto_perl->Icollation_standard;
11990 PL_collxfrm_base = proto_perl->Icollxfrm_base;
11991 PL_collxfrm_mult = proto_perl->Icollxfrm_mult;
11992#endif /* USE_LOCALE_COLLATE */
11993
11994#ifdef USE_LOCALE_NUMERIC
11995 PL_numeric_name = SAVEPV(proto_perl->Inumeric_name);
11996 PL_numeric_standard = proto_perl->Inumeric_standard;
11997 PL_numeric_local = proto_perl->Inumeric_local;
d2d73c3e 11998 PL_numeric_radix_sv = sv_dup_inc(proto_perl->Inumeric_radix_sv, param);
1d7c1841
GS
11999#endif /* !USE_LOCALE_NUMERIC */
12000
12001 /* utf8 character classes */
d2d73c3e
AB
12002 PL_utf8_alnum = sv_dup_inc(proto_perl->Iutf8_alnum, param);
12003 PL_utf8_alnumc = sv_dup_inc(proto_perl->Iutf8_alnumc, param);
12004 PL_utf8_ascii = sv_dup_inc(proto_perl->Iutf8_ascii, param);
12005 PL_utf8_alpha = sv_dup_inc(proto_perl->Iutf8_alpha, param);
12006 PL_utf8_space = sv_dup_inc(proto_perl->Iutf8_space, param);
12007 PL_utf8_cntrl = sv_dup_inc(proto_perl->Iutf8_cntrl, param);
12008 PL_utf8_graph = sv_dup_inc(proto_perl->Iutf8_graph, param);
12009 PL_utf8_digit = sv_dup_inc(proto_perl->Iutf8_digit, param);
12010 PL_utf8_upper = sv_dup_inc(proto_perl->Iutf8_upper, param);
12011 PL_utf8_lower = sv_dup_inc(proto_perl->Iutf8_lower, param);
12012 PL_utf8_print = sv_dup_inc(proto_perl->Iutf8_print, param);
12013 PL_utf8_punct = sv_dup_inc(proto_perl->Iutf8_punct, param);
12014 PL_utf8_xdigit = sv_dup_inc(proto_perl->Iutf8_xdigit, param);
12015 PL_utf8_mark = sv_dup_inc(proto_perl->Iutf8_mark, param);
12016 PL_utf8_toupper = sv_dup_inc(proto_perl->Iutf8_toupper, param);
12017 PL_utf8_totitle = sv_dup_inc(proto_perl->Iutf8_totitle, param);
12018 PL_utf8_tolower = sv_dup_inc(proto_perl->Iutf8_tolower, param);
b4e400f9 12019 PL_utf8_tofold = sv_dup_inc(proto_perl->Iutf8_tofold, param);
82686b01
JH
12020 PL_utf8_idstart = sv_dup_inc(proto_perl->Iutf8_idstart, param);
12021 PL_utf8_idcont = sv_dup_inc(proto_perl->Iutf8_idcont, param);
1d7c1841 12022
6c3182a5 12023 /* Did the locale setup indicate UTF-8? */
9769094f 12024 PL_utf8locale = proto_perl->Iutf8locale;
6c3182a5
JH
12025 /* Unicode features (see perlrun/-C) */
12026 PL_unicode = proto_perl->Iunicode;
12027
12028 /* Pre-5.8 signals control */
12029 PL_signals = proto_perl->Isignals;
12030
12031 /* times() ticks per second */
12032 PL_clocktick = proto_perl->Iclocktick;
12033
12034 /* Recursion stopper for PerlIO_find_layer */
12035 PL_in_load_module = proto_perl->Iin_load_module;
12036
12037 /* sort() routine */
12038 PL_sort_RealCmp = proto_perl->Isort_RealCmp;
12039
57c6e6d2
JH
12040 /* Not really needed/useful since the reenrant_retint is "volatile",
12041 * but do it for consistency's sake. */
12042 PL_reentrant_retint = proto_perl->Ireentrant_retint;
12043
15a5279a
JH
12044 /* Hooks to shared SVs and locks. */
12045 PL_sharehook = proto_perl->Isharehook;
12046 PL_lockhook = proto_perl->Ilockhook;
12047 PL_unlockhook = proto_perl->Iunlockhook;
12048 PL_threadhook = proto_perl->Ithreadhook;
12049
bce260cd
JH
12050 PL_runops_std = proto_perl->Irunops_std;
12051 PL_runops_dbg = proto_perl->Irunops_dbg;
12052
12053#ifdef THREADS_HAVE_PIDS
12054 PL_ppid = proto_perl->Ippid;
12055#endif
12056
1d7c1841
GS
12057 /* swatch cache */
12058 PL_last_swash_hv = Nullhv; /* reinits on demand */
12059 PL_last_swash_klen = 0;
12060 PL_last_swash_key[0]= '\0';
12061 PL_last_swash_tmps = (U8*)NULL;
12062 PL_last_swash_slen = 0;
12063
1d7c1841
GS
12064 PL_glob_index = proto_perl->Iglob_index;
12065 PL_srand_called = proto_perl->Isrand_called;
504f80c1 12066 PL_hash_seed = proto_perl->Ihash_seed;
008fb0c0 12067 PL_rehash_seed = proto_perl->Irehash_seed;
1d7c1841
GS
12068 PL_uudmap['M'] = 0; /* reinits on demand */
12069 PL_bitcount = Nullch; /* reinits on demand */
12070
66fe0623
NIS
12071 if (proto_perl->Ipsig_pend) {
12072 Newz(0, PL_psig_pend, SIG_SIZE, int);
9dd79c3f 12073 }
66fe0623
NIS
12074 else {
12075 PL_psig_pend = (int*)NULL;
12076 }
12077
1d7c1841 12078 if (proto_perl->Ipsig_ptr) {
76d3c696
JH
12079 Newz(0, PL_psig_ptr, SIG_SIZE, SV*);
12080 Newz(0, PL_psig_name, SIG_SIZE, SV*);
76d3c696 12081 for (i = 1; i < SIG_SIZE; i++) {
d2d73c3e
AB
12082 PL_psig_ptr[i] = sv_dup_inc(proto_perl->Ipsig_ptr[i], param);
12083 PL_psig_name[i] = sv_dup_inc(proto_perl->Ipsig_name[i], param);
1d7c1841
GS
12084 }
12085 }
12086 else {
12087 PL_psig_ptr = (SV**)NULL;
12088 PL_psig_name = (SV**)NULL;
12089 }
12090
12091 /* thrdvar.h stuff */
12092
a0739874 12093 if (flags & CLONEf_COPY_STACKS) {
1d7c1841
GS
12094 /* next allocation will be PL_tmps_stack[PL_tmps_ix+1] */
12095 PL_tmps_ix = proto_perl->Ttmps_ix;
12096 PL_tmps_max = proto_perl->Ttmps_max;
12097 PL_tmps_floor = proto_perl->Ttmps_floor;
12098 Newz(50, PL_tmps_stack, PL_tmps_max, SV*);
12099 i = 0;
12100 while (i <= PL_tmps_ix) {
d2d73c3e 12101 PL_tmps_stack[i] = sv_dup_inc(proto_perl->Ttmps_stack[i], param);
1d7c1841
GS
12102 ++i;
12103 }
12104
12105 /* next PUSHMARK() sets *(PL_markstack_ptr+1) */
12106 i = proto_perl->Tmarkstack_max - proto_perl->Tmarkstack;
12107 Newz(54, PL_markstack, i, I32);
12108 PL_markstack_max = PL_markstack + (proto_perl->Tmarkstack_max
12109 - proto_perl->Tmarkstack);
12110 PL_markstack_ptr = PL_markstack + (proto_perl->Tmarkstack_ptr
12111 - proto_perl->Tmarkstack);
12112 Copy(proto_perl->Tmarkstack, PL_markstack,
12113 PL_markstack_ptr - PL_markstack + 1, I32);
12114
12115 /* next push_scope()/ENTER sets PL_scopestack[PL_scopestack_ix]
12116 * NOTE: unlike the others! */
12117 PL_scopestack_ix = proto_perl->Tscopestack_ix;
12118 PL_scopestack_max = proto_perl->Tscopestack_max;
12119 Newz(54, PL_scopestack, PL_scopestack_max, I32);
12120 Copy(proto_perl->Tscopestack, PL_scopestack, PL_scopestack_ix, I32);
12121
1d7c1841 12122 /* NOTE: si_dup() looks at PL_markstack */
d2d73c3e 12123 PL_curstackinfo = si_dup(proto_perl->Tcurstackinfo, param);
1d7c1841
GS
12124
12125 /* PL_curstack = PL_curstackinfo->si_stack; */
d2d73c3e
AB
12126 PL_curstack = av_dup(proto_perl->Tcurstack, param);
12127 PL_mainstack = av_dup(proto_perl->Tmainstack, param);
1d7c1841
GS
12128
12129 /* next PUSHs() etc. set *(PL_stack_sp+1) */
12130 PL_stack_base = AvARRAY(PL_curstack);
12131 PL_stack_sp = PL_stack_base + (proto_perl->Tstack_sp
12132 - proto_perl->Tstack_base);
12133 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
12134
12135 /* next SSPUSHFOO() sets PL_savestack[PL_savestack_ix]
12136 * NOTE: unlike the others! */
12137 PL_savestack_ix = proto_perl->Tsavestack_ix;
12138 PL_savestack_max = proto_perl->Tsavestack_max;
12139 /*Newz(54, PL_savestack, PL_savestack_max, ANY);*/
d2d73c3e 12140 PL_savestack = ss_dup(proto_perl, param);
1d7c1841
GS
12141 }
12142 else {
12143 init_stacks();
985e7056 12144 ENTER; /* perl_destruct() wants to LEAVE; */
1d7c1841
GS
12145 }
12146
12147 PL_start_env = proto_perl->Tstart_env; /* XXXXXX */
12148 PL_top_env = &PL_start_env;
12149
12150 PL_op = proto_perl->Top;
12151
12152 PL_Sv = Nullsv;
12153 PL_Xpv = (XPV*)NULL;
12154 PL_na = proto_perl->Tna;
12155
12156 PL_statbuf = proto_perl->Tstatbuf;
12157 PL_statcache = proto_perl->Tstatcache;
d2d73c3e
AB
12158 PL_statgv = gv_dup(proto_perl->Tstatgv, param);
12159 PL_statname = sv_dup_inc(proto_perl->Tstatname, param);
1d7c1841
GS
12160#ifdef HAS_TIMES
12161 PL_timesbuf = proto_perl->Ttimesbuf;
12162#endif
12163
12164 PL_tainted = proto_perl->Ttainted;
12165 PL_curpm = proto_perl->Tcurpm; /* XXX No PMOP ref count */
d2d73c3e
AB
12166 PL_rs = sv_dup_inc(proto_perl->Trs, param);
12167 PL_last_in_gv = gv_dup(proto_perl->Tlast_in_gv, param);
12168 PL_ofs_sv = sv_dup_inc(proto_perl->Tofs_sv, param);
12169 PL_defoutgv = gv_dup_inc(proto_perl->Tdefoutgv, param);
1d7c1841 12170 PL_chopset = proto_perl->Tchopset; /* XXX never deallocated */
d2d73c3e
AB
12171 PL_toptarget = sv_dup_inc(proto_perl->Ttoptarget, param);
12172 PL_bodytarget = sv_dup_inc(proto_perl->Tbodytarget, param);
12173 PL_formtarget = sv_dup(proto_perl->Tformtarget, param);
1d7c1841
GS
12174
12175 PL_restartop = proto_perl->Trestartop;
12176 PL_in_eval = proto_perl->Tin_eval;
12177 PL_delaymagic = proto_perl->Tdelaymagic;
12178 PL_dirty = proto_perl->Tdirty;
12179 PL_localizing = proto_perl->Tlocalizing;
12180
14dd3ad8 12181#ifdef PERL_FLEXIBLE_EXCEPTIONS
1d7c1841 12182 PL_protect = proto_perl->Tprotect;
14dd3ad8 12183#endif
d2d73c3e 12184 PL_errors = sv_dup_inc(proto_perl->Terrors, param);
dd28f7bb 12185 PL_hv_fetch_ent_mh = Nullhe;
1d7c1841
GS
12186 PL_modcount = proto_perl->Tmodcount;
12187 PL_lastgotoprobe = Nullop;
12188 PL_dumpindent = proto_perl->Tdumpindent;
12189
12190 PL_sortcop = (OP*)any_dup(proto_perl->Tsortcop, proto_perl);
d2d73c3e
AB
12191 PL_sortstash = hv_dup(proto_perl->Tsortstash, param);
12192 PL_firstgv = gv_dup(proto_perl->Tfirstgv, param);
12193 PL_secondgv = gv_dup(proto_perl->Tsecondgv, param);
1d7c1841
GS
12194 PL_sortcxix = proto_perl->Tsortcxix;
12195 PL_efloatbuf = Nullch; /* reinits on demand */
12196 PL_efloatsize = 0; /* reinits on demand */
12197
12198 /* regex stuff */
12199
12200 PL_screamfirst = NULL;
12201 PL_screamnext = NULL;
12202 PL_maxscream = -1; /* reinits on demand */
12203 PL_lastscream = Nullsv;
12204
12205 PL_watchaddr = NULL;
12206 PL_watchok = Nullch;
12207
12208 PL_regdummy = proto_perl->Tregdummy;
1d7c1841
GS
12209 PL_regprecomp = Nullch;
12210 PL_regnpar = 0;
12211 PL_regsize = 0;
1d7c1841
GS
12212 PL_colorset = 0; /* reinits PL_colors[] */
12213 /*PL_colors[6] = {0,0,0,0,0,0};*/
1d7c1841
GS
12214 PL_reginput = Nullch;
12215 PL_regbol = Nullch;
12216 PL_regeol = Nullch;
12217 PL_regstartp = (I32*)NULL;
12218 PL_regendp = (I32*)NULL;
12219 PL_reglastparen = (U32*)NULL;
2d862feb 12220 PL_reglastcloseparen = (U32*)NULL;
1d7c1841 12221 PL_regtill = Nullch;
1d7c1841
GS
12222 PL_reg_start_tmp = (char**)NULL;
12223 PL_reg_start_tmpl = 0;
12224 PL_regdata = (struct reg_data*)NULL;
12225 PL_bostr = Nullch;
12226 PL_reg_flags = 0;
12227 PL_reg_eval_set = 0;
12228 PL_regnarrate = 0;
12229 PL_regprogram = (regnode*)NULL;
12230 PL_regindent = 0;
12231 PL_regcc = (CURCUR*)NULL;
12232 PL_reg_call_cc = (struct re_cc_state*)NULL;
12233 PL_reg_re = (regexp*)NULL;
12234 PL_reg_ganch = Nullch;
12235 PL_reg_sv = Nullsv;
53c4c00c 12236 PL_reg_match_utf8 = FALSE;
1d7c1841
GS
12237 PL_reg_magic = (MAGIC*)NULL;
12238 PL_reg_oldpos = 0;
12239 PL_reg_oldcurpm = (PMOP*)NULL;
12240 PL_reg_curpm = (PMOP*)NULL;
12241 PL_reg_oldsaved = Nullch;
12242 PL_reg_oldsavedlen = 0;
ed252734 12243#ifdef PERL_COPY_ON_WRITE
504cff3b 12244 PL_nrs = Nullsv;
ed252734 12245#endif
1d7c1841
GS
12246 PL_reg_maxiter = 0;
12247 PL_reg_leftiter = 0;
12248 PL_reg_poscache = Nullch;
12249 PL_reg_poscache_size= 0;
12250
12251 /* RE engine - function pointers */
12252 PL_regcompp = proto_perl->Tregcompp;
12253 PL_regexecp = proto_perl->Tregexecp;
12254 PL_regint_start = proto_perl->Tregint_start;
12255 PL_regint_string = proto_perl->Tregint_string;
12256 PL_regfree = proto_perl->Tregfree;
12257
12258 PL_reginterp_cnt = 0;
12259 PL_reg_starttry = 0;
12260
a2efc822
SC
12261 /* Pluggable optimizer */
12262 PL_peepp = proto_perl->Tpeepp;
12263
081fc587
AB
12264 PL_stashcache = newHV();
12265
a0739874
DM
12266 if (!(flags & CLONEf_KEEP_PTR_TABLE)) {
12267 ptr_table_free(PL_ptr_table);
12268 PL_ptr_table = NULL;
12269 }
8cf8f3d1 12270
f284b03f
AMS
12271 /* Call the ->CLONE method, if it exists, for each of the stashes
12272 identified by sv_dup() above.
12273 */
d2d73c3e
AB
12274 while(av_len(param->stashes) != -1) {
12275 HV* stash = (HV*) av_shift(param->stashes);
f284b03f
AMS
12276 GV* cloner = gv_fetchmethod_autoload(stash, "CLONE", 0);
12277 if (cloner && GvCV(cloner)) {
12278 dSP;
12279 ENTER;
12280 SAVETMPS;
12281 PUSHMARK(SP);
dc507217 12282 XPUSHs(sv_2mortal(newSVpv(HvNAME(stash), 0)));
f284b03f
AMS
12283 PUTBACK;
12284 call_sv((SV*)GvCV(cloner), G_DISCARD);
12285 FREETMPS;
12286 LEAVE;
12287 }
4a09accc 12288 }
a0739874 12289
dc507217 12290 SvREFCNT_dec(param->stashes);
dc507217 12291
1d7c1841 12292 return my_perl;
1d7c1841
GS
12293}
12294
1d7c1841 12295#endif /* USE_ITHREADS */
a0ae6670 12296
9f4817db 12297/*
ccfc67b7
JH
12298=head1 Unicode Support
12299
9f4817db
JH
12300=for apidoc sv_recode_to_utf8
12301
5d170f3a
JH
12302The encoding is assumed to be an Encode object, on entry the PV
12303of the sv is assumed to be octets in that encoding, and the sv
12304will be converted into Unicode (and UTF-8).
9f4817db 12305
5d170f3a
JH
12306If the sv already is UTF-8 (or if it is not POK), or if the encoding
12307is not a reference, nothing is done to the sv. If the encoding is not
1768d7eb
JH
12308an C<Encode::XS> Encoding object, bad things will happen.
12309(See F<lib/encoding.pm> and L<Encode>).
9f4817db 12310
5d170f3a 12311The PV of the sv is returned.
9f4817db 12312
5d170f3a
JH
12313=cut */
12314
12315char *
12316Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
12317{
220e2d4e 12318 if (SvPOK(sv) && !SvUTF8(sv) && !IN_BYTES && SvROK(encoding)) {
d0063567
DK
12319 SV *uni;
12320 STRLEN len;
12321 char *s;
12322 dSP;
12323 ENTER;
12324 SAVETMPS;
220e2d4e 12325 save_re_context();
d0063567
DK
12326 PUSHMARK(sp);
12327 EXTEND(SP, 3);
12328 XPUSHs(encoding);
12329 XPUSHs(sv);
7a5fa8a2 12330/*
f9893866
NIS
12331 NI-S 2002/07/09
12332 Passing sv_yes is wrong - it needs to be or'ed set of constants
7a5fa8a2 12333 for Encode::XS, while UTf-8 decode (currently) assumes a true value means
f9893866
NIS
12334 remove converted chars from source.
12335
12336 Both will default the value - let them.
7a5fa8a2 12337
d0063567 12338 XPUSHs(&PL_sv_yes);
f9893866 12339*/
d0063567
DK
12340 PUTBACK;
12341 call_method("decode", G_SCALAR);
12342 SPAGAIN;
12343 uni = POPs;
12344 PUTBACK;
12345 s = SvPV(uni, len);
d0063567
DK
12346 if (s != SvPVX(sv)) {
12347 SvGROW(sv, len + 1);
12348 Move(s, SvPVX(sv), len, char);
12349 SvCUR_set(sv, len);
12350 SvPVX(sv)[len] = 0;
12351 }
12352 FREETMPS;
12353 LEAVE;
d0063567 12354 SvUTF8_on(sv);
95899a2a 12355 return SvPVX(sv);
f9893866 12356 }
95899a2a 12357 return SvPOKp(sv) ? SvPVX(sv) : NULL;
9f4817db
JH
12358}
12359
220e2d4e
IH
12360/*
12361=for apidoc sv_cat_decode
12362
12363The encoding is assumed to be an Encode object, the PV of the ssv is
12364assumed to be octets in that encoding and decoding the input starts
12365from the position which (PV + *offset) pointed to. The dsv will be
12366concatenated the decoded UTF-8 string from ssv. Decoding will terminate
12367when the string tstr appears in decoding output or the input ends on
12368the PV of the ssv. The value which the offset points will be modified
12369to the last input position on the ssv.
68795e93 12370
220e2d4e
IH
12371Returns TRUE if the terminator was found, else returns FALSE.
12372
12373=cut */
12374
12375bool
12376Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding,
12377 SV *ssv, int *offset, char *tstr, int tlen)
12378{
a73e8557 12379 bool ret = FALSE;
220e2d4e 12380 if (SvPOK(ssv) && SvPOK(dsv) && SvROK(encoding) && offset) {
220e2d4e
IH
12381 SV *offsv;
12382 dSP;
12383 ENTER;
12384 SAVETMPS;
12385 save_re_context();
12386 PUSHMARK(sp);
12387 EXTEND(SP, 6);
12388 XPUSHs(encoding);
12389 XPUSHs(dsv);
12390 XPUSHs(ssv);
12391 XPUSHs(offsv = sv_2mortal(newSViv(*offset)));
12392 XPUSHs(sv_2mortal(newSVpvn(tstr, tlen)));
12393 PUTBACK;
12394 call_method("cat_decode", G_SCALAR);
12395 SPAGAIN;
12396 ret = SvTRUE(TOPs);
12397 *offset = SvIV(offsv);
12398 PUTBACK;
12399 FREETMPS;
12400 LEAVE;
220e2d4e 12401 }
a73e8557
JH
12402 else
12403 Perl_croak(aTHX_ "Invalid argument to sv_cat_decode");
12404 return ret;
220e2d4e 12405}
f9893866 12406