OSDN Git Service

be7f7e65e26a77809aeebcd802990dfffe951969
[pf3gnuchains/gcc-fork.git] / libstdc++-v3 / include / bits / localefwd.h
1 // Locale support -*- C++ -*-
2
3 // Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002
4 // Free Software Foundation, Inc.
5 //
6 // This file is part of the GNU ISO C++ Library.  This library is free
7 // software; you can redistribute it and/or modify it under the
8 // terms of the GNU General Public License as published by the
9 // Free Software Foundation; either version 2, or (at your option)
10 // any later version.
11
12 // This library is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 // GNU General Public License for more details.
16
17 // You should have received a copy of the GNU General Public License along
18 // with this library; see the file COPYING.  If not, write to the Free
19 // Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
20 // USA.
21
22 // As a special exception, you may use this file as part of a free software
23 // library without restriction.  Specifically, if other files instantiate
24 // templates or use macros or inline functions from this file, or you compile
25 // this file and link it with other files to produce an executable, this
26 // file does not by itself cause the resulting executable to be covered by
27 // the GNU General Public License.  This exception does not however
28 // invalidate any other reasons why the executable file might be covered by
29 // the GNU General Public License.
30
31 //
32 // ISO C++ 14882: 22.1  Locales
33 //
34
35 /** @file localefwd.h
36  *  This is an internal header file, included by other library headers.
37  *  You should not attempt to use it directly.
38  */
39
40 #ifndef _CPP_BITS_LOCCORE_H
41 #define _CPP_BITS_LOCCORE_H     1
42
43 #pragma GCC system_header
44
45 #include <bits/c++config.h>
46 #include <bits/c++locale.h>     // Defines __c_locale, config-specific includes
47 #include <climits>              // For CHAR_BIT
48 #include <cctype>               // For isspace, etc.
49 #include <string>               // For string
50 #include <bits/functexcept.h>
51
52 namespace std
53 {
54   // NB: Don't instantiate required wchar_t facets if no wchar_t support.
55 #ifdef _GLIBCPP_USE_WCHAR_T
56 # define  _GLIBCPP_NUM_FACETS 28
57 #else
58 # define  _GLIBCPP_NUM_FACETS 14
59 #endif
60
61   // 22.1.1 Locale
62   template<typename _Tp, typename _Alloc> 
63     class vector;
64   class locale;
65
66   // 22.1.3 Convenience interfaces
67   template<typename _CharT> 
68     inline bool 
69     isspace(_CharT, const locale&);
70
71   template<typename _CharT> 
72     inline bool 
73     isprint(_CharT, const locale&);
74
75   template<typename _CharT> 
76     inline bool 
77     iscntrl(_CharT, const locale&);
78
79   template<typename _CharT> 
80     inline bool 
81     isupper(_CharT, const locale&);
82
83   template<typename _CharT> 
84     inline bool 
85     islower(_CharT, const locale&);
86
87   template<typename _CharT> 
88     inline bool 
89     isalpha(_CharT, const locale&);
90
91   template<typename _CharT> 
92     inline bool 
93     isdigit(_CharT, const locale&);
94
95   template<typename _CharT> 
96     inline bool 
97     ispunct(_CharT, const locale&);
98
99   template<typename _CharT> 
100     inline bool 
101     isxdigit(_CharT, const locale&);
102
103   template<typename _CharT> 
104     inline bool 
105     isalnum(_CharT, const locale&);
106
107   template<typename _CharT> 
108     inline bool 
109     isgraph(_CharT, const locale&);
110
111   template<typename _CharT> 
112     inline _CharT 
113     toupper(_CharT, const locale&);
114
115   template<typename _CharT> 
116     inline _CharT 
117     tolower(_CharT, const locale&);
118
119
120   // 22.2.1 and 22.2.1.3 ctype
121   class ctype_base;
122   template<typename _CharT> 
123     class ctype;
124   template<> class ctype<char>;
125 #ifdef _GLIBCPP_USE_WCHAR_T
126   template<> class ctype<wchar_t>;
127 #endif
128   template<typename _CharT> 
129     class ctype_byname;
130   // NB: Specialized for char and wchar_t in locale_facets.h.
131
132   class codecvt_base;
133   class __enc_traits;
134   template<typename _InternT, typename _ExternT, typename _StateT>
135     class codecvt;
136   template<> class codecvt<char, char, mbstate_t>;
137 #ifdef _GLIBCPP_USE_WCHAR_T
138   template<> class codecvt<wchar_t, char, mbstate_t>;
139 #endif
140   template<typename _InternT, typename _ExternT, typename _StateT>
141     class codecvt_byname;
142
143   // 22.2.2 and 22.2.3 numeric
144   template<typename _CharT, typename _InIter = istreambuf_iterator<_CharT> >
145     class num_get;
146   template<typename _CharT, typename _OutIter = ostreambuf_iterator<_CharT> >
147     class num_put;
148   template<typename _CharT> class numpunct;
149   template<typename _CharT> class numpunct_byname;
150
151   // 22.2.4 collation
152   template<typename _CharT> 
153     class collate;
154   template<typename _CharT> class 
155     collate_byname;
156
157   // 22.2.5 date and time
158   class time_base;
159   template<typename _CharT, typename _InIter =  istreambuf_iterator<_CharT> >
160     class time_get;
161   template<typename _CharT, typename _InIter =  istreambuf_iterator<_CharT> >
162     class time_get_byname;
163   template<typename _CharT, typename _OutIter = ostreambuf_iterator<_CharT> >
164     class time_put;
165   template<typename _CharT, typename _OutIter = ostreambuf_iterator<_CharT> >
166     class time_put_byname;
167
168   // 22.2.6 money
169   class money_base;
170   template<typename _CharT, typename _InIter =  istreambuf_iterator<_CharT> >
171     class money_get;
172   template<typename _CharT, typename _OutIter = ostreambuf_iterator<_CharT> >
173     class money_put;
174   template<typename _CharT, bool _Intl = false> 
175     class moneypunct;
176   template<typename _CharT, bool _Intl = false> 
177     class moneypunct_byname;
178
179   // 22.2.7 message retrieval
180   class messages_base;
181   template<typename _CharT> 
182     class messages;
183   template<typename _CharT> 
184     class messages_byname;
185
186   // 22.1.1 Class locale
187   class locale
188   {
189   public:
190     // Types:
191     typedef unsigned int        category;
192
193     // Forward decls and friends:
194     class facet;
195     class id;
196     class _Impl;
197
198     friend class facet;
199     friend class _Impl;
200
201     template<typename _Facet>
202       friend const _Facet& 
203       use_facet(const locale&);
204     
205     template<typename _Facet>
206       friend bool 
207       has_facet(const locale&) throw();
208  
209     // Category values:
210     // NB: Order must match _S_facet_categories definition in locale.cc
211     static const category none          = 0;
212     static const category ctype         = 1L << 0;
213     static const category numeric       = 1L << 1;
214     static const category collate       = 1L << 2;
215     static const category time          = 1L << 3;
216     static const category monetary      = 1L << 4;
217     static const category messages      = 1L << 5;
218     static const category all           = (collate | ctype | monetary |
219                                            numeric | time  | messages);
220
221     // Construct/copy/destroy:
222     locale() throw();
223
224     locale(const locale& __other) throw();
225
226     explicit  
227     locale(const char* __std_name);
228
229     locale(const locale& __base, const char* __s, category __cat);
230
231     locale(const locale& __base, const locale& __add, category __cat);
232
233     template<typename _Facet>
234       locale(const locale& __other, _Facet* __f);
235
236     ~locale() throw();
237
238     const locale&  
239     operator=(const locale& __other) throw();
240
241     template<typename _Facet>
242       locale  
243       combine(const locale& __other) const;
244
245     // Locale operations:
246     string 
247     name() const;
248
249     bool 
250     operator==(const locale& __other) const throw ();
251
252     inline bool  
253     operator!=(const locale& __other) const throw ()
254     { return !(this->operator==(__other));  }
255
256     template<typename _Char, typename _Traits, typename _Alloc>
257       bool  
258       operator()(const basic_string<_Char, _Traits, _Alloc>& __s1,
259                  const basic_string<_Char, _Traits, _Alloc>& __s2) const;
260
261     // Global locale objects:
262     static locale 
263     global(const locale&);
264
265     static const locale& 
266     classic();
267
268   private:
269     // The (shared) implementation
270     _Impl*              _M_impl;  
271
272     // The "C" reference locale
273     static _Impl*       _S_classic; 
274
275     // Current global reference locale
276     static _Impl*       _S_global;  
277
278     static const size_t _S_num_categories = 6;
279     static const size_t _S_num_facets = _GLIBCPP_NUM_FACETS;
280
281     explicit 
282     locale(_Impl*) throw();
283
284     static inline void  
285     _S_initialize()
286     { 
287       if (!_S_classic) 
288         classic();  
289     }
290
291     static category  
292     _S_normalize_category(category);
293
294     void
295     _M_coalesce(const locale& __base, const locale& __add, category __cat);
296   };
297
298
299   // Implementation object for locale 
300   class locale::_Impl
301   {
302   public:
303     // Types.
304     typedef vector<facet*, allocator<facet*> >  __vec_facet;
305
306     // Friends.
307     friend class locale;
308     friend class locale::facet;
309
310     template<typename _Facet>
311       friend const _Facet&  
312       use_facet(const locale&);
313
314     template<typename _Facet>
315       friend bool  
316       has_facet(const locale&) throw();
317
318   private:
319     // Data Members.
320     size_t                              _M_references;
321     __vec_facet*                        _M_facets;
322     string                              _M_names[_S_num_categories];
323     static const locale::id* const      _S_id_ctype[];
324     static const locale::id* const      _S_id_numeric[];
325     static const locale::id* const      _S_id_collate[];
326     static const locale::id* const      _S_id_time[];
327     static const locale::id* const      _S_id_monetary[];
328     static const locale::id* const      _S_id_messages[];
329     static const locale::id* const* const _S_facet_categories[];
330
331     inline void 
332     _M_add_reference() throw()
333     { ++_M_references; }  // XXX MT
334
335     inline void 
336     _M_remove_reference() throw()
337     {
338       if (--_M_references == 0)  // XXX MT
339         {
340           try 
341             { delete this; } 
342           catch(...) 
343             { }
344         }
345     }
346
347     _Impl(const _Impl&, size_t);
348     _Impl(string __name, size_t);
349    ~_Impl() throw();
350
351     inline bool
352     _M_check_same_name()
353     {
354       bool __ret = true;
355       for (size_t i = 0; i < _S_num_categories - 1; ++i)
356         __ret &= _M_names[i] == _M_names[i + 1];
357       return __ret;
358     }
359
360     void 
361     _M_replace_categories(const _Impl*, category);
362
363     void 
364     _M_replace_category(const _Impl*, const locale::id* const*);
365
366     void 
367     _M_replace_facet(const _Impl*, const locale::id*);
368
369     void 
370     _M_install_facet(const locale::id*, facet*);
371
372     template<typename _Facet>
373       inline void 
374       _M_init_facet(_Facet* __facet)
375       { _M_install_facet(&_Facet::id, __facet);  }
376   };
377
378   template<typename _Facet>
379     locale::locale(const locale& __other, _Facet* __f)
380     {
381       _M_impl = new _Impl(*__other._M_impl, 1);
382       _M_impl->_M_install_facet(&_Facet::id, __f);
383       for (size_t __i = 0; __i < _S_num_categories; ++__i)
384         _M_impl->_M_names[__i] = "*";
385     }
386
387   // 22.1.1.1.2  Class locale::facet
388   class locale::facet
389   {
390     friend class locale;
391     friend class locale::_Impl;
392     friend class __enc_traits;
393
394   private:
395     size_t _M_references;
396
397   protected:
398     // Contains data from the underlying "C" library for default "C"
399     // or "POSIX" locale.
400     static __c_locale                _S_c_locale;
401     
402     explicit 
403     facet(size_t __refs = 0) throw();
404
405     virtual 
406     ~facet();
407
408     static void
409     _S_create_c_locale(__c_locale& __cloc, const char* __s);
410
411     static __c_locale
412     _S_clone_c_locale(__c_locale& __cloc);
413
414     static void
415     _S_destroy_c_locale(__c_locale& __cloc);
416
417   private:
418     void 
419     _M_add_reference() throw();
420
421     void 
422     _M_remove_reference() throw();
423
424     facet(const facet&);  // Not defined.
425
426     void 
427     operator=(const facet&);  // Not defined.
428   };
429
430
431   // 22.1.1.1.3 Class locale::id
432   class locale::id
433   {
434   private:
435     friend class locale;
436     friend class locale::_Impl;
437     template<typename _Facet>
438       friend const _Facet&  
439       use_facet(const locale&);
440     template<typename _Facet>
441       friend bool           
442       has_facet(const locale&) throw ();
443
444     // NB: There is no accessor for _M_index because it may be used
445     // before the constructor is run; the effect of calling a member
446     // function (even an inline) would be undefined.
447     mutable size_t      _M_index;
448
449     // Last id number assigned
450     static size_t       _S_highwater;   
451
452     void 
453     operator=(const id&);  // not defined
454
455     id(const id&);  // not defined
456
457   public:
458     // NB: This class is always a static data member, and thus can be
459     // counted on to be zero-initialized.
460     id();
461   };
462
463   template<typename _Facet>
464     const _Facet&
465     use_facet(const locale& __loc);
466
467   template<typename _Facet>
468     bool
469     has_facet(const locale& __loc) throw();
470 } // namespace std
471
472 #endif