Adding templates

[albfan]

Related with #81, how well received will be to add a templating system?

It can be just a subdir with plain templates or a set of wizards that fill template files with placeholders (tag name, description, pins, protocols...)

Feels like user needs to know a lot about internals of simulide to create some customizations. Removing all boilerplate starters, it can be easier to create complex simulations

[albfan]

I will work on some simple implementations that eases the videotutorials available

[Arcachofo]

I guess you are referring to scripted components...
It would be great to add some wizards for scripted components, this would help users a lot.

[albfan]

Ok, I can work on the use cases I'm trying to emulate, but do not know about all possibilities.

On "Files tab" add on contextual menu:

• Add from template
  • Add script: (with a script template with available methods to overload
  • Add mcu
  • Add iou

Maybe another Icon on bar for Circuits, after "New Circuit", "Add from template" (not sure about icon it will use)

I'm ok if you want to write down here specs for templates or wizards.

I know the basics, but something like this should do it:

wizard.cpp

#include <QApplication>
#include <QWizard>
#include <QWizardPage>
#include <QVBoxLayout>
#include <QLabel>
#include <QLineEdit>
#include <QPushButton>
#include <QMessageBox>
#include <QDebug>
#include <QLoggingCategory>
#include <QRegularExpression>
#include <QFile>
#include <QTextStream>

class CustomPage2 : public QWizardPage {
    Q_OBJECT

public:
    CustomPage2(QWidget *parent = nullptr) : QWizardPage(parent) {
        setTitle("Step 2: Enter Details");

        QLabel *nameLabel = new QLabel("Your Name:");
        QLineEdit *nameLineEdit = new QLineEdit;
        errorLabel = new QLabel("Name cannot be empty.");
        errorLabel->setStyleSheet("color: red;");
        errorLabel->hide();

        QVBoxLayout *layout = new QVBoxLayout;
        layout->addWidget(nameLabel);
        layout->addWidget(nameLineEdit);
        layout->addWidget(errorLabel);
        setLayout(layout);

        registerField("name", nameLineEdit);
        nameLineEdit->setObjectName("nameLineEdit");
    }

    bool validatePage() override {
        QString name = field("name").toString();

        if (name.isEmpty()) {
            qDebug() << "name empty";
            errorLabel->show();
            auto *nameLineEdit = dynamic_cast<QLineEdit *>(findChild<QLineEdit *>("nameLineEdit"));
            if (nameLineEdit) {
                nameLineEdit->setStyleSheet("border: 2px solid red;");
            }
            return false;
        } else
            qDebug() << "name: " << name;


        errorLabel->hide();
        auto *nameLineEdit = dynamic_cast<QLineEdit *>(findChild<QLineEdit *>("nameLineEdit"));
        if (nameLineEdit) {
            nameLineEdit->setStyleSheet("");
        }

        return true;
    }

private:
    QLabel *errorLabel;
};

class CustomPage3 : public QWizardPage {
    Q_OBJECT

public:
    CustomPage3(QWidget *parent = nullptr) : QWizardPage(parent) {
        setTitle("Step 2: Enter Further Details");

        QLabel *emailLabel = new QLabel("Your Email:");
        QLineEdit *emailLineEdit = new QLineEdit;
        errorLabel = new QLabel("Email invalid.");
        errorLabel->setStyleSheet("color: red;");
        errorLabel->hide();

        QVBoxLayout *layout = new QVBoxLayout;
        layout->addWidget(emailLabel);
        layout->addWidget(emailLineEdit);
        layout->addWidget(errorLabel);
        setLayout(layout);

        registerField("email", emailLineEdit);
        emailLineEdit->setObjectName("emailLineEdit");
    }

    bool isValidEmail(const QString &email) {
        // Regular expression for email validation
        QRegularExpression regex("^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$");
        
        // Test the input email
        QRegularExpressionMatch match = regex.match(email);
        return match.hasMatch();  // Returns true if the email matches the pattern
    }

    bool validatePage() override {
        QString email = field("email").toString();

        if (!isValidEmail(email)) {
            qDebug() << "email invalid";
            errorLabel->show();
            auto *emailLineEdit = dynamic_cast<QLineEdit *>(findChild<QLineEdit *>("emailLineEdit"));
            if (emailLineEdit) {
                emailLineEdit->setStyleSheet("border: 2px solid red;");
            }
            return false;
        } else
            qDebug() << "email: " << email;


        errorLabel->hide();
        auto *emailLineEdit = dynamic_cast<QLineEdit *>(findChild<QLineEdit *>("emailLineEdit"));
        if (emailLineEdit) {
            emailLineEdit->setStyleSheet("");
        }

        return true;
    }

private:
    QLabel *errorLabel;
};

class CustomWizard : public QWizard {
public:
    CustomWizard(QWidget *parent = nullptr) : QWizard(parent) {
        setWindowTitle("Wizard Example");
        setWizardStyle(QWizard::ClassicStyle);

        addPage(createPage1());
        addPage(new CustomPage2(this));
        addPage(new CustomPage3(this));
        addPage(createPage4());
    }

private:
    QWizardPage *createPage1() {
        QWizardPage *page = new QWizardPage;
        page->setTitle("Step 1: Introduction");

        QLabel *label = new QLabel("Welcome to the Wizard!\nClick 'Next' to proceed.");
        label->setWordWrap(true);

        QVBoxLayout *layout = new QVBoxLayout;
        layout->addWidget(label);
        page->setLayout(layout);

        return page;
    }

    QWizardPage *createPage4() {
        QWizardPage *page = new QWizardPage;
        page->setTitle("Step 3: Confirmation");

        QLabel *label = new QLabel(
            "You have completed all steps! Click 'Finish' to exit.");
        label->setWordWrap(true);

        QVBoxLayout *layout = new QVBoxLayout;
        layout->addWidget(label);
        page->setLayout(layout);

        return page;
    }

    QString processTemplate(const QString &templateContent, const QMap<QString, QString> &placeholders) {
        QString content = templateContent;
    
        // Iterate over all placeholders and replace them
        for (auto it = placeholders.constBegin(); it != placeholders.constEnd(); ++it) {
            QString placeholder = QString("{{%1}}").arg(it.key()); // e.g., {{name}}
            content.replace(placeholder, it.value());             // Replace with the actual value
        }
    
        return content; // Return the updated content
    }

protected:
    void accept() override {
        QString name = field("name").toString();
        QString email = field("email").toString();

        qDebug() << "Collected Details:";
        qDebug() << "Name:" << name;
        qDebug() << "Email:" << email;

        QFile file("template.xmlt");
        if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) {
            qDebug() << "Failed to open the file:" << file.errorString();
            return;
        }

        QTextStream in(&file);
        QString templateContent = in.readAll();
        file.close();

        QMap<QString, QString> placeholders;
        placeholders["name"] = name;
        placeholders["email"] = email;

        QString result = processTemplate(templateContent, placeholders);

        QString output_name = "name-email.xml";
        QFile outputFile(output_name);
        if (!outputFile.open(QIODevice::WriteOnly | QIODevice::Text)) {
            qDebug() << "Failed to write to the file:" << outputFile.errorString();
            return;
        }

        QTextStream out(&outputFile);
        out << result;
        outputFile.close();

        qDebug() << "Processed output written to " << output_name;
        QWizard::accept();
    }
};

int main(int argc, char *argv[]) {
    QApplication app(argc, argv);
    QLoggingCategory::defaultCategory()->setEnabled(QtDebugMsg, true);
    CustomWizard wizard;
    wizard.show();
    return app.exec();
}

#include "main.moc"

template.xmlt

<xml>
        <user>
                <name>{{name}}</name>
                <email>{{email}}</email>
        </user>
</xml>

build

moc-qt5 main.cpp > main.moc
g++ -Wall wizard.cpp -o wizard -fPIC `pkg-config --cflags --libs Qt5Widgets`

run:

./wizard

Producing:

<xml>
        <user>
                <name>Alberto</name>
                <email>myemail@foo.com</email>
        </user>
</xml>

Pointing to videotutorials and specs to ease those workflows would make implement these feature easier for me.

Let's go mad, and if something is too hard to implement we can skip for add a subtask for someone more skilled on Qt

[Arcachofo]

I'm thinking about this...

Maybe we don't need a wizard, but just a widget with options to configure.
Also this would be useful only for scripted components, not for MCUs.

I will do a list with things that could be implemented as soon as possible.

[Arcachofo]

This is a preliminary list we can use as a start point.

It should be possible to add and remove modules, like Ports or Properties, maybe just one button to add and one button per new module to remove.

Those marked as "enum" should be a dropdown list with options, for example list of pins already existing or data types available.

What do you think?

---

General:

• Name [string]
• [check] Linkable

---

Properties:

• Add Property group [button]

Property Group:

• Add Property [button]

Property:

• Name [string]
• Label [string]
• Type [enum]
• Unit [string]

---

Ports:

• Add Port [button]

Port:

• Name [string]
• Pins [string list]

---

USARTs:

• Add USART [button]

USART:

• Name [string]
• Number [int]
• Tx Pin [enum]
• Rx Pin [enum]

---

I2C:

• Add I2C [button]

I2C:

• Name [string]
• SDA Pin [enum]
• SCL Pin [enum]

---

SPI:

• Add SPI [button]

SPI:

• Name [string]
• MOSI Pin [enum]
• MISO Pin [enum]
• SCK Pin [enum]
• SS Pin [enum]

---

Display:

• Name [string]
• Width [int]
• Height [int]
• Scale [double]
• Margin Right [int]
• Margin Left [int]
• Margin Top [int]
• Margin Bottom [int]

[albfan]

Yes, that will work thanks.

I think General need too:

type: circuit/mcu/iou
linker: [bool]

I don't know options in details so maybe we can add examples of final result on https://github.com/eeTools/SimulIDE-Components. A branch templates with a 2.0 dir, and component subdirs, that we can remove as soon as wizard cover it.

Examples on forum might work too

[Arcachofo]

Uploaded some templates to SimulIDE-Components.

I think with this it is possible to start doing something.
When we have some basic thing working maybe we can add more stuff.