]> git.proxmox.com Git - mirror_edk2.git/blame - EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Library/UefiLib/Console.c
Update the copyright notice format
[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Library / EdkIIGlueLib / Library / UefiLib / Console.c
CommitLineData
3eb9473e 1/*++\r
2\r
2c7e5c2f
HT
3Copyright (c) 2004 - 2006, Intel Corporation. All rights reserved.<BR>\r
4This program and the accompanying materials \r
3eb9473e 5are licensed and made available under the terms and conditions of the BSD License \r
6which accompanies this distribution. The full text of the license may be found at \r
7http://opensource.org/licenses/bsd-license.php \r
8 \r
9THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
10WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
11\r
12\r
13Module Name:\r
14\r
15 Console.c\r
16 \r
17Abstract: \r
18\r
19 UEFI library functions.\r
20\r
21--*/\r
22\r
23#include "EdkIIGlueUefi.h"\r
24\r
25typedef struct {\r
26 CHAR16 WChar;\r
27 UINT32 Width;\r
28} UNICODE_WIDTH_ENTRY;\r
29\r
30UNICODE_WIDTH_ENTRY mUnicodeWidthTable[] = {\r
31 //\r
32 // General script area\r
33 //\r
34 {(CHAR16)0x1FFF, 1},\r
35 /*\r
36 * Merge the blocks and replace them with the above entry as they fall to \r
37 * the same category and they are all narrow glyph. This will reduce search\r
38 * time and table size. The merge will omit the reserved code.\r
39 *\r
40 * Remove the above item if below is un-commented.\r
41 *\r
42 {(CHAR16)0x007F, 1}, // C0 controls and basic Latin. 0x0000-0x007F\r
43 {(CHAR16)0x00FF, 1}, // C1 controls and Latin-1 support. 0x0080-0x00FF\r
44 {(CHAR16)0x017F, 1}, // Latin extended-A. 0x0100-0x017F\r
45 {(CHAR16)0x024F, 1}, // Latin extended-B. 0x0180-0x024F\r
46 {(CHAR16)0x02AF, 1}, // IPA extensions. 0x0250-0x02AF\r
47 {(CHAR16)0x02FF, 1}, // Spacing modifier letters. 0x02B0-0x02FF\r
48 {(CHAR16)0x036F, 1}, // Combining diacritical marks. 0x0300-0x036F\r
49 {(CHAR16)0x03FF, 1}, // Greek. 0x0370-0x03FF\r
50 {(CHAR16)0x04FF, 1}, // Cyrillic. 0x0400-0x04FF\r
51 {(CHAR16)0x052F, 0}, // Unassigned. As Armenian in ver3.0. 0x0500-0x052F\r
52 {(CHAR16)0x058F, 1}, // Armenian. 0x0530-0x058F\r
53 {(CHAR16)0x05FF, 1}, // Hebrew. 0x0590-0x05FF\r
54 {(CHAR16)0x06FF, 1}, // Arabic. 0x0600-0x06FF\r
55 {(CHAR16)0x08FF, 0}, // Unassigned. 0x0700-0x08FF\r
56 {(CHAR16)0x097F, 1}, // Devanagari. 0x0900-0x097F\r
57 {(CHAR16)0x09FF, 1}, // Bengali. 0x0980-0x09FF\r
58 {(CHAR16)0x0A7F, 1}, // Gurmukhi. 0x0A00-0x0A7F\r
59 {(CHAR16)0x0AFF, 1}, // Gujarati. 0x0A80-0x0AFF\r
60 {(CHAR16)0x0B7F, 1}, // Oriya. 0x0B00-0x0B7F\r
61 {(CHAR16)0x0BFF, 1}, // Tamil. (See page 7-92). 0x0B80-0x0BFF\r
62 {(CHAR16)0x0C7F, 1}, // Telugu. 0x0C00-0x0C7F\r
63 {(CHAR16)0x0CFF, 1}, // Kannada. (See page 7-100). 0x0C80-0x0CFF\r
64 {(CHAR16)0x0D7F, 1}, // Malayalam (See page 7-104). 0x0D00-0x0D7F\r
65 {(CHAR16)0x0DFF, 0}, // Unassigned. 0x0D80-0x0DFF\r
66 {(CHAR16)0x0E7F, 1}, // Thai. 0x0E00-0x0E7F\r
67 {(CHAR16)0x0EFF, 1}, // Lao. 0x0E80-0x0EFF\r
68 {(CHAR16)0x0FBF, 1}, // Tibetan. 0x0F00-0x0FBF\r
69 {(CHAR16)0x109F, 0}, // Unassigned. 0x0FC0-0x109F\r
70 {(CHAR16)0x10FF, 1}, // Georgian. 0x10A0-0x10FF\r
71 {(CHAR16)0x11FF, 1}, // Hangul Jamo. 0x1100-0x11FF\r
72 {(CHAR16)0x1DFF, 0}, // Unassigned. 0x1200-0x1DFF\r
73 {(CHAR16)0x1EFF, 1}, // Latin extended additional. 0x1E00-0x1EFF\r
74 {(CHAR16)0x1FFF, 1}, // Greek extended. 0x1F00-0x1FFF\r
75 *\r
76 */\r
77\r
78 //\r
79 // Symbol area\r
80 //\r
81 {(CHAR16)0x2FFF, 1},\r
82 /*\r
83 * Merge the blocks and replace them with the above entry as they fall to \r
84 * the same category and they are all narrow glyph. This will reduce search\r
85 * time and table size. The merge will omit the reserved code.\r
86 *\r
87 * Remove the above item if below is un-commented.\r
88 *\r
89 {(CHAR16)0x206F, 1}, // General punctuation. (See page7-154). 0x200-0x206F\r
90 {(CHAR16)0x209F, 1}, // Superscripts and subscripts. 0x2070-0x209F\r
91 {(CHAR16)0x20CF, 1}, // Currency symbols. 0x20A0-0x20CF\r
92 {(CHAR16)0x20FF, 1}, // Combining diacritical marks for symbols. 0x20D0-0x20FF\r
93 {(CHAR16)0x214F, 1}, // Letterlike sympbols. 0x2100-0x214F\r
94 {(CHAR16)0x218F, 1}, // Number forms. 0x2150-0x218F\r
95 {(CHAR16)0x21FF, 1}, // Arrows. 0x2190-0x21FF\r
96 {(CHAR16)0x22FF, 1}, // Mathematical operators. 0x2200-0x22FF\r
97 {(CHAR16)0x23FF, 1}, // Miscellaneous technical. 0x2300-0x23FF\r
98 {(CHAR16)0x243F, 1}, // Control pictures. 0x2400-0x243F\r
99 {(CHAR16)0x245F, 1}, // Optical character recognition. 0x2440-0x245F\r
100 {(CHAR16)0x24FF, 1}, // Enclosed alphanumerics. 0x2460-0x24FF\r
101 {(CHAR16)0x257F, 1}, // Box drawing. 0x2500-0x257F\r
102 {(CHAR16)0x259F, 1}, // Block elements. 0x2580-0x259F\r
103 {(CHAR16)0x25FF, 1}, // Geometric shapes. 0x25A0-0x25FF\r
104 {(CHAR16)0x26FF, 1}, // Miscellaneous symbols. 0x2600-0x26FF\r
105 {(CHAR16)0x27BF, 1}, // Dingbats. 0x2700-0x27BF\r
106 {(CHAR16)0x2FFF, 0}, // Reserved. 0x27C0-0x2FFF\r
107 *\r
108 */\r
109\r
110 //\r
111 // CJK phonetics and symbol area\r
112 //\r
113 {(CHAR16)0x33FF, 2},\r
114 /*\r
115 * Merge the blocks and replace them with the above entry as they fall to \r
116 * the same category and they are all wide glyph. This will reduce search\r
117 * time and table size. The merge will omit the reserved code.\r
118 *\r
119 * Remove the above item if below is un-commented.\r
120 *\r
121 {(CHAR16)0x303F, 2}, // CJK symbols and punctuation. 0x3000-0x303F\r
122 {(CHAR16)0x309F, 2}, // Hiragana. 0x3040-0x309F\r
123 {(CHAR16)0x30FF, 2}, // Katakana. 0x30A0-0x30FF\r
124 {(CHAR16)0x312F, 2}, // Bopomofo. 0x3100-0x312F\r
125 {(CHAR16)0x318F, 2}, // Hangul compatibility jamo. 0x3130-0x318F\r
126 {(CHAR16)0x319F, 2}, // Kanbun. 0x3190-0x319F\r
127 {(CHAR16)0x31FF, 0}, // Reserved. As Bopomofo extended in ver3.0. 0x31A0-0x31FF\r
128 {(CHAR16)0x32FF, 2}, // Enclosed CJK letters and months. 0x3200-0x32FF\r
129 {(CHAR16)0x33FF, 2}, // CJK compatibility. 0x3300-0x33FF\r
130 *\r
131 */\r
132\r
133 //\r
134 // CJK ideograph area\r
135 //\r
136 {(CHAR16)0x9FFF, 2},\r
137 /*\r
138 * Merge the blocks and replace them with the above entry as they fall to \r
139 * the same category and they are all wide glyph. This will reduce search\r
140 * time and table size. The merge will omit the reserved code.\r
141 *\r
142 * Remove the above item if below is un-commented.\r
143 *\r
144 {(CHAR16)0x4DFF, 0}, // Reserved. 0x3400-0x4DBF as CJK unified ideographs \r
145 // extension A in ver3.0. 0x3400-0x4DFF\r
146 {(CHAR16)0x9FFF, 2}, // CJK unified ideographs. 0x4E00-0x9FFF\r
147 *\r
148 */\r
149\r
150 //\r
151 // Reserved\r
152 //\r
153 {(CHAR16)0xABFF, 0}, // Reserved. 0xA000-0xA490 as Yi syllables. 0xA490-0xA4D0\r
154 // as Yi radicals in ver3.0. 0xA000-0xABFF\r
155 //\r
156 // Hangul syllables\r
157 //\r
158 {(CHAR16)0xD7FF, 2},\r
159 /*\r
160 * Merge the blocks and replace them with the above entry as they fall to \r
161 * the same category and they are all wide glyph. This will reduce search\r
162 * time and table size. The merge will omit the reserved code.\r
163 *\r
164 * Remove the above item if below is un-commented.\r
165 *\r
166 {(CHAR16)0xD7A3, 2}, // Hangul syllables. 0xAC00-0xD7A3\r
167 {(CHAR16)0xD7FF, 0}, // Reserved. 0xD7A3-0xD7FF\r
168 *\r
169 */\r
170\r
171 //\r
172 // Surrogates area\r
173 //\r
174 {(CHAR16)0xDFFF, 0}, // Surrogates, not used now. 0xD800-0xDFFF\r
175\r
176 //\r
177 // Private use area\r
178 //\r
179 {(CHAR16)0xF8FF, 0}, // Private use area. 0xE000-0xF8FF\r
180\r
181 //\r
182 // Compatibility area and specials\r
183 //\r
184 {(CHAR16)0xFAFF, 2}, // CJK compatibility ideographs. 0xF900-0xFAFF\r
185 {(CHAR16)0xFB4F, 1}, // Alphabetic presentation forms. 0xFB00-0xFB4F\r
186 {(CHAR16)0xFDFF, 1}, // Arabic presentation forms-A. 0xFB50-0xFDFF\r
187 {(CHAR16)0xFE1F, 0}, // Reserved. As variation selectors in ver3.0. 0xFE00-0xFE1F\r
188 {(CHAR16)0xFE2F, 1}, // Combining half marks. 0xFE20-0xFE2F\r
189 {(CHAR16)0xFE4F, 2}, // CJK compatibility forms. 0xFE30-0xFE4F\r
190 {(CHAR16)0xFE6F, 1}, // Small Form Variants. 0xFE50-0xFE6F\r
191 {(CHAR16)0xFEFF, 1}, // Arabic presentation forms-B. 0xFE70-0xFEFF\r
192 {(CHAR16)0xFFEF, 1}, // Half width and full width forms. 0xFF00-0xFFEF\r
193 {(CHAR16)0xFFFF, 0}, // Speicials. 0xFFF0-0xFFFF\r
194};\r
195\r
196/**\r
197 This function computes and returns the width of the Unicode character \r
198 specified by UnicodeChar.\r
199\r
200 @param UnicodeChar A Unicode character.\r
201\r
202 @retval 0 The width if UnicodeChar could not be determined.\r
203 @retval 1 UnicodeChar is a narrow glyph.\r
204 @retval 2 UnicodeChar is a wide glyph.\r
205\r
206**/\r
207UINTN\r
208EFIAPI\r
209GlueGetGlyphWidth (\r
210 IN CHAR16 UnicodeChar\r
211 )\r
212{\r
213 UINTN Index;\r
214 UINTN Low;\r
215 UINTN High;\r
216 UNICODE_WIDTH_ENTRY *Item;\r
217\r
218 Item = NULL;\r
219 Low = 0;\r
220 High = (sizeof (mUnicodeWidthTable)) / (sizeof (UNICODE_WIDTH_ENTRY)) - 1;\r
221 while (Low <= High) {\r
222 Index = (Low + High) >> 1;\r
223 Item = &(mUnicodeWidthTable[Index]);\r
224 if (Index == 0) {\r
225 if (UnicodeChar <= Item->WChar) {\r
226 break;\r
227 }\r
228\r
229 return 0;\r
230 }\r
231\r
232 if (UnicodeChar > Item->WChar) {\r
233 Low = Index + 1;\r
234 } else if (UnicodeChar <= mUnicodeWidthTable[Index - 1].WChar) {\r
235 High = Index - 1;\r
236 } else {\r
237 //\r
238 // Index - 1 < UnicodeChar <= Index. Found\r
239 //\r
240 break;\r
241 }\r
242 }\r
243\r
244 if (Low <= High) {\r
245 return Item->Width;\r
246 }\r
247\r
248 return 0;\r
249}\r
250\r
251/**\r
252 This function computes and returns the display length of\r
253 the Null-terminated Unicode string specified by String.\r
254 If String is NULL, then 0 is returned.\r
255 If any of the widths of the Unicode characters in String\r
256 can not be determined, then 0 is returned.\r
257\r
258 @param String A pointer to a Null-terminated Unicode string.\r
259\r
260 @return The display length of the Null-terminated Unicode string specified by String.\r
261 \r
262**/\r
263UINTN\r
264EFIAPI\r
265UnicodeStringDisplayLength (\r
266 IN CONST CHAR16 *String\r
267 )\r
268{\r
269 UINTN Length;\r
270 UINTN Width;\r
271\r
272 if (String == NULL) {\r
273 return 0;\r
274 }\r
275\r
276 Length = 0;\r
277 while (*String != 0) {\r
278 Width = GetGlyphWidth (*String);\r
279 if (Width == 0) {\r
280 return 0;\r
281 }\r
282\r
283 Length += Width;\r
284 String++;\r
285 }\r
286\r
287 return Length;\r
288}\r