If.c File Reference

#include "UefiShellLevel1CommandsLib.h"
#include <Library/PrintLib.h>

Go to the source code of this file.

Enumerations
enum	END_TAG_TYPE { EndTagOr , EndTagAnd , EndTagThen , EndTagMax }
enum	BIN_OPERATOR_TYPE {   OperatorGreaterThan , OperatorLessThan , OperatorEqual , OperatorNotEqual ,   OperatorGreatorOrEqual , OperatorLessOrEqual , OperatorUnisgnedGreaterThan , OperatorUnsignedLessThan ,   OperatorUnsignedGreaterOrEqual , OperatorUnsignedLessOrEqual , OperatorMax }

Functions
EFI_STATUS	IsNextFragment (IN OUT CONST CHAR16 **Statement, IN CONST CHAR16 *Fragment, OUT BOOLEAN *Match)
BOOLEAN	IsValidProfile (IN CONST CHAR16 *String)
BOOLEAN	TestOperation (IN CONST CHAR16 *Compare1, IN CONST CHAR16 *Compare2, IN CONST BIN_OPERATOR_TYPE BinOp, IN CONST BOOLEAN CaseInsensitive, IN CONST BOOLEAN ForceStringCompare)
EFI_STATUS	ProcessStatement (IN OUT BOOLEAN *PassingState, IN UINTN StartParameterNumber, IN UINTN EndParameterNumber, IN CONST END_TAG_TYPE OperatorToUse, IN CONST BOOLEAN CaseInsensitive, IN CONST BOOLEAN ForceStringCompare)
BOOLEAN	BuildNextStatement (IN UINTN ParameterNumber, OUT UINTN *EndParameter, OUT END_TAG_TYPE *EndTag)
BOOLEAN	MoveToTagSpecial (IN SCRIPT_FILE *ScriptFile)
EFI_STATUS	PerformResultOperation (IN CONST BOOLEAN Result)
SHELL_STATUS EFIAPI	ShellCommandRunIf (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
SHELL_STATUS EFIAPI	ShellCommandRunElse (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
SHELL_STATUS EFIAPI	ShellCommandRunEndIf (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Detailed Description

Main file for If and else shell level 1 function.

(C) Copyright 2013-2015 Hewlett-Packard Development Company, L.P.
Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file If.c.

Enumeration Type Documentation

BIN_OPERATOR_TYPE

enum BIN_OPERATOR_TYPE

Definition at line 20 of file If.c.

END_TAG_TYPE

enum END_TAG_TYPE

Definition at line 13 of file If.c.

Function Documentation

BuildNextStatement()

BOOLEAN BuildNextStatement	(	IN UINTN	ParameterNumber,
		OUT UINTN *	EndParameter,
		OUT END_TAG_TYPE *	EndTag
	)

Break up the next part of the if statement (until the next 'and', 'or', or 'then').

Parameters

[in]	ParameterNumber	The current parameter number.
[out]	EndParameter	Upon successful return, will point to the parameter to start the next iteration with.
[out]	EndTag	Upon successful return, will point to the type that was found at the end of this statement.

Return values

TRUE	A valid statement was found.
FALSE	A valid statement was not found.

Definition at line 690 of file If.c.

IsNextFragment()

EFI_STATUS IsNextFragment	(	IN OUT CONST CHAR16 **	Statement,
		IN CONST CHAR16 *	Fragment,
		OUT BOOLEAN *	Match
	)

Extract the next fragment, if there is one.

Parameters

[in,out]	Statement	The current remaining statement.
[in]	Fragment	The current fragment.
[out]	Match	TRUE when there is another Fragment in Statement, FALSE otherwise.

Return values

EFI_SUCCESS	The match operation is performed successfully.
EFI_OUT_OF_RESOURCES	Out of resources.

Definition at line 46 of file If.c.

IsValidProfile()

BOOLEAN IsValidProfile

(

IN CONST CHAR16 *

String

)

Determine if String represents a valid profile.

Parameters

[in]

String

The pointer to the string to test.

Return values

TRUE	String is a valid profile.
FALSE	String is not a valid profile.

Definition at line 94 of file If.c.

MoveToTagSpecial()

BOOLEAN MoveToTagSpecial

(

IN SCRIPT_FILE *

ScriptFile

)

Move the script file pointer to a different place in the script file. This one is special since it handles the if/else/endif syntax.

Parameters

[in]

ScriptFile

The script file from GetCurrnetScriptFile().

Return values

TRUE	The move target was found and the move was successful.
FALSE	Something went wrong.

Definition at line 750 of file If.c.

PerformResultOperation()

EFI_STATUS PerformResultOperation

(

IN CONST BOOLEAN

Result

)

Deal with the result of the if operation.

Parameters

[in]

Result

The result of the if.

Return values

EFI_SUCCESS	The operation was successful.
EFI_NOT_FOUND	The ending tag could not be found.

Definition at line 850 of file If.c.

ProcessStatement()

EFI_STATUS ProcessStatement	(	IN OUT BOOLEAN *	PassingState,
		IN UINTN	StartParameterNumber,
		IN UINTN	EndParameterNumber,
		IN CONST END_TAG_TYPE	OperatorToUse,
		IN CONST BOOLEAN	CaseInsensitive,
		IN CONST BOOLEAN	ForceStringCompare
	)

Process an if statement and determine if its is valid or not.

Parameters

[in,out]	PassingState	Opon entry, the current state. Upon exit, the new state.
[in]	StartParameterNumber	The number of the first parameter of this statement.
[in]	EndParameterNumber	The number of the final parameter of this statement.
[in]	OperatorToUse	The type of termination operator.
[in]	CaseInsensitive	TRUE for case insensitive, FALSE otherwise.
[in]	ForceStringCompare	TRUE for all string based, FALSE otherwise.

Return values

EFI_INVALID_PARAMETER	A parameter was invalid.
EFI_SUCCESS	The operation was successful.

Definition at line 373 of file If.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.

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.

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.

TestOperation()

BOOLEAN TestOperation	(	IN CONST CHAR16 *	Compare1,
		IN CONST CHAR16 *	Compare2,
		IN CONST BIN_OPERATOR_TYPE	BinOp,
		IN CONST BOOLEAN	CaseInsensitive,
		IN CONST BOOLEAN	ForceStringCompare
	)

Do a comparison between 2 things.

Parameters

[in]	Compare1	The first item to compare.
[in]	Compare2	The second item to compare.
[in]	BinOp	The type of comparison to perform.
[in]	CaseInsensitive	TRUE to do non-case comparison, FALSE otherwise.
[in]	ForceStringCompare	TRUE to force string comparison, FALSE otherwise.

Returns

The result of the comparison.

Definition at line 127 of file If.c.