ShellPkg: Refactor Print logic out of main loop function

This has no change in the behavior of the LS command, but it removes the printing logic from the main recursive function.  This is the first step toward changing the code flow without affecting the look and feel.

The long term goal is correcting the recursion to be more clean and useful to users.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-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@15179 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/ShellPkg/Library/UefiShellLevel2CommandsLib/Ls.c b/ShellPkg/Library/UefiShellLevel2CommandsLib/Ls.c
index cc4a9d4cf22338fe25f4654df00d3afc2b251c13..60b8c5b492fa722981e8c21e7f4bd50f707c2e61 100644 (file)
--- a/ShellPkg/Library/UefiShellLevel2CommandsLib/Ls.c
+++ b/ShellPkg/Library/UefiShellLevel2CommandsLib/Ls.c
@@ -2,7 +2,7 @@
   Main file for ls shell level 2 function.\r
 \r
   Copyright (c) 2013 Hewlett-Packard Development Company, L.P.\r
-  Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2009 - 2014, 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
@@ -16,6 +16,310 @@
 #include "UefiShellLevel2CommandsLib.h"\r
 #include <Guid/FileSystemInfo.h>\r
 \r
+/**\r
+  print out the standard format output volume entry.\r
+\r
+  @param[in] TheList           a list of files from the volume.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+PrintSfoVolumeInfoTableEntry(\r
+  IN CONST EFI_SHELL_FILE_INFO *TheList\r
+  )\r
+{\r
+  EFI_STATUS            Status;\r
+  EFI_SHELL_FILE_INFO   *Node;\r
+  CHAR16                *DirectoryName;\r
+  EFI_FILE_SYSTEM_INFO  *SysInfo;\r
+  UINTN                 SysInfoSize;\r
+  SHELL_FILE_HANDLE     ShellFileHandle;\r
+  EFI_FILE_PROTOCOL     *EfiFpHandle;\r
+\r
+  //\r
+  // Get the first valid handle (directories)\r
+  //\r
+  for ( Node = (EFI_SHELL_FILE_INFO *)GetFirstNode(&TheList->Link)\r
+      ; !IsNull(&TheList->Link, &Node->Link) && Node->Handle == NULL\r
+      ; Node = (EFI_SHELL_FILE_INFO *)GetNextNode(&TheList->Link, &Node->Link)\r
+     );\r
+\r
+  if (Node->Handle == NULL) {\r
+    DirectoryName = GetFullyQualifiedPath(((EFI_SHELL_FILE_INFO *)GetFirstNode(&TheList->Link))->FullName);\r
+\r
+    //\r
+    // We need to open something up to get system information\r
+    //\r
+    Status = gEfiShellProtocol->OpenFileByName(\r
+      DirectoryName,\r
+      &ShellFileHandle,\r
+      EFI_FILE_MODE_READ\r
+      );\r
+\r
+    ASSERT_EFI_ERROR(Status);\r
+    FreePool(DirectoryName);\r
+\r
+    //\r
+    // Get the Volume Info from ShellFileHandle\r
+    //\r
+    SysInfo     = NULL;\r
+    SysInfoSize = 0;\r
+    EfiFpHandle = ConvertShellHandleToEfiFileProtocol(ShellFileHandle);\r
+    Status = EfiFpHandle->GetInfo(\r
+      EfiFpHandle,\r
+      &gEfiFileSystemInfoGuid,\r
+      &SysInfoSize,\r
+      SysInfo\r
+      );\r
+\r
+    if (Status == EFI_BUFFER_TOO_SMALL) {\r
+      SysInfo = AllocateZeroPool(SysInfoSize);\r
+      Status = EfiFpHandle->GetInfo(\r
+        EfiFpHandle,\r
+        &gEfiFileSystemInfoGuid,\r
+        &SysInfoSize,\r
+        SysInfo\r
+        );\r
+    }\r
+\r
+    ASSERT_EFI_ERROR(Status);\r
+\r
+    gEfiShellProtocol->CloseFile(ShellFileHandle);\r
+  } else {\r
+    //\r
+    // Get the Volume Info from Node->Handle\r
+    //\r
+    SysInfo = NULL;\r
+    SysInfoSize = 0;\r
+    EfiFpHandle = ConvertShellHandleToEfiFileProtocol(Node->Handle);\r
+    Status = EfiFpHandle->GetInfo(\r
+      EfiFpHandle,\r
+      &gEfiFileSystemInfoGuid,\r
+      &SysInfoSize,\r
+      SysInfo\r
+      );\r
+\r
+    if (Status == EFI_BUFFER_TOO_SMALL) {\r
+      SysInfo = AllocateZeroPool(SysInfoSize);\r
+      Status = EfiFpHandle->GetInfo(\r
+        EfiFpHandle,\r
+        &gEfiFileSystemInfoGuid,\r
+        &SysInfoSize,\r
+        SysInfo\r
+        );\r
+    }\r
+\r
+    ASSERT_EFI_ERROR(Status);\r
+  }\r
+\r
+  ShellPrintHiiEx (\r
+    -1,\r
+    -1,\r
+    NULL,\r
+    STRING_TOKEN (STR_GEN_SFO_HEADER),\r
+    gShellLevel2HiiHandle,\r
+    L"ls"\r
+    );\r
+  //\r
+  // print VolumeInfo table\r
+  //\r
+  ASSERT(SysInfo != NULL);\r
+  ShellPrintHiiEx (\r
+    0,\r
+    gST->ConOut->Mode->CursorRow,\r
+    NULL,\r
+    STRING_TOKEN (STR_LS_SFO_VOLINFO),\r
+    gShellLevel2HiiHandle,\r
+    SysInfo->VolumeLabel,\r
+    SysInfo->VolumeSize,\r
+    SysInfo->ReadOnly?L"TRUE":L"FALSE",\r
+    SysInfo->FreeSpace,\r
+    SysInfo->BlockSize\r
+    );\r
+\r
+  SHELL_FREE_NON_NULL(SysInfo);\r
+\r
+  return (Status);\r
+}\r
+\r
+/**\r
+  print out the info on a single file.\r
+\r
+  @param[in] Sfo      TRUE if in SFO, false otherwise.\r
+  @param[in] TheNode  the EFI_SHELL_FILE_INFO node to print out information on.\r
+  @param[in] Files    incremented if a file is printed.\r
+  @param[in] Size     incremented by file size.\r
+  @param[in] Dirs     incremented if a directory is printed.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+PrintFileInformation(\r
+  IN CONST BOOLEAN              Sfo, \r
+  IN CONST EFI_SHELL_FILE_INFO  *TheNode, \r
+  IN UINT64                     *Files, \r
+  IN UINT64                     *Size, \r
+  IN UINT64                     *Dirs\r
+  )\r
+{\r
+  ASSERT(Files    != NULL);\r
+  ASSERT(Size     != NULL);\r
+  ASSERT(Dirs     != NULL);\r
+  ASSERT(TheNode  != NULL);\r
+\r
+  if (Sfo) {\r
+    //\r
+    // Print the FileInfo Table\r
+    //\r
+    ShellPrintHiiEx (\r
+      0,\r
+      gST->ConOut->Mode->CursorRow,\r
+      NULL,\r
+      STRING_TOKEN (STR_LS_SFO_FILEINFO),\r
+      gShellLevel2HiiHandle,\r
+      TheNode->FullName,\r
+      TheNode->Info->FileSize,\r
+      TheNode->Info->PhysicalSize,\r
+      (TheNode->Info->Attribute & EFI_FILE_ARCHIVE)   != 0?L"a":L"",\r
+      (TheNode->Info->Attribute & EFI_FILE_DIRECTORY) != 0?L"d":L"",\r
+      (TheNode->Info->Attribute & EFI_FILE_HIDDEN)    != 0?L"h":L"",\r
+      (TheNode->Info->Attribute & EFI_FILE_READ_ONLY) != 0?L"r":L"",\r
+      (TheNode->Info->Attribute & EFI_FILE_SYSTEM)    != 0?L"s":L"",\r
+      TheNode->Info->CreateTime.Hour,\r
+      TheNode->Info->CreateTime.Minute,\r
+      TheNode->Info->CreateTime.Second,\r
+      TheNode->Info->CreateTime.Day,\r
+      TheNode->Info->CreateTime.Month,\r
+      TheNode->Info->CreateTime.Year,\r
+      TheNode->Info->LastAccessTime.Hour,\r
+      TheNode->Info->LastAccessTime.Minute,\r
+      TheNode->Info->LastAccessTime.Second,\r
+      TheNode->Info->LastAccessTime.Day,\r
+      TheNode->Info->LastAccessTime.Month,\r
+      TheNode->Info->LastAccessTime.Year,\r
+      TheNode->Info->ModificationTime.Hour,\r
+      TheNode->Info->ModificationTime.Minute,\r
+      TheNode->Info->ModificationTime.Second,\r
+      TheNode->Info->ModificationTime.Day,\r
+      TheNode->Info->ModificationTime.Month,\r
+      TheNode->Info->ModificationTime.Year\r
+      );\r
+  } else {\r
+    //\r
+    // print this one out...\r
+    // first print the universal start, next print the type specific name format, last print the CRLF\r
+    //\r
+    ShellPrintHiiEx (\r
+      -1,\r
+      -1,\r
+      NULL,\r
+      STRING_TOKEN (STR_LS_LINE_START_ALL),\r
+      gShellLevel2HiiHandle,\r
+      &TheNode->Info->ModificationTime,\r
+      (TheNode->Info->Attribute & EFI_FILE_DIRECTORY) != 0?L"<DIR>":L"",\r
+      (TheNode->Info->Attribute & EFI_FILE_READ_ONLY) != 0?L'r':L' ',\r
+      TheNode->Info->FileSize\r
+      );\r
+    if (TheNode->Info->Attribute & EFI_FILE_DIRECTORY) {\r
+      (*Dirs)++;\r
+      ShellPrintHiiEx (\r
+        -1,\r
+        -1,\r
+        NULL,\r
+        STRING_TOKEN (STR_LS_LINE_END_DIR),\r
+        gShellLevel2HiiHandle,\r
+        TheNode->FileName\r
+        );\r
+    } else {\r
+      (*Files)++;\r
+      (*Size) += TheNode->Info->FileSize;\r
+      if ( (gUnicodeCollation->StriColl(gUnicodeCollation, (CHAR16*)L".nsh", (CHAR16*)&(TheNode->FileName[StrLen (TheNode->FileName) - 4])) == 0)\r
+        || (gUnicodeCollation->StriColl(gUnicodeCollation, (CHAR16*)L".efi", (CHAR16*)&(TheNode->FileName[StrLen (TheNode->FileName) - 4])) == 0)\r
+       ){\r
+        ShellPrintHiiEx (\r
+          -1,\r
+          -1,\r
+          NULL,\r
+          STRING_TOKEN (STR_LS_LINE_END_EXE),\r
+          gShellLevel2HiiHandle,\r
+          TheNode->FileName\r
+          );\r
+      } else {\r
+        ShellPrintHiiEx (\r
+          -1,\r
+          -1,\r
+          NULL,\r
+          STRING_TOKEN (STR_LS_LINE_END_FILE),\r
+          gShellLevel2HiiHandle,\r
+          TheNode->FileName\r
+          );\r
+      }\r
+    }\r
+  }\r
+}\r
+\r
+/**\r
+  print out the header when not using standard format output.\r
+\r
+  @param[in] Path           String with starting path.\r
+**/\r
+VOID\r
+EFIAPI\r
+PrintNonSfoHeader(\r
+  IN CONST CHAR16 *Path\r
+  )\r
+{\r
+  CHAR16 *DirectoryName;\r
+\r
+  //\r
+  // get directory name from path...\r
+  //\r
+  DirectoryName = GetFullyQualifiedPath(Path);\r
+\r
+  if (DirectoryName != NULL) {\r
+    //\r
+    // print header\r
+    //\r
+    ShellPrintHiiEx (\r
+      0,\r
+      gST->ConOut->Mode->CursorRow,\r
+      NULL,\r
+      STRING_TOKEN (STR_LS_HEADER_LINE1),\r
+      gShellLevel2HiiHandle,\r
+      DirectoryName\r
+      );\r
+\r
+    SHELL_FREE_NON_NULL(DirectoryName);\r
+  }\r
+}\r
+\r
+/**\r
+  print out the footer when not using standard format output.\r
+\r
+  @param[in] Path           String with starting path.\r
+**/\r
+VOID\r
+EFIAPI\r
+PrintNonSfoFooter(\r
+  IN UINT64                     Files, \r
+  IN UINT64                     Size, \r
+  IN UINT64                     Dirs\r
+  )\r
+{\r
+  //\r
+  // print footer\r
+  //\r
+  ShellPrintHiiEx (\r
+    -1,\r
+    -1,\r
+    NULL,\r
+    STRING_TOKEN (STR_LS_FOOTER_LINE),\r
+    gShellLevel2HiiHandle,\r
+    Files,\r
+    Size,\r
+    Dirs\r
+   );\r
+}\r
+\r
 /**\r
   print out the list of files and directories from the LS command\r
 \r
@@ -52,11 +356,7 @@ PrintLsOutput(
   UINT64                FileSize;\r
   CHAR16                *DirectoryName;\r
   UINTN                 LongestPath;\r
-  EFI_FILE_SYSTEM_INFO  *SysInfo;\r
-  UINTN                 SysInfoSize;\r
-  SHELL_FILE_HANDLE     ShellFileHandle;\r
   CHAR16                *CorrectedPath;\r
-  EFI_FILE_PROTOCOL     *EfiFpHandle;\r
 \r
   FileCount     = 0;\r
   DirCount      = 0;\r
@@ -74,23 +374,7 @@ PrintLsOutput(
   PathCleanUpDirectories(CorrectedPath);\r
 \r
   if (!Sfo) {\r
-    //\r
-    // get directory name from path...\r
-    //\r
-    DirectoryName = GetFullyQualifiedPath(CorrectedPath);\r
-\r
-    //\r
-    // print header\r
-    //\r
-    ShellPrintHiiEx (\r
-      0,\r
-      gST->ConOut->Mode->CursorRow,\r
-      NULL,\r
-      STRING_TOKEN (STR_LS_HEADER_LINE1),\r
-      gShellLevel2HiiHandle,\r
-      DirectoryName\r
-     );\r
-    FreePool(DirectoryName);\r
+    PrintNonSfoHeader(CorrectedPath);\r
   }\r
 \r
   Status = ShellOpenFileMetaArg((CHAR16*)CorrectedPath, EFI_FILE_MODE_READ, &ListHead);\r
@@ -114,109 +398,13 @@ PrintLsOutput(
   }\r
 \r
   if (Sfo && First) {\r
-    //\r
-    // Get the first valid handle (directories)\r
-    //\r
-    for ( Node = (EFI_SHELL_FILE_INFO *)GetFirstNode(&ListHead->Link)\r
-        ; !IsNull(&ListHead->Link, &Node->Link) && Node->Handle == NULL\r
-        ; Node = (EFI_SHELL_FILE_INFO *)GetNextNode(&ListHead->Link, &Node->Link)\r
-       );\r
-\r
-    if (Node->Handle == NULL) {\r
-      DirectoryName = GetFullyQualifiedPath(((EFI_SHELL_FILE_INFO *)GetFirstNode(&ListHead->Link))->FullName);\r
-\r
-      //\r
-      // We need to open something up to get system information\r
-      //\r
-      Status = gEfiShellProtocol->OpenFileByName(\r
-        DirectoryName,\r
-        &ShellFileHandle,\r
-        EFI_FILE_MODE_READ);\r
-\r
-      ASSERT_EFI_ERROR(Status);\r
-      FreePool(DirectoryName);\r
-\r
-      //\r
-      // Get the Volume Info from ShellFileHandle\r
-      //\r
-      SysInfo     = NULL;\r
-      SysInfoSize = 0;\r
-      EfiFpHandle = ConvertShellHandleToEfiFileProtocol(ShellFileHandle);\r
-      Status = EfiFpHandle->GetInfo(\r
-        EfiFpHandle,\r
-        &gEfiFileSystemInfoGuid,\r
-        &SysInfoSize,\r
-        SysInfo);\r
-\r
-      if (Status == EFI_BUFFER_TOO_SMALL) {\r
-        SysInfo = AllocateZeroPool(SysInfoSize);\r
-        Status = EfiFpHandle->GetInfo(\r
-          EfiFpHandle,\r
-          &gEfiFileSystemInfoGuid,\r
-          &SysInfoSize,\r
-          SysInfo);\r
-      }\r
-\r
-      ASSERT_EFI_ERROR(Status);\r
-\r
-      gEfiShellProtocol->CloseFile(ShellFileHandle);\r
-    } else {\r
-      //\r
-      // Get the Volume Info from Node->Handle\r
-      //\r
-      SysInfo = NULL;\r
-      SysInfoSize = 0;\r
-      EfiFpHandle = ConvertShellHandleToEfiFileProtocol(Node->Handle);\r
-      Status = EfiFpHandle->GetInfo(\r
-        EfiFpHandle,\r
-        &gEfiFileSystemInfoGuid,\r
-        &SysInfoSize,\r
-        SysInfo);\r
-\r
-      if (Status == EFI_BUFFER_TOO_SMALL) {\r
-        SysInfo = AllocateZeroPool(SysInfoSize);\r
-        Status = EfiFpHandle->GetInfo(\r
-          EfiFpHandle,\r
-          &gEfiFileSystemInfoGuid,\r
-          &SysInfoSize,\r
-          SysInfo);\r
-      }\r
-\r
-      ASSERT_EFI_ERROR(Status);\r
-    }\r
-\r
-    ShellPrintHiiEx (\r
-      -1,\r
-      -1,\r
-      NULL,\r
-      STRING_TOKEN (STR_GEN_SFO_HEADER),\r
-      gShellLevel2HiiHandle,\r
-      L"ls");\r
-    //\r
-    // print VolumeInfo table\r
-    //\r
-    ASSERT(SysInfo != NULL);\r
-    ShellPrintHiiEx (\r
-      0,\r
-      gST->ConOut->Mode->CursorRow,\r
-      NULL,\r
-      STRING_TOKEN (STR_LS_SFO_VOLINFO),\r
-      gShellLevel2HiiHandle,\r
-      SysInfo->VolumeLabel,\r
-      SysInfo->VolumeSize,\r
-      SysInfo->ReadOnly?L"TRUE":L"FALSE",\r
-      SysInfo->FreeSpace,\r
-      SysInfo->BlockSize\r
-     );\r
-    if (SysInfo != NULL) {\r
-      FreePool(SysInfo);\r
-    }\r
+    PrintSfoVolumeInfoTableEntry(ListHead);\r
   }\r
 \r
   for ( Node = (EFI_SHELL_FILE_INFO *)GetFirstNode(&ListHead->Link)\r
       ; !IsNull(&ListHead->Link, &Node->Link)\r
       ; Node = (EFI_SHELL_FILE_INFO *)GetNextNode(&ListHead->Link, &Node->Link)\r
-     ){\r
+      ){\r
     ASSERT(Node != NULL);\r
     if (LongestPath < StrSize(Node->FullName)) {\r
       LongestPath = StrSize(Node->FullName);\r
@@ -246,111 +434,11 @@ PrintLsOutput(
       }\r
     }\r
 \r
-    if (Sfo) {\r
-      //\r
-      // Print the FileInfo Table\r
-      //\r
-    ShellPrintHiiEx (\r
-      0,\r
-      gST->ConOut->Mode->CursorRow,\r
-      NULL,\r
-      STRING_TOKEN (STR_LS_SFO_FILEINFO),\r
-      gShellLevel2HiiHandle,\r
-      Node->FullName,\r
-      Node->Info->FileSize,\r
-      Node->Info->PhysicalSize,\r
-      (Node->Info->Attribute & EFI_FILE_ARCHIVE)   != 0?L"a":L"",\r
-      (Node->Info->Attribute & EFI_FILE_DIRECTORY) != 0?L"d":L"",\r
-      (Node->Info->Attribute & EFI_FILE_HIDDEN)    != 0?L"h":L"",\r
-      (Node->Info->Attribute & EFI_FILE_READ_ONLY) != 0?L"r":L"",\r
-      (Node->Info->Attribute & EFI_FILE_SYSTEM)    != 0?L"s":L"",\r
-      Node->Info->CreateTime.Hour,\r
-      Node->Info->CreateTime.Minute,\r
-      Node->Info->CreateTime.Second,\r
-      Node->Info->CreateTime.Day,\r
-      Node->Info->CreateTime.Month,\r
-      Node->Info->CreateTime.Year,\r
-      Node->Info->LastAccessTime.Hour,\r
-      Node->Info->LastAccessTime.Minute,\r
-      Node->Info->LastAccessTime.Second,\r
-      Node->Info->LastAccessTime.Day,\r
-      Node->Info->LastAccessTime.Month,\r
-      Node->Info->LastAccessTime.Year,\r
-      Node->Info->ModificationTime.Hour,\r
-      Node->Info->ModificationTime.Minute,\r
-      Node->Info->ModificationTime.Second,\r
-      Node->Info->ModificationTime.Day,\r
-      Node->Info->ModificationTime.Month,\r
-      Node->Info->ModificationTime.Year\r
-     );\r
-    } else {\r
-      //\r
-      // print this one out...\r
-      // first print the universal start, next print the type specific name format, last print the CRLF\r
-      //\r
-      ShellPrintHiiEx (\r
-        -1,\r
-        -1,\r
-        NULL,\r
-        STRING_TOKEN (STR_LS_LINE_START_ALL),\r
-        gShellLevel2HiiHandle,\r
-        &Node->Info->ModificationTime,\r
-        (Node->Info->Attribute & EFI_FILE_DIRECTORY) != 0?L"<DIR>":L"",\r
-        (Node->Info->Attribute & EFI_FILE_READ_ONLY) != 0?L'r':L' ',\r
-        Node->Info->FileSize\r
-       );\r
-      if (Node->Info->Attribute & EFI_FILE_DIRECTORY) {\r
-        DirCount++;\r
-        ShellPrintHiiEx (\r
-          -1,\r
-          -1,\r
-          NULL,\r
-          STRING_TOKEN (STR_LS_LINE_END_DIR),\r
-          gShellLevel2HiiHandle,\r
-          Node->FileName\r
-         );\r
-      } else {\r
-        FileCount++;\r
-        FileSize += Node->Info->FileSize;\r
-        if ( (gUnicodeCollation->StriColl(gUnicodeCollation, (CHAR16*)L".nsh", (CHAR16*)&(Node->FileName[StrLen (Node->FileName) - 4])) == 0)\r
-          || (gUnicodeCollation->StriColl(gUnicodeCollation, (CHAR16*)L".efi", (CHAR16*)&(Node->FileName[StrLen (Node->FileName) - 4])) == 0)\r
-         ){\r
-          ShellPrintHiiEx (\r
-            -1,\r
-            -1,\r
-            NULL,\r
-            STRING_TOKEN (STR_LS_LINE_END_EXE),\r
-            gShellLevel2HiiHandle,\r
-            Node->FileName\r
-           );\r
-        } else {\r
-          ShellPrintHiiEx (\r
-            -1,\r
-            -1,\r
-            NULL,\r
-            STRING_TOKEN (STR_LS_LINE_END_FILE),\r
-            gShellLevel2HiiHandle,\r
-            Node->FileName\r
-           );\r
-        }\r
-      }\r
-    }\r
+    PrintFileInformation(Sfo, Node, &FileCount, &FileSize, &DirCount);\r
   }\r
 \r
   if (!Sfo) {\r
-    //\r
-    // print footer\r
-    //\r
-    ShellPrintHiiEx (\r
-      -1,\r
-      -1,\r
-      NULL,\r
-      STRING_TOKEN (STR_LS_FOOTER_LINE),\r
-      gShellLevel2HiiHandle,\r
-      FileCount,\r
-      FileSize,\r
-      DirCount\r
-     );\r
+    PrintNonSfoFooter(FileCount, FileSize, DirCount);\r
   }\r
 \r
   if (Rec){\r