synfig-core: synfig::FileContainer Class Reference

synfig-core 1.0.3

#include <filecontainer.h>

Inheritance diagram for synfig::FileContainer:

Classes
class	ReadStream
class	WriteStream

Public Member Functions
	FileContainer ()
virtual	~FileContainer ()
virtual bool	create (const std::string &container_filename)=0
virtual bool	open (const std::string &container_filename)=0
virtual void	close ()=0
virtual bool	is_opened ()=0
virtual bool	directory_scan (const std::string &dirname, std::list< std::string > &out_files)=0
virtual bool	file_open_read_whole_container ()
virtual bool	file_open_read (const std::string &filename)=0
virtual bool	file_open_write (const std::string &filename)=0
virtual void	file_close ()
virtual bool	file_is_opened_for_read ()=0
virtual bool	file_is_opened_for_write ()=0
virtual size_t	file_read (void *buffer, size_t size)=0
virtual size_t	file_write (const void *buffer, size_t size)=0
bool	file_is_opened ()
ReadStreamHandle	get_read_stream_whole_container ()
virtual ReadStreamHandle	get_read_stream (const std::string &filename)
virtual WriteStreamHandle	get_write_stream (const std::string &filename)
Public Member Functions inherited from synfig::FileSystem
	FileSystem ()
virtual	~FileSystem ()
virtual bool	is_file (const std::string &filename)=0
virtual bool	is_directory (const std::string &filename)=0
virtual bool	directory_create (const std::string &dirname)=0
virtual bool	file_remove (const std::string &filename)=0
virtual bool	file_rename (const std::string &from_filename, const std::string &to_filename)
bool	is_exists (const std::string filename)
Identifier	get_identifier (const std::string &filename)

Protected Attributes
bool	stream_opened_
bool	stream_valid_

Additional Inherited Members
Public Types inherited from synfig::FileSystem
typedef etl::handle< FileSystem >	Handle
typedef etl::handle< ReadStream >	ReadStreamHandle
typedef etl::handle< WriteStream >	WriteStreamHandle
Static Public Member Functions inherited from synfig::FileSystem
static bool	copy (Handle from_file_system, const std::string &from_filename, Handle to_file_system, const std::string &to_filename)
static std::string	fix_slashes (const std::string &filename)
static std::istream &	safeGetline (std::istream &is, std::string &t)
	!

Constructor & Destructor Documentation

FileContainer::FileContainer ( )

FileContainer::~FileContainer ( )

virtual

Member Function Documentation

virtual bool synfig::FileContainer::create ( const std::string & container_filename )

pure virtual

Implemented in synfig::FileContainerZip, and synfig::FileContainerTemporary.

virtual bool synfig::FileContainer::open ( const std::string & container_filename )

pure virtual

Implemented in synfig::FileContainerZip, and synfig::FileContainerTemporary.

virtual void synfig::FileContainer::close ( )

pure virtual

Implemented in synfig::FileContainerZip, and synfig::FileContainerTemporary.

virtual bool synfig::FileContainer::is_opened ( )

pure virtual

Implemented in synfig::FileContainerZip, and synfig::FileContainerTemporary.

virtual bool synfig::FileContainer::directory_scan	(	const std::string &	dirname,
		std::list< std::string > &	out_files
	)

pure virtual

Implemented in synfig::FileContainerZip, and synfig::FileContainerTemporary.

bool FileContainer::file_open_read_whole_container ( )

virtual

Reimplemented in synfig::FileContainerZip.

Referenced by get_read_stream_whole_container().

virtual bool synfig::FileContainer::file_open_read ( const std::string & filename )

pure virtual

Implemented in synfig::FileContainerZip, and synfig::FileContainerTemporary.

Referenced by get_read_stream().

virtual bool synfig::FileContainer::file_open_write ( const std::string & filename )

pure virtual

Implemented in synfig::FileContainerZip, and synfig::FileContainerTemporary.

Referenced by get_write_stream().

void FileContainer::file_close ( )

virtual

Reimplemented in synfig::FileContainerZip, and synfig::FileContainerTemporary.

References stream_valid_.

virtual bool synfig::FileContainer::file_is_opened_for_read ( )

pure virtual

Implemented in synfig::FileContainerZip, and synfig::FileContainerTemporary.

Referenced by file_is_opened().

virtual bool synfig::FileContainer::file_is_opened_for_write ( )

pure virtual

Implemented in synfig::FileContainerZip, and synfig::FileContainerTemporary.

Referenced by file_is_opened().

virtual size_t synfig::FileContainer::file_read	(	void *	buffer,
		size_t	size
	)

pure virtual

Implemented in synfig::FileContainerZip, and synfig::FileContainerTemporary.

virtual size_t synfig::FileContainer::file_write	(	const void *	buffer,
		size_t	size
	)

pure virtual

Implemented in synfig::FileContainerZip, and synfig::FileContainerTemporary.

bool synfig::FileContainer::file_is_opened ( )

inline

References file_is_opened_for_read(), and file_is_opened_for_write().

Referenced by synfig::FileContainerTemporary::file_open_read(), synfig::FileContainerZip::file_open_read(), synfig::FileContainerZip::file_open_read_whole_container(), synfig::FileContainerTemporary::file_open_write(), synfig::FileContainerZip::file_open_write(), synfig::FileContainerTemporary::file_remove(), synfig::FileContainerZip::file_remove(), synfig::FileContainerZip::save(), and synfig::FileContainerTemporary::save_changes().

FileSystem::ReadStreamHandle FileContainer::get_read_stream_whole_container ( )

References file_open_read_whole_container(), stream_opened_, and stream_valid_.

FileSystem::ReadStreamHandle FileContainer::get_read_stream ( const std::string & filename )

virtual

Implements synfig::FileSystem.

References file_open_read(), stream_opened_, and stream_valid_.

FileSystem::WriteStreamHandle FileContainer::get_write_stream ( const std::string & filename )

virtual

Implements synfig::FileSystem.

References file_open_write(), stream_opened_, and stream_valid_.

Member Data Documentation

bool synfig::FileContainer::stream_opened_

protected

Referenced by get_read_stream(), get_read_stream_whole_container(), and get_write_stream().

bool synfig::FileContainer::stream_valid_

protected

Referenced by file_close(), get_read_stream(), get_read_stream_whole_container(), and get_write_stream().

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