mirror of
https://github.com/qelectrotech/qelectrotech-source-mirror.git
synced 2026-10-05 02:24:13 +02:00
Script buttons: stored scripts become commands with an icon
Every .js file in the "scripts" folder of the user's data folder that starts with a // ==QETScript== header becomes a command: in Projet > Scripts, as a button on a new Scripts toolbar, and, because it is registered with ShortcutManager as diagrameditor.script.<file name>, in the shortcut settings, the shortcut bar (S) and command search. The header gives its name, icon (a file next to the script or a theme icon; a tile with its initials otherwise), tooltip, default shortcut and when it is enabled (always, with a selection, with a conductor selected). The folder is watched, so a script added, edited or deleted while QET is open appears, changes or goes without a restart. A file with a header that cannot be used gets no button; the Scripts menu lists it with the reason. The menu also opens the folder, and holds "Exécuter un script…". A click runs the script on the current project as one undo step named after it, and asks to switch scripting on first, like "Exécuter un script…" does: scripting stays off by default. ShortcutManager::unregisterAction() takes a command out of the lists when its script is deleted, and lets it come back under a new name. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
ispyisail
@@ -113,7 +113,8 @@ namespace {
|
||||
constexpr int kScriptTimeoutMs = 30000;
|
||||
}
|
||||
|
||||
bool runOnProject(const QString &scriptPath, QETProject *project, DiagramView *view)
|
||||
bool runOnProject(const QString &scriptPath, QETProject *project, DiagramView *view,
|
||||
const QString &title)
|
||||
{
|
||||
// Checked here as well as at each caller, deliberately: this is the
|
||||
// one function that actually evaluates JavaScript, so it is the one
|
||||
@@ -173,7 +174,8 @@ bool runOnProject(const QString &scriptPath, QETProject *project, DiagramView *v
|
||||
QUndoStack *stack = (view && project) ? project->undoStack() : nullptr;
|
||||
if (stack) {
|
||||
stack->beginMacro(QObject::tr("Script : %1")
|
||||
.arg(QFileInfo(scriptPath).completeBaseName()));
|
||||
.arg(title.isEmpty() ? QFileInfo(scriptPath).completeBaseName()
|
||||
: title));
|
||||
api->setUndoGrouped(true);
|
||||
}
|
||||
|
||||
@@ -229,7 +231,7 @@ int run(const QStringList &)
|
||||
return 1;
|
||||
}
|
||||
|
||||
bool runOnProject(const QString &, QETProject *, DiagramView *)
|
||||
bool runOnProject(const QString &, QETProject *, DiagramView *, const QString &)
|
||||
{
|
||||
err << "This build of QElectroTech was compiled without the Qt Qml "
|
||||
"module, so JavaScript scripting is not available.\n";
|
||||
|
||||
@@ -57,9 +57,12 @@ namespace QetScripting {
|
||||
@param view the active DiagramView, so the script's zoom methods
|
||||
have something to act on; nullptr from the headless entry point,
|
||||
where they become no-ops (see QetScriptApi).
|
||||
@param title what the undo step is called; the script's file name
|
||||
if empty.
|
||||
@return true if the script ran without throwing.
|
||||
*/
|
||||
bool runOnProject(const QString &scriptPath, QETProject *project, DiagramView *view = nullptr);
|
||||
bool runOnProject(const QString &scriptPath, QETProject *project, DiagramView *view = nullptr,
|
||||
const QString &title = QString());
|
||||
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,118 @@
|
||||
/*
|
||||
Copyright 2006-2026 The QElectroTech Team
|
||||
This file is part of QElectroTech.
|
||||
|
||||
QElectroTech 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 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
QElectroTech 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 QElectroTech. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
#ifndef SCRIPTHEADER_H
|
||||
#define SCRIPTHEADER_H
|
||||
|
||||
#include <QRegularExpression>
|
||||
#include <QString>
|
||||
#include <QStringList>
|
||||
|
||||
/**
|
||||
@brief The ScriptHeader struct
|
||||
How a stored script's button looks, read from a comment block at the top
|
||||
of the .js file itself, so one file is all there is to write by hand,
|
||||
to share, or for an assistant to create:
|
||||
|
||||
@code
|
||||
// ==QETScript==
|
||||
// @name Add revision note
|
||||
// @icon note.svg (a file next to the script, or builtin:<theme icon>)
|
||||
// @tooltip Puts a "Rev A" note on the folio on screen
|
||||
// @shortcut Ctrl+Alt+R
|
||||
// @context canvas (canvas, selection or conductor)
|
||||
// @api 1
|
||||
// ==/QETScript==
|
||||
@endcode
|
||||
|
||||
Only @name is required. An unknown key is an error rather than ignored:
|
||||
a misspelt "@shortcut" that silently did nothing would be harder to find
|
||||
than a script refused with the line that is wrong.
|
||||
|
||||
Header-only, with no QElectroTech dependency, so it is tested on its own.
|
||||
*/
|
||||
struct ScriptHeader
|
||||
{
|
||||
QString id; ///< file name without .js; the action id is diagrameditor.script.<id>
|
||||
QString name;
|
||||
QString icon;
|
||||
QString tooltip;
|
||||
QString shortcut; ///< as QKeySequence::fromString() reads it
|
||||
QString context = QStringLiteral("canvas");
|
||||
int api = 1;
|
||||
QString error; ///< empty if the header is usable
|
||||
|
||||
bool isValid() const { return error.isEmpty(); }
|
||||
|
||||
static QStringList contexts()
|
||||
{
|
||||
return {QStringLiteral("canvas"), QStringLiteral("selection"),
|
||||
QStringLiteral("conductor")};
|
||||
}
|
||||
|
||||
/**
|
||||
@brief parse
|
||||
@param text : the whole script
|
||||
@param id : the script's file name without its extension
|
||||
*/
|
||||
static ScriptHeader parse(const QString &text, const QString &id)
|
||||
{
|
||||
ScriptHeader h;
|
||||
h.id = id;
|
||||
static const QRegularExpression block(
|
||||
QStringLiteral("//\\s*==QETScript==\\s*\\n(.*?)//\\s*==/QETScript=="),
|
||||
QRegularExpression::DotMatchesEverythingOption);
|
||||
const QRegularExpressionMatch m = block.match(text);
|
||||
if (!m.hasMatch()) {
|
||||
h.error = QStringLiteral("no // ==QETScript== header");
|
||||
return h;
|
||||
}
|
||||
static const QRegularExpression line_re(
|
||||
QStringLiteral("^\\s*//\\s*@(\\w+)\\s+(.*?)\\s*$"));
|
||||
const QStringList lines = m.captured(1).split(QLatin1Char('\n'));
|
||||
for (const QString &line : lines) {
|
||||
const QRegularExpressionMatch lm = line_re.match(line);
|
||||
if (!lm.hasMatch()) {
|
||||
continue;
|
||||
}
|
||||
const QString key = lm.captured(1);
|
||||
const QString value = lm.captured(2);
|
||||
if (key == QLatin1String("name")) h.name = value;
|
||||
else if (key == QLatin1String("icon")) h.icon = value;
|
||||
else if (key == QLatin1String("tooltip")) h.tooltip = value;
|
||||
else if (key == QLatin1String("shortcut")) h.shortcut = value;
|
||||
else if (key == QLatin1String("context")) h.context = value;
|
||||
else if (key == QLatin1String("api")) h.api = value.toInt();
|
||||
else {
|
||||
h.error = QStringLiteral("unknown header key @%1").arg(key);
|
||||
return h;
|
||||
}
|
||||
}
|
||||
if (h.name.isEmpty()) {
|
||||
h.error = QStringLiteral("@name is required");
|
||||
} else if (!contexts().contains(h.context)) {
|
||||
h.error = QStringLiteral("@context must be one of: %1")
|
||||
.arg(contexts().join(QStringLiteral(", ")));
|
||||
} else if (h.api != 1) {
|
||||
h.error = QStringLiteral("@api %1 is not supported by this "
|
||||
"version (1 is)").arg(h.api);
|
||||
}
|
||||
return h;
|
||||
}
|
||||
};
|
||||
|
||||
#endif // SCRIPTHEADER_H
|
||||
@@ -0,0 +1,194 @@
|
||||
/*
|
||||
Copyright 2006-2026 The QElectroTech Team
|
||||
This file is part of QElectroTech.
|
||||
|
||||
QElectroTech 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 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
QElectroTech 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 QElectroTech. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
#include "scriptlibrary.h"
|
||||
|
||||
#include "../qetapp.h"
|
||||
|
||||
#include <QDir>
|
||||
#include <QFile>
|
||||
#include <QFileInfo>
|
||||
#include <QGuiApplication>
|
||||
#include <QPainter>
|
||||
#include <QPalette>
|
||||
#include <QPixmap>
|
||||
|
||||
ScriptLibrary &ScriptLibrary::instance()
|
||||
{
|
||||
static ScriptLibrary library;
|
||||
return library;
|
||||
}
|
||||
|
||||
/**
|
||||
@brief ScriptLibrary::folder
|
||||
Where stored scripts live: "scripts" in the user's data folder, next to
|
||||
the user's own element and title block collections.
|
||||
*/
|
||||
QString ScriptLibrary::folder()
|
||||
{
|
||||
return QETApp::dataDir() + QStringLiteral("/scripts");
|
||||
}
|
||||
|
||||
/**
|
||||
@brief ScriptLibrary::actionId
|
||||
The ShortcutManager id of a script's action. The "diagrameditor."
|
||||
prefix is what puts it among the commands the shortcut bar can show.
|
||||
*/
|
||||
QString ScriptLibrary::actionId(const QString &script_id)
|
||||
{
|
||||
return QStringLiteral("diagrameditor.script.") + script_id;
|
||||
}
|
||||
|
||||
ScriptLibrary::ScriptLibrary()
|
||||
{
|
||||
//An editor saving a file often writes it more than once, or
|
||||
//replaces it through a rename: wait for it to settle.
|
||||
m_rescan_timer.setSingleShot(true);
|
||||
m_rescan_timer.setInterval(250);
|
||||
connect(&m_rescan_timer, &QTimer::timeout, this, &ScriptLibrary::rescan);
|
||||
connect(&m_watcher, &QFileSystemWatcher::directoryChanged,
|
||||
&m_rescan_timer, qOverload<>(&QTimer::start));
|
||||
connect(&m_watcher, &QFileSystemWatcher::fileChanged,
|
||||
&m_rescan_timer, qOverload<>(&QTimer::start));
|
||||
rescan();
|
||||
}
|
||||
|
||||
/**
|
||||
@brief ScriptLibrary::watch
|
||||
Watch the folder and each script in it, or, while the folder does not
|
||||
exist yet, the data folder it will be created in.
|
||||
*/
|
||||
void ScriptLibrary::watch()
|
||||
{
|
||||
if (!m_watcher.files().isEmpty()) m_watcher.removePaths(m_watcher.files());
|
||||
if (!m_watcher.directories().isEmpty()) m_watcher.removePaths(m_watcher.directories());
|
||||
|
||||
const QDir dir(folder());
|
||||
if (!dir.exists()) {
|
||||
if (QFileInfo::exists(QETApp::dataDir())) {
|
||||
m_watcher.addPath(QETApp::dataDir());
|
||||
}
|
||||
return;
|
||||
}
|
||||
m_watcher.addPath(dir.path());
|
||||
QStringList files;
|
||||
for (const Script &s : std::as_const(m_scripts)) files << s.path;
|
||||
for (const QString &e : std::as_const(m_errors)) files << dir.filePath(e.section(QLatin1Char(':'), 0, 0));
|
||||
if (!files.isEmpty()) m_watcher.addPaths(files);
|
||||
}
|
||||
|
||||
void ScriptLibrary::rescan()
|
||||
{
|
||||
QList<Script> scripts;
|
||||
QStringList errors;
|
||||
const QDir dir(folder());
|
||||
const QFileInfoList infos = dir.entryInfoList({QStringLiteral("*.js")},
|
||||
QDir::Files, QDir::Name);
|
||||
for (const QFileInfo &info : infos) {
|
||||
QFile file(info.filePath());
|
||||
if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) continue;
|
||||
const ScriptHeader header = ScriptHeader::parse(
|
||||
QString::fromUtf8(file.readAll()), info.completeBaseName());
|
||||
if (header.isValid()) {
|
||||
scripts << Script{header, info.filePath()};
|
||||
} else {
|
||||
errors << info.fileName() + QStringLiteral(": ") + header.error;
|
||||
}
|
||||
}
|
||||
|
||||
auto signature = [](const QList<Script> &list) {
|
||||
QStringList parts;
|
||||
for (const Script &s : list) {
|
||||
const ScriptHeader &h = s.header;
|
||||
parts << QStringList{s.path, h.name, h.icon, h.tooltip, h.shortcut,
|
||||
h.context}.join(QLatin1Char('\x1f'));
|
||||
}
|
||||
return parts;
|
||||
};
|
||||
const bool same = signature(scripts) == signature(m_scripts) && errors == m_errors;
|
||||
m_scripts = scripts;
|
||||
m_errors = errors;
|
||||
watch();
|
||||
//The script's own text is read again on every run, so only a
|
||||
//change to what its button shows needs the actions rebuilt --
|
||||
//except an icon file edited in place, which this cannot see; the
|
||||
//next change to the folder picks it up.
|
||||
if (!same) emit changed();
|
||||
}
|
||||
|
||||
QList<ScriptLibrary::Script> ScriptLibrary::scripts() const
|
||||
{
|
||||
return m_scripts;
|
||||
}
|
||||
|
||||
/**
|
||||
@brief ScriptLibrary::errors
|
||||
One "file.js: reason" per script whose header could not be used, so
|
||||
whoever wrote it can be told why its button is missing.
|
||||
*/
|
||||
QStringList ScriptLibrary::errors() const
|
||||
{
|
||||
return m_errors;
|
||||
}
|
||||
|
||||
/**
|
||||
@brief ScriptLibrary::icon
|
||||
The icon a script's header names -- "builtin:<name>" from the icon
|
||||
theme, or an image file, relative to the script -- or, failing that, a
|
||||
tile with the script's initials, so every button can be told apart.
|
||||
*/
|
||||
QIcon ScriptLibrary::icon(const Script &script)
|
||||
{
|
||||
const QString spec = script.header.icon;
|
||||
if (spec.startsWith(QLatin1String("builtin:"))) {
|
||||
const QIcon themed = QIcon::fromTheme(spec.mid(8));
|
||||
if (!themed.isNull()) return themed;
|
||||
} else if (!spec.isEmpty()) {
|
||||
const QString path = QFileInfo(script.path).dir().absoluteFilePath(spec);
|
||||
if (QFileInfo::exists(path)) {
|
||||
const QIcon file_icon(path);
|
||||
if (!file_icon.availableSizes().isEmpty()
|
||||
|| !file_icon.pixmap(32).isNull()) {
|
||||
return file_icon;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
QString initials;
|
||||
for (const QString &word : script.header.name.split(QLatin1Char(' '), Qt::SkipEmptyParts)) {
|
||||
if (word.at(0).isLetterOrNumber()) initials += word.at(0).toUpper();
|
||||
if (initials.size() == 2) break;
|
||||
}
|
||||
if (initials.isEmpty()) initials = QStringLiteral("JS");
|
||||
|
||||
const QPalette palette = QGuiApplication::palette();
|
||||
QPixmap pixmap(64, 64);
|
||||
pixmap.fill(Qt::transparent);
|
||||
QPainter painter(&pixmap);
|
||||
painter.setRenderHint(QPainter::Antialiasing);
|
||||
painter.setPen(Qt::NoPen);
|
||||
painter.setBrush(palette.color(QPalette::Highlight));
|
||||
painter.drawRoundedRect(QRectF(4, 4, 56, 56), 10, 10);
|
||||
QFont font = painter.font();
|
||||
font.setBold(true);
|
||||
font.setPixelSize(initials.size() == 1 ? 34 : 26);
|
||||
painter.setFont(font);
|
||||
painter.setPen(palette.color(QPalette::HighlightedText));
|
||||
painter.drawText(QRectF(4, 4, 56, 56), Qt::AlignCenter, initials);
|
||||
painter.end();
|
||||
return QIcon(pixmap);
|
||||
}
|
||||
@@ -0,0 +1,72 @@
|
||||
/*
|
||||
Copyright 2006-2026 The QElectroTech Team
|
||||
This file is part of QElectroTech.
|
||||
|
||||
QElectroTech 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 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
QElectroTech 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 QElectroTech. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
#ifndef SCRIPTLIBRARY_H
|
||||
#define SCRIPTLIBRARY_H
|
||||
|
||||
#include "scriptheader.h"
|
||||
|
||||
#include <QFileSystemWatcher>
|
||||
#include <QIcon>
|
||||
#include <QList>
|
||||
#include <QObject>
|
||||
#include <QTimer>
|
||||
|
||||
/**
|
||||
@brief The ScriptLibrary class
|
||||
The user's stored scripts: every .js file with a ScriptHeader in
|
||||
folder(). The folder is the whole interface. A script written by hand
|
||||
in any editor, one saved by the script manager and one installed by an
|
||||
assistant through the qet MCP server all arrive the same way, as a file,
|
||||
and the library notices it with a QFileSystemWatcher and emits changed().
|
||||
|
||||
One instance for the application, shared by every editor window.
|
||||
*/
|
||||
class ScriptLibrary : public QObject
|
||||
{
|
||||
Q_OBJECT
|
||||
|
||||
public:
|
||||
struct Script
|
||||
{
|
||||
ScriptHeader header;
|
||||
QString path;
|
||||
};
|
||||
|
||||
static ScriptLibrary &instance();
|
||||
static QString folder();
|
||||
static QString actionId(const QString &script_id);
|
||||
static QIcon icon(const Script &script);
|
||||
|
||||
QList<Script> scripts() const;
|
||||
QStringList errors() const;
|
||||
|
||||
signals:
|
||||
void changed();
|
||||
|
||||
private:
|
||||
ScriptLibrary();
|
||||
void rescan();
|
||||
void watch();
|
||||
|
||||
QFileSystemWatcher m_watcher;
|
||||
QTimer m_rescan_timer;
|
||||
QList<Script> m_scripts;
|
||||
QStringList m_errors;
|
||||
};
|
||||
|
||||
#endif // SCRIPTLIBRARY_H
|
||||
Reference in New Issue
Block a user