lib/libc/locale/collate.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright 2010 Nexenta Systems, Inc.  All rights reserved.
   5  * Copyright (c) 1995 Alex Tatmanjants <alex@elvisti.kiev.ua>
   6  *              at Electronni Visti IA, Kiev, Ukraine.
   7  *                      All rights reserved.
   8  *
   9  * Copyright (c) 2011 The FreeBSD Foundation
  10  * All rights reserved.
  11  * Portions of this software were developed by David Chisnall
  12  * under sponsorship from the FreeBSD Foundation.
  13  *
  14  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions
  16  * are met:
  17  * 1. Redistributions of source code must retain the above copyright
  18  *    notice, this list of conditions and the following disclaimer.
  19  * 2. Redistributions in binary form must reproduce the above copyright
  20  *    notice, this list of conditions and the following disclaimer in the
  21  *    documentation and/or other materials provided with the distribution.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  *
  35  * $FreeBSD$
  36  */
  37
  38 #ifndef _COLLATE_H_
  39 #define _COLLATE_H_
  40
  41 #include <sys/cdefs.h>
  42 #include <sys/types.h>
  43 #include <limits.h>
  44 #include "xlocale_private.h"
  45
  46 /*
  47  * Work around buildworld bootstrapping from older systems whose limits.h
  48  * sets COLL_WEIGHTS_MAX to 0.
  49  */
  50 #if COLL_WEIGHTS_MAX == 0
  51 #undef COLL_WEIGHTS_MAX
  52 #define COLL_WEIGHTS_MAX 10
  53 #endif
  54
  55 #define COLLATE_STR_LEN         24              /* should be 64-bit multiple */
  56
  57 #define COLLATE_FMT_VERSION_LEN 12
  58 #define COLLATE_FMT_VERSION     "BSD 1.0\n"
  59
  60 #define COLLATE_MAX_PRIORITY    (0x7fffffff)    /* max signed value */
  61 #define COLLATE_SUBST_PRIORITY  (0x40000000)    /* bit indicates subst table */
  62
  63 #define DIRECTIVE_UNDEF         0x00
  64 #define DIRECTIVE_FORWARD       0x01
  65 #define DIRECTIVE_BACKWARD      0x02
  66 #define DIRECTIVE_POSITION      0x04
  67 #define DIRECTIVE_UNDEFINED     0x08    /* special last weight for UNDEFINED */
  68
  69 #define DIRECTIVE_DIRECTION_MASK (DIRECTIVE_FORWARD | DIRECTIVE_BACKWARD)
  70
  71 /*
  72  * The collate file format is as follows:
  73  *
  74  * char fmt_version[COLLATE_FMT_VERSION_LEN];   // must be COLLATE_FMT_VERSION
  75  * char def_version[XLOCALE_DEF_VERSION_LEN];   // NUL-terminated, may be empty
  76  * collate_info_t       info;                   // see below, includes padding
  77  * collate_char_pri_t   char_data[256];         // 8 bit char values
  78  * collate_subst_t      subst[*];               // 0 or more substitutions
  79  * collate_chain_pri_t  chains[*];              // 0 or more chains
  80  * collate_large_pri_t  large[*];               // extended char priorities
  81  *
  82  * Note that all structures must be 32-bit aligned, as each structure
  83  * contains 32-bit member fields.  The entire file is mmap'd, so its
  84  * critical that alignment be observed.  It is not generally safe to
  85  * use any 64-bit values in the structures.
  86  */
  87
  88 typedef struct collate_info {
  89         uint8_t directive_count;
  90         uint8_t directive[COLL_WEIGHTS_MAX];
  91         int32_t pri_count[COLL_WEIGHTS_MAX];
  92         int32_t flags;
  93         int32_t chain_count;
  94         int32_t large_count;
  95         int32_t subst_count[COLL_WEIGHTS_MAX];
  96         int32_t undef_pri[COLL_WEIGHTS_MAX];
  97 } collate_info_t;
  98
  99 typedef struct collate_char {
 100         int32_t pri[COLL_WEIGHTS_MAX];
 101 } collate_char_t;
 102
 103 typedef struct collate_chain {
 104         wchar_t str[COLLATE_STR_LEN];
 105         int32_t pri[COLL_WEIGHTS_MAX];
 106 } collate_chain_t;
 107
 108 typedef struct collate_large {
 109         int32_t val;
 110         collate_char_t pri;
 111 } collate_large_t;
 112
 113 typedef struct collate_subst {
 114         int32_t key;
 115         int32_t pri[COLLATE_STR_LEN];
 116 } collate_subst_t;
 117
 118 struct xlocale_collate {
 119         struct xlocale_component header;
 120         int __collate_load_error;
 121         char * map;
 122         size_t maplen;
 123
 124         collate_info_t  *info;
 125         collate_char_t  *char_pri_table;
 126         collate_large_t *large_pri_table;
 127         collate_chain_t *chain_pri_table;
 128         collate_subst_t *subst_table[COLL_WEIGHTS_MAX];
 129 };
 130
 131 __BEGIN_DECLS
 132 int     __collate_load_tables(const char *);
 133 int     __collate_equiv_value(locale_t, const wchar_t *, size_t);
 134 void    _collate_lookup(struct xlocale_collate *,const wchar_t *, int *, int *,
 135         int, const int **);
 136 int     __collate_range_cmp(char, char);
 137 int     __wcollate_range_cmp(wchar_t, wchar_t);
 138 size_t  _collate_wxfrm(struct xlocale_collate *, const wchar_t *, wchar_t *,
 139         size_t);
 140 size_t  _collate_sxfrm(struct xlocale_collate *, const wchar_t *, char *,
 141         size_t);
 142 __END_DECLS
 143
 144 #endif /* !_COLLATE_H_ */