RT #75870 perldata.pod tied hash in scalar context
[perl.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 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 #if !defined(__STDC__)
12 #ifdef NULL
13 #undef NULL
14 #endif
15 #ifndef I286
16 #  define NULL 0
17 #else
18 #  define NULL 0L
19 #endif
20 #endif
21
22 #ifndef PERL_CORE
23 #  define Null(type) ((type)NULL)
24
25 /*
26 =head1 Handy Values
27
28 =for apidoc AmU||Nullch
29 Null character pointer. (No longer available when C<PERL_CORE> is defined.)
30
31 =for apidoc AmU||Nullsv
32 Null SV pointer. (No longer available when C<PERL_CORE> is defined.)
33
34 =cut
35 */
36
37 #  define Nullch Null(char*)
38 #  define Nullfp Null(PerlIO*)
39 #  define Nullsv Null(SV*)
40 #endif
41
42 #ifdef TRUE
43 #undef TRUE
44 #endif
45 #ifdef FALSE
46 #undef FALSE
47 #endif
48 #define TRUE (1)
49 #define FALSE (0)
50
51 /* The MUTABLE_*() macros cast pointers to the types shown, in such a way
52  * (compiler permitting) that casting away const-ness will give a warning;
53  * e.g.:
54  *
55  * const SV *sv = ...;
56  * AV *av1 = (AV*)sv;        <== BAD:  the const has been silently cast away
57  * AV *av2 = MUTABLE_AV(sv); <== GOOD: it may warn
58  */
59
60 #if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
61 #  define MUTABLE_PTR(p) ({ void *_p = (p); _p; })
62 #else
63 #  define MUTABLE_PTR(p) ((void *) (p))
64 #endif
65
66 #define MUTABLE_AV(p)   ((AV *)MUTABLE_PTR(p))
67 #define MUTABLE_CV(p)   ((CV *)MUTABLE_PTR(p))
68 #define MUTABLE_GV(p)   ((GV *)MUTABLE_PTR(p))
69 #define MUTABLE_HV(p)   ((HV *)MUTABLE_PTR(p))
70 #define MUTABLE_IO(p)   ((IO *)MUTABLE_PTR(p))
71 #define MUTABLE_SV(p)   ((SV *)MUTABLE_PTR(p))
72
73 /* XXX Configure ought to have a test for a boolean type, if I can
74    just figure out all the headers such a test needs.
75    Andy Dougherty       August 1996
76 */
77 /* bool is built-in for g++-2.6.3 and later, which might be used
78    for extensions.  <_G_config.h> defines _G_HAVE_BOOL, but we can't
79    be sure _G_config.h will be included before this file.  _G_config.h
80    also defines _G_HAVE_BOOL for both gcc and g++, but only g++
81    actually has bool.  Hence, _G_HAVE_BOOL is pretty useless for us.
82    g++ can be identified by __GNUG__.
83    Andy Dougherty       February 2000
84 */
85 #ifdef __GNUG__         /* GNU g++ has bool built-in */
86 #  ifndef HAS_BOOL
87 #    define HAS_BOOL 1
88 #  endif
89 #endif
90
91 /* The NeXT dynamic loader headers will not build with the bool macro
92    So declare them now to clear confusion.
93 */
94 #if defined(NeXT) || defined(__NeXT__)
95 # undef FALSE
96 # undef TRUE
97   typedef enum bool { FALSE = 0, TRUE = 1 } bool;
98 # define ENUM_BOOL 1
99 # ifndef HAS_BOOL
100 #  define HAS_BOOL 1
101 # endif /* !HAS_BOOL */
102 #endif /* NeXT || __NeXT__ */
103
104 #ifndef HAS_BOOL
105 # if defined(UTS) || defined(VMS)
106 #  define bool int
107 # else
108 #  define bool char
109 # endif
110 # define HAS_BOOL 1
111 #endif
112
113 /* a simple (bool) cast may not do the right thing: if bool is defined
114  * as char for example, then the cast from int is implementation-defined
115  */
116
117 #define cBOOL(cbool) ((bool)!!(cbool))
118
119 /* Try to figure out __func__ or __FUNCTION__ equivalent, if any.
120  * XXX Should really be a Configure probe, with HAS__FUNCTION__
121  *     and FUNCTION__ as results.
122  * XXX Similarly, a Configure probe for __FILE__ and __LINE__ is needed. */
123 #if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || (defined(__SUNPRO_C)) /* C99 or close enough. */
124 #  define FUNCTION__ __func__
125 #else
126 #  if (defined(_MSC_VER) && _MSC_VER < 1300) || /* Pre-MSVC 7.0 has neither __func__ nor __FUNCTION and no good workarounds, either. */ \
127       (defined(__DECC_VER)) /* Tru64 or VMS, and strict C89 being used, but not modern enough cc (in Tur64, -c99 not known, only -std1). */
128 #    define FUNCTION__ ""
129 #  else
130 #    define FUNCTION__ __FUNCTION__ /* Common extension. */
131 #  endif
132 #endif
133
134 /* XXX A note on the perl source internal type system.  The
135    original intent was that I32 be *exactly* 32 bits.
136
137    Currently, we only guarantee that I32 is *at least* 32 bits.
138    Specifically, if int is 64 bits, then so is I32.  (This is the case
139    for the Cray.)  This has the advantage of meshing nicely with
140    standard library calls (where we pass an I32 and the library is
141    expecting an int), but the disadvantage that an I32 is not 32 bits.
142    Andy Dougherty       August 1996
143
144    There is no guarantee that there is *any* integral type with
145    exactly 32 bits.  It is perfectly legal for a system to have
146    sizeof(short) == sizeof(int) == sizeof(long) == 8.
147
148    Similarly, there is no guarantee that I16 and U16 have exactly 16
149    bits.
150
151    For dealing with issues that may arise from various 32/64-bit
152    systems, we will ask Configure to check out
153
154         SHORTSIZE == sizeof(short)
155         INTSIZE == sizeof(int)
156         LONGSIZE == sizeof(long)
157         LONGLONGSIZE == sizeof(long long) (if HAS_LONG_LONG)
158         PTRSIZE == sizeof(void *)
159         DOUBLESIZE == sizeof(double)
160         LONG_DOUBLESIZE == sizeof(long double) (if HAS_LONG_DOUBLE).
161
162 */
163
164 #ifdef I_INTTYPES /* e.g. Linux has int64_t without <inttypes.h> */
165 #   include <inttypes.h>
166 #   ifdef INT32_MIN_BROKEN
167 #       undef  INT32_MIN
168 #       define INT32_MIN (-2147483647-1)
169 #   endif
170 #   ifdef INT64_MIN_BROKEN
171 #       undef  INT64_MIN
172 #       define INT64_MIN (-9223372036854775807LL-1)
173 #   endif
174 #endif
175
176 typedef I8TYPE I8;
177 typedef U8TYPE U8;
178 typedef I16TYPE I16;
179 typedef U16TYPE U16;
180 typedef I32TYPE I32;
181 typedef U32TYPE U32;
182 #ifdef PERL_CORE
183 #   ifdef HAS_QUAD
184 typedef I64TYPE I64;
185 typedef U64TYPE U64;
186 #   endif
187 #endif /* PERL_CORE */
188
189 #if defined(HAS_QUAD) && defined(USE_64_BIT_INT)
190 #   ifndef UINT64_C /* usually from <inttypes.h> */
191 #       if defined(HAS_LONG_LONG) && QUADKIND == QUAD_IS_LONG_LONG
192 #           define INT64_C(c)   CAT2(c,LL)
193 #           define UINT64_C(c)  CAT2(c,ULL)
194 #       else
195 #           if LONGSIZE == 8 && QUADKIND == QUAD_IS_LONG
196 #               define INT64_C(c)       CAT2(c,L)
197 #               define UINT64_C(c)      CAT2(c,UL)
198 #           else
199 #               if defined(_WIN64) && defined(_MSC_VER)
200 #                   define INT64_C(c)   CAT2(c,I64)
201 #                   define UINT64_C(c)  CAT2(c,UI64)
202 #               else
203 #                   define INT64_C(c)   ((I64TYPE)(c))
204 #                   define UINT64_C(c)  ((U64TYPE)(c))
205 #               endif
206 #           endif
207 #       endif
208 #   endif
209 #endif
210
211 #if defined(UINT8_MAX) && defined(INT16_MAX) && defined(INT32_MAX)
212
213 /* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
214    Please search CHAR_MAX in perl.h for further details. */
215 #define U8_MAX UINT8_MAX
216 #define U8_MIN UINT8_MIN
217
218 #define I16_MAX INT16_MAX
219 #define I16_MIN INT16_MIN
220 #define U16_MAX UINT16_MAX
221 #define U16_MIN UINT16_MIN
222
223 #define I32_MAX INT32_MAX
224 #define I32_MIN INT32_MIN
225 #ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */
226 #  define U32_MAX UINT32_MAX
227 #else
228 #  define U32_MAX 4294967295U
229 #endif
230 #define U32_MIN UINT32_MIN
231
232 #else
233
234 /* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type.
235    Please search CHAR_MAX in perl.h for further details. */
236 #define U8_MAX PERL_UCHAR_MAX
237 #define U8_MIN PERL_UCHAR_MIN
238
239 #define I16_MAX PERL_SHORT_MAX
240 #define I16_MIN PERL_SHORT_MIN
241 #define U16_MAX PERL_USHORT_MAX
242 #define U16_MIN PERL_USHORT_MIN
243
244 #if LONGSIZE > 4
245 # define I32_MAX PERL_INT_MAX
246 # define I32_MIN PERL_INT_MIN
247 # define U32_MAX PERL_UINT_MAX
248 # define U32_MIN PERL_UINT_MIN
249 #else
250 # define I32_MAX PERL_LONG_MAX
251 # define I32_MIN PERL_LONG_MIN
252 # define U32_MAX PERL_ULONG_MAX
253 # define U32_MIN PERL_ULONG_MIN
254 #endif
255
256 #endif
257
258 /* log(2) is pretty close to  0.30103, just in case anyone is grepping for it */
259 #define BIT_DIGITS(N)   (((N)*146)/485 + 1)  /* log2(10) =~ 146/485 */
260 #define TYPE_DIGITS(T)  BIT_DIGITS(sizeof(T) * 8)
261 #define TYPE_CHARS(T)   (TYPE_DIGITS(T) + 2) /* sign, NUL */
262
263 #define Ctl(ch) ((ch) & 037)
264
265 /*
266 =head1 SV-Body Allocation
267
268 =for apidoc Ama|SV*|newSVpvs|const char* s
269 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
270
271 =for apidoc Ama|SV*|newSVpvs_flags|const char* s|U32 flags
272 Like C<newSVpvn_flags>, but takes a literal string instead of a string/length
273 pair.
274
275 =for apidoc Ama|SV*|newSVpvs_share|const char* s
276 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
277 pair and omits the hash parameter.
278
279 =for apidoc Am|void|sv_catpvs_flags|SV* sv|const char* s|I32 flags
280 Like C<sv_catpvn_flags>, but takes a literal string instead of a
281 string/length pair.
282
283 =for apidoc Am|void|sv_catpvs_nomg|SV* sv|const char* s
284 Like C<sv_catpvn_nomg>, but takes a literal string instead of a
285 string/length pair.
286
287 =for apidoc Am|void|sv_catpvs|SV* sv|const char* s
288 Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
289
290 =for apidoc Am|void|sv_catpvs_mg|SV* sv|const char* s
291 Like C<sv_catpvn_mg>, but takes a literal string instead of a
292 string/length pair.
293
294 =for apidoc Am|void|sv_setpvs|SV* sv|const char* s
295 Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
296
297 =for apidoc Am|void|sv_setpvs_mg|SV* sv|const char* s
298 Like C<sv_setpvn_mg>, but takes a literal string instead of a
299 string/length pair.
300
301 =for apidoc Am|SV *|sv_setref_pvs|const char* s
302 Like C<sv_setref_pvn>, but takes a literal string instead of a
303 string/length pair.
304
305 =head1 Memory Management
306
307 =for apidoc Ama|char*|savepvs|const char* s
308 Like C<savepvn>, but takes a literal string instead of a string/length pair.
309
310 =for apidoc Ama|char*|savesharedpvs|const char* s
311 A version of C<savepvs()> which allocates the duplicate string in memory
312 which is shared between threads.
313
314 =head1 GV Functions
315
316 =for apidoc Am|HV*|gv_stashpvs|const char* name|I32 create
317 Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
318
319 =head1 Hash Manipulation Functions
320
321 =for apidoc Am|SV**|hv_fetchs|HV* tb|const char* key|I32 lval
322 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
323
324 =for apidoc Am|SV**|hv_stores|HV* tb|const char* key|NULLOK SV* val
325 Like C<hv_store>, but takes a literal string instead of a string/length pair
326 and omits the hash parameter.
327
328 =head1 Lexer interface
329
330 =for apidoc Amx|void|lex_stuff_pvs|const char *pv|U32 flags
331
332 Like L</lex_stuff_pvn>, but takes a literal string instead of a
333 string/length pair.
334
335 =cut
336 */
337
338 /* concatenating with "" ensures that only literal strings are accepted as argument */
339 #define STR_WITH_LEN(s)  ("" s ""), (sizeof(s)-1)
340
341 /* note that STR_WITH_LEN() can't be used as argument to macros or functions that
342  * under some configurations might be macros, which means that it requires the full
343  * Perl_xxx(aTHX_ ...) form for any API calls where it's used.
344  */
345
346 /* STR_WITH_LEN() shortcuts */
347 #define newSVpvs(str) Perl_newSVpvn(aTHX_ STR_WITH_LEN(str))
348 #define newSVpvs_flags(str,flags)       \
349     Perl_newSVpvn_flags(aTHX_ STR_WITH_LEN(str), flags)
350 #define newSVpvs_share(str) Perl_newSVpvn_share(aTHX_ STR_WITH_LEN(str), 0)
351 #define sv_catpvs_flags(sv, str, flags) \
352     Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), flags)
353 #define sv_catpvs_nomg(sv, str) \
354     Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), 0)
355 #define sv_catpvs(sv, str) \
356     Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC)
357 #define sv_catpvs_mg(sv, str) \
358     Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC|SV_SMAGIC)
359 #define sv_setpvs(sv, str) Perl_sv_setpvn(aTHX_ sv, STR_WITH_LEN(str))
360 #define sv_setpvs_mg(sv, str) Perl_sv_setpvn_mg(aTHX_ sv, STR_WITH_LEN(str))
361 #define sv_setref_pvs(rv, classname, str) \
362     Perl_sv_setref_pvn(aTHX_ rv, classname, STR_WITH_LEN(str))
363 #define savepvs(str) Perl_savepvn(aTHX_ STR_WITH_LEN(str))
364 #define savesharedpvs(str) Perl_savesharedpvn(aTHX_ STR_WITH_LEN(str))
365 #define gv_stashpvs(str, create) \
366     Perl_gv_stashpvn(aTHX_ STR_WITH_LEN(str), create)
367 #define gv_fetchpvs(namebeg, add, sv_type) \
368     Perl_gv_fetchpvn_flags(aTHX_ STR_WITH_LEN(namebeg), add, sv_type)
369 #define gv_fetchpvn(namebeg, len, add, sv_type) \
370     Perl_gv_fetchpvn_flags(aTHX_ namebeg, len, add, sv_type)
371 #define sv_catxmlpvs(dsv, str, utf8) \
372     Perl_sv_catxmlpvn(aTHX_ dsv, STR_WITH_LEN(str), utf8)
373 #define hv_fetchs(hv,key,lval)                                          \
374   ((SV **)Perl_hv_common(aTHX_ (hv), NULL, STR_WITH_LEN(key), 0,        \
375                          (lval) ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE)  \
376                          : HV_FETCH_JUST_SV, NULL, 0))
377
378 #define hv_stores(hv,key,val)                                           \
379   ((SV **)Perl_hv_common(aTHX_ (hv), NULL, STR_WITH_LEN(key), 0,        \
380                          (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (val), 0))
381
382 #define lex_stuff_pvs(pv,flags) Perl_lex_stuff_pvn(aTHX_ STR_WITH_LEN(pv), flags)
383
384 #define get_cvs(str, flags)                                     \
385         Perl_get_cvn_flags(aTHX_ STR_WITH_LEN(str), (flags))
386
387 /*
388 =head1 Miscellaneous Functions
389
390 =for apidoc Am|bool|strNE|char* s1|char* s2
391 Test two strings to see if they are different.  Returns true or
392 false.
393
394 =for apidoc Am|bool|strEQ|char* s1|char* s2
395 Test two strings to see if they are equal.  Returns true or false.
396
397 =for apidoc Am|bool|strLT|char* s1|char* s2
398 Test two strings to see if the first, C<s1>, is less than the second,
399 C<s2>.  Returns true or false.
400
401 =for apidoc Am|bool|strLE|char* s1|char* s2
402 Test two strings to see if the first, C<s1>, is less than or equal to the
403 second, C<s2>.  Returns true or false.
404
405 =for apidoc Am|bool|strGT|char* s1|char* s2
406 Test two strings to see if the first, C<s1>, is greater than the second,
407 C<s2>.  Returns true or false.
408
409 =for apidoc Am|bool|strGE|char* s1|char* s2
410 Test two strings to see if the first, C<s1>, is greater than or equal to
411 the second, C<s2>.  Returns true or false.
412
413 =for apidoc Am|bool|strnNE|char* s1|char* s2|STRLEN len
414 Test two strings to see if they are different.  The C<len> parameter
415 indicates the number of bytes to compare.  Returns true or false. (A
416 wrapper for C<strncmp>).
417
418 =for apidoc Am|bool|strnEQ|char* s1|char* s2|STRLEN len
419 Test two strings to see if they are equal.  The C<len> parameter indicates
420 the number of bytes to compare.  Returns true or false. (A wrapper for
421 C<strncmp>).
422
423 =cut
424 */
425
426 #define strNE(s1,s2) (strcmp(s1,s2))
427 #define strEQ(s1,s2) (!strcmp(s1,s2))
428 #define strLT(s1,s2) (strcmp(s1,s2) < 0)
429 #define strLE(s1,s2) (strcmp(s1,s2) <= 0)
430 #define strGT(s1,s2) (strcmp(s1,s2) > 0)
431 #define strGE(s1,s2) (strcmp(s1,s2) >= 0)
432 #define strnNE(s1,s2,l) (strncmp(s1,s2,l))
433 #define strnEQ(s1,s2,l) (!strncmp(s1,s2,l))
434
435 #ifdef HAS_MEMCMP
436 #  define memNE(s1,s2,l) (memcmp(s1,s2,l))
437 #  define memEQ(s1,s2,l) (!memcmp(s1,s2,l))
438 #else
439 #  define memNE(s1,s2,l) (bcmp(s1,s2,l))
440 #  define memEQ(s1,s2,l) (!bcmp(s1,s2,l))
441 #endif
442
443 #define memEQs(s1, l, s2) \
444         (sizeof(s2)-1 == l && memEQ(s1, ("" s2 ""), (sizeof(s2)-1)))
445 #define memNEs(s1, l, s2) !memEQs(s1, l, s2)
446
447 /*
448  * Character classes.
449  *
450  * Unfortunately, the introduction of locales means that we
451  * can't trust isupper(), etc. to tell the truth.  And when
452  * it comes to /\w+/ with tainting enabled, we *must* be able
453  * to trust our character classes.
454  *
455  * Therefore, the default tests in the text of Perl will be
456  * independent of locale.  Any code that wants to depend on
457  * the current locale will use the tests that begin with "lc".
458  */
459
460 #ifdef HAS_SETLOCALE  /* XXX Is there a better test for this? */
461 #  ifndef CTYPE256
462 #    define CTYPE256
463 #  endif
464 #endif
465
466 /*
467
468 =head1 Character classes
469 There are three variants for all the functions in this section.  The base ones
470 operate using the character set of the platform Perl is running on.  The ones
471 with an C<_A> suffix operate on the ASCII character set, and the ones with an
472 C<_L1> suffix operate on the full Latin1 character set.  All are unaffected by
473 locale
474
475 For ASCII platforms, the base function with no suffix and the one with the
476 C<_A> suffix are identical.  The function with the C<_L1> suffix imposes the
477 Latin-1 character set onto the platform.  That is, the code points that are
478 ASCII are unaffected, since ASCII is a subset of Latin-1.  But the non-ASCII
479 code points are treated as if they are Latin-1 characters.  For example,
480 C<isSPACE_L1()> will return true when called with the code point 0xA0, which is
481 the Latin-1 NO-BREAK SPACE.
482
483 For EBCDIC platforms, the base function with no suffix and the one with the
484 C<_L1> suffix should be identical, since, as of this writing, the EBCDIC code
485 pages that Perl knows about all are equivalent to Latin-1.  The function that
486 ends in an C<_A> suffix will not return true unless the specified character also
487 has an ASCII equivalent.
488
489 =for apidoc Am|bool|isALPHA|char ch
490 Returns a boolean indicating whether the specified character is an
491 alphabetic character in the platform's native character set.
492 See the L<top of this section|/Character classes> for an explanation of variants
493 C<isALPHA_A> and C<isALPHA_L1>.
494
495 =for apidoc Am|bool|isASCII|char ch
496 Returns a boolean indicating whether the specified character is one of the 128
497 characters in the ASCII character set.  On non-ASCII platforms, it is if this
498 character corresponds to an ASCII character.  Variants C<isASCII_A()> and
499 C<isASCII_L1()> are identical to C<isASCII()>.
500
501 =for apidoc Am|bool|isDIGIT|char ch
502 Returns a boolean indicating whether the specified character is a
503 digit in the platform's native character set.
504 Variants C<isDIGIT_A> and C<isDIGIT_L1> are identical to C<isDIGIT>.
505
506 =for apidoc Am|bool|isLOWER|char ch
507 Returns a boolean indicating whether the specified character is a
508 lowercase character in the platform's native character set.
509 See the L<top of this section|/Character classes> for an explanation of variants
510 C<isLOWER_A> and C<isLOWER_L1>.
511
512 =for apidoc Am|bool|isOCTAL|char ch
513 Returns a boolean indicating whether the specified character is an
514 octal digit, [0-7] in the platform's native character set.
515 Variants C<isOCTAL_A> and C<isOCTAL_L1> are identical to C<isOCTAL>.
516
517 =for apidoc Am|bool|isSPACE|char ch
518 Returns a boolean indicating whether the specified character is a
519 whitespace character in the platform's native character set.  This is the same
520 as what C<\s> matches in a regular expression.
521 See the L<top of this section|/Character classes> for an explanation of variants
522 C<isSPACE_A> and C<isSPACE_L1>.
523
524 =for apidoc Am|bool|isUPPER|char ch
525 Returns a boolean indicating whether the specified character is an
526 uppercase character in the platform's native character set.
527 See the L<top of this section|/Character classes> for an explanation of variants
528 C<isUPPER_A> and C<isUPPER_L1>.
529
530 =for apidoc Am|bool|isWORDCHAR|char ch
531 Returns a boolean indicating whether the specified character is a
532 character that is any of: alphabetic, numeric, or an underscore.  This is the
533 same as what C<\w> matches in a regular expression.
534 C<isALNUM()> is a synonym provided for backward compatibility.  Note that it
535 does not have the standard C language meaning of alphanumeric, since it matches
536 an underscore and the standard meaning does not.
537 See the L<top of this section|/Character classes> for an explanation of variants
538 C<isWORDCHAR_A> and C<isWORDCHAR_L1>.
539
540 =for apidoc Am|bool|isXDIGIT|char ch
541 Returns a boolean indicating whether the specified character is a hexadecimal
542 digit, [0-9A-Fa-f].  Variants C<isXDIGIT_A()> and C<isXDIGIT_L1()> are
543 identical to C<isXDIGIT()>.
544
545 =head1 Character case changing
546
547 =for apidoc Am|char|toUPPER|char ch
548 Converts the specified character to uppercase in the platform's native
549 character set, if possible; otherwise returns the input character itself.
550
551 =for apidoc Am|char|toLOWER|char ch
552 Converts the specified character to lowercase in the platform's native
553 character set, if possible; otherwise returns the input character itself.
554
555 =cut
556
557 Note that these macros are repeated in Devel::PPPort, so should also be
558 patched there.  The file as of this writing is cpan/Devel-PPPort/parts/inc/misc
559
560 */
561
562 /* FITS_IN_8_BITS(c) returns true if c occupies no more than 8 bits.  It is
563  * designed to be hopefully bomb-proof, making sure that no bits of
564  * information are lost even on a 64-bit machine, but to get the compiler to
565  * optimize it out if possible.  This is because Configure makes sure that the
566  * machine has an 8-bit byte, so if c is stored in a byte, the sizeof()
567  * guarantees that this evaluates to a constant true at compile time.  The use
568  * of the mask instead of '< 256' keeps gcc from complaining that it is alway
569  * true, when c's storage class is a byte.  Use U64TYPE because U64 is known
570  * only in the perl core, and this macro can be called from outside that */
571 #ifdef HAS_QUAD
572 #  define FITS_IN_8_BITS(c) ((sizeof(c) == 1) || (((U64TYPE)(c) & 0xFF) == (U64TYPE)(c)))
573 #else
574 #  define FITS_IN_8_BITS(c) ((sizeof(c) == 1) || (((U32)(c) & 0xFF) == (U32)(c)))
575 #endif
576
577 #define isASCII(c)    (FITS_IN_8_BITS(c) ? NATIVE_TO_UNI((U8) c) <= 127 : 0)
578 #define isASCII_A(c)  isASCII(c)
579
580 /* ASCII range only */
581 #ifdef H_PERL       /* If have access to perl.h, lookup in its table */
582 #   include "l1_char_class_tab.h"
583 #   define isALNUMC_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_ALNUMC_A))
584 #   define isALPHA_A(c)  cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_ALPHA_A))
585 #   define isBLANK_A(c)  cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_BLANK_A))
586 #   define isCNTRL_A(c)  cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_CNTRL_A))
587 #   define isDIGIT_A(c)  cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_DIGIT_A))
588 #   define isGRAPH_A(c)  cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_GRAPH_A))
589 #   define isIDFIRST_A(c)  cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_IDFIRST_A))
590 #   define isLOWER_A(c)  cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_LOWER_A))
591 #   define isOCTAL_A(c)  cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_OCTAL_A))
592 #   define isPRINT_A(c)  cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_PRINT_A))
593 #   define isPSXSPC_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_PSXSPC_A))
594 #   define isPUNCT_A(c)  cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_PUNCT_A))
595 #   define isSPACE_A(c)  cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_SPACE_A))
596 #   define isUPPER_A(c)  cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_UPPER_A))
597 #   define isWORDCHAR_A(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_WORDCHAR_A))
598 #   define isXDIGIT_A(c)  cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_XDIGIT_A))
599 #   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) NATIVE_TO_UNI(c)] & _CC_NONLATIN1_FOLD))
600 #else   /* No perl.h. */
601 #   define isOCTAL_A(c)  ((c) >= '0' && (c) <= '9')
602 #   ifdef EBCDIC
603 #       define isALNUMC_A(c)   (isASCII(c) && isALNUMC(c))
604 #       define isALPHA_A(c)    (isASCII(c) && isALPHA(c))
605 #       define isBLANK_A(c)    (isASCII(c) && isBLANK(c))
606 #       define isCNTRL_A(c)    (isASCII(c) && isCNTRL(c))
607 #       define isDIGIT_A(c)    (isASCII(c) && isDIGIT(c))
608 #       define isGRAPH_A(c)    (isASCII(c) && isGRAPH(c))
609 #       define isIDFIRST_A(c)  (isASCII(c) && isIDFIRST(c))
610 #       define isLOWER_A(c)    (isASCII(c) && isLOWER(c))
611 #       define isPRINT_A(c)    (isASCII(c) && isPRINT(c))
612 #       define isPSXSPC_A(c)   (isASCII(c) && isPSXSPC(c))
613 #       define isPUNCT_A(c)    (isASCII(c) && isPUNCT(c))
614 #       define isSPACE_A(c)    (isASCII(c) && isSPACE(c))
615 #       define isUPPER_A(c)    (isASCII(c) && isUPPER(c))
616 #       define isWORDCHAR_A(c) (isASCII(c) && isWORDCHAR(c))
617 #       define isXDIGIT_A(c)   (isASCII(c) && isXDIGIT(c))
618 #   else   /* ASCII platform, no perl.h */
619 #       define isALNUMC_A(c) (isALPHA_A(c) || isDIGIT_A(c))
620 #       define isALPHA_A(c)  (isUPPER_A(c) || isLOWER_A(c))
621 #       define isBLANK_A(c)  ((c) == ' ' || (c) == '\t')
622 #       define isCNTRL_A(c)  (FITS_IN_8_BITS(c) ? ((U8) (c) < ' ' || (c) == 127) : 0)
623 #       define isDIGIT_A(c)  ((c) >= '0' && (c) <= '9')
624 #       define isGRAPH_A(c)  (isWORDCHAR_A(c) || isPUNCT_A(c))
625 #       define isIDFIRST_A(c) (isALPHA_A(c) || (c) == '_')
626 #       define isLOWER_A(c)  ((c) >= 'a' && (c) <= 'z')
627 #       define isPRINT_A(c)  (((c) >= 32 && (c) < 127))
628 #       define isPSXSPC_A(c) (isSPACE_A(c) || (c) == '\v')
629 #       define isPUNCT_A(c)  (((c) >= 33 && (c) <= 47) || ((c) >= 58 && (c) <= 64)  || ((c) >= 91 && (c) <= 96) || ((c) >= 123 && (c) <= 126))
630 #       define isSPACE_A(c)  ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) =='\r' || (c) == '\f')
631 #       define isUPPER_A(c) ((c) >= 'A' && (c) <= 'Z')
632 #       define isWORDCHAR_A(c) (isALPHA_A(c) || isDIGIT_A(c) || (c) == '_')
633 #       define isXDIGIT_A(c)   (isDIGIT_A(c) || ((c) >= 'a' && (c) <= 'f') || ((c) >= 'A' && (c) <= 'F'))
634 #   endif
635 #endif  /* ASCII range definitions */
636
637 /* Latin1 definitions */
638 #ifdef H_PERL
639 #   define isALNUMC_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_ALNUMC_L1))
640 #   define isALPHA_L1(c)  cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_ALPHA_L1))
641 #   define isBLANK_L1(c)  cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_BLANK_L1))
642 /*  continuation character for legal NAME in \N{NAME} */
643 #   define isCHARNAME_CONT(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_CHARNAME_CONT))
644 #   define isCNTRL_L1(c)  cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_CNTRL_L1))
645 #   define isGRAPH_L1(c)  cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_GRAPH_L1))
646 #   define isIDFIRST_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_IDFIRST_L1))
647 #   define isLOWER_L1(c)  cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_LOWER_L1))
648 #   define isPRINT_L1(c)  cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_PRINT_L1))
649 #   define isPSXSPC_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_PSXSPC_L1))
650 #   define isPUNCT_L1(c)  cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_PUNCT_L1))
651 #   define isSPACE_L1(c)  cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_SPACE_L1))
652 #   define isUPPER_L1(c)  cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_UPPER_L1))
653 #   define isWORDCHAR_L1(c) cBOOL(FITS_IN_8_BITS(c) && (PL_charclass[(U8) NATIVE_TO_UNI(c)] & _CC_WORDCHAR_L1))
654 #else /* No access to perl.h.  Only a few provided here, just in case needed
655        * for backwards compatibility */
656     /* ALPHAU includes Unicode semantics for latin1 characters.  It has an extra
657      * >= AA test to speed up ASCII-only tests at the expense of the others */
658 #   define isALPHA_L1(c) (isALPHA(c) || (NATIVE_TO_UNI((U8) c) >= 0xAA \
659         && ((NATIVE_TO_UNI((U8) c) >= 0xC0 \
660                 && NATIVE_TO_UNI((U8) c) != 0xD7 && NATIVE_TO_UNI((U8) c) != 0xF7) \
661             || NATIVE_TO_UNI((U8) c) == 0xAA \
662             || NATIVE_TO_UNI((U8) c) == 0xB5 \
663             || NATIVE_TO_UNI((U8) c) == 0xBA)))
664 #   define isCHARNAME_CONT(c) (isALNUM_L1(c) || (c) == ' ' || (c) == '-' || (c) == '(' || (c) == ')' || (c) == ':' || NATIVE_TO_UNI((U8) c) == 0xA0)
665 #endif
666
667 /* Macros for backwards compatibility and for completeness when the ASCII and
668  * Latin1 values are identical */
669 #define isALNUM(c)      isWORDCHAR(c)
670 #define isALNUMU(c)     isWORDCHAR_L1(c)
671 #define isALPHAU(c)     isALPHA_L1(c)
672 #define isDIGIT_L1(c)   isDIGIT_A(c)
673 #define isOCTAL(c)      isOCTAL_A(c)
674 #define isOCTAL_L1(c)   isOCTAL_A(c)
675 #define isXDIGIT_L1(c)  isXDIGIT_A(c)
676
677 /* Macros that differ between EBCDIC and ASCII.  Where C89 defines a function,
678  * that is used in the EBCDIC form, because in EBCDIC we do not do locales:
679  * therefore can use native functions.  For those where C89 doesn't define a
680  * function, use our function, assuming that the EBCDIC code page is isomorphic
681  * with Latin1, which the three currently recognized by Perl are.  Some libc's
682  * have an isblank(), but it's not guaranteed. */
683 #ifdef EBCDIC
684 #   define isALNUMC(c)  isalnum(c)
685 #   define isALPHA(c)   isalpha(c)
686 #   define isBLANK(c)   ((c) == ' ' || (c) == '\t' || NATIVE_TO_UNI(c) == 0xA0)
687 #   define isCNTRL(c)   iscntrl(c)
688 #   define isDIGIT(c)   isdigit(c)
689 #   define isGRAPH(c)   isgraph(c)
690 #   define isIDFIRST(c) (isALPHA(c) || (c) == '_')
691 #   define isLOWER(c)   islower(c)
692 #   define isPRINT(c)   isprint(c)
693 #   define isPSXSPC(c)  isspace(c)
694 #   define isPUNCT(c)   ispunct(c)
695 #   define isSPACE(c)   (isPSXSPC(c) && (c) != '\v')
696 #   define isUPPER(c)   isupper(c)
697 #   define isXDIGIT(c)  isxdigit(c)
698 #   define isWORDCHAR(c) (isalnum(c) || (c) == '_')
699 #   define toLOWER(c)   tolower(c)
700 #   define toUPPER(c)   toupper(c)
701 #else /* Not EBCDIC: ASCII-only matching */
702 #   define isALNUMC(c)  isALNUMC_A(c)
703 #   define isALPHA(c)   isALPHA_A(c)
704 #   define isBLANK(c)   isBLANK_A(c)
705 #   define isCNTRL(c)   isCNTRL_A(c)
706 #   define isDIGIT(c)   isDIGIT_A(c)
707 #   define isGRAPH(c)   isGRAPH_A(c)
708 #   define isIDFIRST(c) isIDFIRST_A(c)
709 #   define isLOWER(c)   isLOWER_A(c)
710 #   define isPRINT(c)   isPRINT_A(c)
711 #   define isPSXSPC(c)  isPSXSPC_A(c)
712 #   define isPUNCT(c)   isPUNCT_A(c)
713 #   define isSPACE(c)   isSPACE_A(c)
714 #   define isUPPER(c)   isUPPER_A(c)
715 #   define isWORDCHAR(c) isWORDCHAR_A(c)
716 #   define isXDIGIT(c)  isXDIGIT_A(c)
717
718     /* ASCII casing.  These could also be written as
719         #define toLOWER(c) (isASCII(c) ? toLOWER_LATIN1(c) : (c))
720         #define toUPPER(c) (isASCII(c) ? toUPPER_LATIN1_MOD(c) : (c))
721        which uses table lookup and mask instead of subtraction.  (This would
722        work because the _MOD does not apply in the ASCII range) */
723 #   define toLOWER(c)   (isUPPER(c) ? (c) + ('a' - 'A') : (c))
724 #   define toUPPER(c)   (isLOWER(c) ? (c) - ('a' - 'A') : (c))
725 #endif
726
727
728 /* Use table lookup for speed; return error character for input
729  * out-of-range */
730 #define toLOWER_LATIN1(c)    (FITS_IN_8_BITS(c)                            \
731                              ? UNI_TO_NATIVE(PL_latin1_lc[                 \
732                                                NATIVE_TO_UNI( (U8) (c)) ]) \
733                              : UNICODE_REPLACEMENT)
734 /* Modified uc.  Is correct uc except for three non-ascii chars which are
735  * all mapped to one of them, and these need special handling; error
736  * character for input out-of-range */
737 #define toUPPER_LATIN1_MOD(c) (FITS_IN_8_BITS(c)                           \
738                               ? UNI_TO_NATIVE(PL_mod_latin1_uc[            \
739                                                NATIVE_TO_UNI( (U8) (c)) ]) \
740                               : UNICODE_REPLACEMENT)
741
742 #ifdef USE_NEXT_CTYPE
743
744 #  define isALNUM_LC(c) \
745         (NXIsAlNum((unsigned int)(c)) || (char)(c) == '_')
746 #  define isIDFIRST_LC(c) \
747         (NXIsAlpha((unsigned int)(c)) || (char)(c) == '_')
748 #  define isALPHA_LC(c)         NXIsAlpha((unsigned int)(c))
749 #  define isSPACE_LC(c)         NXIsSpace((unsigned int)(c))
750 #  define isDIGIT_LC(c)         NXIsDigit((unsigned int)(c))
751 #  define isUPPER_LC(c)         NXIsUpper((unsigned int)(c))
752 #  define isLOWER_LC(c)         NXIsLower((unsigned int)(c))
753 #  define isALNUMC_LC(c)        NXIsAlNum((unsigned int)(c))
754 #  define isCNTRL_LC(c)         NXIsCntrl((unsigned int)(c))
755 #  define isGRAPH_LC(c)         NXIsGraph((unsigned int)(c))
756 #  define isPRINT_LC(c)         NXIsPrint((unsigned int)(c))
757 #  define isPUNCT_LC(c)         NXIsPunct((unsigned int)(c))
758 #  define toUPPER_LC(c)         NXToUpper((unsigned int)(c))
759 #  define toLOWER_LC(c)         NXToLower((unsigned int)(c))
760
761 #else /* !USE_NEXT_CTYPE */
762
763 #  if defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII))
764
765 #    define isALNUM_LC(c)   (isalnum((unsigned char)(c)) || (char)(c) == '_')
766 #    define isIDFIRST_LC(c) (isalpha((unsigned char)(c)) || (char)(c) == '_')
767 #    define isALPHA_LC(c)       isalpha((unsigned char)(c))
768 #    define isSPACE_LC(c)       isspace((unsigned char)(c))
769 #    define isDIGIT_LC(c)       isdigit((unsigned char)(c))
770 #    define isUPPER_LC(c)       isupper((unsigned char)(c))
771 #    define isLOWER_LC(c)       islower((unsigned char)(c))
772 #    define isALNUMC_LC(c)      isalnum((unsigned char)(c))
773 #    define isCNTRL_LC(c)       iscntrl((unsigned char)(c))
774 #    define isGRAPH_LC(c)       isgraph((unsigned char)(c))
775 #    define isPRINT_LC(c)       isprint((unsigned char)(c))
776 #    define isPUNCT_LC(c)       ispunct((unsigned char)(c))
777 #    define toUPPER_LC(c)       toupper((unsigned char)(c))
778 #    define toLOWER_LC(c)       tolower((unsigned char)(c))
779
780 #  else
781
782 #    define isALNUM_LC(c)       (isascii(c) && (isalnum(c) || (c) == '_'))
783 #    define isIDFIRST_LC(c)     (isascii(c) && (isalpha(c) || (c) == '_'))
784 #    define isALPHA_LC(c)       (isascii(c) && isalpha(c))
785 #    define isSPACE_LC(c)       (isascii(c) && isspace(c))
786 #    define isDIGIT_LC(c)       (isascii(c) && isdigit(c))
787 #    define isUPPER_LC(c)       (isascii(c) && isupper(c))
788 #    define isLOWER_LC(c)       (isascii(c) && islower(c))
789 #    define isALNUMC_LC(c)      (isascii(c) && isalnum(c))
790 #    define isCNTRL_LC(c)       (isascii(c) && iscntrl(c))
791 #    define isGRAPH_LC(c)       (isascii(c) && isgraph(c))
792 #    define isPRINT_LC(c)       (isascii(c) && isprint(c))
793 #    define isPUNCT_LC(c)       (isascii(c) && ispunct(c))
794 #    define toUPPER_LC(c)       toupper(c)
795 #    define toLOWER_LC(c)       tolower(c)
796
797 #  endif
798 #endif /* USE_NEXT_CTYPE */
799
800 #define isPSXSPC_LC(c)          (isSPACE_LC(c) || (c) == '\v')
801 #define isBLANK_LC(c)           isBLANK(c) /* could be wrong */
802
803 #define isALNUM_uni(c)          is_uni_alnum(c)
804 #define isIDFIRST_uni(c)        is_uni_idfirst(c)
805 #define isALPHA_uni(c)          is_uni_alpha(c)
806 #define isSPACE_uni(c)          is_uni_space(c)
807 #define isDIGIT_uni(c)          is_uni_digit(c)
808 #define isUPPER_uni(c)          is_uni_upper(c)
809 #define isLOWER_uni(c)          is_uni_lower(c)
810 #define isASCII_uni(c)          is_uni_ascii(c)
811 #define isCNTRL_uni(c)          is_uni_cntrl(c)
812 #define isGRAPH_uni(c)          is_uni_graph(c)
813 #define isPRINT_uni(c)          is_uni_print(c)
814 #define isPUNCT_uni(c)          is_uni_punct(c)
815 #define isXDIGIT_uni(c)         is_uni_xdigit(c)
816 #define toUPPER_uni(c,s,l)      to_uni_upper(c,s,l)
817 #define toTITLE_uni(c,s,l)      to_uni_title(c,s,l)
818 #define toLOWER_uni(c,s,l)      to_uni_lower(c,s,l)
819 #define toFOLD_uni(c,s,l)       to_uni_fold(c,s,l)
820
821 #define isPSXSPC_uni(c)         (isSPACE_uni(c) ||(c) == '\f')
822 #define isBLANK_uni(c)          isBLANK(c) /* could be wrong */
823
824 #define isALNUM_LC_uvchr(c)     (c < 256 ? isALNUM_LC(c) : is_uni_alnum_lc(c))
825 #define isIDFIRST_LC_uvchr(c)   (c < 256 ? isIDFIRST_LC(c) : is_uni_idfirst_lc(c))
826 #define isALPHA_LC_uvchr(c)     (c < 256 ? isALPHA_LC(c) : is_uni_alpha_lc(c))
827 #define isSPACE_LC_uvchr(c)     (c < 256 ? isSPACE_LC(c) : is_uni_space_lc(c))
828 #define isDIGIT_LC_uvchr(c)     (c < 256 ? isDIGIT_LC(c) : is_uni_digit_lc(c))
829 #define isUPPER_LC_uvchr(c)     (c < 256 ? isUPPER_LC(c) : is_uni_upper_lc(c))
830 #define isLOWER_LC_uvchr(c)     (c < 256 ? isLOWER_LC(c) : is_uni_lower_lc(c))
831 #define isCNTRL_LC_uvchr(c)     (c < 256 ? isCNTRL_LC(c) : is_uni_cntrl_lc(c))
832 #define isGRAPH_LC_uvchr(c)     (c < 256 ? isGRAPH_LC(c) : is_uni_graph_lc(c))
833 #define isPRINT_LC_uvchr(c)     (c < 256 ? isPRINT_LC(c) : is_uni_print_lc(c))
834 #define isPUNCT_LC_uvchr(c)     (c < 256 ? isPUNCT_LC(c) : is_uni_punct_lc(c))
835
836 #define isPSXSPC_LC_uni(c)      (isSPACE_LC_uni(c) ||(c) == '\f')
837 #define isBLANK_LC_uni(c)       isBLANK(c) /* could be wrong */
838
839 #define isALNUM_utf8(p)         is_utf8_alnum(p)
840 /* The ID_Start of Unicode was originally quite limiting: it assumed an
841  * L-class character (meaning that you could not have, say, a CJK charac-
842  * ter). So, instead, perl has for a long time allowed ID_Continue but
843  * not digits.
844  * We still preserve that for backward compatibility. But we also make sure
845  * that it is alphanumeric, so S_scan_word in toke.c will not hang. See
846  *    http://rt.perl.org/rt3/Ticket/Display.html?id=74022
847  * for more detail than you ever wanted to know about. */
848 #define isIDFIRST_utf8(p) \
849     (is_utf8_idcont(p) && !is_utf8_digit(p) && is_utf8_alnum(p))
850 #define isALPHA_utf8(p)         is_utf8_alpha(p)
851 #define isSPACE_utf8(p)         is_utf8_space(p)
852 #define isDIGIT_utf8(p)         is_utf8_digit(p)
853 #define isUPPER_utf8(p)         is_utf8_upper(p)
854 #define isLOWER_utf8(p)         is_utf8_lower(p)
855 #define isASCII_utf8(p)         is_utf8_ascii(p)
856 #define isCNTRL_utf8(p)         is_utf8_cntrl(p)
857 #define isGRAPH_utf8(p)         is_utf8_graph(p)
858 #define isPRINT_utf8(p)         is_utf8_print(p)
859 #define isPUNCT_utf8(p)         is_utf8_punct(p)
860 #define isXDIGIT_utf8(p)        is_utf8_xdigit(p)
861 #define toUPPER_utf8(p,s,l)     to_utf8_upper(p,s,l)
862 #define toTITLE_utf8(p,s,l)     to_utf8_title(p,s,l)
863 #define toLOWER_utf8(p,s,l)     to_utf8_lower(p,s,l)
864
865 #define isPSXSPC_utf8(c)        (isSPACE_utf8(c) ||(c) == '\f')
866 #define isBLANK_utf8(c)         isBLANK(c) /* could be wrong */
867
868 #define isALNUM_LC_utf8(p)      isALNUM_LC_uvchr(utf8_to_uvchr(p,  0))
869 #define isIDFIRST_LC_utf8(p)    isIDFIRST_LC_uvchr(utf8_to_uvchr(p,  0))
870 #define isALPHA_LC_utf8(p)      isALPHA_LC_uvchr(utf8_to_uvchr(p,  0))
871 #define isSPACE_LC_utf8(p)      isSPACE_LC_uvchr(utf8_to_uvchr(p,  0))
872 #define isDIGIT_LC_utf8(p)      isDIGIT_LC_uvchr(utf8_to_uvchr(p,  0))
873 #define isUPPER_LC_utf8(p)      isUPPER_LC_uvchr(utf8_to_uvchr(p,  0))
874 #define isLOWER_LC_utf8(p)      isLOWER_LC_uvchr(utf8_to_uvchr(p,  0))
875 #define isALNUMC_LC_utf8(p)     isALNUMC_LC_uvchr(utf8_to_uvchr(p,  0))
876 #define isCNTRL_LC_utf8(p)      isCNTRL_LC_uvchr(utf8_to_uvchr(p,  0))
877 #define isGRAPH_LC_utf8(p)      isGRAPH_LC_uvchr(utf8_to_uvchr(p,  0))
878 #define isPRINT_LC_utf8(p)      isPRINT_LC_uvchr(utf8_to_uvchr(p,  0))
879 #define isPUNCT_LC_utf8(p)      isPUNCT_LC_uvchr(utf8_to_uvchr(p,  0))
880
881 #define isPSXSPC_LC_utf8(c)     (isSPACE_LC_utf8(c) ||(c) == '\f')
882 #define isBLANK_LC_utf8(c)      isBLANK(c) /* could be wrong */
883
884 /* This conversion works both ways, strangely enough. On EBCDIC platforms,
885  * CTRL-@ is 0, CTRL-A is 1, etc, just like on ASCII */
886 #  define toCTRL(c)    (toUPPER(NATIVE_TO_UNI(c)) ^ 64)
887
888 /* Line numbers are unsigned, 32 bits. */
889 typedef U32 line_t;
890 #define NOLINE ((line_t) 4294967295UL)
891
892 /* Helpful alias for version prescan */
893 #define is_LAX_VERSION(a,b) \
894         (a != Perl_prescan_version(aTHX_ a, FALSE, b, NULL, NULL, NULL, NULL))
895
896 #define is_STRICT_VERSION(a,b) \
897         (a != Perl_prescan_version(aTHX_ a, TRUE, b, NULL, NULL, NULL, NULL))
898
899 #define BADVERSION(a,b,c) \
900         if (b) { \
901             *b = c; \
902         } \
903         return a;
904
905 /*
906 =head1 Memory Management
907
908 =for apidoc Am|void|Newx|void* ptr|int nitems|type
909 The XSUB-writer's interface to the C C<malloc> function.
910
911 In 5.9.3, Newx() and friends replace the older New() API, and drops
912 the first parameter, I<x>, a debug aid which allowed callers to identify
913 themselves.  This aid has been superseded by a new build option,
914 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>).  The older API is still
915 there for use in XS modules supporting older perls.
916
917 =for apidoc Am|void|Newxc|void* ptr|int nitems|type|cast
918 The XSUB-writer's interface to the C C<malloc> function, with
919 cast.  See also C<Newx>.
920
921 =for apidoc Am|void|Newxz|void* ptr|int nitems|type
922 The XSUB-writer's interface to the C C<malloc> function.  The allocated
923 memory is zeroed with C<memzero>.  See also C<Newx>.
924
925 =for apidoc Am|void|Renew|void* ptr|int nitems|type
926 The XSUB-writer's interface to the C C<realloc> function.
927
928 =for apidoc Am|void|Renewc|void* ptr|int nitems|type|cast
929 The XSUB-writer's interface to the C C<realloc> function, with
930 cast.
931
932 =for apidoc Am|void|Safefree|void* ptr
933 The XSUB-writer's interface to the C C<free> function.
934
935 =for apidoc Am|void|Move|void* src|void* dest|int nitems|type
936 The XSUB-writer's interface to the C C<memmove> function.  The C<src> is the
937 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
938 the type.  Can do overlapping moves.  See also C<Copy>.
939
940 =for apidoc Am|void *|MoveD|void* src|void* dest|int nitems|type
941 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
942 optimise.
943
944 =for apidoc Am|void|Copy|void* src|void* dest|int nitems|type
945 The XSUB-writer's interface to the C C<memcpy> function.  The C<src> is the
946 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
947 the type.  May fail on overlapping copies.  See also C<Move>.
948
949 =for apidoc Am|void *|CopyD|void* src|void* dest|int nitems|type
950
951 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
952 optimise.
953
954 =for apidoc Am|void|Zero|void* dest|int nitems|type
955
956 The XSUB-writer's interface to the C C<memzero> function.  The C<dest> is the
957 destination, C<nitems> is the number of items, and C<type> is the type.
958
959 =for apidoc Am|void *|ZeroD|void* dest|int nitems|type
960
961 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
962 optimise.
963
964 =for apidoc Am|void|StructCopy|type src|type dest|type
965 This is an architecture-independent macro to copy one structure to another.
966
967 =for apidoc Am|void|PoisonWith|void* dest|int nitems|type|U8 byte
968
969 Fill up memory with a byte pattern (a byte repeated over and over
970 again) that hopefully catches attempts to access uninitialized memory.
971
972 =for apidoc Am|void|PoisonNew|void* dest|int nitems|type
973
974 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
975
976 =for apidoc Am|void|PoisonFree|void* dest|int nitems|type
977
978 PoisonWith(0xEF) for catching access to freed memory.
979
980 =for apidoc Am|void|Poison|void* dest|int nitems|type
981
982 PoisonWith(0xEF) for catching access to freed memory.
983
984 =cut */
985
986 /* Maintained for backwards-compatibility only. Use newSV() instead. */
987 #ifndef PERL_CORE
988 #define NEWSV(x,len)    newSV(len)
989 #endif
990
991 #define MEM_SIZE_MAX ((MEM_SIZE)~0)
992
993 /* The +0.0 in MEM_WRAP_CHECK_ is an attempt to foil
994  * overly eager compilers that will bleat about e.g.
995  * (U16)n > (size_t)~0/sizeof(U16) always being false. */
996 #ifdef PERL_MALLOC_WRAP
997 #define MEM_WRAP_CHECK(n,t) MEM_WRAP_CHECK_1(n,t,PL_memory_wrap)
998 #define MEM_WRAP_CHECK_1(n,t,a) \
999         (void)(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t) && (Perl_croak_nocontext("%s",(a)),0))
1000 #define MEM_WRAP_CHECK_(n,t) MEM_WRAP_CHECK(n,t),
1001
1002 #define PERL_STRLEN_ROUNDUP(n) ((void)(((n) > MEM_SIZE_MAX - 2 * PERL_STRLEN_ROUNDUP_QUANTUM) ? (Perl_croak_nocontext("%s",PL_memory_wrap),0):0),((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
1003
1004 #else
1005
1006 #define MEM_WRAP_CHECK(n,t)
1007 #define MEM_WRAP_CHECK_1(n,t,a)
1008 #define MEM_WRAP_CHECK_2(n,t,a,b)
1009 #define MEM_WRAP_CHECK_(n,t)
1010
1011 #define PERL_STRLEN_ROUNDUP(n) (((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1)))
1012
1013 #endif
1014
1015 #ifdef PERL_MEM_LOG
1016 /*
1017  * If PERL_MEM_LOG is defined, all Newx()s, Renew()s, and Safefree()s
1018  * go through functions, which are handy for debugging breakpoints, but
1019  * which more importantly get the immediate calling environment (file and
1020  * line number, and C function name if available) passed in.  This info can
1021  * then be used for logging the calls, for which one gets a sample
1022  * implementation unless -DPERL_MEM_LOG_NOIMPL is also defined.
1023  *
1024  * Known problems:
1025  * - not all memory allocs get logged, only those
1026  *   that go through Newx() and derivatives (while all
1027  *   Safefrees do get logged)
1028  * - __FILE__ and __LINE__ do not work everywhere
1029  * - __func__ or __FUNCTION__ even less so
1030  * - I think more goes on after the perlio frees but
1031  *   the thing is that STDERR gets closed (as do all
1032  *   the file descriptors)
1033  * - no deeper calling stack than the caller of the Newx()
1034  *   or the kind, but do I look like a C reflection/introspection
1035  *   utility to you?
1036  * - the function prototypes for the logging functions
1037  *   probably should maybe be somewhere else than handy.h
1038  * - one could consider inlining (macrofying) the logging
1039  *   for speed, but I am too lazy
1040  * - one could imagine recording the allocations in a hash,
1041  *   (keyed by the allocation address?), and maintain that
1042  *   through reallocs and frees, but how to do that without
1043  *   any News() happening...?
1044  * - lots of -Ddefines to get useful/controllable output
1045  * - lots of ENV reads
1046  */
1047
1048 PERL_EXPORT_C Malloc_t Perl_mem_log_alloc(const UV n, const UV typesize, const char *type_name, Malloc_t newalloc, const char *filename, const int linenumber, const char *funcname);
1049
1050 PERL_EXPORT_C Malloc_t Perl_mem_log_realloc(const UV n, const UV typesize, const char *type_name, Malloc_t oldalloc, Malloc_t newalloc, const char *filename, const int linenumber, const char *funcname);
1051
1052 PERL_EXPORT_C Malloc_t Perl_mem_log_free(Malloc_t oldalloc, const char *filename, const int linenumber, const char *funcname);
1053
1054 # ifdef PERL_CORE
1055 #  ifndef PERL_MEM_LOG_NOIMPL
1056 enum mem_log_type {
1057   MLT_ALLOC,
1058   MLT_REALLOC,
1059   MLT_FREE,
1060   MLT_NEW_SV,
1061   MLT_DEL_SV
1062 };
1063 #  endif
1064 #  if defined(PERL_IN_SV_C)  /* those are only used in sv.c */
1065 void Perl_mem_log_new_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
1066 void Perl_mem_log_del_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname);
1067 #  endif
1068 # endif
1069
1070 #endif
1071
1072 #ifdef PERL_MEM_LOG
1073 #define MEM_LOG_ALLOC(n,t,a)     Perl_mem_log_alloc(n,sizeof(t),STRINGIFY(t),a,__FILE__,__LINE__,FUNCTION__)
1074 #define MEM_LOG_REALLOC(n,t,v,a) Perl_mem_log_realloc(n,sizeof(t),STRINGIFY(t),v,a,__FILE__,__LINE__,FUNCTION__)
1075 #define MEM_LOG_FREE(a)          Perl_mem_log_free(a,__FILE__,__LINE__,FUNCTION__)
1076 #endif
1077
1078 #ifndef MEM_LOG_ALLOC
1079 #define MEM_LOG_ALLOC(n,t,a)     (a)
1080 #endif
1081 #ifndef MEM_LOG_REALLOC
1082 #define MEM_LOG_REALLOC(n,t,v,a) (a)
1083 #endif
1084 #ifndef MEM_LOG_FREE
1085 #define MEM_LOG_FREE(a)          (a)
1086 #endif
1087
1088 #define Newx(v,n,t)     (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
1089 #define Newxc(v,n,t,c)  (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t))))))
1090 #define Newxz(v,n,t)    (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safecalloc((n),sizeof(t)))))
1091
1092 #ifndef PERL_CORE
1093 /* pre 5.9.x compatibility */
1094 #define New(x,v,n,t)    Newx(v,n,t)
1095 #define Newc(x,v,n,t,c) Newxc(v,n,t,c)
1096 #define Newz(x,v,n,t)   Newxz(v,n,t)
1097 #endif
1098
1099 #define Renew(v,n,t) \
1100           (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
1101 #define Renewc(v,n,t,c) \
1102           (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t))))))
1103
1104 #ifdef PERL_POISON
1105 #define Safefree(d) \
1106   ((d) ? (void)(safefree(MEM_LOG_FREE((Malloc_t)(d))), Poison(&(d), 1, Malloc_t)) : (void) 0)
1107 #else
1108 #define Safefree(d)     safefree(MEM_LOG_FREE((Malloc_t)(d)))
1109 #endif
1110
1111 #define Move(s,d,n,t)   (MEM_WRAP_CHECK_(n,t) (void)memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
1112 #define Copy(s,d,n,t)   (MEM_WRAP_CHECK_(n,t) (void)memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
1113 #define Zero(d,n,t)     (MEM_WRAP_CHECK_(n,t) (void)memzero((char*)(d), (n) * sizeof(t)))
1114
1115 #define MoveD(s,d,n,t)  (MEM_WRAP_CHECK_(n,t) memmove((char*)(d),(const char*)(s), (n) * sizeof(t)))
1116 #define CopyD(s,d,n,t)  (MEM_WRAP_CHECK_(n,t) memcpy((char*)(d),(const char*)(s), (n) * sizeof(t)))
1117 #ifdef HAS_MEMSET
1118 #define ZeroD(d,n,t)    (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)))
1119 #else
1120 /* Using bzero(), which returns void.  */
1121 #define ZeroD(d,n,t)    (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)),d)
1122 #endif
1123
1124 #define PoisonWith(d,n,t,b)     (MEM_WRAP_CHECK_(n,t) (void)memset((char*)(d), (U8)(b), (n) * sizeof(t)))
1125 #define PoisonNew(d,n,t)        PoisonWith(d,n,t,0xAB)
1126 #define PoisonFree(d,n,t)       PoisonWith(d,n,t,0xEF)
1127 #define Poison(d,n,t)           PoisonFree(d,n,t)
1128
1129 #ifdef USE_STRUCT_COPY
1130 #define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s)))
1131 #else
1132 #define StructCopy(s,d,t) Copy(s,d,1,t)
1133 #endif
1134
1135 #define C_ARRAY_LENGTH(a)       (sizeof(a)/sizeof((a)[0]))
1136 #define C_ARRAY_END(a)          (a) + (sizeof(a)/sizeof((a)[0]))
1137
1138 #ifdef NEED_VA_COPY
1139 # ifdef va_copy
1140 #  define Perl_va_copy(s, d) va_copy(d, s)
1141 # else
1142 #  if defined(__va_copy)
1143 #   define Perl_va_copy(s, d) __va_copy(d, s)
1144 #  else
1145 #   define Perl_va_copy(s, d) Copy(s, d, 1, va_list)
1146 #  endif
1147 # endif
1148 #endif
1149
1150 /* convenience debug macros */
1151 #ifdef USE_ITHREADS
1152 #define pTHX_FORMAT  "Perl interpreter: 0x%p"
1153 #define pTHX__FORMAT ", Perl interpreter: 0x%p"
1154 #define pTHX_VALUE_   (void *)my_perl,
1155 #define pTHX_VALUE    (void *)my_perl
1156 #define pTHX__VALUE_ ,(void *)my_perl,
1157 #define pTHX__VALUE  ,(void *)my_perl
1158 #else
1159 #define pTHX_FORMAT
1160 #define pTHX__FORMAT
1161 #define pTHX_VALUE_
1162 #define pTHX_VALUE
1163 #define pTHX__VALUE_
1164 #define pTHX__VALUE
1165 #endif /* USE_ITHREADS */
1166
1167 /* Perl_deprecate was not part of the public API, and did not have a deprecate()
1168    shortcut macro defined without -DPERL_CORE. Neither codesearch.google.com nor
1169    CPAN::Unpack show any users outside the core.  */
1170 #ifdef PERL_CORE
1171 #  define deprecate(s) Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED), "Use of " s " is deprecated")
1172 #endif
1173
1174 /*
1175  * Local variables:
1176  * c-indentation-style: bsd
1177  * c-basic-offset: 4
1178  * indent-tabs-mode: t
1179  * End:
1180  *
1181  * ex: set ts=8 sts=4 sw=4 noet:
1182  */