epoc32/include/stdapis/wchar.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*-
     2  * Copyright (c)1999 Citrus Project,
     3  * All rights reserved.
     4  *
     5  * Redistribution and use in source and binary forms, with or without
     6  * modification, are permitted provided that the following conditions
     7  * are met:
     8  * 1. Redistributions of source code must retain the above copyright
     9  *    notice, this list of conditions and the following disclaimer.
    10  * 2. Redistributions in binary form must reproduce the above copyright
    11  *    notice, this list of conditions and the following disclaimer in the
    12  *    documentation and/or other materials provided with the distribution.
    13  *
    14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
    15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
    18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    24  * SUCH DAMAGE.
    25  *
    26  * $FreeBSD: src/include/wchar.h,v 1.45 2004/08/12 12:19:10 tjr Exp $
    27  *
    28  * © Portions Copyright (c) 2006-2007 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
    29  */
    30 
    31 /*-
    32  * Copyright (c) 1999, 2000 The NetBSD Foundation, Inc.
    33  * All rights reserved.
    34  *
    35  * This code is derived from software contributed to The NetBSD Foundation
    36  * by Julian Coleman.
    37  *
    38  * Redistribution and use in source and binary forms, with or without
    39  * modification, are permitted provided that the following conditions
    40  * are met:
    41  * 1. Redistributions of source code must retain the above copyright
    42  *    notice, this list of conditions and the following disclaimer.
    43  * 2. Redistributions in binary form must reproduce the above copyright
    44  *    notice, this list of conditions and the following disclaimer in the
    45  *    documentation and/or other materials provided with the distribution.
    46  * 4. Neither the name of The NetBSD Foundation nor the names of its
    47  *    contributors may be used to endorse or promote products derived
    48  *    from this software without specific prior written permission.
    49  *
    50  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
    51  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
    52  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
    53  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
    54  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    55  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    56  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    57  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    58  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    59  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    60  * POSSIBILITY OF SUCH DAMAGE.
    61  *
    62  *	$NetBSD: wchar.h,v 1.8 2000/12/22 05:31:42 itojun Exp $
    63  */
    64 
    65 #ifndef _WCHAR_H_
    66 #define _WCHAR_H_
    67 
    68 #ifdef __cplusplus
    69 extern "C"
    70 {
    71 #endif //__cplusplus
    72 
    73 #include <sys/cdefs.h>
    74 #include <sys/_null.h>
    75 #include <sys/_types.h>
    76 #include <sys/stat.h>
    77 #include <stdapis/machine/_limits.h>
    78 #include <_ctype.h>
    79 #include <_ansi.h>
    80 #include <stdio.h>
    81 #include <sys/dirent.h>
    82 #ifdef __SYMBIAN32__
    83 #include <stdarg.h>
    84 #endif //__SYMBIAN32__
    85 
    86 #ifndef _MBSTATE_T_DECLARED
    87 typedef	__mbstate_t	mbstate_t;
    88 #define	_MBSTATE_T_DECLARED
    89 #endif
    90 
    91 #ifndef _SIZE_T_DECLARED
    92 typedef	__size_t	size_t;
    93 #define	_SIZE_T_DECLARED
    94 #endif
    95 
    96 #ifndef __SYMBIAN32__
    97 #ifndef	__cplusplus
    98 #ifndef _WCHAR_T_DECLARED
    99 typedef	__wchar_t	wchar_t;
   100 #define	_WCHAR_T_DECLARED
   101 #endif //_WCHAR_T_DECLARED
   102 #endif //__cplusplus
   103 #else //__SYMBIAN32__
   104 //C++ built-in wchar data type which doesn't clash with the definition of wchar
   105 #if !defined _WCHAR_T_DECLARED && defined __cplusplus && defined __WINSCW__
   106 #if __option(wchar_type)
   107 #define	_WCHAR_T_DECLARED
   108 #endif //__option (wchar_type)
   109 #endif //__WINSCW__
   110 
   111 #if !defined _WCHAR_T_DECLARED && !defined __wchar_t_defined
   112 #if defined __cplusplus
   113 #if defined __WINSCW__
   114 typedef unsigned short int wchar_t;
   115 #define	_WCHAR_T_DECLARED
   116 #endif // __WINSCW__
   117 #else
   118 typedef unsigned short int wchar_t;
   119 #define	_WCHAR_T_DECLARED
   120 #endif // __cplusplus 
   121 #endif // __wchar_t_defined
   122 #endif //__SYMBIAN32__
   123 
   124 #ifndef _WINT_T_DECLARED
   125 typedef	__wint_t	wint_t;
   126 #define	_WINT_T_DECLARED
   127 #endif
   128 
   129 #ifndef	WCHAR_MIN 
   130 #define	WCHAR_MIN	(wchar_t)__INT_MIN
   131 #define	WCHAR_MAX	(wchar_t)__INT_MAX
   132 #endif
   133 
   134 #ifndef WEOF
   135 #define	WEOF 	((wint_t)-1)
   136 #endif
   137 
   138 struct __sFILE;
   139 struct tm;
   140 
   141 __BEGIN_DECLS
   142 IMPORT_C wint_t	btowc(int);
   143 IMPORT_C wint_t	fgetwc(struct __sFILE *);
   144 IMPORT_C wchar_t	*
   145 	fgetws(wchar_t * __restrict, int, struct __sFILE * __restrict);
   146 IMPORT_C wint_t	fputwc(wchar_t, struct __sFILE *);
   147 IMPORT_C int	fputws(const wchar_t * __restrict, struct __sFILE * __restrict);
   148 IMPORT_C int	fwide(struct __sFILE *, int);
   149 IMPORT_C int	fwprintf(struct __sFILE * __restrict, const wchar_t * __restrict, ...);
   150 IMPORT_C int	fwscanf(struct __sFILE * __restrict, const wchar_t * __restrict, ...);
   151 IMPORT_C wint_t	getwc(struct __sFILE *);
   152 IMPORT_C wint_t	getwchar(void);
   153 IMPORT_C size_t	mbrlen(const char * __restrict, size_t, mbstate_t * __restrict);
   154 IMPORT_C size_t	mbrtowc(wchar_t * __restrict, const char * __restrict, size_t,
   155 	    mbstate_t * __restrict);
   156 IMPORT_C int	mbsinit(const mbstate_t *);
   157 IMPORT_C size_t	mbsrtowcs(wchar_t * __restrict, const char ** __restrict, size_t,
   158 	    mbstate_t * __restrict);
   159 IMPORT_C wint_t	putwc(wchar_t, struct __sFILE *);
   160 IMPORT_C wint_t	putwchar(wchar_t);
   161 IMPORT_C int	swprintf(wchar_t * __restrict, size_t n, const wchar_t * __restrict,
   162 	    ...);
   163 IMPORT_C int	swscanf(const wchar_t * __restrict, const wchar_t * __restrict, ...);
   164 IMPORT_C wint_t	ungetwc(wint_t, struct __sFILE *);
   165 IMPORT_C int	vfwprintf(struct __sFILE * __restrict, const wchar_t * __restrict,
   166 	    va_list);
   167 IMPORT_C int	vswprintf(wchar_t * __restrict, size_t n, const wchar_t * __restrict,
   168 	    va_list);
   169 IMPORT_C int	vwprintf(const wchar_t * __restrict, va_list);
   170 IMPORT_C size_t	wcrtomb(char * __restrict, wchar_t, mbstate_t * __restrict);
   171 IMPORT_C wchar_t	*wcscat(wchar_t * __restrict, const wchar_t * __restrict);
   172 IMPORT_C wchar_t	*wcschr(const wchar_t *, wchar_t) __pure;
   173 IMPORT_C int	wcscmp(const wchar_t *, const wchar_t *) __pure;
   174 IMPORT_C int	wcscoll(const wchar_t *, const wchar_t *);
   175 IMPORT_C wchar_t	*wcscpy(wchar_t * __restrict, const wchar_t * __restrict);
   176 IMPORT_C size_t	wcscspn(const wchar_t *, const wchar_t *) __pure;
   177 IMPORT_C size_t	wcsftime(wchar_t * __restrict, size_t, const wchar_t * __restrict,
   178 	    const struct tm * __restrict);
   179 IMPORT_C size_t	wcslen(const wchar_t *) __pure;
   180 IMPORT_C wchar_t	*wcsncat(wchar_t * __restrict, const wchar_t * __restrict,
   181 	    size_t);
   182 IMPORT_C int	wcsncmp(const wchar_t *, const wchar_t *, size_t) __pure;
   183 IMPORT_C wchar_t	*wcsncpy(wchar_t * __restrict , const wchar_t * __restrict, size_t);
   184 IMPORT_C wchar_t	*wcspbrk(const wchar_t *, const wchar_t *) __pure;
   185 IMPORT_C wchar_t	*wcsrchr(const wchar_t *, wchar_t) __pure;
   186 IMPORT_C size_t	wcsrtombs(char * __restrict, const wchar_t ** __restrict, size_t,
   187 	    mbstate_t * __restrict);
   188 IMPORT_C size_t	wcsspn(const wchar_t *, const wchar_t *) __pure;
   189 IMPORT_C wchar_t	*wcsstr(const wchar_t * __restrict, const wchar_t * __restrict)
   190 	    __pure;
   191 IMPORT_C size_t	wcsxfrm(wchar_t * __restrict, const wchar_t * __restrict, size_t);
   192 IMPORT_C int	wctob(wint_t);
   193 IMPORT_C double	wcstod(const wchar_t * __restrict, wchar_t ** __restrict);
   194 IMPORT_C wchar_t	*wcstok(wchar_t * __restrict, const wchar_t * __restrict,
   195 	    wchar_t ** __restrict);
   196 IMPORT_C long	 wcstol(const wchar_t * __restrict, wchar_t ** __restrict, int);
   197 IMPORT_C unsigned long
   198 	 wcstoul(const wchar_t * __restrict, wchar_t ** __restrict, int);
   199 IMPORT_C wchar_t	*wmemchr(const wchar_t *, wchar_t, size_t) __pure;
   200 IMPORT_C int	wmemcmp(const wchar_t *, const wchar_t *, size_t) __pure;
   201 IMPORT_C wchar_t	*wmemcpy(wchar_t * __restrict, const wchar_t * __restrict, size_t);
   202 IMPORT_C wchar_t	*wmemmove(wchar_t *, const wchar_t *, size_t);
   203 IMPORT_C wchar_t	*wmemset(wchar_t *, wchar_t, size_t);
   204 IMPORT_C int	wprintf(const wchar_t * __restrict, ...);
   205 IMPORT_C int	wscanf(const wchar_t * __restrict, ...);
   206 #ifdef __SYMBIAN32__
   207 IMPORT_C long long 	 wcstoq(const wchar_t * __restrict, wchar_t ** __restrict, int);
   208 IMPORT_C unsigned long long wcstouq(const wchar_t * __restrict, wchar_t ** __restrict, int);
   209 IMPORT_C wchar_t *wcswcs(const wchar_t * __restrict s, const wchar_t * __restrict find);
   210 IMPORT_C int wpopen3 (const wchar_t* file, const wchar_t* cmd, wchar_t** env, int fids[3]);
   211 #endif //__SYMBIAN32__
   212 
   213 #ifndef _STDSTREAM_DECLARED
   214 extern struct __sFILE *__stdinp;
   215 extern struct __sFILE *__stdoutp;
   216 extern struct __sFILE *__stderrp;
   217 #define	_STDSTREAM_DECLARED
   218 #endif
   219 
   220 #ifndef __SYMBIAN32__
   221 #define	getwc(fp)	fgetwc(fp)
   222 #define	getwchar()	fgetwc(__stdinp)
   223 #define	putwc(wc, fp)	fputwc(wc, fp)
   224 #define	putwchar(wc)	fputwc(wc, __stdoutp)
   225 #else //__SYMBIAN32__
   226 IMPORT_C wint_t	getwc(struct __sFILE *);
   227 IMPORT_C wint_t	getwchar(void);
   228 IMPORT_C wint_t	putwc(wchar_t, struct __sFILE *);
   229 IMPORT_C wint_t	putwchar(wchar_t);
   230 #endif //__SYMBIAN32__
   231 
   232 
   233 #if __ISO_C_VISIBLE >= 1999
   234 IMPORT_C int	vfwscanf(struct __sFILE * __restrict, const wchar_t * __restrict,
   235 	    va_list);
   236 IMPORT_C int	vswscanf(const wchar_t * __restrict, const wchar_t * __restrict,
   237 	    va_list);
   238 IMPORT_C int	vwscanf(const wchar_t * __restrict, va_list);
   239 IMPORT_C float	wcstof(const wchar_t * __restrict, wchar_t ** __restrict);
   240 IMPORT_C long double
   241 	wcstold(const wchar_t * __restrict, wchar_t ** __restrict);
   242 #ifdef __LONG_LONG_SUPPORTED
   243 /* LONGLONG */
   244 IMPORT_C long long
   245 	wcstoll(const wchar_t * __restrict, wchar_t ** __restrict, int);
   246 /* LONGLONG */
   247 IMPORT_C unsigned long long
   248 	 wcstoull(const wchar_t * __restrict, wchar_t ** __restrict, int);
   249 #endif
   250 #endif	/* __ISO_C_VISIBLE >= 1999 */
   251 
   252 #if __XSI_VISIBLE
   253 IMPORT_C int	wcswidth(const wchar_t *, size_t);
   254 IMPORT_C int	wcwidth(wchar_t);
   255 #ifndef __SYMBIAN32__
   256 #define	wcwidth(_c)	__wcwidth(_c)
   257 #endif //__SYMBIAN32__
   258 #endif
   259 
   260 #if __BSD_VISIBLE
   261 
   262 #ifdef __SYMBIAN_COMPILE_UNUSED__
   263 wchar_t	*fgetwln(struct __sFILE * __restrict, size_t * __restrict);
   264 #endif
   265 
   266 IMPORT_C size_t	mbsnrtowcs(wchar_t * __restrict, const char ** __restrict, size_t,
   267 	    size_t, mbstate_t * __restrict);
   268 IMPORT_C size_t	wcsnrtombs(char * __restrict, const wchar_t ** __restrict, size_t,
   269 	    size_t, mbstate_t * __restrict);
   270 #endif
   271 #ifdef __SYMBIAN32__
   272 IMPORT_C wchar_t *wcpcpy(wchar_t *dst, const wchar_t *src);
   273 IMPORT_C wchar_t *wcpncpy(wchar_t * dst, const wchar_t * src, size_t n);
   274 IMPORT_C int wcscasecmp(const wchar_t *s1, const wchar_t *s2);
   275 IMPORT_C wchar_t *wcsdup (const wchar_t *srcwcs);
   276 IMPORT_C int wcsncasecmp(const wchar_t *s1, const wchar_t *s2, size_t n);
   277 IMPORT_C size_t wcsnlen(const wchar_t *s, size_t maxlen);
   278 
   279 IMPORT_C wchar_t* wrealpath (const wchar_t* , wchar_t* );
   280 IMPORT_C int wrmdir (const wchar_t *);
   281 IMPORT_C int wstat (const wchar_t *name, struct stat *st);
   282 IMPORT_C int wsystem (const wchar_t* );
   283 IMPORT_C int wunlink (const wchar_t *);
   284 IMPORT_C FILE* wpopen( const wchar_t* command, const wchar_t* mode );
   285 
   286 IMPORT_C int wopen(const wchar_t *, int, ...);
   287 IMPORT_C FILE 	*wfopen(const wchar_t * __restrict,	const wchar_t * __restrict);
   288 IMPORT_C int wrename (const wchar_t *oldpath, const wchar_t *newpath);
   289 IMPORT_C int wchdir (const wchar_t *_path);
   290 IMPORT_C int wchmod (const wchar_t *_path, mode_t _mode);
   291 IMPORT_C  wchar_t* wgetcwd (wchar_t *_buf, size_t _size);
   292 IMPORT_C int wmkdir (const wchar_t *_path, mode_t _mode);
   293 IMPORT_C int wclosedir (WDIR *dp);
   294 IMPORT_C struct wdirent *wreaddir (WDIR *dp);
   295 IMPORT_C void wrewinddir (WDIR *dp);
   296 IMPORT_C int waccess(const wchar_t *fn, int flags);
   297 IMPORT_C int wcreat(const wchar_t* file, mode_t mode);
   298 IMPORT_C void wseekdir(WDIR *dp,off_t index);
   299 IMPORT_C  off_t wtelldir(const WDIR *dp);
   300 IMPORT_C WDIR *wopendir (const wchar_t *_path);
   301 
   302 #define _wcsupr(wcs) 						wcsupr(wcs)
   303 #define _wcslwr(wcs) 						wcslwr(wcs)
   304 #define _wcsset(wcs, wc) 				wcsset(wcs,wc)
   305 #define _wcsnset(wcs, wc, size) 	wcsnset(wcs, wc, size)
   306 #define _wcsrev(wcs) 						wcsrev(wcs)
   307 #define _wcsicmp(wcs1, wcs2) 		wcsicmp(wcs1, wcs2)
   308 #define _wstrdate(datestr) 			wstrdate(datestr)
   309 #define _wstrtime(timestr) 			wstrtime(timestr)
   310 
   311 IMPORT_C wchar_t* wcsupr(wchar_t *wcs);
   312 IMPORT_C wchar_t* wcslwr(wchar_t *wcs);
   313 IMPORT_C wchar_t* wcsset (wchar_t* wcs, wchar_t wc);
   314 IMPORT_C wchar_t* wcsnset (wchar_t* wcs, wchar_t wc, size_t maxSize);
   315 IMPORT_C wchar_t* wcsrev(wchar_t *wcs);
   316 IMPORT_C int wcsicmp(const wchar_t* wcs1,const wchar_t * wcs2);
   317 IMPORT_C wchar_t* wstrdate( const wchar_t *dateStr );
   318 IMPORT_C wchar_t* wstrtime(const wchar_t *timeStr);
   319 IMPORT_C FILE * wfdopen (int fd, const wchar_t *mode);
   320 IMPORT_C FILE * wfreopen(const wchar_t * file,const wchar_t * mode,FILE *fp);	
   321 IMPORT_C wchar_t* getws(wchar_t* str);
   322 IMPORT_C int wremove(const wchar_t *file);
   323 IMPORT_C int putws(wchar_t* str);
   324 
   325 struct _wfinddata_t 
   326 {
   327     unsigned    attrib;
   328     time_t      time_create;    /* -1 for symbian */
   329     time_t      time_access;    /* -1 for symbian*/
   330     time_t      time_write;
   331     size_t    	size;
   332     wchar_t     name[260];
   333 };
   334 
   335 #define _A_ARCH   0x0020		//Archive. Set whenever the file is changed and cleared by the BACKUP command. Value: 0x20.
   336 #define _A_HIDDEN 0x0002 		//Hidden file. Not normally seen with the DIR command, unless the /AH option is used. Returns information about normal files and files with this attribute. Value: 0x02.
   337 #define _A_NORMAL 0x0000	//Normal. File has no other attributes set and can be read or written to without restriction. Value: 0x00.
   338 #define _A_RDONLY 0x0001		//Read-only. File cannot be opened for writing and a file with the same name cannot be created. Value: 0x01.
   339 #define _A_SYSTEM  0x0004		//System file. Not normally seen with the DIR command, unless the /A or /A:S option is used
   340 
   341 IMPORT_C size_t	wcslcat(wchar_t *, const wchar_t *, size_t);
   342 IMPORT_C size_t	 wcslcpy(wchar_t *, const wchar_t *, size_t);
   343 IMPORT_C wchar_t *wasctime(const struct tm *);
   344 IMPORT_C wchar_t *wctime(const time_t *);
   345 IMPORT_C wchar_t *wsetlocale(int, const wchar_t *);
   346 IMPORT_C void wperror(const wchar_t *);
   347 IMPORT_C wchar_t*	wcserror(int num);
   348 IMPORT_C int wfindnext(intptr_t, struct _wfinddata_t *); 
   349 IMPORT_C intptr_t wfindfirst(const wchar_t* , struct _wfinddata_t* );
   350 IMPORT_C	int findclose( intptr_t handle);
   351 
   352 #define snwprintf swprintf
   353 #define vsnwprintf vswprintf
   354 
   355 IMPORT_C int wcsnicmp (const wchar_t *wcs1, const wchar_t *wcs2, size_t n);
   356 IMPORT_C int wcsicoll(const wchar_t *wcs1, const wchar_t *wcs2);
   357 IMPORT_C int wcsncoll(const wchar_t* wcs1, const wchar_t* wcs2, size_t n);
   358 IMPORT_C int wcsnicoll(const wchar_t* wcs1, const wchar_t* wcs2, size_t n);
   359 IMPORT_C wchar_t* wtmpnam(wchar_t *s);
   360 
   361 #if defined(SYMBIAN_OE_LARGE_FILE_SUPPORT) && !defined(SYMBIAN_OE_NO_LFS)
   362 #define	wfopen64	wfopen
   363 #define wfreopen64	wfreopen
   364 #define wstat64		wstat
   365 #define wcreat64	wcreat
   366 #define wopen64		wopen
   367 #define wreaddir64	wreaddir
   368 #endif /* SYMBIAN_OE_LARGE_FILE_SUPPORT && !SYMBIAN_OE_NO_LFS */
   369 	
   370 
   371 #endif //__SYMBIAN32__
   372 __END_DECLS
   373 
   374 #ifdef __cplusplus
   375 }
   376 #endif //__cplusplus
   377 #endif /* !_WCHAR_H_ */