summaryrefslogtreecommitdiff
path: root/lib/unigbrk.in.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/unigbrk.in.h')
-rw-r--r--lib/unigbrk.in.h13
1 files changed, 10 insertions, 3 deletions
diff --git a/lib/unigbrk.in.h b/lib/unigbrk.in.h
index 4001c6e7..2026284a 100644
--- a/lib/unigbrk.in.h
+++ b/lib/unigbrk.in.h
@@ -1,5 +1,5 @@
/* Grapheme cluster breaks in Unicode strings.
- Copyright (C) 2010-2022 Free Software Foundation, Inc.
+ Copyright (C) 2010-2024 Free Software Foundation, Inc.
Written by Ben Pfaff <blp@cs.stanford.edu>, 2010.
This file is free software.
@@ -88,6 +88,9 @@ extern int
Implements extended (not legacy) grapheme cluster rules, because UAX #29
indicates that they are preferred.
+ Note: This function does not work right with syllables in Indic scripts or
+ emojis, because it does not look at the characters before A and after B.
+
Use A == 0 or B == 0 to indicate start of text or end of text,
respectively. */
extern bool
@@ -95,7 +98,9 @@ extern bool
_UC_ATTRIBUTE_CONST;
/* Returns the start of the next grapheme cluster following S, or NULL if the
- end of the string has been reached. */
+ end of the string has been reached.
+ Note: These functions do not work right with syllables in Indic scripts or
+ emojis, because they do not consider the characters before S. */
extern const uint8_t *
u8_grapheme_next (const uint8_t *s, const uint8_t *end)
_UC_ATTRIBUTE_PURE;
@@ -107,7 +112,9 @@ extern const uint32_t *
_UC_ATTRIBUTE_PURE;
/* Returns the start of the previous grapheme cluster before S, or NULL if the
- start of the string has been reached. */
+ start of the string has been reached.
+ Note: These functions do not work right with syllables in Indic scripts or
+ emojis, because they do not consider the characters at or after S. */
extern const uint8_t *
u8_grapheme_prev (const uint8_t *s, const uint8_t *start)
_UC_ATTRIBUTE_PURE;