1 // File based streams -*- C++ -*-
3 // Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
4 // Free Software Foundation, Inc.
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)
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.
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,
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.
32 // ISO C++ 14882: 27.8 File-based streams
36 #define _FSTREAM_TCC 1
38 #pragma GCC system_header
42 template<typename _CharT, typename _Traits>
44 basic_filebuf<_CharT, _Traits>::
45 _M_allocate_internal_buffer()
47 // Allocate internal buffer only if one doesn't already exist
48 // (either allocated or provided by the user via setbuf).
49 if (!_M_buf_allocated && !this->_M_buf)
51 this->_M_buf = new char_type[this->_M_buf_size];
52 _M_buf_allocated = true;
56 template<typename _CharT, typename _Traits>
58 basic_filebuf<_CharT, _Traits>::
59 _M_destroy_internal_buffer() throw()
63 delete [] this->_M_buf;
65 _M_buf_allocated = false;
74 template<typename _CharT, typename _Traits>
75 basic_filebuf<_CharT, _Traits>::
76 basic_filebuf() : __streambuf_type(), _M_file(&_M_lock),
77 _M_mode(ios_base::openmode(0)), _M_state_beg(), _M_state_cur(),
78 _M_state_last(), _M_buf(NULL), _M_buf_size(BUFSIZ),
79 _M_buf_allocated(false), _M_reading(false), _M_writing(false),
80 _M_pback_cur_save(0), _M_pback_end_save(0), _M_pback_init(false),
81 _M_codecvt(0), _M_ext_buf(0), _M_ext_buf_size(0), _M_ext_next(0),
84 if (has_facet<__codecvt_type>(this->_M_buf_locale))
85 _M_codecvt = &use_facet<__codecvt_type>(this->_M_buf_locale);
88 template<typename _CharT, typename _Traits>
89 typename basic_filebuf<_CharT, _Traits>::__filebuf_type*
90 basic_filebuf<_CharT, _Traits>::
91 open(const char* __s, ios_base::openmode __mode)
93 __filebuf_type *__ret = NULL;
96 _M_file.open(__s, __mode);
99 _M_allocate_internal_buffer();
100 this->_M_mode = __mode;
102 // Setup initial buffer to 'uncommitted' mode.
107 // Reset to initial state.
108 _M_state_last = _M_state_cur = _M_state_beg;
111 if ((__mode & ios_base::ate)
112 && this->seekoff(0, ios_base::end, __mode)
113 == pos_type(off_type(-1)))
122 template<typename _CharT, typename _Traits>
123 typename basic_filebuf<_CharT, _Traits>::__filebuf_type*
124 basic_filebuf<_CharT, _Traits>::
127 __filebuf_type* __ret = NULL;
130 bool __testfail = false;
133 if (!_M_terminate_output())
137 { __testfail = true; }
139 // NB: Do this here so that re-opened filebufs will be cool...
140 this->_M_mode = ios_base::openmode(0);
141 this->_M_pback_init = false;
142 _M_destroy_internal_buffer();
146 _M_state_last = _M_state_cur = _M_state_beg;
148 if (!_M_file.close())
157 template<typename _CharT, typename _Traits>
159 basic_filebuf<_CharT, _Traits>::
162 streamsize __ret = -1;
163 const bool __testin = this->_M_mode & ios_base::in;
164 if (__testin && this->is_open())
166 // For a stateful encoding (-1) the pending sequence might be just
167 // shift and unshift prefixes with no actual character.
168 __ret = this->egptr() - this->gptr();
169 if (__check_facet(_M_codecvt).encoding() >= 0)
170 __ret += _M_file.showmanyc() / _M_codecvt->max_length();
175 template<typename _CharT, typename _Traits>
176 typename basic_filebuf<_CharT, _Traits>::int_type
177 basic_filebuf<_CharT, _Traits>::
180 int_type __ret = traits_type::eof();
181 const bool __testin = this->_M_mode & ios_base::in;
182 if (__testin && !_M_writing)
184 // Check for pback madness, and if so swich back to the
185 // normal buffers and jet outta here before expensive
189 if (this->gptr() < this->egptr())
190 return traits_type::to_int_type(*this->gptr());
192 // Get and convert input sequence.
193 const size_t __buflen = this->_M_buf_size > 1
194 ? this->_M_buf_size - 1 : 1;
196 // Will be set to true if ::read() returns 0 indicating EOF.
197 bool __got_eof = false;
198 // Number of internal characters produced.
199 streamsize __ilen = 0;
200 codecvt_base::result __r = codecvt_base::ok;
201 if (__check_facet(_M_codecvt).always_noconv())
203 __ilen = _M_file.xsgetn(reinterpret_cast<char*>(this->eback()),
210 // Worst-case number of external bytes.
211 // XXX Not done encoding() == -1.
212 const int __enc = _M_codecvt->encoding();
213 streamsize __blen; // Minimum buffer size.
214 streamsize __rlen; // Number of chars to read.
216 __blen = __rlen = __buflen * __enc;
219 __blen = __buflen + _M_codecvt->max_length() - 1;
222 const streamsize __remainder = _M_ext_end - _M_ext_next;
223 __rlen = __rlen > __remainder ? __rlen - __remainder : 0;
225 // An imbue in 'read' mode implies first converting the external
226 // chars already present.
227 if (_M_reading && this->egptr() == this->eback() && __remainder)
230 // Allocate buffer if necessary and move unconverted
232 if (_M_ext_buf_size < __blen)
234 char* __buf = new char[__blen];
236 std::memcpy(__buf, _M_ext_next, __remainder);
238 delete [] _M_ext_buf;
240 _M_ext_buf_size = __blen;
242 else if (__remainder)
243 std::memmove(_M_ext_buf, _M_ext_next, __remainder);
245 _M_ext_next = _M_ext_buf;
246 _M_ext_end = _M_ext_buf + __remainder;
247 _M_state_last = _M_state_cur;
254 // This may fail if the return value of
255 // codecvt::max_length() is bogus.
256 if (_M_ext_end - _M_ext_buf + __rlen > _M_ext_buf_size)
258 __throw_ios_failure(__N("basic_filebuf::underflow "
259 "codecvt::max_length() "
262 streamsize __elen = _M_file.xsgetn(_M_ext_end, __rlen);
265 else if (__elen == -1)
267 _M_ext_end += __elen;
271 __r = _M_codecvt->in(_M_state_cur, _M_ext_next,
272 _M_ext_end, _M_ext_next, this->eback(),
273 this->eback() + __buflen, __iend);
274 if (__r == codecvt_base::noconv)
276 size_t __avail = _M_ext_end - _M_ext_buf;
277 __ilen = std::min(__avail, __buflen);
278 traits_type::copy(this->eback(),
279 reinterpret_cast<char_type*>(_M_ext_buf), __ilen);
280 _M_ext_next = _M_ext_buf + __ilen;
283 __ilen = __iend - this->eback();
285 // _M_codecvt->in may return error while __ilen > 0: this is
286 // ok, and actually occurs in case of mixed encodings (e.g.,
288 if (__r == codecvt_base::error)
293 while (__ilen == 0 && !__got_eof);
298 _M_set_buffer(__ilen);
300 __ret = traits_type::to_int_type(*this->gptr());
304 // If the actual end of file is reached, set 'uncommitted'
305 // mode, thus allowing an immediate write without an
309 // However, reaching it while looping on partial means that
310 // the file has got an incomplete character.
311 if (__r == codecvt_base::partial)
312 __throw_ios_failure(__N("basic_filebuf::underflow "
313 "incomplete character in file"));
315 else if (__r == codecvt_base::error)
316 __throw_ios_failure(__N("basic_filebuf::underflow "
317 "invalid byte sequence in file"));
319 __throw_ios_failure(__N("basic_filebuf::underflow "
320 "error reading the file"));
325 template<typename _CharT, typename _Traits>
326 typename basic_filebuf<_CharT, _Traits>::int_type
327 basic_filebuf<_CharT, _Traits>::
328 pbackfail(int_type __i)
330 int_type __ret = traits_type::eof();
331 const bool __testin = this->_M_mode & ios_base::in;
332 if (__testin && !_M_writing)
334 // Remember whether the pback buffer is active, otherwise below
335 // we may try to store in it a second char (libstdc++/9761).
336 const bool __testpb = this->_M_pback_init;
337 const bool __testeof = traits_type::eq_int_type(__i, __ret);
339 if (this->eback() < this->gptr())
342 __tmp = traits_type::to_int_type(*this->gptr());
344 else if (this->seekoff(-1, ios_base::cur) != pos_type(off_type(-1)))
346 __tmp = this->underflow();
347 if (traits_type::eq_int_type(__tmp, __ret))
352 // At the beginning of the buffer, need to make a
353 // putback position available. But the seek may fail
354 // (f.i., at the beginning of a file, see
355 // libstdc++/9439) and in that case we return
356 // traits_type::eof().
360 // Try to put back __i into input sequence in one of three ways.
361 // Order these tests done in is unspecified by the standard.
362 if (!__testeof && traits_type::eq_int_type(__i, __tmp))
365 __ret = traits_type::not_eof(__i);
370 *this->gptr() = traits_type::to_char_type(__i);
377 template<typename _CharT, typename _Traits>
378 typename basic_filebuf<_CharT, _Traits>::int_type
379 basic_filebuf<_CharT, _Traits>::
380 overflow(int_type __c)
382 int_type __ret = traits_type::eof();
383 const bool __testeof = traits_type::eq_int_type(__c, __ret);
384 const bool __testout = this->_M_mode & ios_base::out;
385 if (__testout && !_M_reading)
387 if (this->pbase() < this->pptr())
389 // If appropriate, append the overflow char.
392 *this->pptr() = traits_type::to_char_type(__c);
396 // Convert pending sequence to external representation,
398 if (_M_convert_to_external(this->pbase(),
399 this->pptr() - this->pbase())
400 && (!__testeof || !_M_file.sync()))
403 __ret = traits_type::not_eof(__c);
406 else if (this->_M_buf_size > 1)
408 // Overflow in 'uncommitted' mode: set _M_writing, set
409 // the buffer to the initial 'write' mode, and put __c
415 *this->pptr() = traits_type::to_char_type(__c);
418 __ret = traits_type::not_eof(__c);
423 char_type __conv = traits_type::to_char_type(__c);
424 if (__testeof || _M_convert_to_external(&__conv, 1))
427 __ret = traits_type::not_eof(__c);
434 template<typename _CharT, typename _Traits>
436 basic_filebuf<_CharT, _Traits>::
437 _M_convert_to_external(_CharT* __ibuf, streamsize __ilen)
439 // Sizes of external and pending output.
442 if (__check_facet(_M_codecvt).always_noconv())
444 __elen = _M_file.xsputn(reinterpret_cast<char*>(__ibuf), __ilen);
449 // Worst-case number of external bytes needed.
450 // XXX Not done encoding() == -1.
451 streamsize __blen = __ilen * _M_codecvt->max_length();
452 char* __buf = static_cast<char*>(__builtin_alloca(__blen));
455 const char_type* __iend;
456 codecvt_base::result __r;
457 __r = _M_codecvt->out(_M_state_cur, __ibuf, __ibuf + __ilen,
458 __iend, __buf, __buf + __blen, __bend);
460 if (__r == codecvt_base::ok || __r == codecvt_base::partial)
461 __blen = __bend - __buf;
462 else if (__r == codecvt_base::noconv)
464 // Same as the always_noconv case above.
465 __buf = reinterpret_cast<char*>(__ibuf);
469 __throw_ios_failure(__N("basic_filebuf::_M_convert_to_external "
470 "conversion error"));
472 __elen = _M_file.xsputn(__buf, __blen);
475 // Try once more for partial conversions.
476 if (__r == codecvt_base::partial && __elen == __plen)
478 const char_type* __iresume = __iend;
479 streamsize __rlen = this->pptr() - __iend;
480 __r = _M_codecvt->out(_M_state_cur, __iresume,
481 __iresume + __rlen, __iend, __buf,
482 __buf + __blen, __bend);
483 if (__r != codecvt_base::error)
485 __rlen = __bend - __buf;
486 __elen = _M_file.xsputn(__buf, __rlen);
490 __throw_ios_failure(__N("basic_filebuf::_M_convert_to_external "
491 "conversion error"));
494 return __elen == __plen;
497 template<typename _CharT, typename _Traits>
499 basic_filebuf<_CharT, _Traits>::
500 xsputn(const _CharT* __s, streamsize __n)
502 // Optimization in the always_noconv() case, to be generalized in the
503 // future: when __n is sufficiently large we write directly instead of
505 streamsize __ret = 0;
506 const bool __testout = this->_M_mode & ios_base::out;
507 if (__testout && !_M_reading
508 && __check_facet(_M_codecvt).always_noconv())
510 // Measurement would reveal the best choice.
511 const streamsize __chunk = 1ul << 10;
512 streamsize __bufavail = this->epptr() - this->pptr();
514 // Don't mistake 'uncommitted' mode buffered with unbuffered.
515 if (!_M_writing && this->_M_buf_size > 1)
516 __bufavail = this->_M_buf_size - 1;
518 const streamsize __limit = std::min(__chunk, __bufavail);
521 const streamsize __buffill = this->pptr() - this->pbase();
522 const char* __buf = reinterpret_cast<const char*>(this->pbase());
523 __ret = _M_file.xsputn_2(__buf, __buffill,
524 reinterpret_cast<const char*>(__s),
526 if (__ret == __buffill + __n)
531 if (__ret > __buffill)
537 __ret = __streambuf_type::xsputn(__s, __n);
540 __ret = __streambuf_type::xsputn(__s, __n);
544 template<typename _CharT, typename _Traits>
545 typename basic_filebuf<_CharT, _Traits>::__streambuf_type*
546 basic_filebuf<_CharT, _Traits>::
547 setbuf(char_type* __s, streamsize __n)
549 if (!this->is_open())
550 if (__s == 0 && __n == 0)
551 this->_M_buf_size = 1;
552 else if (__s && __n > 0)
554 // This is implementation-defined behavior, and assumes that
555 // an external char_type array of length __n exists and has
556 // been pre-allocated. If this is not the case, things will
557 // quickly blow up. When __n > 1, __n - 1 positions will be
558 // used for the get area, __n - 1 for the put area and 1
559 // position to host the overflow char of a full put area.
560 // When __n == 1, 1 position will be used for the get area
561 // and 0 for the put area, as in the unbuffered case above.
563 this->_M_buf_size = __n;
569 // According to 27.8.1.4 p11 - 13, seekoff should ignore the last
570 // argument (of type openmode).
571 template<typename _CharT, typename _Traits>
572 typename basic_filebuf<_CharT, _Traits>::pos_type
573 basic_filebuf<_CharT, _Traits>::
574 seekoff(off_type __off, ios_base::seekdir __way, ios_base::openmode)
578 __width = _M_codecvt->encoding();
582 pos_type __ret = pos_type(off_type(-1));
583 const bool __testfail = __off != 0 && __width <= 0;
584 if (this->is_open() && !__testfail)
586 // Ditch any pback buffers to avoid confusion.
589 // Correct state at destination. Note that this is the correct
590 // state for the current position during output, because
591 // codecvt::unshift() returns the state to the initial state.
592 // This is also the correct state at the end of the file because
593 // an unshift sequence should have been written at the end.
594 __state_type __state = _M_state_beg;
595 off_type __computed_off = __off * __width;
596 if (_M_reading && __way == ios_base::cur)
598 if (_M_codecvt->always_noconv())
599 __computed_off += this->gptr() - this->egptr();
602 // Calculate offset from _M_ext_buf that corresponds
603 // to gptr(). Note: uses _M_state_last, which
604 // corresponds to eback().
605 const int __gptr_off =
606 _M_codecvt->length(_M_state_last, _M_ext_buf, _M_ext_next,
607 this->gptr() - this->eback());
608 __computed_off += _M_ext_buf + __gptr_off - _M_ext_end;
610 // _M_state_last is modified by codecvt::length() so
611 // it now corresponds to gptr().
612 __state = _M_state_last;
615 __ret = _M_seek(__computed_off, __way, __state);
620 // _GLIBCXX_RESOLVE_LIB_DEFECTS
621 // 171. Strange seekpos() semantics due to joint position
622 // According to the resolution of DR 171, seekpos should ignore the last
623 // argument (of type openmode).
624 template<typename _CharT, typename _Traits>
625 typename basic_filebuf<_CharT, _Traits>::pos_type
626 basic_filebuf<_CharT, _Traits>::
627 seekpos(pos_type __pos, ios_base::openmode)
629 pos_type __ret = pos_type(off_type(-1));
632 // Ditch any pback buffers to avoid confusion.
634 __ret = _M_seek(off_type(__pos), ios_base::beg, __pos.state());
639 template<typename _CharT, typename _Traits>
640 typename basic_filebuf<_CharT, _Traits>::pos_type
641 basic_filebuf<_CharT, _Traits>::
642 _M_seek(off_type __off, ios_base::seekdir __way, __state_type __state)
644 pos_type __ret = pos_type(off_type(-1));
645 if (_M_terminate_output())
647 // Returns pos_type(off_type(-1)) in case of failure.
648 __ret = pos_type(_M_file.seekoff(__off, __way));
651 _M_ext_next = _M_ext_end = _M_ext_buf;
653 _M_state_cur = __state;
654 __ret.state(_M_state_cur);
659 template<typename _CharT, typename _Traits>
661 basic_filebuf<_CharT, _Traits>::
662 _M_terminate_output()
664 // Part one: update the output sequence.
665 bool __testvalid = true;
666 if (this->pbase() < this->pptr())
668 const int_type __tmp = this->overflow();
669 if (traits_type::eq_int_type(__tmp, traits_type::eof()))
673 // Part two: output unshift sequence.
674 if (_M_writing && !__check_facet(_M_codecvt).always_noconv()
677 // Note: this value is arbitrary, since there is no way to
678 // get the length of the unshift sequence from codecvt,
679 // without calling unshift.
680 const size_t __blen = 128;
682 codecvt_base::result __r;
683 streamsize __ilen = 0;
688 __r = _M_codecvt->unshift(_M_state_cur, __buf,
689 __buf + __blen, __next);
690 if (__r == codecvt_base::error)
692 else if (__r == codecvt_base::ok ||
693 __r == codecvt_base::partial)
695 __ilen = __next - __buf;
698 const streamsize __elen = _M_file.xsputn(__buf, __ilen);
699 if (__elen != __ilen)
704 while (__r == codecvt_base::partial && __ilen > 0 && __testvalid);
708 // This second call to overflow() is required by the standard,
709 // but it's not clear why it's needed, since the output buffer
710 // should be empty by this point (it should have been emptied
711 // in the first call to overflow()).
712 const int_type __tmp = this->overflow();
713 if (traits_type::eq_int_type(__tmp, traits_type::eof()))
720 template<typename _CharT, typename _Traits>
722 basic_filebuf<_CharT, _Traits>::
725 // Make sure that the internal buffer resyncs its idea of
726 // the file position with the external file.
727 // NB: _M_file.sync() will be called within.
729 if (this->pbase() < this->pptr())
731 const int_type __tmp = this->overflow();
732 if (traits_type::eq_int_type(__tmp, traits_type::eof()))
738 template<typename _CharT, typename _Traits>
740 basic_filebuf<_CharT, _Traits>::
741 imbue(const locale& __loc)
743 bool __testvalid = true;
745 const __codecvt_type* _M_codecvt_tmp = 0;
746 if (__builtin_expect(has_facet<__codecvt_type>(__loc), true))
747 _M_codecvt_tmp = &use_facet<__codecvt_type>(__loc);
751 // encoding() == -1 is ok only at the beginning.
752 if ((_M_reading || _M_writing)
753 && __check_facet(_M_codecvt).encoding() == -1)
759 if (__check_facet(_M_codecvt).always_noconv())
762 && !__check_facet(_M_codecvt_tmp).always_noconv())
763 __testvalid = this->seekoff(0, ios_base::cur, this->_M_mode)
764 != pos_type(off_type(-1));
768 // External position corresponding to gptr().
769 _M_ext_next = _M_ext_buf
770 + _M_codecvt->length(_M_state_last, _M_ext_buf, _M_ext_next,
771 this->gptr() - this->eback());
772 const streamsize __remainder = _M_ext_end - _M_ext_next;
774 std::memmove(_M_ext_buf, _M_ext_next, __remainder);
776 _M_ext_next = _M_ext_buf;
777 _M_ext_end = _M_ext_buf + __remainder;
779 _M_state_last = _M_state_cur = _M_state_beg;
782 else if (_M_writing && (__testvalid = _M_terminate_output()))
788 _M_codecvt = _M_codecvt_tmp;
791 // Inhibit implicit instantiations for required instantiations,
792 // which are defined via explicit instantiations elsewhere.
793 // NB: This syntax is a GNU extension.
794 #if _GLIBCXX_EXTERN_TEMPLATE
795 extern template class basic_filebuf<char>;
796 extern template class basic_ifstream<char>;
797 extern template class basic_ofstream<char>;
798 extern template class basic_fstream<char>;
800 #ifdef _GLIBCXX_USE_WCHAR_T
801 extern template class basic_filebuf<wchar_t>;
802 extern template class basic_ifstream<wchar_t>;
803 extern template class basic_ofstream<wchar_t>;
804 extern template class basic_fstream<wchar_t>;