LogarithmPlotter/common/src/history/editproperty.mjs

/**
 *  LogarithmPlotter - 2D plotter software to make BODE plots, sequences and distribution functions.
 *  Copyright (C) 2021-2024  Ad5001
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

import Objects from "../module/objects.mjs"
import Latex from "../module/latex.mjs"
import * as MathLib from "../math/index.mjs"
import { Action } from "./common.mjs"
import { DrawableObject } from "../objs/common.mjs"

/**
 * Action used everytime an object's property has been changed.
 */
export default class EditedProperty extends Action {
    type() {
        return "EditedProperty"
    }

    icon() {
        return "modify"
    }

    color(darkVer = false) {
        return darkVer ? "darkslateblue" : "cyan"
    }

    /**
     *
     * @param {string} targetName - Name of the object to target
     * @param {string} targetType - Type of the object to target.
     * @param {string} targetProperty - Property being changed
     * @param {any} previousValue - Previous value before change
     * @param {any} newValue - New value after change
     * @param {boolean} valueIsExpressionNeedingImport - True if the value needs to be imported. (e.g expressions)
     */
    constructor(targetName = "", targetType = "Point", targetProperty = "visible", previousValue = false, newValue = true, valueIsExpressionNeedingImport = false) {
        super(targetName, targetType)
        this.targetProperty = targetProperty
        this.targetPropertyReadable = qsTranslate("prop", this.targetProperty)
        this.previousValue = previousValue
        this.newValue = newValue
        this.propertyType = Objects.types[targetType].properties()[targetProperty]
        if(valueIsExpressionNeedingImport) {
            if(typeof this.propertyType == "object" && this.propertyType.type === "Expression") {
                this.previousValue = new MathLib.Expression(this.previousValue)
                this.newValue = new MathLib.Expression(this.newValue)
            } else if(this.propertyType === "Domain") {
                this.previousValue = MathLib.parseDomain(this.previousValue)
                this.newValue = MathLib.parseDomain(this.newValue)
            } else {
                // Objects
                this.previousValue = Objects.currentObjectsByName[this.previousValue] // Objects.getObjectByName(this.previousValue);
                this.newValue = Objects.currentObjectsByName[this.newValue] // Objects.getObjectByName(this.newValue);
            }
        }
        this.setReadableValues()
    }

    undo() {
        Objects.currentObjectsByName[this.targetName][this.targetProperty] = this.previousValue
        Objects.currentObjectsByName[this.targetName].update()
    }

    redo() {
        Objects.currentObjectsByName[this.targetName][this.targetProperty] = this.newValue
        Objects.currentObjectsByName[this.targetName].update()
    }

    export() {
        if(this.previousValue instanceof MathLib.Expression) {
            return [this.targetName, this.targetType, this.targetProperty, this.previousValue.toEditableString(), this.newValue.toEditableString(), true]
        } else if(this.previousValue instanceof DrawableObject) {
            return [this.targetName, this.targetType, this.targetProperty, this.previousValue.name, this.newValue.name, true]
        } else {
            return [this.targetName, this.targetType, this.targetProperty, this.previousValue, this.newValue, false]
        }
    }

    setReadableValues() {
        this.prevString = ""
        this.nextString = ""
        this._renderPromises = []
        if(this.propertyType instanceof Object) {
            switch(this.propertyType.type) {
                case "Enum":
                    this.prevString = this.propertyType.translatedValues[this.propertyType.values.indexOf(this.previousValue)]
                    this.nextString = this.propertyType.translatedValues[this.propertyType.values.indexOf(this.newValue)]
                    break
                case "ObjectType":
                    this.prevString = this.previousValue == null ? "null" : this.previousValue.name
                    this.nextString = this.newValue == null ? "null" : this.newValue.name
                    break
                case "List":
                    this.prevString = this.previousValue.join(",")
                    this.nextString = this.newValue.name.join(",")
                    break
                case "Dict":
                    this.prevString = JSON.stringify(this.previousValue)
                    this.nextString = JSON.stringify(this.newValue)
                    break
                case "Expression":
                    this.prevString = this.previousValue == null ? "null" : this.previousValue.toString()
                    this.nextString = this.newValue == null ? "null" : this.newValue.toString()
                    break
            }
        } else {
            this.prevString = this.previousValue == null ? "null" : this.previousValue.toString()
            this.nextString = this.newValue == null ? "null" : this.newValue.toString()
        }
        // HTML
        this.prevHTML = "<tt style=\"background: rgba(128,128,128,0.1);\">&nbsp;" + this.prevString + "&nbsp;</tt>"
        this.nextHTML = "<tt style=\"background: rgba(128,128,128,0.1);\">&nbsp;" + this.nextString + "&nbsp;</tt>"
        if(Latex.enabled && typeof this.propertyType == "object" && this.propertyType.type === "Expression") {
            // Store promises so that querying can wait for them to finish.
            this._renderPromises = [
                this.renderLatexAsHtml(this.previousValue.latexMarkup).then(prev => this.prevHTML = prev),
                this.renderLatexAsHtml(this.newValue.latexMarkup).then(next => this.nextHTML = next)
            ]
        }
    }

    getReadableString() {
        return qsTranslate("editproperty", "%1 of %2 %3 changed from \"%4\" to \"%5\".")
            .arg(this.targetPropertyReadable)
            .arg(Objects.types[this.targetType].displayType())
            .arg(this.targetName).arg(this.prevString).arg(this.nextString)
    }

    /**
     *
     * @return {Promise<string>|string}
     */
    async getHTMLString() {
        const translation = qsTranslate("editproperty", "%1 of %2 changed from %3 to %4.")
            .arg(this.targetPropertyReadable)
            .arg("<b style=\"font-size: 15px;\">&nbsp;" + this.targetName + "&nbsp;</b>")
        // Check if we need to wait for LaTeX HTML to be rendered.
        if(this.prevHTML === undefined || this.nextHTML === undefined) {
            const [prevHTML, nextHTML] = await Promise.all(this._renderPromises)
            this.prevHTML = this.prevHTML ?? prevHTML
            this.nextHTML = this.nextHTML ?? nextHTML
        }
        return translation.arg(this.prevHTML).arg(this.nextHTML)
    }
}