file.h

Go to the documentation of this file.

/*
 Copyright (C) 2001-2006, William Joseph.
 All Rights Reserved.

 This file is part of GtkRadiant.

 GtkRadiant is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 2 of the License, or
 (at your option) any later version.

 GtkRadiant is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with GtkRadiant; if not, write to the Free Software
 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

#if !defined(INCLUDED_OS_FILE_H)
#define INCLUDED_OS_FILE_H

#if defined(WIN32)
#include <io.h> // _access()
#define access(path, mode) _access(path, mode)
#else
#include <unistd.h> // access()
#endif

#include <string>
#include <stdio.h> // rename(), remove()
#include <sys/stat.h> // stat()
#include <sys/types.h> // this is included by stat.h on win32
#include <cstddef>
#include <ctime>

#include "debugging/debugging.h"

inline bool file_move (const std::string& from, const std::string& to)
{
    return rename(from.c_str(), to.c_str()) == 0;
}

inline bool file_remove (const std::string& path)
{
    return remove(path.c_str()) == 0;
}

namespace FileAccess
{
    enum Mode
    {
        Read = R_OK, Write = W_OK, ReadWrite = Read | Write, Exists = F_OK
    };
}

inline bool file_accessible (const std::string& path, FileAccess::Mode mode)
{
    return access(path.c_str(), static_cast<int> (mode)) == 0;
}

inline bool file_readable (const std::string& path)
{
    return file_accessible(path, FileAccess::Read);
}

inline bool file_writeable (const std::string& path)
{
    return file_accessible(path, FileAccess::Write);
}

inline bool file_exists (const std::string& path)
{
    return file_accessible(path, FileAccess::Exists);
}

inline bool file_is_directory (const std::string& path)
{
    struct stat st;
    if (stat(path.c_str(), &st) == -1)
        return false;
    return S_ISDIR (st.st_mode) != 0;
}

typedef std::size_t FileSize;

inline FileSize file_size (const std::string& path)
{
    struct stat st;
    if (stat(path.c_str(), &st) == -1)
        return 0;
    return st.st_size;
}

typedef std::time_t FileTime;
const FileTime c_invalidFileTime = -1;

inline FileTime file_modified (const std::string& path)
{
    struct stat st;
    if (stat(path.c_str(), &st) == -1)
        return c_invalidFileTime;
    return st.st_mtime;
}

typedef unsigned char byte;

inline int file_write (const void *buffer, int len, FILE * f)
{
    int block, remaining;
    int written;
    byte *buf;
    int tries;

    if (!f)
        return 0;

    buf = (byte *) buffer;

    remaining = len;
    tries = 0;
    while (remaining) {
        block = remaining;
        written = fwrite(buf, 1, block, f);
        if (written == 0) {
            if (!tries) {
                tries = 1;
            } else {
                g_message("file_write: 0 bytes written\n");
                return 0;
            }
        }

        if (written == -1) {
            g_message("file_write: -1 bytes written\n");
            return 0;
        }

        remaining -= written;
        buf += written;
    }
    /*  fflush(f->f); */
    return len;
}

#endif