libstdc++
basic_file.h
Go to the documentation of this file.
1 // Wrapper of C-language FILE struct -*- C++ -*-
2 
3 // Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009
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 3, 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 // Under Section 7 of GPL version 3, you are granted additional
18 // permissions described in the GCC Runtime Library Exception, version
19 // 3.1, as published by the Free Software Foundation.
20 
21 // You should have received a copy of the GNU General Public License and
22 // a copy of the GCC Runtime Library Exception along with this program;
23 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
24 // <http://www.gnu.org/licenses/>.
25 
26 //
27 // ISO C++ 14882: 27.8 File-based streams
28 //
29 
30 /** @file basic_file.h
31  * This is an internal header file, included by other library headers.
32  * You should not attempt to use it directly.
33  */
34 
35 #ifndef _GLIBCXX_BASIC_FILE_STDIO_H
36 #define _GLIBCXX_BASIC_FILE_STDIO_H 1
37 
38 #pragma GCC system_header
39 
40 #include <bits/c++config.h>
41 #include <bits/c++io.h> // for __c_lock and __c_file
42 #include <ios>
43 
44 _GLIBCXX_BEGIN_NAMESPACE(std)
45 
46  // Generic declaration.
47  template<typename _CharT>
48  class __basic_file;
49 
50  // Specialization.
51  template<>
52  class __basic_file<char>
53  {
54  // Underlying data source/sink.
55  __c_file* _M_cfile;
56 
57  // True iff we opened _M_cfile, and thus must close it ourselves.
58  bool _M_cfile_created;
59 
60  public:
61  __basic_file(__c_lock* __lock = 0);
62 
63  __basic_file*
64  open(const char* __name, ios_base::openmode __mode, int __prot = 0664);
65 
66  __basic_file*
67  sys_open(__c_file* __file, ios_base::openmode);
68 
69  __basic_file*
70  sys_open(int __fd, ios_base::openmode __mode);
71 
72  __basic_file*
73  close();
74 
75  bool
76  is_open() const;
77 
78  int
79  fd();
80 
81  __c_file*
82  file();
83 
84  ~__basic_file();
85 
86  streamsize
87  xsputn(const char* __s, streamsize __n);
88 
89  streamsize
90  xsputn_2(const char* __s1, streamsize __n1,
91  const char* __s2, streamsize __n2);
92 
93  streamsize
94  xsgetn(char* __s, streamsize __n);
95 
96  streamoff
97  seekoff(streamoff __off, ios_base::seekdir __way);
98 
99  int
100  sync();
101 
102  streamsize
103  showmanyc();
104  };
105 
106 _GLIBCXX_END_NAMESPACE
107 
108 #endif
ptrdiff_t streamsize
Integral type for I/O operation counts and buffer sizes.
Definition: postypes.h:98
long long streamoff
Type used by fpos, char_traits<char>, and char_traits<wchar_t>.
Definition: postypes.h:94