node_modules/xterm/src/common/CharWidth.ts

   1 /**
   2  * Copyright (c) 2016 The xterm.js authors. All rights reserved.
   3  * @license MIT
   4  */
   5
   6 import { fill } from 'common/TypedArrayUtils';
   7
   8 export const wcwidth = (function(opts: {nul: number, control: number}): (ucs: number) => number {
   9   // extracted from https://www.cl.cam.ac.uk/%7Emgk25/ucs/wcwidth.c
  10   // combining characters
  11   const COMBINING_BMP = [
  12     [0x0300, 0x036F], [0x0483, 0x0486], [0x0488, 0x0489],
  13     [0x0591, 0x05BD], [0x05BF, 0x05BF], [0x05C1, 0x05C2],
  14     [0x05C4, 0x05C5], [0x05C7, 0x05C7], [0x0600, 0x0603],
  15     [0x0610, 0x0615], [0x064B, 0x065E], [0x0670, 0x0670],
  16     [0x06D6, 0x06E4], [0x06E7, 0x06E8], [0x06EA, 0x06ED],
  17     [0x070F, 0x070F], [0x0711, 0x0711], [0x0730, 0x074A],
  18     [0x07A6, 0x07B0], [0x07EB, 0x07F3], [0x0901, 0x0902],
  19     [0x093C, 0x093C], [0x0941, 0x0948], [0x094D, 0x094D],
  20     [0x0951, 0x0954], [0x0962, 0x0963], [0x0981, 0x0981],
  21     [0x09BC, 0x09BC], [0x09C1, 0x09C4], [0x09CD, 0x09CD],
  22     [0x09E2, 0x09E3], [0x0A01, 0x0A02], [0x0A3C, 0x0A3C],
  23     [0x0A41, 0x0A42], [0x0A47, 0x0A48], [0x0A4B, 0x0A4D],
  24     [0x0A70, 0x0A71], [0x0A81, 0x0A82], [0x0ABC, 0x0ABC],
  25     [0x0AC1, 0x0AC5], [0x0AC7, 0x0AC8], [0x0ACD, 0x0ACD],
  26     [0x0AE2, 0x0AE3], [0x0B01, 0x0B01], [0x0B3C, 0x0B3C],
  27     [0x0B3F, 0x0B3F], [0x0B41, 0x0B43], [0x0B4D, 0x0B4D],
  28     [0x0B56, 0x0B56], [0x0B82, 0x0B82], [0x0BC0, 0x0BC0],
  29     [0x0BCD, 0x0BCD], [0x0C3E, 0x0C40], [0x0C46, 0x0C48],
  30     [0x0C4A, 0x0C4D], [0x0C55, 0x0C56], [0x0CBC, 0x0CBC],
  31     [0x0CBF, 0x0CBF], [0x0CC6, 0x0CC6], [0x0CCC, 0x0CCD],
  32     [0x0CE2, 0x0CE3], [0x0D41, 0x0D43], [0x0D4D, 0x0D4D],
  33     [0x0DCA, 0x0DCA], [0x0DD2, 0x0DD4], [0x0DD6, 0x0DD6],
  34     [0x0E31, 0x0E31], [0x0E34, 0x0E3A], [0x0E47, 0x0E4E],
  35     [0x0EB1, 0x0EB1], [0x0EB4, 0x0EB9], [0x0EBB, 0x0EBC],
  36     [0x0EC8, 0x0ECD], [0x0F18, 0x0F19], [0x0F35, 0x0F35],
  37     [0x0F37, 0x0F37], [0x0F39, 0x0F39], [0x0F71, 0x0F7E],
  38     [0x0F80, 0x0F84], [0x0F86, 0x0F87], [0x0F90, 0x0F97],
  39     [0x0F99, 0x0FBC], [0x0FC6, 0x0FC6], [0x102D, 0x1030],
  40     [0x1032, 0x1032], [0x1036, 0x1037], [0x1039, 0x1039],
  41     [0x1058, 0x1059], [0x1160, 0x11FF], [0x135F, 0x135F],
  42     [0x1712, 0x1714], [0x1732, 0x1734], [0x1752, 0x1753],
  43     [0x1772, 0x1773], [0x17B4, 0x17B5], [0x17B7, 0x17BD],
  44     [0x17C6, 0x17C6], [0x17C9, 0x17D3], [0x17DD, 0x17DD],
  45     [0x180B, 0x180D], [0x18A9, 0x18A9], [0x1920, 0x1922],
  46     [0x1927, 0x1928], [0x1932, 0x1932], [0x1939, 0x193B],
  47     [0x1A17, 0x1A18], [0x1B00, 0x1B03], [0x1B34, 0x1B34],
  48     [0x1B36, 0x1B3A], [0x1B3C, 0x1B3C], [0x1B42, 0x1B42],
  49     [0x1B6B, 0x1B73], [0x1DC0, 0x1DCA], [0x1DFE, 0x1DFF],
  50     [0x200B, 0x200F], [0x202A, 0x202E], [0x2060, 0x2063],
  51     [0x206A, 0x206F], [0x20D0, 0x20EF], [0x302A, 0x302F],
  52     [0x3099, 0x309A], [0xA806, 0xA806], [0xA80B, 0xA80B],
  53     [0xA825, 0xA826], [0xFB1E, 0xFB1E], [0xFE00, 0xFE0F],
  54     [0xFE20, 0xFE23], [0xFEFF, 0xFEFF], [0xFFF9, 0xFFFB]
  55   ];
  56   const COMBINING_HIGH = [
  57     [0x10A01, 0x10A03], [0x10A05, 0x10A06], [0x10A0C, 0x10A0F],
  58     [0x10A38, 0x10A3A], [0x10A3F, 0x10A3F], [0x1D167, 0x1D169],
  59     [0x1D173, 0x1D182], [0x1D185, 0x1D18B], [0x1D1AA, 0x1D1AD],
  60     [0x1D242, 0x1D244], [0xE0001, 0xE0001], [0xE0020, 0xE007F],
  61     [0xE0100, 0xE01EF]
  62   ];
  63   // binary search
  64   function bisearch(ucs: number, data: number[][]): boolean {
  65     let min = 0;
  66     let max = data.length - 1;
  67     let mid;
  68     if (ucs < data[0][0] || ucs > data[max][1]) {
  69       return false;
  70     }
  71     while (max >= min) {
  72       mid = (min + max) >> 1;
  73       if (ucs > data[mid][1]) {
  74         min = mid + 1;
  75       } else if (ucs < data[mid][0]) {
  76         max = mid - 1;
  77       } else {
  78         return true;
  79       }
  80     }
  81     return false;
  82   }
  83   function wcwidthHigh(ucs: number): 0 | 1 | 2 {
  84     if (bisearch(ucs, COMBINING_HIGH)) {
  85       return 0;
  86     }
  87     if ((ucs >= 0x20000 && ucs <= 0x2fffd) || (ucs >= 0x30000 && ucs <= 0x3fffd)) {
  88       return 2;
  89     }
  90     return 1;
  91   }
  92   const control = opts.control | 0;
  93
  94   // create lookup table for BMP plane
  95   const table = new Uint8Array(65536);
  96   fill(table, 1);
  97   table[0] = opts.nul;
  98   // control chars
  99   fill(table, opts.control, 1, 32);
 100   fill(table, opts.control, 0x7f, 0xa0);
 101
 102   // apply wide char rules first
 103   // wide chars
 104   fill(table, 2, 0x1100, 0x1160);
 105   table[0x2329] = 2;
 106   table[0x232a] = 2;
 107   fill(table, 2, 0x2e80, 0xa4d0);
 108   table[0x303f] = 1;  // wrongly in last line
 109
 110   fill(table, 2, 0xac00, 0xd7a4);
 111   fill(table, 2, 0xf900, 0xfb00);
 112   fill(table, 2, 0xfe10, 0xfe1a);
 113   fill(table, 2, 0xfe30, 0xfe70);
 114   fill(table, 2, 0xff00, 0xff61);
 115   fill(table, 2, 0xffe0, 0xffe7);
 116
 117   // apply combining last to ensure we overwrite
 118   // wrongly wide set chars:
 119   //    the original algo evals combining first and falls
 120   //    through to wide check so we simply do here the opposite
 121   // combining 0
 122   for (let r = 0; r < COMBINING_BMP.length; ++r) {
 123     fill(table, 0, COMBINING_BMP[r][0], COMBINING_BMP[r][1] + 1);
 124   }
 125
 126   return function (num: number): number {
 127     if (num < 32) {
 128       return control | 0;
 129     }
 130     if (num < 127) {
 131       return 1;
 132     }
 133     if (num < 65536) {
 134       return table[num];
 135     }
 136     // do a full search for high codepoints
 137     return wcwidthHigh(num);
 138   };
 139 })({nul: 0, control: 0});  // configurable options
 140
 141 /**
 142  * Get the terminal cell width for a string.
 143  */
 144 export function getStringCellWidth(s: string): number {
 145   let result = 0;
 146   const length = s.length;
 147   for (let i = 0; i < length; ++i) {
 148     let code = s.charCodeAt(i);
 149     // surrogate pair first
 150     if (0xD800 <= code && code <= 0xDBFF) {
 151       if (++i >= length) {
 152         // this should not happen with strings retrieved from
 153         // Buffer.translateToString as it converts from UTF-32
 154         // and therefore always should contain the second part
 155         // for any other string we still have to handle it somehow:
 156         // simply treat the lonely surrogate first as a single char (UCS-2 behavior)
 157         return result + wcwidth(code);
 158       }
 159       const second = s.charCodeAt(i);
 160       // convert surrogate pair to high codepoint only for valid second part (UTF-16)
 161       // otherwise treat them independently (UCS-2 behavior)
 162       if (0xDC00 <= second && second <= 0xDFFF) {
 163         code = (code - 0xD800) * 0x400 + second - 0xDC00 + 0x10000;
 164       } else {
 165         result += wcwidth(second);
 166       }
 167     }
 168     result += wcwidth(code);
 169   }
 170   return result;
 171 }