<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>CVC3: fdstream.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">CVC3 <span id="projectnumber">2.4.1</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">fdstream.h</div> </div>
</div>
<div class="contents">
<a href="fdstream_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*! \file fdstream.h</span>
<a name="l00002"></a>00002 <span class="comment"> * @brief The following code declares classes to read from and write to</span>
<a name="l00003"></a>00003 <span class="comment"> * file descriptore or file handles.</span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * See</span>
<a name="l00006"></a>00006 <span class="comment"> * http://www.josuttis.com/cppcode</span>
<a name="l00007"></a>00007 <span class="comment"> * for details and the latest version.</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * - open:</span>
<a name="l00010"></a>00010 <span class="comment"> * - integrating BUFSIZ on some systems?</span>
<a name="l00011"></a>00011 <span class="comment"> * - optimized reading of multiple characters</span>
<a name="l00012"></a>00012 <span class="comment"> * - stream for reading AND writing</span>
<a name="l00013"></a>00013 <span class="comment"> * - i18n</span>
<a name="l00014"></a>00014 <span class="comment"> *</span>
<a name="l00015"></a>00015 <span class="comment"> * (C) Copyright Nicolai M. Josuttis 2001.</span>
<a name="l00016"></a>00016 <span class="comment"> * Permission to copy, use, modify, sell and distribute this software</span>
<a name="l00017"></a>00017 <span class="comment"> * is granted provided this copyright notice appears in all copies.</span>
<a name="l00018"></a>00018 <span class="comment"> * This software is provided "as is" without express or implied</span>
<a name="l00019"></a>00019 <span class="comment"> * warranty, and with no claim as to its suitability for any purpose.</span>
<a name="l00020"></a>00020 <span class="comment"> *</span>
<a name="l00021"></a>00021 <span class="comment"> * Version: Jul 28, 2002</span>
<a name="l00022"></a>00022 <span class="comment"> * History:</span>
<a name="l00023"></a>00023 <span class="comment"> * Jul 28, 2002: bugfix memcpy() => memmove()</span>
<a name="l00024"></a>00024 <span class="comment"> * fdinbuf::underflow(): cast for return statements</span>
<a name="l00025"></a>00025 <span class="comment"> * Aug 05, 2001: first public version</span>
<a name="l00026"></a>00026 <span class="comment"> */</span>
<a name="l00027"></a>00027 <span class="preprocessor">#ifndef BOOST_FDSTREAM_HPP</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span><span class="preprocessor">#define BOOST_FDSTREAM_HPP</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <istream></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <ostream></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <streambuf></span>
<a name="l00033"></a>00033 <span class="comment">// for EOF:</span>
<a name="l00034"></a>00034 <span class="preprocessor">#include <cstdio></span>
<a name="l00035"></a>00035 <span class="comment">// for memmove():</span>
<a name="l00036"></a>00036 <span class="preprocessor">#include <cstring></span>
<a name="l00037"></a>00037
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="comment">// low-level read and write functions</span>
<a name="l00040"></a>00040 <span class="preprocessor">#ifdef _MSC_VER</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor"># include <io.h></span>
<a name="l00042"></a>00042 <span class="preprocessor">#else</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor"># include <unistd.h></span>
<a name="l00044"></a>00044 <span class="comment">//extern "C" {</span>
<a name="l00045"></a>00045 <span class="comment">// int write (int fd, const char* buf, int num);</span>
<a name="l00046"></a>00046 <span class="comment">// int read (int fd, char* buf, int num);</span>
<a name="l00047"></a>00047 <span class="comment">//}</span>
<a name="l00048"></a>00048 <span class="preprocessor">#endif</span>
<a name="l00049"></a>00049 <span class="preprocessor"></span>
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="comment">// BEGIN namespace BOOST</span>
<a name="l00052"></a>00052 <span class="keyword">namespace </span>std {
<a name="l00053"></a>00053
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="comment">/************************************************************</span>
<a name="l00056"></a>00056 <span class="comment"> * fdostream</span>
<a name="l00057"></a>00057 <span class="comment"> * - a stream that writes on a file descriptor</span>
<a name="l00058"></a>00058 <span class="comment"> ************************************************************/</span>
<a name="l00059"></a>00059
<a name="l00060"></a>00060
<a name="l00061"></a><a class="code" href="classstd_1_1fdoutbuf.html">00061</a> <span class="keyword">class </span><a class="code" href="classstd_1_1fdoutbuf.html">fdoutbuf</a> : <span class="keyword">public</span> std::streambuf {
<a name="l00062"></a>00062 <span class="keyword">protected</span>:
<a name="l00063"></a><a class="code" href="classstd_1_1fdoutbuf.html#a7841f9fc9946834fef6c18aff5d39d3f">00063</a> <span class="keywordtype">int</span> <a class="code" href="classstd_1_1fdoutbuf.html#a7841f9fc9946834fef6c18aff5d39d3f">fd</a>; <span class="comment">// file descriptor</span>
<a name="l00064"></a>00064 <span class="keyword">public</span>:
<a name="l00065"></a>00065 <span class="comment">// constructor</span>
<a name="l00066"></a><a class="code" href="classstd_1_1fdoutbuf.html#a07d6a113e82ff68c8d28520917621235">00066</a> <a class="code" href="classstd_1_1fdoutbuf.html#a07d6a113e82ff68c8d28520917621235">fdoutbuf</a> (<span class="keywordtype">int</span> _fd) : <a class="code" href="classstd_1_1fdoutbuf.html#a7841f9fc9946834fef6c18aff5d39d3f">fd</a>(_fd) {
<a name="l00067"></a>00067 }
<a name="l00068"></a>00068 <span class="keyword">protected</span>:
<a name="l00069"></a>00069 <span class="comment">// write one character</span>
<a name="l00070"></a><a class="code" href="classstd_1_1fdoutbuf.html#ae716d47a80e05eac06f8d8c6d9b80efd">00070</a> <span class="keyword">virtual</span> int_type <a class="code" href="classstd_1_1fdoutbuf.html#ae716d47a80e05eac06f8d8c6d9b80efd">overflow</a> (int_type c) {
<a name="l00071"></a>00071 <span class="keywordflow">if</span> (c != EOF) {
<a name="l00072"></a>00072 <span class="keywordtype">char</span> z = c;
<a name="l00073"></a>00073 <span class="keywordflow">if</span> (write (<a class="code" href="classstd_1_1fdoutbuf.html#a7841f9fc9946834fef6c18aff5d39d3f">fd</a>, &z, 1) != 1) {
<a name="l00074"></a>00074 <span class="keywordflow">return</span> EOF;
<a name="l00075"></a>00075 }
<a name="l00076"></a>00076 }
<a name="l00077"></a>00077 <span class="keywordflow">return</span> c;
<a name="l00078"></a>00078 }
<a name="l00079"></a>00079 <span class="comment">// write multiple characters</span>
<a name="l00080"></a>00080 <span class="keyword">virtual</span>
<a name="l00081"></a><a class="code" href="classstd_1_1fdoutbuf.html#a9f2e5d6e6a9aa3cfe375524f3bf2ff0b">00081</a> std::streamsize <a class="code" href="classstd_1_1fdoutbuf.html#a9f2e5d6e6a9aa3cfe375524f3bf2ff0b">xsputn</a> (<span class="keyword">const</span> <span class="keywordtype">char</span>* s,
<a name="l00082"></a>00082 std::streamsize num) {
<a name="l00083"></a>00083 <span class="keywordflow">return</span> write(<a class="code" href="classstd_1_1fdoutbuf.html#a7841f9fc9946834fef6c18aff5d39d3f">fd</a>,s,num);
<a name="l00084"></a>00084 }
<a name="l00085"></a>00085 };
<a name="l00086"></a>00086
<a name="l00087"></a><a class="code" href="classstd_1_1fdostream.html">00087</a> <span class="keyword">class </span><a class="code" href="classstd_1_1fdostream.html">fdostream</a> : <span class="keyword">public</span> std::ostream {
<a name="l00088"></a>00088 <span class="keyword">protected</span>:
<a name="l00089"></a><a class="code" href="classstd_1_1fdostream.html#ac63de0f0adad07b87f6016b3d28fd133">00089</a> <a class="code" href="classstd_1_1fdoutbuf.html">fdoutbuf</a> <a class="code" href="classstd_1_1fdostream.html#ac63de0f0adad07b87f6016b3d28fd133">buf</a>;
<a name="l00090"></a>00090 <span class="keyword">public</span>:
<a name="l00091"></a><a class="code" href="classstd_1_1fdostream.html#a66d3a69bc255050f90f87a865e4ad8ca">00091</a> <a class="code" href="classstd_1_1fdostream.html#a66d3a69bc255050f90f87a865e4ad8ca">fdostream</a> (<span class="keywordtype">int</span> fd) : std::ostream(0), <a class="code" href="classstd_1_1fdostream.html#ac63de0f0adad07b87f6016b3d28fd133">buf</a>(fd) {
<a name="l00092"></a>00092 rdbuf(&<a class="code" href="classstd_1_1fdostream.html#ac63de0f0adad07b87f6016b3d28fd133">buf</a>);
<a name="l00093"></a>00093 }
<a name="l00094"></a>00094 };
<a name="l00095"></a>00095
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="comment">/************************************************************</span>
<a name="l00098"></a>00098 <span class="comment"> * fdistream</span>
<a name="l00099"></a>00099 <span class="comment"> * - a stream that reads on a file descriptor</span>
<a name="l00100"></a>00100 <span class="comment"> ************************************************************/</span>
<a name="l00101"></a>00101
<a name="l00102"></a><a class="code" href="classstd_1_1fdinbuf.html">00102</a> <span class="keyword">class </span><a class="code" href="classstd_1_1fdinbuf.html">fdinbuf</a> : <span class="keyword">public</span> std::streambuf {
<a name="l00103"></a>00103 <span class="keyword">protected</span>:
<a name="l00104"></a><a class="code" href="classstd_1_1fdinbuf.html#afbb67f83be6cf75d2eee7001feccadf0">00104</a> <span class="keywordtype">int</span> <a class="code" href="classstd_1_1fdinbuf.html#afbb67f83be6cf75d2eee7001feccadf0">fd</a>; <span class="comment">// file descriptor</span>
<a name="l00105"></a>00105 <span class="keyword">protected</span>:
<a name="l00106"></a>00106 <span class="comment">/* data buffer:</span>
<a name="l00107"></a>00107 <span class="comment"> * - at most, pbSize characters in putback area plus</span>
<a name="l00108"></a>00108 <span class="comment"> * - at most, bufSize characters in ordinary read buffer</span>
<a name="l00109"></a>00109 <span class="comment"> */</span>
<a name="l00110"></a><a class="code" href="classstd_1_1fdinbuf.html#a794741366eee0473eacf24a194e453d5">00110</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classstd_1_1fdinbuf.html#a794741366eee0473eacf24a194e453d5">pbSize</a> = 4; <span class="comment">// size of putback area</span>
<a name="l00111"></a><a class="code" href="classstd_1_1fdinbuf.html#a1ad9c07e2d54a707b532b5a764447b43">00111</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classstd_1_1fdinbuf.html#a1ad9c07e2d54a707b532b5a764447b43">bufSize</a> = 1024; <span class="comment">// size of the data buffer</span>
<a name="l00112"></a><a class="code" href="classstd_1_1fdinbuf.html#ad722d71cdb24ec1b2dbefa66b63508b7">00112</a> <span class="keywordtype">char</span> <a class="code" href="classstd_1_1fdinbuf.html#ad722d71cdb24ec1b2dbefa66b63508b7">buffer</a>[<a class="code" href="classstd_1_1fdinbuf.html#a1ad9c07e2d54a707b532b5a764447b43">bufSize</a>+<a class="code" href="classstd_1_1fdinbuf.html#a794741366eee0473eacf24a194e453d5">pbSize</a>]; <span class="comment">// data buffer</span>
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="keyword">public</span>:
<a name="l00115"></a>00115 <span class="comment">/* constructor</span>
<a name="l00116"></a>00116 <span class="comment"> * - initialize file descriptor</span>
<a name="l00117"></a>00117 <span class="comment"> * - initialize empty data buffer</span>
<a name="l00118"></a>00118 <span class="comment"> * - no putback area</span>
<a name="l00119"></a>00119 <span class="comment"> * => force underflow()</span>
<a name="l00120"></a>00120 <span class="comment"> */</span>
<a name="l00121"></a><a class="code" href="classstd_1_1fdinbuf.html#a8c17fd985fad9718d9a249e4ee31d0a1">00121</a> <a class="code" href="classstd_1_1fdinbuf.html#a8c17fd985fad9718d9a249e4ee31d0a1">fdinbuf</a> (<span class="keywordtype">int</span> _fd) : <a class="code" href="classstd_1_1fdinbuf.html#afbb67f83be6cf75d2eee7001feccadf0">fd</a>(_fd) {
<a name="l00122"></a>00122 setg (<a class="code" href="classstd_1_1fdinbuf.html#ad722d71cdb24ec1b2dbefa66b63508b7">buffer</a>+<a class="code" href="classstd_1_1fdinbuf.html#a794741366eee0473eacf24a194e453d5">pbSize</a>, <span class="comment">// beginning of putback area</span>
<a name="l00123"></a>00123 <a class="code" href="classstd_1_1fdinbuf.html#ad722d71cdb24ec1b2dbefa66b63508b7">buffer</a>+<a class="code" href="classstd_1_1fdinbuf.html#a794741366eee0473eacf24a194e453d5">pbSize</a>, <span class="comment">// read position</span>
<a name="l00124"></a>00124 <a class="code" href="classstd_1_1fdinbuf.html#ad722d71cdb24ec1b2dbefa66b63508b7">buffer</a>+<a class="code" href="classstd_1_1fdinbuf.html#a794741366eee0473eacf24a194e453d5">pbSize</a>); <span class="comment">// end position</span>
<a name="l00125"></a>00125 }
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <span class="keyword">protected</span>:
<a name="l00128"></a>00128 <span class="comment">// insert new characters into the buffer</span>
<a name="l00129"></a><a class="code" href="classstd_1_1fdinbuf.html#a0ec8bd416990c0f15ed57b4bb970290a">00129</a> <span class="keyword">virtual</span> int_type <a class="code" href="classstd_1_1fdinbuf.html#a0ec8bd416990c0f15ed57b4bb970290a">underflow</a> () {
<a name="l00130"></a>00130 <span class="preprocessor">#ifndef _MSC_VER</span>
<a name="l00131"></a>00131 <span class="preprocessor"></span> <span class="keyword">using</span> std::memmove;
<a name="l00132"></a>00132 <span class="preprocessor">#endif</span>
<a name="l00133"></a>00133 <span class="preprocessor"></span>
<a name="l00134"></a>00134 <span class="comment">// is read position before end of buffer?</span>
<a name="l00135"></a>00135 <span class="keywordflow">if</span> (gptr() < egptr()) {
<a name="l00136"></a>00136 <span class="keywordflow">return</span> traits_type::to_int_type(*gptr());
<a name="l00137"></a>00137 }
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="comment">/* process size of putback area</span>
<a name="l00140"></a>00140 <span class="comment"> * - use number of characters read</span>
<a name="l00141"></a>00141 <span class="comment"> * - but at most size of putback area</span>
<a name="l00142"></a>00142 <span class="comment"> */</span>
<a name="l00143"></a>00143 <span class="keywordtype">int</span> numPutback;
<a name="l00144"></a>00144 numPutback = gptr() - eback();
<a name="l00145"></a>00145 <span class="keywordflow">if</span> (numPutback > <a class="code" href="classstd_1_1fdinbuf.html#a794741366eee0473eacf24a194e453d5">pbSize</a>) {
<a name="l00146"></a>00146 numPutback = <a class="code" href="classstd_1_1fdinbuf.html#a794741366eee0473eacf24a194e453d5">pbSize</a>;
<a name="l00147"></a>00147 }
<a name="l00148"></a>00148
<a name="l00149"></a>00149 <span class="comment">/* copy up to pbSize characters previously read into</span>
<a name="l00150"></a>00150 <span class="comment"> * the putback area</span>
<a name="l00151"></a>00151 <span class="comment"> */</span>
<a name="l00152"></a>00152 memmove (<a class="code" href="classstd_1_1fdinbuf.html#ad722d71cdb24ec1b2dbefa66b63508b7">buffer</a>+(<a class="code" href="classstd_1_1fdinbuf.html#a794741366eee0473eacf24a194e453d5">pbSize</a>-numPutback), gptr()-numPutback,
<a name="l00153"></a>00153 numPutback);
<a name="l00154"></a>00154
<a name="l00155"></a>00155 <span class="comment">// read at most bufSize new characters</span>
<a name="l00156"></a>00156 <span class="keywordtype">int</span> num;
<a name="l00157"></a>00157 num = read (<a class="code" href="classstd_1_1fdinbuf.html#afbb67f83be6cf75d2eee7001feccadf0">fd</a>, <a class="code" href="classstd_1_1fdinbuf.html#ad722d71cdb24ec1b2dbefa66b63508b7">buffer</a>+<a class="code" href="classstd_1_1fdinbuf.html#a794741366eee0473eacf24a194e453d5">pbSize</a>, <a class="code" href="classstd_1_1fdinbuf.html#a1ad9c07e2d54a707b532b5a764447b43">bufSize</a>);
<a name="l00158"></a>00158 <span class="keywordflow">if</span> (num <= 0) {
<a name="l00159"></a>00159 <span class="comment">// ERROR or EOF</span>
<a name="l00160"></a>00160 <span class="keywordflow">return</span> EOF;
<a name="l00161"></a>00161 }
<a name="l00162"></a>00162
<a name="l00163"></a>00163 <span class="comment">// reset buffer pointers</span>
<a name="l00164"></a>00164 setg (<a class="code" href="classstd_1_1fdinbuf.html#ad722d71cdb24ec1b2dbefa66b63508b7">buffer</a>+(<a class="code" href="classstd_1_1fdinbuf.html#a794741366eee0473eacf24a194e453d5">pbSize</a>-numPutback), <span class="comment">// beginning of putback area</span>
<a name="l00165"></a>00165 <a class="code" href="classstd_1_1fdinbuf.html#ad722d71cdb24ec1b2dbefa66b63508b7">buffer</a>+<a class="code" href="classstd_1_1fdinbuf.html#a794741366eee0473eacf24a194e453d5">pbSize</a>, <span class="comment">// read position</span>
<a name="l00166"></a>00166 <a class="code" href="classstd_1_1fdinbuf.html#ad722d71cdb24ec1b2dbefa66b63508b7">buffer</a>+<a class="code" href="classstd_1_1fdinbuf.html#a794741366eee0473eacf24a194e453d5">pbSize</a>+num); <span class="comment">// end of buffer</span>
<a name="l00167"></a>00167
<a name="l00168"></a>00168 <span class="comment">// return next character</span>
<a name="l00169"></a>00169 <span class="keywordflow">return</span> traits_type::to_int_type(*gptr());
<a name="l00170"></a>00170 }
<a name="l00171"></a>00171 };
<a name="l00172"></a>00172
<a name="l00173"></a><a class="code" href="classstd_1_1fdistream.html">00173</a> <span class="keyword">class </span><a class="code" href="classstd_1_1fdistream.html">fdistream</a> : <span class="keyword">public</span> std::istream {
<a name="l00174"></a>00174 <span class="keyword">protected</span>:
<a name="l00175"></a><a class="code" href="classstd_1_1fdistream.html#a26b53ffa63279eec770d4bec9f10d3b2">00175</a> <a class="code" href="classstd_1_1fdinbuf.html">fdinbuf</a> <a class="code" href="classstd_1_1fdistream.html#a26b53ffa63279eec770d4bec9f10d3b2">buf</a>;
<a name="l00176"></a>00176 <span class="keyword">public</span>:
<a name="l00177"></a><a class="code" href="classstd_1_1fdistream.html#a2617ced530f049add473d189c88f4ebc">00177</a> <a class="code" href="classstd_1_1fdistream.html#a2617ced530f049add473d189c88f4ebc">fdistream</a> (<span class="keywordtype">int</span> fd) : std::istream(0), <a class="code" href="classstd_1_1fdistream.html#a26b53ffa63279eec770d4bec9f10d3b2">buf</a>(fd) {
<a name="l00178"></a>00178 rdbuf(&<a class="code" href="classstd_1_1fdistream.html#a26b53ffa63279eec770d4bec9f10d3b2">buf</a>);
<a name="l00179"></a>00179 }
<a name="l00180"></a>00180 };
<a name="l00181"></a>00181
<a name="l00182"></a>00182
<a name="l00183"></a>00183 } <span class="comment">// END namespace boost</span>
<a name="l00184"></a>00184
<a name="l00185"></a>00185 <span class="preprocessor">#endif </span><span class="comment">/*BOOST_FDSTREAM_HPP*/</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Sep 7 2011 for CVC3 by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
