1 /* classes: h_files */
2
3 #ifndef SCM_CHARS_H
4 #define SCM_CHARS_H
5
6 /* Copyright (C) 1995, 1996, 2000, 2001, 2004, 2006, 2008, 2009, 2019
7 * Free Software Foundation, Inc.
8 *
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public License
11 * as published by the Free Software Foundation; either version 3 of
12 * the License, or (at your option) any later version.
13 *
14 * This library is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
22 * 02110-1301 USA
23 */
24
25
26
27 #include "libguile/__scm.h"
28
29 #ifndef SCM_T_WCHAR_DEFINED
30 typedef scm_t_int32 scm_t_wchar;
31 #define SCM_T_WCHAR_DEFINED
32 #endif /* SCM_T_WCHAR_DEFINED */
33
34
35 /* Immediate Characters
36 */
37 #define SCM_CHARP(x) (SCM_ITAG8(x) == scm_tc8_char)
38 #define SCM_CHAR(x) ((scm_t_wchar)SCM_ITAG8_DATA(x))
39
40 /* SCM_MAKE_CHAR maps signed chars (-128 to 127) and unsigned chars
41 (0 to 255) to Latin-1 codepoints (0 to 255) while allowing higher
42 codepoints (256 to 1114111) to pass through unchanged.
43
44 This macro evaluates X twice, which may lead to side effects if used
45 incorrectly. It's also likely to be inefficient if X calls a
46 procedure. Use 'scm_i_make_char' in those cases. */
47 #define SCM_MAKE_CHAR(x) \
48 ((x) <= 1 \
49 ? SCM_MAKE_ITAG8 ((scm_t_bits) (unsigned char) (x), scm_tc8_char) \
50 : SCM_MAKE_ITAG8 ((scm_t_bits) (x), scm_tc8_char))
51
52 #define SCM_CODEPOINT_DOTTED_CIRCLE (0x25cc)
53 #define SCM_CODEPOINT_SURROGATE_START (0xd800)
54 #define SCM_CODEPOINT_SURROGATE_END (0xdfff)
55 #define SCM_CODEPOINT_MAX (0x10ffff)
56 #define SCM_IS_UNICODE_CHAR(c) \
57 (((scm_t_wchar) (c) >= 0 \
58 && (scm_t_wchar) (c) < SCM_CODEPOINT_SURROGATE_START) \
59 || ((scm_t_wchar) (c) > SCM_CODEPOINT_SURROGATE_END \
60 && (scm_t_wchar) (c) <= SCM_CODEPOINT_MAX))
61
62
63
64 SCM_API SCM scm_char_p (SCM x);
65 SCM_API SCM scm_char_eq_p (SCM x, SCM y);
66 SCM_API SCM scm_char_less_p (SCM x, SCM y);
67 SCM_API SCM scm_char_leq_p (SCM x, SCM y);
68 SCM_API SCM scm_char_gr_p (SCM x, SCM y);
69 SCM_API SCM scm_char_geq_p (SCM x, SCM y);
70 SCM_API SCM scm_char_ci_eq_p (SCM x, SCM y);
71 SCM_API SCM scm_char_ci_less_p (SCM x, SCM y);
72 SCM_API SCM scm_char_ci_leq_p (SCM x, SCM y);
73 SCM_API SCM scm_char_ci_gr_p (SCM x, SCM y);
74 SCM_API SCM scm_char_ci_geq_p (SCM x, SCM y);
75 SCM_API SCM scm_char_alphabetic_p (SCM chr);
76 SCM_API SCM scm_char_numeric_p (SCM chr);
77 SCM_API SCM scm_char_whitespace_p (SCM chr);
78 SCM_API SCM scm_char_upper_case_p (SCM chr);
79 SCM_API SCM scm_char_lower_case_p (SCM chr);
80 SCM_API SCM scm_char_is_both_p (SCM chr);
81 SCM_API SCM scm_char_to_integer (SCM chr);
82 SCM_API SCM scm_integer_to_char (SCM n);
83 SCM_API SCM scm_char_upcase (SCM chr);
84 SCM_API SCM scm_char_downcase (SCM chr);
85 SCM_API SCM scm_char_titlecase (SCM chr);
86 SCM_API SCM scm_char_general_category (SCM chr);
87
88 SCM_INLINE SCM scm_i_make_char (scm_t_wchar c);
89 SCM_API scm_t_wchar scm_c_upcase (scm_t_wchar c);
90 SCM_API scm_t_wchar scm_c_downcase (scm_t_wchar c);
91 SCM_API scm_t_wchar scm_c_titlecase (scm_t_wchar c);
92
93 SCM_INTERNAL const char *scm_i_charname (SCM chr);
94 SCM_INTERNAL SCM scm_i_charname_to_char (const char *charname,
95 size_t charname_len);
96 SCM_INTERNAL void scm_init_chars (void);
97
98 #if SCM_CAN_INLINE || defined SCM_INLINE_C_IMPLEMENTING_INLINES
99 SCM_INLINE_IMPLEMENTATION SCM
scm_i_make_char(scm_t_wchar c)100 scm_i_make_char (scm_t_wchar c)
101 {
102 return SCM_MAKE_CHAR(c);
103 }
104 #endif
105
106 #endif /* SCM_CHARS_H */
107
108 /*
109 Local Variables:
110 c-file-style: "gnu"
111 End:
112 */
113