]> git.lyx.org Git - lyx.git/blobdiff - src/support/lstrings.h
make doc++ able to generate the source documentation for lyx
[lyx.git] / src / support / lstrings.h
index b51d33a84f5b1ad64fbcb23571c1ce2a383bcd3f..1c90c07598a7fcab7d55af0299044376cf6be1d9 100644 (file)
@@ -1,86 +1,46 @@
 // -*- 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
 
-#include <cstring>
-
-//#warning verify this please. Lgb
-///
-template<class T>
-size_t lstrlen(T const * t)
-{
-       Assert(t); // we don't want null pointers
-       size_t count = 0;
-       T const * r = t;
-       while(*r != 0) ++r, ++count;
-       return count;
-}
+#ifdef __GNUG__
+#pragma interface
+#endif
 
+#include <cstring>
+#include <cctype>
 
-//#warning verify this please. Lgb
-///
-template<class T>
-T * lstrchr(T const * t, int c)
-{
-  Assert(t); // we don't want null pointers
-  T * r = const_cast<T*>(t);
-  while(*r != 0) 
-    if (*r == c) return r; else ++r;
-  return 0;
-}
+#ifdef HAVE_SSTREAM
+#include <sstream>
+#else
+#include <strstream>
+#endif
 
-#include <cctype>
 #include "LString.h"
 
+
 ///
-inline int compare_no_case(string const & s, string const & s2)
-{
-       // ANSI C
-       string::const_iterator p = s.begin();
-       string::const_iterator p2 = s2.begin();
-
-       while (p != s.end() && p2 != s2.end()) {
-               if (tolower(*p) != tolower(*p2))
-                       return (tolower(*p) < tolower(*p2)) ? -1 : 1;
-               ++p;
-               ++p2;
-       }
-
-       return s.size() - s2.size();
-}
+int compare_no_case(string const & s, string const & s2);
 
 ///
-inline int compare_no_case(string const & s, string const & s2,
-                          unsigned int len)
-{
-//#warning verify this func please
-       string::const_iterator p = s.begin();
-       string::const_iterator p2 = s2.begin();
-       unsigned int i = 0;
-       while (i < len && p != s.end() && p2 != s2.end()) {
-               if (tolower(*p) != tolower(*p2))
-                       return (tolower(*p) < tolower(*p2)) ? -1 : 1;
-               ++i;
-               ++p;
-               ++p2;
-       }
-       return s.size() - s2.size();
-}
+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);
 }
@@ -92,32 +52,54 @@ bool isStrInt(string const & str);
 int strToInt(string const & str);
 
 ///
-string lowercase(string const &);
-
-/// int to string
-string tostr(int i);
+bool isStrDbl(string const & str);
 
 ///
-string tostr(unsigned int);
+double strToDbl(string const & str);
 
-/// long to string
-string tostr(long l);
+/// 
+char lowercase(char c);
 
-///
-string tostr(unsigned long l); 
+/// 
+char uppercase(char c);
 
 ///
-string tostr(char c);
+string const lowercase(string const &);
 
-/// void* to string
-string tostr(void* v);
+///
+string const uppercase(string const &);
 
-/// bool to string
-string tostr(bool b);
+/// convert T to string
+template<typename T>
+inline
+string const tostr(T const & t) 
+{
+#ifdef HAVE_SSTREAM
+       std::ostringstream ostr;
+       ostr << t;
+       return ostr.str().c_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)
+#else
+       // The buf is probably a bit large, but if we want to be safer
+       // we should leave it this big. As compiler/libs gets updated
+       // this part of the code will cease to be used and we loose
+       // nothing.
+       char buf[2048]; // a bit too large perhaps?
+       ostrstream ostr(buf, sizeof(buf));
+       ostr << t << '\0';
+       return buf;
+#endif
+}
 
 ///
-string tostr(double d);
-
+inline
+string const tostr(bool b)
+{
+       return (b ? "true" : "false");
+}
+       
 /// Does the string start with this prefix?
 bool prefixIs(string const &, char const *);
 
@@ -139,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
-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.
@@ -148,7 +142,7 @@ 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.
@@ -167,38 +161,38 @@ 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,
-             char const * oldstr, string const & newstr);
+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.
   The leading string up to delim is returned in piece (not including
   delim), while the original string is cut from after the delimiter.
   Example:
-  #s1=""; s2="a;bc".split(s1, ';') -> s1=="a"; s2 == "bc";#
+  #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