Four of the modules provide features available from the tools in the main toolbox...
[synfig.git] / synfig-core / trunk / src / synfig / module.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file synfig/module.cpp
3 **      \brief writeme
4 **
5 **      $Id$
6 **
7 **      \legal
8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 **
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.
14 **
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.
19 **      \endlegal
20 */
21 /* ========================================================================= */
22
23 /* === H E A D E R S ======================================================= */
24
25 #define SYNFIG_NO_ANGLE
26
27 #ifdef USING_PCH
28 #       include "pch.h"
29 #else
30 #ifdef HAVE_CONFIG_H
31 #       include <config.h>
32 #endif
33
34 #include "module.h"
35 #include "general.h"
36 #include <ETL/stringf>
37
38 #ifndef USE_CF_BUNDLES
39 #include <ltdl.h>
40 #endif
41
42 #endif
43
44 /* === M A C R O S ========================================================= */
45
46 /* === G L O B A L S ======================================================= */
47
48 using namespace std;
49 using namespace etl;
50 using namespace synfig;
51
52 Module::Book *synfig::Module::book_;
53
54 /* === P R O C E D U R E S ================================================= */
55
56 bool
57 Module::subsys_init(const String &prefix)
58 {
59 #ifndef USE_CF_BUNDLES
60         #ifndef SYNFIG_LTDL_NO_STATIC
61         //LTDL_SET_PRELOADED_SYMBOLS();
62         #endif
63
64         if(lt_dlinit())
65         {
66                 error(_("Errors on lt_dlinit()"));
67                 error(lt_dlerror());
68                 return false;
69         }
70
71         lt_dladdsearchdir(".");
72         lt_dladdsearchdir("~/.synfig/modules");
73         lt_dladdsearchdir((prefix+"/lib/synfig/modules").c_str());
74 #ifdef LIBDIR
75         lt_dladdsearchdir(LIBDIR"/synfig/modules");
76 #endif
77 #ifdef __APPLE__
78         lt_dladdsearchdir("/Library/Frameworks/synfig.framework/Resources/modules");
79 #endif
80         lt_dladdsearchdir("/usr/local/lib/synfig/modules");
81         lt_dladdsearchdir(".");
82 #endif
83         book_=new Book;
84         return true;
85 }
86
87 bool
88 Module::subsys_stop()
89 {
90         delete book_;
91
92 #ifndef USE_CF_BUNDLES
93         lt_dlexit();
94 #endif
95         return true;
96 }
97
98 void
99 Module::register_default_modules(ProgressCallback *callback)
100 {
101         #define REGISTER_MODULE(module) if (!Register(module, callback)) \
102                                                                                 throw std::runtime_error(strprintf(_("Unable to load module '%s'"), module))
103         REGISTER_MODULE("lyr_freetype");
104         REGISTER_MODULE("mod_geometry");
105         REGISTER_MODULE("mod_gradient");
106         REGISTER_MODULE("mod_particle");
107 }
108
109 Module::Book&
110 Module::book()
111 {
112         return *book_;
113 }
114
115 void
116 synfig::Module::Register(Module::Handle mod)
117 {
118         book()[mod->Name()]=mod;
119 }
120
121 bool
122 synfig::Module::Register(const String &module_name, ProgressCallback *callback)
123 {
124 #ifndef USE_CF_BUNDLES
125         lt_dlhandle module;
126
127         if(callback)callback->task(strprintf(_("Attempting to register \"%s\""),module_name.c_str()));
128
129         module=lt_dlopenext((string("lib")+module_name).c_str());
130         if(!module)module=lt_dlopenext(module_name.c_str());
131
132         if(!module)
133         {
134                 if(callback)callback->warning(strprintf(_("Unable to find module \"%s\" (%s)"),module_name.c_str(),lt_dlerror()));
135                 return false;
136         }
137
138         if(callback)callback->task(strprintf(_("Found module \"%s\""),module_name.c_str()));
139
140         Module::constructor_type constructor=NULL;
141         Handle mod;
142
143         if(!constructor)
144         {
145 //              if(callback)callback->task(string("looking for -> ")+module_name+"_LTX_new_instance()");
146                 constructor=(Module::constructor_type )lt_dlsym(module,(module_name+"_LTX_new_instance").c_str());
147         }
148
149         if(!constructor)
150         {
151 //              if(callback)callback->task(string("looking for -> lib")+module_name+"_LTX_new_instance()");
152                 constructor=(Module::constructor_type )lt_dlsym(module,(string("lib")+module_name+"_LTX_new_instance").c_str());
153         }
154         if(!constructor)
155         {
156 //              if(callback)callback->task(string("looking for -> lib")+module_name+"_LTX_new_instance()");
157                 constructor=(Module::constructor_type )lt_dlsym(module,(string("_lib")+module_name+"_LTX_new_instance").c_str());
158         }
159         if(!constructor)
160         {
161 //              if(callback)callback->task(string("looking for -> lib")+module_name+"_LTX_new_instance()");
162                 constructor=(Module::constructor_type )lt_dlsym(module,(string("_")+module_name+"_LTX_new_instance").c_str());
163         }
164
165         if(constructor)
166         {
167 //              if(callback)callback->task(strprintf("Executing callback for \"%s\"",module_name.c_str()));
168                 mod=handle<Module>((*constructor)(callback));
169         }
170         else
171         {
172                 if(callback)callback->error(strprintf(_("Unable to find entrypoint in module \"%s\" (%s)"),module_name.c_str(),lt_dlerror()));
173                 return false;
174         }
175
176 //      if(callback)callback->task(strprintf("Done executing callback for \"%s\"",module_name.c_str()));
177
178         if(mod)
179         {
180 //              if(callback)callback->task(strprintf("Registering \"%s\"",module_name.c_str()));
181                 Register(mod);
182         }
183         else
184         {
185                 if(callback)callback->error(_("Entrypoint did not return a module."));
186                 return false;
187     }
188
189         if(callback)callback->task(strprintf(_("Success for \"%s\""),module_name.c_str()));
190
191 #endif
192         return true;
193 }