7674af59934c2574ab3191983ecd635f95daab9b
[platform/upstream/perl.git] / doop.c
1 /*    doop.c
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4  *    2001, 2002, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
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  *
9  */
10
11 /*
12  *  'So that was the job I felt I had to do when I started,' thought Sam.
13  *
14  *     [p.934 of _The Lord of the Rings_, VI/iii: "Mount Doom"]
15  */
16
17 /* This file contains some common functions needed to carry out certain
18  * ops. For example, both pp_sprintf() and pp_prtf() call the function
19  * do_sprintf() found in this file.
20  */
21
22 #include "EXTERN.h"
23 #define PERL_IN_DOOP_C
24 #include "perl.h"
25
26 #ifndef PERL_MICRO
27 #include <signal.h>
28 #endif
29
30 STATIC I32
31 S_do_trans_simple(pTHX_ SV * const sv)
32 {
33     I32 matches = 0;
34     STRLEN len;
35     U8 *s = (U8*)SvPV_nomg(sv,len);
36     U8 * const send = s+len;
37     const short * const tbl = (short*)cPVOP->op_pv;
38
39     PERL_ARGS_ASSERT_DO_TRANS_SIMPLE;
40
41     if (!tbl)
42         Perl_croak(aTHX_ "panic: do_trans_simple line %d",__LINE__);
43
44     /* First, take care of non-UTF-8 input strings, because they're easy */
45     if (!SvUTF8(sv)) {
46         while (s < send) {
47             const I32 ch = tbl[*s];
48             if (ch >= 0) {
49                 matches++;
50                 *s = (U8)ch;
51             }
52             s++;
53         }
54         SvSETMAGIC(sv);
55     }
56     else {
57         const I32 grows = PL_op->op_private & OPpTRANS_GROWS;
58         U8 *d;
59         U8 *dstart;
60
61         /* Allow for expansion: $_="a".chr(400); tr/a/\xFE/, FE needs encoding */
62         if (grows)
63             Newx(d, len*2+1, U8);
64         else
65             d = s;
66         dstart = d;
67         while (s < send) {
68             STRLEN ulen;
69             I32 ch;
70
71             /* Need to check this, otherwise 128..255 won't match */
72             const UV c = utf8n_to_uvchr(s, send - s, &ulen, UTF8_ALLOW_DEFAULT);
73             if (c < 0x100 && (ch = tbl[c]) >= 0) {
74                 matches++;
75                 d = uvchr_to_utf8(d, ch);
76                 s += ulen;
77             }
78             else { /* No match -> copy */
79                 Move(s, d, ulen, U8);
80                 d += ulen;
81                 s += ulen;
82             }
83         }
84         if (grows) {
85             sv_setpvn(sv, (char*)dstart, d - dstart);
86             Safefree(dstart);
87         }
88         else {
89             *d = '\0';
90             SvCUR_set(sv, d - dstart);
91         }
92         SvUTF8_on(sv);
93         SvSETMAGIC(sv);
94     }
95     return matches;
96 }
97
98 STATIC I32
99 S_do_trans_count(pTHX_ SV * const sv)
100 {
101     STRLEN len;
102     const U8 *s = (const U8*)SvPV_nomg_const(sv, len);
103     const U8 * const send = s + len;
104     I32 matches = 0;
105     const short * const tbl = (short*)cPVOP->op_pv;
106
107     PERL_ARGS_ASSERT_DO_TRANS_COUNT;
108
109     if (!tbl)
110         Perl_croak(aTHX_ "panic: do_trans_count line %d",__LINE__);
111
112     if (!SvUTF8(sv)) {
113         while (s < send) {
114             if (tbl[*s++] >= 0)
115                 matches++;
116         }
117     }
118     else {
119         const I32 complement = PL_op->op_private & OPpTRANS_COMPLEMENT;
120         while (s < send) {
121             STRLEN ulen;
122             const UV c = utf8n_to_uvchr(s, send - s, &ulen, UTF8_ALLOW_DEFAULT);
123             if (c < 0x100) {
124                 if (tbl[c] >= 0)
125                     matches++;
126             } else if (complement)
127                 matches++;
128             s += ulen;
129         }
130     }
131
132     return matches;
133 }
134
135 STATIC I32
136 S_do_trans_complex(pTHX_ SV * const sv)
137 {
138     STRLEN len;
139     U8 *s = (U8*)SvPV_nomg(sv, len);
140     U8 * const send = s+len;
141     I32 matches = 0;
142     const short * const tbl = (short*)cPVOP->op_pv;
143
144     PERL_ARGS_ASSERT_DO_TRANS_COMPLEX;
145
146     if (!tbl)
147         Perl_croak(aTHX_ "panic: do_trans_complex line %d",__LINE__);
148
149     if (!SvUTF8(sv)) {
150         U8 *d = s;
151         U8 * const dstart = d;
152
153         if (PL_op->op_private & OPpTRANS_SQUASH) {
154             const U8* p = send;
155             while (s < send) {
156                 const I32 ch = tbl[*s];
157                 if (ch >= 0) {
158                     *d = (U8)ch;
159                     matches++;
160                     if (p != d - 1 || *p != *d)
161                         p = d++;
162                 }
163                 else if (ch == -1)      /* -1 is unmapped character */
164                     *d++ = *s;  
165                 else if (ch == -2)      /* -2 is delete character */
166                     matches++;
167                 s++;
168             }
169         }
170         else {
171             while (s < send) {
172                 const I32 ch = tbl[*s];
173                 if (ch >= 0) {
174                     matches++;
175                     *d++ = (U8)ch;
176                 }
177                 else if (ch == -1)      /* -1 is unmapped character */
178                     *d++ = *s;
179                 else if (ch == -2)      /* -2 is delete character */
180                     matches++;
181                 s++;
182             }
183         }
184         *d = '\0';
185         SvCUR_set(sv, d - dstart);
186     }
187     else { /* is utf8 */
188         const I32 complement = PL_op->op_private & OPpTRANS_COMPLEMENT;
189         const I32 grows = PL_op->op_private & OPpTRANS_GROWS;
190         const I32 del = PL_op->op_private & OPpTRANS_DELETE;
191         U8 *d;
192         U8 *dstart;
193         STRLEN rlen = 0;
194
195         if (grows)
196             Newx(d, len*2+1, U8);
197         else
198             d = s;
199         dstart = d;
200         if (complement && !del)
201             rlen = tbl[0x100];
202
203         if (PL_op->op_private & OPpTRANS_SQUASH) {
204             UV pch = 0xfeedface;
205             while (s < send) {
206                 STRLEN len;
207                 const UV comp = utf8n_to_uvchr(s, send - s, &len,
208                                                UTF8_ALLOW_DEFAULT);
209                 I32 ch;
210
211                 if (comp > 0xff) {
212                     if (!complement) {
213                         Move(s, d, len, U8);
214                         d += len;
215                     }
216                     else {
217                         matches++;
218                         if (!del) {
219                             ch = (rlen == 0) ? (I32)comp :
220                                 (comp - 0x100 < rlen) ?
221                                 tbl[comp+1] : tbl[0x100+rlen];
222                             if ((UV)ch != pch) {
223                                 d = uvchr_to_utf8(d, ch);
224                                 pch = (UV)ch;
225                             }
226                             s += len;
227                             continue;
228                         }
229                     }
230                 }
231                 else if ((ch = tbl[comp]) >= 0) {
232                     matches++;
233                     if ((UV)ch != pch) {
234                         d = uvchr_to_utf8(d, ch);
235                         pch = (UV)ch;
236                     }
237                     s += len;
238                     continue;
239                 }
240                 else if (ch == -1) {    /* -1 is unmapped character */
241                     Move(s, d, len, U8);
242                     d += len;
243                 }
244                 else if (ch == -2)      /* -2 is delete character */
245                     matches++;
246                 s += len;
247                 pch = 0xfeedface;
248             }
249         }
250         else {
251             while (s < send) {
252                 STRLEN len;
253                 const UV comp = utf8n_to_uvchr(s, send - s, &len,
254                                                UTF8_ALLOW_DEFAULT);
255                 I32 ch;
256                 if (comp > 0xff) {
257                     if (!complement) {
258                         Move(s, d, len, U8);
259                         d += len;
260                     }
261                     else {
262                         matches++;
263                         if (!del) {
264                             if (comp - 0x100 < rlen)
265                                 d = uvchr_to_utf8(d, tbl[comp+1]);
266                             else
267                                 d = uvchr_to_utf8(d, tbl[0x100+rlen]);
268                         }
269                     }
270                 }
271                 else if ((ch = tbl[comp]) >= 0) {
272                     d = uvchr_to_utf8(d, ch);
273                     matches++;
274                 }
275                 else if (ch == -1) {    /* -1 is unmapped character */
276                     Move(s, d, len, U8);
277                     d += len;
278                 }
279                 else if (ch == -2)      /* -2 is delete character */
280                     matches++;
281                 s += len;
282             }
283         }
284         if (grows) {
285             sv_setpvn(sv, (char*)dstart, d - dstart);
286             Safefree(dstart);
287         }
288         else {
289             *d = '\0';
290             SvCUR_set(sv, d - dstart);
291         }
292         SvUTF8_on(sv);
293     }
294     SvSETMAGIC(sv);
295     return matches;
296 }
297
298 STATIC I32
299 S_do_trans_simple_utf8(pTHX_ SV * const sv)
300 {
301     U8 *s;
302     U8 *send;
303     U8 *d;
304     U8 *start;
305     U8 *dstart, *dend;
306     I32 matches = 0;
307     const I32 grows = PL_op->op_private & OPpTRANS_GROWS;
308     STRLEN len;
309     SV* const  rv =
310 #ifdef USE_ITHREADS
311                     PAD_SVl(cPADOP->op_padix);
312 #else
313                     MUTABLE_SV(cSVOP->op_sv);
314 #endif
315     HV* const  hv = MUTABLE_HV(SvRV(rv));
316     SV* const * svp = hv_fetchs(hv, "NONE", FALSE);
317     const UV none = svp ? SvUV(*svp) : 0x7fffffff;
318     const UV extra = none + 1;
319     UV final = 0;
320     U8 hibit = 0;
321
322     PERL_ARGS_ASSERT_DO_TRANS_SIMPLE_UTF8;
323
324     s = (U8*)SvPV_nomg(sv, len);
325     if (!SvUTF8(sv)) {
326         const U8 *t = s;
327         const U8 * const e = s + len;
328         while (t < e) {
329             const U8 ch = *t++;
330             hibit = !NATIVE_BYTE_IS_INVARIANT(ch);
331             if (hibit) {
332                 s = bytes_to_utf8(s, &len);
333                 break;
334             }
335         }
336     }
337     send = s + len;
338     start = s;
339
340     svp = hv_fetchs(hv, "FINAL", FALSE);
341     if (svp)
342         final = SvUV(*svp);
343
344     if (grows) {
345         /* d needs to be bigger than s, in case e.g. upgrading is required */
346         Newx(d, len * 3 + UTF8_MAXBYTES, U8);
347         dend = d + len * 3;
348         dstart = d;
349     }
350     else {
351         dstart = d = s;
352         dend = d + len;
353     }
354
355     while (s < send) {
356         const UV uv = swash_fetch(rv, s, TRUE);
357         if (uv < none) {
358             s += UTF8SKIP(s);
359             matches++;
360             d = uvchr_to_utf8(d, uv);
361         }
362         else if (uv == none) {
363             const int i = UTF8SKIP(s);
364             Move(s, d, i, U8);
365             d += i;
366             s += i;
367         }
368         else if (uv == extra) {
369             s += UTF8SKIP(s);
370             matches++;
371             d = uvchr_to_utf8(d, final);
372         }
373         else
374             s += UTF8SKIP(s);
375
376         if (d > dend) {
377             const STRLEN clen = d - dstart;
378             const STRLEN nlen = dend - dstart + len + UTF8_MAXBYTES;
379             if (!grows)
380                 Perl_croak(aTHX_ "panic: do_trans_simple_utf8 line %d",__LINE__);
381             Renew(dstart, nlen + UTF8_MAXBYTES, U8);
382             d = dstart + clen;
383             dend = dstart + nlen;
384         }
385     }
386     if (grows || hibit) {
387         sv_setpvn(sv, (char*)dstart, d - dstart);
388         Safefree(dstart);
389         if (grows && hibit)
390             Safefree(start);
391     }
392     else {
393         *d = '\0';
394         SvCUR_set(sv, d - dstart);
395     }
396     SvSETMAGIC(sv);
397     SvUTF8_on(sv);
398
399     return matches;
400 }
401
402 STATIC I32
403 S_do_trans_count_utf8(pTHX_ SV * const sv)
404 {
405     const U8 *s;
406     const U8 *start = NULL;
407     const U8 *send;
408     I32 matches = 0;
409     STRLEN len;
410     SV* const  rv =
411 #ifdef USE_ITHREADS
412                     PAD_SVl(cPADOP->op_padix);
413 #else
414                     MUTABLE_SV(cSVOP->op_sv);
415 #endif
416     HV* const hv = MUTABLE_HV(SvRV(rv));
417     SV* const * const svp = hv_fetchs(hv, "NONE", FALSE);
418     const UV none = svp ? SvUV(*svp) : 0x7fffffff;
419     const UV extra = none + 1;
420     U8 hibit = 0;
421
422     PERL_ARGS_ASSERT_DO_TRANS_COUNT_UTF8;
423
424     s = (const U8*)SvPV_nomg_const(sv, len);
425     if (!SvUTF8(sv)) {
426         const U8 *t = s;
427         const U8 * const e = s + len;
428         while (t < e) {
429             const U8 ch = *t++;
430             hibit = !NATIVE_BYTE_IS_INVARIANT(ch);
431             if (hibit) {
432                 start = s = bytes_to_utf8(s, &len);
433                 break;
434             }
435         }
436     }
437     send = s + len;
438
439     while (s < send) {
440         const UV uv = swash_fetch(rv, s, TRUE);
441         if (uv < none || uv == extra)
442             matches++;
443         s += UTF8SKIP(s);
444     }
445     if (hibit)
446         Safefree(start);
447
448     return matches;
449 }
450
451 STATIC I32
452 S_do_trans_complex_utf8(pTHX_ SV * const sv)
453 {
454     U8 *start, *send;
455     U8 *d;
456     I32 matches = 0;
457     const I32 squash   = PL_op->op_private & OPpTRANS_SQUASH;
458     const I32 del      = PL_op->op_private & OPpTRANS_DELETE;
459     const I32 grows    = PL_op->op_private & OPpTRANS_GROWS;
460     SV* const  rv =
461 #ifdef USE_ITHREADS
462                     PAD_SVl(cPADOP->op_padix);
463 #else
464                     MUTABLE_SV(cSVOP->op_sv);
465 #endif
466     HV * const hv = MUTABLE_HV(SvRV(rv));
467     SV * const *svp = hv_fetchs(hv, "NONE", FALSE);
468     const UV none = svp ? SvUV(*svp) : 0x7fffffff;
469     const UV extra = none + 1;
470     UV final = 0;
471     bool havefinal = FALSE;
472     STRLEN len;
473     U8 *dstart, *dend;
474     U8 hibit = 0;
475     U8 *s = (U8*)SvPV_nomg(sv, len);
476
477     PERL_ARGS_ASSERT_DO_TRANS_COMPLEX_UTF8;
478
479     if (!SvUTF8(sv)) {
480         const U8 *t = s;
481         const U8 * const e = s + len;
482         while (t < e) {
483             const U8 ch = *t++;
484             hibit = !NATIVE_BYTE_IS_INVARIANT(ch);
485             if (hibit) {
486                 s = bytes_to_utf8(s, &len);
487                 break;
488             }
489         }
490     }
491     send = s + len;
492     start = s;
493
494     svp = hv_fetchs(hv, "FINAL", FALSE);
495     if (svp) {
496         final = SvUV(*svp);
497         havefinal = TRUE;
498     }
499
500     if (grows) {
501         /* d needs to be bigger than s, in case e.g. upgrading is required */
502         Newx(d, len * 3 + UTF8_MAXBYTES, U8);
503         dend = d + len * 3;
504         dstart = d;
505     }
506     else {
507         dstart = d = s;
508         dend = d + len;
509     }
510
511     if (squash) {
512         UV puv = 0xfeedface;
513         while (s < send) {
514             UV uv = swash_fetch(rv, s, TRUE);
515         
516             if (d > dend) {
517                 const STRLEN clen = d - dstart;
518                 const STRLEN nlen = dend - dstart + len + UTF8_MAXBYTES;
519                 if (!grows)
520                     Perl_croak(aTHX_ "panic: do_trans_complex_utf8 line %d",__LINE__);
521                 Renew(dstart, nlen + UTF8_MAXBYTES, U8);
522                 d = dstart + clen;
523                 dend = dstart + nlen;
524             }
525             if (uv < none) {
526                 matches++;
527                 s += UTF8SKIP(s);
528                 if (uv != puv) {
529                     d = uvchr_to_utf8(d, uv);
530                     puv = uv;
531                 }
532                 continue;
533             }
534             else if (uv == none) {      /* "none" is unmapped character */
535                 const int i = UTF8SKIP(s);
536                 Move(s, d, i, U8);
537                 d += i;
538                 s += i;
539                 puv = 0xfeedface;
540                 continue;
541             }
542             else if (uv == extra && !del) {
543                 matches++;
544                 if (havefinal) {
545                     s += UTF8SKIP(s);
546                     if (puv != final) {
547                         d = uvchr_to_utf8(d, final);
548                         puv = final;
549                     }
550                 }
551                 else {
552                     STRLEN len;
553                     uv = utf8n_to_uvchr(s, send - s, &len, UTF8_ALLOW_DEFAULT);
554                     if (uv != puv) {
555                         Move(s, d, len, U8);
556                         d += len;
557                         puv = uv;
558                     }
559                     s += len;
560                 }
561                 continue;
562             }
563             matches++;                  /* "none+1" is delete character */
564             s += UTF8SKIP(s);
565         }
566     }
567     else {
568         while (s < send) {
569             const UV uv = swash_fetch(rv, s, TRUE);
570             if (d > dend) {
571                 const STRLEN clen = d - dstart;
572                 const STRLEN nlen = dend - dstart + len + UTF8_MAXBYTES;
573                 if (!grows)
574                     Perl_croak(aTHX_ "panic: do_trans_complex_utf8 line %d",__LINE__);
575                 Renew(dstart, nlen + UTF8_MAXBYTES, U8);
576                 d = dstart + clen;
577                 dend = dstart + nlen;
578             }
579             if (uv < none) {
580                 matches++;
581                 s += UTF8SKIP(s);
582                 d = uvchr_to_utf8(d, uv);
583                 continue;
584             }
585             else if (uv == none) {      /* "none" is unmapped character */
586                 const int i = UTF8SKIP(s);
587                 Move(s, d, i, U8);
588                 d += i;
589                 s += i;
590                 continue;
591             }
592             else if (uv == extra && !del) {
593                 matches++;
594                 s += UTF8SKIP(s);
595                 d = uvchr_to_utf8(d, final);
596                 continue;
597             }
598             matches++;                  /* "none+1" is delete character */
599             s += UTF8SKIP(s);
600         }
601     }
602     if (grows || hibit) {
603         sv_setpvn(sv, (char*)dstart, d - dstart);
604         Safefree(dstart);
605         if (grows && hibit)
606             Safefree(start);
607     }
608     else {
609         *d = '\0';
610         SvCUR_set(sv, d - dstart);
611     }
612     SvUTF8_on(sv);
613     SvSETMAGIC(sv);
614
615     return matches;
616 }
617
618 I32
619 Perl_do_trans(pTHX_ SV *sv)
620 {
621     STRLEN len;
622     const I32 flags = PL_op->op_private;
623     const I32 hasutf = flags & (OPpTRANS_FROM_UTF | OPpTRANS_TO_UTF);
624
625     PERL_ARGS_ASSERT_DO_TRANS;
626
627     if (SvREADONLY(sv) && !(flags & OPpTRANS_IDENTICAL)) {
628         Perl_croak_no_modify();
629     }
630     (void)SvPV_const(sv, len);
631     if (!len)
632         return 0;
633     if (!(flags & OPpTRANS_IDENTICAL)) {
634         if (!SvPOKp(sv) || SvTHINKFIRST(sv))
635             (void)SvPV_force_nomg(sv, len);
636         (void)SvPOK_only_UTF8(sv);
637     }
638
639     DEBUG_t( Perl_deb(aTHX_ "2.TBL\n"));
640
641     /* If we use only OPpTRANS_IDENTICAL to bypass the READONLY check,
642      * we must also rely on it to choose the readonly strategy.
643      */
644     if (flags & OPpTRANS_IDENTICAL) {
645         return hasutf ? do_trans_count_utf8(sv) : do_trans_count(sv);
646     } else if (flags & (OPpTRANS_SQUASH|OPpTRANS_DELETE|OPpTRANS_COMPLEMENT)) {
647         return hasutf ? do_trans_complex_utf8(sv) : do_trans_complex(sv);
648     } else {
649         return hasutf ? do_trans_simple_utf8(sv) : do_trans_simple(sv);
650     }
651 }
652
653 void
654 Perl_do_join(pTHX_ SV *sv, SV *delim, SV **mark, SV **sp)
655 {
656     SV ** const oldmark = mark;
657     I32 items = sp - mark;
658     STRLEN len;
659     STRLEN delimlen;
660     const char * const delims = SvPV_const(delim, delimlen);
661
662     PERL_ARGS_ASSERT_DO_JOIN;
663
664     mark++;
665     len = (items > 0 ? (delimlen * (items - 1) ) : 0);
666     SvUPGRADE(sv, SVt_PV);
667     if (SvLEN(sv) < len + items) {      /* current length is way too short */
668         while (items-- > 0) {
669             if (*mark && !SvGAMAGIC(*mark) && SvOK(*mark)) {
670                 STRLEN tmplen;
671                 SvPV_const(*mark, tmplen);
672                 len += tmplen;
673             }
674             mark++;
675         }
676         SvGROW(sv, len + 1);            /* so try to pre-extend */
677
678         mark = oldmark;
679         items = sp - mark;
680         ++mark;
681     }
682
683     SvPVCLEAR(sv);
684     /* sv_setpv retains old UTF8ness [perl #24846] */
685     SvUTF8_off(sv);
686
687     if (TAINTING_get && SvMAGICAL(sv))
688         SvTAINTED_off(sv);
689
690     if (items-- > 0) {
691         if (*mark)
692             sv_catsv(sv, *mark);
693         mark++;
694     }
695
696     if (delimlen) {
697         const U32 delimflag = DO_UTF8(delim) ? SV_CATUTF8 : SV_CATBYTES;
698         for (; items > 0; items--,mark++) {
699             STRLEN len;
700             const char *s;
701             sv_catpvn_flags(sv,delims,delimlen,delimflag);
702             s = SvPV_const(*mark,len);
703             sv_catpvn_flags(sv,s,len,
704                             DO_UTF8(*mark) ? SV_CATUTF8 : SV_CATBYTES);
705         }
706     }
707     else {
708         for (; items > 0; items--,mark++)
709         {
710             STRLEN len;
711             const char *s = SvPV_const(*mark,len);
712             sv_catpvn_flags(sv,s,len,
713                             DO_UTF8(*mark) ? SV_CATUTF8 : SV_CATBYTES);
714         }
715     }
716     SvSETMAGIC(sv);
717 }
718
719 void
720 Perl_do_sprintf(pTHX_ SV *sv, I32 len, SV **sarg)
721 {
722     STRLEN patlen;
723     const char * const pat = SvPV_const(*sarg, patlen);
724     bool do_taint = FALSE;
725
726     PERL_ARGS_ASSERT_DO_SPRINTF;
727
728     if (SvTAINTED(*sarg))
729         TAINT_PROPER(
730                 (PL_op && PL_op->op_type < OP_max)
731                     ? (PL_op->op_type == OP_PRTF)
732                         ? "printf"
733                         : PL_op_name[PL_op->op_type]
734                     : "(unknown)"
735         );
736     SvUTF8_off(sv);
737     if (DO_UTF8(*sarg))
738         SvUTF8_on(sv);
739     sv_vsetpvfn(sv, pat, patlen, NULL, sarg + 1, len - 1, &do_taint);
740     SvSETMAGIC(sv);
741     if (do_taint)
742         SvTAINTED_on(sv);
743 }
744
745 /* currently converts input to bytes if possible, but doesn't sweat failure */
746 UV
747 Perl_do_vecget(pTHX_ SV *sv, STRLEN offset, int size)
748 {
749     STRLEN srclen, len, avail, uoffset, bitoffs = 0;
750     const I32 svpv_flags = ((PL_op->op_flags & OPf_MOD || LVRET)
751                                           ? SV_UNDEF_RETURNS_NULL : 0);
752     unsigned char *s = (unsigned char *)
753                             SvPV_flags(sv, srclen, (svpv_flags|SV_GMAGIC));
754     UV retnum = 0;
755
756     if (!s) {
757       s = (unsigned char *)"";
758     }
759     
760     PERL_ARGS_ASSERT_DO_VECGET;
761
762     if (size < 1 || (size & (size-1))) /* size < 1 or not a power of two */
763         Perl_croak(aTHX_ "Illegal number of bits in vec");
764
765     if (SvUTF8(sv)) {
766         (void) Perl_sv_utf8_downgrade(aTHX_ sv, TRUE);
767         /* PVX may have changed */
768         s = (unsigned char *) SvPV_flags(sv, srclen, svpv_flags);
769     }
770
771     if (size < 8) {
772         bitoffs = ((offset%8)*size)%8;
773         uoffset = offset/(8/size);
774     }
775     else if (size > 8) {
776         int n = size/8;
777         if (offset > Size_t_MAX / n - 1) /* would overflow */
778             return 0;
779         uoffset = offset*n;
780     }
781     else
782         uoffset = offset;
783
784     if (uoffset >= srclen)
785         return 0;
786
787     len   = (bitoffs + size + 7)/8; /* required number of bytes */
788     avail = srclen - uoffset;       /* available number of bytes */
789
790     /* Does the byte range overlap the end of the string? If so,
791      * handle specially. */
792     if (avail < len) {
793         if (size <= 8)
794             retnum = 0;
795         else {
796             if (size == 16) {
797                 assert(avail == 1);
798                 retnum = (UV) s[uoffset] <<  8;
799             }
800             else if (size == 32) {
801                 assert(avail >= 1 && avail <= 3);
802                 if (avail == 1)
803                     retnum =
804                         ((UV) s[uoffset    ] << 24);
805                 else if (avail == 2)
806                     retnum =
807                         ((UV) s[uoffset    ] << 24) +
808                         ((UV) s[uoffset + 1] << 16);
809                 else
810                     retnum =
811                         ((UV) s[uoffset    ] << 24) +
812                         ((UV) s[uoffset + 1] << 16) +
813                         (     s[uoffset + 2] <<  8);
814             }
815 #ifdef UV_IS_QUAD
816             else if (size == 64) {
817                 Perl_ck_warner(aTHX_ packWARN(WARN_PORTABLE),
818                                "Bit vector size > 32 non-portable");
819                 assert(avail >= 1 && avail <= 7);
820                 if (avail == 1)
821                     retnum =
822                         (UV) s[uoffset     ] << 56;
823                 else if (avail == 2)
824                     retnum =
825                         ((UV) s[uoffset    ] << 56) +
826                         ((UV) s[uoffset + 1] << 48);
827                 else if (avail == 3)
828                     retnum =
829                         ((UV) s[uoffset    ] << 56) +
830                         ((UV) s[uoffset + 1] << 48) +
831                         ((UV) s[uoffset + 2] << 40);
832                 else if (avail == 4)
833                     retnum =
834                         ((UV) s[uoffset    ] << 56) +
835                         ((UV) s[uoffset + 1] << 48) +
836                         ((UV) s[uoffset + 2] << 40) +
837                         ((UV) s[uoffset + 3] << 32);
838                 else if (avail == 5)
839                     retnum =
840                         ((UV) s[uoffset    ] << 56) +
841                         ((UV) s[uoffset + 1] << 48) +
842                         ((UV) s[uoffset + 2] << 40) +
843                         ((UV) s[uoffset + 3] << 32) +
844                         ((UV) s[uoffset + 4] << 24);
845                 else if (avail == 6)
846                     retnum =
847                         ((UV) s[uoffset    ] << 56) +
848                         ((UV) s[uoffset + 1] << 48) +
849                         ((UV) s[uoffset + 2] << 40) +
850                         ((UV) s[uoffset + 3] << 32) +
851                         ((UV) s[uoffset + 4] << 24) +
852                         ((UV) s[uoffset + 5] << 16);
853                 else
854                     retnum =
855                         ((UV) s[uoffset    ] << 56) +
856                         ((UV) s[uoffset + 1] << 48) +
857                         ((UV) s[uoffset + 2] << 40) +
858                         ((UV) s[uoffset + 3] << 32) +
859                         ((UV) s[uoffset + 4] << 24) +
860                         ((UV) s[uoffset + 5] << 16) +
861                         ((UV) s[uoffset + 6] <<  8);
862             }
863 #endif
864         }
865     }
866     else if (size < 8)
867         retnum = (s[uoffset] >> bitoffs) & ((1 << size) - 1);
868     else {
869         if (size == 8)
870             retnum = s[uoffset];
871         else if (size == 16)
872             retnum =
873                 ((UV) s[uoffset] <<      8) +
874                       s[uoffset + 1];
875         else if (size == 32)
876             retnum =
877                 ((UV) s[uoffset    ] << 24) +
878                 ((UV) s[uoffset + 1] << 16) +
879                 (     s[uoffset + 2] <<  8) +
880                       s[uoffset + 3];
881 #ifdef UV_IS_QUAD
882         else if (size == 64) {
883             Perl_ck_warner(aTHX_ packWARN(WARN_PORTABLE),
884                            "Bit vector size > 32 non-portable");
885             retnum =
886                 ((UV) s[uoffset    ] << 56) +
887                 ((UV) s[uoffset + 1] << 48) +
888                 ((UV) s[uoffset + 2] << 40) +
889                 ((UV) s[uoffset + 3] << 32) +
890                 ((UV) s[uoffset + 4] << 24) +
891                 ((UV) s[uoffset + 5] << 16) +
892                 (     s[uoffset + 6] <<  8) +
893                       s[uoffset + 7];
894         }
895 #endif
896     }
897
898     return retnum;
899 }
900
901 /* currently converts input to bytes if possible but doesn't sweat failures,
902  * although it does ensure that the string it clobbers is not marked as
903  * utf8-valid any more
904  */
905 void
906 Perl_do_vecset(pTHX_ SV *sv)
907 {
908     STRLEN offset, bitoffs = 0;
909     int size;
910     unsigned char *s;
911     UV lval;
912     I32 mask;
913     STRLEN targlen;
914     STRLEN len;
915     SV * const targ = LvTARG(sv);
916
917     PERL_ARGS_ASSERT_DO_VECSET;
918
919     if (!targ)
920         return;
921     s = (unsigned char*)SvPV_force_flags(targ, targlen,
922                                          SV_GMAGIC | SV_UNDEF_RETURNS_NULL);
923     if (SvUTF8(targ)) {
924         /* This is handled by the SvPOK_only below...
925         if (!Perl_sv_utf8_downgrade(aTHX_ targ, TRUE))
926             SvUTF8_off(targ);
927          */
928         (void) Perl_sv_utf8_downgrade(aTHX_ targ, TRUE);
929     }
930
931     (void)SvPOK_only(targ);
932     lval = SvUV(sv);
933     offset = LvTARGOFF(sv);
934     size = LvTARGLEN(sv);
935
936     if (size < 1 || (size & (size-1))) /* size < 1 or not a power of two */
937         Perl_croak(aTHX_ "Illegal number of bits in vec");
938
939     if (size < 8) {
940         bitoffs = ((offset%8)*size)%8;
941         offset /= 8/size;
942     }
943     else if (size > 8) {
944         int n = size/8;
945         if (offset > Size_t_MAX / n - 1) /* would overflow */
946             Perl_croak_nocontext("Out of memory!");
947         offset *= n;
948     }
949
950     len = (bitoffs + size + 7)/8;       /* required number of bytes */
951     if (targlen < offset || targlen - offset < len) {
952         STRLEN newlen = offset > Size_t_MAX - len - 1 ? /* avoid overflow */
953                                         Size_t_MAX : offset + len + 1;
954         s = (unsigned char*)SvGROW(targ, newlen);
955         (void)memzero((char *)(s + targlen), newlen - targlen);
956         SvCUR_set(targ, newlen - 1);
957     }
958
959     if (size < 8) {
960         mask = (1 << size) - 1;
961         lval &= mask;
962         s[offset] &= ~(mask << bitoffs);
963         s[offset] |= lval << bitoffs;
964     }
965     else {
966         if (size == 8)
967             s[offset  ] = (U8)( lval        & 0xff);
968         else if (size == 16) {
969             s[offset  ] = (U8)((lval >>  8) & 0xff);
970             s[offset+1] = (U8)( lval        & 0xff);
971         }
972         else if (size == 32) {
973             s[offset  ] = (U8)((lval >> 24) & 0xff);
974             s[offset+1] = (U8)((lval >> 16) & 0xff);
975             s[offset+2] = (U8)((lval >>  8) & 0xff);
976             s[offset+3] = (U8)( lval        & 0xff);
977         }
978 #ifdef UV_IS_QUAD
979         else if (size == 64) {
980             Perl_ck_warner(aTHX_ packWARN(WARN_PORTABLE),
981                            "Bit vector size > 32 non-portable");
982             s[offset  ] = (U8)((lval >> 56) & 0xff);
983             s[offset+1] = (U8)((lval >> 48) & 0xff);
984             s[offset+2] = (U8)((lval >> 40) & 0xff);
985             s[offset+3] = (U8)((lval >> 32) & 0xff);
986             s[offset+4] = (U8)((lval >> 24) & 0xff);
987             s[offset+5] = (U8)((lval >> 16) & 0xff);
988             s[offset+6] = (U8)((lval >>  8) & 0xff);
989             s[offset+7] = (U8)( lval        & 0xff);
990         }
991 #endif
992     }
993     SvSETMAGIC(targ);
994 }
995
996 void
997 Perl_do_vop(pTHX_ I32 optype, SV *sv, SV *left, SV *right)
998 {
999 #ifdef LIBERAL
1000     long *dl;
1001     long *ll;
1002     long *rl;
1003 #endif
1004     char *dc;
1005     STRLEN leftlen;
1006     STRLEN rightlen;
1007     const char *lc;
1008     const char *rc;
1009     STRLEN len;
1010     STRLEN lensave;
1011     const char *lsave;
1012     const char *rsave;
1013     bool left_utf;
1014     bool right_utf;
1015     bool do_warn_above_ff = ckWARN_d(WARN_DEPRECATED);
1016     STRLEN needlen = 0;
1017
1018     PERL_ARGS_ASSERT_DO_VOP;
1019
1020     if (sv != left || (optype != OP_BIT_AND && !SvOK(sv)))
1021         SvPVCLEAR(sv);        /* avoid undef warning on |= and ^= */
1022     if (sv == left) {
1023         lsave = lc = SvPV_force_nomg(left, leftlen);
1024     }
1025     else {
1026         lsave = lc = SvPV_nomg_const(left, leftlen);
1027         SvPV_force_nomg_nolen(sv);
1028     }
1029     rsave = rc = SvPV_nomg_const(right, rightlen);
1030
1031     /* This needs to come after SvPV to ensure that string overloading has
1032        fired off.  */
1033
1034     left_utf = DO_UTF8(left);
1035     right_utf = DO_UTF8(right);
1036
1037     if (left_utf && !right_utf) {
1038         /* Avoid triggering overloading again by using temporaries.
1039            Maybe there should be a variant of sv_utf8_upgrade that takes pvn
1040         */
1041         right = newSVpvn_flags(rsave, rightlen, SVs_TEMP);
1042         sv_utf8_upgrade(right);
1043         rsave = rc = SvPV_nomg_const(right, rightlen);
1044         right_utf = TRUE;
1045     }
1046     else if (!left_utf && right_utf) {
1047         left = newSVpvn_flags(lsave, leftlen, SVs_TEMP);
1048         sv_utf8_upgrade(left);
1049         lsave = lc = SvPV_nomg_const(left, leftlen);
1050         left_utf = TRUE;
1051     }
1052
1053     len = leftlen < rightlen ? leftlen : rightlen;
1054     lensave = len;
1055     SvCUR_set(sv, len);
1056     (void)SvPOK_only(sv);
1057     if ((left_utf || right_utf) && (sv == left || sv == right)) {
1058         needlen = optype == OP_BIT_AND ? len : leftlen + rightlen;
1059         Newxz(dc, needlen + 1, char);
1060     }
1061     else if (SvOK(sv) || SvTYPE(sv) > SVt_PVMG) {
1062         dc = SvPV_force_nomg_nolen(sv);
1063         if (SvLEN(sv) < len + 1) {
1064             dc = SvGROW(sv, len + 1);
1065             (void)memzero(dc + SvCUR(sv), len - SvCUR(sv) + 1);
1066         }
1067         if (optype != OP_BIT_AND && (left_utf || right_utf))
1068             dc = SvGROW(sv, leftlen + rightlen + 1);
1069     }
1070     else {
1071         needlen = optype == OP_BIT_AND
1072                     ? len : (leftlen > rightlen ? leftlen : rightlen);
1073         Newxz(dc, needlen + 1, char);
1074         sv_usepvn_flags(sv, dc, needlen, SV_HAS_TRAILING_NUL);
1075         dc = SvPVX(sv);         /* sv_usepvn() calls Renew() */
1076     }
1077     if (left_utf || right_utf) {
1078         char *dcorig = dc;
1079         char *dcsave = NULL;
1080         STRLEN lulen = leftlen;
1081         STRLEN rulen = rightlen;
1082
1083         switch (optype) {
1084         case OP_BIT_AND:
1085             while (lulen && rulen) {
1086                 UV duc, luc, ruc;
1087                 STRLEN ulen;
1088                 luc = utf8n_to_uvchr((U8*)lc, lulen, &ulen, UTF8_ALLOW_ANYUV);
1089                 lc += ulen;
1090                 lulen -= ulen;
1091                 ruc = utf8n_to_uvchr((U8*)rc, rulen, &ulen, UTF8_ALLOW_ANYUV);
1092                 rc += ulen;
1093                 rulen -= ulen;
1094                 duc = luc & ruc;
1095                 dc = (char*)uvchr_to_utf8((U8*)dc, duc);
1096                 if (do_warn_above_ff && (luc > 0xff || ruc > 0xff)) {
1097                     Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
1098                                 deprecated_above_ff_msg, PL_op_desc[optype]);
1099                     /* Warn only once per operation */
1100                     do_warn_above_ff = FALSE;
1101                 }
1102             }
1103             if (sv == left || sv == right)
1104                 (void)sv_usepvn(sv, dcorig, needlen);
1105             SvCUR_set(sv, dc - dcorig);
1106             *SvEND(sv) = 0;
1107             break;
1108         case OP_BIT_XOR:
1109             while (lulen && rulen) {
1110                 UV duc, luc, ruc;
1111                 STRLEN ulen;
1112                 luc = utf8n_to_uvchr((U8*)lc, lulen, &ulen, UTF8_ALLOW_ANYUV);
1113                 lc += ulen;
1114                 lulen -= ulen;
1115                 ruc = utf8n_to_uvchr((U8*)rc, rulen, &ulen, UTF8_ALLOW_ANYUV);
1116                 rc += ulen;
1117                 rulen -= ulen;
1118                 duc = luc ^ ruc;
1119                 dc = (char*)uvchr_to_utf8((U8*)dc, duc);
1120                 if (do_warn_above_ff && (luc > 0xff || ruc > 0xff)) {
1121                     Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
1122                                 deprecated_above_ff_msg, PL_op_desc[optype]);
1123                     do_warn_above_ff = FALSE;
1124                 }
1125             }
1126             goto mop_up_utf;
1127         case OP_BIT_OR:
1128             while (lulen && rulen) {
1129                 UV duc, luc, ruc;
1130                 STRLEN ulen;
1131                 luc = utf8n_to_uvchr((U8*)lc, lulen, &ulen, UTF8_ALLOW_ANYUV);
1132                 lc += ulen;
1133                 lulen -= ulen;
1134                 ruc = utf8n_to_uvchr((U8*)rc, rulen, &ulen, UTF8_ALLOW_ANYUV);
1135                 rc += ulen;
1136                 rulen -= ulen;
1137                 duc = luc | ruc;
1138                 dc = (char*)uvchr_to_utf8((U8*)dc, duc);
1139                 if (do_warn_above_ff && (luc > 0xff || ruc > 0xff)) {
1140                     Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
1141                                 deprecated_above_ff_msg, PL_op_desc[optype]);
1142                     do_warn_above_ff = FALSE;
1143                 }
1144             }
1145           mop_up_utf:
1146             if (rulen)
1147                 dcsave = savepvn(rc, rulen);
1148             else if (lulen)
1149                 dcsave = savepvn(lc, lulen);
1150             if (sv == left || sv == right)
1151                 (void)sv_usepvn(sv, dcorig, needlen); /* uses Renew(); defaults to nomg */
1152             SvCUR_set(sv, dc - dcorig);
1153             if (rulen)
1154                 sv_catpvn_nomg(sv, dcsave, rulen);
1155             else if (lulen)
1156                 sv_catpvn_nomg(sv, dcsave, lulen);
1157             else
1158                 *SvEND(sv) = '\0';
1159             Safefree(dcsave);
1160             break;
1161         default:
1162             if (sv == left || sv == right)
1163                 Safefree(dcorig);
1164             Perl_croak(aTHX_ "panic: do_vop called for op %u (%s)",
1165                         (unsigned)optype, PL_op_name[optype]);
1166         }
1167         SvUTF8_on(sv);
1168         goto finish;
1169     }
1170     else
1171 #ifdef LIBERAL
1172     if (len >= sizeof(long)*4 &&
1173         !((unsigned long)dc % sizeof(long)) &&
1174         !((unsigned long)lc % sizeof(long)) &&
1175         !((unsigned long)rc % sizeof(long)))    /* It's almost always aligned... */
1176     {
1177         const STRLEN remainder = len % (sizeof(long)*4);
1178         len /= (sizeof(long)*4);
1179
1180         dl = (long*)dc;
1181         ll = (long*)lc;
1182         rl = (long*)rc;
1183
1184         switch (optype) {
1185         case OP_BIT_AND:
1186             while (len--) {
1187                 *dl++ = *ll++ & *rl++;
1188                 *dl++ = *ll++ & *rl++;
1189                 *dl++ = *ll++ & *rl++;
1190                 *dl++ = *ll++ & *rl++;
1191             }
1192             break;
1193         case OP_BIT_XOR:
1194             while (len--) {
1195                 *dl++ = *ll++ ^ *rl++;
1196                 *dl++ = *ll++ ^ *rl++;
1197                 *dl++ = *ll++ ^ *rl++;
1198                 *dl++ = *ll++ ^ *rl++;
1199             }
1200             break;
1201         case OP_BIT_OR:
1202             while (len--) {
1203                 *dl++ = *ll++ | *rl++;
1204                 *dl++ = *ll++ | *rl++;
1205                 *dl++ = *ll++ | *rl++;
1206                 *dl++ = *ll++ | *rl++;
1207             }
1208         }
1209
1210         dc = (char*)dl;
1211         lc = (char*)ll;
1212         rc = (char*)rl;
1213
1214         len = remainder;
1215     }
1216 #endif
1217     {
1218         switch (optype) {
1219         case OP_BIT_AND:
1220             while (len--)
1221                 *dc++ = *lc++ & *rc++;
1222             *dc = '\0';
1223             break;
1224         case OP_BIT_XOR:
1225             while (len--)
1226                 *dc++ = *lc++ ^ *rc++;
1227             goto mop_up;
1228         case OP_BIT_OR:
1229             while (len--)
1230                 *dc++ = *lc++ | *rc++;
1231           mop_up:
1232             len = lensave;
1233             if (rightlen > len) {
1234                 if (dc == rc)
1235                     SvCUR(sv) = rightlen;
1236                 else
1237                     sv_catpvn_nomg(sv, rsave + len, rightlen - len);
1238             }
1239             else if (leftlen > len) {
1240                 if (dc == lc)
1241                     SvCUR(sv) = leftlen;
1242                 else
1243                     sv_catpvn_nomg(sv, lsave + len, leftlen - len);
1244             }
1245             *SvEND(sv) = '\0';
1246
1247             break;
1248         }
1249     }
1250   finish:
1251     SvTAINT(sv);
1252 }
1253
1254
1255 /* used for: pp_keys(), pp_values() */
1256
1257 OP *
1258 Perl_do_kv(pTHX)
1259 {
1260     dSP;
1261     HV * const keys = MUTABLE_HV(POPs);
1262     HE *entry;
1263     SSize_t extend_size;
1264     const U8 gimme = GIMME_V;
1265     const I32 dokv =     (PL_op->op_type == OP_RV2HV || PL_op->op_type == OP_PADHV);
1266     /* op_type is OP_RKEYS/OP_RVALUES if pp_rkeys delegated to here */
1267     const I32 dokeys =   dokv || (PL_op->op_type == OP_KEYS)
1268         || (  PL_op->op_type == OP_AVHVSWITCH
1269            && (PL_op->op_private & 3) + OP_EACH == OP_KEYS  );
1270     const I32 dovalues = dokv || (PL_op->op_type == OP_VALUES)
1271         || (  PL_op->op_type == OP_AVHVSWITCH
1272            && (PL_op->op_private & 3) + OP_EACH == OP_VALUES  );
1273
1274     (void)hv_iterinit(keys);    /* always reset iterator regardless */
1275
1276     if (gimme == G_VOID)
1277         RETURN;
1278
1279     if (gimme == G_SCALAR) {
1280         if (PL_op->op_flags & OPf_MOD || LVRET) {       /* lvalue */
1281             SV * const ret = sv_2mortal(newSV_type(SVt_PVLV));  /* Not TARG RT#67838 */
1282             sv_magic(ret, NULL, PERL_MAGIC_nkeys, NULL, 0);
1283             LvTYPE(ret) = 'k';
1284             LvTARG(ret) = SvREFCNT_inc_simple(keys);
1285             PUSHs(ret);
1286         }
1287         else {
1288             IV i;
1289             dTARGET;
1290
1291             if (! SvTIED_mg((const SV *)keys, PERL_MAGIC_tied) ) {
1292                 i = HvUSEDKEYS(keys);
1293             }
1294             else {
1295                 i = 0;
1296                 while (hv_iternext(keys)) i++;
1297             }
1298             PUSHi( i );
1299         }
1300         RETURN;
1301     }
1302
1303     if (UNLIKELY(PL_op->op_private & OPpMAYBE_LVSUB)) {
1304         const I32 flags = is_lvalue_sub();
1305         if (flags && !(flags & OPpENTERSUB_INARGS))
1306             /* diag_listed_as: Can't modify %s in %s */
1307             Perl_croak(aTHX_ "Can't modify keys in list assignment");
1308     }
1309
1310     /* 2*HvUSEDKEYS() should never be big enough to truncate or wrap */
1311     assert(HvUSEDKEYS(keys) <= (SSize_t_MAX >> 1));
1312     extend_size = (SSize_t)HvUSEDKEYS(keys) * (dokeys + dovalues);
1313     EXTEND(SP, extend_size);
1314
1315     while ((entry = hv_iternext(keys))) {
1316         if (dokeys) {
1317             SV* const sv = hv_iterkeysv(entry);
1318             XPUSHs(sv);
1319         }
1320         if (dovalues) {
1321             SV *tmpstr = hv_iterval(keys,entry);
1322             DEBUG_H(Perl_sv_setpvf(aTHX_ tmpstr, "%lu%%%d=%lu",
1323                             (unsigned long)HeHASH(entry),
1324                             (int)HvMAX(keys)+1,
1325                             (unsigned long)(HeHASH(entry) & HvMAX(keys))));
1326             XPUSHs(tmpstr);
1327         }
1328     }
1329     RETURN;
1330 }
1331
1332 /*
1333  * ex: set ts=8 sts=4 sw=4 et:
1334  */