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