]> git.mxchange.org Git - simgear.git/blobdiff - simgear/misc/strutils.hxx
Back out convertToLowerCase function
[simgear.git] / simgear / misc / strutils.hxx
index 4b116d8b40ad41fa0c4a1208850e6945324187c3..162cdb280438f09b23992f9daa08265c91512d0f 100644 (file)
@@ -1,65 +1,87 @@
-// String utilities.
-//
-// Written by Bernie Bright, 1998
+/**
+ * \file strutils.hxx
+ * String utilities.
+ */
+
+// Written by Bernie Bright, started 1998
 //
-// Copyright (C) 1998  Bernie Bright - bbright@c031.aone.net.au
+// Copyright (C) 1998  Bernie Bright - bbright@bigpond.net.au
 //
-// This program is free software; you can redistribute it and/or
-// modify it under the terms of the GNU General Public License as
-// published by the Free Software Foundation; either version 2 of the
-// License, or (at your option) any later version.
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Library General Public
+// License as published by the Free Software Foundation; either
+// version 2 of the License, or (at your option) any later version.
 //
-// This program is distributed in the hope that it will be useful, but
-// WITHOUT ANY WARRANTY; without even the implied warranty of
+// 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
-// General Public License for more details.
+// Library General Public License for more details.
 //
 // You should have received a copy of the GNU General Public License
 // along with this program; if not, write to the Free Software
-// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 //
 // $Id$
 
+
 #ifndef STRUTILS_H
 #define STRUTILS_H
 
 #include <simgear/compiler.h>
 
-#include STL_STRING
-
-#ifdef FG_HAVE_STD_INCLUDES
-#  include <cstdlib>
-#else
-#  include <stdlib.h>
-#endif
-
-FG_USING_STD(string);
-
-// Default characters to remove.
-extern const string whitespace;
+#include <string>
+#include <vector>
+#include <cstdlib>
 
-// Returns a string with trailing characters removed.
-string trimleft( const string& s, const string& trimmings = whitespace );
 
-// Returns a string with leading characters removed.
-string trimright( const string& s, const string& trimmings = whitespace );
+namespace simgear {
+  namespace strutils {
 
-// Returns a string with leading and trailing characters removed.
-string trim( const string& s, const string& trimmings = whitespace );
+//     /** 
+//      * atof() wrapper for "string" type
+//      */
+//     inline double
+//     atof( const string& str )
+//     {
+//         return ::atof( str.c_str() );
+//     }
 
-//-----------------------------------------------------------------------------
+//     /**
+//      * atoi() wrapper for "string" type
+//      */
+//     inline int
+//     atoi( const string& str )
+//     {
+//         return ::atoi( str.c_str() );
+//     }
 
-inline double
-atof( const string& str )
-{
-    return ::atof( str.c_str() );
-}
+       /**
+        * Strip leading and/or trailing whitespace from s.
+        * @param s String to strip.
+        * @return The stripped string.
+        */
+       std::string lstrip( const std::string& s );
+       std::string rstrip( const std::string& s );
+       std::string strip( const std::string& s );
 
-inline int
-atoi( const string& str )
-{
-    return ::atoi( str.c_str() );
-}
+       /**
+        * Split a string into a words using 'sep' as the delimiter string.
+        * Produces a result similar to the perl and python functions of the
+        * same name.
+        * 
+        * @param s The string to split into words,
+        * @param sep Word delimiters.  If not specified then any whitespace is a separator,
+        * @param maxsplit If given, splits at no more than maxsplit places,
+        * resulting in at most maxsplit+1 words.
+        * @return Array of words.
+        */
+       std::vector<std::string>
+       split( const std::string& s,
+              const char* sep = 0,
+              int maxsplit = 0 );
+  
+  } // end namespace strutils
+} // end namespace simgear
 
 #endif // STRUTILS_H