static/colour.ts

// Copyright (c) 2016, Compiler Explorer Authors
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//     * Redistributions of source code must retain the above copyright notice,
//       this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

import _ from 'underscore';
import * as monaco from 'monaco-editor';

/**
 * A colour scheme
 */
interface ColourScheme {
    name: string;
    desc: string;
    count: number;
    themes: string[];
}

// If you want to use an scheme in every theme, set `theme: ['all']`
export const schemes: ColourScheme[] = [
    { name: 'rainbow', desc: 'Rainbow 1', count: 12, themes: ['default'] },
    { name: 'rainbow2', desc: 'Rainbow 2', count: 12, themes: ['default'] },
    { name: 'earth', desc: 'Earth tones (colourblind safe)', count: 9, themes: ['default'] },
    { name: 'green-blue', desc: 'Greens and blues (colourblind safe)', count: 4, themes: ['default'] },
    { name: 'gray-shade', desc: 'Gray shades', count: 4, themes: ['dark'] },
    { name: 'rainbow-dark', desc: 'Dark Rainbow', count: 12, themes: ['dark'] },
];

export function applyColours(editor: monaco.editor.ICodeEditor, colours: number[], schemeName: string, prevDecorations: string[]): string[] {
    let scheme: ColourScheme = _.findWhere(schemes, { name: schemeName });
    if (!scheme) {
        scheme = schemes[0];
    }

    const newDecorations = _.map(colours, (ordinal: number, _line: number | string) => {
        const line: number = parseInt(_line as string) + 1;
        return {
            range: new monaco.Range(line, 1, line, 1),
            options: {
                isWholeLine: true,
                className: 'line-linkage ' + scheme.name + '-' + (ordinal % scheme.count),
            },
        };
    });

    return editor.deltaDecorations(prevDecorations, newDecorations);
}