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
|
/*++
Copyright (c) 2004 - 2010, Intel Corporation. All rights reserved.<BR>
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:
StringDB.h
Abstract:
Common defines and prototypes for string database management
--*/
#ifndef _STRING_DB_H_
#define _STRING_DB_H_
#define LANGUAGE_NAME_STRING_NAME L"$LANGUAGE_NAME"
#define PRINTABLE_LANGUAGE_NAME_STRING_NAME L"$PRINTABLE_LANGUAGE_NAME"
typedef CHAR16 WCHAR;
#define NARROW_CHAR 0xFFF0
#define WIDE_CHAR 0xFFF1
#define NON_BREAKING_CHAR 0xFFF2
#define GLYPH_WIDTH 8
#define GLYPH_HEIGHT 19
#define STRING_DB_KEY (('S' << 24) | ('D' << 16) | ('B' << 8) | 'K')
//
// Version supported by this tool
//
#define STRING_DB_VERSION 0x00010000
#define STRING_DB_MAJOR_VERSION_MASK 0xFFFF0000
#define STRING_DB_MINOR_VERSION_MASK 0x0000FFFF
#define DEFINE_STR L"// #define"
#define EFI_STRING_ID_BEGIN 0x01
//
// This is the header that gets written to the top of the
// output binary database file.
//
typedef struct {
UINT32 Key;
UINT32 HeaderSize;
UINT32 Version;
UINT32 NumStringIdenfiers;
UINT32 StringIdentifiersSize;
UINT32 NumLanguages;
} STRING_DB_HEADER;
//
// When we write out data to the database, we have a UINT16 identifier, which
// indicates what follows, followed by the data. Here's the structure.
//
typedef struct {
UINT16 DataType;
UINT16 Reserved;
} DB_DATA_ITEM_HEADER;
#define DB_DATA_TYPE_INVALID 0x0000
#define DB_DATA_TYPE_STRING_IDENTIFIER 0x0001
#define DB_DATA_TYPE_LANGUAGE_DEFINITION 0x0002
#define DB_DATA_TYPE_STRING_DEFINITION 0x0003
#define DB_DATA_TYPE_LAST DB_DATA_TYPE_STRING_DEFINITION
//
// We have to keep track of a list of languages, each of which has its own
// list of strings. Define a structure to keep track of all languages and
// their list of strings.
//
typedef struct _STRING_LIST {
struct _STRING_LIST *Next;
UINT32 Size; // number of bytes in string, including null terminator
WCHAR *LanguageName;
WCHAR *StringName; // for example STR_ID_TEXT1
WCHAR *Scope; //
WCHAR *Str; // the actual string
UINT16 Flags; // properties of this string (used, undefined)
} STRING_LIST;
typedef struct _LANGUAGE_LIST {
struct _LANGUAGE_LIST *Next;
WCHAR *LanguageName;
WCHAR *PrintableLanguageName;
WCHAR *SecondaryLanguageList;
STRING_LIST *String;
STRING_LIST *LastString;
} LANGUAGE_LIST;
//
// We also keep track of all the string identifier names, which we assign unique
// values to. Create a structure to keep track of them all.
//
typedef struct _STRING_IDENTIFIER {
struct _STRING_IDENTIFIER *Next;
UINT32 Index; // only need 16 bits, but makes it easier with UINT32
WCHAR *StringName;
UINT16 Flags; // if someone referenced it via STRING_TOKEN()
} STRING_IDENTIFIER;
//
// Keep our globals in this structure to be as modular as possible.
//
typedef struct {
FILE *StringDBFptr;
LANGUAGE_LIST *LanguageList;
LANGUAGE_LIST *LastLanguageList;
LANGUAGE_LIST *CurrentLanguage; // keep track of the last language they used
STRING_IDENTIFIER *StringIdentifier;
STRING_IDENTIFIER *LastStringIdentifier;
UINT8 *StringDBFileName;
UINT32 NumStringIdentifiers;
UINT32 NumStringIdentifiersReferenced;
STRING_IDENTIFIER *CurrentStringIdentifier; // keep track of the last string identifier they added
WCHAR *CurrentScope;
} STRING_DB_DATA;
typedef struct _SPkgBlkBuffer {
UINT32 mBlkSize;
VOID *mBlkBuffer;
struct _SPkgBlkBuffer *mNext;
} SPkgBlkBuffer;
void
StringDBConstructor (
void
)
;
void
StringDBDestructor (
void
)
;
STATUS
StringDBAddString (
WCHAR *LanguageName,
WCHAR *StringIdentifier,
WCHAR *Scope,
WCHAR *String,
BOOLEAN Format,
UINT16 Flags
)
;
STATUS
StringDBSetScope (
WCHAR *Scope
)
;
#define STRING_FLAGS_REFERENCED 0x0001 // if referenced somewhere
#define STRING_FLAGS_UNDEFINED 0x0002 // if we added it for padding purposes
#define STRING_FLAGS_INDEX_ASSIGNED 0x0004 // so don't change the index value
#define STRING_ID_INVALID 0xFFFF
#define STRING_ID_LANGUAGE_NAME 0x0000
#define STRING_ID_PRINTABLE_LANGUAGE_NAME 0x0001
STATUS
StringDBAddStringIdentifier (
WCHAR *StringIdentifier,
UINT16 *NewId,
UINT16 Flags
)
;
STATUS
StringDBReadDatabase (
INT8 *DBFileName,
BOOLEAN IgnoreIfNotExist,
BOOLEAN Verbose
)
;
STATUS
StringDBWriteDatabase (
INT8 *DBFileName,
BOOLEAN Verbose
)
;
STATUS
StringDBDumpDatabase (
INT8 *DBFileName,
INT8 *OutputFileName,
BOOLEAN Verbose
)
;
STATUS
StringDBAddLanguage (
WCHAR *LanguageName,
WCHAR *PrintableLanguageName,
WCHAR *SecondaryLanguageList
)
;
STATUS
StringDBAddSecondaryLanguage (
WCHAR *LanguageName,
WCHAR *SecondaryLanguageList
)
;
STATUS
StringDBDumpCStrings (
INT8 *BaseName,
INT8 *FileName,
WCHAR_STRING_LIST *LanguagesOfInterests
)
;
STATUS
StringDBCreateHiiExportPack (
INT8 *OutputFileName,
WCHAR_STRING_LIST *LanguagesOfInterests
)
;
STATUS
StringDBDumpStringDefines (
INT8 *FileName,
INT8 *BaseName
)
;
STATUS
StringDBSetCurrentLanguage (
WCHAR *LanguageName
)
;
STATUS
StringDBSetStringReferenced (
INT8 *StringIdentifierName,
BOOLEAN IgnoreNotFound
)
;
void
StringDBFormatString (
WCHAR *String
)
;
LANGUAGE_LIST *
StringDBFindLanguageList (
WCHAR *LanguageName
)
;
#endif // #ifndef _STRING_DB_H_
|
