733f138d84
console wrapper - comment fixes. file handle wrappers - allow for creation of layers of file interfaces to automatically convert ASCII to UCS-2. shell - add CTRL-S support and change how searching for startup.nsh. shellenvvar - zero the memory allocations. shall man parser - input verification on the help text. shellparameters protocol - input redirection verification enhanced, leave ^ behind when not used. shell protocol - remove ASSERTs, fixed GetDeviceName, allow mapping of BlockIO devices, and enhanced key monitoring for CTRL-S (now CTRL-S and CTRL-C). git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11440 6f19259b-4bc3-4df7-8a09-765794883524
82 lines
2.7 KiB
C
82 lines
2.7 KiB
C
/** @file
|
|
Function definitions for shell simple text in and out on top of file handles.
|
|
|
|
Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>
|
|
This program and the accompanying materials
|
|
are licensed and made available under the terms and conditions of the BSD License
|
|
which accompanies this distribution. The full text of the license may be found at
|
|
http://opensource.org/licenses/bsd-license.php
|
|
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
|
|
**/
|
|
|
|
#ifndef _SHELL_CONSOLE_WRAPPERS_HEADER_
|
|
#define _SHELL_CONSOLE_WRAPPERS_HEADER_
|
|
|
|
/**
|
|
Function to create a EFI_SIMPLE_TEXT_INPUT_PROTOCOL on top of a
|
|
SHELL_FILE_HANDLE to support redirecting input from a file.
|
|
|
|
@param[in] FileHandleToUse The pointer to the SHELL_FILE_HANDLE to use.
|
|
@param[in] HandleLocation The pointer of a location to copy handle with protocol to.
|
|
|
|
@retval NULL There was insufficient memory available.
|
|
@return A pointer to the allocated protocol structure;
|
|
**/
|
|
EFI_SIMPLE_TEXT_INPUT_PROTOCOL*
|
|
EFIAPI
|
|
CreateSimpleTextInOnFile(
|
|
IN SHELL_FILE_HANDLE FileHandleToUse,
|
|
IN EFI_HANDLE *HandleLocation
|
|
);
|
|
|
|
/**
|
|
Function to close a EFI_SIMPLE_TEXT_INPUT_PROTOCOL on top of a
|
|
SHELL_FILE_HANDLE to support redirecting input from a file.
|
|
|
|
@param[in] SimpleTextIn The pointer to the SimpleTextIn to close.
|
|
|
|
@retval EFI_SUCCESS The object was closed.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
CloseSimpleTextInOnFile(
|
|
IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *SimpleTextIn
|
|
);
|
|
|
|
/**
|
|
Function to create a EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL on top of a
|
|
SHELL_FILE_HANDLE to support redirecting output from a file.
|
|
|
|
@param[in] FileHandleToUse The pointer to the SHELL_FILE_HANDLE to use.
|
|
@param[in] HandleLocation The pointer of a location to copy handle with protocol to.
|
|
|
|
@retval NULL There was insufficient memory available.
|
|
@return A pointer to the allocated protocol structure;
|
|
**/
|
|
EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL*
|
|
EFIAPI
|
|
CreateSimpleTextOutOnFile(
|
|
IN SHELL_FILE_HANDLE FileHandleToUse,
|
|
IN EFI_HANDLE *HandleLocation
|
|
);
|
|
|
|
/**
|
|
Function to close a EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL on top of a
|
|
SHELL_FILE_HANDLE to support redirecting output from a file.
|
|
|
|
@param[in] SimpleTextOut The pointer to the SimpleTextOUT to close.
|
|
|
|
@retval EFI_SUCCESS The object was closed.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
CloseSimpleTextOutOnFile(
|
|
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *SimpleTextOut
|
|
);
|
|
|
|
#endif //_SHELL_CONSOLE_WRAPPERS_HEADER_
|
|
|