filecontainer.h

Go to the documentation of this file.

/* === S Y N F I G ========================================================= */
/* ========================================================================= */

/* === S T A R T =========================================================== */

#ifndef __SYNFIG_FILECONTAINER_H
#define __SYNFIG_FILECONTAINER_H

/* === H E A D E R S ======================================================= */

#include <list>
#include "filesystem.h"

/* === M A C R O S ========================================================= */

/* === T Y P E D E F S ===================================================== */

/* === C L A S S E S & S T R U C T S ======================================= */

namespace synfig
{

    class FileContainer : public FileSystem
    {
    public:
        class ReadStream : public FileSystem::ReadStream
        {
        protected:
            friend class FileContainer;
            ReadStream(Handle file_system);
            virtual size_t internal_read(void *buffer, size_t size);
        public:
            virtual ~ReadStream();
        };

        class WriteStream : public FileSystem::WriteStream
        {
        protected:
            friend class FileContainer;
            WriteStream(Handle file_system);
            virtual size_t internal_write(const void *buffer, size_t size);
        public:
            virtual ~WriteStream();
        };

    protected:
        bool stream_opened_;
        bool stream_valid_;

    public:
        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;

        inline bool file_is_opened()
        {
            return file_is_opened_for_read() || file_is_opened_for_write();
        }

        ReadStreamHandle get_read_stream_whole_container();
        virtual ReadStreamHandle get_read_stream(const std::string &filename);
        virtual WriteStreamHandle get_write_stream(const std::string &filename);
    };

}

/* === E N D =============================================================== */

#endif