PR libstdc++/7219 (continued)
[gcc.git] / libstdc++-v3 / include / bits / ios_base.h
1 // Iostreams base classes -*- C++ -*-
2
3 // Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
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: 27.4 Iostreams base classes
33 //
34
35 /** @file ios_base.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 _IOS_BASE_H
41 #define _IOS_BASE_H 1
42
43 #pragma GCC system_header
44
45 #include <bits/atomicity.h>
46 #include <bits/localefwd.h>
47 #include <bits/locale_classes.h>
48
49 namespace std
50 {
51 // The following definitions of bitmask types are enums, not ints,
52 // as permitted (but not required) in the standard, in order to provide
53 // better type safety in iostream calls. A side effect is that
54 // expressions involving them are no longer compile-time constants.
55 enum _Ios_Fmtflags { _S_ios_fmtflags_end = 1L << 16 };
56
57 inline _Ios_Fmtflags
58 operator&(_Ios_Fmtflags __a, _Ios_Fmtflags __b)
59 { return _Ios_Fmtflags(static_cast<int>(__a) & static_cast<int>(__b)); }
60
61 inline _Ios_Fmtflags
62 operator|(_Ios_Fmtflags __a, _Ios_Fmtflags __b)
63 { return _Ios_Fmtflags(static_cast<int>(__a) | static_cast<int>(__b)); }
64
65 inline _Ios_Fmtflags
66 operator^(_Ios_Fmtflags __a, _Ios_Fmtflags __b)
67 { return _Ios_Fmtflags(static_cast<int>(__a) ^ static_cast<int>(__b)); }
68
69 inline _Ios_Fmtflags
70 operator|=(_Ios_Fmtflags& __a, _Ios_Fmtflags __b)
71 { return __a = __a | __b; }
72
73 inline _Ios_Fmtflags
74 operator&=(_Ios_Fmtflags& __a, _Ios_Fmtflags __b)
75 { return __a = __a & __b; }
76
77 inline _Ios_Fmtflags
78 operator^=(_Ios_Fmtflags& __a, _Ios_Fmtflags __b)
79 { return __a = __a ^ __b; }
80
81 inline _Ios_Fmtflags
82 operator~(_Ios_Fmtflags __a)
83 { return _Ios_Fmtflags(~static_cast<int>(__a)); }
84
85
86 enum _Ios_Openmode { _S_ios_openmode_end = 1L << 16 };
87
88 inline _Ios_Openmode
89 operator&(_Ios_Openmode __a, _Ios_Openmode __b)
90 { return _Ios_Openmode(static_cast<int>(__a) & static_cast<int>(__b)); }
91
92 inline _Ios_Openmode
93 operator|(_Ios_Openmode __a, _Ios_Openmode __b)
94 { return _Ios_Openmode(static_cast<int>(__a) | static_cast<int>(__b)); }
95
96 inline _Ios_Openmode
97 operator^(_Ios_Openmode __a, _Ios_Openmode __b)
98 { return _Ios_Openmode(static_cast<int>(__a) ^ static_cast<int>(__b)); }
99
100 inline _Ios_Openmode
101 operator|=(_Ios_Openmode& __a, _Ios_Openmode __b)
102 { return __a = __a | __b; }
103
104 inline _Ios_Openmode
105 operator&=(_Ios_Openmode& __a, _Ios_Openmode __b)
106 { return __a = __a & __b; }
107
108 inline _Ios_Openmode
109 operator^=(_Ios_Openmode& __a, _Ios_Openmode __b)
110 { return __a = __a ^ __b; }
111
112 inline _Ios_Openmode
113 operator~(_Ios_Openmode __a)
114 { return _Ios_Openmode(~static_cast<int>(__a)); }
115
116
117 enum _Ios_Iostate { _S_ios_iostate_end = 1L << 16 };
118
119 inline _Ios_Iostate
120 operator&(_Ios_Iostate __a, _Ios_Iostate __b)
121 { return _Ios_Iostate(static_cast<int>(__a) & static_cast<int>(__b)); }
122
123 inline _Ios_Iostate
124 operator|(_Ios_Iostate __a, _Ios_Iostate __b)
125 { return _Ios_Iostate(static_cast<int>(__a) | static_cast<int>(__b)); }
126
127 inline _Ios_Iostate
128 operator^(_Ios_Iostate __a, _Ios_Iostate __b)
129 { return _Ios_Iostate(static_cast<int>(__a) ^ static_cast<int>(__b)); }
130
131 inline _Ios_Iostate
132 operator|=(_Ios_Iostate& __a, _Ios_Iostate __b)
133 { return __a = __a | __b; }
134
135 inline _Ios_Iostate
136 operator&=(_Ios_Iostate& __a, _Ios_Iostate __b)
137 { return __a = __a & __b; }
138
139 inline _Ios_Iostate
140 operator^=(_Ios_Iostate& __a, _Ios_Iostate __b)
141 { return __a = __a ^ __b; }
142
143 inline _Ios_Iostate
144 operator~(_Ios_Iostate __a)
145 { return _Ios_Iostate(~static_cast<int>(__a)); }
146
147 enum _Ios_Seekdir { _S_ios_seekdir_end = 1L << 16 };
148
149 // 27.4.2 Class ios_base
150 /**
151 * @brief The very top of the I/O class hierarchy.
152 *
153 * This class defines everything that can be defined about I/O that does
154 * not depend on the type of characters being input or output. Most
155 * people will only see @c ios_base when they need to specify the full
156 * name of the various I/O flags (e.g., the openmodes).
157 */
158 class ios_base
159 {
160 public:
161
162 // 27.4.2.1.1 Class ios_base::failure
163 /// These are thrown to indicate problems. Doc me.
164 class failure : public exception
165 {
166 public:
167 // _GLIBCXX_RESOLVE_LIB_DEFECTS
168 // 48. Use of non-existent exception constructor
169 explicit
170 failure(const string& __str) throw();
171
172 // This declaration is not useless:
173 // http://gcc.gnu.org/onlinedocs/gcc-3.0.2/gcc_6.html#SEC118
174 virtual
175 ~failure() throw();
176
177 virtual const char*
178 what() const throw();
179
180 private:
181 string _M_msg;
182 };
183
184 // 27.4.2.1.2 Type ios_base::fmtflags
185 /**
186 * @brief This is a bitmask type.
187 *
188 * @c "_Ios_Fmtflags" is implementation-defined, but it is valid to
189 * perform bitwise operations on these values and expect the Right
190 * Thing to happen. Defined objects of type fmtflags are:
191 * - boolalpha
192 * - dec
193 * - fixed
194 * - hex
195 * - internal
196 * - left
197 * - oct
198 * - right
199 * - scientific
200 * - showbase
201 * - showpoint
202 * - showpos
203 * - skipws
204 * - unitbuf
205 * - uppercase
206 * - adjustfield
207 * - basefield
208 * - floatfield
209 */
210 typedef _Ios_Fmtflags fmtflags;
211
212 /// Insert/extract @c bool in alphabetic rather than numeric format.
213 static const fmtflags boolalpha = fmtflags(__ios_flags::_S_boolalpha);
214
215 /// Converts integer input or generates integer output in decimal base.
216 static const fmtflags dec = fmtflags(__ios_flags::_S_dec);
217
218 /// Generate floating-point output in fixed-point notation.
219 static const fmtflags fixed = fmtflags(__ios_flags::_S_fixed);
220
221 /// Converts integer input or generates integer output in hexadecimal base.
222 static const fmtflags hex = fmtflags(__ios_flags::_S_hex);
223
224 /// Adds fill characters at a designated internal point in certain
225 /// generated output, or identical to @c right if no such point is
226 /// designated.
227 static const fmtflags internal = fmtflags(__ios_flags::_S_internal);
228
229 /// Adds fill characters on the right (final positions) of certain
230 /// generated output. (I.e., the thing you print is flush left.)
231 static const fmtflags left = fmtflags(__ios_flags::_S_left);
232
233 /// Converts integer input or generates integer output in octal base.
234 static const fmtflags oct = fmtflags(__ios_flags::_S_oct);
235
236 /// Adds fill characters on the left (initial positions) of certain
237 /// generated output. (I.e., the thing you print is flush right.)
238 static const fmtflags right = fmtflags(__ios_flags::_S_right);
239
240 /// Generates floating-point output in scientific notation.
241 static const fmtflags scientific = fmtflags(__ios_flags::_S_scientific);
242
243 /// Generates a prefix indicating the numeric base of generated integer
244 /// output.
245 static const fmtflags showbase = fmtflags(__ios_flags::_S_showbase);
246
247 /// Generates a decimal-point character unconditionally in generated
248 /// floating-point output.
249 static const fmtflags showpoint = fmtflags(__ios_flags::_S_showpoint);
250
251 /// Generates a + sign in non-negative generated numeric output.
252 static const fmtflags showpos = fmtflags(__ios_flags::_S_showpos);
253
254 /// Skips leading white space before certain input operations.
255 static const fmtflags skipws = fmtflags(__ios_flags::_S_skipws);
256
257 /// Flushes output after each output operation.
258 static const fmtflags unitbuf = fmtflags(__ios_flags::_S_unitbuf);
259
260 /// Replaces certain lowercase letters with their uppercase equivalents
261 /// in generated output.
262 static const fmtflags uppercase = fmtflags(__ios_flags::_S_uppercase);
263
264 /// A mask of left|right|internal. Useful for the 2-arg form of @c setf.
265 static const fmtflags adjustfield = fmtflags(__ios_flags::_S_adjustfield);
266
267 /// A mask of dec|oct|hex. Useful for the 2-arg form of @c setf.
268 static const fmtflags basefield = fmtflags(__ios_flags::_S_basefield);
269
270 /// A mask of scientific|fixed. Useful for the 2-arg form of @c setf.
271 static const fmtflags floatfield = fmtflags(__ios_flags::_S_floatfield);
272
273 // 27.4.2.1.3 Type ios_base::iostate
274 /**
275 * @brief This is a bitmask type.
276 *
277 * @c "_Ios_Iostate" is implementation-defined, but it is valid to
278 * perform bitwise operations on these values and expect the Right
279 * Thing to happen. Defined objects of type iostate are:
280 * - badbit
281 * - eofbit
282 * - failbit
283 * - goodbit
284 */
285 typedef _Ios_Iostate iostate;
286
287 /// Indicates a loss of integrity in an input or output sequence (such
288 /// as an irrecoverable read error from a file).
289 static const iostate badbit = iostate(__ios_flags::_S_badbit);
290
291 /// Indicates that an input operation reached the end of an input sequence.
292 static const iostate eofbit = iostate(__ios_flags::_S_eofbit);
293
294 /// Indicates that an input operation failed to read the expected
295 /// characters, or that an output operation failed to generate the
296 /// desired characters.
297 static const iostate failbit = iostate(__ios_flags::_S_failbit);
298
299 /// Indicates all is well.
300 static const iostate goodbit = iostate(0);
301
302 // 27.4.2.1.4 Type ios_base::openmode
303 /**
304 * @brief This is a bitmask type.
305 *
306 * @c "_Ios_Openmode" is implementation-defined, but it is valid to
307 * perform bitwise operations on these values and expect the Right
308 * Thing to happen. Defined objects of type openmode are:
309 * - app
310 * - ate
311 * - binary
312 * - in
313 * - out
314 * - trunc
315 */
316 typedef _Ios_Openmode openmode;
317
318 /// Seek to end before each write.
319 static const openmode app = openmode(__ios_flags::_S_app);
320
321 /// Open and seek to end immediately after opening.
322 static const openmode ate = openmode(__ios_flags::_S_ate);
323
324 /// Perform input and output in binary mode (as opposed to text mode).
325 /// This is probably not what you think it is; see
326 /// http://gcc.gnu.org/onlinedocs/libstdc++/27_io/howto.html#3 and
327 /// http://gcc.gnu.org/onlinedocs/libstdc++/27_io/howto.html#7 for more.
328 static const openmode binary = openmode(__ios_flags::_S_bin);
329
330 /// Open for input. Default for @c ifstream and fstream.
331 static const openmode in = openmode(__ios_flags::_S_in);
332
333 /// Open for output. Default for @c ofstream and fstream.
334 static const openmode out = openmode(__ios_flags::_S_out);
335
336 /// Open for input. Default for @c ofstream.
337 static const openmode trunc = openmode(__ios_flags::_S_trunc);
338
339 // 27.4.2.1.5 Type ios_base::seekdir
340 /**
341 * @brief This is an enumerated type.
342 *
343 * @c "_Ios_Seekdir" is implementation-defined. Defined values
344 * of type seekdir are:
345 * - beg
346 * - cur, equivalent to @c SEEK_CUR in the C standard library.
347 * - end, equivalent to @c SEEK_END in the C standard library.
348 */
349 typedef _Ios_Seekdir seekdir;
350
351 /// Request a seek relative to the beginning of the stream.
352 static const seekdir beg = seekdir(0);
353
354 /// Request a seek relative to the current position within the sequence.
355 static const seekdir cur = seekdir(SEEK_CUR);
356
357 /// Request a seek relative to the current end of the sequence.
358 static const seekdir end = seekdir(SEEK_END);
359
360 // Annex D.6
361 typedef int io_state;
362 typedef int open_mode;
363 typedef int seek_dir;
364
365 typedef std::streampos streampos;
366 typedef std::streamoff streamoff;
367
368 // Callbacks;
369 /**
370 * @brief The set of events that may be passed to an event callback.
371 *
372 * erase_event is used during ~ios() and copyfmt(). imbue_event is used
373 * during imbue(). copyfmt_event is used during copyfmt().
374 */
375 enum event
376 {
377 erase_event,
378 imbue_event,
379 copyfmt_event
380 };
381
382 /**
383 * @brief The type of an event callback function.
384 * @param event One of the members of the event enum.
385 * @param ios_base Reference to the ios_base object.
386 * @param int The integer provided when the callback was registered.
387 *
388 * Event callbacks are user defined functions that get called during
389 * several ios_base and basic_ios functions, specifically imbue(),
390 * copyfmt(), and ~ios().
391 */
392 typedef void (*event_callback) (event, ios_base&, int);
393
394 /**
395 * @brief Add the callback __fn with parameter __index.
396 * @param __fn The function to add.
397 * @param __index The integer to pass to the function when invoked.
398 *
399 * Registers a function as an event callback with an integer parameter to
400 * be passed to the function when invoked. Multiple copies of the
401 * function are allowed. If there are multiple callbacks, they are
402 * invoked in the order they were registered.
403 */
404 void
405 register_callback(event_callback __fn, int __index);
406
407 protected:
408 //@{
409 /**
410 * @if maint
411 * ios_base data members (doc me)
412 * @endif
413 */
414 streamsize _M_precision;
415 streamsize _M_width;
416 fmtflags _M_flags;
417 iostate _M_exception;
418 iostate _M_streambuf_state;
419 //@}
420
421 // 27.4.2.6 Members for callbacks
422 // 27.4.2.6 ios_base callbacks
423 struct _Callback_list
424 {
425 // Data Members
426 _Callback_list* _M_next;
427 ios_base::event_callback _M_fn;
428 int _M_index;
429 _Atomic_word _M_refcount; // 0 means one reference.
430
431 _Callback_list(ios_base::event_callback __fn, int __index,
432 _Callback_list* __cb)
433 : _M_next(__cb), _M_fn(__fn), _M_index(__index), _M_refcount(0) { }
434
435 void
436 _M_add_reference() { __gnu_cxx::__atomic_add(&_M_refcount, 1); }
437
438 // 0 => OK to delete.
439 int
440 _M_remove_reference()
441 { return __gnu_cxx::__exchange_and_add(&_M_refcount, -1); }
442 };
443
444 _Callback_list* _M_callbacks;
445
446 void
447 _M_call_callbacks(event __ev) throw();
448
449 void
450 _M_dispose_callbacks(void);
451
452 // 27.4.2.5 Members for iword/pword storage
453 struct _Words
454 {
455 void* _M_pword;
456 long _M_iword;
457 _Words() : _M_pword(0), _M_iword(0) { }
458 };
459
460 // Only for failed iword/pword calls.
461 _Words _M_word_zero;
462
463 // Guaranteed storage.
464 // The first 5 iword and pword slots are reserved for internal use.
465 static const int _S_local_word_size = 8;
466 _Words _M_local_word[_S_local_word_size];
467
468 // Allocated storage.
469 int _M_word_size;
470 _Words* _M_word;
471
472 _Words&
473 _M_grow_words(int __index, bool __iword);
474
475 // Members for locale and locale caching.
476 locale _M_ios_locale;
477
478 void
479 _M_init();
480
481 public:
482
483 // 27.4.2.1.6 Class ios_base::Init
484 // Used to initialize standard streams. In theory, g++ could use
485 // -finit-priority to order this stuff correctly without going
486 // through these machinations.
487 class Init
488 {
489 friend class ios_base;
490 public:
491 Init();
492 ~Init();
493
494 private:
495 static _Atomic_word _S_refcount;
496 static bool _S_synced_with_stdio;
497 };
498
499 // [27.4.2.2] fmtflags state functions
500 /**
501 * @brief Access to format flags.
502 * @return The format control flags for both input and output.
503 */
504 inline fmtflags
505 flags() const { return _M_flags; }
506
507 /**
508 * @brief Setting new format flags all at once.
509 * @param fmtfl The new flags to set.
510 * @return The previous format control flags.
511 *
512 * This function overwrites all the format flags with @a fmtfl.
513 */
514 inline fmtflags
515 flags(fmtflags __fmtfl)
516 {
517 fmtflags __old = _M_flags;
518 _M_flags = __fmtfl;
519 return __old;
520 }
521
522 /**
523 * @brief Setting new format flags.
524 * @param fmtfl Additional flags to set.
525 * @return The previous format control flags.
526 *
527 * This function sets additional flags in format control. Flags that
528 * were previously set remain set.
529 */
530 inline fmtflags
531 setf(fmtflags __fmtfl)
532 {
533 fmtflags __old = _M_flags;
534 _M_flags |= __fmtfl;
535 return __old;
536 }
537
538 /**
539 * @brief Setting new format flags.
540 * @param fmtfl Additional flags to set.
541 * @param mask The flags mask for @a fmtfl.
542 * @return The previous format control flags.
543 *
544 * This function clears @a mask in the format flags, then sets
545 * @a fmtfl @c & @a mask. An example mask is @c ios_base::adjustfield.
546 */
547 inline fmtflags
548 setf(fmtflags __fmtfl, fmtflags __mask)
549 {
550 fmtflags __old = _M_flags;
551 _M_flags &= ~__mask;
552 _M_flags |= (__fmtfl & __mask);
553 return __old;
554 }
555
556 /**
557 * @brief Clearing format flags.
558 * @param mask The flags to unset.
559 *
560 * This function clears @a mask in the format flags.
561 */
562 inline void
563 unsetf(fmtflags __mask) { _M_flags &= ~__mask; }
564
565 /**
566 * @brief Flags access.
567 * @return The precision to generate on certain output operations.
568 *
569 * @if maint
570 * Be careful if you try to give a definition of "precision" here; see
571 * DR 189.
572 * @endif
573 */
574 inline streamsize
575 precision() const { return _M_precision; }
576
577 /**
578 * @brief Changing flags.
579 * @param prec The new precision value.
580 * @return The previous value of precision().
581 */
582 inline streamsize
583 precision(streamsize __prec)
584 {
585 streamsize __old = _M_precision;
586 _M_precision = __prec;
587 return __old;
588 }
589
590 /**
591 * @brief Flags access.
592 * @return The minimum field width to generate on output operations.
593 *
594 * "Minimum field width" refers to the number of characters.
595 */
596 inline streamsize
597 width() const { return _M_width; }
598
599 /**
600 * @brief Changing flags.
601 * @param wide The new width value.
602 * @return The previous value of width().
603 */
604 inline streamsize
605 width(streamsize __wide)
606 {
607 streamsize __old = _M_width;
608 _M_width = __wide;
609 return __old;
610 }
611
612 // [27.4.2.4] ios_base static members
613 /**
614 * @brief Interaction with the standard C I/O objects.
615 * @param sync Whether to synchronize or not.
616 * @return True if the standard streams were previously synchronized.
617 *
618 * The synchronization referred to is @e only that between the standard
619 * C facilities (e.g., stdout) and the standard C++ objects (e.g.,
620 * cout). User-declared streams are unaffected. See
621 * http://gcc.gnu.org/onlinedocs/libstdc++/27_io/howto.html#8 for more.
622 */
623 static bool
624 sync_with_stdio(bool __sync = true);
625
626 // [27.4.2.3] ios_base locale functions
627 /**
628 * @brief Setting a new locale.
629 * @param loc The new locale.
630 * @return The previous locale.
631 *
632 * Sets the new locale for this stream, and then invokes each callback
633 * with imbue_event.
634 */
635 locale
636 imbue(const locale& __loc);
637
638 /**
639 * @brief Locale access
640 * @return A copy of the current locale.
641 *
642 * If @c imbue(loc) has previously been called, then this function
643 * returns @c loc. Otherwise, it returns a copy of @c std::locale(),
644 * the global C++ locale.
645 */
646 inline locale
647 getloc() const { return _M_ios_locale; }
648
649 /**
650 * @brief Locale access
651 * @return A reference to the current locale.
652 *
653 * Like getloc above, but returns a reference instead of
654 * generating a copy.
655 */
656 inline const locale&
657 _M_getloc() const { return _M_ios_locale; }
658
659 // [27.4.2.5] ios_base storage functions
660 /**
661 * @brief Access to unique indices.
662 * @return An integer different from all previous calls.
663 *
664 * This function returns a unique integer every time it is called. It
665 * can be used for any purpose, but is primarily intended to be a unique
666 * index for the iword and pword functions. The expectation is that an
667 * application calls xalloc in order to obtain an index in the iword and
668 * pword arrays that can be used without fear of conflict.
669 *
670 * The implementation maintains a static variable that is incremented and
671 * returned on each invocation. xalloc is guaranteed to return an index
672 * that is safe to use in the iword and pword arrays.
673 */
674 static int
675 xalloc() throw();
676
677 /**
678 * @brief Access to integer array.
679 * @param __ix Index into the array.
680 * @return A reference to an integer associated with the index.
681 *
682 * The iword function provides access to an array of integers that can be
683 * used for any purpose. The array grows as required to hold the
684 * supplied index. All integers in the array are initialized to 0.
685 *
686 * The implementation reserves several indices. You should use xalloc to
687 * obtain an index that is safe to use. Also note that since the array
688 * can grow dynamically, it is not safe to hold onto the reference.
689 */
690 inline long&
691 iword(int __ix)
692 {
693 _Words& __word = (__ix < _M_word_size)
694 ? _M_word[__ix] : _M_grow_words(__ix, true);
695 return __word._M_iword;
696 }
697
698 /**
699 * @brief Access to void pointer array.
700 * @param __ix Index into the array.
701 * @return A reference to a void* associated with the index.
702 *
703 * The pword function provides access to an array of pointers that can be
704 * used for any purpose. The array grows as required to hold the
705 * supplied index. All pointers in the array are initialized to 0.
706 *
707 * The implementation reserves several indices. You should use xalloc to
708 * obtain an index that is safe to use. Also note that since the array
709 * can grow dynamically, it is not safe to hold onto the reference.
710 */
711 inline void*&
712 pword(int __ix)
713 {
714 _Words& __word = (__ix < _M_word_size)
715 ? _M_word[__ix] : _M_grow_words(__ix, false);
716 return __word._M_pword;
717 }
718
719 // Destructor
720 /**
721 * Invokes each callback with erase_event. Destroys local storage.
722 *
723 * Note that the ios_base object for the standard streams never gets
724 * destroyed. As a result, any callbacks registered with the standard
725 * streams will not get invoked with erase_event (unless copyfmt is
726 * used).
727 */
728 virtual ~ios_base();
729
730 protected:
731 ios_base();
732
733 // _GLIBCXX_RESOLVE_LIB_DEFECTS
734 // 50. Copy constructor and assignment operator of ios_base
735 private:
736 ios_base(const ios_base&);
737
738 ios_base&
739 operator=(const ios_base&);
740 };
741
742 // [27.4.5.1] fmtflags manipulators
743 /// Calls base.setf(ios_base::boolalpha).
744 inline ios_base&
745 boolalpha(ios_base& __base)
746 {
747 __base.setf(ios_base::boolalpha);
748 return __base;
749 }
750
751 /// Calls base.unsetf(ios_base::boolalpha).
752 inline ios_base&
753 noboolalpha(ios_base& __base)
754 {
755 __base.unsetf(ios_base::boolalpha);
756 return __base;
757 }
758
759 /// Calls base.setf(ios_base::showbase).
760 inline ios_base&
761 showbase(ios_base& __base)
762 {
763 __base.setf(ios_base::showbase);
764 return __base;
765 }
766
767 /// Calls base.unsetf(ios_base::showbase).
768 inline ios_base&
769 noshowbase(ios_base& __base)
770 {
771 __base.unsetf(ios_base::showbase);
772 return __base;
773 }
774
775 /// Calls base.setf(ios_base::showpoint).
776 inline ios_base&
777 showpoint(ios_base& __base)
778 {
779 __base.setf(ios_base::showpoint);
780 return __base;
781 }
782
783 /// Calls base.unsetf(ios_base::showpoint).
784 inline ios_base&
785 noshowpoint(ios_base& __base)
786 {
787 __base.unsetf(ios_base::showpoint);
788 return __base;
789 }
790
791 /// Calls base.setf(ios_base::showpos).
792 inline ios_base&
793 showpos(ios_base& __base)
794 {
795 __base.setf(ios_base::showpos);
796 return __base;
797 }
798
799 /// Calls base.unsetf(ios_base::showpos).
800 inline ios_base&
801 noshowpos(ios_base& __base)
802 {
803 __base.unsetf(ios_base::showpos);
804 return __base;
805 }
806
807 /// Calls base.setf(ios_base::skipws).
808 inline ios_base&
809 skipws(ios_base& __base)
810 {
811 __base.setf(ios_base::skipws);
812 return __base;
813 }
814
815 /// Calls base.unsetf(ios_base::skipws).
816 inline ios_base&
817 noskipws(ios_base& __base)
818 {
819 __base.unsetf(ios_base::skipws);
820 return __base;
821 }
822
823 /// Calls base.setf(ios_base::uppercase).
824 inline ios_base&
825 uppercase(ios_base& __base)
826 {
827 __base.setf(ios_base::uppercase);
828 return __base;
829 }
830
831 /// Calls base.unsetf(ios_base::uppercase).
832 inline ios_base&
833 nouppercase(ios_base& __base)
834 {
835 __base.unsetf(ios_base::uppercase);
836 return __base;
837 }
838
839 /// Calls base.setf(ios_base::unitbuf).
840 inline ios_base&
841 unitbuf(ios_base& __base)
842 {
843 __base.setf(ios_base::unitbuf);
844 return __base;
845 }
846
847 /// Calls base.unsetf(ios_base::unitbuf).
848 inline ios_base&
849 nounitbuf(ios_base& __base)
850 {
851 __base.unsetf(ios_base::unitbuf);
852 return __base;
853 }
854
855 // [27.4.5.2] adjustfield anipulators
856 /// Calls base.setf(ios_base::internal, ios_base::adjustfield).
857 inline ios_base&
858 internal(ios_base& __base)
859 {
860 __base.setf(ios_base::internal, ios_base::adjustfield);
861 return __base;
862 }
863
864 /// Calls base.setf(ios_base::left, ios_base::adjustfield).
865 inline ios_base&
866 left(ios_base& __base)
867 {
868 __base.setf(ios_base::left, ios_base::adjustfield);
869 return __base;
870 }
871
872 /// Calls base.setf(ios_base::right, ios_base::adjustfield).
873 inline ios_base&
874 right(ios_base& __base)
875 {
876 __base.setf(ios_base::right, ios_base::adjustfield);
877 return __base;
878 }
879
880 // [27.4.5.3] basefield anipulators
881 /// Calls base.setf(ios_base::dec, ios_base::basefield).
882 inline ios_base&
883 dec(ios_base& __base)
884 {
885 __base.setf(ios_base::dec, ios_base::basefield);
886 return __base;
887 }
888
889 /// Calls base.setf(ios_base::hex, ios_base::basefield).
890 inline ios_base&
891 hex(ios_base& __base)
892 {
893 __base.setf(ios_base::hex, ios_base::basefield);
894 return __base;
895 }
896
897 /// Calls base.setf(ios_base::oct, ios_base::basefield).
898 inline ios_base&
899 oct(ios_base& __base)
900 {
901 __base.setf(ios_base::oct, ios_base::basefield);
902 return __base;
903 }
904
905 // [27.4.5.4] floatfield anipulators
906 /// Calls base.setf(ios_base::fixed, ios_base::floatfield).
907 inline ios_base&
908 fixed(ios_base& __base)
909 {
910 __base.setf(ios_base::fixed, ios_base::floatfield);
911 return __base;
912 }
913
914 /// Calls base.setf(ios_base::scientific, ios_base::floatfield).
915 inline ios_base&
916 scientific(ios_base& __base)
917 {
918 __base.setf(ios_base::scientific, ios_base::floatfield);
919 return __base;
920 }
921 } // namespace std
922
923 #endif /* _IOS_BASE_H */
924