satie/src/implHarmony_harmonyModel.ts

A sheet music renderer for the web

/**
 * This file is part of Satie music engraver <https://github.com/jnetterf/satie>.
 * Copyright (C) Joshua Netterfield <joshua.ca> 2015 - present.
 * 
 * Satie is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * Satie 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 Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with Satie.  If not, see <http://www.gnu.org/licenses/>.
 */

import {Frame, ExplicitImpliedAlternate, Root, Function, Kind, Degree, Inversion, Bass,
    Footnote, Level, NormalBold, NormalItalic, AboveBelow, Harmony, Offset,
    serializeHarmony} from "musicxml-interfaces";
import {forEach} from "lodash";

import {IModel, ILayout, Type} from "./document";

import {IReadOnlyValidationCursor, LayoutCursor} from "./private_cursor";
import {IBoundingRect} from "./private_boundingRect";

class HarmonyModel implements Export.IHarmonyModel {

    /*---- I.1 IModel ---------------------------------------------------------------------------*/

    /** @prototype only */
    divCount: number;

    /** @prototype only */
    divisions: number;

    /** defined externally */
    staffIdx: number;

    /*---- I.2 Harmony --------------------------------------------------------------------------*/

    frame: Frame;
    printFrame: boolean;
    staff: number;
    type: ExplicitImpliedAlternate;
    offset: Offset;

    /*---- I.2.1 HarmonyChord -------------------------------------------------------------------*/

    root: Root;
    function: Function;
    kind: Kind;
    degrees: Degree[];
    inversion: Inversion;
    bass: Bass;

    /*---- I.2.2 Editorial ----------------------------------------------------------------------*/

    footnote: Footnote;
    level: Level;

    /*---- I.2.3 PrintObject --------------------------------------------------------------------*/

    printObject: boolean;

    /*---- I.2.4 PrintStyle ---------------------------------------------------------------------*/

    /*---- PrintStyle > Position ------------------------------------------------------------*/

    defaultX: number; // ignored for now
    relativeY: number;
    defaultY: number;
    relativeX: number;

    /*---- PrintStyle > Font ----------------------------------------------------------------*/

    fontFamily: string;
    fontWeight: NormalBold;
    fontStyle: NormalItalic;
    fontSize: string;

    /*---- PrintStyle > Color ---------------------------------------------------------------*/

    get color(): string {
        let hex = this._color.toString(16);
        return "#" + "000000".substr(0, 6 - hex.length) + hex;
    }
    set color(a: string) {
        switch (true) {
            case !a:
                this._color = 0;
                break;
            case a[0] === "#":
                a = a.slice(1);
                this._color = parseInt(a, 16);
                break;
            default:
                this._color = parseInt(a, 16);
                break;
        }
    }

    /*---- I.2.5 Placement ----------------------------------------------------------------------*/

    placement: AboveBelow;

    /*---- Private ------------------------------------------------------------------------------*/

    private _color: number = 0x000000;

    /*---- Implementation -----------------------------------------------------------------------*/

    constructor(spec: Harmony) {
        forEach<any>(spec, (value, key) => {
            (this as any)[key] = value;
        });
    }

    refresh(cursor: IReadOnlyValidationCursor): void {
        // todo
    }

    getLayout(cursor: LayoutCursor): Export.IHarmonyLayout {
        // todo

        return new HarmonyModel.Layout(this, cursor);
    }

    toXML(): string {
        return `${serializeHarmony(this)}\n<forward><duration>${this.divCount}</duration></forward>\n`;
    }

    inspect() {
        return this.toXML();
    }

    calcWidth(shortest: number) {
        return 0;
    }
}

HarmonyModel.prototype.divCount = 0;
HarmonyModel.prototype.divisions = 0;

module HarmonyModel {
    export class Layout implements Export.IHarmonyLayout {
        constructor(model: HarmonyModel, cursor: LayoutCursor) {
            this.model = model;
            this.x = cursor.segmentX;
            this.division = cursor.segmentDivision;
        }

        /*---- ILayout ------------------------------------------------------*/

        // Constructed:

        model: HarmonyModel;
        x: number;
        division: number;

        // Prototype:

        boundingBoxes: IBoundingRect[];
        renderClass: Type;
        expandPolicy: "none";
    }

    Layout.prototype.expandPolicy = "none";
    Layout.prototype.renderClass = Type.Harmony;
    Layout.prototype.boundingBoxes = [];
    Object.freeze(Layout.prototype.boundingBoxes);
};

/**
 * Registers Harmony in the factory structure passed in.
 */
function Export(constructors: { [key: number]: any }) {
    constructors[Type.Harmony] = HarmonyModel;
}

module Export {
    export interface IHarmonyModel extends IModel, Harmony {
    }

    export interface IHarmonyLayout extends ILayout {
    }
}

export default Export;