1 /* === S Y N F I G ========================================================= */
2 /*! \file synfig/module.h
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_MODULE_H
26 #define __SYNFIG_MODULE_H
28 /* === H E A D E R S ======================================================= */
43 /* === M A C R O S ========================================================= */
45 //! Marks the start of a module description
46 #define MODULE_DESC_BEGIN(x) struct x##_modclass : public synfig::Module { x##_modclass(synfig::ProgressCallback *callback=NULL);
48 //! Sets the localized name of the module
49 #define MODULE_NAME(x) virtual const char * Name() { return x; }
51 //! Sets a localized description of the module
52 #define MODULE_DESCRIPTION(x) virtual const char * Desc() { return x; }
54 //! Sets the name of the module's author
55 #define MODULE_AUTHOR(x) virtual const char * Author() { return x; }
57 //! Sets the version string for the module
58 #define MODULE_VERSION(x) virtual const char * Version() { return x; }
60 //! Sets the copyright string for the module
61 #define MODULE_COPYRIGHT(x) virtual const char * Copyright() { return x; }
63 //! Describes the module's construction function
64 #define MODULE_CONSTRUCTOR(x) bool constructor_(synfig::ProgressCallback *cb) { return x(cb); }
66 //! Describes the module's destruction function
67 #define MODULE_DESTRUCTOR(x) virtual void destructor_() { return x(); }
69 //! Marks the end of a module description
70 #define MODULE_DESC_END };
74 //! Marks the start of a module's inventory
75 #define MODULE_INVENTORY_BEGIN(x) extern "C" { \
76 synfig::Module* _##x##_LTX_new_instance(synfig::ProgressCallback *cb) \
77 { if(SYNFIG_CHECK_VERSION()){x##_modclass *mod=new x##_modclass(cb); mod->constructor_(cb); return mod; }\
78 if(cb)cb->error(#x": Unable to load module due to version mismatch."); return NULL; } \
79 }; x##_modclass::x##_modclass(synfig::ProgressCallback */*cb*/) {
81 //! Marks the start of a module's inventory
82 #define MODULE_INVENTORY_BEGIN(x) extern "C" { \
83 synfig::Module* x##_LTX_new_instance(synfig::ProgressCallback *cb) \
84 { if(SYNFIG_CHECK_VERSION()){x##_modclass *mod=new x##_modclass(cb); mod->constructor_(cb); return mod; }\
85 if(cb)cb->error(#x": Unable to load module due to version mismatch."); return NULL; } \
86 }; x##_modclass::x##_modclass(synfig::ProgressCallback */*cb*/) {
89 //! Marks the start of the layers in the module's inventory
90 #define BEGIN_LAYERS {
92 //! DEPRECATED - use #INCLUDE_LAYER(class)
93 #define LAYER(class) synfig::Layer::register_in_book(synfig::Layer::BookEntry(class::create,class::name__,dgettext("synfig",class::local_name__),dgettext("synfig",class::category__),class::cvs_id__,class::version__));
94 //#define LAYER(x) synfig::Layer::book()[synfig::String(x::name__)]=x::create;
95 #define LAYER_ALIAS(class,alias) synfig::Layer::register_in_book(synfig::Layer::BookEntry(class::create,alias,alias,CATEGORY_DO_NOT_USE,class::cvs_id__,class::version__));
97 //! Marks the end of the layers in the module's inventory
100 //! Marks the start of the targets in the module's inventory
101 #define BEGIN_TARGETS {
104 synfig::Target::book()[synfig::String(x::name__)]= \
105 std::pair<synfig::Target::Factory,synfig::String> \
106 (x::create,synfig::String(x::ext__)); \
107 synfig::Target::ext_book()[synfig::String(x::ext__)]=x::name__;
109 #define TARGET_EXT(x,y) synfig::Target::ext_book()[synfig::String(y)]=x::name__;
111 //! Marks the end of the targets in the module's inventory
112 #define END_TARGETS }
114 //! Marks the start of the importers in the module's inventory
115 #define BEGIN_IMPORTERS {
117 #define IMPORTER(x) synfig::Importer::book()[synfig::String(x::ext__)]=x::create;
119 #define IMPORTER_EXT(x,y) synfig::Importer::book()[synfig::String(y)]=x::create;
121 //! Marks the end of the importers in the module's inventory
122 #define END_IMPORTERS }
124 //! Marks the start of the valuenodes in the module's inventory
125 #define BEGIN_VALUENODES { synfig::LinkableValueNode::Book &book(synfig::LinkableValueNode::book());
127 #define VALUENODE(class,name,local,version) \
128 book[name].factory=reinterpret_cast<synfig::LinkableValueNode::Factory>(&class::create); \
129 book[name].check_type=&class::check_type; \
130 book[name].local_name=local; \
131 book[name].release_version=version;
133 //! Marks the end of the valuenodes in the module's inventory
134 #define END_VALUENODES }
136 //! Marks the end of a module's inventory
137 #define MODULE_INVENTORY_END }
139 /* === T Y P E D E F S ===================================================== */
141 /* === C L A S S E S & S T R U C T S ======================================= */
145 class ProgressCallback;
150 class Module : public etl::shared_object
153 bool constructor_(synfig::ProgressCallback */*cb*/) { return true; }
154 virtual void destructor_() { }
156 typedef etl::handle<Module> Handle;
157 typedef etl::loose_handle<Module> LooseHandle;
158 typedef etl::handle<const Module> ConstHandle;
161 typedef Module*(*constructor_type)(ProgressCallback *);
162 typedef std::map<String, Handle > Book;
168 static bool subsys_init(const String &prefix);
169 static bool subsys_stop();
170 static bool register_default_modules();
172 static void Register(Handle mod);
173 static bool Register(const String &module_name, ProgressCallback *cb=NULL);
174 static inline void Register(Module *mod) { Register(Handle(mod)); }
176 virtual const char * Name() { return " "; }
177 virtual const char * Desc() { return " "; }
178 virtual const char * Author() { return " "; }
179 virtual const char * Version() { return " "; }
180 virtual const char * Copyright() { return SYNFIG_COPYRIGHT; }
182 virtual ~Module() { destructor_(); }
185 }; // END of namespace synfig
187 /* === E N D =============================================================== */