ProcessingAlgoWidget.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/ProcessingAlgoWidget.h"
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/AlgorithmManager.h"
#include "MantidQtWidgets/Common/QSettingsChangeAware.h"
#include <QFileDialog>
#include <QFileInfo>
#include <QMessageBox>
#include <QSettings>
#include <Qsci/qscilexerpython.h>
#include <fstream>
#include <iosfwd>
#include <utility>
 
using Mantid::API::Algorithm_sptr;
using Mantid::API::AlgorithmManager;
 
namespace MantidQt::MantidWidgets {
 
ProcessingAlgoWidgetSettings::ProcessingAlgoWidgetSettings(QString lastFile) : m_lastFile(std::move(lastFile)) {}
 
const QString &ProcessingAlgoWidgetSettings::lastFile() const { return m_lastFile; }
 
ProcessingAlgoWidgetSettings ProcessingAlgoWidgetSettings::readSettings(const QSettings &settings) {
  return ProcessingAlgoWidgetSettings(settings.value("LastFile", QString()).toString());
}
 
void ProcessingAlgoWidgetSettings::saveSettings(QSettings &settings, const ProcessingAlgoWidgetSettings &values) {
  QSettingsChangeAware(settings).setValue("LastFile", values.lastFile());
}
 
//----------------------
// Public member functions
//----------------------
ProcessingAlgoWidget::ProcessingAlgoWidget(QWidget *parent) : QWidget(parent) {
  ui.setupUi(this);
 
  // Load all available algorithms
  ui.algoSelector->update();
 
  // Enable syntax highlighting
  ui.editor->setLexer(new QsciLexerPython);
 
  // Layout tweak
  QList<int> sizes;
  sizes.push_back(300);
  sizes.push_back(1000);
  ui.splitter->setSizes(sizes);
  ui.splitter->setStretchFactor(0, 0);
  ui.splitter->setStretchFactor(1, 0);
 
  //=========== SLOTS =============
  connect(ui.algoSelector, SIGNAL(algorithmSelectionChanged(const QString &, int)), this, SLOT(changeAlgorithm()));
 
  connect(ui.btnSave, SIGNAL(clicked()), this, SLOT(btnSaveClicked()));
  connect(ui.btnLoad, SIGNAL(clicked()), this, SLOT(btnLoadClicked()));
 
  QSettings settings;
  settings.beginGroup("Mantid/ProcessingAlgoWidget");
  restoreSettings(ProcessingAlgoWidgetSettings::readSettings(settings));
  settings.endGroup();
}
 
//------------------------------------------------------------------------------
ProcessingAlgoWidget::~ProcessingAlgoWidget() {
  QSettings settings;
  settings.beginGroup("Mantid/ProcessingAlgoWidget");
  ProcessingAlgoWidgetSettings::saveSettings(settings, captureSettings());
  settings.endGroup();
}
 
//------------------------------------------------------------------------------
void ProcessingAlgoWidget::saveInput() { ui.algoProperties->saveInput(); }
 
//------------------------------------------------------------------------------------
void ProcessingAlgoWidget::restoreSettings(const ProcessingAlgoWidgetSettings &settings) {
  m_lastFile = settings.lastFile();
}
 
ProcessingAlgoWidgetSettings ProcessingAlgoWidget::captureSettings() const {
  return ProcessingAlgoWidgetSettings(m_lastFile);
}
 
//------------------------------------------------------------------------------
void ProcessingAlgoWidget::btnSaveClicked() {
  // Save to a .py file
  QString fileselection = QFileDialog::getSaveFileName(
      this, "Save a Python Script", QFileInfo(m_lastFile).absoluteFilePath(), "Python scripts (*.py);;All files (*)");
  if (!fileselection.isEmpty()) {
    m_lastFile = fileselection;
    std::ofstream file;
    file.exceptions(std::ifstream::failbit | std::ifstream::badbit);
    try {
      file.open(fileselection.toStdString().c_str());
      file << ui.editor->text().toStdString();
      file.close();
    } catch (std::ifstream::failure &e) {
      QMessageBox::critical(this, "Exception saving file " + m_lastFile,
                            QString("The file could not be saved due to the following exception:\n") +
                                QString(e.what()));
    }
  }
}
 
//------------------------------------------------------------------------------
void ProcessingAlgoWidget::btnLoadClicked() {
  // Load a .py file
  QString fileselection = QFileDialog::getOpenFileName(
      this, "Load a Python Script", QFileInfo(m_lastFile).absoluteFilePath(), "Python scripts (*.py);;All files (*)");
  if (!fileselection.isEmpty()) {
    m_lastFile = fileselection;
    std::ifstream file(fileselection.toStdString().c_str());
    std::stringstream buffer;
    buffer << file.rdbuf();
    ui.editor->setText(QString::fromStdString(buffer.str()));
    file.close();
  }
}
 
//------------------------------------------------------------------------------
void ProcessingAlgoWidget::changeAlgorithm() {
  auto alg = ui.algoSelector->getSelectedAlgorithm();
  try {
    m_alg = AlgorithmManager::Instance().createUnmanaged(alg.name.toStdString(), alg.version);
    m_alg->initialize();
  } catch (std::runtime_error &) {
    // Ignore when the m_algorithm is not found
    m_alg = Algorithm_sptr();
 
    // Signal that the algorithm just changed
    emit changedAlgorithm();
    return;
  }
  QStringList disabled;
  disabled.push_back("OutputWorkspace");
  disabled.push_back("InputWorkspace");
  disabled.push_back("Workspace");
  ui.algoProperties->addEnabledAndDisableLists(QStringList(), disabled);
  // Sets the m_algorithm and also the properties from the InputHistory
  ui.algoProperties->setAlgorithm(m_alg);
  ui.algoProperties->hideOrDisableProperties();
 
  // Signal that the algorithm just changed
  emit changedAlgorithm();
}
 
//------------------------------------------------------------------------------
void ProcessingAlgoWidget::setSelectedAlgorithm(QString algo) {
  ui.algoSelector->setSelectedAlgorithm(algo);
  this->changeAlgorithm();
}
 
QString ProcessingAlgoWidget::getScriptText() { return ui.editor->text(); }
void ProcessingAlgoWidget::setScriptText(const QString &text) { ui.editor->setText(text); }
 
} // namespace MantidQt::MantidWidgets