make doc++ able to generate the source documentation for lyx

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

diff --git a/src/support/lstrings.h b/src/support/lstrings.h
index b76e6137b73cd38afcd00aa837389043037f8e3f..1c90c07598a7fcab7d55af0299044376cf6be1d9 100644 (file)
--- a/src/support/lstrings.h
+++ b/src/support/lstrings.h
@@ -1,19 +1,23 @@
 // -*- C++ -*-
 
-/** 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.
+/*
+  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.
 */
 
 #ifndef LSTRINGS_H
 #define LSTRINGS_H
 
+#ifdef __GNUG__
+#pragma interface
+#endif
+
 #include <cstring>
 #include <cctype>
 
 #ifdef HAVE_SSTREAM
 #include <sstream>
-using std::ostringstream;
 #else
 #include <strstream>
 #endif
@@ -28,19 +32,19 @@ int compare_no_case(string const & s, string const & s2);
 int compare_no_case(string const & s, string const & s2, unsigned int len);
 
 ///
-inline int compare(char const * a, char const * b)
+inline
+int compare(char const * a, char const * b)
 {
        return strcmp(a, b);
 }
 
-
 ///
-inline int compare(char const * a, char const * b, unsigned int len)
+inline
+int compare(char const * a, char const * b, unsigned int len)
 {
        return strncmp(a, b, len);
 }
 
-
 ///
 bool isStrInt(string const & str);
 
@@ -48,17 +52,30 @@ bool isStrInt(string const & str);
 int strToInt(string const & str);
 
 ///
-string lowercase(string const &);
+bool isStrDbl(string const & str);
+
+///
+double strToDbl(string const & str);
+
+/// 
+char lowercase(char c);
+
+/// 
+char uppercase(char c);
+
+///
+string const lowercase(string const &);
 
 ///
-string uppercase(string const &);
+string const uppercase(string const &);
 
 /// convert T to string
 template<typename T>
-inline string tostr(T const & t) 
+inline
+string const tostr(T const & t) 
 {
 #ifdef HAVE_SSTREAM
-       ostringstream ostr;
+       std::ostringstream ostr;
        ostr << t;
        return ostr.str().c_str();
        // We need to use the .c_str since we sometimes are using
@@ -76,8 +93,9 @@ inline string tostr(T const & t)
 #endif
 }
 
+///
 inline
-string tostr(bool b)
+string const tostr(bool b)
 {
        return (b ? "true" : "false");
 }
@@ -103,8 +121,20 @@ bool contains(string const & a, string const & b);
 ///
 bool contains(char const * a, char const * b);
 
+///
+bool containsOnly(string const &, char const *);
+
+///
+bool containsOnly(string const &, string const &);
+
+///
+bool containsOnly(char const *, char const *);
+
+///
+bool containsOnly(char const *, string const &);
+
 /// Counts how many of character c there is in a
-unsigned int countChar(string const & a, char const c);
+unsigned int countChar(string const & a, char c);
 
 /** Extracts a token from this string at the nth delim.
   Doesn't modify the original string. Similar to strtok.
@@ -112,7 +142,7 @@ unsigned int countChar(string const & a, char const c);
   #"a;bc;d".token(';', 1) == "bc";#
   #"a;bc;d".token(';', 2) == "d";#
 */
-string token(string const & a, char delim, int n);
+string const token(string const & a, char delim, int n);
 
 
 /** Search a token in this string using the delim.
@@ -131,24 +161,24 @@ int tokenPos(string const & a, char delim, string const & tok);
 bool regexMatch(string const & a, string const & pattern);
 
 /// Substitute all "oldchar"s with "newchar"
-string subst(string const & a, char oldchar, char newchar);
+string const subst(string const & a, char oldchar, char newchar);
 
 /// Substitutes all instances of oldstr with newstr
-string subst(string const & a,
+string const subst(string const & a,
             char const * oldstr, string const & newstr);
 
 /** Strips characters off the end of a string.
   #"abccc".strip('c') = "ab".#
   */
-string strip(string const & a, char const c = ' ');
+string const strip(string const & a, char c = ' ');
 
 /** Strips characters of the beginning of a string.
   #"cccba".frontstrip('c') = "ba"#. */
-string frontStrip(string const & a, char const c = ' ');
+string const frontStrip(string const & a, char c = ' ');
 
 /** Strips characters off the beginning of a string.
     #"ababcdef".frontstrip("ab") = "cdef"# .*/
-string frontStrip(string const & a, char const * p);
+string const frontStrip(string const & a, char const * p);
 
 /** Splits the string by the first delim.
   Splits the string by the first appearance of delim.
@@ -157,12 +187,12 @@ string frontStrip(string const & a, char const * p);
   Example:
   #s1= ""; s2= "a;bc".split(s1, ';') -> s1 == "a"; s2 == "bc";#
   */
-string split(string const & a, string & piece, char delim);
+string const split(string const & a, string & piece, char delim);
 
 /// Same as split but does not return a piece
-string split(string const & a, char delim);
+string const split(string const & a, char delim);
 
 /// Same as split but uses the last delim.
-string rsplit(string const & a, string & piece, char delim);
+string const rsplit(string const & a, string & piece, char delim);
 
 #endif