2 Copyright (c) 2004-2009, John Hurst
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions
8 1. Redistributions of source code must retain the above copyright
9 notice, this list of conditions and the following disclaimer.
10 2. Redistributions in binary form must reproduce the above copyright
11 notice, this list of conditions and the following disclaimer in the
12 documentation and/or other materials provided with the distribution.
13 3. The name of the author may not be used to endorse or promote products
14 derived from this software without specific prior written permission.
16 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 \version $Id: KM_fileio.h,v 1.17 2009/06/22 05:49:02 jhurst Exp $
29 \brief portable file i/o
44 # include <sys/types.h>
60 struct _finddatai64_t m_FileInfo;
66 ~DirScanner() { Close(); }
68 Result_t Open(const char*);
70 Result_t GetNext(char*);
74 typedef __int64 fsize_t;
75 typedef __int64 fpos_t;
76 typedef HANDLE FileHandle;
79 SP_BEGIN = FILE_BEGIN,
80 SP_POS = FILE_CURRENT,
84 typedef off_t fsize_t;
86 typedef int FileHandle;
87 const FileHandle INVALID_HANDLE_VALUE = -1L;
97 #ifndef KM_SMALL_FILES_OK
98 template <bool sizecheck> void compile_time_size_checker();
99 template <> inline void compile_time_size_checker<false>() {}
101 // READ THIS if your compiler is complaining about a previously declared implementation of
102 // compile_time_size_checker(). For example, GCC 4.0.1 looks like this:
104 // error: 'void Kumu::compile_time_size_checker() [with bool sizecheck = false]' previously declared here
106 // This is happening because the equality being tested below is false. The reason for this
107 // will depend on your OS, but on Linux it is probably because you have not used -D_FILE_OFFSET_BITS=64
108 // Adding this magic macro to your CFLAGS will get you going again. If you are on a system that
109 // does not support 64-bit files, you can disable this check by using -DKM_SMALL_FILES_OK. You
110 // will then of course be limited to file sizes < 4GB.
112 template <> inline void compile_time_size_checker<sizeof(Kumu::fsize_t)==sizeof(ui64_t)>() {}
116 const ui32_t Kilobyte = 1024;
117 const ui32_t Megabyte = Kilobyte * Kilobyte;
118 const ui32_t Gigabyte = Megabyte * Kilobyte;
120 const ui32_t MaxFilePath = Kilobyte;
123 //------------------------------------------------------------------------------------------
125 //------------------------------------------------------------------------------------------
128 typedef std::list<std::string> PathCompList_t; // a list of path components
129 typedef std::list<std::string> PathList_t; // a list of paths
132 bool PathExists(const std::string& Path); // true if the path exists in the filesystem
133 bool PathIsFile(const std::string& Path); // true if the path exists in the filesystem and is a file
134 bool PathIsDirectory(const std::string& Path); // true if the path exists in the filesystem and is a directory
135 fsize_t FileSize(const std::string& Path); // returns the size of a regular file, 0 for a directory or device
136 bool PathsAreEquivalent(const std::string& lhs, const std::string& rhs); // true if paths point to the same filesystem entry
138 // Returns free space and total space available for the given path
139 Result_t FreeSpaceForPath(const std::string& path, Kumu::fsize_t& free_space, Kumu::fsize_t& total_space);
141 // split and reassemble paths as lists of path components
142 PathCompList_t& PathToComponents(const std::string& Path, PathCompList_t& CList, char separator = '/'); // removes '//'
143 std::string ComponentsToPath(const PathCompList_t& CList, char separator = '/');
144 std::string ComponentsToAbsolutePath(const PathCompList_t& CList, char separator = '/'); // add separator to the front
145 bool PathHasComponents(const std::string& Path, char separator = '/'); // true if paths starts with separator
147 bool PathIsAbsolute(const std::string& Path, char separator = '/'); // true if path begins with separator
148 std::string PathMakeAbsolute(const std::string& Path, char separator = '/'); // compute position of relative path using getcwd()
149 std::string PathMakeLocal(const std::string& Path, const std::string& Parent); // remove Parent from front of Path, if it exists
150 std::string PathMakeCanonical(const std::string& Path, char separator = '/'); // remove '.' and '..'
153 std::string PathBasename(const std::string& Path, char separator = '/'); // returns right-most path element (list back())
154 std::string PathDirname(const std::string& Path, char separator = '/'); // returns everything but the right-most element
155 std::string PathGetExtension(const std::string& Path); // returns everything in the right-most element following the right-most '.'
156 std::string PathSetExtension(const std::string& Path, const std::string& Extension); // empty extension removes '.' as well
158 std::string PathJoin(const std::string& Path1, const std::string& Path2, char separator = '/');
159 std::string PathJoin(const std::string& Path1, const std::string& Path2, const std::string& Path3, char separator = '/');
160 std::string PathJoin(const std::string& Path1, const std::string& Path2,
161 const std::string& Path3, const std::string& Path4, char separator = '/');
164 //------------------------------------------------------------------------------------------
166 //------------------------------------------------------------------------------------------
168 // An interface for a path matching function, used by FindInPath() and FindInPaths() below
173 virtual ~IPathMatch() {}
174 virtual bool Match(const std::string& s) const = 0;
177 // matches any pathname
178 class PathMatchAny : public IPathMatch
181 virtual ~PathMatchAny() {}
182 inline bool Match(const std::string&) const { return true; }
186 // matches pathnames using a regular expression
187 class PathMatchRegex : public IPathMatch
191 const PathMatchRegex& operator=(const PathMatchRegex&);
194 PathMatchRegex(const std::string& Pattern);
195 PathMatchRegex(const PathMatchRegex&);
196 virtual ~PathMatchRegex();
197 bool Match(const std::string& s) const;
200 // matches pathnames using a Bourne shell glob expression
201 class PathMatchGlob : public IPathMatch
205 const PathMatchGlob& operator=(const PathMatchGlob&);
208 PathMatchGlob(const std::string& Pattern);
209 PathMatchGlob(const PathMatchGlob&);
210 virtual ~PathMatchGlob();
211 bool Match(const std::string& s) const;
213 #endif /* !KM_WIN32 */
215 // Search all paths in SearchPaths for filenames matching Pattern (no directories are returned).
216 // Put results in FoundPaths. Returns after first find if one_shot is true.
217 PathList_t& FindInPath(const IPathMatch& Pattern, const std::string& SearchDir,
218 PathList_t& FoundPaths, bool one_shot = false, char separator = '/');
220 PathList_t& FindInPaths(const IPathMatch& Pattern, const PathList_t& SearchPaths,
221 PathList_t& FoundPaths, bool one_shot = false, char separator = '/');
223 //------------------------------------------------------------------------------------------
224 // Directory Manipulation
225 //------------------------------------------------------------------------------------------
227 // Create a directory, creates intermediate directories as necessary
228 Result_t CreateDirectoriesInPath(const std::string& Path);
230 // Delete a file (fails if the path points to a directory)
231 Result_t DeleteFile(const std::string& filename);
233 // Recursively remove a file or directory
234 Result_t DeletePath(const std::string& pathname);
236 //------------------------------------------------------------------------------------------
238 //------------------------------------------------------------------------------------------
240 // Instant IO for strings
242 // Reads an entire file into a string.
243 Result_t ReadFileIntoString(const char* filename, std::string& outString, ui32_t max_size = 8 * Megabyte);
245 // Writes a string to a file, overwrites the existing file if present.
246 Result_t WriteStringIntoFile(const char* filename, const std::string& inString);
248 // Instant IO for archivable objects
250 // Unarchives a file into an object
251 Result_t ReadFileIntoObject(const std::string& Filename, IArchive& Object, ui32_t max_size = 8 * Kumu::Megabyte);
253 // Archives an object into a file
254 Result_t WriteObjectIntoFile(const IArchive& Object, const std::string& Filename);
256 // Instant IO for memory buffers
258 // Unarchives a file into a buffer
259 Result_t ReadFileIntoBuffer(const std::string& Filename, Kumu::ByteString& Buffer,
260 ui32_t max_size = 8 * Kumu::Megabyte);
262 // Archives a buffer into a file
263 Result_t WriteBufferIntoFile(const Kumu::ByteString& Buffer, const std::string& Filename);
266 //------------------------------------------------------------------------------------------
268 //------------------------------------------------------------------------------------------
273 KM_NO_COPY_CONSTRUCT(FileReader);
276 std::string m_Filename;
280 FileReader() : m_Handle(INVALID_HANDLE_VALUE) {}
281 virtual ~FileReader() { Close(); }
283 Result_t OpenRead(const char*) const; // open the file for reading
284 Result_t Close() const; // close the file
285 fsize_t Size() const; // returns the file's current size
286 Result_t Seek(Kumu::fpos_t = 0, SeekPos_t = SP_BEGIN) const; // move the file pointer
287 Result_t Tell(Kumu::fpos_t* pos) const; // report the file pointer's location
288 Result_t Read(byte_t*, ui32_t, ui32_t* = 0) const; // read a buffer of data
290 inline Kumu::fpos_t Tell() const // report the file pointer's location
292 Kumu::fpos_t tmp_pos;
297 inline bool IsOpen() { // returns true if the file is open
298 return (m_Handle != INVALID_HANDLE_VALUE);
303 class FileWriter : public FileReader
306 mem_ptr<h__iovec> m_IOVec;
307 KM_NO_COPY_CONSTRUCT(FileWriter);
311 virtual ~FileWriter();
313 Result_t OpenWrite(const char*); // open a new file, overwrites existing
314 Result_t OpenModify(const char*); // open a file for read/write
316 // this part of the interface takes advantage of the iovec structure on
317 // platforms that support it. For each call to Writev(const byte_t*, ui32_t, ui32_t*),
318 // the given buffer is added to an internal iovec struct. All items on the list
319 // are written to disk by a call to Writev();
320 Result_t Writev(const byte_t*, ui32_t); // queue buffer for "gather" write
321 Result_t Writev(ui32_t* = 0); // write all queued buffers
323 // if you call this while there are unwritten items on the iovec list,
324 // the iovec list will be written to disk before the given buffer,as though
325 // you had called Writev() first.
326 Result_t Write(const byte_t*, ui32_t, ui32_t* = 0); // write buffer to disk
329 Result_t CreateDirectoriesInPath(const std::string& Path);
330 Result_t FreeSpaceForPath(const std::string& path, Kumu::fsize_t& free_space, Kumu::fsize_t& total_space);
331 Result_t DeleteFile(const std::string& filename);
332 Result_t DeletePath(const std::string& pathname);
337 #endif // _KM_FILEIO_H_