hash: allow C89 compilation
[gnulib.git] / lib / unicase.h
index 63fd862..cb2df95 100644 (file)
@@ -19,6 +19,7 @@
 
 #include "unitypes.h"
 
+/* Get bool.  */
 #include <stdbool.h>
 
 /* Get size_t.  */
@@ -133,7 +134,139 @@ extern uint32_t *
                    uninorm_t nf,
                    uint32_t *resultbuf, size_t *lengthp);
 
+/* The case-mapping context given by a prefix string.  */
+typedef struct casing_prefix_context
+       {
+         /* These fields are private, undocumented.  */
+         uint32_t last_char_except_ignorable;
+         uint32_t last_char_normal_or_above;
+       }
+       casing_prefix_context_t;
+/* The case-mapping context of the empty prefix string.  */
+extern const casing_prefix_context_t unicase_empty_prefix_context;
+/* Return the case-mapping context of a given prefix string.  */
+extern casing_prefix_context_t
+       u8_casing_prefix_context (const uint8_t *s, size_t n);
+extern casing_prefix_context_t
+       u16_casing_prefix_context (const uint16_t *s, size_t n);
+extern casing_prefix_context_t
+       u32_casing_prefix_context (const uint32_t *s, size_t n);
+/* Return the case-mapping context of the prefix concat(A, S), given the
+   case-mapping context of the prefix A.  */
+extern casing_prefix_context_t
+       u8_casing_prefixes_context (const uint8_t *s, size_t n,
+                                  casing_prefix_context_t a_context);
+extern casing_prefix_context_t
+       u16_casing_prefixes_context (const uint16_t *s, size_t n,
+                                   casing_prefix_context_t a_context);
+extern casing_prefix_context_t
+       u32_casing_prefixes_context (const uint32_t *s, size_t n,
+                                   casing_prefix_context_t a_context);
+
+/* The case-mapping context given by a suffix string.  */
+typedef struct casing_suffix_context
+       {
+         /* These fields are private, undocumented.  */
+         uint32_t first_char_except_ignorable;
+         uint32_t bits;
+       }
+       casing_suffix_context_t;
+/* The case-mapping context of the empty suffix string.  */
+extern const casing_suffix_context_t unicase_empty_suffix_context;
+/* Return the case-mapping context of a given suffix string.  */
+extern casing_suffix_context_t
+       u8_casing_suffix_context (const uint8_t *s, size_t n);
+extern casing_suffix_context_t
+       u16_casing_suffix_context (const uint16_t *s, size_t n);
+extern casing_suffix_context_t
+       u32_casing_suffix_context (const uint32_t *s, size_t n);
+/* Return the case-mapping context of the suffix concat(S, A), given the
+   case-mapping context of the suffix A.  */
+extern casing_suffix_context_t
+       u8_casing_suffixes_context (const uint8_t *s, size_t n,
+                                  casing_suffix_context_t a_context);
+extern casing_suffix_context_t
+       u16_casing_suffixes_context (const uint16_t *s, size_t n,
+                                   casing_suffix_context_t a_context);
+extern casing_suffix_context_t
+       u32_casing_suffixes_context (const uint32_t *s, size_t n,
+                                   casing_suffix_context_t a_context);
+
+/* Return the uppercase mapping of a string that is surrounded by a prefix
+   and a suffix.  */
+extern uint8_t *
+       u8_ct_toupper (const uint8_t *s, size_t n,
+                     casing_prefix_context_t prefix_context,
+                     casing_suffix_context_t suffix_context,
+                     const char *iso639_language,
+                     uninorm_t nf,
+                     uint8_t *resultbuf, size_t *lengthp);
+extern uint16_t *
+       u16_ct_toupper (const uint16_t *s, size_t n,
+                     casing_prefix_context_t prefix_context,
+                     casing_suffix_context_t suffix_context,
+                     const char *iso639_language,
+                     uninorm_t nf,
+                     uint16_t *resultbuf, size_t *lengthp);
+extern uint32_t *
+       u32_ct_toupper (const uint32_t *s, size_t n,
+                     casing_prefix_context_t prefix_context,
+                     casing_suffix_context_t suffix_context,
+                     const char *iso639_language,
+                     uninorm_t nf,
+                     uint32_t *resultbuf, size_t *lengthp);
+
+/* Return the lowercase mapping of a string that is surrounded by a prefix
+   and a suffix.  */
+extern uint8_t *
+       u8_ct_tolower (const uint8_t *s, size_t n,
+                     casing_prefix_context_t prefix_context,
+                     casing_suffix_context_t suffix_context,
+                     const char *iso639_language,
+                     uninorm_t nf,
+                     uint8_t *resultbuf, size_t *lengthp);
+extern uint16_t *
+       u16_ct_tolower (const uint16_t *s, size_t n,
+                     casing_prefix_context_t prefix_context,
+                     casing_suffix_context_t suffix_context,
+                     const char *iso639_language,
+                     uninorm_t nf,
+                     uint16_t *resultbuf, size_t *lengthp);
+extern uint32_t *
+       u32_ct_tolower (const uint32_t *s, size_t n,
+                     casing_prefix_context_t prefix_context,
+                     casing_suffix_context_t suffix_context,
+                     const char *iso639_language,
+                     uninorm_t nf,
+                     uint32_t *resultbuf, size_t *lengthp);
+
+/* Return the titlecase mapping of a string that is surrounded by a prefix
+   and a suffix.  */
+extern uint8_t *
+       u8_ct_totitle (const uint8_t *s, size_t n,
+                     casing_prefix_context_t prefix_context,
+                     casing_suffix_context_t suffix_context,
+                     const char *iso639_language,
+                     uninorm_t nf,
+                     uint8_t *resultbuf, size_t *lengthp);
+extern uint16_t *
+       u16_ct_totitle (const uint16_t *s, size_t n,
+                     casing_prefix_context_t prefix_context,
+                     casing_suffix_context_t suffix_context,
+                     const char *iso639_language,
+                     uninorm_t nf,
+                     uint16_t *resultbuf, size_t *lengthp);
+extern uint32_t *
+       u32_ct_totitle (const uint32_t *s, size_t n,
+                     casing_prefix_context_t prefix_context,
+                     casing_suffix_context_t suffix_context,
+                     const char *iso639_language,
+                     uninorm_t nf,
+                     uint32_t *resultbuf, size_t *lengthp);
+
 /* Return the case folded string.
+   Comparing uN_casefold (S1) and uN_casefold (S2) with uN_cmp2() is equivalent
+   to comparing S1 and S2 with uN_casecmp().
    The nf argument identifies the normalization form to apply after the
    case-mapping.  It can also be NULL, for no normalization.  */
 extern uint8_t *
@@ -148,6 +281,28 @@ extern uint32_t *
        u32_casefold (const uint32_t *s, size_t n, const char *iso639_language,
                     uninorm_t nf,
                     uint32_t *resultbuf, size_t *lengthp);
+/* Likewise, for a string that is surrounded by a prefix and a suffix.  */
+extern uint8_t *
+       u8_ct_casefold (const uint8_t *s, size_t n,
+                      casing_prefix_context_t prefix_context,
+                      casing_suffix_context_t suffix_context,
+                      const char *iso639_language,
+                      uninorm_t nf,
+                      uint8_t *resultbuf, size_t *lengthp);
+extern uint16_t *
+       u16_ct_casefold (const uint16_t *s, size_t n,
+                       casing_prefix_context_t prefix_context,
+                       casing_suffix_context_t suffix_context,
+                       const char *iso639_language,
+                       uninorm_t nf,
+                       uint16_t *resultbuf, size_t *lengthp);
+extern uint32_t *
+       u32_ct_casefold (const uint32_t *s, size_t n,
+                       casing_prefix_context_t prefix_context,
+                       casing_suffix_context_t suffix_context,
+                       const char *iso639_language,
+                       uninorm_t nf,
+                       uint32_t *resultbuf, size_t *lengthp);
 
 /* Compare S1 and S2, ignoring differences in case and normalization.
    The nf argument identifies the normalization form to apply after the
@@ -166,10 +321,14 @@ extern int
        u32_casecmp (const uint32_t *s1, size_t n1,
                    const uint32_t *s2, size_t n2,
                    const char *iso639_language, uninorm_t nf, int *resultp);
+extern int
+       ulc_casecmp (const char *s1, size_t n1,
+                   const char *s2, size_t n2,
+                   const char *iso639_language, uninorm_t nf, int *resultp);
 
-/* Converts the string S of length N to a string in locale encoding, in such a
-   way that comparing uN_casexfrm (S1) and uN_casexfrm (S2) with memcmp2() is
-   equivalent to comparing S1 and S2 with uN_casecoll().
+/* Convert the string S of length N to a NUL-terminated byte sequence, in such
+   a way that comparing uN_casexfrm (S1) and uN_casexfrm (S2) with the gnulib
+   function memcmp2() is equivalent to comparing S1 and S2 with uN_casecoll().
    NF must be either UNINORM_NFC, UNINORM_NFKC, or NULL for no normalization.  */
 extern char *
        u8_casexfrm (const uint8_t *s, size_t n, const char *iso639_language,
@@ -180,6 +339,9 @@ extern char *
 extern char *
        u32_casexfrm (const uint32_t *s, size_t n, const char *iso639_language,
                     uninorm_t nf, char *resultbuf, size_t *lengthp);
+extern char *
+       ulc_casexfrm (const char *s, size_t n, const char *iso639_language,
+                    uninorm_t nf, char *resultbuf, size_t *lengthp);
 
 /* Compare S1 and S2, ignoring differences in case and normalization, using the
    collation rules of the current locale.
@@ -200,6 +362,10 @@ extern int
        u32_casecoll (const uint32_t *s1, size_t n1,
                     const uint32_t *s2, size_t n2,
                     const char *iso639_language, uninorm_t nf, int *resultp);
+extern int
+       ulc_casecoll (const char *s1, size_t n1,
+                    const char *s2, size_t n2,
+                    const char *iso639_language, uninorm_t nf, int *resultp);
 
 
 /* Set *RESULTP to true if mapping NFD(S) to upper case is a no-op, or to false