UefiShellLevel1CommandsLib.h File Reference

#include <Uefi.h>
#include <Guid/ShellLibHiiGuid.h>
#include <Protocol/Shell.h>
#include <Protocol/ShellParameters.h>
#include <Protocol/DevicePath.h>
#include <Protocol/LoadedImage.h>
#include <Protocol/UnicodeCollation.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/PcdLib.h>
#include <Library/ShellCommandLib.h>
#include <Library/ShellLib.h>
#include <Library/SortLib.h>
#include <Library/UefiLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/HiiLib.h>
#include <Library/FileHandleLib.h>

Go to the source code of this file.

Typedefs
typedef LIST_ENTRY *(EFIAPI *	LIST_MANIP_FUNC) (IN CONST LIST_ENTRY *List, IN CONST LIST_ENTRY *Node)

Functions
SHELL_STATUS EFIAPI	ShellCommandRunStall (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
SHELL_STATUS EFIAPI	ShellCommandRunExit (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
SHELL_STATUS EFIAPI	ShellCommandRunEndIf (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
SHELL_STATUS EFIAPI	ShellCommandRunFor (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
SHELL_STATUS EFIAPI	ShellCommandRunEndFor (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
SHELL_STATUS EFIAPI	ShellCommandRunIf (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
SHELL_STATUS EFIAPI	ShellCommandRunGoto (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
SHELL_STATUS EFIAPI	ShellCommandRunShift (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
SHELL_STATUS EFIAPI	ShellCommandRunElse (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
BOOLEAN	MoveToTag (IN CONST LIST_MANIP_FUNC Function, IN CONST CHAR16 *DecrementerTag, IN CONST CHAR16 *IncrementerTag, IN CONST CHAR16 *Label OPTIONAL, IN OUT SCRIPT_FILE *ScriptFile, IN CONST BOOLEAN MovePast, IN CONST BOOLEAN FindOnly, IN CONST BOOLEAN WrapAroundScript)

Variables
EFI_HII_HANDLE	gShellLevel1HiiHandle

Detailed Description

Main file for NULL named library for level 1 shell command functions.

Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file UefiShellLevel1CommandsLib.h.

Typedef Documentation

LIST_MANIP_FUNC

typedef LIST_ENTRY *(EFIAPI * LIST_MANIP_FUNC) (IN CONST LIST_ENTRY *List, IN CONST LIST_ENTRY *Node)

Function prototype for BOTH GetNextNode and GetPreviousNode... This is used to control the MoveToTag function direction...

Definition at line 160 of file UefiShellLevel1CommandsLib.h.

Function Documentation

MoveToTag()

BOOLEAN MoveToTag	(	IN CONST LIST_MANIP_FUNC	Function,
		IN CONST CHAR16 *	DecrementerTag,
		IN CONST CHAR16 *	IncrementerTag,
		IN CONST CHAR16 *Label	OPTIONAL,
		IN OUT SCRIPT_FILE *	ScriptFile,
		IN CONST BOOLEAN	MovePast,
		IN CONST BOOLEAN	FindOnly,
		IN CONST BOOLEAN	WrapAroundScript
	)

Move the script pointer from 1 tag (line) to another.

It functions so that count starts at 1 and it increases or decreases when it hits the specified tags. when it hits zero the location has been found.

DecrementerTag and IncrementerTag are used to get around for/endfor and similar paired types where the entire middle should be ignored.

If label is used it will be used instead of the count.

Parameters

[in]	Function	The function to use to enumerate through the list. Normally GetNextNode or GetPreviousNode.
[in]	DecrementerTag	The tag to decrement the count at.
[in]	IncrementerTag	The tag to increment the count at.
[in]	Label	A label to look for.
[in,out]	ScriptFile	The pointer to the current script file structure.
[in]	MovePast	TRUE makes function return 1 past the found location.
[in]	FindOnly	TRUE to not change the ScriptFile.
[in]	WrapAroundScript	TRUE to wrap end-to-beginning or vise versa in searching.

Definition at line 250 of file UefiShellLevel1CommandsLib.c.

ShellCommandRunElse()

SHELL_STATUS EFIAPI ShellCommandRunElse	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Function for 'else' command.

Parameters

[in]	ImageHandle	Handle to the Image (NULL if Internal).
[in]	SystemTable	Pointer to the System Table (NULL if Internal).

Definition at line 1065 of file If.c.

ShellCommandRunEndFor()

SHELL_STATUS EFIAPI ShellCommandRunEndFor	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Function for 'endfor' command.

Parameters

[in]	ImageHandle	Handle to the Image (NULL if Internal).
[in]	SystemTable	Pointer to the System Table (NULL if Internal).

Definition at line 59 of file For.c.

ShellCommandRunEndIf()

SHELL_STATUS EFIAPI ShellCommandRunEndIf	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Function for 'endif' command.

Parameters

[in]	ImageHandle	Handle to the Image (NULL if Internal).
[in]	SystemTable	Pointer to the System Table (NULL if Internal).

Definition at line 1150 of file If.c.

ShellCommandRunExit()

SHELL_STATUS EFIAPI ShellCommandRunExit	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Function for 'exit' command.

Parameters

[in]	ImageHandle	Handle to the Image (NULL if Internal).
[in]	SystemTable	Pointer to the System Table (NULL if Internal).

Definition at line 25 of file Exit.c.

ShellCommandRunFor()

SHELL_STATUS EFIAPI ShellCommandRunFor	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Function for 'for' command.

Parameters

[in]	ImageHandle	Handle to the Image (NULL if Internal).
[in]	SystemTable	Pointer to the System Table (NULL if Internal).

Definition at line 288 of file For.c.

ShellCommandRunGoto()

SHELL_STATUS EFIAPI ShellCommandRunGoto	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Function for 'goto' command.

Parameters

[in]	ImageHandle	Handle to the Image (NULL if Internal).
[in]	SystemTable	Pointer to the System Table (NULL if Internal).

Definition at line 20 of file Goto.c.

ShellCommandRunIf()

SHELL_STATUS EFIAPI ShellCommandRunIf	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Function for 'if' command.

Parameters

[in]	ImageHandle	Handle to the Image (NULL if Internal).
[in]	SystemTable	Pointer to the System Table (NULL if Internal).

Definition at line 869 of file If.c.

ShellCommandRunShift()

SHELL_STATUS EFIAPI ShellCommandRunShift	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Function for 'shift' command.

Parameters

[in]	ImageHandle	Handle to the Image (NULL if Internal).
[in]	SystemTable	Pointer to the System Table (NULL if Internal).

Definition at line 20 of file Shift.c.

ShellCommandRunStall()

SHELL_STATUS EFIAPI ShellCommandRunStall	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Function for 'stall' command.

Parameters

[in]	ImageHandle	Handle to the Image (NULL if Internal).
[in]	SystemTable	Pointer to the System Table (NULL if Internal).

Definition at line 20 of file Stall.c.

Variable Documentation

gShellLevel1HiiHandle

EFI_HII_HANDLE gShellLevel1HiiHandle

extern

Definition at line 13 of file UefiShellLevel1CommandsLib.c.