This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
pp_pack.c: Make pack('U', 0x41) eq 'A'
[perl5.git] / pp_pack.c
1 /*    pp_pack.c
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4  *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 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  * He still hopefully carried some of his gear in his pack: a small tinder-box,
13  * two small shallow pans, the smaller fitting into the larger; inside them a
14  * wooden spoon, a short two-pronged fork and some skewers were stowed; and
15  * hidden at the bottom of the pack in a flat wooden box a dwindling treasure,
16  * some salt.
17  *
18  *     [p.653 of _The Lord of the Rings_, IV/iv: "Of Herbs and Stewed Rabbit"]
19  */
20
21 /* This file contains pp ("push/pop") functions that
22  * execute the opcodes that make up a perl program. A typical pp function
23  * expects to find its arguments on the stack, and usually pushes its
24  * results onto the stack, hence the 'pp' terminology. Each OP structure
25  * contains a pointer to the relevant pp_foo() function.
26  *
27  * This particular file just contains pp_pack() and pp_unpack(). See the
28  * other pp*.c files for the rest of the pp_ functions.
29  */
30
31 #include "EXTERN.h"
32 #define PERL_IN_PP_PACK_C
33 #include "perl.h"
34
35 /* Types used by pack/unpack */ 
36 typedef enum {
37   e_no_len,     /* no length  */
38   e_number,     /* number, [] */
39   e_star        /* asterisk   */
40 } howlen_t;
41
42 typedef struct tempsym {
43   const char*    patptr;   /* current template char */
44   const char*    patend;   /* one after last char   */
45   const char*    grpbeg;   /* 1st char of ()-group  */
46   const char*    grpend;   /* end of ()-group       */
47   I32      code;     /* template code (!<>)   */
48   I32      length;   /* length/repeat count   */
49   howlen_t howlen;   /* how length is given   */ 
50   int      level;    /* () nesting level      */
51   U32      flags;    /* /=4, comma=2, pack=1  */
52                      /*   and group modifiers */
53   STRLEN   strbeg;   /* offset of group start */
54   struct tempsym *previous; /* previous group */
55 } tempsym_t;
56
57 #define TEMPSYM_INIT(symptr, p, e, f) \
58     STMT_START {        \
59         (symptr)->patptr   = (p);       \
60         (symptr)->patend   = (e);       \
61         (symptr)->grpbeg   = NULL;      \
62         (symptr)->grpend   = NULL;      \
63         (symptr)->grpend   = NULL;      \
64         (symptr)->code     = 0;         \
65         (symptr)->length   = 0;         \
66         (symptr)->howlen   = e_no_len;  \
67         (symptr)->level    = 0;         \
68         (symptr)->flags    = (f);       \
69         (symptr)->strbeg   = 0;         \
70         (symptr)->previous = NULL;      \
71    } STMT_END
72
73 typedef union {
74     NV nv;
75     U8 bytes[sizeof(NV)];
76 } NV_bytes;
77
78 #if defined(HAS_LONG_DOUBLE) && defined(USE_LONG_DOUBLE)
79 typedef union {
80     long double ld;
81     U8 bytes[sizeof(long double)];
82 } ld_bytes;
83 #endif
84
85 #ifndef CHAR_BIT
86 # define CHAR_BIT       8
87 #endif
88 /* Maximum number of bytes to which a byte can grow due to upgrade */
89 #define UTF8_EXPAND     2
90
91 /*
92  * Offset for integer pack/unpack.
93  *
94  * On architectures where I16 and I32 aren't really 16 and 32 bits,
95  * which for now are all Crays, pack and unpack have to play games.
96  */
97
98 /*
99  * These values are required for portability of pack() output.
100  * If they're not right on your machine, then pack() and unpack()
101  * wouldn't work right anyway; you'll need to apply the Cray hack.
102  * (I'd like to check them with #if, but you can't use sizeof() in
103  * the preprocessor.)  --???
104  */
105 /*
106     The appropriate SHORTSIZE, INTSIZE, LONGSIZE, and LONGLONGSIZE
107     defines are now in config.h.  --Andy Dougherty  April 1998
108  */
109 #define SIZE16 2
110 #define SIZE32 4
111
112 /* CROSSCOMPILE and MULTIARCH are going to affect pp_pack() and pp_unpack().
113    --jhi Feb 1999 */
114
115 #if U16SIZE > SIZE16 || U32SIZE > SIZE32
116 #  if BYTEORDER == 0x1234 || BYTEORDER == 0x12345678    /* little-endian */
117 #    define OFF16(p)    ((char*)(p))
118 #    define OFF32(p)    ((char*)(p))
119 #  else
120 #    if BYTEORDER == 0x4321 || BYTEORDER == 0x87654321  /* big-endian */
121 #      define OFF16(p)  ((char*)(p) + (sizeof(U16) - SIZE16))
122 #      define OFF32(p)  ((char*)(p) + (sizeof(U32) - SIZE32))
123 #    else
124        ++++ bad cray byte order
125 #    endif
126 #  endif
127 #else
128 #  define OFF16(p)     ((char *) (p))
129 #  define OFF32(p)     ((char *) (p))
130 #endif
131
132 #define PUSH16(utf8, cur, p, needs_swap)                        \
133        PUSH_BYTES(utf8, cur, OFF16(p), SIZE16, needs_swap)
134 #define PUSH32(utf8, cur, p, needs_swap)                        \
135        PUSH_BYTES(utf8, cur, OFF32(p), SIZE32, needs_swap)
136
137 #if BYTEORDER == 0x4321 || BYTEORDER == 0x87654321  /* big-endian */
138 #  define NEEDS_SWAP(d)     (TYPE_ENDIANNESS(d) == TYPE_IS_LITTLE_ENDIAN)
139 #elif BYTEORDER == 0x1234 || BYTEORDER == 0x12345678  /* little-endian */
140 #  define NEEDS_SWAP(d)     (TYPE_ENDIANNESS(d) == TYPE_IS_BIG_ENDIAN)
141 #else
142 #  error "Unsupported byteorder"
143         /* Need to add code here to re-instate mixed endian support.
144            NEEDS_SWAP would need to hold a flag indicating which action to
145            take, and S_reverse_copy and the code in uni_to_bytes would need
146            logic adding to deal with any mixed-endian transformations needed.
147         */
148 #endif
149
150 /* Only to be used inside a loop (see the break) */
151 #define SHIFT_BYTES(utf8, s, strend, buf, len, datumtype, needs_swap)   \
152 STMT_START {                                            \
153     if (UNLIKELY(utf8)) {                               \
154         if (!uni_to_bytes(aTHX_ &s, strend,             \
155           (char *) (buf), len, datumtype)) break;       \
156     } else {                                            \
157         if (UNLIKELY(needs_swap))                       \
158             S_reverse_copy(s, (char *) (buf), len);     \
159         else                                            \
160             Copy(s, (char *) (buf), len, char);         \
161         s += len;                                       \
162     }                                                   \
163 } STMT_END
164
165 #define SHIFT16(utf8, s, strend, p, datumtype, needs_swap)              \
166        SHIFT_BYTES(utf8, s, strend, OFF16(p), SIZE16, datumtype, needs_swap)
167
168 #define SHIFT32(utf8, s, strend, p, datumtype, needs_swap)              \
169        SHIFT_BYTES(utf8, s, strend, OFF32(p), SIZE32, datumtype, needs_swap)
170
171 #define SHIFT_VAR(utf8, s, strend, var, datumtype, needs_swap)          \
172        SHIFT_BYTES(utf8, s, strend, &(var), sizeof(var), datumtype, needs_swap)
173
174 #define PUSH_VAR(utf8, aptr, var, needs_swap)           \
175        PUSH_BYTES(utf8, aptr, &(var), sizeof(var), needs_swap)
176
177 /* Avoid stack overflow due to pathological templates. 100 should be plenty. */
178 #define MAX_SUB_TEMPLATE_LEVEL 100
179
180 /* flags (note that type modifiers can also be used as flags!) */
181 #define FLAG_WAS_UTF8         0x40
182 #define FLAG_PARSE_UTF8       0x20      /* Parse as utf8 */
183 #define FLAG_UNPACK_ONLY_ONE  0x10
184 #define FLAG_DO_UTF8          0x08      /* The underlying string is utf8 */
185 #define FLAG_SLASH            0x04
186 #define FLAG_COMMA            0x02
187 #define FLAG_PACK             0x01
188
189 STATIC SV *
190 S_mul128(pTHX_ SV *sv, U8 m)
191 {
192   STRLEN          len;
193   char           *s = SvPV(sv, len);
194   char           *t;
195
196   PERL_ARGS_ASSERT_MUL128;
197
198   if (!strnEQ(s, "0000", 4)) {  /* need to grow sv */
199     SV * const tmpNew = newSVpvs("0000000000");
200
201     sv_catsv(tmpNew, sv);
202     SvREFCNT_dec(sv);           /* free old sv */
203     sv = tmpNew;
204     s = SvPV(sv, len);
205   }
206   t = s + len - 1;
207   while (!*t)                   /* trailing '\0'? */
208     t--;
209   while (t > s) {
210     const U32 i = ((*t - '0') << 7) + m;
211     *(t--) = '0' + (char)(i % 10);
212     m = (char)(i / 10);
213   }
214   return (sv);
215 }
216
217 /* Explosives and implosives. */
218
219 #if 'I' == 73 && 'J' == 74
220 /* On an ASCII/ISO kind of system */
221 #define ISUUCHAR(ch)    ((ch) >= ' ' && (ch) < 'a')
222 #else
223 /*
224   Some other sort of character set - use memchr() so we don't match
225   the null byte.
226  */
227 #define ISUUCHAR(ch)    (memchr(PL_uuemap, (ch), sizeof(PL_uuemap)-1) || (ch) == ' ')
228 #endif
229
230 /* type modifiers */
231 #define TYPE_IS_SHRIEKING       0x100
232 #define TYPE_IS_BIG_ENDIAN      0x200
233 #define TYPE_IS_LITTLE_ENDIAN   0x400
234 #define TYPE_IS_PACK            0x800
235 #define TYPE_ENDIANNESS_MASK    (TYPE_IS_BIG_ENDIAN|TYPE_IS_LITTLE_ENDIAN)
236 #define TYPE_MODIFIERS(t)       ((t) & ~0xFF)
237 #define TYPE_NO_MODIFIERS(t)    ((t) & 0xFF)
238
239 # define TYPE_ENDIANNESS(t)     ((t) & TYPE_ENDIANNESS_MASK)
240 # define TYPE_NO_ENDIANNESS(t)  ((t) & ~TYPE_ENDIANNESS_MASK)
241
242 # define ENDIANNESS_ALLOWED_TYPES   "sSiIlLqQjJfFdDpP("
243
244 #define PACK_SIZE_CANNOT_CSUM           0x80
245 #define PACK_SIZE_UNPREDICTABLE         0x40    /* Not a fixed size element */
246 #define PACK_SIZE_MASK                  0x3F
247
248 #include "packsizetables.c"
249
250 static void
251 S_reverse_copy(const char *src, char *dest, STRLEN len)
252 {
253     dest += len;
254     while (len--)
255         *--dest = *src++;
256 }
257
258 STATIC U8
259 uni_to_byte(pTHX_ const char **s, const char *end, I32 datumtype)
260 {
261     STRLEN retlen;
262     UV val = utf8n_to_uvchr((U8 *) *s, end-*s, &retlen,
263                          ckWARN(WARN_UTF8) ? 0 : UTF8_ALLOW_ANY);
264     /* We try to process malformed UTF-8 as much as possible (preferably with
265        warnings), but these two mean we make no progress in the string and
266        might enter an infinite loop */
267     if (retlen == (STRLEN) -1 || retlen == 0)
268         Perl_croak(aTHX_ "Malformed UTF-8 string in '%c' format in unpack",
269                    (int) TYPE_NO_MODIFIERS(datumtype));
270     if (val >= 0x100) {
271         Perl_ck_warner(aTHX_ packWARN(WARN_UNPACK),
272                        "Character in '%c' format wrapped in unpack",
273                        (int) TYPE_NO_MODIFIERS(datumtype));
274         val &= 0xff;
275     }
276     *s += retlen;
277     return (U8)val;
278 }
279
280 #define SHIFT_BYTE(utf8, s, strend, datumtype) ((utf8) ? \
281         uni_to_byte(aTHX_ &(s), (strend), (datumtype)) : \
282         *(U8 *)(s)++)
283
284 STATIC bool
285 uni_to_bytes(pTHX_ const char **s, const char *end, const char *buf, int buf_len, I32 datumtype)
286 {
287     UV val;
288     STRLEN retlen;
289     const char *from = *s;
290     int bad = 0;
291     const U32 flags = ckWARN(WARN_UTF8) ?
292         UTF8_CHECK_ONLY : (UTF8_CHECK_ONLY | UTF8_ALLOW_ANY);
293     const bool needs_swap = NEEDS_SWAP(datumtype);
294
295     if (UNLIKELY(needs_swap))
296         buf += buf_len;
297
298     for (;buf_len > 0; buf_len--) {
299         if (from >= end) return FALSE;
300         val = utf8n_to_uvchr((U8 *) from, end-from, &retlen, flags);
301         if (retlen == (STRLEN) -1 || retlen == 0) {
302             from += UTF8SKIP(from);
303             bad |= 1;
304         } else from += retlen;
305         if (val >= 0x100) {
306             bad |= 2;
307             val &= 0xff;
308         }
309         if (UNLIKELY(needs_swap))
310             *(U8 *)--buf = (U8)val;
311         else
312             *(U8 *)buf++ = (U8)val;
313     }
314     /* We have enough characters for the buffer. Did we have problems ? */
315     if (bad) {
316         if (bad & 1) {
317             /* Rewalk the string fragment while warning */
318             const char *ptr;
319             const int flags = ckWARN(WARN_UTF8) ? 0 : UTF8_ALLOW_ANY;
320             for (ptr = *s; ptr < from; ptr += UTF8SKIP(ptr)) {
321                 if (ptr >= end) break;
322                 utf8n_to_uvchr((U8 *) ptr, end-ptr, &retlen, flags);
323             }
324             if (from > end) from = end;
325         }
326         if ((bad & 2))
327             Perl_ck_warner(aTHX_ packWARN(datumtype & TYPE_IS_PACK ?
328                                        WARN_PACK : WARN_UNPACK),
329                            "Character(s) in '%c' format wrapped in %s",
330                            (int) TYPE_NO_MODIFIERS(datumtype),
331                            datumtype & TYPE_IS_PACK ? "pack" : "unpack");
332     }
333     *s = from;
334     return TRUE;
335 }
336
337 STATIC bool
338 next_uni_uu(pTHX_ const char **s, const char *end, I32 *out)
339 {
340     STRLEN retlen;
341     const UV val = utf8n_to_uvchr((U8 *) *s, end-*s, &retlen, UTF8_CHECK_ONLY);
342     if (val >= 0x100 || !ISUUCHAR(val) ||
343         retlen == (STRLEN) -1 || retlen == 0) {
344         *out = 0;
345         return FALSE;
346     }
347     *out = PL_uudmap[val] & 077;
348     *s += retlen;
349     return TRUE;
350 }
351
352 STATIC char *
353 S_bytes_to_uni(const U8 *start, STRLEN len, char *dest, const bool needs_swap) {
354     PERL_ARGS_ASSERT_BYTES_TO_UNI;
355
356     if (UNLIKELY(needs_swap)) {
357         const U8 *p = start + len;
358         while (p-- > start) {
359             append_utf8_from_native_byte(*p, (U8 **) & dest);
360         }
361     } else {
362         const U8 * const end = start + len;
363         while (start < end) {
364             append_utf8_from_native_byte(*start, (U8 **) & dest);
365             start++;
366         }
367     }
368     return dest;
369 }
370
371 #define PUSH_BYTES(utf8, cur, buf, len, needs_swap)             \
372 STMT_START {                                                    \
373     if (UNLIKELY(utf8))                                         \
374         (cur) = S_bytes_to_uni((U8 *) buf, len, (cur), needs_swap);       \
375     else {                                                      \
376         if (UNLIKELY(needs_swap))                               \
377             S_reverse_copy((char *)(buf), cur, len);            \
378         else                                                    \
379             Copy(buf, cur, len, char);                          \
380         (cur) += (len);                                         \
381     }                                                           \
382 } STMT_END
383
384 #define GROWING(utf8, cat, start, cur, in_len)  \
385 STMT_START {                                    \
386     STRLEN glen = (in_len);                     \
387     if (utf8) glen *= UTF8_EXPAND;              \
388     if ((cur) + glen >= (start) + SvLEN(cat)) { \
389         (start) = sv_exp_grow(cat, glen);       \
390         (cur) = (start) + SvCUR(cat);           \
391     }                                           \
392 } STMT_END
393
394 #define PUSH_GROWING_BYTES(utf8, cat, start, cur, buf, in_len) \
395 STMT_START {                                    \
396     const STRLEN glen = (in_len);               \
397     STRLEN gl = glen;                           \
398     if (utf8) gl *= UTF8_EXPAND;                \
399     if ((cur) + gl >= (start) + SvLEN(cat)) {   \
400         *cur = '\0';                            \
401         SvCUR_set((cat), (cur) - (start));      \
402         (start) = sv_exp_grow(cat, gl);         \
403         (cur) = (start) + SvCUR(cat);           \
404     }                                           \
405     PUSH_BYTES(utf8, cur, buf, glen, 0);        \
406 } STMT_END
407
408 #define PUSH_BYTE(utf8, s, byte)                \
409 STMT_START {                                    \
410     if (utf8) {                                 \
411         const U8 au8 = (byte);                  \
412         (s) = S_bytes_to_uni(&au8, 1, (s), 0);  \
413     } else *(U8 *)(s)++ = (byte);               \
414 } STMT_END
415
416 /* Only to be used inside a loop (see the break) */
417 #define NEXT_UNI_VAL(val, cur, str, end, utf8_flags)            \
418 STMT_START {                                                    \
419     STRLEN retlen;                                              \
420     if (str >= end) break;                                      \
421     val = utf8n_to_uvchr((U8 *) str, end-str, &retlen, utf8_flags);     \
422     if (retlen == (STRLEN) -1 || retlen == 0) {                 \
423         *cur = '\0';                                            \
424         Perl_croak(aTHX_ "Malformed UTF-8 string in pack");     \
425     }                                                           \
426     str += retlen;                                              \
427 } STMT_END
428
429 static const char *_action( const tempsym_t* symptr )
430 {
431     return (const char *)(( symptr->flags & FLAG_PACK ) ? "pack" : "unpack");
432 }
433
434 /* Returns the sizeof() struct described by pat */
435 STATIC I32
436 S_measure_struct(pTHX_ tempsym_t* symptr)
437 {
438     I32 total = 0;
439
440     PERL_ARGS_ASSERT_MEASURE_STRUCT;
441
442     while (next_symbol(symptr)) {
443         I32 len;
444         int size;
445
446         switch (symptr->howlen) {
447           case e_star:
448             Perl_croak(aTHX_ "Within []-length '*' not allowed in %s",
449                         _action( symptr ) );
450
451           default:
452             /* e_no_len and e_number */
453             len = symptr->length;
454             break;
455         }
456
457         size = packprops[TYPE_NO_ENDIANNESS(symptr->code)] & PACK_SIZE_MASK;
458         if (!size) {
459             int star;
460             /* endianness doesn't influence the size of a type */
461             switch(TYPE_NO_ENDIANNESS(symptr->code)) {
462             default:
463                 Perl_croak(aTHX_ "Invalid type '%c' in %s",
464                            (int)TYPE_NO_MODIFIERS(symptr->code),
465                            _action( symptr ) );
466             case '.' | TYPE_IS_SHRIEKING:
467             case '@' | TYPE_IS_SHRIEKING:
468             case '@':
469             case '.':
470             case '/':
471             case 'U':                   /* XXXX Is it correct? */
472             case 'w':
473             case 'u':
474                 Perl_croak(aTHX_ "Within []-length '%c' not allowed in %s",
475                            (int) TYPE_NO_MODIFIERS(symptr->code),
476                            _action( symptr ) );
477             case '%':
478                 size = 0;
479                 break;
480             case '(':
481             {
482                 tempsym_t savsym = *symptr;
483                 symptr->patptr = savsym.grpbeg;
484                 symptr->patend = savsym.grpend;
485                 /* XXXX Theoretically, we need to measure many times at
486                    different positions, since the subexpression may contain
487                    alignment commands, but be not of aligned length.
488                    Need to detect this and croak().  */
489                 size = measure_struct(symptr);
490                 *symptr = savsym;
491                 break;
492             }
493             case 'X' | TYPE_IS_SHRIEKING:
494                 /* XXXX Is this useful?  Then need to treat MEASURE_BACKWARDS.
495                  */
496                 if (!len)               /* Avoid division by 0 */
497                     len = 1;
498                 len = total % len;      /* Assumed: the start is aligned. */
499                 /* FALLTHROUGH */
500             case 'X':
501                 size = -1;
502                 if (total < len)
503                     Perl_croak(aTHX_ "'X' outside of string in %s", _action( symptr ) );
504                 break;
505             case 'x' | TYPE_IS_SHRIEKING:
506                 if (!len)               /* Avoid division by 0 */
507                     len = 1;
508                 star = total % len;     /* Assumed: the start is aligned. */
509                 if (star)               /* Other portable ways? */
510                     len = len - star;
511                 else
512                     len = 0;
513                 /* FALLTHROUGH */
514             case 'x':
515             case 'A':
516             case 'Z':
517             case 'a':
518                 size = 1;
519                 break;
520             case 'B':
521             case 'b':
522                 len = (len + 7)/8;
523                 size = 1;
524                 break;
525             case 'H':
526             case 'h':
527                 len = (len + 1)/2;
528                 size = 1;
529                 break;
530
531             case 'P':
532                 len = 1;
533                 size = sizeof(char*);
534                 break;
535             }
536         }
537         total += len * size;
538     }
539     return total;
540 }
541
542
543 /* locate matching closing parenthesis or bracket
544  * returns char pointer to char after match, or NULL
545  */
546 STATIC const char *
547 S_group_end(pTHX_ const char *patptr, const char *patend, char ender)
548 {
549     PERL_ARGS_ASSERT_GROUP_END;
550
551     while (patptr < patend) {
552         const char c = *patptr++;
553
554         if (isSPACE(c))
555             continue;
556         else if (c == ender)
557             return patptr-1;
558         else if (c == '#') {
559             while (patptr < patend && *patptr != '\n')
560                 patptr++;
561             continue;
562         } else if (c == '(')
563             patptr = group_end(patptr, patend, ')') + 1;
564         else if (c == '[')
565             patptr = group_end(patptr, patend, ']') + 1;
566     }
567     Perl_croak(aTHX_ "No group ending character '%c' found in template",
568                ender);
569     NOT_REACHED; /* NOTREACHED */
570 }
571
572
573 /* Convert unsigned decimal number to binary.
574  * Expects a pointer to the first digit and address of length variable
575  * Advances char pointer to 1st non-digit char and returns number
576  */
577 STATIC const char *
578 S_get_num(pTHX_ const char *patptr, I32 *lenptr )
579 {
580   I32 len = *patptr++ - '0';
581
582   PERL_ARGS_ASSERT_GET_NUM;
583
584   while (isDIGIT(*patptr)) {
585     if (len >= 0x7FFFFFFF/10)
586       Perl_croak(aTHX_ "pack/unpack repeat count overflow");
587     len = (len * 10) + (*patptr++ - '0');
588   }
589   *lenptr = len;
590   return patptr;
591 }
592
593 /* The marvellous template parsing routine: Using state stored in *symptr,
594  * locates next template code and count
595  */
596 STATIC bool
597 S_next_symbol(pTHX_ tempsym_t* symptr )
598 {
599   const char* patptr = symptr->patptr;
600   const char* const patend = symptr->patend;
601
602   PERL_ARGS_ASSERT_NEXT_SYMBOL;
603
604   symptr->flags &= ~FLAG_SLASH;
605
606   while (patptr < patend) {
607     if (isSPACE(*patptr))
608       patptr++;
609     else if (*patptr == '#') {
610       patptr++;
611       while (patptr < patend && *patptr != '\n')
612         patptr++;
613       if (patptr < patend)
614         patptr++;
615     } else {
616       /* We should have found a template code */
617       I32 code = *patptr++ & 0xFF;
618       U32 inherited_modifiers = 0;
619
620       if (code == ','){ /* grandfather in commas but with a warning */
621         if (((symptr->flags & FLAG_COMMA) == 0) && ckWARN(WARN_UNPACK)){
622           symptr->flags |= FLAG_COMMA;
623           Perl_warner(aTHX_ packWARN(WARN_UNPACK),
624                       "Invalid type ',' in %s", _action( symptr ) );
625         }
626         continue;
627       }
628
629       /* for '(', skip to ')' */
630       if (code == '(') {
631         if( isDIGIT(*patptr) || *patptr == '*' || *patptr == '[' )
632           Perl_croak(aTHX_ "()-group starts with a count in %s",
633                         _action( symptr ) );
634         symptr->grpbeg = patptr;
635         patptr = 1 + ( symptr->grpend = group_end(patptr, patend, ')') );
636         if( symptr->level >= MAX_SUB_TEMPLATE_LEVEL )
637           Perl_croak(aTHX_ "Too deeply nested ()-groups in %s",
638                         _action( symptr ) );
639       }
640
641       /* look for group modifiers to inherit */
642       if (TYPE_ENDIANNESS(symptr->flags)) {
643         if (strchr(ENDIANNESS_ALLOWED_TYPES, TYPE_NO_MODIFIERS(code)))
644           inherited_modifiers |= TYPE_ENDIANNESS(symptr->flags);
645       }
646
647       /* look for modifiers */
648       while (patptr < patend) {
649         const char *allowed;
650         I32 modifier;
651         switch (*patptr) {
652           case '!':
653             modifier = TYPE_IS_SHRIEKING;
654             allowed = "sSiIlLxXnNvV@.";
655             break;
656           case '>':
657             modifier = TYPE_IS_BIG_ENDIAN;
658             allowed = ENDIANNESS_ALLOWED_TYPES;
659             break;
660           case '<':
661             modifier = TYPE_IS_LITTLE_ENDIAN;
662             allowed = ENDIANNESS_ALLOWED_TYPES;
663             break;
664           default:
665             allowed = "";
666             modifier = 0;
667             break;
668         }
669
670         if (modifier == 0)
671           break;
672
673         if (!strchr(allowed, TYPE_NO_MODIFIERS(code)))
674           Perl_croak(aTHX_ "'%c' allowed only after types %s in %s", *patptr,
675                         allowed, _action( symptr ) );
676
677         if (TYPE_ENDIANNESS(code | modifier) == TYPE_ENDIANNESS_MASK)
678           Perl_croak(aTHX_ "Can't use both '<' and '>' after type '%c' in %s",
679                      (int) TYPE_NO_MODIFIERS(code), _action( symptr ) );
680         else if (TYPE_ENDIANNESS(code | modifier | inherited_modifiers) ==
681                  TYPE_ENDIANNESS_MASK)
682           Perl_croak(aTHX_ "Can't use '%c' in a group with different byte-order in %s",
683                      *patptr, _action( symptr ) );
684
685         if ((code & modifier)) {
686             Perl_ck_warner(aTHX_ packWARN(WARN_UNPACK),
687                            "Duplicate modifier '%c' after '%c' in %s",
688                            *patptr, (int) TYPE_NO_MODIFIERS(code),
689                            _action( symptr ) );
690         }
691
692         code |= modifier;
693         patptr++;
694       }
695
696       /* inherit modifiers */
697       code |= inherited_modifiers;
698
699       /* look for count and/or / */
700       if (patptr < patend) {
701         if (isDIGIT(*patptr)) {
702           patptr = get_num( patptr, &symptr->length );
703           symptr->howlen = e_number;
704
705         } else if (*patptr == '*') {
706           patptr++;
707           symptr->howlen = e_star;
708
709         } else if (*patptr == '[') {
710           const char* lenptr = ++patptr;
711           symptr->howlen = e_number;
712           patptr = group_end( patptr, patend, ']' ) + 1;
713           /* what kind of [] is it? */
714           if (isDIGIT(*lenptr)) {
715             lenptr = get_num( lenptr, &symptr->length );
716             if( *lenptr != ']' )
717               Perl_croak(aTHX_ "Malformed integer in [] in %s",
718                             _action( symptr ) );
719           } else {
720             tempsym_t savsym = *symptr;
721             symptr->patend = patptr-1;
722             symptr->patptr = lenptr;
723             savsym.length = measure_struct(symptr);
724             *symptr = savsym;
725           }
726         } else {
727           symptr->howlen = e_no_len;
728           symptr->length = 1;
729         }
730
731         /* try to find / */
732         while (patptr < patend) {
733           if (isSPACE(*patptr))
734             patptr++;
735           else if (*patptr == '#') {
736             patptr++;
737             while (patptr < patend && *patptr != '\n')
738               patptr++;
739             if (patptr < patend)
740               patptr++;
741           } else {
742             if (*patptr == '/') {
743               symptr->flags |= FLAG_SLASH;
744               patptr++;
745               if (patptr < patend &&
746                   (isDIGIT(*patptr) || *patptr == '*' || *patptr == '['))
747                 Perl_croak(aTHX_ "'/' does not take a repeat count in %s",
748                             _action( symptr ) );
749             }
750             break;
751           }
752         }
753       } else {
754         /* at end - no count, no / */
755         symptr->howlen = e_no_len;
756         symptr->length = 1;
757       }
758
759       symptr->code = code;
760       symptr->patptr = patptr;
761       return TRUE;
762     }
763   }
764   symptr->patptr = patptr;
765   return FALSE;
766 }
767
768 /*
769    There is no way to cleanly handle the case where we should process the
770    string per byte in its upgraded form while it's really in downgraded form
771    (e.g. estimates like strend-s as an upper bound for the number of
772    characters left wouldn't work). So if we foresee the need of this
773    (pattern starts with U or contains U0), we want to work on the encoded
774    version of the string. Users are advised to upgrade their pack string
775    themselves if they need to do a lot of unpacks like this on it
776 */
777 STATIC bool
778 need_utf8(const char *pat, const char *patend)
779 {
780     bool first = TRUE;
781
782     PERL_ARGS_ASSERT_NEED_UTF8;
783
784     while (pat < patend) {
785         if (pat[0] == '#') {
786             pat++;
787             pat = (const char *) memchr(pat, '\n', patend-pat);
788             if (!pat) return FALSE;
789         } else if (pat[0] == 'U') {
790             if (first || pat[1] == '0') return TRUE;
791         } else first = FALSE;
792         pat++;
793     }
794     return FALSE;
795 }
796
797 STATIC char
798 first_symbol(const char *pat, const char *patend) {
799     PERL_ARGS_ASSERT_FIRST_SYMBOL;
800
801     while (pat < patend) {
802         if (pat[0] != '#') return pat[0];
803         pat++;
804         pat = (const char *) memchr(pat, '\n', patend-pat);
805         if (!pat) return 0;
806         pat++;
807     }
808     return 0;
809 }
810
811 /*
812
813 =head1 Pack and Unpack
814
815 =for apidoc unpackstring
816
817 The engine implementing the unpack() Perl function.
818
819 Using the template pat..patend, this function unpacks the string
820 s..strend into a number of mortal SVs, which it pushes onto the perl
821 argument (@_) stack (so you will need to issue a C<PUTBACK> before and
822 C<SPAGAIN> after the call to this function).  It returns the number of
823 pushed elements.
824
825 The strend and patend pointers should point to the byte following the last
826 character of each string.
827
828 Although this function returns its values on the perl argument stack, it
829 doesn't take any parameters from that stack (and thus in particular
830 there's no need to do a PUSHMARK before calling it, unlike L</call_pv> for
831 example).
832
833 =cut */
834
835 I32
836 Perl_unpackstring(pTHX_ const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
837 {
838     tempsym_t sym;
839
840     PERL_ARGS_ASSERT_UNPACKSTRING;
841
842     if (flags & FLAG_DO_UTF8) flags |= FLAG_WAS_UTF8;
843     else if (need_utf8(pat, patend)) {
844         /* We probably should try to avoid this in case a scalar context call
845            wouldn't get to the "U0" */
846         STRLEN len = strend - s;
847         s = (char *) bytes_to_utf8((U8 *) s, &len);
848         SAVEFREEPV(s);
849         strend = s + len;
850         flags |= FLAG_DO_UTF8;
851     }
852
853     if (first_symbol(pat, patend) != 'U' && (flags & FLAG_DO_UTF8))
854         flags |= FLAG_PARSE_UTF8;
855
856     TEMPSYM_INIT(&sym, pat, patend, flags);
857
858     return unpack_rec(&sym, s, s, strend, NULL );
859 }
860
861 STATIC I32
862 S_unpack_rec(pTHX_ tempsym_t* symptr, const char *s, const char *strbeg, const char *strend, const char **new_s )
863 {
864     dSP;
865     SV *sv = NULL;
866     const I32 start_sp_offset = SP - PL_stack_base;
867     howlen_t howlen;
868     I32 checksum = 0;
869     UV cuv = 0;
870     NV cdouble = 0.0;
871     const int bits_in_uv = CHAR_BIT * sizeof(cuv);
872     bool beyond = FALSE;
873     bool explicit_length;
874     const bool unpack_only_one = (symptr->flags & FLAG_UNPACK_ONLY_ONE) != 0;
875     bool utf8 = (symptr->flags & FLAG_PARSE_UTF8) ? 1 : 0;
876
877     PERL_ARGS_ASSERT_UNPACK_REC;
878
879     symptr->strbeg = s - strbeg;
880
881     while (next_symbol(symptr)) {
882         packprops_t props;
883         I32 len;
884         I32 datumtype = symptr->code;
885         bool needs_swap;
886         /* do first one only unless in list context
887            / is implemented by unpacking the count, then popping it from the
888            stack, so must check that we're not in the middle of a /  */
889         if ( unpack_only_one
890              && (SP - PL_stack_base == start_sp_offset + 1)
891              && (datumtype != '/') )   /* XXX can this be omitted */
892             break;
893
894         switch (howlen = symptr->howlen) {
895           case e_star:
896             len = strend - strbeg;      /* long enough */
897             break;
898           default:
899             /* e_no_len and e_number */
900             len = symptr->length;
901             break;
902         }
903
904         explicit_length = TRUE;
905       redo_switch:
906         beyond = s >= strend;
907
908         props = packprops[TYPE_NO_ENDIANNESS(datumtype)];
909         if (props) {
910             /* props nonzero means we can process this letter. */
911             const long size = props & PACK_SIZE_MASK;
912             const long howmany = (strend - s) / size;
913             if (len > howmany)
914                 len = howmany;
915
916             if (!checksum || (props & PACK_SIZE_CANNOT_CSUM)) {
917                 if (len && unpack_only_one) len = 1;
918                 EXTEND(SP, len);
919                 EXTEND_MORTAL(len);
920             }
921         }
922
923         needs_swap = NEEDS_SWAP(datumtype);
924
925         switch(TYPE_NO_ENDIANNESS(datumtype)) {
926         default:
927             Perl_croak(aTHX_ "Invalid type '%c' in unpack", (int)TYPE_NO_MODIFIERS(datumtype) );
928
929         case '%':
930             if (howlen == e_no_len)
931                 len = 16;               /* len is not specified */
932             checksum = len;
933             cuv = 0;
934             cdouble = 0;
935             continue;
936
937         case '(':
938         {
939             tempsym_t savsym = *symptr;
940             const U32 group_modifiers = TYPE_MODIFIERS(datumtype & ~symptr->flags);
941             symptr->flags |= group_modifiers;
942             symptr->patend = savsym.grpend;
943             symptr->previous = &savsym;
944             symptr->level++;
945             PUTBACK;
946             if (len && unpack_only_one) len = 1;
947             while (len--) {
948                 symptr->patptr = savsym.grpbeg;
949                 if (utf8) symptr->flags |=  FLAG_PARSE_UTF8;
950                 else      symptr->flags &= ~FLAG_PARSE_UTF8;
951                 unpack_rec(symptr, s, strbeg, strend, &s);
952                 if (s == strend && savsym.howlen == e_star)
953                     break; /* No way to continue */
954             }
955             SPAGAIN;
956             savsym.flags = symptr->flags & ~group_modifiers;
957             *symptr = savsym;
958             break;
959         }
960         case '.' | TYPE_IS_SHRIEKING:
961         case '.': {
962             const char *from;
963             SV *sv;
964             const bool u8 = utf8 && !(datumtype & TYPE_IS_SHRIEKING);
965             if (howlen == e_star) from = strbeg;
966             else if (len <= 0) from = s;
967             else {
968                 tempsym_t *group = symptr;
969
970                 while (--len && group) group = group->previous;
971                 from = group ? strbeg + group->strbeg : strbeg;
972             }
973             sv = from <= s ?
974                 newSVuv(  u8 ? (UV) utf8_length((const U8*)from, (const U8*)s) : (UV) (s-from)) :
975                 newSViv(-(u8 ? (IV) utf8_length((const U8*)s, (const U8*)from) : (IV) (from-s)));
976             mXPUSHs(sv);
977             break;
978         }
979         case '@' | TYPE_IS_SHRIEKING:
980         case '@':
981             s = strbeg + symptr->strbeg;
982             if (utf8  && !(datumtype & TYPE_IS_SHRIEKING))
983             {
984                 while (len > 0) {
985                     if (s >= strend)
986                         Perl_croak(aTHX_ "'@' outside of string in unpack");
987                     s += UTF8SKIP(s);
988                     len--;
989                 }
990                 if (s > strend)
991                     Perl_croak(aTHX_ "'@' outside of string with malformed UTF-8 in unpack");
992             } else {
993                 if (strend-s < len)
994                     Perl_croak(aTHX_ "'@' outside of string in unpack");
995                 s += len;
996             }
997             break;
998         case 'X' | TYPE_IS_SHRIEKING:
999             if (!len)                   /* Avoid division by 0 */
1000                 len = 1;
1001             if (utf8) {
1002                 const char *hop, *last;
1003                 I32 l = len;
1004                 hop = last = strbeg;
1005                 while (hop < s) {
1006                     hop += UTF8SKIP(hop);
1007                     if (--l == 0) {
1008                         last = hop;
1009                         l = len;
1010                     }
1011                 }
1012                 if (last > s)
1013                     Perl_croak(aTHX_ "Malformed UTF-8 string in unpack");
1014                 s = last;
1015                 break;
1016             }
1017             len = (s - strbeg) % len;
1018             /* FALLTHROUGH */
1019         case 'X':
1020             if (utf8) {
1021                 while (len > 0) {
1022                     if (s <= strbeg)
1023                         Perl_croak(aTHX_ "'X' outside of string in unpack");
1024                     while (--s, UTF8_IS_CONTINUATION(*s)) {
1025                         if (s <= strbeg)
1026                             Perl_croak(aTHX_ "'X' outside of string in unpack");
1027                     }
1028                     len--;
1029                 }
1030             } else {
1031                 if (len > s - strbeg)
1032                     Perl_croak(aTHX_ "'X' outside of string in unpack" );
1033                 s -= len;
1034             }
1035             break;
1036         case 'x' | TYPE_IS_SHRIEKING: {
1037             I32 ai32;
1038             if (!len)                   /* Avoid division by 0 */
1039                 len = 1;
1040             if (utf8) ai32 = utf8_length((U8 *) strbeg, (U8 *) s) % len;
1041             else      ai32 = (s - strbeg)                         % len;
1042             if (ai32 == 0) break;
1043             len -= ai32;
1044             }
1045             /* FALLTHROUGH */
1046         case 'x':
1047             if (utf8) {
1048                 while (len>0) {
1049                     if (s >= strend)
1050                         Perl_croak(aTHX_ "'x' outside of string in unpack");
1051                     s += UTF8SKIP(s);
1052                     len--;
1053                 }
1054             } else {
1055                 if (len > strend - s)
1056                     Perl_croak(aTHX_ "'x' outside of string in unpack");
1057                 s += len;
1058             }
1059             break;
1060         case '/':
1061             Perl_croak(aTHX_ "'/' must follow a numeric type in unpack");
1062
1063         case 'A':
1064         case 'Z':
1065         case 'a':
1066             if (checksum) {
1067                 /* Preliminary length estimate is assumed done in 'W' */
1068                 if (len > strend - s) len = strend - s;
1069                 goto W_checksum;
1070             }
1071             if (utf8) {
1072                 I32 l;
1073                 const char *hop;
1074                 for (l=len, hop=s; l>0; l--, hop += UTF8SKIP(hop)) {
1075                     if (hop >= strend) {
1076                         if (hop > strend)
1077                             Perl_croak(aTHX_ "Malformed UTF-8 string in unpack");
1078                         break;
1079                     }
1080                 }
1081                 if (hop > strend)
1082                     Perl_croak(aTHX_ "Malformed UTF-8 string in unpack");
1083                 len = hop - s;
1084             } else if (len > strend - s)
1085                 len = strend - s;
1086
1087             if (datumtype == 'Z') {
1088                 /* 'Z' strips stuff after first null */
1089                 const char *ptr, *end;
1090                 end = s + len;
1091                 for (ptr = s; ptr < end; ptr++) if (*ptr == 0) break;
1092                 sv = newSVpvn(s, ptr-s);
1093                 if (howlen == e_star) /* exact for 'Z*' */
1094                     len = ptr-s + (ptr != strend ? 1 : 0);
1095             } else if (datumtype == 'A') {
1096                 /* 'A' strips both nulls and spaces */
1097                 const char *ptr;
1098                 if (utf8 && (symptr->flags & FLAG_WAS_UTF8)) {
1099                     for (ptr = s+len-1; ptr >= s; ptr--)
1100                         if (*ptr != 0 && !UTF8_IS_CONTINUATION(*ptr) &&
1101                             !isSPACE_utf8(ptr)) break;
1102                     if (ptr >= s) ptr += UTF8SKIP(ptr);
1103                     else ptr++;
1104                     if (ptr > s+len)
1105                         Perl_croak(aTHX_ "Malformed UTF-8 string in unpack");
1106                 } else {
1107                     for (ptr = s+len-1; ptr >= s; ptr--)
1108                         if (*ptr != 0 && !isSPACE(*ptr)) break;
1109                     ptr++;
1110                 }
1111                 sv = newSVpvn(s, ptr-s);
1112             } else sv = newSVpvn(s, len);
1113
1114             if (utf8) {
1115                 SvUTF8_on(sv);
1116                 /* Undo any upgrade done due to need_utf8() */
1117                 if (!(symptr->flags & FLAG_WAS_UTF8))
1118                     sv_utf8_downgrade(sv, 0);
1119             }
1120             mXPUSHs(sv);
1121             s += len;
1122             break;
1123         case 'B':
1124         case 'b': {
1125             char *str;
1126             if (howlen == e_star || len > (strend - s) * 8)
1127                 len = (strend - s) * 8;
1128             if (checksum) {
1129                 if (utf8)
1130                     while (len >= 8 && s < strend) {
1131                         cuv += PL_bitcount[uni_to_byte(aTHX_ &s, strend, datumtype)];
1132                         len -= 8;
1133                     }
1134                 else
1135                     while (len >= 8) {
1136                         cuv += PL_bitcount[*(U8 *)s++];
1137                         len -= 8;
1138                     }
1139                 if (len && s < strend) {
1140                     U8 bits;
1141                     bits = SHIFT_BYTE(utf8, s, strend, datumtype);
1142                     if (datumtype == 'b')
1143                         while (len-- > 0) {
1144                             if (bits & 1) cuv++;
1145                             bits >>= 1;
1146                         }
1147                     else
1148                         while (len-- > 0) {
1149                             if (bits & 0x80) cuv++;
1150                             bits <<= 1;
1151                         }
1152                 }
1153                 break;
1154             }
1155
1156             sv = sv_2mortal(newSV(len ? len : 1));
1157             SvPOK_on(sv);
1158             str = SvPVX(sv);
1159             if (datumtype == 'b') {
1160                 U8 bits = 0;
1161                 const I32 ai32 = len;
1162                 for (len = 0; len < ai32; len++) {
1163                     if (len & 7) bits >>= 1;
1164                     else if (utf8) {
1165                         if (s >= strend) break;
1166                         bits = uni_to_byte(aTHX_ &s, strend, datumtype);
1167                     } else bits = *(U8 *) s++;
1168                     *str++ = bits & 1 ? '1' : '0';
1169                 }
1170             } else {
1171                 U8 bits = 0;
1172                 const I32 ai32 = len;
1173                 for (len = 0; len < ai32; len++) {
1174                     if (len & 7) bits <<= 1;
1175                     else if (utf8) {
1176                         if (s >= strend) break;
1177                         bits = uni_to_byte(aTHX_ &s, strend, datumtype);
1178                     } else bits = *(U8 *) s++;
1179                     *str++ = bits & 0x80 ? '1' : '0';
1180                 }
1181             }
1182             *str = '\0';
1183             SvCUR_set(sv, str - SvPVX_const(sv));
1184             XPUSHs(sv);
1185             break;
1186         }
1187         case 'H':
1188         case 'h': {
1189             char *str = NULL;
1190             /* Preliminary length estimate, acceptable for utf8 too */
1191             if (howlen == e_star || len > (strend - s) * 2)
1192                 len = (strend - s) * 2;
1193             if (!checksum) {
1194                 sv = sv_2mortal(newSV(len ? len : 1));
1195                 SvPOK_on(sv);
1196                 str = SvPVX(sv);
1197             }
1198             if (datumtype == 'h') {
1199                 U8 bits = 0;
1200                 I32 ai32 = len;
1201                 for (len = 0; len < ai32; len++) {
1202                     if (len & 1) bits >>= 4;
1203                     else if (utf8) {
1204                         if (s >= strend) break;
1205                         bits = uni_to_byte(aTHX_ &s, strend, datumtype);
1206                     } else bits = * (U8 *) s++;
1207                     if (!checksum)
1208                         *str++ = PL_hexdigit[bits & 15];
1209                 }
1210             } else {
1211                 U8 bits = 0;
1212                 const I32 ai32 = len;
1213                 for (len = 0; len < ai32; len++) {
1214                     if (len & 1) bits <<= 4;
1215                     else if (utf8) {
1216                         if (s >= strend) break;
1217                         bits = uni_to_byte(aTHX_ &s, strend, datumtype);
1218                     } else bits = *(U8 *) s++;
1219                     if (!checksum)
1220                         *str++ = PL_hexdigit[(bits >> 4) & 15];
1221                 }
1222             }
1223             if (!checksum) {
1224                 *str = '\0';
1225                 SvCUR_set(sv, str - SvPVX_const(sv));
1226                 XPUSHs(sv);
1227             }
1228             break;
1229         }
1230         case 'C':
1231             if (len == 0) {
1232                 if (explicit_length)
1233                     /* Switch to "character" mode */
1234                     utf8 = (symptr->flags & FLAG_DO_UTF8) ? 1 : 0;
1235                 break;
1236             }
1237             /* FALLTHROUGH */
1238         case 'c':
1239             while (len-- > 0 && s < strend) {
1240                 int aint;
1241                 if (utf8)
1242                   {
1243                     STRLEN retlen;
1244                     aint = utf8n_to_uvchr((U8 *) s, strend-s, &retlen,
1245                                  ckWARN(WARN_UTF8) ? 0 : UTF8_ALLOW_ANY);
1246                     if (retlen == (STRLEN) -1 || retlen == 0)
1247                         Perl_croak(aTHX_ "Malformed UTF-8 string in unpack");
1248                     s += retlen;
1249                   }
1250                 else
1251                   aint = *(U8 *)(s)++;
1252                 if (aint >= 128 && datumtype != 'C')    /* fake up signed chars */
1253                     aint -= 256;
1254                 if (!checksum)
1255                     mPUSHi(aint);
1256                 else if (checksum > bits_in_uv)
1257                     cdouble += (NV)aint;
1258                 else
1259                     cuv += aint;
1260             }
1261             break;
1262         case 'W':
1263           W_checksum:
1264             if (utf8) {
1265                 while (len-- > 0 && s < strend) {
1266                     STRLEN retlen;
1267                     const UV val = utf8n_to_uvchr((U8 *) s, strend-s, &retlen,
1268                                          ckWARN(WARN_UTF8) ? 0 : UTF8_ALLOW_ANY);
1269                     if (retlen == (STRLEN) -1 || retlen == 0)
1270                         Perl_croak(aTHX_ "Malformed UTF-8 string in unpack");
1271                     s += retlen;
1272                     if (!checksum)
1273                         mPUSHu(val);
1274                     else if (checksum > bits_in_uv)
1275                         cdouble += (NV) val;
1276                     else
1277                         cuv += val;
1278                 }
1279             } else if (!checksum)
1280                 while (len-- > 0) {
1281                     const U8 ch = *(U8 *) s++;
1282                     mPUSHu(ch);
1283             }
1284             else if (checksum > bits_in_uv)
1285                 while (len-- > 0) cdouble += (NV) *(U8 *) s++;
1286             else
1287                 while (len-- > 0) cuv += *(U8 *) s++;
1288             break;
1289         case 'U':
1290             if (len == 0) {
1291                 if (explicit_length && howlen != e_star) {
1292                     /* Switch to "bytes in UTF-8" mode */
1293                     if (symptr->flags & FLAG_DO_UTF8) utf8 = 0;
1294                     else
1295                         /* Should be impossible due to the need_utf8() test */
1296                         Perl_croak(aTHX_ "U0 mode on a byte string");
1297                 }
1298                 break;
1299             }
1300             if (len > strend - s) len = strend - s;
1301             if (!checksum) {
1302                 if (len && unpack_only_one) len = 1;
1303                 EXTEND(SP, len);
1304                 EXTEND_MORTAL(len);
1305             }
1306             while (len-- > 0 && s < strend) {
1307                 STRLEN retlen;
1308                 UV auv;
1309                 if (utf8) {
1310                     U8 result[UTF8_MAXLEN];
1311                     const char *ptr = s;
1312                     STRLEN len;
1313                     /* Bug: warns about bad utf8 even if we are short on bytes
1314                        and will break out of the loop */
1315                     if (!uni_to_bytes(aTHX_ &ptr, strend, (char *) result, 1,
1316                                       'U'))
1317                         break;
1318                     len = UTF8SKIP(result);
1319                     if (!uni_to_bytes(aTHX_ &ptr, strend,
1320                                       (char *) &result[1], len-1, 'U')) break;
1321                     auv = NATIVE_TO_UNI(utf8n_to_uvchr(result,
1322                                                        len,
1323                                                        &retlen,
1324                                                        UTF8_ALLOW_DEFAULT));
1325                     s = ptr;
1326                 } else {
1327                     auv = NATIVE_TO_UNI(utf8n_to_uvchr((U8*)s,
1328                                                        strend - s,
1329                                                        &retlen,
1330                                                        UTF8_ALLOW_DEFAULT));
1331                     if (retlen == (STRLEN) -1 || retlen == 0)
1332                         Perl_croak(aTHX_ "Malformed UTF-8 string in unpack");
1333                     s += retlen;
1334                 }
1335                 if (!checksum)
1336                     mPUSHu(auv);
1337                 else if (checksum > bits_in_uv)
1338                     cdouble += (NV) auv;
1339                 else
1340                     cuv += auv;
1341             }
1342             break;
1343         case 's' | TYPE_IS_SHRIEKING:
1344 #if SHORTSIZE != SIZE16
1345             while (len-- > 0) {
1346                 short ashort;
1347                 SHIFT_VAR(utf8, s, strend, ashort, datumtype, needs_swap);
1348                 if (!checksum)
1349                     mPUSHi(ashort);
1350                 else if (checksum > bits_in_uv)
1351                     cdouble += (NV)ashort;
1352                 else
1353                     cuv += ashort;
1354             }
1355             break;
1356 #else
1357             /* FALLTHROUGH */
1358 #endif
1359         case 's':
1360             while (len-- > 0) {
1361                 I16 ai16;
1362
1363 #if U16SIZE > SIZE16
1364                 ai16 = 0;
1365 #endif
1366                 SHIFT16(utf8, s, strend, &ai16, datumtype, needs_swap);
1367 #if U16SIZE > SIZE16
1368                 if (ai16 > 32767)
1369                     ai16 -= 65536;
1370 #endif
1371                 if (!checksum)
1372                     mPUSHi(ai16);
1373                 else if (checksum > bits_in_uv)
1374                     cdouble += (NV)ai16;
1375                 else
1376                     cuv += ai16;
1377             }
1378             break;
1379         case 'S' | TYPE_IS_SHRIEKING:
1380 #if SHORTSIZE != SIZE16
1381             while (len-- > 0) {
1382                 unsigned short aushort;
1383                 SHIFT_VAR(utf8, s, strend, aushort, datumtype, needs_swap,
1384                           needs_swap);
1385                 if (!checksum)
1386                     mPUSHu(aushort);
1387                 else if (checksum > bits_in_uv)
1388                     cdouble += (NV)aushort;
1389                 else
1390                     cuv += aushort;
1391             }
1392             break;
1393 #else
1394             /* FALLTHROUGH */
1395 #endif
1396         case 'v':
1397         case 'n':
1398         case 'S':
1399             while (len-- > 0) {
1400                 U16 au16;
1401 #if U16SIZE > SIZE16
1402                 au16 = 0;
1403 #endif
1404                 SHIFT16(utf8, s, strend, &au16, datumtype, needs_swap);
1405                 if (datumtype == 'n')
1406                     au16 = PerlSock_ntohs(au16);
1407                 if (datumtype == 'v')
1408                     au16 = vtohs(au16);
1409                 if (!checksum)
1410                     mPUSHu(au16);
1411                 else if (checksum > bits_in_uv)
1412                     cdouble += (NV) au16;
1413                 else
1414                     cuv += au16;
1415             }
1416             break;
1417         case 'v' | TYPE_IS_SHRIEKING:
1418         case 'n' | TYPE_IS_SHRIEKING:
1419             while (len-- > 0) {
1420                 I16 ai16;
1421 # if U16SIZE > SIZE16
1422                 ai16 = 0;
1423 # endif
1424                 SHIFT16(utf8, s, strend, &ai16, datumtype, needs_swap);
1425                 /* There should never be any byte-swapping here.  */
1426                 assert(!TYPE_ENDIANNESS(datumtype));
1427                 if (datumtype == ('n' | TYPE_IS_SHRIEKING))
1428                     ai16 = (I16) PerlSock_ntohs((U16) ai16);
1429                 if (datumtype == ('v' | TYPE_IS_SHRIEKING))
1430                     ai16 = (I16) vtohs((U16) ai16);
1431                 if (!checksum)
1432                     mPUSHi(ai16);
1433                 else if (checksum > bits_in_uv)
1434                     cdouble += (NV) ai16;
1435                 else
1436                     cuv += ai16;
1437             }
1438             break;
1439         case 'i':
1440         case 'i' | TYPE_IS_SHRIEKING:
1441             while (len-- > 0) {
1442                 int aint;
1443                 SHIFT_VAR(utf8, s, strend, aint, datumtype, needs_swap);
1444                 if (!checksum)
1445                     mPUSHi(aint);
1446                 else if (checksum > bits_in_uv)
1447                     cdouble += (NV)aint;
1448                 else
1449                     cuv += aint;
1450             }
1451             break;
1452         case 'I':
1453         case 'I' | TYPE_IS_SHRIEKING:
1454             while (len-- > 0) {
1455                 unsigned int auint;
1456                 SHIFT_VAR(utf8, s, strend, auint, datumtype, needs_swap);
1457                 if (!checksum)
1458                     mPUSHu(auint);
1459                 else if (checksum > bits_in_uv)
1460                     cdouble += (NV)auint;
1461                 else
1462                     cuv += auint;
1463             }
1464             break;
1465         case 'j':
1466             while (len-- > 0) {
1467                 IV aiv;
1468                 SHIFT_VAR(utf8, s, strend, aiv, datumtype, needs_swap);
1469                 if (!checksum)
1470                     mPUSHi(aiv);
1471                 else if (checksum > bits_in_uv)
1472                     cdouble += (NV)aiv;
1473                 else
1474                     cuv += aiv;
1475             }
1476             break;
1477         case 'J':
1478             while (len-- > 0) {
1479                 UV auv;
1480                 SHIFT_VAR(utf8, s, strend, auv, datumtype, needs_swap);
1481                 if (!checksum)
1482                     mPUSHu(auv);
1483                 else if (checksum > bits_in_uv)
1484                     cdouble += (NV)auv;
1485                 else
1486                     cuv += auv;
1487             }
1488             break;
1489         case 'l' | TYPE_IS_SHRIEKING:
1490 #if LONGSIZE != SIZE32
1491             while (len-- > 0) {
1492                 long along;
1493                 SHIFT_VAR(utf8, s, strend, along, datumtype, needs_swap);
1494                 if (!checksum)
1495                     mPUSHi(along);
1496                 else if (checksum > bits_in_uv)
1497                     cdouble += (NV)along;
1498                 else
1499                     cuv += along;
1500             }
1501             break;
1502 #else
1503             /* FALLTHROUGH */
1504 #endif
1505         case 'l':
1506             while (len-- > 0) {
1507                 I32 ai32;
1508 #if U32SIZE > SIZE32
1509                 ai32 = 0;
1510 #endif
1511                 SHIFT32(utf8, s, strend, &ai32, datumtype, needs_swap);
1512 #if U32SIZE > SIZE32
1513                 if (ai32 > 2147483647) ai32 -= 4294967296;
1514 #endif
1515                 if (!checksum)
1516                     mPUSHi(ai32);
1517                 else if (checksum > bits_in_uv)
1518                     cdouble += (NV)ai32;
1519                 else
1520                     cuv += ai32;
1521             }
1522             break;
1523         case 'L' | TYPE_IS_SHRIEKING:
1524 #if LONGSIZE != SIZE32
1525             while (len-- > 0) {
1526                 unsigned long aulong;
1527                 SHIFT_VAR(utf8, s, strend, aulong, datumtype, needs_swap);
1528                 if (!checksum)
1529                     mPUSHu(aulong);
1530                 else if (checksum > bits_in_uv)
1531                     cdouble += (NV)aulong;
1532                 else
1533                     cuv += aulong;
1534             }
1535             break;
1536 #else
1537             /* FALLTHROUGH */
1538 #endif
1539         case 'V':
1540         case 'N':
1541         case 'L':
1542             while (len-- > 0) {
1543                 U32 au32;
1544 #if U32SIZE > SIZE32
1545                 au32 = 0;
1546 #endif
1547                 SHIFT32(utf8, s, strend, &au32, datumtype, needs_swap);
1548                 if (datumtype == 'N')
1549                     au32 = PerlSock_ntohl(au32);
1550                 if (datumtype == 'V')
1551                     au32 = vtohl(au32);
1552                 if (!checksum)
1553                     mPUSHu(au32);
1554                 else if (checksum > bits_in_uv)
1555                     cdouble += (NV)au32;
1556                 else
1557                     cuv += au32;
1558             }
1559             break;
1560         case 'V' | TYPE_IS_SHRIEKING:
1561         case 'N' | TYPE_IS_SHRIEKING:
1562             while (len-- > 0) {
1563                 I32 ai32;
1564 #if U32SIZE > SIZE32
1565                 ai32 = 0;
1566 #endif
1567                 SHIFT32(utf8, s, strend, &ai32, datumtype, needs_swap);
1568                 /* There should never be any byte swapping here.  */
1569                 assert(!TYPE_ENDIANNESS(datumtype));
1570                 if (datumtype == ('N' | TYPE_IS_SHRIEKING))
1571                     ai32 = (I32)PerlSock_ntohl((U32)ai32);
1572                 if (datumtype == ('V' | TYPE_IS_SHRIEKING))
1573                     ai32 = (I32)vtohl((U32)ai32);
1574                 if (!checksum)
1575                     mPUSHi(ai32);
1576                 else if (checksum > bits_in_uv)
1577                     cdouble += (NV)ai32;
1578                 else
1579                     cuv += ai32;
1580             }
1581             break;
1582         case 'p':
1583             while (len-- > 0) {
1584                 const char *aptr;
1585                 SHIFT_VAR(utf8, s, strend, aptr, datumtype, needs_swap);
1586                 /* newSVpv generates undef if aptr is NULL */
1587                 mPUSHs(newSVpv(aptr, 0));
1588             }
1589             break;
1590         case 'w':
1591             {
1592                 UV auv = 0;
1593                 U32 bytes = 0;
1594
1595                 while (len > 0 && s < strend) {
1596                     U8 ch;
1597                     ch = SHIFT_BYTE(utf8, s, strend, datumtype);
1598                     auv = (auv << 7) | (ch & 0x7f);
1599                     /* UTF8_IS_XXXXX not right here - using constant 0x80 */
1600                     if (ch < 0x80) {
1601                         bytes = 0;
1602                         mPUSHu(auv);
1603                         len--;
1604                         auv = 0;
1605                         continue;
1606                     }
1607                     if (++bytes >= sizeof(UV)) {        /* promote to string */
1608                         const char *t;
1609
1610                         sv = Perl_newSVpvf(aTHX_ "%.*"UVuf, (int)TYPE_DIGITS(UV), auv);
1611                         while (s < strend) {
1612                             ch = SHIFT_BYTE(utf8, s, strend, datumtype);
1613                             sv = mul128(sv, (U8)(ch & 0x7f));
1614                             if (!(ch & 0x80)) {
1615                                 bytes = 0;
1616                                 break;
1617                             }
1618                         }
1619                         t = SvPV_nolen_const(sv);
1620                         while (*t == '0')
1621                             t++;
1622                         sv_chop(sv, t);
1623                         mPUSHs(sv);
1624                         len--;
1625                         auv = 0;
1626                     }
1627                 }
1628                 if ((s >= strend) && bytes)
1629                     Perl_croak(aTHX_ "Unterminated compressed integer in unpack");
1630             }
1631             break;
1632         case 'P':
1633             if (symptr->howlen == e_star)
1634                 Perl_croak(aTHX_ "'P' must have an explicit size in unpack");
1635             EXTEND(SP, 1);
1636             if (s + sizeof(char*) <= strend) {
1637                 char *aptr;
1638                 SHIFT_VAR(utf8, s, strend, aptr, datumtype, needs_swap);
1639                 /* newSVpvn generates undef if aptr is NULL */
1640                 PUSHs(newSVpvn_flags(aptr, len, SVs_TEMP));
1641             }
1642             break;
1643 #if defined(HAS_QUAD) && IVSIZE >= 8
1644         case 'q':
1645             while (len-- > 0) {
1646                 Quad_t aquad;
1647                 SHIFT_VAR(utf8, s, strend, aquad, datumtype, needs_swap);
1648                 if (!checksum)
1649                     mPUSHs(newSViv((IV)aquad));
1650                 else if (checksum > bits_in_uv)
1651                     cdouble += (NV)aquad;
1652                 else
1653                     cuv += aquad;
1654             }
1655             break;
1656         case 'Q':
1657             while (len-- > 0) {
1658                 Uquad_t auquad;
1659                 SHIFT_VAR(utf8, s, strend, auquad, datumtype, needs_swap);
1660                 if (!checksum)
1661                     mPUSHs(newSVuv((UV)auquad));
1662                 else if (checksum > bits_in_uv)
1663                     cdouble += (NV)auquad;
1664                 else
1665                     cuv += auquad;
1666             }
1667             break;
1668 #endif
1669         /* float and double added gnb@melba.bby.oz.au 22/11/89 */
1670         case 'f':
1671             while (len-- > 0) {
1672                 float afloat;
1673                 SHIFT_VAR(utf8, s, strend, afloat, datumtype, needs_swap);
1674                 if (!checksum)
1675                     mPUSHn(afloat);
1676                 else
1677                     cdouble += afloat;
1678             }
1679             break;
1680         case 'd':
1681             while (len-- > 0) {
1682                 double adouble;
1683                 SHIFT_VAR(utf8, s, strend, adouble, datumtype, needs_swap);
1684                 if (!checksum)
1685                     mPUSHn(adouble);
1686                 else
1687                     cdouble += adouble;
1688             }
1689             break;
1690         case 'F':
1691             while (len-- > 0) {
1692                 NV_bytes anv;
1693                 SHIFT_BYTES(utf8, s, strend, anv.bytes, sizeof(anv.bytes),
1694                             datumtype, needs_swap);
1695                 if (!checksum)
1696                     mPUSHn(anv.nv);
1697                 else
1698                     cdouble += anv.nv;
1699             }
1700             break;
1701 #if defined(HAS_LONG_DOUBLE) && defined(USE_LONG_DOUBLE)
1702         case 'D':
1703             while (len-- > 0) {
1704                 ld_bytes aldouble;
1705                 SHIFT_BYTES(utf8, s, strend, aldouble.bytes,
1706                             sizeof(aldouble.bytes), datumtype, needs_swap);
1707                 /* The most common long double format, the x86 80-bit
1708                  * extended precision, has either 2 or 6 unused bytes,
1709                  * which may contain garbage, which may contain
1710                  * unintentional data.  While we do zero the bytes of
1711                  * the long double data in pack(), here in unpack() we
1712                  * don't, because it's really hard to envision that
1713                  * reading the long double off aldouble would be
1714                  * affected by the unused bytes.
1715                  *
1716                  * Note that trying to unpack 'long doubles' of 'long
1717                  * doubles' packed in another system is in the general
1718                  * case doomed without having more detail. */
1719                 if (!checksum)
1720                     mPUSHn(aldouble.ld);
1721                 else
1722                     cdouble += aldouble.ld;
1723             }
1724             break;
1725 #endif
1726         case 'u':
1727             if (!checksum) {
1728                 const STRLEN l = (STRLEN) (strend - s) * 3 / 4;
1729                 sv = sv_2mortal(newSV(l));
1730                 if (l) SvPOK_on(sv);
1731             }
1732             if (utf8) {
1733                 while (next_uni_uu(aTHX_ &s, strend, &len)) {
1734                     I32 a, b, c, d;
1735                     char hunk[3];
1736
1737                     while (len > 0) {
1738                         next_uni_uu(aTHX_ &s, strend, &a);
1739                         next_uni_uu(aTHX_ &s, strend, &b);
1740                         next_uni_uu(aTHX_ &s, strend, &c);
1741                         next_uni_uu(aTHX_ &s, strend, &d);
1742                         hunk[0] = (char)((a << 2) | (b >> 4));
1743                         hunk[1] = (char)((b << 4) | (c >> 2));
1744                         hunk[2] = (char)((c << 6) | d);
1745                         if (!checksum)
1746                             sv_catpvn(sv, hunk, (len > 3) ? 3 : len);
1747                         len -= 3;
1748                     }
1749                     if (s < strend) {
1750                         if (*s == '\n') {
1751                             s++;
1752                         }
1753                         else {
1754                             /* possible checksum byte */
1755                             const char *skip = s+UTF8SKIP(s);
1756                             if (skip < strend && *skip == '\n')
1757                                 s = skip+1;
1758                         }
1759                     }
1760                 }
1761             } else {
1762                 while (s < strend && *s > ' ' && ISUUCHAR(*s)) {
1763                     I32 a, b, c, d;
1764                     char hunk[3];
1765
1766                     len = PL_uudmap[*(U8*)s++] & 077;
1767                     while (len > 0) {
1768                         if (s < strend && ISUUCHAR(*s))
1769                             a = PL_uudmap[*(U8*)s++] & 077;
1770                         else
1771                             a = 0;
1772                         if (s < strend && ISUUCHAR(*s))
1773                             b = PL_uudmap[*(U8*)s++] & 077;
1774                         else
1775                             b = 0;
1776                         if (s < strend && ISUUCHAR(*s))
1777                             c = PL_uudmap[*(U8*)s++] & 077;
1778                         else
1779                             c = 0;
1780                         if (s < strend && ISUUCHAR(*s))
1781                             d = PL_uudmap[*(U8*)s++] & 077;
1782                         else
1783                             d = 0;
1784                         hunk[0] = (char)((a << 2) | (b >> 4));
1785                         hunk[1] = (char)((b << 4) | (c >> 2));
1786                         hunk[2] = (char)((c << 6) | d);
1787                         if (!checksum)
1788                             sv_catpvn(sv, hunk, (len > 3) ? 3 : len);
1789                         len -= 3;
1790                     }
1791                     if (*s == '\n')
1792                         s++;
1793                     else        /* possible checksum byte */
1794                         if (s + 1 < strend && s[1] == '\n')
1795                             s += 2;
1796                 }
1797             }
1798             if (!checksum)
1799                 XPUSHs(sv);
1800             break;
1801         } /* End of switch */
1802
1803         if (checksum) {
1804             if (strchr("fFdD", TYPE_NO_MODIFIERS(datumtype)) ||
1805               (checksum > bits_in_uv &&
1806                strchr("cCsSiIlLnNUWvVqQjJ", TYPE_NO_MODIFIERS(datumtype))) ) {
1807                 NV trouble, anv;
1808
1809                 anv = (NV) (1 << (checksum & 15));
1810                 while (checksum >= 16) {
1811                     checksum -= 16;
1812                     anv *= 65536.0;
1813                 }
1814                 while (cdouble < 0.0)
1815                     cdouble += anv;
1816                 cdouble = Perl_modf(cdouble / anv, &trouble) * anv;
1817                 sv = newSVnv(cdouble);
1818             }
1819             else {
1820                 if (checksum < bits_in_uv) {
1821                     UV mask = ((UV)1 << checksum) - 1;
1822                     cuv &= mask;
1823                 }
1824                 sv = newSVuv(cuv);
1825             }
1826             mXPUSHs(sv);
1827             checksum = 0;
1828         }
1829
1830         if (symptr->flags & FLAG_SLASH){
1831             if (SP - PL_stack_base - start_sp_offset <= 0)
1832                 break;
1833             if( next_symbol(symptr) ){
1834               if( symptr->howlen == e_number )
1835                 Perl_croak(aTHX_ "Count after length/code in unpack" );
1836               if( beyond ){
1837                 /* ...end of char buffer then no decent length available */
1838                 Perl_croak(aTHX_ "length/code after end of string in unpack" );
1839               } else {
1840                 /* take top of stack (hope it's numeric) */
1841                 len = POPi;
1842                 if( len < 0 )
1843                     Perl_croak(aTHX_ "Negative '/' count in unpack" );
1844               }
1845             } else {
1846                 Perl_croak(aTHX_ "Code missing after '/' in unpack" );
1847             }
1848             datumtype = symptr->code;
1849             explicit_length = FALSE;
1850             goto redo_switch;
1851         }
1852     }
1853
1854     if (new_s)
1855         *new_s = s;
1856     PUTBACK;
1857     return SP - PL_stack_base - start_sp_offset;
1858 }
1859
1860 PP(pp_unpack)
1861 {
1862     dSP;
1863     dPOPPOPssrl;
1864     I32 gimme = GIMME_V;
1865     STRLEN llen;
1866     STRLEN rlen;
1867     const char *pat = SvPV_const(left,  llen);
1868     const char *s   = SvPV_const(right, rlen);
1869     const char *strend = s + rlen;
1870     const char *patend = pat + llen;
1871     I32 cnt;
1872
1873     PUTBACK;
1874     cnt = unpackstring(pat, patend, s, strend,
1875                      ((gimme == G_SCALAR) ? FLAG_UNPACK_ONLY_ONE : 0)
1876                      | (DO_UTF8(right) ? FLAG_DO_UTF8 : 0));
1877
1878     SPAGAIN;
1879     if ( !cnt && gimme == G_SCALAR )
1880        PUSHs(&PL_sv_undef);
1881     RETURN;
1882 }
1883
1884 STATIC U8 *
1885 doencodes(U8 *h, const char *s, I32 len)
1886 {
1887     *h++ = PL_uuemap[len];
1888     while (len > 2) {
1889         *h++ = PL_uuemap[(077 & (s[0] >> 2))];
1890         *h++ = PL_uuemap[(077 & (((s[0] << 4) & 060) | ((s[1] >> 4) & 017)))];
1891         *h++ = PL_uuemap[(077 & (((s[1] << 2) & 074) | ((s[2] >> 6) & 03)))];
1892         *h++ = PL_uuemap[(077 & (s[2] & 077))];
1893         s += 3;
1894         len -= 3;
1895     }
1896     if (len > 0) {
1897         const char r = (len > 1 ? s[1] : '\0');
1898         *h++ = PL_uuemap[(077 & (s[0] >> 2))];
1899         *h++ = PL_uuemap[(077 & (((s[0] << 4) & 060) | ((r >> 4) & 017)))];
1900         *h++ = PL_uuemap[(077 & ((r << 2) & 074))];
1901         *h++ = PL_uuemap[0];
1902     }
1903     *h++ = '\n';
1904     return h;
1905 }
1906
1907 STATIC SV *
1908 S_is_an_int(pTHX_ const char *s, STRLEN l)
1909 {
1910   SV *result = newSVpvn(s, l);
1911   char *const result_c = SvPV_nolen(result);    /* convenience */
1912   char *out = result_c;
1913   bool skip = 1;
1914   bool ignore = 0;
1915
1916   PERL_ARGS_ASSERT_IS_AN_INT;
1917
1918   while (*s) {
1919     switch (*s) {
1920     case ' ':
1921       break;
1922     case '+':
1923       if (!skip) {
1924         SvREFCNT_dec(result);
1925         return (NULL);
1926       }
1927       break;
1928     case '0':
1929     case '1':
1930     case '2':
1931     case '3':
1932     case '4':
1933     case '5':
1934     case '6':
1935     case '7':
1936     case '8':
1937     case '9':
1938       skip = 0;
1939       if (!ignore) {
1940         *(out++) = *s;
1941       }
1942       break;
1943     case '.':
1944       ignore = 1;
1945       break;
1946     default:
1947       SvREFCNT_dec(result);
1948       return (NULL);
1949     }
1950     s++;
1951   }
1952   *(out++) = '\0';
1953   SvCUR_set(result, out - result_c);
1954   return (result);
1955 }
1956
1957 /* pnum must be '\0' terminated */
1958 STATIC int
1959 S_div128(pTHX_ SV *pnum, bool *done)
1960 {
1961     STRLEN len;
1962     char * const s = SvPV(pnum, len);
1963     char *t = s;
1964     int m = 0;
1965
1966     PERL_ARGS_ASSERT_DIV128;
1967
1968     *done = 1;
1969     while (*t) {
1970         const int i = m * 10 + (*t - '0');
1971         const int r = (i >> 7); /* r < 10 */
1972         m = i & 0x7F;
1973         if (r) {
1974             *done = 0;
1975         }
1976         *(t++) = '0' + r;
1977     }
1978     *(t++) = '\0';
1979     SvCUR_set(pnum, (STRLEN) (t - s));
1980     return (m);
1981 }
1982
1983 /*
1984 =for apidoc packlist
1985
1986 The engine implementing pack() Perl function.
1987
1988 =cut
1989 */
1990
1991 void
1992 Perl_packlist(pTHX_ SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist )
1993 {
1994     tempsym_t sym;
1995
1996     PERL_ARGS_ASSERT_PACKLIST;
1997
1998     TEMPSYM_INIT(&sym, pat, patend, FLAG_PACK);
1999
2000     /* We're going to do changes through SvPVX(cat). Make sure it's valid.
2001        Also make sure any UTF8 flag is loaded */
2002     SvPV_force_nolen(cat);
2003     if (DO_UTF8(cat))
2004         sym.flags |= FLAG_PARSE_UTF8 | FLAG_DO_UTF8;
2005
2006     (void)pack_rec( cat, &sym, beglist, endlist );
2007 }
2008
2009 /* like sv_utf8_upgrade, but also repoint the group start markers */
2010 STATIC void
2011 marked_upgrade(pTHX_ SV *sv, tempsym_t *sym_ptr) {
2012     STRLEN len;
2013     tempsym_t *group;
2014     const char *from_ptr, *from_start, *from_end, **marks, **m;
2015     char *to_start, *to_ptr;
2016
2017     if (SvUTF8(sv)) return;
2018
2019     from_start = SvPVX_const(sv);
2020     from_end = from_start + SvCUR(sv);
2021     for (from_ptr = from_start; from_ptr < from_end; from_ptr++)
2022         if (!NATIVE_BYTE_IS_INVARIANT(*from_ptr)) break;
2023     if (from_ptr == from_end) {
2024         /* Simple case: no character needs to be changed */
2025         SvUTF8_on(sv);
2026         return;
2027     }
2028
2029     len = (from_end-from_ptr)*UTF8_EXPAND+(from_ptr-from_start)+1;
2030     Newx(to_start, len, char);
2031     Copy(from_start, to_start, from_ptr-from_start, char);
2032     to_ptr = to_start + (from_ptr-from_start);
2033
2034     Newx(marks, sym_ptr->level+2, const char *);
2035     for (group=sym_ptr; group; group = group->previous)
2036         marks[group->level] = from_start + group->strbeg;
2037     marks[sym_ptr->level+1] = from_end+1;
2038     for (m = marks; *m < from_ptr; m++)
2039         *m = to_start + (*m-from_start);
2040
2041     for (;from_ptr < from_end; from_ptr++) {
2042         while (*m == from_ptr) *m++ = to_ptr;
2043         to_ptr = (char *) uvchr_to_utf8((U8 *) to_ptr, *(U8 *) from_ptr);
2044     }
2045     *to_ptr = 0;
2046
2047     while (*m == from_ptr) *m++ = to_ptr;
2048     if (m != marks + sym_ptr->level+1) {
2049         Safefree(marks);
2050         Safefree(to_start);
2051         Perl_croak(aTHX_ "panic: marks beyond string end, m=%p, marks=%p, "
2052                    "level=%d", m, marks, sym_ptr->level);
2053     }
2054     for (group=sym_ptr; group; group = group->previous)
2055         group->strbeg = marks[group->level] - to_start;
2056     Safefree(marks);
2057
2058     if (SvOOK(sv)) {
2059         if (SvIVX(sv)) {
2060             SvLEN_set(sv, SvLEN(sv) + SvIVX(sv));
2061             from_start -= SvIVX(sv);
2062             SvIV_set(sv, 0);
2063         }
2064         SvFLAGS(sv) &= ~SVf_OOK;
2065     }
2066     if (SvLEN(sv) != 0)
2067         Safefree(from_start);
2068     SvPV_set(sv, to_start);
2069     SvCUR_set(sv, to_ptr - to_start);
2070     SvLEN_set(sv, len);
2071     SvUTF8_on(sv);
2072 }
2073
2074 /* Exponential string grower. Makes string extension effectively O(n)
2075    needed says how many extra bytes we need (not counting the final '\0')
2076    Only grows the string if there is an actual lack of space
2077 */
2078 STATIC char *
2079 S_sv_exp_grow(pTHX_ SV *sv, STRLEN needed) {
2080     const STRLEN cur = SvCUR(sv);
2081     const STRLEN len = SvLEN(sv);
2082     STRLEN extend;
2083
2084     PERL_ARGS_ASSERT_SV_EXP_GROW;
2085
2086     if (len - cur > needed) return SvPVX(sv);
2087     extend = needed > len ? needed : len;
2088     return SvGROW(sv, len+extend+1);
2089 }
2090
2091 static void
2092 S_sv_check_infnan(pTHX_ SV *sv, I32 datumtype)
2093 {
2094     SvGETMAGIC(sv);
2095     if (UNLIKELY(isinfnansv(sv))) {
2096         const I32 c = TYPE_NO_MODIFIERS(datumtype);
2097         const NV nv = SvNV_nomg(sv);
2098         if (c == 'w')
2099             Perl_croak(aTHX_ "Cannot compress %"NVgf" in pack", nv);
2100         else
2101             Perl_croak(aTHX_ "Cannot pack %"NVgf" with '%c'", nv, (int) c);
2102     }
2103 }
2104
2105 #define SvIV_no_inf(sv,d) (S_sv_check_infnan(aTHX_ sv,d), SvIV_nomg(sv))
2106 #define SvUV_no_inf(sv,d) (S_sv_check_infnan(aTHX_ sv,d), SvUV_nomg(sv))
2107
2108 STATIC
2109 SV **
2110 S_pack_rec(pTHX_ SV *cat, tempsym_t* symptr, SV **beglist, SV **endlist )
2111 {
2112     tempsym_t lookahead;
2113     I32 items  = endlist - beglist;
2114     bool found = next_symbol(symptr);
2115     bool utf8 = (symptr->flags & FLAG_PARSE_UTF8) ? 1 : 0;
2116     bool warn_utf8 = ckWARN(WARN_UTF8);
2117     char* from;
2118
2119     PERL_ARGS_ASSERT_PACK_REC;
2120
2121     if (symptr->level == 0 && found && symptr->code == 'U') {
2122         marked_upgrade(aTHX_ cat, symptr);
2123         symptr->flags |= FLAG_DO_UTF8;
2124         utf8 = 0;
2125     }
2126     symptr->strbeg = SvCUR(cat);
2127
2128     while (found) {
2129         SV *fromstr;
2130         STRLEN fromlen;
2131         I32 len;
2132         SV *lengthcode = NULL;
2133         I32 datumtype = symptr->code;
2134         howlen_t howlen = symptr->howlen;
2135         char *start = SvPVX(cat);
2136         char *cur   = start + SvCUR(cat);
2137         bool needs_swap;
2138
2139 #define NEXTFROM (lengthcode ? lengthcode : items-- > 0 ? *beglist++ : &PL_sv_no)
2140 #define PEEKFROM (lengthcode ? lengthcode : items > 0 ? *beglist : &PL_sv_no)
2141
2142         switch (howlen) {
2143           case e_star:
2144             len = strchr("@Xxu", TYPE_NO_MODIFIERS(datumtype)) ?
2145                 0 : items;
2146             break;
2147           default:
2148             /* e_no_len and e_number */
2149             len = symptr->length;
2150             break;
2151         }
2152
2153         if (len) {
2154             packprops_t props = packprops[TYPE_NO_ENDIANNESS(datumtype)];
2155
2156             if (props && !(props & PACK_SIZE_UNPREDICTABLE)) {
2157                 /* We can process this letter. */
2158                 STRLEN size = props & PACK_SIZE_MASK;
2159                 GROWING(utf8, cat, start, cur, (STRLEN) len * size);
2160             }
2161         }
2162
2163         /* Look ahead for next symbol. Do we have code/code? */
2164         lookahead = *symptr;
2165         found = next_symbol(&lookahead);
2166         if (symptr->flags & FLAG_SLASH) {
2167             IV count;
2168             if (!found) Perl_croak(aTHX_ "Code missing after '/' in pack");
2169             if (strchr("aAZ", lookahead.code)) {
2170                 if (lookahead.howlen == e_number) count = lookahead.length;
2171                 else {
2172                     if (items > 0) {
2173                         count = sv_len_utf8(*beglist);
2174                     }
2175                     else count = 0;
2176                     if (lookahead.code == 'Z') count++;
2177                 }
2178             } else {
2179                 if (lookahead.howlen == e_number && lookahead.length < items)
2180                     count = lookahead.length;
2181                 else count = items;
2182             }
2183             lookahead.howlen = e_number;
2184             lookahead.length = count;
2185             lengthcode = sv_2mortal(newSViv(count));
2186         }
2187
2188         needs_swap = NEEDS_SWAP(datumtype);
2189
2190         /* Code inside the switch must take care to properly update
2191            cat (CUR length and '\0' termination) if it updated *cur and
2192            doesn't simply leave using break */
2193         switch (TYPE_NO_ENDIANNESS(datumtype)) {
2194         default:
2195             Perl_croak(aTHX_ "Invalid type '%c' in pack",
2196                        (int) TYPE_NO_MODIFIERS(datumtype));
2197         case '%':
2198             Perl_croak(aTHX_ "'%%' may not be used in pack");
2199
2200         case '.' | TYPE_IS_SHRIEKING:
2201         case '.':
2202             if (howlen == e_star) from = start;
2203             else if (len == 0) from = cur;
2204             else {
2205                 tempsym_t *group = symptr;
2206
2207                 while (--len && group) group = group->previous;
2208                 from = group ? start + group->strbeg : start;
2209             }
2210             fromstr = NEXTFROM;
2211             len = SvIV_no_inf(fromstr, datumtype);
2212             goto resize;
2213         case '@' | TYPE_IS_SHRIEKING:
2214         case '@':
2215             from = start + symptr->strbeg;
2216           resize:
2217             if (utf8  && !(datumtype & TYPE_IS_SHRIEKING))
2218                 if (len >= 0) {
2219                     while (len && from < cur) {
2220                         from += UTF8SKIP(from);
2221                         len--;
2222                     }
2223                     if (from > cur)
2224                         Perl_croak(aTHX_ "Malformed UTF-8 string in pack");
2225                     if (len) {
2226                         /* Here we know from == cur */
2227                       grow:
2228                         GROWING(0, cat, start, cur, len);
2229                         Zero(cur, len, char);
2230                         cur += len;
2231                     } else if (from < cur) {
2232                         len = cur - from;
2233                         goto shrink;
2234                     } else goto no_change;
2235                 } else {
2236                     cur = from;
2237                     len = -len;
2238                     goto utf8_shrink;
2239                 }
2240             else {
2241                 len -= cur - from;
2242                 if (len > 0) goto grow;
2243                 if (len == 0) goto no_change;
2244                 len = -len;
2245                 goto shrink;
2246             }
2247             break;
2248
2249         case '(': {
2250             tempsym_t savsym = *symptr;
2251             U32 group_modifiers = TYPE_MODIFIERS(datumtype & ~symptr->flags);
2252             symptr->flags |= group_modifiers;
2253             symptr->patend = savsym.grpend;
2254             symptr->level++;
2255             symptr->previous = &lookahead;
2256             while (len--) {
2257                 U32 was_utf8;
2258                 if (utf8) symptr->flags |=  FLAG_PARSE_UTF8;
2259                 else      symptr->flags &= ~FLAG_PARSE_UTF8;
2260                 was_utf8 = SvUTF8(cat);
2261                 symptr->patptr = savsym.grpbeg;
2262                 beglist = pack_rec(cat, symptr, beglist, endlist);
2263                 if (SvUTF8(cat) != was_utf8)
2264                     /* This had better be an upgrade while in utf8==0 mode */
2265                     utf8 = 1;
2266
2267                 if (savsym.howlen == e_star && beglist == endlist)
2268                     break;              /* No way to continue */
2269             }
2270             items = endlist - beglist;
2271             lookahead.flags  = symptr->flags & ~group_modifiers;
2272             goto no_change;
2273         }
2274         case 'X' | TYPE_IS_SHRIEKING:
2275             if (!len)                   /* Avoid division by 0 */
2276                 len = 1;
2277             if (utf8) {
2278                 char *hop, *last;
2279                 I32 l = len;
2280                 hop = last = start;
2281                 while (hop < cur) {
2282                     hop += UTF8SKIP(hop);
2283                     if (--l == 0) {
2284                         last = hop;
2285                         l = len;
2286                     }
2287                 }
2288                 if (last > cur)
2289                     Perl_croak(aTHX_ "Malformed UTF-8 string in pack");
2290                 cur = last;
2291                 break;
2292             }
2293             len = (cur-start) % len;
2294             /* FALLTHROUGH */
2295         case 'X':
2296             if (utf8) {
2297                 if (len < 1) goto no_change;
2298               utf8_shrink:
2299                 while (len > 0) {
2300                     if (cur <= start)
2301                         Perl_croak(aTHX_ "'%c' outside of string in pack",
2302                                    (int) TYPE_NO_MODIFIERS(datumtype));
2303                     while (--cur, UTF8_IS_CONTINUATION(*cur)) {
2304                         if (cur <= start)
2305                             Perl_croak(aTHX_ "'%c' outside of string in pack",
2306                                        (int) TYPE_NO_MODIFIERS(datumtype));
2307                     }
2308                     len--;
2309                 }
2310             } else {
2311               shrink:
2312                 if (cur - start < len)
2313                     Perl_croak(aTHX_ "'%c' outside of string in pack",
2314                                (int) TYPE_NO_MODIFIERS(datumtype));
2315                 cur -= len;
2316             }
2317             if (cur < start+symptr->strbeg) {
2318                 /* Make sure group starts don't point into the void */
2319                 tempsym_t *group;
2320                 const STRLEN length = cur-start;
2321                 for (group = symptr;
2322                      group && length < group->strbeg;
2323                      group = group->previous) group->strbeg = length;
2324                 lookahead.strbeg = length;
2325             }
2326             break;
2327         case 'x' | TYPE_IS_SHRIEKING: {
2328             I32 ai32;
2329             if (!len)                   /* Avoid division by 0 */
2330                 len = 1;
2331             if (utf8) ai32 = utf8_length((U8 *) start, (U8 *) cur) % len;
2332             else      ai32 = (cur - start) % len;
2333             if (ai32 == 0) goto no_change;
2334             len -= ai32;
2335         }
2336         /* FALLTHROUGH */
2337         case 'x':
2338             goto grow;
2339         case 'A':
2340         case 'Z':
2341         case 'a': {
2342             const char *aptr;
2343
2344             fromstr = NEXTFROM;
2345             aptr = SvPV_const(fromstr, fromlen);
2346             if (DO_UTF8(fromstr)) {
2347                 const char *end, *s;
2348
2349                 if (!utf8 && !SvUTF8(cat)) {
2350                     marked_upgrade(aTHX_ cat, symptr);
2351                     lookahead.flags |= FLAG_DO_UTF8;
2352                     lookahead.strbeg = symptr->strbeg;
2353                     utf8 = 1;
2354                     start = SvPVX(cat);
2355                     cur = start + SvCUR(cat);
2356                 }
2357                 if (howlen == e_star) {
2358                     if (utf8) goto string_copy;
2359                     len = fromlen+1;
2360                 }
2361                 s = aptr;
2362                 end = aptr + fromlen;
2363                 fromlen = datumtype == 'Z' ? len-1 : len;
2364                 while ((I32) fromlen > 0 && s < end) {
2365                     s += UTF8SKIP(s);
2366                     fromlen--;
2367                 }
2368                 if (s > end)
2369                     Perl_croak(aTHX_ "Malformed UTF-8 string in pack");
2370                 if (utf8) {
2371                     len = fromlen;
2372                     if (datumtype == 'Z') len++;
2373                     fromlen = s-aptr;
2374                     len += fromlen;
2375
2376                     goto string_copy;
2377                 }
2378                 fromlen = len - fromlen;
2379                 if (datumtype == 'Z') fromlen--;
2380                 if (howlen == e_star) {
2381                     len = fromlen;
2382                     if (datumtype == 'Z') len++;
2383                 }
2384                 GROWING(0, cat, start, cur, len);
2385                 if (!uni_to_bytes(aTHX_ &aptr, end, cur, fromlen,
2386                                   datumtype | TYPE_IS_PACK))
2387                     Perl_croak(aTHX_ "panic: predicted utf8 length not available, "
2388                                "for '%c', aptr=%p end=%p cur=%p, fromlen=%"UVuf,
2389                                (int)datumtype, aptr, end, cur, (UV)fromlen);
2390                 cur += fromlen;
2391                 len -= fromlen;
2392             } else if (utf8) {
2393                 if (howlen == e_star) {
2394                     len = fromlen;
2395                     if (datumtype == 'Z') len++;
2396                 }
2397                 if (len <= (I32) fromlen) {
2398                     fromlen = len;
2399                     if (datumtype == 'Z' && fromlen > 0) fromlen--;
2400                 }
2401                 /* assumes a byte expands to at most UTF8_EXPAND bytes on
2402                    upgrade, so:
2403                    expected_length <= from_len*UTF8_EXPAND + (len-from_len) */
2404                 GROWING(0, cat, start, cur, fromlen*(UTF8_EXPAND-1)+len);
2405                 len -= fromlen;
2406                 while (fromlen > 0) {
2407                     cur = (char *) uvchr_to_utf8((U8 *) cur, * (U8 *) aptr);
2408                     aptr++;
2409                     fromlen--;
2410                 }
2411             } else {
2412               string_copy:
2413                 if (howlen == e_star) {
2414                     len = fromlen;
2415                     if (datumtype == 'Z') len++;
2416                 }
2417                 if (len <= (I32) fromlen) {
2418                     fromlen = len;
2419                     if (datumtype == 'Z' && fromlen > 0) fromlen--;
2420                 }
2421                 GROWING(0, cat, start, cur, len);
2422                 Copy(aptr, cur, fromlen, char);
2423                 cur += fromlen;
2424                 len -= fromlen;
2425             }
2426             memset(cur, datumtype == 'A' ? ' ' : '\0', len);
2427             cur += len;
2428             SvTAINT(cat);
2429             break;
2430         }
2431         case 'B':
2432         case 'b': {
2433             const char *str, *end;
2434             I32 l, field_len;
2435             U8 bits;
2436             bool utf8_source;
2437             U32 utf8_flags;
2438
2439             fromstr = NEXTFROM;
2440             str = SvPV_const(fromstr, fromlen);
2441             end = str + fromlen;
2442             if (DO_UTF8(fromstr)) {
2443                 utf8_source = TRUE;
2444                 utf8_flags  = warn_utf8 ? 0 : UTF8_ALLOW_ANY;
2445             } else {
2446                 utf8_source = FALSE;
2447                 utf8_flags  = 0; /* Unused, but keep compilers happy */
2448             }
2449             if (howlen == e_star) len = fromlen;
2450             field_len = (len+7)/8;
2451             GROWING(utf8, cat, start, cur, field_len);
2452             if (len > (I32)fromlen) len = fromlen;
2453             bits = 0;
2454             l = 0;
2455             if (datumtype == 'B')
2456                 while (l++ < len) {
2457                     if (utf8_source) {
2458                         UV val = 0;
2459                         NEXT_UNI_VAL(val, cur, str, end, utf8_flags);
2460                         bits |= val & 1;
2461                     } else bits |= *str++ & 1;
2462                     if (l & 7) bits <<= 1;
2463                     else {
2464                         PUSH_BYTE(utf8, cur, bits);
2465                         bits = 0;
2466                     }
2467                 }
2468             else
2469                 /* datumtype == 'b' */
2470                 while (l++ < len) {
2471                     if (utf8_source) {
2472                         UV val = 0;
2473                         NEXT_UNI_VAL(val, cur, str, end, utf8_flags);
2474                         if (val & 1) bits |= 0x80;
2475                     } else if (*str++ & 1)
2476                         bits |= 0x80;
2477                     if (l & 7) bits >>= 1;
2478                     else {
2479                         PUSH_BYTE(utf8, cur, bits);
2480                         bits = 0;
2481                     }
2482                 }
2483             l--;
2484             if (l & 7) {
2485                 if (datumtype == 'B')
2486                     bits <<= 7 - (l & 7);
2487                 else
2488                     bits >>= 7 - (l & 7);
2489                 PUSH_BYTE(utf8, cur, bits);
2490                 l += 7;
2491             }
2492             /* Determine how many chars are left in the requested field */
2493             l /= 8;
2494             if (howlen == e_star) field_len = 0;
2495             else field_len -= l;
2496             Zero(cur, field_len, char);
2497             cur += field_len;
2498             break;
2499         }
2500         case 'H':
2501         case 'h': {
2502             const char *str, *end;
2503             I32 l, field_len;
2504             U8 bits;
2505             bool utf8_source;
2506             U32 utf8_flags;
2507
2508             fromstr = NEXTFROM;
2509             str = SvPV_const(fromstr, fromlen);
2510             end = str + fromlen;
2511             if (DO_UTF8(fromstr)) {
2512                 utf8_source = TRUE;
2513                 utf8_flags  = warn_utf8 ? 0 : UTF8_ALLOW_ANY;
2514             } else {
2515                 utf8_source = FALSE;
2516                 utf8_flags  = 0; /* Unused, but keep compilers happy */
2517             }
2518             if (howlen == e_star) len = fromlen;
2519             field_len = (len+1)/2;
2520             GROWING(utf8, cat, start, cur, field_len);
2521             if (!utf8 && len > (I32)fromlen) len = fromlen;
2522             bits = 0;
2523             l = 0;
2524             if (datumtype == 'H')
2525                 while (l++ < len) {
2526                     if (utf8_source) {
2527                         UV val = 0;
2528                         NEXT_UNI_VAL(val, cur, str, end, utf8_flags);
2529                         if (val < 256 && isALPHA(val))
2530                             bits |= (val + 9) & 0xf;
2531                         else
2532                             bits |= val & 0xf;
2533                     } else if (isALPHA(*str))
2534                         bits |= (*str++ + 9) & 0xf;
2535                     else
2536                         bits |= *str++ & 0xf;
2537                     if (l & 1) bits <<= 4;
2538                     else {
2539                         PUSH_BYTE(utf8, cur, bits);
2540                         bits = 0;
2541                     }
2542                 }
2543             else
2544                 while (l++ < len) {
2545                     if (utf8_source) {
2546                         UV val = 0;
2547                         NEXT_UNI_VAL(val, cur, str, end, utf8_flags);
2548                         if (val < 256 && isALPHA(val))
2549                             bits |= ((val + 9) & 0xf) << 4;
2550                         else
2551                             bits |= (val & 0xf) << 4;
2552                     } else if (isALPHA(*str))
2553                         bits |= ((*str++ + 9) & 0xf) << 4;
2554                     else
2555                         bits |= (*str++ & 0xf) << 4;
2556                     if (l & 1) bits >>= 4;
2557                     else {
2558                         PUSH_BYTE(utf8, cur, bits);
2559                         bits = 0;
2560                     }
2561                 }
2562             l--;
2563             if (l & 1) {
2564                 PUSH_BYTE(utf8, cur, bits);
2565                 l++;
2566             }
2567             /* Determine how many chars are left in the requested field */
2568             l /= 2;
2569             if (howlen == e_star) field_len = 0;
2570             else field_len -= l;
2571             Zero(cur, field_len, char);
2572             cur += field_len;
2573             break;
2574         }
2575         case 'c':
2576             while (len-- > 0) {
2577                 IV aiv;
2578                 fromstr = NEXTFROM;
2579                 aiv = SvIV_no_inf(fromstr, datumtype);
2580                 if ((-128 > aiv || aiv > 127))
2581                     Perl_ck_warner(aTHX_ packWARN(WARN_PACK),
2582                                    "Character in 'c' format wrapped in pack");
2583                 PUSH_BYTE(utf8, cur, (U8)(aiv & 0xff));
2584             }
2585             break;
2586         case 'C':
2587             if (len == 0) {
2588                 utf8 = (symptr->flags & FLAG_DO_UTF8) ? 1 : 0;
2589                 break;
2590             }
2591             while (len-- > 0) {
2592                 IV aiv;
2593                 fromstr = NEXTFROM;
2594                 aiv = SvIV_no_inf(fromstr, datumtype);
2595                 if ((0 > aiv || aiv > 0xff))
2596                     Perl_ck_warner(aTHX_ packWARN(WARN_PACK),
2597                                    "Character in 'C' format wrapped in pack");
2598                 PUSH_BYTE(utf8, cur, (U8)(aiv & 0xff));
2599             }
2600             break;
2601         case 'W': {
2602             char *end;
2603             U8 in_bytes = (U8)IN_BYTES;
2604
2605             end = start+SvLEN(cat)-1;
2606             if (utf8) end -= UTF8_MAXLEN-1;
2607             while (len-- > 0) {
2608                 UV auv;
2609                 fromstr = NEXTFROM;
2610                 auv = SvUV_no_inf(fromstr, datumtype);
2611                 if (in_bytes) auv = auv % 0x100;
2612                 if (utf8) {
2613                   W_utf8:
2614                     if (cur > end) {
2615                         *cur = '\0';
2616                         SvCUR_set(cat, cur - start);
2617
2618                         GROWING(0, cat, start, cur, len+UTF8_MAXLEN);
2619                         end = start+SvLEN(cat)-UTF8_MAXLEN;
2620                     }
2621                     cur = (char *) uvchr_to_utf8_flags((U8 *) cur,
2622                                                        auv,
2623                                                        warn_utf8 ?
2624                                                        0 : UNICODE_ALLOW_ANY);
2625                 } else {
2626                     if (auv >= 0x100) {
2627                         if (!SvUTF8(cat)) {
2628                             *cur = '\0';
2629                             SvCUR_set(cat, cur - start);
2630                             marked_upgrade(aTHX_ cat, symptr);
2631                             lookahead.flags |= FLAG_DO_UTF8;
2632                             lookahead.strbeg = symptr->strbeg;
2633                             utf8 = 1;
2634                             start = SvPVX(cat);
2635                             cur = start + SvCUR(cat);
2636                             end = start+SvLEN(cat)-UTF8_MAXLEN;
2637                             goto W_utf8;
2638                         }
2639                         Perl_ck_warner(aTHX_ packWARN(WARN_PACK),
2640                                        "Character in 'W' format wrapped in pack");
2641                         auv &= 0xff;
2642                     }
2643                     if (cur >= end) {
2644                         *cur = '\0';
2645                         SvCUR_set(cat, cur - start);
2646                         GROWING(0, cat, start, cur, len+1);
2647                         end = start+SvLEN(cat)-1;
2648                     }
2649                     *(U8 *) cur++ = (U8)auv;
2650                 }
2651             }
2652             break;
2653         }
2654         case 'U': {
2655             char *end;
2656
2657             if (len == 0) {
2658                 if (!(symptr->flags & FLAG_DO_UTF8)) {
2659                     marked_upgrade(aTHX_ cat, symptr);
2660                     lookahead.flags |= FLAG_DO_UTF8;
2661                     lookahead.strbeg = symptr->strbeg;
2662                 }
2663                 utf8 = 0;
2664                 goto no_change;
2665             }
2666
2667             end = start+SvLEN(cat);
2668             if (!utf8) end -= UTF8_MAXLEN;
2669             while (len-- > 0) {
2670                 UV auv;
2671                 fromstr = NEXTFROM;
2672                 auv = SvUV_no_inf(fromstr, datumtype);
2673                 if (utf8) {
2674                     U8 buffer[UTF8_MAXLEN], *endb;
2675                     endb = uvchr_to_utf8_flags(buffer, UNI_TO_NATIVE(auv),
2676                                                warn_utf8 ?
2677                                                0 : UNICODE_ALLOW_ANY);
2678                     if (cur+(endb-buffer)*UTF8_EXPAND >= end) {
2679                         *cur = '\0';
2680                         SvCUR_set(cat, cur - start);
2681                         GROWING(0, cat, start, cur,
2682                                 len+(endb-buffer)*UTF8_EXPAND);
2683                         end = start+SvLEN(cat);
2684                     }
2685                     cur = S_bytes_to_uni(buffer, endb-buffer, cur, 0);
2686                 } else {
2687                     if (cur >= end) {
2688                         *cur = '\0';
2689                         SvCUR_set(cat, cur - start);
2690                         GROWING(0, cat, start, cur, len+UTF8_MAXLEN);
2691                         end = start+SvLEN(cat)-UTF8_MAXLEN;
2692                     }
2693                     cur = (char *) uvchr_to_utf8_flags((U8 *) cur, UNI_TO_NATIVE(auv),
2694                                                        warn_utf8 ?
2695                                                        0 : UNICODE_ALLOW_ANY);
2696                 }
2697             }
2698             break;
2699         }
2700         /* Float and double added by gnb@melba.bby.oz.au  22/11/89 */
2701         case 'f':
2702             while (len-- > 0) {
2703                 float afloat;
2704                 NV anv;
2705                 fromstr = NEXTFROM;
2706                 anv = SvNV(fromstr);
2707 # if defined(VMS) && !defined(_IEEE_FP)
2708                 /* IEEE fp overflow shenanigans are unavailable on VAX and optional
2709                  * on Alpha; fake it if we don't have them.
2710                  */
2711                 if (anv > FLT_MAX)
2712                     afloat = FLT_MAX;
2713                 else if (anv < -FLT_MAX)
2714                     afloat = -FLT_MAX;
2715                 else afloat = (float)anv;
2716 # else
2717                 afloat = (float)anv;
2718 # endif
2719                 PUSH_VAR(utf8, cur, afloat, needs_swap);
2720             }
2721             break;
2722         case 'd':
2723             while (len-- > 0) {
2724                 double adouble;
2725                 NV anv;
2726                 fromstr = NEXTFROM;
2727                 anv = SvNV(fromstr);
2728 # if defined(VMS) && !defined(_IEEE_FP)
2729                 /* IEEE fp overflow shenanigans are unavailable on VAX and optional
2730                  * on Alpha; fake it if we don't have them.
2731                  */
2732                 if (anv > DBL_MAX)
2733                     adouble = DBL_MAX;
2734                 else if (anv < -DBL_MAX)
2735                     adouble = -DBL_MAX;
2736                 else adouble = (double)anv;
2737 # else
2738                 adouble = (double)anv;
2739 # endif
2740                 PUSH_VAR(utf8, cur, adouble, needs_swap);
2741             }
2742             break;
2743         case 'F': {
2744             NV_bytes anv;
2745             Zero(&anv, 1, NV); /* can be long double with unused bits */
2746             while (len-- > 0) {
2747                 fromstr = NEXTFROM;
2748 #ifdef __GNUC__
2749                 /* to work round a gcc/x86 bug; don't use SvNV */
2750                 anv.nv = sv_2nv(fromstr);
2751 #else
2752                 anv.nv = SvNV(fromstr);
2753 #endif
2754                 PUSH_BYTES(utf8, cur, anv.bytes, sizeof(anv.bytes), needs_swap);
2755             }
2756             break;
2757         }
2758 #if defined(HAS_LONG_DOUBLE) && defined(USE_LONG_DOUBLE)
2759         case 'D': {
2760             ld_bytes aldouble;
2761             /* long doubles can have unused bits, which may be nonzero */
2762             Zero(&aldouble, 1, long double);
2763             while (len-- > 0) {
2764                 fromstr = NEXTFROM;
2765 #  ifdef __GNUC__
2766                 /* to work round a gcc/x86 bug; don't use SvNV */
2767                 aldouble.ld = (long double)sv_2nv(fromstr);
2768 #  else
2769                 aldouble.ld = (long double)SvNV(fromstr);
2770 #  endif
2771                 PUSH_BYTES(utf8, cur, aldouble.bytes, sizeof(aldouble.bytes),
2772                            needs_swap);
2773             }
2774             break;
2775         }
2776 #endif
2777         case 'n' | TYPE_IS_SHRIEKING:
2778         case 'n':
2779             while (len-- > 0) {
2780                 I16 ai16;
2781                 fromstr = NEXTFROM;
2782                 ai16 = (I16)SvIV_no_inf(fromstr, datumtype);
2783                 ai16 = PerlSock_htons(ai16);
2784                 PUSH16(utf8, cur, &ai16, FALSE);
2785             }
2786             break;
2787         case 'v' | TYPE_IS_SHRIEKING:
2788         case 'v':
2789             while (len-- > 0) {
2790                 I16 ai16;
2791                 fromstr = NEXTFROM;
2792                 ai16 = (I16)SvIV_no_inf(fromstr, datumtype);
2793                 ai16 = htovs(ai16);
2794                 PUSH16(utf8, cur, &ai16, FALSE);
2795             }
2796             break;
2797         case 'S' | TYPE_IS_SHRIEKING:
2798 #if SHORTSIZE != SIZE16
2799             while (len-- > 0) {
2800                 unsigned short aushort;
2801                 fromstr = NEXTFROM;
2802                 aushort = SvUV_no_inf(fromstr, datumtype);
2803                 PUSH_VAR(utf8, cur, aushort, needs_swap);
2804             }
2805             break;
2806 #else
2807             /* FALLTHROUGH */
2808 #endif
2809         case 'S':
2810             while (len-- > 0) {
2811                 U16 au16;
2812                 fromstr = NEXTFROM;
2813                 au16 = (U16)SvUV_no_inf(fromstr, datumtype);
2814                 PUSH16(utf8, cur, &au16, needs_swap);
2815             }
2816             break;
2817         case 's' | TYPE_IS_SHRIEKING:
2818 #if SHORTSIZE != SIZE16
2819             while (len-- > 0) {
2820                 short ashort;
2821                 fromstr = NEXTFROM;
2822                 ashort = SvIV_no_inf(fromstr, datumtype);
2823                 PUSH_VAR(utf8, cur, ashort, needs_swap);
2824             }
2825             break;
2826 #else
2827             /* FALLTHROUGH */
2828 #endif
2829         case 's':
2830             while (len-- > 0) {
2831                 I16 ai16;
2832                 fromstr = NEXTFROM;
2833                 ai16 = (I16)SvIV_no_inf(fromstr, datumtype);
2834                 PUSH16(utf8, cur, &ai16, needs_swap);
2835             }
2836             break;
2837         case 'I':
2838         case 'I' | TYPE_IS_SHRIEKING:
2839             while (len-- > 0) {
2840                 unsigned int auint;
2841                 fromstr = NEXTFROM;
2842                 auint = SvUV_no_inf(fromstr, datumtype);
2843                 PUSH_VAR(utf8, cur, auint, needs_swap);
2844             }
2845             break;
2846         case 'j':
2847             while (len-- > 0) {
2848                 IV aiv;
2849                 fromstr = NEXTFROM;
2850                 aiv = SvIV_no_inf(fromstr, datumtype);
2851                 PUSH_VAR(utf8, cur, aiv, needs_swap);
2852             }
2853             break;
2854         case 'J':
2855             while (len-- > 0) {
2856                 UV auv;
2857                 fromstr = NEXTFROM;
2858                 auv = SvUV_no_inf(fromstr, datumtype);
2859                 PUSH_VAR(utf8, cur, auv, needs_swap);
2860             }
2861             break;
2862         case 'w':
2863             while (len-- > 0) {
2864                 NV anv;
2865                 fromstr = NEXTFROM;
2866                 S_sv_check_infnan(aTHX_ fromstr, datumtype);
2867                 anv = SvNV_nomg(fromstr);
2868
2869                 if (anv < 0) {
2870                     *cur = '\0';
2871                     SvCUR_set(cat, cur - start);
2872                     Perl_croak(aTHX_ "Cannot compress negative numbers in pack");
2873                 }
2874
2875                 /* 0xFFFFFFFFFFFFFFFF may cast to 18446744073709551616.0,
2876                    which is == UV_MAX_P1. IOK is fine (instead of UV_only), as
2877                    any negative IVs will have already been got by the croak()
2878                    above. IOK is untrue for fractions, so we test them
2879                    against UV_MAX_P1.  */
2880                 if (SvIOK(fromstr) || anv < UV_MAX_P1) {
2881                     char   buf[(sizeof(UV)*CHAR_BIT)/7+1];
2882                     char  *in = buf + sizeof(buf);
2883                     UV     auv = SvUV_nomg(fromstr);
2884
2885                     do {
2886                         *--in = (char)((auv & 0x7f) | 0x80);
2887                         auv >>= 7;
2888                     } while (auv);
2889                     buf[sizeof(buf) - 1] &= 0x7f; /* clear continue bit */
2890                     PUSH_GROWING_BYTES(utf8, cat, start, cur,
2891                                        in, (buf + sizeof(buf)) - in);
2892                 } else if (SvPOKp(fromstr))
2893                     goto w_string;
2894                 else if (SvNOKp(fromstr)) {
2895                     /* 10**NV_MAX_10_EXP is the largest power of 10
2896                        so 10**(NV_MAX_10_EXP+1) is definitely unrepresentable
2897                        given 10**(NV_MAX_10_EXP+1) == 128 ** x solve for x:
2898                        x = (NV_MAX_10_EXP+1) * log (10) / log (128)
2899                        And with that many bytes only Inf can overflow.
2900                        Some C compilers are strict about integral constant
2901                        expressions so we conservatively divide by a slightly
2902                        smaller integer instead of multiplying by the exact
2903                        floating-point value.
2904                     */
2905 #ifdef NV_MAX_10_EXP
2906                     /* char   buf[1 + (int)((NV_MAX_10_EXP + 1) * 0.47456)]; -- invalid C */
2907                     char   buf[1 + (int)((NV_MAX_10_EXP + 1) / 2)]; /* valid C */
2908 #else
2909                     /* char   buf[1 + (int)((308 + 1) * 0.47456)]; -- invalid C */
2910                     char   buf[1 + (int)((308 + 1) / 2)]; /* valid C */
2911 #endif
2912                     char  *in = buf + sizeof(buf);
2913
2914                     anv = Perl_floor(anv);
2915                     do {
2916                         const NV next = Perl_floor(anv / 128);
2917                         if (in <= buf)  /* this cannot happen ;-) */
2918                             Perl_croak(aTHX_ "Cannot compress integer in pack");
2919                         *--in = (unsigned char)(anv - (next * 128)) | 0x80;
2920                         anv = next;
2921                     } while (anv > 0);
2922                     buf[sizeof(buf) - 1] &= 0x7f; /* clear continue bit */
2923                     PUSH_GROWING_BYTES(utf8, cat, start, cur,
2924                                        in, (buf + sizeof(buf)) - in);
2925                 } else {
2926                     const char     *from;
2927                     char           *result, *in;
2928                     SV             *norm;
2929                     STRLEN          len;
2930                     bool            done;
2931
2932                   w_string:
2933                     /* Copy string and check for compliance */
2934                     from = SvPV_nomg_const(fromstr, len);
2935                     if ((norm = is_an_int(from, len)) == NULL)
2936                         Perl_croak(aTHX_ "Can only compress unsigned integers in pack");
2937
2938                     Newx(result, len, char);
2939                     in = result + len;
2940                     done = FALSE;
2941                     while (!done) *--in = div128(norm, &done) | 0x80;
2942                     result[len - 1] &= 0x7F; /* clear continue bit */
2943                     PUSH_GROWING_BYTES(utf8, cat, start, cur,
2944                                        in, (result + len) - in);
2945                     Safefree(result);
2946                     SvREFCNT_dec(norm); /* free norm */
2947                 }
2948             }
2949             break;
2950         case 'i':
2951         case 'i' | TYPE_IS_SHRIEKING:
2952             while (len-- > 0) {
2953                 int aint;
2954                 fromstr = NEXTFROM;
2955                 aint = SvIV_no_inf(fromstr, datumtype);
2956                 PUSH_VAR(utf8, cur, aint, needs_swap);
2957             }
2958             break;
2959         case 'N' | TYPE_IS_SHRIEKING:
2960         case 'N':
2961             while (len-- > 0) {
2962                 U32 au32;
2963                 fromstr = NEXTFROM;
2964                 au32 = SvUV_no_inf(fromstr, datumtype);
2965                 au32 = PerlSock_htonl(au32);
2966                 PUSH32(utf8, cur, &au32, FALSE);
2967             }
2968             break;
2969         case 'V' | TYPE_IS_SHRIEKING:
2970         case 'V':
2971             while (len-- > 0) {
2972                 U32 au32;
2973                 fromstr = NEXTFROM;
2974                 au32 = SvUV_no_inf(fromstr, datumtype);
2975                 au32 = htovl(au32);
2976                 PUSH32(utf8, cur, &au32, FALSE);
2977             }
2978             break;
2979         case 'L' | TYPE_IS_SHRIEKING:
2980 #if LONGSIZE != SIZE32
2981             while (len-- > 0) {
2982                 unsigned long aulong;
2983                 fromstr = NEXTFROM;
2984                 aulong = SvUV_no_inf(fromstr, datumtype);
2985                 PUSH_VAR(utf8, cur, aulong, needs_swap);
2986             }
2987             break;
2988 #else
2989             /* Fall though! */
2990 #endif
2991         case 'L':
2992             while (len-- > 0) {
2993                 U32 au32;
2994                 fromstr = NEXTFROM;
2995                 au32 = SvUV_no_inf(fromstr, datumtype);
2996                 PUSH32(utf8, cur, &au32, needs_swap);
2997             }
2998             break;
2999         case 'l' | TYPE_IS_SHRIEKING:
3000 #if LONGSIZE != SIZE32
3001             while (len-- > 0) {
3002                 long along;
3003                 fromstr = NEXTFROM;
3004                 along = SvIV_no_inf(fromstr, datumtype);
3005                 PUSH_VAR(utf8, cur, along, needs_swap);
3006             }
3007             break;
3008 #else
3009             /* Fall though! */
3010 #endif
3011         case 'l':
3012             while (len-- > 0) {
3013                 I32 ai32;
3014                 fromstr = NEXTFROM;
3015                 ai32 = SvIV_no_inf(fromstr, datumtype);
3016                 PUSH32(utf8, cur, &ai32, needs_swap);
3017             }
3018             break;
3019 #if defined(HAS_QUAD) && IVSIZE >= 8
3020         case 'Q':
3021             while (len-- > 0) {
3022                 Uquad_t auquad;
3023                 fromstr = NEXTFROM;
3024                 auquad = (Uquad_t) SvUV_no_inf(fromstr, datumtype);
3025                 PUSH_VAR(utf8, cur, auquad, needs_swap);
3026             }
3027             break;
3028         case 'q':
3029             while (len-- > 0) {
3030                 Quad_t aquad;
3031                 fromstr = NEXTFROM;
3032                 aquad = (Quad_t)SvIV_no_inf(fromstr, datumtype);
3033                 PUSH_VAR(utf8, cur, aquad, needs_swap);
3034             }
3035             break;
3036 #endif
3037         case 'P':
3038             len = 1;            /* assume SV is correct length */
3039             GROWING(utf8, cat, start, cur, sizeof(char *));
3040             /* FALLTHROUGH */
3041         case 'p':
3042             while (len-- > 0) {
3043                 const char *aptr;
3044
3045                 fromstr = NEXTFROM;
3046                 SvGETMAGIC(fromstr);
3047                 if (!SvOK(fromstr)) aptr = NULL;
3048                 else {
3049                     /* XXX better yet, could spirit away the string to
3050                      * a safe spot and hang on to it until the result
3051                      * of pack() (and all copies of the result) are
3052                      * gone.
3053                      */
3054                     if ((SvTEMP(fromstr) || (SvPADTMP(fromstr) &&
3055                              !SvREADONLY(fromstr)))) {
3056                         Perl_ck_warner(aTHX_ packWARN(WARN_PACK),
3057                                        "Attempt to pack pointer to temporary value");
3058                     }
3059                     if (SvPOK(fromstr) || SvNIOK(fromstr))
3060                         aptr = SvPV_nomg_const_nolen(fromstr);
3061                     else
3062                         aptr = SvPV_force_flags_nolen(fromstr, 0);
3063                 }
3064                 PUSH_VAR(utf8, cur, aptr, needs_swap);
3065             }
3066             break;
3067         case 'u': {
3068             const char *aptr, *aend;
3069             bool from_utf8;
3070
3071             fromstr = NEXTFROM;
3072             if (len <= 2) len = 45;
3073             else len = len / 3 * 3;
3074             if (len >= 64) {
3075                 Perl_ck_warner(aTHX_ packWARN(WARN_PACK),
3076                                "Field too wide in 'u' format in pack");
3077                 len = 63;
3078             }
3079             aptr = SvPV_const(fromstr, fromlen);
3080             from_utf8 = DO_UTF8(fromstr);
3081             if (from_utf8) {
3082                 aend = aptr + fromlen;
3083                 fromlen = sv_len_utf8_nomg(fromstr);
3084             } else aend = NULL; /* Unused, but keep compilers happy */
3085             GROWING(utf8, cat, start, cur, (fromlen+2) / 3 * 4 + (fromlen+len-1)/len * 2);
3086             while (fromlen > 0) {
3087                 U8 *end;
3088                 I32 todo;
3089                 U8 hunk[1+63/3*4+1];
3090
3091                 if ((I32)fromlen > len)
3092                     todo = len;
3093                 else
3094                     todo = fromlen;
3095                 if (from_utf8) {
3096                     char buffer[64];
3097                     if (!uni_to_bytes(aTHX_ &aptr, aend, buffer, todo,
3098                                       'u' | TYPE_IS_PACK)) {
3099                         *cur = '\0';
3100                         SvCUR_set(cat, cur - start);
3101                         Perl_croak(aTHX_ "panic: string is shorter than advertised, "
3102                                    "aptr=%p, aend=%p, buffer=%p, todo=%ld",
3103                                    aptr, aend, buffer, (long) todo);
3104                     }
3105                     end = doencodes(hunk, buffer, todo);
3106                 } else {
3107                     end = doencodes(hunk, aptr, todo);
3108                     aptr += todo;
3109                 }
3110                 PUSH_BYTES(utf8, cur, hunk, end-hunk, 0);
3111                 fromlen -= todo;
3112             }
3113             break;
3114         }
3115         }
3116         *cur = '\0';
3117         SvCUR_set(cat, cur - start);
3118       no_change:
3119         *symptr = lookahead;
3120     }
3121     return beglist;
3122 }
3123 #undef NEXTFROM
3124
3125
3126 PP(pp_pack)
3127 {
3128     dSP; dMARK; dORIGMARK; dTARGET;
3129     SV *cat = TARG;
3130     STRLEN fromlen;
3131     SV *pat_sv = *++MARK;
3132     const char *pat = SvPV_const(pat_sv, fromlen);
3133     const char *patend = pat + fromlen;
3134
3135     MARK++;
3136     sv_setpvs(cat, "");
3137     SvUTF8_off(cat);
3138
3139     packlist(cat, pat, patend, MARK, SP + 1);
3140
3141     SvSETMAGIC(cat);
3142     SP = ORIGMARK;
3143     PUSHs(cat);
3144     RETURN;
3145 }
3146
3147 /*
3148  * Local variables:
3149  * c-indentation-style: bsd
3150  * c-basic-offset: 4
3151  * indent-tabs-mode: nil
3152  * End:
3153  *
3154  * ex: set ts=8 sts=4 sw=4 et:
3155  */