Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_StrUtils.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Teuchos: Common Tools Package
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef TEUCHOS_STRUTILS_H
43 #define TEUCHOS_STRUTILS_H
44 
49 #include "Teuchos_ConfigDefs.hpp"
50 
51 #include "Teuchos_Utils.hpp"
52 #include "Teuchos_Array.hpp"
53 
54 namespace Teuchos {
55 
56 
61 class TEUCHOSCORE_LIB_DLL_EXPORT StrUtils
62 {
63 public:
65  static Array<std::string> readFile(std::istream& is, char comment);
66 
69  static Array<std::string> splitIntoLines(const std::string& input);
70 
72  static Array<Array<std::string> > tokenizeFile(std::istream& is, char comment);
73 
75  static bool readLine(std::istream& is, std::string& line);
76 
78  static Array<std::string> stringTokenizer(const std::string& str);
79 
81  static Array<std::string> getTokensPlusWhitespace(const std::string& str);
82 
84  static std::string reassembleFromTokens(const Array<std::string>& tokens, int iStart=0);
85 
87  static void splitList(const std::string& bigstring, Array<std::string>& elements);
88 
90  static int findNextWhitespace(const std::string& str, int offset);
91 
93  static int findNextNonWhitespace(const std::string& str, int offset);
94 
96  static std::string varSubstitute(const std::string& rawLine,
97  const std::string& varName,
98  const std::string& varValue);
99 
101  static std::string varTableSubstitute(const std::string& rawLine,
102  const Array<std::string>& varNames,
103  const Array<std::string>& varValues);
104 
106  static std::string envSubstitute(const std::string& line);
107 
110  static std::string before(const std::string& str, const std::string& sub);
111 
114  static std::string before(const std::string& str, char sub);
115 
118  static std::string after(const std::string& str, const std::string& sub);
119 
122  static int find(const std::string& str, const std::string& sub);
123 
125  static bool isWhite(const std::string& str);
126 
128  static std::string fixUnprintableCharacters(const std::string& str);
129 
131  static bool isNonWhite(const std::string& str) {return !isWhite(str);}
132 
138  static std::string between(const std::string& str, const std::string& begin,
139  const std::string& end, std::string& front, std::string& back);
140 
144  static std::string subString(const std::string& str, int begin, int end);
145 
146  static std::string readFromStream(std::istream& is);
147 
149  static std::string allCaps(const std::string& str);
150 
152  static double atof(const std::string& str);
153 
155  static int atoi(const std::string& str);
156 
158  static std::ostream& printLines(
159  std::ostream &os
160  ,const std::string &linePrefix
161  ,const std::string &lines
162  );
163 
165  static std::string removeAllSpaces(std::string stringToClean);
166 
167 };
168 
169 
170 } // namespace Teuchos
171 
172 
173 #endif
Teuchos header file which uses auto-configuration information to include necessary C++ headers...
Provides std::string manipulation utilities that are not provided in the standard C++ std::string cla...
Templated array class derived from the STL std::vector.
static bool isNonWhite(const std::string &str)
Returns true if a std::string has any non-whitespace.
A utilities class for Teuchos.