BinaryFile.h

/*
 * Gamedev Framework (gf)
 * Copyright (C) 2016-2018 Julien Bernard
 *
 * This software is provided 'as-is', without any express or implied
 * warranty.  In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 */
#ifndef GF_BINARY_FILE_H
#define GF_BINARY_FILE_H

#include <cstdio>

#include "ArrayRef.h"
#include "BufferRef.h"
#include "Path.h"
#include "Portability.h"

namespace gf {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
inline namespace v1 {
#endif

  class GF_API BinaryFile {
  public:
    enum class Mode {
      Read,   
      Write,  
      Append, 
    };

    BinaryFile(const Path& filename, Mode mode);

    BinaryFile(const BinaryFile&) = delete;

    BinaryFile& operator=(const BinaryFile&) = delete;

    BinaryFile(BinaryFile&& other);

    BinaryFile& operator=(BinaryFile&& other);

    ~BinaryFile();

    std::size_t write(ArrayRef<uint8_t> buffer) const;

    std::size_t write(uint8_t byte) const;

    std::size_t read(BufferRef<uint8_t> buffer) const;

    std::size_t read(uint8_t& byte) const;

    bool isEof() const;

  private:
    std::FILE *m_file;
  };

#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif
}

#endif // GF_BINARY_FILE_H