Update or add comments to files and functions for use by Doxygen.

[mirror_edk2.git] / StdLib / Include / locale.h

/** @file\r
  Localization functions and macros.\r
\r
  Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials are licensed and made available under\r
  the terms and conditions of the BSD License that accompanies this distribution.\r
  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
 * Copyright (c) 1991, 1993\r
 *  The Regents of the University of California.  All rights reserved.\r
 *\r
 * Redistribution and use in source and binary forms, with or without\r
 * modification, are permitted provided that the following conditions\r
 * are met:\r
 * 1. Redistributions of source code must retain the above copyright\r
 *    notice, this list of conditions and the following disclaimer.\r
 * 2. Redistributions in binary form must reproduce the above copyright\r
 *    notice, this list of conditions and the following disclaimer in the\r
 *    documentation and/or other materials provided with the distribution.\r
 * 3. Neither the name of the University nor the names of its contributors\r
 *    may be used to endorse or promote products derived from this software\r
 *    without specific prior written permission.\r
 *\r
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND\r
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE\r
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\r
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS\r
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT\r
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY\r
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF\r
 * SUCH DAMAGE.\r
 *\r
 *  @(#)locale.h  8.1 (Berkeley) 6/2/93\r
 *  $NetBSD: locale.h,v 1.14 2005/02/03 04:39:32 perry Exp\r
**/\r
\r
#ifndef _LOCALE_H_\r
#define _LOCALE_H_\r
\r
/** This is a structure containing members pertaining to the formatting of numeric values.\r
    There is no requirement for members of this structure to be in any particular order.\r
**/\r
struct lconv {\r
  char  *decimal_point;\r
  char  *thousands_sep;\r
  char  *grouping;\r
  char  *int_curr_symbol;\r
  char  *currency_symbol;\r
  char  *mon_decimal_point;\r
  char  *mon_thousands_sep;\r
  char  *mon_grouping;\r
  char  *positive_sign;\r
  char  *negative_sign;\r
  char  int_frac_digits;\r
  char  frac_digits;\r
  char  p_cs_precedes;\r
  char  p_sep_by_space;\r
  char  n_cs_precedes;\r
  char  n_sep_by_space;\r
  char  p_sign_posn;\r
  char  n_sign_posn;\r
  char  int_p_cs_precedes;\r
  char  int_n_cs_precedes;\r
  char  int_p_sep_by_space;\r
  char  int_n_sep_by_space;\r
  char  int_p_sign_posn;\r
  char  int_n_sign_posn;\r
};\r
\r
/** These macros expand to integer expressions suitable for use as the first\r
    argument to the setlocale() function.\r
\r
    Only the first six macros are required by the C language specification.\r
    Implementations are free to extend this list, as has been done with LC_MESSAGES,\r
    with additional macro definitions, beginning with the characters LC_ and\r
    an uppercase letter.\r
@{\r
**/\r
#define LC_ALL      0   ///< The application's entire locale.\r
#define LC_COLLATE  1   ///< Affects the behavior of the strcoll and strxfrm functions.\r
#define LC_CTYPE    2   ///< Affects the behavior of the character handling, multibyte, and wide character functions.\r
#define LC_MONETARY 3   ///< Affects monetary formatting information.\r
#define LC_NUMERIC  4   ///< Affects the decimal-point character and non-monetary formatting information.\r
#define LC_TIME     5   ///< Affects the behavior of the strftime and wcsftime functions.\r
#define LC_MESSAGES 6\r
#define _LC_LAST    7   ///< Number of defined macros. Marks end.\r
/// @}\r
\r
#include  <sys/EfiCdefs.h>\r
\r
/** @fn   char *setlocale(int, const char *)\r
**/\r
\r
/** @fn   struct lconv *localeconv(void)\r
**/\r
\r
__BEGIN_DECLS\r
#ifdef __SETLOCALE_SOURCE__\r
  char    *setlocale(int, const char *);\r
  char    *__setlocale(int, const char *);\r
#else /* !__SETLOCALE_SOURCE__ */\r
  char    *setlocale(int, const char *) __RENAME(__setlocale_mb_len_max_32);\r
#endif /* !__SETLOCALE_SOURCE__ */\r
struct lconv  *localeconv(void);\r
  char    *__setlocale_mb_len_max_32(int, const char *);\r
__END_DECLS\r
\r
#endif /* _LOCALE_H_ */\r