BaseTools/CommonLib: get rid of 'native' type string parsing routines
authorArd Biesheuvel <ard.biesheuvel@linaro.org>
Thu, 29 Nov 2018 12:05:38 +0000 (13:05 +0100)
committerArd Biesheuvel <ard.biesheuvel@linaro.org>
Wed, 5 Dec 2018 08:04:54 +0000 (09:04 +0100)
Parsing a string into an integer variable of the native word size
is not defined for the BaseTools, since the same tools may be used
to build firmware for different targets with different native word
sizes.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
BaseTools/Source/C/Common/CommonLib.c
BaseTools/Source/C/Common/CommonLib.h

index 4a28f63..42dfa82 100644 (file)
@@ -882,72 +882,6 @@ InternalSafeStringNoStrOverlap (
   return !InternalSafeStringIsOverlap (Str1, Size1 * sizeof(CHAR16), Str2, Size2 * sizeof(CHAR16));\r
 }\r
 \r
-RETURN_STATUS\r
-StrDecimalToUintnS (\r
-    CONST CHAR16             *String,\r
-         CHAR16             **EndPointer,  OPTIONAL\r
-         UINTN              *Data\r
-  )\r
-{\r
-  ASSERT (((UINTN) String & BIT0) == 0);\r
-\r
-  //\r
-  // 1. Neither String nor Data shall be a null pointer.\r
-  //\r
-  SAFE_STRING_CONSTRAINT_CHECK ((String != NULL), RETURN_INVALID_PARAMETER);\r
-  SAFE_STRING_CONSTRAINT_CHECK ((Data != NULL), RETURN_INVALID_PARAMETER);\r
-\r
-  //\r
-  // 2. The length of String shall not be greater than RSIZE_MAX.\r
-  //\r
-  if (RSIZE_MAX != 0) {\r
-    SAFE_STRING_CONSTRAINT_CHECK ((StrnLenS (String, RSIZE_MAX + 1) <= RSIZE_MAX), RETURN_INVALID_PARAMETER);\r
-  }\r
-\r
-  if (EndPointer != NULL) {\r
-    *EndPointer = (CHAR16 *) String;\r
-  }\r
-\r
-  //\r
-  // Ignore the pad spaces (space or tab)\r
-  //\r
-  while ((*String == L' ') || (*String == L'\t')) {\r
-    String++;\r
-  }\r
-\r
-  //\r
-  // Ignore leading Zeros after the spaces\r
-  //\r
-  while (*String == L'0') {\r
-    String++;\r
-  }\r
-\r
-  *Data = 0;\r
-\r
-  while (InternalIsDecimalDigitCharacter (*String)) {\r
-    //\r
-    // If the number represented by String overflows according to the range\r
-    // defined by UINTN, then MAX_UINTN is stored in *Data and\r
-    // RETURN_UNSUPPORTED is returned.\r
-    //\r
-    if (*Data > ((MAX_UINTN - (*String - L'0')) / 10)) {\r
-      *Data = MAX_UINTN;\r
-      if (EndPointer != NULL) {\r
-        *EndPointer = (CHAR16 *) String;\r
-      }\r
-      return RETURN_UNSUPPORTED;\r
-    }\r
-\r
-    *Data = *Data * 10 + (*String - L'0');\r
-    String++;\r
-  }\r
-\r
-  if (EndPointer != NULL) {\r
-    *EndPointer = (CHAR16 *) String;\r
-  }\r
-  return RETURN_SUCCESS;\r
-}\r
-\r
 /**\r
   Convert a Null-terminated Unicode decimal string to a value of type UINT64.\r
 \r
@@ -1064,9 +998,9 @@ StrDecimalToUint64S (
 \r
 /**\r
   Convert a Null-terminated Unicode hexadecimal string to a value of type\r
-  UINTN.\r
+  UINT64.\r
 \r
-  This function outputs a value of type UINTN by interpreting the contents of\r
+  This function outputs a value of type UINT64 by interpreting the contents of\r
   the Unicode string specified by String as a hexadecimal number. The format of\r
   the input Unicode string String is:\r
 \r
@@ -1091,8 +1025,8 @@ StrDecimalToUint64S (
 \r
   If String has no valid hexadecimal digits in the above format, then 0 is\r
   stored at the location pointed to by Data.\r
-  If the number represented by String exceeds the range defined by UINTN, then\r
-  MAX_UINTN is stored at the location pointed to by Data.\r
+  If the number represented by String exceeds the range defined by UINT64, then\r
+  MAX_UINT64 is stored at the location pointed to by Data.\r
 \r
   If EndPointer is not NULL, a pointer to the character that stopped the scan\r
   is stored at the location pointed to by EndPointer. If String has no valid\r
@@ -1112,86 +1046,10 @@ StrDecimalToUint64S (
                                    characters, not including the\r
                                    Null-terminator.\r
   @retval RETURN_UNSUPPORTED       If the number represented by String exceeds\r
-                                   the range defined by UINTN.\r
+                                   the range defined by UINT64.\r
 \r
 **/\r
 RETURN_STATUS\r
-StrHexToUintnS (\r
-    CONST CHAR16             *String,\r
-         CHAR16             **EndPointer,  OPTIONAL\r
-         UINTN              *Data\r
-  )\r
-{\r
-  ASSERT (((UINTN) String & BIT0) == 0);\r
-\r
-  //\r
-  // 1. Neither String nor Data shall be a null pointer.\r
-  //\r
-  SAFE_STRING_CONSTRAINT_CHECK ((String != NULL), RETURN_INVALID_PARAMETER);\r
-  SAFE_STRING_CONSTRAINT_CHECK ((Data != NULL), RETURN_INVALID_PARAMETER);\r
-\r
-  //\r
-  // 2. The length of String shall not be greater than RSIZE_MAX.\r
-  //\r
-  if (RSIZE_MAX != 0) {\r
-    SAFE_STRING_CONSTRAINT_CHECK ((StrnLenS (String, RSIZE_MAX + 1) <= RSIZE_MAX), RETURN_INVALID_PARAMETER);\r
-  }\r
-\r
-  if (EndPointer != NULL) {\r
-    *EndPointer = (CHAR16 *) String;\r
-  }\r
-\r
-  //\r
-  // Ignore the pad spaces (space or tab)\r
-  //\r
-  while ((*String == L' ') || (*String == L'\t')) {\r
-    String++;\r
-  }\r
-\r
-  //\r
-  // Ignore leading Zeros after the spaces\r
-  //\r
-  while (*String == L'0') {\r
-    String++;\r
-  }\r
-\r
-  if (InternalCharToUpper (*String) == L'X') {\r
-    if (*(String - 1) != L'0') {\r
-      *Data = 0;\r
-      return RETURN_SUCCESS;\r
-    }\r
-    //\r
-    // Skip the 'X'\r
-    //\r
-    String++;\r
-  }\r
-\r
-  *Data = 0;\r
-\r
-  while (InternalIsHexaDecimalDigitCharacter (*String)) {\r
-    //\r
-    // If the number represented by String overflows according to the range\r
-    // defined by UINTN, then MAX_UINTN is stored in *Data and\r
-    // RETURN_UNSUPPORTED is returned.\r
-    //\r
-    if (*Data > ((MAX_UINTN - InternalHexCharToUintn (*String)) >> 4)) {\r
-      *Data = MAX_UINTN;\r
-      if (EndPointer != NULL) {\r
-        *EndPointer = (CHAR16 *) String;\r
-      }\r
-      return RETURN_UNSUPPORTED;\r
-    }\r
-\r
-    *Data = (*Data << 4) + InternalHexCharToUintn (*String);\r
-    String++;\r
-  }\r
-\r
-  if (EndPointer != NULL) {\r
-    *EndPointer = (CHAR16 *) String;\r
-  }\r
-  return RETURN_SUCCESS;\r
-}\r
-RETURN_STATUS\r
 StrHexToUint64S (\r
     CONST CHAR16             *String,\r
          CHAR16             **EndPointer,  OPTIONAL\r
@@ -1291,28 +1149,6 @@ StrHexToUint64 (
   return Result;\r
 }\r
 \r
-UINTN\r
-StrDecimalToUintn (\r
-  CONST CHAR16              *String\r
-  )\r
-{\r
-  UINTN     Result;\r
-\r
-  StrDecimalToUintnS (String, (CHAR16 **) NULL, &Result);\r
-  return Result;\r
-}\r
-\r
-UINTN\r
-StrHexToUintn (\r
-  CONST CHAR16              *String\r
-  )\r
-{\r
-  UINTN     Result;\r
-\r
-  StrHexToUintnS (String, (CHAR16 **) NULL, &Result);\r
-  return Result;\r
-}\r
-\r
 UINTN\r
 StrSize (\r
   CONST CHAR16              *String\r
index adec0ed..7f67a45 100644 (file)
@@ -251,16 +251,6 @@ StrSize (
   CONST CHAR16              *String\r
   );\r
 \r
-UINTN\r
-StrHexToUintn (\r
-  CONST CHAR16              *String\r
-  );\r
-\r
-UINTN\r
-StrDecimalToUintn (\r
-  CONST CHAR16              *String\r
-  );\r
-\r
 UINT64\r
 StrHexToUint64 (\r
   CONST CHAR16             *String\r
@@ -278,13 +268,6 @@ StrHexToUint64S (
     UINT64             *Data\r
   );\r
 \r
-RETURN_STATUS\r
-StrHexToUintnS (\r
-    CONST CHAR16             *String,\r
-         CHAR16             **EndPointer,  OPTIONAL\r
-         UINTN              *Data\r
-  );\r
-\r
 RETURN_STATUS\r
 StrDecimalToUint64S (\r
     CONST CHAR16             *String,\r
@@ -292,13 +275,6 @@ StrDecimalToUint64S (
          UINT64             *Data\r
   );\r
 \r
-RETURN_STATUS\r
-StrDecimalToUintnS (\r
-    CONST CHAR16             *String,\r
-         CHAR16             **EndPointer,  OPTIONAL\r
-         UINTN              *Data\r
-  );\r
-\r
 VOID *\r
 ReallocatePool (\r
    UINTN  OldSize,\r