file.h

Go to the documentation of this file.

#ifndef UGDK_FILESYSTEM_FILE_H_
#define UGDK_FILESYSTEM_FILE_H_

#include <ugdk/filesystem.h>
#include <ugdk/structure/types.h>
#include <cstddef>
#include <string>

namespace ugdk {
namespace filesystem {

enum class SeekPositions {
    BEGINNING, CURRENT, END
};

class File {
  public:
    virtual ~File() {}

    virtual std::string filename() const = 0;

    virtual int64 size() const = 0;

    virtual int64 Seek(int64 offset, SeekPositions whence) = 0;

    int64 Tell();

    virtual std::size_t ReadRaw(void* ptr, std::size_t size, std::size_t maxnum) = 0;

    template <class T>
    std::size_t Read(T* ptr, std::size_t maxnum = 1) {
        return ReadRaw(ptr, sizeof(T), maxnum);
    }

    virtual std::size_t WriteRaw(const void* ptr, std::size_t size, std::size_t num) = 0;

    template <class T>
    std::size_t Write(const T* ptr, std::size_t num = 1) {
        return WriteRaw(ptr, sizeof(T), num);
    }

    virtual bool Close() = 0;

    std::string GetContents();

    bool CanSeek();

    int fgetc();

    char* fgets(char* str, int count);

  protected:
    File() {}    
};

}  // namespace filesystem
}  // namespace ugdk

#endif  // UGDK_FILESYSTEM_FILE_H_