1 // Locale support -*- C++ -*-
3 // Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
4 // 2006, 2007, 2008, 2009
5 // Free Software Foundation, Inc.
7 // This file is part of the GNU ISO C++ Library. This library is free
8 // software; you can redistribute it and/or modify it under the
9 // terms of the GNU General Public License as published by the
10 // Free Software Foundation; either version 3, or (at your option)
13 // This library is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 // GNU General Public License for more details.
18 // Under Section 7 of GPL version 3, you are granted additional
19 // permissions described in the GCC Runtime Library Exception, version
20 // 3.1, as published by the Free Software Foundation.
22 // You should have received a copy of the GNU General Public License and
23 // a copy of the GCC Runtime Library Exception along with this program;
24 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
25 // <http://www.gnu.org/licenses/>.
27 /** @file locale_facets.h
28 * This is an internal header file, included by other library headers.
29 * You should not attempt to use it directly.
33 // ISO C++ 14882: 22.1 Locales
36 #ifndef _LOCALE_FACETS_H
37 #define _LOCALE_FACETS_H 1
39 #pragma GCC system_header
41 #include <cwctype> // For wctype_t
43 #include <bits/ctype_base.h>
45 #include <bits/ios_base.h> // For ios_base, ios_base::iostate
47 #include <bits/cpp_type_traits.h>
48 #include <ext/type_traits.h>
49 #include <ext/numeric_traits.h>
50 #include <bits/streambuf_iterator.h>
52 _GLIBCXX_BEGIN_NAMESPACE(std)
54 // NB: Don't instantiate required wchar_t facets if no wchar_t support.
55 #ifdef _GLIBCXX_USE_WCHAR_T
56 # define _GLIBCXX_NUM_FACETS 28
58 # define _GLIBCXX_NUM_FACETS 14
61 // Convert string to numeric value of type _Tv and store results.
62 // NB: This is specialized for all required types, there is no
63 // generic definition.
64 template<typename _Tv>
66 __convert_to_v(const char* __in, _Tv& __out, ios_base::iostate& __err,
67 const __c_locale& __cloc);
69 // Explicit specializations for required types.
72 __convert_to_v(const char*, float&, ios_base::iostate&,
77 __convert_to_v(const char*, double&, ios_base::iostate&,
82 __convert_to_v(const char*, long double&, ios_base::iostate&,
85 // NB: __pad is a struct, rather than a function, so it can be
86 // partially-specialized.
87 template<typename _CharT, typename _Traits>
91 _S_pad(ios_base& __io, _CharT __fill, _CharT* __news,
92 const _CharT* __olds, streamsize __newlen, streamsize __oldlen);
95 // Used by both numeric and monetary facets.
96 // Inserts "group separator" characters into an array of characters.
97 // It's recursive, one iteration per group. It moves the characters
98 // in the buffer this way: "xxxx12345" -> "12,345xxx". Call this
99 // only with __gsize != 0.
100 template<typename _CharT>
102 __add_grouping(_CharT* __s, _CharT __sep,
103 const char* __gbeg, size_t __gsize,
104 const _CharT* __first, const _CharT* __last);
106 // This template permits specializing facet output code for
107 // ostreambuf_iterator. For ostreambuf_iterator, sputn is
108 // significantly more efficient than incrementing iterators.
109 template<typename _CharT>
111 ostreambuf_iterator<_CharT>
112 __write(ostreambuf_iterator<_CharT> __s, const _CharT* __ws, int __len)
114 __s._M_put(__ws, __len);
118 // This is the unspecialized form of the template.
119 template<typename _CharT, typename _OutIter>
122 __write(_OutIter __s, const _CharT* __ws, int __len)
124 for (int __j = 0; __j < __len; __j++, ++__s)
130 // 22.2.1.1 Template class ctype
131 // Include host and configuration specific ctype enums for ctype_base.
133 // Common base for ctype<_CharT>.
135 * @brief Common base for ctype facet
137 * This template class provides implementations of the public functions
138 * that forward to the protected virtual functions.
140 * This template also provides abstract stubs for the protected virtual
143 template<typename _CharT>
144 class __ctype_abstract_base : public locale::facet, public ctype_base
148 /// Typedef for the template parameter
149 typedef _CharT char_type;
152 * @brief Test char_type classification.
154 * This function finds a mask M for @a c and compares it to mask @a m.
155 * It does so by returning the value of ctype<char_type>::do_is().
157 * @param c The char_type to compare the mask of.
158 * @param m The mask to compare against.
159 * @return (M & m) != 0.
162 is(mask __m, char_type __c) const
163 { return this->do_is(__m, __c); }
166 * @brief Return a mask array.
168 * This function finds the mask for each char_type in the range [lo,hi)
169 * and successively writes it to vec. vec must have as many elements
170 * as the char array. It does so by returning the value of
171 * ctype<char_type>::do_is().
173 * @param lo Pointer to start of range.
174 * @param hi Pointer to end of range.
175 * @param vec Pointer to an array of mask storage.
179 is(const char_type *__lo, const char_type *__hi, mask *__vec) const
180 { return this->do_is(__lo, __hi, __vec); }
183 * @brief Find char_type matching a mask
185 * This function searches for and returns the first char_type c in
186 * [lo,hi) for which is(m,c) is true. It does so by returning
187 * ctype<char_type>::do_scan_is().
189 * @param m The mask to compare against.
190 * @param lo Pointer to start of range.
191 * @param hi Pointer to end of range.
192 * @return Pointer to matching char_type if found, else @a hi.
195 scan_is(mask __m, const char_type* __lo, const char_type* __hi) const
196 { return this->do_scan_is(__m, __lo, __hi); }
199 * @brief Find char_type not matching a mask
201 * This function searches for and returns the first char_type c in
202 * [lo,hi) for which is(m,c) is false. It does so by returning
203 * ctype<char_type>::do_scan_not().
205 * @param m The mask to compare against.
206 * @param lo Pointer to first char in range.
207 * @param hi Pointer to end of range.
208 * @return Pointer to non-matching char if found, else @a hi.
211 scan_not(mask __m, const char_type* __lo, const char_type* __hi) const
212 { return this->do_scan_not(__m, __lo, __hi); }
215 * @brief Convert to uppercase.
217 * This function converts the argument to uppercase if possible.
218 * If not possible (for example, '2'), returns the argument. It does
219 * so by returning ctype<char_type>::do_toupper().
221 * @param c The char_type to convert.
222 * @return The uppercase char_type if convertible, else @a c.
225 toupper(char_type __c) const
226 { return this->do_toupper(__c); }
229 * @brief Convert array to uppercase.
231 * This function converts each char_type in the range [lo,hi) to
232 * uppercase if possible. Other elements remain untouched. It does so
233 * by returning ctype<char_type>:: do_toupper(lo, hi).
235 * @param lo Pointer to start of range.
236 * @param hi Pointer to end of range.
240 toupper(char_type *__lo, const char_type* __hi) const
241 { return this->do_toupper(__lo, __hi); }
244 * @brief Convert to lowercase.
246 * This function converts the argument to lowercase if possible. If
247 * not possible (for example, '2'), returns the argument. It does so
248 * by returning ctype<char_type>::do_tolower(c).
250 * @param c The char_type to convert.
251 * @return The lowercase char_type if convertible, else @a c.
254 tolower(char_type __c) const
255 { return this->do_tolower(__c); }
258 * @brief Convert array to lowercase.
260 * This function converts each char_type in the range [lo,hi) to
261 * lowercase if possible. Other elements remain untouched. It does so
262 * by returning ctype<char_type>:: do_tolower(lo, hi).
264 * @param lo Pointer to start of range.
265 * @param hi Pointer to end of range.
269 tolower(char_type* __lo, const char_type* __hi) const
270 { return this->do_tolower(__lo, __hi); }
273 * @brief Widen char to char_type
275 * This function converts the char argument to char_type using the
276 * simplest reasonable transformation. It does so by returning
277 * ctype<char_type>::do_widen(c).
279 * Note: this is not what you want for codepage conversions. See
282 * @param c The char to convert.
283 * @return The converted char_type.
286 widen(char __c) const
287 { return this->do_widen(__c); }
290 * @brief Widen array to char_type
292 * This function converts each char in the input to char_type using the
293 * simplest reasonable transformation. It does so by returning
294 * ctype<char_type>::do_widen(c).
296 * Note: this is not what you want for codepage conversions. See
299 * @param lo Pointer to start of range.
300 * @param hi Pointer to end of range.
301 * @param to Pointer to the destination array.
305 widen(const char* __lo, const char* __hi, char_type* __to) const
306 { return this->do_widen(__lo, __hi, __to); }
309 * @brief Narrow char_type to char
311 * This function converts the char_type to char using the simplest
312 * reasonable transformation. If the conversion fails, dfault is
313 * returned instead. It does so by returning
314 * ctype<char_type>::do_narrow(c).
316 * Note: this is not what you want for codepage conversions. See
319 * @param c The char_type to convert.
320 * @param dfault Char to return if conversion fails.
321 * @return The converted char.
324 narrow(char_type __c, char __dfault) const
325 { return this->do_narrow(__c, __dfault); }
328 * @brief Narrow array to char array
330 * This function converts each char_type in the input to char using the
331 * simplest reasonable transformation and writes the results to the
332 * destination array. For any char_type in the input that cannot be
333 * converted, @a dfault is used instead. It does so by returning
334 * ctype<char_type>::do_narrow(lo, hi, dfault, to).
336 * Note: this is not what you want for codepage conversions. See
339 * @param lo Pointer to start of range.
340 * @param hi Pointer to end of range.
341 * @param dfault Char to use if conversion fails.
342 * @param to Pointer to the destination array.
346 narrow(const char_type* __lo, const char_type* __hi,
347 char __dfault, char *__to) const
348 { return this->do_narrow(__lo, __hi, __dfault, __to); }
352 __ctype_abstract_base(size_t __refs = 0): facet(__refs) { }
355 ~__ctype_abstract_base() { }
358 * @brief Test char_type classification.
360 * This function finds a mask M for @a c and compares it to mask @a m.
362 * do_is() is a hook for a derived facet to change the behavior of
363 * classifying. do_is() must always return the same result for the
366 * @param c The char_type to find the mask of.
367 * @param m The mask to compare against.
368 * @return (M & m) != 0.
371 do_is(mask __m, char_type __c) const = 0;
374 * @brief Return a mask array.
376 * This function finds the mask for each char_type in the range [lo,hi)
377 * and successively writes it to vec. vec must have as many elements
380 * do_is() is a hook for a derived facet to change the behavior of
381 * classifying. do_is() must always return the same result for the
384 * @param lo Pointer to start of range.
385 * @param hi Pointer to end of range.
386 * @param vec Pointer to an array of mask storage.
389 virtual const char_type*
390 do_is(const char_type* __lo, const char_type* __hi,
391 mask* __vec) const = 0;
394 * @brief Find char_type matching mask
396 * This function searches for and returns the first char_type c in
397 * [lo,hi) for which is(m,c) is true.
399 * do_scan_is() is a hook for a derived facet to change the behavior of
400 * match searching. do_is() must always return the same result for the
403 * @param m The mask to compare against.
404 * @param lo Pointer to start of range.
405 * @param hi Pointer to end of range.
406 * @return Pointer to a matching char_type if found, else @a hi.
408 virtual const char_type*
409 do_scan_is(mask __m, const char_type* __lo,
410 const char_type* __hi) const = 0;
413 * @brief Find char_type not matching mask
415 * This function searches for and returns a pointer to the first
416 * char_type c of [lo,hi) for which is(m,c) is false.
418 * do_scan_is() is a hook for a derived facet to change the behavior of
419 * match searching. do_is() must always return the same result for the
422 * @param m The mask to compare against.
423 * @param lo Pointer to start of range.
424 * @param hi Pointer to end of range.
425 * @return Pointer to a non-matching char_type if found, else @a hi.
427 virtual const char_type*
428 do_scan_not(mask __m, const char_type* __lo,
429 const char_type* __hi) const = 0;
432 * @brief Convert to uppercase.
434 * This virtual function converts the char_type argument to uppercase
435 * if possible. If not possible (for example, '2'), returns the
438 * do_toupper() is a hook for a derived facet to change the behavior of
439 * uppercasing. do_toupper() must always return the same result for
442 * @param c The char_type to convert.
443 * @return The uppercase char_type if convertible, else @a c.
446 do_toupper(char_type) const = 0;
449 * @brief Convert array to uppercase.
451 * This virtual function converts each char_type in the range [lo,hi)
452 * to uppercase if possible. Other elements remain untouched.
454 * do_toupper() is a hook for a derived facet to change the behavior of
455 * uppercasing. do_toupper() must always return the same result for
458 * @param lo Pointer to start of range.
459 * @param hi Pointer to end of range.
462 virtual const char_type*
463 do_toupper(char_type* __lo, const char_type* __hi) const = 0;
466 * @brief Convert to lowercase.
468 * This virtual function converts the argument to lowercase if
469 * possible. If not possible (for example, '2'), returns the argument.
471 * do_tolower() is a hook for a derived facet to change the behavior of
472 * lowercasing. do_tolower() must always return the same result for
475 * @param c The char_type to convert.
476 * @return The lowercase char_type if convertible, else @a c.
479 do_tolower(char_type) const = 0;
482 * @brief Convert array to lowercase.
484 * This virtual function converts each char_type in the range [lo,hi)
485 * to lowercase if possible. Other elements remain untouched.
487 * do_tolower() is a hook for a derived facet to change the behavior of
488 * lowercasing. do_tolower() must always return the same result for
491 * @param lo Pointer to start of range.
492 * @param hi Pointer to end of range.
495 virtual const char_type*
496 do_tolower(char_type* __lo, const char_type* __hi) const = 0;
501 * This virtual function converts the char to char_type using the
502 * simplest reasonable transformation.
504 * do_widen() is a hook for a derived facet to change the behavior of
505 * widening. do_widen() must always return the same result for the
508 * Note: this is not what you want for codepage conversions. See
511 * @param c The char to convert.
512 * @return The converted char_type
515 do_widen(char) const = 0;
518 * @brief Widen char array
520 * This function converts each char in the input to char_type using the
521 * simplest reasonable transformation.
523 * do_widen() is a hook for a derived facet to change the behavior of
524 * widening. do_widen() must always return the same result for the
527 * Note: this is not what you want for codepage conversions. See
530 * @param lo Pointer to start range.
531 * @param hi Pointer to end of range.
532 * @param to Pointer to the destination array.
536 do_widen(const char* __lo, const char* __hi,
537 char_type* __dest) const = 0;
540 * @brief Narrow char_type to char
542 * This virtual function converts the argument to char using the
543 * simplest reasonable transformation. If the conversion fails, dfault
544 * is returned instead.
546 * do_narrow() is a hook for a derived facet to change the behavior of
547 * narrowing. do_narrow() must always return the same result for the
550 * Note: this is not what you want for codepage conversions. See
553 * @param c The char_type to convert.
554 * @param dfault Char to return if conversion fails.
555 * @return The converted char.
558 do_narrow(char_type, char __dfault) const = 0;
561 * @brief Narrow char_type array to char
563 * This virtual function converts each char_type in the range [lo,hi) to
564 * char using the simplest reasonable transformation and writes the
565 * results to the destination array. For any element in the input that
566 * cannot be converted, @a dfault is used instead.
568 * do_narrow() is a hook for a derived facet to change the behavior of
569 * narrowing. do_narrow() must always return the same result for the
572 * Note: this is not what you want for codepage conversions. See
575 * @param lo Pointer to start of range.
576 * @param hi Pointer to end of range.
577 * @param dfault Char to use if conversion fails.
578 * @param to Pointer to the destination array.
581 virtual const char_type*
582 do_narrow(const char_type* __lo, const char_type* __hi,
583 char __dfault, char* __dest) const = 0;
586 // NB: Generic, mostly useless implementation.
588 * @brief Template ctype facet
590 * This template class defines classification and conversion functions for
591 * character sets. It wraps <cctype> functionality. Ctype gets used by
592 * streams for many I/O operations.
594 * This template provides the protected virtual functions the developer
595 * will have to replace in a derived class or specialization to make a
596 * working facet. The public functions that access them are defined in
597 * __ctype_abstract_base, to allow for implementation flexibility. See
598 * ctype<wchar_t> for an example. The functions are documented in
599 * __ctype_abstract_base.
601 * Note: implementations are provided for all the protected virtual
602 * functions, but will likely not be useful.
604 template<typename _CharT>
605 class ctype : public __ctype_abstract_base<_CharT>
609 typedef _CharT char_type;
610 typedef typename __ctype_abstract_base<_CharT>::mask mask;
612 /// The facet id for ctype<char_type>
613 static locale::id id;
616 ctype(size_t __refs = 0) : __ctype_abstract_base<_CharT>(__refs) { }
623 do_is(mask __m, char_type __c) const;
625 virtual const char_type*
626 do_is(const char_type* __lo, const char_type* __hi, mask* __vec) const;
628 virtual const char_type*
629 do_scan_is(mask __m, const char_type* __lo, const char_type* __hi) const;
631 virtual const char_type*
632 do_scan_not(mask __m, const char_type* __lo,
633 const char_type* __hi) const;
636 do_toupper(char_type __c) const;
638 virtual const char_type*
639 do_toupper(char_type* __lo, const char_type* __hi) const;
642 do_tolower(char_type __c) const;
644 virtual const char_type*
645 do_tolower(char_type* __lo, const char_type* __hi) const;
648 do_widen(char __c) const;
651 do_widen(const char* __lo, const char* __hi, char_type* __dest) const;
654 do_narrow(char_type, char __dfault) const;
656 virtual const char_type*
657 do_narrow(const char_type* __lo, const char_type* __hi,
658 char __dfault, char* __dest) const;
661 template<typename _CharT>
662 locale::id ctype<_CharT>::id;
664 // 22.2.1.3 ctype<char> specialization.
666 * @brief The ctype<char> specialization.
668 * This class defines classification and conversion functions for
669 * the char type. It gets used by char streams for many I/O
670 * operations. The char specialization provides a number of
671 * optimizations as well.
674 class ctype<char> : public locale::facet, public ctype_base
678 /// Typedef for the template parameter char.
679 typedef char char_type;
683 __c_locale _M_c_locale_ctype;
685 __to_type _M_toupper;
686 __to_type _M_tolower;
687 const mask* _M_table;
688 mutable char _M_widen_ok;
689 mutable char _M_widen[1 + static_cast<unsigned char>(-1)];
690 mutable char _M_narrow[1 + static_cast<unsigned char>(-1)];
691 mutable char _M_narrow_ok; // 0 uninitialized, 1 init,
692 // 2 memcpy can't be used
695 /// The facet id for ctype<char>
696 static locale::id id;
697 /// The size of the mask table. It is SCHAR_MAX + 1.
698 static const size_t table_size = 1 + static_cast<unsigned char>(-1);
701 * @brief Constructor performs initialization.
703 * This is the constructor provided by the standard.
705 * @param table If non-zero, table is used as the per-char mask.
706 * Else classic_table() is used.
707 * @param del If true, passes ownership of table to this facet.
708 * @param refs Passed to the base facet class.
711 ctype(const mask* __table = 0, bool __del = false, size_t __refs = 0);
714 * @brief Constructor performs static initialization.
716 * This constructor is used to construct the initial C locale facet.
718 * @param cloc Handle to C locale data.
719 * @param table If non-zero, table is used as the per-char mask.
720 * @param del If true, passes ownership of table to this facet.
721 * @param refs Passed to the base facet class.
724 ctype(__c_locale __cloc, const mask* __table = 0, bool __del = false,
728 * @brief Test char classification.
730 * This function compares the mask table[c] to @a m.
732 * @param c The char to compare the mask of.
733 * @param m The mask to compare against.
734 * @return True if m & table[c] is true, false otherwise.
737 is(mask __m, char __c) const;
740 * @brief Return a mask array.
742 * This function finds the mask for each char in the range [lo, hi) and
743 * successively writes it to vec. vec must have as many elements as
746 * @param lo Pointer to start of range.
747 * @param hi Pointer to end of range.
748 * @param vec Pointer to an array of mask storage.
752 is(const char* __lo, const char* __hi, mask* __vec) const;
755 * @brief Find char matching a mask
757 * This function searches for and returns the first char in [lo,hi) for
758 * which is(m,char) is true.
760 * @param m The mask to compare against.
761 * @param lo Pointer to start of range.
762 * @param hi Pointer to end of range.
763 * @return Pointer to a matching char if found, else @a hi.
766 scan_is(mask __m, const char* __lo, const char* __hi) const;
769 * @brief Find char not matching a mask
771 * This function searches for and returns a pointer to the first char
772 * in [lo,hi) for which is(m,char) is false.
774 * @param m The mask to compare against.
775 * @param lo Pointer to start of range.
776 * @param hi Pointer to end of range.
777 * @return Pointer to a non-matching char if found, else @a hi.
780 scan_not(mask __m, const char* __lo, const char* __hi) const;
783 * @brief Convert to uppercase.
785 * This function converts the char argument to uppercase if possible.
786 * If not possible (for example, '2'), returns the argument.
788 * toupper() acts as if it returns ctype<char>::do_toupper(c).
789 * do_toupper() must always return the same result for the same input.
791 * @param c The char to convert.
792 * @return The uppercase char if convertible, else @a c.
795 toupper(char_type __c) const
796 { return this->do_toupper(__c); }
799 * @brief Convert array to uppercase.
801 * This function converts each char in the range [lo,hi) to uppercase
802 * if possible. Other chars remain untouched.
804 * toupper() acts as if it returns ctype<char>:: do_toupper(lo, hi).
805 * do_toupper() must always return the same result for the same input.
807 * @param lo Pointer to first char in range.
808 * @param hi Pointer to end of range.
812 toupper(char_type *__lo, const char_type* __hi) const
813 { return this->do_toupper(__lo, __hi); }
816 * @brief Convert to lowercase.
818 * This function converts the char argument to lowercase if possible.
819 * If not possible (for example, '2'), returns the argument.
821 * tolower() acts as if it returns ctype<char>::do_tolower(c).
822 * do_tolower() must always return the same result for the same input.
824 * @param c The char to convert.
825 * @return The lowercase char if convertible, else @a c.
828 tolower(char_type __c) const
829 { return this->do_tolower(__c); }
832 * @brief Convert array to lowercase.
834 * This function converts each char in the range [lo,hi) to lowercase
835 * if possible. Other chars remain untouched.
837 * tolower() acts as if it returns ctype<char>:: do_tolower(lo, hi).
838 * do_tolower() must always return the same result for the same input.
840 * @param lo Pointer to first char in range.
841 * @param hi Pointer to end of range.
845 tolower(char_type* __lo, const char_type* __hi) const
846 { return this->do_tolower(__lo, __hi); }
851 * This function converts the char to char_type using the simplest
852 * reasonable transformation. For an underived ctype<char> facet, the
853 * argument will be returned unchanged.
855 * This function works as if it returns ctype<char>::do_widen(c).
856 * do_widen() must always return the same result for the same input.
858 * Note: this is not what you want for codepage conversions. See
861 * @param c The char to convert.
862 * @return The converted character.
865 widen(char __c) const
868 return _M_widen[static_cast<unsigned char>(__c)];
869 this->_M_widen_init();
870 return this->do_widen(__c);
874 * @brief Widen char array
876 * This function converts each char in the input to char using the
877 * simplest reasonable transformation. For an underived ctype<char>
878 * facet, the argument will be copied unchanged.
880 * This function works as if it returns ctype<char>::do_widen(c).
881 * do_widen() must always return the same result for the same input.
883 * Note: this is not what you want for codepage conversions. See
886 * @param lo Pointer to first char in range.
887 * @param hi Pointer to end of range.
888 * @param to Pointer to the destination array.
892 widen(const char* __lo, const char* __hi, char_type* __to) const
894 if (_M_widen_ok == 1)
896 __builtin_memcpy(__to, __lo, __hi - __lo);
901 return this->do_widen(__lo, __hi, __to);
907 * This function converts the char to char using the simplest
908 * reasonable transformation. If the conversion fails, dfault is
909 * returned instead. For an underived ctype<char> facet, @a c
910 * will be returned unchanged.
912 * This function works as if it returns ctype<char>::do_narrow(c).
913 * do_narrow() must always return the same result for the same input.
915 * Note: this is not what you want for codepage conversions. See
918 * @param c The char to convert.
919 * @param dfault Char to return if conversion fails.
920 * @return The converted character.
923 narrow(char_type __c, char __dfault) const
925 if (_M_narrow[static_cast<unsigned char>(__c)])
926 return _M_narrow[static_cast<unsigned char>(__c)];
927 const char __t = do_narrow(__c, __dfault);
929 _M_narrow[static_cast<unsigned char>(__c)] = __t;
934 * @brief Narrow char array
936 * This function converts each char in the input to char using the
937 * simplest reasonable transformation and writes the results to the
938 * destination array. For any char in the input that cannot be
939 * converted, @a dfault is used instead. For an underived ctype<char>
940 * facet, the argument will be copied unchanged.
942 * This function works as if it returns ctype<char>::do_narrow(lo, hi,
943 * dfault, to). do_narrow() must always return the same result for the
946 * Note: this is not what you want for codepage conversions. See
949 * @param lo Pointer to start of range.
950 * @param hi Pointer to end of range.
951 * @param dfault Char to use if conversion fails.
952 * @param to Pointer to the destination array.
956 narrow(const char_type* __lo, const char_type* __hi,
957 char __dfault, char *__to) const
959 if (__builtin_expect(_M_narrow_ok == 1, true))
961 __builtin_memcpy(__to, __lo, __hi - __lo);
966 return this->do_narrow(__lo, __hi, __dfault, __to);
969 // _GLIBCXX_RESOLVE_LIB_DEFECTS
970 // DR 695. ctype<char>::classic_table() not accessible.
971 /// Returns a pointer to the mask table provided to the constructor, or
972 /// the default from classic_table() if none was provided.
974 table() const throw()
977 /// Returns a pointer to the C locale mask table.
979 classic_table() throw();
985 * This function deletes table() if @a del was true in the
992 * @brief Convert to uppercase.
994 * This virtual function converts the char argument to uppercase if
995 * possible. If not possible (for example, '2'), returns the argument.
997 * do_toupper() is a hook for a derived facet to change the behavior of
998 * uppercasing. do_toupper() must always return the same result for
1001 * @param c The char to convert.
1002 * @return The uppercase char if convertible, else @a c.
1005 do_toupper(char_type) const;
1008 * @brief Convert array to uppercase.
1010 * This virtual function converts each char in the range [lo,hi) to
1011 * uppercase if possible. Other chars remain untouched.
1013 * do_toupper() is a hook for a derived facet to change the behavior of
1014 * uppercasing. do_toupper() must always return the same result for
1017 * @param lo Pointer to start of range.
1018 * @param hi Pointer to end of range.
1021 virtual const char_type*
1022 do_toupper(char_type* __lo, const char_type* __hi) const;
1025 * @brief Convert to lowercase.
1027 * This virtual function converts the char argument to lowercase if
1028 * possible. If not possible (for example, '2'), returns the argument.
1030 * do_tolower() is a hook for a derived facet to change the behavior of
1031 * lowercasing. do_tolower() must always return the same result for
1034 * @param c The char to convert.
1035 * @return The lowercase char if convertible, else @a c.
1038 do_tolower(char_type) const;
1041 * @brief Convert array to lowercase.
1043 * This virtual function converts each char in the range [lo,hi) to
1044 * lowercase if possible. Other chars remain untouched.
1046 * do_tolower() is a hook for a derived facet to change the behavior of
1047 * lowercasing. do_tolower() must always return the same result for
1050 * @param lo Pointer to first char in range.
1051 * @param hi Pointer to end of range.
1054 virtual const char_type*
1055 do_tolower(char_type* __lo, const char_type* __hi) const;
1060 * This virtual function converts the char to char using the simplest
1061 * reasonable transformation. For an underived ctype<char> facet, the
1062 * argument will be returned unchanged.
1064 * do_widen() is a hook for a derived facet to change the behavior of
1065 * widening. do_widen() must always return the same result for the
1068 * Note: this is not what you want for codepage conversions. See
1071 * @param c The char to convert.
1072 * @return The converted character.
1075 do_widen(char __c) const
1079 * @brief Widen char array
1081 * This function converts each char in the range [lo,hi) to char using
1082 * the simplest reasonable transformation. For an underived
1083 * ctype<char> facet, the argument will be copied unchanged.
1085 * do_widen() is a hook for a derived facet to change the behavior of
1086 * widening. do_widen() must always return the same result for the
1089 * Note: this is not what you want for codepage conversions. See
1092 * @param lo Pointer to start of range.
1093 * @param hi Pointer to end of range.
1094 * @param to Pointer to the destination array.
1098 do_widen(const char* __lo, const char* __hi, char_type* __dest) const
1100 __builtin_memcpy(__dest, __lo, __hi - __lo);
1105 * @brief Narrow char
1107 * This virtual function converts the char to char using the simplest
1108 * reasonable transformation. If the conversion fails, dfault is
1109 * returned instead. For an underived ctype<char> facet, @a c will be
1110 * returned unchanged.
1112 * do_narrow() is a hook for a derived facet to change the behavior of
1113 * narrowing. do_narrow() must always return the same result for the
1116 * Note: this is not what you want for codepage conversions. See
1119 * @param c The char to convert.
1120 * @param dfault Char to return if conversion fails.
1121 * @return The converted char.
1124 do_narrow(char_type __c, char) const
1128 * @brief Narrow char array to char array
1130 * This virtual function converts each char in the range [lo,hi) to
1131 * char using the simplest reasonable transformation and writes the
1132 * results to the destination array. For any char in the input that
1133 * cannot be converted, @a dfault is used instead. For an underived
1134 * ctype<char> facet, the argument will be copied unchanged.
1136 * do_narrow() is a hook for a derived facet to change the behavior of
1137 * narrowing. do_narrow() must always return the same result for the
1140 * Note: this is not what you want for codepage conversions. See
1143 * @param lo Pointer to start of range.
1144 * @param hi Pointer to end of range.
1145 * @param dfault Char to use if conversion fails.
1146 * @param to Pointer to the destination array.
1149 virtual const char_type*
1150 do_narrow(const char_type* __lo, const char_type* __hi,
1151 char, char* __dest) const
1153 __builtin_memcpy(__dest, __lo, __hi - __lo);
1158 void _M_narrow_init() const;
1159 void _M_widen_init() const;
1162 #ifdef _GLIBCXX_USE_WCHAR_T
1163 // 22.2.1.3 ctype<wchar_t> specialization
1165 * @brief The ctype<wchar_t> specialization.
1167 * This class defines classification and conversion functions for the
1168 * wchar_t type. It gets used by wchar_t streams for many I/O operations.
1169 * The wchar_t specialization provides a number of optimizations as well.
1171 * ctype<wchar_t> inherits its public methods from
1172 * __ctype_abstract_base<wchar_t>.
1175 class ctype<wchar_t> : public __ctype_abstract_base<wchar_t>
1179 /// Typedef for the template parameter wchar_t.
1180 typedef wchar_t char_type;
1181 typedef wctype_t __wmask_type;
1184 __c_locale _M_c_locale_ctype;
1186 // Pre-computed narrowed and widened chars.
1188 char _M_narrow[128];
1189 wint_t _M_widen[1 + static_cast<unsigned char>(-1)];
1191 // Pre-computed elements for do_is.
1193 __wmask_type _M_wmask[16];
1197 /// The facet id for ctype<wchar_t>
1198 static locale::id id;
1201 * @brief Constructor performs initialization.
1203 * This is the constructor provided by the standard.
1205 * @param refs Passed to the base facet class.
1208 ctype(size_t __refs = 0);
1211 * @brief Constructor performs static initialization.
1213 * This constructor is used to construct the initial C locale facet.
1215 * @param cloc Handle to C locale data.
1216 * @param refs Passed to the base facet class.
1219 ctype(__c_locale __cloc, size_t __refs = 0);
1223 _M_convert_to_wmask(const mask __m) const;
1230 * @brief Test wchar_t classification.
1232 * This function finds a mask M for @a c and compares it to mask @a m.
1234 * do_is() is a hook for a derived facet to change the behavior of
1235 * classifying. do_is() must always return the same result for the
1238 * @param c The wchar_t to find the mask of.
1239 * @param m The mask to compare against.
1240 * @return (M & m) != 0.
1243 do_is(mask __m, char_type __c) const;
1246 * @brief Return a mask array.
1248 * This function finds the mask for each wchar_t in the range [lo,hi)
1249 * and successively writes it to vec. vec must have as many elements
1252 * do_is() is a hook for a derived facet to change the behavior of
1253 * classifying. do_is() must always return the same result for the
1256 * @param lo Pointer to start of range.
1257 * @param hi Pointer to end of range.
1258 * @param vec Pointer to an array of mask storage.
1261 virtual const char_type*
1262 do_is(const char_type* __lo, const char_type* __hi, mask* __vec) const;
1265 * @brief Find wchar_t matching mask
1267 * This function searches for and returns the first wchar_t c in
1268 * [lo,hi) for which is(m,c) is true.
1270 * do_scan_is() is a hook for a derived facet to change the behavior of
1271 * match searching. do_is() must always return the same result for the
1274 * @param m The mask to compare against.
1275 * @param lo Pointer to start of range.
1276 * @param hi Pointer to end of range.
1277 * @return Pointer to a matching wchar_t if found, else @a hi.
1279 virtual const char_type*
1280 do_scan_is(mask __m, const char_type* __lo, const char_type* __hi) const;
1283 * @brief Find wchar_t not matching mask
1285 * This function searches for and returns a pointer to the first
1286 * wchar_t c of [lo,hi) for which is(m,c) is false.
1288 * do_scan_is() is a hook for a derived facet to change the behavior of
1289 * match searching. do_is() must always return the same result for the
1292 * @param m The mask to compare against.
1293 * @param lo Pointer to start of range.
1294 * @param hi Pointer to end of range.
1295 * @return Pointer to a non-matching wchar_t if found, else @a hi.
1297 virtual const char_type*
1298 do_scan_not(mask __m, const char_type* __lo,
1299 const char_type* __hi) const;
1302 * @brief Convert to uppercase.
1304 * This virtual function converts the wchar_t argument to uppercase if
1305 * possible. If not possible (for example, '2'), returns the argument.
1307 * do_toupper() is a hook for a derived facet to change the behavior of
1308 * uppercasing. do_toupper() must always return the same result for
1311 * @param c The wchar_t to convert.
1312 * @return The uppercase wchar_t if convertible, else @a c.
1315 do_toupper(char_type) const;
1318 * @brief Convert array to uppercase.
1320 * This virtual function converts each wchar_t in the range [lo,hi) to
1321 * uppercase if possible. Other elements remain untouched.
1323 * do_toupper() is a hook for a derived facet to change the behavior of
1324 * uppercasing. do_toupper() must always return the same result for
1327 * @param lo Pointer to start of range.
1328 * @param hi Pointer to end of range.
1331 virtual const char_type*
1332 do_toupper(char_type* __lo, const char_type* __hi) const;
1335 * @brief Convert to lowercase.
1337 * This virtual function converts the argument to lowercase if
1338 * possible. If not possible (for example, '2'), returns the argument.
1340 * do_tolower() is a hook for a derived facet to change the behavior of
1341 * lowercasing. do_tolower() must always return the same result for
1344 * @param c The wchar_t to convert.
1345 * @return The lowercase wchar_t if convertible, else @a c.
1348 do_tolower(char_type) const;
1351 * @brief Convert array to lowercase.
1353 * This virtual function converts each wchar_t in the range [lo,hi) to
1354 * lowercase if possible. Other elements remain untouched.
1356 * do_tolower() is a hook for a derived facet to change the behavior of
1357 * lowercasing. do_tolower() must always return the same result for
1360 * @param lo Pointer to start of range.
1361 * @param hi Pointer to end of range.
1364 virtual const char_type*
1365 do_tolower(char_type* __lo, const char_type* __hi) const;
1368 * @brief Widen char to wchar_t
1370 * This virtual function converts the char to wchar_t using the
1371 * simplest reasonable transformation. For an underived ctype<wchar_t>
1372 * facet, the argument will be cast to wchar_t.
1374 * do_widen() is a hook for a derived facet to change the behavior of
1375 * widening. do_widen() must always return the same result for the
1378 * Note: this is not what you want for codepage conversions. See
1381 * @param c The char to convert.
1382 * @return The converted wchar_t.
1385 do_widen(char) const;
1388 * @brief Widen char array to wchar_t array
1390 * This function converts each char in the input to wchar_t using the
1391 * simplest reasonable transformation. For an underived ctype<wchar_t>
1392 * facet, the argument will be copied, casting each element to wchar_t.
1394 * do_widen() is a hook for a derived facet to change the behavior of
1395 * widening. do_widen() must always return the same result for the
1398 * Note: this is not what you want for codepage conversions. See
1401 * @param lo Pointer to start range.
1402 * @param hi Pointer to end of range.
1403 * @param to Pointer to the destination array.
1407 do_widen(const char* __lo, const char* __hi, char_type* __dest) const;
1410 * @brief Narrow wchar_t to char
1412 * This virtual function converts the argument to char using
1413 * the simplest reasonable transformation. If the conversion
1414 * fails, dfault is returned instead. For an underived
1415 * ctype<wchar_t> facet, @a c will be cast to char and
1418 * do_narrow() is a hook for a derived facet to change the
1419 * behavior of narrowing. do_narrow() must always return the
1420 * same result for the same input.
1422 * Note: this is not what you want for codepage conversions. See
1425 * @param c The wchar_t to convert.
1426 * @param dfault Char to return if conversion fails.
1427 * @return The converted char.
1430 do_narrow(char_type, char __dfault) const;
1433 * @brief Narrow wchar_t array to char array
1435 * This virtual function converts each wchar_t in the range [lo,hi) to
1436 * char using the simplest reasonable transformation and writes the
1437 * results to the destination array. For any wchar_t in the input that
1438 * cannot be converted, @a dfault is used instead. For an underived
1439 * ctype<wchar_t> facet, the argument will be copied, casting each
1442 * do_narrow() is a hook for a derived facet to change the behavior of
1443 * narrowing. do_narrow() must always return the same result for the
1446 * Note: this is not what you want for codepage conversions. See
1449 * @param lo Pointer to start of range.
1450 * @param hi Pointer to end of range.
1451 * @param dfault Char to use if conversion fails.
1452 * @param to Pointer to the destination array.
1455 virtual const char_type*
1456 do_narrow(const char_type* __lo, const char_type* __hi,
1457 char __dfault, char* __dest) const;
1459 // For use at construction time only.
1461 _M_initialize_ctype();
1463 #endif //_GLIBCXX_USE_WCHAR_T
1465 /// class ctype_byname [22.2.1.2].
1466 template<typename _CharT>
1467 class ctype_byname : public ctype<_CharT>
1470 typedef typename ctype<_CharT>::mask mask;
1473 ctype_byname(const char* __s, size_t __refs = 0);
1477 ~ctype_byname() { };
1480 /// 22.2.1.4 Class ctype_byname specializations.
1482 class ctype_byname<char> : public ctype<char>
1486 ctype_byname(const char* __s, size_t __refs = 0);
1493 #ifdef _GLIBCXX_USE_WCHAR_T
1495 class ctype_byname<wchar_t> : public ctype<wchar_t>
1499 ctype_byname(const char* __s, size_t __refs = 0);
1507 _GLIBCXX_END_NAMESPACE
1509 // Include host and configuration specific ctype inlines.
1510 #include <bits/ctype_inline.h>
1512 _GLIBCXX_BEGIN_NAMESPACE(std)
1514 // 22.2.2 The numeric category.
1518 // NB: Code depends on the order of _S_atoms_out elements.
1519 // Below are the indices into _S_atoms_out.
1527 _S_odigits_end = _S_odigits + 16,
1528 _S_oudigits = _S_odigits_end,
1529 _S_oudigits_end = _S_oudigits + 16,
1530 _S_oe = _S_odigits + 14, // For scientific notation, 'e'
1531 _S_oE = _S_oudigits + 14, // For scientific notation, 'E'
1532 _S_oend = _S_oudigits_end
1535 // A list of valid numeric literals for output. This array
1536 // contains chars that will be passed through the current locale's
1537 // ctype<_CharT>.widen() and then used to render numbers.
1538 // For the standard "C" locale, this is
1539 // "-+xX0123456789abcdef0123456789ABCDEF".
1540 static const char* _S_atoms_out;
1542 // String literal of acceptable (narrow) input, for num_get.
1543 // "-+xX0123456789abcdefABCDEF"
1544 static const char* _S_atoms_in;
1553 _S_ie = _S_izero + 14,
1554 _S_iE = _S_izero + 20,
1559 // Construct and return valid scanf format for floating point types.
1561 _S_format_float(const ios_base& __io, char* __fptr, char __mod);
1564 template<typename _CharT>
1565 struct __numpunct_cache : public locale::facet
1567 const char* _M_grouping;
1568 size_t _M_grouping_size;
1569 bool _M_use_grouping;
1570 const _CharT* _M_truename;
1571 size_t _M_truename_size;
1572 const _CharT* _M_falsename;
1573 size_t _M_falsename_size;
1574 _CharT _M_decimal_point;
1575 _CharT _M_thousands_sep;
1577 // A list of valid numeric literals for output: in the standard
1578 // "C" locale, this is "-+xX0123456789abcdef0123456789ABCDEF".
1579 // This array contains the chars after having been passed
1580 // through the current locale's ctype<_CharT>.widen().
1581 _CharT _M_atoms_out[__num_base::_S_oend];
1583 // A list of valid numeric literals for input: in the standard
1584 // "C" locale, this is "-+xX0123456789abcdefABCDEF"
1585 // This array contains the chars after having been passed
1586 // through the current locale's ctype<_CharT>.widen().
1587 _CharT _M_atoms_in[__num_base::_S_iend];
1591 __numpunct_cache(size_t __refs = 0) : facet(__refs),
1592 _M_grouping(NULL), _M_grouping_size(0), _M_use_grouping(false),
1593 _M_truename(NULL), _M_truename_size(0), _M_falsename(NULL),
1594 _M_falsename_size(0), _M_decimal_point(_CharT()),
1595 _M_thousands_sep(_CharT()), _M_allocated(false)
1598 ~__numpunct_cache();
1601 _M_cache(const locale& __loc);
1605 operator=(const __numpunct_cache&);
1608 __numpunct_cache(const __numpunct_cache&);
1611 template<typename _CharT>
1612 __numpunct_cache<_CharT>::~__numpunct_cache()
1616 delete [] _M_grouping;
1617 delete [] _M_truename;
1618 delete [] _M_falsename;
1623 * @brief Numpunct facet.
1625 * This facet stores several pieces of information related to printing and
1626 * scanning numbers, such as the decimal point character. It takes a
1627 * template parameter specifying the char type. The numpunct facet is
1628 * used by streams for many I/O operations involving numbers.
1630 * The numpunct template uses protected virtual functions to provide the
1631 * actual results. The public accessors forward the call to the virtual
1632 * functions. These virtual functions are hooks for developers to
1633 * implement the behavior they require from a numpunct facet.
1635 template<typename _CharT>
1636 class numpunct : public locale::facet
1642 typedef _CharT char_type;
1643 typedef basic_string<_CharT> string_type;
1645 typedef __numpunct_cache<_CharT> __cache_type;
1648 __cache_type* _M_data;
1651 /// Numpunct facet id.
1652 static locale::id id;
1655 * @brief Numpunct constructor.
1657 * @param refs Refcount to pass to the base class.
1660 numpunct(size_t __refs = 0) : facet(__refs), _M_data(NULL)
1661 { _M_initialize_numpunct(); }
1664 * @brief Internal constructor. Not for general use.
1666 * This is a constructor for use by the library itself to set up the
1667 * predefined locale facets.
1669 * @param cache __numpunct_cache object.
1670 * @param refs Refcount to pass to the base class.
1673 numpunct(__cache_type* __cache, size_t __refs = 0)
1674 : facet(__refs), _M_data(__cache)
1675 { _M_initialize_numpunct(); }
1678 * @brief Internal constructor. Not for general use.
1680 * This is a constructor for use by the library itself to set up new
1683 * @param cloc The "C" locale.
1684 * @param refs Refcount to pass to the base class.
1687 numpunct(__c_locale __cloc, size_t __refs = 0)
1688 : facet(__refs), _M_data(NULL)
1689 { _M_initialize_numpunct(__cloc); }
1692 * @brief Return decimal point character.
1694 * This function returns a char_type to use as a decimal point. It
1695 * does so by returning returning
1696 * numpunct<char_type>::do_decimal_point().
1698 * @return @a char_type representing a decimal point.
1701 decimal_point() const
1702 { return this->do_decimal_point(); }
1705 * @brief Return thousands separator character.
1707 * This function returns a char_type to use as a thousands
1708 * separator. It does so by returning returning
1709 * numpunct<char_type>::do_thousands_sep().
1711 * @return char_type representing a thousands separator.
1714 thousands_sep() const
1715 { return this->do_thousands_sep(); }
1718 * @brief Return grouping specification.
1720 * This function returns a string representing groupings for the
1721 * integer part of a number. Groupings indicate where thousands
1722 * separators should be inserted in the integer part of a number.
1724 * Each char in the return string is interpret as an integer
1725 * rather than a character. These numbers represent the number
1726 * of digits in a group. The first char in the string
1727 * represents the number of digits in the least significant
1728 * group. If a char is negative, it indicates an unlimited
1729 * number of digits for the group. If more chars from the
1730 * string are required to group a number, the last char is used
1733 * For example, if the grouping() returns "\003\002" and is
1734 * applied to the number 123456789, this corresponds to
1735 * 12,34,56,789. Note that if the string was "32", this would
1736 * put more than 50 digits into the least significant group if
1737 * the character set is ASCII.
1739 * The string is returned by calling
1740 * numpunct<char_type>::do_grouping().
1742 * @return string representing grouping specification.
1746 { return this->do_grouping(); }
1749 * @brief Return string representation of bool true.
1751 * This function returns a string_type containing the text
1752 * representation for true bool variables. It does so by calling
1753 * numpunct<char_type>::do_truename().
1755 * @return string_type representing printed form of true.
1759 { return this->do_truename(); }
1762 * @brief Return string representation of bool false.
1764 * This function returns a string_type containing the text
1765 * representation for false bool variables. It does so by calling
1766 * numpunct<char_type>::do_falsename().
1768 * @return string_type representing printed form of false.
1772 { return this->do_falsename(); }
1780 * @brief Return decimal point character.
1782 * Returns a char_type to use as a decimal point. This function is a
1783 * hook for derived classes to change the value returned.
1785 * @return @a char_type representing a decimal point.
1788 do_decimal_point() const
1789 { return _M_data->_M_decimal_point; }
1792 * @brief Return thousands separator character.
1794 * Returns a char_type to use as a thousands separator. This function
1795 * is a hook for derived classes to change the value returned.
1797 * @return @a char_type representing a thousands separator.
1800 do_thousands_sep() const
1801 { return _M_data->_M_thousands_sep; }
1804 * @brief Return grouping specification.
1806 * Returns a string representing groupings for the integer part of a
1807 * number. This function is a hook for derived classes to change the
1808 * value returned. @see grouping() for details.
1810 * @return String representing grouping specification.
1814 { return _M_data->_M_grouping; }
1817 * @brief Return string representation of bool true.
1819 * Returns a string_type containing the text representation for true
1820 * bool variables. This function is a hook for derived classes to
1821 * change the value returned.
1823 * @return string_type representing printed form of true.
1827 { return _M_data->_M_truename; }
1830 * @brief Return string representation of bool false.
1832 * Returns a string_type containing the text representation for false
1833 * bool variables. This function is a hook for derived classes to
1834 * change the value returned.
1836 * @return string_type representing printed form of false.
1839 do_falsename() const
1840 { return _M_data->_M_falsename; }
1842 // For use at construction time only.
1844 _M_initialize_numpunct(__c_locale __cloc = NULL);
1847 template<typename _CharT>
1848 locale::id numpunct<_CharT>::id;
1851 numpunct<char>::~numpunct();
1855 numpunct<char>::_M_initialize_numpunct(__c_locale __cloc);
1857 #ifdef _GLIBCXX_USE_WCHAR_T
1859 numpunct<wchar_t>::~numpunct();
1863 numpunct<wchar_t>::_M_initialize_numpunct(__c_locale __cloc);
1866 /// class numpunct_byname [22.2.3.2].
1867 template<typename _CharT>
1868 class numpunct_byname : public numpunct<_CharT>
1871 typedef _CharT char_type;
1872 typedef basic_string<_CharT> string_type;
1875 numpunct_byname(const char* __s, size_t __refs = 0)
1876 : numpunct<_CharT>(__refs)
1878 if (__builtin_strcmp(__s, "C") != 0
1879 && __builtin_strcmp(__s, "POSIX") != 0)
1882 this->_S_create_c_locale(__tmp, __s);
1883 this->_M_initialize_numpunct(__tmp);
1884 this->_S_destroy_c_locale(__tmp);
1890 ~numpunct_byname() { }
1893 _GLIBCXX_BEGIN_LDBL_NAMESPACE
1896 * @brief Facet for parsing number strings.
1898 * This facet encapsulates the code to parse and return a number
1899 * from a string. It is used by the istream numeric extraction
1902 * The num_get template uses protected virtual functions to provide the
1903 * actual results. The public accessors forward the call to the virtual
1904 * functions. These virtual functions are hooks for developers to
1905 * implement the behavior they require from the num_get facet.
1907 template<typename _CharT, typename _InIter>
1908 class num_get : public locale::facet
1914 typedef _CharT char_type;
1915 typedef _InIter iter_type;
1918 /// Numpunct facet id.
1919 static locale::id id;
1922 * @brief Constructor performs initialization.
1924 * This is the constructor provided by the standard.
1926 * @param refs Passed to the base facet class.
1929 num_get(size_t __refs = 0) : facet(__refs) { }
1932 * @brief Numeric parsing.
1934 * Parses the input stream into the bool @a v. It does so by calling
1935 * num_get::do_get().
1937 * If ios_base::boolalpha is set, attempts to read
1938 * ctype<CharT>::truename() or ctype<CharT>::falsename(). Sets
1939 * @a v to true or false if successful. Sets err to
1940 * ios_base::failbit if reading the string fails. Sets err to
1941 * ios_base::eofbit if the stream is emptied.
1943 * If ios_base::boolalpha is not set, proceeds as with reading a long,
1944 * except if the value is 1, sets @a v to true, if the value is 0, sets
1945 * @a v to false, and otherwise set err to ios_base::failbit.
1947 * @param in Start of input stream.
1948 * @param end End of input stream.
1949 * @param io Source of locale and flags.
1950 * @param err Error flags to set.
1951 * @param v Value to format and insert.
1952 * @return Iterator after reading.
1955 get(iter_type __in, iter_type __end, ios_base& __io,
1956 ios_base::iostate& __err, bool& __v) const
1957 { return this->do_get(__in, __end, __io, __err, __v); }
1961 * @brief Numeric parsing.
1963 * Parses the input stream into the integral variable @a v. It does so
1964 * by calling num_get::do_get().
1966 * Parsing is affected by the flag settings in @a io.
1968 * The basic parse is affected by the value of io.flags() &
1969 * ios_base::basefield. If equal to ios_base::oct, parses like the
1970 * scanf %o specifier. Else if equal to ios_base::hex, parses like %X
1971 * specifier. Else if basefield equal to 0, parses like the %i
1972 * specifier. Otherwise, parses like %d for signed and %u for unsigned
1973 * types. The matching type length modifier is also used.
1975 * Digit grouping is interpreted according to numpunct::grouping() and
1976 * numpunct::thousands_sep(). If the pattern of digit groups isn't
1977 * consistent, sets err to ios_base::failbit.
1979 * If parsing the string yields a valid value for @a v, @a v is set.
1980 * Otherwise, sets err to ios_base::failbit and leaves @a v unaltered.
1981 * Sets err to ios_base::eofbit if the stream is emptied.
1983 * @param in Start of input stream.
1984 * @param end End of input stream.
1985 * @param io Source of locale and flags.
1986 * @param err Error flags to set.
1987 * @param v Value to format and insert.
1988 * @return Iterator after reading.
1991 get(iter_type __in, iter_type __end, ios_base& __io,
1992 ios_base::iostate& __err, long& __v) const
1993 { return this->do_get(__in, __end, __io, __err, __v); }
1996 get(iter_type __in, iter_type __end, ios_base& __io,
1997 ios_base::iostate& __err, unsigned short& __v) const
1998 { return this->do_get(__in, __end, __io, __err, __v); }
2001 get(iter_type __in, iter_type __end, ios_base& __io,
2002 ios_base::iostate& __err, unsigned int& __v) const
2003 { return this->do_get(__in, __end, __io, __err, __v); }
2006 get(iter_type __in, iter_type __end, ios_base& __io,
2007 ios_base::iostate& __err, unsigned long& __v) const
2008 { return this->do_get(__in, __end, __io, __err, __v); }
2010 #ifdef _GLIBCXX_USE_LONG_LONG
2012 get(iter_type __in, iter_type __end, ios_base& __io,
2013 ios_base::iostate& __err, long long& __v) const
2014 { return this->do_get(__in, __end, __io, __err, __v); }
2017 get(iter_type __in, iter_type __end, ios_base& __io,
2018 ios_base::iostate& __err, unsigned long long& __v) const
2019 { return this->do_get(__in, __end, __io, __err, __v); }
2025 * @brief Numeric parsing.
2027 * Parses the input stream into the integral variable @a v. It does so
2028 * by calling num_get::do_get().
2030 * The input characters are parsed like the scanf %g specifier. The
2031 * matching type length modifier is also used.
2033 * The decimal point character used is numpunct::decimal_point().
2034 * Digit grouping is interpreted according to numpunct::grouping() and
2035 * numpunct::thousands_sep(). If the pattern of digit groups isn't
2036 * consistent, sets err to ios_base::failbit.
2038 * If parsing the string yields a valid value for @a v, @a v is set.
2039 * Otherwise, sets err to ios_base::failbit and leaves @a v unaltered.
2040 * Sets err to ios_base::eofbit if the stream is emptied.
2042 * @param in Start of input stream.
2043 * @param end End of input stream.
2044 * @param io Source of locale and flags.
2045 * @param err Error flags to set.
2046 * @param v Value to format and insert.
2047 * @return Iterator after reading.
2050 get(iter_type __in, iter_type __end, ios_base& __io,
2051 ios_base::iostate& __err, float& __v) const
2052 { return this->do_get(__in, __end, __io, __err, __v); }
2055 get(iter_type __in, iter_type __end, ios_base& __io,
2056 ios_base::iostate& __err, double& __v) const
2057 { return this->do_get(__in, __end, __io, __err, __v); }
2060 get(iter_type __in, iter_type __end, ios_base& __io,
2061 ios_base::iostate& __err, long double& __v) const
2062 { return this->do_get(__in, __end, __io, __err, __v); }
2066 * @brief Numeric parsing.
2068 * Parses the input stream into the pointer variable @a v. It does so
2069 * by calling num_get::do_get().
2071 * The input characters are parsed like the scanf %p specifier.
2073 * Digit grouping is interpreted according to numpunct::grouping() and
2074 * numpunct::thousands_sep(). If the pattern of digit groups isn't
2075 * consistent, sets err to ios_base::failbit.
2077 * Note that the digit grouping effect for pointers is a bit ambiguous
2078 * in the standard and shouldn't be relied on. See DR 344.
2080 * If parsing the string yields a valid value for @a v, @a v is set.
2081 * Otherwise, sets err to ios_base::failbit and leaves @a v unaltered.
2082 * Sets err to ios_base::eofbit if the stream is emptied.
2084 * @param in Start of input stream.
2085 * @param end End of input stream.
2086 * @param io Source of locale and flags.
2087 * @param err Error flags to set.
2088 * @param v Value to format and insert.
2089 * @return Iterator after reading.
2092 get(iter_type __in, iter_type __end, ios_base& __io,
2093 ios_base::iostate& __err, void*& __v) const
2094 { return this->do_get(__in, __end, __io, __err, __v); }
2098 virtual ~num_get() { }
2101 _M_extract_float(iter_type, iter_type, ios_base&, ios_base::iostate&,
2104 template<typename _ValueT>
2106 _M_extract_int(iter_type, iter_type, ios_base&, ios_base::iostate&,
2109 template<typename _CharT2>
2110 typename __gnu_cxx::__enable_if<__is_char<_CharT2>::__value, int>::__type
2111 _M_find(const _CharT2*, size_t __len, _CharT2 __c) const
2116 if (__c >= _CharT2('0') && __c < _CharT2(_CharT2('0') + __len))
2117 __ret = __c - _CharT2('0');
2121 if (__c >= _CharT2('0') && __c <= _CharT2('9'))
2122 __ret = __c - _CharT2('0');
2123 else if (__c >= _CharT2('a') && __c <= _CharT2('f'))
2124 __ret = 10 + (__c - _CharT2('a'));
2125 else if (__c >= _CharT2('A') && __c <= _CharT2('F'))
2126 __ret = 10 + (__c - _CharT2('A'));
2131 template<typename _CharT2>
2132 typename __gnu_cxx::__enable_if<!__is_char<_CharT2>::__value,
2134 _M_find(const _CharT2* __zero, size_t __len, _CharT2 __c) const
2137 const char_type* __q = char_traits<_CharT2>::find(__zero, __len, __c);
2140 __ret = __q - __zero;
2149 * @brief Numeric parsing.
2151 * Parses the input stream into the variable @a v. This function is a
2152 * hook for derived classes to change the value returned. @see get()
2155 * @param in Start of input stream.
2156 * @param end End of input stream.
2157 * @param io Source of locale and flags.
2158 * @param err Error flags to set.
2159 * @param v Value to format and insert.
2160 * @return Iterator after reading.
2163 do_get(iter_type, iter_type, ios_base&, ios_base::iostate&, bool&) const;
2166 do_get(iter_type __beg, iter_type __end, ios_base& __io,
2167 ios_base::iostate& __err, long& __v) const
2168 { return _M_extract_int(__beg, __end, __io, __err, __v); }
2171 do_get(iter_type __beg, iter_type __end, ios_base& __io,
2172 ios_base::iostate& __err, unsigned short& __v) const
2173 { return _M_extract_int(__beg, __end, __io, __err, __v); }
2176 do_get(iter_type __beg, iter_type __end, ios_base& __io,
2177 ios_base::iostate& __err, unsigned int& __v) const
2178 { return _M_extract_int(__beg, __end, __io, __err, __v); }
2181 do_get(iter_type __beg, iter_type __end, ios_base& __io,
2182 ios_base::iostate& __err, unsigned long& __v) const
2183 { return _M_extract_int(__beg, __end, __io, __err, __v); }
2185 #ifdef _GLIBCXX_USE_LONG_LONG
2187 do_get(iter_type __beg, iter_type __end, ios_base& __io,
2188 ios_base::iostate& __err, long long& __v) const
2189 { return _M_extract_int(__beg, __end, __io, __err, __v); }
2192 do_get(iter_type __beg, iter_type __end, ios_base& __io,
2193 ios_base::iostate& __err, unsigned long long& __v) const
2194 { return _M_extract_int(__beg, __end, __io, __err, __v); }
2198 do_get(iter_type, iter_type, ios_base&, ios_base::iostate& __err,
2202 do_get(iter_type, iter_type, ios_base&, ios_base::iostate& __err,
2205 // XXX GLIBCXX_ABI Deprecated
2206 #if defined _GLIBCXX_LONG_DOUBLE_COMPAT && defined __LONG_DOUBLE_128__
2208 __do_get(iter_type, iter_type, ios_base&, ios_base::iostate& __err,
2212 do_get(iter_type, iter_type, ios_base&, ios_base::iostate& __err,
2213 long double&) const;
2217 do_get(iter_type, iter_type, ios_base&, ios_base::iostate& __err,
2220 // XXX GLIBCXX_ABI Deprecated
2221 #if defined _GLIBCXX_LONG_DOUBLE_COMPAT && defined __LONG_DOUBLE_128__
2223 do_get(iter_type, iter_type, ios_base&, ios_base::iostate& __err,
2224 long double&) const;
2229 template<typename _CharT, typename _InIter>
2230 locale::id num_get<_CharT, _InIter>::id;
2234 * @brief Facet for converting numbers to strings.
2236 * This facet encapsulates the code to convert a number to a string. It is
2237 * used by the ostream numeric insertion operators.
2239 * The num_put template uses protected virtual functions to provide the
2240 * actual results. The public accessors forward the call to the virtual
2241 * functions. These virtual functions are hooks for developers to
2242 * implement the behavior they require from the num_put facet.
2244 template<typename _CharT, typename _OutIter>
2245 class num_put : public locale::facet
2251 typedef _CharT char_type;
2252 typedef _OutIter iter_type;
2255 /// Numpunct facet id.
2256 static locale::id id;
2259 * @brief Constructor performs initialization.
2261 * This is the constructor provided by the standard.
2263 * @param refs Passed to the base facet class.
2266 num_put(size_t __refs = 0) : facet(__refs) { }
2269 * @brief Numeric formatting.
2271 * Formats the boolean @a v and inserts it into a stream. It does so
2272 * by calling num_put::do_put().
2274 * If ios_base::boolalpha is set, writes ctype<CharT>::truename() or
2275 * ctype<CharT>::falsename(). Otherwise formats @a v as an int.
2277 * @param s Stream to write to.
2278 * @param io Source of locale and flags.
2279 * @param fill Char_type to use for filling.
2280 * @param v Value to format and insert.
2281 * @return Iterator after writing.
2284 put(iter_type __s, ios_base& __f, char_type __fill, bool __v) const
2285 { return this->do_put(__s, __f, __fill, __v); }
2289 * @brief Numeric formatting.
2291 * Formats the integral value @a v and inserts it into a
2292 * stream. It does so by calling num_put::do_put().
2294 * Formatting is affected by the flag settings in @a io.
2296 * The basic format is affected by the value of io.flags() &
2297 * ios_base::basefield. If equal to ios_base::oct, formats like the
2298 * printf %o specifier. Else if equal to ios_base::hex, formats like
2299 * %x or %X with ios_base::uppercase unset or set respectively.
2300 * Otherwise, formats like %d, %ld, %lld for signed and %u, %lu, %llu
2301 * for unsigned values. Note that if both oct and hex are set, neither
2304 * If ios_base::showpos is set, '+' is output before positive values.
2305 * If ios_base::showbase is set, '0' precedes octal values (except 0)
2306 * and '0[xX]' precedes hex values.
2308 * Thousands separators are inserted according to numpunct::grouping()
2309 * and numpunct::thousands_sep(). The decimal point character used is
2310 * numpunct::decimal_point().
2312 * If io.width() is non-zero, enough @a fill characters are inserted to
2313 * make the result at least that wide. If
2314 * (io.flags() & ios_base::adjustfield) == ios_base::left, result is
2315 * padded at the end. If ios_base::internal, then padding occurs
2316 * immediately after either a '+' or '-' or after '0x' or '0X'.
2317 * Otherwise, padding occurs at the beginning.
2319 * @param s Stream to write to.
2320 * @param io Source of locale and flags.
2321 * @param fill Char_type to use for filling.
2322 * @param v Value to format and insert.
2323 * @return Iterator after writing.
2326 put(iter_type __s, ios_base& __f, char_type __fill, long __v) const
2327 { return this->do_put(__s, __f, __fill, __v); }
2330 put(iter_type __s, ios_base& __f, char_type __fill,
2331 unsigned long __v) const
2332 { return this->do_put(__s, __f, __fill, __v); }
2334 #ifdef _GLIBCXX_USE_LONG_LONG
2336 put(iter_type __s, ios_base& __f, char_type __fill, long long __v) const
2337 { return this->do_put(__s, __f, __fill, __v); }
2340 put(iter_type __s, ios_base& __f, char_type __fill,
2341 unsigned long long __v) const
2342 { return this->do_put(__s, __f, __fill, __v); }
2348 * @brief Numeric formatting.
2350 * Formats the floating point value @a v and inserts it into a stream.
2351 * It does so by calling num_put::do_put().
2353 * Formatting is affected by the flag settings in @a io.
2355 * The basic format is affected by the value of io.flags() &
2356 * ios_base::floatfield. If equal to ios_base::fixed, formats like the
2357 * printf %f specifier. Else if equal to ios_base::scientific, formats
2358 * like %e or %E with ios_base::uppercase unset or set respectively.
2359 * Otherwise, formats like %g or %G depending on uppercase. Note that
2360 * if both fixed and scientific are set, the effect will also be like
2363 * The output precision is given by io.precision(). This precision is
2364 * capped at numeric_limits::digits10 + 2 (different for double and
2365 * long double). The default precision is 6.
2367 * If ios_base::showpos is set, '+' is output before positive values.
2368 * If ios_base::showpoint is set, a decimal point will always be
2371 * Thousands separators are inserted according to numpunct::grouping()
2372 * and numpunct::thousands_sep(). The decimal point character used is
2373 * numpunct::decimal_point().
2375 * If io.width() is non-zero, enough @a fill characters are inserted to
2376 * make the result at least that wide. If
2377 * (io.flags() & ios_base::adjustfield) == ios_base::left, result is
2378 * padded at the end. If ios_base::internal, then padding occurs
2379 * immediately after either a '+' or '-' or after '0x' or '0X'.
2380 * Otherwise, padding occurs at the beginning.
2382 * @param s Stream to write to.
2383 * @param io Source of locale and flags.
2384 * @param fill Char_type to use for filling.
2385 * @param v Value to format and insert.
2386 * @return Iterator after writing.
2389 put(iter_type __s, ios_base& __f, char_type __fill, double __v) const
2390 { return this->do_put(__s, __f, __fill, __v); }
2393 put(iter_type __s, ios_base& __f, char_type __fill,
2394 long double __v) const
2395 { return this->do_put(__s, __f, __fill, __v); }
2399 * @brief Numeric formatting.
2401 * Formats the pointer value @a v and inserts it into a stream. It
2402 * does so by calling num_put::do_put().
2404 * This function formats @a v as an unsigned long with ios_base::hex
2405 * and ios_base::showbase set.
2407 * @param s Stream to write to.
2408 * @param io Source of locale and flags.
2409 * @param fill Char_type to use for filling.
2410 * @param v Value to format and insert.
2411 * @return Iterator after writing.
2414 put(iter_type __s, ios_base& __f, char_type __fill,
2415 const void* __v) const
2416 { return this->do_put(__s, __f, __fill, __v); }
2419 template<typename _ValueT>
2421 _M_insert_float(iter_type, ios_base& __io, char_type __fill,
2422 char __mod, _ValueT __v) const;
2425 _M_group_float(const char* __grouping, size_t __grouping_size,
2426 char_type __sep, const char_type* __p, char_type* __new,
2427 char_type* __cs, int& __len) const;
2429 template<typename _ValueT>
2431 _M_insert_int(iter_type, ios_base& __io, char_type __fill,
2435 _M_group_int(const char* __grouping, size_t __grouping_size,
2436 char_type __sep, ios_base& __io, char_type* __new,
2437 char_type* __cs, int& __len) const;
2440 _M_pad(char_type __fill, streamsize __w, ios_base& __io,
2441 char_type* __new, const char_type* __cs, int& __len) const;
2449 * @brief Numeric formatting.
2451 * These functions do the work of formatting numeric values and
2452 * inserting them into a stream. This function is a hook for derived
2453 * classes to change the value returned.
2455 * @param s Stream to write to.
2456 * @param io Source of locale and flags.
2457 * @param fill Char_type to use for filling.
2458 * @param v Value to format and insert.
2459 * @return Iterator after writing.
2462 do_put(iter_type, ios_base&, char_type __fill, bool __v) const;
2465 do_put(iter_type __s, ios_base& __io, char_type __fill, long __v) const
2466 { return _M_insert_int(__s, __io, __fill, __v); }
2469 do_put(iter_type __s, ios_base& __io, char_type __fill,
2470 unsigned long __v) const
2471 { return _M_insert_int(__s, __io, __fill, __v); }
2473 #ifdef _GLIBCXX_USE_LONG_LONG
2475 do_put(iter_type __s, ios_base& __io, char_type __fill,
2476 long long __v) const
2477 { return _M_insert_int(__s, __io, __fill, __v); }
2480 do_put(iter_type __s, ios_base& __io, char_type __fill,
2481 unsigned long long __v) const
2482 { return _M_insert_int(__s, __io, __fill, __v); }
2486 do_put(iter_type, ios_base&, char_type __fill, double __v) const;
2488 // XXX GLIBCXX_ABI Deprecated
2489 #if defined _GLIBCXX_LONG_DOUBLE_COMPAT && defined __LONG_DOUBLE_128__
2491 __do_put(iter_type, ios_base&, char_type __fill, double __v) const;
2494 do_put(iter_type, ios_base&, char_type __fill, long double __v) const;
2498 do_put(iter_type, ios_base&, char_type __fill, const void* __v) const;
2500 // XXX GLIBCXX_ABI Deprecated
2501 #if defined _GLIBCXX_LONG_DOUBLE_COMPAT && defined __LONG_DOUBLE_128__
2503 do_put(iter_type, ios_base&, char_type __fill, long double __v) const;
2508 template <typename _CharT, typename _OutIter>
2509 locale::id num_put<_CharT, _OutIter>::id;
2511 _GLIBCXX_END_LDBL_NAMESPACE
2513 // Subclause convenience interfaces, inlines.
2514 // NB: These are inline because, when used in a loop, some compilers
2515 // can hoist the body out of the loop; then it's just as fast as the
2516 // C is*() function.
2518 /// Convenience interface to ctype.is(ctype_base::space, __c).
2519 template<typename _CharT>
2521 isspace(_CharT __c, const locale& __loc)
2522 { return use_facet<ctype<_CharT> >(__loc).is(ctype_base::space, __c); }
2524 /// Convenience interface to ctype.is(ctype_base::print, __c).
2525 template<typename _CharT>
2527 isprint(_CharT __c, const locale& __loc)
2528 { return use_facet<ctype<_CharT> >(__loc).is(ctype_base::print, __c); }
2530 /// Convenience interface to ctype.is(ctype_base::cntrl, __c).
2531 template<typename _CharT>
2533 iscntrl(_CharT __c, const locale& __loc)
2534 { return use_facet<ctype<_CharT> >(__loc).is(ctype_base::cntrl, __c); }
2536 /// Convenience interface to ctype.is(ctype_base::upper, __c).
2537 template<typename _CharT>
2539 isupper(_CharT __c, const locale& __loc)
2540 { return use_facet<ctype<_CharT> >(__loc).is(ctype_base::upper, __c); }
2542 /// Convenience interface to ctype.is(ctype_base::lower, __c).
2543 template<typename _CharT>
2545 islower(_CharT __c, const locale& __loc)
2546 { return use_facet<ctype<_CharT> >(__loc).is(ctype_base::lower, __c); }
2548 /// Convenience interface to ctype.is(ctype_base::alpha, __c).
2549 template<typename _CharT>
2551 isalpha(_CharT __c, const locale& __loc)
2552 { return use_facet<ctype<_CharT> >(__loc).is(ctype_base::alpha, __c); }
2554 /// Convenience interface to ctype.is(ctype_base::digit, __c).
2555 template<typename _CharT>
2557 isdigit(_CharT __c, const locale& __loc)
2558 { return use_facet<ctype<_CharT> >(__loc).is(ctype_base::digit, __c); }
2560 /// Convenience interface to ctype.is(ctype_base::punct, __c).
2561 template<typename _CharT>
2563 ispunct(_CharT __c, const locale& __loc)
2564 { return use_facet<ctype<_CharT> >(__loc).is(ctype_base::punct, __c); }
2566 /// Convenience interface to ctype.is(ctype_base::xdigit, __c).
2567 template<typename _CharT>
2569 isxdigit(_CharT __c, const locale& __loc)
2570 { return use_facet<ctype<_CharT> >(__loc).is(ctype_base::xdigit, __c); }
2572 /// Convenience interface to ctype.is(ctype_base::alnum, __c).
2573 template<typename _CharT>
2575 isalnum(_CharT __c, const locale& __loc)
2576 { return use_facet<ctype<_CharT> >(__loc).is(ctype_base::alnum, __c); }
2578 /// Convenience interface to ctype.is(ctype_base::graph, __c).
2579 template<typename _CharT>
2581 isgraph(_CharT __c, const locale& __loc)
2582 { return use_facet<ctype<_CharT> >(__loc).is(ctype_base::graph, __c); }
2584 /// Convenience interface to ctype.toupper(__c).
2585 template<typename _CharT>
2587 toupper(_CharT __c, const locale& __loc)
2588 { return use_facet<ctype<_CharT> >(__loc).toupper(__c); }
2590 /// Convenience interface to ctype.tolower(__c).
2591 template<typename _CharT>
2593 tolower(_CharT __c, const locale& __loc)
2594 { return use_facet<ctype<_CharT> >(__loc).tolower(__c); }
2596 _GLIBCXX_END_NAMESPACE
2598 #ifndef _GLIBCXX_EXPORT_TEMPLATE
2599 # include <bits/locale_facets.tcc>