This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
inline.h: Move some fcn '{' to column 1
[perl5.git] / inline.h
1 /*    inline.h
2  *
3  *    Copyright (C) 2012 by Larry Wall and others
4  *
5  *    You may distribute under the terms of either the GNU General Public
6  *    License or the Artistic License, as specified in the README file.
7  *
8  *    This file contains tables and code adapted from
9  *    http://bjoern.hoehrmann.de/utf-8/decoder/dfa/, which requires this
10  *    copyright notice:
11
12 Copyright (c) 2008-2009 Bjoern Hoehrmann <bjoern@hoehrmann.de>
13
14 Permission is hereby granted, free of charge, to any person obtaining a copy of
15 this software and associated documentation files (the "Software"), to deal in
16 the Software without restriction, including without limitation the rights to
17 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
18 of the Software, and to permit persons to whom the Software is furnished to do
19 so, subject to the following conditions:
20
21 The above copyright notice and this permission notice shall be included in all
22 copies or substantial portions of the Software.
23
24 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
27 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
29 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30 SOFTWARE.
31
32  *
33  * This file is a home for static inline functions that cannot go in other
34  * header files, because they depend on proto.h (included after most other
35  * headers) or struct definitions.
36  *
37  * Each section names the header file that the functions "belong" to.
38  */
39
40 /* ------------------------------- av.h ------------------------------- */
41
42 PERL_STATIC_INLINE SSize_t
43 Perl_av_top_index(pTHX_ AV *av)
44 {
45     PERL_ARGS_ASSERT_AV_TOP_INDEX;
46     assert(SvTYPE(av) == SVt_PVAV);
47
48     return AvFILL(av);
49 }
50
51 /* ------------------------------- cv.h ------------------------------- */
52
53 PERL_STATIC_INLINE GV *
54 Perl_CvGV(pTHX_ CV *sv)
55 {
56     return CvNAMED(sv)
57         ? Perl_cvgv_from_hek(aTHX_ sv)
58         : ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_gv_u.xcv_gv;
59 }
60
61 PERL_STATIC_INLINE I32 *
62 Perl_CvDEPTHp(const CV * const sv)
63 {
64     assert(SvTYPE(sv) == SVt_PVCV || SvTYPE(sv) == SVt_PVFM);
65     return &((XPVCV*)SvANY(sv))->xcv_depth;
66 }
67
68 /*
69  CvPROTO returns the prototype as stored, which is not necessarily what
70  the interpreter should be using. Specifically, the interpreter assumes
71  that spaces have been stripped, which has been the case if the prototype
72  was added by toke.c, but is generally not the case if it was added elsewhere.
73  Since we can't enforce the spacelessness at assignment time, this routine
74  provides a temporary copy at parse time with spaces removed.
75  I<orig> is the start of the original buffer, I<len> is the length of the
76  prototype and will be updated when this returns.
77  */
78
79 #ifdef PERL_CORE
80 PERL_STATIC_INLINE char *
81 S_strip_spaces(pTHX_ const char * orig, STRLEN * const len)
82 {
83     SV * tmpsv;
84     char * tmps;
85     tmpsv = newSVpvn_flags(orig, *len, SVs_TEMP);
86     tmps = SvPVX(tmpsv);
87     while ((*len)--) {
88         if (!isSPACE(*orig))
89             *tmps++ = *orig;
90         orig++;
91     }
92     *tmps = '\0';
93     *len = tmps - SvPVX(tmpsv);
94                 return SvPVX(tmpsv);
95 }
96 #endif
97
98 /* ------------------------------- mg.h ------------------------------- */
99
100 #if defined(PERL_CORE) || defined(PERL_EXT)
101 /* assumes get-magic and stringification have already occurred */
102 PERL_STATIC_INLINE STRLEN
103 S_MgBYTEPOS(pTHX_ MAGIC *mg, SV *sv, const char *s, STRLEN len)
104 {
105     assert(mg->mg_type == PERL_MAGIC_regex_global);
106     assert(mg->mg_len != -1);
107     if (mg->mg_flags & MGf_BYTES || !DO_UTF8(sv))
108         return (STRLEN)mg->mg_len;
109     else {
110         const STRLEN pos = (STRLEN)mg->mg_len;
111         /* Without this check, we may read past the end of the buffer: */
112         if (pos > sv_or_pv_len_utf8(sv, s, len)) return len+1;
113         return sv_or_pv_pos_u2b(sv, s, pos, NULL);
114     }
115 }
116 #endif
117
118 /* ------------------------------- pad.h ------------------------------ */
119
120 #if defined(PERL_IN_PAD_C) || defined(PERL_IN_OP_C)
121 PERL_STATIC_INLINE bool
122 S_PadnameIN_SCOPE(const PADNAME * const pn, const U32 seq)
123 {
124     PERL_ARGS_ASSERT_PADNAMEIN_SCOPE;
125
126     /* is seq within the range _LOW to _HIGH ?
127      * This is complicated by the fact that PL_cop_seqmax
128      * may have wrapped around at some point */
129     if (COP_SEQ_RANGE_LOW(pn) == PERL_PADSEQ_INTRO)
130         return FALSE; /* not yet introduced */
131
132     if (COP_SEQ_RANGE_HIGH(pn) == PERL_PADSEQ_INTRO) {
133     /* in compiling scope */
134         if (
135             (seq >  COP_SEQ_RANGE_LOW(pn))
136             ? (seq - COP_SEQ_RANGE_LOW(pn) < (U32_MAX >> 1))
137             : (COP_SEQ_RANGE_LOW(pn) - seq > (U32_MAX >> 1))
138         )
139             return TRUE;
140     }
141     else if (
142         (COP_SEQ_RANGE_LOW(pn) > COP_SEQ_RANGE_HIGH(pn))
143         ?
144             (  seq >  COP_SEQ_RANGE_LOW(pn)
145             || seq <= COP_SEQ_RANGE_HIGH(pn))
146
147         :    (  seq >  COP_SEQ_RANGE_LOW(pn)
148              && seq <= COP_SEQ_RANGE_HIGH(pn))
149     )
150         return TRUE;
151     return FALSE;
152 }
153 #endif
154
155 /* ------------------------------- pp.h ------------------------------- */
156
157 PERL_STATIC_INLINE I32
158 Perl_TOPMARK(pTHX)
159 {
160     DEBUG_s(DEBUG_v(PerlIO_printf(Perl_debug_log,
161                                  "MARK top  %p %" IVdf "\n",
162                                   PL_markstack_ptr,
163                                   (IV)*PL_markstack_ptr)));
164     return *PL_markstack_ptr;
165 }
166
167 PERL_STATIC_INLINE I32
168 Perl_POPMARK(pTHX)
169 {
170     DEBUG_s(DEBUG_v(PerlIO_printf(Perl_debug_log,
171                                  "MARK pop  %p %" IVdf "\n",
172                                   (PL_markstack_ptr-1),
173                                   (IV)*(PL_markstack_ptr-1))));
174     assert((PL_markstack_ptr > PL_markstack) || !"MARK underflow");
175     return *PL_markstack_ptr--;
176 }
177
178 /* ----------------------------- regexp.h ----------------------------- */
179
180 PERL_STATIC_INLINE struct regexp *
181 Perl_ReANY(const REGEXP * const re)
182 {
183     XPV* const p = (XPV*)SvANY(re);
184     assert(isREGEXP(re));
185     return SvTYPE(re) == SVt_PVLV ? p->xpv_len_u.xpvlenu_rx
186                                    : (struct regexp *)p;
187 }
188
189 /* ------------------------------- sv.h ------------------------------- */
190
191 PERL_STATIC_INLINE SV *
192 Perl_SvREFCNT_inc(SV *sv)
193 {
194     if (LIKELY(sv != NULL))
195         SvREFCNT(sv)++;
196     return sv;
197 }
198 PERL_STATIC_INLINE SV *
199 Perl_SvREFCNT_inc_NN(SV *sv)
200 {
201     PERL_ARGS_ASSERT_SVREFCNT_INC_NN;
202
203     SvREFCNT(sv)++;
204     return sv;
205 }
206 PERL_STATIC_INLINE void
207 Perl_SvREFCNT_inc_void(SV *sv)
208 {
209     if (LIKELY(sv != NULL))
210         SvREFCNT(sv)++;
211 }
212 PERL_STATIC_INLINE void
213 Perl_SvREFCNT_dec(pTHX_ SV *sv)
214 {
215     if (LIKELY(sv != NULL)) {
216         U32 rc = SvREFCNT(sv);
217         if (LIKELY(rc > 1))
218             SvREFCNT(sv) = rc - 1;
219         else
220             Perl_sv_free2(aTHX_ sv, rc);
221     }
222 }
223
224 PERL_STATIC_INLINE void
225 Perl_SvREFCNT_dec_NN(pTHX_ SV *sv)
226 {
227     U32 rc = SvREFCNT(sv);
228
229     PERL_ARGS_ASSERT_SVREFCNT_DEC_NN;
230
231     if (LIKELY(rc > 1))
232         SvREFCNT(sv) = rc - 1;
233     else
234         Perl_sv_free2(aTHX_ sv, rc);
235 }
236
237 PERL_STATIC_INLINE void
238 SvAMAGIC_on(SV *sv)
239 {
240     assert(SvROK(sv));
241     if (SvOBJECT(SvRV(sv))) HvAMAGIC_on(SvSTASH(SvRV(sv)));
242 }
243 PERL_STATIC_INLINE void
244 SvAMAGIC_off(SV *sv)
245 {
246     if (SvROK(sv) && SvOBJECT(SvRV(sv)))
247         HvAMAGIC_off(SvSTASH(SvRV(sv)));
248 }
249
250 PERL_STATIC_INLINE U32
251 Perl_SvPADSTALE_on(SV *sv)
252 {
253     assert(!(SvFLAGS(sv) & SVs_PADTMP));
254     return SvFLAGS(sv) |= SVs_PADSTALE;
255 }
256 PERL_STATIC_INLINE U32
257 Perl_SvPADSTALE_off(SV *sv)
258 {
259     assert(!(SvFLAGS(sv) & SVs_PADTMP));
260     return SvFLAGS(sv) &= ~SVs_PADSTALE;
261 }
262 #if defined(PERL_CORE) || defined (PERL_EXT)
263 PERL_STATIC_INLINE STRLEN
264 S_sv_or_pv_pos_u2b(pTHX_ SV *sv, const char *pv, STRLEN pos, STRLEN *lenp)
265 {
266     PERL_ARGS_ASSERT_SV_OR_PV_POS_U2B;
267     if (SvGAMAGIC(sv)) {
268         U8 *hopped = utf8_hop((U8 *)pv, pos);
269         if (lenp) *lenp = (STRLEN)(utf8_hop(hopped, *lenp) - hopped);
270         return (STRLEN)(hopped - (U8 *)pv);
271     }
272     return sv_pos_u2b_flags(sv,pos,lenp,SV_CONST_RETURN);
273 }
274 #endif
275
276 /* ------------------------------- handy.h ------------------------------- */
277
278 /* saves machine code for a common noreturn idiom typically used in Newx*() */
279 GCC_DIAG_IGNORE_DECL(-Wunused-function);
280 static void
281 Perl_croak_memory_wrap(void)
282 {
283     Perl_croak_nocontext("%s",PL_memory_wrap);
284 }
285 GCC_DIAG_RESTORE_DECL;
286
287 /* ------------------------------- utf8.h ------------------------------- */
288
289 /*
290 =head1 Unicode Support
291 */
292
293 PERL_STATIC_INLINE void
294 Perl_append_utf8_from_native_byte(const U8 byte, U8** dest)
295 {
296     /* Takes an input 'byte' (Latin1 or EBCDIC) and appends it to the UTF-8
297      * encoded string at '*dest', updating '*dest' to include it */
298
299     PERL_ARGS_ASSERT_APPEND_UTF8_FROM_NATIVE_BYTE;
300
301     if (NATIVE_BYTE_IS_INVARIANT(byte))
302         *((*dest)++) = byte;
303     else {
304         *((*dest)++) = UTF8_EIGHT_BIT_HI(byte);
305         *((*dest)++) = UTF8_EIGHT_BIT_LO(byte);
306     }
307 }
308
309 /*
310 =for apidoc valid_utf8_to_uvchr
311 Like C<L<perlapi/utf8_to_uvchr_buf>>, but should only be called when it is
312 known that the next character in the input UTF-8 string C<s> is well-formed
313 (I<e.g.>, it passes C<L<perlapi/isUTF8_CHAR>>.  Surrogates, non-character code
314 points, and non-Unicode code points are allowed.
315
316 =cut
317
318  */
319
320 PERL_STATIC_INLINE UV
321 Perl_valid_utf8_to_uvchr(const U8 *s, STRLEN *retlen)
322 {
323     const UV expectlen = UTF8SKIP(s);
324     const U8* send = s + expectlen;
325     UV uv = *s;
326
327     PERL_ARGS_ASSERT_VALID_UTF8_TO_UVCHR;
328
329     if (retlen) {
330         *retlen = expectlen;
331     }
332
333     /* An invariant is trivially returned */
334     if (expectlen == 1) {
335         return uv;
336     }
337
338     /* Remove the leading bits that indicate the number of bytes, leaving just
339      * the bits that are part of the value */
340     uv = NATIVE_UTF8_TO_I8(uv) & UTF_START_MASK(expectlen);
341
342     /* Now, loop through the remaining bytes, accumulating each into the
343      * working total as we go.  (I khw tried unrolling the loop for up to 4
344      * bytes, but there was no performance improvement) */
345     for (++s; s < send; s++) {
346         uv = UTF8_ACCUMULATE(uv, *s);
347     }
348
349     return UNI_TO_NATIVE(uv);
350
351 }
352
353 /*
354 =for apidoc is_utf8_invariant_string
355
356 Returns TRUE if the first C<len> bytes of the string C<s> are the same
357 regardless of the UTF-8 encoding of the string (or UTF-EBCDIC encoding on
358 EBCDIC machines); otherwise it returns FALSE.  That is, it returns TRUE if they
359 are UTF-8 invariant.  On ASCII-ish machines, all the ASCII characters and only
360 the ASCII characters fit this definition.  On EBCDIC machines, the ASCII-range
361 characters are invariant, but so also are the C1 controls.
362
363 If C<len> is 0, it will be calculated using C<strlen(s)>, (which means if you
364 use this option, that C<s> can't have embedded C<NUL> characters and has to
365 have a terminating C<NUL> byte).
366
367 See also
368 C<L</is_utf8_string>>,
369 C<L</is_utf8_string_flags>>,
370 C<L</is_utf8_string_loc>>,
371 C<L</is_utf8_string_loc_flags>>,
372 C<L</is_utf8_string_loclen>>,
373 C<L</is_utf8_string_loclen_flags>>,
374 C<L</is_utf8_fixed_width_buf_flags>>,
375 C<L</is_utf8_fixed_width_buf_loc_flags>>,
376 C<L</is_utf8_fixed_width_buf_loclen_flags>>,
377 C<L</is_strict_utf8_string>>,
378 C<L</is_strict_utf8_string_loc>>,
379 C<L</is_strict_utf8_string_loclen>>,
380 C<L</is_c9strict_utf8_string>>,
381 C<L</is_c9strict_utf8_string_loc>>,
382 and
383 C<L</is_c9strict_utf8_string_loclen>>.
384
385 =cut
386
387 */
388
389 #define is_utf8_invariant_string(s, len)                                    \
390                                 is_utf8_invariant_string_loc(s, len, NULL)
391
392 /*
393 =for apidoc is_utf8_invariant_string_loc
394
395 Like C<L</is_utf8_invariant_string>> but upon failure, stores the location of
396 the first UTF-8 variant character in the C<ep> pointer; if all characters are
397 UTF-8 invariant, this function does not change the contents of C<*ep>.
398
399 =cut
400
401 */
402
403 PERL_STATIC_INLINE bool
404 Perl_is_utf8_invariant_string_loc(const U8* const s, STRLEN len, const U8 ** ep)
405 {
406     const U8* send;
407     const U8* x = s;
408
409     PERL_ARGS_ASSERT_IS_UTF8_INVARIANT_STRING_LOC;
410
411     if (len == 0) {
412         len = strlen((const char *)s);
413     }
414
415     send = s + len;
416
417 /* This looks like 0x010101... */
418 #  define PERL_COUNT_MULTIPLIER   (~ (UINTMAX_C(0)) / 0xFF)
419
420 /* This looks like 0x808080... */
421 #  define PERL_VARIANTS_WORD_MASK (PERL_COUNT_MULTIPLIER * 0x80)
422 #  define PERL_WORDSIZE            sizeof(PERL_UINTMAX_T)
423 #  define PERL_WORD_BOUNDARY_MASK (PERL_WORDSIZE - 1)
424
425 /* Evaluates to 0 if 'x' is at a word boundary; otherwise evaluates to 1, by
426  * or'ing together the lowest bits of 'x'.  Hopefully the final term gets
427  * optimized out completely on a 32-bit system, and its mask gets optimized out
428  * on a 64-bit system */
429 #  define PERL_IS_SUBWORD_ADDR(x) (1 & (       PTR2nat(x)                     \
430                                       |   (  PTR2nat(x) >> 1)                 \
431                                       | ( ( (PTR2nat(x)                       \
432                                            & PERL_WORD_BOUNDARY_MASK) >> 2))))
433
434 #ifndef EBCDIC
435
436     /* Do the word-at-a-time iff there is at least one usable full word.  That
437      * means that after advancing to a word boundary, there still is at least a
438      * full word left.  The number of bytes needed to advance is 'wordsize -
439      * offset' unless offset is 0. */
440     if ((STRLEN) (send - x) >= PERL_WORDSIZE
441
442                             /* This term is wordsize if subword; 0 if not */
443                           + PERL_WORDSIZE * PERL_IS_SUBWORD_ADDR(x)
444
445                             /* 'offset' */
446                           - (PTR2nat(x) & PERL_WORD_BOUNDARY_MASK))
447     {
448
449         /* Process per-byte until reach word boundary.  XXX This loop could be
450          * eliminated if we knew that this platform had fast unaligned reads */
451         while (PTR2nat(x) & PERL_WORD_BOUNDARY_MASK) {
452             if (! UTF8_IS_INVARIANT(*x)) {
453                 if (ep) {
454                     *ep = x;
455                 }
456
457                 return FALSE;
458             }
459             x++;
460         }
461
462         /* Here, we know we have at least one full word to process.  Process
463          * per-word as long as we have at least a full word left */
464         do {
465             if ((* (PERL_UINTMAX_T *) x) & PERL_VARIANTS_WORD_MASK)  {
466
467                 /* Found a variant.  Just return if caller doesn't want its
468                  * exact position */
469                 if (! ep) {
470                     return FALSE;
471                 }
472
473 #  if   BYTEORDER == 0x1234 || BYTEORDER == 0x12345678    \
474      || BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
475
476                 *ep = x + variant_byte_number(* (PERL_UINTMAX_T *) x);
477                 assert(*ep >= s && *ep < send);
478
479                 return FALSE;
480
481 #  else   /* If weird byte order, drop into next loop to do byte-at-a-time
482            checks. */
483
484                 break;
485 #  endif
486             }
487
488             x += PERL_WORDSIZE;
489
490         } while (x + PERL_WORDSIZE <= send);
491     }
492
493 #endif      /* End of ! EBCDIC */
494
495     /* Process per-byte */
496     while (x < send) {
497         if (! UTF8_IS_INVARIANT(*x)) {
498             if (ep) {
499                 *ep = x;
500             }
501
502             return FALSE;
503         }
504
505         x++;
506     }
507
508     return TRUE;
509 }
510
511 #ifndef EBCDIC
512
513 PERL_STATIC_INLINE unsigned int
514 Perl_variant_byte_number(PERL_UINTMAX_T word)
515 {
516
517     /* This returns the position in a word (0..7) of the first variant byte in
518      * it.  This is a helper function.  Note that there are no branches */
519
520     assert(word);
521
522     /* Get just the msb bits of each byte */
523     word &= PERL_VARIANTS_WORD_MASK;
524
525 #  ifdef USING_MSVC6    /* VC6 has some issues with the normal code, and the
526                            easiest thing is to hide that from the callers */
527     {
528         unsigned int i;
529         const U8 * s = (U8 *) &word;
530         dTHX;
531
532         for (i = 0; i < sizeof(word); i++ ) {
533             if (s[i]) {
534                 return i;
535             }
536         }
537
538         Perl_croak(aTHX_ "panic: %s: %d: unexpected zero word\n",
539                                  __FILE__, __LINE__);
540     }
541
542 #  elif BYTEORDER == 0x1234 || BYTEORDER == 0x12345678
543
544     /* Bytes are stored like
545      *  Byte8 ... Byte2 Byte1
546      *  63..56...15...8 7...0
547      *
548      *  Isolate the lsb;
549      * https://stackoverflow.com/questions/757059/position-of-least-significant-bit-that-is-set
550      *
551      * The word will look this this, with a rightmost set bit in position 's':
552      * ('x's are don't cares)
553      *      s
554      *  x..x100..0
555      *  x..xx10..0      Right shift (rightmost 0 is shifted off)
556      *  x..xx01..1      Subtract 1, turns all the trailing zeros into 1's and
557      *                  the 1 just to their left into a 0; the remainder is
558      *                  untouched
559      *  0..0011..1      The xor with the original, x..xx10..0, clears that
560      *                  remainder, sets the bottom to all 1
561      *  0..0100..0      Add 1 to clear the word except for the bit in 's'
562      *
563      * Another method is to do 'word &= -word'; but it generates a compiler
564      * message on some platforms about taking the negative of an unsigned */
565
566     word >>= 1;
567     word = 1 + (word ^ (word - 1));
568
569 #  elif BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
570
571     /* Bytes are stored like
572      *  Byte1 Byte2  ... Byte8
573      * 63..56 55..47 ... 7...0
574      *
575      * Isolate the msb; http://codeforces.com/blog/entry/10330
576      *
577      * Only the most significant set bit matters.  Or'ing word with its right
578      * shift of 1 makes that bit and the next one to its right both 1.  Then
579      * right shifting by 2 makes for 4 1-bits in a row. ...  We end with the
580      * msb and all to the right being 1. */
581     word |= word >>  1;
582     word |= word >>  2;
583     word |= word >>  4;
584     word |= word >>  8;
585     word |= word >> 16;
586     word |= word >> 32;  /* This should get optimized out on 32-bit systems. */
587
588     /* Then subtracting the right shift by 1 clears all but the left-most of
589      * the 1 bits, which is our desired result */
590     word -= (word >> 1);
591
592 #  else
593 #    error Unexpected byte order
594 #  endif
595
596     /* Here 'word' has a single bit set: the  msb of the first byte in which it
597      * is set.  Calculate that position in the word.  We can use this
598      * specialized solution: https://stackoverflow.com/a/32339674/1626653,
599      * assumes an 8-bit byte.  (On a 32-bit machine, the larger numbers should
600      * just get shifted off at compile time) */
601     word = (word >> 7) * ((UINTMAX_C( 7) << 56) | (UINTMAX_C(15) << 48)
602                         | (UINTMAX_C(23) << 40) | (UINTMAX_C(31) << 32)
603                         |           (39 <<  24) |           (47 <<  16)
604                         |           (55 <<   8) |           (63 <<   0));
605     word >>= PERL_WORDSIZE * 7; /* >> by either 56 or 24 */
606
607     /* Here, word contains the position 7..63 of that bit.  Convert to 0..7 */
608     word = ((word + 1) >> 3) - 1;
609
610 #  if BYTEORDER == 0x4321 || BYTEORDER == 0x87654321
611
612     /* And invert the result */
613     word = CHARBITS - word - 1;
614
615 #  endif
616
617     return (unsigned int) word;
618 }
619
620 #endif
621 #if defined(PERL_CORE) || defined(PERL_EXT)
622
623 /*
624 =for apidoc variant_under_utf8_count
625
626 This function looks at the sequence of bytes between C<s> and C<e>, which are
627 assumed to be encoded in ASCII/Latin1, and returns how many of them would
628 change should the string be translated into UTF-8.  Due to the nature of UTF-8,
629 each of these would occupy two bytes instead of the single one in the input
630 string.  Thus, this function returns the precise number of bytes the string
631 would expand by when translated to UTF-8.
632
633 Unlike most of the other functions that have C<utf8> in their name, the input
634 to this function is NOT a UTF-8-encoded string.  The function name is slightly
635 I<odd> to emphasize this.
636
637 This function is internal to Perl because khw thinks that any XS code that
638 would want this is probably operating too close to the internals.  Presenting a
639 valid use case could change that.
640
641 See also
642 C<L<perlapi/is_utf8_invariant_string>>
643 and
644 C<L<perlapi/is_utf8_invariant_string_loc>>,
645
646 =cut
647
648 */
649
650 PERL_STATIC_INLINE Size_t
651 S_variant_under_utf8_count(const U8* const s, const U8* const e)
652 {
653     const U8* x = s;
654     Size_t count = 0;
655
656     PERL_ARGS_ASSERT_VARIANT_UNDER_UTF8_COUNT;
657
658 #  ifndef EBCDIC
659
660     /* Test if the string is long enough to use word-at-a-time.  (Logic is the
661      * same as for is_utf8_invariant_string()) */
662     if ((STRLEN) (e - x) >= PERL_WORDSIZE
663                           + PERL_WORDSIZE * PERL_IS_SUBWORD_ADDR(x)
664                           - (PTR2nat(x) & PERL_WORD_BOUNDARY_MASK))
665     {
666
667         /* Process per-byte until reach word boundary.  XXX This loop could be
668          * eliminated if we knew that this platform had fast unaligned reads */
669         while (PTR2nat(x) & PERL_WORD_BOUNDARY_MASK) {
670             count += ! UTF8_IS_INVARIANT(*x++);
671         }
672
673         /* Process per-word as long as we have at least a full word left */
674         do {    /* Commit 03c1e4ab1d6ee9062fb3f94b0ba31db6698724b1 contains an
675                    explanation of how this works */
676             PERL_UINTMAX_T increment
677                 = ((((* (PERL_UINTMAX_T *) x) & PERL_VARIANTS_WORD_MASK) >> 7)
678                       * PERL_COUNT_MULTIPLIER)
679                     >> ((PERL_WORDSIZE - 1) * CHARBITS);
680             count += (Size_t) increment;
681             x += PERL_WORDSIZE;
682         } while (x + PERL_WORDSIZE <= e);
683     }
684
685 #  endif
686
687     /* Process per-byte */
688     while (x < e) {
689         if (! UTF8_IS_INVARIANT(*x)) {
690             count++;
691         }
692
693         x++;
694     }
695
696     return count;
697 }
698
699 #endif
700
701 #ifndef PERL_IN_REGEXEC_C   /* Keep  these around for that file */
702 #  undef PERL_WORDSIZE
703 #  undef PERL_COUNT_MULTIPLIER
704 #  undef PERL_WORD_BOUNDARY_MASK
705 #  undef PERL_VARIANTS_WORD_MASK
706 #endif
707
708 /*
709 =for apidoc is_utf8_string
710
711 Returns TRUE if the first C<len> bytes of string C<s> form a valid
712 Perl-extended-UTF-8 string; returns FALSE otherwise.  If C<len> is 0, it will
713 be calculated using C<strlen(s)> (which means if you use this option, that C<s>
714 can't have embedded C<NUL> characters and has to have a terminating C<NUL>
715 byte).  Note that all characters being ASCII constitute 'a valid UTF-8 string'.
716
717 This function considers Perl's extended UTF-8 to be valid.  That means that
718 code points above Unicode, surrogates, and non-character code points are
719 considered valid by this function.  Use C<L</is_strict_utf8_string>>,
720 C<L</is_c9strict_utf8_string>>, or C<L</is_utf8_string_flags>> to restrict what
721 code points are considered valid.
722
723 See also
724 C<L</is_utf8_invariant_string>>,
725 C<L</is_utf8_invariant_string_loc>>,
726 C<L</is_utf8_string_loc>>,
727 C<L</is_utf8_string_loclen>>,
728 C<L</is_utf8_fixed_width_buf_flags>>,
729 C<L</is_utf8_fixed_width_buf_loc_flags>>,
730 C<L</is_utf8_fixed_width_buf_loclen_flags>>,
731
732 =cut
733 */
734
735 #define is_utf8_string(s, len)  is_utf8_string_loclen(s, len, NULL, NULL)
736
737 #if defined(PERL_CORE) || defined (PERL_EXT)
738
739 /*
740 =for apidoc is_utf8_non_invariant_string
741
742 Returns TRUE if L<perlapi/is_utf8_invariant_string> returns FALSE for the first
743 C<len> bytes of the string C<s>, but they are, nonetheless, legal Perl-extended
744 UTF-8; otherwise returns FALSE.
745
746 A TRUE return means that at least one code point represented by the sequence
747 either is a wide character not representable as a single byte, or the
748 representation differs depending on whether the sequence is encoded in UTF-8 or
749 not.
750
751 See also
752 C<L<perlapi/is_utf8_invariant_string>>,
753 C<L<perlapi/is_utf8_string>>
754
755 =cut
756
757 This is commonly used to determine if a SV's UTF-8 flag should be turned on.
758 It generally needn't be if its string is entirely UTF-8 invariant, and it
759 shouldn't be if it otherwise contains invalid UTF-8.
760
761 It is an internal function because khw thinks that XS code shouldn't be working
762 at this low a level.  A valid use case could change that.
763
764 */
765
766 PERL_STATIC_INLINE bool
767 S_is_utf8_non_invariant_string(const U8* const s, STRLEN len)
768 {
769     const U8 * first_variant;
770
771     PERL_ARGS_ASSERT_IS_UTF8_NON_INVARIANT_STRING;
772
773     if (is_utf8_invariant_string_loc(s, len, &first_variant)) {
774         return FALSE;
775     }
776
777     return is_utf8_string(first_variant, len - (first_variant - s));
778 }
779
780 #endif
781
782 /*
783 =for apidoc is_strict_utf8_string
784
785 Returns TRUE if the first C<len> bytes of string C<s> form a valid
786 UTF-8-encoded string that is fully interchangeable by any application using
787 Unicode rules; otherwise it returns FALSE.  If C<len> is 0, it will be
788 calculated using C<strlen(s)> (which means if you use this option, that C<s>
789 can't have embedded C<NUL> characters and has to have a terminating C<NUL>
790 byte).  Note that all characters being ASCII constitute 'a valid UTF-8 string'.
791
792 This function returns FALSE for strings containing any
793 code points above the Unicode max of 0x10FFFF, surrogate code points, or
794 non-character code points.
795
796 See also
797 C<L</is_utf8_invariant_string>>,
798 C<L</is_utf8_invariant_string_loc>>,
799 C<L</is_utf8_string>>,
800 C<L</is_utf8_string_flags>>,
801 C<L</is_utf8_string_loc>>,
802 C<L</is_utf8_string_loc_flags>>,
803 C<L</is_utf8_string_loclen>>,
804 C<L</is_utf8_string_loclen_flags>>,
805 C<L</is_utf8_fixed_width_buf_flags>>,
806 C<L</is_utf8_fixed_width_buf_loc_flags>>,
807 C<L</is_utf8_fixed_width_buf_loclen_flags>>,
808 C<L</is_strict_utf8_string_loc>>,
809 C<L</is_strict_utf8_string_loclen>>,
810 C<L</is_c9strict_utf8_string>>,
811 C<L</is_c9strict_utf8_string_loc>>,
812 and
813 C<L</is_c9strict_utf8_string_loclen>>.
814
815 =cut
816 */
817
818 #define is_strict_utf8_string(s, len)  is_strict_utf8_string_loclen(s, len, NULL, NULL)
819
820 /*
821 =for apidoc is_c9strict_utf8_string
822
823 Returns TRUE if the first C<len> bytes of string C<s> form a valid
824 UTF-8-encoded string that conforms to
825 L<Unicode Corrigendum #9|http://www.unicode.org/versions/corrigendum9.html>;
826 otherwise it returns FALSE.  If C<len> is 0, it will be calculated using
827 C<strlen(s)> (which means if you use this option, that C<s> can't have embedded
828 C<NUL> characters and has to have a terminating C<NUL> byte).  Note that all
829 characters being ASCII constitute 'a valid UTF-8 string'.
830
831 This function returns FALSE for strings containing any code points above the
832 Unicode max of 0x10FFFF or surrogate code points, but accepts non-character
833 code points per
834 L<Corrigendum #9|http://www.unicode.org/versions/corrigendum9.html>.
835
836 See also
837 C<L</is_utf8_invariant_string>>,
838 C<L</is_utf8_invariant_string_loc>>,
839 C<L</is_utf8_string>>,
840 C<L</is_utf8_string_flags>>,
841 C<L</is_utf8_string_loc>>,
842 C<L</is_utf8_string_loc_flags>>,
843 C<L</is_utf8_string_loclen>>,
844 C<L</is_utf8_string_loclen_flags>>,
845 C<L</is_utf8_fixed_width_buf_flags>>,
846 C<L</is_utf8_fixed_width_buf_loc_flags>>,
847 C<L</is_utf8_fixed_width_buf_loclen_flags>>,
848 C<L</is_strict_utf8_string>>,
849 C<L</is_strict_utf8_string_loc>>,
850 C<L</is_strict_utf8_string_loclen>>,
851 C<L</is_c9strict_utf8_string_loc>>,
852 and
853 C<L</is_c9strict_utf8_string_loclen>>.
854
855 =cut
856 */
857
858 #define is_c9strict_utf8_string(s, len)  is_c9strict_utf8_string_loclen(s, len, NULL, 0)
859
860 /*
861 =for apidoc is_utf8_string_flags
862
863 Returns TRUE if the first C<len> bytes of string C<s> form a valid
864 UTF-8 string, subject to the restrictions imposed by C<flags>;
865 returns FALSE otherwise.  If C<len> is 0, it will be calculated
866 using C<strlen(s)> (which means if you use this option, that C<s> can't have
867 embedded C<NUL> characters and has to have a terminating C<NUL> byte).  Note
868 that all characters being ASCII constitute 'a valid UTF-8 string'.
869
870 If C<flags> is 0, this gives the same results as C<L</is_utf8_string>>; if
871 C<flags> is C<UTF8_DISALLOW_ILLEGAL_INTERCHANGE>, this gives the same results
872 as C<L</is_strict_utf8_string>>; and if C<flags> is
873 C<UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE>, this gives the same results as
874 C<L</is_c9strict_utf8_string>>.  Otherwise C<flags> may be any
875 combination of the C<UTF8_DISALLOW_I<foo>> flags understood by
876 C<L</utf8n_to_uvchr>>, with the same meanings.
877
878 See also
879 C<L</is_utf8_invariant_string>>,
880 C<L</is_utf8_invariant_string_loc>>,
881 C<L</is_utf8_string>>,
882 C<L</is_utf8_string_loc>>,
883 C<L</is_utf8_string_loc_flags>>,
884 C<L</is_utf8_string_loclen>>,
885 C<L</is_utf8_string_loclen_flags>>,
886 C<L</is_utf8_fixed_width_buf_flags>>,
887 C<L</is_utf8_fixed_width_buf_loc_flags>>,
888 C<L</is_utf8_fixed_width_buf_loclen_flags>>,
889 C<L</is_strict_utf8_string>>,
890 C<L</is_strict_utf8_string_loc>>,
891 C<L</is_strict_utf8_string_loclen>>,
892 C<L</is_c9strict_utf8_string>>,
893 C<L</is_c9strict_utf8_string_loc>>,
894 and
895 C<L</is_c9strict_utf8_string_loclen>>.
896
897 =cut
898 */
899
900 PERL_STATIC_INLINE bool
901 Perl_is_utf8_string_flags(const U8 *s, STRLEN len, const U32 flags)
902 {
903     const U8 * first_variant;
904
905     PERL_ARGS_ASSERT_IS_UTF8_STRING_FLAGS;
906     assert(0 == (flags & ~(UTF8_DISALLOW_ILLEGAL_INTERCHANGE
907                           |UTF8_DISALLOW_PERL_EXTENDED)));
908
909     if (len == 0) {
910         len = strlen((const char *)s);
911     }
912
913     if (flags == 0) {
914         return is_utf8_string(s, len);
915     }
916
917     if ((flags & ~UTF8_DISALLOW_PERL_EXTENDED)
918                                         == UTF8_DISALLOW_ILLEGAL_INTERCHANGE)
919     {
920         return is_strict_utf8_string(s, len);
921     }
922
923     if ((flags & ~UTF8_DISALLOW_PERL_EXTENDED)
924                                        == UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE)
925     {
926         return is_c9strict_utf8_string(s, len);
927     }
928
929     if (! is_utf8_invariant_string_loc(s, len, &first_variant)) {
930         const U8* const send = s + len;
931         const U8* x = first_variant;
932
933         while (x < send) {
934             STRLEN cur_len = isUTF8_CHAR_flags(x, send, flags);
935             if (UNLIKELY(! cur_len)) {
936                 return FALSE;
937             }
938             x += cur_len;
939         }
940     }
941
942     return TRUE;
943 }
944
945 /*
946
947 =for apidoc is_utf8_string_loc
948
949 Like C<L</is_utf8_string>> but stores the location of the failure (in the
950 case of "utf8ness failure") or the location C<s>+C<len> (in the case of
951 "utf8ness success") in the C<ep> pointer.
952
953 See also C<L</is_utf8_string_loclen>>.
954
955 =cut
956 */
957
958 #define is_utf8_string_loc(s, len, ep)  is_utf8_string_loclen(s, len, ep, 0)
959
960 /*
961
962 =for apidoc is_utf8_string_loclen
963
964 Like C<L</is_utf8_string>> but stores the location of the failure (in the
965 case of "utf8ness failure") or the location C<s>+C<len> (in the case of
966 "utf8ness success") in the C<ep> pointer, and the number of UTF-8
967 encoded characters in the C<el> pointer.
968
969 See also C<L</is_utf8_string_loc>>.
970
971 =cut
972 */
973
974 PERL_STATIC_INLINE bool
975 Perl_is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
976 {
977     const U8 * first_variant;
978
979     PERL_ARGS_ASSERT_IS_UTF8_STRING_LOCLEN;
980
981     if (len == 0) {
982         len = strlen((const char *) s);
983     }
984
985     if (is_utf8_invariant_string_loc(s, len, &first_variant)) {
986         if (el)
987             *el = len;
988
989         if (ep) {
990             *ep = s + len;
991         }
992
993         return TRUE;
994     }
995
996     {
997         const U8* const send = s + len;
998         const U8* x = first_variant;
999         STRLEN outlen = first_variant - s;
1000
1001         while (x < send) {
1002             const STRLEN cur_len = isUTF8_CHAR(x, send);
1003             if (UNLIKELY(! cur_len)) {
1004                 break;
1005             }
1006             x += cur_len;
1007             outlen++;
1008         }
1009
1010         if (el)
1011             *el = outlen;
1012
1013         if (ep) {
1014             *ep = x;
1015         }
1016
1017         return (x == send);
1018     }
1019 }
1020
1021 /*
1022
1023 =for apidoc isUTF8_CHAR
1024
1025 Evaluates to non-zero if the first few bytes of the string starting at C<s> and
1026 looking no further than S<C<e - 1>> are well-formed UTF-8, as extended by Perl,
1027 that represents some code point; otherwise it evaluates to 0.  If non-zero, the
1028 value gives how many bytes starting at C<s> comprise the code point's
1029 representation.  Any bytes remaining before C<e>, but beyond the ones needed to
1030 form the first code point in C<s>, are not examined.
1031
1032 The code point can be any that will fit in an IV on this machine, using Perl's
1033 extension to official UTF-8 to represent those higher than the Unicode maximum
1034 of 0x10FFFF.  That means that this macro is used to efficiently decide if the
1035 next few bytes in C<s> is legal UTF-8 for a single character.
1036
1037 Use C<L</isSTRICT_UTF8_CHAR>> to restrict the acceptable code points to those
1038 defined by Unicode to be fully interchangeable across applications;
1039 C<L</isC9_STRICT_UTF8_CHAR>> to use the L<Unicode Corrigendum
1040 #9|http://www.unicode.org/versions/corrigendum9.html> definition of allowable
1041 code points; and C<L</isUTF8_CHAR_flags>> for a more customized definition.
1042
1043 Use C<L</is_utf8_string>>, C<L</is_utf8_string_loc>>, and
1044 C<L</is_utf8_string_loclen>> to check entire strings.
1045
1046 Note also that a UTF-8 "invariant" character (i.e. ASCII on non-EBCDIC
1047 machines) is a valid UTF-8 character.
1048
1049 =cut
1050
1051 This uses an adaptation of the table and algorithm given in
1052 http://bjoern.hoehrmann.de/utf-8/decoder/dfa/, which provides comprehensive
1053 documentation of the original version.  A copyright notice for the original
1054 version is given at the beginning of this file.  The Perl adapation is
1055 documented at the definition of PL_extended_utf8_dfa_tab[].
1056
1057 */
1058
1059 PERL_STATIC_INLINE Size_t
1060 Perl_isUTF8_CHAR(const U8 * const s0, const U8 * const e)
1061 {
1062     const U8 * s = s0;
1063     UV state = 0;
1064
1065     PERL_ARGS_ASSERT_ISUTF8_CHAR;
1066
1067     /* This dfa is fast.  If it accepts the input, it was for a well-formed,
1068      * code point, which can be returned immediately.  Otherwise, it is either
1069      * malformed, or for the start byte FF which the dfa doesn't handle (except
1070      * on 32-bit ASCII platforms where it trivially is an error).  Call a
1071      * helper function for the other platforms. */
1072
1073     while (s < e && LIKELY(state != 1)) {
1074         state = PL_extended_utf8_dfa_tab[256
1075                                          + state
1076                                          + PL_extended_utf8_dfa_tab[*s]];
1077         if (state != 0) {
1078             s++;
1079             continue;
1080         }
1081
1082         return s - s0 + 1;
1083     }
1084
1085 #if defined(UV_IS_QUAD) || defined(EBCDIC)
1086
1087     if (NATIVE_UTF8_TO_I8(*s0) == 0xFF && e - s0 >= UTF8_MAXBYTES) {
1088        return is_utf8_char_helper(s0, e, 0);
1089     }
1090
1091 #endif
1092
1093     return 0;
1094 }
1095
1096 /*
1097
1098 =for apidoc isSTRICT_UTF8_CHAR
1099
1100 Evaluates to non-zero if the first few bytes of the string starting at C<s> and
1101 looking no further than S<C<e - 1>> are well-formed UTF-8 that represents some
1102 Unicode code point completely acceptable for open interchange between all
1103 applications; otherwise it evaluates to 0.  If non-zero, the value gives how
1104 many bytes starting at C<s> comprise the code point's representation.  Any
1105 bytes remaining before C<e>, but beyond the ones needed to form the first code
1106 point in C<s>, are not examined.
1107
1108 The largest acceptable code point is the Unicode maximum 0x10FFFF, and must not
1109 be a surrogate nor a non-character code point.  Thus this excludes any code
1110 point from Perl's extended UTF-8.
1111
1112 This is used to efficiently decide if the next few bytes in C<s> is
1113 legal Unicode-acceptable UTF-8 for a single character.
1114
1115 Use C<L</isC9_STRICT_UTF8_CHAR>> to use the L<Unicode Corrigendum
1116 #9|http://www.unicode.org/versions/corrigendum9.html> definition of allowable
1117 code points; C<L</isUTF8_CHAR>> to check for Perl's extended UTF-8;
1118 and C<L</isUTF8_CHAR_flags>> for a more customized definition.
1119
1120 Use C<L</is_strict_utf8_string>>, C<L</is_strict_utf8_string_loc>>, and
1121 C<L</is_strict_utf8_string_loclen>> to check entire strings.
1122
1123 =cut
1124
1125 This uses an adaptation of the tables and algorithm given in
1126 http://bjoern.hoehrmann.de/utf-8/decoder/dfa/, which provides comprehensive
1127 documentation of the original version.  A copyright notice for the original
1128 version is given at the beginning of this file.  The Perl adapation is
1129 documented at the definition of strict_extended_utf8_dfa_tab[].
1130
1131 */
1132
1133 PERL_STATIC_INLINE Size_t
1134 Perl_isSTRICT_UTF8_CHAR(const U8 * const s0, const U8 * const e)
1135 {
1136     const U8 * s = s0;
1137     UV state = 0;
1138
1139     PERL_ARGS_ASSERT_ISSTRICT_UTF8_CHAR;
1140
1141     while (s < e && LIKELY(state != 1)) {
1142         state = PL_strict_utf8_dfa_tab[256 + state + PL_strict_utf8_dfa_tab[*s]];
1143
1144         if (state != 0) {
1145             s++;
1146             continue;
1147         }
1148
1149         return s - s0 + 1;
1150     }
1151
1152 #ifndef EBCDIC
1153
1154     /* The dfa above drops out for certain Hanguls; handle them specially */
1155     if (is_HANGUL_ED_utf8_safe(s0, e)) {
1156         return 3;
1157     }
1158
1159 #endif
1160
1161     return 0;
1162 }
1163
1164 /*
1165
1166 =for apidoc isC9_STRICT_UTF8_CHAR
1167
1168 Evaluates to non-zero if the first few bytes of the string starting at C<s> and
1169 looking no further than S<C<e - 1>> are well-formed UTF-8 that represents some
1170 Unicode non-surrogate code point; otherwise it evaluates to 0.  If non-zero,
1171 the value gives how many bytes starting at C<s> comprise the code point's
1172 representation.  Any bytes remaining before C<e>, but beyond the ones needed to
1173 form the first code point in C<s>, are not examined.
1174
1175 The largest acceptable code point is the Unicode maximum 0x10FFFF.  This
1176 differs from C<L</isSTRICT_UTF8_CHAR>> only in that it accepts non-character
1177 code points.  This corresponds to
1178 L<Unicode Corrigendum #9|http://www.unicode.org/versions/corrigendum9.html>.
1179 which said that non-character code points are merely discouraged rather than
1180 completely forbidden in open interchange.  See
1181 L<perlunicode/Noncharacter code points>.
1182
1183 Use C<L</isUTF8_CHAR>> to check for Perl's extended UTF-8; and
1184 C<L</isUTF8_CHAR_flags>> for a more customized definition.
1185
1186 Use C<L</is_c9strict_utf8_string>>, C<L</is_c9strict_utf8_string_loc>>, and
1187 C<L</is_c9strict_utf8_string_loclen>> to check entire strings.
1188
1189 =cut
1190
1191 This uses an adaptation of the tables and algorithm given in
1192 http://bjoern.hoehrmann.de/utf-8/decoder/dfa/, which provides comprehensive
1193 documentation of the original version.  A copyright notice for the original
1194 version is given at the beginning of this file.  The Perl adapation is
1195 documented at the definition of PL_c9_utf8_dfa_tab[].
1196
1197 */
1198
1199 PERL_STATIC_INLINE Size_t
1200 Perl_isC9_STRICT_UTF8_CHAR(const U8 * const s0, const U8 * const e)
1201 {
1202     const U8 * s = s0;
1203     UV state = 0;
1204
1205     PERL_ARGS_ASSERT_ISC9_STRICT_UTF8_CHAR;
1206
1207     while (s < e && LIKELY(state != 1)) {
1208         state = PL_c9_utf8_dfa_tab[256 + state + PL_c9_utf8_dfa_tab[*s]];
1209
1210         if (state != 0) {
1211             s++;
1212             continue;
1213         }
1214
1215         return s - s0 + 1;
1216     }
1217
1218     return 0;
1219 }
1220
1221 /*
1222
1223 =for apidoc is_strict_utf8_string_loc
1224
1225 Like C<L</is_strict_utf8_string>> but stores the location of the failure (in the
1226 case of "utf8ness failure") or the location C<s>+C<len> (in the case of
1227 "utf8ness success") in the C<ep> pointer.
1228
1229 See also C<L</is_strict_utf8_string_loclen>>.
1230
1231 =cut
1232 */
1233
1234 #define is_strict_utf8_string_loc(s, len, ep)                               \
1235                                 is_strict_utf8_string_loclen(s, len, ep, 0)
1236
1237 /*
1238
1239 =for apidoc is_strict_utf8_string_loclen
1240
1241 Like C<L</is_strict_utf8_string>> but stores the location of the failure (in the
1242 case of "utf8ness failure") or the location C<s>+C<len> (in the case of
1243 "utf8ness success") in the C<ep> pointer, and the number of UTF-8
1244 encoded characters in the C<el> pointer.
1245
1246 See also C<L</is_strict_utf8_string_loc>>.
1247
1248 =cut
1249 */
1250
1251 PERL_STATIC_INLINE bool
1252 Perl_is_strict_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
1253 {
1254     const U8 * first_variant;
1255
1256     PERL_ARGS_ASSERT_IS_STRICT_UTF8_STRING_LOCLEN;
1257
1258     if (len == 0) {
1259         len = strlen((const char *) s);
1260     }
1261
1262     if (is_utf8_invariant_string_loc(s, len, &first_variant)) {
1263         if (el)
1264             *el = len;
1265
1266         if (ep) {
1267             *ep = s + len;
1268         }
1269
1270         return TRUE;
1271     }
1272
1273     {
1274         const U8* const send = s + len;
1275         const U8* x = first_variant;
1276         STRLEN outlen = first_variant - s;
1277
1278         while (x < send) {
1279             const STRLEN cur_len = isSTRICT_UTF8_CHAR(x, send);
1280             if (UNLIKELY(! cur_len)) {
1281                 break;
1282             }
1283             x += cur_len;
1284             outlen++;
1285         }
1286
1287         if (el)
1288             *el = outlen;
1289
1290         if (ep) {
1291             *ep = x;
1292         }
1293
1294         return (x == send);
1295     }
1296 }
1297
1298 /*
1299
1300 =for apidoc is_c9strict_utf8_string_loc
1301
1302 Like C<L</is_c9strict_utf8_string>> but stores the location of the failure (in
1303 the case of "utf8ness failure") or the location C<s>+C<len> (in the case of
1304 "utf8ness success") in the C<ep> pointer.
1305
1306 See also C<L</is_c9strict_utf8_string_loclen>>.
1307
1308 =cut
1309 */
1310
1311 #define is_c9strict_utf8_string_loc(s, len, ep)                             \
1312                             is_c9strict_utf8_string_loclen(s, len, ep, 0)
1313
1314 /*
1315
1316 =for apidoc is_c9strict_utf8_string_loclen
1317
1318 Like C<L</is_c9strict_utf8_string>> but stores the location of the failure (in
1319 the case of "utf8ness failure") or the location C<s>+C<len> (in the case of
1320 "utf8ness success") in the C<ep> pointer, and the number of UTF-8 encoded
1321 characters in the C<el> pointer.
1322
1323 See also C<L</is_c9strict_utf8_string_loc>>.
1324
1325 =cut
1326 */
1327
1328 PERL_STATIC_INLINE bool
1329 Perl_is_c9strict_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
1330 {
1331     const U8 * first_variant;
1332
1333     PERL_ARGS_ASSERT_IS_C9STRICT_UTF8_STRING_LOCLEN;
1334
1335     if (len == 0) {
1336         len = strlen((const char *) s);
1337     }
1338
1339     if (is_utf8_invariant_string_loc(s, len, &first_variant)) {
1340         if (el)
1341             *el = len;
1342
1343         if (ep) {
1344             *ep = s + len;
1345         }
1346
1347         return TRUE;
1348     }
1349
1350     {
1351         const U8* const send = s + len;
1352         const U8* x = first_variant;
1353         STRLEN outlen = first_variant - s;
1354
1355         while (x < send) {
1356             const STRLEN cur_len = isC9_STRICT_UTF8_CHAR(x, send);
1357             if (UNLIKELY(! cur_len)) {
1358                 break;
1359             }
1360             x += cur_len;
1361             outlen++;
1362         }
1363
1364         if (el)
1365             *el = outlen;
1366
1367         if (ep) {
1368             *ep = x;
1369         }
1370
1371         return (x == send);
1372     }
1373 }
1374
1375 /*
1376
1377 =for apidoc is_utf8_string_loc_flags
1378
1379 Like C<L</is_utf8_string_flags>> but stores the location of the failure (in the
1380 case of "utf8ness failure") or the location C<s>+C<len> (in the case of
1381 "utf8ness success") in the C<ep> pointer.
1382
1383 See also C<L</is_utf8_string_loclen_flags>>.
1384
1385 =cut
1386 */
1387
1388 #define is_utf8_string_loc_flags(s, len, ep, flags)                         \
1389                         is_utf8_string_loclen_flags(s, len, ep, 0, flags)
1390
1391
1392 /* The above 3 actual functions could have been moved into the more general one
1393  * just below, and made #defines that call it with the right 'flags'.  They are
1394  * currently kept separate to increase their chances of getting inlined */
1395
1396 /*
1397
1398 =for apidoc is_utf8_string_loclen_flags
1399
1400 Like C<L</is_utf8_string_flags>> but stores the location of the failure (in the
1401 case of "utf8ness failure") or the location C<s>+C<len> (in the case of
1402 "utf8ness success") in the C<ep> pointer, and the number of UTF-8
1403 encoded characters in the C<el> pointer.
1404
1405 See also C<L</is_utf8_string_loc_flags>>.
1406
1407 =cut
1408 */
1409
1410 PERL_STATIC_INLINE bool
1411 Perl_is_utf8_string_loclen_flags(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el, const U32 flags)
1412 {
1413     const U8 * first_variant;
1414
1415     PERL_ARGS_ASSERT_IS_UTF8_STRING_LOCLEN_FLAGS;
1416     assert(0 == (flags & ~(UTF8_DISALLOW_ILLEGAL_INTERCHANGE
1417                           |UTF8_DISALLOW_PERL_EXTENDED)));
1418
1419     if (len == 0) {
1420         len = strlen((const char *) s);
1421     }
1422
1423     if (flags == 0) {
1424         return is_utf8_string_loclen(s, len, ep, el);
1425     }
1426
1427     if ((flags & ~UTF8_DISALLOW_PERL_EXTENDED)
1428                                         == UTF8_DISALLOW_ILLEGAL_INTERCHANGE)
1429     {
1430         return is_strict_utf8_string_loclen(s, len, ep, el);
1431     }
1432
1433     if ((flags & ~UTF8_DISALLOW_PERL_EXTENDED)
1434                                     == UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE)
1435     {
1436         return is_c9strict_utf8_string_loclen(s, len, ep, el);
1437     }
1438
1439     if (is_utf8_invariant_string_loc(s, len, &first_variant)) {
1440         if (el)
1441             *el = len;
1442
1443         if (ep) {
1444             *ep = s + len;
1445         }
1446
1447         return TRUE;
1448     }
1449
1450     {
1451         const U8* send = s + len;
1452         const U8* x = first_variant;
1453         STRLEN outlen = first_variant - s;
1454
1455         while (x < send) {
1456             const STRLEN cur_len = isUTF8_CHAR_flags(x, send, flags);
1457             if (UNLIKELY(! cur_len)) {
1458                 break;
1459             }
1460             x += cur_len;
1461             outlen++;
1462         }
1463
1464         if (el)
1465             *el = outlen;
1466
1467         if (ep) {
1468             *ep = x;
1469         }
1470
1471         return (x == send);
1472     }
1473 }
1474
1475 /*
1476 =for apidoc utf8_distance
1477
1478 Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
1479 and C<b>.
1480
1481 WARNING: use only if you *know* that the pointers point inside the
1482 same UTF-8 buffer.
1483
1484 =cut
1485 */
1486
1487 PERL_STATIC_INLINE IV
1488 Perl_utf8_distance(pTHX_ const U8 *a, const U8 *b)
1489 {
1490     PERL_ARGS_ASSERT_UTF8_DISTANCE;
1491
1492     return (a < b) ? -1 * (IV) utf8_length(a, b) : (IV) utf8_length(b, a);
1493 }
1494
1495 /*
1496 =for apidoc utf8_hop
1497
1498 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
1499 forward or backward.
1500
1501 WARNING: do not use the following unless you *know* C<off> is within
1502 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
1503 on the first byte of character or just after the last byte of a character.
1504
1505 =cut
1506 */
1507
1508 PERL_STATIC_INLINE U8 *
1509 Perl_utf8_hop(const U8 *s, SSize_t off)
1510 {
1511     PERL_ARGS_ASSERT_UTF8_HOP;
1512
1513     /* Note: cannot use UTF8_IS_...() too eagerly here since e.g
1514      * the bitops (especially ~) can create illegal UTF-8.
1515      * In other words: in Perl UTF-8 is not just for Unicode. */
1516
1517     if (off >= 0) {
1518         while (off--)
1519             s += UTF8SKIP(s);
1520     }
1521     else {
1522         while (off++) {
1523             s--;
1524             while (UTF8_IS_CONTINUATION(*s))
1525                 s--;
1526         }
1527     }
1528     GCC_DIAG_IGNORE(-Wcast-qual)
1529     return (U8 *)s;
1530     GCC_DIAG_RESTORE
1531 }
1532
1533 /*
1534 =for apidoc utf8_hop_forward
1535
1536 Return the UTF-8 pointer C<s> displaced by up to C<off> characters,
1537 forward.
1538
1539 C<off> must be non-negative.
1540
1541 C<s> must be before or equal to C<end>.
1542
1543 When moving forward it will not move beyond C<end>.
1544
1545 Will not exceed this limit even if the string is not valid "UTF-8".
1546
1547 =cut
1548 */
1549
1550 PERL_STATIC_INLINE U8 *
1551 Perl_utf8_hop_forward(const U8 *s, SSize_t off, const U8 *end)
1552 {
1553     PERL_ARGS_ASSERT_UTF8_HOP_FORWARD;
1554
1555     /* Note: cannot use UTF8_IS_...() too eagerly here since e.g
1556      * the bitops (especially ~) can create illegal UTF-8.
1557      * In other words: in Perl UTF-8 is not just for Unicode. */
1558
1559     assert(s <= end);
1560     assert(off >= 0);
1561
1562     while (off--) {
1563         STRLEN skip = UTF8SKIP(s);
1564         if ((STRLEN)(end - s) <= skip) {
1565             GCC_DIAG_IGNORE(-Wcast-qual)
1566             return (U8 *)end;
1567             GCC_DIAG_RESTORE
1568         }
1569         s += skip;
1570     }
1571
1572     GCC_DIAG_IGNORE(-Wcast-qual)
1573     return (U8 *)s;
1574     GCC_DIAG_RESTORE
1575 }
1576
1577 /*
1578 =for apidoc utf8_hop_back
1579
1580 Return the UTF-8 pointer C<s> displaced by up to C<off> characters,
1581 backward.
1582
1583 C<off> must be non-positive.
1584
1585 C<s> must be after or equal to C<start>.
1586
1587 When moving backward it will not move before C<start>.
1588
1589 Will not exceed this limit even if the string is not valid "UTF-8".
1590
1591 =cut
1592 */
1593
1594 PERL_STATIC_INLINE U8 *
1595 Perl_utf8_hop_back(const U8 *s, SSize_t off, const U8 *start)
1596 {
1597     PERL_ARGS_ASSERT_UTF8_HOP_BACK;
1598
1599     /* Note: cannot use UTF8_IS_...() too eagerly here since e.g
1600      * the bitops (especially ~) can create illegal UTF-8.
1601      * In other words: in Perl UTF-8 is not just for Unicode. */
1602
1603     assert(start <= s);
1604     assert(off <= 0);
1605
1606     while (off++ && s > start) {
1607         do {
1608             s--;
1609         } while (UTF8_IS_CONTINUATION(*s) && s > start);
1610     }
1611     
1612     GCC_DIAG_IGNORE(-Wcast-qual)
1613     return (U8 *)s;
1614     GCC_DIAG_RESTORE
1615 }
1616
1617 /*
1618 =for apidoc utf8_hop_safe
1619
1620 Return the UTF-8 pointer C<s> displaced by up to C<off> characters,
1621 either forward or backward.
1622
1623 When moving backward it will not move before C<start>.
1624
1625 When moving forward it will not move beyond C<end>.
1626
1627 Will not exceed those limits even if the string is not valid "UTF-8".
1628
1629 =cut
1630 */
1631
1632 PERL_STATIC_INLINE U8 *
1633 Perl_utf8_hop_safe(const U8 *s, SSize_t off, const U8 *start, const U8 *end)
1634 {
1635     PERL_ARGS_ASSERT_UTF8_HOP_SAFE;
1636
1637     /* Note: cannot use UTF8_IS_...() too eagerly here since e.g
1638      * the bitops (especially ~) can create illegal UTF-8.
1639      * In other words: in Perl UTF-8 is not just for Unicode. */
1640
1641     assert(start <= s && s <= end);
1642
1643     if (off >= 0) {
1644         return utf8_hop_forward(s, off, end);
1645     }
1646     else {
1647         return utf8_hop_back(s, off, start);
1648     }
1649 }
1650
1651 /*
1652
1653 =for apidoc is_utf8_valid_partial_char
1654
1655 Returns 0 if the sequence of bytes starting at C<s> and looking no further than
1656 S<C<e - 1>> is the UTF-8 encoding, as extended by Perl, for one or more code
1657 points.  Otherwise, it returns 1 if there exists at least one non-empty
1658 sequence of bytes that when appended to sequence C<s>, starting at position
1659 C<e> causes the entire sequence to be the well-formed UTF-8 of some code point;
1660 otherwise returns 0.
1661
1662 In other words this returns TRUE if C<s> points to a partial UTF-8-encoded code
1663 point.
1664
1665 This is useful when a fixed-length buffer is being tested for being well-formed
1666 UTF-8, but the final few bytes in it don't comprise a full character; that is,
1667 it is split somewhere in the middle of the final code point's UTF-8
1668 representation.  (Presumably when the buffer is refreshed with the next chunk
1669 of data, the new first bytes will complete the partial code point.)   This
1670 function is used to verify that the final bytes in the current buffer are in
1671 fact the legal beginning of some code point, so that if they aren't, the
1672 failure can be signalled without having to wait for the next read.
1673
1674 =cut
1675 */
1676 #define is_utf8_valid_partial_char(s, e)                                    \
1677                                 is_utf8_valid_partial_char_flags(s, e, 0)
1678
1679 /*
1680
1681 =for apidoc is_utf8_valid_partial_char_flags
1682
1683 Like C<L</is_utf8_valid_partial_char>>, it returns a boolean giving whether
1684 or not the input is a valid UTF-8 encoded partial character, but it takes an
1685 extra parameter, C<flags>, which can further restrict which code points are
1686 considered valid.
1687
1688 If C<flags> is 0, this behaves identically to
1689 C<L</is_utf8_valid_partial_char>>.  Otherwise C<flags> can be any combination
1690 of the C<UTF8_DISALLOW_I<foo>> flags accepted by C<L</utf8n_to_uvchr>>.  If
1691 there is any sequence of bytes that can complete the input partial character in
1692 such a way that a non-prohibited character is formed, the function returns
1693 TRUE; otherwise FALSE.  Non character code points cannot be determined based on
1694 partial character input.  But many  of the other possible excluded types can be
1695 determined from just the first one or two bytes.
1696
1697 =cut
1698  */
1699
1700 PERL_STATIC_INLINE bool
1701 Perl_is_utf8_valid_partial_char_flags(const U8 * const s, const U8 * const e, const U32 flags)
1702 {
1703     PERL_ARGS_ASSERT_IS_UTF8_VALID_PARTIAL_CHAR_FLAGS;
1704
1705     assert(0 == (flags & ~(UTF8_DISALLOW_ILLEGAL_INTERCHANGE
1706                           |UTF8_DISALLOW_PERL_EXTENDED)));
1707
1708     if (s >= e || s + UTF8SKIP(s) <= e) {
1709         return FALSE;
1710     }
1711
1712     return cBOOL(is_utf8_char_helper(s, e, flags));
1713 }
1714
1715 /*
1716
1717 =for apidoc is_utf8_fixed_width_buf_flags
1718
1719 Returns TRUE if the fixed-width buffer starting at C<s> with length C<len>
1720 is entirely valid UTF-8, subject to the restrictions given by C<flags>;
1721 otherwise it returns FALSE.
1722
1723 If C<flags> is 0, any well-formed UTF-8, as extended by Perl, is accepted
1724 without restriction.  If the final few bytes of the buffer do not form a
1725 complete code point, this will return TRUE anyway, provided that
1726 C<L</is_utf8_valid_partial_char_flags>> returns TRUE for them.
1727
1728 If C<flags> in non-zero, it can be any combination of the
1729 C<UTF8_DISALLOW_I<foo>> flags accepted by C<L</utf8n_to_uvchr>>, and with the
1730 same meanings.
1731
1732 This function differs from C<L</is_utf8_string_flags>> only in that the latter
1733 returns FALSE if the final few bytes of the string don't form a complete code
1734 point.
1735
1736 =cut
1737  */
1738 #define is_utf8_fixed_width_buf_flags(s, len, flags)                        \
1739                 is_utf8_fixed_width_buf_loclen_flags(s, len, 0, 0, flags)
1740
1741 /*
1742
1743 =for apidoc is_utf8_fixed_width_buf_loc_flags
1744
1745 Like C<L</is_utf8_fixed_width_buf_flags>> but stores the location of the
1746 failure in the C<ep> pointer.  If the function returns TRUE, C<*ep> will point
1747 to the beginning of any partial character at the end of the buffer; if there is
1748 no partial character C<*ep> will contain C<s>+C<len>.
1749
1750 See also C<L</is_utf8_fixed_width_buf_loclen_flags>>.
1751
1752 =cut
1753 */
1754
1755 #define is_utf8_fixed_width_buf_loc_flags(s, len, loc, flags)               \
1756                 is_utf8_fixed_width_buf_loclen_flags(s, len, loc, 0, flags)
1757
1758 /*
1759
1760 =for apidoc is_utf8_fixed_width_buf_loclen_flags
1761
1762 Like C<L</is_utf8_fixed_width_buf_loc_flags>> but stores the number of
1763 complete, valid characters found in the C<el> pointer.
1764
1765 =cut
1766 */
1767
1768 PERL_STATIC_INLINE bool
1769 Perl_is_utf8_fixed_width_buf_loclen_flags(const U8 * const s,
1770                                        STRLEN len,
1771                                        const U8 **ep,
1772                                        STRLEN *el,
1773                                        const U32 flags)
1774 {
1775     const U8 * maybe_partial;
1776
1777     PERL_ARGS_ASSERT_IS_UTF8_FIXED_WIDTH_BUF_LOCLEN_FLAGS;
1778
1779     if (! ep) {
1780         ep  = &maybe_partial;
1781     }
1782
1783     /* If it's entirely valid, return that; otherwise see if the only error is
1784      * that the final few bytes are for a partial character */
1785     return    is_utf8_string_loclen_flags(s, len, ep, el, flags)
1786            || is_utf8_valid_partial_char_flags(*ep, s + len, flags);
1787 }
1788
1789 PERL_STATIC_INLINE UV
1790 Perl_utf8n_to_uvchr_msgs(const U8 *s,
1791                       STRLEN curlen,
1792                       STRLEN *retlen,
1793                       const U32 flags,
1794                       U32 * errors,
1795                       AV ** msgs)
1796 {
1797     /* This is the inlined portion of utf8n_to_uvchr_msgs.  It handles the
1798      * simple cases, and, if necessary calls a helper function to deal with the
1799      * more complex ones.  Almost all well-formed non-problematic code points
1800      * are considered simple, so that it's unlikely that the helper function
1801      * will need to be called.
1802      *
1803      * This is an adaptation of the tables and algorithm given in
1804      * http://bjoern.hoehrmann.de/utf-8/decoder/dfa/, which provides
1805      * comprehensive documentation of the original version.  A copyright notice
1806      * for the original version is given at the beginning of this file.  The
1807      * Perl adapation is documented at the definition of PL_strict_utf8_dfa_tab[].
1808      */
1809
1810     const U8 * const s0 = s;
1811     const U8 * send = s0 + curlen;
1812     UV uv = 0;      /* The 0 silences some stupid compilers */
1813     UV state = 0;
1814
1815     PERL_ARGS_ASSERT_UTF8N_TO_UVCHR_MSGS;
1816
1817     /* This dfa is fast.  If it accepts the input, it was for a well-formed,
1818      * non-problematic code point, which can be returned immediately.
1819      * Otherwise we call a helper function to figure out the more complicated
1820      * cases. */
1821
1822     while (s < send && LIKELY(state != 1)) {
1823         UV type = PL_strict_utf8_dfa_tab[*s];
1824
1825         uv = (state == 0)
1826              ?  ((0xff >> type) & NATIVE_UTF8_TO_I8(*s))
1827              : UTF8_ACCUMULATE(uv, *s);
1828         state = PL_strict_utf8_dfa_tab[256 + state + type];
1829
1830         if (state != 0) {
1831             s++;
1832             continue;
1833         }
1834
1835         if (retlen) {
1836             *retlen = s - s0 + 1;
1837         }
1838         if (errors) {
1839             *errors = 0;
1840         }
1841         if (msgs) {
1842             *msgs = NULL;
1843         }
1844
1845         return UNI_TO_NATIVE(uv);
1846     }
1847
1848     /* Here is potentially problematic.  Use the full mechanism */
1849     return _utf8n_to_uvchr_msgs_helper(s0, curlen, retlen, flags, errors, msgs);
1850 }
1851
1852 PERL_STATIC_INLINE UV
1853 Perl_utf8_to_uvchr_buf_helper(pTHX_ const U8 *s, const U8 *send, STRLEN *retlen)
1854 {
1855     PERL_ARGS_ASSERT_UTF8_TO_UVCHR_BUF_HELPER;
1856
1857     assert(s < send);
1858
1859     if (! ckWARN_d(WARN_UTF8)) {
1860
1861         /* EMPTY is not really allowed, and asserts on debugging builds.  But
1862          * on non-debugging we have to deal with it, and this causes it to
1863          * return the REPLACEMENT CHARACTER, as the documentation indicates */
1864         return utf8n_to_uvchr(s, send - s, retlen,
1865                               (UTF8_ALLOW_ANY | UTF8_ALLOW_EMPTY));
1866     }
1867     else {
1868         UV ret = utf8n_to_uvchr(s, send - s, retlen, 0);
1869         if (retlen && ret == 0 && *s != '\0') {
1870             *retlen = (STRLEN) -1;
1871         }
1872
1873         return ret;
1874     }
1875 }
1876
1877 /* ------------------------------- perl.h ----------------------------- */
1878
1879 /*
1880 =head1 Miscellaneous Functions
1881
1882 =for apidoc is_safe_syscall
1883
1884 Test that the given C<pv> doesn't contain any internal C<NUL> characters.
1885 If it does, set C<errno> to C<ENOENT>, optionally warn, and return FALSE.
1886
1887 Return TRUE if the name is safe.
1888
1889 Used by the C<IS_SAFE_SYSCALL()> macro.
1890
1891 =cut
1892 */
1893
1894 PERL_STATIC_INLINE bool
1895 Perl_is_safe_syscall(pTHX_ const char *pv, STRLEN len, const char *what, const char *op_name)
1896 {
1897     /* While the Windows CE API provides only UCS-16 (or UTF-16) APIs
1898      * perl itself uses xce*() functions which accept 8-bit strings.
1899      */
1900
1901     PERL_ARGS_ASSERT_IS_SAFE_SYSCALL;
1902
1903     if (len > 1) {
1904         char *null_at;
1905         if (UNLIKELY((null_at = (char *)memchr(pv, 0, len-1)) != NULL)) {
1906                 SETERRNO(ENOENT, LIB_INVARG);
1907                 Perl_ck_warner(aTHX_ packWARN(WARN_SYSCALLS),
1908                                    "Invalid \\0 character in %s for %s: %s\\0%s",
1909                                    what, op_name, pv, null_at+1);
1910                 return FALSE;
1911         }
1912     }
1913
1914     return TRUE;
1915 }
1916
1917 /*
1918
1919 Return true if the supplied filename has a newline character
1920 immediately before the first (hopefully only) NUL.
1921
1922 My original look at this incorrectly used the len from SvPV(), but
1923 that's incorrect, since we allow for a NUL in pv[len-1].
1924
1925 So instead, strlen() and work from there.
1926
1927 This allow for the user reading a filename, forgetting to chomp it,
1928 then calling:
1929
1930   open my $foo, "$file\0";
1931
1932 */
1933
1934 #ifdef PERL_CORE
1935
1936 PERL_STATIC_INLINE bool
1937 S_should_warn_nl(const char *pv)
1938 {
1939     STRLEN len;
1940
1941     PERL_ARGS_ASSERT_SHOULD_WARN_NL;
1942
1943     len = strlen(pv);
1944
1945     return len > 0 && pv[len-1] == '\n';
1946 }
1947
1948 #endif
1949
1950 #if defined(PERL_IN_PP_C) || defined(PERL_IN_PP_HOT_C)
1951
1952 PERL_STATIC_INLINE bool
1953 S_lossless_NV_to_IV(const NV nv, IV *ivp)
1954 {
1955     /* This function determines if the input NV 'nv' may be converted without
1956      * loss of data to an IV.  If not, it returns FALSE taking no other action.
1957      * But if it is possible, it does the conversion, returning TRUE, and
1958      * storing the converted result in '*ivp' */
1959
1960     PERL_ARGS_ASSERT_LOSSLESS_NV_TO_IV;
1961
1962 #  if  defined(Perl_isnan)
1963
1964     if (UNLIKELY(Perl_isnan(nv))) {
1965         return FALSE;
1966     }
1967
1968 #  endif
1969
1970     if (UNLIKELY(nv < IV_MIN) || UNLIKELY(nv > IV_MAX)) {
1971         return FALSE;
1972     }
1973
1974     if ((IV) nv != nv) {
1975         return FALSE;
1976     }
1977
1978     *ivp = (IV) nv;
1979     return TRUE;
1980 }
1981
1982 #endif
1983
1984 /* ------------------ pp.c, regcomp.c, toke.c, universal.c ------------ */
1985
1986 #define MAX_CHARSET_NAME_LENGTH 2
1987
1988 PERL_STATIC_INLINE const char *
1989 get_regex_charset_name(const U32 flags, STRLEN* const lenp)
1990 {
1991     /* Returns a string that corresponds to the name of the regex character set
1992      * given by 'flags', and *lenp is set the length of that string, which
1993      * cannot exceed MAX_CHARSET_NAME_LENGTH characters */
1994
1995     *lenp = 1;
1996     switch (get_regex_charset(flags)) {
1997         case REGEX_DEPENDS_CHARSET: return DEPENDS_PAT_MODS;
1998         case REGEX_LOCALE_CHARSET:  return LOCALE_PAT_MODS;
1999         case REGEX_UNICODE_CHARSET: return UNICODE_PAT_MODS;
2000         case REGEX_ASCII_RESTRICTED_CHARSET: return ASCII_RESTRICT_PAT_MODS;
2001         case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
2002             *lenp = 2;
2003             return ASCII_MORE_RESTRICT_PAT_MODS;
2004     }
2005     /* The NOT_REACHED; hides an assert() which has a rather complex
2006      * definition in perl.h. */
2007     NOT_REACHED; /* NOTREACHED */
2008     return "?";     /* Unknown */
2009 }
2010
2011 /*
2012
2013 Return false if any get magic is on the SV other than taint magic.
2014
2015 */
2016
2017 PERL_STATIC_INLINE bool
2018 Perl_sv_only_taint_gmagic(SV *sv)
2019 {
2020     MAGIC *mg = SvMAGIC(sv);
2021
2022     PERL_ARGS_ASSERT_SV_ONLY_TAINT_GMAGIC;
2023
2024     while (mg) {
2025         if (mg->mg_type != PERL_MAGIC_taint
2026             && !(mg->mg_flags & MGf_GSKIP)
2027             && mg->mg_virtual->svt_get) {
2028             return FALSE;
2029         }
2030         mg = mg->mg_moremagic;
2031     }
2032
2033     return TRUE;
2034 }
2035
2036 /* ------------------ cop.h ------------------------------------------- */
2037
2038
2039 /* Enter a block. Push a new base context and return its address. */
2040
2041 PERL_STATIC_INLINE PERL_CONTEXT *
2042 Perl_cx_pushblock(pTHX_ U8 type, U8 gimme, SV** sp, I32 saveix)
2043 {
2044     PERL_CONTEXT * cx;
2045
2046     PERL_ARGS_ASSERT_CX_PUSHBLOCK;
2047
2048     CXINC;
2049     cx = CX_CUR();
2050     cx->cx_type        = type;
2051     cx->blk_gimme      = gimme;
2052     cx->blk_oldsaveix  = saveix;
2053     cx->blk_oldsp      = (I32)(sp - PL_stack_base);
2054     cx->blk_oldcop     = PL_curcop;
2055     cx->blk_oldmarksp  = (I32)(PL_markstack_ptr - PL_markstack);
2056     cx->blk_oldscopesp = PL_scopestack_ix;
2057     cx->blk_oldpm      = PL_curpm;
2058     cx->blk_old_tmpsfloor = PL_tmps_floor;
2059
2060     PL_tmps_floor        = PL_tmps_ix;
2061     CX_DEBUG(cx, "PUSH");
2062     return cx;
2063 }
2064
2065
2066 /* Exit a block (RETURN and LAST). */
2067
2068 PERL_STATIC_INLINE void
2069 Perl_cx_popblock(pTHX_ PERL_CONTEXT *cx)
2070 {
2071     PERL_ARGS_ASSERT_CX_POPBLOCK;
2072
2073     CX_DEBUG(cx, "POP");
2074     /* these 3 are common to cx_popblock and cx_topblock */
2075     PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp;
2076     PL_scopestack_ix = cx->blk_oldscopesp;
2077     PL_curpm         = cx->blk_oldpm;
2078
2079     /* LEAVE_SCOPE() should have made this true. /(?{})/ cheats
2080      * and leaves a CX entry lying around for repeated use, so
2081      * skip for multicall */                  \
2082     assert(   (CxTYPE(cx) == CXt_SUB && CxMULTICALL(cx))
2083             || PL_savestack_ix == cx->blk_oldsaveix);
2084     PL_curcop     = cx->blk_oldcop;
2085     PL_tmps_floor = cx->blk_old_tmpsfloor;
2086 }
2087
2088 /* Continue a block elsewhere (e.g. NEXT, REDO, GOTO).
2089  * Whereas cx_popblock() restores the state to the point just before
2090  * cx_pushblock() was called,  cx_topblock() restores it to the point just
2091  * *after* cx_pushblock() was called. */
2092
2093 PERL_STATIC_INLINE void
2094 Perl_cx_topblock(pTHX_ PERL_CONTEXT *cx)
2095 {
2096     PERL_ARGS_ASSERT_CX_TOPBLOCK;
2097
2098     CX_DEBUG(cx, "TOP");
2099     /* these 3 are common to cx_popblock and cx_topblock */
2100     PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp;
2101     PL_scopestack_ix = cx->blk_oldscopesp;
2102     PL_curpm         = cx->blk_oldpm;
2103
2104     PL_stack_sp      = PL_stack_base + cx->blk_oldsp;
2105 }
2106
2107
2108 PERL_STATIC_INLINE void
2109 Perl_cx_pushsub(pTHX_ PERL_CONTEXT *cx, CV *cv, OP *retop, bool hasargs)
2110 {
2111     U8 phlags = CX_PUSHSUB_GET_LVALUE_MASK(Perl_was_lvalue_sub);
2112
2113     PERL_ARGS_ASSERT_CX_PUSHSUB;
2114
2115     PERL_DTRACE_PROBE_ENTRY(cv);
2116     cx->blk_sub.cv = cv;
2117     cx->blk_sub.olddepth = CvDEPTH(cv);
2118     cx->blk_sub.prevcomppad = PL_comppad;
2119     cx->cx_type |= (hasargs) ? CXp_HASARGS : 0;
2120     cx->blk_sub.retop = retop;
2121     SvREFCNT_inc_simple_void_NN(cv);
2122     cx->blk_u16 = PL_op->op_private & (phlags|OPpDEREF);
2123 }
2124
2125
2126 /* subsets of cx_popsub() */
2127
2128 PERL_STATIC_INLINE void
2129 Perl_cx_popsub_common(pTHX_ PERL_CONTEXT *cx)
2130 {
2131     CV *cv;
2132
2133     PERL_ARGS_ASSERT_CX_POPSUB_COMMON;
2134     assert(CxTYPE(cx) == CXt_SUB);
2135
2136     PL_comppad = cx->blk_sub.prevcomppad;
2137     PL_curpad = LIKELY(PL_comppad) ? AvARRAY(PL_comppad) : NULL;
2138     cv = cx->blk_sub.cv;
2139     CvDEPTH(cv) = cx->blk_sub.olddepth;
2140     cx->blk_sub.cv = NULL;
2141     SvREFCNT_dec(cv);
2142 }
2143
2144
2145 /* handle the @_ part of leaving a sub */
2146
2147 PERL_STATIC_INLINE void
2148 Perl_cx_popsub_args(pTHX_ PERL_CONTEXT *cx)
2149 {
2150     AV *av;
2151
2152     PERL_ARGS_ASSERT_CX_POPSUB_ARGS;
2153     assert(CxTYPE(cx) == CXt_SUB);
2154     assert(AvARRAY(MUTABLE_AV(
2155         PadlistARRAY(CvPADLIST(cx->blk_sub.cv))[
2156                 CvDEPTH(cx->blk_sub.cv)])) == PL_curpad);
2157
2158     CX_POP_SAVEARRAY(cx);
2159     av = MUTABLE_AV(PAD_SVl(0));
2160     if (UNLIKELY(AvREAL(av)))
2161         /* abandon @_ if it got reified */
2162         clear_defarray(av, 0);
2163     else {
2164         CLEAR_ARGARRAY(av);
2165     }
2166 }
2167
2168
2169 PERL_STATIC_INLINE void
2170 Perl_cx_popsub(pTHX_ PERL_CONTEXT *cx)
2171 {
2172     PERL_ARGS_ASSERT_CX_POPSUB;
2173     assert(CxTYPE(cx) == CXt_SUB);
2174
2175     PERL_DTRACE_PROBE_RETURN(cx->blk_sub.cv);
2176
2177     if (CxHASARGS(cx))
2178         cx_popsub_args(cx);
2179     cx_popsub_common(cx);
2180 }
2181
2182
2183 PERL_STATIC_INLINE void
2184 Perl_cx_pushformat(pTHX_ PERL_CONTEXT *cx, CV *cv, OP *retop, GV *gv)
2185 {
2186     PERL_ARGS_ASSERT_CX_PUSHFORMAT;
2187
2188     cx->blk_format.cv          = cv;
2189     cx->blk_format.retop       = retop;
2190     cx->blk_format.gv          = gv;
2191     cx->blk_format.dfoutgv     = PL_defoutgv;
2192     cx->blk_format.prevcomppad = PL_comppad;
2193     cx->blk_u16                = 0;
2194
2195     SvREFCNT_inc_simple_void_NN(cv);
2196     CvDEPTH(cv)++;
2197     SvREFCNT_inc_void(cx->blk_format.dfoutgv);
2198 }
2199
2200
2201 PERL_STATIC_INLINE void
2202 Perl_cx_popformat(pTHX_ PERL_CONTEXT *cx)
2203 {
2204     CV *cv;
2205     GV *dfout;
2206
2207     PERL_ARGS_ASSERT_CX_POPFORMAT;
2208     assert(CxTYPE(cx) == CXt_FORMAT);
2209
2210     dfout = cx->blk_format.dfoutgv;
2211     setdefout(dfout);
2212     cx->blk_format.dfoutgv = NULL;
2213     SvREFCNT_dec_NN(dfout);
2214
2215     PL_comppad = cx->blk_format.prevcomppad;
2216     PL_curpad = LIKELY(PL_comppad) ? AvARRAY(PL_comppad) : NULL;
2217     cv = cx->blk_format.cv;
2218     cx->blk_format.cv = NULL;
2219     --CvDEPTH(cv);
2220     SvREFCNT_dec_NN(cv);
2221 }
2222
2223
2224 PERL_STATIC_INLINE void
2225 Perl_cx_pusheval(pTHX_ PERL_CONTEXT *cx, OP *retop, SV *namesv)
2226 {
2227     PERL_ARGS_ASSERT_CX_PUSHEVAL;
2228
2229     cx->blk_eval.retop         = retop;
2230     cx->blk_eval.old_namesv    = namesv;
2231     cx->blk_eval.old_eval_root = PL_eval_root;
2232     cx->blk_eval.cur_text      = PL_parser ? PL_parser->linestr : NULL;
2233     cx->blk_eval.cv            = NULL; /* later set by doeval_compile() */
2234     cx->blk_eval.cur_top_env   = PL_top_env;
2235
2236     assert(!(PL_in_eval     & ~ 0x3F));
2237     assert(!(PL_op->op_type & ~0x1FF));
2238     cx->blk_u16 = (PL_in_eval & 0x3F) | ((U16)PL_op->op_type << 7);
2239 }
2240
2241
2242 PERL_STATIC_INLINE void
2243 Perl_cx_popeval(pTHX_ PERL_CONTEXT *cx)
2244 {
2245     SV *sv;
2246
2247     PERL_ARGS_ASSERT_CX_POPEVAL;
2248     assert(CxTYPE(cx) == CXt_EVAL);
2249
2250     PL_in_eval = CxOLD_IN_EVAL(cx);
2251     assert(!(PL_in_eval & 0xc0));
2252     PL_eval_root = cx->blk_eval.old_eval_root;
2253     sv = cx->blk_eval.cur_text;
2254     if (sv && CxEVAL_TXT_REFCNTED(cx)) {
2255         cx->blk_eval.cur_text = NULL;
2256         SvREFCNT_dec_NN(sv);
2257     }
2258
2259     sv = cx->blk_eval.old_namesv;
2260     if (sv) {
2261         cx->blk_eval.old_namesv = NULL;
2262         SvREFCNT_dec_NN(sv);
2263     }
2264 }
2265
2266
2267 /* push a plain loop, i.e.
2268  *     { block }
2269  *     while (cond) { block }
2270  *     for (init;cond;continue) { block }
2271  * This loop can be last/redo'ed etc.
2272  */
2273
2274 PERL_STATIC_INLINE void
2275 Perl_cx_pushloop_plain(pTHX_ PERL_CONTEXT *cx)
2276 {
2277     PERL_ARGS_ASSERT_CX_PUSHLOOP_PLAIN;
2278     cx->blk_loop.my_op = cLOOP;
2279 }
2280
2281
2282 /* push a true for loop, i.e.
2283  *     for var (list) { block }
2284  */
2285
2286 PERL_STATIC_INLINE void
2287 Perl_cx_pushloop_for(pTHX_ PERL_CONTEXT *cx, void *itervarp, SV* itersave)
2288 {
2289     PERL_ARGS_ASSERT_CX_PUSHLOOP_FOR;
2290
2291     /* this one line is common with cx_pushloop_plain */
2292     cx->blk_loop.my_op = cLOOP;
2293
2294     cx->blk_loop.itervar_u.svp = (SV**)itervarp;
2295     cx->blk_loop.itersave      = itersave;
2296 #ifdef USE_ITHREADS
2297     cx->blk_loop.oldcomppad = PL_comppad;
2298 #endif
2299 }
2300
2301
2302 /* pop all loop types, including plain */
2303
2304 PERL_STATIC_INLINE void
2305 Perl_cx_poploop(pTHX_ PERL_CONTEXT *cx)
2306 {
2307     PERL_ARGS_ASSERT_CX_POPLOOP;
2308
2309     assert(CxTYPE_is_LOOP(cx));
2310     if (  CxTYPE(cx) == CXt_LOOP_ARY
2311        || CxTYPE(cx) == CXt_LOOP_LAZYSV)
2312     {
2313         /* Free ary or cur. This assumes that state_u.ary.ary
2314          * aligns with state_u.lazysv.cur. See cx_dup() */
2315         SV *sv = cx->blk_loop.state_u.lazysv.cur;
2316         cx->blk_loop.state_u.lazysv.cur = NULL;
2317         SvREFCNT_dec_NN(sv);
2318         if (CxTYPE(cx) == CXt_LOOP_LAZYSV) {
2319             sv = cx->blk_loop.state_u.lazysv.end;
2320             cx->blk_loop.state_u.lazysv.end = NULL;
2321             SvREFCNT_dec_NN(sv);
2322         }
2323     }
2324     if (cx->cx_type & (CXp_FOR_PAD|CXp_FOR_GV)) {
2325         SV *cursv;
2326         SV **svp = (cx)->blk_loop.itervar_u.svp;
2327         if ((cx->cx_type & CXp_FOR_GV))
2328             svp = &GvSV((GV*)svp);
2329         cursv = *svp;
2330         *svp = cx->blk_loop.itersave;
2331         cx->blk_loop.itersave = NULL;
2332         SvREFCNT_dec(cursv);
2333     }
2334 }
2335
2336
2337 PERL_STATIC_INLINE void
2338 Perl_cx_pushwhen(pTHX_ PERL_CONTEXT *cx)
2339 {
2340     PERL_ARGS_ASSERT_CX_PUSHWHEN;
2341
2342     cx->blk_givwhen.leave_op = cLOGOP->op_other;
2343 }
2344
2345
2346 PERL_STATIC_INLINE void
2347 Perl_cx_popwhen(pTHX_ PERL_CONTEXT *cx)
2348 {
2349     PERL_ARGS_ASSERT_CX_POPWHEN;
2350     assert(CxTYPE(cx) == CXt_WHEN);
2351
2352     PERL_UNUSED_ARG(cx);
2353     PERL_UNUSED_CONTEXT;
2354     /* currently NOOP */
2355 }
2356
2357
2358 PERL_STATIC_INLINE void
2359 Perl_cx_pushgiven(pTHX_ PERL_CONTEXT *cx, SV *orig_defsv)
2360 {
2361     PERL_ARGS_ASSERT_CX_PUSHGIVEN;
2362
2363     cx->blk_givwhen.leave_op = cLOGOP->op_other;
2364     cx->blk_givwhen.defsv_save = orig_defsv;
2365 }
2366
2367
2368 PERL_STATIC_INLINE void
2369 Perl_cx_popgiven(pTHX_ PERL_CONTEXT *cx)
2370 {
2371     SV *sv;
2372
2373     PERL_ARGS_ASSERT_CX_POPGIVEN;
2374     assert(CxTYPE(cx) == CXt_GIVEN);
2375
2376     sv = GvSV(PL_defgv);
2377     GvSV(PL_defgv) = cx->blk_givwhen.defsv_save;
2378     cx->blk_givwhen.defsv_save = NULL;
2379     SvREFCNT_dec(sv);
2380 }
2381
2382 /* ------------------ util.h ------------------------------------------- */
2383
2384 /*
2385 =head1 Miscellaneous Functions
2386
2387 =for apidoc foldEQ
2388
2389 Returns true if the leading C<len> bytes of the strings C<s1> and C<s2> are the
2390 same
2391 case-insensitively; false otherwise.  Uppercase and lowercase ASCII range bytes
2392 match themselves and their opposite case counterparts.  Non-cased and non-ASCII
2393 range bytes match only themselves.
2394
2395 =cut
2396 */
2397
2398 PERL_STATIC_INLINE I32
2399 Perl_foldEQ(const char *s1, const char *s2, I32 len)
2400 {
2401     const U8 *a = (const U8 *)s1;
2402     const U8 *b = (const U8 *)s2;
2403
2404     PERL_ARGS_ASSERT_FOLDEQ;
2405
2406     assert(len >= 0);
2407
2408     while (len--) {
2409         if (*a != *b && *a != PL_fold[*b])
2410             return 0;
2411         a++,b++;
2412     }
2413     return 1;
2414 }
2415
2416 PERL_STATIC_INLINE I32
2417 Perl_foldEQ_latin1(const char *s1, const char *s2, I32 len)
2418 {
2419     /* Compare non-UTF-8 using Unicode (Latin1) semantics.  Works on all folds
2420      * representable without UTF-8, except for LATIN_SMALL_LETTER_SHARP_S, and
2421      * does not check for this.  Nor does it check that the strings each have
2422      * at least 'len' characters. */
2423
2424     const U8 *a = (const U8 *)s1;
2425     const U8 *b = (const U8 *)s2;
2426
2427     PERL_ARGS_ASSERT_FOLDEQ_LATIN1;
2428
2429     assert(len >= 0);
2430
2431     while (len--) {
2432         if (*a != *b && *a != PL_fold_latin1[*b]) {
2433             return 0;
2434         }
2435         a++, b++;
2436     }
2437     return 1;
2438 }
2439
2440 /*
2441 =for apidoc foldEQ_locale
2442
2443 Returns true if the leading C<len> bytes of the strings C<s1> and C<s2> are the
2444 same case-insensitively in the current locale; false otherwise.
2445
2446 =cut
2447 */
2448
2449 PERL_STATIC_INLINE I32
2450 Perl_foldEQ_locale(const char *s1, const char *s2, I32 len)
2451 {
2452     dVAR;
2453     const U8 *a = (const U8 *)s1;
2454     const U8 *b = (const U8 *)s2;
2455
2456     PERL_ARGS_ASSERT_FOLDEQ_LOCALE;
2457
2458     assert(len >= 0);
2459
2460     while (len--) {
2461         if (*a != *b && *a != PL_fold_locale[*b])
2462             return 0;
2463         a++,b++;
2464     }
2465     return 1;
2466 }
2467
2468 #if ! defined (HAS_MEMRCHR) && (defined(PERL_CORE) || defined(PERL_EXT))
2469
2470 PERL_STATIC_INLINE void *
2471 S_my_memrchr(const char * s, const char c, const STRLEN len)
2472 {
2473     /* memrchr(), since many platforms lack it */
2474
2475     const char * t = s + len - 1;
2476
2477     PERL_ARGS_ASSERT_MY_MEMRCHR;
2478
2479     while (t >= s) {
2480         if (*t == c) {
2481             return (void *) t;
2482         }
2483         t--;
2484     }
2485
2486     return NULL;
2487 }
2488
2489 #endif
2490
2491 /*
2492  * ex: set ts=8 sts=4 sw=4 et:
2493  */