Finalize

Author: boutinb

Desktop/data/datasetpackage.cpp

@@ -2523,7 +2523,7 @@ bool DataSetPackage::filePathIsNonSaveable(const QString & path) const
 {
 	QFileInfo fileDir(path);
 
-	return fileDir.dir() == QDir(AppDirs::examples()) || fileDir.dir() == QDir(AppDirs::autoSaveDir());
+    return path.startsWith(AppDirs::examples()) || fileDir.dir() == QDir(AppDirs::autoSaveDir());
 }
 
 void DataSetPackage::setAnalysesData(const Json::Value &analysesData)

Desktop/data/fileevent.cpp

@@ -38,8 +38,8 @@ FileEvent::FileEvent(FileMenu *parent, FileEvent::FileMode fileMode)
 	default:							_exporter = nullptr;					break;
 	}
 
-	connect(this, &FileEvent::started,		parent, &FileMenu::dataSetIORequestStarted);
-	connect(this, &FileEvent::completed,	parent, &FileMenu::dataSetIORequestCompleted);
+    // Only the FileMenu handles the started signal
+    connect(this, &FileEvent::started,		parent, &FileMenu::fileEventRequestDispatcher);
 }
 
 FileEvent::~FileEvent()
@@ -99,14 +99,14 @@ bool FileEvent::setPath(const QString & path)
 
 void FileEvent::setStarted()
 {
-	_started = true;
+    _status = EventStatus::EventStarted;
 
 	emit started();
 }
 
 void FileEvent::setComplete(bool success, const QString & message)
 {
-	_completed	= true;
+    _status     = EventStatus::EventCompleted;
 	_success	= success;
 	_message	= message;
 
@@ -115,17 +115,17 @@ void FileEvent::setComplete(bool success, const QString & message)
 
 void FileEvent::setFinalized()
 {
-	_finalized	= true;
+    _status = EventStatus::EventFinalized;
 	emit finalized();
 	deleteLater();
 }
 
 
 void FileEvent::chain(FileEvent *event)
 {
-	if (_started)
+    if (isStarted())
 	{
-		if (_completed)
+        if (isCompleted())
 			Log::log() << "Event " << getProgressMsg().toStdString() << " is completed before Event " << event->getProgressMsg().toStdString() << " was completed" << std::endl;
 		else // The `this` event is already started, but it should be set complete (and start the finalize process) only when `event` is finalized
 			connect(event, &FileEvent::finalized, this, [this, event]() { setComplete(event->isSuccessful(), event->message()); });

Desktop/data/fileevent.h

@@ -36,6 +36,8 @@ class FileEvent : public QObject
 
 public:
 	enum FileMode { FileSave, FileNew, FileOpen, FileExportResults, FileExportData, FileGenerateData, FileSyncData, FileClose };
+    enum EventStatus { EventInitialized, EventStarted, EventCompleted, EventFinalized };
+
 
 					FileEvent(FileMenu *parent, FileMode fileMode = FileEvent::FileOpen);
 	virtual			~FileEvent();
@@ -56,9 +58,9 @@ class FileEvent : public QObject
 	bool				isOnlineNode()	const { return _path.startsWith("http");		}
 	bool				isExample()		const;
 	bool				isReadOnly()	const { return isExample() || isDatabase();		}
-	bool				isStarted()		const { return _started;						}
-	bool				isCompleted()	const { return _completed;						}
-	bool				isFinalized()	const { return _finalized;						}
+    bool				isStarted()		const { return _status != EventStatus::EventInitialized;	}
+    bool				isCompleted()	const { return _status == EventStatus::EventCompleted || _status == EventStatus::EventFinalized;	}
+    bool				isFinalized()	const { return _status == EventStatus::EventFinalized;	}
 	bool				isSuccessful()	const { return _success;						}
 	bool				isTmp()			const { return _tmp; }
 	static bool			autoSaveExists();
@@ -92,10 +94,8 @@ class FileEvent : public QObject
 						_dataFilePath,
 						_last_error		= "Unknown error",
 						_message;
-	bool				_started		= false,
-						_completed		= false,
-						_finalized		= false,
-						_success		= false,
+    EventStatus         _status         = EventStatus::EventInitialized;
+    bool				_success		= false,
 						_tmp			= false;
 	Exporter		*	_exporter		= nullptr;
 	Json::Value			_database		= Json::nullValue;

Desktop/mainwindow.cpp

@@ -1242,7 +1242,7 @@ bool MainWindow::startDetached(const QString & applicationPath, const QStringLis
 	return worked;
 }
 
-void MainWindow::dataSetIORequestHandler(FileEvent *event)
+void MainWindow::fileEventRequestHandler(FileEvent *event)
 {
 	if (event->operation() == FileEvent::FileNew)
 	{
@@ -1367,7 +1367,7 @@ void MainWindow::closeVariablesPage()
 	_columnModel->setVisible(false);
 }
 
-void MainWindow::dataSetIOCompleted(FileEvent *event)
+void MainWindow::fileEventRequestFinalize(FileEvent *event)
 {
 	hideProgress();
 
@@ -1517,8 +1517,6 @@ void MainWindow::dataSetIOCompleted(FileEvent *event)
 		if(!event->path().endsWith(".pdf") && _preferences->currentThemeName() != "lightTheme")
 			_resultsJsInterface->setThemeCss(_preferences->currentThemeName());
 	}
-
-	event->setFinalized();
 }
 
 
@@ -1860,11 +1858,9 @@ bool MainWindow::startDataEditorHandler()
 
 		if(!justOpenItAlready)
 		{
-			connect(event, &FileEvent::completed, this,			[this, event]()		{ startDataEditorEventCompleted(event); });
-			connect(event, &FileEvent::completed, _fileMenu,	[this, event]()		{ _fileMenu->setSyncFile(event); });
 			event->setPath(dataFilePath);
-			_loader->io(event);
-			showProgress();
+            connect(event, &FileEvent::completed, this,	[this, event]()		{ startDataEditorEventCompleted(event); });
+            event->setStarted();
 		}
 		else
 		{
@@ -1927,6 +1923,7 @@ void MainWindow::startDataEditorEventCompleted(FileEvent* event)
 
 	if (event->isSuccessful())
 	{
+        _fileMenu->setSyncFile(event);
 		_package->setDataFilePath(event->path().toStdString());
 		_package->setDataFileReadOnly(false);
 		_package->setModified(true);
@@ -1985,11 +1982,9 @@ void MainWindow::startDataEditor(QString path)
 						path.append(".csv");
 
 					FileEvent *event = new FileEvent(_fileMenu, FileEvent::FileGenerateData);
-					connect(event, &FileEvent::completed, this,			[this, event]()		{ startDataEditorEventCompleted(event); });
-					connect(event, &FileEvent::completed, _fileMenu,	[this, event]()		{ _fileMenu->setSyncFile(event); });
-					event->setPath(path);
-					_loader->io(event);
-					showProgress();
+                    event->setPath(path);
+                    connect(event, &FileEvent::completed, this,	 [this, event]() { startDataEditorEventCompleted(event); });
+                    event->setStarted();
 				}
 			}
 		}

Desktop/mainwindow.h

@@ -265,8 +265,8 @@ private slots:
 	void analysisImageSavedHandler(Analysis* analysis);
 	void removeAllAnalyses();
 
-	void dataSetIORequestHandler(FileEvent *event);
-	void dataSetIOCompleted(FileEvent *event);
+	void fileEventRequestHandler(FileEvent *event);
+	void fileEventRequestFinalize(FileEvent *event);
 	void populateUIfromDataSet();
 	void startDataEditorEventCompleted(FileEvent *event);
 	void analysisAdded(Analysis *analysis);

Desktop/widgets/filemenu/filemenu.cpp

@@ -261,19 +261,28 @@ void FileMenu::buttonsForEmptyWorkspace()
 	_actionButtons->setEnabled(ActionButtons::Close,			false);
 }
 
-void FileMenu::dataSetIORequestStarted()
+void FileMenu::fileEventRequestDispatcher()
 {
 	FileEvent* event = qobject_cast<FileEvent*>(sender());
-	connect(event, &FileEvent::completed, _mainWindow, [this, event]() { _mainWindow->dataSetIOCompleted(event); }, Qt::QueuedConnection);
-	_mainWindow->dataSetIORequestHandler(event);
 
-	if(event->operation() != FileEvent::FileClose)
-		setVisible(false); //If we just did something we are now done with the filemenu right? Except if we just closed a file
+    // When an event starts, many objects can be involved. It's important to be sure that when an event is set completed, that all computing is effectly done.
+    // The event is set finalized only here, when the MainWindow has finished the finalizing work for the event: all other objects connected with the completed signal should use direct connection.
+    // This is to ensure that when the event is set finalized, no other objects are still using the event.
+    // The finalize signal can be used to compute other stuff (like in chaining event), but the event self should not be used anymore since it is then deleted.
+    connect(event, &FileEvent::completed, this,         &FileMenu::fileEventRequestFinalize);
+    connect(event, &FileEvent::completed, _mainWindow,  [this, event]() { _mainWindow->fileEventRequestFinalize(event); event->setFinalized(); }, Qt::QueuedConnection);
+
+    _mainWindow->fileEventRequestHandler(event);
+
 }
 
-void FileMenu::dataSetIORequestCompleted()
+void FileMenu::fileEventRequestFinalize()
 {
 	FileEvent* event = qobject_cast<FileEvent*>(sender());
+
+    if(event->operation() != FileEvent::FileClose)
+        setVisible(false); //If we just did something we are now done with the filemenu right? Except if we just closed a file
+
 	if (event->operation() == FileEvent::FileSave || event->operation() == FileEvent::FileOpen)
 	{
 		if (event->isSuccessful() && !event->isTmp())

Desktop/widgets/filemenu/filemenu.h

@@ -124,8 +124,8 @@ public slots:
 	void workspaceModified();
 	void setSyncFile(FileEvent *event);
 	void dataAutoSynchronizationChanged(bool on) { setDataFileWatcher(on); }
-	void dataSetIORequestStarted();
-	void dataSetIORequestCompleted();
+	void fileEventRequestDispatcher();
+	void fileEventRequestFinalize();
 	void dataFileModifiedHandler(QString path);
 	void setFileoperation(const ActionButtons::FileOperation fo);
 	void actionButtonClicked(const ActionButtons::FileOperation action);

Desktop/widgets/filemenu/osf.cpp

@@ -287,7 +287,7 @@ void OSF::openSaveFile(const QString & nodePath, const QString & filename, const
 		{
 			setSavefilename(filename);
 
-			connect(event, SIGNAL(completed(FileEvent*)), this, SLOT(openSaveCompleted(FileEvent*)));
+            connect(event, &FileEvent::completed, this, &OSF::openSaveCompleted);
 		}
 	}
 	else
@@ -307,13 +307,12 @@ void OSF::userDetailsReceived()
 	userNode->deleteLater();
 }
 
-void OSF::openSaveCompleted(FileEvent* event)
+void OSF::openSaveCompleted()
 {
+    FileEvent* event = qobject_cast<FileEvent*>(sender());
 
 	if (event->isSuccessful())
-	{
 		_osfFileSystem->refresh();
-	}
 
 	setProcessing(false);
 }

Desktop/widgets/filemenu/osf.h

@@ -96,7 +96,7 @@ private slots:
 	void saveClicked();
 	void openSaveFile(const QString & nodePath, const QString & filename, const QString & osfpath = "");
 	void userDetailsReceived();
-	void openSaveCompleted(FileEvent * event);
+    void openSaveCompleted();
 	void updateUserDetails();
 	void newFolderCreated();
 	void resetOSFListModel();