Commit | Line | Data |
---|---|---|
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 | * | |
8 | * This file is a home for static inline functions that cannot go in other | |
9 | * headers files, because they depend on proto.h (included after most other | |
10 | * headers) or struct definitions. | |
11 | * | |
12 | * Each section names the header file that the functions "belong" to. | |
13 | */ | |
27669aa4 | 14 | |
be3a7a5d KW |
15 | /* ------------------------------- av.h ------------------------------- */ |
16 | ||
c70927a6 | 17 | PERL_STATIC_INLINE SSize_t |
be3a7a5d KW |
18 | S_av_top_index(pTHX_ AV *av) |
19 | { | |
20 | PERL_ARGS_ASSERT_AV_TOP_INDEX; | |
21 | assert(SvTYPE(av) == SVt_PVAV); | |
22 | ||
23 | return AvFILL(av); | |
24 | } | |
25 | ||
1afe1db1 FC |
26 | /* ------------------------------- cv.h ------------------------------- */ |
27 | ||
ae77754a FC |
28 | PERL_STATIC_INLINE GV * |
29 | S_CvGV(pTHX_ CV *sv) | |
30 | { | |
31 | return CvNAMED(sv) | |
32 | ? Perl_cvgv_from_hek(aTHX_ sv) | |
33 | : ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_gv_u.xcv_gv; | |
34 | } | |
35 | ||
1afe1db1 FC |
36 | PERL_STATIC_INLINE I32 * |
37 | S_CvDEPTHp(const CV * const sv) | |
38 | { | |
39 | assert(SvTYPE(sv) == SVt_PVCV || SvTYPE(sv) == SVt_PVFM); | |
8de47657 | 40 | return &((XPVCV*)SvANY(sv))->xcv_depth; |
1afe1db1 FC |
41 | } |
42 | ||
d16269d8 PM |
43 | /* |
44 | CvPROTO returns the prototype as stored, which is not necessarily what | |
45 | the interpreter should be using. Specifically, the interpreter assumes | |
46 | that spaces have been stripped, which has been the case if the prototype | |
47 | was added by toke.c, but is generally not the case if it was added elsewhere. | |
48 | Since we can't enforce the spacelessness at assignment time, this routine | |
49 | provides a temporary copy at parse time with spaces removed. | |
50 | I<orig> is the start of the original buffer, I<len> is the length of the | |
51 | prototype and will be updated when this returns. | |
52 | */ | |
53 | ||
5b67adb8 | 54 | #ifdef PERL_CORE |
d16269d8 PM |
55 | PERL_STATIC_INLINE char * |
56 | S_strip_spaces(pTHX_ const char * orig, STRLEN * const len) | |
57 | { | |
58 | SV * tmpsv; | |
59 | char * tmps; | |
60 | tmpsv = newSVpvn_flags(orig, *len, SVs_TEMP); | |
61 | tmps = SvPVX(tmpsv); | |
62 | while ((*len)--) { | |
63 | if (!isSPACE(*orig)) | |
64 | *tmps++ = *orig; | |
65 | orig++; | |
66 | } | |
67 | *tmps = '\0'; | |
68 | *len = tmps - SvPVX(tmpsv); | |
69 | return SvPVX(tmpsv); | |
70 | } | |
5b67adb8 | 71 | #endif |
d16269d8 | 72 | |
25fdce4a FC |
73 | /* ------------------------------- mg.h ------------------------------- */ |
74 | ||
75 | #if defined(PERL_CORE) || defined(PERL_EXT) | |
76 | /* assumes get-magic and stringification have already occurred */ | |
77 | PERL_STATIC_INLINE STRLEN | |
78 | S_MgBYTEPOS(pTHX_ MAGIC *mg, SV *sv, const char *s, STRLEN len) | |
79 | { | |
80 | assert(mg->mg_type == PERL_MAGIC_regex_global); | |
81 | assert(mg->mg_len != -1); | |
82 | if (mg->mg_flags & MGf_BYTES || !DO_UTF8(sv)) | |
83 | return (STRLEN)mg->mg_len; | |
84 | else { | |
85 | const STRLEN pos = (STRLEN)mg->mg_len; | |
86 | /* Without this check, we may read past the end of the buffer: */ | |
87 | if (pos > sv_or_pv_len_utf8(sv, s, len)) return len+1; | |
88 | return sv_or_pv_pos_u2b(sv, s, pos, NULL); | |
89 | } | |
90 | } | |
91 | #endif | |
92 | ||
03414f05 FC |
93 | /* ------------------------------- pad.h ------------------------------ */ |
94 | ||
95 | #if defined(PERL_IN_PAD_C) || defined(PERL_IN_OP_C) | |
96 | PERL_STATIC_INLINE bool | |
97 | PadnameIN_SCOPE(const PADNAME * const pn, const U32 seq) | |
98 | { | |
99 | /* is seq within the range _LOW to _HIGH ? | |
100 | * This is complicated by the fact that PL_cop_seqmax | |
101 | * may have wrapped around at some point */ | |
102 | if (COP_SEQ_RANGE_LOW(pn) == PERL_PADSEQ_INTRO) | |
103 | return FALSE; /* not yet introduced */ | |
104 | ||
105 | if (COP_SEQ_RANGE_HIGH(pn) == PERL_PADSEQ_INTRO) { | |
106 | /* in compiling scope */ | |
107 | if ( | |
108 | (seq > COP_SEQ_RANGE_LOW(pn)) | |
109 | ? (seq - COP_SEQ_RANGE_LOW(pn) < (U32_MAX >> 1)) | |
110 | : (COP_SEQ_RANGE_LOW(pn) - seq > (U32_MAX >> 1)) | |
111 | ) | |
112 | return TRUE; | |
113 | } | |
114 | else if ( | |
115 | (COP_SEQ_RANGE_LOW(pn) > COP_SEQ_RANGE_HIGH(pn)) | |
116 | ? | |
117 | ( seq > COP_SEQ_RANGE_LOW(pn) | |
118 | || seq <= COP_SEQ_RANGE_HIGH(pn)) | |
119 | ||
120 | : ( seq > COP_SEQ_RANGE_LOW(pn) | |
121 | && seq <= COP_SEQ_RANGE_HIGH(pn)) | |
122 | ) | |
123 | return TRUE; | |
124 | return FALSE; | |
125 | } | |
126 | #endif | |
127 | ||
33a4312b FC |
128 | /* ------------------------------- pp.h ------------------------------- */ |
129 | ||
130 | PERL_STATIC_INLINE I32 | |
131 | S_TOPMARK(pTHX) | |
132 | { | |
133 | DEBUG_s(DEBUG_v(PerlIO_printf(Perl_debug_log, | |
134 | "MARK top %p %"IVdf"\n", | |
135 | PL_markstack_ptr, | |
136 | (IV)*PL_markstack_ptr))); | |
137 | return *PL_markstack_ptr; | |
138 | } | |
139 | ||
140 | PERL_STATIC_INLINE I32 | |
141 | S_POPMARK(pTHX) | |
142 | { | |
143 | DEBUG_s(DEBUG_v(PerlIO_printf(Perl_debug_log, | |
144 | "MARK pop %p %"IVdf"\n", | |
145 | (PL_markstack_ptr-1), | |
146 | (IV)*(PL_markstack_ptr-1)))); | |
147 | assert((PL_markstack_ptr > PL_markstack) || !"MARK underflow"); | |
148 | return *PL_markstack_ptr--; | |
149 | } | |
150 | ||
8d919b0a FC |
151 | /* ----------------------------- regexp.h ----------------------------- */ |
152 | ||
153 | PERL_STATIC_INLINE struct regexp * | |
154 | S_ReANY(const REGEXP * const re) | |
155 | { | |
156 | assert(isREGEXP(re)); | |
157 | return re->sv_u.svu_rx; | |
158 | } | |
159 | ||
27669aa4 FC |
160 | /* ------------------------------- sv.h ------------------------------- */ |
161 | ||
162 | PERL_STATIC_INLINE SV * | |
163 | S_SvREFCNT_inc(SV *sv) | |
164 | { | |
2439e033 | 165 | if (LIKELY(sv != NULL)) |
27669aa4 FC |
166 | SvREFCNT(sv)++; |
167 | return sv; | |
168 | } | |
169 | PERL_STATIC_INLINE SV * | |
170 | S_SvREFCNT_inc_NN(SV *sv) | |
171 | { | |
172 | SvREFCNT(sv)++; | |
173 | return sv; | |
174 | } | |
175 | PERL_STATIC_INLINE void | |
176 | S_SvREFCNT_inc_void(SV *sv) | |
177 | { | |
2439e033 | 178 | if (LIKELY(sv != NULL)) |
27669aa4 FC |
179 | SvREFCNT(sv)++; |
180 | } | |
75e16a44 FC |
181 | PERL_STATIC_INLINE void |
182 | S_SvREFCNT_dec(pTHX_ SV *sv) | |
183 | { | |
2439e033 | 184 | if (LIKELY(sv != NULL)) { |
75a9bf96 | 185 | U32 rc = SvREFCNT(sv); |
79e2a32a | 186 | if (LIKELY(rc > 1)) |
75a9bf96 DM |
187 | SvREFCNT(sv) = rc - 1; |
188 | else | |
189 | Perl_sv_free2(aTHX_ sv, rc); | |
75e16a44 FC |
190 | } |
191 | } | |
541377b1 FC |
192 | |
193 | PERL_STATIC_INLINE void | |
4a9a56a7 DM |
194 | S_SvREFCNT_dec_NN(pTHX_ SV *sv) |
195 | { | |
196 | U32 rc = SvREFCNT(sv); | |
79e2a32a | 197 | if (LIKELY(rc > 1)) |
4a9a56a7 DM |
198 | SvREFCNT(sv) = rc - 1; |
199 | else | |
200 | Perl_sv_free2(aTHX_ sv, rc); | |
201 | } | |
202 | ||
203 | PERL_STATIC_INLINE void | |
541377b1 FC |
204 | SvAMAGIC_on(SV *sv) |
205 | { | |
206 | assert(SvROK(sv)); | |
207 | if (SvOBJECT(SvRV(sv))) HvAMAGIC_on(SvSTASH(SvRV(sv))); | |
208 | } | |
209 | PERL_STATIC_INLINE void | |
210 | SvAMAGIC_off(SV *sv) | |
211 | { | |
212 | if (SvROK(sv) && SvOBJECT(SvRV(sv))) | |
213 | HvAMAGIC_off(SvSTASH(SvRV(sv))); | |
214 | } | |
215 | ||
216 | PERL_STATIC_INLINE U32 | |
541377b1 FC |
217 | S_SvPADSTALE_on(SV *sv) |
218 | { | |
c0683843 | 219 | assert(!(SvFLAGS(sv) & SVs_PADTMP)); |
541377b1 FC |
220 | return SvFLAGS(sv) |= SVs_PADSTALE; |
221 | } | |
222 | PERL_STATIC_INLINE U32 | |
223 | S_SvPADSTALE_off(SV *sv) | |
224 | { | |
c0683843 | 225 | assert(!(SvFLAGS(sv) & SVs_PADTMP)); |
541377b1 FC |
226 | return SvFLAGS(sv) &= ~SVs_PADSTALE; |
227 | } | |
25fdce4a | 228 | #if defined(PERL_CORE) || defined (PERL_EXT) |
4ddea69a | 229 | PERL_STATIC_INLINE STRLEN |
6964422a | 230 | S_sv_or_pv_pos_u2b(pTHX_ SV *sv, const char *pv, STRLEN pos, STRLEN *lenp) |
4ddea69a | 231 | { |
25fdce4a | 232 | PERL_ARGS_ASSERT_SV_OR_PV_POS_U2B; |
4ddea69a FC |
233 | if (SvGAMAGIC(sv)) { |
234 | U8 *hopped = utf8_hop((U8 *)pv, pos); | |
235 | if (lenp) *lenp = (STRLEN)(utf8_hop(hopped, *lenp) - hopped); | |
236 | return (STRLEN)(hopped - (U8 *)pv); | |
237 | } | |
238 | return sv_pos_u2b_flags(sv,pos,lenp,SV_CONST_RETURN); | |
239 | } | |
240 | #endif | |
f019c49e | 241 | |
d1decf2b TC |
242 | /* ------------------------------- handy.h ------------------------------- */ |
243 | ||
244 | /* saves machine code for a common noreturn idiom typically used in Newx*() */ | |
c1d6452f | 245 | #ifdef GCC_DIAG_PRAGMA |
6ab56f1e | 246 | GCC_DIAG_IGNORE(-Wunused-function) /* Intentionally left semicolonless. */ |
c1d6452f | 247 | #endif |
d1decf2b TC |
248 | static void |
249 | S_croak_memory_wrap(void) | |
250 | { | |
251 | Perl_croak_nocontext("%s",PL_memory_wrap); | |
252 | } | |
c1d6452f | 253 | #ifdef GCC_DIAG_PRAGMA |
6ab56f1e | 254 | GCC_DIAG_RESTORE /* Intentionally left semicolonless. */ |
c1d6452f | 255 | #endif |
d1decf2b | 256 | |
a8a2ceaa KW |
257 | /* ------------------------------- utf8.h ------------------------------- */ |
258 | ||
2fe720e2 KW |
259 | /* |
260 | =head1 Unicode Support | |
261 | */ | |
262 | ||
55d09dc8 KW |
263 | PERL_STATIC_INLINE void |
264 | S_append_utf8_from_native_byte(const U8 byte, U8** dest) | |
265 | { | |
266 | /* Takes an input 'byte' (Latin1 or EBCDIC) and appends it to the UTF-8 | |
267 | * encoded string at '*dest', updating '*dest' to include it */ | |
268 | ||
55d09dc8 KW |
269 | PERL_ARGS_ASSERT_APPEND_UTF8_FROM_NATIVE_BYTE; |
270 | ||
6f2d5cbc | 271 | if (NATIVE_BYTE_IS_INVARIANT(byte)) |
a09ec51a | 272 | *((*dest)++) = byte; |
55d09dc8 | 273 | else { |
a09ec51a KW |
274 | *((*dest)++) = UTF8_EIGHT_BIT_HI(byte); |
275 | *((*dest)++) = UTF8_EIGHT_BIT_LO(byte); | |
55d09dc8 KW |
276 | } |
277 | } | |
278 | ||
e123187a | 279 | /* |
2fe720e2 | 280 | =for apidoc valid_utf8_to_uvchr |
2717076a | 281 | Like C<L</utf8_to_uvchr_buf>>, but should only be called when it is known that |
2fe720e2 KW |
282 | the next character in the input UTF-8 string C<s> is well-formed (I<e.g.>, |
283 | it passes C<L</isUTF8_CHAR>>. Surrogates, non-character code points, and | |
284 | non-Unicode code points are allowed. | |
285 | ||
286 | =cut | |
287 | ||
288 | */ | |
289 | ||
290 | PERL_STATIC_INLINE UV | |
291 | Perl_valid_utf8_to_uvchr(const U8 *s, STRLEN *retlen) | |
292 | { | |
c41b2540 | 293 | const UV expectlen = UTF8SKIP(s); |
2fe720e2 KW |
294 | const U8* send = s + expectlen; |
295 | UV uv = *s; | |
296 | ||
297 | PERL_ARGS_ASSERT_VALID_UTF8_TO_UVCHR; | |
298 | ||
299 | if (retlen) { | |
300 | *retlen = expectlen; | |
301 | } | |
302 | ||
303 | /* An invariant is trivially returned */ | |
304 | if (expectlen == 1) { | |
305 | return uv; | |
306 | } | |
307 | ||
308 | /* Remove the leading bits that indicate the number of bytes, leaving just | |
309 | * the bits that are part of the value */ | |
310 | uv = NATIVE_UTF8_TO_I8(uv) & UTF_START_MASK(expectlen); | |
311 | ||
312 | /* Now, loop through the remaining bytes, accumulating each into the | |
313 | * working total as we go. (I khw tried unrolling the loop for up to 4 | |
314 | * bytes, but there was no performance improvement) */ | |
315 | for (++s; s < send; s++) { | |
316 | uv = UTF8_ACCUMULATE(uv, *s); | |
317 | } | |
318 | ||
319 | return UNI_TO_NATIVE(uv); | |
320 | ||
321 | } | |
322 | ||
1e599354 KW |
323 | /* |
324 | =for apidoc is_utf8_invariant_string | |
325 | ||
82c5d941 | 326 | Returns TRUE if the first C<len> bytes of the string C<s> are the same |
1e599354 | 327 | regardless of the UTF-8 encoding of the string (or UTF-EBCDIC encoding on |
82c5d941 KW |
328 | EBCDIC machines); otherwise it returns FALSE. That is, it returns TRUE if they |
329 | are UTF-8 invariant. On ASCII-ish machines, all the ASCII characters and only | |
330 | the ASCII characters fit this definition. On EBCDIC machines, the ASCII-range | |
331 | characters are invariant, but so also are the C1 controls. | |
1e599354 KW |
332 | |
333 | If C<len> is 0, it will be calculated using C<strlen(s)>, (which means if you | |
334 | use this option, that C<s> can't have embedded C<NUL> characters and has to | |
335 | have a terminating C<NUL> byte). | |
336 | ||
9f2abfde KW |
337 | See also |
338 | C<L</is_utf8_string>>, | |
339 | C<L</is_utf8_string_flags>>, | |
340 | C<L</is_utf8_string_loc>>, | |
341 | C<L</is_utf8_string_loc_flags>>, | |
342 | C<L</is_utf8_string_loclen>>, | |
343 | C<L</is_utf8_string_loclen_flags>>, | |
344 | C<L</is_strict_utf8_string>>, | |
345 | C<L</is_strict_utf8_string_loc>>, | |
346 | C<L</is_strict_utf8_string_loclen>>, | |
347 | C<L</is_c9strict_utf8_string>>, | |
348 | C<L</is_c9strict_utf8_string_loc>>, | |
349 | and | |
350 | C<L</is_c9strict_utf8_string_loclen>>. | |
1e599354 KW |
351 | |
352 | =cut | |
353 | */ | |
354 | ||
355 | PERL_STATIC_INLINE bool | |
356 | S_is_utf8_invariant_string(const U8* const s, const STRLEN len) | |
357 | { | |
358 | const U8* const send = s + (len ? len : strlen((const char *)s)); | |
359 | const U8* x = s; | |
360 | ||
361 | PERL_ARGS_ASSERT_IS_UTF8_INVARIANT_STRING; | |
362 | ||
363 | for (; x < send; ++x) { | |
364 | if (!UTF8_IS_INVARIANT(*x)) | |
365 | return FALSE; | |
366 | } | |
367 | ||
368 | return TRUE; | |
369 | } | |
370 | ||
7c93d8f0 | 371 | /* |
5ff889fb KW |
372 | =for apidoc is_utf8_string |
373 | ||
82c5d941 KW |
374 | Returns TRUE if the first C<len> bytes of string C<s> form a valid |
375 | Perl-extended-UTF-8 string; returns FALSE otherwise. If C<len> is 0, it will | |
376 | be calculated using C<strlen(s)> (which means if you use this option, that C<s> | |
377 | can't have embedded C<NUL> characters and has to have a terminating C<NUL> | |
378 | byte). Note that all characters being ASCII constitute 'a valid UTF-8 string'. | |
379 | ||
2717076a KW |
380 | This function considers Perl's extended UTF-8 to be valid. That means that |
381 | code points above Unicode, surrogates, and non-character code points are | |
9f2abfde KW |
382 | considered valid by this function. Use C<L</is_strict_utf8_string>>, |
383 | C<L</is_c9strict_utf8_string>>, or C<L</is_utf8_string_flags>> to restrict what | |
384 | code points are considered valid. | |
5ff889fb | 385 | |
9f2abfde KW |
386 | See also |
387 | C<L</is_utf8_invariant_string>>, | |
388 | C<L</is_utf8_string_loc>>, | |
389 | C<L</is_utf8_string_loclen>>, | |
5ff889fb KW |
390 | |
391 | =cut | |
392 | */ | |
393 | ||
56e4cf64 | 394 | PERL_STATIC_INLINE bool |
c41b2540 | 395 | Perl_is_utf8_string(const U8 *s, const STRLEN len) |
5ff889fb | 396 | { |
35936d22 KW |
397 | /* This is now marked pure in embed.fnc, because isUTF8_CHAR now is pure. |
398 | * Be aware of possible changes to that */ | |
399 | ||
5ff889fb KW |
400 | const U8* const send = s + (len ? len : strlen((const char *)s)); |
401 | const U8* x = s; | |
402 | ||
403 | PERL_ARGS_ASSERT_IS_UTF8_STRING; | |
404 | ||
405 | while (x < send) { | |
c41b2540 KW |
406 | const STRLEN cur_len = isUTF8_CHAR(x, send); |
407 | if (UNLIKELY(! cur_len)) { | |
5ff889fb KW |
408 | return FALSE; |
409 | } | |
c41b2540 | 410 | x += cur_len; |
5ff889fb KW |
411 | } |
412 | ||
413 | return TRUE; | |
414 | } | |
415 | ||
416 | /* | |
9f2abfde KW |
417 | =for apidoc is_strict_utf8_string |
418 | ||
419 | Returns TRUE if the first C<len> bytes of string C<s> form a valid | |
420 | UTF-8-encoded string that is fully interchangeable by any application using | |
421 | Unicode rules; otherwise it returns FALSE. If C<len> is 0, it will be | |
422 | calculated using C<strlen(s)> (which means if you use this option, that C<s> | |
423 | can't have embedded C<NUL> characters and has to have a terminating C<NUL> | |
424 | byte). Note that all characters being ASCII constitute 'a valid UTF-8 string'. | |
425 | ||
426 | This function returns FALSE for strings containing any | |
427 | code points above the Unicode max of 0x10FFFF, surrogate code points, or | |
428 | non-character code points. | |
429 | ||
430 | See also | |
431 | C<L</is_utf8_invariant_string>>, | |
432 | C<L</is_utf8_string>>, | |
433 | C<L</is_utf8_string_flags>>, | |
434 | C<L</is_utf8_string_loc>>, | |
435 | C<L</is_utf8_string_loc_flags>>, | |
436 | C<L</is_utf8_string_loclen>>, | |
437 | C<L</is_utf8_string_loclen_flags>>, | |
438 | C<L</is_strict_utf8_string_loc>>, | |
439 | C<L</is_strict_utf8_string_loclen>>, | |
440 | C<L</is_c9strict_utf8_string>>, | |
441 | C<L</is_c9strict_utf8_string_loc>>, | |
442 | and | |
443 | C<L</is_c9strict_utf8_string_loclen>>. | |
444 | ||
445 | =cut | |
446 | */ | |
447 | ||
448 | PERL_STATIC_INLINE bool | |
449 | S_is_strict_utf8_string(const U8 *s, const STRLEN len) | |
450 | { | |
451 | const U8* const send = s + (len ? len : strlen((const char *)s)); | |
452 | const U8* x = s; | |
453 | ||
454 | PERL_ARGS_ASSERT_IS_STRICT_UTF8_STRING; | |
455 | ||
456 | while (x < send) { | |
457 | const STRLEN cur_len = isSTRICT_UTF8_CHAR(x, send); | |
458 | if (UNLIKELY(! cur_len)) { | |
459 | return FALSE; | |
460 | } | |
461 | x += cur_len; | |
462 | } | |
463 | ||
464 | return TRUE; | |
465 | } | |
466 | ||
467 | /* | |
468 | =for apidoc is_c9strict_utf8_string | |
469 | ||
470 | Returns TRUE if the first C<len> bytes of string C<s> form a valid | |
471 | UTF-8-encoded string that conforms to | |
472 | L<Unicode Corrigendum #9|http://www.unicode.org/versions/corrigendum9.html>; | |
473 | otherwise it returns FALSE. If C<len> is 0, it will be calculated using | |
474 | C<strlen(s)> (which means if you use this option, that C<s> can't have embedded | |
475 | C<NUL> characters and has to have a terminating C<NUL> byte). Note that all | |
476 | characters being ASCII constitute 'a valid UTF-8 string'. | |
477 | ||
478 | This function returns FALSE for strings containing any code points above the | |
479 | Unicode max of 0x10FFFF or surrogate code points, but accepts non-character | |
480 | code points per | |
481 | L<Corrigendum #9|http://www.unicode.org/versions/corrigendum9.html>. | |
482 | ||
483 | See also | |
484 | C<L</is_utf8_invariant_string>>, | |
485 | C<L</is_utf8_string>>, | |
486 | C<L</is_utf8_string_flags>>, | |
487 | C<L</is_utf8_string_loc>>, | |
488 | C<L</is_utf8_string_loc_flags>>, | |
489 | C<L</is_utf8_string_loclen>>, | |
490 | C<L</is_utf8_string_loclen_flags>>, | |
491 | C<L</is_strict_utf8_string>>, | |
492 | C<L</is_strict_utf8_string_loc>>, | |
493 | C<L</is_strict_utf8_string_loclen>>, | |
494 | C<L</is_c9strict_utf8_string_loc>>, | |
495 | and | |
496 | C<L</is_c9strict_utf8_string_loclen>>. | |
497 | ||
498 | =cut | |
499 | */ | |
500 | ||
501 | PERL_STATIC_INLINE bool | |
502 | S_is_c9strict_utf8_string(const U8 *s, const STRLEN len) | |
503 | { | |
504 | const U8* const send = s + (len ? len : strlen((const char *)s)); | |
505 | const U8* x = s; | |
506 | ||
507 | PERL_ARGS_ASSERT_IS_C9STRICT_UTF8_STRING; | |
508 | ||
509 | while (x < send) { | |
510 | const STRLEN cur_len = isC9_STRICT_UTF8_CHAR(x, send); | |
511 | if (UNLIKELY(! cur_len)) { | |
512 | return FALSE; | |
513 | } | |
514 | x += cur_len; | |
515 | } | |
516 | ||
517 | return TRUE; | |
518 | } | |
519 | ||
520 | /* The above 3 functions could have been moved into the more general one just | |
521 | * below, and made #defines that call it with the right 'flags'. They are | |
522 | * currently kept separate to increase their chances of getting inlined */ | |
523 | ||
524 | /* | |
525 | =for apidoc is_utf8_string_flags | |
526 | ||
527 | Returns TRUE if the first C<len> bytes of string C<s> form a valid | |
528 | UTF-8 string, subject to the restrictions imposed by C<flags>; | |
529 | returns FALSE otherwise. If C<len> is 0, it will be calculated | |
530 | using C<strlen(s)> (which means if you use this option, that C<s> can't have | |
531 | embedded C<NUL> characters and has to have a terminating C<NUL> byte). Note | |
532 | that all characters being ASCII constitute 'a valid UTF-8 string'. | |
533 | ||
534 | If C<flags> is 0, this gives the same results as C<L</is_utf8_string>>; if | |
535 | C<flags> is C<UTF8_DISALLOW_ILLEGAL_INTERCHANGE>, this gives the same results | |
536 | as C<L</is_strict_utf8_string>>; and if C<flags> is | |
537 | C<UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE>, this gives the same results as | |
538 | C<L</is_c9strict_utf8_string>>. Otherwise C<flags> may be any | |
539 | combination of the C<UTF8_DISALLOW_I<foo>> flags understood by | |
540 | C<L</utf8n_to_uvchr>>, with the same meanings. | |
541 | ||
542 | See also | |
543 | C<L</is_utf8_invariant_string>>, | |
544 | C<L</is_utf8_string>>, | |
545 | C<L</is_utf8_string_loc>>, | |
546 | C<L</is_utf8_string_loc_flags>>, | |
547 | C<L</is_utf8_string_loclen>>, | |
548 | C<L</is_utf8_string_loclen_flags>>, | |
549 | C<L</is_strict_utf8_string>>, | |
550 | C<L</is_strict_utf8_string_loc>>, | |
551 | C<L</is_strict_utf8_string_loclen>>, | |
552 | C<L</is_c9strict_utf8_string>>, | |
553 | C<L</is_c9strict_utf8_string_loc>>, | |
554 | and | |
555 | C<L</is_c9strict_utf8_string_loclen>>. | |
556 | ||
557 | =cut | |
558 | */ | |
559 | ||
560 | PERL_STATIC_INLINE bool | |
561 | S_is_utf8_string_flags(const U8 *s, const STRLEN len, const U32 flags) | |
562 | { | |
563 | const U8* const send = s + (len ? len : strlen((const char *)s)); | |
564 | const U8* x = s; | |
565 | ||
566 | PERL_ARGS_ASSERT_IS_UTF8_STRING_FLAGS; | |
567 | assert(0 == (flags & ~(UTF8_DISALLOW_ILLEGAL_INTERCHANGE | |
568 | |UTF8_DISALLOW_ABOVE_31_BIT))); | |
569 | ||
570 | if (flags == 0) { | |
571 | return is_utf8_string(s, len); | |
572 | } | |
573 | ||
574 | if ((flags & ~UTF8_DISALLOW_ABOVE_31_BIT) | |
575 | == UTF8_DISALLOW_ILLEGAL_INTERCHANGE) | |
576 | { | |
577 | return is_strict_utf8_string(s, len); | |
578 | } | |
579 | ||
580 | if ((flags & ~UTF8_DISALLOW_ABOVE_31_BIT) | |
581 | == UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE) | |
582 | { | |
583 | return is_c9strict_utf8_string(s, len); | |
584 | } | |
585 | ||
586 | while (x < send) { | |
587 | STRLEN cur_len = isUTF8_CHAR_flags(x, send, flags); | |
588 | if (UNLIKELY(! cur_len)) { | |
589 | return FALSE; | |
590 | } | |
591 | x += cur_len; | |
592 | } | |
593 | ||
594 | return TRUE; | |
595 | } | |
596 | ||
597 | /* | |
5ff889fb KW |
598 | |
599 | =for apidoc is_utf8_string_loc | |
600 | ||
2717076a | 601 | Like C<L</is_utf8_string>> but stores the location of the failure (in the |
5ff889fb | 602 | case of "utf8ness failure") or the location C<s>+C<len> (in the case of |
82c5d941 | 603 | "utf8ness success") in the C<ep> pointer. |
5ff889fb | 604 | |
2717076a | 605 | See also C<L</is_utf8_string_loclen>>. |
5ff889fb | 606 | |
3964c812 KW |
607 | =cut |
608 | */ | |
609 | ||
610 | #define is_utf8_string_loc(s, len, ep) is_utf8_string_loclen(s, len, ep, 0) | |
611 | ||
612 | /* | |
613 | ||
5ff889fb KW |
614 | =for apidoc is_utf8_string_loclen |
615 | ||
2717076a | 616 | Like C<L</is_utf8_string>> but stores the location of the failure (in the |
5ff889fb | 617 | case of "utf8ness failure") or the location C<s>+C<len> (in the case of |
9f2abfde | 618 | "utf8ness success") in the C<ep> pointer, and the number of UTF-8 |
82c5d941 | 619 | encoded characters in the C<el> pointer. |
5ff889fb | 620 | |
2717076a | 621 | See also C<L</is_utf8_string_loc>>. |
5ff889fb KW |
622 | |
623 | =cut | |
624 | */ | |
625 | ||
56e4cf64 | 626 | PERL_STATIC_INLINE bool |
c41b2540 | 627 | Perl_is_utf8_string_loclen(const U8 *s, const STRLEN len, const U8 **ep, STRLEN *el) |
5ff889fb KW |
628 | { |
629 | const U8* const send = s + (len ? len : strlen((const char *)s)); | |
630 | const U8* x = s; | |
631 | STRLEN outlen = 0; | |
632 | ||
633 | PERL_ARGS_ASSERT_IS_UTF8_STRING_LOCLEN; | |
634 | ||
635 | while (x < send) { | |
c41b2540 KW |
636 | const STRLEN cur_len = isUTF8_CHAR(x, send); |
637 | if (UNLIKELY(! cur_len)) { | |
5ff889fb KW |
638 | break; |
639 | } | |
c41b2540 | 640 | x += cur_len; |
5ff889fb KW |
641 | outlen++; |
642 | } | |
643 | ||
644 | if (el) | |
645 | *el = outlen; | |
646 | ||
647 | if (ep) { | |
648 | *ep = x; | |
649 | } | |
650 | ||
651 | return (x == send); | |
652 | } | |
653 | ||
654 | /* | |
9f2abfde KW |
655 | |
656 | =for apidoc is_strict_utf8_string_loc | |
657 | ||
658 | Like C<L</is_strict_utf8_string>> but stores the location of the failure (in the | |
659 | case of "utf8ness failure") or the location C<s>+C<len> (in the case of | |
660 | "utf8ness success") in the C<ep> pointer. | |
661 | ||
662 | See also C<L</is_strict_utf8_string_loclen>>. | |
663 | ||
664 | =cut | |
665 | */ | |
666 | ||
667 | #define is_strict_utf8_string_loc(s, len, ep) \ | |
668 | is_strict_utf8_string_loclen(s, len, ep, 0) | |
669 | ||
670 | /* | |
671 | ||
672 | =for apidoc is_strict_utf8_string_loclen | |
673 | ||
674 | Like C<L</is_strict_utf8_string>> but stores the location of the failure (in the | |
675 | case of "utf8ness failure") or the location C<s>+C<len> (in the case of | |
676 | "utf8ness success") in the C<ep> pointer, and the number of UTF-8 | |
677 | encoded characters in the C<el> pointer. | |
678 | ||
679 | See also C<L</is_strict_utf8_string_loc>>. | |
680 | ||
681 | =cut | |
682 | */ | |
683 | ||
684 | PERL_STATIC_INLINE bool | |
685 | S_is_strict_utf8_string_loclen(const U8 *s, const STRLEN len, const U8 **ep, STRLEN *el) | |
686 | { | |
687 | const U8* const send = s + (len ? len : strlen((const char *)s)); | |
688 | const U8* x = s; | |
689 | STRLEN outlen = 0; | |
690 | ||
691 | PERL_ARGS_ASSERT_IS_STRICT_UTF8_STRING_LOCLEN; | |
692 | ||
693 | while (x < send) { | |
694 | const STRLEN cur_len = isSTRICT_UTF8_CHAR(x, send); | |
695 | if (UNLIKELY(! cur_len)) { | |
696 | break; | |
697 | } | |
698 | x += cur_len; | |
699 | outlen++; | |
700 | } | |
701 | ||
702 | if (el) | |
703 | *el = outlen; | |
704 | ||
705 | if (ep) { | |
706 | *ep = x; | |
707 | } | |
708 | ||
709 | return (x == send); | |
710 | } | |
711 | ||
712 | /* | |
713 | ||
714 | =for apidoc is_c9strict_utf8_string_loc | |
715 | ||
716 | Like C<L</is_c9strict_utf8_string>> but stores the location of the failure (in | |
717 | the case of "utf8ness failure") or the location C<s>+C<len> (in the case of | |
718 | "utf8ness success") in the C<ep> pointer. | |
719 | ||
720 | See also C<L</is_c9strict_utf8_string_loclen>>. | |
721 | ||
722 | =cut | |
723 | */ | |
724 | ||
725 | #define is_c9strict_utf8_string_loc(s, len, ep) \ | |
726 | is_c9strict_utf8_string_loclen(s, len, ep, 0) | |
727 | ||
728 | /* | |
729 | ||
730 | =for apidoc is_c9strict_utf8_string_loclen | |
731 | ||
732 | Like C<L</is_c9strict_utf8_string>> but stores the location of the failure (in | |
733 | the case of "utf8ness failure") or the location C<s>+C<len> (in the case of | |
734 | "utf8ness success") in the C<ep> pointer, and the number of UTF-8 encoded | |
735 | characters in the C<el> pointer. | |
736 | ||
737 | See also C<L</is_c9strict_utf8_string_loc>>. | |
738 | ||
739 | =cut | |
740 | */ | |
741 | ||
742 | PERL_STATIC_INLINE bool | |
743 | S_is_c9strict_utf8_string_loclen(const U8 *s, const STRLEN len, const U8 **ep, STRLEN *el) | |
744 | { | |
745 | const U8* const send = s + (len ? len : strlen((const char *)s)); | |
746 | const U8* x = s; | |
747 | STRLEN outlen = 0; | |
748 | ||
749 | PERL_ARGS_ASSERT_IS_C9STRICT_UTF8_STRING_LOCLEN; | |
750 | ||
751 | while (x < send) { | |
752 | const STRLEN cur_len = isC9_STRICT_UTF8_CHAR(x, send); | |
753 | if (UNLIKELY(! cur_len)) { | |
754 | break; | |
755 | } | |
756 | x += cur_len; | |
757 | outlen++; | |
758 | } | |
759 | ||
760 | if (el) | |
761 | *el = outlen; | |
762 | ||
763 | if (ep) { | |
764 | *ep = x; | |
765 | } | |
766 | ||
767 | return (x == send); | |
768 | } | |
769 | ||
770 | /* | |
771 | ||
772 | =for apidoc is_utf8_string_loc_flags | |
773 | ||
774 | Like C<L</is_utf8_string_flags>> but stores the location of the failure (in the | |
775 | case of "utf8ness failure") or the location C<s>+C<len> (in the case of | |
776 | "utf8ness success") in the C<ep> pointer. | |
777 | ||
778 | See also C<L</is_utf8_string_loclen_flags>>. | |
779 | ||
780 | =cut | |
781 | */ | |
782 | ||
783 | #define is_utf8_string_loc_flags(s, len, ep, flags) \ | |
784 | is_utf8_string_loclen_flags(s, len, ep, 0, flags) | |
785 | ||
786 | ||
787 | /* The above 3 actual functions could have been moved into the more general one | |
788 | * just below, and made #defines that call it with the right 'flags'. They are | |
789 | * currently kept separate to increase their chances of getting inlined */ | |
790 | ||
791 | /* | |
792 | ||
793 | =for apidoc is_utf8_string_loclen_flags | |
794 | ||
795 | Like C<L</is_utf8_string_flags>> but stores the location of the failure (in the | |
796 | case of "utf8ness failure") or the location C<s>+C<len> (in the case of | |
797 | "utf8ness success") in the C<ep> pointer, and the number of UTF-8 | |
798 | encoded characters in the C<el> pointer. | |
799 | ||
800 | See also C<L</is_utf8_string_loc_flags>>. | |
801 | ||
802 | =cut | |
803 | */ | |
804 | ||
805 | PERL_STATIC_INLINE bool | |
806 | S_is_utf8_string_loclen_flags(const U8 *s, const STRLEN len, const U8 **ep, STRLEN *el, const U32 flags) | |
807 | { | |
808 | const U8* const send = s + (len ? len : strlen((const char *)s)); | |
809 | const U8* x = s; | |
810 | STRLEN outlen = 0; | |
811 | ||
812 | PERL_ARGS_ASSERT_IS_UTF8_STRING_LOCLEN_FLAGS; | |
813 | assert(0 == (flags & ~(UTF8_DISALLOW_ILLEGAL_INTERCHANGE | |
814 | |UTF8_DISALLOW_ABOVE_31_BIT))); | |
815 | ||
816 | if (flags == 0) { | |
817 | return is_utf8_string_loclen(s, len, ep, el); | |
818 | } | |
819 | ||
820 | if ((flags & ~UTF8_DISALLOW_ABOVE_31_BIT) | |
821 | == UTF8_DISALLOW_ILLEGAL_INTERCHANGE) | |
822 | { | |
823 | return is_strict_utf8_string_loclen(s, len, ep, el); | |
824 | } | |
825 | ||
826 | if ((flags & ~UTF8_DISALLOW_ABOVE_31_BIT) | |
827 | == UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE) | |
828 | { | |
829 | return is_c9strict_utf8_string_loclen(s, len, ep, el); | |
830 | } | |
831 | ||
832 | while (x < send) { | |
833 | const STRLEN cur_len = isUTF8_CHAR_flags(x, send, flags); | |
834 | if (UNLIKELY(! cur_len)) { | |
835 | break; | |
836 | } | |
837 | x += cur_len; | |
838 | outlen++; | |
839 | } | |
840 | ||
841 | if (el) | |
842 | *el = outlen; | |
843 | ||
844 | if (ep) { | |
845 | *ep = x; | |
846 | } | |
847 | ||
848 | return (x == send); | |
849 | } | |
850 | ||
851 | /* | |
7c93d8f0 KW |
852 | =for apidoc utf8_distance |
853 | ||
854 | Returns the number of UTF-8 characters between the UTF-8 pointers C<a> | |
855 | and C<b>. | |
856 | ||
857 | WARNING: use only if you *know* that the pointers point inside the | |
858 | same UTF-8 buffer. | |
859 | ||
860 | =cut | |
861 | */ | |
862 | ||
863 | PERL_STATIC_INLINE IV | |
864 | Perl_utf8_distance(pTHX_ const U8 *a, const U8 *b) | |
865 | { | |
866 | PERL_ARGS_ASSERT_UTF8_DISTANCE; | |
867 | ||
868 | return (a < b) ? -1 * (IV) utf8_length(a, b) : (IV) utf8_length(b, a); | |
869 | } | |
870 | ||
871 | /* | |
872 | =for apidoc utf8_hop | |
873 | ||
874 | Return the UTF-8 pointer C<s> displaced by C<off> characters, either | |
875 | forward or backward. | |
876 | ||
877 | WARNING: do not use the following unless you *know* C<off> is within | |
878 | the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned | |
879 | on the first byte of character or just after the last byte of a character. | |
880 | ||
881 | =cut | |
882 | */ | |
883 | ||
884 | PERL_STATIC_INLINE U8 * | |
885 | Perl_utf8_hop(const U8 *s, SSize_t off) | |
886 | { | |
887 | PERL_ARGS_ASSERT_UTF8_HOP; | |
888 | ||
889 | /* Note: cannot use UTF8_IS_...() too eagerly here since e.g | |
890 | * the bitops (especially ~) can create illegal UTF-8. | |
891 | * In other words: in Perl UTF-8 is not just for Unicode. */ | |
892 | ||
893 | if (off >= 0) { | |
894 | while (off--) | |
895 | s += UTF8SKIP(s); | |
896 | } | |
897 | else { | |
898 | while (off++) { | |
899 | s--; | |
900 | while (UTF8_IS_CONTINUATION(*s)) | |
901 | s--; | |
902 | } | |
903 | } | |
904 | return (U8 *)s; | |
905 | } | |
906 | ||
4dab108f KW |
907 | /* |
908 | ||
909 | =for apidoc is_utf8_valid_partial_char | |
910 | ||
6cbb9248 KW |
911 | Returns 0 if the sequence of bytes starting at C<s> and looking no further than |
912 | S<C<e - 1>> is the UTF-8 encoding, as extended by Perl, for one or more code | |
913 | points. Otherwise, it returns 1 if there exists at least one non-empty | |
914 | sequence of bytes that when appended to sequence C<s>, starting at position | |
915 | C<e> causes the entire sequence to be the well-formed UTF-8 of some code point; | |
916 | otherwise returns 0. | |
917 | ||
918 | In other words this returns TRUE if C<s> points to a partial UTF-8-encoded code | |
919 | point. | |
920 | ||
921 | This is useful when a fixed-length buffer is being tested for being well-formed | |
922 | UTF-8, but the final few bytes in it don't comprise a full character; that is, | |
923 | it is split somewhere in the middle of the final code point's UTF-8 | |
924 | representation. (Presumably when the buffer is refreshed with the next chunk | |
925 | of data, the new first bytes will complete the partial code point.) This | |
926 | function is used to verify that the final bytes in the current buffer are in | |
927 | fact the legal beginning of some code point, so that if they aren't, the | |
928 | failure can be signalled without having to wait for the next read. | |
4dab108f KW |
929 | |
930 | =cut | |
931 | */ | |
2717076a KW |
932 | #define is_utf8_valid_partial_char(s, e) \ |
933 | is_utf8_valid_partial_char_flags(s, e, 0) | |
f1c999a7 KW |
934 | |
935 | /* | |
936 | ||
937 | =for apidoc is_utf8_valid_partial_char_flags | |
938 | ||
939 | Like C<L</is_utf8_valid_partial_char>>, it returns a boolean giving whether | |
940 | or not the input is a valid UTF-8 encoded partial character, but it takes an | |
941 | extra parameter, C<flags>, which can further restrict which code points are | |
942 | considered valid. | |
943 | ||
944 | If C<flags> is 0, this behaves identically to | |
945 | C<L</is_utf8_valid_partial_char>>. Otherwise C<flags> can be any combination | |
946 | of the C<UTF8_DISALLOW_I<foo>> flags accepted by C<L</utf8n_to_uvchr>>. If | |
947 | there is any sequence of bytes that can complete the input partial character in | |
948 | such a way that a non-prohibited character is formed, the function returns | |
2717076a KW |
949 | TRUE; otherwise FALSE. Non character code points cannot be determined based on |
950 | partial character input. But many of the other possible excluded types can be | |
f1c999a7 KW |
951 | determined from just the first one or two bytes. |
952 | ||
953 | =cut | |
954 | */ | |
955 | ||
56e4cf64 | 956 | PERL_STATIC_INLINE bool |
f1c999a7 | 957 | S_is_utf8_valid_partial_char_flags(const U8 * const s, const U8 * const e, const U32 flags) |
4dab108f | 958 | { |
f1c999a7 | 959 | PERL_ARGS_ASSERT_IS_UTF8_VALID_PARTIAL_CHAR_FLAGS; |
4dab108f | 960 | |
f1c999a7 KW |
961 | assert(0 == (flags & ~(UTF8_DISALLOW_ILLEGAL_INTERCHANGE |
962 | |UTF8_DISALLOW_ABOVE_31_BIT))); | |
4dab108f | 963 | |
8875bd48 | 964 | if (s >= e || s + UTF8SKIP(s) <= e) { |
4dab108f KW |
965 | return FALSE; |
966 | } | |
967 | ||
f1c999a7 | 968 | return cBOOL(_is_utf8_char_helper(s, e, flags)); |
4dab108f KW |
969 | } |
970 | ||
c8028aa6 TC |
971 | /* ------------------------------- perl.h ----------------------------- */ |
972 | ||
973 | /* | |
dcccc8ff KW |
974 | =head1 Miscellaneous Functions |
975 | ||
41188aa0 | 976 | =for apidoc AiR|bool|is_safe_syscall|const char *pv|STRLEN len|const char *what|const char *op_name |
c8028aa6 | 977 | |
6602b933 | 978 | Test that the given C<pv> doesn't contain any internal C<NUL> characters. |
796b6530 | 979 | If it does, set C<errno> to C<ENOENT>, optionally warn, and return FALSE. |
c8028aa6 TC |
980 | |
981 | Return TRUE if the name is safe. | |
982 | ||
796b6530 | 983 | Used by the C<IS_SAFE_SYSCALL()> macro. |
c8028aa6 TC |
984 | |
985 | =cut | |
986 | */ | |
987 | ||
988 | PERL_STATIC_INLINE bool | |
41188aa0 | 989 | S_is_safe_syscall(pTHX_ const char *pv, STRLEN len, const char *what, const char *op_name) { |
c8028aa6 TC |
990 | /* While the Windows CE API provides only UCS-16 (or UTF-16) APIs |
991 | * perl itself uses xce*() functions which accept 8-bit strings. | |
992 | */ | |
993 | ||
994 | PERL_ARGS_ASSERT_IS_SAFE_SYSCALL; | |
995 | ||
6c4650b3 | 996 | if (len > 1) { |
c8028aa6 | 997 | char *null_at; |
41188aa0 | 998 | if (UNLIKELY((null_at = (char *)memchr(pv, 0, len-1)) != NULL)) { |
c8028aa6 | 999 | SETERRNO(ENOENT, LIB_INVARG); |
1d505182 | 1000 | Perl_ck_warner(aTHX_ packWARN(WARN_SYSCALLS), |
c8028aa6 | 1001 | "Invalid \\0 character in %s for %s: %s\\0%s", |
41188aa0 | 1002 | what, op_name, pv, null_at+1); |
c8028aa6 TC |
1003 | return FALSE; |
1004 | } | |
1005 | } | |
1006 | ||
1007 | return TRUE; | |
1008 | } | |
1009 | ||
1010 | /* | |
7cb3f959 TC |
1011 | |
1012 | Return true if the supplied filename has a newline character | |
fa6c7d00 | 1013 | immediately before the first (hopefully only) NUL. |
7cb3f959 TC |
1014 | |
1015 | My original look at this incorrectly used the len from SvPV(), but | |
1016 | that's incorrect, since we allow for a NUL in pv[len-1]. | |
1017 | ||
1018 | So instead, strlen() and work from there. | |
1019 | ||
1020 | This allow for the user reading a filename, forgetting to chomp it, | |
1021 | then calling: | |
1022 | ||
1023 | open my $foo, "$file\0"; | |
1024 | ||
1025 | */ | |
1026 | ||
1027 | #ifdef PERL_CORE | |
1028 | ||
1029 | PERL_STATIC_INLINE bool | |
1030 | S_should_warn_nl(const char *pv) { | |
1031 | STRLEN len; | |
1032 | ||
1033 | PERL_ARGS_ASSERT_SHOULD_WARN_NL; | |
1034 | ||
1035 | len = strlen(pv); | |
1036 | ||
1037 | return len > 0 && pv[len-1] == '\n'; | |
1038 | } | |
1039 | ||
1040 | #endif | |
1041 | ||
81d52ecd JH |
1042 | /* ------------------ pp.c, regcomp.c, toke.c, universal.c ------------ */ |
1043 | ||
1044 | #define MAX_CHARSET_NAME_LENGTH 2 | |
1045 | ||
1046 | PERL_STATIC_INLINE const char * | |
1047 | get_regex_charset_name(const U32 flags, STRLEN* const lenp) | |
1048 | { | |
1049 | /* Returns a string that corresponds to the name of the regex character set | |
1050 | * given by 'flags', and *lenp is set the length of that string, which | |
1051 | * cannot exceed MAX_CHARSET_NAME_LENGTH characters */ | |
1052 | ||
1053 | *lenp = 1; | |
1054 | switch (get_regex_charset(flags)) { | |
1055 | case REGEX_DEPENDS_CHARSET: return DEPENDS_PAT_MODS; | |
1056 | case REGEX_LOCALE_CHARSET: return LOCALE_PAT_MODS; | |
1057 | case REGEX_UNICODE_CHARSET: return UNICODE_PAT_MODS; | |
1058 | case REGEX_ASCII_RESTRICTED_CHARSET: return ASCII_RESTRICT_PAT_MODS; | |
1059 | case REGEX_ASCII_MORE_RESTRICTED_CHARSET: | |
1060 | *lenp = 2; | |
1061 | return ASCII_MORE_RESTRICT_PAT_MODS; | |
1062 | } | |
1063 | /* The NOT_REACHED; hides an assert() which has a rather complex | |
1064 | * definition in perl.h. */ | |
1065 | NOT_REACHED; /* NOTREACHED */ | |
1066 | return "?"; /* Unknown */ | |
1067 | } | |
1068 | ||
7cb3f959 | 1069 | /* |
ed382232 TC |
1070 | |
1071 | Return false if any get magic is on the SV other than taint magic. | |
1072 | ||
1073 | */ | |
1074 | ||
1075 | PERL_STATIC_INLINE bool | |
1076 | S_sv_only_taint_gmagic(SV *sv) { | |
1077 | MAGIC *mg = SvMAGIC(sv); | |
1078 | ||
1079 | PERL_ARGS_ASSERT_SV_ONLY_TAINT_GMAGIC; | |
1080 | ||
1081 | while (mg) { | |
1082 | if (mg->mg_type != PERL_MAGIC_taint | |
1083 | && !(mg->mg_flags & MGf_GSKIP) | |
1084 | && mg->mg_virtual->svt_get) { | |
1085 | return FALSE; | |
1086 | } | |
1087 | mg = mg->mg_moremagic; | |
1088 | } | |
1089 | ||
1090 | return TRUE; | |
1091 | } | |
1092 | ||
ed8ff0f3 DM |
1093 | /* ------------------ cop.h ------------------------------------------- */ |
1094 | ||
1095 | ||
1096 | /* Enter a block. Push a new base context and return its address. */ | |
1097 | ||
1098 | PERL_STATIC_INLINE PERL_CONTEXT * | |
1099 | S_cx_pushblock(pTHX_ U8 type, U8 gimme, SV** sp, I32 saveix) | |
1100 | { | |
1101 | PERL_CONTEXT * cx; | |
1102 | ||
1103 | PERL_ARGS_ASSERT_CX_PUSHBLOCK; | |
1104 | ||
1105 | CXINC; | |
1106 | cx = CX_CUR(); | |
1107 | cx->cx_type = type; | |
1108 | cx->blk_gimme = gimme; | |
1109 | cx->blk_oldsaveix = saveix; | |
4caf7d8c | 1110 | cx->blk_oldsp = (I32)(sp - PL_stack_base); |
ed8ff0f3 | 1111 | cx->blk_oldcop = PL_curcop; |
4caf7d8c | 1112 | cx->blk_oldmarksp = (I32)(PL_markstack_ptr - PL_markstack); |
ed8ff0f3 DM |
1113 | cx->blk_oldscopesp = PL_scopestack_ix; |
1114 | cx->blk_oldpm = PL_curpm; | |
ce8bb8d8 | 1115 | cx->blk_old_tmpsfloor = PL_tmps_floor; |
ed8ff0f3 DM |
1116 | |
1117 | PL_tmps_floor = PL_tmps_ix; | |
1118 | CX_DEBUG(cx, "PUSH"); | |
1119 | return cx; | |
1120 | } | |
1121 | ||
1122 | ||
1123 | /* Exit a block (RETURN and LAST). */ | |
1124 | ||
1125 | PERL_STATIC_INLINE void | |
1126 | S_cx_popblock(pTHX_ PERL_CONTEXT *cx) | |
1127 | { | |
1128 | PERL_ARGS_ASSERT_CX_POPBLOCK; | |
1129 | ||
1130 | CX_DEBUG(cx, "POP"); | |
1131 | /* these 3 are common to cx_popblock and cx_topblock */ | |
1132 | PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp; | |
1133 | PL_scopestack_ix = cx->blk_oldscopesp; | |
1134 | PL_curpm = cx->blk_oldpm; | |
1135 | ||
1136 | /* LEAVE_SCOPE() should have made this true. /(?{})/ cheats | |
1137 | * and leaves a CX entry lying around for repeated use, so | |
1138 | * skip for multicall */ \ | |
1139 | assert( (CxTYPE(cx) == CXt_SUB && CxMULTICALL(cx)) | |
1140 | || PL_savestack_ix == cx->blk_oldsaveix); | |
1141 | PL_curcop = cx->blk_oldcop; | |
ce8bb8d8 | 1142 | PL_tmps_floor = cx->blk_old_tmpsfloor; |
ed8ff0f3 DM |
1143 | } |
1144 | ||
1145 | /* Continue a block elsewhere (e.g. NEXT, REDO, GOTO). | |
1146 | * Whereas cx_popblock() restores the state to the point just before | |
1147 | * cx_pushblock() was called, cx_topblock() restores it to the point just | |
1148 | * *after* cx_pushblock() was called. */ | |
1149 | ||
1150 | PERL_STATIC_INLINE void | |
1151 | S_cx_topblock(pTHX_ PERL_CONTEXT *cx) | |
1152 | { | |
1153 | PERL_ARGS_ASSERT_CX_TOPBLOCK; | |
1154 | ||
1155 | CX_DEBUG(cx, "TOP"); | |
1156 | /* these 3 are common to cx_popblock and cx_topblock */ | |
1157 | PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp; | |
1158 | PL_scopestack_ix = cx->blk_oldscopesp; | |
1159 | PL_curpm = cx->blk_oldpm; | |
1160 | ||
1161 | PL_stack_sp = PL_stack_base + cx->blk_oldsp; | |
1162 | } | |
1163 | ||
1164 | ||
a73d8813 DM |
1165 | PERL_STATIC_INLINE void |
1166 | S_cx_pushsub(pTHX_ PERL_CONTEXT *cx, CV *cv, OP *retop, bool hasargs) | |
1167 | { | |
1168 | U8 phlags = CX_PUSHSUB_GET_LVALUE_MASK(Perl_was_lvalue_sub); | |
1169 | ||
1170 | PERL_ARGS_ASSERT_CX_PUSHSUB; | |
1171 | ||
3f6bd23a | 1172 | PERL_DTRACE_PROBE_ENTRY(cv); |
a73d8813 DM |
1173 | cx->blk_sub.cv = cv; |
1174 | cx->blk_sub.olddepth = CvDEPTH(cv); | |
1175 | cx->blk_sub.prevcomppad = PL_comppad; | |
1176 | cx->cx_type |= (hasargs) ? CXp_HASARGS : 0; | |
1177 | cx->blk_sub.retop = retop; | |
1178 | SvREFCNT_inc_simple_void_NN(cv); | |
1179 | cx->blk_u16 = PL_op->op_private & (phlags|OPpDEREF); | |
1180 | } | |
1181 | ||
1182 | ||
1183 | /* subsets of cx_popsub() */ | |
1184 | ||
1185 | PERL_STATIC_INLINE void | |
1186 | S_cx_popsub_common(pTHX_ PERL_CONTEXT *cx) | |
1187 | { | |
1188 | CV *cv; | |
1189 | ||
1190 | PERL_ARGS_ASSERT_CX_POPSUB_COMMON; | |
1191 | assert(CxTYPE(cx) == CXt_SUB); | |
1192 | ||
1193 | PL_comppad = cx->blk_sub.prevcomppad; | |
1194 | PL_curpad = LIKELY(PL_comppad) ? AvARRAY(PL_comppad) : NULL; | |
1195 | cv = cx->blk_sub.cv; | |
1196 | CvDEPTH(cv) = cx->blk_sub.olddepth; | |
1197 | cx->blk_sub.cv = NULL; | |
1198 | SvREFCNT_dec(cv); | |
1199 | } | |
1200 | ||
1201 | ||
1202 | /* handle the @_ part of leaving a sub */ | |
1203 | ||
1204 | PERL_STATIC_INLINE void | |
1205 | S_cx_popsub_args(pTHX_ PERL_CONTEXT *cx) | |
1206 | { | |
1207 | AV *av; | |
1208 | ||
1209 | PERL_ARGS_ASSERT_CX_POPSUB_ARGS; | |
1210 | assert(CxTYPE(cx) == CXt_SUB); | |
1211 | assert(AvARRAY(MUTABLE_AV( | |
1212 | PadlistARRAY(CvPADLIST(cx->blk_sub.cv))[ | |
1213 | CvDEPTH(cx->blk_sub.cv)])) == PL_curpad); | |
1214 | ||
1215 | CX_POP_SAVEARRAY(cx); | |
1216 | av = MUTABLE_AV(PAD_SVl(0)); | |
1217 | if (UNLIKELY(AvREAL(av))) | |
1218 | /* abandon @_ if it got reified */ | |
1219 | clear_defarray(av, 0); | |
1220 | else { | |
1221 | CLEAR_ARGARRAY(av); | |
1222 | } | |
1223 | } | |
1224 | ||
1225 | ||
1226 | PERL_STATIC_INLINE void | |
1227 | S_cx_popsub(pTHX_ PERL_CONTEXT *cx) | |
1228 | { | |
1229 | PERL_ARGS_ASSERT_CX_POPSUB; | |
1230 | assert(CxTYPE(cx) == CXt_SUB); | |
1231 | ||
3f6bd23a | 1232 | PERL_DTRACE_PROBE_RETURN(cx->blk_sub.cv); |
a73d8813 DM |
1233 | |
1234 | if (CxHASARGS(cx)) | |
1235 | cx_popsub_args(cx); | |
1236 | cx_popsub_common(cx); | |
1237 | } | |
1238 | ||
1239 | ||
6a7d52cc DM |
1240 | PERL_STATIC_INLINE void |
1241 | S_cx_pushformat(pTHX_ PERL_CONTEXT *cx, CV *cv, OP *retop, GV *gv) | |
1242 | { | |
1243 | PERL_ARGS_ASSERT_CX_PUSHFORMAT; | |
1244 | ||
1245 | cx->blk_format.cv = cv; | |
1246 | cx->blk_format.retop = retop; | |
1247 | cx->blk_format.gv = gv; | |
1248 | cx->blk_format.dfoutgv = PL_defoutgv; | |
1249 | cx->blk_format.prevcomppad = PL_comppad; | |
1250 | cx->blk_u16 = 0; | |
1251 | ||
1252 | SvREFCNT_inc_simple_void_NN(cv); | |
1253 | CvDEPTH(cv)++; | |
1254 | SvREFCNT_inc_void(cx->blk_format.dfoutgv); | |
1255 | } | |
1256 | ||
1257 | ||
1258 | PERL_STATIC_INLINE void | |
1259 | S_cx_popformat(pTHX_ PERL_CONTEXT *cx) | |
1260 | { | |
1261 | CV *cv; | |
1262 | GV *dfout; | |
1263 | ||
1264 | PERL_ARGS_ASSERT_CX_POPFORMAT; | |
1265 | assert(CxTYPE(cx) == CXt_FORMAT); | |
1266 | ||
1267 | dfout = cx->blk_format.dfoutgv; | |
1268 | setdefout(dfout); | |
1269 | cx->blk_format.dfoutgv = NULL; | |
1270 | SvREFCNT_dec_NN(dfout); | |
1271 | ||
1272 | PL_comppad = cx->blk_format.prevcomppad; | |
1273 | PL_curpad = LIKELY(PL_comppad) ? AvARRAY(PL_comppad) : NULL; | |
1274 | cv = cx->blk_format.cv; | |
1275 | cx->blk_format.cv = NULL; | |
1276 | --CvDEPTH(cv); | |
1277 | SvREFCNT_dec_NN(cv); | |
1278 | } | |
1279 | ||
1280 | ||
13febba5 DM |
1281 | PERL_STATIC_INLINE void |
1282 | S_cx_pusheval(pTHX_ PERL_CONTEXT *cx, OP *retop, SV *namesv) | |
1283 | { | |
1284 | PERL_ARGS_ASSERT_CX_PUSHEVAL; | |
1285 | ||
1286 | cx->blk_eval.retop = retop; | |
1287 | cx->blk_eval.old_namesv = namesv; | |
1288 | cx->blk_eval.old_eval_root = PL_eval_root; | |
1289 | cx->blk_eval.cur_text = PL_parser ? PL_parser->linestr : NULL; | |
1290 | cx->blk_eval.cv = NULL; /* later set by doeval_compile() */ | |
1291 | cx->blk_eval.cur_top_env = PL_top_env; | |
1292 | ||
1293 | assert(!(PL_in_eval & ~ 0x7F)); | |
1294 | assert(!(PL_op->op_type & ~0x1FF)); | |
1295 | cx->blk_u16 = (PL_in_eval & 0x7F) | ((U16)PL_op->op_type << 7); | |
1296 | } | |
1297 | ||
1298 | ||
1299 | PERL_STATIC_INLINE void | |
1300 | S_cx_popeval(pTHX_ PERL_CONTEXT *cx) | |
1301 | { | |
1302 | SV *sv; | |
1303 | ||
1304 | PERL_ARGS_ASSERT_CX_POPEVAL; | |
1305 | assert(CxTYPE(cx) == CXt_EVAL); | |
1306 | ||
1307 | PL_in_eval = CxOLD_IN_EVAL(cx); | |
1308 | PL_eval_root = cx->blk_eval.old_eval_root; | |
1309 | sv = cx->blk_eval.cur_text; | |
1310 | if (sv && SvSCREAM(sv)) { | |
1311 | cx->blk_eval.cur_text = NULL; | |
1312 | SvREFCNT_dec_NN(sv); | |
1313 | } | |
1314 | ||
1315 | sv = cx->blk_eval.old_namesv; | |
2a1e0dfe DM |
1316 | if (sv) { |
1317 | cx->blk_eval.old_namesv = NULL; | |
1318 | SvREFCNT_dec_NN(sv); | |
1319 | } | |
13febba5 | 1320 | } |
6a7d52cc | 1321 | |
a73d8813 | 1322 | |
d1b6bf72 DM |
1323 | /* push a plain loop, i.e. |
1324 | * { block } | |
1325 | * while (cond) { block } | |
1326 | * for (init;cond;continue) { block } | |
1327 | * This loop can be last/redo'ed etc. | |
1328 | */ | |
1329 | ||
1330 | PERL_STATIC_INLINE void | |
1331 | S_cx_pushloop_plain(pTHX_ PERL_CONTEXT *cx) | |
1332 | { | |
1333 | PERL_ARGS_ASSERT_CX_PUSHLOOP_PLAIN; | |
1334 | cx->blk_loop.my_op = cLOOP; | |
1335 | } | |
1336 | ||
1337 | ||
1338 | /* push a true for loop, i.e. | |
1339 | * for var (list) { block } | |
1340 | */ | |
1341 | ||
1342 | PERL_STATIC_INLINE void | |
1343 | S_cx_pushloop_for(pTHX_ PERL_CONTEXT *cx, void *itervarp, SV* itersave) | |
1344 | { | |
1345 | PERL_ARGS_ASSERT_CX_PUSHLOOP_FOR; | |
1346 | ||
1347 | /* this one line is common with cx_pushloop_plain */ | |
1348 | cx->blk_loop.my_op = cLOOP; | |
1349 | ||
1350 | cx->blk_loop.itervar_u.svp = (SV**)itervarp; | |
1351 | cx->blk_loop.itersave = itersave; | |
1352 | #ifdef USE_ITHREADS | |
1353 | cx->blk_loop.oldcomppad = PL_comppad; | |
1354 | #endif | |
1355 | } | |
1356 | ||
1357 | ||
1358 | /* pop all loop types, including plain */ | |
1359 | ||
1360 | PERL_STATIC_INLINE void | |
1361 | S_cx_poploop(pTHX_ PERL_CONTEXT *cx) | |
1362 | { | |
1363 | PERL_ARGS_ASSERT_CX_POPLOOP; | |
1364 | ||
1365 | assert(CxTYPE_is_LOOP(cx)); | |
1366 | if ( CxTYPE(cx) == CXt_LOOP_ARY | |
1367 | || CxTYPE(cx) == CXt_LOOP_LAZYSV) | |
1368 | { | |
1369 | /* Free ary or cur. This assumes that state_u.ary.ary | |
1370 | * aligns with state_u.lazysv.cur. See cx_dup() */ | |
1371 | SV *sv = cx->blk_loop.state_u.lazysv.cur; | |
1372 | cx->blk_loop.state_u.lazysv.cur = NULL; | |
1373 | SvREFCNT_dec_NN(sv); | |
1374 | if (CxTYPE(cx) == CXt_LOOP_LAZYSV) { | |
1375 | sv = cx->blk_loop.state_u.lazysv.end; | |
1376 | cx->blk_loop.state_u.lazysv.end = NULL; | |
1377 | SvREFCNT_dec_NN(sv); | |
1378 | } | |
1379 | } | |
1380 | if (cx->cx_type & (CXp_FOR_PAD|CXp_FOR_GV)) { | |
1381 | SV *cursv; | |
1382 | SV **svp = (cx)->blk_loop.itervar_u.svp; | |
1383 | if ((cx->cx_type & CXp_FOR_GV)) | |
1384 | svp = &GvSV((GV*)svp); | |
1385 | cursv = *svp; | |
1386 | *svp = cx->blk_loop.itersave; | |
1387 | cx->blk_loop.itersave = NULL; | |
1388 | SvREFCNT_dec(cursv); | |
1389 | } | |
1390 | } | |
1391 | ||
2a7b7c61 DM |
1392 | |
1393 | PERL_STATIC_INLINE void | |
1394 | S_cx_pushwhen(pTHX_ PERL_CONTEXT *cx) | |
1395 | { | |
1396 | PERL_ARGS_ASSERT_CX_PUSHWHEN; | |
1397 | ||
1398 | cx->blk_givwhen.leave_op = cLOGOP->op_other; | |
1399 | } | |
1400 | ||
1401 | ||
1402 | PERL_STATIC_INLINE void | |
1403 | S_cx_popwhen(pTHX_ PERL_CONTEXT *cx) | |
1404 | { | |
1405 | PERL_ARGS_ASSERT_CX_POPWHEN; | |
1406 | assert(CxTYPE(cx) == CXt_WHEN); | |
1407 | ||
1408 | PERL_UNUSED_ARG(cx); | |
59a14f30 | 1409 | PERL_UNUSED_CONTEXT; |
2a7b7c61 DM |
1410 | /* currently NOOP */ |
1411 | } | |
1412 | ||
1413 | ||
1414 | PERL_STATIC_INLINE void | |
1415 | S_cx_pushgiven(pTHX_ PERL_CONTEXT *cx, SV *orig_defsv) | |
1416 | { | |
1417 | PERL_ARGS_ASSERT_CX_PUSHGIVEN; | |
1418 | ||
1419 | cx->blk_givwhen.leave_op = cLOGOP->op_other; | |
1420 | cx->blk_givwhen.defsv_save = orig_defsv; | |
1421 | } | |
1422 | ||
1423 | ||
1424 | PERL_STATIC_INLINE void | |
1425 | S_cx_popgiven(pTHX_ PERL_CONTEXT *cx) | |
1426 | { | |
1427 | SV *sv; | |
1428 | ||
1429 | PERL_ARGS_ASSERT_CX_POPGIVEN; | |
1430 | assert(CxTYPE(cx) == CXt_GIVEN); | |
1431 | ||
1432 | sv = GvSV(PL_defgv); | |
1433 | GvSV(PL_defgv) = cx->blk_givwhen.defsv_save; | |
1434 | cx->blk_givwhen.defsv_save = NULL; | |
1435 | SvREFCNT_dec(sv); | |
1436 | } | |
1437 | ||
ed382232 | 1438 | /* |
c8028aa6 TC |
1439 | * ex: set ts=8 sts=4 sw=4 et: |
1440 | */ |