5d5b1026494f584e0a20d208ede622298364d5be
[kopensolaris-gnu/glibc.git] / wcsmbs / bits / wchar2.h
1 /* Checking macros for wchar functions.
2    Copyright (C) 2005 Free Software Foundation, Inc.
3    This file is part of the GNU C Library.
4
5    The GNU C Library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU Lesser General Public
7    License as published by the Free Software Foundation; either
8    version 2.1 of the License, or (at your option) any later version.
9
10    The GNU C Library is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    Lesser General Public License for more details.
14
15    You should have received a copy of the GNU Lesser General Public
16    License along with the GNU C Library; if not, write to the Free
17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
18    02111-1307 USA.  */
19
20 #ifndef _WCHAR_H
21 # error "Never include <bits/wchar.h> directly; use <wchar.h> instead."
22 #endif
23
24
25 extern wchar_t *__wmemcpy_chk (wchar_t *__restrict __s1,
26                                __const wchar_t *__restrict __s2, size_t __n,
27                                size_t __ns1) __THROW;
28 extern wchar_t *__REDIRECT (__wmemcpy_alias, (wchar_t *__restrict __s1,
29                                               __const wchar_t *__restrict __s2,
30                                               size_t __n), wmemcpy) __THROW;
31
32 extern __always_inline wchar_t *
33 wmemcpy (wchar_t *__restrict __s1, __const wchar_t *__restrict __s2,
34          size_t __n)
35 {
36   if (__bos0 (__s1) != (size_t) -1)
37     return __wmemcpy_chk (__s1, __s2, __n, __bos0 (__s1) / sizeof (wchar_t));
38   return __wmemcpy_alias (__s1, __s2, __n);
39 }
40
41
42 extern wchar_t *__wmemmove_chk (wchar_t *__s1, __const wchar_t *__s2,
43                                 size_t __n, size_t __ns1) __THROW;
44 extern wchar_t *__REDIRECT (__wmemmove_alias, (wchar_t *__s1,
45                                                __const wchar_t *__s2,
46                                                size_t __n), wmemmove) __THROW;
47
48 extern __always_inline wchar_t *
49 wmemmove (wchar_t *__restrict __s1, __const wchar_t *__restrict __s2,
50           size_t __n)
51 {
52   if (__bos0 (__s1) != (size_t) -1)
53     return __wmemmove_chk (__s1, __s2, __n, __bos0 (__s1) / sizeof (wchar_t));
54   return __wmemmove_alias (__s1, __s2, __n);
55 }
56
57
58 #ifdef __USE_GNU
59 extern wchar_t *__wmempcpy_chk (wchar_t *__restrict __s1,
60                                 __const wchar_t *__restrict __s2, size_t __n,
61                                 size_t __ns1) __THROW;
62 extern wchar_t *__REDIRECT (__wmempcpy_alias,
63                             (wchar_t *__restrict __s1,
64                              __const wchar_t *__restrict __s2,
65                              size_t __n), wmempcpy) __THROW;
66
67 extern __always_inline wchar_t *
68 wmempcpy (wchar_t *__restrict __s1, __const wchar_t *__restrict __s2,
69           size_t __n)
70 {
71   if (__bos0 (__s1) != (size_t) -1)
72     return __wmempcpy_chk (__s1, __s2, __n, __bos0 (__s1) / sizeof (wchar_t));
73   return __wmempcpy_alias (__s1, __s2, __n);
74 }
75 #endif
76
77
78 extern wchar_t *__wmemset_chk (wchar_t *__s, wchar_t __c, size_t __n,
79                                size_t __ns) __THROW;
80 extern wchar_t *__REDIRECT (__wmemset_alias, (wchar_t *__s, wchar_t __c,
81                                               size_t __n), wmemset) __THROW;
82
83 extern __always_inline wchar_t *
84 wmemset (wchar_t *__restrict __s, wchar_t __c, size_t __n)
85 {
86   if (__bos0 (__s) != (size_t) -1)
87     return __wmemset_chk (__s, __c, __n, __bos0 (__s) / sizeof (wchar_t));
88   return __wmemset_alias (__s, __c, __n);
89 }
90
91
92 extern wchar_t *__wcscpy_chk (wchar_t *__restrict __dest,
93                               __const wchar_t *__restrict __src,
94                               size_t __n) __THROW;
95 extern wchar_t *__REDIRECT (__wcscpy_alias,
96                             (wchar_t *__restrict __dest,
97                              __const wchar_t *__restrict __src), wcscpy)
98   __THROW;
99
100 extern __always_inline wchar_t *
101 wcscpy (wchar_t *__dest, __const wchar_t *__src)
102 {
103   if (__bos (__dest) != (size_t) -1)
104     return __wcscpy_chk (__dest, __src, __bos (__dest) / sizeof (wchar_t));
105   return __wcscpy_alias (__dest, __src);
106 }
107
108
109 extern wchar_t *__wcpcpy_chk (wchar_t *__dest, __const wchar_t *__src,
110                               size_t __destlen) __THROW;
111 extern wchar_t *__REDIRECT (__wcpcpy_alias, (wchar_t *__dest,
112                                              __const wchar_t *__src), wcpcpy)
113   __THROW;
114
115 extern __always_inline wchar_t *
116 wcpcpy (wchar_t *__dest, __const wchar_t *__src)
117 {
118   if (__bos (__dest) != (size_t) -1)
119     return __wcpcpy_chk (__dest, __src, __bos (__dest) / sizeof (wchar_t));
120   return __wcpcpy_alias (__dest, __src);
121 }
122
123
124 extern wchar_t *__wcsncpy_chk (wchar_t *__restrict __dest,
125                                __const wchar_t *__restrict __src, size_t __n,
126                                size_t __destlen) __THROW;
127 extern wchar_t *__REDIRECT (__wcsncpy_alias,
128                             (wchar_t *__restrict __dest,
129                              __const wchar_t *__restrict __src, size_t __n),
130                             wcsncpy) __THROW;
131
132 extern __always_inline wchar_t *
133 wcsncpy (wchar_t *__dest, __const wchar_t *__src, size_t __n)
134 {
135   if (__bos (__dest) != (size_t) -1
136       && (!__builtin_constant_p (__n) || __bos (__dest) >= __n))
137     return __wcsncpy_chk (__dest, __src, __n,
138                           __bos (__dest) / sizeof (wchar_t));
139   return __wcsncpy_alias (__dest, __src, __n);
140 }
141
142
143 extern wchar_t *__wcpncpy_chk (wchar_t *__restrict __dest,
144                                __const wchar_t *__restrict __src, size_t __n,
145                                size_t __destlen) __THROW;
146 extern wchar_t *__REDIRECT (__wcpncpy_alias,
147                             (wchar_t *__restrict __dest,
148                              __const wchar_t *__restrict __src, size_t __n),
149                             wcpncpy) __THROW;
150
151 extern __always_inline wchar_t *
152 wcpncpy (wchar_t *__dest, __const wchar_t *__src, size_t __n)
153 {
154   if (__bos (__dest) != (size_t) -1
155       && (!__builtin_constant_p (__n) || __bos (__dest) >= __n))
156     return __wcpncpy_chk (__dest, __src, __n,
157                           __bos (__dest) / sizeof (wchar_t));
158   return __wcpncpy_alias (__dest, __src, __n);
159 }
160
161
162 extern wchar_t *__wcscat_chk (wchar_t *__restrict __dest,
163                               __const wchar_t *__restrict __src,
164                               size_t __destlen) __THROW;
165 extern wchar_t *__REDIRECT (__wcscat_alias,
166                             (wchar_t *__restrict __dest,
167                              __const wchar_t *__restrict __src), wcscat)
168   __THROW;
169
170 extern __always_inline wchar_t *
171 wcscat (wchar_t *__dest, __const wchar_t *__src)
172 {
173   if (__bos (__dest) != (size_t) -1)
174     return __wcscat_chk (__dest, __src, __bos (__dest) / sizeof (wchar_t));
175   return __wcscat_alias (__dest, __src);
176 }
177
178
179 extern wchar_t *__wcsncat_chk (wchar_t *__restrict __dest,
180                                __const wchar_t *__restrict __src,
181                                size_t __n, size_t __destlen) __THROW;
182 extern wchar_t *__REDIRECT (__wcsncat_alias,
183                             (wchar_t *__restrict __dest,
184                              __const wchar_t *__restrict __src, size_t __n),
185                             wcsncat) __THROW;
186
187 extern __always_inline wchar_t *
188 wcsncat (wchar_t *__dest, __const wchar_t *__src, size_t __n)
189 {
190   if (__bos (__dest) != (size_t) -1)
191     return __wcsncat_chk (__dest, __src, __n,
192                           __bos (__dest) / sizeof (wchar_t));
193   return __wcsncat_alias (__dest, __src, __n);
194 }
195
196
197 extern int __swprintf_chk (wchar_t *__restrict __s, size_t __n,
198                            int __flag, size_t __s_len,
199                            __const wchar_t *__restrict __format, ...)
200      __THROW /* __attribute__ ((__format__ (__wprintf__, 5, 6))) */;
201
202 /* XXX We might want to have support in gcc for swprintf.  */
203 #define swprintf(s, n, format, ...) \
204   (__bos (s) != (size_t) -1 || __USE_FORTIFY_LEVEL > 1                        \
205    ? __swprintf_chk (s, n, __USE_FORTIFY_LEVEL - 1, __bos (s), format,        \
206                      __VA_ARGS__)                                             \
207    : swprintf (s, n, format, __VA_ARGS__))
208
209
210 extern int __vswprintf_chk (wchar_t *__restrict __s, size_t __n,
211                             int __flag, size_t __s_len,
212                             __const wchar_t *__restrict __format,
213                             __gnuc_va_list __arg)
214      __THROW /* __attribute__ ((__format__ (__wprintf__, 5, 0))) */;
215 extern int __REDIRECT (__vswprintf_alias,
216                        (wchar_t *__restrict __s, size_t __n,
217                         __const wchar_t *__restrict __format,
218                         __gnuc_va_list __arg), vswprintf)
219      __THROW /* __attribute__ ((__format__ (__wprintf__, 3, 0))) */;
220
221
222 extern __always_inline int
223 vswprintf (wchar_t *__s, size_t __n, __const wchar_t *__format,
224            __gnuc_va_list __arg)
225 {
226   if (__bos (__s) != (size_t) -1 || __USE_FORTIFY_LEVEL > 1)
227     return __vswprintf_chk (__s, __n, __USE_FORTIFY_LEVEL - 1, __bos (__s),
228                             __format, __arg);
229   return vswprintf (__s, __n, __format, __arg);
230 }
231
232
233 #if __USE_FORTIFY_LEVEL > 1
234
235 extern int __fwprintf_chk (FILE *__restrict __stream, int __flag,
236                            __const wchar_t *__restrict __format, ...);
237 extern int __wprintf_chk (int __flag, __const wchar_t *__restrict __format,
238                           ...);
239 extern int __vfwprintf_chk (FILE *__restrict __stream, int __flag,
240                             __const wchar_t *__restrict __format,
241                             _G_va_list __ap);
242 extern int __vwprintf_chk (int __flag, __const wchar_t *__restrict __format,
243                            _G_va_list __ap);
244
245 # define wprintf(...) \
246   __wprintf_chk (__USE_FORTIFY_LEVEL - 1, __VA_ARGS__)
247 # define fwprintf(stream, ...) \
248   __fwprintf_chk (stream, __USE_FORTIFY_LEVEL - 1, __VA_ARGS__)
249 # define vwprintf(format, ap) \
250   __vwprintf_chk (__USE_FORTIFY_LEVEL - 1, format, ap)
251 # define vfwprintf(stream, format, ap) \
252   __vfwprintf_chk (stream, __USE_FORTIFY_LEVEL - 1, format, ap)
253
254 #endif
255
256 extern wchar_t *__fgetws_chk (wchar_t *__restrict __s, size_t __size, int __n,
257                               FILE *__restrict __stream) __wur;
258 extern wchar_t *__REDIRECT (__fgetws_alias,
259                             (wchar_t *__restrict __s, int __n,
260                              FILE *__restrict __stream), fgetws) __wur;
261
262 extern __always_inline __wur wchar_t *
263 fgetws (wchar_t *__restrict __s, int __n, FILE *__restrict __stream)
264 {
265   if (__bos (__s) != (size_t) -1
266       && (!__builtin_constant_p (__n) || (size_t) __n > __bos (__s)))
267     return __fgetws_chk (__s, __bos (__s), __n, __stream);
268   return __fgetws_alias (__s, __n, __stream);
269 }
270
271 #ifdef __USE_GNU
272 extern wchar_t *__fgetws_unlocked_chk (wchar_t *__restrict __s, size_t __size,
273                                        int __n, FILE *__restrict __stream)
274   __wur;
275 extern wchar_t *__REDIRECT (__fgetws_unlocked_alias,
276                             (wchar_t *__restrict __s, int __n,
277                              FILE *__restrict __stream), fgetws_unlocked)
278   __wur;
279
280 extern __always_inline __wur wchar_t *
281 fgetws_unlocked (wchar_t *__restrict __s, int __n, FILE *__restrict __stream)
282 {
283   if (__bos (__s) != (size_t) -1
284       && (!__builtin_constant_p (__n) || (size_t) __n > __bos (__s)))
285     return __fgetws_unlocked_chk (__s, __bos (__s), __n, __stream);
286   return __fgetws_unlocked_alias (__s, __n, __stream);
287 }
288 #endif