File.hpp

Go to the documentation of this file.

// ======================================================================
// \title Os/Posix/File.hpp
// \brief posix implementation for Os::File, header and test definitions
// ======================================================================
#include <Os/File.hpp>
#ifndef OS_POSIX_FILE_HPP
#define OS_POSIX_FILE_HPP
 
namespace Os {
namespace Posix {
namespace File {
 
struct PosixFileHandle : public FileHandle {
    static constexpr PlatformIntType INVALID_FILE_DESCRIPTOR = -1;
    static constexpr PlatformIntType ERROR_RETURN_VALUE = -1;
 
    PlatformIntType m_file_descriptor = INVALID_FILE_DESCRIPTOR;
};
 
class PosixFile : public FileInterface {
  public:
    PosixFile() = default;
 
#ifdef TGT_OS_TYPE_VXWORKS
    // Adding this pound-if-define code to allow building VxWorks for POSIX.
    // Better than the alternative of copying this entire file to the VxWorks repo
    // and removing this line.
    PosixFile(const PosixFile& other) = delete;
#else
    PosixFile(const PosixFile& other);
#endif
 
#ifdef TGT_OS_TYPE_VXWORKS
    // Adding this pound-if-define code to allow building VxWorks for POSIX.
    // Better than the alternative of copying this entire file to the VxWorks repo
    // and removing this line.
    PosixFile& operator=(const PosixFile& other) = delete;
#else
    PosixFile& operator=(const PosixFile& other);
#endif
 
    ~PosixFile() override = default;
 
    // ------------------------------------
    // Functions overrides
    // ------------------------------------
 
    Os::FileInterface::Status open(const char* path, Mode mode, OverwriteType overwrite) override;
 
    void close() override;
 
    Status size(FwSignedSizeType& size_result) override;
 
    Status position(FwSignedSizeType& position_result) override;
 
    Status preallocate(FwSignedSizeType offset, FwSignedSizeType length) override;
 
    Status seek(FwSignedSizeType offset, SeekType seekType) override;
 
    Status flush() override;
 
    Status read(U8* buffer, FwSignedSizeType& size, WaitType wait) override;
 
    Status write(const U8* buffer, FwSignedSizeType& size, WaitType wait) override;
 
    FileHandle* getHandle() override;
 
  private:
    PosixFileHandle m_handle;
};
}  // namespace File
}  // namespace Posix
}  // namespace Os
 
#endif  // OS_POSIX_FILE_HPP