This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
sort Porting/deparse-skips.txt
[perl5.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         if (Perl_sv_utf8_downgrade(aTHX_ sv, TRUE)) {
767             /* PVX may have changed */
768             s = (unsigned char *) SvPV_flags(sv, srclen, svpv_flags);
769         }
770         else {
771             Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),
772                                 "Use of strings with code points over 0xFF as"
773                                 " arguments to vec is deprecated. This will"
774                                 " be a fatal error in Perl 5.32");
775         }
776     }
777
778     if (size < 8) {
779         bitoffs = ((offset%8)*size)%8;
780         uoffset = offset/(8/size);
781     }
782     else if (size > 8) {
783         int n = size/8;
784         if (offset > Size_t_MAX / n - 1) /* would overflow */
785             return 0;
786         uoffset = offset*n;
787     }
788     else
789         uoffset = offset;
790
791     if (uoffset >= srclen)
792         return 0;
793
794     len   = (bitoffs + size + 7)/8; /* required number of bytes */
795     avail = srclen - uoffset;       /* available number of bytes */
796
797     /* Does the byte range overlap the end of the string? If so,
798      * handle specially. */
799     if (avail < len) {
800         if (size <= 8)
801             retnum = 0;
802         else {
803             if (size == 16) {
804                 assert(avail == 1);
805                 retnum = (UV) s[uoffset] <<  8;
806             }
807             else if (size == 32) {
808                 assert(avail >= 1 && avail <= 3);
809                 if (avail == 1)
810                     retnum =
811                         ((UV) s[uoffset    ] << 24);
812                 else if (avail == 2)
813                     retnum =
814                         ((UV) s[uoffset    ] << 24) +
815                         ((UV) s[uoffset + 1] << 16);
816                 else
817                     retnum =
818                         ((UV) s[uoffset    ] << 24) +
819                         ((UV) s[uoffset + 1] << 16) +
820                         (     s[uoffset + 2] <<  8);
821             }
822 #ifdef UV_IS_QUAD
823             else if (size == 64) {
824                 Perl_ck_warner(aTHX_ packWARN(WARN_PORTABLE),
825                                "Bit vector size > 32 non-portable");
826                 assert(avail >= 1 && avail <= 7);
827                 if (avail == 1)
828                     retnum =
829                         (UV) s[uoffset     ] << 56;
830                 else if (avail == 2)
831                     retnum =
832                         ((UV) s[uoffset    ] << 56) +
833                         ((UV) s[uoffset + 1] << 48);
834                 else if (avail == 3)
835                     retnum =
836                         ((UV) s[uoffset    ] << 56) +
837                         ((UV) s[uoffset + 1] << 48) +
838                         ((UV) s[uoffset + 2] << 40);
839                 else if (avail == 4)
840                     retnum =
841                         ((UV) s[uoffset    ] << 56) +
842                         ((UV) s[uoffset + 1] << 48) +
843                         ((UV) s[uoffset + 2] << 40) +
844                         ((UV) s[uoffset + 3] << 32);
845                 else if (avail == 5)
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                 else if (avail == 6)
853                     retnum =
854                         ((UV) s[uoffset    ] << 56) +
855                         ((UV) s[uoffset + 1] << 48) +
856                         ((UV) s[uoffset + 2] << 40) +
857                         ((UV) s[uoffset + 3] << 32) +
858                         ((UV) s[uoffset + 4] << 24) +
859                         ((UV) s[uoffset + 5] << 16);
860                 else
861                     retnum =
862                         ((UV) s[uoffset    ] << 56) +
863                         ((UV) s[uoffset + 1] << 48) +
864                         ((UV) s[uoffset + 2] << 40) +
865                         ((UV) s[uoffset + 3] << 32) +
866                         ((UV) s[uoffset + 4] << 24) +
867                         ((UV) s[uoffset + 5] << 16) +
868                         ((UV) s[uoffset + 6] <<  8);
869             }
870 #endif
871         }
872     }
873     else if (size < 8)
874         retnum = (s[uoffset] >> bitoffs) & ((1 << size) - 1);
875     else {
876         if (size == 8)
877             retnum = s[uoffset];
878         else if (size == 16)
879             retnum =
880                 ((UV) s[uoffset] <<      8) +
881                       s[uoffset + 1];
882         else if (size == 32)
883             retnum =
884                 ((UV) s[uoffset    ] << 24) +
885                 ((UV) s[uoffset + 1] << 16) +
886                 (     s[uoffset + 2] <<  8) +
887                       s[uoffset + 3];
888 #ifdef UV_IS_QUAD
889         else if (size == 64) {
890             Perl_ck_warner(aTHX_ packWARN(WARN_PORTABLE),
891                            "Bit vector size > 32 non-portable");
892             retnum =
893                 ((UV) s[uoffset    ] << 56) +
894                 ((UV) s[uoffset + 1] << 48) +
895                 ((UV) s[uoffset + 2] << 40) +
896                 ((UV) s[uoffset + 3] << 32) +
897                 ((UV) s[uoffset + 4] << 24) +
898                 ((UV) s[uoffset + 5] << 16) +
899                 (     s[uoffset + 6] <<  8) +
900                       s[uoffset + 7];
901         }
902 #endif
903     }
904
905     return retnum;
906 }
907
908 /* currently converts input to bytes if possible but doesn't sweat failures,
909  * although it does ensure that the string it clobbers is not marked as
910  * utf8-valid any more
911  */
912 void
913 Perl_do_vecset(pTHX_ SV *sv)
914 {
915     STRLEN offset, bitoffs = 0;
916     int size;
917     unsigned char *s;
918     UV lval;
919     I32 mask;
920     STRLEN targlen;
921     STRLEN len;
922     SV * const targ = LvTARG(sv);
923     char errflags = LvFLAGS(sv);
924
925     PERL_ARGS_ASSERT_DO_VECSET;
926
927     /* some out-of-range errors have been deferred if/until the LV is
928      * actually written to: f(vec($s,-1,8)) is not always fatal */
929     if (errflags) {
930         assert(!(errflags & ~(LVf_NEG_OFF|LVf_OUT_OF_RANGE)));
931         if (errflags & LVf_NEG_OFF)
932             Perl_croak_nocontext("Negative offset to vec in lvalue context");
933         Perl_croak_nocontext("Out of memory!");
934     }
935
936     if (!targ)
937         return;
938     s = (unsigned char*)SvPV_force_flags(targ, targlen,
939                                          SV_GMAGIC | SV_UNDEF_RETURNS_NULL);
940     if (SvUTF8(targ)) {
941         /* This is handled by the SvPOK_only below...
942         if (!Perl_sv_utf8_downgrade(aTHX_ targ, TRUE))
943             SvUTF8_off(targ);
944          */
945         (void) Perl_sv_utf8_downgrade(aTHX_ targ, TRUE);
946     }
947
948     (void)SvPOK_only(targ);
949     lval = SvUV(sv);
950     offset = LvTARGOFF(sv);
951     size = LvTARGLEN(sv);
952
953     if (size < 1 || (size & (size-1))) /* size < 1 or not a power of two */
954         Perl_croak(aTHX_ "Illegal number of bits in vec");
955
956     if (size < 8) {
957         bitoffs = ((offset%8)*size)%8;
958         offset /= 8/size;
959     }
960     else if (size > 8) {
961         int n = size/8;
962         if (offset > Size_t_MAX / n - 1) /* would overflow */
963             Perl_croak_nocontext("Out of memory!");
964         offset *= n;
965     }
966
967     len = (bitoffs + size + 7)/8;       /* required number of bytes */
968     if (targlen < offset || targlen - offset < len) {
969         STRLEN newlen = offset > Size_t_MAX - len - 1 ? /* avoid overflow */
970                                         Size_t_MAX : offset + len + 1;
971         s = (unsigned char*)SvGROW(targ, newlen);
972         (void)memzero((char *)(s + targlen), newlen - targlen);
973         SvCUR_set(targ, newlen - 1);
974     }
975
976     if (size < 8) {
977         mask = (1 << size) - 1;
978         lval &= mask;
979         s[offset] &= ~(mask << bitoffs);
980         s[offset] |= lval << bitoffs;
981     }
982     else {
983         if (size == 8)
984             s[offset  ] = (U8)( lval        & 0xff);
985         else if (size == 16) {
986             s[offset  ] = (U8)((lval >>  8) & 0xff);
987             s[offset+1] = (U8)( lval        & 0xff);
988         }
989         else if (size == 32) {
990             s[offset  ] = (U8)((lval >> 24) & 0xff);
991             s[offset+1] = (U8)((lval >> 16) & 0xff);
992             s[offset+2] = (U8)((lval >>  8) & 0xff);
993             s[offset+3] = (U8)( lval        & 0xff);
994         }
995 #ifdef UV_IS_QUAD
996         else if (size == 64) {
997             Perl_ck_warner(aTHX_ packWARN(WARN_PORTABLE),
998                            "Bit vector size > 32 non-portable");
999             s[offset  ] = (U8)((lval >> 56) & 0xff);
1000             s[offset+1] = (U8)((lval >> 48) & 0xff);
1001             s[offset+2] = (U8)((lval >> 40) & 0xff);
1002             s[offset+3] = (U8)((lval >> 32) & 0xff);
1003             s[offset+4] = (U8)((lval >> 24) & 0xff);
1004             s[offset+5] = (U8)((lval >> 16) & 0xff);
1005             s[offset+6] = (U8)((lval >>  8) & 0xff);
1006             s[offset+7] = (U8)( lval        & 0xff);
1007         }
1008 #endif
1009     }
1010     SvSETMAGIC(targ);
1011 }
1012
1013 void
1014 Perl_do_vop(pTHX_ I32 optype, SV *sv, SV *left, SV *right)
1015 {
1016 #ifdef LIBERAL
1017     long *dl;
1018     long *ll;
1019     long *rl;
1020 #endif
1021     char *dc;
1022     STRLEN leftlen;
1023     STRLEN rightlen;
1024     const char *lc;
1025     const char *rc;
1026     STRLEN len;
1027     STRLEN lensave;
1028     const char *lsave;
1029     const char *rsave;
1030     bool left_utf;
1031     bool right_utf;
1032     bool do_warn_above_ff = ckWARN_d(WARN_DEPRECATED);
1033     STRLEN needlen = 0;
1034
1035     PERL_ARGS_ASSERT_DO_VOP;
1036
1037     if (sv != left || (optype != OP_BIT_AND && !SvOK(sv)))
1038         SvPVCLEAR(sv);        /* avoid undef warning on |= and ^= */
1039     if (sv == left) {
1040         lsave = lc = SvPV_force_nomg(left, leftlen);
1041     }
1042     else {
1043         lsave = lc = SvPV_nomg_const(left, leftlen);
1044         SvPV_force_nomg_nolen(sv);
1045     }
1046     rsave = rc = SvPV_nomg_const(right, rightlen);
1047
1048     /* This needs to come after SvPV to ensure that string overloading has
1049        fired off.  */
1050
1051     left_utf = DO_UTF8(left);
1052     right_utf = DO_UTF8(right);
1053
1054     if (left_utf && !right_utf) {
1055         /* Avoid triggering overloading again by using temporaries.
1056            Maybe there should be a variant of sv_utf8_upgrade that takes pvn
1057         */
1058         right = newSVpvn_flags(rsave, rightlen, SVs_TEMP);
1059         sv_utf8_upgrade(right);
1060         rsave = rc = SvPV_nomg_const(right, rightlen);
1061         right_utf = TRUE;
1062     }
1063     else if (!left_utf && right_utf) {
1064         left = newSVpvn_flags(lsave, leftlen, SVs_TEMP);
1065         sv_utf8_upgrade(left);
1066         lsave = lc = SvPV_nomg_const(left, leftlen);
1067         left_utf = TRUE;
1068     }
1069
1070     len = leftlen < rightlen ? leftlen : rightlen;
1071     lensave = len;
1072     SvCUR_set(sv, len);
1073     (void)SvPOK_only(sv);
1074     if ((left_utf || right_utf) && (sv == left || sv == right)) {
1075         needlen = optype == OP_BIT_AND ? len : leftlen + rightlen;
1076         Newxz(dc, needlen + 1, char);
1077     }
1078     else if (SvOK(sv) || SvTYPE(sv) > SVt_PVMG) {
1079         dc = SvPV_force_nomg_nolen(sv);
1080         if (SvLEN(sv) < len + 1) {
1081             dc = SvGROW(sv, len + 1);
1082             (void)memzero(dc + SvCUR(sv), len - SvCUR(sv) + 1);
1083         }
1084         if (optype != OP_BIT_AND && (left_utf || right_utf))
1085             dc = SvGROW(sv, leftlen + rightlen + 1);
1086     }
1087     else {
1088         needlen = optype == OP_BIT_AND
1089                     ? len : (leftlen > rightlen ? leftlen : rightlen);
1090         Newxz(dc, needlen + 1, char);
1091         sv_usepvn_flags(sv, dc, needlen, SV_HAS_TRAILING_NUL);
1092         dc = SvPVX(sv);         /* sv_usepvn() calls Renew() */
1093     }
1094     if (left_utf || right_utf) {
1095         char *dcorig = dc;
1096         char *dcsave = NULL;
1097         STRLEN lulen = leftlen;
1098         STRLEN rulen = rightlen;
1099
1100         switch (optype) {
1101         case OP_BIT_AND:
1102             while (lulen && rulen) {
1103                 UV duc, luc, ruc;
1104                 STRLEN ulen;
1105                 luc = utf8n_to_uvchr((U8*)lc, lulen, &ulen, UTF8_ALLOW_ANYUV);
1106                 lc += ulen;
1107                 lulen -= ulen;
1108                 ruc = utf8n_to_uvchr((U8*)rc, rulen, &ulen, UTF8_ALLOW_ANYUV);
1109                 rc += ulen;
1110                 rulen -= ulen;
1111                 duc = luc & ruc;
1112                 dc = (char*)uvchr_to_utf8((U8*)dc, duc);
1113                 if (do_warn_above_ff && (luc > 0xff || ruc > 0xff)) {
1114                     Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
1115                                 deprecated_above_ff_msg, PL_op_desc[optype]);
1116                     /* Warn only once per operation */
1117                     do_warn_above_ff = FALSE;
1118                 }
1119             }
1120             if (sv == left || sv == right)
1121                 (void)sv_usepvn(sv, dcorig, needlen);
1122             SvCUR_set(sv, dc - dcorig);
1123             *SvEND(sv) = 0;
1124             break;
1125         case OP_BIT_XOR:
1126             while (lulen && rulen) {
1127                 UV duc, luc, ruc;
1128                 STRLEN ulen;
1129                 luc = utf8n_to_uvchr((U8*)lc, lulen, &ulen, UTF8_ALLOW_ANYUV);
1130                 lc += ulen;
1131                 lulen -= ulen;
1132                 ruc = utf8n_to_uvchr((U8*)rc, rulen, &ulen, UTF8_ALLOW_ANYUV);
1133                 rc += ulen;
1134                 rulen -= ulen;
1135                 duc = luc ^ ruc;
1136                 dc = (char*)uvchr_to_utf8((U8*)dc, duc);
1137                 if (do_warn_above_ff && (luc > 0xff || ruc > 0xff)) {
1138                     Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
1139                                 deprecated_above_ff_msg, PL_op_desc[optype]);
1140                     do_warn_above_ff = FALSE;
1141                 }
1142             }
1143             goto mop_up_utf;
1144         case OP_BIT_OR:
1145             while (lulen && rulen) {
1146                 UV duc, luc, ruc;
1147                 STRLEN ulen;
1148                 luc = utf8n_to_uvchr((U8*)lc, lulen, &ulen, UTF8_ALLOW_ANYUV);
1149                 lc += ulen;
1150                 lulen -= ulen;
1151                 ruc = utf8n_to_uvchr((U8*)rc, rulen, &ulen, UTF8_ALLOW_ANYUV);
1152                 rc += ulen;
1153                 rulen -= ulen;
1154                 duc = luc | ruc;
1155                 dc = (char*)uvchr_to_utf8((U8*)dc, duc);
1156                 if (do_warn_above_ff && (luc > 0xff || ruc > 0xff)) {
1157                     Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),
1158                                 deprecated_above_ff_msg, PL_op_desc[optype]);
1159                     do_warn_above_ff = FALSE;
1160                 }
1161             }
1162           mop_up_utf:
1163             if (rulen)
1164                 dcsave = savepvn(rc, rulen);
1165             else if (lulen)
1166                 dcsave = savepvn(lc, lulen);
1167             if (sv == left || sv == right)
1168                 (void)sv_usepvn(sv, dcorig, needlen); /* uses Renew(); defaults to nomg */
1169             SvCUR_set(sv, dc - dcorig);
1170             if (rulen)
1171                 sv_catpvn_nomg(sv, dcsave, rulen);
1172             else if (lulen)
1173                 sv_catpvn_nomg(sv, dcsave, lulen);
1174             else
1175                 *SvEND(sv) = '\0';
1176             Safefree(dcsave);
1177             break;
1178         default:
1179             if (sv == left || sv == right)
1180                 Safefree(dcorig);
1181             Perl_croak(aTHX_ "panic: do_vop called for op %u (%s)",
1182                         (unsigned)optype, PL_op_name[optype]);
1183         }
1184         SvUTF8_on(sv);
1185         goto finish;
1186     }
1187     else
1188 #ifdef LIBERAL
1189     if (len >= sizeof(long)*4 &&
1190         !((unsigned long)dc % sizeof(long)) &&
1191         !((unsigned long)lc % sizeof(long)) &&
1192         !((unsigned long)rc % sizeof(long)))    /* It's almost always aligned... */
1193     {
1194         const STRLEN remainder = len % (sizeof(long)*4);
1195         len /= (sizeof(long)*4);
1196
1197         dl = (long*)dc;
1198         ll = (long*)lc;
1199         rl = (long*)rc;
1200
1201         switch (optype) {
1202         case OP_BIT_AND:
1203             while (len--) {
1204                 *dl++ = *ll++ & *rl++;
1205                 *dl++ = *ll++ & *rl++;
1206                 *dl++ = *ll++ & *rl++;
1207                 *dl++ = *ll++ & *rl++;
1208             }
1209             break;
1210         case OP_BIT_XOR:
1211             while (len--) {
1212                 *dl++ = *ll++ ^ *rl++;
1213                 *dl++ = *ll++ ^ *rl++;
1214                 *dl++ = *ll++ ^ *rl++;
1215                 *dl++ = *ll++ ^ *rl++;
1216             }
1217             break;
1218         case OP_BIT_OR:
1219             while (len--) {
1220                 *dl++ = *ll++ | *rl++;
1221                 *dl++ = *ll++ | *rl++;
1222                 *dl++ = *ll++ | *rl++;
1223                 *dl++ = *ll++ | *rl++;
1224             }
1225         }
1226
1227         dc = (char*)dl;
1228         lc = (char*)ll;
1229         rc = (char*)rl;
1230
1231         len = remainder;
1232     }
1233 #endif
1234     {
1235         switch (optype) {
1236         case OP_BIT_AND:
1237             while (len--)
1238                 *dc++ = *lc++ & *rc++;
1239             *dc = '\0';
1240             break;
1241         case OP_BIT_XOR:
1242             while (len--)
1243                 *dc++ = *lc++ ^ *rc++;
1244             goto mop_up;
1245         case OP_BIT_OR:
1246             while (len--)
1247                 *dc++ = *lc++ | *rc++;
1248           mop_up:
1249             len = lensave;
1250             if (rightlen > len) {
1251                 if (dc == rc)
1252                     SvCUR(sv) = rightlen;
1253                 else
1254                     sv_catpvn_nomg(sv, rsave + len, rightlen - len);
1255             }
1256             else if (leftlen > len) {
1257                 if (dc == lc)
1258                     SvCUR(sv) = leftlen;
1259                 else
1260                     sv_catpvn_nomg(sv, lsave + len, leftlen - len);
1261             }
1262             *SvEND(sv) = '\0';
1263
1264             break;
1265         }
1266     }
1267   finish:
1268     SvTAINT(sv);
1269 }
1270
1271
1272 /* used for: pp_keys(), pp_values() */
1273
1274 OP *
1275 Perl_do_kv(pTHX)
1276 {
1277     dSP;
1278     HV * const keys = MUTABLE_HV(POPs);
1279     HE *entry;
1280     SSize_t extend_size;
1281     const U8 gimme = GIMME_V;
1282     const I32 dokv =     (PL_op->op_type == OP_RV2HV || PL_op->op_type == OP_PADHV);
1283     /* op_type is OP_RKEYS/OP_RVALUES if pp_rkeys delegated to here */
1284     const I32 dokeys =   dokv || (PL_op->op_type == OP_KEYS)
1285         || (  PL_op->op_type == OP_AVHVSWITCH
1286            && (PL_op->op_private & 3) + OP_EACH == OP_KEYS  );
1287     const I32 dovalues = dokv || (PL_op->op_type == OP_VALUES)
1288         || (  PL_op->op_type == OP_AVHVSWITCH
1289            && (PL_op->op_private & 3) + OP_EACH == OP_VALUES  );
1290
1291     (void)hv_iterinit(keys);    /* always reset iterator regardless */
1292
1293     if (gimme == G_VOID)
1294         RETURN;
1295
1296     if (gimme == G_SCALAR) {
1297         if (PL_op->op_flags & OPf_MOD || LVRET) {       /* lvalue */
1298             SV * const ret = sv_2mortal(newSV_type(SVt_PVLV));  /* Not TARG RT#67838 */
1299             sv_magic(ret, NULL, PERL_MAGIC_nkeys, NULL, 0);
1300             LvTYPE(ret) = 'k';
1301             LvTARG(ret) = SvREFCNT_inc_simple(keys);
1302             PUSHs(ret);
1303         }
1304         else {
1305             IV i;
1306             dTARGET;
1307
1308             if (! SvTIED_mg((const SV *)keys, PERL_MAGIC_tied) ) {
1309                 i = HvUSEDKEYS(keys);
1310             }
1311             else {
1312                 i = 0;
1313                 while (hv_iternext(keys)) i++;
1314             }
1315             PUSHi( i );
1316         }
1317         RETURN;
1318     }
1319
1320     if (UNLIKELY(PL_op->op_private & OPpMAYBE_LVSUB)) {
1321         const I32 flags = is_lvalue_sub();
1322         if (flags && !(flags & OPpENTERSUB_INARGS))
1323             /* diag_listed_as: Can't modify %s in %s */
1324             Perl_croak(aTHX_ "Can't modify keys in list assignment");
1325     }
1326
1327     /* 2*HvUSEDKEYS() should never be big enough to truncate or wrap */
1328     assert(HvUSEDKEYS(keys) <= (SSize_t_MAX >> 1));
1329     extend_size = (SSize_t)HvUSEDKEYS(keys) * (dokeys + dovalues);
1330     EXTEND(SP, extend_size);
1331
1332     while ((entry = hv_iternext(keys))) {
1333         if (dokeys) {
1334             SV* const sv = hv_iterkeysv(entry);
1335             XPUSHs(sv);
1336         }
1337         if (dovalues) {
1338             SV *tmpstr = hv_iterval(keys,entry);
1339             DEBUG_H(Perl_sv_setpvf(aTHX_ tmpstr, "%lu%%%d=%lu",
1340                             (unsigned long)HeHASH(entry),
1341                             (int)HvMAX(keys)+1,
1342                             (unsigned long)(HeHASH(entry) & HvMAX(keys))));
1343             XPUSHs(tmpstr);
1344         }
1345     }
1346     RETURN;
1347 }
1348
1349 /*
1350  * ex: set ts=8 sts=4 sw=4 et:
1351  */