1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
|
/** @file
HII Library implementation that uses DXE protocols and services.
Copyright (c) 2006 - 2021, Intel Corporation. All rights reserved.<BR>
(C) Copyright 2021 Hewlett Packard Enterprise Development LP<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include "InternalHiiLib.h"
/**
This function create a new string in String Package or updates an existing
string in a String Package. If StringId is 0, then a new string is added to
a String Package. If StringId is not zero, then a string in String Package is
updated. If SupportedLanguages is NULL, then the string is added or updated
for all the languages that the String Package supports. If SupportedLanguages
is not NULL, then the string is added or updated for the set of languages
specified by SupportedLanguages.
If HiiHandle is NULL, then ASSERT().
If String is NULL, then ASSERT().
@param[in] HiiHandle A handle that was previously registered in the
HII Database.
@param[in] StringId If zero, then a new string is created in the
String Package associated with HiiHandle. If
non-zero, then the string specified by StringId
is updated in the String Package associated
with HiiHandle.
@param[in] String A pointer to the Null-terminated Unicode string
to add or update in the String Package associated
with HiiHandle.
@param[in] SupportedLanguages A pointer to a Null-terminated ASCII string of
language codes. If this parameter is NULL, then
String is added or updated in the String Package
associated with HiiHandle for all the languages
that the String Package supports. If this
parameter is not NULL, then then String is added
or updated in the String Package associated with
HiiHandle for the set oflanguages specified by
SupportedLanguages. The format of
SupportedLanguages must follow the language
format assumed the HII Database.
@retval 0 The string could not be added or updated in the String Package.
@retval Other The EFI_STRING_ID of the newly added or updated string.
**/
EFI_STRING_ID
EFIAPI
HiiSetString (
IN EFI_HII_HANDLE HiiHandle,
IN EFI_STRING_ID StringId OPTIONAL,
IN CONST EFI_STRING String,
IN CONST CHAR8 *SupportedLanguages OPTIONAL
)
{
EFI_STATUS Status;
CHAR8 *AllocatedLanguages;
CHAR8 *Supported;
CHAR8 *Language;
ASSERT (HiiHandle != NULL);
ASSERT (String != NULL);
if (SupportedLanguages == NULL) {
//
// Retrieve the languages that the package specified by HiiHandle supports
//
AllocatedLanguages = HiiGetSupportedLanguages (HiiHandle);
} else {
//
// Allocate a copy of the SupportLanguages string that passed in
//
AllocatedLanguages = AllocateCopyPool (AsciiStrSize (SupportedLanguages), SupportedLanguages);
}
//
// If there are not enough resources for the supported languages string, then return a StringId of 0
//
if (AllocatedLanguages == NULL) {
return (EFI_STRING_ID)(0);
}
Status = EFI_INVALID_PARAMETER;
//
// Loop through each language that the string supports
//
for (Supported = AllocatedLanguages; *Supported != '\0'; ) {
//
// Cache a pointer to the beginning of the current language in the list of languages
//
Language = Supported;
//
// Search for the next language separator and replace it with a Null-terminator
//
for (; *Supported != 0 && *Supported != ';'; Supported++);
if (*Supported != 0) {
*(Supported++) = '\0';
}
if ((SupportedLanguages == NULL) && AsciiStrnCmp (Language, UEFI_CONFIG_LANG, AsciiStrLen (UEFI_CONFIG_LANG)) == 0) {
//
// Skip string package used for keyword protocol.
//
continue;
}
//
// If StringId is 0, then call NewString(). Otherwise, call SetString()
//
if (StringId == (EFI_STRING_ID)(0)) {
Status = gHiiString->NewString (gHiiString, HiiHandle, &StringId, Language, NULL, String, NULL);
} else {
Status = gHiiString->SetString (gHiiString, HiiHandle, StringId, Language, String, NULL);
}
//
// If there was an error, then break out of the loop and return a StringId of 0
//
if (EFI_ERROR (Status)) {
break;
}
}
//
// Free the buffer of supported languages
//
FreePool (AllocatedLanguages);
if (EFI_ERROR (Status)) {
return (EFI_STRING_ID)(0);
} else {
return StringId;
}
}
/**
Retrieves a string from a string package names by GUID in a specific language.
If the language is not specified, then a string from a string package in the
current platform language is retrieved. If the string can not be retrieved
using the specified language or the current platform language, then the string
is retrieved from the string package in the first language the string package
supports. The returned string is allocated using AllocatePool(). The caller
is responsible for freeing the allocated buffer using FreePool().
If PackageListGuid is NULL, then ASSERT().
If StringId is 0, then ASSERT.
@param[in] PackageListGuid The GUID of a package list that was previously
registered in the HII Database.
@param[in] StringId The identifier of the string to retrieved from the
string package associated with PackageListGuid.
@param[in] Language The language of the string to retrieve. If this
parameter is NULL, then the current platform
language is used. The format of Language must
follow the language format assumed the HII Database.
@retval NULL The package list specified by PackageListGuid is not present in the
HII Database.
@retval NULL The string specified by StringId is not present in the string package.
@retval Other The string was returned.
**/
EFI_STRING
EFIAPI
HiiGetPackageString (
IN CONST EFI_GUID *PackageListGuid,
IN EFI_STRING_ID StringId,
IN CONST CHAR8 *Language OPTIONAL
)
{
EFI_HII_HANDLE *HiiHandleBuffer;
EFI_HII_HANDLE HiiHandle;
ASSERT (PackageListGuid != NULL);
HiiHandleBuffer = HiiGetHiiHandles (PackageListGuid);
if (HiiHandleBuffer == NULL) {
return NULL;
}
HiiHandle = HiiHandleBuffer[0];
FreePool (HiiHandleBuffer);
return HiiGetString (HiiHandle, StringId, Language);
}
/**
Retrieves a string from a string package in a specific language specified in Language
or in the best lanaguage. See HiiGetStringEx () for the details.
@param[in] HiiHandle A handle that was previously registered in the HII Database.
@param[in] StringId The identifier of the string to retrieved from the string
package associated with HiiHandle.
@param[in] Language The language of the string to retrieve. If this parameter
is NULL, then the current platform language is used. The
format of Language must follow the language format assumed
the HII Database.
@retval NULL The string specified by StringId is not present in the string package.
@retval Other The string was returned.
**/
EFI_STRING
EFIAPI
HiiGetString (
IN EFI_HII_HANDLE HiiHandle,
IN EFI_STRING_ID StringId,
IN CONST CHAR8 *Language OPTIONAL
)
{
return HiiGetStringEx (HiiHandle, StringId, Language, TRUE);
}
/**
Retrieves a string from a string package in a specific language or in the best
language at discretion of this function according to the priority of languages.
TryBestLanguage is used to get the string in the best language or in the language
specified in Language parameter. The behavior is,
If TryBestLanguage is TRUE, this function looks for the best language for the string.
- If the string can not be retrieved using the specified language or the current
platform language, then the string is retrieved from the string package in the
first language the string package supports.
If TryBestLanguage is FALSE, Language must be specified for retrieving the string.
The returned string is allocated using AllocatePool(). The caller is responsible
for freeing the allocated buffer using FreePool().
If HiiHandle is NULL, then ASSERT().
If StringId is 0, then ASSET.
If TryBestLanguage is FALE and Language is NULL, then ASSERT().
@param[in] HiiHandle A handle that was previously registered in the HII Database.
@param[in] StringId The identifier of the string to retrieved from the string
package associated with HiiHandle.
@param[in] Language The language of the string to retrieve. If this parameter
is NULL, then the current platform language is used. The
format of Language must follow the language format assumed
the HII Database.
@param[in] TryBestLanguage If TRUE, try to get the best matching language from all
supported languages.If FALSE, the Language must be assigned
for the StringID.
@retval NULL The string specified by StringId is not present in the string package.
@retval Other The string was returned.
**/
EFI_STRING
EFIAPI
HiiGetStringEx (
IN EFI_HII_HANDLE HiiHandle,
IN EFI_STRING_ID StringId,
IN CONST CHAR8 *Language OPTIONAL,
IN BOOLEAN TryBestLanguage
)
{
EFI_STATUS Status;
UINTN StringSize;
CHAR16 TempString;
EFI_STRING String;
CHAR8 *SupportedLanguages;
CHAR8 *PlatformLanguage;
CHAR8 *BestLanguage;
ASSERT (HiiHandle != NULL);
ASSERT (StringId != 0);
//
// Language must be specified if TryBestLanguage = FALSE.
//
ASSERT (!(!TryBestLanguage && Language == NULL));
//
// Initialize all allocated buffers to NULL
//
SupportedLanguages = NULL;
PlatformLanguage = NULL;
BestLanguage = NULL;
String = NULL;
//
// Get the languages that the package specified by HiiHandle supports
//
SupportedLanguages = HiiGetSupportedLanguages (HiiHandle);
if (SupportedLanguages == NULL) {
goto Error;
}
//
// Get the current platform language setting
//
GetEfiGlobalVariable2 (L"PlatformLang", (VOID**)&PlatformLanguage, NULL);
//
// If Languag is NULL, then set it to an empty string, so it will be
// skipped by GetBestLanguage()
//
if (Language == NULL) {
Language = "";
}
if (TryBestLanguage) {
//
// Get the best matching language from SupportedLanguages
//
BestLanguage = GetBestLanguage (
SupportedLanguages,
FALSE, // RFC 4646 mode
Language, // Highest priority
PlatformLanguage != NULL ? PlatformLanguage : "", // Next highest priority
SupportedLanguages, // Lowest priority
NULL
);
if (BestLanguage == NULL) {
goto Error;
}
} else {
BestLanguage = (CHAR8 *) Language;
}
//
// Retrieve the size of the string in the string package for the BestLanguage
//
StringSize = 0;
Status = gHiiString->GetString (
gHiiString,
BestLanguage,
HiiHandle,
StringId,
&TempString,
&StringSize,
NULL
);
//
// If GetString() returns EFI_SUCCESS for a zero size,
// then there are no supported languages registered for HiiHandle. If GetString()
// returns an error other than EFI_BUFFER_TOO_SMALL, then HiiHandle is not present
// in the HII Database
//
if (Status != EFI_BUFFER_TOO_SMALL) {
goto Error;
}
//
// Allocate a buffer for the return string
//
String = AllocateZeroPool (StringSize);
if (String == NULL) {
goto Error;
}
//
// Retrieve the string from the string package
//
Status = gHiiString->GetString (
gHiiString,
BestLanguage,
HiiHandle,
StringId,
String,
&StringSize,
NULL
);
if (EFI_ERROR (Status)) {
//
// Free the buffer and return NULL if the supported languages can not be retrieved.
//
FreePool (String);
String = NULL;
}
Error:
//
// Free allocated buffers
//
if (SupportedLanguages != NULL) {
FreePool (SupportedLanguages);
}
if (PlatformLanguage != NULL) {
FreePool (PlatformLanguage);
}
if (TryBestLanguage && BestLanguage != NULL) {
FreePool (BestLanguage);
}
//
// Return the Null-terminated Unicode string
//
return String;
}
|