openMSX: openmsx::FileBase Class Reference

openMSX

#include <FileBase.hh>

Inheritance diagram for openmsx::FileBase:

Inheritance graph

[legend]

Public Member Functions
virtual	~FileBase ()=default

virtual void	read (void *buffer, size_t num)=0

virtual void	write (const void *buffer, size_t num)=0

virtual span< const uint8_t >	mmap ()

virtual void	munmap ()

virtual size_t	getSize ()=0

virtual void	seek (size_t pos)=0

virtual size_t	getPos ()=0

virtual void	truncate (size_t size)

virtual void	flush ()=0

virtual const std::string &	getURL () const =0

virtual std::string	getLocalReference ()

virtual std::string_view	getOriginalName ()

virtual bool	isReadOnly () const =0

virtual time_t	getModificationDate ()=0

Detailed Description

Definition at line 11 of file FileBase.hh.

Constructor & Destructor Documentation

◆ ~FileBase()

virtual openmsx::FileBase::~FileBase ( )

virtualdefault

Member Function Documentation

◆ flush()

virtual void openmsx::FileBase::flush ( )

pure virtual

Implemented in openmsx::MemoryBufferFile, openmsx::LocalFile, and openmsx::CompressedFileAdapter.

◆ getLocalReference()

string openmsx::FileBase::getLocalReference ( )

virtual

Reimplemented in openmsx::LocalFile.

Definition at line 51 of file FileBase.cc.

◆ getModificationDate()

virtual time_t openmsx::FileBase::getModificationDate ( )

pure virtual

Implemented in openmsx::MemoryBufferFile, openmsx::LocalFile, and openmsx::CompressedFileAdapter.

◆ getOriginalName()

std::string_view openmsx::FileBase::getOriginalName ( )

virtual

Reimplemented in openmsx::CompressedFileAdapter.

Definition at line 58 of file FileBase.cc.

References openmsx::FileOperations::getFilename(), and getURL().

◆ getPos()

virtual size_t openmsx::FileBase::getPos ( )

pure virtual

Implemented in openmsx::MemoryBufferFile, openmsx::LocalFile, and openmsx::CompressedFileAdapter.

Referenced by mmap().

◆ getSize()

virtual size_t openmsx::FileBase::getSize ( )

pure virtual

Implemented in openmsx::MemoryBufferFile, openmsx::LocalFile, and openmsx::CompressedFileAdapter.

Referenced by mmap(), and truncate().

◆ getURL()

virtual const std::string& openmsx::FileBase::getURL ( ) const

pure virtual

Implemented in openmsx::MemoryBufferFile, openmsx::LocalFile, and openmsx::CompressedFileAdapter.

Referenced by getOriginalName().

◆ isReadOnly()

virtual bool openmsx::FileBase::isReadOnly ( ) const

pure virtual

Implemented in openmsx::MemoryBufferFile, openmsx::LocalFile, and openmsx::CompressedFileAdapter.

◆ mmap()

span< const uint8_t > openmsx::FileBase::mmap ( )

virtual

Reimplemented in openmsx::LocalFile, and openmsx::CompressedFileAdapter.

Definition at line 10 of file FileBase.cc.

References openmsx::MemBuffer< T, ALIGNMENT >::data(), openmsx::MemBuffer< T, ALIGNMENT >::empty(), getPos(), getSize(), read(), seek(), and utf8::unchecked::size().

◆ munmap()

void openmsx::FileBase::munmap ( )

virtual

Reimplemented in openmsx::LocalFile, and openmsx::CompressedFileAdapter.

Definition at line 26 of file FileBase.cc.

References openmsx::MemBuffer< T, ALIGNMENT >::clear().

◆ read()

virtual void openmsx::FileBase::read	(	void *	buffer,
		size_t	num
	)

pure virtual

Implemented in openmsx::MemoryBufferFile, openmsx::LocalFile, and openmsx::CompressedFileAdapter.

Referenced by mmap().

◆ seek()

virtual void openmsx::FileBase::seek ( size_t pos )

pure virtual

Implemented in openmsx::LocalFile, openmsx::CompressedFileAdapter, and openmsx::MemoryBufferFile.

Referenced by mmap(), and truncate().

◆ truncate()

void openmsx::FileBase::truncate ( size_t size )

virtual

Reimplemented in openmsx::LocalFile, and openmsx::CompressedFileAdapter.

Definition at line 31 of file FileBase.cc.

References openmsx::BUF_SIZE, getSize(), gl::min(), seek(), and write().

◆ write()

virtual void openmsx::FileBase::write	(	const void *	buffer,
		size_t	num
	)

pure virtual

Implemented in openmsx::MemoryBufferFile, openmsx::LocalFile, and openmsx::CompressedFileAdapter.

Referenced by truncate().

The documentation for this class was generated from the following files: