// file.h cross platform basic file class. supports 64 bit offsets and such.

/*    Copyright 2009 10gen Inc.
 *
 *    This program is free software: you can redistribute it and/or  modify
 *    it under the terms of the GNU Affero General Public License, version 3,
 *    as published by the Free Software Foundation.
 *
 *    This program 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 Affero General Public License for more details.
 *
 *    You should have received a copy of the GNU Affero General Public License
 *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the GNU Affero General Public License in all respects
 *    for all of the code used other than as permitted herein. If you modify
 *    file(s) with this exception, you may extend this exception to your
 *    version of the file(s), but you are not obligated to do so. If you do not
 *    wish to do so, delete this exception statement from your version. If you
 *    delete this exception statement from all source files in the program,
 *    then also delete it in the license file.
 */

#pragma once

#include <cstdint>
#include <string>

#include "mongo/platform/basic.h"

namespace mongo {

typedef uint64_t fileofs;

// NOTE: not thread-safe. (at least the windows implementation isn't)

class File {
public:
    File();
    ~File();

    bool bad() const {
        return _bad;
    }
    void fsync() const;
    bool is_open() const;
    fileofs len();
    void open(const char* filename, bool readOnly = false, bool direct = false);
    void read(fileofs o, char* data, unsigned len);
    void truncate(fileofs size);
    void write(fileofs o, const char* data, unsigned len);

    static intmax_t freeSpace(const std::string& path);

private:
    bool _bad;
#ifdef _WIN32
    HANDLE _handle;
#else
    int _fd;
#endif
    std::string _name;
};
}