This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Deprecate isFOO_utf8() macros
[perl5.git] / handy.h
1 /*    handy.h
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1999, 2000,
4  *    2001, 2002, 2004, 2005, 2006, 2007, 2008, 2012 by Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  */
10
11 /* IMPORTANT NOTE: Everything whose name begins with an underscore is for
12  * internal core Perl use only. */
13
14 #ifndef HANDY_H /* Guard against nested #inclusion */
15 #define HANDY_H
16
17 #if !defined(__STDC__)
18 #ifdef NULL
19 #undef NULL
20 #endif
21 #  define NULL 0
22 #endif
23
24 #ifndef PERL_CORE
25 #  define Null(type) ((type)NULL)
26
27 /*
28 =head1 Handy Values
29
30 =for apidoc AmU||Nullch
31 Null character pointer.  (No longer available when C<PERL_CORE> is
32 defined.)
33
34 =for apidoc AmU||Nullsv
35 Null SV pointer.  (No longer available when C<PERL_CORE> is defined.)
36
37 =cut
38 */
39
40 #  define Nullch Null(char*)
41 #  define Nullfp Null(PerlIO*)
42 #  define Nullsv Null(SV*)
43 #endif
44
45 #ifdef TRUE
46 #undef TRUE
47 #endif
48 #ifdef FALSE
49 #undef FALSE
50 #endif
51 #define TRUE (1)
52 #define FALSE (0)
53
54 /* The MUTABLE_*() macros cast pointers to the types shown, in such a way
55  * (compiler permitting) that casting away const-ness will give a warning;
56  * e.g.:
57  *
58  * const SV *sv = ...;
59  * AV *av1 = (AV*)sv;        <== BAD:  the const has been silently cast away
60  * AV *av2 = MUTABLE_AV(sv); <== GOOD: it may warn
61  */
62
63 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
64 #  define MUTABLE_PTR(p) ({ void *_p = (p); _p; })
65 #else
66 #  define MUTABLE_PTR(p) ((void *) (p))
67 #endif
68
69 #define MUTABLE_AV(p)   ((AV *)MUTABLE_PTR(p))
70 #define MUTABLE_CV(p)   ((CV *)MUTABLE_PTR(p))
71 #define MUTABLE_GV(p)   ((GV *)MUTABLE_PTR(p))
72 #define MUTABLE_HV(p)   ((HV *)MUTABLE_PTR(p))
73 #define MUTABLE_IO(p)   ((IO *)MUTABLE_PTR(p))
74 #define MUTABLE_SV(p)   ((SV *)MUTABLE_PTR(p))
75
76 #if defined(I_STDBOOL) && !defined(PERL_BOOL_AS_CHAR)
77 #  include <stdbool.h>
78 #  ifndef HAS_BOOL
79 #    define HAS_BOOL 1
80 #  endif
81 #endif
82
83 /* bool is built-in for g++-2.6.3 and later, which might be used
84    for extensions.  <_G_config.h> defines _G_HAVE_BOOL, but we can't
85    be sure _G_config.h will be included before this file.  _G_config.h
86    also defines _G_HAVE_BOOL for both gcc and g++, but only g++
87    actually has bool.  Hence, _G_HAVE_BOOL is pretty useless for us.
88    g++ can be identified by __GNUG__.
89    Andy Dougherty       February 2000
90 */
91 #ifdef __GNUG__         /* GNU g++ has bool built-in */
92 # ifndef PERL_BOOL_AS_CHAR
93 #  ifndef HAS_BOOL
94 #    define HAS_BOOL 1
95 #  endif
96 # endif
97 #endif
98
99 #ifndef HAS_BOOL
100 # ifdef bool
101 #  undef bool
102 # endif
103 # define bool char
104 # define HAS_BOOL 1
105 #endif
106
107 /* cast-to-bool.  A simple (bool) cast may not do the right thing: if bool is
108  * defined as char for example, then the cast from int is
109  * implementation-defined (bool)!!(cbool) in a ternary triggers a bug in xlc on
110  * AIX */
111 #define cBOOL(cbool) ((cbool) ? (bool)1 : (bool)0)
112
113 /* Try to figure out __func__ or __FUNCTION__ equivalent, if any.
114  * XXX Should really be a Configure probe, with HAS__FUNCTION__
115  *     and FUNCTION__ as results.
116  * XXX Similarly, a Configure probe for __FILE__ and __LINE__ is needed. */
117 #if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || (defined(__SUNPRO_C)) /* C99 or close enough. */
118 #  define FUNCTION__ __func__
119 #else
120 #  if (defined(USING_MSVC6)) || /* MSVC6 has neither __func__ nor __FUNCTION and no good workarounds, either. */ \
121       (defined(__DECC_VER)) /* Tru64 or VMS, and strict C89 being used, but not modern enough cc (in Tur64, -c99 not known, only -std1). */
122 #    define FUNCTION__ ""
123 #  else
124 #    define FUNCTION__ __FUNCTION__ /* Common extension. */
125 #  endif
126 #endif
127
128 /* XXX A note on the perl source internal type system.  The
129    original intent was that I32 be *exactly* 32 bits.
130
131    Currently, we only guarantee that I32 is *at least* 32 bits.
132    Specifically, if int is 64 bits, then so is I32.  (This is the case
133    for the Cray.)  This has the advantage of meshing nicely with
134    standard library calls (where we pass an I32 and the library is
135    expecting an int), but the disadvantage that an I32 is not 32 bits.
136    Andy Dougherty       August 1996
137
138    There is no guarantee that there is *any* integral type with
139    exactly 32 bits.  It is perfectly legal for a system to have
140    sizeof(short) == sizeof(int) == sizeof(long) == 8.
141
142    Similarly, there is no guarantee that I16 and U16 have exactly 16
143    bits.
144
145    For dealing with issues that may arise from various 32/64-bit
146    systems, we will ask Configure to check out
147
148         SHORTSIZE == sizeof(short)
149         INTSIZE == sizeof(int)
150         LONGSIZE == sizeof(long)
151         LONGLONGSIZE == sizeof(long long) (if HAS_LONG_LONG)
152         PTRSIZE == sizeof(void *)
153         DOUBLESIZE == sizeof(double)
154         LONG_DOUBLESIZE == sizeof(long double) (if HAS_LONG_DOUBLE).
155
156 */
157
158 #ifdef I_INTTYPES /* e.g. Linux has int64_t without <inttypes.h> */
159 #   include <inttypes.h>
160 #   ifdef INT32_MIN_BROKEN
161 #       undef  INT32_MIN
162 #       define INT32_MIN (-2147483647-1)
163 #   endif
164 #   ifdef INT64_MIN_BROKEN
165 #       undef  INT64_MIN
166 #       define INT64_MIN (-9223372036854775807LL-1)
167 #   endif
168 #endif
169
170 typedef I8TYPE I8;
171 typedef U8TYPE U8;
172 typedef I16TYPE I16;
173 typedef U16TYPE U16;
174 typedef I32TYPE I32;
175 typedef U32TYPE U32;
176
177 #ifdef HAS_QUAD
178 typedef I64TYPE I64;
179 typedef U64TYPE U64;
180 #endif
181
182 /* INT64_C/UINT64_C are C99 from <stdint.h> (so they will not be
183  * available in strict C89 mode), but they are nice, so let's define
184  * them if necessary. */
185 #if defined(HAS_QUAD)
186 #  undef PeRl_INT64_C
187 #  undef PeRl_UINT64_C
188 /* Prefer the native integer types (int and long) over long long
189  * (which is not C89) and Win32-specific __int64. */
190 #  if QUADKIND == QUAD_IS_INT && INTSIZE == 8
191 #    define PeRl_INT64_C(c)     (c)
192 #    define PeRl_UINT64_C(c)    CAT2(c,U)
193 #  endif
194 #  if QUADKIND == QUAD_IS_LONG && LONGSIZE == 8
195 #    define PeRl_INT64_C(c)     CAT2(c,L)
196 #    define PeRl_UINT64_C(c)    CAT2(c,UL)
197 #  endif
198 #  if QUADKIND == QUAD_IS_LONG_LONG && defined(HAS_LONG_LONG)
199 #    define PeRl_INT64_C(c)     CAT2(c,LL)
200 #    define PeRl_UINT64_C(c)    CAT2(c,ULL)
201 #  endif
202 #  if QUADKIND == QUAD_IS___INT64
203 #    define PeRl_INT64_C(c)     CAT2(c,I64)
204 #    define PeRl_UINT64_C(c)    CAT2(c,UI64)
205 #  endif
206 #  ifndef PeRl_INT64_C
207 #    define PeRl_INT64_C(c)     ((I64)(c)) /* last resort */
208 #    define PeRl_UINT64_C(c)    ((U64)(c))
209 #  endif
210 /* In OS X the INT64_C/UINT64_C are defined with LL/ULL, which will
211  * not fly with C89-pedantic gcc, so let's undefine them first so that
212  * we can redefine them with our native integer preferring versions. */
213 #  if defined(PERL_DARWIN) && defined(PERL_GCC_PEDANTIC)
214 #    undef INT64_C
215 #    undef UINT64_C
216 #  endif
217 #  ifndef INT64_C
218 #    define INT64_C(c) PeRl_INT64_C(c)
219 #  endif
220 #  ifndef UINT64_C
221 #    define UINT64_C(c) PeRl_UINT64_C(c)
222 #  endif
223 #endif
224
225 #if defined(UINT8_MAX) && defined(INT16_MAX) && defined(INT32_MAX)
226
227 /* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
228    Please search CHAR_MAX in perl.h for further details. */
229 #define U8_MAX UINT8_MAX
230 #define U8_MIN UINT8_MIN
231
232 #define I16_MAX INT16_MAX
233 #define I16_MIN INT16_MIN
234 #define U16_MAX UINT16_MAX
235 #define U16_MIN UINT16_MIN
236
237 #define I32_MAX INT32_MAX
238 #define I32_MIN INT32_MIN
239 #ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
240 #  define U32_MAX UINT32_MAX
241 #else
242 #  define U32_MAX 4294967295U
243 #endif
244 #define U32_MIN UINT32_MIN
245
246 #else
247
248 /* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
249    Please search CHAR_MAX in perl.h for further details. */
250 #define U8_MAX PERL_UCHAR_MAX
251 #define U8_MIN PERL_UCHAR_MIN
252
253 #define I16_MAX PERL_SHORT_MAX
254 #define I16_MIN PERL_SHORT_MIN
255 #define U16_MAX PERL_USHORT_MAX
256 #define U16_MIN PERL_USHORT_MIN
257
258 #if LONGSIZE > 4
259 # define I32_MAX PERL_INT_MAX
260 # define I32_MIN PERL_INT_MIN
261 # define U32_MAX PERL_UINT_MAX
262 # define U32_MIN PERL_UINT_MIN
263 #else
264 # define I32_MAX PERL_LONG_MAX
265 # define I32_MIN PERL_LONG_MIN
266 # define U32_MAX PERL_ULONG_MAX
267 # define U32_MIN PERL_ULONG_MIN
268 #endif
269
270 #endif
271
272 /* log(2) is pretty close to  0.30103, just in case anyone is grepping for it */
273 #define BIT_DIGITS(N)   (((N)*146)/485 + 1)  /* log2(10) =~ 146/485 */
274 #define TYPE_DIGITS(T)  BIT_DIGITS(sizeof(T) * 8)
275 #define TYPE_CHARS(T)   (TYPE_DIGITS(T) + 2) /* sign, NUL */
276
277 /* Unused by core; should be deprecated */
278 #define Ctl(ch) ((ch) & 037)
279
280 #if defined(PERL_CORE) || defined(PERL_EXT)
281 #  ifndef MIN
282 #    define MIN(a,b) ((a) < (b) ? (a) : (b))
283 #  endif
284 #  ifndef MAX
285 #    define MAX(a,b) ((a) > (b) ? (a) : (b))
286 #  endif
287 #endif
288
289 /* This is a helper macro to avoid preprocessor issues, replaced by nothing
290  * unless under DEBUGGING, where it expands to an assert of its argument,
291  * followed by a comma (hence the comma operator).  If we just used a straight
292  * assert(), we would get a comma with nothing before it when not DEBUGGING.
293  *
294  * We also use empty definition under Coverity since the __ASSERT__
295  * checks often check for things that Really Cannot Happen, and Coverity
296  * detects that and gets all excited. */
297
298 #if defined(DEBUGGING) && !defined(__COVERITY__)
299 #   define __ASSERT_(statement)  assert(statement),
300 #else
301 #   define __ASSERT_(statement)
302 #endif
303
304 /*
305 =head1 SV-Body Allocation
306
307 =for apidoc Ama|SV*|newSVpvs|const char* s
308 Like C<newSVpvn>, but takes a C<NUL>-terminated literal string instead of a
309 string/length pair.
310
311 =for apidoc Ama|SV*|newSVpvs_flags|const char* s|U32 flags
312 Like C<newSVpvn_flags>, but takes a C<NUL>-terminated literal string instead of
313 a string/length pair.
314
315 =for apidoc Ama|SV*|newSVpvs_share|const char* s
316 Like C<newSVpvn_share>, but takes a C<NUL>-terminated literal string instead of
317 a string/length pair and omits the hash parameter.
318
319 =for apidoc Am|void|sv_catpvs_flags|SV* sv|const char* s|I32 flags
320 Like C<sv_catpvn_flags>, but takes a C<NUL>-terminated literal string instead
321 of a string/length pair.
322
323 =for apidoc Am|void|sv_catpvs_nomg|SV* sv|const char* s
324 Like C<sv_catpvn_nomg>, but takes a C<NUL>-terminated literal string instead of
325 a string/length pair.
326
327 =for apidoc Am|void|sv_catpvs|SV* sv|const char* s
328 Like C<sv_catpvn>, but takes a C<NUL>-terminated literal string instead of a
329 string/length pair.
330
331 =for apidoc Am|void|sv_catpvs_mg|SV* sv|const char* s
332 Like C<sv_catpvn_mg>, but takes a C<NUL>-terminated literal string instead of a
333 string/length pair.
334
335 =for apidoc Am|void|sv_setpvs|SV* sv|const char* s
336 Like C<sv_setpvn>, but takes a C<NUL>-terminated literal string instead of a
337 string/length pair.
338
339 =for apidoc Am|void|sv_setpvs_mg|SV* sv|const char* s
340 Like C<sv_setpvn_mg>, but takes a C<NUL>-terminated literal string instead of a
341 string/length pair.
342
343 =for apidoc Am|SV *|sv_setref_pvs|const char* s
344 Like C<sv_setref_pvn>, but takes a C<NUL>-terminated literal string instead of
345 a string/length pair.
346
347 =head1 Memory Management
348
349 =for apidoc Ama|char*|savepvs|const char* s
350 Like C<savepvn>, but takes a C<NUL>-terminated literal string instead of a
351 string/length pair.
352
353 =for apidoc Ama|char*|savesharedpvs|const char* s
354 A version of C<savepvs()> which allocates the duplicate string in memory
355 which is shared between threads.
356
357 =head1 GV Functions
358
359 =for apidoc Am|HV*|gv_stashpvs|const char* name|I32 create
360 Like C<gv_stashpvn>, but takes a C<NUL>-terminated literal string instead of a
361 string/length pair.
362
363 =head1 Hash Manipulation Functions
364
365 =for apidoc Am|SV**|hv_fetchs|HV* tb|const char* key|I32 lval
366 Like C<hv_fetch>, but takes a C<NUL>-terminated literal string instead of a
367 string/length pair.
368
369 =for apidoc Am|SV**|hv_stores|HV* tb|const char* key|NULLOK SV* val
370 Like C<hv_store>, but takes a C<NUL>-terminated literal string instead of a
371 string/length pair
372 and omits the hash parameter.
373
374 =head1 Lexer interface
375
376 =for apidoc Amx|void|lex_stuff_pvs|const char *pv|U32 flags
377
378 Like L</lex_stuff_pvn>, but takes a C<NUL>-terminated literal string instead of
379 a string/length pair.
380
381 =cut
382 */
383
384 /* concatenating with "" ensures that only literal strings are accepted as
385  * argument */
386 #define STR_WITH_LEN(s)  ("" s ""), (sizeof(s)-1)
387
388 /* note that STR_WITH_LEN() can't be used as argument to macros or functions
389  * that under some configurations might be macros, which means that it requires
390  * the full Perl_xxx(aTHX_ ...) form for any API calls where it's used.
391  */
392
393 /* STR_WITH_LEN() shortcuts */
394 #define newSVpvs(str) Perl_newSVpvn(aTHX_ STR_WITH_LEN(str))
395 #define newSVpvs_flags(str,flags)       \
396     Perl_newSVpvn_flags(aTHX_ STR_WITH_LEN(str), flags)
397 #define newSVpvs_share(str) Perl_newSVpvn_share(aTHX_ STR_WITH_LEN(str), 0)
398 #define sv_catpvs_flags(sv, str, flags) \
399     Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), flags)
400 #define sv_catpvs_nomg(sv, str) \
401     Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), 0)
402 #define sv_catpvs(sv, str) \
403     Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC)
404 #define sv_catpvs_mg(sv, str) \
405     Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC|SV_SMAGIC)
406 #define sv_setpvs(sv, str) Perl_sv_setpvn(aTHX_ sv, STR_WITH_LEN(str))
407 #define sv_setpvs_mg(sv, str) Perl_sv_setpvn_mg(aTHX_ sv, STR_WITH_LEN(str))
408 #define sv_setref_pvs(rv, classname, str) \
409     Perl_sv_setref_pvn(aTHX_ rv, classname, STR_WITH_LEN(str))
410 #define savepvs(str) Perl_savepvn(aTHX_ STR_WITH_LEN(str))
411 #define savesharedpvs(str) Perl_savesharedpvn(aTHX_ STR_WITH_LEN(str))
412 #define gv_stashpvs(str, create) \
413     Perl_gv_stashpvn(aTHX_ STR_WITH_LEN(str), create)
414 #define gv_fetchpvs(namebeg, add, sv_type) \
415     Perl_gv_fetchpvn_flags(aTHX_ STR_WITH_LEN(namebeg), add, sv_type)
416 #define gv_fetchpvn(namebeg, len, add, sv_type) \
417     Perl_gv_fetchpvn_flags(aTHX_ namebeg, len, add, sv_type)
418 #define sv_catxmlpvs(dsv, str, utf8) \
419     Perl_sv_catxmlpvn(aTHX_ dsv, STR_WITH_LEN(str), utf8)
420
421
422 #define lex_stuff_pvs(pv,flags) Perl_lex_stuff_pvn(aTHX_ STR_WITH_LEN(pv), flags)
423
424 #define get_cvs(str, flags)                                     \
425         Perl_get_cvn_flags(aTHX_ STR_WITH_LEN(str), (flags))
426
427 /*
428 =head1 Miscellaneous Functions
429
430 =for apidoc Am|bool|strNE|char* s1|char* s2
431 Test two C<NUL>-terminated strings to see if they are different.  Returns true
432 or false.
433
434 =for apidoc Am|bool|strEQ|char* s1|char* s2
435 Test two C<NUL>-terminated strings to see if they are equal.  Returns true or
436 false.
437
438 =for apidoc Am|bool|strLT|char* s1|char* s2
439 Test two C<NUL>-terminated strings to see if the first, C<s1>, is less than the
440 second, C<s2>.  Returns true or false.
441
442 =for apidoc Am|bool|strLE|char* s1|char* s2
443 Test two C<NUL>-terminated strings to see if the first, C<s1>, is less than or
444 equal to the second, C<s2>.  Returns true or false.
445
446 =for apidoc Am|bool|strGT|char* s1|char* s2
447 Test two C<NUL>-terminated strings to see if the first, C<s1>, is greater than
448 the second, C<s2>.  Returns true or false.
449
450 =for apidoc Am|bool|strGE|char* s1|char* s2
451 Test two C<NUL>-terminated strings to see if the first, C<s1>, is greater than
452 or equal to the second, C<s2>.  Returns true or false.
453
454 =for apidoc Am|bool|strnNE|char* s1|char* s2|STRLEN len
455 Test two C<NUL>-terminated strings to see if they are different.  The C<len>
456 parameter indicates the number of bytes to compare.  Returns true or false.  (A
457 wrapper for C<strncmp>).
458
459 =for apidoc Am|bool|strnEQ|char* s1|char* s2|STRLEN len
460 Test two C<NUL>-terminated strings to see if they are equal.  The C<len>
461 parameter indicates the number of bytes to compare.  Returns true or false.  (A
462 wrapper for C<strncmp>).
463
464 =for apidoc Am|bool|memEQ|char* s1|char* s2|STRLEN len
465 Test two buffers (which may contain embedded C<NUL> characters, to see if they
466 are equal.  The C<len> parameter indicates the number of bytes to compare.
467 Returns zero if equal, or non-zero if non-equal.
468
469 =for apidoc Am|bool|memNE|char* s1|char* s2|STRLEN len
470 Test two buffers (which may contain embedded C<NUL> characters, to see if they
471 are not equal.  The C<len> parameter indicates the number of bytes to compare.
472 Returns zero if non-equal, or non-zero if equal.
473
474 =cut
475 */
476
477
478 #define strNE(s1,s2) (strcmp(s1,s2))
479 #define strEQ(s1,s2) (!strcmp(s1,s2))
480 #define strLT(s1,s2) (strcmp(s1,s2) < 0)
481 #define strLE(s1,s2) (strcmp(s1,s2) <= 0)
482 #define strGT(s1,s2) (strcmp(s1,s2) > 0)
483 #define strGE(s1,s2) (strcmp(s1,s2) >= 0)
484
485 #define strnNE(s1,s2,l) (strncmp(s1,s2,l))
486 #define strnEQ(s1,s2,l) (!strncmp(s1,s2,l))
487
488 #define strNEs(s1,s2) (strncmp(s1,"" s2 "", sizeof(s2)-1))
489 #define strEQs(s1,s2) (!strncmp(s1,"" s2 "", sizeof(s2)-1))
490
491 #ifdef HAS_MEMCMP
492 #  define memNE(s1,s2,l) (memcmp(s1,s2,l))
493 #  define memEQ(s1,s2,l) (!memcmp(s1,s2,l))
494 #else
495 #  define memNE(s1,s2,l) (bcmp(s1,s2,l))
496 #  define memEQ(s1,s2,l) (!bcmp(s1,s2,l))
497 #endif
498
499 /* memEQ and memNE where second comparand is a string constant */
500 #define memEQs(s1, l, s2) \
501         (((sizeof(s2)-1) == (l)) && memEQ((s1), ("" s2 ""), (sizeof(s2)-1)))
502 #define memNEs(s1, l, s2) !memEQs(s1, l, s2)
503
504 /* memEQ and memNE where second comparand is a string constant
505  * and we can assume the length of s1 is at least that of the string */
506 #define _memEQs(s1, s2) \
507         (memEQ((s1), ("" s2 ""), (sizeof(s2)-1)))
508 #define _memNEs(s1, s2) (memNE((s1),("" s2 ""),(sizeof(s2)-1)))
509
510 #define memLT(s1,s2,l) (memcmp(s1,s2,l) < 0)
511 #define memLE(s1,s2,l) (memcmp(s1,s2,l) <= 0)
512 #define memGT(s1,s2,l) (memcmp(s1,s2,l) > 0)
513 #define memGE(s1,s2,l) (memcmp(s1,s2,l) >= 0)
514
515 /*
516  * Character classes.
517  *
518  * Unfortunately, the introduction of locales means that we
519  * can't trust isupper(), etc. to tell the truth.  And when
520  * it comes to /\w+/ with tainting enabled, we *must* be able
521  * to trust our character classes.
522  *
523  * Therefore, the default tests in the text of Perl will be
524  * independent of locale.  Any code that wants to depend on
525  * the current locale will use the tests that begin with "lc".
526  */
527
528 #ifdef HAS_SETLOCALE  /* XXX Is there a better test for this? */
529 #  ifndef CTYPE256
530 #    define CTYPE256
531 #  endif
532 #endif
533
534 /*
535
536 =head1 Character classification
537 This section is about functions (really macros) that classify characters
538 into types, such as punctuation versus alphabetic, etc.  Most of these are
539 analogous to regular expression character classes.  (See
540 L<perlrecharclass/POSIX Character Classes>.)  There are several variants for
541 each class.  (Not all macros have all variants; each item below lists the
542 ones valid for it.)  None are affected by C<use bytes>, and only the ones
543 with C<LC> in the name are affected by the current locale.
544
545 The base function, e.g., C<isALPHA()>, takes an octet (either a C<char> or a
546 C<U8>) as input and returns a boolean as to whether or not the character
547 represented by that octet is (or on non-ASCII platforms, corresponds to) an
548 ASCII character in the named class based on platform, Unicode, and Perl rules.
549 If the input is a number that doesn't fit in an octet, FALSE is returned.
550
551 Variant C<isFOO_A> (e.g., C<isALPHA_A()>) is identical to the base function
552 with no suffix C<"_A">.  This variant is used to emphasize by its name that
553 only ASCII-range characters can return TRUE.
554
555 Variant C<isFOO_L1> imposes the Latin-1 (or EBCDIC equivlalent) character set
556 onto the platform.  That is, the code points that are ASCII are unaffected,
557 since ASCII is a subset of Latin-1.  But the non-ASCII code points are treated
558 as if they are Latin-1 characters.  For example, C<isWORDCHAR_L1()> will return
559 true when called with the code point 0xDF, which is a word character in both
560 ASCII and EBCDIC (though it represents different characters in each).
561
562 Variant C<isFOO_uvchr> is like the C<isFOO_L1> variant, but accepts any UV code
563 point as input.  If the code point is larger than 255, Unicode rules are used
564 to determine if it is in the character class.  For example,
565 C<isWORDCHAR_uvchr(0x100)> returns TRUE, since 0x100 is LATIN CAPITAL LETTER A
566 WITH MACRON in Unicode, and is a word character.
567
568 Variant C<isFOO_utf8_safe> is like C<isFOO_uvchr>, but is used for UTF-8
569 encoded strings.  Each call classifies one character, even if the string
570 contains many.  This variant takes two parameters.  The first, C<p>, is a
571 pointer to the first byte of the character to be classified.  (Recall that it
572 may take more than one byte to represent a character in UTF-8 strings.)  The
573 second parameter, C<e>, points to anywhere in the string beyond the first
574 character, up to one byte past the end of the entire string.  The suffix
575 C<_safe> in the function's name indicates that it will not attempt to read
576 beyond S<C<e - 1>>, provided that the constraint S<C<s E<lt> e>> is true (this
577 is asserted for in C<-DDEBUGGING> builds).  If the UTF-8 for the input
578 character is malformed in some way, the program may croak, or the function may
579 return FALSE, at the discretion of the implementation, and subject to change in
580 future releases.
581
582 Variant C<isFOO_utf8> is like C<isFOO_utf8_safe>, but takes just a single
583 parameter, C<p>, which has the same meaning as the corresponding parameter does
584 in C<isFOO_utf8_safe>.  The function therefore can't check if it is reading
585 beyond the end of the string.  Starting in Perl v5.30, it will take a second
586 parameter, becoming a synonym for C<isFOO_utf8_safe>.  At that time every
587 program that uses it will have to be changed to successfully compile.  In the
588 meantime, the first runtime call to C<isFOO_utf8> from each call point in the
589 program will raise a deprecation warning, enabled by default.  You can convert
590 your program now to use C<isFOO_utf8_safe>, and avoid the warnings, and get an
591 extra measure of protection, or you can wait until v5.30, when you'll be forced
592 to add the C<e> parameter.
593
594 Variant C<isFOO_LC> is like the C<isFOO_A> and C<isFOO_L1> variants, but the
595 result is based on the current locale, which is what C<LC> in the name stands
596 for.  If Perl can determine that the current locale is a UTF-8 locale, it uses
597 the published Unicode rules; otherwise, it uses the C library function that
598 gives the named classification.  For example, C<isDIGIT_LC()> when not in a
599 UTF-8 locale returns the result of calling C<isdigit()>.  FALSE is always
600 returned if the input won't fit into an octet.  On some platforms where the C
601 library function is known to be defective, Perl changes its result to follow
602 the POSIX standard's rules.
603
604 Variant C<isFOO_LC_uvchr> is like C<isFOO_LC>, but is defined on any UV.  It
605 returns the same as C<isFOO_LC> for input code points less than 256, and
606 returns the hard-coded, not-affected-by-locale, Unicode results for larger ones.
607
608 Variant C<isFOO_LC_utf8_safe> is like C<isFOO_LC_uvchr>, but is used for UTF-8
609 encoded strings.  Each call classifies one character, even if the string
610 contains many.  This variant takes two parameters.  The first, C<p>, is a
611 pointer to the first byte of the character to be classified.  (Recall that it
612 may take more than one byte to represent a character in UTF-8 strings.) The
613 second parameter, C<e>, points to anywhere in the string beyond the first
614 character, up to one byte past the end of the entire string.  The suffix
615 C<_safe> in the function's name indicates that it will not attempt to read
616 beyond S<C<e - 1>>, provided that the constraint S<C<s E<lt> e>> is true (this
617 is asserted for in C<-DDEBUGGING> builds).  If the UTF-8 for the input
618 character is malformed in some way, the program may croak, or the function may
619 return FALSE, at the discretion of the implementation, and subject to change in
620 future releases.
621
622 Variant C<isFOO_LC_utf8> is like C<isFOO_LC_utf8_safe>, but takes just a single
623 parameter, C<p>, which has the same meaning as the corresponding parameter does
624 in C<isFOO_LC_utf8_safe>.  The function therefore can't check if it is reading
625 beyond the end of the string.  Starting in Perl v5.30, it will take a second
626 parameter, becoming a synonym for C<isFOO_LC_utf8_safe>.  At that time every
627 program that uses it will have to be changed to successfully compile.  In the
628 meantime, the first runtime call to C<isFOO_LC_utf8> from each call point in
629 the program will raise a deprecation warning, enabled by default.  You can
630 convert your program now to use C<isFOO_LC_utf8_safe>, and avoid the warnings,
631 and get an extra measure of protection, or you can wait until v5.30, when
632 you'll be forced to add the C<e> parameter.
633
634 =for apidoc Am|bool|isALPHA|char ch
635 Returns a boolean indicating whether the specified character is an
636 alphabetic character, analogous to C<m/[[:alpha:]]/>.
637 See the L<top of this section|/Character classification> for an explanation of
638 variants
639 C<isALPHA_A>, C<isALPHA_L1>, C<isALPHA_uvchr>, C<isALPHA_utf8_safe>,
640 C<isALPHA_LC>, C<isALPHA_LC_uvchr>, and C<isALPHA_LC_utf8_safe>.
641
642 =for apidoc Am|bool|isALPHANUMERIC|char ch
643 Returns a boolean indicating whether the specified character is a either an
644 alphabetic character or decimal digit, analogous to C<m/[[:alnum:]]/>.
645 See the L<top of this section|/Character classification> for an explanation of
646 variants
647 C<isALPHANUMERIC_A>, C<isALPHANUMERIC_L1>, C<isALPHANUMERIC_uvchr>,
648 C<isALPHANUMERIC_utf8_safe>, C<isALPHANUMERIC_LC>, C<isALPHANUMERIC_LC_uvchr>,
649 and C<isALPHANUMERIC_LC_utf8_safe>.
650
651 =for apidoc Am|bool|isASCII|char ch
652 Returns a boolean indicating whether the specified character is one of the 128
653 characters in the ASCII character set, analogous to C<m/[[:ascii:]]/>.
654 On non-ASCII platforms, it returns TRUE iff this
655 character corresponds to an ASCII character.  Variants C<isASCII_A()> and
656 C<isASCII_L1()> are identical to C<isASCII()>.
657 See the L<top of this section|/Character classification> for an explanation of
658 variants
659 C<isASCII_uvchr>, C<isASCII_utf8_safe>, C<isASCII_LC>, C<isASCII_LC_uvchr>, and
660 C<isASCII_LC_utf8_safe>.  Note, however, that some platforms do not have the C
661 library routine C<isascii()>.  In these cases, the variants whose names contain
662 C<LC> are the same as the corresponding ones without.
663
664 Also note, that because all ASCII characters are UTF-8 invariant (meaning they
665 have the exact same representation (always a single byte) whether encoded in
666 UTF-8 or not), C<isASCII> will give the correct results when called with any
667 byte in any string encoded or not in UTF-8.  And similarly C<isASCII_utf8_safe>
668 will work properly on any string encoded or not in UTF-8.
669
670 =for apidoc Am|bool|isBLANK|char ch
671 Returns a boolean indicating whether the specified character is a
672 character considered to be a blank, analogous to C<m/[[:blank:]]/>.
673 See the L<top of this section|/Character classification> for an explanation of
674 variants
675 C<isBLANK_A>, C<isBLANK_L1>, C<isBLANK_uvchr>, C<isBLANK_utf8_safe>,
676 C<isBLANK_LC>, C<isBLANK_LC_uvchr>, and C<isBLANK_LC_utf8_safe>.  Note,
677 however, that some platforms do not have the C library routine
678 C<isblank()>.  In these cases, the variants whose names contain C<LC> are
679 the same as the corresponding ones without.
680
681 =for apidoc Am|bool|isCNTRL|char ch
682 Returns a boolean indicating whether the specified character is a
683 control character, analogous to C<m/[[:cntrl:]]/>.
684 See the L<top of this section|/Character classification> for an explanation of
685 variants
686 C<isCNTRL_A>, C<isCNTRL_L1>, C<isCNTRL_uvchr>, C<isCNTRL_utf8_safe>,
687 C<isCNTRL_LC>, C<isCNTRL_LC_uvchr>, and C<isCNTRL_LC_utf8_safe> On EBCDIC
688 platforms, you almost always want to use the C<isCNTRL_L1> variant.
689
690 =for apidoc Am|bool|isDIGIT|char ch
691 Returns a boolean indicating whether the specified character is a
692 digit, analogous to C<m/[[:digit:]]/>.
693 Variants C<isDIGIT_A> and C<isDIGIT_L1> are identical to C<isDIGIT>.
694 See the L<top of this section|/Character classification> for an explanation of
695 variants
696 C<isDIGIT_uvchr>, C<isDIGIT_utf8_safe>, C<isDIGIT_LC>, C<isDIGIT_LC_uvchr>, and
697 C<isDIGIT_LC_utf8_safe>.
698
699 =for apidoc Am|bool|isGRAPH|char ch
700 Returns a boolean indicating whether the specified character is a
701 graphic character, analogous to C<m/[[:graph:]]/>.
702 See the L<top of this section|/Character classification> for an explanation of
703 variants C<isGRAPH_A>, C<isGRAPH_L1>, C<isGRAPH_uvchr>, C<isGRAPH_utf8_safe>,
704 C<isGRAPH_LC>, C<isGRAPH_LC_uvchr>, and C<isGRAPH_LC_utf8_safe>.
705
706 =for apidoc Am|bool|isLOWER|char ch
707 Returns a boolean indicating whether the specified character is a
708 lowercase character, analogous to C<m/[[:lower:]]/>.
709 See the L<top of this section|/Character classification> for an explanation of
710 variants
711 C<isLOWER_A>, C<isLOWER_L1>, C<isLOWER_uvchr>, C<isLOWER_utf8_safe>,
712 C<isLOWER_LC>, C<isLOWER_LC_uvchr>, and C<isLOWER_LC_utf8_safe>.
713
714 =for apidoc Am|bool|isOCTAL|char ch
715 Returns a boolean indicating whether the specified character is an
716 octal digit, [0-7].
717 The only two variants are C<isOCTAL_A> and C<isOCTAL_L1>; each is identical to
718 C<isOCTAL>.
719
720 =for apidoc Am|bool|isPUNCT|char ch
721 Returns a boolean indicating whether the specified character is a
722 punctuation character, analogous to C<m/[[:punct:]]/>.
723 Note that the definition of what is punctuation isn't as
724 straightforward as one might desire.  See L<perlrecharclass/POSIX Character
725 Classes> for details.
726 See the L<top of this section|/Character classification> for an explanation of
727 variants C<isPUNCT_A>, C<isPUNCT_L1>, C<isPUNCT_uvchr>, C<isPUNCT_utf8_safe>,
728 C<isPUNCT_LC>, C<isPUNCT_LC_uvchr>, and C<isPUNCT_LC_utf8_safe>.
729
730 =for apidoc Am|bool|isSPACE|char ch
731 Returns a boolean indicating whether the specified character is a
732 whitespace character.  This is analogous
733 to what C<m/\s/> matches in a regular expression.  Starting in Perl 5.18
734 this also matches what C<m/[[:space:]]/> does.  Prior to 5.18, only the
735 locale forms of this macro (the ones with C<LC> in their names) matched
736 precisely what C<m/[[:space:]]/> does.  In those releases, the only difference,
737 in the non-locale variants, was that C<isSPACE()> did not match a vertical tab.
738 (See L</isPSXSPC> for a macro that matches a vertical tab in all releases.)
739 See the L<top of this section|/Character classification> for an explanation of
740 variants
741 C<isSPACE_A>, C<isSPACE_L1>, C<isSPACE_uvchr>, C<isSPACE_utf8_safe>,
742 C<isSPACE_LC>, C<isSPACE_LC_uvchr>, and C<isSPACE_LC_utf8_safe>.
743
744 =for apidoc Am|bool|isPSXSPC|char ch
745 (short for Posix Space)
746 Starting in 5.18, this is identical in all its forms to the
747 corresponding C<isSPACE()> macros.
748 The locale forms of this macro are identical to their corresponding
749 C<isSPACE()> forms in all Perl releases.  In releases prior to 5.18, the
750 non-locale forms differ from their C<isSPACE()> forms only in that the
751 C<isSPACE()> forms don't match a Vertical Tab, and the C<isPSXSPC()> forms do.
752 Otherwise they are identical.  Thus this macro is analogous to what
753 C<m/[[:space:]]/> matches in a regular expression.
754 See the L<top of this section|/Character classification> for an explanation of
755 variants C<isPSXSPC_A>, C<isPSXSPC_L1>, C<isPSXSPC_uvchr>, C<isPSXSPC_utf8_safe>,
756 C<isPSXSPC_LC>, C<isPSXSPC_LC_uvchr>, and C<isPSXSPC_LC_utf8_safe>.
757
758 =for apidoc Am|bool|isUPPER|char ch
759 Returns a boolean indicating whether the specified character is an
760 uppercase character, analogous to C<m/[[:upper:]]/>.
761 See the L<top of this section|/Character classification> for an explanation of
762 variants C<isUPPER_A>, C<isUPPER_L1>, C<isUPPER_uvchr>, C<isUPPER_utf8_safe>,
763 C<isUPPER_LC>, C<isUPPER_LC_uvchr>, and C<isUPPER_LC_utf8_safe>.
764
765 =for apidoc Am|bool|isPRINT|char ch
766 Returns a boolean indicating whether the specified character is a
767 printable character, analogous to C<m/[[:print:]]/>.
768 See the L<top of this section|/Character classification> for an explanation of
769 variants
770 C<isPRINT_A>, C<isPRINT_L1>, C<isPRINT_uvchr>, C<isPRINT_utf8_safe>,
771 C<isPRINT_LC>, C<isPRINT_LC_uvchr>, and C<isPRINT_LC_utf8_safe>.
772
773 =for apidoc Am|bool|isWORDCHAR|char ch
774 Returns a boolean indicating whether the specified character is a character
775 that is a word character, analogous to what C<m/\w/> and C<m/[[:word:]]/> match
776 in a regular expression.  A word character is an alphabetic character, a
777 decimal digit, a connecting punctuation character (such as an underscore), or
778 a "mark" character that attaches to one of those (like some sort of accent).
779 C<isALNUM()> is a synonym provided for backward compatibility, even though a
780 word character includes more than the standard C language meaning of
781 alphanumeric.
782 See the L<top of this section|/Character classification> for an explanation of
783 variants C<isWORDCHAR_A>, C<isWORDCHAR_L1>, C<isWORDCHAR_uvchr>, and
784 C<isWORDCHAR_utf8_safe>.  C<isWORDCHAR_LC>, C<isWORDCHAR_LC_uvchr>, and
785 C<isWORDCHAR_LC_utf8_safe> are also as described there, but additionally
786 include the platform's native underscore.
787
788 =for apidoc Am|bool|isXDIGIT|char ch
789 Returns a boolean indicating whether the specified character is a hexadecimal
790 digit.  In the ASCII range these are C<[0-9A-Fa-f]>.  Variants C<isXDIGIT_A()>
791 and C<isXDIGIT_L1()> are identical to C<isXDIGIT()>.
792 See the L<top of this section|/Character classification> for an explanation of
793 variants
794 C<isXDIGIT_uvchr>, C<isXDIGIT_utf8_safe>, C<isXDIGIT_LC>, C<isXDIGIT_LC_uvchr>,
795 and C<isXDIGIT_LC_utf8_safe>.
796
797 =for apidoc Am|bool|isIDFIRST|char ch
798 Returns a boolean indicating whether the specified character can be the first
799 character of an identifier.  This is very close to, but not quite the same as
800 the official Unicode property C<XID_Start>.  The difference is that this
801 returns true only if the input character also matches L</isWORDCHAR>.
802 See the L<top of this section|/Character classification> for an explanation of
803 variants
804 C<isIDFIRST_A>, C<isIDFIRST_L1>, C<isIDFIRST_uvchr>, C<isIDFIRST_utf8_safe>,
805 C<isIDFIRST_LC>, C<isIDFIRST_LC_uvchr>, and C<isIDFIRST_LC_utf8_safe>.
806
807 =for apidoc Am|bool|isIDCONT|char ch
808 Returns a boolean indicating whether the specified character can be the
809 second or succeeding character of an identifier.  This is very close to, but
810 not quite the same as the official Unicode property C<XID_Continue>.  The
811 difference is that this returns true only if the input character also matches
812 L</isWORDCHAR>.  See the L<top of this section|/Character classification> for
813 an
814 explanation of variants C<isIDCONT_A>, C<isIDCONT_L1>, C<isIDCONT_uvchr>,
815 C<isIDCONT_utf8_safe>, C<isIDCONT_LC>, C<isIDCONT_LC_uvchr>, and
816 C<isIDCONT_LC_utf8_safe>.
817
818 =head1 Miscellaneous Functions
819
820 =for apidoc Am|U8|READ_XDIGIT|char str*
821 Returns the value of an ASCII-range hex digit and advances the string pointer.
822 Behaviour is only well defined when isXDIGIT(*str) is true.
823
824 =head1 Character case changing
825 Perl uses "full" Unicode case mappings.  This means that converting a single
826 character to another case may result in a sequence of more than one character.
827 For example, the uppercase of C<E<223>> (LATIN SMALL LETTER SHARP S) is the two
828 character sequence C<SS>.  This presents some complications   The lowercase of
829 all characters in the range 0..255 is a single character, and thus
830 C<L</toLOWER_L1>> is furnished.  But, C<toUPPER_L1> can't exist, as it couldn't
831 return a valid result for all legal inputs.  Instead C<L</toUPPER_uvchr>> has
832 an API that does allow every possible legal result to be returned.)  Likewise
833 no other function that is crippled by not being able to give the correct
834 results for the full range of possible inputs has been implemented here.
835
836 =for apidoc Am|U8|toUPPER|U8 ch
837 Converts the specified character to uppercase.  If the input is anything but an
838 ASCII lowercase character, that input character itself is returned.  Variant
839 C<toUPPER_A> is equivalent.
840
841 =for apidoc Am|UV|toUPPER_uvchr|UV cp|U8* s|STRLEN* lenp
842 Converts the code point C<cp> to its uppercase version, and
843 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>.  The code
844 point is interpreted as native if less than 256; otherwise as Unicode.  Note
845 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
846 bytes since the uppercase version may be longer than the original character.
847
848 The first code point of the uppercased version is returned
849 (but note, as explained at L<the top of this section|/Character case
850 changing>, that there may be more.)
851
852 =for apidoc Am|UV|toUPPER_utf8|U8* p|U8* s|STRLEN* lenp
853 Converts the UTF-8 encoded character at C<p> to its uppercase version, and
854 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>.  Note
855 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
856 bytes since the uppercase version may be longer than the original character.
857
858 The first code point of the uppercased version is returned
859 (but note, as explained at L<the top of this section|/Character case
860 changing>, that there may be more).
861
862 The input character at C<p> is assumed to be well-formed.
863
864 =for apidoc Am|U8|toFOLD|U8 ch
865 Converts the specified character to foldcase.  If the input is anything but an
866 ASCII uppercase character, that input character itself is returned.  Variant
867 C<toFOLD_A> is equivalent.  (There is no equivalent C<to_FOLD_L1> for the full
868 Latin1 range, as the full generality of L</toFOLD_uvchr> is needed there.)
869
870 =for apidoc Am|UV|toFOLD_uvchr|UV cp|U8* s|STRLEN* lenp
871 Converts the code point C<cp> to its foldcase version, and
872 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>.  The code
873 point is interpreted as native if less than 256; otherwise as Unicode.  Note
874 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
875 bytes since the foldcase version may be longer than the original character.
876
877 The first code point of the foldcased version is returned
878 (but note, as explained at L<the top of this section|/Character case
879 changing>, that there may be more).
880
881 =for apidoc Am|UV|toFOLD_utf8|U8* p|U8* s|STRLEN* lenp
882 Converts the UTF-8 encoded character at C<p> to its foldcase version, and
883 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>.  Note
884 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
885 bytes since the foldcase version may be longer than the original character.
886
887 The first code point of the foldcased version is returned
888 (but note, as explained at L<the top of this section|/Character case
889 changing>, that there may be more).
890
891 The input character at C<p> is assumed to be well-formed.
892
893 =for apidoc Am|U8|toLOWER|U8 ch
894 Converts the specified character to lowercase.  If the input is anything but an
895 ASCII uppercase character, that input character itself is returned.  Variant
896 C<toLOWER_A> is equivalent.
897
898 =for apidoc Am|U8|toLOWER_L1|U8 ch
899 Converts the specified Latin1 character to lowercase.  The results are
900 undefined if the input doesn't fit in a byte.
901
902 =for apidoc Am|U8|toLOWER_LC|U8 ch
903 Converts the specified character to lowercase using the current locale's rules,
904 if possible; otherwise returns the input character itself.
905
906 =for apidoc Am|UV|toLOWER_uvchr|UV cp|U8* s|STRLEN* lenp
907 Converts the code point C<cp> to its lowercase version, and
908 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>.  The code
909 point is interpreted as native if less than 256; otherwise as Unicode.  Note
910 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
911 bytes since the lowercase version may be longer than the original character.
912
913 The first code point of the lowercased version is returned
914 (but note, as explained at L<the top of this section|/Character case
915 changing>, that there may be more).
916
917 =for apidoc Am|UV|toLOWER_utf8|U8* p|U8* s|STRLEN* lenp
918 Converts the UTF-8 encoded character at C<p> to its lowercase version, and
919 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>.  Note
920 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
921 bytes since the lowercase version may be longer than the original character.
922
923 The first code point of the lowercased version is returned
924 (but note, as explained at L<the top of this section|/Character case
925 changing>, that there may be more).
926
927 The input character at C<p> is assumed to be well-formed.
928
929 =for apidoc Am|U8|toTITLE|U8 ch
930 Converts the specified character to titlecase.  If the input is anything but an
931 ASCII lowercase character, that input character itself is returned.  Variant
932 C<toTITLE_A> is equivalent.  (There is no C<toTITLE_L1> for the full Latin1
933 range, as the full generality of L</toTITLE_uvchr> is needed there.  Titlecase is
934 not a concept used in locale handling, so there is no functionality for that.)
935
936 =for apidoc Am|UV|toTITLE_uvchr|UV cp|U8* s|STRLEN* lenp
937 Converts the code point C<cp> to its titlecase version, and
938 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>.  The code
939 point is interpreted as native if less than 256; otherwise as Unicode.  Note
940 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
941 bytes since the titlecase version may be longer than the original character.
942
943 The first code point of the titlecased version is returned
944 (but note, as explained at L<the top of this section|/Character case
945 changing>, that there may be more).
946
947 =for apidoc Am|UV|toTITLE_utf8|U8* p|U8* s|STRLEN* lenp
948 Converts the UTF-8 encoded character at C<p> to its titlecase version, and
949 stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>.  Note
950 that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
951 bytes since the titlecase version may be longer than the original character.
952
953 The first code point of the titlecased version is returned
954 (but note, as explained at L<the top of this section|/Character case
955 changing>, that there may be more).
956
957 The input character at C<p> is assumed to be well-formed.
958
959 =cut
960
961 XXX Still undocumented isVERTWS_uvchr and _utf8; it's unclear what their names
962 really should be.  Also toUPPER_LC and toFOLD_LC, which are subject to change.
963
964 Note that these macros are repeated in Devel::PPPort, so should also be
965 patched there.  The file as of this writing is cpan/Devel-PPPort/parts/inc/misc
966
967 */
968
969 /* Specify the widest unsigned type on the platform.  Use U64TYPE because U64
970  * is known only in the perl core, and this macro can be called from outside
971  * that */
972 #ifdef HAS_QUAD
973 #   define WIDEST_UTYPE U64TYPE
974 #else
975 #   define WIDEST_UTYPE U32
976 #endif
977
978 /* FITS_IN_8_BITS(c) returns true if c doesn't have  a bit set other than in
979  * the lower 8.  It is designed to be hopefully bomb-proof, making sure that no
980  * bits of information are lost even on a 64-bit machine, but to get the
981  * compiler to optimize it out if possible.  This is because Configure makes
982  * sure that the machine has an 8-bit byte, so if c is stored in a byte, the
983  * sizeof() guarantees that this evaluates to a constant true at compile time.
984  *
985  * For Coverity, be always true, because otherwise Coverity thinks
986  * it finds several expressions that are always true, independent
987  * of operands.  Well, they are, but that is kind of the point.
988  */
989 #ifndef __COVERITY__
990   /* The '| 0' part ensures a compiler error if c is not integer (like e.g., a
991    * pointer) */
992 #define FITS_IN_8_BITS(c) (   (sizeof(c) == 1)                      \
993                            || !(((WIDEST_UTYPE)((c) | 0)) & ~0xFF))
994 #else
995 #define FITS_IN_8_BITS(c) (1)
996 #endif
997
998 #ifdef EBCDIC
999 #   ifndef _ALL_SOURCE
1000         /* The native libc isascii() et.al. functions return the wrong results
1001          * on at least z/OS unless this is defined. */
1002 #       error   _ALL_SOURCE should probably be defined
1003 #   endif
1004 #else
1005     /* There is a simple definition of ASCII for ASCII platforms.  But the
1006      * EBCDIC one isn't so simple, so is defined using table look-up like the
1007      * other macros below.
1008      *
1009      * The cast here is used instead of '(c) >= 0', because some compilers emit
1010      * a warning that that test is always true when the parameter is an
1011      * unsigned type.  khw supposes that it could be written as
1012      *      && ((c) == '\0' || (c) > 0)
1013      * to avoid the message, but the cast will likely avoid extra branches even
1014      * with stupid compilers.
1015      *
1016      * The '| 0' part ensures a compiler error if c is not integer (like e.g.,
1017      * a pointer) */
1018 #   define isASCII(c)    ((WIDEST_UTYPE)((c) | 0) < 128)
1019 #endif
1020
1021 /* Take the eight possible bit patterns of the lower 3 bits and you get the
1022  * lower 3 bits of the 8 octal digits, in both ASCII and EBCDIC, so those bits
1023  * can be ignored.  If the rest match '0', we have an octal */
1024 #define isOCTAL_A(c)  (((WIDEST_UTYPE)((c) | 0) & ~7) == '0')
1025
1026 #ifdef H_PERL       /* If have access to perl.h, lookup in its table */
1027
1028 /* Character class numbers.  For internal core Perl use only.  The ones less
1029  * than 32 are used in PL_charclass[] and the ones up through the one that
1030  * corresponds to <_HIGHEST_REGCOMP_DOT_H_SYNC> are used by regcomp.h and
1031  * related files.  PL_charclass ones use names used in l1_char_class_tab.h but
1032  * their actual definitions are here.  If that file has a name not used here,
1033  * it won't compile.
1034  *
1035  * The first group of these is ordered in what I (khw) estimate to be the
1036  * frequency of their use.  This gives a slight edge to exiting a loop earlier
1037  * (in reginclass() in regexec.c) */
1038 #  define _CC_WORDCHAR           0      /* \w and [:word:] */
1039 #  define _CC_DIGIT              1      /* \d and [:digit:] */
1040 #  define _CC_ALPHA              2      /* [:alpha:] */
1041 #  define _CC_LOWER              3      /* [:lower:] */
1042 #  define _CC_UPPER              4      /* [:upper:] */
1043 #  define _CC_PUNCT              5      /* [:punct:] */
1044 #  define _CC_PRINT              6      /* [:print:] */
1045 #  define _CC_ALPHANUMERIC       7      /* [:alnum:] */
1046 #  define _CC_GRAPH              8      /* [:graph:] */
1047 #  define _CC_CASED              9      /* [:lower:] or [:upper:] under /i */
1048
1049 #define _FIRST_NON_SWASH_CC     10
1050 /* The character classes above are implemented with swashes.  The second group
1051  * (just below) contains the ones implemented without.  These are also sorted
1052  * in rough order of the frequency of their use, except that \v should be last,
1053  * as it isn't a real Posix character class, and some (small) inefficiencies in
1054  * regular expression handling would be introduced by putting it in the middle
1055  * of those that are.  Also, cntrl and ascii come after the others as it may be
1056  * useful to group these which have no members that match above Latin1, (or
1057  * above ASCII in the latter case) */
1058
1059 #  define _CC_SPACE             10      /* \s, [:space:] */
1060 #  define _CC_PSXSPC            _CC_SPACE   /* XXX Temporary, can be removed
1061                                                when the deprecated isFOO_utf8()
1062                                                functions are removed */
1063 #  define _CC_BLANK             11      /* [:blank:] */
1064 #  define _CC_XDIGIT            12      /* [:xdigit:] */
1065 #  define _CC_CNTRL             13      /* [:cntrl:] */
1066 #  define _CC_ASCII             14      /* [:ascii:] */
1067 #  define _CC_VERTSPACE         15      /* \v */
1068
1069 #  define _HIGHEST_REGCOMP_DOT_H_SYNC _CC_VERTSPACE
1070
1071 /* The members of the third group below do not need to be coordinated with data
1072  * structures in regcomp.[ch] and regexec.c. */
1073 #  define _CC_IDFIRST                  16
1074 #  define _CC_CHARNAME_CONT            17
1075 #  define _CC_NONLATIN1_FOLD           18
1076 #  define _CC_NONLATIN1_SIMPLE_FOLD    19
1077 #  define _CC_QUOTEMETA                20
1078 #  define _CC_NON_FINAL_FOLD           21
1079 #  define _CC_IS_IN_SOME_FOLD          22
1080 #  define _CC_MNEMONIC_CNTRL           23
1081
1082 #  define _CC_IDCONT 24 /* XXX Temporary, can be removed when the deprecated
1083                            isFOO_utf8() functions are removed */
1084
1085 /* This next group is only used on EBCDIC platforms, so theoretically could be
1086  * shared with something entirely different that's only on ASCII platforms */
1087 #  define _CC_UTF8_START_BYTE_IS_FOR_AT_LEAST_SURROGATE 28
1088 #  define _CC_UTF8_IS_START                             29
1089 #  define _CC_UTF8_IS_DOWNGRADEABLE_START               30
1090 #  define _CC_UTF8_IS_CONTINUATION                      31
1091 /* Unused: 24-27
1092  * If more bits are needed, one could add a second word for non-64bit
1093  * QUAD_IS_INT systems, using some #ifdefs to distinguish between having a 2nd
1094  * word or not.  The IS_IN_SOME_FOLD bit is the most easily expendable, as it
1095  * is used only for optimization (as of this writing), and differs in the
1096  * Latin1 range from the ALPHA bit only in two relatively unimportant
1097  * characters: the masculine and feminine ordinal indicators, so removing it
1098  * would just cause /i regexes which match them to run less efficiently.
1099  * Similarly the EBCDIC-only bits are used just for speed, and could be
1100  * replaced by other means */
1101
1102 #if defined(PERL_CORE) || defined(PERL_EXT)
1103 /* An enum version of the character class numbers, to help compilers
1104  * optimize */
1105 typedef enum {
1106     _CC_ENUM_ALPHA          = _CC_ALPHA,
1107     _CC_ENUM_ALPHANUMERIC   = _CC_ALPHANUMERIC,
1108     _CC_ENUM_ASCII          = _CC_ASCII,
1109     _CC_ENUM_BLANK          = _CC_BLANK,
1110     _CC_ENUM_CASED          = _CC_CASED,
1111     _CC_ENUM_CNTRL          = _CC_CNTRL,
1112     _CC_ENUM_DIGIT          = _CC_DIGIT,
1113     _CC_ENUM_GRAPH          = _CC_GRAPH,
1114     _CC_ENUM_LOWER          = _CC_LOWER,
1115     _CC_ENUM_PRINT          = _CC_PRINT,
1116     _CC_ENUM_PUNCT          = _CC_PUNCT,
1117     _CC_ENUM_SPACE          = _CC_SPACE,
1118     _CC_ENUM_UPPER          = _CC_UPPER,
1119     _CC_ENUM_VERTSPACE      = _CC_VERTSPACE,
1120     _CC_ENUM_WORDCHAR       = _CC_WORDCHAR,
1121     _CC_ENUM_XDIGIT         = _CC_XDIGIT
1122 } _char_class_number;
1123 #endif
1124
1125 #define POSIX_SWASH_COUNT _FIRST_NON_SWASH_CC
1126 #define POSIX_CC_COUNT    (_HIGHEST_REGCOMP_DOT_H_SYNC + 1)
1127
1128 #if defined(PERL_IN_UTF8_C)                         \
1129  || defined(PERL_IN_REGCOMP_C)                      \
1130  || defined(PERL_IN_REGEXEC_C)
1131 #   if _CC_WORDCHAR != 0 || _CC_DIGIT != 1 || _CC_ALPHA != 2 || _CC_LOWER != 3 \
1132        || _CC_UPPER != 4 || _CC_PUNCT != 5 || _CC_PRINT != 6                   \
1133        || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8 || _CC_CASED != 9
1134       #error Need to adjust order of swash_property_names[]
1135 #   endif
1136
1137 /* This is declared static in each of the few files that this is #defined for
1138  * to keep them from being publicly accessible.  Hence there is a small amount
1139  * of wasted space */
1140
1141 static const char* const swash_property_names[] = {
1142     "XPosixWord",
1143     "XPosixDigit",
1144     "XPosixAlpha",
1145     "XPosixLower",
1146     "XPosixUpper",
1147     "XPosixPunct",
1148     "XPosixPrint",
1149     "XPosixAlnum",
1150     "XPosixGraph",
1151     "Cased"
1152 };
1153 #endif
1154
1155 START_EXTERN_C
1156 #  ifdef DOINIT
1157 EXTCONST  U32 PL_charclass[] = {
1158 #    include "l1_char_class_tab.h"
1159 };
1160
1161 #  else /* ! DOINIT */
1162 EXTCONST U32 PL_charclass[];
1163 #  endif
1164 END_EXTERN_C
1165
1166     /* The 1U keeps Solaris from griping when shifting sets the uppermost bit */
1167 #   define _CC_mask(classnum) (1U << (classnum))
1168
1169     /* For internal core Perl use only: the base macro for defining macros like
1170      * isALPHA */
1171 #   define _generic_isCC(c, classnum) cBOOL(FITS_IN_8_BITS(c)    \
1172                 && (PL_charclass[(U8) (c)] & _CC_mask(classnum)))
1173
1174     /* The mask for the _A versions of the macros; it just adds in the bit for
1175      * ASCII. */
1176 #   define _CC_mask_A(classnum) (_CC_mask(classnum) | _CC_mask(_CC_ASCII))
1177
1178     /* For internal core Perl use only: the base macro for defining macros like
1179      * isALPHA_A.  The foo_A version makes sure that both the desired bit and
1180      * the ASCII bit are present */
1181 #   define _generic_isCC_A(c, classnum) (FITS_IN_8_BITS(c)      \
1182         && ((PL_charclass[(U8) (c)] & _CC_mask_A(classnum))     \
1183                                    == _CC_mask_A(classnum)))
1184
1185 #   define isALPHA_A(c)  _generic_isCC_A(c, _CC_ALPHA)
1186 #   define isALPHANUMERIC_A(c) _generic_isCC_A(c, _CC_ALPHANUMERIC)
1187 #   define isBLANK_A(c)  _generic_isCC_A(c, _CC_BLANK)
1188 #   define isCNTRL_A(c)  _generic_isCC_A(c, _CC_CNTRL)
1189 #   define isDIGIT_A(c)  _generic_isCC(c, _CC_DIGIT) /* No non-ASCII digits */
1190 #   define isGRAPH_A(c)  _generic_isCC_A(c, _CC_GRAPH)
1191 #   define isLOWER_A(c)  _generic_isCC_A(c, _CC_LOWER)
1192 #   define isPRINT_A(c)  _generic_isCC_A(c, _CC_PRINT)
1193 #   define isPUNCT_A(c)  _generic_isCC_A(c, _CC_PUNCT)
1194 #   define isSPACE_A(c)  _generic_isCC_A(c, _CC_SPACE)
1195 #   define isUPPER_A(c)  _generic_isCC_A(c, _CC_UPPER)
1196 #   define isWORDCHAR_A(c) _generic_isCC_A(c, _CC_WORDCHAR)
1197 #   define isXDIGIT_A(c)  _generic_isCC(c, _CC_XDIGIT) /* No non-ASCII xdigits
1198                                                         */
1199 #   define isIDFIRST_A(c) _generic_isCC_A(c, _CC_IDFIRST)
1200 #   define isALPHA_L1(c)  _generic_isCC(c, _CC_ALPHA)
1201 #   define isALPHANUMERIC_L1(c) _generic_isCC(c, _CC_ALPHANUMERIC)
1202 #   define isBLANK_L1(c)  _generic_isCC(c, _CC_BLANK)
1203
1204     /* continuation character for legal NAME in \N{NAME} */
1205 #   define isCHARNAME_CONT(c) _generic_isCC(c, _CC_CHARNAME_CONT)
1206
1207 #   define isCNTRL_L1(c)  _generic_isCC(c, _CC_CNTRL)
1208 #   define isGRAPH_L1(c)  _generic_isCC(c, _CC_GRAPH)
1209 #   define isLOWER_L1(c)  _generic_isCC(c, _CC_LOWER)
1210 #   define isPRINT_L1(c)  _generic_isCC(c, _CC_PRINT)
1211 #   define isPSXSPC_L1(c)  isSPACE_L1(c)
1212 #   define isPUNCT_L1(c)  _generic_isCC(c, _CC_PUNCT)
1213 #   define isSPACE_L1(c)  _generic_isCC(c, _CC_SPACE)
1214 #   define isUPPER_L1(c)  _generic_isCC(c, _CC_UPPER)
1215 #   define isWORDCHAR_L1(c) _generic_isCC(c, _CC_WORDCHAR)
1216 #   define isIDFIRST_L1(c) _generic_isCC(c, _CC_IDFIRST)
1217
1218 #   ifdef EBCDIC
1219 #       define isASCII(c) _generic_isCC(c, _CC_ASCII)
1220 #   endif
1221
1222     /* Participates in a single-character fold with a character above 255 */
1223 #   define _HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(c) ((! cBOOL(FITS_IN_8_BITS(c))) || (PL_charclass[(U8) (c)] & _CC_mask(_CC_NONLATIN1_SIMPLE_FOLD)))
1224
1225     /* Like the above, but also can be part of a multi-char fold */
1226 #   define _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(c) ((! cBOOL(FITS_IN_8_BITS(c))) || (PL_charclass[(U8) (c)] & _CC_mask(_CC_NONLATIN1_FOLD)))
1227
1228 #   define _isQUOTEMETA(c) _generic_isCC(c, _CC_QUOTEMETA)
1229 #   define _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \
1230                                            _generic_isCC(c, _CC_NON_FINAL_FOLD)
1231 #   define _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \
1232                                            _generic_isCC(c, _CC_IS_IN_SOME_FOLD)
1233 #   define _IS_MNEMONIC_CNTRL_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \
1234                                             _generic_isCC(c, _CC_MNEMONIC_CNTRL)
1235 #else   /* else we don't have perl.h H_PERL */
1236
1237     /* If we don't have perl.h, we are compiling a utility program.  Below we
1238      * hard-code various macro definitions that wouldn't otherwise be available
1239      * to it. Most are coded based on first principles.  These are written to
1240      * avoid EBCDIC vs. ASCII #ifdef's as much as possible. */
1241 #   define isDIGIT_A(c)  ((c) <= '9' && (c) >= '0')
1242 #   define isBLANK_A(c)  ((c) == ' ' || (c) == '\t')
1243 #   define isSPACE_A(c)  (isBLANK_A(c)                                   \
1244                           || (c) == '\n'                                 \
1245                           || (c) == '\r'                                 \
1246                           || (c) == '\v'                                 \
1247                           || (c) == '\f')
1248     /* On EBCDIC, there are gaps between 'i' and 'j'; 'r' and 's'.  Same for
1249      * uppercase.  The tests for those aren't necessary on ASCII, but hurt only
1250      * performance (if optimization isn't on), and allow the same code to be
1251      * used for both platform types */
1252 #   define isLOWER_A(c)  ((c) >= 'a' && (c) <= 'z'                      \
1253                   && (    (c) <= 'i'                                    \
1254                       || ((c) >= 'j' && (c) <= 'r')                     \
1255                       ||  (c) >= 's'))
1256 #   define isUPPER_A(c)  ((c) >= 'A' && (c) <= 'Z'                      \
1257                   && (    (c) <= 'I'                                    \
1258                       || ((c) >= 'J' && (c) <= 'R')                     \
1259                       ||  (c) >= 'S'))
1260 #   define isALPHA_A(c)  (isUPPER_A(c) || isLOWER_A(c))
1261 #   define isALPHANUMERIC_A(c) (isALPHA_A(c) || isDIGIT_A(c))
1262 #   define isWORDCHAR_A(c)   (isALPHANUMERIC_A(c) || (c) == '_')
1263 #   define isIDFIRST_A(c)    (isALPHA_A(c) || (c) == '_')
1264 #   define isXDIGIT_A(c) (isDIGIT_A(c)                                  \
1265                           || ((c) >= 'a' && (c) <= 'f')                 \
1266                           || ((c) <= 'F' && (c) >= 'A'))
1267 #   define isPUNCT_A(c)  ((c) == '-' || (c) == '!' || (c) == '"'        \
1268                        || (c) == '#' || (c) == '$' || (c) == '%'        \
1269                        || (c) == '&' || (c) == '\'' || (c) == '('       \
1270                        || (c) == ')' || (c) == '*' || (c) == '+'        \
1271                        || (c) == ',' || (c) == '.' || (c) == '/'        \
1272                        || (c) == ':' || (c) == ';' || (c) == '<'        \
1273                        || (c) == '=' || (c) == '>' || (c) == '?'        \
1274                        || (c) == '@' || (c) == '[' || (c) == '\\'       \
1275                        || (c) == ']' || (c) == '^' || (c) == '_'        \
1276                        || (c) == '`' || (c) == '{' || (c) == '|'        \
1277                        || (c) == '}' || (c) == '~')
1278 #   define isGRAPH_A(c)  (isALPHANUMERIC_A(c) || isPUNCT_A(c))
1279 #   define isPRINT_A(c)  (isGRAPH_A(c) || (c) == ' ')
1280
1281 #   ifdef EBCDIC
1282         /* The below is accurate for the 3 EBCDIC code pages traditionally
1283          * supported by perl.  The only difference between them in the controls
1284          * is the position of \n, and that is represented symbolically below */
1285 #       define isCNTRL_A(c)  ((c) == '\0' || (c) == '\a' || (c) == '\b'     \
1286                           ||  (c) == '\f' || (c) == '\n' || (c) == '\r'     \
1287                           ||  (c) == '\t' || (c) == '\v'                    \
1288                           || ((c) <= 3 && (c) >= 1) /* SOH, STX, ETX */     \
1289                           ||  (c) == 7    /* U+7F DEL */                    \
1290                           || ((c) <= 0x13 && (c) >= 0x0E) /* SO, SI */      \
1291                                                          /* DLE, DC[1-3] */ \
1292                           ||  (c) == 0x18 /* U+18 CAN */                    \
1293                           ||  (c) == 0x19 /* U+19 EOM */                    \
1294                           || ((c) <= 0x1F && (c) >= 0x1C) /* [FGRU]S */     \
1295                           ||  (c) == 0x26 /* U+17 ETB */                    \
1296                           ||  (c) == 0x27 /* U+1B ESC */                    \
1297                           ||  (c) == 0x2D /* U+05 ENQ */                    \
1298                           ||  (c) == 0x2E /* U+06 ACK */                    \
1299                           ||  (c) == 0x32 /* U+16 SYN */                    \
1300                           ||  (c) == 0x37 /* U+04 EOT */                    \
1301                           ||  (c) == 0x3C /* U+14 DC4 */                    \
1302                           ||  (c) == 0x3D /* U+15 NAK */                    \
1303                           ||  (c) == 0x3F)/* U+1A SUB */
1304 #       define isASCII(c)    (isCNTRL_A(c) || isPRINT_A(c))
1305 #   else /* isASCII is already defined for ASCII platforms, so can use that to
1306             define isCNTRL */
1307 #       define isCNTRL_A(c)  (isASCII(c) && ! isPRINT_A(c))
1308 #   endif
1309
1310     /* The _L1 macros may be unnecessary for the utilities; I (khw) added them
1311      * during debugging, and it seems best to keep them.  We may be called
1312      * without NATIVE_TO_LATIN1 being defined.  On ASCII platforms, it doesn't
1313      * do anything anyway, so make it not a problem */
1314 #   if ! defined(EBCDIC) && ! defined(NATIVE_TO_LATIN1)
1315 #       define NATIVE_TO_LATIN1(ch) (ch)
1316 #   endif
1317 #   define isALPHA_L1(c)     (isUPPER_L1(c) || isLOWER_L1(c))
1318 #   define isALPHANUMERIC_L1(c) (isALPHA_L1(c) || isDIGIT_A(c))
1319 #   define isBLANK_L1(c)     (isBLANK_A(c)                                   \
1320                               || (FITS_IN_8_BITS(c)                          \
1321                                   && NATIVE_TO_LATIN1((U8) c) == 0xA0))
1322 #   define isCNTRL_L1(c)     (FITS_IN_8_BITS(c) && (! isPRINT_L1(c)))
1323 #   define isGRAPH_L1(c)     (isPRINT_L1(c) && (! isBLANK_L1(c)))
1324 #   define isLOWER_L1(c)     (isLOWER_A(c)                                   \
1325                               || (FITS_IN_8_BITS(c)                          \
1326                                   && ((NATIVE_TO_LATIN1((U8) c) >= 0xDF      \
1327                                        && NATIVE_TO_LATIN1((U8) c) != 0xF7)  \
1328                                        || NATIVE_TO_LATIN1((U8) c) == 0xAA   \
1329                                        || NATIVE_TO_LATIN1((U8) c) == 0xBA   \
1330                                        || NATIVE_TO_LATIN1((U8) c) == 0xB5)))
1331 #   define isPRINT_L1(c)     (isPRINT_A(c)                                   \
1332                               || (FITS_IN_8_BITS(c)                          \
1333                                   && NATIVE_TO_LATIN1((U8) c) >= 0xA0))
1334 #   define isPUNCT_L1(c)     (isPUNCT_A(c)                                   \
1335                               || (FITS_IN_8_BITS(c)                          \
1336                                   && (NATIVE_TO_LATIN1((U8) c) == 0xA1       \
1337                                       || NATIVE_TO_LATIN1((U8) c) == 0xA7    \
1338                                       || NATIVE_TO_LATIN1((U8) c) == 0xAB    \
1339                                       || NATIVE_TO_LATIN1((U8) c) == 0xB6    \
1340                                       || NATIVE_TO_LATIN1((U8) c) == 0xB7    \
1341                                       || NATIVE_TO_LATIN1((U8) c) == 0xBB    \
1342                                       || NATIVE_TO_LATIN1((U8) c) == 0xBF)))
1343 #   define isSPACE_L1(c)     (isSPACE_A(c)                                   \
1344                               || (FITS_IN_8_BITS(c)                          \
1345                                   && (NATIVE_TO_LATIN1((U8) c) == 0x85       \
1346                                       || NATIVE_TO_LATIN1((U8) c) == 0xA0)))
1347 #   define isUPPER_L1(c)     (isUPPER_A(c)                                   \
1348                               || (FITS_IN_8_BITS(c)                          \
1349                                   && (NATIVE_TO_LATIN1((U8) c) >= 0xC0       \
1350                                       && NATIVE_TO_LATIN1((U8) c) <= 0xDE    \
1351                                       && NATIVE_TO_LATIN1((U8) c) != 0xD7)))
1352 #   define isWORDCHAR_L1(c)  (isIDFIRST_L1(c) || isDIGIT_A(c))
1353 #   define isIDFIRST_L1(c)   (isALPHA_L1(c) || NATIVE_TO_LATIN1(c) == '_')
1354 #   define isCHARNAME_CONT(c) (isWORDCHAR_L1(c)                              \
1355                                || isBLANK_L1(c)                              \
1356                                || (c) == '-'                                 \
1357                                || (c) == '('                                 \
1358                                || (c) == ')')
1359     /* The following are not fully accurate in the above-ASCII range.  I (khw)
1360      * don't think it's necessary to be so for the purposes where this gets
1361      * compiled */
1362 #   define _isQUOTEMETA(c)      (FITS_IN_8_BITS(c) && ! isWORDCHAR_L1(c))
1363 #   define _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) isALPHA_L1(c)
1364
1365     /*  And these aren't accurate at all.  They are useful only for above
1366      *  Latin1, which utilities and bootstrapping don't deal with */
1367 #   define _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) 0
1368 #   define _HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(c) 0
1369 #   define _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(c) 0
1370
1371     /* Many of the macros later in this file are defined in terms of these.  By
1372      * implementing them with a function, which converts the class number into
1373      * a call to the desired macro, all of the later ones work.  However, that
1374      * function won't be actually defined when building a utility program (no
1375      * perl.h), and so a compiler error will be generated if one is attempted
1376      * to be used.  And the above-Latin1 code points require Unicode tables to
1377      * be present, something unlikely to be the case when bootstrapping */
1378 #   define _generic_isCC(c, classnum)                                        \
1379          (FITS_IN_8_BITS(c) && S_bootstrap_ctype((U8) (c), (classnum), TRUE))
1380 #   define _generic_isCC_A(c, classnum)                                      \
1381          (FITS_IN_8_BITS(c) && S_bootstrap_ctype((U8) (c), (classnum), FALSE))
1382 #endif  /* End of no perl.h H_PERL */
1383
1384 #define isALPHANUMERIC(c)  isALPHANUMERIC_A(c)
1385 #define isALPHA(c)   isALPHA_A(c)
1386 #define isASCII_A(c)  isASCII(c)
1387 #define isASCII_L1(c)  isASCII(c)
1388 #define isBLANK(c)   isBLANK_A(c)
1389 #define isCNTRL(c)   isCNTRL_A(c)
1390 #define isDIGIT(c)   isDIGIT_A(c)
1391 #define isGRAPH(c)   isGRAPH_A(c)
1392 #define isIDFIRST(c) isIDFIRST_A(c)
1393 #define isLOWER(c)   isLOWER_A(c)
1394 #define isPRINT(c)   isPRINT_A(c)
1395 #define isPSXSPC_A(c) isSPACE_A(c)
1396 #define isPSXSPC(c)  isPSXSPC_A(c)
1397 #define isPSXSPC_L1(c) isSPACE_L1(c)
1398 #define isPUNCT(c)   isPUNCT_A(c)
1399 #define isSPACE(c)   isSPACE_A(c)
1400 #define isUPPER(c)   isUPPER_A(c)
1401 #define isWORDCHAR(c) isWORDCHAR_A(c)
1402 #define isXDIGIT(c)  isXDIGIT_A(c)
1403
1404 /* ASCII casing.  These could also be written as
1405     #define toLOWER(c) (isASCII(c) ? toLOWER_LATIN1(c) : (c))
1406     #define toUPPER(c) (isASCII(c) ? toUPPER_LATIN1_MOD(c) : (c))
1407    which uses table lookup and mask instead of subtraction.  (This would
1408    work because the _MOD does not apply in the ASCII range) */
1409 #define toLOWER(c)  (isUPPER(c) ? (U8)((c) + ('a' - 'A')) : (c))
1410 #define toUPPER(c)  (isLOWER(c) ? (U8)((c) - ('a' - 'A')) : (c))
1411
1412 /* In the ASCII range, these are equivalent to what they're here defined to be.
1413  * But by creating these definitions, other code doesn't have to be aware of
1414  * this detail */
1415 #define toFOLD(c)    toLOWER(c)
1416 #define toTITLE(c)   toUPPER(c)
1417
1418 #define toLOWER_A(c) toLOWER(c)
1419 #define toUPPER_A(c) toUPPER(c)
1420 #define toFOLD_A(c)  toFOLD(c)
1421 #define toTITLE_A(c) toTITLE(c)
1422
1423 /* Use table lookup for speed; returns the input itself if is out-of-range */
1424 #define toLOWER_LATIN1(c)    ((! FITS_IN_8_BITS(c))                        \
1425                              ? (c)                                         \
1426                              : PL_latin1_lc[ (U8) (c) ])
1427 #define toLOWER_L1(c)    toLOWER_LATIN1(c)  /* Synonym for consistency */
1428
1429 /* Modified uc.  Is correct uc except for three non-ascii chars which are
1430  * all mapped to one of them, and these need special handling; returns the
1431  * input itself if is out-of-range */
1432 #define toUPPER_LATIN1_MOD(c) ((! FITS_IN_8_BITS(c))                       \
1433                                ? (c)                                       \
1434                                : PL_mod_latin1_uc[ (U8) (c) ])
1435 #define IN_UTF8_CTYPE_LOCALE PL_in_utf8_CTYPE_locale
1436
1437 /* Use foo_LC_uvchr() instead  of these for beyond the Latin1 range */
1438
1439 /* For internal core Perl use only: the base macro for defining macros like
1440  * isALPHA_LC, which uses the current LC_CTYPE locale.  'c' is the code point
1441  * (0-255) to check.  In a UTF-8 locale, the result is the same as calling
1442  * isFOO_L1(); the 'utf8_locale_classnum' parameter is something like
1443  * _CC_UPPER, which gives the class number for doing this.  For non-UTF-8
1444  * locales, the code to actually do the test this is passed in 'non_utf8'.  If
1445  * 'c' is above 255, 0 is returned.  For accessing the full range of possible
1446  * code points under locale rules, use the macros based on _generic_LC_uvchr
1447  * instead of this. */
1448 #define _generic_LC_base(c, utf8_locale_classnum, non_utf8)                    \
1449            (! FITS_IN_8_BITS(c)                                                \
1450            ? 0                                                                 \
1451            : IN_UTF8_CTYPE_LOCALE                                              \
1452              ? cBOOL(PL_charclass[(U8) (c)] & _CC_mask(utf8_locale_classnum))  \
1453              : cBOOL(non_utf8))
1454
1455 /* For internal core Perl use only: a helper macro for defining macros like
1456  * isALPHA_LC.  'c' is the code point (0-255) to check.  The function name to
1457  * actually do this test is passed in 'non_utf8_func', which is called on 'c',
1458  * casting 'c' to the macro _LC_CAST, which should not be parenthesized.  See
1459  * _generic_LC_base for more info */
1460 #define _generic_LC(c, utf8_locale_classnum, non_utf8_func)                    \
1461                         _generic_LC_base(c,utf8_locale_classnum,               \
1462                                          non_utf8_func( (_LC_CAST) (c)))
1463
1464 /* For internal core Perl use only: like _generic_LC, but also returns TRUE if
1465  * 'c' is the platform's native underscore character */
1466 #define _generic_LC_underscore(c,utf8_locale_classnum,non_utf8_func)           \
1467                         _generic_LC_base(c, utf8_locale_classnum,              \
1468                                          (non_utf8_func( (_LC_CAST) (c))       \
1469                                           || (char)(c) == '_'))
1470
1471 /* These next three are also for internal core Perl use only: case-change
1472  * helper macros */
1473 #define _generic_toLOWER_LC(c, function, cast)  (! FITS_IN_8_BITS(c)           \
1474                                                 ? (c)                          \
1475                                                 : (IN_UTF8_CTYPE_LOCALE)       \
1476                                                   ? PL_latin1_lc[ (U8) (c) ]   \
1477                                                 : (cast)function((cast)(c)))
1478
1479 /* Note that the result can be larger than a byte in a UTF-8 locale.  It
1480  * returns a single value, so can't adequately return the upper case of LATIN
1481  * SMALL LETTER SHARP S in a UTF-8 locale (which should be a string of two
1482  * values "SS");  instead it asserts against that under DEBUGGING, and
1483  * otherwise returns its input */
1484 #define _generic_toUPPER_LC(c, function, cast)                                 \
1485                     (! FITS_IN_8_BITS(c)                                       \
1486                     ? (c)                                                      \
1487                     : ((! IN_UTF8_CTYPE_LOCALE)                                \
1488                       ? (cast)function((cast)(c))                              \
1489                       : ((((U8)(c)) == MICRO_SIGN)                             \
1490                         ? GREEK_CAPITAL_LETTER_MU                              \
1491                         : ((((U8)(c)) == LATIN_SMALL_LETTER_Y_WITH_DIAERESIS)  \
1492                           ? LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS              \
1493                           : ((((U8)(c)) == LATIN_SMALL_LETTER_SHARP_S)         \
1494                             ? (__ASSERT_(0) (c))                               \
1495                             : PL_mod_latin1_uc[ (U8) (c) ])))))
1496
1497 /* Note that the result can be larger than a byte in a UTF-8 locale.  It
1498  * returns a single value, so can't adequately return the fold case of LATIN
1499  * SMALL LETTER SHARP S in a UTF-8 locale (which should be a string of two
1500  * values "ss"); instead it asserts against that under DEBUGGING, and
1501  * otherwise returns its input */
1502 #define _generic_toFOLD_LC(c, function, cast)                                  \
1503                     ((UNLIKELY((c) == MICRO_SIGN) && IN_UTF8_CTYPE_LOCALE)     \
1504                       ? GREEK_SMALL_LETTER_MU                                  \
1505                       : (__ASSERT_(! IN_UTF8_CTYPE_LOCALE                      \
1506                                    || (c) != LATIN_SMALL_LETTER_SHARP_S)       \
1507                          _generic_toLOWER_LC(c, function, cast)))
1508
1509 /* Use the libc versions for these if available. */
1510 #if defined(HAS_ISASCII)
1511 #   define isASCII_LC(c) (FITS_IN_8_BITS(c) && isascii( (U8) (c)))
1512 #else
1513 #   define isASCII_LC(c) isASCII(c)
1514 #endif
1515
1516 #if defined(HAS_ISBLANK)
1517 #   define isBLANK_LC(c) _generic_LC(c, _CC_BLANK, isblank)
1518 #else /* Unlike isASCII, varies if in a UTF-8 locale */
1519 #   define isBLANK_LC(c) ((IN_UTF8_CTYPE_LOCALE) ? isBLANK_L1(c) : isBLANK(c))
1520 #endif
1521
1522 #define _LC_CAST U8
1523
1524 #ifdef WIN32
1525     /* The Windows functions don't bother to follow the POSIX standard, which
1526      * for example says that something can't both be a printable and a control.
1527      * But Windows treats the \t control as a printable, and does such things
1528      * as making superscripts into both digits and punctuation.  This tames
1529      * these flaws by assuming that the definitions of both controls and space
1530      * are correct, and then making sure that other definitions don't have
1531      * weirdnesses, by making sure that isalnum() isn't also ispunct(), etc.
1532      * Not all possible weirdnesses are checked for, just the ones that were
1533      * detected on actual Microsoft code pages */
1534
1535 #  define isCNTRL_LC(c)  _generic_LC(c, _CC_CNTRL, iscntrl)
1536 #  define isSPACE_LC(c)  _generic_LC(c, _CC_SPACE, isspace)
1537
1538 #  define isALPHA_LC(c)  (_generic_LC(c, _CC_ALPHA, isalpha)                  \
1539                                                     && isALPHANUMERIC_LC(c))
1540 #  define isALPHANUMERIC_LC(c)  (_generic_LC(c, _CC_ALPHANUMERIC, isalnum) && \
1541                                                               ! isPUNCT_LC(c))
1542 #  define isDIGIT_LC(c)  (_generic_LC(c, _CC_DIGIT, isdigit) &&               \
1543                                                          isALPHANUMERIC_LC(c))
1544 #  define isGRAPH_LC(c)  (_generic_LC(c, _CC_GRAPH, isgraph) && isPRINT_LC(c))
1545 #  define isIDFIRST_LC(c) (((c) == '_')                                       \
1546                  || (_generic_LC(c, _CC_IDFIRST, isalpha) && ! isPUNCT_LC(c)))
1547 #  define isLOWER_LC(c)  (_generic_LC(c, _CC_LOWER, islower) && isALPHA_LC(c))
1548 #  define isPRINT_LC(c)  (_generic_LC(c, _CC_PRINT, isprint) && ! isCNTRL_LC(c))
1549 #  define isPUNCT_LC(c)  (_generic_LC(c, _CC_PUNCT, ispunct) && ! isCNTRL_LC(c))
1550 #  define isUPPER_LC(c)  (_generic_LC(c, _CC_UPPER, isupper) && isALPHA_LC(c))
1551 #  define isWORDCHAR_LC(c) (((c) == '_') || isALPHANUMERIC_LC(c))
1552 #  define isXDIGIT_LC(c) (_generic_LC(c, _CC_XDIGIT, isxdigit)                \
1553                                                     && isALPHANUMERIC_LC(c))
1554
1555 #  define toLOWER_LC(c) _generic_toLOWER_LC((c), tolower, U8)
1556 #  define toUPPER_LC(c) _generic_toUPPER_LC((c), toupper, U8)
1557 #  define toFOLD_LC(c)  _generic_toFOLD_LC((c), tolower, U8)
1558
1559 #elif defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII))
1560     /* For most other platforms */
1561
1562 #  define isALPHA_LC(c)   _generic_LC(c, _CC_ALPHA, isalpha)
1563 #  define isALPHANUMERIC_LC(c)  _generic_LC(c, _CC_ALPHANUMERIC, isalnum)
1564 #  define isCNTRL_LC(c)    _generic_LC(c, _CC_CNTRL, iscntrl)
1565 #  define isDIGIT_LC(c)    _generic_LC(c, _CC_DIGIT, isdigit)
1566 #  define isGRAPH_LC(c)    _generic_LC(c, _CC_GRAPH, isgraph)
1567 #  define isIDFIRST_LC(c)  _generic_LC_underscore(c, _CC_IDFIRST, isalpha)
1568 #  define isLOWER_LC(c)    _generic_LC(c, _CC_LOWER, islower)
1569 #  define isPRINT_LC(c)    _generic_LC(c, _CC_PRINT, isprint)
1570 #  define isPUNCT_LC(c)    _generic_LC(c, _CC_PUNCT, ispunct)
1571 #  define isSPACE_LC(c)    _generic_LC(c, _CC_SPACE, isspace)
1572 #  define isUPPER_LC(c)    _generic_LC(c, _CC_UPPER, isupper)
1573 #  define isWORDCHAR_LC(c) _generic_LC_underscore(c, _CC_WORDCHAR, isalnum)
1574 #  define isXDIGIT_LC(c)   _generic_LC(c, _CC_XDIGIT, isxdigit)
1575
1576
1577 #  define toLOWER_LC(c) _generic_toLOWER_LC((c), tolower, U8)
1578 #  define toUPPER_LC(c) _generic_toUPPER_LC((c), toupper, U8)
1579 #  define toFOLD_LC(c)  _generic_toFOLD_LC((c), tolower, U8)
1580
1581 #else  /* The final fallback position */
1582
1583 #  define isALPHA_LC(c)         (isascii(c) && isalpha(c))
1584 #  define isALPHANUMERIC_LC(c)  (isascii(c) && isalnum(c))
1585 #  define isCNTRL_LC(c)         (isascii(c) && iscntrl(c))
1586 #  define isDIGIT_LC(c)         (isascii(c) && isdigit(c))
1587 #  define isGRAPH_LC(c)         (isascii(c) && isgraph(c))
1588 #  define isIDFIRST_LC(c)       (isascii(c) && (isalpha(c) || (c) == '_'))
1589 #  define isLOWER_LC(c)         (isascii(c) && islower(c))
1590 #  define isPRINT_LC(c)         (isascii(c) && isprint(c))
1591 #  define isPUNCT_LC(c)         (isascii(c) && ispunct(c))
1592 #  define isSPACE_LC(c)         (isascii(c) && isspace(c))
1593 #  define isUPPER_LC(c)         (isascii(c) && isupper(c))
1594 #  define isWORDCHAR_LC(c)      (isascii(c) && (isalnum(c) || (c) == '_'))
1595 #  define isXDIGIT_LC(c)        (isascii(c) && isxdigit(c))
1596
1597 #  define toLOWER_LC(c) (isascii(c) ? tolower(c) : (c))
1598 #  define toUPPER_LC(c) (isascii(c) ? toupper(c) : (c))
1599 #  define toFOLD_LC(c)  (isascii(c) ? tolower(c) : (c))
1600
1601 #endif
1602
1603 #define isIDCONT(c)             isWORDCHAR(c)
1604 #define isIDCONT_A(c)           isWORDCHAR_A(c)
1605 #define isIDCONT_L1(c)          isWORDCHAR_L1(c)
1606 #define isIDCONT_LC(c)          isWORDCHAR_LC(c)
1607 #define isPSXSPC_LC(c)          isSPACE_LC(c)
1608
1609 /* For internal core Perl use only: the base macros for defining macros like
1610  * isALPHA_uvchr.  'c' is the code point to check.  'classnum' is the POSIX class
1611  * number defined earlier in this file.  _generic_uvchr() is used for POSIX
1612  * classes where there is a macro or function 'above_latin1' that takes the
1613  * single argument 'c' and returns the desired value.  These exist for those
1614  * classes which have simple definitions, avoiding the overhead of a hash
1615  * lookup or inversion list binary search.  _generic_swash_uvchr() can be used
1616  * for classes where that overhead is faster than a direct lookup.
1617  * _generic_uvchr() won't compile if 'c' isn't unsigned, as it won't match the
1618  * 'above_latin1' prototype. _generic_isCC() macro does bounds checking, so
1619  * have duplicate checks here, so could create versions of the macros that
1620  * don't, but experiments show that gcc optimizes them out anyway. */
1621
1622 /* Note that all ignore 'use bytes' */
1623 #define _generic_uvchr(classnum, above_latin1, c) ((c) < 256                    \
1624                                              ? _generic_isCC(c, classnum)     \
1625                                              : above_latin1(c))
1626 #define _generic_swash_uvchr(classnum, c) ((c) < 256                            \
1627                                              ? _generic_isCC(c, classnum)     \
1628                                              : _is_uni_FOO(classnum, c))
1629 #define isALPHA_uvchr(c)      _generic_swash_uvchr(_CC_ALPHA, c)
1630 #define isALPHANUMERIC_uvchr(c) _generic_swash_uvchr(_CC_ALPHANUMERIC, c)
1631 #define isASCII_uvchr(c)      isASCII(c)
1632 #define isBLANK_uvchr(c)      _generic_uvchr(_CC_BLANK, is_HORIZWS_cp_high, c)
1633 #define isCNTRL_uvchr(c)      isCNTRL_L1(c) /* All controls are in Latin1 */
1634 #define isDIGIT_uvchr(c)      _generic_swash_uvchr(_CC_DIGIT, c)
1635 #define isGRAPH_uvchr(c)      _generic_swash_uvchr(_CC_GRAPH, c)
1636 #define isIDCONT_uvchr(c)     _generic_uvchr(_CC_WORDCHAR, _is_uni_perl_idcont, c)
1637 #define isIDFIRST_uvchr(c)    _generic_uvchr(_CC_IDFIRST, _is_uni_perl_idstart, c)
1638 #define isLOWER_uvchr(c)      _generic_swash_uvchr(_CC_LOWER, c)
1639 #define isPRINT_uvchr(c)      _generic_swash_uvchr(_CC_PRINT, c)
1640
1641 #define isPUNCT_uvchr(c)      _generic_swash_uvchr(_CC_PUNCT, c)
1642 #define isSPACE_uvchr(c)      _generic_uvchr(_CC_SPACE, is_XPERLSPACE_cp_high, c)
1643 #define isPSXSPC_uvchr(c)     isSPACE_uvchr(c)
1644
1645 #define isUPPER_uvchr(c)      _generic_swash_uvchr(_CC_UPPER, c)
1646 #define isVERTWS_uvchr(c)     _generic_uvchr(_CC_VERTSPACE, is_VERTWS_cp_high, c)
1647 #define isWORDCHAR_uvchr(c)   _generic_swash_uvchr(_CC_WORDCHAR, c)
1648 #define isXDIGIT_uvchr(c)     _generic_uvchr(_CC_XDIGIT, is_XDIGIT_cp_high, c)
1649
1650 #define toFOLD_uvchr(c,s,l)     to_uni_fold(c,s,l)
1651 #define toLOWER_uvchr(c,s,l)    to_uni_lower(c,s,l)
1652 #define toTITLE_uvchr(c,s,l)    to_uni_title(c,s,l)
1653 #define toUPPER_uvchr(c,s,l)    to_uni_upper(c,s,l)
1654
1655 /* For backwards compatibility, even though '_uni' should mean official Unicode
1656  * code points, in Perl it means native for those below 256 */
1657 #define isALPHA_uni(c)          isALPHA_uvchr(c)
1658 #define isALPHANUMERIC_uni(c)   isALPHANUMERIC_uvchr(c)
1659 #define isASCII_uni(c)          isASCII_uvchr(c)
1660 #define isBLANK_uni(c)          isBLANK_uvchr(c)
1661 #define isCNTRL_uni(c)          isCNTRL_uvchr(c)
1662 #define isDIGIT_uni(c)          isDIGIT_uvchr(c)
1663 #define isGRAPH_uni(c)          isGRAPH_uvchr(c)
1664 #define isIDCONT_uni(c)         isIDCONT_uvchr(c)
1665 #define isIDFIRST_uni(c)        isIDFIRST_uvchr(c)
1666 #define isLOWER_uni(c)          isLOWER_uvchr(c)
1667 #define isPRINT_uni(c)          isPRINT_uvchr(c)
1668 #define isPUNCT_uni(c)          isPUNCT_uvchr(c)
1669 #define isSPACE_uni(c)          isSPACE_uvchr(c)
1670 #define isPSXSPC_uni(c)         isPSXSPC_uvchr(c)
1671 #define isUPPER_uni(c)          isUPPER_uvchr(c)
1672 #define isVERTWS_uni(c)         isVERTWS_uvchr(c)
1673 #define isWORDCHAR_uni(c)       isWORDCHAR_uvchr(c)
1674 #define isXDIGIT_uni(c)         isXDIGIT_uvchr(c)
1675 #define toFOLD_uni(c,s,l)       toFOLD_uvchr(c,s,l)
1676 #define toLOWER_uni(c,s,l)      toLOWER_uvchr(c,s,l)
1677 #define toTITLE_uni(c,s,l)      toTITLE_uvchr(c,s,l)
1678 #define toUPPER_uni(c,s,l)      toUPPER_uvchr(c,s,l)
1679
1680 /* For internal core Perl use only: the base macros for defining macros like
1681  * isALPHA_LC_uvchr.  These are like isALPHA_LC, but the input can be any code
1682  * point, not just 0-255.  Like _generic_uvchr, there are two versions, one for
1683  * simple class definitions; the other for more complex.  These are like
1684  * _generic_uvchr, so see it for more info. */
1685 #define _generic_LC_uvchr(latin1, above_latin1, c)                            \
1686                                     (c < 256 ? latin1(c) : above_latin1(c))
1687 #define _generic_LC_swash_uvchr(latin1, classnum, c)                          \
1688                             (c < 256 ? latin1(c) : _is_uni_FOO(classnum, c))
1689
1690 #define isALPHA_LC_uvchr(c)  _generic_LC_swash_uvchr(isALPHA_LC, _CC_ALPHA, c)
1691 #define isALPHANUMERIC_LC_uvchr(c)  _generic_LC_swash_uvchr(isALPHANUMERIC_LC, \
1692                                                          _CC_ALPHANUMERIC, c)
1693 #define isASCII_LC_uvchr(c)   isASCII_LC(c)
1694 #define isBLANK_LC_uvchr(c)  _generic_LC_uvchr(isBLANK_LC,                    \
1695                                                         is_HORIZWS_cp_high, c)
1696 #define isCNTRL_LC_uvchr(c)  (c < 256 ? isCNTRL_LC(c) : 0)
1697 #define isDIGIT_LC_uvchr(c)  _generic_LC_swash_uvchr(isDIGIT_LC, _CC_DIGIT, c)
1698 #define isGRAPH_LC_uvchr(c)  _generic_LC_swash_uvchr(isGRAPH_LC, _CC_GRAPH, c)
1699 #define isIDCONT_LC_uvchr(c) _generic_LC_uvchr(isIDCONT_LC,                   \
1700                                                   _is_uni_perl_idcont, c)
1701 #define isIDFIRST_LC_uvchr(c) _generic_LC_uvchr(isIDFIRST_LC,                 \
1702                                                   _is_uni_perl_idstart, c)
1703 #define isLOWER_LC_uvchr(c)  _generic_LC_swash_uvchr(isLOWER_LC, _CC_LOWER, c)
1704 #define isPRINT_LC_uvchr(c)  _generic_LC_swash_uvchr(isPRINT_LC, _CC_PRINT, c)
1705 #define isPSXSPC_LC_uvchr(c)  isSPACE_LC_uvchr(c)
1706 #define isPUNCT_LC_uvchr(c)  _generic_LC_swash_uvchr(isPUNCT_LC, _CC_PUNCT, c)
1707 #define isSPACE_LC_uvchr(c)  _generic_LC_uvchr(isSPACE_LC,                    \
1708                                                     is_XPERLSPACE_cp_high, c)
1709 #define isUPPER_LC_uvchr(c)  _generic_LC_swash_uvchr(isUPPER_LC, _CC_UPPER, c)
1710 #define isWORDCHAR_LC_uvchr(c) _generic_LC_swash_uvchr(isWORDCHAR_LC,         \
1711                                                            _CC_WORDCHAR, c)
1712 #define isXDIGIT_LC_uvchr(c) _generic_LC_uvchr(isXDIGIT_LC,                  \
1713                                                        is_XDIGIT_cp_high, c)
1714
1715 #define isBLANK_LC_uni(c)    isBLANK_LC_uvchr(UNI_TO_NATIVE(c))
1716
1717 /* For internal core Perl use only: the base macros for defining macros like
1718  * isALPHA_utf8.  These are like the earlier defined macros, but take an input
1719  * UTF-8 encoded string 'p'. If the input is in the Latin1 range, use
1720  * the Latin1 macro 'classnum' on 'p'.  Otherwise use the value given by the
1721  * 'utf8' parameter.  This relies on the fact that ASCII characters have the
1722  * same representation whether utf8 or not.  Note that it assumes that the utf8
1723  * has been validated, and ignores 'use bytes' */
1724 #define _base_generic_utf8(enum_name, name, p, use_locale )                 \
1725     _is_utf8_FOO(CAT2(_CC_, enum_name),                                     \
1726                  (const U8 *) p,                                            \
1727                  "is" STRINGIFY(name) "_utf8",                              \
1728                  "is" STRINGIFY(name) "_utf8_safe",                         \
1729                  1, use_locale, __FILE__,__LINE__)
1730
1731 #define _generic_utf8(name, p) _base_generic_utf8(name, name, p, 0)
1732
1733 /* The "_safe" macros make sure that we don't attempt to read beyond 'e', but
1734  * they don't otherwise go out of their way to look for malformed UTF-8.  If
1735  * they can return accurate results without knowing if the input is otherwise
1736  * malformed, they do so.  For example isASCII is accurate in spite of any
1737  * non-length malformations because it looks only at a single byte. Likewise
1738  * isDIGIT looks just at the first byte for code points 0-255, as all UTF-8
1739  * variant ones return FALSE.  But, if the input has to be well-formed in order
1740  * for the results to be accurate, the macros will test and if malformed will
1741  * call a routine to die
1742  *
1743  * Except for toke.c, the macros do assume that e > p, asserting that on
1744  * DEBUGGING builds.  Much code that calls these depends on this being true,
1745  * for other reasons.  toke.c is treated specially as using the regular
1746  * assertion breaks it in many ways.  All strings that these operate on there
1747  * are supposed to have an extra NUL character at the end,  so that *e = \0. A
1748  * bunch of code in toke.c assumes that this is true, so the assertion allows
1749  * for that */
1750 #ifdef PERL_IN_TOKE_C
1751 #  define _utf8_safe_assert(p,e) ((e) > (p) || ((e) == (p) && *(p) == '\0'))
1752 #else
1753 #  define _utf8_safe_assert(p,e) ((e) > (p))
1754 #endif
1755
1756 #define _generic_utf8_safe(classnum, p, e, above_latin1)                    \
1757          (__ASSERT_(_utf8_safe_assert(p, e))                                \
1758          (UTF8_IS_INVARIANT(*(p)))                                          \
1759           ? _generic_isCC(*(p), classnum)                                   \
1760           : (UTF8_IS_DOWNGRADEABLE_START(*(p))                              \
1761              ? ((LIKELY((e) - (p) > 1 && UTF8_IS_CONTINUATION(*((p)+1))))   \
1762                 ? _generic_isCC(EIGHT_BIT_UTF8_TO_NATIVE(*(p), *((p)+1 )),  \
1763                                 classnum)                                   \
1764                 : (_force_out_malformed_utf8_message(                       \
1765                                         (U8 *) (p), (U8 *) (e), 0, 1), 0))  \
1766              : above_latin1))
1767 /* Like the above, but calls 'above_latin1(p)' to get the utf8 value.
1768  * 'above_latin1' can be a macro */
1769 #define _generic_func_utf8_safe(classnum, above_latin1, p, e)               \
1770                     _generic_utf8_safe(classnum, p, e, above_latin1(p, e))
1771 #define _generic_non_swash_utf8_safe(classnum, above_latin1, p, e)          \
1772           _generic_utf8_safe(classnum, p, e,                                \
1773                              (UNLIKELY((e) - (p) < UTF8SKIP(p))             \
1774                               ? (_force_out_malformed_utf8_message(         \
1775                                       (U8 *) (p), (U8 *) (e), 0, 1), 0)     \
1776                               : above_latin1(p)))
1777 /* Like the above, but passes classnum to _isFOO_utf8(), instead of having an
1778  * 'above_latin1' parameter */
1779 #define _generic_swash_utf8_safe(classnum, p, e)                            \
1780 _generic_utf8_safe(classnum, p, e, _is_utf8_FOO_with_len(classnum, p, e))
1781
1782 /* Like the above, but should be used only when it is known that there are no
1783  * characters in the upper-Latin1 range (128-255 on ASCII platforms) which the
1784  * class is TRUE for.  Hence it can skip the tests for this range.
1785  * 'above_latin1' should include its arguments */
1786 #define _generic_utf8_safe_no_upper_latin1(classnum, p, e, above_latin1)    \
1787          (__ASSERT_(_utf8_safe_assert(p, e))                                \
1788          (UTF8_IS_INVARIANT(*(p)))                                          \
1789           ? _generic_isCC(*(p), classnum)                                   \
1790           : (UTF8_IS_DOWNGRADEABLE_START(*(p)))                             \
1791              ? 0 /* Note that doesn't check validity for latin1 */          \
1792              : above_latin1)
1793
1794 /* NOTE that some of these macros have very similar ones in regcharclass.h.
1795  * For example, there is (at the time of this writing) an 'is_SPACE_utf8()'
1796  * there, differing in name only by an underscore from the one here
1797  * 'isSPACE_utf8().  The difference is that the ones here are probably more
1798  * efficient and smaller, using an O(1) array lookup for Latin1-range code
1799  * points; the regcharclass.h ones are implemented as a series of
1800  * "if-else-if-else ..." */
1801
1802 #define isALPHA_utf8(p)         _generic_utf8(ALPHA, p)
1803 #define isALPHANUMERIC_utf8(p)  _generic_utf8(ALPHANUMERIC, p)
1804 #define isASCII_utf8(p)         _generic_utf8(ASCII, p)
1805 #define isBLANK_utf8(p)         _generic_utf8(BLANK, p)
1806 #define isCNTRL_utf8(p)         _generic_utf8(CNTRL, p)
1807 #define isDIGIT_utf8(p)         _generic_utf8(DIGIT, p)
1808 #define isGRAPH_utf8(p)         _generic_utf8(GRAPH, p)
1809 #define isIDCONT_utf8(p)        _generic_utf8(IDCONT, p)
1810 #define isIDFIRST_utf8(p)       _generic_utf8(IDFIRST, p)
1811 #define isLOWER_utf8(p)         _generic_utf8(LOWER, p)
1812 #define isPRINT_utf8(p)         _generic_utf8(PRINT, p)
1813 #define isPSXSPC_utf8(p)        _generic_utf8(PSXSPC, p)
1814 #define isPUNCT_utf8(p)         _generic_utf8(PUNCT, p)
1815 #define isSPACE_utf8(p)         _generic_utf8(SPACE, p)
1816 #define isUPPER_utf8(p)         _generic_utf8(UPPER, p)
1817 #define isVERTWS_utf8(p)        _generic_utf8(VERTSPACE, p)
1818 #define isWORDCHAR_utf8(p)      _generic_utf8(WORDCHAR, p)
1819 #define isXDIGIT_utf8(p)        _generic_utf8(XDIGIT, p)
1820
1821 #define isALPHA_utf8_safe(p, e)  _generic_swash_utf8_safe(_CC_ALPHA, p, e)
1822 #define isALPHANUMERIC_utf8_safe(p, e)                                      \
1823                         _generic_swash_utf8_safe(_CC_ALPHANUMERIC, p, e)
1824 #define isASCII_utf8_safe(p, e)                                             \
1825     /* Because ASCII is invariant under utf8, the non-utf8 macro            \
1826     * works */                                                              \
1827     (__ASSERT_(_utf8_safe_assert(p, e)) isASCII(*(p)))
1828 #define isBLANK_utf8_safe(p, e)                                             \
1829         _generic_non_swash_utf8_safe(_CC_BLANK, is_HORIZWS_high, p, e)
1830
1831 #ifdef EBCDIC
1832     /* Because all controls are UTF-8 invariants in EBCDIC, we can use this
1833      * more efficient macro instead of the more general one */
1834 #   define isCNTRL_utf8_safe(p, e)                                          \
1835                     (__ASSERT_(_utf8_safe_assert(p, e)) isCNTRL_L1(*(p))
1836 #else
1837 #   define isCNTRL_utf8_safe(p, e)  _generic_utf8_safe(_CC_CNTRL, p, e, 0)
1838 #endif
1839
1840 #define isDIGIT_utf8_safe(p, e)                                             \
1841             _generic_utf8_safe_no_upper_latin1(_CC_DIGIT, p, e,             \
1842                                     _is_utf8_FOO_with_len(_CC_DIGIT, p, e))
1843 #define isGRAPH_utf8_safe(p, e)    _generic_swash_utf8_safe(_CC_GRAPH, p, e)
1844 #define isIDCONT_utf8_safe(p, e)   _generic_func_utf8_safe(_CC_WORDCHAR,    \
1845                                      _is_utf8_perl_idcont_with_len, p, e)
1846
1847 /* To prevent S_scan_word in toke.c from hanging, we have to make sure that
1848  * IDFIRST is an alnum.  See
1849  * http://rt.perl.org/rt3/Ticket/Display.html?id=74022 for more detail than you
1850  * ever wanted to know about.  (In the ASCII range, there isn't a difference.)
1851  * This used to be not the XID version, but we decided to go with the more
1852  * modern Unicode definition */
1853 #define isIDFIRST_utf8_safe(p, e)                                           \
1854     _generic_func_utf8_safe(_CC_IDFIRST,                                    \
1855                     _is_utf8_perl_idstart_with_len, (U8 *) (p), (U8 *) (e))
1856
1857 #define isLOWER_utf8_safe(p, e)     _generic_swash_utf8_safe(_CC_LOWER, p, e)
1858 #define isPRINT_utf8_safe(p, e)     _generic_swash_utf8_safe(_CC_PRINT, p, e)
1859 #define isPSXSPC_utf8_safe(p, e)     isSPACE_utf8_safe(p, e)
1860 #define isPUNCT_utf8_safe(p, e)     _generic_swash_utf8_safe(_CC_PUNCT, p, e)
1861 #define isSPACE_utf8_safe(p, e)                                             \
1862     _generic_non_swash_utf8_safe(_CC_SPACE, is_XPERLSPACE_high, p, e)
1863 #define isUPPER_utf8_safe(p, e)  _generic_swash_utf8_safe(_CC_UPPER, p, e)
1864 #define isVERTWS_utf8_safe(p, e)                                            \
1865         _generic_non_swash_utf8_safe(_CC_VERTSPACE, is_VERTWS_high, p, e)
1866 #define isWORDCHAR_utf8_safe(p, e)                                          \
1867                              _generic_swash_utf8_safe(_CC_WORDCHAR, p, e)
1868 #define isXDIGIT_utf8_safe(p, e)                                            \
1869                    _generic_utf8_safe_no_upper_latin1(_CC_XDIGIT, p, e,     \
1870                              (UNLIKELY((e) - (p) < UTF8SKIP(p))             \
1871                               ? (_force_out_malformed_utf8_message(         \
1872                                       (U8 *) (p), (U8 *) (e), 0, 1), 0)     \
1873                               : is_XDIGIT_high(p)))
1874
1875 #define toFOLD_utf8(p,s,l)      to_utf8_fold(p,s,l)
1876 #define toLOWER_utf8(p,s,l)     to_utf8_lower(p,s,l)
1877 #define toTITLE_utf8(p,s,l)     to_utf8_title(p,s,l)
1878 #define toUPPER_utf8(p,s,l)     to_utf8_upper(p,s,l)
1879
1880 /* For internal core Perl use only: the base macros for defining macros like
1881  * isALPHA_LC_utf8.  These are like _generic_utf8, but if the first code point
1882  * in 'p' is within the 0-255 range, it uses locale rules from the passed-in
1883  * 'macro' parameter */
1884 #define _generic_LC_utf8(name, p) _base_generic_utf8(name, name, p, 1)
1885
1886 #define isALPHA_LC_utf8(p)         _generic_LC_utf8(ALPHA, p)
1887 #define isALPHANUMERIC_LC_utf8(p)  _generic_LC_utf8(ALPHANUMERIC, p)
1888 #define isASCII_LC_utf8(p)         _generic_LC_utf8(ASCII, p)
1889 #define isBLANK_LC_utf8(p)         _generic_LC_utf8(BLANK, p)
1890 #define isCNTRL_LC_utf8(p)         _generic_LC_utf8(CNTRL, p)
1891 #define isDIGIT_LC_utf8(p)         _generic_LC_utf8(DIGIT, p)
1892 #define isGRAPH_LC_utf8(p)         _generic_LC_utf8(GRAPH, p)
1893 #define isIDCONT_LC_utf8(p)        _generic_LC_utf8(IDCONT, p)
1894 #define isIDFIRST_LC_utf8(p)       _generic_LC_utf8(IDFIRST, p)
1895 #define isLOWER_LC_utf8(p)         _generic_LC_utf8(LOWER, p)
1896 #define isPRINT_LC_utf8(p)         _generic_LC_utf8(PRINT, p)
1897 #define isPSXSPC_LC_utf8(p)        _generic_LC_utf8(PSXSPC, p)
1898 #define isPUNCT_LC_utf8(p)         _generic_LC_utf8(PUNCT, p)
1899 #define isSPACE_LC_utf8(p)         _generic_LC_utf8(SPACE, p)
1900 #define isUPPER_LC_utf8(p)         _generic_LC_utf8(UPPER, p)
1901 #define isWORDCHAR_LC_utf8(p)      _generic_LC_utf8(WORDCHAR, p)
1902 #define isXDIGIT_LC_utf8(p)        _generic_LC_utf8(XDIGIT, p)
1903
1904 /* For internal core Perl use only: the base macros for defining macros like
1905  * isALPHA_LC_utf8_safe.  These are like _generic_utf8, but if the first code
1906  * point in 'p' is within the 0-255 range, it uses locale rules from the
1907  * passed-in 'macro' parameter */
1908 #define _generic_LC_utf8_safe(macro, p, e, above_latin1)                    \
1909          (__ASSERT_(_utf8_safe_assert(p, e))                                \
1910          (UTF8_IS_INVARIANT(*(p)))                                          \
1911           ? macro(*(p))                                                     \
1912           : (UTF8_IS_DOWNGRADEABLE_START(*(p))                              \
1913              ? ((LIKELY((e) - (p) > 1 && UTF8_IS_CONTINUATION(*((p)+1))))   \
1914                 ? macro(EIGHT_BIT_UTF8_TO_NATIVE(*(p), *((p)+1)))           \
1915                 : (_force_out_malformed_utf8_message(                       \
1916                                         (U8 *) (p), (U8 *) (e), 0, 1), 0))  \
1917               : above_latin1))
1918
1919 #define _generic_LC_swash_utf8_safe(macro, classnum, p, e)                  \
1920             _generic_LC_utf8_safe(macro, p, e,                              \
1921                                _is_utf8_FOO_with_len(classnum, p, e))
1922
1923 #define _generic_LC_func_utf8_safe(macro, above_latin1, p, e)               \
1924             _generic_LC_utf8_safe(macro, p, e, above_latin1(p, e))
1925
1926 #define _generic_LC_non_swash_utf8_safe(classnum, above_latin1, p, e)       \
1927           _generic_LC_utf8_safe(classnum, p, e,                             \
1928                              (UNLIKELY((e) - (p) < UTF8SKIP(p))             \
1929                               ? (_force_out_malformed_utf8_message(         \
1930                                       (U8 *) (p), (U8 *) (e), 0, 1), 0)     \
1931                               : above_latin1(p)))
1932
1933 #define isALPHANUMERIC_LC_utf8_safe(p, e)                                   \
1934             _generic_LC_swash_utf8_safe(isALPHANUMERIC_LC,                  \
1935                                         _CC_ALPHANUMERIC, p, e)
1936 #define isALPHA_LC_utf8_safe(p, e)                                          \
1937             _generic_LC_swash_utf8_safe(isALPHA_LC, _CC_ALPHA, p, e)
1938 #define isASCII_LC_utf8_safe(p, e)                                          \
1939                     (__ASSERT_(_utf8_safe_assert(p, e)) isASCII_LC(*(p)))
1940 #define isBLANK_LC_utf8_safe(p, e)                                          \
1941         _generic_LC_non_swash_utf8_safe(isBLANK_LC, is_HORIZWS_high, p, e)
1942 #define isCNTRL_LC_utf8_safe(p, e)                                          \
1943             _generic_LC_utf8_safe(isCNTRL_LC, p, e, 0)
1944 #define isDIGIT_LC_utf8_safe(p, e)                                          \
1945             _generic_LC_swash_utf8_safe(isDIGIT_LC, _CC_DIGIT, p, e)
1946 #define isGRAPH_LC_utf8_safe(p, e)                                          \
1947             _generic_LC_swash_utf8_safe(isGRAPH_LC, _CC_GRAPH, p, e)
1948 #define isIDCONT_LC_utf8_safe(p, e)                                         \
1949             _generic_LC_func_utf8_safe(isIDCONT_LC,                         \
1950                                 _is_utf8_perl_idcont_with_len, p, e)
1951 #define isIDFIRST_LC_utf8_safe(p, e)                                        \
1952             _generic_LC_func_utf8_safe(isIDFIRST_LC,                        \
1953                                 _is_utf8_perl_idstart_with_len, p, e)
1954 #define isLOWER_LC_utf8_safe(p, e)                                          \
1955             _generic_LC_swash_utf8_safe(isLOWER_LC, _CC_LOWER, p, e)
1956 #define isPRINT_LC_utf8_safe(p, e)                                          \
1957             _generic_LC_swash_utf8_safe(isPRINT_LC, _CC_PRINT, p, e)
1958 #define isPSXSPC_LC_utf8_safe(p, e)    isSPACE_LC_utf8_safe(p, e)
1959 #define isPUNCT_LC_utf8_safe(p, e)                                          \
1960             _generic_LC_swash_utf8_safe(isPUNCT_LC, _CC_PUNCT, p, e)
1961 #define isSPACE_LC_utf8_safe(p, e)                                          \
1962     _generic_LC_non_swash_utf8_safe(isSPACE_LC, is_XPERLSPACE_high, p, e)
1963 #define isUPPER_LC_utf8_safe(p, e)                                          \
1964             _generic_LC_swash_utf8_safe(isUPPER_LC, _CC_UPPER, p, e)
1965 #define isWORDCHAR_LC_utf8_safe(p, e)                                       \
1966             _generic_LC_swash_utf8_safe(isWORDCHAR_LC, _CC_WORDCHAR, p, e)
1967 #define isXDIGIT_LC_utf8_safe(p, e)                                         \
1968         _generic_LC_non_swash_utf8_safe(isXDIGIT_LC, is_XDIGIT_high, p, e)
1969
1970 /* Macros for backwards compatibility and for completeness when the ASCII and
1971  * Latin1 values are identical */
1972 #define isALPHAU(c)         isALPHA_L1(c)
1973 #define isDIGIT_L1(c)       isDIGIT_A(c)
1974 #define isOCTAL(c)          isOCTAL_A(c)
1975 #define isOCTAL_L1(c)       isOCTAL_A(c)
1976 #define isXDIGIT_L1(c)      isXDIGIT_A(c)
1977 #define isALNUM(c)          isWORDCHAR(c)
1978 #define isALNUMU(c)         isWORDCHAR_L1(c)
1979 #define isALNUM_LC(c)       isWORDCHAR_LC(c)
1980 #define isALNUM_uni(c)      isWORDCHAR_uni(c)
1981 #define isALNUM_LC_uvchr(c) isWORDCHAR_LC_uvchr(c)
1982 #define isALNUM_utf8(p)     isWORDCHAR_utf8(p)
1983 #define isALNUM_LC_utf8(p)  isWORDCHAR_LC_utf8(p)
1984 #define isALNUMC_A(c)       isALPHANUMERIC_A(c)      /* Mnemonic: "C's alnum" */
1985 #define isALNUMC_L1(c)      isALPHANUMERIC_L1(c)
1986 #define isALNUMC(c)         isALPHANUMERIC(c)
1987 #define isALNUMC_LC(c)      isALPHANUMERIC_LC(c)
1988 #define isALNUMC_uni(c)     isALPHANUMERIC_uni(c)
1989 #define isALNUMC_LC_uvchr(c) isALPHANUMERIC_LC_uvchr(c)
1990 #define isALNUMC_utf8(p)    isALPHANUMERIC_utf8(p)
1991 #define isALNUMC_LC_utf8(p) isALPHANUMERIC_LC_utf8(p)
1992
1993 /* On EBCDIC platforms, CTRL-@ is 0, CTRL-A is 1, etc, just like on ASCII,
1994  * except that they don't necessarily mean the same characters, e.g. CTRL-D is
1995  * 4 on both systems, but that is EOT on ASCII;  ST on EBCDIC.
1996  * '?' is special-cased on EBCDIC to APC, which is the control there that is
1997  * the outlier from the block that contains the other controls, just like
1998  * toCTRL('?') on ASCII yields DEL, the control that is the outlier from the C0
1999  * block.  If it weren't special cased, it would yield a non-control.
2000  * The conversion works both ways, so toCTRL('D') is 4, and toCTRL(4) is D,
2001  * etc. */
2002 #ifndef EBCDIC
2003 #  define toCTRL(c)    (__ASSERT_(FITS_IN_8_BITS(c)) toUPPER(((U8)(c))) ^ 64)
2004 #else
2005 #  define toCTRL(c)   (__ASSERT_(FITS_IN_8_BITS(c))                     \
2006                       ((isPRINT_A(c))                                   \
2007                        ? (UNLIKELY((c) == '?')                          \
2008                          ? QUESTION_MARK_CTRL                           \
2009                          : (NATIVE_TO_LATIN1(toUPPER((U8) (c))) ^ 64))  \
2010                        : (UNLIKELY((c) == QUESTION_MARK_CTRL)           \
2011                          ? '?'                                          \
2012                          : (LATIN1_TO_NATIVE(((U8) (c)) ^ 64)))))
2013 #endif
2014
2015 /* Line numbers are unsigned, 32 bits. */
2016 typedef U32 line_t;
2017 #define NOLINE ((line_t) 4294967295UL)  /* = FFFFFFFF */
2018
2019 /* Helpful alias for version prescan */
2020 #define is_LAX_VERSION(a,b) \
2021         (a != Perl_prescan_version(aTHX_ a, FALSE, b, NULL, NULL, NULL, NULL))
2022
2023 #define is_STRICT_VERSION(a,b) \
2024         (a != Perl_prescan_version(aTHX_ a, TRUE, b, NULL, NULL, NULL, NULL))
2025
2026 #define BADVERSION(a,b,c) \
2027         if (b) { \
2028             *b = c; \
2029         } \
2030         return a;
2031
2032 /* Converts a character known to represent a hexadecimal digit (0-9, A-F, or
2033  * a-f) to its numeric value.  READ_XDIGIT's argument is a string pointer,
2034  * which is advanced.  The input is validated only by an assert() in DEBUGGING
2035  * builds.  In both ASCII and EBCDIC the last 4 bits of the digits are 0-9; and
2036  * the last 4 bits of A-F and a-f are 1-6, so adding 9 yields 10-15 */
2037 #define XDIGIT_VALUE(c) (__ASSERT_(isXDIGIT(c)) (0xf & (isDIGIT(c)        \
2038                                                         ? (c)             \
2039                                                         : ((c) + 9))))
2040 #define READ_XDIGIT(s)  (__ASSERT_(isXDIGIT(*s)) (0xf & (isDIGIT(*(s))     \
2041                                                         ? (*(s)++)         \
2042                                                         : (*(s)++ + 9))))
2043
2044 /* Converts a character known to represent an octal digit (0-7) to its numeric
2045  * value.  The input is validated only by an assert() in DEBUGGING builds.  In
2046  * both ASCII and EBCDIC the last 3 bits of the octal digits range from 0-7. */
2047 #define OCTAL_VALUE(c) (__ASSERT_(isOCTAL(c)) (7 & (c)))
2048
2049 /* Efficiently returns a boolean as to if two native characters are equivalent
2050  * case-insenstively.  At least one of the characters must be one of [A-Za-z];
2051  * the ALPHA in the name is to remind you of that.  This is asserted() in
2052  * DEBUGGING builds.  Because [A-Za-z] are invariant under UTF-8, this macro
2053  * works (on valid input) for both non- and UTF-8-encoded bytes.
2054  *
2055  * When one of the inputs is a compile-time constant and gets folded by the
2056  * compiler, this reduces to an AND and a TEST.  On both EBCDIC and ASCII
2057  * machines, 'A' and 'a' differ by a single bit; the same with the upper and
2058  * lower case of all other ASCII-range alphabetics.  On ASCII platforms, they
2059  * are 32 apart; on EBCDIC, they are 64.  At compile time, this uses an
2060  * exclusive 'or' to find that bit and then inverts it to form a mask, with
2061  * just a single 0, in the bit position where the upper- and lowercase differ.
2062  * */
2063 #define isALPHA_FOLD_EQ(c1, c2)                                         \
2064                       (__ASSERT_(isALPHA_A(c1) || isALPHA_A(c2))        \
2065                       ((c1) & ~('A' ^ 'a')) ==  ((c2) & ~('A' ^ 'a')))
2066 #define isALPHA_FOLD_NE(c1, c2) (! isALPHA_FOLD_EQ((c1), (c2)))
2067
2068 /*
2069 =head1 Memory Management
2070
2071 =for apidoc Am|void|Newx|void* ptr|int nitems|type
2072 The XSUB-writer's interface to the C C<malloc> function.
2073
2074 Memory obtained by this should B<ONLY> be freed with L</"Safefree">.
2075
2076 In 5.9.3, Newx() and friends replace the older New() API, and drops
2077 the first parameter, I<x>, a debug aid which allowed callers to identify
2078 themselves.  This aid has been superseded by a new build option,
2079 PERL_MEM_LOG (see L<perlhacktips/PERL_MEM_LOG>).  The older API is still
2080 there for use in XS modules supporting older perls.
2081
2082 =for apidoc Am|void|Newxc|void* ptr|int nitems|type|cast
2083 The XSUB-writer's interface to the C C<malloc> function, with
2084 cast.  See also C<L</Newx>>.
2085
2086 Memory obtained by this should B<ONLY> be freed with L</"Safefree">.
2087
2088 =for apidoc Am|void|Newxz|void* ptr|int nitems|type
2089 The XSUB-writer's interface to the C C<malloc> function.  The allocated
2090 memory is zeroed with C<memzero>.  See also C<L</Newx>>.
2091
2092 Memory obtained by this should B<ONLY> be freed with L</"Safefree">.
2093
2094 =for apidoc Am|void|Renew|void* ptr|int nitems|type
2095 The XSUB-writer's interface to the C C<realloc> function.
2096
2097 Memory obtained by this should B<ONLY> be freed with L</"Safefree">.
2098
2099 =for apidoc Am|void|Renewc|void* ptr|int nitems|type|cast
2100 The XSUB-writer's interface to the C C<realloc> function, with
2101 cast.
2102
2103 Memory obtained by this should B<ONLY> be freed with L</"Safefree">.
2104
2105 =for apidoc Am|void|Safefree|void* ptr
2106 The XSUB-writer's interface to the C C<free> function.
2107
2108 This should B<ONLY> be used on memory obtained using L</"Newx"> and friends.
2109
2110 =for apidoc Am|void|Move|void* src|void* dest|int nitems|type
2111 The XSUB-writer's interface to the C C<memmove> function.  The C<src> is the
2112 source, C<dest> is the destination, C<nitems> is the number of items, and
2113 C<type> is the type.  Can do overlapping moves.  See also C<L</Copy>>.
2114
2115 =for apidoc Am|void *|MoveD|void* src|void* dest|int nitems|type
2116 Like C<Move> but returns C<dest>.  Useful
2117 for encouraging compilers to tail-call
2118 optimise.
2119
2120 =for apidoc Am|void|Copy|void* src|void* dest|int nitems|type
2121 The XSUB-writer's interface to the C C<memcpy> function.  The C<src> is the
2122 source, C<dest> is the destination, C<nitems> is the number of items, and
2123 C<type> is the type.  May fail on overlapping copies.  See also C<L</Move>>.
2124
2125 =for apidoc Am|void *|CopyD|void* src|void* dest|int nitems|type
2126
2127 Like C<Copy> but returns C<dest>.  Useful
2128 for encouraging compilers to tail-call
2129 optimise.
2130
2131 =for apidoc Am|void|Zero|void* dest|int nitems|type
2132
2133 The XSUB-writer's interface to the C C<memzero> function.  The C<dest> is the
2134 destination, C<nitems> is the number of items, and C<type> is the type.
2135
2136 =for apidoc Am|void *|ZeroD|void* dest|int nitems|type
2137
2138 Like C<Zero> but returns dest.  Useful
2139 for encouraging compilers to tail-call
2140 optimise.
2141
2142 =for apidoc Am|void|StructCopy|type *src|type *dest|type
2143 This is an architecture-independent macro to copy one structure to another.
2144
2145 =for apidoc Am|void|PoisonWith|void* dest|int nitems|type|U8 byte
2146
2147 Fill up memory with a byte pattern (a byte repeated over and over
2148 again) that hopefully catches attempts to access uninitialized memory.
2149
2150 =for apidoc Am|void|PoisonNew|void* dest|int nitems|type
2151
2152 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2153
2154 =for apidoc Am|void|PoisonFree|void* dest|int nitems|type
2155
2156 PoisonWith(0xEF) for catching access to freed memory.
2157
2158 =for apidoc Am|void|Poison|void* dest|int nitems|type
2159
2160 PoisonWith(0xEF) for catching access to freed memory.
2161
2162 =cut */
2163
2164 /* Maintained for backwards-compatibility only. Use newSV() instead. */
2165 #ifndef PERL_CORE
2166 #define NEWSV(x,len)    newSV(len)
2167 #endif
2168
2169 #define MEM_SIZE_MAX ((MEM_SIZE)~0)
2170
2171
2172 #ifdef PERL_MALLOC_WRAP
2173
2174 /* This expression will be constant-folded at compile time.  It checks
2175  * whether or not the type of the count n is so small (e.g. U8 or U16, or
2176  * U32 on 64-bit systems) that there's no way a wrap-around could occur.
2177  * As well as avoiding the need for a run-time check in some cases, it's
2178  * designed to avoid compiler warnings like:
2179  *     comparison is always false due to limited range of data type
2180  * It's mathematically equivalent to
2181  *    max(n) * sizeof(t) > MEM_SIZE_MAX
2182  */
2183
2184 #  define _MEM_WRAP_NEEDS_RUNTIME_CHECK(n,t) \
2185     (8 * sizeof(n) + sizeof(t) > sizeof(MEM_SIZE))
2186
2187 /* This is written in a slightly odd way to avoid various spurious
2188  * compiler warnings. We *want* to write the expression as
2189  *    _MEM_WRAP_NEEDS_RUNTIME_CHECK(n,t) && (n > C)
2190  * (for some compile-time constant C), but even when the LHS
2191  * constant-folds to false at compile-time, g++ insists on emitting
2192  * warnings about the RHS (e.g. "comparison is always false"), so instead
2193  * we write it as
2194  *
2195  *    (cond ? n : X) > C
2196  *
2197  * where X is a constant with X > C always false. Choosing a value for X
2198  * is tricky. If 0, some compilers will complain about 0 > C always being
2199  * false; if 1, Coverity complains when n happens to be the constant value
2200  * '1', that cond ? 1 : 1 has the same value on both branches; so use C
2201  * for X and hope that nothing else whines.
2202  */
2203
2204 #  define _MEM_WRAP_WILL_WRAP(n,t) \
2205       ((_MEM_WRAP_NEEDS_RUNTIME_CHECK(n,t) ? (MEM_SIZE)(n) : \
2206             MEM_SIZE_MAX/sizeof(t)) > MEM_SIZE_MAX/sizeof(t))
2207
2208 #  define MEM_WRAP_CHECK(n,t) \
2209         (void)(UNLIKELY(_MEM_WRAP_WILL_WRAP(n,t)) \
2210         && (croak_memory_wrap(),0))
2211
2212 #  define MEM_WRAP_CHECK_1(n,t,a) \
2213         (void)(UNLIKELY(_MEM_WRAP_WILL_WRAP(n,t)) \
2214         && (Perl_croak_nocontext("%s",(a)),0))
2215
2216 #define MEM_WRAP_CHECK_(n,t) MEM_WRAP_CHECK(n,t),
2217
2218 #define PERL_STRLEN_ROUNDUP(n) ((void)(((n) > MEM_SIZE_MAX - 2 * PERL_STRLEN_ROUNDUP_QUANTUM) ? (croak_memory_wrap(),0):0),((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
2219 #else
2220
2221 #define MEM_WRAP_CHECK(n,t)
2222 #define MEM_WRAP_CHECK_1(n,t,a)
2223 #define MEM_WRAP_CHECK_2(n,t,a,b)
2224 #define MEM_WRAP_CHECK_(n,t)
2225
2226 #define PERL_STRLEN_ROUNDUP(n) (((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
2227
2228 #endif
2229
2230 #ifdef PERL_MEM_LOG
2231 /*
2232  * If PERL_MEM_LOG is defined, all Newx()s, Renew()s, and Safefree()s
2233  * go through functions, which are handy for debugging breakpoints, but
2234  * which more importantly get the immediate calling environment (file and
2235  * line number, and C function name if available) passed in.  This info can
2236  * then be used for logging the calls, for which one gets a sample
2237  * implementation unless -DPERL_MEM_LOG_NOIMPL is also defined.
2238  *
2239  * Known problems:
2240  * - not all memory allocs get logged, only those
2241  *   that go through Newx() and derivatives (while all
2242  *   Safefrees do get logged)
2243  * - __FILE__ and __LINE__ do not work everywhere
2244  * - __func__ or __FUNCTION__ even less so
2245  * - I think more goes on after the perlio frees but
2246  *   the thing is that STDERR gets closed (as do all
2247  *   the file descriptors)
2248  * - no deeper calling stack than the caller of the Newx()
2249  *   or the kind, but do I look like a C reflection/introspection
2250  *   utility to you?
2251  * - the function prototypes for the logging functions
2252  *   probably should maybe be somewhere else than handy.h
2253  * - one could consider inlining (macrofying) the logging
2254  *   for speed, but I am too lazy
2255  * - one could imagine recording the allocations in a hash,
2256  *   (keyed by the allocation address?), and maintain that
2257  *   through reallocs and frees, but how to do that without
2258  *   any News() happening...?
2259  * - lots of -Ddefines to get useful/controllable output
2260  * - lots of ENV reads
2261  */
2262
2263 # ifdef PERL_CORE
2264 #  ifndef PERL_MEM_LOG_NOIMPL
2265 enum mem_log_type {
2266   MLT_ALLOC,
2267   MLT_REALLOC,
2268   MLT_FREE,
2269   MLT_NEW_SV,
2270   MLT_DEL_SV
2271 };
2272 #  endif
2273 #  if defined(PERL_IN_SV_C)  /* those are only used in sv.c */
2274 void Perl_mem_log_new_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
2275 void Perl_mem_log_del_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
2276 #  endif
2277 # endif
2278
2279 #endif
2280
2281 #ifdef PERL_MEM_LOG
2282 #define MEM_LOG_ALLOC(n,t,a)     Perl_mem_log_alloc(n,sizeof(t),STRINGIFY(t),a,__FILE__,__LINE__,FUNCTION__)
2283 #define MEM_LOG_REALLOC(n,t,v,a) Perl_mem_log_realloc(n,sizeof(t),STRINGIFY(t),v,a,__FILE__,__LINE__,FUNCTION__)
2284 #define MEM_LOG_FREE(a)          Perl_mem_log_free(a,__FILE__,__LINE__,FUNCTION__)
2285 #endif
2286
2287 #ifndef MEM_LOG_ALLOC
2288 #define MEM_LOG_ALLOC(n,t,a)     (a)
2289 #endif
2290 #ifndef MEM_LOG_REALLOC
2291 #define MEM_LOG_REALLOC(n,t,v,a) (a)
2292 #endif
2293 #ifndef MEM_LOG_FREE
2294 #define MEM_LOG_FREE(a)          (a)
2295 #endif
2296
2297 #define Newx(v,n,t)     (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
2298 #define Newxc(v,n,t,c)  (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
2299 #define Newxz(v,n,t)    (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safecalloc((n),sizeof(t)))))
2300
2301 #ifndef PERL_CORE
2302 /* pre 5.9.x compatibility */
2303 #define New(x,v,n,t)    Newx(v,n,t)
2304 #define Newc(x,v,n,t,c) Newxc(v,n,t,c)
2305 #define Newz(x,v,n,t)   Newxz(v,n,t)
2306 #endif
2307
2308 #define Renew(v,n,t) \
2309           (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
2310 #define Renewc(v,n,t,c) \
2311           (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
2312
2313 #ifdef PERL_POISON
2314 #define Safefree(d) \
2315   ((d) ? (void)(safefree(MEM_LOG_FREE((Malloc_t)(d))), Poison(&(d), 1, Malloc_t)) : (void) 0)
2316 #else
2317 #define Safefree(d)     safefree(MEM_LOG_FREE((Malloc_t)(d)))
2318 #endif
2319
2320 #define Move(s,d,n,t)   (MEM_WRAP_CHECK_(n,t) (void)memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
2321 #define Copy(s,d,n,t)   (MEM_WRAP_CHECK_(n,t) (void)memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
2322 #define Zero(d,n,t)     (MEM_WRAP_CHECK_(n,t) (void)memzero((char*)(d), (n) * sizeof(t)))
2323
2324 #define MoveD(s,d,n,t)  (MEM_WRAP_CHECK_(n,t) memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
2325 #define CopyD(s,d,n,t)  (MEM_WRAP_CHECK_(n,t) memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
2326 #ifdef HAS_MEMSET
2327 #define ZeroD(d,n,t)    (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)))
2328 #else
2329 /* Using bzero(), which returns void.  */
2330 #define ZeroD(d,n,t)    (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)),d)
2331 #endif
2332
2333 #define PoisonWith(d,n,t,b)     (MEM_WRAP_CHECK_(n,t) (void)memset((char*)(d), (U8)(b), (n) * sizeof(t)))
2334 #define PoisonNew(d,n,t)        PoisonWith(d,n,t,0xAB)
2335 #define PoisonFree(d,n,t)       PoisonWith(d,n,t,0xEF)
2336 #define Poison(d,n,t)           PoisonFree(d,n,t)
2337
2338 #ifdef PERL_POISON
2339 #  define PERL_POISON_EXPR(x) x
2340 #else
2341 #  define PERL_POISON_EXPR(x)
2342 #endif
2343
2344 #ifdef USE_STRUCT_COPY
2345 #define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
2346 #else
2347 #define StructCopy(s,d,t) Copy(s,d,1,t)
2348 #endif
2349
2350 /* C_ARRAY_LENGTH is the number of elements in the C array (so you
2351  * want your zero-based indices to be less than but not equal to).
2352  *
2353  * C_ARRAY_END is one past the last: half-open/half-closed range,
2354  * not last-inclusive range. */
2355 #define C_ARRAY_LENGTH(a)       (sizeof(a)/sizeof((a)[0]))
2356 #define C_ARRAY_END(a)          ((a) + C_ARRAY_LENGTH(a))
2357
2358 #ifdef NEED_VA_COPY
2359 # ifdef va_copy
2360 #  define Perl_va_copy(s, d) va_copy(d, s)
2361 # else
2362 #  if defined(__va_copy)
2363 #   define Perl_va_copy(s, d) __va_copy(d, s)
2364 #  else
2365 #   define Perl_va_copy(s, d) Copy(s, d, 1, va_list)
2366 #  endif
2367 # endif
2368 #endif
2369
2370 /* convenience debug macros */
2371 #ifdef USE_ITHREADS
2372 #define pTHX_FORMAT  "Perl interpreter: 0x%p"
2373 #define pTHX__FORMAT ", Perl interpreter: 0x%p"
2374 #define pTHX_VALUE_   (void *)my_perl,
2375 #define pTHX_VALUE    (void *)my_perl
2376 #define pTHX__VALUE_ ,(void *)my_perl,
2377 #define pTHX__VALUE  ,(void *)my_perl
2378 #else
2379 #define pTHX_FORMAT
2380 #define pTHX__FORMAT
2381 #define pTHX_VALUE_
2382 #define pTHX_VALUE
2383 #define pTHX__VALUE_
2384 #define pTHX__VALUE
2385 #endif /* USE_ITHREADS */
2386
2387 /* Perl_deprecate was not part of the public API, and did not have a deprecate()
2388    shortcut macro defined without -DPERL_CORE. Neither codesearch.google.com nor
2389    CPAN::Unpack show any users outside the core.  */
2390 #ifdef PERL_CORE
2391 #  define deprecate(s) Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),    \
2392                                             "Use of " s " is deprecated")
2393 #endif
2394
2395 /* Internal macros to deal with gids and uids */
2396 #ifdef PERL_CORE
2397
2398 #  if Uid_t_size > IVSIZE
2399 #    define sv_setuid(sv, uid)       sv_setnv((sv), (NV)(uid))
2400 #    define SvUID(sv)                SvNV(sv)
2401 #  else
2402 #    if Uid_t_sign <= 0
2403 #      define sv_setuid(sv, uid)       sv_setiv((sv), (IV)(uid))
2404 #      define SvUID(sv)                SvIV(sv)
2405 #    else
2406 #      define sv_setuid(sv, uid)       sv_setuv((sv), (UV)(uid))
2407 #      define SvUID(sv)                SvUV(sv)
2408 #    endif
2409 #  endif /* Uid_t_size */
2410
2411 #  if Gid_t_size > IVSIZE
2412 #    define sv_setgid(sv, gid)       sv_setnv((sv), (NV)(gid))
2413 #    define SvGID(sv)                SvNV(sv)
2414 #  else
2415 #    if Gid_t_sign <= 0
2416 #      define sv_setgid(sv, gid)       sv_setiv((sv), (IV)(gid))
2417 #      define SvGID(sv)                SvIV(sv)
2418 #    else
2419 #      define sv_setgid(sv, gid)       sv_setuv((sv), (UV)(gid))
2420 #      define SvGID(sv)                SvUV(sv)
2421 #    endif
2422 #  endif /* Gid_t_size */
2423
2424 #endif
2425
2426 #endif  /* HANDY_H */
2427
2428 /*
2429  * ex: set ts=8 sts=4 sw=4 et:
2430  */