libstdc++-v3/config/io/basic_file_stdio.h

   1 // Wrapper of C-language FILE struct -*- C++ -*-
   2
   3 // Copyright (C) 2000, 2001, 2002 Free Software Foundation, Inc.
   4 //
   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)
   9 // any later version.
  10
  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.
  15
  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,
  19 // USA.
  20
  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.
  29
  30 //
  31 // ISO C++ 14882: 27.8  File-based streams
  32 //
  33
  34 /** @file basic_file.h
  35  *  This is an internal header file, included by other library headers.
  36  *  You should not attempt to use it directly.
  37  */
  38
  39 #ifndef _CPP_BASIC_FILE
  40 #define _CPP_BASIC_FILE 1
  41
  42 #pragma GCC system_header
  43
  44 #include <bits/c++config.h>
  45 #include <ios>
  46
  47 namespace std
  48 {
  49   // Generic declaration.
  50   template<typename _CharT>
  51     class __basic_file;
  52
  53   // Specialization.
  54   template<>
  55     class __basic_file<char>
  56     {
  57       // Underlying data source/sink.
  58       __c_file_type*    _M_cfile;
  59       // True iff we opened _M_cfile, and thus must close it ourselves.
  60       bool              _M_cfile_created;
  61
  62     public:
  63       __basic_file(__c_lock* __lock = 0);
  64
  65       void
  66       _M_open_mode(ios_base::openmode __mode, int& __p_mode, int& __rw_mode,
  67                    char* __c_mode);
  68
  69       __basic_file*
  70       open(const char* __name, ios_base::openmode __mode, int __prot = 0664);
  71
  72       __basic_file*
  73       sys_open(__c_file_type* __file, ios_base::openmode __mode);
  74
  75       char
  76       sys_getc();
  77
  78       char
  79       sys_ungetc(char);
  80
  81       __basic_file*
  82       close();
  83
  84       bool
  85       is_open();
  86
  87       int
  88       fd();
  89
  90       ~__basic_file();
  91
  92       streamsize
  93       xsputn(const char* __s, streamsize __n);
  94
  95       streamsize
  96       xsgetn(char* __s, streamsize __n);
  97
  98       streamoff
  99       seekoff(streamoff __off, ios_base::seekdir __way,
 100               ios_base::openmode __mode = ios_base::in | ios_base::out);
 101
 102       streamoff
 103       seekpos(streamoff __pos,
 104               ios_base::openmode __mode = ios_base::in | ios_base::out);
 105
 106       int
 107       sync();
 108     };
 109 }  // namespace std
 110
 111 #endif  // _CPP_BASIC_FILE