synfig-core: synfig::FileContainerTemporary Class Reference

synfig-core 1.0.3

#include <filecontainertemporary.h>

Inheritance diagram for synfig::FileContainerTemporary:

Classes
struct	FileInfo

Public Member Functions
	FileContainerTemporary ()
virtual	~FileContainerTemporary ()
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, FileContainerZip::file_size_t truncate_storage_size=0)
virtual void	close ()
virtual bool	is_opened ()
virtual bool	is_file (const std::string &filename)
virtual bool	is_directory (const std::string &filename)
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)
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)
const std::string &	get_container_filename () const
const std::string &	get_temporary_filename_base () const
bool	save_temporary () const
bool	open_temporary (const std::string &filename_base)
bool	save_changes (const std::string &filename=std::string(), bool as_copy=false)
void	discard_changes ()
Public Member Functions inherited from synfig::FileContainer
	FileContainer ()
virtual	~FileContainer ()
virtual bool	file_open_read_whole_container ()
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::string	get_temporary_directory ()
static std::string	generate_temporary_filename_base ()
static std::string	generate_temporary_filename ()

Additional Inherited Members
Public Types inherited from synfig::FileSystem
typedef etl::handle< FileSystem >	Handle
typedef etl::handle< ReadStream >	ReadStreamHandle
typedef etl::handle< WriteStream >	WriteStreamHandle
Protected Attributes inherited from synfig::FileContainer
bool	stream_opened_
bool	stream_valid_

Constructor & Destructor Documentation

FileContainerTemporary::FileContainerTemporary ( )

FileContainerTemporary::~FileContainerTemporary ( )

virtual

References close().

Member Function Documentation

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

virtual

Implements synfig::FileContainer.

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

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

virtual

Implements synfig::FileContainer.

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

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

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

void FileContainerTemporary::close ( )

virtual

Implements synfig::FileContainer.

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

Referenced by ~FileContainerTemporary().

bool FileContainerTemporary::is_opened ( )

virtual

Implements synfig::FileContainer.

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

bool FileContainerTemporary::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 FileContainerTemporary::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 FileContainerTemporary::directory_create ( const std::string & dirname )

virtual

Implements synfig::FileSystem.

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

bool FileContainerTemporary::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 FileContainerTemporary::file_remove ( const std::string & filename )

virtual

Implements synfig::FileSystem.

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

bool FileContainerTemporary::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 FileContainerTemporary::file_open_write ( const std::string & filename )

virtual

Implements synfig::FileContainer.

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

void FileContainerTemporary::file_close ( )

virtual

Reimplemented from synfig::FileContainer.

Referenced by close(), and discard_changes().

bool FileContainerTemporary::file_is_opened_for_read ( )

virtual

Implements synfig::FileContainer.

References is_opened().

Referenced by file_read().

bool FileContainerTemporary::file_is_opened_for_write ( )

virtual

Implements synfig::FileContainer.

References is_opened().

Referenced by file_write().

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

virtual

Implements synfig::FileContainer.

References file_is_opened_for_read().

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

virtual

Implements synfig::FileContainer.

References file_is_opened_for_write().

std::string FileContainerTemporary::get_temporary_directory ( )

static

Referenced by discard_changes(), generate_temporary_filename(), open_temporary(), and save_temporary().

std::string FileContainerTemporary::generate_temporary_filename_base ( )

static

References synfig::GUID::get_string().

Referenced by discard_changes(), and generate_temporary_filename().

std::string FileContainerTemporary::generate_temporary_filename ( )

static

References generate_temporary_filename_base(), and get_temporary_directory().

Referenced by file_open_write().

const std::string& synfig::FileContainerTemporary::get_container_filename ( ) const

inline

const std::string& synfig::FileContainerTemporary::get_temporary_filename_base ( ) const

inline

Referenced by discard_changes(), and save_temporary().

bool FileContainerTemporary::save_temporary ( ) const

References synfig::error(), get_temporary_directory(), and get_temporary_filename_base().

bool FileContainerTemporary::open_temporary ( const std::string & filename_base )

References get_temporary_directory(), synfig::info(), and is_opened().

bool FileContainerTemporary::save_changes	(	const std::string &	filename = `std::string()`,
		bool	as_copy = `false`
	)

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

void FileContainerTemporary::discard_changes ( )

References file_close(), generate_temporary_filename_base(), get_temporary_directory(), get_temporary_filename_base(), and is_opened().

Referenced by close().

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