Merge commit '48410b113dd2036e69dbf723a39ec9af02fc9b12'
[xonotic/netradiant.git] / libs / os / file.h
1 /*
2 Copyright (C) 2001-2006, William Joseph.
3 All Rights Reserved.
4
5 This file is part of GtkRadiant.
6
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.
11
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.
16
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
20 */
21
22 #if !defined(INCLUDED_OS_FILE_H)
23 #define INCLUDED_OS_FILE_H
24
25 /// \file
26 /// \brief OS file-system querying and manipulation.
27
28 #if defined( WIN32 )
29 #define S_ISDIR(mode) (mode & _S_IFDIR)
30 #include <io.h> // _access()
31 #define F_OK 0x00
32 #define W_OK 0x02
33 #define R_OK 0x04
34 #define access(path, mode) _access(path, mode)
35 #else
36 #include <unistd.h> // access()
37 #endif
38
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
42 #include <cstddef>
43 #include <ctime>
44
45 #include "debugging/debugging.h"
46
47 /// \brief Attempts to move the file identified by \p from to \p to and returns true if the operation was successful.
48 ///
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)
55 {
56   ASSERT_MESSAGE(from != 0 && to != 0, "file_move: invalid path");
57   return rename(from, to) == 0;
58 }
59
60 /// \brief Attempts to remove the file identified by \p path and returns true if the operation was successful.
61 ///
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)
66 {
67   ASSERT_MESSAGE(path != 0, "file_remove: invalid path");
68   return remove(path) == 0;
69 }
70
71 namespace FileAccess
72 {
73   enum Mode
74   {
75     Read = R_OK,
76     Write = W_OK,
77     ReadWrite = Read | Write,
78     Exists = F_OK
79   };
80 }
81
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)
84 {
85   ASSERT_MESSAGE(path != 0, "file_accessible: invalid path");
86   return access(path, static_cast<int>(mode)) == 0;
87 }
88
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)
91 {
92   return file_accessible(path, FileAccess::Read);
93 }
94
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)
97 {
98   return file_accessible(path, FileAccess::Write);
99 }
100
101 /// \brief Returns true if the file or directory identified by \p path exists.
102 inline bool file_exists(const char* path)
103 {
104   return file_accessible(path, FileAccess::Exists);
105 }
106
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)
109 {
110   ASSERT_MESSAGE(path != 0, "file_is_directory: invalid path");
111   struct stat st;
112   if(stat(path, &st) == -1)
113   {
114     return false;
115   }
116   return S_ISDIR (st.st_mode) != 0;
117 }
118
119 typedef std::size_t FileSize;
120
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)
123 {
124   ASSERT_MESSAGE(path != 0, "file_size: invalid path");
125   struct stat st;
126   if(stat(path, &st) == -1)
127   {
128     return 0;
129   }
130   return st.st_size;
131 }
132
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;
137
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)
140 {
141   ASSERT_MESSAGE(path != 0, "file_modified: invalid path");
142   struct stat st;
143   if(stat(path, &st) == -1)
144   {
145     return c_invalidFileTime;
146   }
147   return st.st_mtime;
148 }
149
150
151
152 #endif