Removing usage of "Modules" to refer to modules in JavaScript (using imports instead)

This commit is contained in:
Ad5001 2024-09-22 19:35:40 +02:00
parent a88be86350
commit a4e9ad7f5a
Signed by: Ad5001
GPG key ID: EF45F9C6AFE20160
10 changed files with 139 additions and 109 deletions

View file

@ -20,6 +20,8 @@ import { Module } from "./modules.mjs"
import { textsup } from "./utils.mjs" import { textsup } from "./utils.mjs"
import { Expression } from "./mathlib.mjs" import { Expression } from "./mathlib.mjs"
import Latex from "./math/latex.mjs" import Latex from "./math/latex.mjs"
import Objects from "./objects.mjs"
import History from "./history/module.mjs"
class CanvasAPI extends Module { class CanvasAPI extends Module {
@ -168,8 +170,8 @@ class CanvasAPI extends Module {
this._drawAxes() this._drawAxes()
this._drawLabels() this._drawLabels()
this._ctx.lineWidth = this.linewidth this._ctx.lineWidth = this.linewidth
for(let objType in Modules.Objects.currentObjects) { for(let objType in Objects.currentObjects) {
for(let obj of Modules.Objects.currentObjects[objType]){ for(let obj of Objects.currentObjects[objType]){
this._ctx.strokeStyle = obj.color this._ctx.strokeStyle = obj.color
this._ctx.fillStyle = obj.color this._ctx.fillStyle = obj.color
if(obj.visible) if(obj.visible)
@ -180,7 +182,7 @@ class CanvasAPI extends Module {
console.error(e) console.error(e)
console.log(e.stack) console.log(e.stack)
this._drawingErrorDialog.showDialog(objType, obj.name, e.message) 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 * @private
*/ */
_computeAxes() { _computeAxes() {
@ -538,4 +540,4 @@ class CanvasAPI extends Module {
/** @type {CanvasAPI} */ /** @type {CanvasAPI} */
Modules.Canvas = Modules.Canvas || new CanvasAPI() Modules.Canvas = Modules.Canvas || new CanvasAPI()
export const API = Modules.Canvas export default Modules.Canvas

View file

@ -16,35 +16,9 @@
* along with this program. If not, see <https://www.gnu.org/licenses/>. * along with this program. If not, see <https://www.gnu.org/licenses/>.
*/ */
import { Module } from "../modules.mjs" import History from "./module.mjs"
import Latex from "../math/latex.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 { export class Action {
/** /**
* Type of the action. * Type of the action.
@ -102,7 +76,7 @@ export class Action {
* @returns {string} * @returns {string}
*/ */
getIconRichText(type) { getIconRichText(type) {
return `<img source="../icons/objects/${type}.svg" style="color: ${Modules.History.themeTextColor};" width=18 height=18></img>` return `<img source="../icons/objects/${type}.svg" style="color: ${History.themeTextColor};" width=18 height=18></img>`
} }
/** /**
@ -115,11 +89,11 @@ export class Action {
if(!Latex.enabled) if(!Latex.enabled)
throw new Error("Cannot render an item as LaTeX when LaTeX is disabled.") throw new Error("Cannot render an item as LaTeX when LaTeX is disabled.")
return new Promise(resolve => { return new Promise(resolve => {
let imgDepth = Modules.History.imageDepth let imgDepth = History.imageDepth
Latex.requestAsyncRender( Latex.requestAsyncRender(
latexString, latexString,
imgDepth * (Modules.History.fontSize + 2), imgDepth * (History.fontSize + 2),
Modules.History.themeTextColor History.themeTextColor
).then((imgData) => { ).then((imgData) => {
const { source, width, height } = imgData const { source, width, height } = imgData
resolve(`<img src="${source}" width="${width/imgDepth}" height="${height/imgDepth}" style="vertical-align: middle"/>`) resolve(`<img src="${source}" width="${width/imgDepth}" height="${height/imgDepth}" style="vertical-align: middle"/>`)

View file

@ -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 <https://www.gnu.org/licenses/>.
*/
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

View file

@ -16,12 +16,15 @@
* along with this program. If not, see <https://www.gnu.org/licenses/>. * along with this program. If not, see <https://www.gnu.org/licenses/>.
*/ */
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 { class IOAPI extends Module {
constructor() { constructor() {
super('IO', [ super("IO", [
Modules.Objects, Modules.Objects,
Modules.History Modules.History
]) ])
@ -50,13 +53,13 @@ class IOAPI extends Module {
*/ */
saveDiagram(filename) { saveDiagram(filename) {
// Add extension if necessary // Add extension if necessary
if(['lpf'].indexOf(filename.split('.')[filename.split('.').length-1]) === -1) if(["lpf"].indexOf(filename.split(".")[filename.split(".").length - 1]) === -1)
filename += '.lpf' filename += ".lpf"
this.saveFilename = filename this.saveFilename = filename
let objs = {} let objs = {}
for(let objType in Modules.Objects.currentObjects){ for(let objType in Objects.currentObjects) {
objs[objType] = [] objs[objType] = []
for(let obj of Modules.Objects.currentObjects[objType]) { for(let obj of Objects.currentObjects[objType]) {
objs[objType].push(obj.export()) objs[objType].push(obj.export())
} }
} }
@ -74,15 +77,15 @@ class IOAPI extends Module {
"showxgrad": this.settings.showxgrad, "showxgrad": this.settings.showxgrad,
"showygrad": this.settings.showygrad, "showygrad": this.settings.showygrad,
"textsize": this.settings.textsize, "textsize": this.settings.textsize,
"history": Modules.History.serialize(), "history": History.serialize(),
"width": this.rootElement.width, "width": this.rootElement.width,
"height": this.rootElement.height, "height": this.rootElement.height,
"objects": objs, "objects": objs,
"type": "logplotv1" "type": "logplotv1"
} }
Helper.write(filename, JSON.stringify(settings)) Helper.write(filename, JSON.stringify(settings))
this.alert.show(qsTranslate('io', "Saved plot to '%1'.").arg(filename.split("/").pop())) this.alert.show(qsTranslate("io", "Saved plot to '%1'.").arg(filename.split("/").pop()))
Modules.History.history.saved = true History.history.saved = true
} }
/** /**
@ -91,16 +94,16 @@ class IOAPI extends Module {
*/ */
loadDiagram(filename) { loadDiagram(filename) {
let basename = filename.split("/").pop() 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 data = JSON.parse(Helper.load(filename))
let error = ""; let error = ""
if(Object.keys(data).includes("type") && data["type"] === "logplotv1") { if(Object.keys(data).includes("type") && data["type"] === "logplotv1") {
Modules.History.clear() History.clear()
// Importing settings // Importing settings
this.settings.saveFilename = filename this.settings.saveFilename = filename
this.settings.xzoom = parseFloat(data["xzoom"]) || 100 this.settings.xzoom = parseFloat(data["xzoom"]) || 100
this.settings.yzoom = parseFloat(data["yzoom"]) || 10 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.ymax = parseFloat(data["ymax"]) || 24
this.settings.xaxisstep = data["xaxisstep"] || "4" this.settings.xaxisstep = data["xaxisstep"] || "4"
this.settings.yaxisstep = data["yaxisstep"] || "4" this.settings.yaxisstep = data["yaxisstep"] || "4"
@ -119,51 +122,53 @@ class IOAPI extends Module {
this.rootElement.width = parseFloat(data["width"]) || 1000 this.rootElement.width = parseFloat(data["width"]) || 1000
// Importing objects // Importing objects
Modules.Objects.currentObjects = {} Objects.currentObjects = {}
for(let key of Object.keys(Modules.Objects.currentObjectsByName)) { for(let key of Object.keys(Objects.currentObjectsByName)) {
delete Modules.Objects.currentObjectsByName[key]; delete Objects.currentObjectsByName[key]
// Required to keep the same reference for the copy of the object used in expression variable detection. // 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. // 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']) { for(let objType in data["objects"]) {
if(Object.keys(Modules.Objects.types).indexOf(objType) > -1) { if(Object.keys(Objects.types).indexOf(objType) > -1) {
Modules.Objects.currentObjects[objType] = [] Objects.currentObjects[objType] = []
for(let objData of data['objects'][objType]) { for(let objData of data["objects"][objType]) {
/** @type {DrawableObject} */ /** @type {DrawableObject} */
let obj = Modules.Objects.types[objType].import(...objData) let obj = Objects.types[objType].import(...objData)
Modules.Objects.currentObjects[objType].push(obj) Objects.currentObjects[objType].push(obj)
Modules.Objects.currentObjectsByName[obj.name] = obj Objects.currentObjectsByName[obj.name] = obj
} }
} else { } else {
error += qsTranslate('io', "Unknown object type: %1.").arg(objType) + "\n"; error += qsTranslate("io", "Unknown object type: %1.").arg(objType) + "\n"
} }
} }
// Updating object dependencies. // Updating object dependencies.
for(let objName in Modules.Objects.currentObjectsByName) for(let objName in Objects.currentObjectsByName)
Modules.Objects.currentObjectsByName[objName].update() Objects.currentObjectsByName[objName].update()
// Importing history // Importing history
if("history" in data) if("history" in data)
Modules.History.unserialize(...data["history"]) History.unserialize(...data["history"])
// Refreshing sidebar // Refreshing sidebar
this.rootElement.updateObjectsLists() this.rootElement.updateObjectsLists()
} else { } else {
error = qsTranslate('io', "Invalid file provided.") error = qsTranslate("io", "Invalid file provided.")
} }
if(error !== "") { if(error !== "") {
console.log(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 // TODO: Error handling
return return
} }
Modules.Canvas.redraw() Canvas.redraw()
this.alert.show(qsTranslate('io', "Loaded file '%1'.").arg(basename)) this.alert.show(qsTranslate("io", "Loaded file '%1'.").arg(basename))
Modules.History.history.saved = true History.history.saved = true
} }
} }
/** @type {IOAPI} */ /** @type {IOAPI} */
Modules.IO = Modules.IO || new IOAPI() Modules.IO = Modules.IO || new IOAPI()
export default Modules.IO

View file

@ -112,5 +112,5 @@ export class ExprParserAPI extends Module {
/** @type {ExprParserAPI} */ /** @type {ExprParserAPI} */
Modules.ExprParser = Modules.ExprParser || new ExprParserAPI() Modules.ExprParser = Modules.ExprParser || new ExprParserAPI()
export default Modules.ExprParser

View file

@ -19,19 +19,17 @@
import Latex from "latex.mjs" import Latex from "latex.mjs"
import * as Utils from "../utils.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. * Represents any kind of x-based or non variable based expression.
*/ */
export class Expression { export class Expression {
constructor(expr) { 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") { if(typeof expr === "string") {
this.expr = Utils.exponentsToExpression(expr) this.expr = Utils.exponentsToExpression(expr)
this.calc = Modules.ExprParser.parse(this.expr).simplify() this.calc = ExprParser.parse(this.expr).simplify()
} else { } else {
// Passed an expression here directly. // Passed an expression here directly.
this.calc = expr.simplify() this.calc = expr.simplify()
@ -40,7 +38,7 @@ export class Expression {
this.cached = this.isConstant() this.cached = this.isConstant()
this.cachedValue = null this.cachedValue = null
if(this.cached && this.allRequirementsFullfilled()) 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) this.latexMarkup = Latex.expression(this.calc.tokens)
} }
@ -54,26 +52,26 @@ export class Expression {
} }
allRequirementsFullfilled() { allRequirementsFullfilled() {
return this.requiredObjects().every(objName => objName in Modules.Objects.currentObjectsByName) return this.requiredObjects().every(objName => objName in Objects.currentObjectsByName)
} }
undefinedVariables() { undefinedVariables() {
return this.requiredObjects().filter(objName => !(objName in Modules.Objects.currentObjectsByName)) return this.requiredObjects().filter(objName => !(objName in Objects.currentObjectsByName))
} }
recache() { recache() {
if(this.cached) if(this.cached)
this.cachedValue = this.calc.evaluate(Modules.Objects.currentObjectsByName) this.cachedValue = this.calc.evaluate(Objects.currentObjectsByName)
} }
execute(x = 1) { execute(x = 1) {
if(this.cached) { if(this.cached) {
if(this.cachedValue == null) if(this.cachedValue == null)
this.cachedValue = this.calc.evaluate(Modules.Objects.currentObjectsByName) this.cachedValue = this.calc.evaluate(Objects.currentObjectsByName)
return this.cachedValue return this.cachedValue
} }
Modules.ExprParser.currentVars = Object.assign({'x': x}, Modules.Objects.currentObjectsByName) ExprParser.currentVars = Object.assign({'x': x}, Objects.currentObjectsByName)
return this.calc.evaluate(Modules.ExprParser.currentVars) return this.calc.evaluate(ExprParser.currentVars)
} }
simplify(x) { simplify(x) {

View file

@ -18,7 +18,9 @@
import * as Expr from "expression.mjs" import * as Expr from "expression.mjs"
import * as Utils from "../utils.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. * Represents mathematical object for sequences.
@ -33,7 +35,7 @@ export class Sequence extends Expr.Expression {
this.latexValues = Object.assign({}, baseValues) this.latexValues = Object.assign({}, baseValues)
for(let n in this.calcValues) for(let n in this.calcValues)
if(['string', 'number'].includes(typeof this.calcValues[n])) { 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.latexValues[n] = Latex.expression(parsed.tokens)
this.calcValues[n] = parsed.evaluate() this.calcValues[n] = parsed.evaluate()
} }
@ -59,17 +61,17 @@ export class Sequence extends Expr.Expression {
cache(n = 1) { cache(n = 1) {
let str = Utils.simplifyExpression(this.calc.substitute('n', n-this.valuePlus).toString()) 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. // Cache values required for this one.
if(!this.calcValues[n-this.valuePlus] && n-this.valuePlus > 0) if(!this.calcValues[n-this.valuePlus] && n-this.valuePlus > 0)
this.cache(n-this.valuePlus) this.cache(n-this.valuePlus)
// Setting current variables // Setting current variables
Modules.ExprParser.currentVars = Object.assign( ExprParser.currentVars = Object.assign(
{'n': n-this.valuePlus}, // Just in case, add n (for custom functions) {'n': n-this.valuePlus}, // Just in case, add n (for custom functions)
Modules.Objects.currentObjectsByName, Objects.currentObjectsByName,
{[this.name]: this.calcValues} {[this.name]: this.calcValues}
) )
this.calcValues[n] = expr.evaluate(Modules.ExprParser.currentVars) this.calcValues[n] = expr.evaluate(ExprParser.currentVars)
} }
toString(forceSign=false) { toString(forceSign=false) {

View file

@ -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(Point)
registerObject(Text) registerObject(Text)
registerObject(Function) registerObject(Function)

View file

@ -16,6 +16,7 @@
* along with this program. If not, see <https://www.gnu.org/licenses/>. * along with this program. If not, see <https://www.gnu.org/licenses/>.
*/ */
import {parseDomain, Expression as Expr, Domain} from "./mathlib.mjs" import {parseDomain, Expression as Expr, Domain} from "./mathlib.mjs"
import { Objects } from "./objects.mjs"
const NONE = class Empty {} const NONE = class Empty {}
@ -129,8 +130,8 @@ export class ObjectType extends PropertyType {
parse(name) { parse(name) {
let result = NONE let result = NONE
if(typeof name == 'string' && name in Modules.Objects.currentObjectsByName) { if(typeof name == 'string' && name in Objects.currentObjectsByName) {
let obj = Modules.Objects.currentObjectsByName[name] let obj = Objects.currentObjectsByName[name]
if (obj.type === this.objType || (this.objType === 'ExecutableObject' && obj.execute)) { if (obj.type === this.objType || (this.objType === 'ExecutableObject' && obj.execute)) {
result = obj result = obj
} else { } else {

View file

@ -17,6 +17,8 @@
*/ */
import {BoolSetting} from "common.mjs" import {BoolSetting} from "common.mjs"
import Canvas from "../canvas.mjs"
import LatexAPI from "../math/latex.mjs"
const CHECK_FOR_UPDATES = new BoolSetting( const CHECK_FOR_UPDATES = new BoolSetting(
qsTranslate("general", "Check for updates on startup"), qsTranslate("general", "Check for updates on startup"),
@ -38,8 +40,8 @@ class EnableLatex extends BoolSetting {
set(value) { set(value) {
if(!value || Latex.checkLatexInstallation()) { if(!value || Latex.checkLatexInstallation()) {
super.set(value) super.set(value)
Modules.Latex.enabled = value LatexAPI.enabled = value
Modules.Canvas.requestPaint() Canvas.requestPaint()
} }
} }
} }