Annotation of embedaddon/php/ext/mbstring/php_unicode.h, revision 1.1.1.1

1.1       misho       1: /*
                      2:    +----------------------------------------------------------------------+
                      3:    | PHP Version 5                                                        |
                      4:    +----------------------------------------------------------------------+
                      5:    | Copyright (c) 1997-2012 The PHP Group                                |
                      6:    +----------------------------------------------------------------------+
                      7:    | This source file is subject to version 3.01 of the PHP license,      |
                      8:    | that is bundled with this package in the file LICENSE, and is        |
                      9:    | available through the world-wide-web at the following url:           |
                     10:    | http://www.php.net/license/3_01.txt                                  |
                     11:    | If you did not receive a copy of the PHP license and are unable to   |
                     12:    | obtain it through the world-wide-web, please send a note to          |
                     13:    | license@php.net so we can mail you a copy immediately.               |
                     14:    +----------------------------------------------------------------------+
                     15:    | Author: Wez Furlong (wez@thebrainroom.com)                           |
                     16:    +----------------------------------------------------------------------+
                     17: 
                     18:        Based on code from ucdata-2.5, which has the following Copyright:
                     19:    
                     20:        Copyright 2001 Computing Research Labs, New Mexico State University
                     21:  
                     22:        Permission is hereby granted, free of charge, to any person obtaining a
                     23:        copy of this software and associated documentation files (the "Software"),
                     24:        to deal in the Software without restriction, including without limitation
                     25:        the rights to use, copy, modify, merge, publish, distribute, sublicense,
                     26:        and/or sell copies of the Software, and to permit persons to whom the
                     27:        Software is furnished to do so, subject to the following conditions:
                     28:  
                     29:        The above copyright notice and this permission notice shall be included in
                     30:        all copies or substantial portions of the Software.
                     31: */
                     32: 
                     33: #ifndef PHP_UNICODE_H
                     34: #define PHP_UNICODE_H
                     35: 
                     36: #if HAVE_MBSTRING
                     37: /*
                     38:  * Values that can appear in the `mask1' parameter of the php_unicode_is_prop()
                     39:  * function.
                     40:  */
                     41: #define UC_MN 0x00000001 /* Mark, Non-Spacing          */
                     42: #define UC_MC 0x00000002 /* Mark, Spacing Combining    */
                     43: #define UC_ME 0x00000004 /* Mark, Enclosing            */
                     44: #define UC_ND 0x00000008 /* Number, Decimal Digit      */
                     45: #define UC_NL 0x00000010 /* Number, Letter             */
                     46: #define UC_NO 0x00000020 /* Number, Other              */
                     47: #define UC_ZS 0x00000040 /* Separator, Space           */
                     48: #define UC_ZL 0x00000080 /* Separator, Line            */
                     49: #define UC_ZP 0x00000100 /* Separator, Paragraph       */
                     50: #define UC_CC 0x00000200 /* Other, Control             */
                     51: #define UC_CF 0x00000400 /* Other, Format              */
                     52: #define UC_OS 0x00000800 /* Other, Surrogate           */
                     53: #define UC_CO 0x00001000 /* Other, Private Use         */
                     54: #define UC_CN 0x00002000 /* Other, Not Assigned        */
                     55: #define UC_LU 0x00004000 /* Letter, Uppercase          */
                     56: #define UC_LL 0x00008000 /* Letter, Lowercase          */
                     57: #define UC_LT 0x00010000 /* Letter, Titlecase          */
                     58: #define UC_LM 0x00020000 /* Letter, Modifier           */
                     59: #define UC_LO 0x00040000 /* Letter, Other              */
                     60: #define UC_PC 0x00080000 /* Punctuation, Connector     */
                     61: #define UC_PD 0x00100000 /* Punctuation, Dash          */
                     62: #define UC_PS 0x00200000 /* Punctuation, Open          */
                     63: #define UC_PE 0x00400000 /* Punctuation, Close         */
                     64: #define UC_PO 0x00800000 /* Punctuation, Other         */
                     65: #define UC_SM 0x01000000 /* Symbol, Math               */
                     66: #define UC_SC 0x02000000 /* Symbol, Currency           */
                     67: #define UC_SK 0x04000000 /* Symbol, Modifier           */
                     68: #define UC_SO 0x08000000 /* Symbol, Other              */
                     69: #define UC_L  0x10000000 /* Left-To-Right              */
                     70: #define UC_R  0x20000000 /* Right-To-Left              */
                     71: #define UC_EN 0x40000000 /* European Number            */
                     72: #define UC_ES 0x80000000 /* European Number Separator  */
                     73: 
                     74: /*
                     75:  * Values that can appear in the `mask2' parameter of the php_unicode_is_prop()
                     76:  * function.
                     77:  */
                     78: #define UC_ET 0x00000001 /* European Number Terminator */
                     79: #define UC_AN 0x00000002 /* Arabic Number              */
                     80: #define UC_CS 0x00000004 /* Common Number Separator    */
                     81: #define UC_B  0x00000008 /* Block Separator            */
                     82: #define UC_S  0x00000010 /* Segment Separator          */
                     83: #define UC_WS 0x00000020 /* Whitespace                 */
                     84: #define UC_ON 0x00000040 /* Other Neutrals             */
                     85: /*
                     86:  * Implementation specific character properties.
                     87:  */
                     88: #define UC_CM 0x00000080 /* Composite                  */
                     89: #define UC_NB 0x00000100 /* Non-Breaking               */
                     90: #define UC_SY 0x00000200 /* Symmetric                  */
                     91: #define UC_HD 0x00000400 /* Hex Digit                  */
                     92: #define UC_QM 0x00000800 /* Quote Mark                 */
                     93: #define UC_MR 0x00001000 /* Mirroring                  */
                     94: #define UC_SS 0x00002000 /* Space, other               */
                     95: 
                     96: #define UC_CP 0x00004000 /* Defined                    */
                     97: 
                     98: /*
                     99:  * Added for UnicodeData-2.1.3.
                    100:  */
                    101: #define UC_PI 0x00008000 /* Punctuation, Initial       */
                    102: #define UC_PF 0x00010000 /* Punctuation, Final         */
                    103: 
                    104: MBSTRING_API int php_unicode_is_prop(unsigned long code, unsigned long mask1,
                    105:                unsigned long mask2);
                    106: MBSTRING_API char *php_unicode_convert_case(int case_mode, const char *srcstr, size_t srclen, size_t *retlen,
                    107:                const char *src_encoding TSRMLS_DC);
                    108: 
                    109: #define PHP_UNICODE_CASE_UPPER 0
                    110: #define PHP_UNICODE_CASE_LOWER 1
                    111: #define PHP_UNICODE_CASE_TITLE 2
                    112: 
                    113: #define php_unicode_is_alpha(cc) php_unicode_is_prop(cc, UC_LU|UC_LL|UC_LM|UC_LO|UC_LT, 0)
                    114: #define php_unicode_is_digit(cc) php_unicode_is_prop(cc, UC_ND, 0)
                    115: #define php_unicode_is_alnum(cc) php_unicode_is_prop(cc, UC_LU|UC_LL|UC_LM|UC_LO|UC_LT|UC_ND, 0)
                    116: #define php_unicode_is_cntrl(cc) php_unicode_is_prop(cc, UC_CC|UC_CF, 0)
                    117: #define php_unicode_is_space(cc) php_unicode_is_prop(cc, UC_ZS|UC_SS, 0)
                    118: #define php_unicode_is_blank(cc) php_unicode_is_prop(cc, UC_ZS, 0)
                    119: #define php_unicode_is_punct(cc) php_unicode_is_prop(cc, UC_PD|UC_PS|UC_PE|UC_PO, UC_PI|UC_PF)
                    120: #define php_unicode_is_graph(cc) php_unicode_is_prop(cc, UC_MN|UC_MC|UC_ME|UC_ND|UC_NL|UC_NO|\
                    121:                                UC_LU|UC_LL|UC_LT|UC_LM|UC_LO|UC_PC|UC_PD|\
                    122:                                UC_PS|UC_PE|UC_PO|UC_SM|UC_SM|UC_SC|UC_SK|\
                    123:                                UC_SO, UC_PI|UC_PF)
                    124: #define php_unicode_is_print(cc) php_unicode_is_prop(cc, UC_MN|UC_MC|UC_ME|UC_ND|UC_NL|UC_NO|\
                    125:                                UC_LU|UC_LL|UC_LT|UC_LM|UC_LO|UC_PC|UC_PD|\
                    126:                                UC_PS|UC_PE|UC_PO|UC_SM|UC_SM|UC_SC|UC_SK|\
                    127:                                UC_SO|UC_ZS, UC_PI|UC_PF)
                    128: #define php_unicode_is_upper(cc) php_unicode_is_prop(cc, UC_LU, 0)
                    129: #define php_unicode_is_lower(cc) php_unicode_is_prop(cc, UC_LL, 0)
                    130: #define php_unicode_is_title(cc) php_unicode_is_prop(cc, UC_LT, 0)
                    131: #define php_unicode_is_xdigit(cc) php_unicode_is_prop(cc, 0, UC_HD)
                    132: 
                    133: #define php_unicode_is_isocntrl(cc) php_unicode_is_prop(cc, UC_CC, 0)
                    134: #define php_unicode_is_fmtcntrl(cc) php_unicode_is_prop(cc, UC_CF, 0)
                    135: 
                    136: #define php_unicode_is_symbol(cc) php_unicode_is_prop(cc, UC_SM|UC_SC|UC_SO|UC_SK, 0)
                    137: #define php_unicode_is_number(cc) php_unicode_is_prop(cc, UC_ND|UC_NO|UC_NL, 0)
                    138: #define php_unicode_is_nonspacing(cc) php_unicode_is_prop(cc, UC_MN, 0)
                    139: #define php_unicode_is_openpunct(cc) php_unicode_is_prop(cc, UC_PS, 0)
                    140: #define php_unicode_is_closepunct(cc) php_unicode_is_prop(cc, UC_PE, 0)
                    141: #define php_unicode_is_initialpunct(cc) php_unicode_is_prop(cc, 0, UC_PI)
                    142: #define php_unicode_is_finalpunct(cc) php_unicode_is_prop(cc, 0, UC_PF)
                    143: 
                    144: #define php_unicode_is_composite(cc) php_unicode_is_prop(cc, 0, UC_CM)
                    145: #define php_unicode_is_hex(cc) php_unicode_is_prop(cc, 0, UC_HD)
                    146: #define php_unicode_is_quote(cc) php_unicode_is_prop(cc, 0, UC_QM)
                    147: #define php_unicode_is_symmetric(cc) php_unicode_is_prop(cc, 0, UC_SY)
                    148: #define php_unicode_is_mirroring(cc) php_unicode_is_prop(cc, 0, UC_MR)
                    149: #define php_unicode_is_nonbreaking(cc) php_unicode_is_prop(cc, 0, UC_NB)
                    150: 
                    151: /*
                    152:  * Directionality macros.
                    153:  */
                    154: #define php_unicode_is_rtl(cc) php_unicode_is_prop(cc, UC_R, 0)
                    155: #define php_unicode_is_ltr(cc) php_unicode_is_prop(cc, UC_L, 0)
                    156: #define php_unicode_is_strong(cc) php_unicode_is_prop(cc, UC_L|UC_R, 0)
                    157: #define php_unicode_is_weak(cc) php_unicode_is_prop(cc, UC_EN|UC_ES, UC_ET|UC_AN|UC_CS)
                    158: #define php_unicode_is_neutral(cc) php_unicode_is_prop(cc, 0, UC_B|UC_S|UC_WS|UC_ON)
                    159: #define php_unicode_is_separator(cc) php_unicode_is_prop(cc, 0, UC_B|UC_S)
                    160: 
                    161: /*
                    162:  * Other macros inspired by John Cowan.
                    163:  */
                    164: #define php_unicode_is_mark(cc) php_unicode_is_prop(cc, UC_MN|UC_MC|UC_ME, 0)
                    165: #define php_unicode_is_modif(cc) php_unicode_is_prop(cc, UC_LM, 0)
                    166: #define php_unicode_is_letnum(cc) php_unicode_is_prop(cc, UC_NL, 0)
                    167: #define php_unicode_is_connect(cc) php_unicode_is_prop(cc, UC_PC, 0)
                    168: #define php_unicode_is_dash(cc) php_unicode_is_prop(cc, UC_PD, 0)
                    169: #define php_unicode_is_math(cc) php_unicode_is_prop(cc, UC_SM, 0)
                    170: #define php_unicode_is_currency(cc) php_unicode_is_prop(cc, UC_SC, 0)
                    171: #define php_unicode_is_modifsymbol(cc) php_unicode_is_prop(cc, UC_SK, 0)
                    172: #define php_unicode_is_nsmark(cc) php_unicode_is_prop(cc, UC_MN, 0)
                    173: #define php_unicode_is_spmark(cc) php_unicode_is_prop(cc, UC_MC, 0)
                    174: #define php_unicode_is_enclosing(cc) php_unicode_is_prop(cc, UC_ME, 0)
                    175: #define php_unicode_is_private(cc) php_unicode_is_prop(cc, UC_CO, 0)
                    176: #define php_unicode_is_surrogate(cc) php_unicode_is_prop(cc, UC_OS, 0)
                    177: #define php_unicode_is_lsep(cc) php_unicode_is_prop(cc, UC_ZL, 0)
                    178: #define php_unicode_is_psep(cc) php_unicode_is_prop(cc, UC_ZP, 0)
                    179: 
                    180: #define php_unicode_is_identstart(cc) php_unicode_is_prop(cc, UC_LU|UC_LL|UC_LT|UC_LO|UC_NL, 0)
                    181: #define php_unicode_is_identpart(cc) php_unicode_is_prop(cc, UC_LU|UC_LL|UC_LT|UC_LO|UC_NL|\
                    182:                                    UC_MN|UC_MC|UC_ND|UC_PC|UC_CF, 0)
                    183: 
                    184: #define php_unicode_is_defined(cc) php_unicode_is_prop(cc, 0, UC_CP)
                    185: #define php_unicode_is_undefined(cc) !php_unicode_is_prop(cc, 0, UC_CP)
                    186: 
                    187: /*
                    188:  * Other miscellaneous character property macros.
                    189:  */
                    190: #define php_unicode_is_han(cc) (((cc) >= 0x4e00 && (cc) <= 0x9fff) ||\
                    191:                      ((cc) >= 0xf900 && (cc) <= 0xfaff))
                    192: #define php_unicode_is_hangul(cc) ((cc) >= 0xac00 && (cc) <= 0xd7ff)
                    193: 
                    194: 
                    195: #endif
                    196: 
                    197: 
                    198: #endif /* PHP_UNICODE_H */
                    199: 
                    200: 
                    201: 

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>