2 Copyright (C) 2001-2006, William Joseph.
5 This file is part of GtkRadiant.
7 GtkRadiant is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 GtkRadiant is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GtkRadiant; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #if !defined(INCLUDED_OS_FILE_H)
23 #define INCLUDED_OS_FILE_H
26 /// \brief OS file-system querying and manipulation.
29 #define S_ISDIR(mode) (mode & _S_IFDIR)
30 #include <io.h> // _access()
34 #define access(path, mode) _access(path, mode)
36 #include <unistd.h> // access()
39 #include <stdio.h> // rename(), remove()
40 #include <sys/stat.h> // stat()
41 #include <sys/types.h> // this is included by stat.h on win32
45 #include "debugging/debugging.h"
47 /// \brief Attempts to move the file identified by \p from to \p to and returns true if the operation was successful.
49 /// The operation will fail unless:
50 /// - The path \p from identifies an existing file which is accessible for writing.
51 /// - The directory component of \p from identifies an existing directory which is accessible for writing.
52 /// - The path \p to does not identify an existing file or directory.
53 /// - The directory component of \p to identifies an existing directory which is accessible for writing.
54 inline bool file_move(const char* from, const char* to)
56 ASSERT_MESSAGE(from != 0 && to != 0, "file_move: invalid path");
57 return rename(from, to) == 0;
60 /// \brief Attempts to remove the file identified by \p path and returns true if the operation was successful.
62 /// The operation will fail unless:
63 /// - The \p path identifies an existing file.
64 /// - The parent-directory component of \p path identifies an existing directory which is accessible for writing.
65 inline bool file_remove(const char* path)
67 ASSERT_MESSAGE(path != 0, "file_remove: invalid path");
68 return remove(path) == 0;
77 ReadWrite = Read | Write,
82 /// \brief Returns true if the file or directory identified by \p path exists and/or may be accessed for reading, writing or both, depending on the value of \p mode.
83 inline bool file_accessible(const char* path, FileAccess::Mode mode)
85 ASSERT_MESSAGE(path != 0, "file_accessible: invalid path");
86 return access(path, static_cast<int>(mode)) == 0;
89 /// \brief Returns true if the file or directory identified by \p path exists and may be opened for reading.
90 inline bool file_readable(const char* path)
92 return file_accessible(path, FileAccess::Read);
95 /// \brief Returns true if the file or directory identified by \p path exists and may be opened for writing.
96 inline bool file_writeable(const char* path)
98 return file_accessible(path, FileAccess::Write);
101 /// \brief Returns true if the file or directory identified by \p path exists.
102 inline bool file_exists(const char* path)
104 return file_accessible(path, FileAccess::Exists);
107 /// \brief Returns true if the file or directory identified by \p path exists and is a directory.
108 inline bool file_is_directory(const char* path)
110 ASSERT_MESSAGE(path != 0, "file_is_directory: invalid path");
112 if(stat(path, &st) == -1)
116 return S_ISDIR (st.st_mode) != 0;
119 typedef std::size_t FileSize;
121 /// \brief Returns the size in bytes of the file identified by \p path, or 0 if the file was not found.
122 inline FileSize file_size(const char* path)
124 ASSERT_MESSAGE(path != 0, "file_size: invalid path");
126 if(stat(path, &st) == -1)
133 /// Seconds elapsed since Jan 1, 1970
134 typedef std::time_t FileTime;
135 /// No file can have been modified earlier than this time.
136 const FileTime c_invalidFileTime = -1;
138 /// \brief Returns the time that the file identified by \p path was last modified, or c_invalidFileTime if the file was not found.
139 inline FileTime file_modified(const char* path)
141 ASSERT_MESSAGE(path != 0, "file_modified: invalid path");
143 if(stat(path, &st) == -1)
145 return c_invalidFileTime;