GIT_REPOSITORIES/LPP/Users/mperrinel/SciQLop-fork Commit - r361:ca227f940fcb

Uses weak pointers in lambda functions to prevent a shared_ptr from ever being deleted (because a reference would always be kept in the lambda)

Alexandre Leroux -

r361:ca227f940fcb

parent child

Context file:

r361:ca227f940fcb

Collapse all files

core/src/Variable/VariableController.cpp +7 -6

             #include <Variable/Variable.h>
             #include <Variable/VariableCacheController.h>
             #include <Variable/VariableController.h>
             #include <Variable/VariableModel.h>
             #include <Data/DataProviderParameters.h>
             #include <Data/IDataProvider.h>
             #include <Data/IDataSeries.h>
             #include <Time/TimeController.h>
             #include <QDateTime>
             #include <QMutex>
             #include <QThread>
             #include <QtCore/QItemSelectionModel>
             #include <unordered_map>
             Q_LOGGING_CATEGORY(LOG_VariableController, "VariableController")
             namespace {
             /// @todo Generates default dataseries, according to the provider passed in parameter. This method
             /// will be deleted when the timerange is recovered from SciQlop
             std::shared_ptr<IDataSeries> generateDefaultDataSeries(const IDataProvider &provider,
                                                                    const SqpDateTime &dateTime) noexcept
             {
                 auto parameters = DataProviderParameters{dateTime};
                 return provider.retrieveData(parameters);
             }
             } // namespace
             struct VariableController::VariableControllerPrivate {
                 explicit VariableControllerPrivate(VariableController *parent)
                         : m_WorkingMutex{},
                           m_VariableModel{new VariableModel{parent}},
                           m_VariableSelectionModel{new QItemSelectionModel{m_VariableModel, parent}},
                           m_VariableCacheController{std::make_unique<VariableCacheController>()}
                 {
                 }
                 QMutex m_WorkingMutex;
                 /// Variable model. The VariableController has the ownership
                 VariableModel *m_VariableModel;
                 QItemSelectionModel *m_VariableSelectionModel;
                 TimeController *m_TimeController{nullptr};
                 std::unique_ptr<VariableCacheController> m_VariableCacheController;
                 std::unordered_map<std::shared_ptr<Variable>, std::shared_ptr<IDataProvider> >
                     m_VariableToProviderMap;
             };
             VariableController::VariableController(QObject *parent)
                     : QObject{parent}, impl{spimpl::make_unique_impl<VariableControllerPrivate>(this)}
             {
                 qCDebug(LOG_VariableController()) << tr("VariableController construction")
                                                   << QThread::currentThread();
             }
             VariableController::~VariableController()
             {
                 qCDebug(LOG_VariableController()) << tr("VariableController destruction")
                                                   << QThread::currentThread();
                 this->waitForFinish();
             }
             VariableModel *VariableController::variableModel() noexcept
             {
                 return impl->m_VariableModel;
             }
             QItemSelectionModel *VariableController::variableSelectionModel() noexcept
             {
                 return impl->m_VariableSelectionModel;
             }
             void VariableController::setTimeController(TimeController *timeController) noexcept
             {
                 impl->m_TimeController = timeController;
             }
             void VariableController::deleteVariable(std::shared_ptr<Variable> variable) noexcept
             {
                 if (!variable) {
                     qCCritical(LOG_VariableController()) << "Can't delete variable: variable is null";
                     return;
                 }
                 // Spreads in SciQlop that the variable will be deleted, so that potential receivers can
                 // make some treatments before the deletion
                 emit variableAboutToBeDeleted(variable);
                 // Deletes provider
                 auto nbProvidersDeleted = impl->m_VariableToProviderMap.erase(variable);
                 qCDebug(LOG_VariableController())
                     << tr("Number of providers deleted for variable %1: %2")
                            .arg(variable->name(), QString::number(nbProvidersDeleted));
                 // Clears cache
                 impl->m_VariableCacheController->clear(variable);
                 // Deletes from model
                 impl->m_VariableModel->deleteVariable(variable);
             }
             void VariableController::deleteVariables(
                 const QVector<std::shared_ptr<Variable> > &variables) noexcept
             {
                 for (auto variable : qAsConst(variables)) {
                     deleteVariable(variable);
                 }
             }
             void VariableController::createVariable(const QString &name,
                                                     std::shared_ptr<IDataProvider> provider) noexcept
             {
                 if (!impl->m_TimeController) {
                     qCCritical(LOG_VariableController())
                         << tr("Impossible to create variable: The time controller is null");
                     return;
                 }
                 /// @todo : for the moment :
                 /// - the provider is only used to retrieve data from the variable for its initialization, but
                 /// it will be retained later
                 /// - default data are generated for the variable, without taking into account the timerange set
                 /// in sciqlop
                 auto dateTime = impl->m_TimeController->dateTime();
                 if (auto newVariable = impl->m_VariableModel->createVariable(name, dateTime)) {
                     // store the provider
                     impl->m_VariableToProviderMap[newVariable] = provider;
-                    auto addDateTimeAcquired
+                    auto addDateTimeAcquired = [ this, varW = std::weak_ptr<Variable>{newVariable} ](
-                        = [this, newVariable](auto dataSeriesAcquired, auto dateTimeToPutInCache) {
+                        auto dataSeriesAcquired, auto dateTimeToPutInCache)
+                    {
-                              impl->m_VariableCacheController->addDateTime(newVariable, dateTimeToPutInCache);
+                        if (auto variable = varW.lock()) {
-                              newVariable->setDataSeries(dataSeriesAcquired);
+                            impl->m_VariableCacheController->addDateTime(variable, dateTimeToPutInCache);
+                            variable->setDataSeries(dataSeriesAcquired);
+                        }
                     };
                     connect(provider.get(), &IDataProvider::dataProvided, addDateTimeAcquired);
                     this->onRequestDataLoading(newVariable, dateTime);
                 }
             }
             void VariableController::onDateTimeOnSelection(const SqpDateTime &dateTime)
             {
                 auto selectedRows = impl->m_VariableSelectionModel->selectedRows();
                 for (const auto &selectedRow : qAsConst(selectedRows)) {
                     if (auto selectedVariable = impl->m_VariableModel->variable(selectedRow.row())) {
                         selectedVariable->setDateTime(dateTime);
                         this->onRequestDataLoading(selectedVariable, dateTime);
                     }
                 }
             }
             void VariableController::onRequestDataLoading(std::shared_ptr<Variable> variable,
                                                           const SqpDateTime &dateTime)
             {
                 // we want to load data of the variable for the dateTime.
                 // First we check if the cache contains some of them.
                 // For the other, we ask the provider to give them.
                 if (variable) {
                     auto dateTimeListNotInCache
                         = impl->m_VariableCacheController->provideNotInCacheDateTimeList(variable, dateTime);
                     if (!dateTimeListNotInCache.empty()) {
                         // Ask the provider for each data on the dateTimeListNotInCache
                         impl->m_VariableToProviderMap.at(variable)->requestDataLoading(
                             std::move(dateTimeListNotInCache));
                     }
                     else {
                         emit variable->updated();
                     }
                 }
                 else {
                     qCCritical(LOG_VariableController()) << tr("Impossible to load data of a variable null");
                 }
             }
             void VariableController::initialize()
             {
                 qCDebug(LOG_VariableController()) << tr("VariableController init") << QThread::currentThread();
                 impl->m_WorkingMutex.lock();
                 qCDebug(LOG_VariableController()) << tr("VariableController init END");
             }
             void VariableController::finalize()
             {
                 impl->m_WorkingMutex.unlock();
             }
             void VariableController::waitForFinish()
             {
                 QMutexLocker locker{&impl->m_WorkingMutex};
             }

gui/src/Visualization/operations/GenerateVariableMenuOperation.cpp +23 -10

             #include "Visualization/operations/GenerateVariableMenuOperation.h"
             #include "Visualization/operations/MenuBuilder.h"
             #include "Visualization/VisualizationGraphWidget.h"
             #include "Visualization/VisualizationTabWidget.h"
             #include "Visualization/VisualizationZoneWidget.h"
             #include <Variable/Variable.h>
             #include <QMenu>
             #include <QStack>
             Q_LOGGING_CATEGORY(LOG_GenerateVariableMenuOperation, "GenerateVariableMenuOperation")
             struct GenerateVariableMenuOperation::GenerateVariableMenuOperationPrivate {
                 explicit GenerateVariableMenuOperationPrivate(QMenu *menu, std::shared_ptr<Variable> variable)
                         : m_Variable{variable}, m_PlotMenuBuilder{menu}, m_UnplotMenuBuilder{menu}
                 {
                 }
                 void visitRootEnter()
                 {
                     // Creates the root menu
                     m_PlotMenuBuilder.addMenu(QObject::tr("Plot"), QIcon{":/icones/plot.png"});
                     m_UnplotMenuBuilder.addMenu(QObject::tr("Unplot"), QIcon{":/icones/unplot.png"});
                 }
                 void visitRootLeave()
                 {
                     // Closes the root menu
                     m_PlotMenuBuilder.closeMenu();
                     m_UnplotMenuBuilder.closeMenu();
                 }
                 void visitNodeEnter(const IVisualizationWidget &container)
                 {
                     // Opens a new menu associated to the node
                     m_PlotMenuBuilder.addMenu(container.name());
                     m_UnplotMenuBuilder.addMenu(container.name());
                 }
                 template <typename ActionFun>
                 void visitNodeLeavePlot(const IVisualizationWidget &container, const QString &actionName,
                                         ActionFun actionFunction)
                 {
                     if (m_Variable && container.canDrop(*m_Variable)) {
                         m_PlotMenuBuilder.addSeparator();
                         m_PlotMenuBuilder.addAction(actionName, actionFunction);
                     }
                     // Closes the menu associated to the node
                     m_PlotMenuBuilder.closeMenu();
                 }
                 void visitNodeLeaveUnplot()
                 {
                     // Closes the menu associated to the node
                     m_UnplotMenuBuilder.closeMenu();
                 }
                 template <typename ActionFun>
                 void visitLeafPlot(const IVisualizationWidget &container, const QString &actionName,
                                    ActionFun actionFunction)
                 {
                     if (m_Variable && container.canDrop(*m_Variable)) {
                         m_PlotMenuBuilder.addAction(actionName, actionFunction);
                     }
                 }
                 template <typename ActionFun>
                 void visitLeafUnplot(const IVisualizationWidget &container, const QString &actionName,
                                      ActionFun actionFunction)
                 {
                     if (m_Variable && container.contains(*m_Variable)) {
                         m_UnplotMenuBuilder.addAction(actionName, actionFunction);
                     }
                 }
                 std::shared_ptr<Variable> m_Variable;
                 MenuBuilder m_PlotMenuBuilder;   ///< Builder for the 'Plot' menu
                 MenuBuilder m_UnplotMenuBuilder; ///< Builder for the 'Unplot' menu
             };
             GenerateVariableMenuOperation::GenerateVariableMenuOperation(QMenu *menu,
                                                                          std::shared_ptr<Variable> variable)
                     : impl{spimpl::make_unique_impl<GenerateVariableMenuOperationPrivate>(menu, variable)}
             {
             }
             void GenerateVariableMenuOperation::visitEnter(VisualizationWidget *widget)
             {
                 // VisualizationWidget is not intended to accommodate a variable
                 Q_UNUSED(widget)
                 // 'Plot' and 'Unplot' menus
                 impl->visitRootEnter();
             }
             void GenerateVariableMenuOperation::visitLeave(VisualizationWidget *widget)
             {
                 // VisualizationWidget is not intended to accommodate a variable
                 Q_UNUSED(widget)
                 // 'Plot' and 'Unplot' menus
                 impl->visitRootLeave();
             }
             void GenerateVariableMenuOperation::visitEnter(VisualizationTabWidget *tabWidget)
             {
                 if (tabWidget) {
                     // 'Plot' and 'Unplot' menus
                     impl->visitNodeEnter(*tabWidget);
                 }
                 else {
                     qCCritical(LOG_GenerateVariableMenuOperation(),
                                "Can't visit enter VisualizationTabWidget : the widget is null");
                 }
             }
             void GenerateVariableMenuOperation::visitLeave(VisualizationTabWidget *tabWidget)
             {
                 if (tabWidget) {
                     // 'Plot' menu
-                    impl->visitNodeLeavePlot(
+                    impl->visitNodeLeavePlot(*tabWidget, QObject::tr("Open in a new zone"),
-                        *tabWidget, QObject::tr("Open in a new zone"),
+                                             [ varW = std::weak_ptr<Variable>{impl->m_Variable}, tabWidget ]() {
-                        [ var = impl->m_Variable, tabWidget ]() { tabWidget->createZone(var); });
+                                                 if (auto var = varW.lock()) {
+                                                     tabWidget->createZone(var);
+                                                 }
+                                             });
                     // 'Unplot' menu
                     impl->visitNodeLeaveUnplot();
                 }
                 else {
                     qCCritical(LOG_GenerateVariableMenuOperation(),
                                "Can't visit leave VisualizationTabWidget : the widget is null");
                 }
             }
             void GenerateVariableMenuOperation::visitEnter(VisualizationZoneWidget *zoneWidget)
             {
                 if (zoneWidget) {
                     // 'Plot' and 'Unplot' menus
                     impl->visitNodeEnter(*zoneWidget);
                 }
                 else {
                     qCCritical(LOG_GenerateVariableMenuOperation(),
                                "Can't visit enter VisualizationZoneWidget : the widget is null");
                 }
             }
             void GenerateVariableMenuOperation::visitLeave(VisualizationZoneWidget *zoneWidget)
             {
                 if (zoneWidget) {
                     // 'Plot' menu
                     impl->visitNodeLeavePlot(
                         *zoneWidget, QObject::tr("Open in a new graph"),
-                        [ var = impl->m_Variable, zoneWidget ]() { zoneWidget->createGraph(var); });
+                        [ varW = std::weak_ptr<Variable>{impl->m_Variable}, zoneWidget ]() {
+                            if (auto var = varW.lock()) {
+                                zoneWidget->createGraph(var);
+                            }
+                        });
                     // 'Unplot' menu
                     impl->visitNodeLeaveUnplot();
                 }
                 else {
                     qCCritical(LOG_GenerateVariableMenuOperation(),
                                "Can't visit leave VisualizationZoneWidget : the widget is null");
                 }
             }
             void GenerateVariableMenuOperation::visit(VisualizationGraphWidget *graphWidget)
             {
                 if (graphWidget) {
                     // 'Plot' menu
-                    impl->visitLeafPlot(
+                    impl->visitLeafPlot(*graphWidget, QObject::tr("Open in %1").arg(graphWidget->name()),
-                        *graphWidget, QObject::tr("Open in %1").arg(graphWidget->name()),
+                                        [ varW = std::weak_ptr<Variable>{impl->m_Variable}, graphWidget ]() {
-                        [ var = impl->m_Variable, graphWidget ]() { graphWidget->addVariableUsingGraph(var); });
+                                            if (auto var = varW.lock()) {
+                                                graphWidget->addVariableUsingGraph(var);
+                                            }
+                                        });
                     // 'Unplot' menu
-                    impl->visitLeafUnplot(
+                    impl->visitLeafUnplot(*graphWidget, QObject::tr("Remove from %1").arg(graphWidget->name()),
-                        *graphWidget, QObject::tr("Remove from %1").arg(graphWidget->name()),
+                                          [ varW = std::weak_ptr<Variable>{impl->m_Variable}, graphWidget ]() {
-                        [ var = impl->m_Variable, graphWidget ]() { graphWidget->removeVariable(var); });
+                                              if (auto var = varW.lock()) {
+                                                  graphWidget->removeVariable(var);
+                                              }
+                                          });
                 }
                 else {
                     qCCritical(LOG_GenerateVariableMenuOperation(),
                                "Can't visit VisualizationGraphWidget : the widget is null");
                 }
             }

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages