another safety belt

[lyx.git] / src / support / lstrings.h

diff --git a/src/support/lstrings.h b/src/support/lstrings.h
index f47d592c83ab8fb9245b88355bce27c1ed75662f..1330616ab92da2770a90549fe9a29a45bb086609 100644 (file)
--- a/src/support/lstrings.h
+++ b/src/support/lstrings.h
@@ -1,13 +1,17 @@
 // -*- C++ -*-
-
-/** String helper functions.
-    \file lstrings.h
-    This is a collection of string helper functions that works
-    together with string (and later also with STL String. Some of these
-    would certainly benefit from a rewrite/optimization.
-    \author Lars Gullik Bjønnes
-    \author Jean-Marc Lasgouttes
-*/
+/**
+ * \file lstrings.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Lars Gullik Bjønnes
+ * \author Jean-Marc Lasgouttes
+ *
+ * Full author contact details are available in file CREDITS
+ *
+ * A collection of string helper functions that works with string.
+ * Some of these would certainly benefit from a rewrite/optimization.
+ */
 
 #ifndef LSTRINGS_H
 #define LSTRINGS_H
@@ -93,7 +97,7 @@ string const tostr(T const & t)
 {
        ostringstream ostr;
        ostr << t;
-       return ostr.str().c_str();
+       return STRCONV(ostr.str());
        // We need to use the .c_str since we sometimes are using
        // our own string class and that is not compatible with
        // basic_string<char>. (of course we don't want this later)
@@ -192,19 +196,26 @@ string const subst(string const & a,
 string const subst(string const & a,
                   string const & oldstr, string const & newstr);
 
-/** Strips characters off the end of a string.
+/** Trims characters off the end and beginning of a string.
+    \code
+    trim("ccabccc", "c") == "ab".
+    \endcode
+*/
+string const trim(string const & a, char const * p = " ");
+
+/** Trims characters off the end of a string.
     \code
-    strip("abccc", "c") == "ab".
+    rtrim("abccc", "c") == "ab".
     \endcode
 */
-string const strip(string const & a, char const * p = " ");
+string const rtrim(string const & a, char const * p = " ");
 
-/** Strips characters off the beginning of a string.
+/** Trims characters off the beginning of a string.
     \code
-    frontstrip("ababcdef", "ab") = "cdef"
+   ltrim("ababcdef", "ab") = "cdef"
     \endcode
 */
-string const frontStrip(string const & a, char const * p = " ");
+string const ltrim(string const & a, char const * p = " ");
 
 /** Splits the string by the first delim.
     Splits the string by the first appearance of delim.