conversion.hpp
12.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
//
// Copyright (c) 2009-2011 Artyom Beilis (Tonkikh)
//
// Distributed under the Boost Software License, Version 1.0.
// https://www.boost.org/LICENSE_1_0.txt
#ifndef BOOST_LOCALE_CONVERTER_HPP_INCLUDED
#define BOOST_LOCALE_CONVERTER_HPP_INCLUDED
#include <boost/locale/config.hpp>
#include <boost/locale/util/string.hpp>
#include <locale>
#ifdef BOOST_MSVC
# pragma warning(push)
# pragma warning(disable : 4275 4251 4231 4660)
#endif
namespace boost { namespace locale {
/// \defgroup convert Text Conversions
///
/// This module provides various function for string manipulation like Unicode normalization, case conversion etc.
/// @{
/// \brief This class provides base flags for text manipulation. It is used as base for converter facet.
class converter_base {
public:
/// The flag used for facet - the type of operation to perform
enum conversion_type {
normalization, ///< Apply Unicode normalization on the text
upper_case, ///< Convert text to upper case
lower_case, ///< Convert text to lower case
case_folding, ///< Fold case in the text
title_case ///< Convert text to title case
};
};
template<typename CharType>
class converter;
#ifdef BOOST_LOCALE_DOXYGEN
///
/// \brief The facet that implements text manipulation
///
/// It is used to performs text conversion operations defined by \ref converter_base::conversion_type.
/// It is specialized for four types of characters \c char, \c wchar_t, \c char16_t, \c char32_t
template<typename Char>
class BOOST_LOCALE_DECL converter : public converter_base, public std::locale::facet {
public:
/// Locale identification
static std::locale::id id;
/// Standard constructor
converter(size_t refs = 0) : std::locale::facet(refs) {}
/// Convert text in range [\a begin, \a end) according to conversion method \a how. Parameter
/// \a flags is used for specification of normalization method like nfd, nfc etc.
virtual std::basic_string<Char>
convert(conversion_type how, const Char* begin, const Char* end, int flags = 0) const = 0;
};
#else
template<>
class BOOST_LOCALE_DECL converter<char> : public converter_base, public std::locale::facet {
public:
static std::locale::id id;
converter(size_t refs = 0) : std::locale::facet(refs) {}
~converter();
virtual std::string convert(conversion_type how, const char* begin, const char* end, int flags = 0) const = 0;
};
template<>
class BOOST_LOCALE_DECL converter<wchar_t> : public converter_base, public std::locale::facet {
public:
static std::locale::id id;
converter(size_t refs = 0) : std::locale::facet(refs) {}
~converter();
virtual std::wstring
convert(conversion_type how, const wchar_t* begin, const wchar_t* end, int flags = 0) const = 0;
};
# ifdef BOOST_LOCALE_ENABLE_CHAR16_T
template<>
class BOOST_LOCALE_DECL converter<char16_t> : public converter_base, public std::locale::facet {
public:
static std::locale::id id;
converter(size_t refs = 0) : std::locale::facet(refs) {}
~converter();
virtual std::u16string
convert(conversion_type how, const char16_t* begin, const char16_t* end, int flags = 0) const = 0;
};
# endif
# ifdef BOOST_LOCALE_ENABLE_CHAR32_T
template<>
class BOOST_LOCALE_DECL converter<char32_t> : public converter_base, public std::locale::facet {
public:
static std::locale::id id;
converter(size_t refs = 0) : std::locale::facet(refs) {}
~converter();
virtual std::u32string
convert(conversion_type how, const char32_t* begin, const char32_t* end, int flags = 0) const = 0;
};
# endif
#endif
/// The type that defined <a href="http://unicode.org/reports/tr15/#Norm_Forms">normalization form</a>
enum norm_type {
norm_nfd, ///< Canonical decomposition
norm_nfc, ///< Canonical decomposition followed by canonical composition
norm_nfkd, ///< Compatibility decomposition
norm_nfkc, ///< Compatibility decomposition followed by canonical composition.
norm_default = norm_nfc, ///< Default normalization - canonical decomposition followed by canonical composition
};
/// Normalize Unicode string in range [begin,end) according to \ref norm_type "normalization form" \a n
///
/// Note: This function receives only Unicode strings, i.e.: UTF-8, UTF-16 or UTF-32. It does not take
/// in account the locale encoding, because Unicode decomposition and composition are meaningless outside
/// of a Unicode character set.
///
/// \note throws std::bad_cast if loc does not have \ref converter facet installed
template<typename CharType>
std::basic_string<CharType> normalize(const CharType* begin,
const CharType* end,
norm_type n = norm_default,
const std::locale& loc = std::locale())
{
return std::use_facet<converter<CharType>>(loc).convert(converter_base::normalization, begin, end, n);
}
/// Normalize Unicode string \a str according to \ref norm_type "normalization form" \a n
///
/// Note: This function receives only Unicode strings, i.e.: UTF-8, UTF-16 or UTF-32. It does not take
/// in account the locale encoding, because Unicode decomposition and composition are meaningless outside
/// of a Unicode character set.
///
/// \note throws std::bad_cast if loc does not have \ref converter facet installed
template<typename CharType>
std::basic_string<CharType> normalize(const std::basic_string<CharType>& str,
norm_type n = norm_default,
const std::locale& loc = std::locale())
{
return normalize(str.data(), str.data() + str.size(), n, loc);
}
/// Normalize NULL terminated Unicode string \a str according to \ref norm_type "normalization form" \a n
///
/// Note: This function receives only Unicode strings, i.e.: UTF-8, UTF-16 or UTF-32. It does not take
/// in account the locale encoding, because Unicode decomposition and composition are meaningless outside
/// of a Unicode character set.
///
/// \note throws std::bad_cast if loc does not have \ref converter facet installed
template<typename CharType>
std::basic_string<CharType>
normalize(const CharType* str, norm_type n = norm_default, const std::locale& loc = std::locale())
{
return normalize(str, util::str_end(str), n, loc);
}
///////////////////////////////////////////////////
/// Convert a string in range [begin,end) to upper case according to locale \a loc
///
/// \note throws std::bad_cast if loc does not have \ref converter facet installed
template<typename CharType>
std::basic_string<CharType>
to_upper(const CharType* begin, const CharType* end, const std::locale& loc = std::locale())
{
return std::use_facet<converter<CharType>>(loc).convert(converter_base::upper_case, begin, end);
}
/// Convert a string \a str to upper case according to locale \a loc
///
/// \note throws std::bad_cast if loc does not have \ref converter facet installed
template<typename CharType>
std::basic_string<CharType> to_upper(const std::basic_string<CharType>& str, const std::locale& loc = std::locale())
{
return to_upper(str.data(), str.data() + str.size(), loc);
}
/// Convert a NULL terminated string \a str to upper case according to locale \a loc
///
/// \note throws std::bad_cast if loc does not have \ref converter facet installed
template<typename CharType>
std::basic_string<CharType> to_upper(const CharType* str, const std::locale& loc = std::locale())
{
return to_upper(str, util::str_end(str), loc);
}
///////////////////////////////////////////////////
/// Convert a string in range [begin,end) to lower case according to locale \a loc
///
/// \note throws std::bad_cast if loc does not have \ref converter facet installed
template<typename CharType>
std::basic_string<CharType>
to_lower(const CharType* begin, const CharType* end, const std::locale& loc = std::locale())
{
return std::use_facet<converter<CharType>>(loc).convert(converter_base::lower_case, begin, end);
}
/// Convert a string \a str to lower case according to locale \a loc
///
/// \note throws std::bad_cast if loc does not have \ref converter facet installed
template<typename CharType>
std::basic_string<CharType> to_lower(const std::basic_string<CharType>& str, const std::locale& loc = std::locale())
{
return to_lower(str.data(), str.data() + str.size(), loc);
}
/// Convert a NULL terminated string \a str to lower case according to locale \a loc
///
/// \note throws std::bad_cast if loc does not have \ref converter facet installed
template<typename CharType>
std::basic_string<CharType> to_lower(const CharType* str, const std::locale& loc = std::locale())
{
return to_lower(str, util::str_end(str), loc);
}
///////////////////////////////////////////////////
/// Convert a string in range [begin,end) to title case according to locale \a loc
///
/// \note throws std::bad_cast if loc does not have \ref converter facet installed
template<typename CharType>
std::basic_string<CharType>
to_title(const CharType* begin, const CharType* end, const std::locale& loc = std::locale())
{
return std::use_facet<converter<CharType>>(loc).convert(converter_base::title_case, begin, end);
}
/// Convert a string \a str to title case according to locale \a loc
///
/// \note throws std::bad_cast if loc does not have \ref converter facet installed
template<typename CharType>
std::basic_string<CharType> to_title(const std::basic_string<CharType>& str, const std::locale& loc = std::locale())
{
return to_title(str.data(), str.data() + str.size(), loc);
}
/// Convert a NULL terminated string \a str to title case according to locale \a loc
///
/// \note throws std::bad_cast if loc does not have \ref converter facet installed
template<typename CharType>
std::basic_string<CharType> to_title(const CharType* str, const std::locale& loc = std::locale())
{
return to_title(str, util::str_end(str), loc);
}
///////////////////////////////////////////////////
/// Fold case of a string in range [begin,end) according to locale \a loc
///
/// \note throws std::bad_cast if loc does not have \ref converter facet installed
template<typename CharType>
std::basic_string<CharType>
fold_case(const CharType* begin, const CharType* end, const std::locale& loc = std::locale())
{
return std::use_facet<converter<CharType>>(loc).convert(converter_base::case_folding, begin, end);
}
/// Fold case of a string \a str according to locale \a loc
///
/// \note throws std::bad_cast if loc does not have \ref converter facet installed
template<typename CharType>
std::basic_string<CharType> fold_case(const std::basic_string<CharType>& str,
const std::locale& loc = std::locale())
{
return fold_case(str.data(), str.data() + str.size(), loc);
}
/// Fold case of a NULL terminated string \a str according to locale \a loc
///
/// \note throws std::bad_cast if loc does not have \ref converter facet installed
template<typename CharType>
std::basic_string<CharType> fold_case(const CharType* str, const std::locale& loc = std::locale())
{
return fold_case(str, util::str_end(str), loc);
}
///@}
}} // namespace boost::locale
#ifdef BOOST_MSVC
# pragma warning(pop)
#endif
/// \example conversions.cpp
///
/// Example of using various text conversion functions.
///
/// \example wconversions.cpp
///
/// Example of using various text conversion functions with wide strings.
#endif