]> git.lyx.org Git - lyx.git/blob - src/support/lstrings.h
in addition to the changes mentioned in ChangeLog, there is the usual batch of whites...
[lyx.git] / src / support / lstrings.h
1 // -*- C++ -*-
2
3 /** This is a collection of string helper functions that works
4     together with string (and later also with STL String. Some of these
5     would certainly benefit from a rewrite/optimization.
6 */
7
8 #ifndef LSTRINGS_H
9 #define LSTRINGS_H
10
11 #include <cstring>
12
13 //#warning verify this please. Lgb
14 ///
15 template<class T>
16 size_t lstrlen(T const * t)
17 {
18         Assert(t); // we don't want null pointers
19         size_t count = 0;
20         T const * r = t;
21         while(*r != 0) ++r, ++count;
22         return count;
23 }
24
25
26 //#warning verify this please. Lgb
27 ///
28 template<class T>
29 T * lstrchr(T const * t, int c)
30 {
31   Assert(t); // we don't want null pointers
32   T * r = const_cast<T*>(t);
33   while(*r != 0) 
34     if (*r == c) return r; else ++r;
35   return 0;
36 }
37
38 #include <cctype>
39 #include "LString.h"
40
41
42 ///
43 inline int compare_no_case(string const & s, string const & s2)
44 {
45         // ANSI C
46         string::const_iterator p = s.begin();
47         string::const_iterator p2 = s2.begin();
48
49         while (p != s.end() && p2 != s2.end()) {
50                 if (tolower(*p) != tolower(*p2))
51                         return (tolower(*p) < tolower(*p2)) ? -1 : 1;
52                 ++p;
53                 ++p2;
54         }
55
56         return s.size() - s2.size();
57 }
58
59
60 ///
61 inline int compare_no_case(string const & s, string const & s2,
62                            unsigned int len)
63 {
64 //#warning verify this func please
65         string::const_iterator p = s.begin();
66         string::const_iterator p2 = s2.begin();
67         unsigned int i = 0;
68         while (i < len && p != s.end() && p2 != s2.end()) {
69                 if (tolower(*p) != tolower(*p2))
70                         return (tolower(*p) < tolower(*p2)) ? -1 : 1;
71                 ++i;
72                 ++p;
73                 ++p2;
74         }
75         return s.size() - s2.size();
76 }
77
78
79 ///
80 inline int compare(char const * a, char const * b)
81 {
82         return strcmp(a, b);
83 }
84
85
86 ///
87 inline int compare(char const * a, char const * b, unsigned int len)
88 {
89         return strncmp(a, b, len);
90 }
91
92
93 ///
94 bool isStrInt(string const & str);
95
96 ///
97 int strToInt(string const & str);
98
99 ///
100 string lowercase(string const &);
101
102 /// int to string
103 string tostr(int i);
104
105 ///
106 string tostr(unsigned int);
107
108 /// long to string
109 string tostr(long l);
110
111 ///
112 string tostr(unsigned long l); 
113
114 ///
115 string tostr(char c);
116
117 /// void * to string
118 string tostr(void * v);
119
120 /// bool to string
121 string tostr(bool b);
122
123 ///
124 string tostr(double d);
125
126 /// Does the string start with this prefix?
127 bool prefixIs(string const &, char const *);
128
129 /// Does the string end with this char?
130 bool suffixIs(string const &, char);
131
132 /// Does the string end with this suffix?
133 bool suffixIs(string const &, char const *);
134
135 ///
136 bool contains(char const * a, string const & b);
137
138 ///
139 bool contains(string const & a, char const * b);
140
141 ///
142 bool contains(string const & a, string const & b);
143
144 ///
145 bool contains(char const * a, char const * b);
146
147 /// Counts how many of character c there is in a
148 int countChar(string const & a, char const c);
149
150 /** Extracts a token from this string at the nth delim.
151   Doesn't modify the original string. Similar to strtok.
152   Example:
153   #"a;bc;d".token(';', 1) == "bc";#
154   #"a;bc;d".token(';', 2) == "d";#
155 */
156 string token(string const & a, char delim, int n);
157
158
159 /** Search a token in this string using the delim.
160   Doesn't modify the original string. Returns -1 in case of
161   failure. 
162   Example:
163   #"a;bc;d".tokenPos(';', "bc") == 1;#
164   #"a;bc;d".token(';', "d") == 2;#
165 */
166 int tokenPos(string const & a, char delim, string const & tok);
167
168
169 /** Compares a string and a (simple) regular expression
170   The only element allowed is "*" for any string of characters
171   */
172 bool regexMatch(string const & a, string const & pattern);
173
174 /// Substitute all "oldchar"s with "newchar"
175 string subst(string const & a, char oldchar, char newchar);
176
177 /// Substitutes all instances of oldstr with newstr
178 string subst(string const & a,
179              char const * oldstr, string const & newstr);
180
181 /** Strips characters off the end of a string.
182   #"abccc".strip('c') = "ab".#
183   */
184 string strip(string const & a, char const c = ' ');
185
186 /** Strips characters of the beginning of a string.
187   #"cccba".frontstrip('c') = "ba"#. */
188 string frontStrip(string const & a, char const c = ' ');
189
190 /** Strips characters off the beginning of a string.
191     #"ababcdef".frontstrip("ab") = "cdef"# .*/
192 string frontStrip(string const & a, char const * p);
193
194 /** Splits the string by the first delim.
195   Splits the string by the first appearance of delim.
196   The leading string up to delim is returned in piece (not including
197   delim), while the original string is cut from after the delimiter.
198   Example:
199   #s1= ""; s2= "a;bc".split(s1, ';') -> s1 == "a"; s2 == "bc";#
200   */
201 string split(string const & a, string & piece, char delim);
202
203 /// Same as split but does not return a piece
204 string split(string const & a, char delim);
205
206 /// Same as split but uses the last delim.
207 string rsplit(string const & a, string & piece, char delim);
208
209 #endif