/* emodules.h - Declarations and definitions for XEmacs loadable modules.
(C) Copyright 1998, 1999 J. Kean Johnston. All rights reserved.
This file is part of XEmacs.
XEmacs is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.
XEmacs is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with XEmacs. If not, see . */
#ifndef EMODULES_HDR
#ifndef EMODULES_GATHER_VERSION
#define EMODULES_HDR
#endif
#define EMODULES_VERSION "1.1.0"
#define EMODULES_MAJOR 1
#define EMODULES_MINOR 1
#define EMODULES_PATCH 0
#define EMODULES_REVISION (long)((EMODULES_MAJOR * 1000) + \
(EMODULES_MINOR * 10) + \
(EMODULES_PATCH))
#ifndef EMODULES_GATHER_VERSION
#include
#include "lisp.h"
#include "sysdep.h"
#include "window.h"
#include "buffer.h"
#include "insdel.h"
#include "frame.h"
#include "lstream.h"
#include "file-coding.h"
/* Module loading technology version number */
extern Lisp_Object Vmodule_version;
/* XEmacs version Information */
extern Lisp_Object Vemacs_major_version;
extern Lisp_Object Vemacs_minor_version;
/*
* Load in a C module. The first argument is the name of the .so file, the
* second is the name of the module, and the third is the module version.
* If the module name is NULL, we will always reload the .so. If it is not
* NULL, we check to make sure we haven't loaded it before. If the version
* is specified, we check to make sure we didn't load the module of the
* specified version before. We also use these as checks when we open the
* module to make sure we have the right module.
*/
extern void emodules_load (const Ibyte *module, const Ibyte *modname,
const Ibyte *modver);
/*
* Because subrs and symbols added by a dynamic module are not part of
* the make-docfile process, we need a clean way to get the variables
* and functions documented. Since people don't like the idea of making
* shared modules use different versions of DEFSUBR() and DEFVAR_LISP()
* and friends, we need these two functions to insert the documentation
* into the right place. These functions will be called by the module
* init code, generated by ellcc during initialization mode.
*/
EXTERN_C MODULE_API void emodules_doc_subr (const Ascbyte *objname,
const Ascbyte *docstr);
EXTERN_C MODULE_API void emodules_doc_sym (const Ascbyte *objname,
const Ascbyte *docstr);
#define CDOCSUBR(Fname, DOC) emodules_doc_subr (Fname, DOC)
#define CDOCSYM(Sname, DOC) emodules_doc_sym (Sname, DOC)
#endif /* EMODULES_GATHER_VERSION */
/* We should not expose module entities to the portable dumper. */
#if defined(PDUMP) && defined(EMACS_MODULE)
#undef dump_add_root_block_ptr
#define dump_add_root_block_ptr(varaddr,descaddr) DO_NOTHING
#undef dump_add_opaque
#define dump_add_opaque(varaddr,size) DO_NOTHING
#undef dump_add_root_block
#define dump_add_root_block(ptraddress,desc) DO_NOTHING
#undef dump_add_opaque_int
#define dump_add_opaque_int(int_varaddr) DO_NOTHING
#undef dump_add_opaque_fixnum
#define dump_add_opaque_fixnum(fixnum_varaddr) DO_NOTHING
#undef dump_add_root_lisp_object
#define dump_add_root_lisp_object(varaddr) DO_NOTHING
#undef dump_add_weak_object_chain
#define dump_add_weak_object_chain(varaddr) DO_NOTHING
#undef staticpro
#define staticpro(DSF_location) staticpro_nodump(DSF_location)
#undef unstaticpro
#define unstaticpro(DSF_location) unstaticpro_nodump(DFS_location)
#undef DEFSYMBOL
#define DEFSYMBOL(name) DEFSYMBOL_NO_DUMP (name)
#undef DEFSYMBOL_MULTIWORD_PREDICATE
#define DEFSYMBOL_MULTIWORD_PREDICATE(name) \
DEFSYMBOL_MULTIWORD_PREDICATE_NO_DUMP (name)
#undef defsymbol
#define defsymbol(location,name) defsymbol_nodump (location, name)
#endif /* defined(PDUMP) && defined(EMACS_MODULE) */
#endif /* EMODULES_HDR */