Clean up SetupBrowserDxe for Doxygen comments requirement.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5472 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
qwang12 2008-07-15 08:35:54 +00:00
parent 7b9ff69833
commit 7936fb6a1f
12 changed files with 11479 additions and 10824 deletions

View File

@ -1,4 +1,5 @@
/** @file
MACRO definitions for color used in Setup Browser.
Copyright (c) 2004, Intel Corporation
All rights reserved. This program and the accompanying materials
@ -9,20 +10,12 @@ 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.
Module Name:
Colors.h
Abstract:
Revision History
**/
//
// Unicode collation protocol in
#ifndef _COLORS_H
#define _COLORS_H
#ifndef _COLORS_H_
#define _COLORS_H_
//
// Screen Color Settings

File diff suppressed because it is too large Load Diff

View File

@ -1,4 +1,6 @@
/** @file
Parser for IFR binary encoding.
Copyright (c) 2007 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@ -8,15 +10,6 @@ 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.
Module Name:
IfrParse.c
Abstract:
Parser for IFR binary encoding.
**/
#include "Setup.h"
@ -337,7 +330,7 @@ InitializeRequestElement (
StrLen = UnicodeSPrint (RequestElement, 30 * sizeof (CHAR16), L"&%s", Question->VariableName);
}
if ((Question->Operand == EFI_IFR_PASSWORD_OP) && (Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK)) {
if ((Question->Operand == EFI_IFR_PASSWORD_OP) && ((Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) == EFI_IFR_FLAG_CALLBACK)) {
//
// Password with CALLBACK flag is stored in encoded format,
// so don't need to append it to <ConfigRequest>
@ -371,12 +364,10 @@ InitializeRequestElement (
/**
Free resources of a Expression
Free resources of a Expression.
@param FormSet Pointer of the Expression
@return None.
**/
VOID
DestroyExpression (
@ -402,12 +393,10 @@ DestroyExpression (
/**
Free resources of a storage
Free resources of a storage.
@param Storage Pointer of the storage
@return None.
**/
VOID
DestroyStorage (
@ -444,12 +433,10 @@ DestroyStorage (
/**
Free resources of a Statement
Free resources of a Statement.
@param Statement Pointer of the Statement
@return None.
**/
VOID
DestroyStatement (
@ -511,11 +498,9 @@ DestroyStatement (
/**
Free resources of a Form
Free resources of a Form.
@param Form Pointer of the Form
@return None.
@param Form Pointer of the Form.
**/
VOID
@ -557,12 +542,10 @@ DestroyForm (
/**
Free resources allocated for a FormSet
Free resources allocated for a FormSet.
@param FormSet Pointer of the FormSet
@return None.
**/
VOID
DestroyFormSet (
@ -657,8 +640,6 @@ IsExpressionOpCode (
@param NumberOfStatement Number of Statemens(Questions)
@param NumberOfExpression Number of Expression OpCodes
@return None.
**/
VOID
CountOpCodes (
@ -791,7 +772,7 @@ ParseOpCodes (
//
// If scope bit set, push onto scope stack
//
if (Scope) {
if (Scope != 0) {
PushScope (Operand);
}
@ -1091,7 +1072,7 @@ ParseOpCodes (
CurrentStatement = CreateStatement (OpCodeData, FormSet, CurrentForm);
CurrentStatement->Flags = ((EFI_IFR_SUBTITLE *) OpCodeData)->Flags;
if (Scope) {
if (Scope != 0) {
mInScopeSubtitle = TRUE;
}
break;
@ -1187,7 +1168,7 @@ ParseOpCodes (
InitializeRequestElement (FormSet, CurrentStatement);
if ((Operand == EFI_IFR_ONE_OF_OP) && Scope) {
if ((Operand == EFI_IFR_ONE_OF_OP) && Scope != 0) {
SuppressForOption = TRUE;
}
break;
@ -1208,7 +1189,7 @@ ParseOpCodes (
CurrentStatement->HiiValue.Type = EFI_IFR_TYPE_OTHER;
CurrentStatement->BufferValue = AllocateZeroPool (CurrentStatement->StorageWidth);
if (Scope) {
if (Scope != 0) {
SuppressForOption = TRUE;
}
break;
@ -1320,7 +1301,7 @@ ParseOpCodes (
//
InsertTailList (&CurrentStatement->DefaultListHead, &CurrentDefault->Link);
if (Scope) {
if (Scope != 0) {
InScopeDefault = TRUE;
}
break;

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -1,326 +1,349 @@
/** @file
Copyright (c) 2004 - 2007, Intel Corporation
All rights reserved. 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.
Module Name:
Print.c
Abstract:
Basic Ascii AvSPrintf() function named VSPrint(). VSPrint() enables very
simple implemenation of SPrint() and Print() to support debug.
You can not Print more than EFI_DRIVER_LIB_MAX_PRINT_BUFFER characters at a
time. This makes the implementation very simple.
VSPrint, Print, SPrint format specification has the follwoing form
%type
type:
'S','s' - argument is an Unicode string
'c' - argument is an ascii character
'%' - Print a %
**/
#include "Setup.h"
UINTN
ValueToString (
IN OUT CHAR16 *Buffer,
IN BOOLEAN Flags,
IN INT64 Value
);
UINTN
PrintInternal (
IN UINTN Column,
IN UINTN Row,
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *Out,
IN CHAR16 *fmt,
IN VA_LIST args
)
//
// Display string worker for: Print, PrintAt, IPrint, IPrintAt
//
{
CHAR16 *Buffer;
CHAR16 *BackupBuffer;
UINTN Index;
UINTN PreviousIndex;
//
// For now, allocate an arbitrarily long buffer
//
Buffer = AllocateZeroPool (0x10000);
BackupBuffer = AllocateZeroPool (0x10000);
ASSERT (Buffer);
ASSERT (BackupBuffer);
if (Column != (UINTN) -1) {
Out->SetCursorPosition (Out, Column, Row);
}
UnicodeVSPrint (Buffer, 0x10000, fmt, args);
Out->Mode->Attribute = Out->Mode->Attribute & 0x7f;
Out->SetAttribute (Out, Out->Mode->Attribute);
Index = 0;
PreviousIndex = 0;
do {
for (; (Buffer[Index] != NARROW_CHAR) && (Buffer[Index] != WIDE_CHAR) && (Buffer[Index] != 0); Index++) {
BackupBuffer[Index] = Buffer[Index];
}
if (Buffer[Index] == 0) {
break;
}
//
// Null-terminate the temporary string
//
BackupBuffer[Index] = 0;
//
// Print this out, we are about to switch widths
//
Out->OutputString (Out, &BackupBuffer[PreviousIndex]);
//
// Preserve the current index + 1, since this is where we will start printing from next
//
PreviousIndex = Index + 1;
//
// We are at a narrow or wide character directive. Set attributes and strip it and print it
//
if (Buffer[Index] == NARROW_CHAR) {
//
// Preserve bits 0 - 6 and zero out the rest
//
Out->Mode->Attribute = Out->Mode->Attribute & 0x7f;
Out->SetAttribute (Out, Out->Mode->Attribute);
} else {
//
// Must be wide, set bit 7 ON
//
Out->Mode->Attribute = Out->Mode->Attribute | EFI_WIDE_ATTRIBUTE;
Out->SetAttribute (Out, Out->Mode->Attribute);
}
Index++;
} while (Buffer[Index] != 0);
//
// We hit the end of the string - print it
//
Out->OutputString (Out, &BackupBuffer[PreviousIndex]);
gBS->FreePool (Buffer);
gBS->FreePool (BackupBuffer);
return EFI_SUCCESS;
}
/**
Prints a formatted unicode string to the default console
@param fmt Format string
@return Length of string printed to the console
**/
UINTN
ConsolePrint (
IN CHAR16 *fmt,
...
)
{
VA_LIST args;
VA_START (args, fmt);
return PrintInternal ((UINTN) -1, (UINTN) -1, gST->ConOut, fmt, args);
}
/**
Prints a unicode string to the default console,
using L"%s" format.
@param String String pointer.
@return Length of string printed to the console
**/
UINTN
PrintString (
CHAR16 *String
)
{
return ConsolePrint (L"%s", String);
}
/**
Prints a chracter to the default console,
using L"%c" format.
@param Character Character to print.
@return Length of string printed to the console.
**/
UINTN
PrintChar (
CHAR16 Character
)
{
return ConsolePrint (L"%c", Character);
}
/**
Prints a formatted unicode string to the default console, at
the supplied cursor position
@param Row The cursor position to print the string at
@param fmt Format string
@return Length of string printed to the console
**/
UINTN
PrintAt (
IN UINTN Column,
IN UINTN Row,
IN CHAR16 *fmt,
...
)
{
VA_LIST args;
VA_START (args, fmt);
return PrintInternal (Column, Row, gST->ConOut, fmt, args);
}
/**
Prints a unicode string to the default console, at
the supplied cursor position, using L"%s" format.
@param Row The cursor position to print the string at
@param String String pointer.
@return Length of string printed to the console
**/
UINTN
PrintStringAt (
IN UINTN Column,
IN UINTN Row,
CHAR16 *String
)
{
return PrintAt (Column, Row, L"%s", String);
}
/**
Prints a chracter to the default console, at
the supplied cursor position, using L"%c" format.
@param Row The cursor position to print the string at
@param Character Character to print.
@return Length of string printed to the console.
**/
UINTN
PrintCharAt (
IN UINTN Column,
IN UINTN Row,
CHAR16 Character
)
{
return PrintAt (Column, Row, L"%c", Character);
}
/**
VSPrint worker function that prints a Value as a decimal number in Buffer
@param Buffer Location to place ascii decimal number string of Value.
@param Value Decimal value to convert to a string in Buffer.
@param Flags Flags to use in printing decimal string, see file header for
details.
@return Number of characters printed.
**/
UINTN
ValueToString (
IN OUT CHAR16 *Buffer,
IN BOOLEAN Flags,
IN INT64 Value
)
{
CHAR16 TempBuffer[30];
CHAR16 *TempStr;
CHAR16 *BufferPtr;
UINTN Count;
UINTN NumberCount;
UINT32 Remainder;
BOOLEAN Negative;
Negative = FALSE;
TempStr = TempBuffer;
BufferPtr = Buffer;
Count = 0;
NumberCount = 0;
if (Value < 0) {
Negative = TRUE;
Value = -Value;
}
do {
Value = (INT64) DivU64x32Remainder ((UINT64) Value, 10, &Remainder);
*(TempStr++) = (CHAR16) (Remainder + '0');
Count++;
NumberCount++;
if ((Flags & COMMA_TYPE) == COMMA_TYPE) {
if (NumberCount % 3 == 0 && Value != 0) {
*(TempStr++) = ',';
Count++;
}
}
} while (Value != 0);
if (Negative) {
*(BufferPtr++) = '-';
Count++;
}
//
// Reverse temp string into Buffer.
//
while (TempStr != TempBuffer) {
*(BufferPtr++) = *(--TempStr);
}
*BufferPtr = 0;
return Count;
}
/** @file
Basic Ascii AvSPrintf() function named VSPrint(). VSPrint() enables very
simple implemenation of SPrint() and Print() to support debug.
You can not Print more than EFI_DRIVER_LIB_MAX_PRINT_BUFFER characters at a
time. This makes the implementation very simple.
VSPrint, Print, SPrint format specification has the follwoing form
%type
type:
'S','s' - argument is an Unicode string
'c' - argument is an ascii character
'%' - Print a %
Copyright (c) 2004 - 2007, Intel Corporation
All rights reserved. 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.
**/
#include "Setup.h"
/**
VSPrint worker function that prints a Value as a decimal number in Buffer.
@param Buffer Location to place ascii decimal number string of Value.
@param Flags Flags to use in printing decimal string, see file header for
details.
@param Value Decimal value to convert to a string in Buffer.
@return Number of characters printed.
**/
UINTN
ValueToString (
IN OUT CHAR16 *Buffer,
IN BOOLEAN Flags,
IN INT64 Value
);
/**
The internal function prints to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
protocol instance.
@param Column The position of the output string.
@param Row The position of the output string.
@param Out The EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL instance.
@param Fmt The format string.
@param Args The additional argument for the variables in the format string.
@return Number of Unicode character printed.
**/
UINTN
PrintInternal (
IN UINTN Column,
IN UINTN Row,
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *Out,
IN CHAR16 *Fmt,
IN VA_LIST Args
)
{
CHAR16 *Buffer;
CHAR16 *BackupBuffer;
UINTN Index;
UINTN PreviousIndex;
UINTN Count;
//
// For now, allocate an arbitrarily long buffer
//
Buffer = AllocateZeroPool (0x10000);
BackupBuffer = AllocateZeroPool (0x10000);
ASSERT (Buffer);
ASSERT (BackupBuffer);
if (Column != (UINTN) -1) {
Out->SetCursorPosition (Out, Column, Row);
}
UnicodeVSPrint (Buffer, 0x10000, Fmt, Args);
Out->Mode->Attribute = Out->Mode->Attribute & 0x7f;
Out->SetAttribute (Out, Out->Mode->Attribute);
Index = 0;
PreviousIndex = 0;
Count = 0;
do {
for (; (Buffer[Index] != NARROW_CHAR) && (Buffer[Index] != WIDE_CHAR) && (Buffer[Index] != 0); Index++) {
BackupBuffer[Index] = Buffer[Index];
}
if (Buffer[Index] == 0) {
break;
}
//
// Null-terminate the temporary string
//
BackupBuffer[Index] = 0;
//
// Print this out, we are about to switch widths
//
Out->OutputString (Out, &BackupBuffer[PreviousIndex]);
Count += StrLen (&BackupBuffer[PreviousIndex]);
//
// Preserve the current index + 1, since this is where we will start printing from next
//
PreviousIndex = Index + 1;
//
// We are at a narrow or wide character directive. Set attributes and strip it and print it
//
if (Buffer[Index] == NARROW_CHAR) {
//
// Preserve bits 0 - 6 and zero out the rest
//
Out->Mode->Attribute = Out->Mode->Attribute & 0x7f;
Out->SetAttribute (Out, Out->Mode->Attribute);
} else {
//
// Must be wide, set bit 7 ON
//
Out->Mode->Attribute = Out->Mode->Attribute | EFI_WIDE_ATTRIBUTE;
Out->SetAttribute (Out, Out->Mode->Attribute);
}
Index++;
} while (Buffer[Index] != 0);
//
// We hit the end of the string - print it
//
Out->OutputString (Out, &BackupBuffer[PreviousIndex]);
Count += StrLen (&BackupBuffer[PreviousIndex]);
gBS->FreePool (Buffer);
gBS->FreePool (BackupBuffer);
return Count;
}
/**
Prints a formatted unicode string to the default console.
@param Fmt Format string
@param ... Variable argument list for format string.
@return Length of string printed to the console.
**/
UINTN
ConsolePrint (
IN CHAR16 *Fmt,
IN ...
)
{
VA_LIST Args;
VA_START (Args, Fmt);
return PrintInternal ((UINTN) -1, (UINTN) -1, gST->ConOut, Fmt, Args);
}
/**
Prints a unicode string to the default console,
using L"%s" format.
@param String String pointer.
@return Length of string printed to the console
**/
UINTN
PrintString (
IN CHAR16 *String
)
{
return ConsolePrint (L"%s", String);
}
/**
Prints a chracter to the default console,
using L"%c" format.
@param Character Character to print.
@return Length of string printed to the console.
**/
UINTN
PrintChar (
CHAR16 Character
)
{
return ConsolePrint (L"%c", Character);
}
/**
Prints a formatted unicode string to the default console, at
the supplied cursor position.
@param Column The cursor position to print the string at.
@param Row The cursor position to print the string at.
@param Fmt Format string.
@param ... Variable argument list for format string.
@return Length of string printed to the console
**/
UINTN
PrintAt (
IN UINTN Column,
IN UINTN Row,
IN CHAR16 *Fmt,
...
)
{
VA_LIST Args;
VA_START (Args, Fmt);
return PrintInternal (Column, Row, gST->ConOut, Fmt, Args);
}
/**
Prints a unicode string to the default console, at
the supplied cursor position, using L"%s" format.
@param Column The cursor position to print the string at.
@param Row The cursor position to print the string at
@param String String pointer.
@return Length of string printed to the console
**/
UINTN
PrintStringAt (
IN UINTN Column,
IN UINTN Row,
CHAR16 *String
)
{
return PrintAt (Column, Row, L"%s", String);
}
/**
Prints a chracter to the default console, at
the supplied cursor position, using L"%c" format.
@param Column The cursor position to print the string at.
@param Row The cursor position to print the string at.
@param Character Character to print.
@return Length of string printed to the console.
**/
UINTN
PrintCharAt (
IN UINTN Column,
IN UINTN Row,
CHAR16 Character
)
{
return PrintAt (Column, Row, L"%c", Character);
}
/**
VSPrint worker function that prints a Value as a decimal number in Buffer.
@param Buffer Location to place ascii decimal number string of Value.
@param Flags Flags to use in printing decimal string, see file header for
details.
@param Value Decimal value to convert to a string in Buffer.
@return Number of characters printed.
**/
UINTN
ValueToString (
IN OUT CHAR16 *Buffer,
IN BOOLEAN Flags,
IN INT64 Value
)
{
CHAR16 TempBuffer[30];
CHAR16 *TempStr;
CHAR16 *BufferPtr;
UINTN Count;
UINTN NumberCount;
UINT32 Remainder;
BOOLEAN Negative;
Negative = FALSE;
TempStr = TempBuffer;
BufferPtr = Buffer;
Count = 0;
NumberCount = 0;
if (Value < 0) {
Negative = TRUE;
Value = -Value;
}
do {
Value = (INT64) DivU64x32Remainder ((UINT64) Value, 10, &Remainder);
*(TempStr++) = (CHAR16) (Remainder + '0');
Count++;
NumberCount++;
if ((Flags & COMMA_TYPE) == COMMA_TYPE) {
if (NumberCount % 3 == 0 && Value != 0) {
*(TempStr++) = ',';
Count++;
}
}
} while (Value != 0);
if (Negative) {
*(BufferPtr++) = '-';
Count++;
}
//
// Reverse temp string into Buffer.
//
while (TempStr != TempBuffer) {
*(BufferPtr++) = *(--TempStr);
}
*BufferPtr = 0;
return Count;
}

View File

@ -1,4 +1,5 @@
/** @file
Micro definitions data for Print.c
Copyright (c) 2004, Intel Corporation
All rights reserved. This program and the accompanying materials
@ -9,15 +10,6 @@ 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.
Module Name:
Print.h
Abstract:
Private data for Print.c
**/
#ifndef _PRINT_H_

View File

@ -1,4 +1,6 @@
/** @file
Implementation for handling the User Interface option processing.
Copyright (c) 2004 - 2007, Intel Corporation
All rights reserved. This program and the accompanying materials
@ -9,17 +11,6 @@ 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.
Module Name:
ProcessOptions.c
Abstract:
Implementation for handling the User Interface option processing.
Revision History
**/
#include "Ui.h"
@ -113,7 +104,7 @@ ValueToOption (
/**
Print Question Value according to it's storage width and display attributes.
@param Event The event to wait for
@param Question The Question to be printed.
@param FormattedNumber Buffer for output string.
@param BufferSize The FormattedNumber buffer size in bytes.
@ -265,10 +256,6 @@ PasswordCallback (
/**
Display error message for invalid password.
None.
@return None.
**/
VOID
PasswordInvalid (
@ -624,7 +611,7 @@ ProcessOptions (
//
// For interactive passwords, old password is validated by callback
//
if (Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) {
if ((Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) != 0) {
//
// Use a NULL password to test whether old password is required
//
@ -707,7 +694,7 @@ ProcessOptions (
//
// Reset state machine for interactive password
//
if (Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) {
if ((Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) != 0) {
PasswordCallback (Selection, MenuOption, NULL);
}
@ -725,7 +712,7 @@ ProcessOptions (
//
// Reset state machine for interactive password
//
if (Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) {
if ((Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) != 0) {
PasswordCallback (Selection, MenuOption, NULL);
}
@ -741,7 +728,7 @@ ProcessOptions (
//
// Two password match, send it to Configuration Driver
//
if (Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) {
if ((Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) != 0) {
PasswordCallback (Selection, MenuOption, StringPtr);
} else {
CopyMem (Question->BufferValue, StringPtr, Maximum * sizeof (CHAR16));
@ -751,7 +738,7 @@ ProcessOptions (
//
// Reset state machine for interactive password
//
if (Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) {
if ((Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) != 0) {
PasswordCallback (Selection, MenuOption, NULL);
}
@ -781,11 +768,8 @@ ProcessOptions (
FormattedString and the glyph width of each line cannot exceed gHelpBlockWidth.
@param StringPtr The entire help string.
@param MenuOption The MenuOption for this Question.
@param FormattedString The oupput formatted string.
@param RowCount TRUE: if Question is selected.
@param OptionString Pointer of the Option String to be displayed.
@return None.
**/
VOID

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff