X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=simgear%2Fmisc%2Fstrutils.hxx;h=9bd1dbe1851fc20637cb8a5829cb32de05691e26;hb=619163d40e6beeaf08759944d80256692395ec9e;hp=c8c430a428722c3b5f94504eb272e961d0a3c437;hpb=82459a2802a939434f9fc5b88d2b2aea58f0043d;p=simgear.git diff --git a/simgear/misc/strutils.hxx b/simgear/misc/strutils.hxx index c8c430a4..9bd1dbe1 100644 --- a/simgear/misc/strutils.hxx +++ b/simgear/misc/strutils.hxx @@ -1,8 +1,11 @@ -// 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 library is free software; you can redistribute it and/or // modify it under the terms of the GNU Library General Public @@ -14,53 +17,133 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU // Library General Public License for more details. // -// You should have received a copy of the GNU Library 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. +// 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. // // $Id$ + #ifndef STRUTILS_H #define STRUTILS_H #include -#include STL_STRING +#include +#include +#include + +typedef std::vector < std::string > string_list; + +namespace simgear { + namespace strutils { -#ifdef FG_HAVE_STD_INCLUDES -# include -#else -# include -#endif +// /** +// * atof() wrapper for "string" type +// */ +// inline double +// atof( const string& str ) +// { +// return ::atof( str.c_str() ); +// } -FG_USING_STD(string); +// /** +// * atoi() wrapper for "string" type +// */ +// inline int +// atoi( const string& str ) +// { +// return ::atoi( str.c_str() ); +// } -// Default characters to remove. -extern const string whitespace; + /** + * 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 ); -// Returns a string with trailing characters removed. -string trimleft( const string& s, const string& trimmings = whitespace ); + /** + * Right-padding of a string to a given length + * @param s String to pad + * @param length The total length of the resulting string + * @param c The character to pad with + * @return The padded string + */ + std::string rpad( const std::string & s, size_t length, char c ); -// Returns a string with leading characters removed. -string trimright( const string& s, const string& trimmings = whitespace ); + /** + * Left-padding of a string to a given length + * @param s String to pad + * @param length The total length of the resulting string + * @param c The character to pad with + * @return The padded string + */ + std::string lpad( const std::string & s, size_t length, char c ); -// Returns a string with leading and trailing characters removed. -string trim( const string& s, const string& trimmings = whitespace ); + /** + * 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. + */ + string_list + split( const std::string& s, + const char* sep = 0, + int maxsplit = 0 ); -//----------------------------------------------------------------------------- + /** + * create a single string by joining the elements of a list with + * another string. + */ + std::string join(const string_list& l, const std::string& joinWith = ""); -inline double -atof( const string& str ) -{ - return ::atof( str.c_str() ); -} + /** + * Test if a string starts with a string + * + * @param s The string to be tested + * @param substr The string to test + * @return True, if s starts with substr, False otherwise + */ + bool starts_with( const std::string & s, const std::string & substr ); -inline int -atoi( const string& str ) -{ - return ::atoi( str.c_str() ); -} + /** + * Test if a string ends with a string + * + * @param s The string to be tested + * @param substr The string to test + * @return True, if s ends with substr, False otherwise + */ + bool ends_with( const std::string & s, const std::string & substr ); + + /** + * Strip all leading/trailing whitespace, and transform all interal + * whitespace into a single ' ' character - i.e newlines/carriage returns/ + * tabs/multiple spaces will be condensed. + */ + std::string simplify(const std::string& s); + + /** + * convert a string representing a decimal number, to an int + */ + int to_int(const std::string& s, int base = 10); + + /** + * Like strcmp(), but for dotted versions strings NN.NN.NN + * any number of terms are support. + * @return 0 if versions match, -ve number if v1 is lower, +ve if v1 + * is greater + */ + int compare_versions(const std::string& v1, const std::string& v2); + } // end namespace strutils +} // end namespace simgear #endif // STRUTILS_H