StringTokenizer.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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 <cstddef> //std::size_t
#include <string>
#include <vector>
 
#include "MantidKernel/DllConfig.h"
 
namespace Mantid {
namespace Kernel {
 
class MANTID_KERNEL_DLL StringTokenizer final {
public:
  enum Options {
    TOK_IGNORE_EMPTY = 1,            
    TOK_TRIM = 2,                    
    TOK_IGNORE_FINAL_EMPTY_TOKEN = 4 
  };
  using TokenVec = std::vector<std::string>;
  using Iterator = std::vector<std::string>::iterator;
  using ConstIterator = std::vector<std::string>::const_iterator;
  StringTokenizer() = default;
  StringTokenizer(const std::string &str, const std::string &separators, unsigned options = 0);
 
  ~StringTokenizer() = default;
 
  Iterator begin() { return m_tokens.begin(); }
 
  Iterator end() { return m_tokens.end(); }
 
  ConstIterator begin() const { return m_tokens.cbegin(); }
  ConstIterator end() const { return m_tokens.cend(); }
 
  ConstIterator cbegin() const { return m_tokens.cbegin(); }
  ConstIterator cend() const { return m_tokens.cend(); }
 
  const std::string &operator[](std::size_t index) const { return m_tokens[index]; }
 
  std::string &operator[](std::size_t index) { return m_tokens[index]; }
 
  const TokenVec &asVector() { return m_tokens; }
 
  const std::string &at(std::size_t index) const { return m_tokens.at(index); }
 
  std::string &at(std::size_t index) { return m_tokens.at(index); }
 
  std::size_t count() const { return m_tokens.size(); }
 
  std::size_t size() const noexcept { return m_tokens.size(); }
 
private:
  std::vector<std::string> m_tokens;
};
} // namespace Kernel
} // namespace Mantid