itkFancyString.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
 
#ifndef itkFancyString_h
#define itkFancyString_h
 
#include <string>
#include <vector>
#include <map>
#include "itkArray.h"
#include "ITKIOXMLExport.h"
 
namespace itk
{

class ITKIOXML_EXPORT FancyString
{
public:
  FancyString();
  FancyString(const std::string & str);
  FancyString(const char * s);
 
  FancyString &
  operator=(const std::string & str);
  FancyString &
  operator=(const char * s);

  operator const char *() const;

  // helper functions for converting a string to/from a std::vector

  template <typename T>
  FancyString &
  ToData(std::vector<T> & outputData, int count = -1);

  template <typename T>
  FancyString &
  FromData(const std::vector<T> & inputData);

  // helper functions for converting a string to/from a itk::Array

  template <typename T>
  FancyString &
  ToData(Array<T> & outputData, int count = -1);

  template <typename T>
  FancyString &
  FromData(const Array<T> & inputData);

  // helper functions for converting a string to/from a basic data type

  operator const std::string &() const;

  const std::string &
  ToString() const;

  template <typename T>
  FancyString &
  ToData(T & outputData);

  template <typename T>
  FancyString &
  FromData(const T & inputData);

  // helper functions for string manipulations

  void
  ClearContent();

  void
  Append(const FancyString & str);

  FancyString &
  Trim(const std::string & dislike = " \t\n\r");

  FancyString &
  TrimLeft(const std::string & dislike = " \t\n\r");

  FancyString &
  TrimRight(const std::string & dislike = " \t\n\r");

  FancyString &
  ToUpperCase();

  FancyString &
  ToLowerCase();

  void
  Split(std::string & lpart, std::string & rpart, const std::string & delims = "=:") const;

  void
  Split(std::vector<std::string> & result, const std::string & delims = ";|") const;

  void
  Split(std::map<std::string, std::string> & result, const std::string & delims = ";|");

  bool
  MatchWith(const std::string & s2, bool ignoreCase = true);

  bool
  StartWith(const std::string & s2, bool ignoreCase = true);

  bool
  EndWith(const std::string & s2, bool ignoreCase = true);

  bool
  ContainSub(const std::string & s2, bool ignoreCase = true);
 
private:
  std::string m_Value;
 
}; // class FancyString
 
} // namespace itk

// helper function to compare FancyString with std::string and char*
 
bool ITKIOXML_EXPORT
operator!=(itk::FancyString & s, const std::string &);
bool ITKIOXML_EXPORT
operator!=(itk::FancyString & s, const char *);
bool ITKIOXML_EXPORT
operator!=(itk::FancyString & s, const itk::FancyString &);
 
bool ITKIOXML_EXPORT
operator==(itk::FancyString & s, const std::string &);
bool ITKIOXML_EXPORT
operator==(itk::FancyString & s, const char *);
bool ITKIOXML_EXPORT
operator==(itk::FancyString & s, const itk::FancyString &);
 
namespace itk
{
// manipulators for FancyString (currently only one is defined)

FancyString &
operator<<(FancyString & s, void (*mf)(FancyString &));

void
ClearContent(FancyString & input);

// helper functions for converting a string to/from a std::vector

template <typename T>
FancyString &
operator>>(FancyString & s, std::vector<T> & data);

template <typename T>
FancyString &
operator<<(FancyString & s, const std::vector<T> & data);

// helper functions for converting a string to/from a itk::Array

template <typename T>
FancyString &
operator>>(FancyString & s, Array<T> & data);

template <typename T>
FancyString &
operator<<(FancyString & s, const Array<T> & data);

// helper functions for converting a string to/from a basic data type

template <typename T>
FancyString &
operator>>(FancyString & s, T & data);

template <typename T>
FancyString &
operator<<(FancyString & s, const T & data);
 
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkFancyString.hxx"
#endif
 
#endif // itkFancyString_h