FileProperty.h

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 +
#pragma once
 
//-----------------------------------------------------------------
// Includes
//-----------------------------------------------------------------
#include "MantidAPI/DllConfig.h"
#include "MantidKernel/PropertyWithValue.h"
 
namespace Mantid {
namespace API {
 
#ifdef _WIN32
#pragma warning(push)
// Disable 'multiple assignment operators specified' warning for this class
//  - it's not an accident that we have more than one
#pragma warning(disable : 4522)
#endif
 
class MANTID_API_DLL FileProperty : public Kernel::PropertyWithValue<std::string> {
public:
  enum FileAction {
    // Note that the order here ensures that the correct boolean gets passed to
    // the FileValidator.
    Save = 0,         
    OptionalSave = 1, 
    Load = 2,             
    OptionalLoad = 3,     
    Directory = 4,        
    OptionalDirectory = 5 
  };
 
  FileProperty(const std::string &name, const std::string &defaultValue, unsigned int action,
               const std::vector<std::string> &exts = std::vector<std::string>(),
               unsigned int direction = Kernel::Direction::Input);
  FileProperty(const std::string &name, const std::string &default_value, unsigned int action, const std::string &ext,
               unsigned int direction = Kernel::Direction::Input);
  FileProperty(const std::string &name, const std::string &default_value, unsigned int action,
               std::initializer_list<std::string> exts, unsigned int direction = Kernel::Direction::Input);
 
  FileProperty(const FileProperty &) = default;
  FileProperty &operator=(const FileProperty &) = default;
 
  FileProperty *clone() const override { return new FileProperty(*this); }
 
  bool isLoadProperty() const;
  bool isSaveProperty() const;
  bool isDirectoryProperty() const;
  bool isOptional() const;
  std::string setValue(const std::string &propValue) override;
  std::string isValid() const override;
 
  std::string getDefaultExt() const { return m_defaultExt; }
 
  // Unhide the PropertyWithValue assignment operator
  using Kernel::PropertyWithValue<std::string>::operator=;
 
private:
  std::string isEmptyValueValid() const;
  bool extsMatchRunFiles();
  std::string setLoadProperty(const std::string &propValue);
  std::string setSaveProperty(const std::string &propValue);
  unsigned int m_action;
  std::string m_defaultExt;
  bool m_runFileProp;
  std::string m_oldLoadPropValue;
  std::string m_oldLoadFoundFile;
};
 
#ifdef _WIN32
#pragma warning(pop) // Re-enable the warning about multiple assignment operators
#endif
} // namespace API
} // namespace Mantid