UserSubWindowFactory.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2019 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/DynamicFactory.h"
#include "MantidKernel/SingletonHolder.h"
#include "MantidQtWidgets/Common/BaseDecoder.h"
#include "MantidQtWidgets/Common/BaseEncoder.h"
#include <QHash>
#include <QSetIterator>
#include <QStringList>
#include <boost/optional.hpp>
#include <set>
 
namespace MantidQt {
 
namespace API {
 
//-------------------------------
// MantidQt forward declarations
//-------------------------------
class AlgorithmDialog;
class UserSubWindow;
 
class EXPORT_OPT_MANTIDQT_COMMON UserSubWindowFactoryImpl : public Mantid::Kernel::DynamicFactory<UserSubWindow> {
public:
  UserSubWindowFactoryImpl(const UserSubWindowFactoryImpl &) = delete;
  UserSubWindowFactoryImpl &operator=(const UserSubWindowFactoryImpl &) = delete;
  // Override createUnwrapped to search through the alias list
  UserSubWindow *createUnwrapped(const std::string &name) const override;
 
  QSet<QString> categories(const QString &interfaceName) const;
  QStringList keys() const;
 
  BaseEncoder *findEncoder(QWidget *window);
  BaseDecoder *findDecoder(const std::string &decodeString);
 
  template <typename TYPE> void subscribe();
  template <typename WindowType, typename EncoderType, typename DecoderType>
  void subscribe(const std::string &decoderTag);
 
protected:
  // Unhide the inherited create method
  using Mantid::Kernel::DynamicFactory<UserSubWindow>::createUnwrapped;
 
private:
  friend struct Mantid::Kernel::CreateUsingNew<UserSubWindowFactoryImpl>;
 
  UserSubWindowFactoryImpl();
  ~UserSubWindowFactoryImpl() override = default;
  UserSubWindow *createFromAlias(const std::string &name) const;
 
  template <typename TYPE> void saveAliasNames(const std::string &realName);
 
private:
  QHash<QString, std::string> m_aliasLookup;
  QHash<QString, QList<std::string>> m_badAliases;
  QHash<QString, QSet<QString>> m_categoryLookup;
 
  // QHash doesn't seem to support std::unique_ptr<> as a valueso a std::map is
  // used instead
  std::map<std::string, std::shared_ptr<Mantid::Kernel::AbstractInstantiator<BaseEncoder>>> m_encoders;
  std::map<std::string, std::shared_ptr<Mantid::Kernel::AbstractInstantiator<BaseDecoder>>> m_decoders;
};
 
template <typename TYPE> void UserSubWindowFactoryImpl::subscribe() {
  std::string realName = TYPE::name();
  Mantid::Kernel::DynamicFactory<UserSubWindow>::subscribe<TYPE>(realName);
  saveAliasNames<TYPE>(realName);
 
  // Make a record of each interface's categories.
  const QStringList categories = TYPE::categoryInfo().split(";", Qt::SkipEmptyParts);
  QSet<QString> result;
  foreach (const QString category, categories) { result.insert(category.trimmed()); }
  m_categoryLookup[QString::fromStdString(realName)] = result;
}
 
template <typename WindowType, typename EncoderType, typename DecoderType>
void UserSubWindowFactoryImpl::subscribe(const std::string &decoderTag) {
  subscribe<WindowType>();
  m_encoders.insert({WindowType::name(), std::make_shared<Mantid::Kernel::Instantiator<EncoderType, BaseEncoder>>()});
  m_decoders.insert({decoderTag, std::make_shared<Mantid::Kernel::Instantiator<DecoderType, BaseDecoder>>()});
}
 
template <typename TYPE> void UserSubWindowFactoryImpl::saveAliasNames(const std::string &realName) {
  std::set<std::string> aliases = TYPE::aliases();
  for (const auto &alias_std_str : aliases) {
    QString alias = QString::fromStdString(alias_std_str);
    if (m_aliasLookup.contains(alias)) {
      if (m_badAliases.contains(alias)) {
        QList<std::string> names = m_badAliases.value(alias);
        names.append(realName);
        m_badAliases[alias] = names;
      } else {
        QList<std::string> names;
        names.append(m_aliasLookup.value(alias));
        names.append(realName);
        m_badAliases.insert(alias, names);
      }
      continue;
    }
    m_aliasLookup.insert(alias, realName);
  }
}
 
using UserSubWindowFactory = Mantid::Kernel::SingletonHolder<UserSubWindowFactoryImpl>;
 
} // namespace API
} // namespace MantidQt
 
namespace Mantid {
namespace Kernel {
EXTERN_MANTIDQT_COMMON template class EXPORT_OPT_MANTIDQT_COMMON
    Mantid::Kernel::SingletonHolder<MantidQt::API::UserSubWindowFactoryImpl>;
} // namespace Kernel
} // namespace Mantid