MdeModulePkg, MdePkg, NetworkPkg, OvmfPkg, PerformancePkg, ShellPkg: Library Migration.

Move libraries from ShellPkg into MdeModulePkg and MdePkg.

The following libraries are being migrated out of ShellPkg in order to make
their functionality more widely available.
  • PathLib:        Incorporate into MdePkg/Library/BaseLib
  • FileHandleLib:  MdePkg/Library/UefiFileHandleLib
  • BaseSortLib:    MdeModulePkg/Library/BaseSortLib
  • UefiSortLib:    MdeModulePkg/Library/UefiSortLib

Diffs showing file changes are in the attached file, LibMigration.patch.
A description of the changes follows:

  • Move ShellPkg/Include/Library/FileHandleLib.h to MdePkg/Include/Library/FileHandleLib.h
  • Move ShellPkg/Include/Library/SortLib.h to MdeModulePkg/Include/Library/SortLib.h
  • Move ShellPkg/Library/BaseSortLib to MdeModulePkg/Library/BaseSortLib
  • Move ShellPkg/Library/UefiSortLib to MdeModulePkg/Library/UefiSortLib
  • Move ShellPkg/Library/BasePathLib/BasePathLib.c to MdePkg/Library/BaseLib/FilePaths.c
  • Merge ShellPkg/Include/Library/PathLib.h into MdePkg/Include/Library/BaseLib.h
  • Delete  ShellPkg/Library/BasePathLib; Includes BasePathLib.c and BasePathLib.inf

  • NetworkPkg/NetworkPkg.dsc
  • PerformancePkg.dsc
  • OvmfPkg/OvmfPkgX64.dsc
  • OvmfPkg/OvmfPkgIa32X64.dsc
  • OvmfPkg/OvmfPkgIa32.dsc
    o Update SortLib and FileHandleLib library classes to point to the new library locations.
    o Remove PathLib library class and make sure that BaseLib is described.

  • MdeModulePkg/MdeModulePkg.dec
    o Add SortLib library class

  • MdePkg/MdePkg.dec
    o Add FileHandleLib library class
    o Add PcdUefiFileHandleLibPrintBufferSize PCD

  • MdePkg/Library/BaseLib/BaseLib.inf
    o Add FilePaths.c to [Sources]

  • MdePkg/Include/Library/BaseLib.h
    o Update file description to include "file path functions"

  • ShellPkg/ShellPkg.dsc
    o Change PACKAGE_GUID to { C1014BB7-4092-43D4-984F-0738EB424DBF }
    o Update PACKAGE_VERSION to 1.0
    o Update SortLib and FileHandleLib library classes to point to the new library locations.
    o Remove PathLib library class and make sure that BaseLib is described.
    o Remove ShellPkg/Library/UefiFileHandleLib/UefiFileHandleLib.inf from [Components]

  • ShellPkg/ShellPkg.dec
    o Update PLATFORM_VERSION to 1.0
    o Remove declarations of the FileHandleLib, SortLib, and PathLib Library Classes
    o Update comment for the PcdShellPrintBufferSize PCD.

  • ShellPkg/Library/UefiShellLevel2CommandsLib/UefiShellLevel2CommandsLib.inf
  • ShellPkg/Application/Shell/Shell.inf
    o Remove PathLib from [LibraryClasses]

  • ShellPkg/Library/UefiShellLevel2CommandsLib/UefiShellLevel2CommandsLib.h
  • ShellPkg/Application/Shell/Shell.h
    o Remove #include <Library/PathLib.h>

  • ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.inf
    o Add PathLib to [LibraryClasses]

  • ShellPkg/Library/UefiShellLevel1CommandsLib/If.c
    o Remove #include <Library/PathLib.h>

  • ShellPkg/Application/ShellSortTestApp/ShellSortTestApp.inf
    o Add MdeModulePkg/MdeModulePkg.dec to [Packages]

  • MdeModulePkg/Library/BaseSortLib/BaseSortLib.inf
  • MdeModulePkg/Library/UefiSortLib/UefiSortLib.inf
    o Replace ShellPkg.dec with MdeModulePkg.dec in [Packages]

  • MdeModulePkg/Library/UefiSortLib/UefiSortLib.c
    o Remove #include <ShellBase.h>
    o Define USL_FREE_NON_NULL() to replace SHELL_FREE_NON_NULL()

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Daryl McDaniel <daryl.mcdaniel@intel.com>
Reviewed-by: Jaben Carsey <jaben.carsey@intel.com>
Reviewed-by: Erik Bjorge <erik.c.bjorge@intel.com>


git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@16601 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 47 insertions, 10 deletions

diff --git a/MdePkg/Include/Library/BaseLib.h b/MdePkg/Include/Library/BaseLib.h
index bd3f9cfc60..750f82e8f7 100644
--- a/MdePkg/Include/Library/BaseLib.h
+++ b/MdePkg/Include/Library/BaseLib.h
@@ -1,8 +1,8 @@
 /** @file

   Provides string functions, linked list functions, math functions, synchronization

-  functions, and CPU architecture-specific functions.

+  functions, file path functions, and CPU architecture-specific functions.

 

-Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>

 Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

@@ -484,7 +484,7 @@ AsciiStrnCatS (
 #ifndef DISABLE_NEW_DEPRECATED_INTERFACES

 

 /**

-  [ATTENTION] This function will be deprecated for security reason.

+  [ATTENTION] This function is deprecated for security reason.

 

   Copies one Null-terminated Unicode string to another Null-terminated Unicode

   string and returns the new Unicode string.

@@ -517,7 +517,7 @@ StrCpy (
 

 

 /**

-  [ATTENTION] This function will be deprecated for security reason.

+  [ATTENTION] This function is deprecated for security reason.

 

   Copies up to a specified length from one Null-terminated Unicode string to 

   another Null-terminated Unicode string and returns the new Unicode string.

@@ -686,7 +686,7 @@ StrnCmp (
 #ifndef DISABLE_NEW_DEPRECATED_INTERFACES

 

 /**

-  [ATTENTION] This function will be deprecated for security reason.

+  [ATTENTION] This function is deprecated for security reason.

 

   Concatenates one Null-terminated Unicode string to another Null-terminated

   Unicode string, and returns the concatenated Unicode string.

@@ -728,7 +728,7 @@ StrCat (
 

 

 /**

-  [ATTENTION] This function will be deprecated for security reason.

+  [ATTENTION] This function is deprecated for security reason.

 

   Concatenates up to a specified length one Null-terminated Unicode to the end 

   of another Null-terminated Unicode string, and returns the concatenated 

@@ -1016,7 +1016,7 @@ UnicodeStrToAsciiStr (
 #ifndef DISABLE_NEW_DEPRECATED_INTERFACES

 

 /**

-  [ATTENTION] This function will be deprecated for security reason.

+  [ATTENTION] This function is deprecated for security reason.

 

   Copies one Null-terminated ASCII string to another Null-terminated ASCII

   string and returns the new ASCII string.

@@ -1047,7 +1047,7 @@ AsciiStrCpy (
 

 

 /**

-  [ATTENTION] This function will be deprecated for security reason.

+  [ATTENTION] This function is deprecated for security reason.

 

   Copies up to a specified length one Null-terminated ASCII string to another 

   Null-terminated ASCII string and returns the new ASCII string.

@@ -1245,7 +1245,7 @@ AsciiStrnCmp (
 #ifndef DISABLE_NEW_DEPRECATED_INTERFACES

 

 /**

-  [ATTENTION] This function will be deprecated for security reason.

+  [ATTENTION] This function is deprecated for security reason.

 

   Concatenates one Null-terminated ASCII string to another Null-terminated

   ASCII string, and returns the concatenated ASCII string.

@@ -1282,7 +1282,7 @@ AsciiStrCat (
 

 

 /**

-  [ATTENTION] This function will be deprecated for security reason.

+  [ATTENTION] This function is deprecated for security reason.

 

   Concatenates up to a specified length one Null-terminated ASCII string to 

   the end of another Null-terminated ASCII string, and returns the 

@@ -1591,6 +1591,43 @@ BcdToDecimal8 (
   IN      UINT8                     Value

   );

 

+//

+//  File Path Manipulation Functions

+//

+

+/**

+  Removes the last directory or file entry in a path by changing the last

+  L'\' to a CHAR_NULL.

+

+  @param[in, out] Path    The pointer to the path to modify.

+

+  @retval FALSE     Nothing was found to remove.

+  @retval TRUE      A directory or file was removed.

+**/

+BOOLEAN

+EFIAPI

+PathRemoveLastItem(

+  IN OUT CHAR16 *Path

+  );

+

+/**

+  Function to clean up paths.

+    - Single periods in the path are removed.

+    - Double periods in the path are removed along with a single parent directory.

+    - Forward slashes L'/' are converted to backward slashes L'\'.

+

+  This will be done inline and the existing buffer may be larger than required

+  upon completion.

+

+  @param[in] Path       The pointer to the string containing the path.

+

+  @return       Returns Path, otherwise returns NULL to indicate that an error has occured.

+**/

+CHAR16*

+EFIAPI

+PathCleanUpDirectories(

+  IN CHAR16 *Path

+);

 

 //

 // Linked List Functions and Macros