lib/unigbrk.in.h

   1 /* Grapheme cluster breaks in Unicode strings.
   2    Copyright (C) 2010-2011 Free Software Foundation, Inc.
   3    Written by Ben Pfaff <blp@cs.stanford.edu>, 2010.
   4
   5    This program is free software: you can redistribute it and/or modify it
   6    under the terms of the GNU Lesser General Public License as published
   7    by the Free Software Foundation; either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public License
  16    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  17
  18 #ifndef _UNIGBRK_H
  19 #define _UNIGBRK_H
  20
  21 /* Get bool.  */
  22 #include <stdbool.h>
  23
  24 /* Get size_t. */
  25 #include <stddef.h>
  26
  27 #include "unitypes.h"
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 /* ========================================================================= */
  34
  35 /* Property defined in Unicode Standard Annex #29, section "Grapheme Cluster
  36    Boundaries"
  37    <http://unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries> */
  38
  39 /* Possible values of the Grapheme_Cluster_Break property.
  40    This enumeration may be extended in the future.  */
  41 enum
  42 {
  43   GBP_OTHER        = 0,
  44   GBP_CR           = 1,
  45   GBP_LF           = 2,
  46   GBP_CONTROL      = 3,
  47   GBP_EXTEND       = 4,
  48   GBP_PREPEND      = 5,
  49   GBP_SPACINGMARK  = 6,
  50   GBP_L            = 7,
  51   GBP_V            = 8,
  52   GBP_T            = 9,
  53   GBP_LV           = 10,
  54   GBP_LVT          = 11
  55 };
  56
  57 /* Return the Grapheme_Cluster_Break property of a Unicode character. */
  58 extern int
  59        uc_graphemeclusterbreak_property (ucs4_t uc);
  60
  61 /* ========================================================================= */
  62
  63 /* Grapheme cluster breaks.  */
  64
  65 /* Returns true if there is an grapheme cluster boundary between Unicode code
  66    points A and B.  A "grapheme cluster" is an approximation to a
  67    user-perceived character, which sometimes corresponds to multiple code
  68    points.  For example, an English letter followed by an acute accent can be
  69    expressed as two consecutive Unicode code points, but it is perceived by the
  70    user as only a single character and therefore constitutes a single grapheme
  71    cluster.
  72
  73    Implements extended (not legacy) grapheme cluster rules, because UAX #29
  74    indicates that they are preferred.
  75
  76    Use A == 0 or B == 0 to indicate start of text or end of text,
  77    respectively. */
  78 extern bool
  79        uc_is_grapheme_cluster_break (ucs4_t a, ucs4_t b);
  80
  81 /* Returns the length (in units) of the first grapheme cluster in the N units
  82    in S.  If the return value is N, then extending the string could extend the
  83    length of the grapheme cluster too.  Returns 0 only if N is zero. */
  84 extern size_t
  85        u8_grapheme_len (const uint8_t *s, size_t n);
  86 extern size_t
  87        u16_grapheme_len (const uint16_t *s, size_t n);
  88 extern size_t
  89        u32_grapheme_len (const uint32_t *s, size_t n);
  90
  91 /* Returns the start of the next grapheme cluster following S, or NULL if the
  92    end of the string has been reached. */
  93 extern const uint8_t *
  94        u8_grapheme_next (const uint8_t *s, const uint8_t *end);
  95 extern const uint16_t *
  96        u16_grapheme_next (const uint16_t *s, const uint16_t *end);
  97 extern const uint32_t *
  98        u32_grapheme_next (const uint32_t *s, const uint32_t *end);
  99
 100 /* Returns the start of the previous grapheme cluster before S, or NULL if the
 101    start of the string has been reached. */
 102 extern const uint8_t *
 103        u8_grapheme_prev (const uint8_t *s, const uint8_t *start);
 104 extern const uint16_t *
 105        u16_grapheme_prev (const uint16_t *s, const uint16_t *start);
 106 extern const uint32_t *
 107        u32_grapheme_prev (const uint32_t *s, const uint32_t *start);
 108
 109 /* Determine the grapheme cluster boundaries in S, and store the result at
 110    p[0..n-1].  p[i] = 1 means that a new grapheme cluster begins at s[i].  p[i]
 111    = 0 means that s[i-1] and s[i] are part of the same grapheme cluster.  p[0]
 112    will always be 1.
 113  */
 114 extern void
 115        u8_grapheme_breaks (const uint8_t *s, size_t n, char *p);
 116 extern void
 117        u16_grapheme_breaks (const uint16_t *s, size_t n, char *p);
 118 extern void
 119        u32_grapheme_breaks (const uint32_t *s, size_t n, char *p);
 120 extern void
 121        ulc_grapheme_breaks (const char *s, size_t n, char *p);
 122
 123 /* ========================================================================= */
 124
 125 #ifdef __cplusplus
 126 }
 127 #endif
 128
 129
 130 #endif /* _UNIGBRK_H */