pcjs/modules/c1pjs/lib/panel.js

/**
 * @fileoverview This file implements the C1Pjs Panel component.
 * @author <a href="mailto:Jeff@pcjs.org">Jeff Parsons</a>
 * @copyright © Jeff Parsons 2012-2016
 *
 * This file is part of PCjs, a computer emulation software project at <http://pcjs.org/>.
 *
 * PCjs is free software: you can redistribute it and/or modify it under the terms of the
 * GNU General Public License as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * PCjs is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with PCjs.  If not,
 * see <http://www.gnu.org/licenses/gpl.html>.
 *
 * You are required to include the above copyright notice in every modified copy of this work
 * and to display that copyright notice when the software starts running; see COPYRIGHT in
 * <http://pcjs.org/modules/shared/lib/defines.js>.
 *
 * Some PCjs files also attempt to load external resource files, such as character-image files,
 * ROM files, and disk image files. Those external resource files are not considered part of PCjs
 * for purposes of the GNU General Public License, and the author does not claim any copyright
 * as to their contents.
 */

"use strict";

if (NODE) {
    var web         = require("../../shared/lib/weblib");
    var Component   = require("../../shared/lib/component");
}

/**
 * C1PPanel(parmsPanel)
 *
 * The Panel component has no required (parmsPanel) properties.
 *
 * @constructor
 * @extends Component
 */
function C1PPanel(parmsPanel)
{
    Component.call(this, "C1PPanel", parmsPanel);

    this.flags.powered = false;
}

Component.subclass(C1PPanel);

/**
 * The Panel doesn't have any bindings of its own; it passes along all binding requests to
 * the Computer, CPU, Keyboard and Debugger components. The order shouldn't matter, since any
 * component that doesn't recognize the specified binding should simply ignore it.
 *
 * @this {C1PPanel}
 * @param {string|null} sHTMLType is the type of the HTML control (eg, "button", "list", "text", "submit", "textarea", "canvas")
 * @param {string} sBinding is the value of the 'binding' parameter stored in the HTML control's "data-value" attribute (eg, "reset")
 * @param {Object} control is the HTML control DOM object (eg, HTMLButtonElement)
 * @param {string} [sValue] optional data value
 * @return {boolean} true if binding was successful, false if unrecognized binding request
 */
C1PPanel.prototype.setBinding = function(sHTMLType, sBinding, control, sValue)
{
    if (this.cmp && this.cmp.setBinding(sHTMLType, sBinding, control, sValue)) return true;
    if (this.cpu && this.cpu.setBinding(sHTMLType, sBinding, control, sValue)) return true;
    if (this.kbd && this.kbd.setBinding(sHTMLType, sBinding, control, sValue)) return true;
    if (DEBUGGER && this.dbg && this.dbg.setBinding(sHTMLType, sBinding, control, sValue)) return true;
    return Component.prototype.setBinding.call(this, sHTMLType, sBinding, control, sValue);
};

/**
 * @this {C1PPanel}
 * @param {boolean} fOn
 * @param {C1PComputer} cmp
 */
C1PPanel.prototype.setPower = function(fOn, cmp)
{
    if (fOn && !this.flags.powered) {
        this.flags.powered = true;
        this.cmp = cmp;
        this.cpu = cmp.getComponentByType("cpu");
        this.kbd = cmp.getComponentByType("keyboard");
        if (DEBUGGER) this.dbg = cmp.getComponentByType("debugger");
        C1PPanel.init();
    }
};

/**
 * C1PPanel.init()
 *
 * This function operates on every HTML element of class "panel", extracting the
 * JSON-encoded parameters for the C1PPanel constructor from the element's "data-value"
 * attribute, invoking the constructor to create a C1PPanel component, and then binding
 * any associated HTML controls to the new component.
 *
 * NOTE: Unlike most other component init() functions, this one is designed to be
 * called multiple times: once at load time, so that we can binding our print()
 * function to the panel's output control ASAP, and again when the C1PComputer component
 * is verifying that all components are ready and invoking their setPower() functions.
 *
 * Our setPower() method gives us a second opportunity to notify any components that
 * that might care (eg, C1PCPU, C1PKeyboard, and C1PDebugger) that we have some controls
 * they might want to use.
 */
C1PPanel.init = function()
{
    var fReady = false;
    var aePanels = Component.getElementsByClass(document, C1PJS.APPCLASS, "panel");
    for (var iPanel=0; iPanel < aePanels.length; iPanel++) {
        var ePanel = aePanels[iPanel];
        var parmsPanel = Component.getComponentParms(ePanel);
        var panel = Component.getComponentByID(parmsPanel['id']);
        if (!panel) {
            fReady = true;
            panel = new C1PPanel(parmsPanel);
        }
        Component.bindComponentControls(panel, ePanel, C1PJS.APPCLASS);
        if (fReady) panel.setReady();
    }
};

/*
 * Initialize every Panel module on the page.
 */
web.onInit(C1PPanel.init);