EdkCompatibilityPkg/Compatibility/Include/Library/LanguageLib.h

   1 /** @file
   2   Provides functions for language conversion between ISO 639-2 and RFC 4646 styles.
   3
   4 Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>
   5 Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<BR>
   6 All rights reserved. This program and the accompanying materials
   7 are licensed and made available under the terms and conditions of the BSD License
   8 which accompanies this distribution.  The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php.
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef __LANGUAGE_LIB__
  17 #define __LANGUAGE_LIB__
  18
  19 /**
  20   Converts an ISO 639-2 language code to an RFC 4646 language code.
  21   If the ISO 639-2 language code has a corresponding ISO 639-1 code, then that ISO 639-1
  22   code is returned in the out parameter. Else the original ISO 639-2 code is returned. The returned RFC 4646
  23   language code is composed of only a primary language subtag.
  24
  25   If Iso639Language is NULL, then ASSERT().
  26   If Rfc4646Language is NULL, then ASSERT().
  27
  28   @param[out] Rfc4646Language  Pointers to a buffer large enough for an ASCII string
  29                                representing an RFC 4646 language code containing only
  30                                either a ISO 639-1 or ISO 639-2 primary language subtag.
  31                                This string is Null-terminated.
  32   @param[in]  Iso639Language   The pointer to a 3-letter ASCII string that represents
  33                                an ISO 639-2 language code. This string is not required
  34                                to be Null-terminated.
  35
  36   @retval TRUE                 The ISO 639-2 language code was converted to an ISO 639-1 code.
  37   @retval FALSE                The language code does not have a corresponding ISO 639-1 code.
  38
  39 **/
  40 BOOLEAN
  41 EFIAPI
  42 ConvertIso639ToRfc4646 (
  43   OUT CHAR8        *Rfc4646Language,
  44   IN  CONST CHAR8  *Iso639Language
  45   );
  46
  47 /**
  48   Converts an RFC 4646 language code to an ISO 639-2 language code. The primary language
  49   subtag of the RFC 4646 code must be either an ISO 639-1 or 639-2 code. If the primary
  50   language subtag is an ISO 639-1 code, then it is converted to its corresponding ISO 639-2
  51   code (T code if applies). Else the ISO 639-2 code is returned.
  52
  53   If Rfc4646Language is NULL, then ASSERT().
  54   If Iso639Language is NULL, then ASSERT().
  55
  56   @param[out] Iso639Language   Pointers to a buffer large enough for a 3-letter ASCII string
  57                                representing an ISO 639-2 language code. The string
  58                                is Null-terminated.
  59   @param[in]  Rfc4646Language  The pointer to a RFC 4646 language code string.
  60                                This string is terminated
  61                                by a NULL or a ';' character.
  62
  63   @retval TRUE                 Language code converted successfully.
  64   @retval FALSE                The RFC 4646 language code is invalid or unsupported.
  65
  66 **/
  67 BOOLEAN
  68 EFIAPI
  69 ConvertRfc4646ToIso639 (
  70   OUT CHAR8        *Iso639Language,
  71   IN  CONST CHAR8  *Rfc4646Language
  72   );
  73
  74 /**
  75   Converts ISO 639-2 language codes to RFC 4646 codes and returns the converted codes.
  76   Caller is responsible for freeing the allocated buffer.
  77
  78   If Iso639Languages is NULL, then ASSERT.
  79
  80   @param[in] Iso639Languages  Pointers to Null-terminated ISO 639-2 language code strings containing
  81                               one or more ISO 639-2 3-letter language codes.
  82
  83   @retval NULL                Invalid ISO 639-2 language code found.
  84   @retval NULL                Out of memory.
  85   @return                     The pointer to the allocate buffer containing the
  86                               Null-terminated converted language codes string.
  87                               This string is composed of one or more RFC4646
  88                               language codes each of which has only
  89                               ISO 639-1 2-letter primary language subtag.
  90
  91 **/
  92 CHAR8 *
  93 EFIAPI
  94 ConvertLanguagesIso639ToRfc4646 (
  95   IN CONST CHAR8  *Iso639Languages
  96   );
  97
  98 /**
  99   Converts RFC 4646 language codes to ISO 639-2 codes and returns the converted codes.
 100   The primary language subtag of the RFC 4646 code must be either an ISO 639-1 or 639-2 code.
 101   Caller is responsible for freeing the allocated buffer.
 102
 103   If Rfc4646Languages is NULL, then ASSERT.
 104
 105   @param[in] Rfc4646Languages  Pointers to a Null-terminated RFC 4646 language codes
 106                                string containing one or more RFC 4646 language codes.
 107
 108   @retval NULL                 Invalid or unsupported RFC 4646 language code found.
 109   @retval NULL                 Out of memory.
 110   @return                      The pointer to the allocate buffer containing the
 111                                Null-terminated converted language codes string.
 112                                This string is composed of one or more ISO 639-2
 113                                language codes.
 114
 115 **/
 116 CHAR8 *
 117 EFIAPI
 118 ConvertLanguagesRfc4646ToIso639 (
 119   IN CONST CHAR8  *Rfc4646Languages
 120   );
 121
 122
 123 #endif