4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
10 * Full author contact details are available in file CREDITS.
13 #ifndef LYX_DOCSTRING_H
14 #define LYX_DOCSTRING_H
16 #include "support/strfwd.h"
23 * String type for storing the main text in UCS4 encoding.
24 * Use std::string only in cases 7-bit ASCII is to be manipulated
25 * within the variable.
27 typedef std::basic_string<char_type> docstring;
29 /// Creates a docstring from a C string of ASCII characters
30 docstring const from_ascii(char const *);
32 /// Creates a docstring from a std::string of ASCII characters
33 docstring const from_ascii(std::string const &);
35 /// Creates a std::string of ASCII characters from a docstring
36 std::string const to_ascii(docstring const &);
38 /// Creates a docstring from a UTF8 string. This should go eventually.
39 docstring const from_utf8(std::string const &);
41 /// Creates a UTF8 string from a docstring. This should go eventually.
42 std::string const to_utf8(docstring const &);
44 /// convert \p s from the encoding of the locale to ucs4.
45 docstring const from_local8bit(std::string const & s);
48 * Convert \p s from ucs4 to the encoding of the locale.
49 * This may fail and throw an exception, the caller is expected to act
52 std::string const to_local8bit(docstring const & s);
54 /// convert \p s from the encoding of the file system to ucs4.
55 docstring const from_filesystem8bit(std::string const & s);
57 /// convert \p s from ucs4 to the encoding of the file system.
58 std::string const to_filesystem8bit(docstring const & s);
60 /// convert \p s from ucs4 to the \p encoding.
61 std::string const to_iconv_encoding(docstring const & s,
62 std::string const & encoding);
64 /// convert \p s from \p encoding to ucs4.
65 docstring const from_iconv_encoding(std::string const & s,
66 std::string const & encoding);
68 /// normalize \p s to precomposed form c
69 docstring const normalize_c(docstring const & s);
71 /// Compare a docstring with a C string of ASCII characters
72 bool operator==(docstring const &, char const *);
74 /// Compare a C string of ASCII characters with a docstring
75 inline bool operator==(char const * l, docstring const & r) { return r == l; }
77 /// Compare a docstring with a C string of ASCII characters
78 inline bool operator!=(docstring const & l, char const * r) { return !(l == r); }
80 /// Compare a C string of ASCII characters with a docstring
81 inline bool operator!=(char const * l, docstring const & r) { return !(r == l); }
83 /// Concatenate a docstring and a C string of ASCII characters
84 docstring operator+(docstring const &, char const *);
86 /// Concatenate a C string of ASCII characters and a docstring
87 docstring operator+(char const *, docstring const &);
89 /// Concatenate a docstring and a single ASCII character
90 docstring operator+(docstring const & l, char r);
92 /// Concatenate a single ASCII character and a docstring
93 docstring operator+(char l, docstring const & r);
95 /// Append a C string of ASCII characters to a docstring
96 docstring & operator+=(docstring &, char const *);
98 /// Append a single ASCII character to a docstring
99 docstring & operator+=(docstring & l, char r);
104 #if ! defined(USE_WCHAR_T) && defined(__GNUC__) && defined(__GNUC_MINOR__) && __GNUC__ == 3 && __GNUC_MINOR__ < 4
105 // Missing char_traits methods in gcc 3.3 and older. Taken from gcc 4.2svn.
108 template<typename T> void
109 char_traits<T>::assign(char_type & c1, char_type const & c2)
115 template<typename T> bool
116 char_traits<T>::eq(char_type const & c1, char_type const & c2)
122 template<typename T> bool
123 char_traits<T>::lt(char_type const & c1, char_type const & c2)
129 template<typename T> int
130 char_traits<T>::compare(char_type const * s1, char_type const * s2, std::size_t n)
132 for (std::size_t i = 0; i < n; ++i)
133 if (lt(s1[i], s2[i]))
135 else if (lt(s2[i], s1[i]))
141 template<typename T> std::size_t
142 char_traits<T>::length(char_type const * p)
145 while (!eq(p[i], char_type()))
151 template<typename T> typename char_traits<T>::char_type const *
152 char_traits<T>::find(char_type const * s, size_t n, char_type const & a)
154 for (std::size_t i = 0; i < n; ++i)
161 template<typename T> typename char_traits<T>::char_type *
162 char_traits<T>::move(char_type * s1, char_type const * s2, std::size_t n)
164 return static_cast<T *>(std::memmove(s1, s2, n * sizeof(char_type)));
168 template<typename T> typename char_traits<T>::char_type *
169 char_traits<T>::copy(char_type * s1, char_type const * s2, std::size_t n)
171 std::copy(s2, s2 + n, s1);
176 template<typename T> typename char_traits<T>::char_type *
177 char_traits<T>::assign(char_type * s, std::size_t n, char_type a)
179 std::fill_n(s, n, a);
184 template<typename T> typename char_traits<T>::char_type
185 char_traits<T>::to_char_type(int_type const & c)
187 return static_cast<char_type>(c);
191 template<typename T> typename char_traits<T>::int_type
192 char_traits<T>::to_int_type(char_type const & c)
194 return static_cast<int_type>(c);
198 template<typename T> bool
199 char_traits<T>::eq_int_type(int_type const & c1, int_type const & c2)
205 template<typename T> typename char_traits<T>::int_type
206 char_traits<T>::eof()
208 return static_cast<int_type>(EOF);
212 template<typename T> typename char_traits<T>::int_type
213 char_traits<T>::not_eof(int_type const & c)
215 return !eq_int_type(c, eof()) ? c : to_int_type(char_type());