<!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>ucommon: ucommon/fsys.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.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<h1>ucommon/fsys.h</h1><a href="a00185.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (C) 2006-2010 David Sugar, Tycho Softworks.</span>
<a name="l00002"></a>00002 <span class="comment">//</span>
<a name="l00003"></a>00003 <span class="comment">// This file is part of GNU uCommon C++.</span>
<a name="l00004"></a>00004 <span class="comment">//</span>
<a name="l00005"></a>00005 <span class="comment">// GNU uCommon C++ is free software: you can redistribute it and/or modify</span>
<a name="l00006"></a>00006 <span class="comment">// it under the terms of the GNU Lesser General Public License as published</span>
<a name="l00007"></a>00007 <span class="comment">// by the Free Software Foundation, either version 3 of the License, or</span>
<a name="l00008"></a>00008 <span class="comment">// (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment">//</span>
<a name="l00010"></a>00010 <span class="comment">// GNU uCommon C++ is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00013"></a>00013 <span class="comment">// GNU Lesser General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment">//</span>
<a name="l00015"></a>00015 <span class="comment">// You should have received a copy of the GNU Lesser General Public License</span>
<a name="l00016"></a>00016 <span class="comment">// along with GNU uCommon C++. If not, see <http://www.gnu.org/licenses/>.</span>
<a name="l00017"></a>00017
<a name="l00027"></a>00027 <span class="preprocessor">#ifndef _UCOMMON_FILE_H_</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span><span class="preprocessor">#define _UCOMMON_FILE_H_</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span>
<a name="l00030"></a>00030 <span class="preprocessor">#ifndef _UCOMMON_CONFIG_H_</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#include <<a class="code" href="a00194.html" title="Various miscellaneous platform specific headers and defines.">ucommon/platform.h</a>></span>
<a name="l00032"></a>00032 <span class="preprocessor">#endif</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span>
<a name="l00034"></a>00034 <span class="preprocessor">#ifndef _UCOMMON_PROTOCOLS_H_</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span><span class="preprocessor">#include <<a class="code" href="a00195.html" title="Abstract interfaces and support.">ucommon/protocols.h</a>></span>
<a name="l00036"></a>00036 <span class="preprocessor">#endif</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span>
<a name="l00038"></a>00038 <span class="preprocessor">#ifndef _UCOMMON_THREAD_H_</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#include <<a class="code" href="a00202.html" title="Thread classes and sychronization objects.">ucommon/thread.h</a>></span>
<a name="l00040"></a>00040 <span class="preprocessor">#endif</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span>
<a name="l00042"></a>00042 <span class="preprocessor">#ifndef _UCOMMON_STRING_H_</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor">#include <<a class="code" href="a00201.html" title="A common string class and character string support functions.">ucommon/string.h</a>></span>
<a name="l00044"></a>00044 <span class="preprocessor">#endif</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span>
<a name="l00046"></a>00046 <span class="preprocessor">#ifndef _MSWINDOWS_</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor">#include <sys/stat.h></span>
<a name="l00048"></a>00048 <span class="preprocessor">#else</span>
<a name="l00049"></a>00049 <span class="preprocessor"></span><span class="preprocessor">#include <io.h></span>
<a name="l00050"></a>00050 <span class="preprocessor">#ifndef R_OK</span>
<a name="l00051"></a>00051 <span class="preprocessor"></span><span class="preprocessor">#define F_OK 0</span>
<a name="l00052"></a>00052 <span class="preprocessor"></span><span class="preprocessor">#define X_OK 1</span>
<a name="l00053"></a>00053 <span class="preprocessor"></span><span class="preprocessor">#define W_OK 2</span>
<a name="l00054"></a>00054 <span class="preprocessor"></span><span class="preprocessor">#define R_OK 4</span>
<a name="l00055"></a>00055 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00056"></a>00056 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00057"></a>00057 <span class="preprocessor"></span>
<a name="l00058"></a>00058 <span class="preprocessor">#include <errno.h></span>
<a name="l00059"></a>00059 <span class="preprocessor">#include <stdio.h></span>
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="preprocessor">#ifndef __S_ISTYPE</span>
<a name="l00062"></a>00062 <span class="preprocessor"></span><span class="preprocessor">#define __S_ISTYPE(mode, mask) (((mode) & S_IFMT) == (mask))</span>
<a name="l00063"></a>00063 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00064"></a>00064 <span class="preprocessor"></span>
<a name="l00065"></a><a class="code" href="a00208.html#a99d0265119ce8940834ef128ce145daf">00065</a> <span class="preprocessor">#if !defined(S_ISDIR) && defined(S_IFDIR)</span>
<a name="l00066"></a>00066 <span class="preprocessor"></span><span class="preprocessor">#define S_ISDIR(mode) __S_ISTYPE((mode), S_IFDIR)</span>
<a name="l00067"></a>00067 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00068"></a>00068 <span class="preprocessor"></span>
<a name="l00069"></a>00069 <span class="preprocessor">#if !defined(S_ISCHR) && defined(S_IFCHR)</span>
<a name="l00070"></a><a class="code" href="a00208.html#a81814d8ebd1c6bd5a48b5b508f1f5193">00070</a> <span class="preprocessor"></span><span class="preprocessor">#define S_ISCHR(mode) __S_ISTYPE((mode), S_IFCHR)</span>
<a name="l00071"></a>00071 <span class="preprocessor"></span><span class="preprocessor">#elif !defined(S_ISCHR)</span>
<a name="l00072"></a>00072 <span class="preprocessor"></span><span class="preprocessor">#define S_ISCHR(mode) 0</span>
<a name="l00073"></a>00073 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00074"></a>00074 <span class="preprocessor"></span>
<a name="l00075"></a>00075 <span class="preprocessor">#if !defined(S_ISBLK) && defined(S_IFBLK)</span>
<a name="l00076"></a>00076 <span class="preprocessor"></span><span class="preprocessor">#define S_ISBLK(mode) __S_ISTYPE((mode), S_IFBLK)</span>
<a name="l00077"></a>00077 <span class="preprocessor"></span><span class="preprocessor">#elif !defined(S_ISBLK)</span>
<a name="l00078"></a>00078 <span class="preprocessor"></span><span class="preprocessor">#define S_ISBLK(mode) 0</span>
<a name="l00079"></a>00079 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00080"></a><a class="code" href="a00052.html">00080</a> <span class="preprocessor"></span>
<a name="l00081"></a>00081 <span class="preprocessor">#if !defined(S_ISREG) && defined(S_IFREG)</span>
<a name="l00082"></a>00082 <span class="preprocessor"></span><span class="preprocessor">#define S_ISREG(mode) __S_ISTYPE((mode), S_IFREG)</span>
<a name="l00083"></a>00083 <span class="preprocessor"></span><span class="preprocessor">#elif !defined(S_ISREG)</span>
<a name="l00084"></a>00084 <span class="preprocessor"></span><span class="preprocessor">#define S_ISREG(mode) 1</span>
<a name="l00085"></a>00085 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00086"></a>00086 <span class="preprocessor"></span>
<a name="l00087"></a>00087 <span class="preprocessor">#if !defined(S_ISSOCK) && defined(S_IFSOCK)</span>
<a name="l00088"></a>00088 <span class="preprocessor"></span><span class="preprocessor">#define S_ISSOCK(mode) __S_ISTYPE((mode), S_IFSOCK)</span>
<a name="l00089"></a>00089 <span class="preprocessor"></span><span class="preprocessor">#elif !defined(S_ISSOCK)</span>
<a name="l00090"></a>00090 <span class="preprocessor"></span><span class="preprocessor">#define S_ISSOCK(mode) (0)</span>
<a name="l00091"></a>00091 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00092"></a>00092 <span class="preprocessor"></span>
<a name="l00093"></a>00093 <span class="preprocessor">#if !defined(S_ISFIFO) && defined(S_IFIFO)</span>
<a name="l00094"></a>00094 <span class="preprocessor"></span><span class="preprocessor">#define S_ISFIFO(mode) __S_ISTYPE((mode), S_IFIFO)</span>
<a name="l00095"></a>00095 <span class="preprocessor"></span><span class="preprocessor">#elif !defined(S_ISFIFO)</span>
<a name="l00096"></a>00096 <span class="preprocessor"></span><span class="preprocessor">#define S_ISFIFO(mode) (0)</span>
<a name="l00097"></a>00097 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00098"></a>00098 <span class="preprocessor"></span>
<a name="l00099"></a>00099 <span class="preprocessor">#if !defined(S_ISLNK) && defined(S_IFLNK)</span>
<a name="l00100"></a>00100 <span class="preprocessor"></span><span class="preprocessor">#define S_ISLNK(mode) __S_ISTYPE((mode), S_IFLNK)</span>
<a name="l00101"></a>00101 <span class="preprocessor"></span><span class="preprocessor">#elif !defined(S_ISLNK)</span>
<a name="l00102"></a>00102 <span class="preprocessor"></span><span class="preprocessor">#define S_ISLNK(mode) (0)</span>
<a name="l00103"></a>00103 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00104"></a>00104 <span class="preprocessor"></span>
<a name="l00105"></a><a class="code" href="a00052.html#a8077a56ced2b26f2bcefa74dbacb4e90">00105</a> NAMESPACE_UCOMMON
<a name="l00106"></a>00106
<a name="l00110"></a>00110 <span class="keyword">typedef</span> <span class="keywordtype">void</span> *<a class="code" href="a00208.html#a99d0265119ce8940834ef128ce145daf" title="Convenience type for directory scan operations.">dir_t</a>;
<a name="l00111"></a>00111
<a name="l00115"></a>00115 <span class="keyword">typedef</span> <span class="keywordtype">void</span> *<a class="code" href="a00208.html#a81814d8ebd1c6bd5a48b5b508f1f5193" title="Convenience type for loader operations.">mem_t</a>;
<a name="l00116"></a>00116
<a name="l00125"></a><a class="code" href="a00052.html#a5d4dd8856ba149757838aa99b80dfa63">00125</a> <span class="keyword">class </span>__EXPORT <a class="code" href="a00052.html" title="A container for generic and o/s portable threadsafe file system functions.">fsys</a>
<a name="l00126"></a>00126 {
<a name="l00127"></a>00127 <span class="keyword">protected</span>:
<a name="l00128"></a>00128 fd_t fd;
<a name="l00129"></a>00129 <span class="preprocessor">#ifdef _MSWINDOWS_</span>
<a name="l00130"></a>00130 <span class="preprocessor"></span> WIN32_FIND_DATA *ptr;
<a name="l00131"></a>00131 HINSTANCE mem;
<a name="l00132"></a>00132 <span class="preprocessor">#else</span>
<a name="l00133"></a>00133 <span class="preprocessor"></span> <span class="keywordtype">void</span> *ptr;
<a name="l00134"></a>00134 <span class="preprocessor">#endif</span>
<a name="l00135"></a>00135 <span class="preprocessor"></span> <span class="keywordtype">int</span> error;
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="keyword">public</span>:
<a name="l00138"></a>00138 <span class="keyword">typedef</span> <span class="keyword">struct </span>stat fileinfo_t;
<a name="l00139"></a>00139
<a name="l00140"></a>00140 <span class="preprocessor">#ifdef _MSWINDOWS_</span>
<a name="l00141"></a>00141 <span class="preprocessor"></span> <span class="keyword">static</span> <span class="keywordtype">int</span> remapError(<span class="keywordtype">void</span>);
<a name="l00142"></a>00142 <span class="preprocessor">#else</span>
<a name="l00143"></a>00143 <span class="preprocessor"></span> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">int</span> remapError(<span class="keywordtype">void</span>)
<a name="l00144"></a>00144 {<span class="keywordflow">return</span> errno;};
<a name="l00145"></a>00145 <span class="preprocessor">#endif</span>
<a name="l00146"></a>00146 <span class="preprocessor"></span>
<a name="l00150"></a>00150 <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00151"></a>00151 ACCESS_RDONLY,
<a name="l00152"></a>00152 ACCESS_WRONLY,
<a name="l00153"></a>00153 ACCESS_REWRITE,
<a name="l00154"></a>00154 ACCESS_RDWR = ACCESS_REWRITE,
<a name="l00155"></a>00155 ACCESS_APPEND,
<a name="l00156"></a>00156 ACCESS_SHARED,
<a name="l00157"></a>00157 ACCESS_DIRECTORY,
<a name="l00158"></a>00158 ACCESS_STREAM,
<a name="l00159"></a>00159 ACCESS_RANDOM
<a name="l00160"></a>00160 } <a class="code" href="a00052.html#a8077a56ced2b26f2bcefa74dbacb4e90" title="Enumerated file access modes.">access_t</a>;
<a name="l00161"></a>00161
<a name="l00165"></a>00165 <span class="keyword">typedef</span> <span class="keywordtype">long</span> <a class="code" href="a00052.html#ac1346469625016aaf46d9e18fa806927" title="File offset type.">offset_t</a>;
<a name="l00166"></a>00166
<a name="l00170"></a>00170 <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="a00052.html#ac1346469625016aaf46d9e18fa806927" title="File offset type.">offset_t</a> end;
<a name="l00171"></a>00171
<a name="l00175"></a>00175 <a class="code" href="a00052.html" title="A container for generic and o/s portable threadsafe file system functions.">fsys</a>();
<a name="l00176"></a>00176
<a name="l00180"></a>00180 <a class="code" href="a00052.html" title="A container for generic and o/s portable threadsafe file system functions.">fsys</a>(fd_t handle);
<a name="l00181"></a><a class="code" href="a00052.html#a269ab395fe6fda9e52386d433cf71cbb">00181</a>
<a name="l00186"></a>00186 <a class="code" href="a00052.html" title="A container for generic and o/s portable threadsafe file system functions.">fsys</a>(<span class="keyword">const</span> <a class="code" href="a00052.html" title="A container for generic and o/s portable threadsafe file system functions.">fsys</a>& descriptor);
<a name="l00187"></a>00187
<a name="l00193"></a>00193 <a class="code" href="a00052.html" title="A container for generic and o/s portable threadsafe file system functions.">fsys</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *path, <a class="code" href="a00052.html#a8077a56ced2b26f2bcefa74dbacb4e90" title="Enumerated file access modes.">access_t</a> <a class="code" href="a00208.html#a5422fe5f7269f2606c8317e29e4147bf" title="Convenience function to access (lock) shared object through it&#39;s protocol.">access</a>);
<a name="l00194"></a>00194
<a name="l00201"></a>00201 <a class="code" href="a00052.html" title="A container for generic and o/s portable threadsafe file system functions.">fsys</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *path, <a class="code" href="a00052.html#a8077a56ced2b26f2bcefa74dbacb4e90" title="Enumerated file access modes.">access_t</a> <a class="code" href="a00208.html#a5422fe5f7269f2606c8317e29e4147bf" title="Convenience function to access (lock) shared object through it&#39;s protocol.">access</a>, <span class="keywordtype">unsigned</span> permission);
<a name="l00202"></a>00202
<a name="l00206"></a>00206 ~<a class="code" href="a00052.html" title="A container for generic and o/s portable threadsafe file system functions.">fsys</a>();
<a name="l00207"></a><a class="code" href="a00052.html#a7d1aa162f6b5851b90459c1f9a7afb87">00207</a>
<a name="l00212"></a>00212 <span class="keyword">inline</span> fd_t operator*()<span class="keyword"> const</span>
<a name="l00213"></a>00213 <span class="keyword"> </span>{<span class="keywordflow">return</span> fd;};
<a name="l00214"></a>00214
<a name="l00219"></a>00219 <span class="keyword">inline</span> operator fd_t()<span class="keyword"> const</span>
<a name="l00220"></a>00220 <span class="keyword"> </span>{<span class="keywordflow">return</span> fd;};
<a name="l00221"></a>00221
<a name="l00226"></a>00226 <span class="keyword">inline</span> operator bool()<span class="keyword"> const</span>
<a name="l00227"></a>00227 <span class="keyword"> </span>{<span class="keywordflow">return</span> fd != INVALID_HANDLE_VALUE || ptr != NULL;};
<a name="l00228"></a>00228
<a name="l00233"></a>00233 <span class="keyword">inline</span> <span class="keywordtype">bool</span> operator!()<span class="keyword"> const</span>
<a name="l00234"></a>00234 <span class="keyword"> </span>{<span class="keywordflow">return</span> fd == INVALID_HANDLE_VALUE && ptr == NULL;};
<a name="l00235"></a>00235
<a name="l00240"></a>00240 <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> fsys& descriptor);
<a name="l00241"></a>00241
<a name="l00246"></a>00246 <span class="keywordtype">void</span> operator=(fd_t descriptor);
<a name="l00247"></a>00247
<a name="l00252"></a>00252 <span class="keyword">inline</span> fd_t getHandle(<span class="keywordtype">void</span>)<span class="keyword"> const</span>
<a name="l00253"></a>00253 <span class="keyword"> </span>{<span class="keywordflow">return</span> fd;};
<a name="l00254"></a>00254
<a name="l00259"></a>00259 <span class="keywordtype">void</span> <span class="keyword">set</span>(fd_t descriptor);
<a name="l00260"></a>00260
<a name="l00265"></a>00265 fd_t <a class="code" href="a00208.html#a8df8e4b667d68be02961ff0d4cd84224" title="Convenience function to unlock shared object through it&#39;s protocol.">release</a>(<span class="keywordtype">void</span>);
<a name="l00266"></a>00266
<a name="l00272"></a>00272 <span class="keywordtype">int</span> seek(offset_t offset);
<a name="l00273"></a>00273
<a name="l00279"></a>00279 <span class="keywordtype">int</span> drop(offset_t size = 0);
<a name="l00280"></a>00280
<a name="l00285"></a>00285 <span class="keywordtype">bool</span> istty(<span class="keywordtype">void</span>);
<a name="l00286"></a>00286
<a name="l00291"></a>00291 <span class="keyword">static</span> <span class="keywordtype">bool</span> istty(fd_t fd);
<a name="l00292"></a>00292
<a name="l00299"></a>00299 ssize_t read(<span class="keywordtype">void</span> *buffer, <span class="keywordtype">size_t</span> count);
<a name="l00300"></a>00300
<a name="l00307"></a>00307 ssize_t write(<span class="keyword">const</span> <span class="keywordtype">void</span> *buffer, <span class="keywordtype">size_t</span> count);
<a name="l00308"></a>00308
<a name="l00314"></a>00314 <span class="keywordtype">int</span> fileinfo(fileinfo_t *buffer);
<a name="l00315"></a>00315
<a name="l00322"></a>00322 <span class="keywordtype">int</span> trunc(offset_t offset);
<a name="l00323"></a>00323
<a name="l00328"></a>00328 <span class="keywordtype">int</span> sync(<span class="keywordtype">void</span>);
<a name="l00329"></a>00329
<a name="l00335"></a>00335 <span class="keyword">static</span> <span class="keywordtype">int</span> changeDir(<span class="keyword">const</span> <span class="keywordtype">char</span> *path);
<a name="l00336"></a>00336
<a name="l00343"></a>00343 <span class="keyword">static</span> <span class="keywordtype">int</span> getPrefix(<span class="keywordtype">char</span> *path, <span class="keywordtype">size_t</span> size);
<a name="l00344"></a>00344
<a name="l00351"></a>00351 <span class="keyword">static</span> <span class="keywordtype">int</span> fileinfo(<span class="keyword">const</span> <span class="keywordtype">char</span> *path, fileinfo_t *buffer);
<a name="l00352"></a>00352
<a name="l00358"></a>00358 <span class="keyword">static</span> <span class="keywordtype">int</span> <span class="keyword">remove</span>(<span class="keyword">const</span> <span class="keywordtype">char</span> *path);
<a name="l00359"></a>00359
<a name="l00367"></a>00367 <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="a00208.html#aa948d5926268ce79c22778bd81cc6ed9" title="Convenience function to access object copy.">copy</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *source, <span class="keyword">const</span> <span class="keywordtype">char</span> *target, <span class="keywordtype">size_t</span> size = 1024);
<a name="l00368"></a>00368
<a name="l00375"></a>00375 <span class="keyword">static</span> <span class="keywordtype">int</span> rename(<span class="keyword">const</span> <span class="keywordtype">char</span> *oldpath, <span class="keyword">const</span> <span class="keywordtype">char</span> *newpath);
<a name="l00376"></a>00376
<a name="l00383"></a><a class="code" href="a00052.html#aa64d573956be5107945d7824fe73fd83">00383</a> <span class="keyword">static</span> <span class="keywordtype">int</span> change(<span class="keyword">const</span> <span class="keywordtype">char</span> *path, <span class="keywordtype">unsigned</span> mode);
<a name="l00384"></a>00384
<a name="l00391"></a>00391 <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="a00208.html#a5422fe5f7269f2606c8317e29e4147bf" title="Convenience function to access (lock) shared object through it&#39;s protocol.">access</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *path, <span class="keywordtype">unsigned</span> mode);
<a name="l00392"></a>00392
<a name="l00398"></a>00398 <span class="keyword">static</span> <span class="keywordtype">bool</span> isfile(<span class="keyword">const</span> <span class="keywordtype">char</span> *path);
<a name="l00399"></a>00399
<a name="l00405"></a>00405 <span class="keyword">static</span> <span class="keywordtype">bool</span> isdir(<span class="keyword">const</span> <span class="keywordtype">char</span> *path);
<a name="l00406"></a>00406
<a name="l00412"></a>00412 <span class="keyword">static</span> <span class="keywordtype">bool</span> islink(<span class="keyword">const</span> <span class="keywordtype">char</span> *path);
<a name="l00413"></a>00413
<a name="l00419"></a>00419 <span class="keyword">static</span> <span class="keywordtype">bool</span> ishidden(<span class="keyword">const</span> <span class="keywordtype">char</span> *path);
<a name="l00420"></a>00420
<a name="l00428"></a>00428 <span class="keyword">inline</span> <span class="keyword">static</span> ssize_t read(<a class="code" href="a00052.html" title="A container for generic and o/s portable threadsafe file system functions.">fsys</a>& descriptor, <span class="keywordtype">void</span> *buffer, <span class="keywordtype">size_t</span> count)
<a name="l00429"></a>00429 {<span class="keywordflow">return</span> descriptor.<a class="code" href="a00052.html#aab71ef039e7534892f1cf1079f6946ee" title="Read data from descriptor or scan directory.">read</a>(buffer, count);};
<a name="l00430"></a>00430
<a name="l00438"></a>00438 <span class="keyword">inline</span> <span class="keyword">static</span> ssize_t write(<a class="code" href="a00052.html" title="A container for generic and o/s portable threadsafe file system functions.">fsys</a>& descriptor, <span class="keyword">const</span> <span class="keywordtype">void</span> *buffer, <span class="keywordtype">size_t</span> count)
<a name="l00439"></a>00439 {<span class="keywordflow">return</span> descriptor.<a class="code" href="a00052.html#acb4d6ea069d89ba1f1441242a3fd354d" title="Write data to descriptor.">write</a>(buffer, count);};
<a name="l00440"></a>00440
<a name="l00447"></a>00447 <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">int</span> seek(fsys& descriptor, offset_t offset)
<a name="l00448"></a>00448 {<span class="keywordflow">return</span> descriptor.seek(offset);};
<a name="l00449"></a>00449
<a name="l00456"></a>00456 <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">int</span> drop(fsys& descriptor, offset_t size)
<a name="l00457"></a>00457 {<span class="keywordflow">return</span> descriptor.drop(size);};
<a name="l00458"></a>00458
<a name="l00464"></a>00464 <span class="keywordtype">void</span> open(<span class="keyword">const</span> <span class="keywordtype">char</span> *path, access_t <a class="code" href="a00208.html#a5422fe5f7269f2606c8317e29e4147bf" title="Convenience function to access (lock) shared object through it&#39;s protocol.">access</a>);
<a name="l00465"></a>00465
<a name="l00470"></a>00470 <span class="keyword">inline</span> <span class="keywordtype">void</span> assign(fd_t descriptor)
<a name="l00471"></a>00471 {close(); fd = descriptor;};
<a name="l00472"></a>00472
<a name="l00478"></a>00478 <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">void</span> assign(fsys& <span class="keywordtype">object</span>, fd_t descriptor)
<a name="l00479"></a>00479 {<span class="keywordtype">object</span>.close(); <span class="keywordtype">object</span>.fd = descriptor;};
<a name="l00480"></a>00480
<a name="l00487"></a>00487 <span class="keywordtype">void</span> create(<span class="keyword">const</span> <span class="keywordtype">char</span> *path, access_t <a class="code" href="a00208.html#a5422fe5f7269f2606c8317e29e4147bf" title="Convenience function to access (lock) shared object through it&#39;s protocol.">access</a>, <span class="keywordtype">unsigned</span> mode);
<a name="l00488"></a>00488
<a name="l00495"></a>00495 <span class="keyword">static</span> <span class="keywordtype">int</span> createDir(<span class="keyword">const</span> <span class="keywordtype">char</span> *path, <span class="keywordtype">unsigned</span> mode);
<a name="l00496"></a><a class="code" href="a00052.html#aa7a235ac17b8a6e7cb24c375b8cb6348">00496</a>
<a name="l00502"></a>00502 <span class="keyword">static</span> <span class="keywordtype">int</span> removeDir(<span class="keyword">const</span> <span class="keywordtype">char</span> *path);
<a name="l00503"></a>00503
<a name="l00511"></a>00511 <span class="keyword">static</span> <span class="keywordtype">int</span> unlink(<span class="keyword">const</span> <span class="keywordtype">char</span> *path);
<a name="l00512"></a>00512
<a name="l00519"></a>00519 <span class="keyword">static</span> <span class="keywordtype">int</span> link(<span class="keyword">const</span> <span class="keywordtype">char</span> *path, <span class="keyword">const</span> <span class="keywordtype">char</span> *target);
<a name="l00520"></a>00520
<a name="l00527"></a><a class="code" href="a00052.html#a42d9b7665beec9f61f5388d1a162780b">00527</a> <span class="keyword">static</span> <span class="keywordtype">int</span> hardlink(<span class="keyword">const</span> <span class="keywordtype">char</span> *path, <span class="keyword">const</span> <span class="keywordtype">char</span> *target);
<a name="l00528"></a>00528
<a name="l00535"></a>00535 <span class="keyword">static</span> <span class="keywordtype">int</span> linkinfo(<span class="keyword">const</span> <span class="keywordtype">char</span> *path, <span class="keywordtype">char</span> *buffer, <span class="keywordtype">size_t</span> size);
<a name="l00536"></a>00536
<a name="l00541"></a>00541 <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">void</span> close(<a class="code" href="a00052.html" title="A container for generic and o/s portable threadsafe file system functions.">fsys</a>& descriptor)
<a name="l00542"></a>00542 {descriptor.<a class="code" href="a00052.html#aa7a235ac17b8a6e7cb24c375b8cb6348" title="Close a file descriptor or directory directly.">close</a>();};
<a name="l00543"></a>00543
<a name="l00547"></a>00547 <span class="keywordtype">void</span> close(<span class="keywordtype">void</span>);
<a name="l00548"></a>00548
<a name="l00553"></a>00553 <span class="keyword">inline</span> <span class="keywordtype">int</span> err(<span class="keywordtype">void</span>)<span class="keyword"> const</span>
<a name="l00554"></a>00554 <span class="keyword"> </span>{<span class="keywordflow">return</span> error;}
<a name="l00555"></a>00555
<a name="l00562"></a>00562 <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">void</span> open(fsys& <span class="keywordtype">object</span>, <span class="keyword">const</span> <span class="keywordtype">char</span> *path, access_t <a class="code" href="a00208.html#a5422fe5f7269f2606c8317e29e4147bf" title="Convenience function to access (lock) shared object through it&#39;s protocol.">access</a>)
<a name="l00563"></a>00563 {<span class="keywordtype">object</span>.open(path, access);};
<a name="l00564"></a>00564
<a name="l00572"></a>00572 <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">void</span> create(fsys& <span class="keywordtype">object</span>, <span class="keyword">const</span> <span class="keywordtype">char</span> *path, access_t access, <span class="keywordtype">unsigned</span> mode)
<a name="l00573"></a>00573 {<span class="keywordtype">object</span>.create(path, access, mode);};
<a name="l00574"></a>00574
<a name="l00580"></a>00580 <span class="keyword">static</span> <span class="keywordtype">int</span> load(<span class="keyword">const</span> <span class="keywordtype">char</span> *path);
<a name="l00581"></a>00581
<a name="l00587"></a>00587 <span class="keyword">static</span> <span class="keywordtype">void</span> load(fsys& module, <span class="keyword">const</span> <span class="keywordtype">char</span> *path);
<a name="l00588"></a>00588
<a name="l00593"></a>00593 <span class="keyword">static</span> <span class="keywordtype">void</span> unload(fsys& module);
<a name="l00594"></a>00594
<a name="l00601"></a>00601 <span class="keyword">static</span> <span class="keywordtype">void</span> *find(fsys& module, <span class="keyword">const</span> <span class="keywordtype">char</span> *symbol);
<a name="l00602"></a><a class="code" href="a00032.html#abdc1961b0415d142c2217540b79d4b10">00602</a>
<a name="l00603"></a>00603 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> isfile(<span class="keyword">struct</span> stat *inode)
<a name="l00604"></a>00604 {<span class="keywordflow">return</span> S_ISREG(inode->st_mode);}
<a name="l00605"></a>00605
<a name="l00606"></a>00606 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> isdir(<span class="keyword">struct</span> stat *inode)
<a name="l00607"></a>00607 {<span class="keywordflow">return</span> S_ISDIR(inode->st_mode);}
<a name="l00608"></a>00608
<a name="l00609"></a>00609 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> islink(<span class="keyword">struct</span> stat *inode)
<a name="l00610"></a>00610 {<span class="keywordflow">return</span> S_ISLNK(inode->st_mode);}
<a name="l00611"></a>00611
<a name="l00612"></a>00612 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> isdev(<span class="keyword">struct</span> stat *inode)
<a name="l00613"></a>00613 {<span class="keywordflow">return</span> S_ISBLK(inode->st_mode) || S_ISCHR(inode->st_mode);}
<a name="l00614"></a>00614
<a name="l00615"></a>00615 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> ischar(<span class="keyword">struct</span> stat *inode)
<a name="l00616"></a>00616 {<span class="keywordflow">return</span> S_ISCHR(inode->st_mode);}
<a name="l00617"></a>00617
<a name="l00618"></a>00618 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> isdisk(<span class="keyword">struct</span> stat *inode)
<a name="l00619"></a>00619 {<span class="keywordflow">return</span> S_ISBLK(inode->st_mode);}
<a name="l00620"></a>00620
<a name="l00621"></a>00621 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> issys(<span class="keyword">struct</span> stat *inode)
<a name="l00622"></a>00622 {<span class="keywordflow">return</span> S_ISSOCK(inode->st_mode) || S_ISFIFO(inode->st_mode);}
<a name="l00623"></a>00623 };
<a name="l00624"></a>00624
<a name="l00630"></a>00630 <span class="keyword">class </span>__EXPORT charfile : <span class="keyword">public</span> CharacterProtocol
<a name="l00631"></a>00631 {
<a name="l00632"></a>00632 <span class="keyword">private</span>:
<a name="l00633"></a><a class="code" href="a00032.html#aacc76d233308f361141d2d10c4398aef">00633</a> FILE *fp;
<a name="l00634"></a>00634 <span class="keywordtype">bool</span> opened;
<a name="l00635"></a>00635
<a name="l00636"></a>00636 <span class="keywordtype">int</span> _putch(<span class="keywordtype">int</span> code);
<a name="l00637"></a>00637
<a name="l00638"></a>00638 <span class="keywordtype">int</span> _getch(<span class="keywordtype">void</span>);
<a name="l00639"></a>00639
<a name="l00640"></a>00640 <span class="keyword">public</span>:
<a name="l00641"></a>00641 typedef ::fpos_t bookmark_t;
<a name="l00642"></a>00642
<a name="l00647"></a>00647 <span class="keyword">inline</span> <a class="code" href="a00032.html" title="Access standard files through character protocol.">charfile</a>(FILE *file)
<a name="l00648"></a>00648 {fp = file; opened = <span class="keyword">false</span>;}
<a name="l00649"></a>00649
<a name="l00655"></a>00655 <a class="code" href="a00032.html" title="Access standard files through character protocol.">charfile</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *path, <span class="keyword">const</span> <span class="keywordtype">char</span> *mode);
<a name="l00656"></a>00656
<a name="l00660"></a>00660 <a class="code" href="a00032.html" title="Access standard files through character protocol.">charfile</a>();
<a name="l00661"></a>00661
<a name="l00665"></a>00665 ~<a class="code" href="a00032.html" title="Access standard files through character protocol.">charfile</a>();
<a name="l00666"></a>00666
<a name="l00671"></a>00671 <span class="keyword">inline</span> operator bool()
<a name="l00672"></a>00672 {<span class="keywordflow">return</span> fp != NULL;}
<a name="l00673"></a>00673
<a name="l00678"></a>00678 <span class="keyword">inline</span> <span class="keywordtype">bool</span> operator !()
<a name="l00679"></a>00679 {<span class="keywordflow">return</span> fp == NULL;}
<a name="l00680"></a>00680
<a name="l00686"></a>00686 <span class="keywordtype">void</span> open(<span class="keyword">const</span> <span class="keywordtype">char</span> *path, <span class="keyword">const</span> <span class="keywordtype">char</span> *mode);
<a name="l00687"></a>00687
<a name="l00691"></a>00691 <span class="keywordtype">void</span> close(<span class="keywordtype">void</span>);
<a name="l00692"></a>00692
<a name="l00698"></a>00698 <span class="keywordtype">size_t</span> put(<span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keywordtype">string</span>);
<a name="l00699"></a>00699
<a name="l00709"></a>00709 <span class="keywordtype">size_t</span> readline(<span class="keywordtype">char</span> *<span class="keywordtype">string</span>, <span class="keywordtype">size_t</span> size);
<a name="l00710"></a>00710
<a name="l00719"></a>00719 <span class="keywordtype">size_t</span> readline(<span class="keywordtype">string</span>& <span class="keywordtype">string</span>);
<a name="l00720"></a>00720
<a name="l00721"></a>00721 <span class="keyword">inline</span> <span class="keywordtype">size_t</span> put(<span class="keyword">const</span> <span class="keywordtype">void</span> *data, <span class="keywordtype">size_t</span> size)
<a name="l00722"></a>00722 { <span class="keywordflow">return</span> fp == NULL ? 0 : fwrite(data, 1, size, fp);}
<a name="l00723"></a>00723
<a name="l00724"></a>00724 <span class="keywordtype">size_t</span> <span class="keyword">get</span>(<span class="keywordtype">void</span> *data, <span class="keywordtype">size_t</span> size)
<a name="l00725"></a>00725 { <span class="keywordflow">return</span> fp == NULL ? 0 : fread(data, 1, size, fp);}
<a name="l00726"></a>00726
<a name="l00727"></a>00727 <span class="keyword">inline</span> <span class="keywordtype">void</span> <span class="keyword">get</span>(bookmark_t& pos)
<a name="l00728"></a>00728 { <span class="keywordflow">if</span>(fp) fsetpos(fp, &pos);}
<a name="l00729"></a>00729
<a name="l00730"></a>00730 <span class="keyword">inline</span> <span class="keywordtype">void</span> <span class="keyword">set</span>(bookmark_t& pos)
<a name="l00731"></a>00731 { <span class="keywordflow">if</span>(fp) fgetpos(fp, &pos);}
<a name="l00732"></a>00732
<a name="l00733"></a>00733 <span class="keywordtype">int</span> err(<span class="keywordtype">void</span>);
<a name="l00734"></a>00734
<a name="l00735"></a>00735 <span class="keywordtype">bool</span> eof(<span class="keywordtype">void</span>);
<a name="l00736"></a>00736
<a name="l00737"></a>00737 <span class="keyword">inline</span> <span class="keywordtype">void</span> seek(<span class="keywordtype">long</span> offset)
<a name="l00738"></a>00738 {<span class="keywordflow">if</span>(fp) fseek(fp, offset, SEEK_SET);}
<a name="l00739"></a>00739
<a name="l00740"></a>00740 <span class="keyword">inline</span> <span class="keywordtype">void</span> move(<span class="keywordtype">long</span> offset)
<a name="l00741"></a>00741 {<span class="keywordflow">if</span>(fp) fseek(fp, offset, SEEK_CUR);}
<a name="l00742"></a>00742
<a name="l00743"></a>00743 <span class="keyword">inline</span> <span class="keywordtype">void</span> append(<span class="keywordtype">void</span>)
<a name="l00744"></a>00744 {<span class="keywordflow">if</span> (fp) fseek(fp, 0l, SEEK_END);}
<a name="l00745"></a>00745
<a name="l00746"></a>00746 <span class="keyword">inline</span> <span class="keywordtype">void</span> rewind(<span class="keywordtype">void</span>)
<a name="l00747"></a>00747 {<span class="keywordflow">if</span>(fp) ::rewind(fp);}
<a name="l00748"></a>00748
<a name="l00749"></a>00749 <span class="keywordtype">size_t</span> printf(<span class="keyword">const</span> <span class="keywordtype">char</span> *format, ...) __PRINTF(2, 3);
<a name="l00750"></a>00750
<a name="l00751"></a>00751 <span class="keywordtype">bool</span> istty(<span class="keywordtype">void</span>);
<a name="l00752"></a>00752 };
<a name="l00753"></a>00753
<a name="l00754"></a>00754 <a class="code" href="a00208.html#a9045ddbf2980f6330c065a6935f40161" title="A convenience type when mixing std::string in old compilers that are bad with namespaces...">String</a> str(charfile& fp, <a class="code" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6" title="A convenience class for size of strings.">strsize_t</a> size);
<a name="l00755"></a>00755
<a name="l00759"></a>00759 typedef fsys <a class="code" href="a00208.html#a23faf183eb888649c6c0b43a23234700" title="Convience type for fsys.">fsys_t</a>;
<a name="l00760"></a>00760
<a name="l00761"></a>00761 extern charfile cstdin, cstdout, cstderr;
<a name="l00762"></a>00762
<a name="l00763"></a>00763 END_NAMESPACE
<a name="l00764"></a>00764
<a name="l00765"></a>00765 <span class="preprocessor">#endif</span>
<a name="l00766"></a>00766 <span class="preprocessor"></span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:38:56 2011 for ucommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
