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