1 // Iostreams base classes -*- C++ -*-
3 // Copyright (C) 1997, 1998, 1999, 2000, 2001 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 2, 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 // You should have received a copy of the GNU General Public License along
17 // with this library; see the file COPYING. If not, write to the Free
18 // Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
21 // As a special exception, you may use this file as part of a free software
22 // library without restriction. Specifically, if other files instantiate
23 // templates or use macros or inline functions from this file, or you compile
24 // this file and link it with other files to produce an executable, this
25 // file does not by itself cause the resulting executable to be covered by
26 // the GNU General Public License. This exception does not however
27 // invalidate any other reasons why the executable file might be covered by
28 // the GNU General Public License.
31 // ISO C++ 14882: 27.8 File-based streams
34 #ifndef _CPP_BITS_IOSBASE_H
35 #define _CPP_BITS_IOSBASE_H 1
39 // The following definitions of bitmask types are enums, not ints,
40 // as permitted (but not required) in the standard, in order to provide
41 // better type safety in iostream calls. A side effect is that
42 // expressions involving them are no longer compile-time constants.
43 enum _Ios_Fmtflags
{ _M_ios_fmtflags_end
= 1 << 16 };
46 operator&(_Ios_Fmtflags __a
, _Ios_Fmtflags __b
)
47 { return _Ios_Fmtflags(static_cast<int>(__a
) & static_cast<int>(__b
)); }
50 operator|(_Ios_Fmtflags __a
, _Ios_Fmtflags __b
)
51 { return _Ios_Fmtflags(static_cast<int>(__a
) | static_cast<int>(__b
)); }
54 operator^(_Ios_Fmtflags __a
, _Ios_Fmtflags __b
)
55 { return _Ios_Fmtflags(static_cast<int>(__a
) ^ static_cast<int>(__b
)); }
58 operator|=(_Ios_Fmtflags
& __a
, _Ios_Fmtflags __b
)
59 { return __a
= __a
| __b
; }
62 operator&=(_Ios_Fmtflags
& __a
, _Ios_Fmtflags __b
)
63 { return __a
= __a
& __b
; }
66 operator^=(_Ios_Fmtflags
& __a
, _Ios_Fmtflags __b
)
67 { return __a
= __a
^ __b
; }
70 operator~(_Ios_Fmtflags __a
)
71 { return _Ios_Fmtflags(~static_cast<int>(__a
)); }
74 enum _Ios_Openmode
{ _M_ios_openmode_end
= 1 << 16 };
77 operator&(_Ios_Openmode __a
, _Ios_Openmode __b
)
78 { return _Ios_Openmode(static_cast<int>(__a
) & static_cast<int>(__b
)); }
81 operator|(_Ios_Openmode __a
, _Ios_Openmode __b
)
82 { return _Ios_Openmode(static_cast<int>(__a
) | static_cast<int>(__b
)); }
85 operator^(_Ios_Openmode __a
, _Ios_Openmode __b
)
86 { return _Ios_Openmode(static_cast<int>(__a
) ^ static_cast<int>(__b
)); }
89 operator|=(_Ios_Openmode
& __a
, _Ios_Openmode __b
)
90 { return __a
= __a
| __b
; }
93 operator&=(_Ios_Openmode
& __a
, _Ios_Openmode __b
)
94 { return __a
= __a
& __b
; }
97 operator^=(_Ios_Openmode
& __a
, _Ios_Openmode __b
)
98 { return __a
= __a
^ __b
; }
101 operator~(_Ios_Openmode __a
)
102 { return _Ios_Openmode(~static_cast<int>(__a
)); }
105 enum _Ios_Iostate
{ _M_ios_iostate_end
= 1 << 16 };
108 operator&(_Ios_Iostate __a
, _Ios_Iostate __b
)
109 { return _Ios_Iostate(static_cast<int>(__a
) & static_cast<int>(__b
)); }
112 operator|(_Ios_Iostate __a
, _Ios_Iostate __b
)
113 { return _Ios_Iostate(static_cast<int>(__a
) | static_cast<int>(__b
)); }
116 operator^(_Ios_Iostate __a
, _Ios_Iostate __b
)
117 { return _Ios_Iostate(static_cast<int>(__a
) ^ static_cast<int>(__b
)); }
120 operator|=(_Ios_Iostate
& __a
, _Ios_Iostate __b
)
121 { return __a
= __a
| __b
; }
124 operator&=(_Ios_Iostate
& __a
, _Ios_Iostate __b
)
125 { return __a
= __a
& __b
; }
128 operator^=(_Ios_Iostate
& __a
, _Ios_Iostate __b
)
129 { return __a
= __a
^ __b
; }
132 operator~(_Ios_Iostate __a
)
133 { return _Ios_Iostate(~static_cast<int>(__a
)); }
135 enum _Ios_Seekdir
{ _M_ios_seekdir_end
= 1 << 16 };
137 // 27.4.2 Class ios_base
142 // 27.4.2.1.1 Class ios_base::failure
143 class failure
: public exception
146 #ifdef _GLIBCPP_RESOLVE_LIB_DEFECTS
147 // Can't do exception(_msg) as defined in 27.4.2.1.1
149 failure(const string
& __str
);
155 what() const throw();
158 enum { _M_bufsize
= 256 };
159 char _M_name
[_M_bufsize
];
163 // 27.4.2.1.2 Type ios_base::fmtflags
164 typedef _Ios_Fmtflags fmtflags
;
165 // 27.4.2.1.2 Type fmtflags
166 static const fmtflags boolalpha
= fmtflags(__ios_flags::_S_boolalpha
);
167 static const fmtflags dec
= fmtflags(__ios_flags::_S_dec
);
168 static const fmtflags fixed
= fmtflags(__ios_flags::_S_fixed
);
169 static const fmtflags hex
= fmtflags(__ios_flags::_S_hex
);
170 static const fmtflags internal
= fmtflags(__ios_flags::_S_internal
);
171 static const fmtflags left
= fmtflags(__ios_flags::_S_left
);
172 static const fmtflags oct
= fmtflags(__ios_flags::_S_oct
);
173 static const fmtflags right
= fmtflags(__ios_flags::_S_right
);
174 static const fmtflags scientific
= fmtflags(__ios_flags::_S_scientific
);
175 static const fmtflags showbase
= fmtflags(__ios_flags::_S_showbase
);
176 static const fmtflags showpoint
= fmtflags(__ios_flags::_S_showpoint
);
177 static const fmtflags showpos
= fmtflags(__ios_flags::_S_showpos
);
178 static const fmtflags skipws
= fmtflags(__ios_flags::_S_skipws
);
179 static const fmtflags unitbuf
= fmtflags(__ios_flags::_S_unitbuf
);
180 static const fmtflags uppercase
= fmtflags(__ios_flags::_S_uppercase
);
181 static const fmtflags adjustfield
= fmtflags(__ios_flags::_S_adjustfield
);
182 static const fmtflags basefield
= fmtflags(__ios_flags::_S_basefield
);
183 static const fmtflags floatfield
= fmtflags(__ios_flags::_S_floatfield
);
185 // 27.4.2.1.3 Type ios_base::iostate
186 typedef _Ios_Iostate iostate
;
187 static const iostate badbit
= iostate(__ios_flags::_S_badbit
);
188 static const iostate eofbit
= iostate(__ios_flags::_S_eofbit
);
189 static const iostate failbit
= iostate(__ios_flags::_S_failbit
);
190 static const iostate goodbit
= iostate(0);
192 // 27.4.2.1.4 Type openmode
193 typedef _Ios_Openmode openmode
;
194 static const openmode app
= openmode(__ios_flags::_S_app
);
195 static const openmode ate
= openmode(__ios_flags::_S_ate
);
196 static const openmode binary
= openmode(__ios_flags::_S_bin
);
197 static const openmode in
= openmode(__ios_flags::_S_in
);
198 static const openmode out
= openmode(__ios_flags::_S_out
);
199 static const openmode trunc
= openmode(__ios_flags::_S_trunc
);
201 // 27.4.2.1.5 Type seekdir
202 typedef _Ios_Seekdir seekdir
;
203 static const seekdir beg
= seekdir(0);
204 static const seekdir cur
= seekdir(SEEK_CUR
);
205 static const seekdir end
= seekdir(SEEK_END
);
207 #ifdef _GLIBCPP_DEPRECATED
208 typedef int io_state
;
209 typedef int open_mode
;
210 typedef int seek_dir
;
221 typedef void (*event_callback
) (event
, ios_base
&, int);
224 register_callback(event_callback __fn
, int __index
);
228 streamsize _M_precision
;
232 // 27.4.2.6 Members for callbacks
233 // 27.4.2.6 ios_base callbacks
234 struct _Callback_list
237 _Callback_list
* _M_next
;
238 ios_base::event_callback _M_fn
;
240 int _M_refcount
; // 0 means one reference.
242 _Callback_list(ios_base::event_callback __fn
, int __index
,
243 _Callback_list
* __cb
)
244 : _M_next(__cb
), _M_fn(__fn
), _M_index(__index
), _M_refcount(0) { }
247 _M_add_reference() { ++_M_refcount
; } // XXX MT
250 _M_remove_reference() { return _M_refcount
--; } // 0 => OK to delete
253 _Callback_list
* _M_callbacks
;
256 _M_call_callbacks(event __ev
) throw();
259 _M_dispose_callbacks(void);
261 // 27.4.2.5 Members for iword/pword storage
268 static const int _S_local_words
= 8;
269 _Words _M_word_array
[_S_local_words
]; // Guaranteed storage
270 _Words _M_dummy
; // Only for failed iword/pword calls.
275 _M_grow_words(int __index
);
277 // Members for locale and locale caching.
278 locale _M_ios_locale
;
285 // 27.4.2.1.6 Class ios_base::Init
286 // Used to initialize standard streams. In theory, g++ could use
287 // -finit-priority to order this stuff correctly without going
288 // through these machinations.
291 friend class ios_base
;
296 static int _S_ios_base_init
;
297 bool _M_synced_with_stdio
;
301 #ifdef _GLIBCPP_USE_WCHAR_T
310 flags() const { return _M_flags
; }
313 flags(fmtflags __fmtfl
)
315 fmtflags __old
= _M_flags
;
321 setf(fmtflags __fmtfl
)
323 fmtflags __old
= _M_flags
;
329 setf(fmtflags __fmtfl
, fmtflags __mask
)
331 fmtflags __old
= _M_flags
;
333 _M_flags
|= (__fmtfl
& __mask
);
338 unsetf(fmtflags __mask
) { _M_flags
&= ~__mask
; }
341 precision() const { return _M_precision
; }
344 precision(streamsize __prec
)
346 streamsize __old
= _M_precision
;
347 _M_precision
= __prec
;
352 width() const { return _M_width
; }
355 width(streamsize __wide
)
357 streamsize __old
= _M_width
;
363 sync_with_stdio(bool __sync
= true);
367 imbue(const locale
& __loc
);
370 getloc() const { return _M_ios_locale
; }
379 _Words
& __word
= (__ix
< _M_word_limit
)
380 ? _M_words
[__ix
] : _M_grow_words(__ix
);
381 return __word
._M_iword
;
387 _Words
& __word
= (__ix
< _M_word_limit
)
388 ? _M_words
[__ix
] : _M_grow_words(__ix
);
389 return __word
._M_pword
;
398 #ifdef _GLIBCPP_RESOLVE_LIB_DEFECTS
400 ios_base(const ios_base
&);
403 operator=(const ios_base
&);
407 // 27.4.5.1 fmtflags manipulators:
409 boolalpha(ios_base
& __base
)
411 __base
.setf(ios_base::boolalpha
);
416 noboolalpha(ios_base
& __base
)
418 __base
.unsetf(ios_base::boolalpha
);
423 showbase(ios_base
& __base
)
425 __base
.setf(ios_base::showbase
);
430 noshowbase(ios_base
& __base
)
432 __base
.unsetf(ios_base::showbase
);
437 showpoint(ios_base
& __base
)
439 __base
.setf(ios_base::showpoint
);
444 noshowpoint(ios_base
& __base
)
446 __base
.unsetf(ios_base::showpoint
);
451 showpos(ios_base
& __base
)
453 __base
.setf(ios_base::showpos
);
458 noshowpos(ios_base
& __base
)
460 __base
.unsetf(ios_base::showpos
);
465 skipws(ios_base
& __base
)
467 __base
.setf(ios_base::skipws
);
472 noskipws(ios_base
& __base
)
474 __base
.unsetf(ios_base::skipws
);
479 uppercase(ios_base
& __base
)
481 __base
.setf(ios_base::uppercase
);
486 nouppercase(ios_base
& __base
)
488 __base
.unsetf(ios_base::uppercase
);
493 unitbuf(ios_base
& __base
)
495 __base
.setf(ios_base::unitbuf
);
500 nounitbuf(ios_base
& __base
)
502 __base
.unsetf(ios_base::unitbuf
);
506 // 27.4.5.2 adjustfield anipulators:
508 internal(ios_base
& __base
)
510 __base
.setf(ios_base::internal
, ios_base::adjustfield
);
515 left(ios_base
& __base
)
517 __base
.setf(ios_base::left
, ios_base::adjustfield
);
522 right(ios_base
& __base
)
524 __base
.setf(ios_base::right
, ios_base::adjustfield
);
528 // 27.4.5.3 basefield anipulators:
530 dec(ios_base
& __base
)
532 __base
.setf(ios_base::dec
, ios_base::basefield
);
537 hex(ios_base
& __base
)
539 __base
.setf(ios_base::hex
, ios_base::basefield
);
544 oct(ios_base
& __base
)
546 __base
.setf(ios_base::oct
, ios_base::basefield
);
550 // 27.4.5.4 floatfield anipulators:
552 fixed(ios_base
& __base
)
554 __base
.setf(ios_base::fixed
, ios_base::floatfield
);
559 scientific(ios_base
& __base
)
561 __base
.setf(ios_base::scientific
, ios_base::floatfield
);
567 #endif /* _CPP_BITS_IOSBASE_H */