Improve script generation and execution

Author: serhmarch

doc/README.md

@@ -46,6 +46,12 @@ c:\Qt\5.15.2\msvc2019_64\bin>qhelpgenerator "path\to\ModbusTools\doc\output\Modb
 c:\Qt\5.15.2\msvc2019_64\bin>qhelpgenerator "path\to\ModbusTools\doc\output\ModbusServer.qhcp"
 ```
 
+To check correctness of help generation Qt assistant can be used:
+```console
+c:\Qt\5.15.2\msvc2019_64\bin>assistant -collectionFile ModbusClient.qhc
+c:\Qt\5.15.2\msvc2019_64\bin>assistant -collectionFile ModbusServer.qhc
+```
+
 # File System with help
 
 Assumed application dir view:

src/client/client.pro

@@ -6,7 +6,7 @@ CONFIG += no_keywords
 
 DESTDIR  = ../../bin
 
-QT = core gui widgets xml
+QT = core gui widgets
 
 unix:QMAKE_RPATHDIR += .
 

src/core/core.pro

@@ -6,7 +6,7 @@ CONFIG += no_keywords
 
 DESTDIR = ../../bin
 
-QT = core gui widgets xml help
+QT = core gui widgets help
 
 DEFINES += MB_EXPORTS
 

src/core/core/core_filemanager.cpp

@@ -2,7 +2,6 @@
 
 #include <QFile>
 #include <QDir>
-#include <QDomDocument>
 #include <QUuid>
 #include <QTextStream>
 
@@ -12,10 +11,9 @@ mbCoreFileManager::Strings::Strings() :
     dirname_mbtools  (QStringLiteral(".mbtools")),
     dirname_project  (QStringLiteral("project" )),
     dirname_temporary(QStringLiteral("tmp")),
-    filename_projects(QStringLiteral("projects.xml")),
+    filename_projects(QStringLiteral("projects.conf")),
     filename_files   (QStringLiteral("files.xml")),
-    dom_projects     (QStringLiteral("projects")),
-    dom_project      (QStringLiteral("project"))
+    id_path          (QStringLiteral("path"))
 {
 }
 
@@ -29,6 +27,7 @@ mbCoreFileManager::mbCoreFileManager(mbCore *core, QObject *parent) : QObject{pa
     m_core (core)
 {
     m_project = nullptr;
+    m_settings = nullptr;
 
     checkAndCreateHiddenFolder();
     connect(m_core, &mbCore::projectChanged, this, &mbCoreFileManager::setProject);
@@ -54,11 +53,11 @@ bool mbCoreFileManager::getOrCreateHiddenFile(const QString &fileName, QFile &fi
 {
     QString sFileName = m_currentProjectDir.filePath(fileName);
     file.setFileName(sFileName);
+    if (m_project->isModified())
+        return false;
     QFileInfo info(file);
-    if (m_project->isModified() || !file.exists() || (info.lastModified() < m_project->fileModified()))
-    {
+    if (!file.exists() || (info.lastModified() < m_project->fileModified()))
         return file.open(QIODevice::WriteOnly);
-    }
     return file.open(mode);
 }
 
@@ -164,83 +163,37 @@ QList<mbCoreFileManager::ProjectInfo*> mbCoreFileManager::parseProjects()
 {
     const Strings &s = Strings::instance();
     QList<ProjectInfo*> projects;
-
-    QString filePath = m_hiddenProjectsDir.absoluteFilePath(s.filename_projects);
-    QFile file(filePath);
-    if (!file.open(QIODevice::ReadOnly | QIODevice::Text))
+    QSettings *conf = getQSettings();
+    Q_FOREACH (const QString &id, conf->childGroups())
     {
-        //qWarning() << "Failed to open file:" << filePath;
-        return projects;
-    }
-
-    QDomDocument doc;
-    if (!doc.setContent(&file))
-    {
-        //qWarning() << "Failed to parse XML file.";
-        file.close();
-        return projects;
-    }
-    file.close();
-
-    QDomElement root = doc.documentElement();
-    if (root.tagName() != s.dom_projects)
-    {
-        //qWarning() << "Invalid root element in XML.";
-        return projects;
-    }
-
-    QDomNodeList projectNodes = root.elementsByTagName(s.dom_project);
-    for (int i = 0; i < projectNodes.size(); ++i)
-    {
-        QDomElement projectElement = projectNodes.at(i).toElement();
-        if (!projectElement.isNull())
+        conf->beginGroup(id);
+        QString absPath = conf->value(s.id_path).toString();
+        conf->endGroup();
+        if (!id.isEmpty() && !absPath.isEmpty())
         {
-            QString id = projectElement.attribute("dir");
-            QString absPath = projectElement.text();
-            if (!id.isEmpty() && !absPath.isEmpty())
-            {
-                ProjectInfo *info = new ProjectInfo;
-                info->id = id;
-                info->absPath = absPath;
-                projects.append(info);
-            }
+            ProjectInfo *info = new ProjectInfo;
+            info->id = id;
+            info->absPath = absPath;
+            projects.append(info);
         }
     }
-
     return projects;
 }
 
 bool mbCoreFileManager::saveProjects(const QList<ProjectInfo*> &projects)
 {
     const Strings &s = Strings::instance();
-    QString filePath = m_hiddenProjectsDir.absoluteFilePath(s.filename_projects);
-    QDomDocument doc;
-
-    QDomElement root = doc.createElement(s.dom_projects);
-    doc.appendChild(root);
-
-    Q_FOREACH (ProjectInfo *info, projects)
-    {
-        QDomElement projectElement = doc.createElement(s.dom_project);
-        projectElement.setAttribute("dir", info->id);
-        QDomText pathText = doc.createTextNode(info->absPath);
-        projectElement.appendChild(pathText);
-        root.appendChild(projectElement);
-    }
-
-    QFile file(filePath);
-    if (!file.open(QIODevice::WriteOnly | QIODevice::Text))
+    QSettings *conf = getQSettings();
+    conf->clear();
+    Q_FOREACH (const ProjectInfo *info, projects)
     {
-        //qWarning() << "Failed to open file for writing:" << filePath;
-        return false;
+        conf->beginGroup(info->id);
+        conf->setValue(s.id_path, info->absPath);
+        conf->endGroup();
     }
 
-    QTextStream stream(&file);
-    stream.setCodec("UTF-8");
-    doc.save(stream, 4);
-    file.close();
-
-    return true;}
+    return true;
+}
 
 void mbCoreFileManager::cleanupProjects(QList<ProjectInfo*> &projects)
 {
@@ -269,3 +222,15 @@ void mbCoreFileManager::addProjectInfo(ProjectInfo *info)
     m_projects.append(info);
     m_hashProjects.insert(info->absPath, info);
 }
+
+QSettings *mbCoreFileManager::getQSettings()
+{
+    if (!m_settings)
+    {
+        const Strings &s = Strings::instance();
+        QString filePath = m_hiddenProjectsDir.absoluteFilePath(s.filename_projects);
+        m_settings = new QSettings(filePath, QSettings::IniFormat, this);
+        m_settings->setIniCodec("UTF-8");
+    }
+    return m_settings;
+}

src/core/core/core_filemanager.h

@@ -5,6 +5,8 @@
 #include <QFile>
 #include <QDir>
 
+class QSettings;
+
 #include "core.h"
 
 class MB_EXPORT mbCoreFileManager : public QObject
@@ -27,13 +29,12 @@ class MB_EXPORT mbCoreFileManager : public QObject
 public:
     struct MB_EXPORT Strings
     {
-        const QString dirname_mbtools   ;
-        const QString dirname_project   ;
-        const QString dirname_temporary ;
-        const QString filename_projects ;
-        const QString filename_files    ;
-        const QString dom_projects      ;
-        const QString dom_project       ;
+        const QString dirname_mbtools  ;
+        const QString dirname_project  ;
+        const QString dirname_temporary;
+        const QString filename_projects;
+        const QString filename_files   ;
+        const QString id_path          ;
 
         Strings();
         static const Strings &instance();
@@ -64,6 +65,8 @@ protected Q_SLOTS:
 protected:
     inline ProjectInfo* projectInfo(const QString absFilePath) const { return m_hashProjects.value(absFilePath); }
     void addProjectInfo(ProjectInfo* info);
+    QSettings *getQSettings();
+
 
 protected:
     mbCore *m_core;
@@ -73,6 +76,7 @@ protected Q_SLOTS:
     QDir m_currentProjectDir;
     QList<ProjectInfo*> m_projects;
     QHash<QString, ProjectInfo*> m_hashProjects;
+    QSettings *m_settings;
 };
 
 #endif // CORE_FILEMANAGER_H

src/core/gui/help/core_helpui.cpp

@@ -63,7 +63,7 @@ mbCoreHelpUi::mbCoreHelpUi(const QString &relativeCollectionFile, QWidget *paren
 //#endif
 
     if (!m_helpEngine->setupData())
-        mbCore::LogError("HelpSystem", "HelpEngine is not setup");
+        mbCore::LogError("HelpSystem", "HelpEngine is not setup. Error: " + m_helpEngine->error());
 
     QTabWidget* tabWidget = new QTabWidget;
     tabWidget->addTab(m_helpEngine->contentWidget(), "Contents");

src/core/gui/icons/clear.png

@@ -27,6 +27,7 @@
 #include <QTableView>
 #include <QPlainTextEdit>
 #include <QToolBar>
+#include <QCoreApplication>
 
 #include <core.h>
 #include <gui/core_ui.h>
@@ -57,11 +58,13 @@ mbCoreLogView::mbCoreLogView(QWidget *parent)
 
     QAction *actionClear = new QAction(m_toolBar);
     actionClear->setIcon(QIcon(":/core/icons/clear.png"));
+    actionClear->setText(QCoreApplication::translate("mbCoreLogView", "Clear", nullptr));
     connect(actionClear, &QAction::triggered, this, &mbCoreLogView::clear);
     m_toolBar->addAction(actionClear);
 
     QAction *actionExportLog = new QAction(m_toolBar);
     actionExportLog->setIcon(QIcon(":/core/icons/logexport.png"));
+    actionExportLog->setText(QCoreApplication::translate("mbCoreLogView", "Export", nullptr));
     connect(actionExportLog, &QAction::triggered, this, &mbCoreLogView::exportLog);
     m_toolBar->addAction(actionExportLog);
 

src/core/gui/logview/core_logview.cpp

@@ -41,9 +41,10 @@ mbServer::Strings::Strings() : mbCore::Strings(),
     GUID(QStringLiteral("bcde38bb-2402-4b3f-9ddb-3abfd0986852")), // generated by https://www.guidgenerator.com/online-guid-generator.aspx
     settings_application(QStringLiteral("Server")),
     default_server(settings_application),
-    settings_scriptEnable (QStringLiteral("Script.Enable")),
-    settings_scriptManual (QStringLiteral("Script.Manual")),
-    settings_scriptDefault(QStringLiteral("Script.Default"))
+    settings_scriptEnable         (QStringLiteral("Script.Enable")),
+    settings_scriptUseOptimization(QStringLiteral("Script.UseOptimization")),
+    settings_scriptManual         (QStringLiteral("Script.Manual")),
+    settings_scriptDefault        (QStringLiteral("Script.DefaultInterpreter"))
 {
 }
 
@@ -134,6 +135,7 @@ mbServer::mbServer() :
 {
     //Strings s = Strings::instance();
     m_scriptEnable = true;
+    m_scriptUseOptimization = true;
     m_autoDetectedExec = findPythonExecutables();
 }
 
@@ -145,9 +147,10 @@ MBSETTINGS mbServer::cachedSettings() const
 {
     const Strings &s = Strings::instance();
     MBSETTINGS r = mbCore::cachedSettings();
-    r[s.settings_scriptEnable ] = scriptEnable();
-    r[s.settings_scriptManual ] = scriptManualExecutables();
-    r[s.settings_scriptDefault] = scriptDefaultExecutable();
+    r[s.settings_scriptEnable           ] = scriptEnable();
+    r[s.settings_scriptUseOptimization  ] = scriptUseOptimization();
+    r[s.settings_scriptManual           ] = scriptManualExecutables();
+    r[s.settings_scriptDefault          ] = scriptDefaultExecutable();
     return r;
 }
 
@@ -159,9 +162,10 @@ void mbServer::setCachedSettings(const MBSETTINGS &settings)
     MBSETTINGS::const_iterator it;
     MBSETTINGS::const_iterator end = settings.end();
 
-    it = settings.find(s.settings_scriptEnable ); if (it != end) setScriptEnable           (it.value().toBool      ());
-    it = settings.find(s.settings_scriptManual ); if (it != end) scriptSetManualExecutables(it.value().toStringList());
-    it = settings.find(s.settings_scriptDefault); if (it != end) scriptSetDefaultExecutable(it.value().toString    ());
+    it = settings.find(s.settings_scriptEnable          ); if (it != end) setScriptEnable           (it.value().toBool      ());
+    it = settings.find(s.settings_scriptUseOptimization ); if (it != end) setScriptUseOptimization  (it.value().toBool      ());
+    it = settings.find(s.settings_scriptManual          ); if (it != end) scriptSetManualExecutables(it.value().toStringList());
+    it = settings.find(s.settings_scriptDefault         ); if (it != end) scriptSetDefaultExecutable(it.value().toString    ());
 }
 
 QString mbServer::scriptDefaultExecutable() const

src/server/core/server.cpp

@@ -49,9 +49,10 @@ class mbServer : public mbCore
         const QString settings_application;
         const QString default_server;
 
-        const QString settings_scriptEnable ;
-        const QString settings_scriptManual ;
-        const QString settings_scriptDefault;
+        const QString settings_scriptEnable         ;
+        const QString settings_scriptUseOptimization;
+        const QString settings_scriptManual         ;
+        const QString settings_scriptDefault        ;
         Strings();
         static const Strings &instance();
     };
@@ -76,7 +77,9 @@ class mbServer : public mbCore
 
 public:
     inline bool scriptEnable() const { return m_scriptEnable; }
-    inline void setScriptEnable(bool use) { m_scriptEnable = use; }
+    inline void setScriptEnable(bool enable) { m_scriptEnable = enable; }
+    inline bool scriptUseOptimization() const { return m_scriptUseOptimization; }
+    inline void setScriptUseOptimization(bool use) { m_scriptUseOptimization = use; }
     inline QStringList scriptAutoDetectedExecutables() const { return m_autoDetectedExec; }
     inline QStringList scriptManualExecutables() const { return m_manualExec; }
     inline void scriptSetManualExecutables(const QStringList &exec) { m_manualExec = exec; }
@@ -93,6 +96,7 @@ class mbServer : public mbCore
 
 private:
     bool m_scriptEnable;
+    bool m_scriptUseOptimization;
     QStringList m_autoDetectedExec;
     QStringList m_manualExec;
     mutable QString m_defaultExec;