| 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 | #ifdef PERL_CORE |
| 177 | # ifdef HAS_QUAD |
| 178 | typedef I64TYPE I64; |
| 179 | typedef U64TYPE U64; |
| 180 | # endif |
| 181 | #endif /* PERL_CORE */ |
| 182 | |
| 183 | /* INT64_C/UINT64_C are C99 from <stdint.h> (so they will not be |
| 184 | * available in strict C89 mode), but they are nice, so let's define |
| 185 | * them if necessary. */ |
| 186 | #if defined(HAS_QUAD) |
| 187 | # undef PeRl_INT64_C |
| 188 | # undef PeRl_UINT64_C |
| 189 | /* Prefer the native integer types (int and long) over long long |
| 190 | * (which is not C89) and Win32-specific __int64. */ |
| 191 | # if QUADKIND == QUAD_IS_INT && INTSIZE == 8 |
| 192 | # define PeRl_INT64_C(c) (c) |
| 193 | # define PeRl_UINT64_C(c) CAT2(c,U) |
| 194 | # endif |
| 195 | # if QUADKIND == QUAD_IS_LONG && LONGSIZE == 8 |
| 196 | # define PeRl_INT64_C(c) CAT2(c,L) |
| 197 | # define PeRl_UINT64_C(c) CAT2(c,UL) |
| 198 | # endif |
| 199 | # if QUADKIND == QUAD_IS_LONG_LONG && defined(HAS_LONG_LONG) |
| 200 | # define PeRl_INT64_C(c) CAT2(c,LL) |
| 201 | # define PeRl_UINT64_C(c) CAT2(c,ULL) |
| 202 | # endif |
| 203 | # if QUADKIND == QUAD_IS___INT64 |
| 204 | # define PeRl_INT64_C(c) CAT2(c,I64) |
| 205 | # define PeRl_UINT64_C(c) CAT2(c,UI64) |
| 206 | # endif |
| 207 | # ifndef PeRl_INT64_C |
| 208 | # define PeRl_INT64_C(c) ((I64TYPE)(c)) /* last resort */ |
| 209 | # define PeRl_UINT64_C(c) ((U64TYPE)(c)) |
| 210 | # endif |
| 211 | /* In OS X the INT64_C/UINT64_C are defined with LL/ULL, which will |
| 212 | * not fly with C89-pedantic gcc, so let's undefine them first so that |
| 213 | * we can redefine them with our native integer preferring versions. */ |
| 214 | # if defined(PERL_DARWIN) && defined(PERL_GCC_PEDANTIC) |
| 215 | # undef INT64_C |
| 216 | # undef UINT64_C |
| 217 | # endif |
| 218 | # ifndef INT64_C |
| 219 | # define INT64_C(c) PeRl_INT64_C(c) |
| 220 | # endif |
| 221 | # ifndef UINT64_C |
| 222 | # define UINT64_C(c) PeRl_UINT64_C(c) |
| 223 | # endif |
| 224 | #endif |
| 225 | |
| 226 | #if defined(UINT8_MAX) && defined(INT16_MAX) && defined(INT32_MAX) |
| 227 | |
| 228 | /* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type. |
| 229 | Please search CHAR_MAX in perl.h for further details. */ |
| 230 | #define U8_MAX UINT8_MAX |
| 231 | #define U8_MIN UINT8_MIN |
| 232 | |
| 233 | #define I16_MAX INT16_MAX |
| 234 | #define I16_MIN INT16_MIN |
| 235 | #define U16_MAX UINT16_MAX |
| 236 | #define U16_MIN UINT16_MIN |
| 237 | |
| 238 | #define I32_MAX INT32_MAX |
| 239 | #define I32_MIN INT32_MIN |
| 240 | #ifndef UINT32_MAX_BROKEN /* e.g. HP-UX with gcc messes this up */ |
| 241 | # define U32_MAX UINT32_MAX |
| 242 | #else |
| 243 | # define U32_MAX 4294967295U |
| 244 | #endif |
| 245 | #define U32_MIN UINT32_MIN |
| 246 | |
| 247 | #else |
| 248 | |
| 249 | /* I8_MAX and I8_MIN constants are not defined, as I8 is an ambiguous type. |
| 250 | Please search CHAR_MAX in perl.h for further details. */ |
| 251 | #define U8_MAX PERL_UCHAR_MAX |
| 252 | #define U8_MIN PERL_UCHAR_MIN |
| 253 | |
| 254 | #define I16_MAX PERL_SHORT_MAX |
| 255 | #define I16_MIN PERL_SHORT_MIN |
| 256 | #define U16_MAX PERL_USHORT_MAX |
| 257 | #define U16_MIN PERL_USHORT_MIN |
| 258 | |
| 259 | #if LONGSIZE > 4 |
| 260 | # define I32_MAX PERL_INT_MAX |
| 261 | # define I32_MIN PERL_INT_MIN |
| 262 | # define U32_MAX PERL_UINT_MAX |
| 263 | # define U32_MIN PERL_UINT_MIN |
| 264 | #else |
| 265 | # define I32_MAX PERL_LONG_MAX |
| 266 | # define I32_MIN PERL_LONG_MIN |
| 267 | # define U32_MAX PERL_ULONG_MAX |
| 268 | # define U32_MIN PERL_ULONG_MIN |
| 269 | #endif |
| 270 | |
| 271 | #endif |
| 272 | |
| 273 | /* log(2) is pretty close to 0.30103, just in case anyone is grepping for it */ |
| 274 | #define BIT_DIGITS(N) (((N)*146)/485 + 1) /* log2(10) =~ 146/485 */ |
| 275 | #define TYPE_DIGITS(T) BIT_DIGITS(sizeof(T) * 8) |
| 276 | #define TYPE_CHARS(T) (TYPE_DIGITS(T) + 2) /* sign, NUL */ |
| 277 | |
| 278 | #define Ctl(ch) ((ch) & 037) |
| 279 | |
| 280 | /* This is a helper macro to avoid preprocessor issues, replaced by nothing |
| 281 | * unless under DEBUGGING, where it expands to an assert of its argument, |
| 282 | * followed by a comma (hence the comma operator). If we just used a straight |
| 283 | * assert(), we would get a comma with nothing before it when not DEBUGGING */ |
| 284 | #ifdef DEBUGGING |
| 285 | # define __ASSERT_(statement) assert(statement), |
| 286 | #else |
| 287 | # define __ASSERT_(statement) |
| 288 | #endif |
| 289 | |
| 290 | /* |
| 291 | =head1 SV-Body Allocation |
| 292 | |
| 293 | =for apidoc Ama|SV*|newSVpvs|const char* s |
| 294 | Like C<newSVpvn>, but takes a literal C<NUL>-terminated string instead of a |
| 295 | string/length pair. |
| 296 | |
| 297 | =for apidoc Ama|SV*|newSVpvs_flags|const char* s|U32 flags |
| 298 | Like C<newSVpvn_flags>, but takes a literal C<NUL>-terminated string instead of |
| 299 | a string/length pair. |
| 300 | |
| 301 | =for apidoc Ama|SV*|newSVpvs_share|const char* s |
| 302 | Like C<newSVpvn_share>, but takes a literal C<NUL>-terminated string instead of |
| 303 | a string/length pair and omits the hash parameter. |
| 304 | |
| 305 | =for apidoc Am|void|sv_catpvs_flags|SV* sv|const char* s|I32 flags |
| 306 | Like C<sv_catpvn_flags>, but takes a literal C<NUL>-terminated string instead |
| 307 | of a string/length pair. |
| 308 | |
| 309 | =for apidoc Am|void|sv_catpvs_nomg|SV* sv|const char* s |
| 310 | Like C<sv_catpvn_nomg>, but takes a literal string instead of a |
| 311 | string/length pair. |
| 312 | |
| 313 | =for apidoc Am|void|sv_catpvs|SV* sv|const char* s |
| 314 | Like C<sv_catpvn>, but takes a literal string instead of a string/length pair. |
| 315 | |
| 316 | =for apidoc Am|void|sv_catpvs_mg|SV* sv|const char* s |
| 317 | Like C<sv_catpvn_mg>, but takes a literal string instead of a |
| 318 | string/length pair. |
| 319 | |
| 320 | =for apidoc Am|void|sv_setpvs|SV* sv|const char* s |
| 321 | Like C<sv_setpvn>, but takes a literal string instead of a string/length pair. |
| 322 | |
| 323 | =for apidoc Am|void|sv_setpvs_mg|SV* sv|const char* s |
| 324 | Like C<sv_setpvn_mg>, but takes a literal string instead of a |
| 325 | string/length pair. |
| 326 | |
| 327 | =for apidoc Am|SV *|sv_setref_pvs|const char* s |
| 328 | Like C<sv_setref_pvn>, but takes a literal string instead of a |
| 329 | string/length pair. |
| 330 | |
| 331 | =head1 Memory Management |
| 332 | |
| 333 | =for apidoc Ama|char*|savepvs|const char* s |
| 334 | Like C<savepvn>, but takes a literal C<NUL>-terminated string instead of a |
| 335 | string/length pair. |
| 336 | |
| 337 | =for apidoc Ama|char*|savesharedpvs|const char* s |
| 338 | A version of C<savepvs()> which allocates the duplicate string in memory |
| 339 | which is shared between threads. |
| 340 | |
| 341 | =head1 GV Functions |
| 342 | |
| 343 | =for apidoc Am|HV*|gv_stashpvs|const char* name|I32 create |
| 344 | Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair. |
| 345 | |
| 346 | =head1 Hash Manipulation Functions |
| 347 | |
| 348 | =for apidoc Am|SV**|hv_fetchs|HV* tb|const char* key|I32 lval |
| 349 | Like C<hv_fetch>, but takes a literal string instead of a string/length pair. |
| 350 | |
| 351 | =for apidoc Am|SV**|hv_stores|HV* tb|const char* key|NULLOK SV* val |
| 352 | Like C<hv_store>, but takes a literal string instead of a string/length pair |
| 353 | and omits the hash parameter. |
| 354 | |
| 355 | =head1 Lexer interface |
| 356 | |
| 357 | =for apidoc Amx|void|lex_stuff_pvs|const char *pv|U32 flags |
| 358 | |
| 359 | Like L</lex_stuff_pvn>, but takes a literal string instead of a |
| 360 | string/length pair. |
| 361 | |
| 362 | =cut |
| 363 | */ |
| 364 | |
| 365 | /* concatenating with "" ensures that only literal strings are accepted as |
| 366 | * argument */ |
| 367 | #define STR_WITH_LEN(s) ("" s ""), (sizeof(s)-1) |
| 368 | |
| 369 | /* note that STR_WITH_LEN() can't be used as argument to macros or functions |
| 370 | * that under some configurations might be macros, which means that it requires |
| 371 | * the full Perl_xxx(aTHX_ ...) form for any API calls where it's used. |
| 372 | */ |
| 373 | |
| 374 | /* STR_WITH_LEN() shortcuts */ |
| 375 | #define newSVpvs(str) Perl_newSVpvn(aTHX_ STR_WITH_LEN(str)) |
| 376 | #define newSVpvs_flags(str,flags) \ |
| 377 | Perl_newSVpvn_flags(aTHX_ STR_WITH_LEN(str), flags) |
| 378 | #define newSVpvs_share(str) Perl_newSVpvn_share(aTHX_ STR_WITH_LEN(str), 0) |
| 379 | #define sv_catpvs_flags(sv, str, flags) \ |
| 380 | Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), flags) |
| 381 | #define sv_catpvs_nomg(sv, str) \ |
| 382 | Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), 0) |
| 383 | #define sv_catpvs(sv, str) \ |
| 384 | Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC) |
| 385 | #define sv_catpvs_mg(sv, str) \ |
| 386 | Perl_sv_catpvn_flags(aTHX_ sv, STR_WITH_LEN(str), SV_GMAGIC|SV_SMAGIC) |
| 387 | #define sv_setpvs(sv, str) Perl_sv_setpvn(aTHX_ sv, STR_WITH_LEN(str)) |
| 388 | #define sv_setpvs_mg(sv, str) Perl_sv_setpvn_mg(aTHX_ sv, STR_WITH_LEN(str)) |
| 389 | #define sv_setref_pvs(rv, classname, str) \ |
| 390 | Perl_sv_setref_pvn(aTHX_ rv, classname, STR_WITH_LEN(str)) |
| 391 | #define savepvs(str) Perl_savepvn(aTHX_ STR_WITH_LEN(str)) |
| 392 | #define savesharedpvs(str) Perl_savesharedpvn(aTHX_ STR_WITH_LEN(str)) |
| 393 | #define gv_stashpvs(str, create) \ |
| 394 | Perl_gv_stashpvn(aTHX_ STR_WITH_LEN(str), create) |
| 395 | #define gv_fetchpvs(namebeg, add, sv_type) \ |
| 396 | Perl_gv_fetchpvn_flags(aTHX_ STR_WITH_LEN(namebeg), add, sv_type) |
| 397 | #define gv_fetchpvn(namebeg, len, add, sv_type) \ |
| 398 | Perl_gv_fetchpvn_flags(aTHX_ namebeg, len, add, sv_type) |
| 399 | #define sv_catxmlpvs(dsv, str, utf8) \ |
| 400 | Perl_sv_catxmlpvn(aTHX_ dsv, STR_WITH_LEN(str), utf8) |
| 401 | #define hv_fetchs(hv,key,lval) \ |
| 402 | ((SV **)Perl_hv_common(aTHX_ (hv), NULL, STR_WITH_LEN(key), 0, \ |
| 403 | (lval) ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE) \ |
| 404 | : HV_FETCH_JUST_SV, NULL, 0)) |
| 405 | |
| 406 | #define hv_stores(hv,key,val) \ |
| 407 | ((SV **)Perl_hv_common(aTHX_ (hv), NULL, STR_WITH_LEN(key), 0, \ |
| 408 | (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (val), 0)) |
| 409 | |
| 410 | #define lex_stuff_pvs(pv,flags) Perl_lex_stuff_pvn(aTHX_ STR_WITH_LEN(pv), flags) |
| 411 | |
| 412 | #define get_cvs(str, flags) \ |
| 413 | Perl_get_cvn_flags(aTHX_ STR_WITH_LEN(str), (flags)) |
| 414 | |
| 415 | /* |
| 416 | =head1 Miscellaneous Functions |
| 417 | |
| 418 | =for apidoc Am|bool|strNE|char* s1|char* s2 |
| 419 | Test two strings to see if they are different. Returns true or |
| 420 | false. |
| 421 | |
| 422 | =for apidoc Am|bool|strEQ|char* s1|char* s2 |
| 423 | Test two strings to see if they are equal. Returns true or false. |
| 424 | |
| 425 | =for apidoc Am|bool|strLT|char* s1|char* s2 |
| 426 | Test two strings to see if the first, C<s1>, is less than the second, |
| 427 | C<s2>. Returns true or false. |
| 428 | |
| 429 | =for apidoc Am|bool|strLE|char* s1|char* s2 |
| 430 | Test two strings to see if the first, C<s1>, is less than or equal to the |
| 431 | second, C<s2>. Returns true or false. |
| 432 | |
| 433 | =for apidoc Am|bool|strGT|char* s1|char* s2 |
| 434 | Test two strings to see if the first, C<s1>, is greater than the second, |
| 435 | C<s2>. Returns true or false. |
| 436 | |
| 437 | =for apidoc Am|bool|strGE|char* s1|char* s2 |
| 438 | Test two strings to see if the first, C<s1>, is greater than or equal to |
| 439 | the second, C<s2>. Returns true or false. |
| 440 | |
| 441 | =for apidoc Am|bool|strnNE|char* s1|char* s2|STRLEN len |
| 442 | Test two strings to see if they are different. The C<len> parameter |
| 443 | indicates the number of bytes to compare. Returns true or false. (A |
| 444 | wrapper for C<strncmp>). |
| 445 | |
| 446 | =for apidoc Am|bool|strnEQ|char* s1|char* s2|STRLEN len |
| 447 | Test two strings to see if they are equal. The C<len> parameter indicates |
| 448 | the number of bytes to compare. Returns true or false. (A wrapper for |
| 449 | C<strncmp>). |
| 450 | |
| 451 | =cut |
| 452 | */ |
| 453 | |
| 454 | #define strNE(s1,s2) (strcmp(s1,s2)) |
| 455 | #define strEQ(s1,s2) (!strcmp(s1,s2)) |
| 456 | #define strLT(s1,s2) (strcmp(s1,s2) < 0) |
| 457 | #define strLE(s1,s2) (strcmp(s1,s2) <= 0) |
| 458 | #define strGT(s1,s2) (strcmp(s1,s2) > 0) |
| 459 | #define strGE(s1,s2) (strcmp(s1,s2) >= 0) |
| 460 | #define strnNE(s1,s2,l) (strncmp(s1,s2,l)) |
| 461 | #define strnEQ(s1,s2,l) (!strncmp(s1,s2,l)) |
| 462 | |
| 463 | #ifdef HAS_MEMCMP |
| 464 | # define memNE(s1,s2,l) (memcmp(s1,s2,l)) |
| 465 | # define memEQ(s1,s2,l) (!memcmp(s1,s2,l)) |
| 466 | #else |
| 467 | # define memNE(s1,s2,l) (bcmp(s1,s2,l)) |
| 468 | # define memEQ(s1,s2,l) (!bcmp(s1,s2,l)) |
| 469 | #endif |
| 470 | |
| 471 | #define memEQs(s1, l, s2) \ |
| 472 | (sizeof(s2)-1 == l && memEQ(s1, ("" s2 ""), (sizeof(s2)-1))) |
| 473 | #define memNEs(s1, l, s2) !memEQs(s1, l, s2) |
| 474 | |
| 475 | /* |
| 476 | * Character classes. |
| 477 | * |
| 478 | * Unfortunately, the introduction of locales means that we |
| 479 | * can't trust isupper(), etc. to tell the truth. And when |
| 480 | * it comes to /\w+/ with tainting enabled, we *must* be able |
| 481 | * to trust our character classes. |
| 482 | * |
| 483 | * Therefore, the default tests in the text of Perl will be |
| 484 | * independent of locale. Any code that wants to depend on |
| 485 | * the current locale will use the tests that begin with "lc". |
| 486 | */ |
| 487 | |
| 488 | #ifdef HAS_SETLOCALE /* XXX Is there a better test for this? */ |
| 489 | # ifndef CTYPE256 |
| 490 | # define CTYPE256 |
| 491 | # endif |
| 492 | #endif |
| 493 | |
| 494 | /* |
| 495 | |
| 496 | =head1 Character classification |
| 497 | This section is about functions (really macros) that classify characters |
| 498 | into types, such as punctuation versus alphabetic, etc. Most of these are |
| 499 | analogous to regular expression character classes. (See |
| 500 | L<perlrecharclass/POSIX Character Classes>.) There are several variants for |
| 501 | each class. (Not all macros have all variants; each item below lists the |
| 502 | ones valid for it.) None are affected by C<use bytes>, and only the ones |
| 503 | with C<LC> in the name are affected by the current locale. |
| 504 | |
| 505 | The base function, e.g., C<isALPHA()>, takes an octet (either a C<char> or a |
| 506 | C<U8>) as input and returns a boolean as to whether or not the character |
| 507 | represented by that octet is (or on non-ASCII platforms, corresponds to) an |
| 508 | ASCII character in the named class based on platform, Unicode, and Perl rules. |
| 509 | If the input is a number that doesn't fit in an octet, FALSE is returned. |
| 510 | |
| 511 | Variant C<isFOO_A> (e.g., C<isALPHA_A()>) is identical to the base function |
| 512 | with no suffix C<"_A">. |
| 513 | |
| 514 | Variant C<isFOO_L1> imposes the Latin-1 (or EBCDIC equivlalent) character set |
| 515 | onto the platform. That is, the code points that are ASCII are unaffected, |
| 516 | since ASCII is a subset of Latin-1. But the non-ASCII code points are treated |
| 517 | as if they are Latin-1 characters. For example, C<isWORDCHAR_L1()> will return |
| 518 | true when called with the code point 0xDF, which is a word character in both |
| 519 | ASCII and EBCDIC (though it represents different characters in each). |
| 520 | |
| 521 | Variant C<isFOO_uni> is like the C<isFOO_L1> variant, but accepts any UV code |
| 522 | point as input. If the code point is larger than 255, Unicode rules are used |
| 523 | to determine if it is in the character class. For example, |
| 524 | C<isWORDCHAR_uni(0x100)> returns TRUE, since 0x100 is LATIN CAPITAL LETTER A |
| 525 | WITH MACRON in Unicode, and is a word character. |
| 526 | |
| 527 | Variant C<isFOO_utf8> is like C<isFOO_uni>, but the input is a pointer to a |
| 528 | (known to be well-formed) UTF-8 encoded string (C<U8*> or C<char*>). The |
| 529 | classification of just the first (possibly multi-byte) character in the string |
| 530 | is tested. |
| 531 | |
| 532 | Variant C<isFOO_LC> is like the C<isFOO_A> and C<isFOO_L1> variants, but the |
| 533 | result is based on the current locale, which is what C<LC> in the name stands |
| 534 | for. If Perl can determine that the current locale is a UTF-8 locale, it uses |
| 535 | the published Unicode rules; otherwise, it uses the C library function that |
| 536 | gives the named classification. For example, C<isDIGIT_LC()> when not in a |
| 537 | UTF-8 locale returns the result of calling C<isdigit()>. FALSE is always |
| 538 | returned if the input won't fit into an octet. |
| 539 | |
| 540 | Variant C<isFOO_LC_uvchr> is like C<isFOO_LC>, but is defined on any UV. It |
| 541 | returns the same as C<isFOO_LC> for input code points less than 256, and |
| 542 | returns the hard-coded, not-affected-by-locale, Unicode results for larger ones. |
| 543 | |
| 544 | Variant C<isFOO_LC_utf8> is like C<isFOO_LC_uvchr>, but the input is a pointer to a |
| 545 | (known to be well-formed) UTF-8 encoded string (C<U8*> or C<char*>). The |
| 546 | classification of just the first (possibly multi-byte) character in the string |
| 547 | is tested. |
| 548 | |
| 549 | =for apidoc Am|bool|isALPHA|char ch |
| 550 | Returns a boolean indicating whether the specified character is an |
| 551 | alphabetic character, analogous to C<m/[[:alpha:]]/>. |
| 552 | See the L<top of this section|/Character classification> for an explanation of |
| 553 | variants |
| 554 | C<isALPHA_A>, C<isALPHA_L1>, C<isALPHA_uni>, C<isALPHA_utf8>, C<isALPHA_LC>, |
| 555 | C<isALPHA_LC_uvchr>, and C<isALPHA_LC_utf8>. |
| 556 | |
| 557 | =for apidoc Am|bool|isALPHANUMERIC|char ch |
| 558 | Returns a boolean indicating whether the specified character is a either an |
| 559 | alphabetic character or decimal digit, analogous to C<m/[[:alnum:]]/>. |
| 560 | See the L<top of this section|/Character classification> for an explanation of |
| 561 | variants |
| 562 | C<isALPHANUMERIC_A>, C<isALPHANUMERIC_L1>, C<isALPHANUMERIC_uni>, |
| 563 | C<isALPHANUMERIC_utf8>, C<isALPHANUMERIC_LC>, C<isALPHANUMERIC_LC_uvchr>, and |
| 564 | C<isALPHANUMERIC_LC_utf8>. |
| 565 | |
| 566 | =for apidoc Am|bool|isASCII|char ch |
| 567 | Returns a boolean indicating whether the specified character is one of the 128 |
| 568 | characters in the ASCII character set, analogous to C<m/[[:ascii:]]/>. |
| 569 | On non-ASCII platforms, it returns TRUE iff this |
| 570 | character corresponds to an ASCII character. Variants C<isASCII_A()> and |
| 571 | C<isASCII_L1()> are identical to C<isASCII()>. |
| 572 | See the L<top of this section|/Character classification> for an explanation of |
| 573 | variants |
| 574 | C<isASCII_uni>, C<isASCII_utf8>, C<isASCII_LC>, C<isASCII_LC_uvchr>, and |
| 575 | C<isASCII_LC_utf8>. Note, however, that some platforms do not have the C |
| 576 | library routine C<isascii()>. In these cases, the variants whose names contain |
| 577 | C<LC> are the same as the corresponding ones without. |
| 578 | |
| 579 | Also note, that because all ASCII characters are UTF-8 invariant (meaning they |
| 580 | have the exact same representation (always a single byte) whether encoded in |
| 581 | UTF-8 or not), C<isASCII> will give the correct results when called with any |
| 582 | byte in any string encoded or not in UTF-8. And similarly C<isASCII_utf8> will |
| 583 | work properly on any string encoded or not in UTF-8. |
| 584 | |
| 585 | =for apidoc Am|bool|isBLANK|char ch |
| 586 | Returns a boolean indicating whether the specified character is a |
| 587 | character considered to be a blank, analogous to C<m/[[:blank:]]/>. |
| 588 | See the L<top of this section|/Character classification> for an explanation of |
| 589 | variants |
| 590 | C<isBLANK_A>, C<isBLANK_L1>, C<isBLANK_uni>, C<isBLANK_utf8>, C<isBLANK_LC>, |
| 591 | C<isBLANK_LC_uvchr>, and C<isBLANK_LC_utf8>. Note, however, that some |
| 592 | platforms do not have the C library routine C<isblank()>. In these cases, the |
| 593 | variants whose names contain C<LC> are the same as the corresponding ones |
| 594 | without. |
| 595 | |
| 596 | =for apidoc Am|bool|isCNTRL|char ch |
| 597 | Returns a boolean indicating whether the specified character is a |
| 598 | control character, analogous to C<m/[[:cntrl:]]/>. |
| 599 | See the L<top of this section|/Character classification> for an explanation of |
| 600 | variants |
| 601 | C<isCNTRL_A>, C<isCNTRL_L1>, C<isCNTRL_uni>, C<isCNTRL_utf8>, C<isCNTRL_LC>, |
| 602 | C<isCNTRL_LC_uvchr>, and C<isCNTRL_LC_utf8> |
| 603 | On EBCDIC platforms, you almost always want to use the C<isCNTRL_L1> variant. |
| 604 | |
| 605 | =for apidoc Am|bool|isDIGIT|char ch |
| 606 | Returns a boolean indicating whether the specified character is a |
| 607 | digit, analogous to C<m/[[:digit:]]/>. |
| 608 | Variants C<isDIGIT_A> and C<isDIGIT_L1> are identical to C<isDIGIT>. |
| 609 | See the L<top of this section|/Character classification> for an explanation of |
| 610 | variants |
| 611 | C<isDIGIT_uni>, C<isDIGIT_utf8>, C<isDIGIT_LC>, C<isDIGIT_LC_uvchr>, and |
| 612 | C<isDIGIT_LC_utf8>. |
| 613 | |
| 614 | =for apidoc Am|bool|isGRAPH|char ch |
| 615 | Returns a boolean indicating whether the specified character is a |
| 616 | graphic character, analogous to C<m/[[:graph:]]/>. |
| 617 | See the L<top of this section|/Character classification> for an explanation of |
| 618 | variants |
| 619 | C<isGRAPH_A>, C<isGRAPH_L1>, C<isGRAPH_uni>, C<isGRAPH_utf8>, C<isGRAPH_LC>, |
| 620 | C<isGRAPH_LC_uvchr>, and C<isGRAPH_LC_utf8>. |
| 621 | |
| 622 | =for apidoc Am|bool|isLOWER|char ch |
| 623 | Returns a boolean indicating whether the specified character is a |
| 624 | lowercase character, analogous to C<m/[[:lower:]]/>. |
| 625 | See the L<top of this section|/Character classification> for an explanation of |
| 626 | variants |
| 627 | C<isLOWER_A>, C<isLOWER_L1>, C<isLOWER_uni>, C<isLOWER_utf8>, C<isLOWER_LC>, |
| 628 | C<isLOWER_LC_uvchr>, and C<isLOWER_LC_utf8>. |
| 629 | |
| 630 | =for apidoc Am|bool|isOCTAL|char ch |
| 631 | Returns a boolean indicating whether the specified character is an |
| 632 | octal digit, [0-7]. |
| 633 | The only two variants are C<isOCTAL_A> and C<isOCTAL_L1>; each is identical to |
| 634 | C<isOCTAL>. |
| 635 | |
| 636 | =for apidoc Am|bool|isPUNCT|char ch |
| 637 | Returns a boolean indicating whether the specified character is a |
| 638 | punctuation character, analogous to C<m/[[:punct:]]/>. |
| 639 | Note that the definition of what is punctuation isn't as |
| 640 | straightforward as one might desire. See L<perlrecharclass/POSIX Character |
| 641 | Classes> for details. |
| 642 | See the L<top of this section|/Character classification> for an explanation of |
| 643 | variants |
| 644 | C<isPUNCT_A>, C<isPUNCT_L1>, C<isPUNCT_uni>, C<isPUNCT_utf8>, C<isPUNCT_LC>, |
| 645 | C<isPUNCT_LC_uvchr>, and C<isPUNCT_LC_utf8>. |
| 646 | |
| 647 | =for apidoc Am|bool|isSPACE|char ch |
| 648 | Returns a boolean indicating whether the specified character is a |
| 649 | whitespace character. This is analogous |
| 650 | to what C<m/\s/> matches in a regular expression. Starting in Perl 5.18 |
| 651 | (experimentally), this also matches what C<m/[[:space:]]/> does. |
| 652 | ("Experimentally" means that this change may be backed out in 5.22 if |
| 653 | field experience indicates that it was unwise.) Prior to 5.18, only the |
| 654 | locale forms of this macro (the ones with C<LC> in their names) matched |
| 655 | precisely what C<m/[[:space:]]/> does. In those releases, the only difference, |
| 656 | in the non-locale variants, was that C<isSPACE()> did not match a vertical tab. |
| 657 | (See L</isPSXSPC> for a macro that matches a vertical tab in all releases.) |
| 658 | See the L<top of this section|/Character classification> for an explanation of |
| 659 | variants |
| 660 | C<isSPACE_A>, C<isSPACE_L1>, C<isSPACE_uni>, C<isSPACE_utf8>, C<isSPACE_LC>, |
| 661 | C<isSPACE_LC_uvchr>, and C<isSPACE_LC_utf8>. |
| 662 | |
| 663 | =for apidoc Am|bool|isPSXSPC|char ch |
| 664 | (short for Posix Space) |
| 665 | Starting in 5.18, this is identical (experimentally) in all its forms to the |
| 666 | corresponding C<isSPACE()> macros. ("Experimentally" means that this change |
| 667 | may be backed out in 5.22 if field experience indicates that it |
| 668 | was unwise.) |
| 669 | The locale forms of this macro are identical to their corresponding |
| 670 | C<isSPACE()> forms in all Perl releases. In releases prior to 5.18, the |
| 671 | non-locale forms differ from their C<isSPACE()> forms only in that the |
| 672 | C<isSPACE()> forms don't match a Vertical Tab, and the C<isPSXSPC()> forms do. |
| 673 | Otherwise they are identical. Thus this macro is analogous to what |
| 674 | C<m/[[:space:]]/> matches in a regular expression. |
| 675 | See the L<top of this section|/Character classification> for an explanation of |
| 676 | variants |
| 677 | C<isPSXSPC_A>, C<isPSXSPC_L1>, C<isPSXSPC_uni>, C<isPSXSPC_utf8>, C<isPSXSPC_LC>, |
| 678 | C<isPSXSPC_LC_uvchr>, and C<isPSXSPC_LC_utf8>. |
| 679 | |
| 680 | =for apidoc Am|bool|isUPPER|char ch |
| 681 | Returns a boolean indicating whether the specified character is an |
| 682 | uppercase character, analogous to C<m/[[:upper:]]/>. |
| 683 | See the L<top of this section|/Character classification> for an explanation of |
| 684 | variants |
| 685 | C<isUPPER_A>, C<isUPPER_L1>, C<isUPPER_uni>, C<isUPPER_utf8>, C<isUPPER_LC>, |
| 686 | C<isUPPER_LC_uvchr>, and C<isUPPER_LC_utf8>. |
| 687 | |
| 688 | =for apidoc Am|bool|isPRINT|char ch |
| 689 | Returns a boolean indicating whether the specified character is a |
| 690 | printable character, analogous to C<m/[[:print:]]/>. |
| 691 | See the L<top of this section|/Character classification> for an explanation of |
| 692 | variants |
| 693 | C<isPRINT_A>, C<isPRINT_L1>, C<isPRINT_uni>, C<isPRINT_utf8>, C<isPRINT_LC>, |
| 694 | C<isPRINT_LC_uvchr>, and C<isPRINT_LC_utf8>. |
| 695 | |
| 696 | =for apidoc Am|bool|isWORDCHAR|char ch |
| 697 | Returns a boolean indicating whether the specified character is a character |
| 698 | that is a word character, analogous to what C<m/\w/> and C<m/[[:word:]]/> match |
| 699 | in a regular expression. A word character is an alphabetic character, a |
| 700 | decimal digit, a connecting punctuation character (such as an underscore), or |
| 701 | a "mark" character that attaches to one of those (like some sort of accent). |
| 702 | C<isALNUM()> is a synonym provided for backward compatibility, even though a |
| 703 | word character includes more than the standard C language meaning of |
| 704 | alphanumeric. |
| 705 | See the L<top of this section|/Character classification> for an explanation of |
| 706 | variants |
| 707 | C<isWORDCHAR_A>, C<isWORDCHAR_L1>, C<isWORDCHAR_uni>, C<isWORDCHAR_utf8>, |
| 708 | C<isWORDCHAR_LC>, C<isWORDCHAR_LC_uvchr>, and C<isWORDCHAR_LC_utf8>. |
| 709 | |
| 710 | =for apidoc Am|bool|isXDIGIT|char ch |
| 711 | Returns a boolean indicating whether the specified character is a hexadecimal |
| 712 | digit. In the ASCII range these are C<[0-9A-Fa-f]>. Variants C<isXDIGIT_A()> |
| 713 | and C<isXDIGIT_L1()> are identical to C<isXDIGIT()>. |
| 714 | See the L<top of this section|/Character classification> for an explanation of |
| 715 | variants |
| 716 | C<isXDIGIT_uni>, C<isXDIGIT_utf8>, C<isXDIGIT_LC>, C<isXDIGIT_LC_uvchr>, and |
| 717 | C<isXDIGIT_LC_utf8>. |
| 718 | |
| 719 | =for apidoc Am|bool|isIDFIRST|char ch |
| 720 | Returns a boolean indicating whether the specified character can be the first |
| 721 | character of an identifier. This is very close to, but not quite the same as |
| 722 | the official Unicode property C<XID_Start>. The difference is that this |
| 723 | returns true only if the input character also matches L</isWORDCHAR>. |
| 724 | See the L<top of this section|/Character classification> for an explanation of |
| 725 | variants |
| 726 | C<isIDFIRST_A>, C<isIDFIRST_L1>, C<isIDFIRST_uni>, C<isIDFIRST_utf8>, |
| 727 | C<isIDFIRST_LC>, C<isIDFIRST_LC_uvchr>, and C<isIDFIRST_LC_utf8>. |
| 728 | |
| 729 | =for apidoc Am|bool|isIDCONT|char ch |
| 730 | Returns a boolean indicating whether the specified character can be the |
| 731 | second or succeeding character of an identifier. This is very close to, but |
| 732 | not quite the same as the official Unicode property C<XID_Continue>. The |
| 733 | difference is that this returns true only if the input character also matches |
| 734 | L</isWORDCHAR>. See the L<top of this section|/Character classification> for |
| 735 | an |
| 736 | explanation of variants C<isIDCONT_A>, C<isIDCONT_L1>, C<isIDCONT_uni>, |
| 737 | C<isIDCONT_utf8>, C<isIDCONT_LC>, C<isIDCONT_LC_uvchr>, and |
| 738 | C<isIDCONT_LC_utf8>. |
| 739 | |
| 740 | =head1 Miscellaneous Functions |
| 741 | |
| 742 | =for apidoc Am|U8|READ_XDIGIT|char str* |
| 743 | Returns the value of an ASCII-range hex digit and advances the string pointer. |
| 744 | Behaviour is only well defined when isXDIGIT(*str) is true. |
| 745 | |
| 746 | =head1 Character case changing |
| 747 | |
| 748 | =for apidoc Am|U8|toUPPER|U8 ch |
| 749 | Converts the specified character to uppercase. If the input is anything but an |
| 750 | ASCII lowercase character, that input character itself is returned. Variant |
| 751 | C<toUPPER_A> is equivalent. |
| 752 | |
| 753 | =for apidoc Am|UV|toUPPER_uni|UV cp|U8* s|STRLEN* lenp |
| 754 | Converts the Unicode code point C<cp> to its uppercase version, and |
| 755 | stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note |
| 756 | that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1> |
| 757 | bytes since the uppercase version may be longer than the original character. |
| 758 | |
| 759 | The first code point of the uppercased version is returned |
| 760 | (but note, as explained just above, that there may be more.) |
| 761 | |
| 762 | =for apidoc Am|UV|toUPPER_utf8|U8* p|U8* s|STRLEN* lenp |
| 763 | Converts the UTF-8 encoded character at C<p> to its uppercase version, and |
| 764 | stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note |
| 765 | that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1> |
| 766 | bytes since the uppercase version may be longer than the original character. |
| 767 | |
| 768 | The first code point of the uppercased version is returned |
| 769 | (but note, as explained just above, that there may be more.) |
| 770 | |
| 771 | The input character at C<p> is assumed to be well-formed. |
| 772 | |
| 773 | =for apidoc Am|U8|toFOLD|U8 ch |
| 774 | Converts the specified character to foldcase. If the input is anything but an |
| 775 | ASCII uppercase character, that input character itself is returned. Variant |
| 776 | C<toFOLD_A> is equivalent. (There is no equivalent C<to_FOLD_L1> for the full |
| 777 | Latin1 range, as the full generality of L</toFOLD_uni> is needed there.) |
| 778 | |
| 779 | =for apidoc Am|UV|toFOLD_uni|UV cp|U8* s|STRLEN* lenp |
| 780 | Converts the Unicode code point C<cp> to its foldcase version, and |
| 781 | stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note |
| 782 | that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1> |
| 783 | bytes since the foldcase version may be longer than the original character. |
| 784 | |
| 785 | The first code point of the foldcased version is returned |
| 786 | (but note, as explained just above, that there may be more.) |
| 787 | |
| 788 | =for apidoc Am|UV|toFOLD_utf8|U8* p|U8* s|STRLEN* lenp |
| 789 | Converts the UTF-8 encoded character at C<p> to its foldcase version, and |
| 790 | stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note |
| 791 | that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1> |
| 792 | bytes since the foldcase version may be longer than the original character. |
| 793 | |
| 794 | The first code point of the foldcased version is returned |
| 795 | (but note, as explained just above, that there may be more.) |
| 796 | |
| 797 | The input character at C<p> is assumed to be well-formed. |
| 798 | |
| 799 | =for apidoc Am|U8|toLOWER|U8 ch |
| 800 | Converts the specified character to lowercase. If the input is anything but an |
| 801 | ASCII uppercase character, that input character itself is returned. Variant |
| 802 | C<toLOWER_A> is equivalent. |
| 803 | |
| 804 | =for apidoc Am|U8|toLOWER_L1|U8 ch |
| 805 | Converts the specified Latin1 character to lowercase. The results are undefined if |
| 806 | the input doesn't fit in a byte. |
| 807 | |
| 808 | =for apidoc Am|U8|toLOWER_LC|U8 ch |
| 809 | Converts the specified character to lowercase using the current locale's rules, |
| 810 | if possible; otherwise returns the input character itself. |
| 811 | |
| 812 | =for apidoc Am|UV|toLOWER_uni|UV cp|U8* s|STRLEN* lenp |
| 813 | Converts the Unicode code point C<cp> to its lowercase version, and |
| 814 | stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note |
| 815 | that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1> |
| 816 | bytes since the lowercase version may be longer than the original character. |
| 817 | |
| 818 | The first code point of the lowercased version is returned |
| 819 | (but note, as explained just above, that there may be more.) |
| 820 | |
| 821 | =for apidoc Am|UV|toLOWER_utf8|U8* p|U8* s|STRLEN* lenp |
| 822 | Converts the UTF-8 encoded character at C<p> to its lowercase version, and |
| 823 | stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note |
| 824 | that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1> |
| 825 | bytes since the lowercase version may be longer than the original character. |
| 826 | |
| 827 | The first code point of the lowercased version is returned |
| 828 | (but note, as explained just above, that there may be more.) |
| 829 | |
| 830 | The input character at C<p> is assumed to be well-formed. |
| 831 | |
| 832 | =for apidoc Am|U8|toLOWER_LC|U8 ch |
| 833 | Converts the specified character to lowercase using the current locale's rules, |
| 834 | if possible; otherwise returns the input character itself. |
| 835 | |
| 836 | =for apidoc Am|U8|toTITLE|U8 ch |
| 837 | Converts the specified character to titlecase. If the input is anything but an |
| 838 | ASCII lowercase character, that input character itself is returned. Variant |
| 839 | C<toTITLE_A> is equivalent. (There is no C<toTITLE_L1> for the full Latin1 range, |
| 840 | as the full generality of L</toTITLE_uni> is needed there. Titlecase is not a |
| 841 | concept used in locale handling, so there is no functionality for that.) |
| 842 | |
| 843 | =for apidoc Am|UV|toTITLE_uni|UV cp|U8* s|STRLEN* lenp |
| 844 | Converts the Unicode code point C<cp> to its titlecase version, and |
| 845 | stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note |
| 846 | that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1> |
| 847 | bytes since the titlecase version may be longer than the original character. |
| 848 | |
| 849 | The first code point of the titlecased version is returned |
| 850 | (but note, as explained just above, that there may be more.) |
| 851 | |
| 852 | =for apidoc Am|UV|toTITLE_utf8|U8* p|U8* s|STRLEN* lenp |
| 853 | Converts the UTF-8 encoded character at C<p> to its titlecase 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 titlecase version may be longer than the original character. |
| 857 | |
| 858 | The first code point of the titlecased version is returned |
| 859 | (but note, as explained just above, that there may be more.) |
| 860 | |
| 861 | The input character at C<p> is assumed to be well-formed. |
| 862 | |
| 863 | =cut |
| 864 | |
| 865 | XXX Still undocumented isVERTWS_uni and _utf8; it's unclear what their names |
| 866 | really should be. Also toUPPER_LC and toFOLD_LC, which are subject to change. |
| 867 | |
| 868 | Note that these macros are repeated in Devel::PPPort, so should also be |
| 869 | patched there. The file as of this writing is cpan/Devel-PPPort/parts/inc/misc |
| 870 | |
| 871 | */ |
| 872 | |
| 873 | /* Specify the widest unsigned type on the platform. Use U64TYPE because U64 |
| 874 | * is known only in the perl core, and this macro can be called from outside |
| 875 | * that */ |
| 876 | #ifdef HAS_QUAD |
| 877 | # define WIDEST_UTYPE U64TYPE |
| 878 | #else |
| 879 | # define WIDEST_UTYPE U32 |
| 880 | #endif |
| 881 | |
| 882 | /* FITS_IN_8_BITS(c) returns true if c doesn't have a bit set other than in |
| 883 | * the lower 8. It is designed to be hopefully bomb-proof, making sure that no |
| 884 | * bits of information are lost even on a 64-bit machine, but to get the |
| 885 | * compiler to optimize it out if possible. This is because Configure makes |
| 886 | * sure that the machine has an 8-bit byte, so if c is stored in a byte, the |
| 887 | * sizeof() guarantees that this evaluates to a constant true at compile time. |
| 888 | */ |
| 889 | #define FITS_IN_8_BITS(c) ((sizeof(c) == 1) || !(((WIDEST_UTYPE)(c)) & ~0xFF)) |
| 890 | |
| 891 | #ifdef EBCDIC |
| 892 | # ifndef _ALL_SOURCE |
| 893 | /* This returns the wrong results on at least z/OS unless this is |
| 894 | * defined. */ |
| 895 | # error _ALL_SOURCE should probably be defined |
| 896 | # endif |
| 897 | |
| 898 | /* We could be called without perl.h, in which case NATIVE_TO_ASCII() is |
| 899 | * likely not defined, and so we use the native function */ |
| 900 | # define isASCII(c) cBOOL(isascii(c)) |
| 901 | #else |
| 902 | # define isASCII(c) ((WIDEST_UTYPE)(c) < 128) |
| 903 | #endif |
| 904 | |
| 905 | #define isASCII_A(c) isASCII(c) |
| 906 | #define isASCII_L1(c) isASCII(c) |
| 907 | |
| 908 | /* The lower 3 bits in both the ASCII and EBCDIC representations of '0' are 0, |
| 909 | * and the 8 possible permutations of those bits exactly comprise the 8 octal |
| 910 | * digits */ |
| 911 | #define isOCTAL_A(c) cBOOL(FITS_IN_8_BITS(c) && (0xF8 & (c)) == '0') |
| 912 | |
| 913 | /* ASCII range only */ |
| 914 | #ifdef H_PERL /* If have access to perl.h, lookup in its table */ |
| 915 | |
| 916 | /* Character class numbers. For internal core Perl use only. The ones less |
| 917 | * than 32 are used in PL_charclass[] and the ones up through the one that |
| 918 | * corresponds to <_HIGHEST_REGCOMP_DOT_H_SYNC> are used by regcomp.h and |
| 919 | * related files. PL_charclass ones use names used in l1_char_class_tab.h but |
| 920 | * their actual definitions are here. If that file has a name not used here, |
| 921 | * it won't compile. |
| 922 | * |
| 923 | * The first group of these is ordered in what I (khw) estimate to be the |
| 924 | * frequency of their use. This gives a slight edge to exiting a loop earlier |
| 925 | * (in reginclass() in regexec.c) */ |
| 926 | # define _CC_WORDCHAR 0 /* \w and [:word:] */ |
| 927 | # define _CC_DIGIT 1 /* \d and [:digit:] */ |
| 928 | # define _CC_ALPHA 2 /* [:alpha:] */ |
| 929 | # define _CC_LOWER 3 /* [:lower:] */ |
| 930 | # define _CC_UPPER 4 /* [:upper:] */ |
| 931 | # define _CC_PUNCT 5 /* [:punct:] */ |
| 932 | # define _CC_PRINT 6 /* [:print:] */ |
| 933 | # define _CC_ALPHANUMERIC 7 /* [:alnum:] */ |
| 934 | # define _CC_GRAPH 8 /* [:graph:] */ |
| 935 | # define _CC_CASED 9 /* [:lower:] and [:upper:] under /i */ |
| 936 | |
| 937 | #define _FIRST_NON_SWASH_CC 10 |
| 938 | /* The character classes above are implemented with swashes. The second group |
| 939 | * (just below) contains the ones implemented without. These are also sorted |
| 940 | * in rough order of the frequency of their use, except that \v should be last, |
| 941 | * as it isn't a real Posix character class, and some (small) inefficiencies in |
| 942 | * regular expression handling would be introduced by putting it in the middle |
| 943 | * of those that are. Also, cntrl and ascii come after the others as it may be |
| 944 | * useful to group these which have no members that match above Latin1, (or |
| 945 | * above ASCII in the latter case) */ |
| 946 | |
| 947 | # define _CC_SPACE 10 /* \s */ |
| 948 | # define _CC_BLANK 11 /* [:blank:] */ |
| 949 | # define _CC_XDIGIT 12 /* [:xdigit:] */ |
| 950 | # define _CC_PSXSPC 13 /* [:space:] */ |
| 951 | # define _CC_CNTRL 14 /* [:cntrl:] */ |
| 952 | # define _CC_ASCII 15 /* [:ascii:] */ |
| 953 | # define _CC_VERTSPACE 16 /* \v */ |
| 954 | |
| 955 | # define _HIGHEST_REGCOMP_DOT_H_SYNC _CC_VERTSPACE |
| 956 | |
| 957 | /* The members of the third group below do not need to be coordinated with data |
| 958 | * structures in regcomp.[ch] and regexec.c. */ |
| 959 | # define _CC_IDFIRST 17 |
| 960 | # define _CC_CHARNAME_CONT 18 |
| 961 | # define _CC_NONLATIN1_FOLD 19 |
| 962 | # define _CC_NONLATIN1_SIMPLE_FOLD 20 |
| 963 | # define _CC_QUOTEMETA 21 |
| 964 | # define _CC_NON_FINAL_FOLD 22 |
| 965 | # define _CC_IS_IN_SOME_FOLD 23 |
| 966 | # define _CC_MNEMONIC_CNTRL 24 |
| 967 | /* Unused: 25-31 |
| 968 | * If more bits are needed, one could add a second word for non-64bit |
| 969 | * QUAD_IS_INT systems, using some #ifdefs to distinguish between having a 2nd |
| 970 | * word or not. The IS_IN_SOME_FOLD bit is the most easily expendable, as it |
| 971 | * is used only for optimization (as of this writing), and differs in the |
| 972 | * Latin1 range from the ALPHA bit only in two relatively unimportant |
| 973 | * characters: the masculine and feminine ordinal indicators, so removing it |
| 974 | * would just cause /i regexes which match them to run less efficiently */ |
| 975 | |
| 976 | #if defined(PERL_CORE) || defined(PERL_EXT) |
| 977 | /* An enum version of the character class numbers, to help compilers |
| 978 | * optimize */ |
| 979 | typedef enum { |
| 980 | _CC_ENUM_ALPHA = _CC_ALPHA, |
| 981 | _CC_ENUM_ALPHANUMERIC = _CC_ALPHANUMERIC, |
| 982 | _CC_ENUM_ASCII = _CC_ASCII, |
| 983 | _CC_ENUM_BLANK = _CC_BLANK, |
| 984 | _CC_ENUM_CASED = _CC_CASED, |
| 985 | _CC_ENUM_CNTRL = _CC_CNTRL, |
| 986 | _CC_ENUM_DIGIT = _CC_DIGIT, |
| 987 | _CC_ENUM_GRAPH = _CC_GRAPH, |
| 988 | _CC_ENUM_LOWER = _CC_LOWER, |
| 989 | _CC_ENUM_PRINT = _CC_PRINT, |
| 990 | _CC_ENUM_PSXSPC = _CC_PSXSPC, |
| 991 | _CC_ENUM_PUNCT = _CC_PUNCT, |
| 992 | _CC_ENUM_SPACE = _CC_SPACE, |
| 993 | _CC_ENUM_UPPER = _CC_UPPER, |
| 994 | _CC_ENUM_VERTSPACE = _CC_VERTSPACE, |
| 995 | _CC_ENUM_WORDCHAR = _CC_WORDCHAR, |
| 996 | _CC_ENUM_XDIGIT = _CC_XDIGIT |
| 997 | } _char_class_number; |
| 998 | #endif |
| 999 | |
| 1000 | #define POSIX_SWASH_COUNT _FIRST_NON_SWASH_CC |
| 1001 | #define POSIX_CC_COUNT (_HIGHEST_REGCOMP_DOT_H_SYNC + 1) |
| 1002 | |
| 1003 | #if defined(PERL_IN_UTF8_C) || defined(PERL_IN_REGCOMP_C) || defined(PERL_IN_REGEXEC_C) |
| 1004 | # if _CC_WORDCHAR != 0 || _CC_DIGIT != 1 || _CC_ALPHA != 2 || _CC_LOWER != 3 \ |
| 1005 | || _CC_UPPER != 4 || _CC_PUNCT != 5 || _CC_PRINT != 6 \ |
| 1006 | || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8 || _CC_CASED != 9 |
| 1007 | #error Need to adjust order of swash_property_names[] |
| 1008 | # endif |
| 1009 | |
| 1010 | /* This is declared static in each of the few files that this is #defined for |
| 1011 | * to keep them from being publicly accessible. Hence there is a small amount |
| 1012 | * of wasted space */ |
| 1013 | |
| 1014 | static const char* const swash_property_names[] = { |
| 1015 | "XPosixWord", |
| 1016 | "XPosixDigit", |
| 1017 | "XPosixAlpha", |
| 1018 | "XPosixLower", |
| 1019 | "XPosixUpper", |
| 1020 | "XPosixPunct", |
| 1021 | "XPosixPrint", |
| 1022 | "XPosixAlnum", |
| 1023 | "XPosixGraph", |
| 1024 | "Cased" |
| 1025 | }; |
| 1026 | #endif |
| 1027 | |
| 1028 | # ifdef DOINIT |
| 1029 | EXTCONST U32 PL_charclass[] = { |
| 1030 | # include "l1_char_class_tab.h" |
| 1031 | }; |
| 1032 | |
| 1033 | # else /* ! DOINIT */ |
| 1034 | EXTCONST U32 PL_charclass[]; |
| 1035 | # endif |
| 1036 | |
| 1037 | /* The 1U keeps Solaris from griping when shifting sets the uppermost bit */ |
| 1038 | # define _CC_mask(classnum) (1U << (classnum)) |
| 1039 | |
| 1040 | /* For internal core Perl use only: the base macro for defining macros like |
| 1041 | * isALPHA */ |
| 1042 | # define _generic_isCC(c, classnum) cBOOL(FITS_IN_8_BITS(c) \ |
| 1043 | && (PL_charclass[(U8) (c)] & _CC_mask(classnum))) |
| 1044 | |
| 1045 | /* The mask for the _A versions of the macros; it just adds in the bit for |
| 1046 | * ASCII. */ |
| 1047 | # define _CC_mask_A(classnum) (_CC_mask(classnum) | _CC_mask(_CC_ASCII)) |
| 1048 | |
| 1049 | /* For internal core Perl use only: the base macro for defining macros like |
| 1050 | * isALPHA_A. The foo_A version makes sure that both the desired bit and |
| 1051 | * the ASCII bit are present */ |
| 1052 | # define _generic_isCC_A(c, classnum) (FITS_IN_8_BITS(c) \ |
| 1053 | && ((PL_charclass[(U8) (c)] & _CC_mask_A(classnum)) \ |
| 1054 | == _CC_mask_A(classnum))) |
| 1055 | |
| 1056 | # define isALPHA_A(c) _generic_isCC_A(c, _CC_ALPHA) |
| 1057 | # define isALPHANUMERIC_A(c) _generic_isCC_A(c, _CC_ALPHANUMERIC) |
| 1058 | # define isBLANK_A(c) _generic_isCC_A(c, _CC_BLANK) |
| 1059 | # define isCNTRL_A(c) _generic_isCC_A(c, _CC_CNTRL) |
| 1060 | # define isDIGIT_A(c) _generic_isCC(c, _CC_DIGIT) /* No non-ASCII digits */ |
| 1061 | # define isGRAPH_A(c) _generic_isCC_A(c, _CC_GRAPH) |
| 1062 | # define isLOWER_A(c) _generic_isCC_A(c, _CC_LOWER) |
| 1063 | # define isPRINT_A(c) _generic_isCC_A(c, _CC_PRINT) |
| 1064 | # define isPSXSPC_A(c) _generic_isCC_A(c, _CC_PSXSPC) |
| 1065 | # define isPUNCT_A(c) _generic_isCC_A(c, _CC_PUNCT) |
| 1066 | # define isSPACE_A(c) _generic_isCC_A(c, _CC_SPACE) |
| 1067 | # define isUPPER_A(c) _generic_isCC_A(c, _CC_UPPER) |
| 1068 | # define isWORDCHAR_A(c) _generic_isCC_A(c, _CC_WORDCHAR) |
| 1069 | # define isXDIGIT_A(c) _generic_isCC(c, _CC_XDIGIT) /* No non-ASCII xdigits */ |
| 1070 | # define isIDFIRST_A(c) _generic_isCC_A(c, _CC_IDFIRST) |
| 1071 | # define isALPHA_L1(c) _generic_isCC(c, _CC_ALPHA) |
| 1072 | # define isALPHANUMERIC_L1(c) _generic_isCC(c, _CC_ALPHANUMERIC) |
| 1073 | # define isBLANK_L1(c) _generic_isCC(c, _CC_BLANK) |
| 1074 | |
| 1075 | /* continuation character for legal NAME in \N{NAME} */ |
| 1076 | # define isCHARNAME_CONT(c) _generic_isCC(c, _CC_CHARNAME_CONT) |
| 1077 | |
| 1078 | # define isCNTRL_L1(c) _generic_isCC(c, _CC_CNTRL) |
| 1079 | # define isGRAPH_L1(c) _generic_isCC(c, _CC_GRAPH) |
| 1080 | # define isLOWER_L1(c) _generic_isCC(c, _CC_LOWER) |
| 1081 | # define isPRINT_L1(c) _generic_isCC(c, _CC_PRINT) |
| 1082 | # define isPSXSPC_L1(c) _generic_isCC(c, _CC_PSXSPC) |
| 1083 | # define isPUNCT_L1(c) _generic_isCC(c, _CC_PUNCT) |
| 1084 | # define isSPACE_L1(c) _generic_isCC(c, _CC_SPACE) |
| 1085 | # define isUPPER_L1(c) _generic_isCC(c, _CC_UPPER) |
| 1086 | # define isWORDCHAR_L1(c) _generic_isCC(c, _CC_WORDCHAR) |
| 1087 | # define isIDFIRST_L1(c) _generic_isCC(c, _CC_IDFIRST) |
| 1088 | |
| 1089 | /* Participates in a single-character fold with a character above 255 */ |
| 1090 | # 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))) |
| 1091 | |
| 1092 | /* Like the above, but also can be part of a multi-char fold */ |
| 1093 | # 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))) |
| 1094 | |
| 1095 | # define _isQUOTEMETA(c) _generic_isCC(c, _CC_QUOTEMETA) |
| 1096 | # define _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \ |
| 1097 | _generic_isCC(c, _CC_NON_FINAL_FOLD) |
| 1098 | # define _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \ |
| 1099 | _generic_isCC(c, _CC_IS_IN_SOME_FOLD) |
| 1100 | # define _IS_MNEMONIC_CNTRL_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) \ |
| 1101 | _generic_isCC(c, _CC_MNEMONIC_CNTRL) |
| 1102 | #else /* else we don't have perl.h */ |
| 1103 | |
| 1104 | /* If we don't have perl.h, we are compiling a utility program. Below we |
| 1105 | * hard-code various macro definitions that wouldn't otherwise be available |
| 1106 | * to it. */ |
| 1107 | # ifdef EBCDIC |
| 1108 | /* Use the native functions. They likely will return false for all |
| 1109 | * non-ASCII values, but this makes sure */ |
| 1110 | # define isLOWER_A(c) (isASCII(c) && islower(c)) |
| 1111 | # define isPRINT_A(c) (isASCII(c) && isprint(c)) |
| 1112 | # define isUPPER_A(c) (isASCII(c) && isupper(c)) |
| 1113 | # else /* ASCII platform. These are coded based on first principals */ |
| 1114 | # define isLOWER_A(c) ((c) >= 'a' && (c) <= 'z') |
| 1115 | # define isPRINT_A(c) (((c) >= 32 && (c) < 127)) |
| 1116 | # define isUPPER_A(c) ((c) <= 'Z' && (c) >= 'A') |
| 1117 | # endif /* Below are common definitions for ASCII and non-ASCII */ |
| 1118 | # define isALPHA_A(c) (isUPPER_A(c) || isLOWER_A(c)) |
| 1119 | # define isALPHANUMERIC_A(c) (isALPHA_A(c) || isDIGIT_A(c)) |
| 1120 | # define isBLANK_A(c) ((c) == ' ' || (c) == '\t') |
| 1121 | # define isCNTRL_A(c) (isASCII(c) && (! isPRINT_A(c))) |
| 1122 | # define isDIGIT_A(c) ((c) <= '9' && (c) >= '0') |
| 1123 | # define isGRAPH_A(c) (isPRINT_A(c) && (c) != ' ') |
| 1124 | # define isIDFIRST_A(c) (isALPHA_A(c) || (c) == '_') |
| 1125 | # define isPUNCT_A(c) (isGRAPH_A(c) && (! isALPHANUMERIC_A(c))) |
| 1126 | # define isSPACE_A(c) ((c) == ' ' \ |
| 1127 | || (c) == '\t' \ |
| 1128 | || (c) == '\n' \ |
| 1129 | || (c) == '\r' \ |
| 1130 | || (c) == '\v' \ |
| 1131 | || (c) == '\f') |
| 1132 | # define isWORDCHAR_A(c) (isALPHANUMERIC_A(c) || (c) == '_') |
| 1133 | # define isXDIGIT_A(c) (isDIGIT_A(c) \ |
| 1134 | || ((c) >= 'a' && (c) <= 'f') \ |
| 1135 | || ((c) <= 'F' && (c) >= 'A')) |
| 1136 | |
| 1137 | /* The _L1 macros may be unnecessary for the utilities; I (khw) added them |
| 1138 | * during debugging, and it seems best to keep them. */ |
| 1139 | # define isPSXSPC_A(c) isSPACE_A(c) /* XXX Assumes SPACE matches '\v' */ |
| 1140 | # define isALPHA_L1(c) (isUPPER_L1(c) || isLOWER_L1(c)) |
| 1141 | # define isALPHANUMERIC_L1(c) (isALPHA_L1(c) || isDIGIT_A(c)) |
| 1142 | # define isBLANK_L1(c) (isBLANK_A(c) \ |
| 1143 | || (FITS_IN_8_BITS(c) \ |
| 1144 | && NATIVE_TO_LATIN1((U8) c) == 0xA0)) |
| 1145 | # define isCNTRL_L1(c) (FITS_IN_8_BITS(c) && (! isPRINT_L1(c))) |
| 1146 | # define isGRAPH_L1(c) (isPRINT_L1(c) && (! isBLANK_L1(c))) |
| 1147 | # define isLOWER_L1(c) (isLOWER_A(c) \ |
| 1148 | || (FITS_IN_8_BITS(c) \ |
| 1149 | && ((NATIVE_TO_LATIN1((U8) c) >= 0xDF \ |
| 1150 | && NATIVE_TO_LATIN1((U8) c) != 0xF7) \ |
| 1151 | || NATIVE_TO_LATIN1((U8) c) == 0xAA \ |
| 1152 | || NATIVE_TO_LATIN1((U8) c) == 0xBA \ |
| 1153 | || NATIVE_TO_LATIN1((U8) c) == 0xB5))) |
| 1154 | # define isPRINT_L1(c) (isPRINT_A(c) \ |
| 1155 | || (FITS_IN_8_BITS(c) \ |
| 1156 | && NATIVE_TO_LATIN1((U8) c) >= 0xA0)) |
| 1157 | # define isPSXSPC_L1(c) isSPACE_L1(c) |
| 1158 | # define isPUNCT_L1(c) (isPUNCT_A(c) \ |
| 1159 | || (FITS_IN_8_BITS(c) \ |
| 1160 | && (NATIVE_TO_LATIN1((U8) c) == 0xA1 \ |
| 1161 | || NATIVE_TO_LATIN1((U8) c) == 0xA7 \ |
| 1162 | || NATIVE_TO_LATIN1((U8) c) == 0xAB \ |
| 1163 | || NATIVE_TO_LATIN1((U8) c) == 0xB6 \ |
| 1164 | || NATIVE_TO_LATIN1((U8) c) == 0xB7 \ |
| 1165 | || NATIVE_TO_LATIN1((U8) c) == 0xBB \ |
| 1166 | || NATIVE_TO_LATIN1((U8) c) == 0xBF))) |
| 1167 | # define isSPACE_L1(c) (isSPACE_A(c) \ |
| 1168 | || (FITS_IN_8_BITS(c) \ |
| 1169 | && (NATIVE_TO_LATIN1((U8) c) == 0x85 \ |
| 1170 | || NATIVE_TO_LATIN1((U8) c) == 0xA0))) |
| 1171 | # define isUPPER_L1(c) (isUPPER_A(c) \ |
| 1172 | || (FITS_IN_8_BITS(c) \ |
| 1173 | && (NATIVE_TO_LATIN1((U8) c) >= 0xC0 \ |
| 1174 | && NATIVE_TO_LATIN1((U8) c) <= 0xDE \ |
| 1175 | && NATIVE_TO_LATIN1((U8) c) != 0xD7))) |
| 1176 | # define isWORDCHAR_L1(c) (isIDFIRST_L1(c) || isDIGIT_A(c)) |
| 1177 | # define isIDFIRST_L1(c) (isALPHA_L1(c) || NATIVE_TO_LATIN1(c) == '_') |
| 1178 | # define isCHARNAME_CONT(c) (isWORDCHAR_L1(c) \ |
| 1179 | || isBLANK_L1(c) \ |
| 1180 | || (c) == '-' \ |
| 1181 | || (c) == '(' \ |
| 1182 | || (c) == ')') |
| 1183 | /* The following are not fully accurate in the above-ASCII range. I (khw) |
| 1184 | * don't think it's necessary to be so for the purposes where this gets |
| 1185 | * compiled */ |
| 1186 | # define _isQUOTEMETA(c) (FITS_IN_8_BITS(c) && ! isWORDCHAR_L1(c)) |
| 1187 | # define _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) isALPHA_L1(c) |
| 1188 | |
| 1189 | /* And these aren't accurate at all. They are useful only for above |
| 1190 | * Latin1, which utilities and bootstrapping don't deal with */ |
| 1191 | # define _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c) 0 |
| 1192 | # define _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(c) 0 |
| 1193 | |
| 1194 | /* Many of the macros later in this file are defined in terms of these. By |
| 1195 | * implementing them with a function, which converts the class number into |
| 1196 | * a call to the desired macro, all of the later ones work. However, that |
| 1197 | * function won't be actually defined when building a utility program (no |
| 1198 | * perl.h), and so a compiler error will be generated if one is attempted |
| 1199 | * to be used. And the above-Latin1 code points require Unicode tables to |
| 1200 | * be present, something unlikely to be the case when bootstrapping */ |
| 1201 | # define _generic_isCC(c, classnum) \ |
| 1202 | (FITS_IN_8_BITS(c) && S_bootstrap_ctype((U8) (c), (classnum), TRUE)) |
| 1203 | # define _generic_isCC_A(c, classnum) \ |
| 1204 | (FITS_IN_8_BITS(c) && S_bootstrap_ctype((U8) (c), (classnum), FALSE)) |
| 1205 | #endif /* End of no perl.h */ |
| 1206 | |
| 1207 | #define isALPHANUMERIC(c) isALPHANUMERIC_A(c) |
| 1208 | #define isALPHA(c) isALPHA_A(c) |
| 1209 | #define isBLANK(c) isBLANK_A(c) |
| 1210 | #define isCNTRL(c) isCNTRL_A(c) |
| 1211 | #define isDIGIT(c) isDIGIT_A(c) |
| 1212 | #define isGRAPH(c) isGRAPH_A(c) |
| 1213 | #define isIDFIRST(c) isIDFIRST_A(c) |
| 1214 | #define isLOWER(c) isLOWER_A(c) |
| 1215 | #define isPRINT(c) isPRINT_A(c) |
| 1216 | #define isPSXSPC(c) isPSXSPC_A(c) |
| 1217 | #define isPUNCT(c) isPUNCT_A(c) |
| 1218 | #define isSPACE(c) isSPACE_A(c) |
| 1219 | #define isUPPER(c) isUPPER_A(c) |
| 1220 | #define isWORDCHAR(c) isWORDCHAR_A(c) |
| 1221 | #define isXDIGIT(c) isXDIGIT_A(c) |
| 1222 | |
| 1223 | /* ASCII casing. These could also be written as |
| 1224 | #define toLOWER(c) (isASCII(c) ? toLOWER_LATIN1(c) : (c)) |
| 1225 | #define toUPPER(c) (isASCII(c) ? toUPPER_LATIN1_MOD(c) : (c)) |
| 1226 | which uses table lookup and mask instead of subtraction. (This would |
| 1227 | work because the _MOD does not apply in the ASCII range) */ |
| 1228 | #define toLOWER(c) (isUPPER(c) ? (U8)((c) + ('a' - 'A')) : (c)) |
| 1229 | #define toUPPER(c) (isLOWER(c) ? (U8)((c) - ('a' - 'A')) : (c)) |
| 1230 | |
| 1231 | /* In the ASCII range, these are equivalent to what they're here defined to be. |
| 1232 | * But by creating these definitions, other code doesn't have to be aware of |
| 1233 | * this detail */ |
| 1234 | #define toFOLD(c) toLOWER(c) |
| 1235 | #define toTITLE(c) toUPPER(c) |
| 1236 | |
| 1237 | #define toLOWER_A(c) toLOWER(c) |
| 1238 | #define toUPPER_A(c) toUPPER(c) |
| 1239 | #define toFOLD_A(c) toFOLD(c) |
| 1240 | #define toTITLE_A(c) toTITLE(c) |
| 1241 | |
| 1242 | /* Use table lookup for speed; returns the input itself if is out-of-range */ |
| 1243 | #define toLOWER_LATIN1(c) ((! FITS_IN_8_BITS(c)) \ |
| 1244 | ? (c) \ |
| 1245 | : PL_latin1_lc[ (U8) (c) ]) |
| 1246 | #define toLOWER_L1(c) toLOWER_LATIN1(c) /* Synonym for consistency */ |
| 1247 | |
| 1248 | /* Modified uc. Is correct uc except for three non-ascii chars which are |
| 1249 | * all mapped to one of them, and these need special handling; returns the |
| 1250 | * input itself if is out-of-range */ |
| 1251 | #define toUPPER_LATIN1_MOD(c) ((! FITS_IN_8_BITS(c)) \ |
| 1252 | ? (c) \ |
| 1253 | : PL_mod_latin1_uc[ (U8) (c) ]) |
| 1254 | #define IN_UTF8_CTYPE_LOCALE PL_in_utf8_CTYPE_locale |
| 1255 | |
| 1256 | /* Use foo_LC_uvchr() instead of these for beyond the Latin1 range */ |
| 1257 | |
| 1258 | /* For internal core Perl use only: the base macro for defining macros like |
| 1259 | * isALPHA_LC, which uses the current LC_CTYPE locale. 'c' is the code point |
| 1260 | * (0-255) to check. In a UTF-8 locale, the result is the same as calling |
| 1261 | * isFOO_L1(); the 'utf8_locale_classnum' parameter is something like |
| 1262 | * _CC_UPPER, which gives the class number for doing this. For non-UTF-8 |
| 1263 | * locales, the code to actually do the test this is passed in 'non_utf8'. If |
| 1264 | * 'c' is above 255, 0 is returned. For accessing the full range of possible |
| 1265 | * code points under locale rules, use the macros based on _generic_LC_uvchr |
| 1266 | * instead of this. */ |
| 1267 | #define _generic_LC_base(c, utf8_locale_classnum, non_utf8) \ |
| 1268 | (! FITS_IN_8_BITS(c) \ |
| 1269 | ? 0 \ |
| 1270 | : IN_UTF8_CTYPE_LOCALE \ |
| 1271 | ? cBOOL(PL_charclass[(U8) (c)] & _CC_mask(utf8_locale_classnum)) \ |
| 1272 | : cBOOL(non_utf8)) |
| 1273 | |
| 1274 | /* For internal core Perl use only: a helper macro for defining macros like |
| 1275 | * isALPHA_LC. 'c' is the code point (0-255) to check. The function name to |
| 1276 | * actually do this test is passed in 'non_utf8_func', which is called on 'c', |
| 1277 | * casting 'c' to the macro _LC_CAST, which should not be parenthesized. See |
| 1278 | * _generic_LC_base for more info */ |
| 1279 | #define _generic_LC(c, utf8_locale_classnum, non_utf8_func) \ |
| 1280 | _generic_LC_base(c,utf8_locale_classnum, \ |
| 1281 | non_utf8_func( (_LC_CAST) (c))) |
| 1282 | |
| 1283 | /* For internal core Perl use only: like _generic_LC, but also returns TRUE if |
| 1284 | * 'c' is the platform's native underscore character */ |
| 1285 | #define _generic_LC_underscore(c,utf8_locale_classnum,non_utf8_func) \ |
| 1286 | _generic_LC_base(c, utf8_locale_classnum, \ |
| 1287 | (non_utf8_func( (_LC_CAST) (c)) \ |
| 1288 | || (char)(c) == '_')) |
| 1289 | |
| 1290 | /* These next three are also for internal core Perl use only: case-change |
| 1291 | * helper macros */ |
| 1292 | #define _generic_toLOWER_LC(c, function, cast) (! FITS_IN_8_BITS(c) \ |
| 1293 | ? (c) \ |
| 1294 | : (IN_UTF8_CTYPE_LOCALE) \ |
| 1295 | ? PL_latin1_lc[ (U8) (c) ] \ |
| 1296 | : function((cast)(c))) |
| 1297 | |
| 1298 | /* Note that the result can be larger than a byte in a UTF-8 locale. It |
| 1299 | * returns a single value, so can't adequately return the upper case of LATIN |
| 1300 | * SMALL LETTER SHARP S in a UTF-8 locale (which should be a string of two |
| 1301 | * values "SS"); instead it asserts against that under DEBUGGING, and |
| 1302 | * otherwise returns its input */ |
| 1303 | #define _generic_toUPPER_LC(c, function, cast) \ |
| 1304 | (! FITS_IN_8_BITS(c) \ |
| 1305 | ? (c) \ |
| 1306 | : ((! IN_UTF8_CTYPE_LOCALE) \ |
| 1307 | ? function((cast)(c)) \ |
| 1308 | : ((((U8)(c)) == MICRO_SIGN) \ |
| 1309 | ? GREEK_CAPITAL_LETTER_MU \ |
| 1310 | : ((((U8)(c)) == LATIN_SMALL_LETTER_Y_WITH_DIAERESIS) \ |
| 1311 | ? LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS \ |
| 1312 | : ((((U8)(c)) == LATIN_SMALL_LETTER_SHARP_S) \ |
| 1313 | ? (__ASSERT_(0) (c)) \ |
| 1314 | : PL_mod_latin1_uc[ (U8) (c) ]))))) |
| 1315 | |
| 1316 | /* Note that the result can be larger than a byte in a UTF-8 locale. It |
| 1317 | * returns a single value, so can't adequately return the fold case of LATIN |
| 1318 | * SMALL LETTER SHARP S in a UTF-8 locale (which should be a string of two |
| 1319 | * values "ss"); instead it asserts against that under DEBUGGING, and |
| 1320 | * otherwise returns its input */ |
| 1321 | #define _generic_toFOLD_LC(c, function, cast) \ |
| 1322 | ((UNLIKELY((c) == MICRO_SIGN) && IN_UTF8_CTYPE_LOCALE) \ |
| 1323 | ? GREEK_SMALL_LETTER_MU \ |
| 1324 | : (__ASSERT_(! IN_UTF8_CTYPE_LOCALE \ |
| 1325 | || (c) != LATIN_SMALL_LETTER_SHARP_S) \ |
| 1326 | _generic_toLOWER_LC(c, function, cast))) |
| 1327 | |
| 1328 | /* Use the libc versions for these if available. */ |
| 1329 | #if defined(HAS_ISASCII) |
| 1330 | # define isASCII_LC(c) (FITS_IN_8_BITS(c) && isascii( (U8) (c))) |
| 1331 | #else |
| 1332 | # define isASCII_LC(c) isASCII(c) |
| 1333 | #endif |
| 1334 | |
| 1335 | #if defined(HAS_ISBLANK) |
| 1336 | # define isBLANK_LC(c) _generic_LC(c, _CC_BLANK, isblank) |
| 1337 | #else /* Unlike isASCII, varies if in a UTF-8 locale */ |
| 1338 | # define isBLANK_LC(c) (IN_UTF8_CTYPE_LOCALE) ? isBLANK_L1(c) : isBLANK(c) |
| 1339 | #endif |
| 1340 | |
| 1341 | #define _LC_CAST U8 |
| 1342 | |
| 1343 | #ifdef WIN32 |
| 1344 | /* The Windows functions don't bother to follow the POSIX standard, which |
| 1345 | * for example says that something can't both be a printable and a control. |
| 1346 | * But Windows treats the \t control as a printable, and does such things |
| 1347 | * as making superscripts into both digits and punctuation. This tames |
| 1348 | * these flaws by assuming that the definitions of both controls and space |
| 1349 | * are correct, and then making sure that other definitions don't have |
| 1350 | * weirdnesses, by making sure that isalnum() isn't also ispunct(), etc. |
| 1351 | * Not all possible weirdnesses are checked for, just the ones that were |
| 1352 | * detected on actual Microsoft code pages */ |
| 1353 | |
| 1354 | # define isCNTRL_LC(c) _generic_LC(c, _CC_CNTRL, iscntrl) |
| 1355 | # define isSPACE_LC(c) _generic_LC(c, _CC_SPACE, isspace) |
| 1356 | |
| 1357 | # define isALPHA_LC(c) (_generic_LC(c, _CC_ALPHA, isalpha) && isALPHANUMERIC_LC(c)) |
| 1358 | # define isALPHANUMERIC_LC(c) (_generic_LC(c, _CC_ALPHANUMERIC, isalnum) && ! isPUNCT_LC(c)) |
| 1359 | # define isDIGIT_LC(c) (_generic_LC(c, _CC_DIGIT, isdigit) && isALPHANUMERIC_LC(c)) |
| 1360 | # define isGRAPH_LC(c) (_generic_LC(c, _CC_GRAPH, isgraph) && isPRINT_LC(c)) |
| 1361 | # define isIDFIRST_LC(c) (((c) == '_') || (_generic_LC(c, _CC_IDFIRST, isalpha) && ! isPUNCT_LC(c))) |
| 1362 | # define isLOWER_LC(c) (_generic_LC(c, _CC_LOWER, islower) && isALPHA_LC(c)) |
| 1363 | # define isPRINT_LC(c) (_generic_LC(c, _CC_PRINT, isprint) && ! isCNTRL_LC(c)) |
| 1364 | # define isPUNCT_LC(c) (_generic_LC(c, _CC_PUNCT, ispunct) && ! isCNTRL_LC(c)) |
| 1365 | # define isUPPER_LC(c) (_generic_LC(c, _CC_UPPER, isupper) && isALPHA_LC(c)) |
| 1366 | # define isWORDCHAR_LC(c) (((c) == '_') || isALPHANUMERIC_LC(c)) |
| 1367 | # define isXDIGIT_LC(c) (_generic_LC(c, _CC_XDIGIT, isxdigit) && isALPHANUMERIC_LC(c)) |
| 1368 | |
| 1369 | # define toLOWER_LC(c) _generic_toLOWER_LC((c), tolower, U8) |
| 1370 | # define toUPPER_LC(c) _generic_toUPPER_LC((c), toupper, U8) |
| 1371 | # define toFOLD_LC(c) _generic_toFOLD_LC((c), tolower, U8) |
| 1372 | |
| 1373 | #elif defined(CTYPE256) || (!defined(isascii) && !defined(HAS_ISASCII)) |
| 1374 | /* For most other platforms */ |
| 1375 | |
| 1376 | # define isALPHA_LC(c) _generic_LC(c, _CC_ALPHA, isalpha) |
| 1377 | # define isALPHANUMERIC_LC(c) _generic_LC(c, _CC_ALPHANUMERIC, isalnum) |
| 1378 | # define isCNTRL_LC(c) _generic_LC(c, _CC_CNTRL, iscntrl) |
| 1379 | # define isDIGIT_LC(c) _generic_LC(c, _CC_DIGIT, isdigit) |
| 1380 | # define isGRAPH_LC(c) _generic_LC(c, _CC_GRAPH, isgraph) |
| 1381 | # define isIDFIRST_LC(c) _generic_LC_underscore(c, _CC_IDFIRST, isalpha) |
| 1382 | # define isLOWER_LC(c) _generic_LC(c, _CC_LOWER, islower) |
| 1383 | # define isPRINT_LC(c) _generic_LC(c, _CC_PRINT, isprint) |
| 1384 | # define isPUNCT_LC(c) _generic_LC(c, _CC_PUNCT, ispunct) |
| 1385 | # define isSPACE_LC(c) _generic_LC(c, _CC_SPACE, isspace) |
| 1386 | # define isUPPER_LC(c) _generic_LC(c, _CC_UPPER, isupper) |
| 1387 | # define isWORDCHAR_LC(c) _generic_LC_underscore(c, _CC_WORDCHAR, isalnum) |
| 1388 | # define isXDIGIT_LC(c) _generic_LC(c, _CC_XDIGIT, isxdigit) |
| 1389 | |
| 1390 | |
| 1391 | # define toLOWER_LC(c) _generic_toLOWER_LC((c), tolower, U8) |
| 1392 | # define toUPPER_LC(c) _generic_toUPPER_LC((c), toupper, U8) |
| 1393 | # define toFOLD_LC(c) _generic_toFOLD_LC((c), tolower, U8) |
| 1394 | |
| 1395 | #else /* The final fallback position */ |
| 1396 | |
| 1397 | # define isALPHA_LC(c) (isascii(c) && isalpha(c)) |
| 1398 | # define isALPHANUMERIC_LC(c) (isascii(c) && isalnum(c)) |
| 1399 | # define isCNTRL_LC(c) (isascii(c) && iscntrl(c)) |
| 1400 | # define isDIGIT_LC(c) (isascii(c) && isdigit(c)) |
| 1401 | # define isGRAPH_LC(c) (isascii(c) && isgraph(c)) |
| 1402 | # define isIDFIRST_LC(c) (isascii(c) && (isalpha(c) || (c) == '_')) |
| 1403 | # define isLOWER_LC(c) (isascii(c) && islower(c)) |
| 1404 | # define isPRINT_LC(c) (isascii(c) && isprint(c)) |
| 1405 | # define isPUNCT_LC(c) (isascii(c) && ispunct(c)) |
| 1406 | # define isSPACE_LC(c) (isascii(c) && isspace(c)) |
| 1407 | # define isUPPER_LC(c) (isascii(c) && isupper(c)) |
| 1408 | # define isWORDCHAR_LC(c) (isascii(c) && (isalnum(c) || (c) == '_')) |
| 1409 | # define isXDIGIT_LC(c) (isascii(c) && isxdigit(c)) |
| 1410 | |
| 1411 | # define toLOWER_LC(c) (isascii(c) ? tolower(c) : (c)) |
| 1412 | # define toUPPER_LC(c) (isascii(c) ? toupper(c) : (c)) |
| 1413 | # define toFOLD_LC(c) (isascii(c) ? tolower(c) : (c)) |
| 1414 | |
| 1415 | #endif |
| 1416 | |
| 1417 | #define isIDCONT(c) isWORDCHAR(c) |
| 1418 | #define isIDCONT_A(c) isWORDCHAR_A(c) |
| 1419 | #define isIDCONT_L1(c) isWORDCHAR_L1(c) |
| 1420 | #define isIDCONT_LC(c) isWORDCHAR_LC(c) |
| 1421 | #define isPSXSPC_LC(c) isSPACE_LC(c) |
| 1422 | |
| 1423 | /* For internal core Perl use only: the base macros for defining macros like |
| 1424 | * isALPHA_uni. 'c' is the code point to check. 'classnum' is the POSIX class |
| 1425 | * number defined earlier in this file. _generic_uni() is used for POSIX |
| 1426 | * classes where there is a macro or function 'above_latin1' that takes the |
| 1427 | * single argument 'c' and returns the desired value. These exist for those |
| 1428 | * classes which have simple definitions, avoiding the overhead of a hash |
| 1429 | * lookup or inversion list binary search. _generic_swash_uni() can be used |
| 1430 | * for classes where that overhead is faster than a direct lookup. |
| 1431 | * _generic_uni() won't compile if 'c' isn't unsigned, as it won't match the |
| 1432 | * 'above_latin1' prototype. _generic_isCC() macro does bounds checking, so |
| 1433 | * have duplicate checks here, so could create versions of the macros that |
| 1434 | * don't, but experiments show that gcc optimizes them out anyway. */ |
| 1435 | |
| 1436 | /* Note that all ignore 'use bytes' */ |
| 1437 | #define _generic_uni(classnum, above_latin1, c) ((c) < 256 \ |
| 1438 | ? _generic_isCC(c, classnum) \ |
| 1439 | : above_latin1(c)) |
| 1440 | #define _generic_swash_uni(classnum, c) ((c) < 256 \ |
| 1441 | ? _generic_isCC(c, classnum) \ |
| 1442 | : _is_uni_FOO(classnum, c)) |
| 1443 | #define isALPHA_uni(c) _generic_swash_uni(_CC_ALPHA, c) |
| 1444 | #define isALPHANUMERIC_uni(c) _generic_swash_uni(_CC_ALPHANUMERIC, c) |
| 1445 | #define isASCII_uni(c) isASCII(c) |
| 1446 | #define isBLANK_uni(c) _generic_uni(_CC_BLANK, is_HORIZWS_cp_high, c) |
| 1447 | #define isCNTRL_uni(c) isCNTRL_L1(c) /* All controls are in Latin1 */ |
| 1448 | #define isDIGIT_uni(c) _generic_swash_uni(_CC_DIGIT, c) |
| 1449 | #define isGRAPH_uni(c) _generic_swash_uni(_CC_GRAPH, c) |
| 1450 | #define isIDCONT_uni(c) _generic_uni(_CC_WORDCHAR, _is_uni_perl_idcont, c) |
| 1451 | #define isIDFIRST_uni(c) _generic_uni(_CC_IDFIRST, _is_uni_perl_idstart, c) |
| 1452 | #define isLOWER_uni(c) _generic_swash_uni(_CC_LOWER, c) |
| 1453 | #define isPRINT_uni(c) _generic_swash_uni(_CC_PRINT, c) |
| 1454 | |
| 1455 | /* Posix and regular space are identical above Latin1 */ |
| 1456 | #define isPSXSPC_uni(c) _generic_uni(_CC_PSXSPC, is_XPERLSPACE_cp_high, c) |
| 1457 | |
| 1458 | #define isPUNCT_uni(c) _generic_swash_uni(_CC_PUNCT, c) |
| 1459 | #define isSPACE_uni(c) _generic_uni(_CC_SPACE, is_XPERLSPACE_cp_high, c) |
| 1460 | #define isUPPER_uni(c) _generic_swash_uni(_CC_UPPER, c) |
| 1461 | #define isVERTWS_uni(c) _generic_uni(_CC_VERTSPACE, is_VERTWS_cp_high, c) |
| 1462 | #define isWORDCHAR_uni(c) _generic_swash_uni(_CC_WORDCHAR, c) |
| 1463 | #define isXDIGIT_uni(c) _generic_uni(_CC_XDIGIT, is_XDIGIT_cp_high, c) |
| 1464 | |
| 1465 | #define toFOLD_uni(c,s,l) to_uni_fold(c,s,l) |
| 1466 | #define toLOWER_uni(c,s,l) to_uni_lower(c,s,l) |
| 1467 | #define toTITLE_uni(c,s,l) to_uni_title(c,s,l) |
| 1468 | #define toUPPER_uni(c,s,l) to_uni_upper(c,s,l) |
| 1469 | |
| 1470 | /* For internal core Perl use only: the base macros for defining macros like |
| 1471 | * isALPHA_LC_uvchr. These are like isALPHA_LC, but the input can be any code |
| 1472 | * point, not just 0-255. Like _generic_uni, there are two versions, one for |
| 1473 | * simple class definitions; the other for more complex. These are like |
| 1474 | * _generic_uni, so see it for more info. */ |
| 1475 | #define _generic_LC_uvchr(latin1, above_latin1, c) \ |
| 1476 | (c < 256 ? latin1(c) : above_latin1(c)) |
| 1477 | #define _generic_LC_swash_uvchr(latin1, classnum, c) \ |
| 1478 | (c < 256 ? latin1(c) : _is_uni_FOO(classnum, c)) |
| 1479 | |
| 1480 | #define isALPHA_LC_uvchr(c) _generic_LC_swash_uvchr(isALPHA_LC, _CC_ALPHA, c) |
| 1481 | #define isALPHANUMERIC_LC_uvchr(c) _generic_LC_swash_uvchr(isALPHANUMERIC_LC, \ |
| 1482 | _CC_ALPHANUMERIC, c) |
| 1483 | #define isASCII_LC_uvchr(c) isASCII_LC(c) |
| 1484 | #define isBLANK_LC_uvchr(c) _generic_LC_uvchr(isBLANK_LC, is_HORIZWS_cp_high, c) |
| 1485 | #define isCNTRL_LC_uvchr(c) (c < 256 ? isCNTRL_LC(c) : 0) |
| 1486 | #define isDIGIT_LC_uvchr(c) _generic_LC_swash_uvchr(isDIGIT_LC, _CC_DIGIT, c) |
| 1487 | #define isGRAPH_LC_uvchr(c) _generic_LC_swash_uvchr(isGRAPH_LC, _CC_GRAPH, c) |
| 1488 | #define isIDCONT_LC_uvchr(c) _generic_LC_uvchr(isIDCONT_LC, \ |
| 1489 | _is_uni_perl_idcont, c) |
| 1490 | #define isIDFIRST_LC_uvchr(c) _generic_LC_uvchr(isIDFIRST_LC, \ |
| 1491 | _is_uni_perl_idstart, c) |
| 1492 | #define isLOWER_LC_uvchr(c) _generic_LC_swash_uvchr(isLOWER_LC, _CC_LOWER, c) |
| 1493 | #define isPRINT_LC_uvchr(c) _generic_LC_swash_uvchr(isPRINT_LC, _CC_PRINT, c) |
| 1494 | #define isPSXSPC_LC_uvchr(c) isSPACE_LC_uvchr(c) /* space is identical to posix |
| 1495 | space under locale */ |
| 1496 | #define isPUNCT_LC_uvchr(c) _generic_LC_swash_uvchr(isPUNCT_LC, _CC_PUNCT, c) |
| 1497 | #define isSPACE_LC_uvchr(c) _generic_LC_uvchr(isSPACE_LC, \ |
| 1498 | is_XPERLSPACE_cp_high, c) |
| 1499 | #define isUPPER_LC_uvchr(c) _generic_LC_swash_uvchr(isUPPER_LC, _CC_UPPER, c) |
| 1500 | #define isWORDCHAR_LC_uvchr(c) _generic_LC_swash_uvchr(isWORDCHAR_LC, \ |
| 1501 | _CC_WORDCHAR, c) |
| 1502 | #define isXDIGIT_LC_uvchr(c) _generic_LC_uvchr(isXDIGIT_LC, is_XDIGIT_cp_high, c) |
| 1503 | |
| 1504 | #define isBLANK_LC_uni(c) isBLANK_LC_uvchr(UNI_TO_NATIVE(c)) |
| 1505 | |
| 1506 | /* For internal core Perl use only: the base macros for defining macros like |
| 1507 | * isALPHA_utf8. These are like the earlier defined macros, but take an input |
| 1508 | * UTF-8 encoded string 'p'. If the input is in the Latin1 range, use |
| 1509 | * the Latin1 macro 'classnum' on 'p'. Otherwise use the value given by the |
| 1510 | * 'utf8' parameter. This relies on the fact that ASCII characters have the |
| 1511 | * same representation whether utf8 or not. Note that it assumes that the utf8 |
| 1512 | * has been validated, and ignores 'use bytes' */ |
| 1513 | #define _generic_utf8(classnum, p, utf8) (UTF8_IS_INVARIANT(*(p)) \ |
| 1514 | ? _generic_isCC(*(p), classnum) \ |
| 1515 | : (UTF8_IS_DOWNGRADEABLE_START(*(p))) \ |
| 1516 | ? _generic_isCC( \ |
| 1517 | TWO_BYTE_UTF8_TO_NATIVE(*(p), \ |
| 1518 | *((p)+1 )), \ |
| 1519 | classnum) \ |
| 1520 | : utf8) |
| 1521 | /* Like the above, but calls 'above_latin1(p)' to get the utf8 value. 'above_latin1' |
| 1522 | * can be a macro */ |
| 1523 | #define _generic_func_utf8(classnum, above_latin1, p) \ |
| 1524 | _generic_utf8(classnum, p, above_latin1(p)) |
| 1525 | /* Like the above, but passes classnum to _isFOO_utf8(), instead of having an |
| 1526 | * 'above_latin1' parameter */ |
| 1527 | #define _generic_swash_utf8(classnum, p) \ |
| 1528 | _generic_utf8(classnum, p, _is_utf8_FOO(classnum, p)) |
| 1529 | |
| 1530 | /* Like the above, but should be used only when it is known that there are no |
| 1531 | * characters in the upper-Latin1 range (128-255 on ASCII platforms) which the |
| 1532 | * class is TRUE for. Hence it can skip the tests for this range. |
| 1533 | * 'above_latin1' should include its arguments */ |
| 1534 | #define _generic_utf8_no_upper_latin1(classnum, p, above_latin1) \ |
| 1535 | (UTF8_IS_INVARIANT(*(p)) \ |
| 1536 | ? _generic_isCC(*(p), classnum) \ |
| 1537 | : (UTF8_IS_ABOVE_LATIN1(*(p))) \ |
| 1538 | ? above_latin1 \ |
| 1539 | : 0) |
| 1540 | |
| 1541 | /* NOTE that some of these macros have very similar ones in regcharclass.h. |
| 1542 | * For example, there is (at the time of this writing) an 'is_SPACE_utf8()' |
| 1543 | * there, differing in name only by an underscore from the one here |
| 1544 | * 'isSPACE_utf8(). The difference is that the ones here are probably more |
| 1545 | * efficient and smaller, using an O(1) array lookup for Latin1-range code |
| 1546 | * points; the regcharclass.h ones are implemented as a series of |
| 1547 | * "if-else-if-else ..." */ |
| 1548 | |
| 1549 | #define isALPHA_utf8(p) _generic_swash_utf8(_CC_ALPHA, p) |
| 1550 | #define isALPHANUMERIC_utf8(p) _generic_swash_utf8(_CC_ALPHANUMERIC, p) |
| 1551 | #define isASCII_utf8(p) isASCII(*p) /* Because ASCII is invariant under |
| 1552 | utf8, the non-utf8 macro works |
| 1553 | */ |
| 1554 | #define isBLANK_utf8(p) _generic_func_utf8(_CC_BLANK, is_HORIZWS_high, p) |
| 1555 | |
| 1556 | #ifdef EBCDIC |
| 1557 | /* Because all controls are UTF-8 invariants in EBCDIC, we can use this |
| 1558 | * more efficient macro instead of the more general one */ |
| 1559 | # define isCNTRL_utf8(p) isCNTRL_L1(p) |
| 1560 | #else |
| 1561 | # define isCNTRL_utf8(p) _generic_utf8(_CC_CNTRL, p, 0) |
| 1562 | #endif |
| 1563 | |
| 1564 | #define isDIGIT_utf8(p) _generic_utf8_no_upper_latin1(_CC_DIGIT, p, \ |
| 1565 | _is_utf8_FOO(_CC_DIGIT, p)) |
| 1566 | #define isGRAPH_utf8(p) _generic_swash_utf8(_CC_GRAPH, p) |
| 1567 | #define isIDCONT_utf8(p) _generic_func_utf8(_CC_WORDCHAR, \ |
| 1568 | _is_utf8_perl_idcont, p) |
| 1569 | |
| 1570 | /* To prevent S_scan_word in toke.c from hanging, we have to make sure that |
| 1571 | * IDFIRST is an alnum. See |
| 1572 | * http://rt.perl.org/rt3/Ticket/Display.html?id=74022 for more detail than you |
| 1573 | * ever wanted to know about. (In the ASCII range, there isn't a difference.) |
| 1574 | * This used to be not the XID version, but we decided to go with the more |
| 1575 | * modern Unicode definition */ |
| 1576 | #define isIDFIRST_utf8(p) _generic_func_utf8(_CC_IDFIRST, \ |
| 1577 | _is_utf8_perl_idstart, p) |
| 1578 | |
| 1579 | #define isLOWER_utf8(p) _generic_swash_utf8(_CC_LOWER, p) |
| 1580 | #define isPRINT_utf8(p) _generic_swash_utf8(_CC_PRINT, p) |
| 1581 | |
| 1582 | /* Posix and regular space are identical above Latin1 */ |
| 1583 | #define isPSXSPC_utf8(p) _generic_func_utf8(_CC_PSXSPC, is_XPERLSPACE_high, p) |
| 1584 | |
| 1585 | #define isPUNCT_utf8(p) _generic_swash_utf8(_CC_PUNCT, p) |
| 1586 | #define isSPACE_utf8(p) _generic_func_utf8(_CC_SPACE, is_XPERLSPACE_high, p) |
| 1587 | #define isUPPER_utf8(p) _generic_swash_utf8(_CC_UPPER, p) |
| 1588 | #define isVERTWS_utf8(p) _generic_func_utf8(_CC_VERTSPACE, is_VERTWS_high, p) |
| 1589 | #define isWORDCHAR_utf8(p) _generic_swash_utf8(_CC_WORDCHAR, p) |
| 1590 | #define isXDIGIT_utf8(p) _generic_utf8_no_upper_latin1(_CC_XDIGIT, p, \ |
| 1591 | is_XDIGIT_high(p)) |
| 1592 | |
| 1593 | #define toFOLD_utf8(p,s,l) to_utf8_fold(p,s,l) |
| 1594 | #define toLOWER_utf8(p,s,l) to_utf8_lower(p,s,l) |
| 1595 | #define toTITLE_utf8(p,s,l) to_utf8_title(p,s,l) |
| 1596 | #define toUPPER_utf8(p,s,l) to_utf8_upper(p,s,l) |
| 1597 | |
| 1598 | /* For internal core Perl use only: the base macros for defining macros like |
| 1599 | * isALPHA_LC_utf8. These are like _generic_utf8, but if the first code point |
| 1600 | * in 'p' is within the 0-255 range, it uses locale rules from the passed-in |
| 1601 | * 'macro' parameter */ |
| 1602 | #define _generic_LC_utf8(macro, p, utf8) \ |
| 1603 | (UTF8_IS_INVARIANT(*(p)) \ |
| 1604 | ? macro(*(p)) \ |
| 1605 | : (UTF8_IS_DOWNGRADEABLE_START(*(p))) \ |
| 1606 | ? macro(TWO_BYTE_UTF8_TO_NATIVE(*(p), *((p)+1))) \ |
| 1607 | : utf8) |
| 1608 | |
| 1609 | #define _generic_LC_swash_utf8(macro, classnum, p) \ |
| 1610 | _generic_LC_utf8(macro, p, _is_utf8_FOO(classnum, p)) |
| 1611 | #define _generic_LC_func_utf8(macro, above_latin1, p) \ |
| 1612 | _generic_LC_utf8(macro, p, above_latin1(p)) |
| 1613 | |
| 1614 | #define isALPHANUMERIC_LC_utf8(p) _generic_LC_swash_utf8(isALPHANUMERIC_LC, \ |
| 1615 | _CC_ALPHANUMERIC, p) |
| 1616 | #define isALPHA_LC_utf8(p) _generic_LC_swash_utf8(isALPHA_LC, _CC_ALPHA, p) |
| 1617 | #define isASCII_LC_utf8(p) isASCII_LC(*p) |
| 1618 | #define isBLANK_LC_utf8(p) _generic_LC_func_utf8(isBLANK_LC, is_HORIZWS_high, p) |
| 1619 | #define isCNTRL_LC_utf8(p) _generic_LC_utf8(isCNTRL_LC, p, 0) |
| 1620 | #define isDIGIT_LC_utf8(p) _generic_LC_swash_utf8(isDIGIT_LC, _CC_DIGIT, p) |
| 1621 | #define isGRAPH_LC_utf8(p) _generic_LC_swash_utf8(isGRAPH_LC, _CC_GRAPH, p) |
| 1622 | #define isIDCONT_LC_utf8(p) _generic_LC_func_utf8(isIDCONT_LC, _is_utf8_perl_idcont, p) |
| 1623 | #define isIDFIRST_LC_utf8(p) _generic_LC_func_utf8(isIDFIRST_LC, _is_utf8_perl_idstart, p) |
| 1624 | #define isLOWER_LC_utf8(p) _generic_LC_swash_utf8(isLOWER_LC, _CC_LOWER, p) |
| 1625 | #define isPRINT_LC_utf8(p) _generic_LC_swash_utf8(isPRINT_LC, _CC_PRINT, p) |
| 1626 | #define isPSXSPC_LC_utf8(p) isSPACE_LC_utf8(p) /* space is identical to posix |
| 1627 | space under locale */ |
| 1628 | #define isPUNCT_LC_utf8(p) _generic_LC_swash_utf8(isPUNCT_LC, _CC_PUNCT, p) |
| 1629 | #define isSPACE_LC_utf8(p) _generic_LC_func_utf8(isSPACE_LC, is_XPERLSPACE_high, p) |
| 1630 | #define isUPPER_LC_utf8(p) _generic_LC_swash_utf8(isUPPER_LC, _CC_UPPER, p) |
| 1631 | #define isWORDCHAR_LC_utf8(p) _generic_LC_swash_utf8(isWORDCHAR_LC, \ |
| 1632 | _CC_WORDCHAR, p) |
| 1633 | #define isXDIGIT_LC_utf8(p) _generic_LC_func_utf8(isXDIGIT_LC, is_XDIGIT_high, p) |
| 1634 | |
| 1635 | /* Macros for backwards compatibility and for completeness when the ASCII and |
| 1636 | * Latin1 values are identical */ |
| 1637 | #define isALPHAU(c) isALPHA_L1(c) |
| 1638 | #define isDIGIT_L1(c) isDIGIT_A(c) |
| 1639 | #define isOCTAL(c) isOCTAL_A(c) |
| 1640 | #define isOCTAL_L1(c) isOCTAL_A(c) |
| 1641 | #define isXDIGIT_L1(c) isXDIGIT_A(c) |
| 1642 | #define isALNUM(c) isWORDCHAR(c) |
| 1643 | #define isALNUMU(c) isWORDCHAR_L1(c) |
| 1644 | #define isALNUM_LC(c) isWORDCHAR_LC(c) |
| 1645 | #define isALNUM_uni(c) isWORDCHAR_uni(c) |
| 1646 | #define isALNUM_LC_uvchr(c) isWORDCHAR_LC_uvchr(c) |
| 1647 | #define isALNUM_utf8(p) isWORDCHAR_utf8(p) |
| 1648 | #define isALNUM_LC_utf8(p) isWORDCHAR_LC_utf8(p) |
| 1649 | #define isALNUMC_A(c) isALPHANUMERIC_A(c) /* Mnemonic: "C's alnum" */ |
| 1650 | #define isALNUMC_L1(c) isALPHANUMERIC_L1(c) |
| 1651 | #define isALNUMC(c) isALPHANUMERIC(c) |
| 1652 | #define isALNUMC_LC(c) isALPHANUMERIC_LC(c) |
| 1653 | #define isALNUMC_uni(c) isALPHANUMERIC_uni(c) |
| 1654 | #define isALNUMC_LC_uvchr(c) isALPHANUMERIC_LC_uvchr(c) |
| 1655 | #define isALNUMC_utf8(p) isALPHANUMERIC_utf8(p) |
| 1656 | #define isALNUMC_LC_utf8(p) isALPHANUMERIC_LC_utf8(p) |
| 1657 | |
| 1658 | /* On EBCDIC platforms, CTRL-@ is 0, CTRL-A is 1, etc, just like on ASCII, |
| 1659 | * except that they don't necessarily mean the same characters, e.g. CTRL-D is |
| 1660 | * 4 on both systems, but that is EOT on ASCII; ST on EBCDIC. |
| 1661 | * '?' is special-cased on EBCDIC to APC, which is the control there that is |
| 1662 | * the outlier from the block that contains the other controls, just like |
| 1663 | * toCTRL('?') on ASCII yields DEL, the control that is the outlier from the C0 |
| 1664 | * block. If it weren't special cased, it would yield a non-control. |
| 1665 | * The conversion works both ways, so CTRL('D') is 4, and CTRL(4) is D, etc. */ |
| 1666 | #ifndef EBCDIC |
| 1667 | # define toCTRL(c) (toUPPER(c) ^ 64) |
| 1668 | #else |
| 1669 | # define toCTRL(c) ((isPRINT_A(c)) \ |
| 1670 | ? UNLIKELY((c) == '?') \ |
| 1671 | ? QUESTION_MARK_CTRL \ |
| 1672 | : (NATIVE_TO_LATIN1(toUPPER(c)) ^ 64) \ |
| 1673 | : UNLIKELY((c) == QUESTION_MARK_CTRL) \ |
| 1674 | ? ((c) == '?') \ |
| 1675 | : (LATIN1_TO_NATIVE((c) ^ 64))) |
| 1676 | #endif |
| 1677 | |
| 1678 | /* Line numbers are unsigned, 32 bits. */ |
| 1679 | typedef U32 line_t; |
| 1680 | #define NOLINE ((line_t) 4294967295UL) /* = FFFFFFFF */ |
| 1681 | |
| 1682 | /* Helpful alias for version prescan */ |
| 1683 | #define is_LAX_VERSION(a,b) \ |
| 1684 | (a != Perl_prescan_version(aTHX_ a, FALSE, b, NULL, NULL, NULL, NULL)) |
| 1685 | |
| 1686 | #define is_STRICT_VERSION(a,b) \ |
| 1687 | (a != Perl_prescan_version(aTHX_ a, TRUE, b, NULL, NULL, NULL, NULL)) |
| 1688 | |
| 1689 | #define BADVERSION(a,b,c) \ |
| 1690 | if (b) { \ |
| 1691 | *b = c; \ |
| 1692 | } \ |
| 1693 | return a; |
| 1694 | |
| 1695 | /* Converts a character known to represent a hexadecimal digit (0-9, A-F, or |
| 1696 | * a-f) to its numeric value. READ_XDIGIT's argument is a string pointer, |
| 1697 | * which is advanced. The input is validated only by an assert() in DEBUGGING |
| 1698 | * builds. In both ASCII and EBCDIC the last 4 bits of the digits are 0-9; and |
| 1699 | * the last 4 bits of A-F and a-f are 1-6, so adding 9 yields 10-15 */ |
| 1700 | #define XDIGIT_VALUE(c) (__ASSERT_(isXDIGIT(c)) (0xf & (isDIGIT(c) \ |
| 1701 | ? (c) \ |
| 1702 | : ((c) + 9)))) |
| 1703 | #define READ_XDIGIT(s) (__ASSERT_(isXDIGIT(*s)) (0xf & (isDIGIT(*(s)) \ |
| 1704 | ? (*(s)++) \ |
| 1705 | : (*(s)++ + 9)))) |
| 1706 | |
| 1707 | /* Converts a character known to represent an octal digit (0-7) to its numeric |
| 1708 | * value. The input is validated only by an assert() in DEBUGGING builds. In |
| 1709 | * both ASCII and EBCDIC the last 3 bits of the octal digits range from 0-7. */ |
| 1710 | #define OCTAL_VALUE(c) (__ASSERT_(isOCTAL(c)) (7 & (c))) |
| 1711 | |
| 1712 | /* Efficiently returns a boolean as to if two native characters are equivalent |
| 1713 | * case-insenstively. At least one of the characters must be one of [A-Za-z]; |
| 1714 | * the ALPHA in the name is to remind you of that. This is asserted() in |
| 1715 | * DEBUGGING builds. Because [A-Za-z] are invariant under UTF-8, this macro |
| 1716 | * works (on valid input) for both non- and UTF-8-encoded bytes. |
| 1717 | * |
| 1718 | * When one of the inputs is a compile-time constant and gets folded by the |
| 1719 | * compiler, this reduces to an AND and a TEST. On both EBCDIC and ASCII |
| 1720 | * machines, 'A' and 'a' differ by a single bit; the same with the upper and |
| 1721 | * lower case of all other ASCII-range alphabetics. On ASCII platforms, they |
| 1722 | * are 32 apart; on EBCDIC, they are 64. At compile time, this uses an |
| 1723 | * exclusive 'or' to find that bit and then inverts it to form a mask, with |
| 1724 | * just a single 0, in the bit position where the upper- and lowercase differ. |
| 1725 | * */ |
| 1726 | #define isALPHA_FOLD_EQ(c1, c2) \ |
| 1727 | (__ASSERT_(isALPHA_A(c1) || isALPHA_A(c2)) \ |
| 1728 | ((c1) & ~('A' ^ 'a')) == ((c2) & ~('A' ^ 'a'))) |
| 1729 | #define isALPHA_FOLD_NE(c1, c2) (! isALPHA_FOLD_EQ((c1), (c2))) |
| 1730 | |
| 1731 | /* |
| 1732 | =head1 Memory Management |
| 1733 | |
| 1734 | =for apidoc Am|void|Newx|void* ptr|int nitems|type |
| 1735 | The XSUB-writer's interface to the C C<malloc> function. |
| 1736 | |
| 1737 | Memory obtained by this should B<ONLY> be freed with L<"Safefree">. |
| 1738 | |
| 1739 | In 5.9.3, Newx() and friends replace the older New() API, and drops |
| 1740 | the first parameter, I<x>, a debug aid which allowed callers to identify |
| 1741 | themselves. This aid has been superseded by a new build option, |
| 1742 | PERL_MEM_LOG (see L<perlhacktips/PERL_MEM_LOG>). The older API is still |
| 1743 | there for use in XS modules supporting older perls. |
| 1744 | |
| 1745 | =for apidoc Am|void|Newxc|void* ptr|int nitems|type|cast |
| 1746 | The XSUB-writer's interface to the C C<malloc> function, with |
| 1747 | cast. See also C<Newx>. |
| 1748 | |
| 1749 | Memory obtained by this should B<ONLY> be freed with L<"Safefree">. |
| 1750 | |
| 1751 | =for apidoc Am|void|Newxz|void* ptr|int nitems|type |
| 1752 | The XSUB-writer's interface to the C C<malloc> function. The allocated |
| 1753 | memory is zeroed with C<memzero>. See also C<Newx>. |
| 1754 | |
| 1755 | Memory obtained by this should B<ONLY> be freed with L<"Safefree">. |
| 1756 | |
| 1757 | =for apidoc Am|void|Renew|void* ptr|int nitems|type |
| 1758 | The XSUB-writer's interface to the C C<realloc> function. |
| 1759 | |
| 1760 | Memory obtained by this should B<ONLY> be freed with L<"Safefree">. |
| 1761 | |
| 1762 | =for apidoc Am|void|Renewc|void* ptr|int nitems|type|cast |
| 1763 | The XSUB-writer's interface to the C C<realloc> function, with |
| 1764 | cast. |
| 1765 | |
| 1766 | Memory obtained by this should B<ONLY> be freed with L<"Safefree">. |
| 1767 | |
| 1768 | =for apidoc Am|void|Safefree|void* ptr |
| 1769 | The XSUB-writer's interface to the C C<free> function. |
| 1770 | |
| 1771 | This should B<ONLY> be used on memory obtained using L<"Newx"> and friends. |
| 1772 | |
| 1773 | =for apidoc Am|void|Move|void* src|void* dest|int nitems|type |
| 1774 | The XSUB-writer's interface to the C C<memmove> function. The C<src> is the |
| 1775 | source, C<dest> is the destination, C<nitems> is the number of items, and |
| 1776 | C<type> is the type. Can do overlapping moves. See also C<Copy>. |
| 1777 | |
| 1778 | =for apidoc Am|void *|MoveD|void* src|void* dest|int nitems|type |
| 1779 | Like C<Move> but returns dest. Useful |
| 1780 | for encouraging compilers to tail-call |
| 1781 | optimise. |
| 1782 | |
| 1783 | =for apidoc Am|void|Copy|void* src|void* dest|int nitems|type |
| 1784 | The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the |
| 1785 | source, C<dest> is the destination, C<nitems> is the number of items, and |
| 1786 | C<type> is the type. May fail on overlapping copies. See also C<Move>. |
| 1787 | |
| 1788 | =for apidoc Am|void *|CopyD|void* src|void* dest|int nitems|type |
| 1789 | |
| 1790 | Like C<Copy> but returns dest. Useful |
| 1791 | for encouraging compilers to tail-call |
| 1792 | optimise. |
| 1793 | |
| 1794 | =for apidoc Am|void|Zero|void* dest|int nitems|type |
| 1795 | |
| 1796 | The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the |
| 1797 | destination, C<nitems> is the number of items, and C<type> is the type. |
| 1798 | |
| 1799 | =for apidoc Am|void *|ZeroD|void* dest|int nitems|type |
| 1800 | |
| 1801 | Like C<Zero> but returns dest. Useful |
| 1802 | for encouraging compilers to tail-call |
| 1803 | optimise. |
| 1804 | |
| 1805 | =for apidoc Am|void|StructCopy|type *src|type *dest|type |
| 1806 | This is an architecture-independent macro to copy one structure to another. |
| 1807 | |
| 1808 | =for apidoc Am|void|PoisonWith|void* dest|int nitems|type|U8 byte |
| 1809 | |
| 1810 | Fill up memory with a byte pattern (a byte repeated over and over |
| 1811 | again) that hopefully catches attempts to access uninitialized memory. |
| 1812 | |
| 1813 | =for apidoc Am|void|PoisonNew|void* dest|int nitems|type |
| 1814 | |
| 1815 | PoisonWith(0xAB) for catching access to allocated but uninitialized memory. |
| 1816 | |
| 1817 | =for apidoc Am|void|PoisonFree|void* dest|int nitems|type |
| 1818 | |
| 1819 | PoisonWith(0xEF) for catching access to freed memory. |
| 1820 | |
| 1821 | =for apidoc Am|void|Poison|void* dest|int nitems|type |
| 1822 | |
| 1823 | PoisonWith(0xEF) for catching access to freed memory. |
| 1824 | |
| 1825 | =cut */ |
| 1826 | |
| 1827 | /* Maintained for backwards-compatibility only. Use newSV() instead. */ |
| 1828 | #ifndef PERL_CORE |
| 1829 | #define NEWSV(x,len) newSV(len) |
| 1830 | #endif |
| 1831 | |
| 1832 | #define MEM_SIZE_MAX ((MEM_SIZE)~0) |
| 1833 | |
| 1834 | /* The +0.0 in MEM_WRAP_CHECK_ is an attempt to foil |
| 1835 | * overly eager compilers that will bleat about e.g. |
| 1836 | * (U16)n > (size_t)~0/sizeof(U16) always being false. */ |
| 1837 | #ifdef PERL_MALLOC_WRAP |
| 1838 | #define MEM_WRAP_CHECK(n,t) \ |
| 1839 | (void)(UNLIKELY(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t)) && (croak_memory_wrap(),0)) |
| 1840 | #define MEM_WRAP_CHECK_1(n,t,a) \ |
| 1841 | (void)(UNLIKELY(sizeof(t) > 1 && ((MEM_SIZE)(n)+0.0) > MEM_SIZE_MAX/sizeof(t)) && (Perl_croak_nocontext("%s",(a)),0)) |
| 1842 | #define MEM_WRAP_CHECK_(n,t) MEM_WRAP_CHECK(n,t), |
| 1843 | |
| 1844 | #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))) |
| 1845 | #else |
| 1846 | |
| 1847 | #define MEM_WRAP_CHECK(n,t) |
| 1848 | #define MEM_WRAP_CHECK_1(n,t,a) |
| 1849 | #define MEM_WRAP_CHECK_2(n,t,a,b) |
| 1850 | #define MEM_WRAP_CHECK_(n,t) |
| 1851 | |
| 1852 | #define PERL_STRLEN_ROUNDUP(n) (((n-1+PERL_STRLEN_ROUNDUP_QUANTUM)&~((MEM_SIZE)PERL_STRLEN_ROUNDUP_QUANTUM-1))) |
| 1853 | |
| 1854 | #endif |
| 1855 | |
| 1856 | #ifdef PERL_MEM_LOG |
| 1857 | /* |
| 1858 | * If PERL_MEM_LOG is defined, all Newx()s, Renew()s, and Safefree()s |
| 1859 | * go through functions, which are handy for debugging breakpoints, but |
| 1860 | * which more importantly get the immediate calling environment (file and |
| 1861 | * line number, and C function name if available) passed in. This info can |
| 1862 | * then be used for logging the calls, for which one gets a sample |
| 1863 | * implementation unless -DPERL_MEM_LOG_NOIMPL is also defined. |
| 1864 | * |
| 1865 | * Known problems: |
| 1866 | * - not all memory allocs get logged, only those |
| 1867 | * that go through Newx() and derivatives (while all |
| 1868 | * Safefrees do get logged) |
| 1869 | * - __FILE__ and __LINE__ do not work everywhere |
| 1870 | * - __func__ or __FUNCTION__ even less so |
| 1871 | * - I think more goes on after the perlio frees but |
| 1872 | * the thing is that STDERR gets closed (as do all |
| 1873 | * the file descriptors) |
| 1874 | * - no deeper calling stack than the caller of the Newx() |
| 1875 | * or the kind, but do I look like a C reflection/introspection |
| 1876 | * utility to you? |
| 1877 | * - the function prototypes for the logging functions |
| 1878 | * probably should maybe be somewhere else than handy.h |
| 1879 | * - one could consider inlining (macrofying) the logging |
| 1880 | * for speed, but I am too lazy |
| 1881 | * - one could imagine recording the allocations in a hash, |
| 1882 | * (keyed by the allocation address?), and maintain that |
| 1883 | * through reallocs and frees, but how to do that without |
| 1884 | * any News() happening...? |
| 1885 | * - lots of -Ddefines to get useful/controllable output |
| 1886 | * - lots of ENV reads |
| 1887 | */ |
| 1888 | |
| 1889 | 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); |
| 1890 | |
| 1891 | 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); |
| 1892 | |
| 1893 | PERL_EXPORT_C Malloc_t Perl_mem_log_free(Malloc_t oldalloc, const char *filename, const int linenumber, const char *funcname); |
| 1894 | |
| 1895 | # ifdef PERL_CORE |
| 1896 | # ifndef PERL_MEM_LOG_NOIMPL |
| 1897 | enum mem_log_type { |
| 1898 | MLT_ALLOC, |
| 1899 | MLT_REALLOC, |
| 1900 | MLT_FREE, |
| 1901 | MLT_NEW_SV, |
| 1902 | MLT_DEL_SV |
| 1903 | }; |
| 1904 | # endif |
| 1905 | # if defined(PERL_IN_SV_C) /* those are only used in sv.c */ |
| 1906 | void Perl_mem_log_new_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname); |
| 1907 | void Perl_mem_log_del_sv(const SV *sv, const char *filename, const int linenumber, const char *funcname); |
| 1908 | # endif |
| 1909 | # endif |
| 1910 | |
| 1911 | #endif |
| 1912 | |
| 1913 | #ifdef PERL_MEM_LOG |
| 1914 | #define MEM_LOG_ALLOC(n,t,a) Perl_mem_log_alloc(n,sizeof(t),STRINGIFY(t),a,__FILE__,__LINE__,FUNCTION__) |
| 1915 | #define MEM_LOG_REALLOC(n,t,v,a) Perl_mem_log_realloc(n,sizeof(t),STRINGIFY(t),v,a,__FILE__,__LINE__,FUNCTION__) |
| 1916 | #define MEM_LOG_FREE(a) Perl_mem_log_free(a,__FILE__,__LINE__,FUNCTION__) |
| 1917 | #endif |
| 1918 | |
| 1919 | #ifndef MEM_LOG_ALLOC |
| 1920 | #define MEM_LOG_ALLOC(n,t,a) (a) |
| 1921 | #endif |
| 1922 | #ifndef MEM_LOG_REALLOC |
| 1923 | #define MEM_LOG_REALLOC(n,t,v,a) (a) |
| 1924 | #endif |
| 1925 | #ifndef MEM_LOG_FREE |
| 1926 | #define MEM_LOG_FREE(a) (a) |
| 1927 | #endif |
| 1928 | |
| 1929 | #define Newx(v,n,t) (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t)))))) |
| 1930 | #define Newxc(v,n,t,c) (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_ALLOC(n,t,safemalloc((MEM_SIZE)((n)*sizeof(t)))))) |
| 1931 | #define Newxz(v,n,t) (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_ALLOC(n,t,safecalloc((n),sizeof(t))))) |
| 1932 | |
| 1933 | #ifndef PERL_CORE |
| 1934 | /* pre 5.9.x compatibility */ |
| 1935 | #define New(x,v,n,t) Newx(v,n,t) |
| 1936 | #define Newc(x,v,n,t,c) Newxc(v,n,t,c) |
| 1937 | #define Newz(x,v,n,t) Newxz(v,n,t) |
| 1938 | #endif |
| 1939 | |
| 1940 | #define Renew(v,n,t) \ |
| 1941 | (v = (MEM_WRAP_CHECK_(n,t) (t*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t)))))) |
| 1942 | #define Renewc(v,n,t,c) \ |
| 1943 | (v = (MEM_WRAP_CHECK_(n,t) (c*)MEM_LOG_REALLOC(n,t,v,saferealloc((Malloc_t)(v),(MEM_SIZE)((n)*sizeof(t)))))) |
| 1944 | |
| 1945 | #ifdef PERL_POISON |
| 1946 | #define Safefree(d) \ |
| 1947 | ((d) ? (void)(safefree(MEM_LOG_FREE((Malloc_t)(d))), Poison(&(d), 1, Malloc_t)) : (void) 0) |
| 1948 | #else |
| 1949 | #define Safefree(d) safefree(MEM_LOG_FREE((Malloc_t)(d))) |
| 1950 | #endif |
| 1951 | |
| 1952 | #define Move(s,d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memmove((char*)(d),(const char*)(s), (n) * sizeof(t))) |
| 1953 | #define Copy(s,d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memcpy((char*)(d),(const char*)(s), (n) * sizeof(t))) |
| 1954 | #define Zero(d,n,t) (MEM_WRAP_CHECK_(n,t) (void)memzero((char*)(d), (n) * sizeof(t))) |
| 1955 | |
| 1956 | #define MoveD(s,d,n,t) (MEM_WRAP_CHECK_(n,t) memmove((char*)(d),(const char*)(s), (n) * sizeof(t))) |
| 1957 | #define CopyD(s,d,n,t) (MEM_WRAP_CHECK_(n,t) memcpy((char*)(d),(const char*)(s), (n) * sizeof(t))) |
| 1958 | #ifdef HAS_MEMSET |
| 1959 | #define ZeroD(d,n,t) (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t))) |
| 1960 | #else |
| 1961 | /* Using bzero(), which returns void. */ |
| 1962 | #define ZeroD(d,n,t) (MEM_WRAP_CHECK_(n,t) memzero((char*)(d), (n) * sizeof(t)),d) |
| 1963 | #endif |
| 1964 | |
| 1965 | #define PoisonWith(d,n,t,b) (MEM_WRAP_CHECK_(n,t) (void)memset((char*)(d), (U8)(b), (n) * sizeof(t))) |
| 1966 | #define PoisonNew(d,n,t) PoisonWith(d,n,t,0xAB) |
| 1967 | #define PoisonFree(d,n,t) PoisonWith(d,n,t,0xEF) |
| 1968 | #define Poison(d,n,t) PoisonFree(d,n,t) |
| 1969 | |
| 1970 | #ifdef PERL_POISON |
| 1971 | # define PERL_POISON_EXPR(x) x |
| 1972 | #else |
| 1973 | # define PERL_POISON_EXPR(x) |
| 1974 | #endif |
| 1975 | |
| 1976 | #ifdef USE_STRUCT_COPY |
| 1977 | #define StructCopy(s,d,t) (*((t*)(d)) = *((t*)(s))) |
| 1978 | #else |
| 1979 | #define StructCopy(s,d,t) Copy(s,d,1,t) |
| 1980 | #endif |
| 1981 | |
| 1982 | /* C_ARRAY_LENGTH is the number of elements in the C array (so you |
| 1983 | * want your zero-based indices to be less than but not equal to). |
| 1984 | * |
| 1985 | * C_ARRAY_END is one past the last: half-open/half-closed range, |
| 1986 | * not last-inclusive range. */ |
| 1987 | #define C_ARRAY_LENGTH(a) (sizeof(a)/sizeof((a)[0])) |
| 1988 | #define C_ARRAY_END(a) ((a) + C_ARRAY_LENGTH(a)) |
| 1989 | |
| 1990 | #ifdef NEED_VA_COPY |
| 1991 | # ifdef va_copy |
| 1992 | # define Perl_va_copy(s, d) va_copy(d, s) |
| 1993 | # else |
| 1994 | # if defined(__va_copy) |
| 1995 | # define Perl_va_copy(s, d) __va_copy(d, s) |
| 1996 | # else |
| 1997 | # define Perl_va_copy(s, d) Copy(s, d, 1, va_list) |
| 1998 | # endif |
| 1999 | # endif |
| 2000 | #endif |
| 2001 | |
| 2002 | /* convenience debug macros */ |
| 2003 | #ifdef USE_ITHREADS |
| 2004 | #define pTHX_FORMAT "Perl interpreter: 0x%p" |
| 2005 | #define pTHX__FORMAT ", Perl interpreter: 0x%p" |
| 2006 | #define pTHX_VALUE_ (void *)my_perl, |
| 2007 | #define pTHX_VALUE (void *)my_perl |
| 2008 | #define pTHX__VALUE_ ,(void *)my_perl, |
| 2009 | #define pTHX__VALUE ,(void *)my_perl |
| 2010 | #else |
| 2011 | #define pTHX_FORMAT |
| 2012 | #define pTHX__FORMAT |
| 2013 | #define pTHX_VALUE_ |
| 2014 | #define pTHX_VALUE |
| 2015 | #define pTHX__VALUE_ |
| 2016 | #define pTHX__VALUE |
| 2017 | #endif /* USE_ITHREADS */ |
| 2018 | |
| 2019 | /* Perl_deprecate was not part of the public API, and did not have a deprecate() |
| 2020 | shortcut macro defined without -DPERL_CORE. Neither codesearch.google.com nor |
| 2021 | CPAN::Unpack show any users outside the core. */ |
| 2022 | #ifdef PERL_CORE |
| 2023 | # define deprecate(s) Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED), "Use of " s " is deprecated") |
| 2024 | #endif |
| 2025 | |
| 2026 | /* Internal macros to deal with gids and uids */ |
| 2027 | #ifdef PERL_CORE |
| 2028 | |
| 2029 | # if Uid_t_size > IVSIZE |
| 2030 | # define sv_setuid(sv, uid) sv_setnv((sv), (NV)(uid)) |
| 2031 | # define SvUID(sv) SvNV(sv) |
| 2032 | # else |
| 2033 | # if Uid_t_sign <= 0 |
| 2034 | # define sv_setuid(sv, uid) sv_setiv((sv), (IV)(uid)) |
| 2035 | # define SvUID(sv) SvIV(sv) |
| 2036 | # else |
| 2037 | # define sv_setuid(sv, uid) sv_setuv((sv), (UV)(uid)) |
| 2038 | # define SvUID(sv) SvUV(sv) |
| 2039 | # endif |
| 2040 | # endif /* Uid_t_size */ |
| 2041 | |
| 2042 | # if Gid_t_size > IVSIZE |
| 2043 | # define sv_setgid(sv, gid) sv_setnv((sv), (NV)(gid)) |
| 2044 | # define SvGID(sv) SvNV(sv) |
| 2045 | # else |
| 2046 | # if Gid_t_sign <= 0 |
| 2047 | # define sv_setgid(sv, gid) sv_setiv((sv), (IV)(gid)) |
| 2048 | # define SvGID(sv) SvIV(sv) |
| 2049 | # else |
| 2050 | # define sv_setgid(sv, gid) sv_setuv((sv), (UV)(gid)) |
| 2051 | # define SvGID(sv) SvUV(sv) |
| 2052 | # endif |
| 2053 | # endif /* Gid_t_size */ |
| 2054 | |
| 2055 | #endif |
| 2056 | |
| 2057 | #endif /* HANDY_H */ |
| 2058 | |
| 2059 | /* |
| 2060 | * Local variables: |
| 2061 | * c-indentation-style: bsd |
| 2062 | * c-basic-offset: 4 |
| 2063 | * indent-tabs-mode: nil |
| 2064 | * End: |
| 2065 | * |
| 2066 | * ex: set ts=8 sts=4 sw=4 et: |
| 2067 | */ |