SelectFunctionDialog.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 +
//-------------------------------------------
// Includes
//-------------------------------------------
#include "MantidQtWidgets/Common/SelectFunctionDialog.h"
#include "ui_SelectFunctionDialog.h"
 
#include "MantidAPI/FunctionFactory.h"
#include "MantidAPI/IFunction.h"
#include "MantidQtWidgets/Common/HelpWindow.h"
 
#include <boost/lexical_cast.hpp>
 
#include <QButtonGroup>
#include <QCheckBox>
#include <QComboBox>
#include <QCompleter>
#include <QGridLayout>
#include <QGroupBox>
#include <QIcon>
#include <QLabel>
#include <QPushButton>
#include <QTreeWidget>
#include <QVBoxLayout>
 
namespace MantidQt::MantidWidgets {
 
SelectFunctionDialog::SelectFunctionDialog(QWidget *parent)
    : SelectFunctionDialog(parent, std::vector<std::string>()) {}
 
SelectFunctionDialog::SelectFunctionDialog(QWidget *parent, const std::vector<std::string> &restrictions)
    : MantidDialog(parent), m_form(new Ui::SelectFunctionDialog) {
  setWindowModality(Qt::WindowModal);
  setWindowIcon(QIcon(":/images/MantidIcon.ico"));
  m_form->setupUi(this);
  m_form->errorMessage->hide();
 
  auto &factory = Mantid::API::FunctionFactory::Instance();
  auto registeredFunctions = factory.getFunctionNamesGUI();
  // Add functions to each of the categories. If it appears in more than one
  // category then add to both
  // Store in a map. Key = category. Value = vector of fit functions belonging
  // to that category.
  std::map<std::string, std::vector<std::string>> categories;
  for (const auto &registeredFunction : registeredFunctions) {
    auto f = factory.createFunction(registeredFunction);
    std::vector<std::string> tempCategories = f->categories();
    for (size_t j = 0; j < tempCategories.size(); ++j) {
      categories[tempCategories[boost::lexical_cast<int>(j)]].emplace_back(registeredFunction);
    }
  }
 
  // Set up the search box
  m_form->searchBox->completer()->setCompletionMode(QCompleter::PopupCompletion);
  m_form->searchBox->completer()->setFilterMode(Qt::MatchContains);
 
  // Complete suggestions in search box,
  // number of suggestions same as number of registeredFunctions
  addSearchBoxFunctionNames(registeredFunctions);
 
  connect(m_form->searchBox, SIGNAL(editTextChanged(const QString &)), this, SLOT(searchBoxChanged(const QString &)));
 
  // Construct the QTreeWidget based on the map information of categories and
  // their respective fit functions.
  constructFunctionTree(categories, restrictions);
  setMinimumHeightOfFunctionTree();
 
  connect(m_form->fitTree, SIGNAL(itemDoubleClicked(QTreeWidgetItem *, int)), this,
          SLOT(functionDoubleClicked(QTreeWidgetItem *)));
  m_form->fitTree->setToolTip("Select a function type and press OK.");
 
  connect(m_form->buttonBox, SIGNAL(accepted()), this, SLOT(acceptFunction()));
  connect(m_form->buttonBox, SIGNAL(rejected()), this, SLOT(rejectFunction()));
 
  m_form->searchBox->setCurrentIndex(-1);
 
  connect(m_form->helpButton, SIGNAL(clicked()), this, SLOT(helpClicked()));
}
 
void SelectFunctionDialog::addSearchBoxFunctionNames(const std::vector<std::string> &registeredFunctions) {
  for (const auto &function : registeredFunctions) {
    m_form->searchBox->addItem(QString::fromStdString(function));
  }
}
 
void SelectFunctionDialog::constructFunctionTree(
    const std::map<std::string, std::vector<std::string>> &categoryFunctionsMap,
    const std::vector<std::string> &restrictions) {
  // Don't show category if it's not in the list (unless list is empty)
  auto showCategory = [&restrictions](const std::string &name) {
    if (restrictions.empty()) {
      return true;
    } else {
      return (std::find(restrictions.begin(), restrictions.end(), name) != restrictions.end());
    }
  };
 
  // keeps track of categories added to the tree
  QMap<QString, QTreeWidgetItem *> categories;
 
  for (const auto &entry : categoryFunctionsMap) {
 
    QString categoryName = QString::fromStdString(entry.first);
    QStringList subCategories = categoryName.split('\\');
    if (!categories.contains(categoryName)) {
      if (subCategories.size() == 1) {
        if (showCategory(entry.first)) {
          QTreeWidgetItem *catItem = new QTreeWidgetItem(QStringList(categoryName));
          categories.insert(categoryName, catItem);
          m_form->fitTree->addTopLevelItem(catItem);
          for (const auto &function : entry.second) {
            QTreeWidgetItem *fit = new QTreeWidgetItem(catItem);
            fit->setText(0, QString::fromStdString(function));
          }
        }
      } else {
        // go through the path and add the folders if they don't already exist
        QString currentPath = subCategories[0];
        QTreeWidgetItem *catItem = nullptr;
        int subCategoryNo = subCategories.size();
        bool show = false;
        for (int j = 0; j < subCategoryNo; ++j) {
          if (showCategory(subCategories[j].toStdString())) {
            show = true;
          }
        }
        if (show) {
          for (int j = 0; j < subCategoryNo; ++j) {
            if (categories.contains(currentPath)) {
              catItem = categories[currentPath];
            } else {
              QTreeWidgetItem *newCatItem = new QTreeWidgetItem(QStringList(subCategories[j]));
              categories.insert(currentPath, newCatItem);
              if (!catItem) {
                m_form->fitTree->addTopLevelItem(newCatItem);
              } else {
                catItem->addChild(newCatItem);
              }
              catItem = newCatItem;
            }
            if (j != subCategoryNo - 1)
              currentPath += "\\" + subCategories[j + 1];
            else {
              // This is the end of the path so add the functions
              for (const auto &function : entry.second) {
                QTreeWidgetItem *fit = new QTreeWidgetItem(catItem);
                fit->setText(0, QString::fromStdString(function));
              }
            }
          }
        }
      }
    }
  }
}
 
SelectFunctionDialog::~SelectFunctionDialog() { delete m_form; }
 
void SelectFunctionDialog::setMinimumHeightOfFunctionTree() {
  auto const numberOfTopLevelItems = m_form->fitTree->topLevelItemCount();
  if (numberOfTopLevelItems > 0) {
    auto const firstItem = m_form->fitTree->topLevelItem(0);
    auto const itemHeight = m_form->fitTree->visualItemRect(firstItem).height();
    m_form->fitTree->setMinimumHeight(itemHeight * numberOfTopLevelItems);
  }
}
 
QString SelectFunctionDialog::getFunction() const {
  const auto searchText = m_form->searchBox->currentText();
  QList<QTreeWidgetItem *> items(m_form->fitTree->selectedItems());
  if (items.size() == 1 && items[0]->childCount() == 0) {
    return items[0]->text(0);
  } else if (m_form->searchBox->findText(searchText) >= 0) {
    return searchText;
  }
  return "";
}
 
void SelectFunctionDialog::clearSearchBoxText() const { m_form->searchBox->clearEditText(); }
 
void SelectFunctionDialog::searchBoxChanged(const QString &text) {
  if (text.isEmpty()) {
    return;
  }
  m_form->fitTree->setCurrentIndex(QModelIndex());
 
  const auto index = m_form->searchBox->findText(text);
  if (index >= 0)
    m_form->searchBox->setCurrentIndex(index);
}
 
void SelectFunctionDialog::functionDoubleClicked(QTreeWidgetItem *item) {
  if (item->childCount() == 0)
    acceptFunction();
}
 
void SelectFunctionDialog::acceptFunction() {
  const auto func = getFunction();
  if (func.isEmpty()) {
    m_form->errorMessage->setText(QString("<span style='color:red'> Function  not found</span> "));
    m_form->errorMessage->show();
  } else {
    m_form->errorMessage->hide();
    accept();
  }
}
 
void SelectFunctionDialog::rejectFunction() {
  m_form->errorMessage->hide();
  reject();
}
 
void SelectFunctionDialog::helpClicked() const {
  auto function = getFunction();
  if (!function.isEmpty()) {
    MantidQt::API::HelpWindow::showFitFunction(function.toStdString());
  } else { // No function selected open fit function index
    MantidQt::API::HelpWindow::showFitFunction("");
  }
}
 
} // namespace MantidQt::MantidWidgets