ScopedFileHelper.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 "MantidFrameworkTestHelpers/ScopedFileHelper.h"
#include "MantidKernel/Logger.h"
 
#include <filesystem>
 
namespace {
Mantid::Kernel::Logger logger("ScopedFileHelper");
}
 
namespace ScopedFileHelper {
ScopedFile::ScopedFile(const std::string &fileContents, const std::string &fileName) {
  std::filesystem::path path(Mantid::Kernel::ConfigService::Instance().getTempDir().c_str());
  path /= fileName;
  doCreateFile(fileContents, path);
}
 
ScopedFile::ScopedFile(const std::string &fileContents, const std::string &fileName, const std::string &fileDirectory) {
  std::filesystem::path path(fileDirectory);
  path /= fileName;
  doCreateFile(fileContents, path);
}
 
void ScopedFile::release() const { this->m_filename.clear(); }
 
ScopedFile &ScopedFile::operator=(const ScopedFile &other) {
  if (this != &other) {
    this->m_file.close();
    this->m_filename = other.m_filename;
    other.release();
  }
  return *this;
}
 
ScopedFile::ScopedFile(const ScopedFile &other) {
  this->m_filename = other.m_filename;
  other.release();
}
 
void ScopedFile::doCreateFile(const std::string &fileContents, const std::filesystem::path &fileNameAndPath) {
  m_filename = fileNameAndPath.string();
  m_file.open(m_filename.c_str(), std::ios_base::out);
  if (!m_file.is_open()) {
    throw std::runtime_error("Cannot open " + m_filename);
  }
  m_file << fileContents;
  m_file.close();
}
 
const std::string &ScopedFile::getFileName() const { return m_filename; }
 
ScopedFile::~ScopedFile() {
  if (!m_filename.empty()) // check that file should be disposed.
  {
    m_file.close();
    if (remove(m_filename.c_str()) != 0) {
      // destructors shouldn't throw exceptions so we have to resort to printing
      // an error
      logger.error() << "~ScopedFile() - Error deleting file '" << m_filename << "'\n";
    }
  }
}
} // namespace ScopedFileHelper