]> git.proxmox.com Git - mirror_edk2.git/commitdiff
updated comments and added string-to-number conversion with return value to indicate...
authorjcarsey <jcarsey@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 25 Mar 2011 20:49:53 +0000 (20:49 +0000)
committerjcarsey <jcarsey@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 25 Mar 2011 20:49:53 +0000 (20:49 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11424 6f19259b-4bc3-4df7-8a09-765794883524

ShellPkg/Library/UefiShellLib/UefiShellLib.c
ShellPkg/Library/UefiShellLib/UefiShellLib.h
ShellPkg/Library/UefiShellLib/UefiShellLib.inf

index bcb6f2a7e4ca143e3f8db1c8121add3cd11cb018..ba0395dec2a45b333ddd156ab8d36751bf969d9e 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Provides interface to shell functionality for shell commands and applications.\r
 \r
-  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2006 - 2011, 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
@@ -14,6 +14,7 @@
 \r
 #include "UefiShellLib.h"\r
 #include <ShellBase.h>\r
+#include <Library/SortLib.h>\r
 \r
 #define FIND_XXXXX_FILE_BUFFER_SIZE (SIZE_OF_EFI_FILE_INFO + MAX_FILE_NAME_LEN)\r
 \r
@@ -123,7 +124,7 @@ ShellFindSE2 (
     // maybe it's not there???\r
     //\r
     if (Status == EFI_BUFFER_TOO_SMALL) {\r
-      Buffer = (EFI_HANDLE*)AllocatePool(BufferSize);\r
+      Buffer = (EFI_HANDLE*)AllocateZeroPool(BufferSize);\r
       ASSERT(Buffer != NULL);\r
       Status = gBS->LocateHandle (ByProtocol,\r
                                   &gEfiShellEnvironment2Guid,\r
@@ -159,12 +160,14 @@ ShellFindSE2 (
   return (Status);\r
 }\r
 \r
-/*/\r
+/**\r
   Function to do most of the work of the constructor.  Allows for calling \r
   multiple times without complete re-initialization.\r
 \r
   @param[in] ImageHandle  A copy of the ImageHandle.\r
   @param[in] SystemTable  A pointer to the SystemTable for the application.\r
+\r
+  @retval EFI_SUCCESS   The operationw as successful.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -817,7 +820,7 @@ ShellReadFile(
 EFI_STATUS\r
 EFIAPI\r
 ShellWriteFile(\r
-  IN SHELL_FILE_HANDLE                     FileHandle,\r
+  IN SHELL_FILE_HANDLE          FileHandle,\r
   IN OUT UINTN                  *BufferSize,\r
   IN VOID                       *Buffer\r
   )\r
@@ -1169,7 +1172,6 @@ ShellSetEnvironmentVariable (
   @retval EFI_OUT_OF_RESOURCES    Out of resources.\r
   @retval EFI_UNSUPPORTED         The operation is not allowed.\r
 **/\r
-\r
 EFI_STATUS\r
 EFIAPI\r
 ShellExecute (\r
@@ -1770,10 +1772,11 @@ EFIAPI
 InternalIsOnCheckList (\r
   IN CONST CHAR16               *Name,\r
   IN CONST SHELL_PARAM_ITEM     *CheckList,\r
-  OUT SHELL_PARAM_TYPE                 *Type\r
+  OUT SHELL_PARAM_TYPE          *Type\r
   )\r
 {\r
   SHELL_PARAM_ITEM              *TempListItem;\r
+  CHAR16                        *TempString;\r
 \r
   //\r
   // ASSERT that all 3 pointer parameters aren't NULL\r
@@ -1788,6 +1791,7 @@ InternalIsOnCheckList (
   if ((StrCmp(Name, L"-?") == 0) ||\r
       (StrCmp(Name, L"-b") == 0)\r
      ) {\r
+     *Type = TypeFlag;\r
      return (TRUE);\r
   }\r
 \r
@@ -1799,10 +1803,22 @@ InternalIsOnCheckList (
     // If the Type is TypeStart only check the first characters of the passed in param\r
     // If it matches set the type and return TRUE\r
     //\r
-    if (TempListItem->Type == TypeStart && StrnCmp(Name, TempListItem->Name, StrLen(TempListItem->Name)) == 0) {\r
-      *Type = TempListItem->Type;\r
-      return (TRUE);\r
-    } else if (StrCmp(Name, TempListItem->Name) == 0) {\r
+    if (TempListItem->Type == TypeStart) { \r
+      if (StrnCmp(Name, TempListItem->Name, StrLen(TempListItem->Name)) == 0) {\r
+        *Type = TempListItem->Type;\r
+        return (TRUE);\r
+      }\r
+      TempString = NULL;\r
+      TempString = StrnCatGrow(&TempString, NULL, Name, StrLen(TempListItem->Name));\r
+      if (TempString != NULL) {\r
+        if (StringNoCaseCompare(&TempString, &TempListItem->Name) == 0) {\r
+          *Type = TempListItem->Type;\r
+          FreePool(TempString);\r
+          return (TRUE);\r
+        }\r
+        FreePool(TempString);\r
+      }\r
+    } else if (StringNoCaseCompare(&Name, &TempListItem->Name) == 0) {\r
       *Type = TempListItem->Type;\r
       return (TRUE);\r
     }\r
@@ -1888,11 +1904,12 @@ InternalCommandLineParse (
   )\r
 {\r
   UINTN                         LoopCounter;\r
-  SHELL_PARAM_TYPE                     CurrentItemType;\r
+  SHELL_PARAM_TYPE              CurrentItemType;\r
   SHELL_PARAM_PACKAGE           *CurrentItemPackage;\r
   UINTN                         GetItemValue;\r
   UINTN                         ValueSize;\r
   UINTN                         Count;\r
+  CONST CHAR16                  *TempPointer;\r
 \r
   CurrentItemPackage = NULL;\r
   GetItemValue = 0;\r
@@ -1938,9 +1955,9 @@ InternalCommandLineParse (
       //\r
       // this is a flag\r
       //\r
-      CurrentItemPackage = AllocatePool(sizeof(SHELL_PARAM_PACKAGE));\r
+      CurrentItemPackage = AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE));\r
       ASSERT(CurrentItemPackage != NULL);\r
-      CurrentItemPackage->Name  = AllocatePool(StrSize(Argv[LoopCounter]));\r
+      CurrentItemPackage->Name  = AllocateZeroPool(StrSize(Argv[LoopCounter]));\r
       ASSERT(CurrentItemPackage->Name != NULL);\r
       StrCpy(CurrentItemPackage->Name,  Argv[LoopCounter]);\r
       CurrentItemPackage->Type  = CurrentItemType;\r
@@ -1996,27 +2013,35 @@ InternalCommandLineParse (
       //\r
       // add this one as a non-flag\r
       //\r
-      CurrentItemPackage = AllocatePool(sizeof(SHELL_PARAM_PACKAGE));\r
+\r
+      TempPointer = Argv[LoopCounter];\r
+      if ((*TempPointer == L'^' && *(TempPointer+1) == L'-') \r
+       || (*TempPointer == L'^' && *(TempPointer+1) == L'/')\r
+       || (*TempPointer == L'^' && *(TempPointer+1) == L'+')\r
+      ){\r
+        TempPointer++;\r
+      }\r
+      CurrentItemPackage = AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE));\r
       ASSERT(CurrentItemPackage != NULL);\r
       CurrentItemPackage->Name  = NULL;\r
       CurrentItemPackage->Type  = TypePosition;\r
-      CurrentItemPackage->Value = AllocatePool(StrSize(Argv[LoopCounter]));\r
+      CurrentItemPackage->Value = AllocateZeroPool(StrSize(TempPointer));\r
       ASSERT(CurrentItemPackage->Value != NULL);\r
-      StrCpy(CurrentItemPackage->Value, Argv[LoopCounter]);\r
+      StrCpy(CurrentItemPackage->Value, TempPointer);\r
       CurrentItemPackage->OriginalPosition = Count++;\r
       InsertHeadList(*CheckPackage, &CurrentItemPackage->Link);\r
-    } else if (ProblemParam != NULL) {\r
+    } else {\r
       //\r
       // this was a non-recognised flag... error!\r
       //\r
-      *ProblemParam = AllocatePool(StrSize(Argv[LoopCounter]));\r
-      ASSERT(*ProblemParam != NULL);\r
-      StrCpy(*ProblemParam, Argv[LoopCounter]);\r
+      if (ProblemParam != NULL) {\r
+        *ProblemParam = AllocateZeroPool(StrSize(Argv[LoopCounter]));\r
+        ASSERT(*ProblemParam != NULL);\r
+        StrCpy(*ProblemParam, Argv[LoopCounter]);      \r
+      }\r
       ShellCommandLineFreeVarList(*CheckPackage);\r
       *CheckPackage = NULL;\r
       return (EFI_VOLUME_CORRUPTED);\r
-    } else {\r
-      //ASSERT(FALSE);\r
     }\r
   }\r
   if (GetItemValue != 0) {\r
@@ -2183,6 +2208,7 @@ ShellCommandLineGetFlag (
   )\r
 {\r
   LIST_ENTRY                    *Node;\r
+  CHAR16                        *TempString;\r
 \r
   //\r
   // ASSERT that both CheckPackage and KeyString aren't NULL\r
@@ -2202,7 +2228,7 @@ ShellCommandLineGetFlag (
   for ( Node = GetFirstNode(CheckPackage)\r
       ; !IsNull (CheckPackage, Node)\r
       ; Node = GetNextNode(CheckPackage, Node)\r
-     ){\r
+      ){\r
     //\r
     // If the Name matches, return TRUE (and there may be NULL name)\r
     //\r
@@ -2210,11 +2236,20 @@ ShellCommandLineGetFlag (
       //\r
       // If Type is TypeStart then only compare the begining of the strings\r
       //\r
-      if ( ((SHELL_PARAM_PACKAGE*)Node)->Type == TypeStart\r
-        && StrnCmp(KeyString, ((SHELL_PARAM_PACKAGE*)Node)->Name, StrLen(KeyString)) == 0\r
-       ){\r
-        return (TRUE);\r
-      } else if (StrCmp(KeyString, ((SHELL_PARAM_PACKAGE*)Node)->Name) == 0) {\r
+      if (((SHELL_PARAM_PACKAGE*)Node)->Type == TypeStart) {\r
+        if (StrnCmp(KeyString, ((SHELL_PARAM_PACKAGE*)Node)->Name, StrLen(KeyString)) == 0) {\r
+          return (TRUE);\r
+        }\r
+        TempString = NULL;\r
+        TempString = StrnCatGrow(&TempString, NULL, KeyString, StrLen(((SHELL_PARAM_PACKAGE*)Node)->Name));\r
+        if (TempString != NULL) {\r
+          if (StringNoCaseCompare(&KeyString, &((SHELL_PARAM_PACKAGE*)Node)->Name) == 0) {\r
+            FreePool(TempString);\r
+            return (TRUE);\r
+          }\r
+          FreePool(TempString);\r
+        }\r
+      } else if (StringNoCaseCompare(&KeyString, &((SHELL_PARAM_PACKAGE*)Node)->Name) == 0) {\r
         return (TRUE);\r
       }\r
     }\r
@@ -2242,6 +2277,7 @@ ShellCommandLineGetValue (
   )\r
 {\r
   LIST_ENTRY                    *Node;\r
+  CHAR16                        *TempString;\r
 \r
   //\r
   // check for CheckPackage == NULL\r
@@ -2256,25 +2292,28 @@ ShellCommandLineGetValue (
   for ( Node = GetFirstNode(CheckPackage)\r
       ; !IsNull (CheckPackage, Node)\r
       ; Node = GetNextNode(CheckPackage, Node)\r
-     ){\r
+      ){\r
     //\r
-    // If the Name matches, return the value (name can be NULL)\r
+    // If the Name matches, return TRUE (and there may be NULL name)\r
     //\r
     if (((SHELL_PARAM_PACKAGE*)Node)->Name != NULL) {\r
       //\r
       // If Type is TypeStart then only compare the begining of the strings\r
       //\r
-      if ( ((SHELL_PARAM_PACKAGE*)Node)->Type == TypeStart\r
-        && StrnCmp(KeyString, ((SHELL_PARAM_PACKAGE*)Node)->Name, StrLen(KeyString)) == 0\r
-       ){\r
-        //\r
-        // return the string part after the flag\r
-        //\r
-        return (((SHELL_PARAM_PACKAGE*)Node)->Name + StrLen(KeyString));\r
-      } else if (StrCmp(KeyString, ((SHELL_PARAM_PACKAGE*)Node)->Name) == 0) {\r
-        //\r
-        // return the value\r
-        //\r
+      if (((SHELL_PARAM_PACKAGE*)Node)->Type == TypeStart) {\r
+        if (StrnCmp(KeyString, ((SHELL_PARAM_PACKAGE*)Node)->Name, StrLen(KeyString)) == 0) {\r
+          return (((SHELL_PARAM_PACKAGE*)Node)->Name + StrLen(KeyString));\r
+        }\r
+        TempString = NULL;\r
+        TempString = StrnCatGrow(&TempString, NULL, KeyString, StrLen(((SHELL_PARAM_PACKAGE*)Node)->Name));\r
+        if (TempString != NULL) {\r
+          if (StringNoCaseCompare(&KeyString, &((SHELL_PARAM_PACKAGE*)Node)->Name) == 0) {\r
+            FreePool(TempString);\r
+            return (((SHELL_PARAM_PACKAGE*)Node)->Name + StrLen(KeyString));\r
+          }\r
+          FreePool(TempString);\r
+        }\r
+      } else if (StringNoCaseCompare(&KeyString, &((SHELL_PARAM_PACKAGE*)Node)->Name) == 0) {\r
         return (((SHELL_PARAM_PACKAGE*)Node)->Value);\r
       }\r
     }\r
@@ -2554,8 +2593,8 @@ InternalPrintTo (
 \r
   Note: The background color is controlled by the shell command cls.\r
 \r
-  @param[in] Row        the row to print at\r
   @param[in] Col        the column to print at\r
+  @param[in] Row        the row to print at\r
   @param[in] Format     the format string\r
   @param[in] Marker     the marker for the variable argument list\r
 \r
@@ -2568,7 +2607,7 @@ InternalShellPrintWorker(
   IN INT32                Col OPTIONAL,\r
   IN INT32                Row OPTIONAL,\r
   IN CONST CHAR16         *Format,\r
-  VA_LIST                 Marker\r
+  IN VA_LIST              Marker\r
   )\r
 {\r
   EFI_STATUS        Status;\r
@@ -2600,7 +2639,6 @@ InternalShellPrintWorker(
 \r
   if (Col != -1 && Row != -1) {\r
     Status = gST->ConOut->SetCursorPosition(gST->ConOut, Col, Row);\r
-    ASSERT_EFI_ERROR(Status);\r
   }\r
 \r
   FormatWalker = mPostReplaceFormat2;\r
@@ -2908,13 +2946,15 @@ ShellIsFileInPath(
   FreePool(NewName);\r
   return (Status);\r
 }\r
+\r
 /**\r
   Function to determine whether a string is decimal or hex representation of a number\r
   and return the number converted from the string.\r
 \r
   @param[in] String   String representation of a number\r
 \r
-  @retval all         the number\r
+  @return             the number\r
+  @retval (UINTN)(-1) An error ocurred.\r
 **/\r
 UINTN\r
 EFIAPI\r
@@ -2922,17 +2962,19 @@ ShellStrToUintn(
   IN CONST CHAR16 *String\r
   )\r
 {\r
-  CONST CHAR16  *Walker;\r
-  for (Walker = String; Walker != NULL && *Walker != CHAR_NULL && *Walker == L' '; Walker++);\r
-  if (Walker == NULL || *Walker == CHAR_NULL) {\r
-    ASSERT(FALSE);\r
-    return ((UINTN)(-1));\r
-  } else {\r
-    if (StrnCmp(Walker, L"0x", 2) == 0 || StrnCmp(Walker, L"0X", 2) == 0){\r
-      return (StrHexToUintn(Walker));\r
-    }\r
-    return (StrDecimalToUintn(Walker));\r
+  UINT64        RetVal;\r
+  BOOLEAN       Hex;\r
+\r
+  Hex = FALSE;\r
+\r
+  if (!InternalShellIsHexOrDecimalNumber(String, Hex, TRUE)) {\r
+    Hex = TRUE;\r
   }\r
+\r
+  if (!EFI_ERROR(ShellConvertStringToUint64(String, &RetVal, Hex, TRUE))) {\r
+    return ((UINTN)RetVal);\r
+  }\r
+  return ((UINTN)(-1));\r
 }\r
 \r
 /**\r
@@ -3086,7 +3128,7 @@ ShellPromptForResponse (
   Buffer  = NULL;\r
   Size    = 0;\r
   if (Type != ShellPromptResponseTypeFreeform) {\r
-    Resp = (SHELL_PROMPT_RESPONSE*)AllocatePool(sizeof(SHELL_PROMPT_RESPONSE));\r
+    Resp = (SHELL_PROMPT_RESPONSE*)AllocateZeroPool(sizeof(SHELL_PROMPT_RESPONSE));\r
     if (Resp == NULL) {\r
       return (EFI_OUT_OF_RESOURCES);\r
     }\r
@@ -3315,7 +3357,7 @@ ShellPromptForResponseHii (
 **/\r
 BOOLEAN\r
 EFIAPI\r
-ShellIsHexOrDecimalNumber (\r
+InternalShellIsHexOrDecimalNumber (\r
   IN CONST CHAR16   *String,\r
   IN CONST BOOLEAN  ForceHex,\r
   IN CONST BOOLEAN  StopAtSpace\r
@@ -3372,6 +3414,7 @@ ShellIsHexOrDecimalNumber (
       }\r
     }\r
   }\r
+\r
   return (TRUE);\r
 }\r
 \r
@@ -3405,3 +3448,350 @@ ShellFileExists(
 \r
   return (EFI_SUCCESS);\r
 }\r
+\r
+/**\r
+  Convert a Unicode character to upper case only if \r
+  it maps to a valid small-case ASCII character.\r
+\r
+  This internal function only deal with Unicode character\r
+  which maps to a valid small-case ASCII character, i.e.\r
+  L'a' to L'z'. For other Unicode character, the input character\r
+  is returned directly.\r
+\r
+  @param  Char  The character to convert.\r
+\r
+  @retval LowerCharacter   If the Char is with range L'a' to L'z'.\r
+  @retval Unchanged        Otherwise.\r
+\r
+**/\r
+CHAR16\r
+EFIAPI\r
+InternalShellCharToUpper (\r
+  IN      CHAR16                    Char\r
+  )\r
+{\r
+  if (Char >= L'a' && Char <= L'z') {\r
+    return (CHAR16) (Char - (L'a' - L'A'));\r
+  }\r
+\r
+  return Char;\r
+}\r
+\r
+/**\r
+  Convert a Unicode character to numerical value.\r
+\r
+  This internal function only deal with Unicode character\r
+  which maps to a valid hexadecimal ASII character, i.e.\r
+  L'0' to L'9', L'a' to L'f' or L'A' to L'F'. For other \r
+  Unicode character, the value returned does not make sense.\r
+\r
+  @param  Char  The character to convert.\r
+\r
+  @return The numerical value converted.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+InternalShellHexCharToUintn (\r
+  IN      CHAR16                    Char\r
+  )\r
+{\r
+  if (ShellIsDecimalDigitCharacter (Char)) {\r
+    return Char - L'0';\r
+  }\r
+\r
+  return (UINTN) (10 + InternalShellCharToUpper (Char) - L'A');\r
+}\r
+\r
+/**\r
+  Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.\r
+\r
+  This function returns a value of type UINTN by interpreting the contents\r
+  of the Unicode string specified by String as a hexadecimal number.\r
+  The format of the input Unicode string String is:\r
+\r
+                  [spaces][zeros][x][hexadecimal digits].\r
+\r
+  The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].\r
+  The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.\r
+  If "x" appears in the input string, it must be prefixed with at least one 0.\r
+  The function will ignore the pad space, which includes spaces or tab characters,\r
+  before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or\r
+  [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the\r
+  first valid hexadecimal digit. Then, the function stops at the first character that is\r
+  a not a valid hexadecimal character or NULL, whichever one comes first.\r
+\r
+  If String has only pad spaces, then zero is returned.\r
+  If String has no leading pad spaces, leading zeros or valid hexadecimal digits,\r
+  then zero is returned.\r
+\r
+  @param[in]  String      A pointer to a Null-terminated Unicode string.\r
+  @param[out] Value       Upon a successful return the value of the conversion.\r
+  @param[in] StopAtSpace  FALSE to skip spaces.\r
+\r
+  @retval EFI_SUCCESS             The conversion was successful.\r
+  @retval EFI_INVALID_PARAMETER   A parameter was NULL or invalid.\r
+  @retval EFI_DEVICE_ERROR        An overflow occured.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InternalShellStrHexToUint64 (\r
+  IN CONST CHAR16   *String,\r
+     OUT   UINT64   *Value,\r
+  IN CONST BOOLEAN  StopAtSpace\r
+  )\r
+{\r
+  UINT64    Result;\r
+\r
+  if (String == NULL || StrSize(String) == 0 || Value == NULL) {\r
+    return (EFI_INVALID_PARAMETER);\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 (InternalShellCharToUpper (*String) == L'X') {\r
+    if (*(String - 1) != L'0') {\r
+      return 0;\r
+    }\r
+    //\r
+    // Skip the 'X'\r
+    //\r
+    String++;\r
+  }\r
+\r
+  Result = 0;\r
+  \r
+  //\r
+  // Skip spaces if requested\r
+  //\r
+  while (StopAtSpace && *String == L' ') {\r
+    String++;\r
+  }\r
+  \r
+  while (ShellIsHexaDecimalDigitCharacter (*String)) {\r
+    //\r
+    // If the Hex Number represented by String overflows according \r
+    // to the range defined by UINTN, then ASSERT().\r
+    //\r
+    if (!(Result <= (RShiftU64((((UINT64) ~0) - InternalShellHexCharToUintn (*String)), 4)))) {\r
+//    if (!(Result <= ((((UINT64) ~0) - InternalShellHexCharToUintn (*String)) >> 4))) {\r
+      return (EFI_DEVICE_ERROR);\r
+    }\r
+\r
+    Result = (LShiftU64(Result, 4));\r
+    Result += InternalShellHexCharToUintn (*String);\r
+    String++;\r
+\r
+    //\r
+    // Skip spaces if requested\r
+    //\r
+    while (StopAtSpace && *String == L' ') {\r
+      String++;\r
+    }\r
+  }\r
+\r
+  *Value = Result;\r
+  return (EFI_SUCCESS);\r
+}\r
+\r
+/**\r
+  Convert a Null-terminated Unicode decimal string to a value of\r
+  type UINT64.\r
+\r
+  This function returns a value of type UINT64 by interpreting the contents\r
+  of the Unicode string specified by String as a decimal number. The format\r
+  of the input Unicode string String is:\r
+\r
+                  [spaces] [decimal digits].\r
+\r
+  The valid decimal digit character is in the range [0-9]. The\r
+  function will ignore the pad space, which includes spaces or\r
+  tab characters, before [decimal digits]. The running zero in the\r
+  beginning of [decimal digits] will be ignored. Then, the function\r
+  stops at the first character that is a not a valid decimal character\r
+  or a Null-terminator, whichever one comes first.\r
+\r
+  If String has only pad spaces, then 0 is returned.\r
+  If String has no pad spaces or valid decimal digits,\r
+  then 0 is returned.\r
+\r
+  @param[in]  String      A pointer to a Null-terminated Unicode string.\r
+  @param[out] Value       Upon a successful return the value of the conversion.\r
+  @param[in] StopAtSpace  FALSE to skip spaces.\r
+\r
+  @retval EFI_SUCCESS             The conversion was successful.\r
+  @retval EFI_INVALID_PARAMETER   A parameter was NULL or invalid.\r
+  @retval EFI_DEVICE_ERROR        An overflow occured.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InternalShellStrDecimalToUint64 (\r
+  IN CONST CHAR16 *String,\r
+     OUT   UINT64 *Value,\r
+  IN CONST BOOLEAN  StopAtSpace\r
+  )\r
+{\r
+  UINT64     Result;\r
+\r
+  if (String == NULL || StrSize (String) == 0 || Value == NULL) {\r
+    return (EFI_INVALID_PARAMETER);\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
+  Result = 0;\r
+\r
+  //\r
+  // Skip spaces if requested\r
+  //\r
+  while (StopAtSpace && *String == L' ') {\r
+    String++;\r
+  }\r
+  while (ShellIsDecimalDigitCharacter (*String)) {\r
+    //\r
+    // If the number represented by String overflows according \r
+    // to the range defined by UINT64, then ASSERT().\r
+    //\r
+    \r
+    if (!(Result <= (DivU64x32((((UINT64) ~0) - (*String - L'0')),10)))) {\r
+      return (EFI_DEVICE_ERROR);\r
+    }\r
+\r
+    Result = MultU64x32(Result, 10) + (*String - L'0');\r
+    String++;\r
+\r
+    //\r
+    // Stop at spaces if requested\r
+    //\r
+    if (StopAtSpace && *String == L' ') {\r
+      break;\r
+    }\r
+  }\r
+\r
+  *Value = Result;\r
+  \r
+  return (EFI_SUCCESS);\r
+}\r
+\r
+/**\r
+  Function to verify and convert a string to its numerical value.\r
+\r
+  If Hex it must be preceeded with a 0x, 0X, or has ForceHex set TRUE.\r
+\r
+  @param[in] String       The string to evaluate.\r
+  @param[out] Value       Upon a successful return the value of the conversion.\r
+  @param[in] ForceHex     TRUE - always assume hex.\r
+  @param[in] StopAtSpace  FALSE to skip spaces.\r
+  \r
+  @retval EFI_SUCCESS             The conversion was successful.\r
+  @retval EFI_INVALID_PARAMETER   String contained an invalid character.\r
+  @retval EFI_NOT_FOUND           String was a number, but Value was NULL.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+ShellConvertStringToUint64(\r
+  IN CONST CHAR16   *String,\r
+     OUT   UINT64   *Value,\r
+  IN CONST BOOLEAN  ForceHex,\r
+  IN CONST BOOLEAN  StopAtSpace\r
+  )\r
+{\r
+  UINT64        RetVal;\r
+  CONST CHAR16  *Walker;\r
+  EFI_STATUS    Status;\r
+  BOOLEAN       Hex;\r
+\r
+  Hex = ForceHex;\r
+\r
+  if (!InternalShellIsHexOrDecimalNumber(String, Hex, StopAtSpace)) {\r
+    if (!Hex) {\r
+      Hex = TRUE;\r
+      if (!InternalShellIsHexOrDecimalNumber(String, Hex, StopAtSpace)) {\r
+        return (EFI_INVALID_PARAMETER);\r
+      }\r
+    } else {\r
+      return (EFI_INVALID_PARAMETER);\r
+    }\r
+  }\r
+\r
+  //\r
+  // Chop off leading spaces\r
+  //\r
+  for (Walker = String; Walker != NULL && *Walker != CHAR_NULL && *Walker == L' '; Walker++);\r
+\r
+  //\r
+  // make sure we have something left that is numeric.\r
+  //\r
+  if (Walker == NULL || *Walker == CHAR_NULL || !InternalShellIsHexOrDecimalNumber(Walker, Hex, StopAtSpace)) {\r
+    return (EFI_INVALID_PARAMETER);\r
+  } \r
+\r
+  //\r
+  // do the conversion.\r
+  //\r
+  if (Hex || StrnCmp(Walker, L"0x", 2) == 0 || StrnCmp(Walker, L"0X", 2) == 0){\r
+    Status = InternalShellStrHexToUint64(Walker, &RetVal, StopAtSpace);\r
+  } else {\r
+    Status = InternalShellStrDecimalToUint64(Walker, &RetVal, StopAtSpace);\r
+  }\r
+\r
+  if (Value == NULL && !EFI_ERROR(Status)) {\r
+    return (EFI_NOT_FOUND);\r
+  }\r
+\r
+  if (Value != NULL) {\r
+    *Value = RetVal;\r
+  }\r
+\r
+  return (Status);\r
+}\r
+\r
+/**\r
+  Function to determin if an entire string is a valid number.\r
+\r
+  If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.\r
+\r
+  @param[in] String       The string to evaluate.\r
+  @param[in] ForceHex     TRUE - always assume hex.\r
+  @param[in] StopAtSpace  TRUE to halt upon finding a space, FALSE to keep going.\r
+\r
+  @retval TRUE        It is all numeric (dec/hex) characters.\r
+  @retval FALSE       There is a non-numeric character.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+ShellIsHexOrDecimalNumber (\r
+  IN CONST CHAR16   *String,\r
+  IN CONST BOOLEAN  ForceHex,\r
+  IN CONST BOOLEAN  StopAtSpace\r
+  )\r
+{\r
+  if (ShellConvertStringToUint64(String, NULL, ForceHex, StopAtSpace) == EFI_NOT_FOUND) {\r
+    return (TRUE);\r
+  }\r
+  return (FALSE);\r
+}\r
index 044179797de635bfbe891ed1684fbac944a847fb..9baa3e45bcaf8df0d2b1a2a79cd235156eaee496 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Provides interface to shell functionality for shell commands and applications.\r
 \r
-  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2006 - 2011, 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
@@ -12,6 +12,9 @@
 \r
 **/\r
 \r
+#if !defined (_UEFI_SHELL_LIB_INTERNAL_H_)\r
+#define _UEFI_SHELL_LIB_INTERNAL_H_\r
+\r
 #include <Uefi.h>\r
 \r
 #include <Guid/FileInfo.h>\r
@@ -48,3 +51,26 @@ typedef struct  {
   EFI_SHELL_FLUSH_FILE                      FlushFile;\r
   EFI_SHELL_GET_FILE_SIZE                   GetFileSize;\r
 } FILE_HANDLE_FUNCTION_MAP;\r
+\r
+/**\r
+  Function to determin if an entire string is a valid number.\r
+\r
+  If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.\r
+\r
+  @param[in] String       The string to evaluate.\r
+  @param[in] ForceHex     TRUE - always assume hex.\r
+  @param[in] StopAtSpace  TRUE to halt upon finding a space, FALSE to keep going.\r
+\r
+  @retval TRUE        It is all numeric (dec/hex) characters.\r
+  @retval FALSE       There is a non-numeric character.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+InternalShellIsHexOrDecimalNumber (\r
+  IN CONST CHAR16   *String,\r
+  IN CONST BOOLEAN  ForceHex,\r
+  IN CONST BOOLEAN  StopAtSpace\r
+  );\r
+\r
+#endif\r
+\r
index bcbf9bdd7ad3d91aa3f9cea0b496e238cc5fdea9..18803bdcb8e53bdc11287945786cfc7a7f95f443 100644 (file)
@@ -1,7 +1,7 @@
 ##  @file\r
 # Provides interface to shell functionality for shell commands and applications.\r
 #\r
-# Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved. <BR>\r
+# Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved. <BR>\r
 #\r
 #  This program and the accompanying materials\r
 #  are licensed and made available under the terms and conditions of the BSD License\r
@@ -47,6 +47,7 @@
   PrintLib\r
   UefiLib\r
   HiiLib\r
+  SortLib\r
 \r
 [Protocols]\r
   gEfiSimpleFileSystemProtocolGuid              # ALWAYS_CONSUMED\r