include/wchar.h

   1 /*      $NetBSD: src/include/wchar.h,v 1.20 2004/05/08 21:57:05 kleink Exp $    */
   2 /*      $DragonFly: src/include/wchar.h,v 1.12 2008/06/05 17:53:10 swildner Exp $ */
   3
   4 /*-
   5  * Copyright (c)1999 Citrus Project,
   6  * All rights reserved.
   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  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 /*-
  31  * Copyright (c) 1999, 2000 The NetBSD Foundation, Inc.
  32  * All rights reserved.
  33  *
  34  * This code is derived from software contributed to The NetBSD Foundation
  35  * by Julian Coleman.
  36  *
  37  * Redistribution and use in source and binary forms, with or without
  38  * modification, are permitted provided that the following conditions
  39  * are met:
  40  * 1. Redistributions of source code must retain the above copyright
  41  *    notice, this list of conditions and the following disclaimer.
  42  * 2. Redistributions in binary form must reproduce the above copyright
  43  *    notice, this list of conditions and the following disclaimer in the
  44  *    documentation and/or other materials provided with the distribution.
  45  * 3. All advertising materials mentioning features or use of this software
  46  *    must display the following acknowledgement:
  47  *        This product includes software developed by the NetBSD
  48  *        Foundation, Inc. and its contributors.
  49  * 4. Neither the name of The NetBSD Foundation nor the names of its
  50  *    contributors may be used to endorse or promote products derived
  51  *    from this software without specific prior written permission.
  52  *
  53  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  54  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  55  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  56  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  57  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  58  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  59  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  60  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  61  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  62  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  63  * POSSIBILITY OF SUCH DAMAGE.
  64  */
  65
  66 #ifndef _WCHAR_H_
  67 #define _WCHAR_H_
  68
  69 #include <sys/stdint.h>
  70 /* XXX namespace pollution */
  71 #include <machine/limits.h>
  72
  73 #include <stdio.h> /* for FILE* */
  74 #include <sys/_null.h>
  75
  76 #ifndef _WCHAR_T_DECLARED
  77 #define _WCHAR_T_DECLARED
  78 typedef __wchar_t       wchar_t;
  79 #endif
  80
  81 #ifndef WCHAR_MIN
  82 #define WCHAR_MIN       INT_MIN
  83 #endif
  84
  85 #ifndef WCHAR_MAX
  86 #define WCHAR_MAX       INT_MAX
  87 #endif
  88
  89 #ifndef _WINT_T_DECLARED
  90 #define _WINT_T_DECLARED
  91 typedef __wint_t        wint_t;
  92 #endif
  93
  94 #ifndef WINT_MIN
  95 #define WINT_MIN        INT_MIN
  96 #endif
  97
  98 #ifndef WINT_MAX
  99 #define WINT_MAX        INT_MAX
 100 #endif
 101
 102 #ifndef _MBSTATE_T_DECLARED
 103 #define _MBSTATE_T_DECLARED
 104 typedef __mbstate_t     mbstate_t;
 105 #endif
 106
 107 #ifndef _SIZE_T_DECLARED
 108 #define _SIZE_T_DECLARED
 109 typedef __size_t        size_t;
 110 #endif
 111
 112 #ifndef WEOF
 113 #define WEOF    ((wint_t)(-1))
 114 #endif
 115
 116 struct tm;
 117
 118 __BEGIN_DECLS
 119 wint_t  btowc(int);
 120 size_t  mbrlen(const char * __restrict, size_t, mbstate_t * __restrict);
 121 size_t  mbrtowc(wchar_t * __restrict, const char * __restrict, size_t,
 122             mbstate_t * __restrict);
 123 int     mbsinit(const mbstate_t *);
 124 size_t  mbsrtowcs(wchar_t * __restrict, const char ** __restrict, size_t,
 125             mbstate_t * __restrict);
 126 size_t  wcrtomb(char * __restrict, wchar_t, mbstate_t * __restrict);
 127 wchar_t *wcscat(wchar_t * __restrict, const wchar_t * __restrict);
 128 wchar_t *wcschr(const wchar_t *, wchar_t);
 129 int     wcscmp(const wchar_t *, const wchar_t *);
 130 int     wcscoll(const wchar_t *, const wchar_t *);
 131 wchar_t *wcscpy(wchar_t * __restrict, const wchar_t * __restrict);
 132 size_t  wcscspn(const wchar_t *, const wchar_t *);
 133 size_t  wcsftime(wchar_t * __restrict, size_t, const wchar_t * __restrict,
 134                  const struct tm * __restrict);
 135 size_t  wcslen(const wchar_t *);
 136 wchar_t *wcsncat(wchar_t * __restrict, const wchar_t * __restrict, size_t);
 137 int     wcsncmp(const wchar_t *, const wchar_t *, size_t);
 138 wchar_t *wcsncpy(wchar_t * __restrict , const wchar_t * __restrict, size_t);
 139 size_t   wcsnlen(const wchar_t *, size_t) __pure;
 140 wchar_t *wcspbrk(const wchar_t *, const wchar_t *);
 141 wchar_t *wcsrchr(const wchar_t *, wchar_t);
 142 size_t  wcsrtombs(char * __restrict, const wchar_t ** __restrict, size_t,
 143                   mbstate_t * __restrict);
 144 size_t  wcsspn(const wchar_t *, const wchar_t *);
 145 wchar_t *wcsstr(const wchar_t *, const wchar_t *);
 146 wchar_t *wcstok(wchar_t * __restrict, const wchar_t * __restrict,
 147                 wchar_t ** __restrict);
 148 size_t  wcsxfrm(wchar_t *, const wchar_t *, size_t);
 149 wchar_t *wcswcs(const wchar_t *, const wchar_t *);
 150 wchar_t *wmemchr(const wchar_t *, wchar_t, size_t);
 151 int     wmemcmp(const wchar_t *, const wchar_t *, size_t);
 152 wchar_t *wmemcpy(wchar_t * __restrict, const wchar_t * __restrict, size_t);
 153 wchar_t *wmemmove(wchar_t *, const wchar_t *, size_t);
 154 wchar_t *wmemset(wchar_t *, wchar_t, size_t);
 155
 156 size_t  wcslcat(wchar_t *, const wchar_t *, size_t);
 157 size_t  wcslcpy(wchar_t *, const wchar_t *, size_t);
 158 int     wcswidth(const wchar_t *, size_t);
 159 int     wctob(wint_t);
 160 int     wcwidth(wchar_t);
 161
 162 unsigned long wcstoul(const wchar_t * __restrict, wchar_t ** __restrict, int);
 163 long    wcstol(const wchar_t * __restrict, wchar_t ** __restrict, int);
 164 double  wcstod(const wchar_t * __restrict, wchar_t ** __restrict);
 165
 166 #if __ISO_C_VISIBLE >= 1999 || __DF_VISIBLE
 167 float   wcstof(const wchar_t * __restrict, wchar_t ** __restrict);
 168 long double wcstold(const wchar_t * __restrict, wchar_t ** __restrict);
 169
 170 /* LONGLONG */
 171 long long wcstoll(const wchar_t * __restrict, wchar_t ** __restrict, int);
 172 /* LONGLONG */
 173 unsigned long long wcstoull(const wchar_t * __restrict,
 174                             wchar_t ** __restrict, int);
 175 #endif
 176
 177 wint_t  ungetwc(wint_t, FILE *);
 178 wint_t  fgetwc(FILE *);
 179 wchar_t *fgetws(wchar_t * __restrict, int, FILE * __restrict);
 180 wint_t  getwc(FILE *);
 181 wint_t  getwchar(void);
 182 wint_t  fputwc(wchar_t, FILE *);
 183 int     fputws(const wchar_t * __restrict, FILE * __restrict);
 184 wint_t  putwc(wchar_t, FILE *);
 185 wint_t  putwchar(wchar_t);
 186
 187 int     fwide(FILE *, int);
 188
 189 wchar_t *fgetwln(FILE * __restrict, size_t * __restrict);
 190 int     fwprintf(FILE * __restrict, const wchar_t * __restrict, ...);
 191 int     fwscanf(FILE * __restrict, const wchar_t * __restrict, ...);
 192 int     swprintf(wchar_t * __restrict, size_t n,
 193                  const wchar_t * __restrict, ...);
 194 int     swscanf(const wchar_t * __restrict, const wchar_t * __restrict, ...);
 195 int     vfwprintf(FILE * __restrict, const wchar_t * __restrict, __va_list);
 196 int     vswprintf(wchar_t * __restrict, size_t, const wchar_t * __restrict,
 197               __va_list);
 198 int     vwprintf(const wchar_t * __restrict, __va_list);
 199 int     wprintf(const wchar_t * __restrict, ...);
 200 int     wscanf(const wchar_t * __restrict, ...);
 201 #if __ISO_C_VISIBLE >= 1999 || __DF_VISIBLE
 202 int     vfwscanf(FILE * __restrict, const wchar_t * __restrict, __va_list);
 203 int     vswscanf(const wchar_t * __restrict, const wchar_t * __restrict,
 204                  __va_list);
 205 int     vwscanf(const wchar_t * __restrict, __va_list);
 206 #endif
 207 __END_DECLS
 208
 209 #define getwc(f) fgetwc(f)
 210 #define getwchar() getwc(stdin)
 211 #define putwc(wc, f) fputwc((wc), (f))
 212 #define putwchar(wc) putwc((wc), stdout)
 213
 214 #endif /* !_WCHAR_H_ */