@desertnet/html-parser/lib/HTMLParseError.js

HTML parser and non-strict validator

/**
 * Class for recording syntactic and semantic HTML errors.
 */
export default class HTMLParseError {
  constructor () {
    /**
     * @private
     * @type {string} message
     */
    this._message = "Unknown parse error";

    /**
     * @private
     * @type {Array.<Foundation.Scanner.Token>}
     */
    this._tokens = [];
  }

  /**
   * @param {string} message
   */
  set message (message) {
    this._message = message;
  }

  /**
   * @public
   * @return {string}
   */
  get message () {
    return this._message;
  }

  /**
   * @param {Foundation.Scanner.Token} token
   */
  addToken (token) {
    this._tokens.push(token);
    this._tokens.sort((a, b) => (a.index < b.index) ? -1 : 1);
  }

  /**
   * @param {Foundation.HTML.Parser.HTMLNode} node
   */
  addTokensFromNode (node) {
    node.tokens.forEach(token => this.addToken(token));
  }

  /**
   * The offset in the source string where the error begins.
   * @public
   * @return {number}
   */
  get startIndex () {
    this.assertTokensHaveBeenAdded();
    return this._tokens[0].index;
  }

  /**
   * The offset in the source string where the error stops.
   * @public
   * @return {number}
   */
  get endIndex () {
    this.assertTokensHaveBeenAdded();
    var lastToken = this._tokens[this._tokens.length - 1];
    return lastToken.index + lastToken.value.length;
  }

  /**
   * The line number in the source string where the error begins.
   * @public
   * @return {number}
   */
  get line () {
    this.assertTokensHaveBeenAdded();
    return this._tokens[0].line;
  }

  /**
   * The column number of the line in the source string where the error begins.
   * @public
   * @return {number}
   */
  get column () {
    this.assertTokensHaveBeenAdded();
    return this._tokens[0].column;
  }

  /**
   * @private
   */
  assertTokensHaveBeenAdded () {
    if (this._tokens.length === 0) {
      throw new Error("No tokens added to error object.");
    }
  }

  /**
   * @private
   * @return {Array.<Foundation.Scanner.Token>}
   */
  get tokens () {
    return this._tokens.slice(0);
  }
}