1 // Character Traits for use by standard string and iostream -*- C++ -*-
3 // Copyright (C) 1997-2013 Free Software Foundation, Inc.
5 // This file is part of the GNU ISO C++ Library. This library is free
6 // software; you can redistribute it and/or modify it under the
7 // terms of the GNU General Public License as published by the
8 // Free Software Foundation; either version 3, or (at your option)
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // Under Section 7 of GPL version 3, you are granted additional
17 // permissions described in the GCC Runtime Library Exception, version
18 // 3.1, as published by the Free Software Foundation.
20 // You should have received a copy of the GNU General Public License and
21 // a copy of the GCC Runtime Library Exception along with this program;
22 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23 // <http://www.gnu.org/licenses/>.
25 /** @file bits/char_traits.h
26 * This is an internal header file, included by other library headers.
27 * Do not attempt to use it directly. @headername{string}
31 // ISO C++ 14882: 21 Strings library
34 #ifndef _CHAR_TRAITS_H
35 #define _CHAR_TRAITS_H 1
37 #pragma GCC system_header
39 #include <bits/stl_algobase.h> // std::copy, std::fill_n
40 #include <bits/postypes.h> // For streampos
41 #include <cwchar> // For WEOF, wmemmove, wmemset, etc.
43 namespace __gnu_cxx
_GLIBCXX_VISIBILITY(default)
45 _GLIBCXX_BEGIN_NAMESPACE_VERSION
48 * @brief Mapping from character type to associated types.
50 * @note This is an implementation class for the generic version
51 * of char_traits. It defines int_type, off_type, pos_type, and
52 * state_type. By default these are unsigned long, streamoff,
53 * streampos, and mbstate_t. Users who need a different set of
54 * types, but who don't need to change the definitions of any function
55 * defined in char_traits, can specialize __gnu_cxx::_Char_types
56 * while leaving __gnu_cxx::char_traits alone. */
57 template<typename _CharT
>
60 typedef unsigned long int_type
;
61 typedef std::streampos pos_type
;
62 typedef std::streamoff off_type
;
63 typedef std::mbstate_t state_type
;
68 * @brief Base class used to implement std::char_traits.
70 * @note For any given actual character type, this definition is
71 * probably wrong. (Most of the member functions are likely to be
72 * right, but the int_type and state_type typedefs, and the eof()
73 * member function, are likely to be wrong.) The reason this class
74 * exists is so users can specialize it. Classes in namespace std
75 * may not be specialized for fundamental types, but classes in
76 * namespace __gnu_cxx may be.
78 * See http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt05ch13s03.html
79 * for advice on how to make use of this class for @a unusual character
80 * types. Also, check out include/ext/pod_char_traits.h.
82 template<typename _CharT
>
85 typedef _CharT char_type
;
86 typedef typename _Char_types
<_CharT
>::int_type int_type
;
87 typedef typename _Char_types
<_CharT
>::pos_type pos_type
;
88 typedef typename _Char_types
<_CharT
>::off_type off_type
;
89 typedef typename _Char_types
<_CharT
>::state_type state_type
;
92 assign(char_type
& __c1
, const char_type
& __c2
)
95 static _GLIBCXX_CONSTEXPR
bool
96 eq(const char_type
& __c1
, const char_type
& __c2
)
97 { return __c1
== __c2
; }
99 static _GLIBCXX_CONSTEXPR
bool
100 lt(const char_type
& __c1
, const char_type
& __c2
)
101 { return __c1
< __c2
; }
104 compare(const char_type
* __s1
, const char_type
* __s2
, std::size_t __n
);
107 length(const char_type
* __s
);
109 static const char_type
*
110 find(const char_type
* __s
, std::size_t __n
, const char_type
& __a
);
113 move(char_type
* __s1
, const char_type
* __s2
, std::size_t __n
);
116 copy(char_type
* __s1
, const char_type
* __s2
, std::size_t __n
);
119 assign(char_type
* __s
, std::size_t __n
, char_type __a
);
121 static _GLIBCXX_CONSTEXPR char_type
122 to_char_type(const int_type
& __c
)
123 { return static_cast<char_type
>(__c
); }
125 static _GLIBCXX_CONSTEXPR int_type
126 to_int_type(const char_type
& __c
)
127 { return static_cast<int_type
>(__c
); }
129 static _GLIBCXX_CONSTEXPR
bool
130 eq_int_type(const int_type
& __c1
, const int_type
& __c2
)
131 { return __c1
== __c2
; }
133 static _GLIBCXX_CONSTEXPR int_type
135 { return static_cast<int_type
>(_GLIBCXX_STDIO_EOF
); }
137 static _GLIBCXX_CONSTEXPR int_type
138 not_eof(const int_type
& __c
)
139 { return !eq_int_type(__c
, eof()) ? __c
: to_int_type(char_type()); }
142 template<typename _CharT
>
144 char_traits
<_CharT
>::
145 compare(const char_type
* __s1
, const char_type
* __s2
, std::size_t __n
)
147 for (std::size_t __i
= 0; __i
< __n
; ++__i
)
148 if (lt(__s1
[__i
], __s2
[__i
]))
150 else if (lt(__s2
[__i
], __s1
[__i
]))
155 template<typename _CharT
>
157 char_traits
<_CharT
>::
158 length(const char_type
* __p
)
161 while (!eq(__p
[__i
], char_type()))
166 template<typename _CharT
>
167 const typename char_traits
<_CharT
>::char_type
*
168 char_traits
<_CharT
>::
169 find(const char_type
* __s
, std::size_t __n
, const char_type
& __a
)
171 for (std::size_t __i
= 0; __i
< __n
; ++__i
)
172 if (eq(__s
[__i
], __a
))
177 template<typename _CharT
>
178 typename char_traits
<_CharT
>::char_type
*
179 char_traits
<_CharT
>::
180 move(char_type
* __s1
, const char_type
* __s2
, std::size_t __n
)
182 return static_cast<_CharT
*>(__builtin_memmove(__s1
, __s2
,
183 __n
* sizeof(char_type
)));
186 template<typename _CharT
>
187 typename char_traits
<_CharT
>::char_type
*
188 char_traits
<_CharT
>::
189 copy(char_type
* __s1
, const char_type
* __s2
, std::size_t __n
)
191 // NB: Inline std::copy so no recursive dependencies.
192 std::copy(__s2
, __s2
+ __n
, __s1
);
196 template<typename _CharT
>
197 typename char_traits
<_CharT
>::char_type
*
198 char_traits
<_CharT
>::
199 assign(char_type
* __s
, std::size_t __n
, char_type __a
)
201 // NB: Inline std::fill_n so no recursive dependencies.
202 std::fill_n(__s
, __n
, __a
);
206 _GLIBCXX_END_NAMESPACE_VERSION
209 namespace std
_GLIBCXX_VISIBILITY(default)
211 _GLIBCXX_BEGIN_NAMESPACE_VERSION
215 * @brief Basis for explicit traits specializations.
217 * @note For any given actual character type, this definition is
218 * probably wrong. Since this is just a thin wrapper around
219 * __gnu_cxx::char_traits, it is possible to achieve a more
220 * appropriate definition by specializing __gnu_cxx::char_traits.
222 * See http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt05ch13s03.html
223 * for advice on how to make use of this class for @a unusual character
224 * types. Also, check out include/ext/pod_char_traits.h.
226 template<class _CharT
>
227 struct char_traits
: public __gnu_cxx::char_traits
<_CharT
>
231 /// 21.1.3.1 char_traits specializations
233 struct char_traits
<char>
235 typedef char char_type
;
236 typedef int int_type
;
237 typedef streampos pos_type
;
238 typedef streamoff off_type
;
239 typedef mbstate_t state_type
;
242 assign(char_type
& __c1
, const char_type
& __c2
) _GLIBCXX_NOEXCEPT
245 static _GLIBCXX_CONSTEXPR
bool
246 eq(const char_type
& __c1
, const char_type
& __c2
) _GLIBCXX_NOEXCEPT
247 { return __c1
== __c2
; }
249 static _GLIBCXX_CONSTEXPR
bool
250 lt(const char_type
& __c1
, const char_type
& __c2
) _GLIBCXX_NOEXCEPT
251 { return __c1
< __c2
; }
254 compare(const char_type
* __s1
, const char_type
* __s2
, size_t __n
)
255 { return __builtin_memcmp(__s1
, __s2
, __n
); }
258 length(const char_type
* __s
)
259 { return __builtin_strlen(__s
); }
261 static const char_type
*
262 find(const char_type
* __s
, size_t __n
, const char_type
& __a
)
263 { return static_cast<const char_type
*>(__builtin_memchr(__s
, __a
, __n
)); }
266 move(char_type
* __s1
, const char_type
* __s2
, size_t __n
)
267 { return static_cast<char_type
*>(__builtin_memmove(__s1
, __s2
, __n
)); }
270 copy(char_type
* __s1
, const char_type
* __s2
, size_t __n
)
271 { return static_cast<char_type
*>(__builtin_memcpy(__s1
, __s2
, __n
)); }
274 assign(char_type
* __s
, size_t __n
, char_type __a
)
275 { return static_cast<char_type
*>(__builtin_memset(__s
, __a
, __n
)); }
277 static _GLIBCXX_CONSTEXPR char_type
278 to_char_type(const int_type
& __c
) _GLIBCXX_NOEXCEPT
279 { return static_cast<char_type
>(__c
); }
281 // To keep both the byte 0xff and the eof symbol 0xffffffff
282 // from ending up as 0xffffffff.
283 static _GLIBCXX_CONSTEXPR int_type
284 to_int_type(const char_type
& __c
) _GLIBCXX_NOEXCEPT
285 { return static_cast<int_type
>(static_cast<unsigned char>(__c
)); }
287 static _GLIBCXX_CONSTEXPR
bool
288 eq_int_type(const int_type
& __c1
, const int_type
& __c2
) _GLIBCXX_NOEXCEPT
289 { return __c1
== __c2
; }
291 static _GLIBCXX_CONSTEXPR int_type
292 eof() _GLIBCXX_NOEXCEPT
293 { return static_cast<int_type
>(_GLIBCXX_STDIO_EOF
); }
295 static _GLIBCXX_CONSTEXPR int_type
296 not_eof(const int_type
& __c
) _GLIBCXX_NOEXCEPT
297 { return (__c
== eof()) ? 0 : __c
; }
301 #ifdef _GLIBCXX_USE_WCHAR_T
302 /// 21.1.3.2 char_traits specializations
304 struct char_traits
<wchar_t>
306 typedef wchar_t char_type
;
307 typedef wint_t int_type
;
308 typedef streamoff off_type
;
309 typedef wstreampos pos_type
;
310 typedef mbstate_t state_type
;
313 assign(char_type
& __c1
, const char_type
& __c2
) _GLIBCXX_NOEXCEPT
316 static _GLIBCXX_CONSTEXPR
bool
317 eq(const char_type
& __c1
, const char_type
& __c2
) _GLIBCXX_NOEXCEPT
318 { return __c1
== __c2
; }
320 static _GLIBCXX_CONSTEXPR
bool
321 lt(const char_type
& __c1
, const char_type
& __c2
) _GLIBCXX_NOEXCEPT
322 { return __c1
< __c2
; }
325 compare(const char_type
* __s1
, const char_type
* __s2
, size_t __n
)
326 { return wmemcmp(__s1
, __s2
, __n
); }
329 length(const char_type
* __s
)
330 { return wcslen(__s
); }
332 static const char_type
*
333 find(const char_type
* __s
, size_t __n
, const char_type
& __a
)
334 { return wmemchr(__s
, __a
, __n
); }
337 move(char_type
* __s1
, const char_type
* __s2
, size_t __n
)
338 { return wmemmove(__s1
, __s2
, __n
); }
341 copy(char_type
* __s1
, const char_type
* __s2
, size_t __n
)
342 { return wmemcpy(__s1
, __s2
, __n
); }
345 assign(char_type
* __s
, size_t __n
, char_type __a
)
346 { return wmemset(__s
, __a
, __n
); }
348 static _GLIBCXX_CONSTEXPR char_type
349 to_char_type(const int_type
& __c
) _GLIBCXX_NOEXCEPT
350 { return char_type(__c
); }
352 static _GLIBCXX_CONSTEXPR int_type
353 to_int_type(const char_type
& __c
) _GLIBCXX_NOEXCEPT
354 { return int_type(__c
); }
356 static _GLIBCXX_CONSTEXPR
bool
357 eq_int_type(const int_type
& __c1
, const int_type
& __c2
) _GLIBCXX_NOEXCEPT
358 { return __c1
== __c2
; }
360 static _GLIBCXX_CONSTEXPR int_type
361 eof() _GLIBCXX_NOEXCEPT
362 { return static_cast<int_type
>(WEOF
); }
364 static _GLIBCXX_CONSTEXPR int_type
365 not_eof(const int_type
& __c
) _GLIBCXX_NOEXCEPT
366 { return eq_int_type(__c
, eof()) ? 0 : __c
; }
368 #endif //_GLIBCXX_USE_WCHAR_T
370 _GLIBCXX_END_NAMESPACE_VERSION
373 #if ((__cplusplus >= 201103L) \
374 && defined(_GLIBCXX_USE_C99_STDINT_TR1))
378 namespace std
_GLIBCXX_VISIBILITY(default)
380 _GLIBCXX_BEGIN_NAMESPACE_VERSION
383 struct char_traits
<char16_t
>
385 typedef char16_t char_type
;
386 typedef uint_least16_t int_type
;
387 typedef streamoff off_type
;
388 typedef u16streampos pos_type
;
389 typedef mbstate_t state_type
;
392 assign(char_type
& __c1
, const char_type
& __c2
) noexcept
395 static constexpr bool
396 eq(const char_type
& __c1
, const char_type
& __c2
) noexcept
397 { return __c1
== __c2
; }
399 static constexpr bool
400 lt(const char_type
& __c1
, const char_type
& __c2
) noexcept
401 { return __c1
< __c2
; }
404 compare(const char_type
* __s1
, const char_type
* __s2
, size_t __n
)
406 for (size_t __i
= 0; __i
< __n
; ++__i
)
407 if (lt(__s1
[__i
], __s2
[__i
]))
409 else if (lt(__s2
[__i
], __s1
[__i
]))
415 length(const char_type
* __s
)
418 while (!eq(__s
[__i
], char_type()))
423 static const char_type
*
424 find(const char_type
* __s
, size_t __n
, const char_type
& __a
)
426 for (size_t __i
= 0; __i
< __n
; ++__i
)
427 if (eq(__s
[__i
], __a
))
433 move(char_type
* __s1
, const char_type
* __s2
, size_t __n
)
435 return (static_cast<char_type
*>
436 (__builtin_memmove(__s1
, __s2
, __n
* sizeof(char_type
))));
440 copy(char_type
* __s1
, const char_type
* __s2
, size_t __n
)
442 return (static_cast<char_type
*>
443 (__builtin_memcpy(__s1
, __s2
, __n
* sizeof(char_type
))));
447 assign(char_type
* __s
, size_t __n
, char_type __a
)
449 for (size_t __i
= 0; __i
< __n
; ++__i
)
450 assign(__s
[__i
], __a
);
454 static constexpr char_type
455 to_char_type(const int_type
& __c
) noexcept
456 { return char_type(__c
); }
458 static constexpr int_type
459 to_int_type(const char_type
& __c
) noexcept
460 { return int_type(__c
); }
462 static constexpr bool
463 eq_int_type(const int_type
& __c1
, const int_type
& __c2
) noexcept
464 { return __c1
== __c2
; }
466 static constexpr int_type
468 { return static_cast<int_type
>(-1); }
470 static constexpr int_type
471 not_eof(const int_type
& __c
) noexcept
472 { return eq_int_type(__c
, eof()) ? 0 : __c
; }
476 struct char_traits
<char32_t
>
478 typedef char32_t char_type
;
479 typedef uint_least32_t int_type
;
480 typedef streamoff off_type
;
481 typedef u32streampos pos_type
;
482 typedef mbstate_t state_type
;
485 assign(char_type
& __c1
, const char_type
& __c2
) noexcept
488 static constexpr bool
489 eq(const char_type
& __c1
, const char_type
& __c2
) noexcept
490 { return __c1
== __c2
; }
492 static constexpr bool
493 lt(const char_type
& __c1
, const char_type
& __c2
) noexcept
494 { return __c1
< __c2
; }
497 compare(const char_type
* __s1
, const char_type
* __s2
, size_t __n
)
499 for (size_t __i
= 0; __i
< __n
; ++__i
)
500 if (lt(__s1
[__i
], __s2
[__i
]))
502 else if (lt(__s2
[__i
], __s1
[__i
]))
508 length(const char_type
* __s
)
511 while (!eq(__s
[__i
], char_type()))
516 static const char_type
*
517 find(const char_type
* __s
, size_t __n
, const char_type
& __a
)
519 for (size_t __i
= 0; __i
< __n
; ++__i
)
520 if (eq(__s
[__i
], __a
))
526 move(char_type
* __s1
, const char_type
* __s2
, size_t __n
)
528 return (static_cast<char_type
*>
529 (__builtin_memmove(__s1
, __s2
, __n
* sizeof(char_type
))));
533 copy(char_type
* __s1
, const char_type
* __s2
, size_t __n
)
535 return (static_cast<char_type
*>
536 (__builtin_memcpy(__s1
, __s2
, __n
* sizeof(char_type
))));
540 assign(char_type
* __s
, size_t __n
, char_type __a
)
542 for (size_t __i
= 0; __i
< __n
; ++__i
)
543 assign(__s
[__i
], __a
);
547 static constexpr char_type
548 to_char_type(const int_type
& __c
) noexcept
549 { return char_type(__c
); }
551 static constexpr int_type
552 to_int_type(const char_type
& __c
) noexcept
553 { return int_type(__c
); }
555 static constexpr bool
556 eq_int_type(const int_type
& __c1
, const int_type
& __c2
) noexcept
557 { return __c1
== __c2
; }
559 static constexpr int_type
561 { return static_cast<int_type
>(-1); }
563 static constexpr int_type
564 not_eof(const int_type
& __c
) noexcept
565 { return eq_int_type(__c
, eof()) ? 0 : __c
; }
568 _GLIBCXX_END_NAMESPACE_VERSION
573 #endif // _CHAR_TRAITS_H