Teuchos_StrUtils.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER

#ifndef TEUCHOS_STRUTILS_H
#define TEUCHOS_STRUTILS_H

#include "Teuchos_ConfigDefs.hpp"

#include "Teuchos_Utils.hpp"
#include "Teuchos_Array.hpp"

namespace Teuchos
{
  class TEUCHOS_LIB_DLL_EXPORT StrUtils
    {
    public:
      static Array<std::string> readFile(std::istream& is, char comment);

      static Array<std::string> splitIntoLines(const std::string& input);

      static Array<Array<std::string> > tokenizeFile(std::istream& is, char comment);

      static bool readLine(std::istream& is, std::string& line);

      static Array<std::string> stringTokenizer(const std::string& str);

      static Array<std::string> getTokensPlusWhitespace(const std::string& str);

      static std::string reassembleFromTokens(const Array<std::string>& tokens, int iStart=0);

      static void splitList(const std::string& bigstring, Array<std::string>& elements);

      static int findNextWhitespace(const std::string& str, int offset);

      static int findNextNonWhitespace(const std::string& str, int offset);


      static  std::string varSubstitute(const std::string& rawLine,
                                   const std::string& varName,
                                   const std::string& varValue);

      static std::string varTableSubstitute(const std::string& rawLine,
                                       const Array<std::string>& varNames,
                                       const Array<std::string>& varValues);

      static std::string envSubstitute(const std::string& line);

      static std::string before(const std::string& str, const std::string& sub);

      static std::string before(const std::string& str, char sub);

      static std::string after(const std::string& str, const std::string& sub);

      static int find(const std::string& str, const std::string& sub);

      static bool isWhite(const std::string& str);

      static std::string fixUnprintableCharacters(const std::string& str);

      static bool isNonWhite(const std::string& str) {return !isWhite(str);}

      static std::string between(const std::string& str, const std::string& begin,
                            const std::string& end, std::string& front, std::string& back);

      static std::string subString(const std::string& str, int begin, int end);

      static std::string readFromStream(std::istream& is);

      static std::string allCaps(const std::string& str);

      static double atof(const std::string& str);

      static int atoi(const std::string& str);

      static std::ostream& printLines(
        std::ostream             &os
        ,const std::string       &linePrefix
        ,const std::string       &lines
        );

    };

}

#endif