[mirror_edk2.git] / MdePkg / Library / UefiLib / Console.c

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