|
428
|
1 /* emodules.c - Support routines for dynamic module loading
|
|
|
2 (C) Copyright 1998, 1999 J. Kean Johnston. All rights reserved.
|
|
|
3
|
|
|
4 This file is part of XEmacs.
|
|
|
5
|
|
|
6 XEmacs is free software; you can redistribute it and/or modify it
|
|
|
7 under the terms of the GNU General Public License as published by the
|
|
|
8 Free Software Foundation; either version 2, or (at your option) any
|
|
|
9 later version.
|
|
|
10
|
|
|
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
|
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
|
14 for more details.
|
|
|
15
|
|
|
16 You should have received a copy of the GNU General Public License
|
|
|
17 along with XEmacs; see the file COPYING. If not, write to
|
|
|
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
19 Boston, MA 02111-1307, USA. */
|
|
|
20
|
|
|
21 #include "emodules.h"
|
|
|
22 #include "sysdll.h"
|
|
|
23
|
|
|
24 #ifdef HAVE_SHLIB
|
|
|
25
|
|
|
26 /* CE-Emacs version number */
|
|
|
27 Lisp_Object Vmodule_version;
|
|
|
28
|
|
|
29 /* Do we do our work quietly? */
|
|
|
30 int load_modules_quietly;
|
|
|
31
|
|
|
32 /* Load path */
|
|
|
33 Lisp_Object Vmodule_load_path;
|
|
|
34
|
|
|
35 typedef struct _emodules_list
|
|
|
36 {
|
|
|
37 int used; /* Is this slot used? */
|
|
|
38 char *soname; /* Name of the shared object loaded (full path) */
|
|
|
39 char *modname; /* The name of the module */
|
|
|
40 char *modver; /* The version that the module is at */
|
|
|
41 char *modtitle; /* How the module announces itself */
|
|
|
42 dll_handle dlhandle; /* Dynamic lib handle */
|
|
|
43 } emodules_list;
|
|
|
44
|
|
|
45 static Lisp_Object Vmodule_extensions;
|
|
|
46
|
|
|
47 static int emodules_depth;
|
|
|
48 static dll_handle dlhandle;
|
|
|
49 static emodules_list *modules;
|
|
|
50 static int modnum;
|
|
|
51
|
|
442
|
52 static int find_make_module (const char *mod, const char *name, const char *ver, int make_or_find);
|
|
428
|
53 static Lisp_Object module_load_unwind (Lisp_Object);
|
|
|
54 static void attempt_module_delete (int mod);
|
|
|
55
|
|
|
56 DEFUN ("load-module", Fload_module, 1, 3, "FLoad dynamic module: ", /*
|
|
|
57 Load in a C Emacs Extension module named FILE.
|
|
|
58 The optional NAME and VERSION are used to identify specific modules.
|
|
|
59
|
|
|
60 This function is similar in intent to `load' except that it loads in
|
|
|
61 pre-compiled C or C++ code, using dynamic shared objects. If NAME is
|
|
|
62 specified, then the module is only loaded if its internal name matches
|
|
|
63 the NAME specified. If VERSION is specified, then the module is only
|
|
|
64 loaded if it matches that VERSION. This function will check to make
|
|
|
65 sure that the same module is not loaded twice. Modules are searched
|
|
|
66 for in the same way as Lisp files, except that the valid file
|
|
|
67 extensions are `.so', `.dll' or `.ell'.
|
|
|
68
|
|
|
69 All symbols in the shared module must be completely resolved in order
|
|
|
70 for this function to be successful. Any modules which the specified
|
|
|
71 FILE depends on will be automatically loaded. You can determine which
|
|
|
72 modules have been loaded as dynamic shared objects by examining the
|
|
|
73 return value of the function `list-modules'.
|
|
|
74
|
|
|
75 It is possible, although unwise, to unload modules using `unload-module'.
|
|
442
|
76 The preferred mechanism for unloading or reloading modules is to quit
|
|
428
|
77 XEmacs, and then reload those new or changed modules that are required.
|
|
|
78
|
|
|
79 Messages informing you of the progress of the load are displayed unless
|
|
|
80 the variable `load-modules-quietly' is non-NIL.
|
|
|
81 */
|
|
444
|
82 (file, name, version))
|
|
428
|
83 {
|
|
|
84 char *mod, *mname, *mver;
|
|
|
85 int speccount = specpdl_depth();
|
|
|
86
|
|
|
87 CHECK_STRING(file);
|
|
|
88
|
|
|
89 mod = (char *)XSTRING_DATA (file);
|
|
|
90
|
|
|
91 if (NILP (name))
|
|
|
92 mname = "";
|
|
|
93 else
|
|
|
94 mname = (char *)XSTRING_DATA (name);
|
|
|
95
|
|
|
96 if (NILP (version))
|
|
|
97 mver = "";
|
|
|
98 else
|
|
|
99 mver = (char *)XSTRING_DATA (version);
|
|
|
100
|
|
|
101 dlhandle = 0;
|
|
|
102 record_unwind_protect (module_load_unwind, make_int(modnum));
|
|
|
103 emodules_load (mod, mname, mver);
|
|
|
104 unbind_to (speccount, Qnil);
|
|
|
105
|
|
|
106 return Qt;
|
|
|
107 }
|
|
|
108
|
|
|
109 #ifdef DANGEROUS_NASTY_SCARY_MONSTER
|
|
|
110
|
|
|
111 DEFUN ("unload-module", Fmodule_unload, 1, 3, 0, /*
|
|
|
112 Unload a module previously loaded with load-module.
|
|
|
113
|
|
|
114 As with load-module, this function requires at least the module FILE, and
|
|
|
115 optionally the module NAME and VERSION to unload. It may not be possible
|
|
|
116 for the module to be unloaded from memory, as there may be Lisp objects
|
|
442
|
117 referring to variables inside the module code. However, once you have
|
|
428
|
118 requested a module to be unloaded, it will be unloaded from memory as
|
|
|
119 soon as the last reference to symbols within the module is destroyed.
|
|
|
120 */
|
|
444
|
121 (file, name, version))
|
|
428
|
122 {
|
|
|
123 int x;
|
|
|
124 char *mod, *mname, *mver;
|
|
|
125
|
|
|
126 CHECK_STRING(file);
|
|
|
127
|
|
|
128 mod = (char *)XSTRING_DATA (file);
|
|
|
129
|
|
|
130 if (NILP (name))
|
|
|
131 mname = "";
|
|
|
132 else
|
|
|
133 mname = (char *)XSTRING_DATA (name);
|
|
|
134
|
|
|
135 if (NILP (version))
|
|
|
136 mver = "";
|
|
|
137 else
|
|
|
138 mver = (char *)XSTRING_DATA (version);
|
|
|
139
|
|
|
140 x = find_make_module (mod, mname, mver, 1);
|
|
|
141 if (x != -1)
|
|
|
142 attempt_module_delete (x);
|
|
|
143 return Qt;
|
|
|
144 }
|
|
|
145 #endif /* DANGEROUS_NASTY_SCARY_MONSTER */
|
|
|
146
|
|
|
147 DEFUN ("list-modules", Flist_modules, 0, 0, "", /*
|
|
|
148 Produce a list of loaded dynamic modules.
|
|
|
149
|
|
|
150 This function will return a list of all the loaded dynamic modules.
|
|
|
151 Each element in the list is a list in the form (SONAME NAME VER DESC),
|
|
|
152 where SONAME is the name of the shared object that was loaded, NAME
|
|
|
153 is the internal module name, VER is the version of the module, and DESC
|
|
|
154 is how the module describes itself.
|
|
|
155
|
|
|
156 This function returns a list, so you will need to assign the return value
|
|
|
157 to a variable and then examine the variable with `describe-variable'.
|
|
|
158 For example:
|
|
|
159
|
|
|
160 (setq mylist (list-modules))
|
|
|
161 (describe-variable 'mylist)
|
|
|
162
|
|
|
163
|
|
|
164 NOTE: It is possible for the same module to be loaded more than once,
|
|
|
165 at different versions. However, you should never see the same module,
|
|
|
166 with the same name and version, loaded more than once. If you do, this
|
|
|
167 is a bug, and you are encouraged to report it.
|
|
|
168 */
|
|
|
169 ())
|
|
|
170 {
|
|
|
171 Lisp_Object mlist = Qnil;
|
|
|
172 int i;
|
|
|
173
|
|
|
174 for (i = 0; i < modnum; i++)
|
|
|
175 {
|
|
|
176 if (modules[i].used == 1)
|
|
|
177 mlist = Fcons (list4 (build_string (modules[i].soname),
|
|
|
178 build_string (modules[i].modname),
|
|
|
179 build_string (modules[i].modver),
|
|
|
180 build_string (modules[i].modtitle)), mlist);
|
|
|
181 }
|
|
|
182
|
|
|
183 return mlist;
|
|
|
184 }
|
|
|
185
|
|
|
186 static int
|
|
442
|
187 find_make_module (const char *mod, const char *name, const char *ver, int mof)
|
|
428
|
188 {
|
|
|
189 int i, fs = -1;
|
|
|
190
|
|
|
191 for (i = 0; i < modnum; i++)
|
|
|
192 {
|
|
|
193 if (fs == -1 && modules[i].used == 0)
|
|
|
194 fs = i;
|
|
|
195 if (strcmp (modules[i].soname, mod) == 0)
|
|
|
196 {
|
|
|
197 if (name && name[0] && strcmp (modules[i].modname, name))
|
|
|
198 continue;
|
|
|
199 if (ver && ver[0] && strcmp (modules[i].modver, ver))
|
|
|
200 continue;
|
|
|
201 return i; /* Found a match */
|
|
|
202 }
|
|
|
203 }
|
|
|
204
|
|
|
205 if (mof)
|
|
|
206 return fs;
|
|
|
207
|
|
|
208 if (fs != -1)
|
|
|
209 return fs; /* First free slot */
|
|
|
210
|
|
|
211 /*
|
|
442
|
212 * We only get here if we haven't found a free slot and the module was
|
|
428
|
213 * not previously loaded.
|
|
|
214 */
|
|
|
215 if (modules == (emodules_list *)0)
|
|
440
|
216 modules = (emodules_list *) xmalloc (sizeof (emodules_list));
|
|
428
|
217 modnum++;
|
|
440
|
218 modules = (emodules_list *) xrealloc (modules, modnum * sizeof (emodules_list));
|
|
428
|
219
|
|
|
220 fs = modnum - 1;
|
|
|
221 memset (&modules[fs], 0, sizeof(emodules_list));
|
|
|
222 return fs;
|
|
|
223 }
|
|
|
224
|
|
|
225 static void
|
|
|
226 attempt_module_delete (int mod)
|
|
|
227 {
|
|
|
228 if (dll_close (modules[mod].dlhandle) == 0)
|
|
|
229 {
|
|
|
230 xfree (modules[mod].soname);
|
|
|
231 xfree (modules[mod].modname);
|
|
|
232 xfree (modules[mod].modver);
|
|
|
233 xfree (modules[mod].modtitle);
|
|
|
234 modules[mod].dlhandle = 0;
|
|
|
235 modules[mod].used = 0;
|
|
|
236 }
|
|
|
237 else if (modules[mod].used > 1)
|
|
|
238 modules[mod].used = 1; /* We couldn't delete it - it stays */
|
|
|
239 }
|
|
|
240
|
|
|
241 static Lisp_Object
|
|
|
242 module_load_unwind (Lisp_Object upto)
|
|
|
243 {
|
|
|
244 int x,l=0;
|
|
|
245
|
|
|
246 /*
|
|
|
247 * First close off the current handle if it is open.
|
|
|
248 */
|
|
|
249 if (dlhandle != 0)
|
|
|
250 dll_close (dlhandle);
|
|
|
251 dlhandle = 0;
|
|
|
252
|
|
|
253 if (CONSP (upto))
|
|
|
254 {
|
|
|
255 if (INTP (XCAR (upto)))
|
|
|
256 l = XINT (XCAR (upto));
|
|
|
257 free_cons (XCONS (upto));
|
|
|
258 }
|
|
|
259 else
|
|
|
260 l = XINT (upto);
|
|
|
261
|
|
|
262 /*
|
|
|
263 * Here we need to go through and dlclose() (IN REVERSE ORDER!) any
|
|
|
264 * modules that were loaded as part of this load chain. We only mark
|
|
|
265 * the slots as closed if the dlclose() succeeds.
|
|
|
266 */
|
|
|
267 for (x = modnum-1; x >= l; x--)
|
|
|
268 {
|
|
|
269 if (modules[x].used > 1)
|
|
|
270 attempt_module_delete (x);
|
|
|
271 }
|
|
|
272 emodules_depth = 0;
|
|
|
273
|
|
|
274 return Qnil;
|
|
|
275 }
|
|
|
276
|
|
|
277 /*
|
|
|
278 * Do the actual grunt-work of loading in a module. We first try and
|
|
|
279 * dlopen() the module. If that fails, we have an error and we bail
|
|
|
280 * out immediately. If the dlopen() succeeds, we need to check for the
|
|
442
|
281 * existence of certain special symbols.
|
|
428
|
282 *
|
|
|
283 * All modules will have complete access to the variables and functions
|
|
|
284 * defined within XEmacs itself. It is up to the module to declare any
|
|
|
285 * variables or functions it uses, however. Modules will also have access
|
|
|
286 * to other functions and variables in other loaded modules, unless they
|
|
|
287 * are defined as STATIC.
|
|
|
288 *
|
|
|
289 * We need to be very careful with how we load modules. If we encounter an
|
|
|
290 * error along the way, we need to back out completely to the point at
|
|
442
|
291 * which the user started. Since we can be called recursively, we need to
|
|
428
|
292 * take care with marking modules as loaded. When we first start loading
|
|
|
293 * modules, we set the counter to zero. As we enter the function each time,
|
|
442
|
294 * we increment the counter, and before we leave we decrement it. When
|
|
428
|
295 * we get back down to 0, we know we are at the end of the chain and we
|
|
|
296 * can mark all the modules in the list as loaded.
|
|
|
297 *
|
|
|
298 * When we signal an error, we need to be sure to unwind all modules loaded
|
|
|
299 * thus far (but only for this module chain). It is assumed that if any
|
|
|
300 * modules in a chain fail, then they all do. This is logical, considering
|
|
442
|
301 * that the only time we recurse is when we have dependent modules. So in
|
|
428
|
302 * the error handler we take great care to close off the module chain before
|
|
|
303 * we call "error" and let the Fmodule_load unwind_protect() function handle
|
|
|
304 * the cleaning up.
|
|
|
305 */
|
|
|
306 void
|
|
442
|
307 emodules_load(const char *module, const char *modname, const char *modver)
|
|
428
|
308 {
|
|
|
309 Lisp_Object filename;
|
|
|
310 Lisp_Object foundname;
|
|
|
311 int fd, x, mpx;
|
|
|
312 char *soname, *tmod;
|
|
442
|
313 const char **f;
|
|
|
314 const long *ellcc_rev;
|
|
428
|
315 char *mver, *mname, *mtitle, *symname;
|
|
|
316 void (*modload)(void) = 0;
|
|
|
317 void (*modsyms)(void) = 0;
|
|
|
318 void (*modvars)(void) = 0;
|
|
|
319 void (*moddocs)(void) = 0;
|
|
|
320 emodules_list *mp;
|
|
|
321 struct gcpro gcpro1,gcpro2;
|
|
|
322
|
|
|
323 filename = Qnil;
|
|
|
324 foundname = Qnil;
|
|
|
325
|
|
|
326 emodules_depth++;
|
|
|
327 dlhandle = 0;
|
|
|
328
|
|
442
|
329 if ((module == (const char *)0) || (module[0] == '\0'))
|
|
563
|
330 invalid_argument ("Empty module name", Qunbound);
|
|
428
|
331
|
|
|
332 /* This is to get around the fact that build_string() is not declared
|
|
|
333 as taking a const char * as an argument. I HATE compiler warnings. */
|
|
|
334 tmod = (char *)alloca (strlen (module) + 1);
|
|
|
335 strcpy (tmod, module);
|
|
|
336
|
|
|
337 GCPRO2(filename, foundname);
|
|
|
338 filename = build_string (tmod);
|
|
563
|
339 fd = locate_file (Vmodule_load_path, filename, Vmodule_extensions,
|
|
|
340 &foundname, -1);
|
|
428
|
341 UNGCPRO;
|
|
|
342
|
|
|
343 if (fd < 0)
|
|
563
|
344 signal_error (Qdll_error, "Cannot open dynamic module", filename);
|
|
428
|
345
|
|
|
346 soname = (char *)alloca (XSTRING_LENGTH (foundname) + 1);
|
|
|
347 strcpy (soname, (char *)XSTRING_DATA (foundname));
|
|
|
348
|
|
|
349 dlhandle = dll_open (soname);
|
|
|
350 if (dlhandle == (dll_handle)0)
|
|
563
|
351 {
|
|
|
352 Bufbyte *dllerrint;
|
|
|
353
|
|
|
354 EXTERNAL_TO_C_STRING (dll_error (dlhandle), dllerrint, Qnative);
|
|
|
355 signal_error (Qdll_error, "Opening dynamic module",
|
|
|
356 build_string (dllerrint));
|
|
|
357 }
|
|
428
|
358
|
|
442
|
359 ellcc_rev = (const long *)dll_variable (dlhandle, "emodule_compiler");
|
|
|
360 if ((ellcc_rev == (const long *)0) || (*ellcc_rev <= 0))
|
|
563
|
361 signal_error (Qdll_error, "Invalid dynamic module: Missing symbol `emodule_compiler'", Qunbound);
|
|
428
|
362 if (*ellcc_rev > EMODULES_REVISION)
|
|
563
|
363 signal_ferror (Qdll_error, "Invalid dynamic module: Unsupported version `%ld(%ld)'", *ellcc_rev, EMODULES_REVISION);
|
|
428
|
364
|
|
442
|
365 f = (const char **)dll_variable (dlhandle, "emodule_name");
|
|
|
366 if ((f == (const char **)0) || (*f == (const char *)0))
|
|
563
|
367 signal_error (Qdll_error, "Invalid dynamic module: Missing symbol `emodule_name'", Qunbound);
|
|
428
|
368
|
|
|
369 mname = (char *)alloca (strlen (*f) + 1);
|
|
|
370 strcpy (mname, *f);
|
|
|
371 if (mname[0] == '\0')
|
|
563
|
372 signal_error (Qdll_error, "Invalid dynamic module: Empty value for `emodule_name'", Qunbound);
|
|
428
|
373
|
|
442
|
374 f = (const char **)dll_variable (dlhandle, "emodule_version");
|
|
|
375 if ((f == (const char **)0) || (*f == (const char *)0))
|
|
563
|
376 signal_error (Qdll_error, "Missing symbol `emodule_version': Invalid dynamic module", Qunbound);
|
|
428
|
377
|
|
|
378 mver = (char *)alloca (strlen (*f) + 1);
|
|
|
379 strcpy (mver, *f);
|
|
|
380
|
|
442
|
381 f = (const char **)dll_variable (dlhandle, "emodule_title");
|
|
|
382 if ((f == (const char **)0) || (*f == (const char *)0))
|
|
563
|
383 signal_error (Qdll_error, "Invalid dynamic module: Missing symbol `emodule_title'", Qunbound);
|
|
428
|
384
|
|
|
385 mtitle = (char *)alloca (strlen (*f) + 1);
|
|
|
386 strcpy (mtitle, *f);
|
|
|
387
|
|
|
388 symname = (char *)alloca (strlen (mname) + 15);
|
|
|
389
|
|
|
390 strcpy (symname, "modules_of_");
|
|
|
391 strcat (symname, mname);
|
|
|
392 modload = (void (*)(void))dll_function (dlhandle, symname);
|
|
|
393 /*
|
|
442
|
394 * modload is optional. If the module doesn't require other modules it can
|
|
428
|
395 * be left out.
|
|
|
396 */
|
|
|
397
|
|
|
398 strcpy (symname, "syms_of_");
|
|
|
399 strcat (symname, mname);
|
|
|
400 modsyms = (void (*)(void))dll_function (dlhandle, symname);
|
|
|
401 if (modsyms == (void (*)(void))0)
|
|
563
|
402 {
|
|
|
403 missing_symbol:
|
|
|
404 signal_error (Qdll_error, "Invalid dynamic module: Missing symbol",
|
|
|
405 build_string (symname));
|
|
|
406 }
|
|
428
|
407
|
|
|
408 strcpy (symname, "vars_of_");
|
|
|
409 strcat (symname, mname);
|
|
|
410 modvars = (void (*)(void))dll_function (dlhandle, symname);
|
|
|
411 if (modvars == (void (*)(void))0)
|
|
563
|
412 goto missing_symbol;
|
|
428
|
413
|
|
|
414 strcpy (symname, "docs_of_");
|
|
|
415 strcat (symname, mname);
|
|
|
416 moddocs = (void (*)(void))dll_function (dlhandle, symname);
|
|
|
417 if (moddocs == (void (*)(void))0)
|
|
563
|
418 goto missing_symbol;
|
|
428
|
419
|
|
|
420 if (modname && modname[0] && strcmp (modname, mname))
|
|
563
|
421 signal_error (Qdll_error, "Module name mismatch", Qunbound);
|
|
428
|
422
|
|
|
423 if (modver && modver[0] && strcmp (modver, mver))
|
|
563
|
424 signal_error (Qdll_error, "Module version mismatch", Qunbound);
|
|
428
|
425
|
|
|
426 /*
|
|
|
427 * Attempt to make a new slot for this module. If this really is the
|
|
|
428 * first time we are loading this module, the used member will be 0.
|
|
|
429 * If that is non-zero, we know that we have a previously loaded module
|
|
442
|
430 * of the same name and version, and we don't need to go any further.
|
|
428
|
431 */
|
|
|
432 mpx = find_make_module (soname, mname, mver, 0);
|
|
|
433 mp = &modules[mpx];
|
|
|
434 if (mp->used > 0)
|
|
|
435 {
|
|
|
436 emodules_depth--;
|
|
|
437 dll_close (dlhandle);
|
|
|
438 return;
|
|
|
439 }
|
|
|
440
|
|
|
441 if (!load_modules_quietly)
|
|
|
442 message ("Loading %s v%s (%s)", mname, mver, mtitle);
|
|
|
443
|
|
|
444 /*
|
|
|
445 * We have passed the basic initialization, and can now add this
|
|
|
446 * module to the list of modules.
|
|
|
447 */
|
|
|
448 mp->used = emodules_depth + 1;
|
|
|
449 mp->soname = xstrdup (soname);
|
|
|
450 mp->modname = xstrdup (mname);
|
|
|
451 mp->modver = xstrdup (mver);
|
|
|
452 mp->modtitle = xstrdup (mtitle);
|
|
|
453 mp->dlhandle = dlhandle;
|
|
|
454 dlhandle = 0;
|
|
|
455
|
|
|
456 /*
|
|
|
457 * Now we need to call the module init function and perform the various
|
|
|
458 * startup tasks.
|
|
|
459 */
|
|
|
460 if (modload != 0)
|
|
|
461 (*modload)();
|
|
|
462
|
|
|
463 /*
|
|
|
464 * Now we can get the module to initialize its symbols, and then its
|
|
|
465 * variables, and lastly the documentation strings.
|
|
|
466 */
|
|
|
467 (*modsyms)();
|
|
|
468 (*modvars)();
|
|
|
469 (*moddocs)();
|
|
|
470
|
|
|
471 if (!load_modules_quietly)
|
|
|
472 message ("Loaded module %s v%s (%s)", mname, mver, mtitle);
|
|
|
473
|
|
|
474
|
|
|
475 emodules_depth--;
|
|
|
476 if (emodules_depth == 0)
|
|
|
477 {
|
|
|
478 /*
|
|
|
479 * We have reached the end of the load chain. We now go through the
|
|
|
480 * list of loaded modules and mark all the valid modules as just
|
|
|
481 * that.
|
|
|
482 */
|
|
|
483 for (x = 0; x < modnum; x++)
|
|
|
484 if (modules[x].used > 1)
|
|
|
485 modules[x].used = 1;
|
|
|
486 }
|
|
|
487 }
|
|
|
488
|
|
|
489 void
|
|
442
|
490 emodules_doc_subr(const char *symname, const char *doc)
|
|
428
|
491 {
|
|
|
492 Bytecount len = strlen (symname);
|
|
442
|
493 Lisp_Object sym = oblookup (Vobarray, (const Bufbyte *)symname, len);
|
|
440
|
494 Lisp_Subr *subr;
|
|
428
|
495
|
|
|
496 if (SYMBOLP(sym))
|
|
|
497 {
|
|
|
498 subr = XSUBR( XSYMBOL(sym)->function);
|
|
|
499 subr->doc = xstrdup (doc);
|
|
|
500 }
|
|
|
501 /*
|
|
|
502 * FIXME: I wish there was some way to avoid the xstrdup(). Is it
|
|
|
503 * possible to just set a pointer to the string, or somehow create a
|
|
|
504 * symbol whose value we can point to the constant string? Can someone
|
|
|
505 * look into this?
|
|
|
506 */
|
|
|
507 }
|
|
|
508
|
|
|
509 void
|
|
442
|
510 emodules_doc_sym (const char *symname, const char *doc)
|
|
428
|
511 {
|
|
|
512 Bytecount len = strlen (symname);
|
|
442
|
513 Lisp_Object sym = oblookup (Vobarray, (const Bufbyte *)symname, len);
|
|
428
|
514 Lisp_Object docstr;
|
|
|
515 struct gcpro gcpro1;
|
|
|
516
|
|
|
517 if (SYMBOLP(sym))
|
|
|
518 {
|
|
|
519 docstr = build_string (doc);
|
|
|
520 GCPRO1(docstr);
|
|
|
521 Fput (sym, Qvariable_documentation, docstr);
|
|
|
522 UNGCPRO;
|
|
|
523 }
|
|
|
524 }
|
|
|
525
|
|
|
526
|
|
|
527 void
|
|
|
528 syms_of_module (void)
|
|
|
529 {
|
|
|
530 DEFSUBR(Fload_module);
|
|
|
531 DEFSUBR(Flist_modules);
|
|
|
532 #ifdef DANGEROUS_NASTY_SCARY_MONSTER
|
|
|
533 DEFSUBR(Funload_module);
|
|
|
534 #endif
|
|
|
535 }
|
|
|
536
|
|
|
537 void
|
|
|
538 reinit_vars_of_module (void)
|
|
|
539 {
|
|
|
540 emodules_depth = 0;
|
|
|
541 modules = (emodules_list *)0;
|
|
|
542 modnum = 0;
|
|
|
543 }
|
|
|
544
|
|
|
545 void
|
|
|
546 vars_of_module (void)
|
|
|
547 {
|
|
|
548 reinit_vars_of_module ();
|
|
|
549
|
|
|
550 DEFVAR_LISP ("module-version", &Vmodule_version /*
|
|
|
551 Emacs dynamic loading mechanism version, as a string.
|
|
|
552
|
|
|
553 This string is in the form XX.YY.ppp, where XX is the major version
|
|
|
554 number, YY is the minor version number, and ppp is the patch level.
|
|
442
|
555 This variable can be used to distinguish between different versions of
|
|
428
|
556 the dynamic loading technology used in Emacs, if required. It is not
|
|
|
557 a given that this value will be the same as the Emacs version number.
|
|
|
558 */ );
|
|
|
559 Vmodule_version = build_string (EMODULES_VERSION);
|
|
|
560
|
|
|
561 DEFVAR_BOOL ("load-modules-quietly", &load_modules_quietly /*
|
|
|
562 *Set to t if module loading is to be silent.
|
|
|
563
|
|
|
564 Normally, when loading dynamic modules, Emacs will inform you of its
|
|
|
565 progress, and will display the module name and version if the module
|
|
|
566 is loaded correctly. Setting this variable to `t' will suppress these
|
|
|
567 messages. This would normally only be done if `load-module' was being
|
|
|
568 called by a Lisp function.
|
|
|
569 */);
|
|
|
570
|
|
|
571 DEFVAR_LISP ("module-load-path", &Vmodule_load_path /*
|
|
|
572 *List of directories to search for dynamic modules to load.
|
|
|
573 Each element is a string (directory name) or nil (try default directory).
|
|
|
574
|
|
|
575 Note that elements of this list *may not* begin with "~", so you must
|
|
442
|
576 call `expand-file-name' on them before adding them to this list.
|
|
428
|
577
|
|
|
578 Initialized based on EMACSMODULEPATH environment variable, if any, otherwise
|
|
|
579 to default specified the file `paths.h' when XEmacs was built. If there
|
|
|
580 were no paths specified in `paths.h', then XEmacs chooses a default
|
|
|
581 value for this variable by looking around in the file-system near the
|
|
|
582 directory in which the XEmacs executable resides.
|
|
|
583
|
|
|
584 Due to the nature of dynamic modules, the path names should almost always
|
|
442
|
585 refer to architecture-dependent directories. It is unwise to attempt to
|
|
|
586 store dynamic modules in a heterogenous environment. Some environments
|
|
428
|
587 are similar enough to each other that XEmacs will be unable to determine
|
|
|
588 the correctness of a dynamic module, which can have unpredictable results
|
|
|
589 when a dynamic module is loaded.
|
|
|
590 */);
|
|
|
591
|
|
|
592 /* #### Export this to Lisp */
|
|
|
593 Vmodule_extensions = build_string (":.ell:.so:.dll");
|
|
|
594 staticpro (&Vmodule_extensions);
|
|
|
595
|
|
|
596 load_modules_quietly = 0;
|
|
|
597 Vmodule_load_path = Qnil;
|
|
|
598 Fprovide (intern ("modules"));
|
|
|
599 }
|
|
|
600
|
|
|
601 #endif /* HAVE_SHLIB */
|
|
|
602
|
