ShellCommandLib.h

Go to the documentation of this file.

 
#ifndef _SHELL_COMMAND_LIB_
#define _SHELL_COMMAND_LIB_
 
#include <Uefi.h>
 
#include <Protocol/Shell.h>
#include <Protocol/ShellParameters.h>
#include <Protocol/UnicodeCollation.h>
#include <Protocol/SimpleFileSystem.h>
 
#include <Library/UefiBootServicesTableLib.h>
 
//
// The extern global protocol poionters.
//
extern        EFI_UNICODE_COLLATION_PROTOCOL  *gUnicodeCollation;
extern        CONST CHAR16                    *SupportLevel[];
 
//
// The map list objects.
//
typedef struct {
  LIST_ENTRY                  Link;
  EFI_DEVICE_PATH_PROTOCOL    *DevicePath;
  CHAR16                      *MapName;
  CHAR16                      *CurrentDirectoryPath;
  UINT64                      Flags;
} SHELL_MAP_LIST;
extern        SHELL_MAP_LIST  gShellMapList;
extern        SHELL_MAP_LIST  *gShellCurMapping;
 
typedef
CONST CHAR16 *
(EFIAPI *SHELL_GET_MAN_FILENAME)(
  VOID
  );
 
typedef
SHELL_STATUS
(EFIAPI *SHELL_RUN_COMMAND)(
  IN EFI_HANDLE        ImageHandle,
  IN EFI_SYSTEM_TABLE  *SystemTable
  );
 
RETURN_STATUS
EFIAPI
ShellCommandRegisterCommandName (
  IN CONST  CHAR16                  *CommandString,
  IN        SHELL_RUN_COMMAND       CommandHandler,
  IN        SHELL_GET_MAN_FILENAME  GetManFileName,
  IN        UINT32                  ShellMinSupportLevel,
  IN CONST  CHAR16                  *ProfileName,
  IN CONST  BOOLEAN                 CanAffectLE,
  IN CONST  EFI_HII_HANDLE          HiiHandle,
  IN CONST  EFI_STRING_ID           ManFormatHelp
  );
 
RETURN_STATUS
EFIAPI
ShellCommandRunCommandHandler (
  IN CONST CHAR16      *CommandString,
  IN OUT SHELL_STATUS  *RetVal,
  IN OUT BOOLEAN       *CanAffectLE OPTIONAL
  );
 
CONST CHAR16 *
EFIAPI
ShellCommandGetManFileNameHandler (
  IN CONST CHAR16  *CommandString
  );
 
typedef struct {
  LIST_ENTRY    Link;
  CHAR16        *CommandString;
} COMMAND_LIST;
 
CONST COMMAND_LIST *
EFIAPI
ShellCommandGetCommandList (
  IN CONST BOOLEAN  Sort
  );
 
typedef struct {
  LIST_ENTRY    Link;
  CHAR16        *CommandString;
  CHAR16        *Alias;
} ALIAS_LIST;
 
RETURN_STATUS
EFIAPI
ShellCommandRegisterAlias (
  IN CONST CHAR16  *Command,
  IN CONST CHAR16  *Alias
  );
 
CONST ALIAS_LIST *
EFIAPI
ShellCommandGetInitAliasList (
  VOID
  );
 
BOOLEAN
EFIAPI
ShellCommandIsOnAliasList (
  IN CONST CHAR16  *Alias
  );
 
BOOLEAN
EFIAPI
ShellCommandIsCommandOnList (
  IN CONST  CHAR16  *CommandString
  );
 
CHAR16 *
EFIAPI
ShellCommandGetCommandHelp (
  IN CONST  CHAR16  *CommandString
  );
 
EFI_STATUS
EFIAPI
CommandInit (
  VOID
  );
 
BOOLEAN
EFIAPI
ShellCommandGetEchoState (
  VOID
  );
 
VOID
EFIAPI
ShellCommandSetEchoState (
  IN BOOLEAN  State
  );
 
VOID
EFIAPI
ShellCommandRegisterExit (
  IN BOOLEAN       ScriptOnly,
  IN CONST UINT64  ErrorCode
  );
 
UINT64
EFIAPI
ShellCommandGetExitCode (
  VOID
  );
 
BOOLEAN
EFIAPI
ShellCommandGetExit (
  VOID
  );
 
BOOLEAN
EFIAPI
ShellCommandGetScriptExit (
  VOID
  );
 
typedef struct {
  LIST_ENTRY    Link;       
  UINTN         Line;       
  CHAR16        *Cl;        
  VOID          *Data;      
  BOOLEAN       Reset;      
} SCRIPT_COMMAND_LIST;
 
typedef struct {
  CHAR16                 *ScriptName;     
  CHAR16                 **Argv;          
  UINTN                  Argc;            
  LIST_ENTRY             CommandList;     
  SCRIPT_COMMAND_LIST    *CurrentCommand; 
  LIST_ENTRY             SubstList;       
} SCRIPT_FILE;
 
SCRIPT_FILE *
EFIAPI
ShellCommandGetCurrentScriptFile (
  VOID
  );
 
SCRIPT_FILE *
EFIAPI
ShellCommandSetNewScript (
  IN SCRIPT_FILE  *Script OPTIONAL
  );
 
VOID
EFIAPI
DeleteScriptFileStruct (
  IN SCRIPT_FILE  *Script
  );
 
CONST CHAR16 *
EFIAPI
ShellCommandGetProfileList (
  VOID
  );
 
typedef enum {
  MappingTypeFileSystem,
  MappingTypeBlockIo,
  MappingTypeMax
} SHELL_MAPPING_TYPE;
 
CHAR16 *
EFIAPI
ShellCommandCreateNewMappingName (
  IN CONST SHELL_MAPPING_TYPE  Type
  );
 
EFI_STATUS
EFIAPI
ShellCommandConsistMappingInitialize (
  EFI_DEVICE_PATH_PROTOCOL  ***Table
  );
 
EFI_STATUS
EFIAPI
ShellCommandConsistMappingUnInitialize (
  EFI_DEVICE_PATH_PROTOCOL  **Table
  );
 
CHAR16 *
EFIAPI
ShellCommandConsistMappingGenMappingName (
  IN EFI_DEVICE_PATH_PROTOCOL  *DevicePath,
  IN EFI_DEVICE_PATH_PROTOCOL  **Table
  );
 
SHELL_MAP_LIST *
EFIAPI
ShellCommandFindMapItem (
  IN CONST CHAR16  *MapKey
  );
 
EFI_STATUS
EFIAPI
ShellCommandAddMapItemAndUpdatePath (
  IN CONST CHAR16                    *Name,
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath,
  IN CONST UINT64                    Flags,
  IN CONST BOOLEAN                   Path
  );
 
EFI_STATUS
EFIAPI
ShellCommandCreateInitialMappingsAndPaths (
  VOID
  );
 
EFI_STATUS
EFIAPI
ShellCommandUpdateMapping (
  VOID
  );
 
EFI_FILE_PROTOCOL *
EFIAPI
ConvertShellHandleToEfiFileProtocol (
  IN CONST SHELL_FILE_HANDLE  Handle
  );
 
BOOLEAN
EFIAPI
ShellFileHandleRemove (
  IN CONST SHELL_FILE_HANDLE  Handle
  );
 
SHELL_FILE_HANDLE
EFIAPI
ConvertEfiFileProtocolToShellHandle (
  IN CONST EFI_FILE_PROTOCOL  *Handle,
  IN CONST CHAR16             *Path
  );
 
CONST CHAR16 *
EFIAPI
ShellFileHandleGetPath (
  IN CONST SHELL_FILE_HANDLE  Handle
  );
 
BOOLEAN
EFIAPI
ShellFileHandleEof (
  IN SHELL_FILE_HANDLE  Handle
  );
 
typedef struct {
  LIST_ENTRY    Link;
  void          *Buffer;
} BUFFER_LIST;
 
VOID
EFIAPI
FreeBufferList (
  IN BUFFER_LIST  *List
  );
 
VOID
EFIAPI
DumpHex (
  IN UINTN  Indent,
  IN UINTN  Offset,
  IN UINTN  DataSize,
  IN VOID   *UserData
  );
 
CHAR16 *
EFIAPI
CatSDumpHex (
  IN CHAR16  *Buffer,
  IN UINTN   Indent,
  IN UINTN   Offset,
  IN UINTN   DataSize,
  IN VOID    *UserData
  );
 
//
// Determines the ordering operation for ShellSortFileList().
//
typedef enum {
  //
  // Sort the EFI_SHELL_FILE_INFO objects by the FileName field, in increasing
  // order, using gUnicodeCollation->StriColl().
  //
  ShellSortFileListByFileName,
  //
  // Sort the EFI_SHELL_FILE_INFO objects by the FullName field, in increasing
  // order, using gUnicodeCollation->StriColl().
  //
  ShellSortFileListByFullName,
  ShellSortFileListMax
} SHELL_SORT_FILE_LIST;
 
EFI_STATUS
EFIAPI
ShellSortFileList (
  IN OUT EFI_SHELL_FILE_INFO   **FileList,
  OUT EFI_SHELL_FILE_INFO      **Duplicates OPTIONAL,
  IN     SHELL_SORT_FILE_LIST  Order
  );
 
#endif //_SHELL_COMMAND_LIB_