#include "CustomizedDisplayLibInternal.h"

Macros
#define	SPACE_BUFFER_SIZE 1000

Functions
VOID	PrintBannerInfo (IN FORM_DISPLAY_ENGINE_FORM *FormData)

VOID	PrintFramework (IN FORM_DISPLAY_ENGINE_FORM *FormData)

VOID	ProcessUserOpcode (IN EFI_IFR_OP_HEADER *OpCodeData)

VOID	ProcessExternedOpcode (IN FORM_DISPLAY_ENGINE_FORM *FormData)

EFI_STATUS	ScreenDiemensionInfoValidate (IN FORM_DISPLAY_ENGINE_FORM *FormData)

CHAR16 *	LibGetToken (IN EFI_STRING_ID Token, IN EFI_HII_HANDLE HiiHandle)

UINTN	LibGetStringWidth (IN CHAR16 *String)

VOID	PrintHotKeyHelpString (IN FORM_DISPLAY_ENGINE_FORM *FormData, IN BOOLEAN SetState)

UINT64	LibGetFieldFromNum (IN EFI_IFR_OP_HEADER *OpCode)

VOID	InitializeLibStrings (VOID)

VOID	FreeLibStrings (VOID)

EFI_STATUS	WaitForKeyStroke (OUT EFI_INPUT_KEY *Key)

VOID	LibSetUnicodeMem (IN VOID *Buffer, IN UINTN Size, IN CHAR16 Value)

UINTN	PrintInternal (IN UINTN Width, IN UINTN Column, IN UINTN Row, IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL Out, IN CHAR16 Fmt, IN VA_LIST Args)

UINTN EFIAPI	PrintAt (IN UINTN Width, IN UINTN Column, IN UINTN Row, IN CHAR16 *Fmt,...)

Variables
EFI_SCREEN_DESCRIPTOR	gScreenDimensions

CHAR16 *	mLibUnknownString

EFI_HII_HANDLE	mCDLStringPackHandle

CHAR16 *	mSpaceBuffer

CHAR16 *	gEnterString

CHAR16 *	gEnterCommitString

CHAR16 *	gEnterEscapeString

CHAR16 *	gEscapeString

CHAR16 *	gMoveHighlight

CHAR16 *	gDecNumericInput

CHAR16 *	gHexNumericInput

CHAR16 *	gToggleCheckBox

CHAR16 *	gLibEmptyString

CHAR16 *	gAreYouSure

CHAR16 *	gYesResponse

CHAR16 *	gNoResponse

CHAR16 *	gPlusString

CHAR16 *	gMinusString

CHAR16 *	gAdjustNumber

CHAR16 *	gSaveChanges

CHAR16 *	gNvUpdateMessage

CHAR16 *	gInputErrorMessage

Detailed Description

This library class defines a set of interfaces to customize Display module

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

Definition in file CustomizedDisplayLibInternal.c.

Macro Definition Documentation

◆ SPACE_BUFFER_SIZE

#define SPACE_BUFFER_SIZE 1000

Definition at line 15 of file CustomizedDisplayLibInternal.c.

Function Documentation

◆ FreeLibStrings()

VOID FreeLibStrings ( VOID )

Free the HII String.

Definition at line 753 of file CustomizedDisplayLibInternal.c.

◆ InitializeLibStrings()

VOID InitializeLibStrings ( VOID )

Initialize the HII String Token to the correct values.

Definition at line 711 of file CustomizedDisplayLibInternal.c.

◆ LibGetFieldFromNum()

UINT64 LibGetFieldFromNum ( IN EFI_IFR_OP_HEADER * OpCode )

Get step info from numeric opcode.

Parameters

[in] OpCode The input numeric op code.

Returns: step info for this opcode.

Definition at line 672 of file CustomizedDisplayLibInternal.c.

◆ LibGetStringWidth()

UINTN LibGetStringWidth ( IN CHAR16 * String )

Count the storage space of a Unicode string.

This function handles the Unicode string with NARROW_CHAR and WIDE_CHAR control characters. NARROW_HCAR and WIDE_CHAR does not count in the resultant output. If a WIDE_CHAR is hit, then 2 Unicode character will consume an output storage space with size of CHAR16 till a NARROW_CHAR is hit.

If String is NULL, then ASSERT ().

Parameters

String The input string to be counted.

Returns: Storage space for the input string.

Definition at line 495 of file CustomizedDisplayLibInternal.c.

◆ LibGetToken()

CHAR16 * LibGetToken	(	IN EFI_STRING_ID	Token,
		IN EFI_HII_HANDLE	HiiHandle
	)

Get the string based on the StringId and HII Package List Handle.

Parameters

Token	The String's ID.
HiiHandle	The package list in the HII database to search for the specified string.

Returns: The output string.

Definition at line 462 of file CustomizedDisplayLibInternal.c.

◆ LibSetUnicodeMem()

VOID LibSetUnicodeMem	(	IN VOID *	Buffer,
		IN UINTN	Size,
		IN CHAR16	Value
	)

Set Buffer to Value for Size bytes.

Parameters

Buffer	Memory to set.
Size	Number of bytes to set
Value	Value of the set operation.

Definition at line 823 of file CustomizedDisplayLibInternal.c.

◆ PrintAt()

UINTN EFIAPI PrintAt	(	IN UINTN	Width,
		IN UINTN	Column,
		IN UINTN	Row,
		IN CHAR16 *	Fmt,
			...
	)

Prints a formatted unicode string to the default console, at the supplied cursor position.

Parameters

Width	Width of String to be printed.
Column	The cursor position to print the string at.
Row	The cursor position to print the string at.
Fmt	Format string.
...	Variable argument list for format string.

Returns: Length of string printed to the console

Definition at line 972 of file CustomizedDisplayLibInternal.c.

◆ PrintBannerInfo()

VOID PrintBannerInfo ( IN FORM_DISPLAY_ENGINE_FORM * FormData )

Print banner info for front page.

Parameters

[in] FormData Form Data to be shown in Page

Definition at line 47 of file CustomizedDisplayLibInternal.c.

◆ PrintFramework()

VOID PrintFramework ( IN FORM_DISPLAY_ENGINE_FORM * FormData )

Print framework and form title for a page.

Parameters

[in] FormData Form Data to be shown in Page

Definition at line 133 of file CustomizedDisplayLibInternal.c.

◆ PrintHotKeyHelpString()

VOID PrintHotKeyHelpString	(	IN FORM_DISPLAY_ENGINE_FORM *	FormData,
		IN BOOLEAN	SetState
	)

Show all registered HotKey help strings on bottom Rows.

Parameters

FormData	The curent input form data info.
SetState	Set HotKey or Clear HotKey

Definition at line 565 of file CustomizedDisplayLibInternal.c.

◆ PrintInternal()

UINTN PrintInternal	(	IN UINTN	Width,
		IN UINTN	Column,
		IN UINTN	Row,
		IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *	Out,
		IN CHAR16 *	Fmt,
		IN VA_LIST	Args
	)

The internal function prints to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL protocol instance.

Parameters

Width	Width of string to be print.
Column	The position of the output string.
Row	The position of the output string.
Out	The EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL instance.
Fmt	The format string.
Args	The additional argument for the variables in the format string.