MdePkg/Library/UefiLib/Console.c

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