Comment's added and fixed.

[mirror_edk2.git] / ShellPkg / Include / ShellBase.h

diff --git a/ShellPkg/Include/ShellBase.h b/ShellPkg/Include/ShellBase.h
index d5f0b03eec30db1ff19671aecb0dde89715662f2..73ef064207814028880c112ea4ad689f614cc1e0 100644 (file)
--- a/ShellPkg/Include/ShellBase.h
+++ b/ShellPkg/Include/ShellBase.h
@@ -1,20 +1,34 @@
 /** @file\r
   Root include file for Shell Package modules that utilize the SHELL_RETURN type\r
 \r
-Copyright (c), 2009, Intel Corporation<BR>\r
-All rights reserved. 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
+  Copyright (c) 2009 - 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
 \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
+  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
 **/\r
 \r
-#if !defined(__SHELL_BASE__)\r
+#ifndef __SHELL_BASE__\r
 #define __SHELL_BASE__\r
 \r
+#define ABS(a) ((a<0)?(-(a)):(a))\r
+\r
+typedef VOID *SHELL_FILE_HANDLE;\r
+\r
+#ifndef SHELL_FREE_NON_NULL\r
+#define SHELL_FREE_NON_NULL(Pointer)  \\r
+  do {                                \\r
+    if ((Pointer) != NULL) {          \\r
+      FreePool((Pointer));            \\r
+      (Pointer) = NULL;               \\r
+    }                                 \\r
+  } while(FALSE)\r
+#endif //SHELL_FREE_NON_NULL\r
+\r
 typedef enum {\r
 ///\r
 /// The operation completed successfully.\r
@@ -60,7 +74,7 @@ SHELL_NOT_READY             = 6,
 SHELL_DEVICE_ERROR          = 7,\r
 \r
 ///\r
-/// The device can not be written to.\r
+/// The device cannot be written to.\r
 ///\r
 SHELL_WRITE_PROTECTED       = 8,\r
 \r
@@ -70,7 +84,7 @@ SHELL_WRITE_PROTECTED       = 8,
 SHELL_OUT_OF_RESOURCES      = 9,\r
 \r
 ///\r
-/// An inconsistency was detected on the file system causing the \r
+/// An inconsistency was detected on the file system causing the\r
 /// operation to fail.\r
 ///\r
 SHELL_VOLUME_CORRUPTED      = 10,\r
@@ -81,7 +95,7 @@ SHELL_VOLUME_CORRUPTED      = 10,
 SHELL_VOLUME_FULL           = 11,\r
 \r
 ///\r
-/// The device does not contain any medium to perform the \r
+/// The device does not contain any medium to perform the\r
 /// operation.\r
 ///\r
 SHELL_NO_MEDIA              = 12,\r