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         ASSERT_MESSAGE( from != 0 && to != 0, "file_move: invalid path" );
  56         return rename( from, to ) == 0;
  57 }
  58
  59 /// \brief Attempts to remove the file identified by \p path and returns true if the operation was successful.
  60 ///
  61 /// The operation will fail unless:
  62 /// - The \p path identifies an existing file.
  63 /// - The parent-directory component of \p path identifies an existing directory which is accessible for writing.
  64 inline bool file_remove( const char* path ){
  65         ASSERT_MESSAGE( path != 0, "file_remove: invalid path" );
  66         return remove( path ) == 0;
  67 }
  68
  69 namespace FileAccess
  70 {
  71 enum Mode
  72 {
  73         Read = R_OK,
  74         Write = W_OK,
  75         ReadWrite = Read | Write,
  76         Exists = F_OK
  77 };
  78 }
  79
  80 /// \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.
  81 inline bool file_accessible( const char* path, FileAccess::Mode mode ){
  82         ASSERT_MESSAGE( path != 0, "file_accessible: invalid path" );
  83         return access( path, static_cast<int>( mode ) ) == 0;
  84 }
  85
  86 /// \brief Returns true if the file or directory identified by \p path exists and may be opened for reading.
  87 inline bool file_readable( const char* path ){
  88         return file_accessible( path, FileAccess::Read );
  89 }
  90
  91 /// \brief Returns true if the file or directory identified by \p path exists and may be opened for writing.
  92 inline bool file_writeable( const char* path ){
  93         return file_accessible( path, FileAccess::Write );
  94 }
  95
  96 /// \brief Returns true if the file or directory identified by \p path exists.
  97 inline bool file_exists( const char* path ){
  98         return file_accessible( path, FileAccess::Exists );
  99 }
 100
 101 /// \brief Returns true if the file or directory identified by \p path exists and is a directory.
 102 inline bool file_is_directory( const char* path ){
 103         ASSERT_MESSAGE( path != 0, "file_is_directory: invalid path" );
 104         struct stat st;
 105         if ( stat( path, &st ) == -1 ) {
 106                 return false;
 107         }
 108         return S_ISDIR( st.st_mode ) != 0;
 109 }
 110
 111 typedef std::size_t FileSize;
 112
 113 /// \brief Returns the size in bytes of the file identified by \p path, or 0 if the file was not found.
 114 inline FileSize file_size( const char* path ){
 115         ASSERT_MESSAGE( path != 0, "file_size: invalid path" );
 116         struct stat st;
 117         if ( stat( path, &st ) == -1 ) {
 118                 return 0;
 119         }
 120         return st.st_size;
 121 }
 122
 123 /// Seconds elapsed since Jan 1, 1970
 124 typedef std::time_t FileTime;
 125 /// No file can have been modified earlier than this time.
 126 const FileTime c_invalidFileTime = -1;
 127
 128 /// \brief Returns the time that the file identified by \p path was last modified, or c_invalidFileTime if the file was not found.
 129 inline FileTime file_modified( const char* path ){
 130         ASSERT_MESSAGE( path != 0, "file_modified: invalid path" );
 131         struct stat st;
 132         if ( stat( path, &st ) == -1 ) {
 133                 return c_invalidFileTime;
 134         }
 135         return st.st_mtime;
 136 }
 137
 138
 139
 140 #endif