From a4e9ad7f5a22a239b43cbea4dfe6fe8c0c9862d2 Mon Sep 17 00:00:00 2001 From: Ad5001 Date: Sun, 22 Sep 2024 19:35:40 +0200 Subject: [PATCH] Removing usage of "Modules" to refer to modules in JavaScript (using imports instead) --- .../eu/ad5001/LogarithmPlotter/js/canvas.mjs | 12 +- .../LogarithmPlotter/js/history/common.mjs | 36 +----- .../LogarithmPlotter/js/history/module.mjs | 46 ++++++++ .../qml/eu/ad5001/LogarithmPlotter/js/io.mjs | 103 +++++++++--------- .../js/lib/expr-eval/integration.mjs | 2 +- .../LogarithmPlotter/js/math/expression.mjs | 22 ++-- .../LogarithmPlotter/js/math/sequence.mjs | 14 ++- .../LogarithmPlotter/js/objs/autoload.mjs | 2 +- .../ad5001/LogarithmPlotter/js/parameters.mjs | 5 +- .../js/preferences/general.mjs | 6 +- 10 files changed, 139 insertions(+), 109 deletions(-) create mode 100644 LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/history/module.mjs diff --git a/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/canvas.mjs b/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/canvas.mjs index d214be3..3736a11 100644 --- a/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/canvas.mjs +++ b/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/canvas.mjs @@ -20,6 +20,8 @@ import { Module } from "./modules.mjs" import { textsup } from "./utils.mjs" import { Expression } from "./mathlib.mjs" import Latex from "./math/latex.mjs" +import Objects from "./objects.mjs" +import History from "./history/module.mjs" class CanvasAPI extends Module { @@ -168,8 +170,8 @@ class CanvasAPI extends Module { this._drawAxes() this._drawLabels() this._ctx.lineWidth = this.linewidth - for(let objType in Modules.Objects.currentObjects) { - for(let obj of Modules.Objects.currentObjects[objType]){ + for(let objType in Objects.currentObjects) { + for(let obj of Objects.currentObjects[objType]){ this._ctx.strokeStyle = obj.color this._ctx.fillStyle = obj.color if(obj.visible) @@ -180,7 +182,7 @@ class CanvasAPI extends Module { console.error(e) console.log(e.stack) this._drawingErrorDialog.showDialog(objType, obj.name, e.message) - Modules.History.undo() + History.undo() } } } @@ -188,7 +190,7 @@ class CanvasAPI extends Module { } /** - * Calculates informations for drawing gradations for axes. + * Calculates information for drawing gradations for axes. * @private */ _computeAxes() { @@ -538,4 +540,4 @@ class CanvasAPI extends Module { /** @type {CanvasAPI} */ Modules.Canvas = Modules.Canvas || new CanvasAPI() -export const API = Modules.Canvas +export default Modules.Canvas diff --git a/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/history/common.mjs b/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/history/common.mjs index db2d5dc..a9d7d60 100644 --- a/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/history/common.mjs +++ b/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/history/common.mjs @@ -16,35 +16,9 @@ * along with this program. If not, see . */ -import { Module } from "../modules.mjs" +import History from "./module.mjs" import Latex from "../math/latex.mjs" - -class HistoryCommonAPI extends Module { - constructor() { - super('History', [ - Modules.Latex - ]) - // History QML object - this.history = null; - this.themeTextColor = "#ff0000"; - this.imageDepth = 2; - this.fontSize = 14; - } - - undo() { this.history.undo() } - redo() { this.history.redo() } - clear() { this.history.clear() } - addToHistory(action) { this.history.addToHistory(action) } - unserialize(...data) { this.history.unserialize(...data) } - serialize() { return this.history.serialize() } -} - -/** @type {HistoryCommonAPI} */ -Modules.History = Modules.History || new HistoryCommonAPI() - -export const API = Modules.History - export class Action { /** * Type of the action. @@ -102,7 +76,7 @@ export class Action { * @returns {string} */ getIconRichText(type) { - return `` + return `` } /** @@ -115,11 +89,11 @@ export class Action { if(!Latex.enabled) throw new Error("Cannot render an item as LaTeX when LaTeX is disabled.") return new Promise(resolve => { - let imgDepth = Modules.History.imageDepth + let imgDepth = History.imageDepth Latex.requestAsyncRender( latexString, - imgDepth * (Modules.History.fontSize + 2), - Modules.History.themeTextColor + imgDepth * (History.fontSize + 2), + History.themeTextColor ).then((imgData) => { const { source, width, height } = imgData resolve(``) diff --git a/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/history/module.mjs b/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/history/module.mjs new file mode 100644 index 0000000..873502a --- /dev/null +++ b/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/history/module.mjs @@ -0,0 +1,46 @@ +/** + * 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 . + */ + +import { Module } from "../modules.mjs" +import Latex from "../math/latex.mjs" + + +class HistoryAPI extends Module { + constructor() { + super('History', [ + Modules.Latex + ]) + // History QML object + this.history = null; + this.themeTextColor = "#ff0000"; + this.imageDepth = 2; + this.fontSize = 14; + } + + undo() { this.history.undo() } + redo() { this.history.redo() } + clear() { this.history.clear() } + addToHistory(action) { this.history.addToHistory(action) } + unserialize(...data) { this.history.unserialize(...data) } + serialize() { return this.history.serialize() } +} + +/** @type {HistoryAPI} */ +Modules.History = Modules.History || new HistoryAPI() + +export default Modules.History \ No newline at end of file diff --git a/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/io.mjs b/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/io.mjs index 4bc76b5..0186321 100644 --- a/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/io.mjs +++ b/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/io.mjs @@ -16,12 +16,15 @@ * along with this program. If not, see . */ -import {Module} from "./modules.mjs" +import { Module } from "./modules.mjs" +import Objects from "./objects.mjs" +import History from "./history/module.mjs" +import Canvas from "./canvas.mjs" class IOAPI extends Module { constructor() { - super('IO', [ + super("IO", [ Modules.Objects, Modules.History ]) @@ -50,39 +53,39 @@ class IOAPI extends Module { */ saveDiagram(filename) { // Add extension if necessary - if(['lpf'].indexOf(filename.split('.')[filename.split('.').length-1]) === -1) - filename += '.lpf' + if(["lpf"].indexOf(filename.split(".")[filename.split(".").length - 1]) === -1) + filename += ".lpf" this.saveFilename = filename let objs = {} - for(let objType in Modules.Objects.currentObjects){ + for(let objType in Objects.currentObjects) { objs[objType] = [] - for(let obj of Modules.Objects.currentObjects[objType]) { + for(let obj of Objects.currentObjects[objType]) { objs[objType].push(obj.export()) } } let settings = { - "xzoom": this.settings.xzoom, - "yzoom": this.settings.yzoom, - "xmin": this.settings.xmin, - "ymax": this.settings.ymax, - "xaxisstep": this.settings.xaxisstep, - "yaxisstep": this.settings.yaxisstep, - "xaxislabel": this.settings.xlabel, - "yaxislabel": this.settings.ylabel, - "logscalex": this.settings.logscalex, - "linewidth": this.settings.linewidth, - "showxgrad": this.settings.showxgrad, - "showygrad": this.settings.showygrad, - "textsize": this.settings.textsize, - "history": Modules.History.serialize(), - "width": this.rootElement.width, - "height": this.rootElement.height, - "objects": objs, - "type": "logplotv1" + "xzoom": this.settings.xzoom, + "yzoom": this.settings.yzoom, + "xmin": this.settings.xmin, + "ymax": this.settings.ymax, + "xaxisstep": this.settings.xaxisstep, + "yaxisstep": this.settings.yaxisstep, + "xaxislabel": this.settings.xlabel, + "yaxislabel": this.settings.ylabel, + "logscalex": this.settings.logscalex, + "linewidth": this.settings.linewidth, + "showxgrad": this.settings.showxgrad, + "showygrad": this.settings.showygrad, + "textsize": this.settings.textsize, + "history": History.serialize(), + "width": this.rootElement.width, + "height": this.rootElement.height, + "objects": objs, + "type": "logplotv1" } Helper.write(filename, JSON.stringify(settings)) - this.alert.show(qsTranslate('io', "Saved plot to '%1'.").arg(filename.split("/").pop())) - Modules.History.history.saved = true + this.alert.show(qsTranslate("io", "Saved plot to '%1'.").arg(filename.split("/").pop())) + History.history.saved = true } /** @@ -91,16 +94,16 @@ class IOAPI extends Module { */ loadDiagram(filename) { let basename = filename.split("/").pop() - this.alert.show(qsTranslate('io', "Loading file '%1'.").arg(basename)) + this.alert.show(qsTranslate("io", "Loading file '%1'.").arg(basename)) let data = JSON.parse(Helper.load(filename)) - let error = ""; + let error = "" if(Object.keys(data).includes("type") && data["type"] === "logplotv1") { - Modules.History.clear() + History.clear() // Importing settings this.settings.saveFilename = filename this.settings.xzoom = parseFloat(data["xzoom"]) || 100 this.settings.yzoom = parseFloat(data["yzoom"]) || 10 - this.settings.xmin = parseFloat(data["xmin"]) || 5/10 + this.settings.xmin = parseFloat(data["xmin"]) || 5 / 10 this.settings.ymax = parseFloat(data["ymax"]) || 24 this.settings.xaxisstep = data["xaxisstep"] || "4" this.settings.yaxisstep = data["yaxisstep"] || "4" @@ -119,51 +122,53 @@ class IOAPI extends Module { this.rootElement.width = parseFloat(data["width"]) || 1000 // Importing objects - Modules.Objects.currentObjects = {} - for(let key of Object.keys(Modules.Objects.currentObjectsByName)) { - delete Modules.Objects.currentObjectsByName[key]; + Objects.currentObjects = {} + for(let key of Object.keys(Objects.currentObjectsByName)) { + delete Objects.currentObjectsByName[key] // Required to keep the same reference for the copy of the object used in expression variable detection. // Another way would be to change the reference as well, but I feel like the code would be less clean. } - for(let objType in data['objects']) { - if(Object.keys(Modules.Objects.types).indexOf(objType) > -1) { - Modules.Objects.currentObjects[objType] = [] - for(let objData of data['objects'][objType]) { + for(let objType in data["objects"]) { + if(Object.keys(Objects.types).indexOf(objType) > -1) { + Objects.currentObjects[objType] = [] + for(let objData of data["objects"][objType]) { /** @type {DrawableObject} */ - let obj = Modules.Objects.types[objType].import(...objData) - Modules.Objects.currentObjects[objType].push(obj) - Modules.Objects.currentObjectsByName[obj.name] = obj + let obj = Objects.types[objType].import(...objData) + Objects.currentObjects[objType].push(obj) + Objects.currentObjectsByName[obj.name] = obj } } else { - error += qsTranslate('io', "Unknown object type: %1.").arg(objType) + "\n"; + error += qsTranslate("io", "Unknown object type: %1.").arg(objType) + "\n" } } // Updating object dependencies. - for(let objName in Modules.Objects.currentObjectsByName) - Modules.Objects.currentObjectsByName[objName].update() + for(let objName in Objects.currentObjectsByName) + Objects.currentObjectsByName[objName].update() // Importing history if("history" in data) - Modules.History.unserialize(...data["history"]) + History.unserialize(...data["history"]) // Refreshing sidebar this.rootElement.updateObjectsLists() } else { - error = qsTranslate('io', "Invalid file provided.") + error = qsTranslate("io", "Invalid file provided.") } if(error !== "") { console.log(error) - this.alert.show(qsTranslate('io', "Could not save file: ") + error) + this.alert.show(qsTranslate("io", "Could not save file: ") + error) // TODO: Error handling return } - Modules.Canvas.redraw() - this.alert.show(qsTranslate('io', "Loaded file '%1'.").arg(basename)) - Modules.History.history.saved = true + Canvas.redraw() + this.alert.show(qsTranslate("io", "Loaded file '%1'.").arg(basename)) + History.history.saved = true } } /** @type {IOAPI} */ Modules.IO = Modules.IO || new IOAPI() + +export default Modules.IO \ No newline at end of file diff --git a/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/lib/expr-eval/integration.mjs b/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/lib/expr-eval/integration.mjs index 244194f..2b99c9a 100644 --- a/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/lib/expr-eval/integration.mjs +++ b/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/lib/expr-eval/integration.mjs @@ -112,5 +112,5 @@ export class ExprParserAPI extends Module { /** @type {ExprParserAPI} */ Modules.ExprParser = Modules.ExprParser || new ExprParserAPI() - +export default Modules.ExprParser diff --git a/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/math/expression.mjs b/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/math/expression.mjs index 3a0ebb4..eb8ac8a 100644 --- a/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/math/expression.mjs +++ b/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/math/expression.mjs @@ -19,19 +19,17 @@ import Latex from "latex.mjs" import * as Utils from "../utils.mjs" +import ExprParser from "../lib/expr-eval/integration.mjs" +import Objects from "../objects.mjs" /** * Represents any kind of x-based or non variable based expression. */ export class Expression { constructor(expr) { - if(!Modules.ExprParser) - throw new Error('Expression parser not initialized.') - if(!Modules.Objects) - throw new Error('Objects API not initialized.') if(typeof expr === "string") { this.expr = Utils.exponentsToExpression(expr) - this.calc = Modules.ExprParser.parse(this.expr).simplify() + this.calc = ExprParser.parse(this.expr).simplify() } else { // Passed an expression here directly. this.calc = expr.simplify() @@ -40,7 +38,7 @@ export class Expression { this.cached = this.isConstant() this.cachedValue = null if(this.cached && this.allRequirementsFullfilled()) - this.cachedValue = this.calc.evaluate(Modules.Objects.currentObjectsByName) + this.cachedValue = this.calc.evaluate(Objects.currentObjectsByName) this.latexMarkup = Latex.expression(this.calc.tokens) } @@ -54,26 +52,26 @@ export class Expression { } allRequirementsFullfilled() { - return this.requiredObjects().every(objName => objName in Modules.Objects.currentObjectsByName) + return this.requiredObjects().every(objName => objName in Objects.currentObjectsByName) } undefinedVariables() { - return this.requiredObjects().filter(objName => !(objName in Modules.Objects.currentObjectsByName)) + return this.requiredObjects().filter(objName => !(objName in Objects.currentObjectsByName)) } recache() { if(this.cached) - this.cachedValue = this.calc.evaluate(Modules.Objects.currentObjectsByName) + this.cachedValue = this.calc.evaluate(Objects.currentObjectsByName) } execute(x = 1) { if(this.cached) { if(this.cachedValue == null) - this.cachedValue = this.calc.evaluate(Modules.Objects.currentObjectsByName) + this.cachedValue = this.calc.evaluate(Objects.currentObjectsByName) return this.cachedValue } - Modules.ExprParser.currentVars = Object.assign({'x': x}, Modules.Objects.currentObjectsByName) - return this.calc.evaluate(Modules.ExprParser.currentVars) + ExprParser.currentVars = Object.assign({'x': x}, Objects.currentObjectsByName) + return this.calc.evaluate(ExprParser.currentVars) } simplify(x) { diff --git a/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/math/sequence.mjs b/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/math/sequence.mjs index 677d68e..abc04c1 100644 --- a/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/math/sequence.mjs +++ b/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/math/sequence.mjs @@ -18,7 +18,9 @@ import * as Expr from "expression.mjs" import * as Utils from "../utils.mjs" -import Latex from "../math/latex.mjs" +import Latex from "./latex.mjs" +import Objects from "../objects.mjs" +import ExprParser from "../lib/expr-eval/integration.mjs" /** * Represents mathematical object for sequences. @@ -33,7 +35,7 @@ export class Sequence extends Expr.Expression { this.latexValues = Object.assign({}, baseValues) for(let n in this.calcValues) if(['string', 'number'].includes(typeof this.calcValues[n])) { - let parsed = Modules.ExprParser.parse(this.calcValues[n].toString()).simplify() + let parsed = ExprParser.parse(this.calcValues[n].toString()).simplify() this.latexValues[n] = Latex.expression(parsed.tokens) this.calcValues[n] = parsed.evaluate() } @@ -59,17 +61,17 @@ export class Sequence extends Expr.Expression { cache(n = 1) { let str = Utils.simplifyExpression(this.calc.substitute('n', n-this.valuePlus).toString()) - let expr = Modules.ExprParser.parse(str).simplify() + let expr = ExprParser.parse(str).simplify() // Cache values required for this one. if(!this.calcValues[n-this.valuePlus] && n-this.valuePlus > 0) this.cache(n-this.valuePlus) // Setting current variables - Modules.ExprParser.currentVars = Object.assign( + ExprParser.currentVars = Object.assign( {'n': n-this.valuePlus}, // Just in case, add n (for custom functions) - Modules.Objects.currentObjectsByName, + Objects.currentObjectsByName, {[this.name]: this.calcValues} ) - this.calcValues[n] = expr.evaluate(Modules.ExprParser.currentVars) + this.calcValues[n] = expr.evaluate(ExprParser.currentVars) } toString(forceSign=false) { diff --git a/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/objs/autoload.mjs b/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/objs/autoload.mjs index cf0df63..6173faf 100644 --- a/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/objs/autoload.mjs +++ b/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/objs/autoload.mjs @@ -43,7 +43,7 @@ function registerObject(obj) { } } -if(Object.keys(Modules.Objects.types).length === 0) { +if(Object.keys(Objects.types).length === 0) { registerObject(Point) registerObject(Text) registerObject(Function) diff --git a/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/parameters.mjs b/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/parameters.mjs index f59c322..477e3d5 100644 --- a/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/parameters.mjs +++ b/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/parameters.mjs @@ -16,6 +16,7 @@ * along with this program. If not, see . */ import {parseDomain, Expression as Expr, Domain} from "./mathlib.mjs" +import { Objects } from "./objects.mjs" const NONE = class Empty {} @@ -129,8 +130,8 @@ export class ObjectType extends PropertyType { parse(name) { let result = NONE - if(typeof name == 'string' && name in Modules.Objects.currentObjectsByName) { - let obj = Modules.Objects.currentObjectsByName[name] + if(typeof name == 'string' && name in Objects.currentObjectsByName) { + let obj = Objects.currentObjectsByName[name] if (obj.type === this.objType || (this.objType === 'ExecutableObject' && obj.execute)) { result = obj } else { diff --git a/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/preferences/general.mjs b/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/preferences/general.mjs index eb47e4a..d5f2fb5 100644 --- a/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/preferences/general.mjs +++ b/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/js/preferences/general.mjs @@ -17,6 +17,8 @@ */ import {BoolSetting} from "common.mjs" +import Canvas from "../canvas.mjs" +import LatexAPI from "../math/latex.mjs" const CHECK_FOR_UPDATES = new BoolSetting( qsTranslate("general", "Check for updates on startup"), @@ -38,8 +40,8 @@ class EnableLatex extends BoolSetting { set(value) { if(!value || Latex.checkLatexInstallation()) { super.set(value) - Modules.Latex.enabled = value - Modules.Canvas.requestPaint() + LatexAPI.enabled = value + Canvas.requestPaint() } } }