Explicitly mention in RETURN VALUES that socket() sets
[dragonfly.git] / include / runetype.h
1 /*-
2  * Copyright (c) 1993
3  *      The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Paul Borman at Krystal Technologies.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *      This product includes software developed by the University of
19  *      California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *      @(#)runetype.h  8.1 (Berkeley) 6/2/93
37  * $FreeBSD: src/include/runetype.h,v 1.3.8.1 2002/08/08 02:42:29 imp Exp $
38  * $DragonFly: src/include/Attic/runetype.h,v 1.5 2003/11/15 19:28:42 asmodai Exp $
39  */
40
41 #ifndef _RUNETYPE_H_
42 #define _RUNETYPE_H_
43
44 #include <sys/cdefs.h>
45 #ifndef _SYS_STDINT_H_
46 #include <sys/stdint.h> /* for __rune_t and friends */
47 #endif
48
49 #ifndef _RUNE_T_DECLARED
50 #define _RUNE_T_DECLARED
51 typedef __rune_t        rune_t;
52 #endif
53 #ifndef __cplusplus
54 #ifndef _WCHAR_T_DECLARED
55 #define _WCHAR_T_DECLARED
56 typedef __wchar_t       wchar_t;
57 #endif
58 #endif
59
60 #define _CACHED_RUNES   (1 <<8 )        /* Must be a power of 2 */
61 #define _CRMASK         (~(_CACHED_RUNES - 1))
62
63 /*
64  * The lower 8 bits of runetype[] contain the digit value of the rune.
65  */
66 typedef struct {
67         rune_t          min;            /* First rune of the range */
68         rune_t          max;            /* Last rune (inclusive) of the range */
69         rune_t          map;            /* What first maps to in maps */
70         unsigned long   *types;         /* Array of types in range */
71 } _RuneEntry;
72
73 typedef struct {
74         int             nranges;        /* Number of ranges stored */
75         _RuneEntry      *ranges;        /* Pointer to the ranges */
76 } _RuneRange;
77
78 typedef struct {
79         char            magic[8];       /* Magic saying what version we are */
80         char            encoding[32];   /* ASCII name of this encoding */
81
82         rune_t          (*sgetrune)
83             (const char *, __size_t, char const **);
84         int             (*sputrune)
85             (rune_t, char *, __size_t, char **);
86         rune_t          invalid_rune;
87
88         unsigned long   runetype[_CACHED_RUNES];
89         rune_t          maplower[_CACHED_RUNES];
90         rune_t          mapupper[_CACHED_RUNES];
91
92         /*
93          * The following are to deal with Runes larger than _CACHED_RUNES - 1.
94          * Their data is actually contiguous with this structure so as to make
95          * it easier to read/write from/to disk.
96          */
97         _RuneRange      runetype_ext;
98         _RuneRange      maplower_ext;
99         _RuneRange      mapupper_ext;
100
101         void            *variable;      /* Data which depends on the encoding */
102         int             variable_len;   /* how long that data is */
103 } _RuneLocale;
104
105 #define _RUNE_MAGIC_1   "RuneMagi"      /* Indicates version 0 of RuneLocale */
106
107 extern _RuneLocale _DefaultRuneLocale;
108 extern _RuneLocale *_CurrentRuneLocale;
109
110 #endif  /* !_RUNETYPE_H_ */