Merge remote-tracking branch 'ups/master' into 687_macos_ci

[mirror_xterm.js.git] / src / utils / DomElementObjectPool.ts

/**
 * @module xterm/utils/DomElementObjectPool
 * @license MIT
 */

/**
 * An object pool that manages acquisition and releasing of DOM elements for
 * when reuse is desirable.
 */
export class DomElementObjectPool {
  private static readonly OBJECT_ID_ATTRIBUTE = 'data-obj-id';

  private static _objectCount = 0;

  private _type: string;
  private _pool: HTMLElement[];
  private _inUse: {[key: string]: HTMLElement};

  /**
   * @param type The DOM element type (div, span, etc.).
   */
  constructor(private type: string) {
    this._type = type;
    this._pool = [];
    this._inUse = {};
  }

  /**
   * Acquire an element from the pool, creating it if the pool is empty.
   */
  public acquire(): HTMLElement {
    let element: HTMLElement;
    if (this._pool.length === 0) {
      element = this._createNew();
    } else {
      element = this._pool.pop();
    }
    this._inUse[element.getAttribute(DomElementObjectPool.OBJECT_ID_ATTRIBUTE)] = element;
    return element;
  }

  /**
   * Release an element back into the pool. It's up to the caller of this
   * function to ensure that all external references to the element have been
   * removed.
   * @param element The element being released.
   */
  public release(element: HTMLElement): void {
    if (!this._inUse[element.getAttribute(DomElementObjectPool.OBJECT_ID_ATTRIBUTE)]) {
      throw new Error('Could not release an element not yet acquired');
    }
    delete this._inUse[element.getAttribute(DomElementObjectPool.OBJECT_ID_ATTRIBUTE)];
    this._cleanElement(element);
    this._pool.push(element);
  }

  /**
   * Creates a new element for the pool.
   */
  private _createNew(): HTMLElement {
    const element = document.createElement(this._type);
    const id = DomElementObjectPool._objectCount++;
    element.setAttribute(DomElementObjectPool.OBJECT_ID_ATTRIBUTE, id.toString(10));
    return element;
  }

  /**
   * Resets an element back to a "clean state".
   * @param element The element to be cleaned.
   */
  private _cleanElement(element: HTMLElement): void {
    element.className = '';
    element.innerHTML = '';
  }
}