ArduinoCodeGen.h

Go to the documentation of this file.

// Copyright 2015 - 2026, GIBIS-UNIFESP and the wiRedPanda contributors
// SPDX-License-Identifier: GPL-3.0-or-later

 
#pragma once
 
#include <QCoreApplication>
#include <QFile>
#include <QHash>
#include <QTextStream>
#include <QVector>
 
#include "App/Core/Enums.h"
 
class GraphicElement;
class IC;
class InputPort;
class Port;

class MappedPin
{
public:
    MappedPin() = default;
    MappedPin(GraphicElement *elm, const QString &pin, const QString &varName, Port *port, const int portNumber = 0)
        : m_elm(elm)
        , m_port(port)
        , m_pin(pin)
        , m_varName(varName)
        , m_portNumber(portNumber)
    {
    }
 
    GraphicElement *m_elm = nullptr;
    Port *m_port = nullptr;
    QString m_pin;
    QString m_varName;
    int m_portNumber = 0;
};

struct ArduinoBoardConfig
{
    QString name;          
    QStringList availablePins; 
    QString description;   
    qsizetype maxPins() const { return availablePins.size(); }
};

class ArduinoCodeGen
{
    Q_DECLARE_TR_FUNCTIONS(ArduinoCodeGen)
 
public:
    // --- Lifecycle ---

    struct TestVector {
        QVector<bool> inputs;   
        QVector<bool> outputs;  
    };

    ArduinoCodeGen(const QString &fileName, const QVector<GraphicElement *> &elements);
 
    // --- Code Generation ---

    void generate();
    void generateTestbench(const QString &tbFileName, const QVector<TestVector> &vectors);
 
private:
    // --- String Utilities ---

    static QString highLow(Status val);
    static QString removeForbiddenChars(const QString &input);
    static bool isArduinoReserved(const QString &name);
 
    // --- Board Selection ---

    ArduinoBoardConfig selectBoard(int requiredPins);
    QVector<ArduinoBoardConfig> availableBoards() const;
 
    // --- Signal Name Resolution ---

    QString buildSelectExpression(GraphicElement *elm, int startIndex, int numSelectLines);
    QString otherPortName(Port *port);
    QString otherPortNameImpl(Port *port, QSet<Port *> &visited);
    void emitFlipFlopBlock(GraphicElement *elm, const QString &typeName, const QString &firstOut,
                           const QString &secondOut, int clockInputIndex, int presetInputIndex,
                           int clearInputIndex, const std::function<void()> &edgeLogic,
                           const std::function<void()> &stateEpilogue = {});
    static bool hasNativeMemory(const QVector<GraphicElement *> &elements);
    void emitCommitFlipFlops();
    void emitCommitFlipFlopsRec(const QVector<GraphicElement *> &elements);
    void emitTickDriver();
    void emitDFlipFlop(GraphicElement *elm, const QString &firstOut);
    void emitDLatch(GraphicElement *elm, const QString &firstOut);
    void emitJKFlipFlop(GraphicElement *elm, const QString &firstOut);
    void emitSRFlipFlop(GraphicElement *elm, const QString &firstOut);
    void emitTFlipFlop(GraphicElement *elm, const QString &firstOut);
    void emitSRLatch(GraphicElement *elm, const QString &firstOut);
    void emitMux(GraphicElement *elm);
    void emitDemux(GraphicElement *elm);
    void emitTruthTable(GraphicElement *elm);
    void assignLogicOperator(GraphicElement *elm);
 
    // --- Variable / Declaration Emission ---

    void assignVariablesRec(const QVector<GraphicElement *> &elements);
    void declareAuxVariables();
    void declareAuxVariablesRec(const QVector<GraphicElement *> &elements, const bool isBox, const QString &icPrefix);
    void declareSequentialStateRec(const QVector<GraphicElement *> &elements, bool topLevel);
    void declareInputs();
    void declareOutputs();
    void emitComputeLogicFunction();
    void loop();
    void setup();
 
    // --- Members ---
 
    QFile m_file;                              
    QHash<Port *, QString> m_varMap;        
    QHash<QString, InputPort *> m_txInputPorts; 
    QStringList m_availablePins;               
    QStringList m_declaredVariables;           
    QTextStream m_stream;                      
    QVector<MappedPin> m_inputMap;             
    QVector<MappedPin> m_outputMap;            
    const QVector<GraphicElement *> m_elements; 
    IC *m_currentIC = nullptr;                 
    ArduinoBoardConfig m_selectedBoard;        
    int m_totalRequiredPins = 0;               
    bool m_hasSequential = false;              

    [[noreturn]] void throwPinOverflow() const;
};