1 /* === S Y N F I G ========================================================= */
3 ** \brief It is the base class for all the importers.
8 ** Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
10 ** This package is free software; you can redistribute it and/or
11 ** modify it under the terms of the GNU General Public License as
12 ** published by the Free Software Foundation; either version 2 of
13 ** the License, or (at your option) any later version.
15 ** This package is distributed in the hope that it will be useful,
16 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 ** General Public License for more details.
21 /* ========================================================================= */
23 /* === S T A R T =========================================================== */
25 #ifndef __SYNFIG_IMPORTER_H
26 #define __SYNFIG_IMPORTER_H
28 /* === H E A D E R S ======================================================= */
37 /* === M A C R O S ========================================================= */
39 //! Defines various variables and the create method, common for all importers.
40 //! To be used in the private part of the importer class definition.
41 #define SYNFIG_IMPORTER_MODULE_EXT \
42 public: static const char name__[], version__[], ext__[],cvs_id__[]; \
43 static Importer *create(const char *filename);
45 //! Sets the name of the importer.
46 #define SYNFIG_IMPORTER_SET_NAME(class,x) const char class::name__[]=x
48 //! Sets the primary file extension of the importer.
49 #define SYNFIG_IMPORTER_SET_EXT(class,x) const char class::ext__[]=x
51 //! Sets the version of the importer.
52 #define SYNFIG_IMPORTER_SET_VERSION(class,x) const char class::version__[]=x
54 //! Sets the CVS ID of the importer.
55 #define SYNFIG_IMPORTER_SET_CVS_ID(class,x) const char class::cvs_id__[]=x
57 //! Defines de implementation of the create method for the importer
58 //! \param filename The file name to be imported by the importer.
59 #define SYNFIG_IMPORTER_INIT(class) synfig::Importer* class::create(const char *filename) { return new class(filename); }
61 /* === T Y P E D E F S ===================================================== */
63 /* === C L A S S E S & S T R U C T S ======================================= */
68 class ProgressCallback;
71 ** \brief Used for importing bitmaps of various formats, including animations.
73 * It is the base class for all the importers. It defines the has a static Book
74 * pointer class that is a map for the importers factory creators and the strings
75 * of the extension that the importer can understand. It allows to create the a
76 * pointer to a particular importer just by using the extension of the name of file
77 * to import. Also it creates a virtual member get_frame that must be declared in
78 * the inherited classes.
82 class Importer : public etl::shared_object
85 //! Type that represents a pointer to a Importer's constructor.
86 //! As a pointer to the constructor, it represents a "factory" of importers.
87 typedef Importer* (*Factory)(const char *filename);
88 typedef std::map<String,Factory> Book;
93 //! Initializes the Import module by creating a book of importers names
94 //! and its creators and the list of open importers
95 static bool subsys_init();
96 //! Stops the Import module by deleting the book and the list of open
98 static bool subsys_stop();
100 typedef etl::handle<Importer> Handle;
101 typedef etl::loose_handle<Importer> LooseHandle;
102 typedef etl::handle<const Importer> ConstHandle;
105 //! Gamma of the importer.
106 //! \todo Do not hardcode the gamma to 2.2
114 Gamma& gamma() { return gamma_; }
115 const Gamma& gamma()const { return gamma_; }
119 //! Gets a frame and puts it into \a surface
120 /*! \param surface Reference to surface to put frame into
121 ** \param time For animated importers, determines which frame to get.
122 ** For static importers, this parameter is unused.
123 ** \param callback Pointer to callback class for progress, errors, etc.
124 ** \return \c true on success, \c false on error
125 ** \see ProgressCallback, Surface
127 virtual bool get_frame(Surface &surface,Time time, ProgressCallback *callback=NULL)=0;
128 virtual bool get_frame(Surface &surface,Time time,
129 bool &trimmed __attribute__ ((unused)),
130 unsigned int &width __attribute__ ((unused)),
131 unsigned int &height __attribute__ ((unused)),
132 unsigned int &top __attribute__ ((unused)),
133 unsigned int &left __attribute__ ((unused)),
134 ProgressCallback *callback=NULL)
136 return get_frame(surface,time,callback);
139 //! Returns \c true if the importer pays attention to the \a time parameter of get_frame()
140 virtual bool is_animated() { return false; }
142 //! Attempts to open \a filename, and returns a handle to the associated Importer
143 static Handle open(const String &filename);
146 }; // END of namespace synfig
148 /* === E N D =============================================================== */