StdLib/Include/locale.h

   1 /** @file
   2   Localization functions and macros.
   3
   4   Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>
   5   This program and the accompanying materials are licensed and made available under
   6   the terms and conditions of the BSD License that accompanies this distribution.
   7   The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13  * Copyright (c) 1991, 1993
  14  *  The Regents of the University of California.  All rights reserved.
  15  *
  16  * Redistribution and use in source and binary forms, with or without
  17  * modification, are permitted provided that the following conditions
  18  * are met:
  19  * 1. Redistributions of source code must retain the above copyright
  20  *    notice, this list of conditions and the following disclaimer.
  21  * 2. Redistributions in binary form must reproduce the above copyright
  22  *    notice, this list of conditions and the following disclaimer in the
  23  *    documentation and/or other materials provided with the distribution.
  24  * 3. Neither the name of the University nor the names of its contributors
  25  *    may be used to endorse or promote products derived from this software
  26  *    without specific prior written permission.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  38  * SUCH DAMAGE.
  39  *
  40  *  @(#)locale.h  8.1 (Berkeley) 6/2/93
  41  *  $NetBSD: locale.h,v 1.14 2005/02/03 04:39:32 perry Exp
  42 **/
  43
  44 #ifndef _LOCALE_H_
  45 #define _LOCALE_H_
  46
  47 /** This is a structure containing members pertaining to the formatting of numeric values.
  48     There is no requirement for members of this structure to be in any particular order.
  49 **/
  50 struct lconv {
  51   char  *decimal_point;
  52   char  *thousands_sep;
  53   char  *grouping;
  54   char  *int_curr_symbol;
  55   char  *currency_symbol;
  56   char  *mon_decimal_point;
  57   char  *mon_thousands_sep;
  58   char  *mon_grouping;
  59   char  *positive_sign;
  60   char  *negative_sign;
  61   char  int_frac_digits;
  62   char  frac_digits;
  63   char  p_cs_precedes;
  64   char  p_sep_by_space;
  65   char  n_cs_precedes;
  66   char  n_sep_by_space;
  67   char  p_sign_posn;
  68   char  n_sign_posn;
  69   char  int_p_cs_precedes;
  70   char  int_n_cs_precedes;
  71   char  int_p_sep_by_space;
  72   char  int_n_sep_by_space;
  73   char  int_p_sign_posn;
  74   char  int_n_sign_posn;
  75 };
  76
  77 /** These macros expand to integer expressions suitable for use as the first
  78     argument to the setlocale() function.
  79
  80     Only the first six macros are required by the C language specification.
  81     Implementations are free to extend this list, as has been done with LC_MESSAGES,
  82     with additional macro definitions, beginning with the characters LC_ and
  83     an uppercase letter.
  84 @{
  85 **/
  86 #define LC_ALL      0   ///< The application's entire locale.
  87 #define LC_COLLATE  1   ///< Affects the behavior of the strcoll and strxfrm functions.
  88 #define LC_CTYPE    2   ///< Affects the behavior of the character handling, multibyte, and wide character functions.
  89 #define LC_MONETARY 3   ///< Affects monetary formatting information.
  90 #define LC_NUMERIC  4   ///< Affects the decimal-point character and non-monetary formatting information.
  91 #define LC_TIME     5   ///< Affects the behavior of the strftime and wcsftime functions.
  92 #define LC_MESSAGES 6
  93 #define _LC_LAST    7   ///< Number of defined macros. Marks end.
  94 /// @}
  95
  96 #include  <sys/EfiCdefs.h>
  97
  98 /** @fn   char *setlocale(int, const char *)
  99 **/
 100
 101 /** @fn   struct lconv *localeconv(void)
 102 **/
 103
 104 __BEGIN_DECLS
 105 #ifdef __SETLOCALE_SOURCE__
 106   char    *setlocale(int, const char *);
 107   char    *__setlocale(int, const char *);
 108 #else /* !__SETLOCALE_SOURCE__ */
 109   char    *setlocale(int, const char *) __RENAME(__setlocale_mb_len_max_32);
 110 #endif /* !__SETLOCALE_SOURCE__ */
 111 struct lconv  *localeconv(void);
 112   char    *__setlocale_mb_len_max_32(int, const char *);
 113 __END_DECLS
 114
 115 #endif /* _LOCALE_H_ */