sprotty/src/base/commands/command-stack-options.ts

A next-gen framework for graphical views

/********************************************************************************
 * Copyright (c) 2017-2021 TypeFox and others.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the Eclipse
 * Public License v. 2.0 are satisfied: GNU General Public License, version 2
 * with the GNU Classpath Exception which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 ********************************************************************************/

import { Container, interfaces } from 'inversify';
import { safeAssign } from 'sprotty-protocol/lib/utils/object';
import { TYPES } from '../types';

/**
 * Options for the command execution
 */
export interface CommandStackOptions {
    /**
     * The default duration of an animated command in milliseconds
     */
    defaultDuration: number

    /**
     * The maximum number of commands that can be undone. Once the undo stack
     * reaches this number, any additional command that is pushed will remove
     * one from the bottom of the stack.
     *
     * If negative, there is no limit, which results in a memory leak.
     */
    undoHistoryLimit: number
}

export const defaultCommandStackOptions: () => CommandStackOptions = () => ({
    defaultDuration: 250,
    undoHistoryLimit: 50
});

/**
 * Utility function to partially set command stack options. Default values (from `defaultViewerOptions`) are used for
 * options that are not specified.
 */
export function configureCommandStackOptions(context: { bind: interfaces.Bind, isBound: interfaces.IsBound, rebind: interfaces.Rebind },
        options: Partial<CommandStackOptions>): void {
    const opt: CommandStackOptions = {
        ...defaultCommandStackOptions(),
        ...options
    };
    if (context.isBound(TYPES.CommandStackOptions)) {
        context.rebind(TYPES.CommandStackOptions).toConstantValue(opt);
    } else {
        context.bind(TYPES.CommandStackOptions).toConstantValue(opt);
    }
}

/**
 * Utility function to partially override the currently configured command stack options in a DI container.
 */
export function overrideCommandStackOptions(container: Container, options: Partial<CommandStackOptions>): CommandStackOptions {
    const defaultOptions = container.get<CommandStackOptions>(TYPES.CommandStackOptions);
    safeAssign(defaultOptions, options);
    return defaultOptions;
}