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