Enabled $Id$ expansion.
[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 bool
99 register_default_modules()
100 {
101         return true;
102 }
103
104 Module::Book&
105 Module::book()
106 {
107         return *book_;
108 }
109
110 void
111 synfig::Module::Register(Module::Handle mod)
112 {
113         book()[mod->Name()]=mod;
114 }
115
116 bool
117 synfig::Module::Register(const String &module_name, ProgressCallback *callback)
118 {
119 #ifndef USE_CF_BUNDLES
120         lt_dlhandle module;
121
122         if(callback)callback->task(strprintf(_("Attempting to register \"%s\""),module_name.c_str()));
123
124         module=lt_dlopenext((string("lib")+module_name).c_str());
125         if(!module)module=lt_dlopenext(module_name.c_str());
126
127         if(!module)
128         {
129                 if(callback)callback->warning(strprintf(_("Unable to find module \"%s\" (%s)"),module_name.c_str(),lt_dlerror()));
130                 return false;
131         }
132
133         if(callback)callback->task(strprintf(_("Found module \"%s\""),module_name.c_str()));
134
135         Module::constructor_type constructor=NULL;
136         Handle mod;
137
138         if(!constructor)
139         {
140 //              if(callback)callback->task(string("looking for -> ")+module_name+"_LTX_new_instance()");
141                 constructor=(Module::constructor_type )lt_dlsym(module,(module_name+"_LTX_new_instance").c_str());
142         }
143
144         if(!constructor)
145         {
146 //              if(callback)callback->task(string("looking for -> lib")+module_name+"_LTX_new_instance()");
147                 constructor=(Module::constructor_type )lt_dlsym(module,(string("lib")+module_name+"_LTX_new_instance").c_str());
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("_")+module_name+"_LTX_new_instance").c_str());
158         }
159
160         if(constructor)
161         {
162 //              if(callback)callback->task(strprintf("Executing callback for \"%s\"",module_name.c_str()));
163                 mod=handle<Module>((*constructor)(callback));
164         }
165         else
166         {
167                 if(callback)callback->error(strprintf(_("Unable to find entrypoint in module \"%s\" (%s)"),module_name.c_str(),lt_dlerror()));
168                 return false;
169         }
170
171 //      if(callback)callback->task(strprintf("Done executing callback for \"%s\"",module_name.c_str()));
172
173         if(mod)
174         {
175 //              if(callback)callback->task(strprintf("Registering \"%s\"",module_name.c_str()));
176                 Register(mod);
177         }
178         else
179         {
180                 if(callback)callback->error(_("Entrypoint did not return a module."));
181                 return false;
182     }
183
184         if(callback)callback->task(strprintf(_("Success for \"%s\""),module_name.c_str()));
185
186 #endif
187         return false;
188 }