EditorOptionHandlers.js

/*
 * GNU AGPL-3.0 License
 *
 * Copyright (c) 2021 - present core.ai . All rights reserved.
 * Original work Copyright (c) 2013 - 2021 Adobe Systems Incorporated. All rights reserved.
 *
 * This program 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.
 *
 * This program 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 this program. If not, see https://opensource.org/licenses/AGPL-3.0.
 *
 */

define(function (require, exports, module) {


    const AppInit             = require("utils/AppInit"),
        Editor              = require("editor/Editor").Editor,
        Commands            = require("command/Commands"),
        CommandManager      = require("command/CommandManager"),
        PreferencesManager  = require("preferences/PreferencesManager"),
        Strings             = require("strings"),
        EditorManager       = require("editor/EditorManager"),
        ThemeManager        = require("view/ThemeManager"),
        _                   = require("thirdparty/lodash");

    // Constants for the preferences referred to in this file
    const SHOW_LINE_NUMBERS = "showLineNumbers",
        STYLE_ACTIVE_LINE = "styleActiveLine",
        WORD_WRAP         = "wordWrap",
        CLOSE_BRACKETS    = "closeBrackets",
        AUTO_HIDE_SEARCH  = "autoHideSearch";

    let currentMaxLineLength = 120;

    const PREFERENCES_EDITOR_RULERS = "editor.rulers",
        PREFERENCES_EDITOR_RULER_COLORS = "editor.rulerColors",
        PREFERENCES_EDITOR_RULERS_ENABLED = "editor.rulersEnabled";
    PreferencesManager.definePreference(PREFERENCES_EDITOR_RULERS_ENABLED, "boolean", true, {
        description: Strings.DESCRIPTION_RULERS_ENABLED
    });
    PreferencesManager.definePreference(PREFERENCES_EDITOR_RULERS, "array", [120], {
        description: Strings.DESCRIPTION_RULERS_COLUMNS
    });
    PreferencesManager.definePreference(PREFERENCES_EDITOR_RULER_COLORS, "array", [], {
        description: Strings.DESCRIPTION_RULERS_COLORS
    });

    let _currentTheme;
    /**
     * @private
     *
     * Maps from preference names to the command names needed to update the checked status.
     */
    let _optionMapping = {};
    _optionMapping[SHOW_LINE_NUMBERS] = Commands.TOGGLE_LINE_NUMBERS;
    _optionMapping[STYLE_ACTIVE_LINE] = Commands.TOGGLE_ACTIVE_LINE;
    _optionMapping[WORD_WRAP] = Commands.TOGGLE_WORD_WRAP;
    _optionMapping[CLOSE_BRACKETS] = Commands.TOGGLE_CLOSE_BRACKETS;
    _optionMapping[AUTO_HIDE_SEARCH] = Commands.TOGGLE_SEARCH_AUTOHIDE;
    _optionMapping[PREFERENCES_EDITOR_RULERS_ENABLED] = Commands.TOGGLE_RULERS;



    /**
     * @private
     *
     * Updates the command checked status based on the preference name given.
     *
     * @param {string} name Name of preference that has changed
     */
    function _updateCheckedState(name) {
        var mapping = _optionMapping[name];
        if (!mapping) {
            return;
        }
        CommandManager.get(mapping).setChecked(PreferencesManager.get(name));
    }

    // Listen to preference changes for the preferences we care about
    Object.keys(_optionMapping).forEach(function (preference) {
        PreferencesManager.on("change", preference, function () {
            _updateCheckedState(preference);
        });
    });

    /**
     * @private
     * Creates a function that will toggle the named preference.
     *
     * @param {string} prefName Name of preference that should be toggled by the function
     */
    function _getToggler(prefName) {
        return function () {
            PreferencesManager.set(prefName, !PreferencesManager.get(prefName));
        };
    }

    function _createRulers(editor) {
        const rulerColumns = PreferencesManager.get(PREFERENCES_EDITOR_RULERS) || [];
        const rulerColors = PreferencesManager.get(PREFERENCES_EDITOR_RULER_COLORS) || [];
        const rulersEnabled = PreferencesManager.get(PREFERENCES_EDITOR_RULERS_ENABLED);
        if( !rulersEnabled || !rulerColumns.length || !editor){
            return;
        }

        if(!_currentTheme){
            _currentTheme = ThemeManager.getCurrentTheme();
        }
        if(!_currentTheme){
            // theme manager can return a null current theme at startup before themes load!
            return;
        }
        const defaultColor = (_currentTheme && _currentTheme.dark) ? "#333333" : "#e0e0e0";

        if(!editor._codeMirror.getOption("rulers")){
            let rulerOptions = [];
            for(let i=0; i<rulerColumns.length; i++) {
                rulerOptions.push({
                    color: rulerColors[i] ? rulerColors[i]: defaultColor,
                    column: rulerColumns[i],
                    lineStyle: "solid !important"
                });
            }
            editor._codeMirror.setOption("rulers", rulerOptions);
        }
    }

    function _resetRulers() {
        Editor.forEveryEditor(function (editor) {
            editor._codeMirror.setOption("rulers", null);
            _createRulers(editor);
        });
    }

    function _handleThemeChange() {
        _currentTheme = ThemeManager.getCurrentTheme();
        _resetRulers();
    }

    CommandManager.register(Strings.CMD_TOGGLE_LINE_NUMBERS, Commands.TOGGLE_LINE_NUMBERS, _getToggler(SHOW_LINE_NUMBERS));
    CommandManager.register(Strings.CMD_TOGGLE_ACTIVE_LINE, Commands.TOGGLE_ACTIVE_LINE, _getToggler(STYLE_ACTIVE_LINE));
    CommandManager.register(Strings.CMD_TOGGLE_WORD_WRAP, Commands.TOGGLE_WORD_WRAP, _getToggler(WORD_WRAP));
    CommandManager.register(Strings.CMD_TOGGLE_CLOSE_BRACKETS, Commands.TOGGLE_CLOSE_BRACKETS, _getToggler(CLOSE_BRACKETS));
    CommandManager.register(Strings.CMD_TOGGLE_SEARCH_AUTOHIDE, Commands.TOGGLE_SEARCH_AUTOHIDE, _getToggler(AUTO_HIDE_SEARCH));
    CommandManager.register(Strings.CMD_TOGGLE_RULERS, Commands.TOGGLE_RULERS, _getToggler(PREFERENCES_EDITOR_RULERS_ENABLED));

    function _init() {
        _.each(_optionMapping, function (commandName, prefName) {
            CommandManager.get(commandName).setChecked(PreferencesManager.get(prefName));
        });

        if (!Editor.getShowLineNumbers()) {
            Editor._toggleLinePadding(true);
        }

        // fires for inline editor creation;
        EditorManager.on('activeEditorChange', (_event, newActiveEditor)=>{
            _createRulers(newActiveEditor);
        });
        PreferencesManager.on("change", PREFERENCES_EDITOR_RULERS_ENABLED, _resetRulers);
        PreferencesManager.on("change", PREFERENCES_EDITOR_RULERS, ()=>{
            const rulerColumns = PreferencesManager.get(PREFERENCES_EDITOR_RULERS) || [];
            currentMaxLineLength = rulerColumns.length ? Math.max(...rulerColumns) : 120;
            _resetRulers();
        });
        PreferencesManager.on("change", PREFERENCES_EDITOR_RULER_COLORS, _resetRulers);
        ThemeManager.on(ThemeManager.EVENT_THEME_CHANGE, _handleThemeChange);
        _resetRulers();
    }

    function getMaxLineLength() {
        return currentMaxLineLength;
    }

    AppInit.appReady(_init);

    exports.getMaxLineLength = getMaxLineLength;
});