MultiFileNameParser.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2010 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 "MantidKernel/DllConfig.h"
 
#include <set>
#include <string>
#include <utility>
#include <vector>
 
namespace Mantid {
namespace Kernel {
namespace MultiFileNameParsing {
MANTID_KERNEL_DLL std::string suggestWorkspaceName(const std::vector<std::string> &fileNames);
 
namespace Regexs {
extern const std::string INST, UNDERSCORE, SPACE;
extern const std::string COMMA, PLUS, MINUS, COLON;
extern const std::string SINGLE, RANGE, STEP_RANGE, ADD_LIST, ADD_RANGE, ADD_STEP_RANGE;
extern const std::string ANY, LIST;
} // namespace Regexs
 
class MANTID_KERNEL_DLL ReverseCaselessCompare {
public:
  bool operator()(const std::string &a, const std::string &b) const;
};
 
class MANTID_KERNEL_DLL Parser {
public:
  Parser();
  ~Parser() = default;
 
  void parse(const std::string &multiFileName);
 
  std::vector<std::vector<unsigned int>> runs() const { return m_runs; }
  std::vector<std::vector<std::string>> fileNames() const { return m_fileNames; }
  std::string dirString() const { return m_dirString; }
  std::string instString() const { return m_instString; }
  std::string underscoreString() const { return m_underscoreString; }
  std::string runString() const { return m_runString; }
  std::string extString() const { return m_extString; }
  std::vector<std::vector<unsigned int>> parseMultiRunString(std::string runString);
  bool trimWhiteSpaces() const;
  void setTrimWhiteSpaces(const bool &setting);
 
private:
  void clear();
  void split();
 
  std::vector<std::vector<unsigned int>> m_runs;
  std::vector<std::vector<std::string>> m_fileNames;
  std::string m_multiFileName;
  std::string m_dirString, m_instString, m_underscoreString, m_runString, m_extString;
  std::set<std::string, ReverseCaselessCompare> m_validInstNames;
  bool m_trimWhiteSpaces;
};
 
class MANTID_KERNEL_DLL GenerateFileName {
public:
  GenerateFileName(std::string prefix, std::string suffix, std::string instString);
 
  std::vector<std::string> operator()(const std::vector<unsigned int> &runs);
  std::string operator()(unsigned int run);
 
private:
  std::string m_prefix;
  std::string m_suffix;
  std::string m_instString;
};
 
class MANTID_KERNEL_DLL RunRangeList {
public:
  RunRangeList();
 
  // Returns the list of run ranges.
  std::set<std::pair<unsigned int, unsigned int>> rangeList() const { return m_rangeList; };
 
  void addRun(const unsigned int run);
  void addRunRange(const unsigned int from, const unsigned int to);
  void addRunRange(const std::pair<unsigned int, unsigned int> &range);
 
private:
  std::set<std::pair<unsigned int, unsigned int>> m_rangeList;
};
 
} // namespace MultiFileNameParsing
 
} // namespace Kernel
} // namespace Mantid