Delete svn tags. We don't need them in git
[synfig.git] / synfig-core / trunk / src / synfig / module.h
1 /* === S Y N F I G ========================================================= */
2 /*!     \file synfig/module.h
3 **      \brief writeme
4 **
5 **      $Id$
6 **
7 **      \legal
8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 **      Copyright (c) 2007, 2008 Chris Moore
10 **
11 **      This package is free software; you can redistribute it and/or
12 **      modify it under the terms of the GNU General Public License as
13 **      published by the Free Software Foundation; either version 2 of
14 **      the License, or (at your option) any later version.
15 **
16 **      This package is distributed in the hope that it will be useful,
17 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
18 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 **      General Public License for more details.
20 **      \endlegal
21 */
22 /* ========================================================================= */
23
24 /* === S T A R T =========================================================== */
25
26 #ifndef __SYNFIG_MODULE_H
27 #define __SYNFIG_MODULE_H
28
29 /* === H E A D E R S ======================================================= */
30
31 #include "general.h"
32 #include <ETL/handle>
33 #include <map>
34 #include "string.h"
35 #include "releases.h"
36 #include <utility>
37 #include "vector.h"
38 #include "color.h"
39 #include "layer.h"
40 #include "canvas.h"
41
42 //#include "value.h"
43
44 /* === M A C R O S ========================================================= */
45
46 //! Marks the start of a module description
47 #define MODULE_DESC_BEGIN(x) struct x##_modclass : public synfig::Module { x##_modclass(synfig::ProgressCallback *callback=NULL);
48
49 //! Sets the localized name of the module
50 #define MODULE_NAME(x)                  virtual const char * Name() { return x; }
51
52 //! Sets a localized description of the module
53 #define MODULE_DESCRIPTION(x)   virtual const char * Desc() { return x; }
54
55 //! Sets the name of the module's author
56 #define MODULE_AUTHOR(x)                virtual const char * Author() { return x; }
57
58 //! Sets the version string for the module
59 #define MODULE_VERSION(x)               virtual const char * Version() { return x; }
60
61 //! Sets the copyright string for the module
62 #define MODULE_COPYRIGHT(x)             virtual const char * Copyright() { return x; }
63
64 //! Describes the module's construction function
65 #define MODULE_CONSTRUCTOR(x)   bool constructor_(synfig::ProgressCallback *cb) { return x(cb); }
66
67 //! Describes the module's destruction function
68 #define MODULE_DESTRUCTOR(x)    virtual void destructor_() { return x(); }
69
70 //! Marks the end of a module description
71 #define MODULE_DESC_END };
72
73 //#if 0
74 #ifdef __APPLE__
75 //! Marks the start of a module's inventory
76 #define MODULE_INVENTORY_BEGIN(x)  extern "C" {         \
77         synfig::Module* _##x##_LTX_new_instance(synfig::ProgressCallback *cb) \
78         { if(SYNFIG_CHECK_VERSION()){x##_modclass *mod=new x##_modclass(cb); mod->constructor_(cb); return mod; }\
79         if(cb)cb->error(#x": Unable to load module due to version mismatch."); return NULL; } \
80         }; x##_modclass::x##_modclass(synfig::ProgressCallback */*cb*/) {
81 #else
82 //! Marks the start of a module's inventory
83 #define MODULE_INVENTORY_BEGIN(x)  extern "C" {         \
84         synfig::Module* x##_LTX_new_instance(synfig::ProgressCallback *cb) \
85         { if(SYNFIG_CHECK_VERSION()){x##_modclass *mod=new x##_modclass(cb); mod->constructor_(cb); return mod; }\
86         if(cb)cb->error(#x": Unable to load module due to version mismatch."); return NULL; } \
87         }; x##_modclass::x##_modclass(synfig::ProgressCallback */*cb*/) {
88 #endif
89
90 //! Marks the start of the layers in the module's inventory
91 #define BEGIN_LAYERS {
92
93 //! DEPRECATED - use #INCLUDE_LAYER(class)
94 #define LAYER(class)                                                                                                                                                    \
95         synfig::Layer::register_in_book(                                                                                                                        \
96                 synfig::Layer::BookEntry(class::create,                                                                                                 \
97                                                                  class::name__,                                                                                                 \
98                                                                  dgettext("synfig", class::local_name__),                                               \
99                                                                  class::category__,                                                                                             \
100                                                                  class::cvs_id__,                                                                                               \
101                                                                  class::version__));
102
103 #define LAYER_ALIAS(class,alias)                                                                                                                                \
104         synfig::Layer::register_in_book(                                                                                                                        \
105                 synfig::Layer::BookEntry(class::create,                                                                                                 \
106                                                                  alias,                                                                                                                 \
107                                                                  alias,                                                                                                                 \
108                                                                  CATEGORY_DO_NOT_USE,                                                                                   \
109                                                                  class::cvs_id__,                                                                                               \
110                                                                  class::version__));
111
112 //! Marks the end of the layers in the module's inventory
113 #define END_LAYERS }
114
115 //! Marks the start of the targets in the module's inventory
116 #define BEGIN_TARGETS {
117
118 #define TARGET(x)                                                                                                                                                               \
119         synfig::Target::book()[synfig::String(x::name__)]=                                                                                      \
120                 std::pair<synfig::Target::Factory,synfig::String>                                                                               \
121                         (x::create,synfig::String(x::ext__));                                                                                           \
122         synfig::Target::ext_book()[synfig::String(x::ext__)]=x::name__;
123
124 #define TARGET_EXT(x,y) synfig::Target::ext_book()[synfig::String(y)]=x::name__;
125
126 //! Marks the end of the targets in the module's inventory
127 #define END_TARGETS }
128
129 //! Marks the start of the importers in the module's inventory
130 #define BEGIN_IMPORTERS {
131
132 #define IMPORTER(x) synfig::Importer::book()[synfig::String(x::ext__)]=x::create;
133
134 #define IMPORTER_EXT(x,y) synfig::Importer::book()[synfig::String(y)]=x::create;
135
136 //! Marks the end of the importers in the module's inventory
137 #define END_IMPORTERS }
138
139 //! Marks the start of the valuenodes in the module's inventory
140 #define BEGIN_VALUENODES { synfig::LinkableValueNode::Book &book(synfig::LinkableValueNode::book());
141
142 #define VALUENODE(class,name,local,version)                                                                                                             \
143         book[name].factory=reinterpret_cast<synfig::LinkableValueNode::Factory>(&class::create);        \
144         book[name].check_type=&class::check_type;                                                                                                       \
145         book[name].local_name=local;                                                                                                                            \
146         book[name].release_version=version;
147
148 //! Marks the end of the valuenodes in the module's inventory
149 #define END_VALUENODES }
150
151 //! Marks the end of a module's inventory
152 #define MODULE_INVENTORY_END    }
153
154 /* === T Y P E D E F S ===================================================== */
155
156 /* === C L A S S E S & S T R U C T S ======================================= */
157
158 namespace synfig {
159
160 class ProgressCallback;
161
162 /*!     \class Module
163 **      \todo writeme
164 */
165 class Module : public etl::shared_object
166 {
167 public:
168         bool constructor_(synfig::ProgressCallback */*cb*/) { return true; }
169         virtual void destructor_() { }
170
171         typedef etl::handle<Module> Handle;
172         typedef etl::loose_handle<Module> LooseHandle;
173         typedef etl::handle<const Module> ConstHandle;
174
175 public:
176         typedef Module*(*constructor_type)(ProgressCallback *);
177         typedef std::map<String, Handle > Book;
178 private:
179         static Book* book_;
180 public:
181         static Book& book();
182
183         static bool subsys_init(const String &prefix);
184         static bool subsys_stop();
185         static void register_default_modules(ProgressCallback *cb=NULL);
186
187         static void Register(Handle mod);
188         static bool Register(const String &module_name, ProgressCallback *cb=NULL);
189         static inline void Register(Module *mod) { Register(Handle(mod)); }
190
191         virtual const char * Name() { return " "; }
192         virtual const char * Desc() { return " "; }
193         virtual const char * Author() { return " "; }
194         virtual const char * Version() { return " "; }
195         virtual const char * Copyright() { return SYNFIG_COPYRIGHT; }
196
197         virtual ~Module() { destructor_(); }
198 };
199
200 }; // END of namespace synfig
201
202 /* === E N D =============================================================== */
203
204 #endif