wave_widget.cpp

Go to the documentation of this file.

#include "waveform_viewer/wave_widget.h"
#include "waveform_viewer/wave_tree_view.h"
#include "waveform_viewer/wave_tree_model.h"
#include "waveform_viewer/wave_graphics_canvas.h"
#include "waveform_viewer/waveform_viewer.h"
#include "netlist_simulator_controller/wave_data.h"
#include "netlist_simulator_controller/saleae_directory.h"
#include "netlist_simulator_controller/saleae_file.h"
#include "waveform_viewer/wave_edit_dialog.h"
#include "waveform_viewer/wave_selection_dialog.h"
#include "math.h"
 
#include <QResizeEvent>
#include <QWheelEvent>
#include <QScrollBar>
#include <QHeaderView>
#include <QDebug>
#include <QApplication>
 
#include "netlist_simulator_controller/netlist_simulator_controller.h"
#include "netlist_simulator_controller/plugin_netlist_simulator_controller.h"
#include "netlist_simulator_controller/simulation_settings.h"
#include "hal_core/netlist/grouping.h"
#include "hal_core/utilities/log.h"
#include "gui/content_manager/content_manager.h"
#include "gui/grouping/grouping_manager_widget.h"
#include "gui/grouping/grouping_table_model.h"
#include "gui/selection_details_widget/selection_details_widget.h"
#include "gui/gui_globals.h"
 
namespace hal {
 
    WaveWidget::WaveWidget(NetlistSimulatorController *ctrl, QWidget *parent)
        : QSplitter(parent), mController(ctrl), mControllerOwner(nullptr),
          mControllerId(ctrl->get_id()), mControllerName(ctrl->get_name()),
          mOngoingYscroll(false), mVisualizeNetState(false), mAutoAddWaves(true)
    {
        mWaveItemHash   = new WaveItemHash;
        mWaveDataList   = ctrl->get_waves();
        mTreeView       = new WaveTreeView(mWaveDataList,  mWaveItemHash, this);
        mGraphicsCanvas = new WaveGraphicsCanvas(mWaveDataList,  mWaveItemHash, this);
        mTreeModel      = new WaveTreeModel(mWaveDataList, mWaveItemHash, mGraphicsCanvas, this);
        mTreeView->setModel(mTreeModel);
        mTreeView->expandAll();
        mTreeView->setColumnWidth(0,200);
        mTreeView->setColumnWidth(1,40);
        mTreeView->setColumnWidth(2,60);
        mTreeView->header()->setStretchLastSection(true);
        addWidget(mTreeView);
 
        addWidget(mGraphicsCanvas);
 
        connect(mWaveDataList,&WaveDataList::waveAdded,mTreeModel,&WaveTreeModel::handleWaveAdded,Qt::QueuedConnection);
        connect(mWaveDataList,&WaveDataList::groupAdded,mTreeModel,&WaveTreeModel::handleGroupAdded,Qt::QueuedConnection);
        connect(mWaveDataList,&WaveDataList::booleanAdded,mTreeModel,&WaveTreeModel::handleBooleanAdded,Qt::QueuedConnection);
        connect(mWaveDataList,&WaveDataList::triggerAdded,mTreeModel,&WaveTreeModel::handleTriggerAdded,Qt::QueuedConnection);
        connect(mWaveDataList,&WaveDataList::waveAddedToGroup,mTreeModel,&WaveTreeModel::handleWaveAddedToGroup,Qt::QueuedConnection);
        connect(mWaveDataList,&WaveDataList::waveRemovedFromGroup,mTreeModel,&WaveTreeModel::handleWaveRemovedFromGroup,Qt::QueuedConnection);
        connect(mWaveDataList,&WaveDataList::groupAboutToBeRemoved,mTreeModel,&WaveTreeModel::handleGroupAboutToBeRemoved,Qt::QueuedConnection);
        connect(mWaveDataList,&WaveDataList::waveRenamed,mTreeModel,&WaveTreeModel::handleWaveRenamed,Qt::QueuedConnection);
        connect(mWaveDataList,&WaveDataList::groupRenamed,mTreeModel,&WaveTreeModel::handleGroupRenamed,Qt::QueuedConnection);
        connect(mWaveDataList,&WaveDataList::groupUpdated,mTreeModel,&WaveTreeModel::handleGroupUpdated,Qt::QueuedConnection);
        connect(mWaveDataList,&WaveDataList::waveUpdated,mGraphicsCanvas,&WaveGraphicsCanvas::handleWaveUpdated,Qt::QueuedConnection);
        connect(mTreeModel,&WaveTreeModel::inserted,mTreeView,&WaveTreeView::handleInserted,Qt::QueuedConnection);
        connect(mTreeModel,&WaveTreeModel::triggerReorder,mTreeView,&WaveTreeView::reorder,Qt::QueuedConnection);
        connect(mTreeModel,&WaveTreeModel::numberEntriesChanged,this,&WaveWidget::handleNumberWaveformChanged,Qt::QueuedConnection);
        connect(mTreeView,&WaveTreeView::triggerUpdateWaveItems,mGraphicsCanvas,&WaveGraphicsCanvas::updateRequest,Qt::QueuedConnection);
        connect(mGraphicsCanvas,&WaveGraphicsCanvas::cursorMoved,mTreeModel,&WaveTreeModel::handleCursorMoved,Qt::QueuedConnection);
        connect(mWaveDataList,&WaveDataList::timeframeChanged,mGraphicsCanvas,&WaveGraphicsCanvas::handleTimeframeChanged,Qt::QueuedConnection);
        connect(mWaveDataList,&WaveDataList::triggerBeginResetModel,mTreeModel,&WaveTreeModel::forwardBeginResetModel,Qt::QueuedConnection);
        connect(mWaveDataList,&WaveDataList::triggerEndResetModel,mTreeModel,&WaveTreeModel::forwardEndResetModel,Qt::QueuedConnection);
 
 
        if (parent && parent->parent())   // WaveformViewer -> QTabWidget -> WaveWidget
        {
            WaveformViewer* vv = static_cast<WaveformViewer*>(parent->parent());
            if (vv)
            {
                connect(mController,&NetlistSimulatorController::parseComplete,vv,&WaveformViewer::handleParseComplete,Qt::QueuedConnection);
                connect(mController,&NetlistSimulatorController::loadProgress,vv,&WaveformViewer::showProgress,Qt::QueuedConnection);
                connect(mGraphicsCanvas,&WaveGraphicsCanvas::undoStateChanged,vv,&WaveformViewer::testUndoEnable,Qt::QueuedConnection);
            }
        }
 
        connect(gContentManager->getSelectionDetailsWidget(),&SelectionDetailsWidget::triggerHighlight,this,&WaveWidget::handleSelectionHighlight);
 
        connect(mController, &NetlistSimulatorController::stateChanged, this, &WaveWidget::handleStateChanged);
        mTreeView->verticalScrollBar()->setValue(0);
        setSizes({320,880});
        mTreeModel->restore();
        log_info(mControllerName, "Simulation controller id={} name='{}' instantiated", mControllerId, mControllerName);
    }
 
    WaveWidget::~WaveWidget()
    {
        log_info(mControllerName, "Simulation controller id={} name='{}' disposed", mControllerId, mControllerName);
    }
 
    void WaveWidget::refreshNetNames()
    {
        int nWaves = mWaveDataList->size();
        for (int i=0; i<nWaves; i++)
        {
            const WaveData* wd = mWaveDataList->at(i);
            if (!wd->id()) continue;
            Net* n = gNetlist->get_net_by_id(wd->id());
            if (!n) continue;
            QString netName = QString::fromStdString(n->get_name());
            if (netName == wd->name()) continue;
            mWaveDataList->updateWaveName(i,netName);
        }
    }
 
    u32 WaveWidget::controllerId() const
    {
        if (!mController) return 0;
        return mControllerId;
    }
 
    NetlistSimulatorController::SimulationState WaveWidget::state() const
    {
        if (!mController) return NetlistSimulatorController::NoGatesSelected;
        return mController->get_state();
    }
 
    bool WaveWidget::hasOwnership() const
    {
        return mControllerOwner != nullptr;
    }
 
    void WaveWidget::takeOwnership(std::unique_ptr<NetlistSimulatorController>& ctrl)
    {
        mControllerOwner = std::move(ctrl);
    }
 
    bool WaveWidget::isEmpty() const
    {
        return mWaveItemHash->isEmpty();
    }
 
    bool WaveWidget::canImportWires() const
    {
        if (mWaveDataList->size() > mWaveItemHash->importedWires()) return true;
        if (mController)
        {
            SaleaeDirectory sd(mController->get_saleae_directory_filename());
            if (sd.get_next_available_index() > mWaveItemHash->importedWires()) return true;
        }
        return false;
    }
 
    bool WaveWidget::triggerClose()
    {
        if (!mControllerOwner) return false;
        deleteLater();
        return true;
    }
 
    void WaveWidget::handleStateChanged(NetlistSimulatorController::SimulationState state)
    {
        Q_EMIT stateChanged(state);
        qApp->processEvents();
    }
 
    void WaveWidget::handleSelectionHighlight(const QVector<const ModuleItem*>& highlight)
    {
        QSet<u32> hlIds;
        for (const ModuleItem* sti : highlight)
            if (sti->getType() == ModuleItem::TreeItemType::Net)
                hlIds.insert(sti->id());
 
        mTreeView->setWaveSelection(hlIds);
    }
 
    void WaveWidget::createEngine(const QString &engineFactoryName)
    {
        if (mController)
            mController->create_simulation_engine(engineFactoryName.toStdString());
    }
 
    void WaveWidget::setVisualizeNetState(bool state, bool activeTab)
    {
        GroupingTableModel* gtm = gContentManager->getGroupingManagerWidget()->getModel();
        static const char* grpNames[3] = {"x state", "0 state", "1 state"};
        mVisualizeNetState = state;
        if (!activeTab) return;
        if (mVisualizeNetState)
        {
            for (int i=0; i<3; i++)
            {
                Grouping* grp = gtm->groupingByName(grpNames[i]);
                if (!grp)
                {
                    grp = gNetlist->create_grouping(grpNames[i]);
                    gtm->recolorGrouping(grp->get_id(),QColor(NetlistSimulatorControllerPlugin::sSimulationSettings->color((SimulationSettings::ColorSetting) (SimulationSettings::ValueX+i))));
                }
                mGroupIds[i] = grp->get_id();
            }
            visualizeCurrentNetState(mTreeModel->cursorTime(),mTreeModel->cursorXpos());
            connect(mGraphicsCanvas,&WaveGraphicsCanvas::cursorMoved,this,&WaveWidget::visualizeCurrentNetState);
        }
        else
        {
            disconnect(mGraphicsCanvas,&WaveGraphicsCanvas::cursorMoved,this,&WaveWidget::visualizeCurrentNetState);
            for (int i=0; i<3; i++)
            {
                Grouping* grp = gtm->groupingByName(grpNames[i]);
                if (grp) gNetlist->delete_grouping(grp);
                mGroupIds[i] = 0;
            }
        }
    }
 
    QMap<WaveSelectionEntry,int> WaveWidget::addableEntries() const
    {
        QSet<int> alreadyShownInx = mTreeModel->waveDataIndexSet();
        QSet<QString> alreadyShownNames;
 
        // Which wavedata container entries are not shown yet
        int n = mWaveDataList->size();
        QMap<WaveSelectionEntry,int> retval;
        for (int i=0; i<n; i++)
        {
            if (alreadyShownInx.contains(i))
                alreadyShownNames.insert(mWaveDataList->at(i)->name());
            else
            {
                WaveData* wd = mWaveDataList->at(i);
                retval.insert(WaveSelectionEntry(wd->id(),wd->name(),wd->fileSize()),i);
            }
        }
 
        // Which salea directory entries are not shown yet
        SaleaeDirectory* sd = mController ? new SaleaeDirectory(mController->get_saleae_directory_filename()) : nullptr;
        if (sd)
        {
            for (const SaleaeDirectory::ListEntry& sdle : sd->get_net_list())
            {
                QString netName = QString::fromStdString(sdle.name);
                if (alreadyShownNames.contains(netName)) continue; // already shown
                if (mWaveDataList->waveIndexByNetId(sdle.id)>=0) continue; // already added to selection list by previous loop
                retval.insert(WaveSelectionEntry(sdle.id,netName,sdle.size),-1);
            }
        }
        delete sd;
//        qDebug() << "Addable entries :" << retval.size();
        return retval;
    }
 
    void WaveWidget::addSelectedResults(const QMap<WaveSelectionEntry,int>& sel)
    {
        SaleaeDirectory* sd = mController ? new SaleaeDirectory(mController->get_saleae_directory_filename()) : nullptr;
 
        QVector<WaveData*> wavesToAdd;
        wavesToAdd.reserve(sel.size());
 
        for (auto it = sel.constBegin(); it!=sel.constEnd(); ++it)
        {
            int iwave = it.value();
            if (iwave<0 && sd)
            {
                iwave = mWaveDataList->size();
                WaveData* wd = new WaveData(it.key().id(),it.key().name());
                if (wd->loadSaleae(mWaveDataList->timeFrame()))
                {
                    mWaveDataList->add(wd,false);
                    wavesToAdd.append(wd);
                }
            }
            else if (iwave >= 0)
                wavesToAdd.append(mWaveDataList->at(iwave));
        }
        mTreeModel->addWaves(wavesToAdd);
        
        if (sd) delete sd;
    }
 
    void WaveWidget::addResults()
    {
        if (!canImportWires()) return;
 
        QMap<WaveSelectionEntry,int> wseMap = addableEntries();
 
        WaveSelectionDialog wsd(wseMap,this);
        if (wsd.exec() == QDialog::Accepted)
        {
            wseMap = wsd.selectedWaves();
            if (!wseMap.isEmpty())
                addSelectedResults(wseMap);
        }
        mGraphicsCanvas->handleTimeframeChanged(&mWaveDataList->timeFrame());
    }
 
    void WaveWidget::setGates(const std::vector<Gate*>& gats)
    {
        if (!mController || mController->get_state() != NetlistSimulatorController::NoGatesSelected) return;
        mController->reset();
        mController->add_gates(gats);
        for (const Net* inpNet : mController->get_input_nets())
            mController->get_waveform_by_net(inpNet);
    }
 
    void WaveWidget::handleNumberWaveformChanged(int count)
    {
        if (mTreeModel)
        {
            int expectMoreEvents = mTreeModel->decreaseNumberEntriesChangedEvents();
            if (expectMoreEvents) return;
        }
        Q_UNUSED(count);
        Q_EMIT stateChanged(mController->get_state());
    }
 
    void WaveWidget::resizeEvent(QResizeEvent* event)
    {
        QSplitter::resizeEvent(event);
        int w = event->size().width() - 320;
        if (w < 100) return;
        setSizes({320,w});
    }
 
    void WaveWidget::visualizeCurrentNetState(double tCursor, int xpos)
    {
        QSet<Net*> netState[3]; // x, 0, 1
 
        for (auto it = mWaveItemHash->begin(); it != mWaveItemHash->end(); ++it)
        {
            WaveItem* wi = it.value();
            if (!wi) continue;
            const WaveData* wd = wi->wavedata();
            if (!wd) continue;
            Net* n = gNetlist->get_net_by_id(wd->id());
            if (!n) continue;
            int val = wi->cursorValue(tCursor, xpos);
            if (val < -1 || val > 1) continue;
            netState[val+1].insert(n);
        }
 
        for (int i=0; i<3; i++)
        {
            Grouping* grp = gNetlist->get_grouping_by_id(mGroupIds[i]);
            if (!grp) continue;
            for (Net* n : grp->get_nets())
            {
                auto it = netState[i].find(n);
                if (it == netState[i].end())
                    grp->remove_net(n);
                else
                    netState[i].erase(it);
            }
            for (Net* n : netState[i])
                grp->assign_net(n, true);
        }
    }
 
    void WaveWidget::scrollToYpos(int ypos)
    {
        if (mOngoingYscroll) return;
        mOngoingYscroll = true;
        if (mTreeView->verticalScrollBar()->value() != ypos)
            mTreeView->verticalScrollBar()->setValue(ypos);
 
 
        if (mGraphicsCanvas->verticalScrollBar()->value() != ypos)
        {
            mGraphicsCanvas->verticalScrollBar()->setMaximum(
                        mTreeView->verticalScrollBar()->maximum());
            mGraphicsCanvas->verticalScrollBar()->setValue(ypos);
        }
        mOngoingYscroll = false;
    }
 
    void WaveWidget::removeGroup(u32 grpId)
    {
        if (!grpId) return;
        mWaveDataList->removeGroup(grpId);
    }
}