ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.h

   1 /** @file
   2   Provides interface to shell internal functions for shell commands.
   3
   4   Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved. <BR>
   5   (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
   6   SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #ifndef _UEFI_COMMAND_LIB_INTERNAL_HEADER_
  11 #define _UEFI_COMMAND_LIB_INTERNAL_HEADER_
  12
  13 #include <Uefi.h>
  14
  15 #include <Guid/FileInfo.h>
  16 #include <Guid/GlobalVariable.h>
  17
  18 #include <Protocol/SimpleFileSystem.h>
  19 #include <Protocol/LoadedImage.h>
  20 #include <Protocol/EfiShellInterface.h>
  21 #include <Protocol/EfiShellEnvironment2.h>
  22 #include <Protocol/Shell.h>
  23 #include <Protocol/ShellParameters.h>
  24 #include <Protocol/UnicodeCollation.h>
  25 #include <Protocol/BlockIo.h>
  26 #include <Protocol/ShellDynamicCommand.h>
  27
  28 #include <Library/DevicePathLib.h>
  29 #include <Library/SortLib.h>
  30 #include <Library/HandleParsingLib.h>
  31 #include <Library/BaseLib.h>
  32 #include <Library/BaseMemoryLib.h>
  33 #include <Library/DebugLib.h>
  34 #include <Library/MemoryAllocationLib.h>
  35 #include <Library/PcdLib.h>
  36 #include <Library/ShellCommandLib.h>
  37 #include <Library/PrintLib.h>
  38 #include <Library/ShellLib.h>
  39 #include <Library/HiiLib.h>
  40 #include <Library/UefiBootServicesTableLib.h>
  41 #include <Library/UefiLib.h>
  42 #include <Library/OrderedCollectionLib.h>
  43
  44 typedef struct{
  45   LIST_ENTRY                  Link;
  46   CHAR16                      *CommandString;
  47   SHELL_GET_MAN_FILENAME      GetManFileName;
  48   SHELL_RUN_COMMAND           CommandHandler;
  49   BOOLEAN                     LastError;
  50   EFI_HII_HANDLE              HiiHandle;
  51   EFI_STRING_ID               ManFormatHelp;
  52 } SHELL_COMMAND_INTERNAL_LIST_ENTRY;
  53
  54 typedef struct {
  55   LIST_ENTRY Link;
  56   SCRIPT_FILE *Data;
  57 } SCRIPT_FILE_LIST;
  58
  59 typedef struct {
  60   EFI_FILE_PROTOCOL *FileHandle;
  61   CHAR16            *Path;
  62 } SHELL_COMMAND_FILE_HANDLE;
  63
  64 //
  65 // Collects multiple EFI_SHELL_FILE_INFO objects that share the same name.
  66 //
  67 typedef struct {
  68   //
  69   // A string that compares equal to either the FileName or the FullName fields
  70   // of all EFI_SHELL_FILE_INFO objects on SameNameList, according to
  71   // gUnicodeCollation->StriColl(). The string is not dynamically allocated;
  72   // instead, it *aliases* the FileName or FullName field of the
  73   // EFI_SHELL_FILE_INFO object that was first encountered with this name.
  74   //
  75   CONST CHAR16 *Alias;
  76   //
  77   // A list of EFI_SHELL_FILE_INFO objects whose FileName or FullName fields
  78   // compare equal to Alias, according to gUnicodeCollation->StriColl().
  79   //
  80   LIST_ENTRY SameNameList;
  81 } SHELL_SORT_UNIQUE_NAME;
  82
  83 #endif //_UEFI_COMMAND_LIB_INTERNAL_HEADER_
  84