satie/src/__tests__/etestutil.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/>.
 */

/**
 * @file part of Satie test suite
 */

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

import {IFactory} from "../private_factory";
import {ValidationCursor, LayoutCursor} from "../private_cursor";

export let fakeFactory: IFactory = {
    create: (modelType: Type): IModel => {
        chai.assert(false, "not reached");
        return null;
    },
    modelHasType: (model: IModel, modelType: Type): boolean => {
        if (model.divCount === 0) {
            return modelType === Type.Attributes;
        } else if ("length" in model) {
            return modelType === Type.Chord;
        }
        return modelType === Type.Spacer;
    },
    search: (models: IModel[], idx: number,
            modelType: Type): IModel[] => {
        return fakeFactory.modelHasType(models[idx], modelType) ? [models[idx]] : [];
    },
    fromSpec: (spec: any): IModel => {
        throw new Error("Not implemented");
    }
} as any;

export function createFakeStaffSegment(
        divisions1: number, divisions2: number, idx: number): ISegment {
    let a: ISegment = <any> <IModel[]> [
        {
            divCount: divisions1,
            staffIdx: 1,

            refresh: function(cursor: ValidationCursor) {
                // pass
            },
            getLayout: function(cursor: LayoutCursor): ILayout {
                let width = 10;
                cursor.segmentX += width;
                return {
                    boundingBoxes: [],
                    division: cursor.segmentDivision,
                    x: cursor.segmentX - width,
                    model: this,
                    renderClass: Type.Attributes
                };
            }
        },
        {
            divCount: divisions2,
            staffIdx: 1,

            refresh: function(cursor: ValidationCursor) {
                // pass
            },
            getLayout: function(cursor: LayoutCursor): ILayout {
                let width = 10;
                cursor.segmentX += width;
                return {
                    boundingBoxes: [],
                    division: cursor.segmentDivision,
                    x: cursor.segmentX - width,
                    model: this,
                    renderClass: Type.Attributes
                };
            }
        }
    ];
    a.owner = idx;
    a.part = "P1";
    a.divisions = divisions1 + divisions2;
    a.ownerType = "staff";
    return a;
}

export function createFakeVoiceSegment(
        divisions1: number, divisions2: number, idx: number): ISegment {
    let a: ISegment = <any> <(IModel & {length: number; 0: any})[]> [
        {
            divCount: divisions1,
            staffIdx: 1,
            length: 1,
            [0]: {
                pitch: {
                    step: "E",
                    octave: 4
                },
                noteType: {
                    duration: 8,
                },
                ties: [{}]
            },

            refresh: function(cursor: ValidationCursor) {
                // pass
            },

            getLayout: function(cursor: LayoutCursor): ILayout {
                let width = divisions1 * 10;
                cursor.segmentX += width;
                return {
                    boundingBoxes: [],
                    division: cursor.segmentDivision,
                    x: cursor.segmentX - width,
                    expandPolicy: "after",
                    model: this,
                    renderClass: Type.Chord
                };
            }
        },
        {
            divCount: divisions2,
            staffIdx: 1,
            length: 1,
            [0]: {
                pitch: {
                    step: "E",
                    octave: 4
                },
                noteType: {
                    duration: 8,
                },
                ties: [{}]
            },

            refresh: function(cursor: ValidationCursor) {
                // pass
            },

            getLayout: function(cursor: LayoutCursor): ILayout {
                let width = divisions2 * 10;
                cursor.segmentX += width;
                return {
                    boundingBoxes: [],
                    division: cursor.segmentDivision,
                    x: cursor.segmentX - width,
                    expandPolicy: "after",
                    model: this,
                    renderClass: Type.Chord
                };
            }
        }
    ];
    a.owner = idx;
    a.part = "P1";
    a.ownerType = "voice";
    a.divisions = divisions1 + divisions2;
    return a;
}

export function createFakeLayout(idx: number, offset: number, max: boolean): ILayout {
    return {
        model: <any> {},
        x: idx * 100 + Math.log(1 + offset) / Math.log(2) * 10,
        division: idx * 4 + offset,
        boundingBoxes: [],
        renderClass: Type.Attributes
    };
}