<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>edelib: edelib/File.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">edelib  <span id="projectnumber">2.0.0</span> </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.7.6.1 --> <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> </ul> </div> </div> <div class="header"> <div class="headertitle"> <div class="title">edelib/File.h</div> </div> </div><!--header--> <div class="contents"> <div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment"> * $Id: File.h 2967 2009-12-02 14:31:34Z karijes $</span> <a name="l00003"></a>00003 <span class="comment"> *</span> <a name="l00004"></a>00004 <span class="comment"> * File IO stream</span> <a name="l00005"></a>00005 <span class="comment"> * Copyright (c) 2005-2007 edelib authors</span> <a name="l00006"></a>00006 <span class="comment"> *</span> <a name="l00007"></a>00007 <span class="comment"> * This library is free software; you can redistribute it and/or</span> <a name="l00008"></a>00008 <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span> <a name="l00009"></a>00009 <span class="comment"> * License as published by the Free Software Foundation; either</span> <a name="l00010"></a>00010 <span class="comment"> * version 2 of the License, or (at your option) any later version.</span> <a name="l00011"></a>00011 <span class="comment"> *</span> <a name="l00012"></a>00012 <span class="comment"> * This library is distributed in the hope that it will be useful,</span> <a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span> <a name="l00015"></a>00015 <span class="comment"> * Lesser General Public License for more details.</span> <a name="l00016"></a>00016 <span class="comment"> *</span> <a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU Lesser General Public License</span> <a name="l00018"></a>00018 <span class="comment"> * along with this library. If not, see <http://www.gnu.org/licenses/>.</span> <a name="l00019"></a>00019 <span class="comment"> */</span> <a name="l00020"></a>00020 <a name="l00021"></a>00021 <span class="preprocessor">#ifndef __EDELIB_FILE_H__</span> <a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define __EDELIB_FILE_H__</span> <a name="l00023"></a>00023 <span class="preprocessor"></span> <a name="l00024"></a>00024 <span class="preprocessor">#include <stdio.h></span> <a name="l00025"></a>00025 <span class="preprocessor">#include "String.h"</span> <a name="l00026"></a>00026 <a name="l00027"></a>00027 EDELIB_NS_BEGIN <a name="l00028"></a>00028 <a name="l00033"></a><a class="code" href="namespaceedelib.html#ad211e853fcabbe36449f29642fb59114">00033</a> <span class="keyword">enum</span> <a class="code" href="namespaceedelib.html#ad211e853fcabbe36449f29642fb59114" title="Error codes returned by File class.">FileErrors</a> { <a name="l00034"></a><a class="code" href="namespaceedelib.html#ad211e853fcabbe36449f29642fb59114a72bd77b523cfa4452c18282bcbb849dd">00034</a> <a class="code" href="namespaceedelib.html#ad211e853fcabbe36449f29642fb59114a72bd77b523cfa4452c18282bcbb849dd" title="successful operation">FILE_SUCCESS</a> = 0, <a name="l00035"></a><a class="code" href="namespaceedelib.html#ad211e853fcabbe36449f29642fb59114a663718d82f871a7e8e53c03aa557c22c">00035</a> <a class="code" href="namespaceedelib.html#ad211e853fcabbe36449f29642fb59114a663718d82f871a7e8e53c03aa557c22c" title="permission denied">FILE_EACCESS</a>, <a name="l00036"></a><a class="code" href="namespaceedelib.html#ad211e853fcabbe36449f29642fb59114aad1f5be3b181e47b6ad89e0cfbdc28a8">00036</a> <a class="code" href="namespaceedelib.html#ad211e853fcabbe36449f29642fb59114aad1f5be3b181e47b6ad89e0cfbdc28a8" title="no such file">FILE_ENOENT</a>, <a name="l00037"></a><a class="code" href="namespaceedelib.html#ad211e853fcabbe36449f29642fb59114ab9ff5f5ef1870e3eb12a3a9e902e15a5">00037</a> <a class="code" href="namespaceedelib.html#ad211e853fcabbe36449f29642fb59114ab9ff5f5ef1870e3eb12a3a9e902e15a5" title="too many opened files">FILE_EMFILE</a>, <a name="l00038"></a><a class="code" href="namespaceedelib.html#ad211e853fcabbe36449f29642fb59114a835a1fcd995435b7c3e592b847810bb3">00038</a> <a class="code" href="namespaceedelib.html#ad211e853fcabbe36449f29642fb59114a835a1fcd995435b7c3e592b847810bb3" title="no space left on device">FILE_ENSPC</a>, <a name="l00039"></a><a class="code" href="namespaceedelib.html#ad211e853fcabbe36449f29642fb59114af7d6d54754b1a2afa177129defa0177e">00039</a> <a class="code" href="namespaceedelib.html#ad211e853fcabbe36449f29642fb59114af7d6d54754b1a2afa177129defa0177e" title="bad flag">FILE_FLAG</a> <a name="l00040"></a>00040 }; <a name="l00041"></a>00041 <a name="l00046"></a><a class="code" href="namespaceedelib.html#af88b067682dd1949588373ef65b159fb">00046</a> <span class="keyword">enum</span> <a class="code" href="namespaceedelib.html#af88b067682dd1949588373ef65b159fb" title="Open and write flags for File class.">FileIOMode</a> { <a name="l00047"></a><a class="code" href="namespaceedelib.html#af88b067682dd1949588373ef65b159fbac15cbb3a5cad099d083c457ddf43c666">00047</a> <a class="code" href="namespaceedelib.html#af88b067682dd1949588373ef65b159fbac15cbb3a5cad099d083c457ddf43c666" title="open file in read-only mode">FIO_READ</a> = (1<<1), <a name="l00048"></a><a class="code" href="namespaceedelib.html#af88b067682dd1949588373ef65b159fba462b50a1cb87bd29bbdd02ba4640633c">00048</a> FIO_WRITE = (1<<2), <a name="l00049"></a><a class="code" href="namespaceedelib.html#af88b067682dd1949588373ef65b159fbafd8162249125530eee4b3840c4836843">00049</a> <a class="code" href="namespaceedelib.html#af88b067682dd1949588373ef65b159fbafd8162249125530eee4b3840c4836843" title="open file in append mode">FIO_APPEND</a> = (1<<3), <a name="l00050"></a><a class="code" href="namespaceedelib.html#af88b067682dd1949588373ef65b159fbad98481f7f40de4202b3765494945641e">00050</a> FIO_BINARY = (1<<4), <a name="l00051"></a><a class="code" href="namespaceedelib.html#af88b067682dd1949588373ef65b159fba1eb6bdb1f051b8644a0da3d6dc82368f">00051</a> <a class="code" href="namespaceedelib.html#af88b067682dd1949588373ef65b159fba1eb6bdb1f051b8644a0da3d6dc82368f" title="truncate currently opened file">FIO_TRUNC</a> = (1<<5) <a name="l00052"></a>00052 }; <a name="l00053"></a>00053 <a name="l00074"></a><a class="code" href="classedelib_1_1File.html">00074</a> <span class="keyword">class </span>EDELIB_API <a class="code" href="classedelib_1_1File.html" title="A system file io stream.">File</a> { <a name="l00075"></a>00075 <span class="keyword">private</span>: <a name="l00076"></a>00076 FILE* fobj; <a name="l00077"></a>00077 <span class="keywordtype">char</span>* fname; <a name="l00078"></a>00078 <span class="keywordtype">int</span> fmode; <a name="l00079"></a>00079 <span class="keywordtype">int</span> errcode; <a name="l00080"></a>00080 <span class="keywordtype">bool</span> opened; <a name="l00081"></a>00081 <span class="keywordtype">bool</span> alloc; <a name="l00082"></a>00082 <a name="l00083"></a>00083 <a class="code" href="classedelib_1_1File.html" title="A system file io stream.">File</a>(<span class="keyword">const</span> <a class="code" href="classedelib_1_1File.html" title="A system file io stream.">File</a>&); <a name="l00084"></a>00084 <a class="code" href="classedelib_1_1File.html" title="A system file io stream.">File</a>& operator=(<a class="code" href="classedelib_1_1File.html" title="A system file io stream.">File</a>&); <a name="l00085"></a>00085 <a name="l00086"></a>00086 <span class="keyword">public</span>: <a name="l00090"></a>00090 <a class="code" href="classedelib_1_1File.html" title="A system file io stream.">File</a>(); <a name="l00091"></a>00091 <a name="l00098"></a>00098 <a class="code" href="classedelib_1_1File.html" title="A system file io stream.">File</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* n, <span class="keywordtype">int</span> m); <a name="l00099"></a>00099 <a name="l00104"></a>00104 ~<a class="code" href="classedelib_1_1File.html" title="A system file io stream.">File</a>(); <a name="l00105"></a>00105 <a name="l00112"></a>00112 <span class="keywordtype">bool</span> open(<span class="keyword">const</span> <span class="keywordtype">char</span>* fname, <span class="keywordtype">int</span> mode = <a class="code" href="namespaceedelib.html#af88b067682dd1949588373ef65b159fbac15cbb3a5cad099d083c457ddf43c666" title="open file in read-only mode">FIO_READ</a>); <a name="l00113"></a>00113 <a name="l00119"></a>00119 <span class="keywordtype">void</span> close(<span class="keywordtype">void</span>); <a name="l00120"></a>00120 <a name="l00127"></a>00127 <span class="keyword">const</span> <span class="keywordtype">char</span>* name(<span class="keywordtype">void</span>) <span class="keyword">const</span>; <a name="l00128"></a>00128 <a name="l00134"></a>00134 <span class="keywordtype">bool</span> eof(<span class="keywordtype">void</span>); <a name="l00135"></a>00135 <a name="l00141"></a>00141 <span class="keywordtype">int</span> getch(<span class="keywordtype">void</span>); <a name="l00142"></a>00142 <a name="l00151"></a>00151 <span class="keywordtype">int</span> read(<span class="keywordtype">void</span>* buff, <span class="keywordtype">int</span> typesz, <span class="keywordtype">int</span> buffsz); <a name="l00152"></a>00152 <a name="l00166"></a>00166 <span class="keywordtype">int</span> readline(<span class="keywordtype">char</span>* buff, <span class="keywordtype">int</span> buffsz); <a name="l00167"></a>00167 <a name="l00173"></a>00173 <span class="keywordtype">int</span> putch(<span class="keywordtype">int</span> c); <a name="l00174"></a>00174 <a name="l00183"></a>00183 <span class="keywordtype">int</span> write(<span class="keyword">const</span> <span class="keywordtype">void</span>* buff, <span class="keywordtype">int</span> typesz, <span class="keywordtype">int</span> buffsz); <a name="l00184"></a>00184 <a name="l00192"></a>00192 <span class="keywordtype">int</span> write(<span class="keyword">const</span> <span class="keywordtype">char</span>* buff, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> buffsz); <a name="l00193"></a>00193 <a name="l00197"></a>00197 <span class="keywordtype">int</span> write(<span class="keyword">const</span> <span class="keywordtype">char</span>* buff); <a name="l00198"></a>00198 <a name="l00204"></a>00204 <span class="keywordtype">int</span> printf(<span class="keyword">const</span> <span class="keywordtype">char</span>* fmt, ...); <a name="l00205"></a>00205 }; <a name="l00206"></a>00206 <a name="l00212"></a>00212 EDELIB_API <span class="keywordtype">bool</span> <a class="code" href="classedelib_1_1File.html#a08154d2484b918ec2952f55843b05c88">file_exists</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name) EDELIB_DEPRECATED; <a name="l00213"></a>00213 <a name="l00219"></a>00219 EDELIB_API <span class="keywordtype">bool</span> <a class="code" href="classedelib_1_1File.html#aba2158a09bd27f9e8b84fa44ce462939">file_readable</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name) EDELIB_DEPRECATED; <a name="l00220"></a>00220 <a name="l00226"></a>00226 EDELIB_API <span class="keywordtype">bool</span> <a class="code" href="classedelib_1_1File.html#a01375d48cd88a9d2e54e4a4aa37dc563">file_writeable</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name) EDELIB_DEPRECATED; <a name="l00227"></a>00227 <a name="l00228"></a>00228 <a name="l00234"></a>00234 EDELIB_API <span class="keywordtype">bool</span> <a class="code" href="classedelib_1_1File.html#ad184cc1a2bc299e0e0699b147f51477a">file_executable</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name) EDELIB_DEPRECATED; <a name="l00235"></a>00235 <a name="l00245"></a>00245 EDELIB_API <span class="keywordtype">bool</span> <a class="code" href="classedelib_1_1File.html#a085a557b72965124eb8b8c3065885ac7">file_remove</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name); <a name="l00246"></a>00246 <a name="l00266"></a>00266 EDELIB_API <span class="keywordtype">bool</span> <a class="code" href="classedelib_1_1File.html#a22d18d1f8b422ab933e02178d820ab52">file_copy</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* src, <span class="keyword">const</span> <span class="keywordtype">char</span>* dest, <span class="keywordtype">bool</span> exact = <span class="keyword">false</span>); <a name="l00267"></a>00267 <a name="l00275"></a>00275 EDELIB_API <span class="keywordtype">bool</span> <a class="code" href="classedelib_1_1File.html#ad388ef22307c342e057b7b3f648bd4e8">file_rename</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* from, <span class="keyword">const</span> <span class="keywordtype">char</span>* to); <a name="l00276"></a>00276 <a name="l00294"></a>00294 EDELIB_API <a class="code" href="classedelib_1_1String.html" title="A (relatively simple) string implementation.">String</a> <a class="code" href="classedelib_1_1File.html#ac1e64c0ef91d7579d8d86c8a834ce7be">file_path</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* fname, <span class="keywordtype">bool</span> skip_link = <span class="keyword">false</span>); <a name="l00295"></a>00295 <a name="l00296"></a>00296 EDELIB_NS_END <a name="l00297"></a>00297 <span class="preprocessor">#endif</span> </pre></div></div><!-- contents --> <hr class="footer"/><address class="footer"><small> Generated on Tue Jun 5 2012 17:49:02 for edelib by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.7.6.1 </small></address> </body> </html>