source: trunk/libc/include/klibc/locale.h@ 3056

/* $Id: locale.h 3056 2007-04-08 17:12:27Z bird $ */
/** @file
 *
 * kLIBC - Internal locale header.
 *
 * Copyright (c) 2003 InnoTek Systemberatung GmbH
 * Copyright (c) 2003-2006 knut st. osmundsen <[email protected]>
 *
 *
 * This file is part of kLIBC.
 *
 * kLIBC is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * kLIBC is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with kLIBC; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#ifndef __klibc_locale_h__
#define __klibc_locale_h__

#include <sys/cdefs.h>
#include <sys/types.h>
#include <locale.h>
#ifdef __OS2__
# include <uconv.h>
#endif
#ifdef __CTYPE_H_
# error "klibc/locale.h must be included *before* ctype.h!"
#endif

__BEGIN_DECLS

/**
 * LC_COLLATE information.
 */
typedef struct __libc_LocaleCollate
{
    /** Character weight for SBCS codepages. */
    unsigned char   auchWeight[256];
    /** MBCS prefixes. Two bits per character. */
    unsigned char   au2MBCSPrefixs[256/4];
#ifdef __OS2__
    /** The converter object to convert to and from selected codepage
      (used with MBCS codepages only). */
    UconvObject     uobj;
    /** The locale object. */
    LocaleObject    lobj;
#endif
    /** Non-zero if there are any MBCS prefix characters in codepage. */
    char            mbcs;
} __LIBC_LOCALECOLLATE;
/** Pointer to locale collate structure. */
typedef __LIBC_LOCALECOLLATE *__LIBC_PLOCALECOLLATE;

/**
 * Multibyte to/from wide character conversion functions.
 */
typedef struct __libc_localeCTypeFuncs
{
    int     (*pfnmbsinit)(const __mbstate_t *);
    size_t  (*pfnmbrtowc)(__wchar_t * __restrict, const char * __restrict, size_t, __mbstate_t * __restrict);
    size_t  (*pfnmbsnrtowcs)(__wchar_t * __restrict, const char ** __restrict, size_t, size_t, __mbstate_t * __restrict);
    size_t  (*pfnwcrtomb)(char * __restrict, __wchar_t, __mbstate_t * __restrict);
    size_t  (*pfnwcsnrtombs)(char * __restrict, const __wchar_t ** __restrict, size_t, size_t, __mbstate_t * __restrict);
} __LIBC_LOCALECTYPEFUNCS;
/** Pointer to multibyte/wide character conversion functions. */
typedef __LIBC_LOCALECTYPEFUNCS *__LIBC_PLOCALECTYPEFUNCS;
/** Pointer to const multibyte/wide character conversion functions. */
typedef const __LIBC_LOCALECTYPEFUNCS *__LIBC_PCLOCALECTYPEFUNCS;

/**
 * This structure contains the flags and uppercase/lowercase tables.
 */
typedef struct __libc_LocaleCtype
{
    /** All uppercased characters. */
    unsigned char           auchUpper[256];
    /** All lowercased characters. */
    unsigned char           auchLower[256];
    /** Bit flags for every character (for isXXX() function series). */
    unsigned                aufType[256];

/* part which we don't 'expose': */
    /** MBCS prefixes. Two bits per character. */
    unsigned char           au2MBCSPrefixs[256/4];
    /** Unicode translation. (0xffff means no translation.) */
    unsigned short          aucUnicode[256];
    /** Unicode -> SBCS conversion: 0..128. */
    unsigned char           auchToSBCS0To128[128];
    /** Unicode -> SBCS conversion: Custom regions. */
    struct
    {
        /** First unicode code point. */
        unsigned short      usStart;
        /** Number of entries used. */
        unsigned short      cChars;
        /** Array SBCS chars corresponding to (wc - usStart). 0 means no conversion. */
        unsigned char       auch[28];
    }                       aSBCSs[8];
    /** Number of aSBCS regions in use. */
    unsigned                cSBCSs;
    /** Conversion functions. */
    __LIBC_LOCALECTYPEFUNCS CtypeFuncs;
#ifdef __OS2__
    /** The converter object to convert to and from selected codepage
      (used with MBCS codepages only). */
    UconvObject             uobj;
    /** The locale object. */
    LocaleObject            lobj;
#endif
    /** Non-zero if there are any MBCS prefix characters in codepage. */
    char                    mbcs;
    /** Codeset name. */
    char                    szCodeSet[32];
} __LIBC_LOCALECTYPE;
/** Pointer to the Ctype locale struct. */
typedef __LIBC_LOCALECTYPE *__LIBC_PLOCALECTYPE;


/**
 * Unicode CType data.
 * The structure contains information for the first 256 unicode chars.
 */
typedef struct __libc_localeWCType
{
    /** All uppercased characters. */
    __wchar_t       awcUpper[256];
    /** All lowercased characters. */
    __wchar_t       awcLower[256];
    /** Bit flags for every character (for iswXXX() function series). */
    unsigned        aufType[256];
    /** Mask used to check if an index is within the above arrays.
     * This is required because 'C' doesn't do more than 0-127. So,
     * the mask is either ~0xff or ~0x7f. */
    unsigned        uMask;
} __LIBC_LOCALEWCTYPE;
/** Pointer to the Ctype unicode struct. */
typedef __LIBC_LOCALEWCTYPE *__LIBC_PLOCALEWCTYPE;

/**
 * This structure keeps the time formatting rules.
 * The fConsts flag indicates what kind of memory is backing the strings.
 */
typedef struct __libc_LocaleTime
{
    /** Short month names. */
    char   *smonths[12];
    /** Long month names. */
    char   *lmonths[12];
    /** Short weekday names. */
    char   *swdays[7];
    /** Long weekday names. */
    char   *lwdays[7];