xref: /netbsd-src/external/gpl3/gcc.old/dist/libstdc++-v3/doc/xml/manual/io.xml (revision b7b7574d3bf8eeb51a1fa3977b59142ec6434a55)
1<?xml version='1.0'?>
2<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
4[ ]>
5
6<chapter id="std.io" xreflabel="Input and Output">
7<?dbhtml filename="io.html"?>
8
9<chapterinfo>
10  <keywordset>
11    <keyword>
12      ISO C++
13    </keyword>
14    <keyword>
15      library
16    </keyword>
17  </keywordset>
18</chapterinfo>
19
20<title>
21  Input and Output
22  <indexterm><primary>Input and Output</primary></indexterm>
23</title>
24
25<!-- Sect1 01 : Iostream Objects -->
26<sect1 id="std.io.objects" xreflabel="IO Objects">
27<?dbhtml filename="iostream_objects.html"?>
28  <title>Iostream Objects</title>
29
30   <para>To minimize the time you have to wait on the compiler, it's good to
31      only include the headers you really need.  Many people simply include
32      &lt;iostream&gt; when they don't need to -- and that can <emphasis>penalize
33      your runtime as well.</emphasis>  Here are some tips on which header to use
34      for which situations, starting with the simplest.
35   </para>
36   <para><emphasis>&lt;iosfwd&gt;</emphasis> should be included whenever you simply
37      need the <emphasis>name</emphasis> of an I/O-related class, such as
38      &quot;ofstream&quot; or &quot;basic_streambuf&quot;.  Like the name
39      implies, these are forward declarations.  (A word to all you fellow
40      old school programmers:  trying to forward declare classes like
41      &quot;class istream;&quot; won't work.  Look in the iosfwd header if
42      you'd like to know why.)  For example,
43   </para>
44   <programlisting>
45    #include &lt;iosfwd&gt;
46
47    class MyClass
48    {
49	....
50	std::ifstream&amp;   input_file;
51    };
52
53    extern std::ostream&amp; operator&lt;&lt; (std::ostream&amp;, MyClass&amp;);
54   </programlisting>
55   <para><emphasis>&lt;ios&gt;</emphasis> declares the base classes for the entire
56      I/O stream hierarchy, std::ios_base and std::basic_ios&lt;charT&gt;, the
57      counting types std::streamoff and std::streamsize, the file
58      positioning type std::fpos, and the various manipulators like
59      std::hex, std::fixed, std::noshowbase, and so forth.
60   </para>
61   <para>The ios_base class is what holds the format flags, the state flags,
62      and the functions which change them (setf(), width(), precision(),
63      etc).  You can also store extra data and register callback functions
64      through ios_base, but that has been historically underused.  Anything
65      which doesn't depend on the type of characters stored is consolidated
66      here.
67   </para>
68   <para>The template class basic_ios is the highest template class in the
69      hierarchy; it is the first one depending on the character type, and
70      holds all general state associated with that type:  the pointer to the
71      polymorphic stream buffer, the facet information, etc.
72   </para>
73   <para><emphasis>&lt;streambuf&gt;</emphasis> declares the template class
74      basic_streambuf, and two standard instantiations, streambuf and
75      wstreambuf.  If you need to work with the vastly useful and capable
76      stream buffer classes, e.g., to create a new form of storage
77      transport, this header is the one to include.
78   </para>
79   <para><emphasis>&lt;istream&gt;</emphasis>/<emphasis>&lt;ostream&gt;</emphasis> are
80      the headers to include when you are using the &gt;&gt;/&lt;&lt;
81      interface, or any of the other abstract stream formatting functions.
82      For example,
83   </para>
84   <programlisting>
85    #include &lt;istream&gt;
86
87    std::ostream&amp; operator&lt;&lt; (std::ostream&amp; os, MyClass&amp; c)
88    {
89       return os &lt;&lt; c.data1() &lt;&lt; c.data2();
90    }
91   </programlisting>
92   <para>The std::istream and std::ostream classes are the abstract parents of
93      the various concrete implementations.  If you are only using the
94      interfaces, then you only need to use the appropriate interface header.
95   </para>
96   <para><emphasis>&lt;iomanip&gt;</emphasis> provides &quot;extractors and inserters
97      that alter information maintained by class ios_base and its derived
98      classes,&quot; such as std::setprecision and std::setw.  If you need
99      to write expressions like <code>os &lt;&lt; setw(3);</code> or
100      <code>is &gt;&gt; setbase(8);</code>, you must include &lt;iomanip&gt;.
101   </para>
102   <para><emphasis>&lt;sstream&gt;</emphasis>/<emphasis>&lt;fstream&gt;</emphasis>
103      declare the six stringstream and fstream classes.  As they are the
104      standard concrete descendants of istream and ostream, you will already
105      know about them.
106   </para>
107   <para>Finally, <emphasis>&lt;iostream&gt;</emphasis> provides the eight standard
108      global objects (cin, cout, etc).  To do this correctly, this header
109      also provides the contents of the &lt;istream&gt; and &lt;ostream&gt;
110      headers, but nothing else.  The contents of this header look like
111   </para>
112   <programlisting>
113    #include &lt;ostream&gt;
114    #include &lt;istream&gt;
115
116    namespace std
117    {
118	extern istream cin;
119	extern ostream cout;
120	....
121
122	// this is explained below
123	<emphasis>static ios_base::Init __foo;</emphasis>    // not its real name
124    }
125   </programlisting>
126   <para>Now, the runtime penalty mentioned previously:  the global objects
127      must be initialized before any of your own code uses them; this is
128      guaranteed by the standard.  Like any other global object, they must
129      be initialized once and only once.  This is typically done with a
130      construct like the one above, and the nested class ios_base::Init is
131      specified in the standard for just this reason.
132   </para>
133   <para>How does it work?  Because the header is included before any of your
134      code, the <emphasis>__foo</emphasis> object is constructed before any of
135      your objects.  (Global objects are built in the order in which they
136      are declared, and destroyed in reverse order.)  The first time the
137      constructor runs, the eight stream objects are set up.
138   </para>
139   <para>The <code>static</code> keyword means that each object file compiled
140      from a source file containing &lt;iostream&gt; will have its own
141      private copy of <emphasis>__foo</emphasis>.  There is no specified order
142      of construction across object files (it's one of those pesky NP
143      problems that make life so interesting), so one copy in each object
144      file means that the stream objects are guaranteed to be set up before
145      any of your code which uses them could run, thereby meeting the
146      requirements of the standard.
147   </para>
148   <para>The penalty, of course, is that after the first copy of
149      <emphasis>__foo</emphasis> is constructed, all the others are just wasted
150      processor time.  The time spent is merely for an increment-and-test
151      inside a function call, but over several dozen or hundreds of object
152      files, that time can add up.  (It's not in a tight loop, either.)
153   </para>
154   <para>The lesson?  Only include &lt;iostream&gt; when you need to use one of
155      the standard objects in that source file; you'll pay less startup
156      time.  Only include the header files you need to in general; your
157      compile times will go down when there's less parsing work to do.
158   </para>
159
160</sect1>
161
162<!-- Sect1 02 : Stream Buffers -->
163<sect1 id="std.io.streambufs" xreflabel="Stream Buffers">
164<?dbhtml filename="streambufs.html"?>
165  <title>Stream Buffers</title>
166
167  <sect2 id="io.streambuf.derived" xreflabel="Derived streambuf Classes">
168    <title>Derived streambuf Classes</title>
169    <para>
170    </para>
171
172   <para>Creating your own stream buffers for I/O can be remarkably easy.
173      If you are interested in doing so, we highly recommend two very
174      excellent books:
175      <ulink url="http://www.angelikalanger.com/iostreams.html">Standard C++
176      IOStreams and Locales</ulink> by Langer and Kreft, ISBN 0-201-18395-1, and
177      <ulink url="http://www.josuttis.com/libbook/">The C++ Standard Library</ulink>
178      by Nicolai Josuttis, ISBN 0-201-37926-0.  Both are published by
179      Addison-Wesley, who isn't paying us a cent for saying that, honest.
180   </para>
181   <para>Here is a simple example, io/outbuf1, from the Josuttis text.  It
182      transforms everything sent through it to uppercase.  This version
183      assumes many things about the nature of the character type being
184      used (for more information, read the books or the newsgroups):
185   </para>
186   <programlisting>
187    #include &lt;iostream&gt;
188    #include &lt;streambuf&gt;
189    #include &lt;locale&gt;
190    #include &lt;cstdio&gt;
191
192    class outbuf : public std::streambuf
193    {
194      protected:
195	/* central output function
196	 * - print characters in uppercase mode
197	 */
198	virtual int_type overflow (int_type c) {
199	    if (c != EOF) {
200		// convert lowercase to uppercase
201		c = std::toupper(static_cast&lt;char&gt;(c),getloc());
202
203		// and write the character to the standard output
204		if (putchar(c) == EOF) {
205		    return EOF;
206		}
207	    }
208	    return c;
209	}
210    };
211
212    int main()
213    {
214	// create special output buffer
215	outbuf ob;
216	// initialize output stream with that output buffer
217	std::ostream out(&amp;ob);
218
219	out &lt;&lt; "31 hexadecimal: "
220	    &lt;&lt; std::hex &lt;&lt; 31 &lt;&lt; std::endl;
221	return 0;
222    }
223   </programlisting>
224   <para>Try it yourself!  More examples can be found in 3.1.x code, in
225      <code>include/ext/*_filebuf.h</code>, and in this article by James Kanze:
226      <ulink url="http://kanze.james.neuf.fr/articles/fltrsbf1.html">Filtering
227      Streambufs</ulink>.
228   </para>
229
230  </sect2>
231
232  <sect2 id="io.streambuf.buffering" xreflabel="Buffering">
233    <title>Buffering</title>
234   <para>First, are you sure that you understand buffering?  Chaptericularly
235      the fact that C++ may not, in fact, have anything to do with it?
236   </para>
237   <para>The rules for buffering can be a little odd, but they aren't any
238      different from those of C.  (Maybe that's why they can be a bit
239      odd.)  Many people think that writing a newline to an output
240      stream automatically flushes the output buffer.  This is true only
241      when the output stream is, in fact, a terminal and not a file
242      or some other device -- and <emphasis>that</emphasis> may not even be true
243      since C++ says nothing about files nor terminals.  All of that is
244      system-dependent.  (The &quot;newline-buffer-flushing only occurring
245      on terminals&quot; thing is mostly true on Unix systems, though.)
246   </para>
247   <para>Some people also believe that sending <code>endl</code> down an
248      output stream only writes a newline.  This is incorrect; after a
249      newline is written, the buffer is also flushed.  Perhaps this
250      is the effect you want when writing to a screen -- get the text
251      out as soon as possible, etc -- but the buffering is largely
252      wasted when doing this to a file:
253   </para>
254   <programlisting>
255   output &lt;&lt; &quot;a line of text&quot; &lt;&lt; endl;
256   output &lt;&lt; some_data_variable &lt;&lt; endl;
257   output &lt;&lt; &quot;another line of text&quot; &lt;&lt; endl; </programlisting>
258   <para>The proper thing to do in this case to just write the data out
259      and let the libraries and the system worry about the buffering.
260      If you need a newline, just write a newline:
261   </para>
262   <programlisting>
263   output &lt;&lt; &quot;a line of text\n&quot;
264	  &lt;&lt; some_data_variable &lt;&lt; '\n'
265	  &lt;&lt; &quot;another line of text\n&quot;; </programlisting>
266   <para>I have also joined the output statements into a single statement.
267      You could make the code prettier by moving the single newline to
268      the start of the quoted text on the last line, for example.
269   </para>
270   <para>If you do need to flush the buffer above, you can send an
271      <code>endl</code> if you also need a newline, or just flush the buffer
272      yourself:
273   </para>
274   <programlisting>
275   output &lt;&lt; ...... &lt;&lt; flush;    // can use std::flush manipulator
276   output.flush();               // or call a member fn </programlisting>
277   <para>On the other hand, there are times when writing to a file should
278      be like writing to standard error; no buffering should be done
279      because the data needs to appear quickly (a prime example is a
280      log file for security-related information).  The way to do this is
281      just to turn off the buffering <emphasis>before any I/O operations at
282      all</emphasis> have been done (note that opening counts as an I/O operation):
283   </para>
284   <programlisting>
285   std::ofstream    os;
286   std::ifstream    is;
287   int   i;
288
289   os.rdbuf()-&gt;pubsetbuf(0,0);
290   is.rdbuf()-&gt;pubsetbuf(0,0);
291
292   os.open(&quot;/foo/bar/baz&quot;);
293   is.open(&quot;/qux/quux/quuux&quot;);
294   ...
295   os &lt;&lt; &quot;this data is written immediately\n&quot;;
296   is &gt;&gt; i;   // and this will probably cause a disk read </programlisting>
297   <para>Since all aspects of buffering are handled by a streambuf-derived
298      member, it is necessary to get at that member with <code>rdbuf()</code>.
299      Then the public version of <code>setbuf</code> can be called.  The
300      arguments are the same as those for the Standard C I/O Library
301      function (a buffer area followed by its size).
302   </para>
303   <para>A great deal of this is implementation-dependent.  For example,
304      <code>streambuf</code> does not specify any actions for its own
305      <code>setbuf()</code>-ish functions; the classes derived from
306      <code>streambuf</code> each define behavior that &quot;makes
307      sense&quot; for that class:  an argument of (0,0) turns off buffering
308      for <code>filebuf</code> but does nothing at all for its siblings
309      <code>stringbuf</code> and <code>strstreambuf</code>, and specifying
310      anything other than (0,0) has varying effects.
311      User-defined classes derived from <code>streambuf</code> can
312      do whatever they want.  (For <code>filebuf</code> and arguments for
313      <code>(p,s)</code> other than zeros, libstdc++ does what you'd expect:
314      the first <code>s</code> bytes of <code>p</code> are used as a buffer,
315      which you must allocate and deallocate.)
316   </para>
317   <para>A last reminder:  there are usually more buffers involved than
318      just those at the language/library level.  Kernel buffers, disk
319      buffers, and the like will also have an effect.  Inspecting and
320      changing those are system-dependent.
321   </para>
322
323  </sect2>
324</sect1>
325
326<!-- Sect1 03 : Memory-based Streams -->
327<sect1 id="std.io.memstreams" xreflabel="Memory Streams">
328<?dbhtml filename="stringstreams.html"?>
329  <title>Memory Based Streams</title>
330  <sect2 id="std.io.memstreams.compat" xreflabel="Compatibility strstream">
331    <title>Compatibility With strstream</title>
332    <para>
333    </para>
334   <para>Stringstreams (defined in the header <code>&lt;sstream&gt;</code>)
335      are in this author's opinion one of the coolest things since
336      sliced time.  An example of their use is in the Received Wisdom
337      section for Sect1 21 (Strings),
338      <link linkend="strings.string.Cstring"> describing how to
339      format strings</link>.
340   </para>
341   <para>The quick definition is:  they are siblings of ifstream and ofstream,
342      and they do for <code>std::string</code> what their siblings do for
343      files.  All that work you put into writing <code>&lt;&lt;</code> and
344      <code>&gt;&gt;</code> functions for your classes now pays off
345      <emphasis>again!</emphasis>  Need to format a string before passing the string
346      to a function?  Send your stuff via <code>&lt;&lt;</code> to an
347      ostringstream.  You've read a string as input and need to parse it?
348      Initialize an istringstream with that string, and then pull pieces
349      out of it with <code>&gt;&gt;</code>.  Have a stringstream and need to
350      get a copy of the string inside?  Just call the <code>str()</code>
351      member function.
352   </para>
353   <para>This only works if you've written your
354      <code>&lt;&lt;</code>/<code>&gt;&gt;</code> functions correctly, though,
355      and correctly means that they take istreams and ostreams as
356      parameters, not i<emphasis>f</emphasis>streams and o<emphasis>f</emphasis>streams.  If they
357      take the latter, then your I/O operators will work fine with
358      file streams, but with nothing else -- including stringstreams.
359   </para>
360   <para>If you are a user of the strstream classes, you need to update
361      your code.  You don't have to explicitly append <code>ends</code> to
362      terminate the C-style character array, you don't have to mess with
363      &quot;freezing&quot; functions, and you don't have to manage the
364      memory yourself.  The strstreams have been officially deprecated,
365      which means that 1) future revisions of the C++ Standard won't
366      support them, and 2) if you use them, people will laugh at you.
367   </para>
368
369
370  </sect2>
371</sect1>
372
373<!-- Sect1 04 : File-based Streams -->
374<sect1 id="std.io.filestreams" xreflabel="File Streams">
375<?dbhtml filename="fstreams.html"?>
376  <title>File Based Streams</title>
377
378  <sect2 id="std.io.filestreams.copying_a_file" xreflabel="Copying a File">
379  <title>Copying a File</title>
380  <para>
381  </para>
382
383   <para>So you want to copy a file quickly and easily, and most important,
384      completely portably.  And since this is C++, you have an open
385      ifstream (call it IN) and an open ofstream (call it OUT):
386   </para>
387   <programlisting>
388   #include &lt;fstream&gt;
389
390   std::ifstream  IN ("input_file");
391   std::ofstream  OUT ("output_file"); </programlisting>
392   <para>Here's the easiest way to get it completely wrong:
393   </para>
394   <programlisting>
395   OUT &lt;&lt; IN;</programlisting>
396   <para>For those of you who don't already know why this doesn't work
397      (probably from having done it before), I invite you to quickly
398      create a simple text file called &quot;input_file&quot; containing
399      the sentence
400   </para>
401      <programlisting>
402      The quick brown fox jumped over the lazy dog.</programlisting>
403   <para>surrounded by blank lines.  Code it up and try it.  The contents
404      of &quot;output_file&quot; may surprise you.
405   </para>
406   <para>Seriously, go do it.  Get surprised, then come back.  It's worth it.
407   </para>
408   <para>The thing to remember is that the <code>basic_[io]stream</code> classes
409      handle formatting, nothing else.  In chaptericular, they break up on
410      whitespace.  The actual reading, writing, and storing of data is
411      handled by the <code>basic_streambuf</code> family.  Fortunately, the
412      <code>operator&lt;&lt;</code> is overloaded to take an ostream and
413      a pointer-to-streambuf, in order to help with just this kind of
414      &quot;dump the data verbatim&quot; situation.
415   </para>
416   <para>Why a <emphasis>pointer</emphasis> to streambuf and not just a streambuf?  Well,
417      the [io]streams hold pointers (or references, depending on the
418      implementation) to their buffers, not the actual
419      buffers.  This allows polymorphic behavior on the chapter of the buffers
420      as well as the streams themselves.  The pointer is easily retrieved
421      using the <code>rdbuf()</code> member function.  Therefore, the easiest
422      way to copy the file is:
423   </para>
424   <programlisting>
425   OUT &lt;&lt; IN.rdbuf();</programlisting>
426   <para>So what <emphasis>was</emphasis> happening with OUT&lt;&lt;IN?  Undefined
427      behavior, since that chaptericular &lt;&lt; isn't defined by the Standard.
428      I have seen instances where it is implemented, but the character
429      extraction process removes all the whitespace, leaving you with no
430      blank lines and only &quot;Thequickbrownfox...&quot;.  With
431      libraries that do not define that operator, IN (or one of IN's
432      member pointers) sometimes gets converted to a void*, and the output
433      file then contains a perfect text representation of a hexadecimal
434      address (quite a big surprise).  Others don't compile at all.
435   </para>
436   <para>Also note that none of this is specific to o<emphasis>*f*</emphasis>streams.
437      The operators shown above are all defined in the parent
438      basic_ostream class and are therefore available with all possible
439      descendants.
440   </para>
441
442  </sect2>
443
444  <sect2 id="std.io.filestreams.binary" xreflabel="Binary Input and Output">
445    <title>Binary Input and Output</title>
446    <para>
447    </para>
448   <para>The first and most important thing to remember about binary I/O is
449      that opening a file with <code>ios::binary</code> is not, repeat
450      <emphasis>not</emphasis>, the only thing you have to do.  It is not a silver
451      bullet, and will not allow you to use the <code>&lt;&lt;/&gt;&gt;</code>
452      operators of the normal fstreams to do binary I/O.
453   </para>
454   <para>Sorry.  Them's the breaks.
455   </para>
456   <para>This isn't going to try and be a complete tutorial on reading and
457      writing binary files (because &quot;binary&quot;
458      covers a lot of ground), but we will try and clear
459      up a couple of misconceptions and common errors.
460   </para>
461   <para>First, <code>ios::binary</code> has exactly one defined effect, no more
462      and no less.  Normal text mode has to be concerned with the newline
463      characters, and the runtime system will translate between (for
464      example) '\n' and the appropriate end-of-line sequence (LF on Unix,
465      CRLF on DOS, CR on Macintosh, etc).  (There are other things that
466      normal mode does, but that's the most obvious.)  Opening a file in
467      binary mode disables this conversion, so reading a CRLF sequence
468      under Windows won't accidentally get mapped to a '\n' character, etc.
469      Binary mode is not supposed to suddenly give you a bitstream, and
470      if it is doing so in your program then you've discovered a bug in
471      your vendor's compiler (or some other chapter of the C++ implementation,
472      possibly the runtime system).
473   </para>
474   <para>Second, using <code>&lt;&lt;</code> to write and <code>&gt;&gt;</code> to
475      read isn't going to work with the standard file stream classes, even
476      if you use <code>skipws</code> during reading.  Why not?  Because
477      ifstream and ofstream exist for the purpose of <emphasis>formatting</emphasis>,
478      not reading and writing.  Their job is to interpret the data into
479      text characters, and that's exactly what you don't want to happen
480      during binary I/O.
481   </para>
482   <para>Third, using the <code>get()</code> and <code>put()/write()</code> member
483      functions still aren't guaranteed to help you.  These are
484      &quot;unformatted&quot; I/O functions, but still character-based.
485      (This may or may not be what you want, see below.)
486   </para>
487   <para>Notice how all the problems here are due to the inappropriate use
488      of <emphasis>formatting</emphasis> functions and classes to perform something
489      which <emphasis>requires</emphasis> that formatting not be done?  There are a
490      seemingly infinite number of solutions, and a few are listed here:
491   </para>
492   <itemizedlist>
493      <listitem>
494	<para><quote>Derive your own fstream-type classes and write your own
495	  &lt;&lt;/&gt;&gt; operators to do binary I/O on whatever data
496	  types you're using.</quote>
497	</para>
498	<para>
499	  This is a Bad Thing, because while
500	  the compiler would probably be just fine with it, other humans
501	  are going to be confused.  The overloaded bitshift operators
502	  have a well-defined meaning (formatting), and this breaks it.
503	</para>
504      </listitem>
505      <listitem>
506	<para>
507	  <quote>Build the file structure in memory, then
508	  <code>mmap()</code> the file and copy the
509	  structure.
510	</quote>
511	</para>
512	<para>
513	  Well, this is easy to make work, and easy to break, and is
514	  pretty equivalent to using <code>::read()</code> and
515	  <code>::write()</code> directly, and makes no use of the
516	  iostream library at all...
517	  </para>
518      </listitem>
519      <listitem>
520	<para>
521	  <quote>Use streambufs, that's what they're there for.</quote>
522	</para>
523	<para>
524	  While not trivial for the beginner, this is the best of all
525	  solutions.  The streambuf/filebuf layer is the layer that is
526	  responsible for actual I/O.  If you want to use the C++
527	  library for binary I/O, this is where you start.
528	</para>
529      </listitem>
530   </itemizedlist>
531   <para>How to go about using streambufs is a bit beyond the scope of this
532      document (at least for now), but while streambufs go a long way,
533      they still leave a couple of things up to you, the programmer.
534      As an example, byte ordering is completely between you and the
535      operating system, and you have to handle it yourself.
536   </para>
537   <para>Deriving a streambuf or filebuf
538      class from the standard ones, one that is specific to your data
539      types (or an abstraction thereof) is probably a good idea, and
540      lots of examples exist in journals and on Usenet.  Using the
541      standard filebufs directly (either by declaring your own or by
542      using the pointer returned from an fstream's <code>rdbuf()</code>)
543      is certainly feasible as well.
544   </para>
545   <para>One area that causes problems is trying to do bit-by-bit operations
546      with filebufs.  C++ is no different from C in this respect:  I/O
547      must be done at the byte level.  If you're trying to read or write
548      a few bits at a time, you're going about it the wrong way.  You
549      must read/write an integral number of bytes and then process the
550      bytes.  (For example, the streambuf functions take and return
551      variables of type <code>int_type</code>.)
552   </para>
553   <para>Another area of problems is opening text files in binary mode.
554      Generally, binary mode is intended for binary files, and opening
555      text files in binary mode means that you now have to deal with all of
556      those end-of-line and end-of-file problems that we mentioned before.
557   </para>
558   <para>
559      An instructive thread from comp.lang.c++.moderated delved off into
560      this topic starting more or less at
561      <ulink url="http://groups.google.com/group/comp.std.c++/browse_thread/thread/f87b4abd7954a87/946a3eb9921e382d?q=comp.std.c%2B%2B+binary+iostream#946a3eb9921e382d">this</ulink>
562      post and continuing to the end of the thread. (The subject heading is &quot;binary iostreams&quot; on both comp.std.c++
563      and comp.lang.c++.moderated.) Take special note of the replies by James Kanze and Dietmar K&uuml;hl.
564   </para>
565    <para>Briefly, the problems of byte ordering and type sizes mean that
566      the unformatted functions like <code>ostream::put()</code> and
567      <code>istream::get()</code> cannot safely be used to communicate
568      between arbitrary programs, or across a network, or from one
569      invocation of a program to another invocation of the same program
570      on a different platform, etc.
571   </para>
572 </sect2>
573
574</sect1>
575
576<!-- Sect1 03 : Interacting with C -->
577<sect1 id="std.io.c" xreflabel="Interacting with C">
578<?dbhtml filename="io_and_c.html"?>
579  <title>Interacting with C</title>
580
581
582  <sect2 id="std.io.c.FILE" xreflabel="Using FILE* and file descriptors">
583    <title>Using FILE* and file descriptors</title>
584    <para>
585      See the <link linkend="manual.ext.io">extensions</link> for using
586      <type>FILE</type> and <type>file descriptors</type> with
587      <classname>ofstream</classname> and
588      <classname>ifstream</classname>.
589    </para>
590  </sect2>
591
592  <sect2 id="std.io.c.sync" xreflabel="Performance Issues">
593    <title>Performance</title>
594    <para>
595      Pathetic Performance? Ditch C.
596    </para>
597   <para>It sounds like a flame on C, but it isn't.  Really.  Calm down.
598      I'm just saying it to get your attention.
599   </para>
600   <para>Because the C++ library includes the C library, both C-style and
601      C++-style I/O have to work at the same time.  For example:
602   </para>
603   <programlisting>
604     #include &lt;iostream&gt;
605     #include &lt;cstdio&gt;
606
607     std::cout &lt;&lt; &quot;Hel&quot;;
608     std::printf (&quot;lo, worl&quot;);
609     std::cout &lt;&lt; &quot;d!\n&quot;;
610   </programlisting>
611   <para>This must do what you think it does.
612   </para>
613   <para>Alert members of the audience will immediately notice that buffering
614      is going to make a hash of the output unless special steps are taken.
615   </para>
616   <para>The special steps taken by libstdc++, at least for version 3.0,
617      involve doing very little buffering for the standard streams, leaving
618      most of the buffering to the underlying C library.  (This kind of
619      thing is tricky to get right.)
620      The upside is that correctness is ensured.  The downside is that
621      writing through <code>cout</code> can quite easily lead to awful
622      performance when the C++ I/O library is layered on top of the C I/O
623      library (as it is for 3.0 by default).  Some patches have been applied
624      which improve the situation for 3.1.
625   </para>
626   <para>However, the C and C++ standard streams only need to be kept in sync
627      when both libraries' facilities are in use.  If your program only uses
628      C++ I/O, then there's no need to sync with the C streams.  The right
629      thing to do in this case is to call
630   </para>
631   <programlisting>
632     #include <emphasis>any of the I/O headers such as ios, iostream, etc</emphasis>
633
634     std::ios::sync_with_stdio(false);
635   </programlisting>
636   <para>You must do this before performing any I/O via the C++ stream objects.
637      Once you call this, the C++ streams will operate independently of the
638      (unused) C streams.  For GCC 3.x, this means that <code>cout</code> and
639      company will become fully buffered on their own.
640   </para>
641   <para>Note, by the way, that the synchronization requirement only applies to
642      the standard streams (<code>cin</code>, <code>cout</code>,
643      <code>cerr</code>,
644      <code>clog</code>, and their wide-character counterchapters).  File stream
645      objects that you declare yourself have no such requirement and are fully
646      buffered.
647   </para>
648
649
650  </sect2>
651</sect1>
652
653</chapter>
654