summaryrefslogtreecommitdiff
path: root/StdLib/LibC/Locale/runetype.h
blob: 2cd563e103a132d9921650a3657455e742c0a509 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
/*  $NetBSD: runetype.h,v 1.19 2005/11/29 03:11:59 christos Exp $ */

/*-
 * Copyright (c) 1993
 *  The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Paul Borman at Krystal Technologies.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *  @(#)runetype.h  8.1 (Berkeley) 6/2/93
 */
#ifndef _NB_RUNETYPE_H_
#define _NB_RUNETYPE_H_

#include  <sys/EfiCdefs.h>
#include <sys/types.h>

/* for cross host tools on older systems */
#ifndef UINT32_C
/* assumes sizeof(unsigned int)>=4 */
#define UINT32_C(c) ((uint32_t)(c##U))
#endif

typedef uint32_t  __nbrune_t;
typedef uint64_t  __runepad_t;

#define _NB_CACHED_RUNES  (1 << 8)  /* Must be a power of 2 */
#define _NB_RUNE_ISCACHED(c)  ((c)>=0 && (c)<_CACHED_RUNES)

#define _NB_DEFAULT_INVALID_RUNE ((__nbrune_t)-3)

/*
 * The lower 8 bits of runetype[] contain the digit value of the rune.
 */
typedef uint32_t _RuneType;
#define _RUNETYPE_A UINT32_C(0x00000100)  /* Alpha */
#define _RUNETYPE_C UINT32_C(0x00000200)  /* Control */
#define _RUNETYPE_D UINT32_C(0x00000400)  /* Digit */
#define _RUNETYPE_G UINT32_C(0x00000800)  /* Graph */
#define _RUNETYPE_L UINT32_C(0x00001000)  /* Lower */
#define _RUNETYPE_P UINT32_C(0x00002000)  /* Punct */
#define _RUNETYPE_S UINT32_C(0x00004000)  /* Space */
#define _RUNETYPE_U UINT32_C(0x00008000)  /* Upper */
#define _RUNETYPE_X UINT32_C(0x00010000)  /* X digit */
#define _RUNETYPE_B UINT32_C(0x00020000)  /* Blank */
#define _RUNETYPE_R UINT32_C(0x00040000)  /* Print */
#define _RUNETYPE_I UINT32_C(0x00080000)  /* Ideogram */
#define _RUNETYPE_T UINT32_C(0x00100000)  /* Special */
#define _RUNETYPE_Q UINT32_C(0x00200000)  /* Phonogram */
#define _RUNETYPE_SWM UINT32_C(0xc0000000)/* Mask to get screen width data */
#define _RUNETYPE_SWS 30    /* Bits to shift to get width */
#define _RUNETYPE_SW0 UINT32_C(0x00000000)  /* 0 width character */
#define _RUNETYPE_SW1 UINT32_C(0x40000000)  /* 1 width character */
#define _RUNETYPE_SW2 UINT32_C(0x80000000)  /* 2 width character */
#define _RUNETYPE_SW3 UINT32_C(0xc0000000)  /* 3 width character */


/*
 * rune file format.  network endian.
 */
typedef struct {
  int32_t   fre_min;  /* First rune of the range */
  int32_t   fre_max;  /* Last rune (inclusive) of the range */
  int32_t   fre_map;  /* What first maps to in maps */
  uint32_t  fre_pad1; /* backward compatibility */
  __runepad_t fre_pad2; /* backward compatibility */
} __attribute__((__packed__)) _FileRuneEntry;


typedef struct {
  uint32_t  frr_nranges;  /* Number of ranges stored */
  uint32_t  frr_pad1; /* backward compatibility */
  __runepad_t frr_pad2; /* backward compatibility */
} __attribute__((__packed__)) _FileRuneRange;


typedef struct {
  char    frl_magic[8]; /* Magic saying what version we are */
  char    frl_encoding[32];/* ASCII name of this encoding */

  __runepad_t frl_pad1; /* backward compatibility */
  __runepad_t frl_pad2; /* backward compatibility */
  int32_t   frl_invalid_rune;
  uint32_t  frl_pad3; /* backward compatibility */

  _RuneType frl_runetype[_NB_CACHED_RUNES];
  int32_t   frl_maplower[_NB_CACHED_RUNES];
  int32_t   frl_mapupper[_NB_CACHED_RUNES];

  /*
   * The following are to deal with Runes larger than _CACHED_RUNES - 1.
   * Their data is actually contiguous with this structure so as to make
   * it easier to read/write from/to disk.
   */
  _FileRuneRange  frl_runetype_ext;
  _FileRuneRange  frl_maplower_ext;
  _FileRuneRange  frl_mapupper_ext;

  __runepad_t frl_pad4; /* backward compatibility */
  int32_t   frl_variable_len;/* how long that data is */
  uint32_t  frl_pad5; /* backward compatibility */

  /* variable size data follows */
} __attribute__((__packed__)) _FileRuneLocale;


/*
 * expanded rune locale declaration.  local to the host.  host endian.
 */
typedef struct {
  __nbrune_t  re_min;   /* First rune of the range */
  __nbrune_t  re_max;   /* Last rune (inclusive) of the range */
  __nbrune_t  re_map;   /* What first maps to in maps */
  _RuneType *re_rune_types; /* Array of types in range */
} _NBRuneEntry;


typedef struct {
  uint32_t  rr_nranges; /* Number of ranges stored */
  _NBRuneEntry  *rr_rune_ranges;
} _NBRuneRange;


/*
 * wctrans stuffs.
 */
typedef struct _WCTransEntry {
  const char  *te_name;
  __nbrune_t  *te_cached;
  _NBRuneRange  *te_extmap;
} _WCTransEntry;
#define _WCTRANS_INDEX_LOWER  0
#define _WCTRANS_INDEX_UPPER  1
#define _WCTRANS_NINDEXES 2

/*
 * wctype stuffs.
 */
typedef struct _WCTypeEntry {
  const char  *te_name;
  _RuneType te_mask;
} _WCTypeEntry;
#define _WCTYPE_INDEX_ALNUM 0
#define _WCTYPE_INDEX_ALPHA 1
#define _WCTYPE_INDEX_BLANK 2
#define _WCTYPE_INDEX_CNTRL 3
#define _WCTYPE_INDEX_DIGIT 4
#define _WCTYPE_INDEX_GRAPH 5
#define _WCTYPE_INDEX_LOWER 6
#define _WCTYPE_INDEX_PRINT 7
#define _WCTYPE_INDEX_PUNCT 8
#define _WCTYPE_INDEX_SPACE 9
#define _WCTYPE_INDEX_UPPER 10
#define _WCTYPE_INDEX_XDIGIT  11
#define _WCTYPE_NINDEXES  12

/*
 * ctype stuffs
 */

typedef struct _NBRuneLocale {
  /*
   * copied from _FileRuneLocale
   */
  char    rl_magic[8];  /* Magic saying what version we are */
  char    rl_encoding[32];/* ASCII name of this encoding */
  __nbrune_t  rl_invalid_rune;
  _RuneType rl_runetype[_NB_CACHED_RUNES];
  __nbrune_t  rl_maplower[_NB_CACHED_RUNES];
  __nbrune_t  rl_mapupper[_NB_CACHED_RUNES];
  _NBRuneRange  rl_runetype_ext;
  _NBRuneRange  rl_maplower_ext;
  _NBRuneRange  rl_mapupper_ext;

  void    *rl_variable;
  size_t    rl_variable_len;

  /*
   * the following portion is generated on the fly
   */
  const char      *rl_codeset;
  struct _citrus_ctype_rec  *rl_citrus_ctype;
  _WCTransEntry     rl_wctrans[_WCTRANS_NINDEXES];
  _WCTypeEntry      rl_wctype[_WCTYPE_NINDEXES];
} _NBRuneLocale;


/* magic number for LC_CTYPE (rune)locale declaration */
#define _NB_RUNE_MAGIC_1 "RuneCT10" /* Indicates version 0 of RuneLocale */

/* magic string for dynamic link module - type should be like "LC_CTYPE" */
#define _NB_RUNE_MODULE_1(type) "RuneModule10." type

/* codeset tag */
#define _NB_RUNE_CODESET "CODESET="

#endif  /* !_NB_RUNETYPE_H_ */