]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/DisplayEngineDxe/ProcessOptions.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
MdeModulePkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / MdeModulePkg / Universal / DisplayEngineDxe / ProcessOptions.c
1 /** @file
2 Implementation for handling the User Interface option processing.
3
4
5 Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>
6 SPDX-License-Identifier: BSD-2-Clause-Patent
7
8 **/
9
10 #include "FormDisplay.h"
11
12 #define MAX_TIME_OUT_LEN 0x10
13
14 /**
15 Concatenate a narrow string to another string.
16
17 @param Destination The destination string.
18 @param DestMax The Max length of destination string.
19 @param Source The source string. The string to be concatenated.
20 to the end of Destination.
21
22 **/
23 VOID
24 NewStrCat (
25 IN OUT CHAR16 *Destination,
26 IN UINTN DestMax,
27 IN CHAR16 *Source
28 )
29 {
30 UINTN Length;
31
32 for (Length = 0; Destination[Length] != 0; Length++)
33 ;
34
35 //
36 // We now have the length of the original string
37 // We can safely assume for now that we are concatenating a narrow value to this string.
38 // For instance, the string is "XYZ" and cat'ing ">"
39 // If this assumption changes, we need to make this routine a bit more complex
40 //
41 Destination[Length] = NARROW_CHAR;
42 Length++;
43
44 StrCpyS (Destination + Length, DestMax - Length, Source);
45 }
46
47 /**
48 Get UINT64 type value.
49
50 @param Value Input Hii value.
51
52 @retval UINT64 Return the UINT64 type value.
53
54 **/
55 UINT64
56 HiiValueToUINT64 (
57 IN EFI_HII_VALUE *Value
58 )
59 {
60 UINT64 RetVal;
61
62 RetVal = 0;
63
64 switch (Value->Type) {
65 case EFI_IFR_TYPE_NUM_SIZE_8:
66 RetVal = Value->Value.u8;
67 break;
68
69 case EFI_IFR_TYPE_NUM_SIZE_16:
70 RetVal = Value->Value.u16;
71 break;
72
73 case EFI_IFR_TYPE_NUM_SIZE_32:
74 RetVal = Value->Value.u32;
75 break;
76
77 case EFI_IFR_TYPE_BOOLEAN:
78 RetVal = Value->Value.b;
79 break;
80
81 case EFI_IFR_TYPE_DATE:
82 RetVal = *(UINT64*) &Value->Value.date;
83 break;
84
85 case EFI_IFR_TYPE_TIME:
86 RetVal = (*(UINT64*) &Value->Value.time) & 0xffffff;
87 break;
88
89 default:
90 RetVal = Value->Value.u64;
91 break;
92 }
93
94 return RetVal;
95 }
96
97 /**
98 Check whether this value type can be transfer to EFI_IFR_TYPE_BUFFER type.
99
100 EFI_IFR_TYPE_REF, EFI_IFR_TYPE_DATE and EFI_IFR_TYPE_TIME are converted to
101 EFI_IFR_TYPE_BUFFER when do the value compare.
102
103 @param Value Expression value to compare on.
104
105 @retval TRUE This value type can be transter to EFI_IFR_TYPE_BUFFER type.
106 @retval FALSE This value type can't be transter to EFI_IFR_TYPE_BUFFER type.
107
108 **/
109 BOOLEAN
110 IsTypeInBuffer (
111 IN EFI_HII_VALUE *Value
112 )
113 {
114 switch (Value->Type) {
115 case EFI_IFR_TYPE_BUFFER:
116 case EFI_IFR_TYPE_DATE:
117 case EFI_IFR_TYPE_TIME:
118 case EFI_IFR_TYPE_REF:
119 return TRUE;
120
121 default:
122 return FALSE;
123 }
124 }
125
126 /**
127 Check whether this value type can be transfer to EFI_IFR_TYPE_UINT64
128
129 @param Value Expression value to compare on.
130
131 @retval TRUE This value type can be transter to EFI_IFR_TYPE_BUFFER type.
132 @retval FALSE This value type can't be transter to EFI_IFR_TYPE_BUFFER type.
133
134 **/
135 BOOLEAN
136 IsTypeInUINT64 (
137 IN EFI_HII_VALUE *Value
138 )
139 {
140 switch (Value->Type) {
141 case EFI_IFR_TYPE_NUM_SIZE_8:
142 case EFI_IFR_TYPE_NUM_SIZE_16:
143 case EFI_IFR_TYPE_NUM_SIZE_32:
144 case EFI_IFR_TYPE_NUM_SIZE_64:
145 case EFI_IFR_TYPE_BOOLEAN:
146 return TRUE;
147
148 default:
149 return FALSE;
150 }
151 }
152
153 /**
154 Return the buffer length and buffer pointer for this value.
155
156 EFI_IFR_TYPE_REF, EFI_IFR_TYPE_DATE and EFI_IFR_TYPE_TIME are converted to
157 EFI_IFR_TYPE_BUFFER when do the value compare.
158
159 @param Value Expression value to compare on.
160 @param Buf Return the buffer pointer.
161 @param BufLen Return the buffer length.
162
163 **/
164 VOID
165 GetBufAndLenForValue (
166 IN EFI_HII_VALUE *Value,
167 OUT UINT8 **Buf,
168 OUT UINT16 *BufLen
169 )
170 {
171 switch (Value->Type) {
172 case EFI_IFR_TYPE_BUFFER:
173 *Buf = Value->Buffer;
174 *BufLen = Value->BufferLen;
175 break;
176
177 case EFI_IFR_TYPE_DATE:
178 *Buf = (UINT8 *) (&Value->Value.date);
179 *BufLen = (UINT16) sizeof (EFI_HII_DATE);
180 break;
181
182 case EFI_IFR_TYPE_TIME:
183 *Buf = (UINT8 *) (&Value->Value.time);
184 *BufLen = (UINT16) sizeof (EFI_HII_TIME);
185 break;
186
187 case EFI_IFR_TYPE_REF:
188 *Buf = (UINT8 *) (&Value->Value.ref);
189 *BufLen = (UINT16) sizeof (EFI_HII_REF);
190 break;
191
192 default:
193 *Buf = NULL;
194 *BufLen = 0;
195 }
196 }
197
198 /**
199 Compare two Hii value.
200
201 @param Value1 Expression value to compare on left-hand.
202 @param Value2 Expression value to compare on right-hand.
203 @param Result Return value after compare.
204 retval 0 Two operators equal.
205 return Positive value if Value1 is greater than Value2.
206 retval Negative value if Value1 is less than Value2.
207 @param HiiHandle Only required for string compare.
208
209 @retval other Could not perform compare on two values.
210 @retval EFI_SUCCESS Compare the value success.
211
212 **/
213 EFI_STATUS
214 CompareHiiValue (
215 IN EFI_HII_VALUE *Value1,
216 IN EFI_HII_VALUE *Value2,
217 OUT INTN *Result,
218 IN EFI_HII_HANDLE HiiHandle OPTIONAL
219 )
220 {
221 INT64 Temp64;
222 CHAR16 *Str1;
223 CHAR16 *Str2;
224 UINTN Len;
225 UINT8 *Buf1;
226 UINT16 Buf1Len;
227 UINT8 *Buf2;
228 UINT16 Buf2Len;
229
230 if (Value1->Type == EFI_IFR_TYPE_STRING && Value2->Type == EFI_IFR_TYPE_STRING) {
231 if (Value1->Value.string == 0 || Value2->Value.string == 0) {
232 //
233 // StringId 0 is reserved
234 //
235 return EFI_INVALID_PARAMETER;
236 }
237
238 if (Value1->Value.string == Value2->Value.string) {
239 *Result = 0;
240 return EFI_SUCCESS;
241 }
242
243 Str1 = GetToken (Value1->Value.string, HiiHandle);
244 if (Str1 == NULL) {
245 //
246 // String not found
247 //
248 return EFI_NOT_FOUND;
249 }
250
251 Str2 = GetToken (Value2->Value.string, HiiHandle);
252 if (Str2 == NULL) {
253 FreePool (Str1);
254 return EFI_NOT_FOUND;
255 }
256
257 *Result = StrCmp (Str1, Str2);
258
259 FreePool (Str1);
260 FreePool (Str2);
261
262 return EFI_SUCCESS;
263 }
264
265 //
266 // Take types(date, time, ref, buffer) as buffer
267 //
268 if (IsTypeInBuffer(Value1) && IsTypeInBuffer(Value2)) {
269 GetBufAndLenForValue(Value1, &Buf1, &Buf1Len);
270 GetBufAndLenForValue(Value2, &Buf2, &Buf2Len);
271
272 Len = Buf1Len > Buf2Len ? Buf2Len : Buf1Len;
273 *Result = CompareMem (Buf1, Buf2, Len);
274 if ((*Result == 0) && (Buf1Len != Buf2Len)) {
275 //
276 // In this case, means base on samll number buffer, the data is same
277 // So which value has more data, which value is bigger.
278 //
279 *Result = Buf1Len > Buf2Len ? 1 : -1;
280 }
281 return EFI_SUCCESS;
282 }
283
284 //
285 // Take remain types(integer, boolean, date/time) as integer
286 //
287 if (IsTypeInUINT64(Value1) && IsTypeInUINT64(Value2)) {
288 Temp64 = HiiValueToUINT64(Value1) - HiiValueToUINT64(Value2);
289 if (Temp64 > 0) {
290 *Result = 1;
291 } else if (Temp64 < 0) {
292 *Result = -1;
293 } else {
294 *Result = 0;
295 }
296 return EFI_SUCCESS;
297 }
298
299 return EFI_UNSUPPORTED;
300 }
301
302 /**
303 Search an Option of a Question by its value.
304
305 @param Question The Question
306 @param OptionValue Value for Option to be searched.
307
308 @retval Pointer Pointer to the found Option.
309 @retval NULL Option not found.
310
311 **/
312 DISPLAY_QUESTION_OPTION *
313 ValueToOption (
314 IN FORM_DISPLAY_ENGINE_STATEMENT *Question,
315 IN EFI_HII_VALUE *OptionValue
316 )
317 {
318 LIST_ENTRY *Link;
319 DISPLAY_QUESTION_OPTION *Option;
320 INTN Result;
321 EFI_HII_VALUE Value;
322
323 Link = GetFirstNode (&Question->OptionListHead);
324 while (!IsNull (&Question->OptionListHead, Link)) {
325 Option = DISPLAY_QUESTION_OPTION_FROM_LINK (Link);
326
327 ZeroMem (&Value, sizeof (EFI_HII_VALUE));
328 Value.Type = Option->OptionOpCode->Type;
329 CopyMem (&Value.Value, &Option->OptionOpCode->Value, Option->OptionOpCode->Header.Length - OFFSET_OF (EFI_IFR_ONE_OF_OPTION, Value));
330
331 if ((CompareHiiValue (&Value, OptionValue, &Result, NULL) == EFI_SUCCESS) && (Result == 0)) {
332 return Option;
333 }
334
335 Link = GetNextNode (&Question->OptionListHead, Link);
336 }
337
338 return NULL;
339 }
340
341
342 /**
343 Return data element in an Array by its Index.
344
345 @param Array The data array.
346 @param Type Type of the data in this array.
347 @param Index Zero based index for data in this array.
348
349 @retval Value The data to be returned
350
351 **/
352 UINT64
353 GetArrayData (
354 IN VOID *Array,
355 IN UINT8 Type,
356 IN UINTN Index
357 )
358 {
359 UINT64 Data;
360
361 ASSERT (Array != NULL);
362
363 Data = 0;
364 switch (Type) {
365 case EFI_IFR_TYPE_NUM_SIZE_8:
366 Data = (UINT64) *(((UINT8 *) Array) + Index);
367 break;
368
369 case EFI_IFR_TYPE_NUM_SIZE_16:
370 Data = (UINT64) *(((UINT16 *) Array) + Index);
371 break;
372
373 case EFI_IFR_TYPE_NUM_SIZE_32:
374 Data = (UINT64) *(((UINT32 *) Array) + Index);
375 break;
376
377 case EFI_IFR_TYPE_NUM_SIZE_64:
378 Data = (UINT64) *(((UINT64 *) Array) + Index);
379 break;
380
381 default:
382 break;
383 }
384
385 return Data;
386 }
387
388
389 /**
390 Set value of a data element in an Array by its Index.
391
392 @param Array The data array.
393 @param Type Type of the data in this array.
394 @param Index Zero based index for data in this array.
395 @param Value The value to be set.
396
397 **/
398 VOID
399 SetArrayData (
400 IN VOID *Array,
401 IN UINT8 Type,
402 IN UINTN Index,
403 IN UINT64 Value
404 )
405 {
406
407 ASSERT (Array != NULL);
408
409 switch (Type) {
410 case EFI_IFR_TYPE_NUM_SIZE_8:
411 *(((UINT8 *) Array) + Index) = (UINT8) Value;
412 break;
413
414 case EFI_IFR_TYPE_NUM_SIZE_16:
415 *(((UINT16 *) Array) + Index) = (UINT16) Value;
416 break;
417
418 case EFI_IFR_TYPE_NUM_SIZE_32:
419 *(((UINT32 *) Array) + Index) = (UINT32) Value;
420 break;
421
422 case EFI_IFR_TYPE_NUM_SIZE_64:
423 *(((UINT64 *) Array) + Index) = (UINT64) Value;
424 break;
425
426 default:
427 break;
428 }
429 }
430
431 /**
432 Check whether this value already in the array, if yes, return the index.
433
434 @param Array The data array.
435 @param Type Type of the data in this array.
436 @param Value The value to be find.
437 @param Index The index in the array which has same value with Value.
438
439 @retval TRUE Found the value in the array.
440 @retval FALSE Not found the value.
441
442 **/
443 BOOLEAN
444 FindArrayData (
445 IN VOID *Array,
446 IN UINT8 Type,
447 IN UINT64 Value,
448 OUT UINTN *Index OPTIONAL
449 )
450 {
451 UINTN Count;
452 UINT64 TmpValue;
453 UINT64 ValueComp;
454
455 ASSERT (Array != NULL);
456
457 Count = 0;
458 TmpValue = 0;
459
460 switch (Type) {
461 case EFI_IFR_TYPE_NUM_SIZE_8:
462 ValueComp = (UINT8) Value;
463 break;
464
465 case EFI_IFR_TYPE_NUM_SIZE_16:
466 ValueComp = (UINT16) Value;
467 break;
468
469 case EFI_IFR_TYPE_NUM_SIZE_32:
470 ValueComp = (UINT32) Value;
471 break;
472
473 case EFI_IFR_TYPE_NUM_SIZE_64:
474 ValueComp = (UINT64) Value;
475 break;
476
477 default:
478 ValueComp = 0;
479 break;
480 }
481
482 while ((TmpValue = GetArrayData (Array, Type, Count)) != 0) {
483 if (ValueComp == TmpValue) {
484 if (Index != NULL) {
485 *Index = Count;
486 }
487 return TRUE;
488 }
489
490 Count ++;
491 }
492
493 return FALSE;
494 }
495
496 /**
497 Print Question Value according to it's storage width and display attributes.
498
499 @param Question The Question to be printed.
500 @param FormattedNumber Buffer for output string.
501 @param BufferSize The FormattedNumber buffer size in bytes.
502
503 @retval EFI_SUCCESS Print success.
504 @retval EFI_BUFFER_TOO_SMALL Buffer size is not enough for formatted number.
505
506 **/
507 EFI_STATUS
508 PrintFormattedNumber (
509 IN FORM_DISPLAY_ENGINE_STATEMENT *Question,
510 IN OUT CHAR16 *FormattedNumber,
511 IN UINTN BufferSize
512 )
513 {
514 INT64 Value;
515 CHAR16 *Format;
516 EFI_HII_VALUE *QuestionValue;
517 EFI_IFR_NUMERIC *NumericOp;
518
519 if (BufferSize < (21 * sizeof (CHAR16))) {
520 return EFI_BUFFER_TOO_SMALL;
521 }
522
523 QuestionValue = &Question->CurrentValue;
524 NumericOp = (EFI_IFR_NUMERIC *) Question->OpCode;
525
526 Value = (INT64) QuestionValue->Value.u64;
527 switch (NumericOp->Flags & EFI_IFR_DISPLAY) {
528 case EFI_IFR_DISPLAY_INT_DEC:
529 switch (QuestionValue->Type) {
530 case EFI_IFR_NUMERIC_SIZE_1:
531 Value = (INT64) ((INT8) QuestionValue->Value.u8);
532 break;
533
534 case EFI_IFR_NUMERIC_SIZE_2:
535 Value = (INT64) ((INT16) QuestionValue->Value.u16);
536 break;
537
538 case EFI_IFR_NUMERIC_SIZE_4:
539 Value = (INT64) ((INT32) QuestionValue->Value.u32);
540 break;
541
542 case EFI_IFR_NUMERIC_SIZE_8:
543 default:
544 break;
545 }
546
547 if (Value < 0) {
548 Value = -Value;
549 Format = L"-%ld";
550 } else {
551 Format = L"%ld";
552 }
553 break;
554
555 case EFI_IFR_DISPLAY_UINT_DEC:
556 Format = L"%ld";
557 break;
558
559 case EFI_IFR_DISPLAY_UINT_HEX:
560 Format = L"%lx";
561 break;
562
563 default:
564 return EFI_UNSUPPORTED;
565 }
566
567 UnicodeSPrint (FormattedNumber, BufferSize, Format, Value);
568
569 return EFI_SUCCESS;
570 }
571
572
573 /**
574 Draw a pop up windows based on the dimension, number of lines and
575 strings specified.
576
577 @param RequestedWidth The width of the pop-up.
578 @param NumberOfLines The number of lines.
579 @param Marker The variable argument list for the list of string to be printed.
580
581 **/
582 VOID
583 CreateSharedPopUp (
584 IN UINTN RequestedWidth,
585 IN UINTN NumberOfLines,
586 IN VA_LIST Marker
587 )
588 {
589 UINTN Index;
590 UINTN Count;
591 CHAR16 Character;
592 UINTN Start;
593 UINTN End;
594 UINTN Top;
595 UINTN Bottom;
596 CHAR16 *String;
597 UINTN DimensionsWidth;
598 UINTN DimensionsHeight;
599
600 DimensionsWidth = gStatementDimensions.RightColumn - gStatementDimensions.LeftColumn;
601 DimensionsHeight = gStatementDimensions.BottomRow - gStatementDimensions.TopRow;
602
603 gST->ConOut->SetAttribute (gST->ConOut, GetPopupColor ());
604
605 if ((RequestedWidth + 2) > DimensionsWidth) {
606 RequestedWidth = DimensionsWidth - 2;
607 }
608
609 //
610 // Subtract the PopUp width from total Columns, allow for one space extra on
611 // each end plus a border.
612 //
613 Start = (DimensionsWidth - RequestedWidth - 2) / 2 + gStatementDimensions.LeftColumn + 1;
614 End = Start + RequestedWidth + 1;
615
616 Top = ((DimensionsHeight - NumberOfLines - 2) / 2) + gStatementDimensions.TopRow - 1;
617 Bottom = Top + NumberOfLines + 2;
618
619 Character = BOXDRAW_DOWN_RIGHT;
620 PrintCharAt (Start, Top, Character);
621 Character = BOXDRAW_HORIZONTAL;
622 for (Index = Start; Index + 2 < End; Index++) {
623 PrintCharAt ((UINTN)-1, (UINTN)-1, Character);
624 }
625
626 Character = BOXDRAW_DOWN_LEFT;
627 PrintCharAt ((UINTN)-1, (UINTN)-1, Character);
628 Character = BOXDRAW_VERTICAL;
629
630 Count = 0;
631 for (Index = Top; Index + 2 < Bottom; Index++, Count++) {
632 String = VA_ARG (Marker, CHAR16*);
633
634 //
635 // This will clear the background of the line - we never know who might have been
636 // here before us. This differs from the next clear in that it used the non-reverse
637 // video for normal printing.
638 //
639 if (GetStringWidth (String) / 2 > 1) {
640 ClearLines (Start, End, Index + 1, Index + 1, GetPopupColor ());
641 }
642
643 //
644 // Passing in a space results in the assumption that this is where typing will occur
645 //
646 if (String[0] == L' ') {
647 ClearLines (Start + 1, End - 1, Index + 1, Index + 1, GetPopupInverseColor ());
648 }
649
650 //
651 // Passing in a NULL results in a blank space
652 //
653 if (String[0] == CHAR_NULL) {
654 ClearLines (Start, End, Index + 1, Index + 1, GetPopupColor ());
655 }
656
657 PrintStringAt (
658 ((DimensionsWidth - GetStringWidth (String) / 2) / 2) + gStatementDimensions.LeftColumn + 1,
659 Index + 1,
660 String
661 );
662 gST->ConOut->SetAttribute (gST->ConOut, GetPopupColor ());
663 PrintCharAt (Start, Index + 1, Character);
664 PrintCharAt (End - 1, Index + 1, Character);
665 }
666
667 Character = BOXDRAW_UP_RIGHT;
668 PrintCharAt (Start, Bottom - 1, Character);
669 Character = BOXDRAW_HORIZONTAL;
670 for (Index = Start; Index + 2 < End; Index++) {
671 PrintCharAt ((UINTN)-1, (UINTN)-1, Character);
672 }
673
674 Character = BOXDRAW_UP_LEFT;
675 PrintCharAt ((UINTN)-1, (UINTN)-1, Character);
676 }
677
678 /**
679 Draw a pop up windows based on the dimension, number of lines and
680 strings specified.
681
682 @param RequestedWidth The width of the pop-up.
683 @param NumberOfLines The number of lines.
684 @param ... A series of text strings that displayed in the pop-up.
685
686 **/
687 VOID
688 EFIAPI
689 CreateMultiStringPopUp (
690 IN UINTN RequestedWidth,
691 IN UINTN NumberOfLines,
692 ...
693 )
694 {
695 VA_LIST Marker;
696
697 VA_START (Marker, NumberOfLines);
698
699 CreateSharedPopUp (RequestedWidth, NumberOfLines, Marker);
700
701 VA_END (Marker);
702 }
703
704 /**
705 Process nothing.
706
707 @param Event The Event need to be process
708 @param Context The context of the event.
709
710 **/
711 VOID
712 EFIAPI
713 EmptyEventProcess (
714 IN EFI_EVENT Event,
715 IN VOID *Context
716 )
717 {
718 }
719
720 /**
721 Process for the refresh interval statement.
722
723 @param Event The Event need to be process
724 @param Context The context of the event.
725
726 **/
727 VOID
728 EFIAPI
729 RefreshTimeOutProcess (
730 IN EFI_EVENT Event,
731 IN VOID *Context
732 )
733 {
734 WARNING_IF_CONTEXT *EventInfo;
735 CHAR16 TimeOutString[MAX_TIME_OUT_LEN];
736
737 EventInfo = (WARNING_IF_CONTEXT *) Context;
738
739 if (*(EventInfo->TimeOut) == 0) {
740 gBS->CloseEvent (Event);
741
742 gBS->SignalEvent (EventInfo->SyncEvent);
743 return;
744 }
745
746 UnicodeSPrint(TimeOutString, MAX_TIME_OUT_LEN, L"%d", *(EventInfo->TimeOut));
747
748 CreateDialog (NULL, gEmptyString, EventInfo->ErrorInfo, gPressEnter, gEmptyString, TimeOutString, NULL);
749
750 *(EventInfo->TimeOut) -= 1;
751 }
752
753 /**
754 Display error message for invalid password.
755
756 **/
757 VOID
758 PasswordInvalid (
759 VOID
760 )
761 {
762 EFI_INPUT_KEY Key;
763
764 //
765 // Invalid password, prompt error message
766 //
767 do {
768 CreateDialog (&Key, gEmptyString, gPassowordInvalid, gPressEnter, gEmptyString, NULL);
769 } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);
770 }
771
772 /**
773 Process password op code.
774
775 @param MenuOption The menu for current password op code.
776
777 @retval EFI_SUCCESS Question Option process success.
778 @retval Other Question Option process fail.
779
780 **/
781 EFI_STATUS
782 PasswordProcess (
783 IN UI_MENU_OPTION *MenuOption
784 )
785 {
786 CHAR16 *StringPtr;
787 CHAR16 *TempString;
788 UINTN Maximum;
789 EFI_STATUS Status;
790 EFI_IFR_PASSWORD *PasswordInfo;
791 FORM_DISPLAY_ENGINE_STATEMENT *Question;
792 EFI_INPUT_KEY Key;
793
794 Question = MenuOption->ThisTag;
795 PasswordInfo = (EFI_IFR_PASSWORD *) Question->OpCode;
796 Maximum = PasswordInfo->MaxSize;
797 Status = EFI_SUCCESS;
798
799 StringPtr = AllocateZeroPool ((Maximum + 1) * sizeof (CHAR16));
800 ASSERT (StringPtr);
801
802 //
803 // Use a NULL password to test whether old password is required
804 //
805 *StringPtr = 0;
806 Status = Question->PasswordCheck (gFormData, Question, StringPtr);
807 if (Status == EFI_NOT_AVAILABLE_YET || Status == EFI_UNSUPPORTED) {
808 //
809 // Password can't be set now.
810 //
811 if (Status == EFI_UNSUPPORTED) {
812 do {
813 CreateDialog (&Key, gEmptyString, gPasswordUnsupported, gPressEnter, gEmptyString, NULL);
814 } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);
815 }
816 FreePool (StringPtr);
817 return EFI_SUCCESS;
818 }
819
820 if (EFI_ERROR (Status)) {
821 //
822 // Old password exist, ask user for the old password
823 //
824 Status = ReadString (MenuOption, gPromptForPassword, StringPtr);
825 if (EFI_ERROR (Status)) {
826 FreePool (StringPtr);
827 return Status;
828 }
829
830 //
831 // Check user input old password
832 //
833 Status = Question->PasswordCheck (gFormData, Question, StringPtr);
834 if (EFI_ERROR (Status)) {
835 if (Status == EFI_NOT_READY) {
836 //
837 // Typed in old password incorrect
838 //
839 PasswordInvalid ();
840 } else {
841 Status = EFI_SUCCESS;
842 }
843
844 FreePool (StringPtr);
845 return Status;
846 }
847 }
848
849 //
850 // Ask for new password
851 //
852 ZeroMem (StringPtr, (Maximum + 1) * sizeof (CHAR16));
853 Status = ReadString (MenuOption, gPromptForNewPassword, StringPtr);
854 if (EFI_ERROR (Status)) {
855 //
856 // Reset state machine for password
857 //
858 Question->PasswordCheck (gFormData, Question, NULL);
859 FreePool (StringPtr);
860 return Status;
861 }
862
863 //
864 // Confirm new password
865 //
866 TempString = AllocateZeroPool ((Maximum + 1) * sizeof (CHAR16));
867 ASSERT (TempString);
868 Status = ReadString (MenuOption, gConfirmPassword, TempString);
869 if (EFI_ERROR (Status)) {
870 //
871 // Reset state machine for password
872 //
873 Question->PasswordCheck (gFormData, Question, NULL);
874 FreePool (StringPtr);
875 FreePool (TempString);
876 return Status;
877 }
878
879 //
880 // Compare two typed-in new passwords
881 //
882 if (StrCmp (StringPtr, TempString) == 0) {
883 gUserInput->InputValue.Buffer = AllocateCopyPool (Question->CurrentValue.BufferLen, StringPtr);
884 gUserInput->InputValue.BufferLen = Question->CurrentValue.BufferLen;
885 gUserInput->InputValue.Type = Question->CurrentValue.Type;
886 gUserInput->InputValue.Value.string = HiiSetString(gFormData->HiiHandle, gUserInput->InputValue.Value.string, StringPtr, NULL);
887
888 Status = EFI_SUCCESS;
889 } else {
890 //
891 // Reset state machine for password
892 //
893 Question->PasswordCheck (gFormData, Question, NULL);
894
895 //
896 // Two password mismatch, prompt error message
897 //
898 do {
899 CreateDialog (&Key, gEmptyString, gConfirmError, gPressEnter, gEmptyString, NULL);
900 } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);
901
902 Status = EFI_INVALID_PARAMETER;
903 }
904 ZeroMem (TempString, (Maximum + 1) * sizeof (CHAR16));
905 ZeroMem (StringPtr, (Maximum + 1) * sizeof (CHAR16));
906 FreePool (TempString);
907 FreePool (StringPtr);
908
909 return Status;
910 }
911
912 /**
913 Process a Question's Option (whether selected or un-selected).
914
915 @param MenuOption The MenuOption for this Question.
916 @param Selected TRUE: if Question is selected.
917 @param OptionString Pointer of the Option String to be displayed.
918 @param SkipErrorValue Whether need to return when value without option for it.
919
920 @retval EFI_SUCCESS Question Option process success.
921 @retval Other Question Option process fail.
922
923 **/
924 EFI_STATUS
925 ProcessOptions (
926 IN UI_MENU_OPTION *MenuOption,
927 IN BOOLEAN Selected,
928 OUT CHAR16 **OptionString,
929 IN BOOLEAN SkipErrorValue
930 )
931 {
932 EFI_STATUS Status;
933 CHAR16 *StringPtr;
934 UINTN Index;
935 FORM_DISPLAY_ENGINE_STATEMENT *Question;
936 CHAR16 FormattedNumber[21];
937 UINT16 Number;
938 CHAR16 Character[2];
939 EFI_INPUT_KEY Key;
940 UINTN BufferSize;
941 DISPLAY_QUESTION_OPTION *OneOfOption;
942 LIST_ENTRY *Link;
943 EFI_HII_VALUE HiiValue;
944 EFI_HII_VALUE *QuestionValue;
945 DISPLAY_QUESTION_OPTION *Option;
946 UINTN Index2;
947 UINT8 *ValueArray;
948 UINT8 ValueType;
949 EFI_IFR_ORDERED_LIST *OrderList;
950 BOOLEAN ValueInvalid;
951 UINTN MaxLen;
952
953 Status = EFI_SUCCESS;
954
955 StringPtr = NULL;
956 Character[1] = L'\0';
957 *OptionString = NULL;
958 ValueInvalid = FALSE;
959
960 ZeroMem (FormattedNumber, 21 * sizeof (CHAR16));
961 BufferSize = (gOptionBlockWidth + 1) * 2 * gStatementDimensions.BottomRow;
962
963 Question = MenuOption->ThisTag;
964 QuestionValue = &Question->CurrentValue;
965
966 switch (Question->OpCode->OpCode) {
967 case EFI_IFR_ORDERED_LIST_OP:
968
969 //
970 // Check whether there are Options of this OrderedList
971 //
972 if (IsListEmpty (&Question->OptionListHead)) {
973 break;
974 }
975
976 OrderList = (EFI_IFR_ORDERED_LIST *) Question->OpCode;
977
978 Link = GetFirstNode (&Question->OptionListHead);
979 OneOfOption = DISPLAY_QUESTION_OPTION_FROM_LINK (Link);
980
981 ValueType = OneOfOption->OptionOpCode->Type;
982 ValueArray = Question->CurrentValue.Buffer;
983
984 if (Selected) {
985 //
986 // Go ask for input
987 //
988 Status = GetSelectionInputPopUp (MenuOption);
989 } else {
990 //
991 // We now know how many strings we will have, so we can allocate the
992 // space required for the array or strings.
993 //
994 MaxLen = OrderList->MaxContainers * BufferSize / sizeof (CHAR16);
995 *OptionString = AllocateZeroPool (MaxLen * sizeof (CHAR16));
996 ASSERT (*OptionString);
997
998 HiiValue.Type = ValueType;
999 HiiValue.Value.u64 = 0;
1000 for (Index = 0; Index < OrderList->MaxContainers; Index++) {
1001 HiiValue.Value.u64 = GetArrayData (ValueArray, ValueType, Index);
1002 if (HiiValue.Value.u64 == 0) {
1003 //
1004 // Values for the options in ordered lists should never be a 0
1005 //
1006 break;
1007 }
1008
1009 OneOfOption = ValueToOption (Question, &HiiValue);
1010 if (OneOfOption == NULL) {
1011 if (SkipErrorValue) {
1012 //
1013 // Just try to get the option string, skip the value which not has option.
1014 //
1015 continue;
1016 }
1017
1018 //
1019 // Show error message
1020 //
1021 do {
1022 CreateDialog (&Key, gEmptyString, gOptionMismatch, gPressEnter, gEmptyString, NULL);
1023 } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);
1024
1025 //
1026 // The initial value of the orderedlist is invalid, force to be valid value
1027 // Exit current DisplayForm with new value.
1028 //
1029 gUserInput->SelectedStatement = Question;
1030 gMisMatch = TRUE;
1031 ValueArray = AllocateZeroPool (Question->CurrentValue.BufferLen);
1032 ASSERT (ValueArray != NULL);
1033 gUserInput->InputValue.Buffer = ValueArray;
1034 gUserInput->InputValue.BufferLen = Question->CurrentValue.BufferLen;
1035 gUserInput->InputValue.Type = Question->CurrentValue.Type;
1036
1037 Link = GetFirstNode (&Question->OptionListHead);
1038 Index2 = 0;
1039 while (!IsNull (&Question->OptionListHead, Link) && Index2 < OrderList->MaxContainers) {
1040 Option = DISPLAY_QUESTION_OPTION_FROM_LINK (Link);
1041 Link = GetNextNode (&Question->OptionListHead, Link);
1042 SetArrayData (ValueArray, ValueType, Index2, Option->OptionOpCode->Value.u64);
1043 Index2++;
1044 }
1045 SetArrayData (ValueArray, ValueType, Index2, 0);
1046
1047 FreePool (*OptionString);
1048 *OptionString = NULL;
1049 return EFI_NOT_FOUND;
1050 }
1051
1052 Character[0] = LEFT_ONEOF_DELIMITER;
1053 NewStrCat (OptionString[0], MaxLen, Character);
1054 StringPtr = GetToken (OneOfOption->OptionOpCode->Option, gFormData->HiiHandle);
1055 ASSERT (StringPtr != NULL);
1056 NewStrCat (OptionString[0], MaxLen, StringPtr);
1057 Character[0] = RIGHT_ONEOF_DELIMITER;
1058 NewStrCat (OptionString[0], MaxLen, Character);
1059 Character[0] = CHAR_CARRIAGE_RETURN;
1060 NewStrCat (OptionString[0], MaxLen, Character);
1061 FreePool (StringPtr);
1062 }
1063
1064 //
1065 // If valid option more than the max container, skip these options.
1066 //
1067 if (Index >= OrderList->MaxContainers) {
1068 break;
1069 }
1070
1071 //
1072 // Search the other options, try to find the one not in the container.
1073 //
1074 Link = GetFirstNode (&Question->OptionListHead);
1075 while (!IsNull (&Question->OptionListHead, Link)) {
1076 OneOfOption = DISPLAY_QUESTION_OPTION_FROM_LINK (Link);
1077 Link = GetNextNode (&Question->OptionListHead, Link);
1078
1079 if (FindArrayData (ValueArray, ValueType, OneOfOption->OptionOpCode->Value.u64, NULL)) {
1080 continue;
1081 }
1082
1083 if (SkipErrorValue) {
1084 //
1085 // Not report error, just get the correct option string info.
1086 //
1087 Character[0] = LEFT_ONEOF_DELIMITER;
1088 NewStrCat (OptionString[0], MaxLen, Character);
1089 StringPtr = GetToken (OneOfOption->OptionOpCode->Option, gFormData->HiiHandle);
1090 ASSERT (StringPtr != NULL);
1091 NewStrCat (OptionString[0], MaxLen, StringPtr);
1092 Character[0] = RIGHT_ONEOF_DELIMITER;
1093 NewStrCat (OptionString[0], MaxLen, Character);
1094 Character[0] = CHAR_CARRIAGE_RETURN;
1095 NewStrCat (OptionString[0], MaxLen, Character);
1096 FreePool (StringPtr);
1097
1098 continue;
1099 }
1100
1101 if (!ValueInvalid) {
1102 ValueInvalid = TRUE;
1103 //
1104 // Show error message
1105 //
1106 do {
1107 CreateDialog (&Key, gEmptyString, gOptionMismatch, gPressEnter, gEmptyString, NULL);
1108 } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);
1109
1110 //
1111 // The initial value of the orderedlist is invalid, force to be valid value
1112 // Exit current DisplayForm with new value.
1113 //
1114 gUserInput->SelectedStatement = Question;
1115 gMisMatch = TRUE;
1116 ValueArray = AllocateCopyPool (Question->CurrentValue.BufferLen, Question->CurrentValue.Buffer);
1117 ASSERT (ValueArray != NULL);
1118 gUserInput->InputValue.Buffer = ValueArray;
1119 gUserInput->InputValue.BufferLen = Question->CurrentValue.BufferLen;
1120 gUserInput->InputValue.Type = Question->CurrentValue.Type;
1121 }
1122
1123 SetArrayData (ValueArray, ValueType, Index++, OneOfOption->OptionOpCode->Value.u64);
1124 }
1125
1126 if (ValueInvalid) {
1127 FreePool (*OptionString);
1128 *OptionString = NULL;
1129 return EFI_NOT_FOUND;
1130 }
1131 }
1132 break;
1133
1134 case EFI_IFR_ONE_OF_OP:
1135 //
1136 // Check whether there are Options of this OneOf
1137 //
1138 if (IsListEmpty (&Question->OptionListHead)) {
1139 break;
1140 }
1141 if (Selected) {
1142 //
1143 // Go ask for input
1144 //
1145 Status = GetSelectionInputPopUp (MenuOption);
1146 } else {
1147 MaxLen = BufferSize / sizeof(CHAR16);
1148 *OptionString = AllocateZeroPool (BufferSize);
1149 ASSERT (*OptionString);
1150
1151 OneOfOption = ValueToOption (Question, QuestionValue);
1152 if (OneOfOption == NULL) {
1153 if (SkipErrorValue) {
1154 //
1155 // Not report error, just get the correct option string info.
1156 //
1157 Link = GetFirstNode (&Question->OptionListHead);
1158 OneOfOption = DISPLAY_QUESTION_OPTION_FROM_LINK (Link);
1159 } else {
1160 //
1161 // Show error message
1162 //
1163 do {
1164 CreateDialog (&Key, gEmptyString, gOptionMismatch, gPressEnter, gEmptyString, NULL);
1165 } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);
1166
1167 //
1168 // Force the Question value to be valid
1169 // Exit current DisplayForm with new value.
1170 //
1171 Link = GetFirstNode (&Question->OptionListHead);
1172 Option = DISPLAY_QUESTION_OPTION_FROM_LINK (Link);
1173
1174 gUserInput->InputValue.Type = Option->OptionOpCode->Type;
1175 switch (gUserInput->InputValue.Type) {
1176 case EFI_IFR_TYPE_NUM_SIZE_8:
1177 gUserInput->InputValue.Value.u8 = Option->OptionOpCode->Value.u8;
1178 break;
1179 case EFI_IFR_TYPE_NUM_SIZE_16:
1180 CopyMem (&gUserInput->InputValue.Value.u16, &Option->OptionOpCode->Value.u16, sizeof (UINT16));
1181 break;
1182 case EFI_IFR_TYPE_NUM_SIZE_32:
1183 CopyMem (&gUserInput->InputValue.Value.u32, &Option->OptionOpCode->Value.u32, sizeof (UINT32));
1184 break;
1185 case EFI_IFR_TYPE_NUM_SIZE_64:
1186 CopyMem (&gUserInput->InputValue.Value.u64, &Option->OptionOpCode->Value.u64, sizeof (UINT64));
1187 break;
1188 default:
1189 ASSERT (FALSE);
1190 break;
1191 }
1192 gUserInput->SelectedStatement = Question;
1193 gMisMatch = TRUE;
1194 FreePool (*OptionString);
1195 *OptionString = NULL;
1196 return EFI_NOT_FOUND;
1197 }
1198 }
1199
1200 Character[0] = LEFT_ONEOF_DELIMITER;
1201 NewStrCat (OptionString[0], MaxLen, Character);
1202 StringPtr = GetToken (OneOfOption->OptionOpCode->Option, gFormData->HiiHandle);
1203 ASSERT (StringPtr != NULL);
1204 NewStrCat (OptionString[0], MaxLen, StringPtr);
1205 Character[0] = RIGHT_ONEOF_DELIMITER;
1206 NewStrCat (OptionString[0], MaxLen, Character);
1207
1208 FreePool (StringPtr);
1209 }
1210 break;
1211
1212 case EFI_IFR_CHECKBOX_OP:
1213 if (Selected) {
1214 //
1215 // Since this is a BOOLEAN operation, flip it upon selection
1216 //
1217 gUserInput->InputValue.Type = QuestionValue->Type;
1218 gUserInput->InputValue.Value.b = (BOOLEAN) (QuestionValue->Value.b ? FALSE : TRUE);
1219
1220 //
1221 // Perform inconsistent check
1222 //
1223 return EFI_SUCCESS;
1224 } else {
1225 *OptionString = AllocateZeroPool (BufferSize);
1226 ASSERT (*OptionString);
1227
1228 *OptionString[0] = LEFT_CHECKBOX_DELIMITER;
1229
1230 if (QuestionValue->Value.b) {
1231 *(OptionString[0] + 1) = CHECK_ON;
1232 } else {
1233 *(OptionString[0] + 1) = CHECK_OFF;
1234 }
1235 *(OptionString[0] + 2) = RIGHT_CHECKBOX_DELIMITER;
1236 }
1237 break;
1238
1239 case EFI_IFR_NUMERIC_OP:
1240 if (Selected) {
1241 //
1242 // Go ask for input
1243 //
1244 Status = GetNumericInput (MenuOption);
1245 } else {
1246 *OptionString = AllocateZeroPool (BufferSize);
1247 ASSERT (*OptionString);
1248
1249 *OptionString[0] = LEFT_NUMERIC_DELIMITER;
1250
1251 //
1252 // Formatted print
1253 //
1254 PrintFormattedNumber (Question, FormattedNumber, 21 * sizeof (CHAR16));
1255 Number = (UINT16) GetStringWidth (FormattedNumber);
1256 CopyMem (OptionString[0] + 1, FormattedNumber, Number);
1257
1258 *(OptionString[0] + Number / 2) = RIGHT_NUMERIC_DELIMITER;
1259 }
1260 break;
1261
1262 case EFI_IFR_DATE_OP:
1263 if (Selected) {
1264 //
1265 // This is similar to numerics
1266 //
1267 Status = GetNumericInput (MenuOption);
1268 } else {
1269 *OptionString = AllocateZeroPool (BufferSize);
1270 ASSERT (*OptionString);
1271
1272 switch (MenuOption->Sequence) {
1273 case 0:
1274 *OptionString[0] = LEFT_NUMERIC_DELIMITER;
1275 if (QuestionValue->Value.date.Month == 0xff){
1276 UnicodeSPrint (OptionString[0] + 1, 21 * sizeof (CHAR16), L"??");
1277 } else {
1278 UnicodeSPrint (OptionString[0] + 1, 21 * sizeof (CHAR16), L"%02d", QuestionValue->Value.date.Month);
1279 }
1280 *(OptionString[0] + 3) = DATE_SEPARATOR;
1281 break;
1282
1283 case 1:
1284 SetUnicodeMem (OptionString[0], 4, L' ');
1285 if (QuestionValue->Value.date.Day == 0xff){
1286 UnicodeSPrint (OptionString[0] + 4, 21 * sizeof (CHAR16), L"??");
1287 } else {
1288 UnicodeSPrint (OptionString[0] + 4, 21 * sizeof (CHAR16), L"%02d", QuestionValue->Value.date.Day);
1289 }
1290 *(OptionString[0] + 6) = DATE_SEPARATOR;
1291 break;
1292
1293 case 2:
1294 SetUnicodeMem (OptionString[0], 7, L' ');
1295 if (QuestionValue->Value.date.Year == 0xff){
1296 UnicodeSPrint (OptionString[0] + 7, 21 * sizeof (CHAR16), L"????");
1297 } else {
1298 UnicodeSPrint (OptionString[0] + 7, 21 * sizeof (CHAR16), L"%04d", QuestionValue->Value.date.Year);
1299 }
1300 *(OptionString[0] + 11) = RIGHT_NUMERIC_DELIMITER;
1301 break;
1302 }
1303 }
1304 break;
1305
1306 case EFI_IFR_TIME_OP:
1307 if (Selected) {
1308 //
1309 // This is similar to numerics
1310 //
1311 Status = GetNumericInput (MenuOption);
1312 } else {
1313 *OptionString = AllocateZeroPool (BufferSize);
1314 ASSERT (*OptionString);
1315
1316 switch (MenuOption->Sequence) {
1317 case 0:
1318 *OptionString[0] = LEFT_NUMERIC_DELIMITER;
1319 if (QuestionValue->Value.time.Hour == 0xff){
1320 UnicodeSPrint (OptionString[0] + 1, 21 * sizeof (CHAR16), L"??");
1321 } else {
1322 UnicodeSPrint (OptionString[0] + 1, 21 * sizeof (CHAR16), L"%02d", QuestionValue->Value.time.Hour);
1323 }
1324 *(OptionString[0] + 3) = TIME_SEPARATOR;
1325 break;
1326
1327 case 1:
1328 SetUnicodeMem (OptionString[0], 4, L' ');
1329 if (QuestionValue->Value.time.Minute == 0xff){
1330 UnicodeSPrint (OptionString[0] + 4, 21 * sizeof (CHAR16), L"??");
1331 } else {
1332 UnicodeSPrint (OptionString[0] + 4, 21 * sizeof (CHAR16), L"%02d", QuestionValue->Value.time.Minute);
1333 }
1334 *(OptionString[0] + 6) = TIME_SEPARATOR;
1335 break;
1336
1337 case 2:
1338 SetUnicodeMem (OptionString[0], 7, L' ');
1339 if (QuestionValue->Value.time.Second == 0xff){
1340 UnicodeSPrint (OptionString[0] + 7, 21 * sizeof (CHAR16), L"??");
1341 } else {
1342 UnicodeSPrint (OptionString[0] + 7, 21 * sizeof (CHAR16), L"%02d", QuestionValue->Value.time.Second);
1343 }
1344 *(OptionString[0] + 9) = RIGHT_NUMERIC_DELIMITER;
1345 break;
1346 }
1347 }
1348 break;
1349
1350 case EFI_IFR_STRING_OP:
1351 if (Selected) {
1352 StringPtr = AllocateZeroPool (Question->CurrentValue.BufferLen + sizeof (CHAR16));
1353 ASSERT (StringPtr);
1354 CopyMem(StringPtr, Question->CurrentValue.Buffer, Question->CurrentValue.BufferLen);
1355
1356 Status = ReadString (MenuOption, gPromptForData, StringPtr);
1357 if (EFI_ERROR (Status)) {
1358 FreePool (StringPtr);
1359 return Status;
1360 }
1361
1362 gUserInput->InputValue.Buffer = AllocateCopyPool (Question->CurrentValue.BufferLen, StringPtr);
1363 gUserInput->InputValue.BufferLen = Question->CurrentValue.BufferLen;
1364 gUserInput->InputValue.Type = Question->CurrentValue.Type;
1365 gUserInput->InputValue.Value.string = HiiSetString(gFormData->HiiHandle, gUserInput->InputValue.Value.string, StringPtr, NULL);
1366 FreePool (StringPtr);
1367 return EFI_SUCCESS;
1368 } else {
1369 *OptionString = AllocateZeroPool (BufferSize);
1370 ASSERT (*OptionString);
1371
1372 if (((CHAR16 *) Question->CurrentValue.Buffer)[0] == 0x0000) {
1373 *(OptionString[0]) = '_';
1374 } else {
1375 if (Question->CurrentValue.BufferLen < BufferSize) {
1376 BufferSize = Question->CurrentValue.BufferLen;
1377 }
1378 CopyMem (OptionString[0], (CHAR16 *) Question->CurrentValue.Buffer, BufferSize);
1379 }
1380 }
1381 break;
1382
1383 case EFI_IFR_PASSWORD_OP:
1384 if (Selected) {
1385 Status = PasswordProcess (MenuOption);
1386 }
1387 break;
1388
1389 default:
1390 break;
1391 }
1392
1393 return Status;
1394 }
1395
1396
1397 /**
1398 Process the help string: Split StringPtr to several lines of strings stored in
1399 FormattedString and the glyph width of each line cannot exceed gHelpBlockWidth.
1400
1401 @param StringPtr The entire help string.
1402 @param FormattedString The oupput formatted string.
1403 @param EachLineWidth The max string length of each line in the formatted string.
1404 @param RowCount TRUE: if Question is selected.
1405
1406 **/
1407 UINTN
1408 ProcessHelpString (
1409 IN CHAR16 *StringPtr,
1410 OUT CHAR16 **FormattedString,
1411 OUT UINT16 *EachLineWidth,
1412 IN UINTN RowCount
1413 )
1414 {
1415 UINTN Index;
1416 CHAR16 *OutputString;
1417 UINTN TotalRowNum;
1418 UINTN CheckedNum;
1419 UINT16 GlyphWidth;
1420 UINT16 LineWidth;
1421 UINT16 MaxStringLen;
1422 UINT16 StringLen;
1423
1424 TotalRowNum = 0;
1425 CheckedNum = 0;
1426 GlyphWidth = 1;
1427 Index = 0;
1428 MaxStringLen = 0;
1429 StringLen = 0;
1430
1431 //
1432 // Set default help string width.
1433 //
1434 LineWidth = (UINT16) (gHelpBlockWidth - 1);
1435
1436 //
1437 // Get row number of the String.
1438 //
1439 while ((StringLen = GetLineByWidth (StringPtr, LineWidth, &GlyphWidth, &Index, &OutputString)) != 0) {
1440 if (StringLen > MaxStringLen) {
1441 MaxStringLen = StringLen;
1442 }
1443
1444 TotalRowNum ++;
1445 FreePool (OutputString);
1446 }
1447 *EachLineWidth = MaxStringLen;
1448
1449 *FormattedString = AllocateZeroPool (TotalRowNum * MaxStringLen * sizeof (CHAR16));
1450 ASSERT (*FormattedString != NULL);
1451
1452 //
1453 // Generate formatted help string array.
1454 //
1455 GlyphWidth = 1;
1456 Index = 0;
1457 while((StringLen = GetLineByWidth (StringPtr, LineWidth, &GlyphWidth, &Index, &OutputString)) != 0) {
1458 CopyMem (*FormattedString + CheckedNum * MaxStringLen, OutputString, StringLen * sizeof (CHAR16));
1459 CheckedNum ++;
1460 FreePool (OutputString);
1461 }
1462
1463 return TotalRowNum;
1464 }
EFI Development Kit II mirror for PVE