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
  32 #ifndef F_OK
  33 #define F_OK 0x00
  34 #endif
  35
  36 #ifndef W_OK
  37 #define W_OK 0x02
  38 #endif
  39
  40 #ifndef R_OK
  41 #define R_OK 0x04
  42 #endif
  43
  44 #define access( path, mode ) _access( path, mode )
  45 #else
  46 #include <unistd.h> // access()
  47 #endif
  48
  49 #include <stdio.h> // rename(), remove()
  50 #include <sys/stat.h> // stat()
  51 #include <sys/types.h> // this is included by stat.h on win32
  52 #include <cstddef>
  53 #include <ctime>
  54
  55 #include "debugging/debugging.h"
  56
  57 /// \brief Attempts to move the file identified by \p from to \p to and returns true if the operation was successful.
  58 ///
  59 /// The operation will fail unless:
  60 /// - The path \p from identifies an existing file which is accessible for writing.
  61 /// - The directory component of \p from identifies an existing directory which is accessible for writing.
  62 /// - The path \p to does not identify an existing file or directory.
  63 /// - The directory component of \p to identifies an existing directory which is accessible for writing.
  64 inline bool file_move( const char* from, const char* to ){
  65         ASSERT_MESSAGE( from != 0 && to != 0, "file_move: invalid path" );
  66         return rename( from, to ) == 0;
  67 }
  68
  69 /// \brief Attempts to remove the file identified by \p path and returns true if the operation was successful.
  70 ///
  71 /// The operation will fail unless:
  72 /// - The \p path identifies an existing file.
  73 /// - The parent-directory component of \p path identifies an existing directory which is accessible for writing.
  74 inline bool file_remove( const char* path ){
  75         ASSERT_MESSAGE( path != 0, "file_remove: invalid path" );
  76         return remove( path ) == 0;
  77 }
  78
  79 namespace FileAccess
  80 {
  81 enum Mode
  82 {
  83         Read = R_OK,
  84         Write = W_OK,
  85         ReadWrite = Read | Write,
  86         Exists = F_OK
  87 };
  88 }
  89
  90 /// \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.
  91 inline bool file_accessible( const char* path, FileAccess::Mode mode ){
  92         ASSERT_MESSAGE( path != 0, "file_accessible: invalid path" );
  93         return access( path, static_cast<int>( mode ) ) == 0;
  94 }
  95
  96 /// \brief Returns true if the file or directory identified by \p path exists and may be opened for reading.
  97 inline bool file_readable( const char* path ){
  98         return file_accessible( path, FileAccess::Read );
  99 }
 100
 101 /// \brief Returns true if the file or directory identified by \p path exists and may be opened for writing.
 102 inline bool file_writeable( const char* path ){
 103         return file_accessible( path, FileAccess::Write );
 104 }
 105
 106 /// \brief Returns true if the file or directory identified by \p path exists.
 107 inline bool file_exists( const char* path ){
 108         return file_accessible( path, FileAccess::Exists );
 109 }
 110
 111 /// \brief Returns true if the file or directory identified by \p path exists and is a directory.
 112 inline bool file_is_directory( const char* path ){
 113         ASSERT_MESSAGE( path != 0, "file_is_directory: invalid path" );
 114         struct stat st;
 115         if ( stat( path, &st ) == -1 ) {
 116                 return false;
 117         }
 118         return S_ISDIR( st.st_mode ) != 0;
 119 }
 120
 121 typedef std::size_t FileSize;
 122
 123 /// \brief Returns the size in bytes of the file identified by \p path, or 0 if the file was not found.
 124 inline FileSize file_size( const char* path ){
 125         ASSERT_MESSAGE( path != 0, "file_size: invalid path" );
 126         struct stat st;
 127         if ( stat( path, &st ) == -1 ) {
 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         ASSERT_MESSAGE( path != 0, "file_modified: invalid path" );
 141         struct stat st;
 142         if ( stat( path, &st ) == -1 ) {
 143                 return c_invalidFileTime;
 144         }
 145         return st.st_mtime;
 146 }
 147
 148
 149
 150 #endif