AlgorithmInputHistory.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2009 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 +
#pragma once
 
//----------------------------------
// Includes
//----------------------------------
#include "DllOption.h"
#include "MantidKernel/SingletonHolder.h"
#include "MantidQtWidgets/Common/Configurable.h"
#include <QHash>
#include <QString>
 
namespace MantidQt {
namespace API {
 
class EXPORT_OPT_MANTIDQT_COMMON AlgorithmInputHistorySettings {
public:
  using InputHistory = QHash<QString, QHash<QString, QString>>;
 
  AlgorithmInputHistorySettings(InputHistory lastInput = {}, QString previousDirectory = {});
 
  [[nodiscard]] InputHistory const &lastInput() const;
  [[nodiscard]] QString const &previousDirectory() const;
 
private:
  InputHistory m_lastInput;
  QString m_previousDirectory;
};
 
class EXPORT_OPT_MANTIDQT_COMMON AbstractAlgorithmInputHistory
    : public MantidWidgets::Configurable<AlgorithmInputHistorySettings> {
public:
  AbstractAlgorithmInputHistory(const AbstractAlgorithmInputHistory &) = delete;
  AbstractAlgorithmInputHistory &operator=(const AbstractAlgorithmInputHistory &) = delete;
  virtual ~AbstractAlgorithmInputHistory() override = 0;
 
  void storeNewValue(const QString &algName, const std::pair<QString, QString> &property);
 
  void clearAlgorithmInput(const QString &algName);
 
  QString previousInput(const QString &algName, const QString &propName) const;
 
  void setPreviousDirectory(const QString &lastdir);
 
  const QString &getPreviousDirectory() const;
 
  void save() const;
 
  [[nodiscard]] AlgorithmInputHistorySettings readSettings(const QSettings &storage) const;
  void restoreSettings(const AlgorithmInputHistorySettings &settings) override;
  [[nodiscard]] AlgorithmInputHistorySettings captureSettings() const override;
  void saveSettings(QSettings &storage, const AlgorithmInputHistorySettings &settings) const;
 
protected:
  AbstractAlgorithmInputHistory(const QString &settingsGroup);
 
private:
  void initializeSettings();
 
  QHash<QString, QHash<QString, QString>> m_lastInput;
 
  QString m_previousDirectory;
 
  QString m_algorithmsGroup;
 
  QString m_dirKey;
};
 
class EXPORT_OPT_MANTIDQT_COMMON AlgorithmInputHistoryImpl : public AbstractAlgorithmInputHistory {
private:
  AlgorithmInputHistoryImpl() : AbstractAlgorithmInputHistory("Mantid/Algorithms") {}
  ~AlgorithmInputHistoryImpl() override = default;
 
private:
  friend struct Mantid::Kernel::CreateUsingNew<AlgorithmInputHistoryImpl>;
};
 
using AlgorithmInputHistory = Mantid::Kernel::SingletonHolder<AlgorithmInputHistoryImpl>;
} // namespace API
} // namespace MantidQt
 
namespace Mantid {
namespace Kernel {
EXTERN_MANTIDQT_COMMON template class EXPORT_OPT_MANTIDQT_COMMON
    Mantid::Kernel::SingletonHolder<MantidQt::API::AlgorithmInputHistoryImpl>;
}
} // namespace Mantid