]>
Commit | Line | Data |
---|---|---|
878ddf1f | 1 | /*++\r |
2 | \r | |
3 | Copyright (c) 2004, Intel Corporation \r | |
4 | All rights reserved. This program and the accompanying materials \r | |
5 | are licensed and made available under the terms and conditions of the BSD License \r | |
6 | which accompanies this distribution. The full text of the license may be found at \r | |
7 | http://opensource.org/licenses/bsd-license.php \r | |
8 | \r | |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
11 | \r | |
12 | Module Name:\r | |
13 | \r | |
14 | StringDB.h\r | |
15 | \r | |
16 | Abstract:\r | |
17 | \r | |
18 | Common defines and prototypes for string database management\r | |
19 | \r | |
20 | --*/\r | |
21 | \r | |
22 | #ifndef _STRING_DB_H_\r | |
23 | #define _STRING_DB_H_\r | |
24 | \r | |
25 | #define LANGUAGE_NAME_STRING_NAME L"$LANGUAGE_NAME"\r | |
26 | #define PRINTABLE_LANGUAGE_NAME_STRING_NAME L"$PRINTABLE_LANGUAGE_NAME"\r | |
27 | \r | |
28 | void\r | |
29 | StringDBConstructor (\r | |
30 | void\r | |
31 | )\r | |
32 | ;\r | |
33 | void\r | |
34 | StringDBDestructor (\r | |
35 | void\r | |
36 | )\r | |
37 | ;\r | |
38 | \r | |
39 | STATUS\r | |
40 | StringDBAddString (\r | |
41 | WCHAR *LanguageName,\r | |
42 | WCHAR *StringIdentifier,\r | |
43 | WCHAR *Scope,\r | |
44 | WCHAR *String,\r | |
45 | BOOLEAN Format,\r | |
46 | UINT16 Flags\r | |
47 | )\r | |
48 | ;\r | |
49 | \r | |
50 | STATUS\r | |
51 | StringDBSetScope (\r | |
52 | WCHAR *Scope\r | |
53 | )\r | |
54 | ;\r | |
55 | \r | |
56 | #define STRING_FLAGS_REFERENCED 0x0001 // if referenced somewhere\r | |
57 | #define STRING_FLAGS_UNDEFINED 0x0002 // if we added it for padding purposes\r | |
58 | #define STRING_FLAGS_INDEX_ASSIGNED 0x0004 // so don't change the index value\r | |
59 | #define STRING_ID_INVALID 0xFFFF\r | |
60 | #define STRING_ID_LANGUAGE_NAME 0x0000\r | |
61 | #define STRING_ID_PRINTABLE_LANGUAGE_NAME 0x0001\r | |
62 | \r | |
63 | STATUS\r | |
64 | StringDBAddStringIdentifier (\r | |
65 | WCHAR *StringIdentifier,\r | |
66 | UINT16 *NewId,\r | |
67 | UINT16 Flags\r | |
68 | )\r | |
69 | ;\r | |
70 | \r | |
71 | STATUS\r | |
72 | StringDBReadDatabase (\r | |
73 | INT8 *DBFileName,\r | |
74 | BOOLEAN IgnoreIfNotExist,\r | |
75 | BOOLEAN Verbose\r | |
76 | )\r | |
77 | ;\r | |
78 | \r | |
79 | STATUS\r | |
80 | StringDBWriteDatabase (\r | |
81 | INT8 *DBFileName,\r | |
82 | BOOLEAN Verbose\r | |
83 | )\r | |
84 | ;\r | |
85 | \r | |
86 | STATUS\r | |
87 | StringDBDumpDatabase (\r | |
88 | INT8 *DBFileName,\r | |
89 | INT8 *OutputFileName,\r | |
90 | BOOLEAN Verbose\r | |
91 | )\r | |
92 | ;\r | |
93 | \r | |
94 | STATUS\r | |
95 | StringDBAddLanguage (\r | |
96 | WCHAR *LanguageName,\r | |
97 | WCHAR *PrintableLanguageName\r | |
98 | )\r | |
99 | ;\r | |
100 | \r | |
101 | STATUS\r | |
102 | StringDBDumpCStrings (\r | |
103 | INT8 *FileName,\r | |
104 | INT8 *BaseName,\r | |
105 | WCHAR_STRING_LIST *LanguagesOfInterest,\r | |
106 | WCHAR_MATCHING_STRING_LIST *IndirectionList\r | |
107 | )\r | |
108 | ;\r | |
109 | \r | |
110 | STATUS\r | |
111 | StringDBDumpStringDefines (\r | |
112 | INT8 *FileName,\r | |
113 | INT8 *BaseName\r | |
114 | )\r | |
115 | ;\r | |
116 | \r | |
117 | STATUS\r | |
118 | StringDBSetCurrentLanguage (\r | |
119 | WCHAR *LanguageName\r | |
120 | )\r | |
121 | ;\r | |
122 | \r | |
123 | STATUS\r | |
124 | StringDBSetStringReferenced (\r | |
125 | INT8 *StringIdentifierName,\r | |
126 | BOOLEAN IgnoreNotFound\r | |
127 | )\r | |
128 | ;\r | |
129 | \r | |
130 | void\r | |
131 | StringDBFormatString (\r | |
132 | WCHAR *String\r | |
133 | )\r | |
134 | ;\r | |
135 | \r | |
136 | #endif // #ifndef _STRING_DB_H_\r |