FindFilesThreadPoolManager.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#include "MantidQtWidgets/Common/FindFilesThreadPoolManager.h"
#include "MantidAPI/AlgorithmManager.h"
#include "MantidAPI/FileFinder.h"
#include "MantidAPI/FileProperty.h"
#include "MantidAPI/MultipleFileProperty.h"
#include "MantidKernel/ConfigService.h"
#include "MantidKernel/FacilityInfo.h"
#include "MantidKernel/VectorHelper.h"
 
#include <Poco/File.h>
#include <QCoreApplication>
#include <QSharedPointer>
#include <boost/algorithm/string.hpp>
#include <utility>
 
using namespace Mantid::Kernel;
using namespace Mantid::API;
using namespace MantidQt::API;
 
// Thread pool to run file finder workers on
static std::unique_ptr<QThreadPool> tp = {nullptr};
 
const std::unique_ptr<QThreadPool> &FindFilesThreadPoolManager::poolInstance() const {
  if (!tp)
    tp = std::make_unique<QThreadPool>();
  return tp;
}
 
void MantidQt::API::FindFilesThreadPoolManager::destroyThreadPool() {
  if (tp)
    tp.reset();
}
 
FindFilesThreadPoolManager::FindFilesThreadPoolManager()
    : m_workerAllocator([](const FindFilesSearchParameters &parameters) { return new FindFilesWorker(parameters); }) {}
 
void FindFilesThreadPoolManager::setAllocator(ThreadAllocator allocator) { m_workerAllocator = std::move(allocator); }
 
void FindFilesThreadPoolManager::createWorker(const QObject *parent, const FindFilesSearchParameters &parameters) {
  cancelWorker();
 
  // if parent is null then don't do anything as there will be no
  // object listening for the search result
  if (!parent)
    return;
 
  auto worker = m_workerAllocator(parameters);
  connectWorker(parent, worker);
 
  // pass ownership to the thread pool
  // we do not need to worry about deleting worker
  poolInstance()->start(worker);
  m_searchIsRunning = true;
}
 
void FindFilesThreadPoolManager::connectWorker(const QObject *parent, const FindFilesWorker *worker) {
  parent->connect(worker, SIGNAL(finished(const FindFilesSearchResults &)), parent,
                  SLOT(inspectThreadResult(const FindFilesSearchResults &)), Qt::QueuedConnection);
 
  parent->connect(worker, SIGNAL(finished(const FindFilesSearchResults &)), parent, SIGNAL(fileFindingFinished()),
                  Qt::QueuedConnection);
 
  this->connect(worker, SIGNAL(finished(const FindFilesSearchResults &)), this, SLOT(searchFinished()),
                Qt::QueuedConnection);
 
  this->connect(this, SIGNAL(disconnectWorkers()), worker, SLOT(disconnectWorker()), Qt::QueuedConnection);
}
 
void FindFilesThreadPoolManager::cancelWorker() {
  // Just disconnect any signals from the worker. We leave the worker to
  // continue running in the background because 1) terminating it directly
  // is dangerous (we have no idea what it's currently doing from here) and 2)
  // waiting for it to finish before starting a new thread locks up the GUI
  // event loop.
  emit disconnectWorkers();
  m_searchIsRunning = false;
  QCoreApplication::sendPostedEvents();
}
 
bool FindFilesThreadPoolManager::isSearchRunning() const { return m_searchIsRunning; }
 
void FindFilesThreadPoolManager::waitForDone() { poolInstance()->waitForDone(); }
 
void FindFilesThreadPoolManager::searchFinished() { m_searchIsRunning = false; }