Reformatted.
[chise/xemacs-chise.git.1] / src / emodules.h
1 /* emodules.h - Declarations and definitions for XEmacs loadable modules.
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 #ifndef EMODULES_HDR
22
23 #ifndef EMODULES_GATHER_VERSION
24 #define EMODULES_HDR
25 #endif
26
27 #define EMODULES_VERSION    "1.0.0"
28 #define EMODULES_MAJOR      1
29 #define EMODULES_MINOR      0
30 #define EMODULES_PATCH      0
31 #define EMODULES_REVISION   (long)((EMODULES_MAJOR * 1000) + \
32                              (EMODULES_MINOR * 10) + \
33                              (EMODULES_PATCH))
34
35 #ifndef EMODULES_GATHER_VERSION
36 #include <config.h>
37 #include "lisp.h"
38 #include "sysdep.h"
39 #include "window.h"
40 #include "buffer.h"
41 #include "insdel.h"
42 #include "frame.h"
43 #include "lstream.h"
44 #ifdef FILE_CODING
45 #include "file-coding.h"
46 #endif
47
48 /* Module loading technology version number */
49 extern Lisp_Object Vmodule_version;
50
51 /* Load path */
52 extern Lisp_Object Vmodule_load_path;
53
54 /* XEmacs version Information */
55 extern Lisp_Object Vemacs_major_version;
56 extern Lisp_Object Vemacs_minor_version;
57
58 /*
59  * Load in a C module. The first argument is the name of the .so file, the
60  * second is the name of the module, and the third is the module version.
61  * If the module name is NULL, we will always reload the .so. If it is not
62  * NULL, we check to make sure we haven't loaded it before. If the version
63  * is specified, we check to make sure we didn't load the module of the
64  * specified version before. We also use these as checks when we open the
65  * module to make sure we have the right module.
66  */
67 extern void emodules_load (const char *module, const char *name, const char *version);
68
69 /*
70  * Because subrs and symbols added by a dynamic module are not part of
71  * the make-docfile process, we need a clean way to get the variables
72  * and functions documented. Since people don't like the idea of making
73  * shared modules use different versions of DEFSUBR() and DEFVAR_LISP()
74  * and friends, we need these two functions to insert the documentation
75  * into the right place. These functions will be called by the module
76  * init code, generated by ellcc during initialization mode.
77  */
78 extern void emodules_doc_subr (const char *objname, const char *docstr);
79 extern void emodules_doc_sym (const char *objname, const char *docstr);
80
81 #define CDOCSUBR(Fname, DOC) emodules_doc_subr (Fname, DOC)
82 #define CDOCSYM(Sname, DOC)  emodules_doc_sym  (Sname, DOC)
83 #endif /* EMODULES_GATHER_VERSION */
84
85 #endif /* EMODULES_HDR */