itkStringTools.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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
 *
 *         http://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 itkStringTools_h
#define itkStringTools_h

#include <vector>
#include <map>
#include "itkArray.h"
#include "ITKIOXMLExport.h"

namespace itk
{

class ITKIOXML_EXPORT StringTools
{
public:
  // helper functions for converting a string to/from a std::vector

  template < typename T >
  static std::string& ToData( std::string& s, std::vector<T>& data, int count = -1 );

  template < typename T >
  static std::string& FromData( std::string& s, const std::vector<T>& data );

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

  template < typename T >
  static std::string& ToData( std::string& s, Array<T>& data, int count = -1 );

  template < typename T >
  static std::string& FromData( std::string& s, const Array<T>& data );

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

  template < typename T >
  static std::string& ToData( std::string& s, T& data );

  template < typename T >
  static std::string& FromData( std::string& s, const T& data );

  // helper functions for string manipulations

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

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

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

  static std::string& ToUpperCase( std::string& str );

  static std::string& ToLowerCase( std::string& str );

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

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

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

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

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

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

  static bool ContainSub( const std::string& s1, const std::string& s2, bool ignoreCase = true );
}; // class StringTools

} // namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkStringTools.hxx"
#endif

#endif // itkStringTools_h