synfig-core: synfig::FileContainerZip Class Reference

synfig-core 1.0.3

#include <filecontainerzip.h>

Inheritance diagram for synfig::FileContainerZip:

Classes
struct	FileInfo
struct	HistoryRecord
class	WholeZipReadStream

Public Types
typedef long long int	file_size_t

Public Member Functions
	FileContainerZip ()
virtual	~FileContainerZip ()
virtual bool	create (const std::string &container_filename)
virtual bool	open (const std::string &container_filename)
bool	open_from_history (const std::string &container_filename, file_size_t truncate_storage_size=0)
virtual void	close ()
virtual bool	is_opened ()
bool	save ()
virtual bool	is_file (const std::string &filename)
virtual bool	is_directory (const std::string &filename)
bool	directory_check_name (const std::string &dirname)
virtual bool	directory_create (const std::string &dirname)
virtual bool	directory_scan (const std::string &dirname, std::list< std::string > &out_files)
virtual bool	file_remove (const std::string &filename)
bool	file_check_name (const std::string &filename)
virtual bool	file_open_read_whole_container ()
virtual bool	file_open_read (const std::string &filename)
virtual bool	file_open_write (const std::string &filename)
virtual void	file_close ()
virtual bool	file_is_opened_for_read ()
virtual bool	file_is_opened_for_write ()
virtual size_t	file_read (void *buffer, size_t size)
virtual size_t	file_write (const void *buffer, size_t size)
Public Member Functions inherited from synfig::FileContainer
	FileContainer ()
virtual	~FileContainer ()
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	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)

Static Public Member Functions
static std::list< HistoryRecord >	read_history (const std::string &container_filename)

Additional Inherited Members
Protected Attributes inherited from synfig::FileContainer
bool	stream_opened_
bool	stream_valid_

Member Typedef Documentation

typedef long long int synfig::FileContainerZip::file_size_t

Constructor & Destructor Documentation

FileContainerZip::FileContainerZip ( )

FileContainerZip::~FileContainerZip ( )

virtual

References close().

Member Function Documentation

bool FileContainerZip::create ( const std::string & container_filename )

virtual

Implements synfig::FileContainer.

References synfig::FileSystem::fix_slashes(), and is_opened().

bool FileContainerZip::open ( const std::string & container_filename )

virtual

Implements synfig::FileContainer.

References open_from_history().

bool FileContainerZip::open_from_history	(	const std::string &	container_filename,
		file_size_t	truncate_storage_size = `0`
	)

References synfig::FileSystem::fix_slashes(), synfig::info(), and is_opened().

Referenced by open().

void FileContainerZip::close ( )

virtual

Implements synfig::FileContainer.

References file_close(), is_opened(), and save().

Referenced by ~FileContainerZip().

bool FileContainerZip::is_opened ( )

virtual

Implements synfig::FileContainer.

Referenced by close(), create(), directory_create(), file_is_opened_for_read(), file_is_opened_for_write(), file_open_read(), file_open_read_whole_container(), file_open_write(), is_directory(), is_file(), and open_from_history().

bool FileContainerZip::save ( )

References synfig::FileContainer::file_is_opened(), and synfig::info().

Referenced by close().

std::list< FileContainerZip::HistoryRecord > FileContainerZip::read_history ( const std::string & container_filename )

static

bool FileContainerZip::is_file ( const std::string & filename )

virtual

Implements synfig::FileSystem.

References synfig::FileSystem::fix_slashes(), and is_opened().

Referenced by directory_create(), and file_remove().

bool FileContainerZip::is_directory ( const std::string & filename )

virtual

Implements synfig::FileSystem.

References synfig::FileSystem::fix_slashes(), and is_opened().

Referenced by directory_create(), directory_scan(), file_open_write(), and file_remove().

bool FileContainerZip::directory_check_name ( const std::string & dirname )

Referenced by directory_create().

bool FileContainerZip::directory_create ( const std::string & dirname )

virtual

Implements synfig::FileSystem.

References directory_check_name(), synfig::FileSystem::fix_slashes(), synfig::info(), is_directory(), is_file(), and is_opened().

bool FileContainerZip::directory_scan	(	const std::string &	dirname,
		std::list< std::string > &	out_files
	)

virtual

Implements synfig::FileContainer.

References synfig::FileSystem::fix_slashes(), and is_directory().

Referenced by file_remove().

bool FileContainerZip::file_remove ( const std::string & filename )

virtual

Implements synfig::FileSystem.

References directory_scan(), synfig::FileContainer::file_is_opened(), synfig::FileSystem::fix_slashes(), is_directory(), and is_file().

bool FileContainerZip::file_check_name ( const std::string & filename )

Referenced by file_open_write().

bool FileContainerZip::file_open_read_whole_container ( )

virtual

Reimplemented from synfig::FileContainer.

References synfig::FileContainer::file_is_opened(), and is_opened().

bool FileContainerZip::file_open_read ( const std::string & filename )

virtual

Implements synfig::FileContainer.

References synfig::FileContainer::file_is_opened(), synfig::FileSystem::fix_slashes(), and is_opened().

bool FileContainerZip::file_open_write ( const std::string & filename )

virtual

Implements synfig::FileContainer.

References file_check_name(), synfig::FileContainer::file_is_opened(), synfig::FileSystem::fix_slashes(), synfig::info(), is_directory(), and is_opened().

void FileContainerZip::file_close ( )

virtual

Reimplemented from synfig::FileContainer.

References file_is_opened_for_write().

Referenced by close().

bool FileContainerZip::file_is_opened_for_read ( )

virtual

Implements synfig::FileContainer.

References is_opened().

Referenced by file_read().

bool FileContainerZip::file_is_opened_for_write ( )

virtual

Implements synfig::FileContainer.

References is_opened().

Referenced by file_close(), and file_write().

size_t FileContainerZip::file_read	(	void *	buffer,
		size_t	size
	)

virtual

Implements synfig::FileContainer.

References file_is_opened_for_read().

size_t FileContainerZip::file_write	(	const void *	buffer,
		size_t	size
	)

virtual

Implements synfig::FileContainer.

References file_is_opened_for_write().

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