libstdc++
basic_file.h
Go to the documentation of this file.
00001 // Wrapper of C-language FILE struct -*- C++ -*-
00002 
00003 // Copyright (C) 2000-2013 Free Software Foundation, Inc.
00004 //
00005 // This file is part of the GNU ISO C++ Library.  This library is free
00006 // software; you can redistribute it and/or modify it under the
00007 // terms of the GNU General Public License as published by the
00008 // Free Software Foundation; either version 3, or (at your option)
00009 // any later version.
00010 
00011 // This library is distributed in the hope that it will be useful,
00012 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00013 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014 // GNU General Public License for more details.
00015 
00016 // Under Section 7 of GPL version 3, you are granted additional
00017 // permissions described in the GCC Runtime Library Exception, version
00018 // 3.1, as published by the Free Software Foundation.
00019 
00020 // You should have received a copy of the GNU General Public License and
00021 // a copy of the GCC Runtime Library Exception along with this program;
00022 // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
00023 // <http://www.gnu.org/licenses/>.
00024 
00025 //
00026 // ISO C++ 14882: 27.8  File-based streams
00027 //
00028 
00029 /** @file bits/basic_file.h
00030  *  This is an internal header file, included by other library headers.
00031  *  Do not attempt to use it directly. @headername{ios}
00032  */
00033 
00034 #ifndef _GLIBCXX_BASIC_FILE_STDIO_H
00035 #define _GLIBCXX_BASIC_FILE_STDIO_H 1
00036 
00037 #pragma GCC system_header
00038 
00039 #include <bits/c++config.h>
00040 #include <bits/c++io.h>  // for __c_lock and __c_file
00041 #include <ios>
00042 
00043 namespace std _GLIBCXX_VISIBILITY(default)
00044 {
00045 _GLIBCXX_BEGIN_NAMESPACE_VERSION
00046 
00047   // Generic declaration.
00048   template<typename _CharT>
00049     class __basic_file; 
00050 
00051   // Specialization.
00052   template<>
00053     class __basic_file<char>
00054     {
00055       // Underlying data source/sink.
00056       __c_file*     _M_cfile;
00057 
00058       // True iff we opened _M_cfile, and thus must close it ourselves.
00059       bool      _M_cfile_created;
00060 
00061     public:
00062       __basic_file(__c_lock* __lock = 0) throw ();
00063 
00064       __basic_file* 
00065       open(const char* __name, ios_base::openmode __mode, int __prot = 0664);
00066 
00067       __basic_file*
00068       sys_open(__c_file* __file, ios_base::openmode);
00069 
00070       __basic_file*
00071       sys_open(int __fd, ios_base::openmode __mode) throw ();
00072 
00073       __basic_file* 
00074       close(); 
00075 
00076       _GLIBCXX_PURE bool 
00077       is_open() const throw ();
00078 
00079       _GLIBCXX_PURE int 
00080       fd() throw ();
00081 
00082       _GLIBCXX_PURE __c_file*
00083       file() throw ();
00084 
00085       ~__basic_file();
00086 
00087       streamsize 
00088       xsputn(const char* __s, streamsize __n);
00089 
00090       streamsize 
00091       xsputn_2(const char* __s1, streamsize __n1,
00092            const char* __s2, streamsize __n2);
00093 
00094       streamsize 
00095       xsgetn(char* __s, streamsize __n);
00096 
00097       streamoff
00098       seekoff(streamoff __off, ios_base::seekdir __way) throw ();
00099 
00100       int 
00101       sync();
00102 
00103       streamsize
00104       showmanyc();
00105     };
00106 
00107 _GLIBCXX_END_NAMESPACE_VERSION
00108 } // namespace
00109 
00110 #endif