libguile/chars.h

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