Shell.h

Go to the documentation of this file.

 
#ifndef _SHELL_INTERNAL_HEADER_
#define _SHELL_INTERNAL_HEADER_
 
#include <Uefi.h>
 
#include <Guid/ShellVariableGuid.h>
#include <Guid/ShellAliasGuid.h>
 
#include <Protocol/LoadedImage.h>
#include <Protocol/SimpleTextOut.h>
#include <Protocol/Shell.h>
#include <Protocol/EfiShellInterface.h>
#include <Protocol/EfiShellEnvironment2.h>
#include <Protocol/ShellParameters.h>
#include <Protocol/BlockIo.h>
#include <Protocol/HiiPackageList.h>
 
#include <Library/BaseLib.h>
#include <Library/UefiApplicationEntryPoint.h>
#include <Library/UefiLib.h>
#include <Library/DebugLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/ShellCommandLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/DevicePathLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/PcdLib.h>
#include <Library/ShellLib.h>
#include <Library/SortLib.h>
#include <Library/HiiLib.h>
#include <Library/PrintLib.h>
#include <Library/HandleParsingLib.h>
#include <Library/FileHandleLib.h>
#include <Library/UefiHiiServicesLib.h>
 
#include "ShellParametersProtocol.h"
#include "ShellProtocol.h"
#include "ShellEnvVar.h"
#include "ConsoleLogger.h"
#include "ShellManParser.h"
#include "ConsoleWrappers.h"
#include "FileHandleWrappers.h"
 
extern CONST CHAR16  mNoNestingEnvVarName[];
extern CONST CHAR16  mNoNestingTrue[];
extern CONST CHAR16  mNoNestingFalse[];
 
typedef struct {
  LIST_ENTRY           Link;        
  SHELL_FILE_HANDLE    SplitStdOut; 
  SHELL_FILE_HANDLE    SplitStdIn;  
} SPLIT_LIST;
 
typedef struct {
  UINT32    Startup      : 1; 
  UINT32    NoStartup    : 1; 
  UINT32    NoConsoleOut : 1; 
  UINT32    NoConsoleIn  : 1; 
  UINT32    NoInterrupt  : 1; 
  UINT32    NoMap        : 1; 
  UINT32    NoVersion    : 1; 
  UINT32    Delay        : 1; 
  UINT32    Exit         : 1; 
  UINT32    NoNest       : 1; 
  UINT32    Reserved     : 7; 
} SHELL_BITS;
 
typedef union {
  SHELL_BITS    Bits;
  UINT16        AllBits;
} SHELL_BIT_UNION;
 
typedef struct {
  SHELL_BIT_UNION    BitUnion;
  UINTN              Delay;        
  CHAR16             *FileName;    
  CHAR16             *FileOptions; 
} SHELL_INIT_SETTINGS;
 
typedef struct {
  BUFFER_LIST    CommandHistory;
  UINTN          VisibleRowNumber;
  UINTN          OriginalVisibleRowNumber;
  BOOLEAN        InsertMode;                        
} SHELL_VIEWING_SETTINGS;
 
typedef struct {
  EFI_SHELL_PARAMETERS_PROTOCOL    *NewShellParametersProtocol;
  EFI_SHELL_PROTOCOL               *NewEfiShellProtocol;
  BOOLEAN                          PageBreakEnabled;
  BOOLEAN                          RootShellInstance;
  SHELL_INIT_SETTINGS              ShellInitSettings;
  BUFFER_LIST                      BufferToFreeList;  
  SHELL_VIEWING_SETTINGS           ViewingSettings;
  EFI_HII_HANDLE                   HiiHandle;           
  UINTN                            LogScreenCount;      
  EFI_EVENT                        UserBreakTimer;      
  EFI_DEVICE_PATH_PROTOCOL         *ImageDevPath;       
  EFI_DEVICE_PATH_PROTOCOL         *FileDevPath;        
  CONSOLE_LOGGER_PRIVATE_DATA      *ConsoleInfo;        
  EFI_SHELL_PARAMETERS_PROTOCOL    *OldShellParameters; 
  SHELL_PROTOCOL_HANDLE_LIST       OldShellList;        
  SPLIT_LIST                       SplitList;           
  VOID                             *CtrlCNotifyHandle1; 
  VOID                             *CtrlCNotifyHandle2; 
  VOID                             *CtrlCNotifyHandle3; 
  VOID                             *CtrlCNotifyHandle4; 
  VOID                             *CtrlSNotifyHandle1; 
  VOID                             *CtrlSNotifyHandle2; 
  VOID                             *CtrlSNotifyHandle3; 
  VOID                             *CtrlSNotifyHandle4; 
  BOOLEAN                          HaltOutput;          
} SHELL_INFO;
 
#pragma pack(1)
typedef struct {
  VENDOR_DEVICE_PATH          VendorDevicePath;
  EFI_DEVICE_PATH_PROTOCOL    End;
} SHELL_MAN_HII_VENDOR_DEVICE_PATH;
#pragma pack()
 
extern SHELL_INFO  ShellInfoObject;
 
EFI_STATUS
ProcessCommandLineToFinal (
  IN OUT CHAR16  **CmdLine
  );
 
EFI_STATUS
SetLastError (
  IN CONST SHELL_STATUS  ErrorCode
  );
 
EFI_STATUS
SetBuiltInAlias (
  VOID
  );
 
EFI_STATUS
GetDevicePathsForImageAndFile (
  IN OUT EFI_DEVICE_PATH_PROTOCOL  **DevPath,
  IN OUT EFI_DEVICE_PATH_PROTOCOL  **FilePath
  );
 
EFI_STATUS
ProcessCommandLine (
  VOID
  );
 
EFI_STATUS
DoStartupScript (
  IN EFI_DEVICE_PATH_PROTOCOL  *ImagePath,
  IN EFI_DEVICE_PATH_PROTOCOL  *FilePath
  );
 
EFI_STATUS
DoShellPrompt (
  VOID
  );
 
VOID *
AddBufferToFreeList (
  VOID  *Buffer
  );
 
VOID
AddLineToCommandHistory (
  IN CONST CHAR16  *Buffer
  );
 
EFI_STATUS
RunCommand (
  IN CONST CHAR16  *CmdLine
  );
 
EFI_STATUS
RunShellCommand (
  IN CONST CHAR16  *CmdLine,
  OUT EFI_STATUS   *CommandStatus
  );
 
EFI_STATUS
RunScriptFileHandle (
  IN SHELL_FILE_HANDLE  Handle,
  IN CONST CHAR16       *Name
  );
 
EFI_STATUS
RunScriptFile (
  IN CONST CHAR16                   *ScriptPath,
  IN SHELL_FILE_HANDLE              Handle OPTIONAL,
  IN CONST CHAR16                   *CmdLine,
  IN EFI_SHELL_PARAMETERS_PROTOCOL  *ParamProtocol
  );
 
CONST CHAR16 *
FindFirstCharacter (
  IN CONST CHAR16  *String,
  IN CONST CHAR16  *CharacterList,
  IN CONST CHAR16  EscapeCharacter
  );
 
EFI_STATUS
TrimSpaces (
  IN CHAR16  **String
  );
 
VOID
SaveBufferList (
  OUT LIST_ENTRY  *OldBufferList
  );
 
VOID
RestoreBufferList (
  IN OUT LIST_ENTRY  *OldBufferList
  );
 
#endif //_SHELL_INTERNAL_HEADER_