add comments to function declarations and definitions and updated to match coding...

[mirror_edk2.git] / ShellPkg / Library / UefiShellLib / UefiShellLib.h

diff --git a/ShellPkg/Library/UefiShellLib/UefiShellLib.h b/ShellPkg/Library/UefiShellLib/UefiShellLib.h
index fe886ae79e2b8946c8df7cdaa1175a3665917036..32f1c6596d1d74307b8d7cb88f4148c6ddb4be86 100644 (file)
--- a/ShellPkg/Library/UefiShellLib/UefiShellLib.h
+++ b/ShellPkg/Library/UefiShellLib/UefiShellLib.h
@@ -1,8 +1,8 @@
 /** @file\r
   Provides interface to shell functionality for shell commands and applications.\r
 \r
-  Copyright (c) 2006 - 2010, Intel Corporation<BR>\r
-  All rights reserved. This program and the accompanying materials\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
   http://opensource.org/licenses/bsd-license.php\r
@@ -12,6 +12,9 @@
 \r
 **/\r
 \r
+#ifndef _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