TextTools.h

Go to the documentation of this file.

//
// File: TextTools.h
// Created by: Julien Dutheil
// Created on: Fri Aug  8 12:57:50 2003
//

/*
   Copyright or © or Copr. Bio++ Development Team, (November 17, 2004)

   This software is a computer program whose purpose is to provide basal and
   utilitary classes. This file belongs to the Bio++ Project.

   This software is governed by the CeCILL  license under French law and
   abiding by the rules of distribution of free software.  You can  use, 
   modify and/ or redistribute the software under the terms of the CeCILL
   license as circulated by CEA, CNRS and INRIA at the following URL
   "http://www.cecill.info". 

   As a counterpart to the access to the source code and  rights to copy,
   modify and redistribute granted by the license, users are provided only
   with a limited warranty  and the software's author,  the holder of the
   economic rights,  and the successive licensors  have only  limited
   liability. 

   In this respect, the user's attention is drawn to the risks associated
   with loading,  using,  modifying and/or developing or reproducing the
   software by the user in light of its specific status of free software,
   that may mean  that it is complicated to manipulate,  and  that  also
   therefore means  that it is reserved for developers  and  experienced
   professionals having in-depth computer knowledge. Users are therefore
   encouraged to load and test the software's suitability as regards their
   requirements in conditions enabling the security of their systems and/or 
   data to be ensured and,  more generally, to use and operate it in the 
   same conditions as regards security. 

   The fact that you are presently reading this means that you have had
   knowledge of the CeCILL license and that you accept its terms.
   */

#ifndef _TEXTTOOLS_H_
#define _TEXTTOOLS_H_

#include "../Exceptions.h"


// From the STL:
#include <string>
#include <vector>
#include <sstream>
#include <iomanip>

namespace bpp
{

  class TextTools
  {
    public:

      static bool isEmpty(const std::string& s);

      static std::string toUpper(const std::string& s);

      static std::string toLower(const std::string& s);

      static bool isWhiteSpaceCharacter(char c);

      static std::string removeWhiteSpaces (const std::string& s);

      static std::string removeFirstWhiteSpaces (const std::string& s);

      static std::string removeLastWhiteSpaces (const std::string& s);

      static std::string removeSurroundingWhiteSpaces(const std::string& s);

      static bool isNewLineCharacter(char c);

      static std::string removeNewLines (const std::string& s);

      static std::string removeLastNewLines(const std::string& s);

      static bool isDecimalNumber(char c);

      static bool isDecimalNumber(const std::string& s, char dec = '.', char scientificNotation = 'e');

      static bool isDecimalInteger(const std::string& s, char scientificNotation = 'e');

      template<class T> static std::string toString(T t)
      {
        std::ostringstream oss;
        oss << t;
        return oss.str();
      }

      template<class T>
        static std::string toString(T t, int precision)
        {
          std::ostringstream oss;
          oss << std::setprecision(precision) << t;
          return oss.str();
        }

      template<class T> static T fromString(const std::string& s)
      {
        std::istringstream iss(s);
        T obj;
        iss >> obj;
        return obj;
      }

      static std::string toString(int i);

      static std::string toString(char c);

      static std::string toString(double d, int precision = 6);

      static int toInt(const std::string& s, char scientificNotation = 'e') throw (Exception);

      static double toDouble(const std::string& s, char dec = '.', char scientificNotation = 'e') throw (Exception);

      template<class T>
      static T to(const std::string& s)
      {
        std::istringstream iss(s);
        T t;
        iss >> t;
        return t;
      }

      static std::string resizeRight(const std::string& s, size_t newSize, char fill = ' ');

      static std::string resizeLeft(const std::string& s, size_t newSize, char fill = ' ');

      static std::vector<std::string> split(const std::string& s, size_t n);

      static std::string removeSubstrings(const std::string& s, char blockBeginning, char blockEnding)
        throw (Exception);
  
      static std::string removeSubstrings(const std::string& s, char blockBeginning, char blockEnding, std::vector<std::string>& exceptionsBeginning, std::vector<std::string>& exceptionsEnding)
        throw (Exception);
  
      static std::string removeChar(const std::string& s, char c);

      static unsigned int count(const std::string& s, const std::string& pattern);

      static bool startsWith(const std::string& s, const std::string& pattern);

      static bool endsWith(const std::string& s, const std::string& pattern);

      static bool hasSubstring(const std::string& s, const std::string& pattern);

      static void replaceAll(std::string& target, const std::string& query, const std::string& replacement);
     
  };

} //end of namespace bpp.

#endif  //_TEXTTOOLS_H_