Update the copyright notice format

[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Library / EfiCommonLib / String.c

/*++\r
\r
Copyright (c) 2004 - 2007, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \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
Module Name:\r
\r
  String.c\r
\r
Abstract:\r
\r
  Unicode string primatives\r
\r
--*/\r
\r
#include "Tiano.h"\r
#include "EfiDriverLib.h"\r
#include "EfiCommonLib.h"\r
\r
VOID\r
EfiStrCpy (\r
  IN CHAR16   *Destination,\r
  IN CHAR16   *Source\r
  )\r
/*++\r
\r
Routine Description:\r
  Copy the Unicode string Source to Destination.\r
\r
Arguments:\r
  Destination - Location to copy string\r
  Source      - String to copy\r
\r
Returns:\r
  NONE\r
\r
--*/\r
{\r
  while (*Source) {\r
    *(Destination++) = *(Source++);\r
  }\r
  *Destination = 0;\r
}\r
\r
VOID\r
EfiStrnCpy (\r
  OUT CHAR16  *Dst,\r
  IN  CHAR16  *Src,\r
  IN  UINTN   Length\r
  )\r
/*++\r
\r
Routine Description:\r
  Copy a string from source to destination\r
\r
Arguments:\r
  Dst              Destination string\r
  Src              Source string\r
  Length           Length of destination string\r
\r
Returns:\r
\r
--*/\r
{\r
  UINTN Index;\r
  UINTN SrcLen;\r
\r
  SrcLen = EfiStrLen (Src);\r
\r
  Index = 0;\r
  while (Index < Length && Index < SrcLen) {\r
    Dst[Index] = Src[Index];\r
    Index++;\r
  }\r
  for (Index = SrcLen; Index < Length; Index++) {\r
    Dst[Index] = 0;\r
  }\r
}\r
\r
UINTN\r
EfiStrLen (\r
  IN CHAR16   *String\r
  )\r
/*++\r
\r
Routine Description:\r
  Return the number of Unicode characters in String. This is not the same as\r
  the length of the string in bytes.\r
\r
Arguments:\r
  String - String to process\r
\r
Returns:\r
  Number of Unicode characters in String\r
\r
--*/\r
{\r
  UINTN Length;\r
  \r
  for (Length=0; *String; String++, Length++);\r
  return Length;\r
}\r
\r
\r
UINTN\r
EfiStrSize (\r
  IN CHAR16   *String\r
  )\r
/*++\r
\r
Routine Description:\r
  Return the number bytes in the Unicode String. This is not the same as\r
  the length of the string in characters. The string size includes the NULL\r
\r
Arguments:\r
  String - String to process\r
\r
Returns:\r
  Number of bytes in String\r
\r
--*/\r
{\r
  return ((EfiStrLen (String) + 1) * sizeof (CHAR16));\r
}\r
\r
\r
INTN\r
EfiStrCmp (\r
  IN CHAR16   *String,\r
  IN CHAR16   *String2\r
  )\r
/*++\r
\r
Routine Description:\r
  Compare the Unicode string pointed by String to the string pointed by String2.\r
\r
Arguments:\r
  String - String to process\r
\r
  String2 - The other string to process\r
\r
Returns:\r
  Return a positive integer if String is lexicall greater than String2; Zero if \r
  the two strings are identical; and a negative interger if String is lexically \r
  less than String2.\r
\r
--*/\r
{\r
  while (*String) {\r
    if (*String != *String2) {\r
      break;\r
    }\r
\r
    String += 1;\r
    String2 += 1;\r
  }\r
\r
  return *String - *String2;\r
}\r
\r
INTN\r
EfiStrnCmp (\r
  IN CHAR16   *String,\r
  IN CHAR16   *String2,\r
  IN UINTN    Length\r
  )\r
/*++\r
\r
Routine Description:\r
  This function compares the Unicode string String to the Unicode\r
  string String2 for len characters.  If the first len characters\r
  of String is identical to the first len characters of String2,\r
  then 0 is returned.  If substring of String sorts lexicographically\r
  after String2, the function returns a number greater than 0. If\r
  substring of String sorts lexicographically before String2, the\r
  function returns a number less than 0.\r
\r
Arguments:\r
  String  - Compare to String2\r
  String2 - Compare to String\r
  Length  - Number of Unicode characters to compare\r
\r
Returns:\r
  0     - The substring of String and String2 is identical.\r
  > 0   - The substring of String sorts lexicographically after String2\r
  < 0   - The substring of String sorts lexicographically before String2\r
\r
--*/\r
{\r
  while (*String && Length != 0) {\r
    if (*String != *String2) {\r
      break;\r
    }\r
    String  += 1;\r
    String2 += 1;\r
    Length  -= 1;\r
  }\r
  return Length > 0 ? *String - *String2 : 0;\r
}\r
\r
VOID\r
EfiStrCat (\r
  IN CHAR16   *Destination,\r
  IN CHAR16   *Source\r
  )\r
/*++\r
\r
Routine Description:\r
  Concatinate Source on the end of Destination\r
\r
Arguments:\r
  Destination - String to added to the end of.\r
  Source      - String to concatinate.\r
\r
Returns:\r
  NONE\r
\r
--*/\r
{   \r
  EfiStrCpy (Destination + EfiStrLen (Destination), Source);\r
}\r
\r
VOID\r
EfiStrnCat (\r
  IN CHAR16   *Dest,\r
  IN CHAR16   *Src,\r
  IN UINTN    Length\r
  )\r
/*++\r
\r
Routine Description:\r
  Concatinate Source on the end of Destination\r
\r
Arguments:\r
  Dst              Destination string\r
  Src              Source string\r
  Length           Length of destination string\r
\r
Returns:\r
\r
--*/\r
{\r
  EfiStrnCpy (Dest + EfiStrLen (Dest), Src, Length);\r
}\r
\r
UINTN\r
EfiAsciiStrLen (\r
  IN CHAR8   *String\r
  )\r
/*++\r
\r
Routine Description:\r
  Return the number of Ascii characters in String. This is not the same as\r
  the length of the string in bytes.\r
\r
Arguments:\r
  String - String to process\r
\r
Returns:\r
  Number of Ascii characters in String\r
\r
--*/\r
{\r
  UINTN Length;\r
  \r
  for (Length=0; *String; String++, Length++);\r
  return Length;\r
}\r
\r
\r
CHAR8 *\r
EfiAsciiStrCpy (\r
  IN CHAR8    *Destination,\r
  IN CHAR8    *Source\r
  )\r
/*++\r
\r
Routine Description:\r
  Copy the Ascii string Source to Destination.\r
\r
Arguments:\r
  Destination - Location to copy string\r
  Source      - String to copy\r
\r
Returns:\r
  Pointer just pass the end of Destination\r
\r
--*/\r
{\r
  while (*Source) {\r
    *(Destination++) = *(Source++);\r
  }\r
  *Destination = 0;\r
  return Destination + 1;\r
}\r
\r
VOID\r
EfiAsciiStrnCpy (\r
  OUT CHAR8    *Dst,\r
  IN  CHAR8    *Src,\r
  IN  UINTN    Length\r
  )\r
/*++\r
\r
Routine Description:\r
  Copy the Ascii string from source to destination\r
\r
Arguments:\r
  Dst              Destination string\r
  Src              Source string\r
  Length           Length of destination string\r
\r
Returns:\r
\r
--*/\r
{\r
  UINTN Index;\r
  UINTN SrcLen;\r
\r
  SrcLen = EfiAsciiStrLen (Src);\r
\r
  Index = 0;\r
  while (Index < Length && Index < SrcLen) {\r
    Dst[Index] = Src[Index];\r
    Index++;\r
  }\r
  for (Index = SrcLen; Index < Length; Index++) {\r
    Dst[Index] = 0;\r
  }\r
}\r
\r
UINTN\r
EfiAsciiStrSize (\r
  IN CHAR8   *String\r
  )\r
/*++\r
\r
Routine Description:\r
  Return the number bytes in the Ascii String. This is not the same as\r
  the length of the string in characters. The string size includes the NULL\r
\r
Arguments:\r
  String - String to process\r
\r
Returns:\r
  Number of bytes in String\r
\r
--*/\r
{\r
  return (EfiAsciiStrLen (String) + 1);\r
}\r
\r
\r
INTN\r
EfiAsciiStrCmp (\r
  IN CHAR8   *String,\r
  IN CHAR8   *String2\r
  )\r
/*++\r
\r
Routine Description:\r
  Compare the Ascii string pointed by String to the string pointed by String2. \r
\r
Arguments:\r
  String - String to process\r
\r
  String2 - The other string to process\r
\r
Returns:\r
  Return a positive integer if String is lexicall greater than String2; Zero if \r
  the two strings are identical; and a negative interger if String is lexically \r
  less than String2.\r
--*/\r
{\r
  while (*String) {\r
    if (*String != *String2) {\r
      break;\r
    }\r
\r
    String += 1;\r
    String2 += 1;\r
  }\r
\r
  return *String - *String2;\r
}\r
\r
INTN\r
EfiAsciiStrnCmp (\r
  IN CHAR8    *String,\r
  IN CHAR8    *String2,\r
  IN UINTN    Length\r
  )\r
{\r
  if (Length == 0) {\r
    return 0;\r
  }\r
\r
  while ((*String != '\0') &&\r
         (*String == *String2) &&\r
         (Length > 1)) {\r
    String++;\r
    String2++;\r
    Length--;\r
  }\r
  return *String - *String2;\r
}\r
\r
VOID\r
EfiAsciiStrCat (\r
  IN CHAR8   *Destination,\r
  IN CHAR8   *Source\r
  )\r
/*++\r
\r
Routine Description:\r
  Concatinate Source on the end of Destination\r
\r
Arguments:\r
  Destination - String to added to the end of.\r
  Source      - String to concatinate.\r
\r
Returns:\r
  NONE\r
\r
--*/\r
{   \r
  EfiAsciiStrCpy (Destination + EfiAsciiStrLen (Destination), Source);\r
}\r
\r
VOID\r
EfiAsciiStrnCat (\r
  IN CHAR8   *Destination,\r
  IN CHAR8   *Source,\r
  IN UINTN   Length\r
  )\r
/*++\r
\r
Routine Description:\r
  Concatinate Source on the end of Destination\r
\r
Arguments:\r
  Destination - String to added to the end of.\r
  Source      - String to concatinate.\r
\r
Returns:\r
  NONE\r
\r
--*/\r
{\r
  EfiAsciiStrnCpy (Destination + EfiAsciiStrLen (Destination), Source, Length);\r
}\r
\r
BOOLEAN\r
IsHexDigit (\r
  OUT UINT8      *Digit,\r
  IN  CHAR16      Char\r
  )\r
/*++\r
\r
  Routine Description:\r
    Determines if a Unicode character is a hexadecimal digit.\r
    The test is case insensitive.\r
\r
  Arguments:\r
    Digit - Pointer to byte that receives the value of the hex character.\r
    Char  - Unicode character to test.\r
\r
  Returns:\r
    TRUE  - If the character is a hexadecimal digit.\r
    FALSE - Otherwise.\r
\r
--*/\r
{\r
  if ((Char >= L'0') && (Char <= L'9')) {\r
    *Digit = (UINT8) (Char - L'0');\r
    return TRUE;\r
  }\r
\r
  if ((Char >= L'A') && (Char <= L'F')) {\r
    *Digit = (UINT8) (Char - L'A' + 0x0A);\r
    return TRUE;\r
  }\r
\r
  if ((Char >= L'a') && (Char <= L'f')) {\r
    *Digit = (UINT8) (Char - L'a' + 0x0A);\r
    return TRUE;\r
  }\r
\r
  return FALSE;\r
}\r
\r
CHAR16\r
NibbleToHexChar (\r
  IN UINT8      Nibble\r
  )\r
/*++\r
\r
  Routine Description:\r
    Converts the low nibble of a byte  to hex unicode character.\r
\r
  Arguments:\r
    Nibble - lower nibble of a byte.\r
\r
  Returns:\r
    Hex unicode character.\r
\r
--*/\r
{\r
  Nibble &= 0x0F;\r
  if (Nibble <= 0x9) {\r
    return (CHAR16)(Nibble + L'0');\r
  }\r
\r
  return (CHAR16)(Nibble - 0xA + L'A');\r
}\r
\r
EFI_STATUS\r
HexStringToBuf (\r
  IN OUT UINT8                     *Buf,   \r
  IN OUT UINTN                    *Len,\r
  IN     CHAR16                    *Str,\r
  OUT    UINTN                     *ConvertedStrLen  OPTIONAL\r
  )\r
/*++\r
\r
  Routine Description:\r
    Converts Unicode string to binary buffer.\r
    The conversion may be partial.\r
    The first character in the string that is not hex digit stops the conversion.\r
    At a minimum, any blob of data could be represented as a hex string.\r
\r
  Arguments:\r
    Buf    - Pointer to buffer that receives the data.\r
    Len    - Length in bytes of the buffer to hold converted data.\r
                If routine return with EFI_SUCCESS, containing length of converted data.\r
                If routine return with EFI_BUFFER_TOO_SMALL, containg length of buffer desired.\r
    Str    - String to be converted from.\r
    ConvertedStrLen - Length of the Hex String consumed.\r
\r
  Returns:\r
    EFI_SUCCESS: Routine Success.\r
    EFI_BUFFER_TOO_SMALL: The buffer is too small to hold converted data.\r
    EFI_\r
\r
--*/\r
{\r
  UINTN       HexCnt;\r
  UINTN       Idx;\r
  UINTN       BufferLength;\r
  UINT8       Digit;\r
  UINT8       Byte;\r
\r
  //\r
  // Find out how many hex characters the string has.\r
  //\r
  for (Idx = 0, HexCnt = 0; IsHexDigit (&Digit, Str[Idx]); Idx++, HexCnt++);\r
\r
  if (HexCnt == 0) {\r
    *Len = 0;\r
    return EFI_SUCCESS;\r
  }\r
  //\r
  // Two Unicode characters make up 1 buffer byte. Round up.\r
  //\r
  BufferLength = (HexCnt + 1) / 2; \r
\r
  //\r
  // Test if  buffer is passed enough.\r
  //\r
  if (BufferLength > (*Len)) {\r
    *Len = BufferLength;\r
    return EFI_BUFFER_TOO_SMALL;\r
  }\r
\r
  *Len = BufferLength;\r
\r
  for (Idx = 0; Idx < HexCnt; Idx++) {\r
\r
    IsHexDigit (&Digit, Str[HexCnt - 1 - Idx]);\r
\r
    //\r
    // For odd charaters, write the lower nibble for each buffer byte,\r
    // and for even characters, the upper nibble.\r
    //\r
    if ((Idx & 1) == 0) {\r
      Byte = Digit;\r
    } else {\r
      Byte = Buf[Idx / 2];\r
      Byte &= 0x0F;\r
      Byte = (UINT8)(Byte | (Digit << 4));\r
    }\r
\r
    Buf[Idx / 2] = Byte;\r
  }\r
\r
  if (ConvertedStrLen != NULL) {\r
    *ConvertedStrLen = HexCnt;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
BufToHexString (\r
  IN OUT CHAR16                    *Str,\r
  IN OUT UINTN                     *HexStringBufferLength,\r
  IN     UINT8                     *Buf,\r
  IN     UINTN                      Len\r
  )\r
/*++\r
\r
  Routine Description:\r
    Converts binary buffer to Unicode string.\r
    At a minimum, any blob of data could be represented as a hex string.\r
\r
  Arguments:\r
    Str - Pointer to the string.\r
    HexStringBufferLength - Length in bytes of buffer to hold the hex string. Includes tailing '\0' character.\r
                                        If routine return with EFI_SUCCESS, containing length of hex string buffer.\r
                                        If routine return with EFI_BUFFER_TOO_SMALL, containg length of hex string buffer desired.\r
    Buf - Buffer to be converted from.\r
    Len - Length in bytes of the buffer to be converted.\r
\r
  Returns:\r
    EFI_SUCCESS: Routine success.\r
    EFI_BUFFER_TOO_SMALL: The hex string buffer is too small.\r
\r
--*/\r
{\r
  UINTN       Idx;\r
  UINT8       Byte;\r
  UINTN       StrLen;\r
\r
  //\r
  // Make sure string is either passed or allocate enough.\r
  // It takes 2 Unicode characters (4 bytes) to represent 1 byte of the binary buffer.\r
  // Plus the Unicode termination character.\r
  //\r
  StrLen = Len * 2;\r
  if (StrLen > ((*HexStringBufferLength) - 1)) {\r
    *HexStringBufferLength = StrLen + 1;\r
    return EFI_BUFFER_TOO_SMALL;\r
  }\r
\r
  *HexStringBufferLength = StrLen + 1;\r
  //\r
  // Ends the string.\r
  //\r
  Str[StrLen] = L'\0'; \r
\r
  for (Idx = 0; Idx < Len; Idx++) {\r
\r
    Byte = Buf[Idx];\r
    Str[StrLen - 1 - Idx * 2] = NibbleToHexChar (Byte);\r
    Str[StrLen - 2 - Idx * 2] = NibbleToHexChar ((UINT8)(Byte >> 4));\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
VOID\r
EfiStrTrim (\r
  IN OUT CHAR16   *str,\r
  IN     CHAR16   CharC\r
  )\r
/*++\r
\r
Routine Description:\r
  \r
  Removes (trims) specified leading and trailing characters from a string.\r
  \r
Arguments: \r
  \r
  str     - Pointer to the null-terminated string to be trimmed. On return, \r
            str will hold the trimmed string. \r
  CharC       - Character will be trimmed from str.\r
  \r
Returns:\r
\r
--*/\r
{\r
  CHAR16  *p1;\r
  CHAR16  *p2;\r
  \r
  if (*str == 0) {\r
    return;\r
  }\r
  \r
  //\r
  // Trim off the leading and trailing characters c\r
  //\r
  for (p1 = str; *p1 && *p1 == CharC; p1++) {\r
    ;\r
  }\r
  \r
  p2 = str;\r
  if (p2 == p1) {\r
    while (*p1) {\r
      p2++;\r
      p1++;\r
    }\r
  } else {\r
    while (*p1) {    \r
    *p2 = *p1;    \r
    p1++;\r
    p2++;\r
    }\r
    *p2 = 0;\r
  }\r
  \r
  \r
  for (p1 = str + EfiStrLen(str) - 1; p1 >= str && *p1 == CharC; p1--) {\r
    ;\r
  }\r
  if  (p1 !=  str + EfiStrLen(str) - 1) { \r
    *(p1 + 1) = 0;\r
  }\r
}\r
CHAR16*\r
EfiStrStr (\r
   IN  CHAR16  *String,\r
   IN  CHAR16  *StrCharSet\r
   )\r
/*++\r
 \r
Routine Description:\r
   \r
  Find a substring.\r
   \r
Arguments: \r
   \r
  String      - Null-terminated string to search.\r
  StrCharSet  - Null-terminated string to search for.\r
   \r
Returns:\r
  The address of the first occurrence of the matching substring if successful, or NULL otherwise.\r
--*/\r
{\r
  CHAR16 *Src;\r
  CHAR16 *Sub;\r
  \r
  Src = String;\r
  Sub = StrCharSet;\r
  \r
  while ((*String != L'\0') && (*StrCharSet != L'\0')) {\r
    if (*String++ != *StrCharSet) {\r
      String = ++Src;\r
      StrCharSet = Sub;\r
    } else {\r
      StrCharSet++;\r
    }\r
  }\r
  if (*StrCharSet == L'\0') {\r
    return Src;\r
  } else {\r
    return NULL;\r
  }\r
}\r
 \r
CHAR8*\r
EfiAsciiStrStr (\r
  IN  CHAR8  *String,\r
  IN  CHAR8  *StrCharSet\r
  )\r
/*++\r
\r
Routine Description:\r
  \r
  Find a Ascii substring.\r
  \r
Arguments: \r
  \r
  String      - Null-terminated Ascii string to search.\r
  StrCharSet  - Null-terminated Ascii string to search for.\r
  \r
Returns:\r
  The address of the first occurrence of the matching Ascii substring if successful, or NULL otherwise.\r
--*/\r
{\r
  CHAR8 *Src;\r
  CHAR8 *Sub;\r
   \r
  Src = String;\r
  Sub = StrCharSet;\r
  \r
  while ((*String != '\0') && (*StrCharSet != '\0')) {\r
    if (*String++ != *StrCharSet) {\r
      String = ++Src;\r
      StrCharSet = Sub;\r
    } else {\r
      StrCharSet++;\r
    }\r
  }\r
  if (*StrCharSet == '\0') {\r
    return Src;\r
  } else {\r
    return NULL;\r
  }\r
}\r
\r