Parse.c File Reference

#include "UefiShellLevel2CommandsLib.h"

Go to the source code of this file.

Functions
BOOLEAN	IsStdInDataAvailable (VOID)
EFI_STRING	HandleStringWithEscapeCharForParse (IN CHAR16 *String)
SHELL_STATUS	PerformParsing (IN CONST CHAR16 *FileName, IN CONST CHAR16 *TableName, IN CONST UINTN ColumnIndex, IN CONST UINTN TableNameInstance, IN CONST UINTN ShellCommandInstance, IN BOOLEAN StreamingUnicode)
SHELL_STATUS EFIAPI	ShellCommandRunParse (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables
STATIC CONST SHELL_PARAM_ITEM	ParamList []

Detailed Description

Main file for Parse shell level 2 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 Parse.c.

Function Documentation

HandleStringWithEscapeCharForParse()

EFI_STRING HandleStringWithEscapeCharForParse

(

IN CHAR16 *

String

)

Handle stings for SFO Output with escape character ^ in a string

1. Quotation marks in the string must be escaped by using a ^ character (i.e. ^").
2. The ^ character may be inserted using ^^.

Parameters

[in]

String

The Unicode NULL-terminated string.

Return values

NewString

The new string handled for SFO.

Definition at line 63 of file Parse.c.

IsStdInDataAvailable()

BOOLEAN IsStdInDataAvailable

(

VOID

)

Check if data is coming from StdIn output.

Parameters

[in]

None

Return values

TRUE	StdIn stream data available to parse
FALSE	StdIn stream data is not available to parse.

Definition at line 21 of file Parse.c.

PerformParsing()

SHELL_STATUS PerformParsing	(	IN CONST CHAR16 *	FileName,
		IN CONST CHAR16 *	TableName,
		IN CONST UINTN	ColumnIndex,
		IN CONST UINTN	TableNameInstance,
		IN CONST UINTN	ShellCommandInstance,
		IN BOOLEAN	StreamingUnicode
	)

Do the actual parsing of the file. the file should be SFO output from a shell command or a similar format.

Parameters

[in]	FileName	The filename to open.
[in]	TableName	The name of the table to find.
[in]	ColumnIndex	The column number to get.
[in]	TableNameInstance	Which instance of the table to get (row).
[in]	ShellCommandInstance	Which instance of the command to get.
[in]	StreamingUnicode	Indicates Input file is StdIn Unicode streaming data or not

Return values

SHELL_NOT_FOUND	The requested instance was not found.
SHELL_SUCCESS	The operation was successful.

Definition at line 115 of file Parse.c.

ShellCommandRunParse()

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

Function for 'parse' command.

Parameters

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

Definition at line 245 of file Parse.c.

Variable Documentation

ParamList

STATIC CONST SHELL_PARAM_ITEM ParamList[]

Initial value:

= {
  { L"-i", TypeValue },
  { L"-s", TypeValue },
  { NULL,  TypeMax   }
}

Definition at line 231 of file Parse.c.