@daiyam/xterm-tab-addon-ligatures/src/parse.ts

Add support for programming ligatures to xterm.js

/**
 * Copyright (c) 2018 The xterm.js authors. All rights reserved.
 * @license MIT
 */

interface IParseContext {
  input: string;
  offset: number;
}

/**
 * Parses a CSS font family value, returning the component font families
 * contained within.
 *
 * @param family The CSS font family input string to parse
 */
export default function parse(family: string): string[] {
  if (typeof family !== 'string') {
    throw new Error('Font family must be a string');
  }

  const context: IParseContext = {
    input: family,
    offset: 0
  };

  const families = [];
  let currentFamily = '';

  // Work through the input character by character until there are none left.
  // This lexing and parsing in one pass.
  while (context.offset < context.input.length) {
    const char = context.input[context.offset++];
    switch (char) {
      // String
      case '\'':
      case '"':
        currentFamily += parseString(context, char);
        break;
      // End of family
      case ',':
        families.push(currentFamily);
        currentFamily = '';
        break;
      default:
        // Identifiers (whitespace between families is swallowed)
        if (!/\s/.test(char)) {
          context.offset--;
          currentFamily += parseIdentifier(context);
          families.push(currentFamily);
          currentFamily = '';
        }
    }
  }

  return families;
}

/**
 * Parse a CSS string.
 *
 * @param context Parsing input and offset
 * @param quoteChar The quote character for the string (' or ")
 */
function parseString(context: IParseContext, quoteChar: '\'' | '"'): string {
  let str = '';
  let escaped = false;
  while (context.offset < context.input.length) {
    const char = context.input[context.offset++];
    if (escaped) {
      if (/[\dA-Fa-f]/.test(char)) {
        // Unicode escape
        context.offset--;
        str += parseUnicode(context);
      } else if (char !== '\n') {
        // Newlines are ignored if escaped. Other characters are used as is.
        str += char;
      }
      escaped = false;
    } else {
      switch (char) {
        // Terminated quote
        case quoteChar:
          return str;
        // Begin escape
        case '\\':
          escaped = true;
          break;
        // Add character to string
        default:
          str += char;
      }
    }
  }

  throw new Error('Unterminated string');
}

/**
 * Parse a CSS custom identifier.
 *
 * @param context Parsing input and offset
 */
function parseIdentifier(context: IParseContext): string {
  let str = '';
  let escaped = false;
  while (context.offset < context.input.length) {
    const char = context.input[context.offset++];
    if (escaped) {
      if (/[\dA-Fa-f]/.test(char)) {
        // Unicode escape
        context.offset--;
        str += parseUnicode(context);
      } else {
        // Everything else is used as is
        str += char;
      }
      escaped = false;
    } else {
      switch (char) {
        // Begin escape
        case '\\':
          escaped = true;
          break;
        // Terminate identifier
        case ',':
          return str;
        default:
          if (/\s/.test(char)) {
            // Whitespace is collapsed into a single space within an identifier
            if (!str.endsWith(' ')) {
              str += ' ';
            }
          } else {
            // Add other characters directly
            str += char;
          }
      }
    }
  }

  return str;
}

/**
 * Parse a CSS unicode escape.
 *
 * @param context Parsing input and offset
 */
function parseUnicode(context: IParseContext): string {
  let str = '';
  while (context.offset < context.input.length) {
    const char = context.input[context.offset++];
    if (/\s/.test(char)) {
      // The first whitespace character after a unicode escape indicates the end
      // of the escape and is swallowed.
      return unicodeToString(str);
    }
    if (str.length >= 6 || !/[\dA-Fa-f]/.test(char)) {
      // If the next character is not a valid hex digit or we have reached the
      // maximum of 6 digits in the escape, terminate the escape.
      context.offset--;
      return unicodeToString(str);
    }

    // Otherwise, just add it to the escape
    str += char;
  }

  return unicodeToString(str);
}

/**
 * Convert a unicode code point from a hex string to a utf8 string.
 *
 * @param codePoint Unicode code point represented as a hex string
 */
function unicodeToString(codePoint: string): string {
  return String.fromCodePoint(parseInt(codePoint, 16));
}