RPG Maker MZ
Text Helper v1.1.1

/******************************************************************************
 * CXJ_MZ_TextHelper.js                                                       *
 ******************************************************************************
 * By G.A.M. Kertopermono, a.k.a. GaryCXJk                                    *
 ******************************************************************************
 * License: MIT                                                               *
 ******************************************************************************
 * Copyright (c) 2020-2022, G.A.M. Kertopermono                               *
 *                                                                            *
 * Permission is hereby granted, free of charge, to any person obtaining a    *
 * copy of this software and associated documentation files (the "Software"), *
 * to deal in the Software without restriction, including without limitation  *
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,   *
 * and/or sell copies of the Software, and to permit persons to whom the      *
 * Software is furnished to do so, subject to the following conditions:       *
 *                                                                            *
 * The above copyright notice and this permission notice shall be included in *
 * all copies or substantial portions of the Software.                        *
 *                                                                            *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,   *
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL    *
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING    *
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER        *
 * DEALINGS IN THE SOFTWARE.                                                  *
 ******************************************************************************/

/*:
 * @target MZ
 * @plugindesc Adds various helper functions to create text strings.
 * @author G.A.M. Kertopermono
 *
 * @help
 * ============================================================================
 * = About                                                                    =
 * ============================================================================
 *
 * Adding new text commands can be a hassle, and sometimes you just want to
 * add simple text commands without needing to create new plugins. Or you just
 * want to make it easier for yourself to add new text commands. This plugin
 * can help you with that.
 *
 * This plugin is meant for both plugin developers as well as developers of
 * RPG Maker games.
 *
 * ============================================================================
 * = Requirements                                                             =
 * ============================================================================
 *
 * This plugin requires the following plugins to work:
 *
 * * CXJ_MZ.CoreEssentials: ^1.3
 *
 * ============================================================================
 * = Placement                                                                =
 * ============================================================================
 *
 * Make sure to place this plugin below the plugins that this plugin requires,
 * but above plugins that rely on this plugin.
 *
 * ============================================================================
 * = Usage                                                                    =
 * ============================================================================
 *
 * -----------------
 * Plugin developers
 * -----------------
 *
 * CXJ_MZ.TextHelper.addMessageCode(code, callback, type, escapeBrackets = null,
 *                                      location = 'base')
 *
 * Message codes can be added through this method. For the large part it's
 * fairly straightforward. The code is a regular expression string, this will
 * later be converted to a regular expression object, primarily because depending
 * on the chosen type, the full regular expression changes. It will also be
 * pre-processed to replace certain strings with a regular expression:
 *
 * :any  - (.+?)             - Any character string.
 * :num  - (-?\d+(?:\.\d+)?) - A number.
 * :unum - (\d+(?:\.\d+)?)   - A positive number.
 * :int  - (-?\d+)           - An integer.
 * :uint - (\d+)             - A positive integer.
 * :id   - (\w+)             - Any alphanumerical character or an underscore.
 *
 * There are three types of message codes, convert, process and getLength. The
 * convert codes essentially replaces the codes before it gets rendered, and process
 * replaces the codes on render. Essentially it depends whether the code is being used
 * in Window_Base.prototype.convertEscapeCharacters or in
 * Window_Base.prototype.processEscapeCharacter.
 *
 * For example, if you simply want to display the current date, the name of
 * the first party member, or the amount of money you have, these codes are
 * being used during convert. If you want to display an image icon, or you
 * want to change the text color, these codes are being used during process.
 *
 * Finally, there's getLength, which will help calculate the length of the text. This
 * is mainly useful for codes that don't return text, like image icons. It should
 * return an array with two values. The first value is number, which will be
 * interpreted as the length in pixels. The second value is a boolean. If true, it
 * will tell the interpreter that this code will be run in a new line.
 *
 * The escape brackets option has priority over the global settings, meaning a
 * plugin developer can enforce whether the brackets and parentheses are escaped
 * or not.
 *
 * Location allows you to only set the code to a certain window. By default, only
 * base (Window_Base) and message (Window_Message) are supported, but essentially
 * all windows are supported, so long as the object uses the Window_ prefix, as
 * the location is determined by the class name / object prototype constructor.
 *
 * Note that with process callbacks, the first argument is always the text state.
 *
 * Arguments:
 *
 * {string} code            - The code, as a regular expression string.
 * {function} callback      - A callback function. Must return a string for convert,
 *                            or a boolean for process.
 * {string} type            - Either convert or process.
 * {boolean} escapeBrackets - (optional) Whether to escape brackets and
 *                            parentheses or not.
 * {string} location        - (optional) Allows you to limit where the code can be
 *                            used. Use "base" to make it available everywhere.
 *
 * -----------------
 * Plugin parameters
 * -----------------
 *
 * Escape brackets and parentheses
 * -------------------------------
 *
 * Just like how you'd normally add message codes, the codes you define using
 * this plugin requires the use of regular expressions. This also means that
 * square brackets and parentheses need to be escaped. If you are absolutely
 * certain that your own codes don't already escape brackets, you can enable
 * this.
 *
 * Message codes
 * -------------
 *
 * If you don't want to write your own plugin to add message codes, you can
 * create them through this parameter. Do note that message codes added
 * through here will get run first, followed by those added by other plugins,
 * and finally the built-in message codes.
 *
 * Note that with process callbacks, the first argument is always the text state.
 * This parameter will automatically be defined as textState.
 *
 * Each entry has the following options:
 *
 * Code                            - The message code used. This is a regular
 *                                   expression, without a leading backslash.
 * Callback                        - The callback function. This should return
 *                                   the string that replaces the original
 *                                   code in case the code is run during the
 *                                   convert phase.
 * Type                            - The type of message code. Either convert
 *                                   or process.
 * Parameter names                 - The name of the parameters. These can be
 *                                   used in the callback.
 * Escape brackets and parentheses - Whether square brackets and parentheses
 *                                   should be escaped or not.
 * Valid code location             - The window where the code is valid.
 * Other location                  - When "Valid code location" is "Other",
 *                                   this field is used.
 *
 * ============================================================================
 * = Changelog                                                                =
 * ============================================================================
 *
 * 1.1.1 (2022-07-20)
 * ------------------
 *
 * * Added: Option to interpret the PY code as a new line or not.
 * * Changed: Moved addWaitMode to Core Essentials.
 * * Changed: Moved wait mode plugin parameters to Core Improvements.
 * * Changed: Moved wait mode plugin command to Core Commands.
 * * Fixed: Issues when calculating the line width when the line starts with a
 *   supposed line breaking code.
 *
 * 1.1 (2022-07-04)
 * ----------------
 *
 * * Added a new code type getLength, which allows you to determine the length
 *   of a line while interpreting the string.
 * * All built-in codes will have a corresponding getLength callback.
 * * Changed: runProcessEscapeCharacter will first set the index before
 *   processing the code.
 *
 * 1.0.3 (2022-07-04)
 * ------------------
 *
 * * Fixed: process type codes won't work when defining codes in the plugin
 *   manager.
 *
 * 1.0.2 (2020-11-11)
 * ------------------
 *
 * * Changed callback parameter types from note to multiline_string.
 *
 * 1.0.1 (2020-11-10)
 * ------------------
 *
 * * Replaced instances of windowName with the property windowName
 *
 * 1.0 (2020-11-01)
 * ----------------
 *
 * * Initial release
 *
 * ============================================================================
 * = Compatibility                                                            =
 * ============================================================================
 *
 * This plugin overwrites default functionality. Make sure you check whether or
 * not the plugin is compatible with other plugins by checking which functions
 * they overwrite. Below is the list of methods it overwrites:
 *
 * * Window_Base.prototype.convertEscapeCharacters
 * * Window_Base.prototype.processEscapeCharacter
 * * Window_Message.prototype.processEscapeCharacter
 *
 * ============================================================================
 * = License                                                                  =
 * ============================================================================
 *
 * Copyright (c) 2020, G.A.M. Kertopermono
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *
 * ============================================================================
 *
 * @param textParser
 * @text Text parser
 *
 * @param textParser.escapeBrackets
 * @text Escape brackets and parentheses
 * @desc Whether brackets [] and parentheses () should be escaped.
 * @parent textParser
 * @type boolean
 * @on Yes
 * @off No
 * @default false
 *
 * @param textParser.messageCodes
 * @text Message codes
 * @desc You can add message codes through this parameter.
 * @parent textParser
 * @type struct<TextParserMessageCode>[]
 *
 * @param textParser.isNewLinePY
 * @text PY starts new line
 * @desc Whether the PY code should be counted as starting a new line
 * @parent textParser
 * @type boolean
 * @default false
 * @on Yes
 * @off No
 */
/*~struct~TextParserMessageCode:
 * @param code
 * @text Code
 * @type text
 *
 * @param callback
 * @text Callback
 * @type multiline_string
 *
 * @param type
 * @text Type
 * @type select
 * @default convert
 * @option Before interpretation (convert)
 * @value convert
 * @option During interpretation (process)
 * @value process
 * @option During length retrieval (getLength)
 * @value getLength
 *
 * @param parameterNames
 * @text Parameter names
 * @desc You can define the parameter names here.
 * @type text[]
 * @default []
 *
 * @param escapeBrackets
 * @text Escape brackets and parentheses
 * @desc Whether brackets [] and parentheses () should be escaped.
 * @type select
 * @default null
 * @option Default
 * @value null
 * @option Yes
 * @value true
 * @option No
 * @value false
 *
 * @param location
 * @text Valid code location
 * @desc The window where the code is valid.
 * @type select
 * @default base
 * @option All windows
 * @value base
 * @option Message
 * @value message
 * @option Other
 * @value other
 *
 * @param locationOther
 * @text Other location
 * @desc Enter the location name if you picked "Other".
 * @type text
 */

(() => {
  window.CXJ_MZ = window.CXJ_MZ || {};
  const {
    CXJ_MZ
  } = window;
  CXJ_MZ.TextHelper = CXJ_MZ.TextHelper || {};
  CXJ_MZ.TextHelper.version = '1.1.1';

  if (!CXJ_MZ.CoreEssentials) {
    throw new Error('CoreEssentials has not been initialized. Make sure you load CoreEssentials before this plugin.');
  }

  if (!CXJ_MZ.CoreEssentials.isVersion('CXJ_MZ.CoreEssentials', '1.3')) {
    throw new Error('The correct version of CoreEssentials has not been loaded (required version: 1.3).');
  }

  const {
    CoreEssentials,
    TextHelper,
  } = CXJ_MZ;

  const pluginName = 'CXJ_MZ_TextHelper';

  /* ------------------------------------------------------------------------
   * - Default parameters                                                   -
   * ------------------------------------------------------------------------
   */

  const parameters = CoreEssentials.getParameters(pluginName, {
    'textParser.escapeBrackets': false,
    'textParser.messageCodes': [],
    'textParser.isNewLinePY': false,
  }, {
    'textParser.escapeBrackets': 'boolean',
    'textParser.messageCodes': ['array', 'object', {
      code: 'text',
      callback: 'text',
      type: 'text',
      parameterNames: ['array', 'text'],
      escapeBrackets: 'literal',
      location: 'text',
      locationOther: 'text',
    }],
    'textParser.isNewLinePY': 'boolean',
  });

  /* ------------------------------------------------------------------------
   * - PRIVATE VARIABLES                                                    -
   * ------------------------------------------------------------------------
   */

  const messageCodes = {
    convert: {
      base: [],
      message: [],
    },
    process: {
      base: [],
      message: [],
    },
    getLength: {
      base: [],
      message: [],
    }
  };

  /* --------------------------------------------------------------------------
   * - PRIVATE FUNCTIONS                                                      -
   * -                                                                        -
   * - These are helper functions that aren't meant to be used outside the    -
   * - plugin.                                                                -
   * --------------------------------------------------------------------------
   */

  const setMessageCode = function(code, escapeBrackets = null) {
    let messageCode = code;
    const escapeBracketsSet = escapeBrackets === null || typeof escapeBrackets === 'undefined';
    if ((escapeBracketsSet && parameters['textParser.escapeBrackets']) || escapeBrackets) {
      messageCode = messageCode.replace(/\[(.+?)\]/, '\\[$1\\]');
      messageCode = messageCode.replace(/\((.+?)\)/, '\\($1\\)');
    }
    messageCode = messageCode.replace(/\:any/,'(.+?)');
    messageCode = messageCode.replace(/\:num/,'(-?\d+(?:\.\d+)?)');
    messageCode = messageCode.replace(/\:unum/,'(\d+(?:\.\d+)?)');
    messageCode = messageCode.replace(/\:int/,'(-?\d+)');
    messageCode = messageCode.replace(/\:uint/,'(\d+)');
    messageCode = messageCode.replace(/\:id/,'(\w+)');
    return messageCode;
  }

  /**
   * Helper function that simplifies executing code.
   *
   * Essentially it shifts the first entry, the full string match, out of
   * the match array and uses the rest as parameter for the callback
   * function.
   *
   * @param {function} callback - A callback.
   * @param  {...string} match - A regular expression match.
   */
  const runMessageCode = function(callback, ...match) {
    return callback.call(this, ...match.slice(1));
  };

  /**
   * Helper function that simplifies running convertEscapeCharacters on
   * custom text codes.
   *
   * @param {string} text - The text that needs to be replaced.
   * @param {string} location - The window type.
   * @param {function} callback - The callback.
   */
  const runConvertEscapeCharacters = function(text, location, callback = null) {
    let newText = text.replace(/\\/g, '\x1b');
    newText = newText.replace(/\x1b\x1b/g, '\\');
    const list = messageCodes.convert[location] || [];
    list.forEach((data) => {
      const [code, callback] = data;
      newText = newText.replace(new RegExp(`\x1b${code}`, 'gi'), runMessageCode.bind(this, callback));
    });
    newText = newText.replace(/\\/g, '\\\\');
    if (callback) {
      newText = callback.call(this, newText);
    }
    return newText;
  }

  /**
   * Helper function that simplifies running processEscapeCharacter on
   * custom text codes.
   *
   * @param {string} code - The code that's found. Will be used to (temporarily)
   * reset the text state index.
   * @param {object} textState - The current text state.
   * @param {string} location - The location.
   * @param {function} callback - The callback.
   */
  const runProcessEscapeCharacter = function(code, textState, location, callback = null) {
    // First, let's set the index back, as Window_Base.prototype.obtainEscapeCode
    // sets the index to where it thinks the code ends.
    textState.index-= code.length;

    // Let's get the relevant bit of the text.
    const text = textState.text.slice(textState.index);

    // We'll check if a code match has been found by setting this variable.
    let found = false;

    // Ensures we'll work with an array (in case a non-existing location is picked).
    // This is mainly for the unsupported window types.
    const list = messageCodes.process[location] || [];
    list.every((data) => {
      // Destructurizes the data object.
      const [longCode, callback] = data;

      // Check if there's a match at the beginning of the text string.
      const match = text.match(new RegExp(`^${longCode}`, 'i'));
      if (match) {
        // If there is a match, run the callback, and set the index after the matched
        // string. Finally, set found to true, and abort the loop.
        const matchedString = match[0];
        textState.index+= matchedString.length;
        callback.call(this, textState, ...match.slice(1));
        found = true;
        return false;
      }
      return true;
    });
    if (!found) {
      // If no code match is found, set the index back to where it originally was.
      textState.index+= code.length;

      // If there's a callback, run the callback.
      if (callback) {
        return callback.call(this, code, textState);
      }
    }
    // Return the found status.
    return found;
  }

  runGetEscapeCharacterLength = function(textState, location) {
    const list = messageCodes.convert[location] || [];

    // Let's get the relevant bit of the text.
    const text = textState.text.slice(textState.index);

    let returnValues = [0, false];

    list.every((data) => {
      // Destructurizes the data object.
      const [code, callback] = data;

      // Check if there's a match at the beginning of the text string.
      const match = text.match(new RegExp(`^${code}`, 'i'));
      if (match) {
        // If there is a match, run the callback, and set the index after the matched
        // string. Finally, set found to true, and abort the loop.
        const matchedString = match[0];
        textState.index+= matchedString.length;
        returnValues = callback.call(this, textState, ...match.slice(1));
        return false;
      }
      return true;
    });

    return returnValues;
  }

  /* --------------------------------------------------------------------------
   * - Plugin methods                                                         -
   * --------------------------------------------------------------------------
   */

  /**
   * Adds a message code.
   * @param {string} code - The code.
   * @param {function} callback - The callback that should be called.
   * @param {string} type - Either convert, process or length.
   * @param {*} escapeBrackets - Whether to escape brackets and parentheses or
   * not. Set null for default.
   * @param {string} location - Allows you to limit where the code can be used.
   * Use "base" to make it available everywhere.
   */
  TextHelper.addMessageCode = (code, callback, type, escapeBrackets = null, location = 'base') => {
    const data = [setMessageCode(code, escapeBrackets), callback];
    messageCodes[type] = messageCodes[type] || {};
    messageCodes[type][location] = messageCodes[type][location] || [];
    messageCodes[type][location].push(data);
  }

  // All parameter message codes get stored.
  if (parameters['textParser.messageCodes'] && parameters['textParser.messageCodes'].length) {
    parameters['textParser.messageCodes'].forEach((data) => {
      const {
        code,
        callback,
        type,
        parameterNames = [],
        escapeBrackets = null,
        location = 'base',
        locationOther = 'base',
      } = data;

      // Ensures that the first parameter for convert callbacks is textState.
      const realParameterNames = [
        ...(type === 'process' ? ['textState'] : []),
        ...parameterNames,
      ];

      const realCallback = new Function(...realParameterNames, callback);
      TextHelper.addMessageCode(code, realCallback, type, escapeBrackets, location === 'other' ? locationOther : location);
    });
  }

  /* --------------------------------------------------------------------------
   * - Overrides and additions                                                -
   * --------------------------------------------------------------------------
   */
  // Add default length codes.
  TextHelper.addMessageCode('C\\[:uint\\]', function (textState, color) {
    this.changeTextColor(color);
    return [0, false];
  }, 'length', false);
  TextHelper.addMessageCode('I\\[:uint\\]', (textState) => {
    const x = ImageManager.iconWidth + 4;
    textState+= x;
    return [x, false];
  }, 'length', false);
  TextHelper.addMessageCode('PX\\[:uint\\]', (textState, x) => {
    textState.x = x;
    return [x, true];
  }, 'length', false);
  TextHelper.addMessageCode('PY\\[:uint\\]', (textState, y) => {
    textState.y = y;
    if (parameters['textParser.isNewLinePY']) {
      return [textState.x, true];
    }
    return [0, false];
  }, 'length', false);
  TextHelper.addMessageCode('FS\\[:uint\\]', function (textState, fontSize) {
    this.contents.fontSize = fontSize;
    return [0, false];
  }, 'length', false);
  TextHelper.addMessageCode('{', function () {
    this.makeFontBigger();
    return [0, false];
  }, 'length', false);
  TextHelper.addMessageCode('}', function () {
    this.makeFontSmaller();
    return [0, false];
  }, 'length', false);
  TextHelper.addMessageCode('$', () => [0, false], 'length', false, 'message');
  TextHelper.addMessageCode('.', () => [0, false], 'length', false, 'message');
  TextHelper.addMessageCode('|', () => [0, false], 'length', false, 'message');
  TextHelper.addMessageCode('!', () => [0, false], 'length', false, 'message');
  TextHelper.addMessageCode('>', () => [0, false], 'length', false, 'message');
  TextHelper.addMessageCode('<', () => [0, false], 'length', false, 'message');
  TextHelper.addMessageCode('^', () => [0, false], 'length', false, 'message');

  (() => {

    /* --------------------------------------------------------------------
     * - Window_Base.prototype.convertEscapeCharacters (Override)         -
     * --------------------------------------------------------------------
     */

    /**
     * @method convertEscapeCharacters
     * @param {string} text - A text string.
     * @private
     */
    const wbConvertEscapeCharacters = CoreEssentials.setNoConflict('Window_Base.prototype.convertEscapeCharacters');
    Window_Base.prototype.convertEscapeCharacters = function(text) {
      let newText = text;
      if (this.windowName !== 'base') {
        newText = runConvertEscapeCharacters.call(this, newText, this.windowName);
      }
      return runConvertEscapeCharacters.call(this, newText, 'base', wbConvertEscapeCharacters);
    };

    /* --------------------------------------------------------------------
     * - Window_Base.prototype.processEscapeCharacter (Override)          -
     * --------------------------------------------------------------------
     */

    /**
     * @method convertEscapeCharacters
     * @param {string} code
     * @param {object} textState
     * @private
     */
    const wbProcessEscapeCharacter = CoreEssentials.setNoConflict('Window_Base.prototype.processEscapeCharacter');
    Window_Base.prototype.processEscapeCharacter = function(code, textState) {
      if (!['base', 'message'].includes(this.windowName)) {
        const found = runProcessEscapeCharacter.call(this, code, textState, this.windowName);
        if (found) {
          return true;
        }
      }
      return runProcessEscapeCharacter.call(this, code, textState, 'base', wbProcessEscapeCharacter);
    }

    Object.defineProperty(Window_Base.prototype, "windowName", {
      get: function() {
        return this.constructor.name.replace(/^Window_/, '').toLowerCase();
      },
      enumerable: false,
    });

    /* --------------------------------------------------------------------
     * - Window_Message.prototype.processEscapeCharacter (Override)       -
     * --------------------------------------------------------------------
     */

    /**
     * @method convertEscapeCharacters
     * @param {string} code
     * @param {object} textState
     * @private
     */
    const wmProcessEscapeCharacter = CoreEssentials.setNoConflict('Window_Message.prototype.processEscapeCharacter');
    Window_Message.prototype.processEscapeCharacter = function(code, textState) {
      return runProcessEscapeCharacter.call(this, code, textState, 'message', wmProcessEscapeCharacter);
    }

    /* --------------------------------------------------------------------
     * - Window_Base.prototype.getTextLineLength (New)                    -
     * --------------------------------------------------------------------
     */

    /**
     * @method getTextLineLength
     * @param {object} currentTextState
     * @param {boolean} resetStyle
     */
    Window_Base.prototype.getTextLineLength = function (currentTextState, resetStyle = false) {
      const contentsProps = {
        fontFace: this.contents.fontFace,
        fontSize: this.contents.fontSize,
        textColor: this.contents.textColor,
        outlineColor: this.contents.outlineColor,
      };

      if (resetStyle) {
        this.resetFontSettings();
      }

      const textState = { ...currentTextState };

      let width = 0;
      while (textState.index < textState.text.length) {
        const match = textState.text.slice(textState.index).match(/^(.+?)(\n|\x1b)/);
        const str = match?.[1] ?? textState.text.slice(textState.index);
        const escape = match?.[2] ?? '\n';
        width+= this.textWidth(str);
        textState.x+= this.textWidth(str);
        if (escape === '\n') {
          if (width === 0) {
            textState.index += 1;
            continue;
          }
          break;
        }
        textState.index += str.length + 1;

        const [widthValue, isNewLine] = runGetEscapeCharacterLength.call(this, textState);
        width+= widthValue;

        if (isNewLine && width > 0) {
          break;
        }
      }

      Object.assign(this.contents, contentsProps);

      return width;
    }
  })();
})();