Cleanup utilities. Introduce sxe-memory.h
[sxemacs] / src / sxemacs.h
1 /*** sxemacs.h -- meta include file for external emodule sources
2  *
3  * Copyright (C) 2004 Steve Youngs.
4  * Copyright (C) 2007 Sebastian Freundt
5  *
6  * This file is part of SXEmacs.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * 3. Neither the name of the author nor the names of any contributors
20  *    may be used to endorse or promote products derived from this
21  *    software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR
24  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26  * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
30  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
31  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
32  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
33  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34  *
35  ***/
36
37 #ifndef INCLUDED_sxemacs_h_
38 #define INCLUDED_sxemacs_h_
39
40 /***
41  * This header is just a convenience thing. Projects using SXEmacs will solely
42  * need to include this one and will not have to care about additional stuff.
43  * In particular this simplifies include paths since we might not be the only
44  * project on this earth with a lisp.h header and we are definitely not the
45  * only ones with a process.h file.  Thus, to avoid confusion because of
46  * mistakenly included files from other projects we provide this meta-header.
47  *
48  * To use this in your emodules (or wherever) install SXEmacs (>= 22.1.7)
49  * properly (or assume it has been done already), then invoke pkg-config to
50  * determine the include path of the latest and greatest SXEmacs on your/that
51  * box, like so:
52  *
53  *      pkg-config --cflags sxemacs
54  *
55  * and save that value somehow, say to SXE_CPPFLAGS, then as your final
56  * CPPFLAGS you'd use "${YOUR_CPPFLAGS} ${SXE_CPPFLAGS}" in the Makefile (or
57  * whatever system you're using).  It's probably not the fastest way to do but
58  * of course you could just invoke your C compiler like so:
59  *
60  *      gcc $(pkg-config --cflags sxemacs) ...
61  *
62  * In your project, thence, just use
63  *
64  *      #include <sxemacs.h>
65  *
66  * and forget about all the other include files.  Of course, you can include
67  * sxemacs.h as many times as you like.
68  *
69  * Easy, innit? :)
70  *
71  ***/
72
73 /* pretend to be an emacs
74  * some stuff is suitable for other than emacsen modules too
75  * however to avoid one more CPPFLAG we simply define `emacs' here
76  */
77 #ifndef emacs
78 # define emacs
79 #endif
80
81 #if defined USE_SXEMACS_CONFIG_H
82 # include "config.h"
83 #endif
84
85 #include "lisp.h"
86
87 #include "sysfile.h"
88 #include "sysdir.h"
89 #include "systime.h"
90 #include "sysdep.h"
91 #include "syspwd.h"
92 #include "buffer.h"
93 #include "commands.h"
94 #include "elhash.h"
95 #include "regex.h"
96 #include "opaque.h"
97 #include "syntax.h"
98 #include "dllist.h"
99 #include "bloom.h"
100 #include "dynacat.h"
101
102 #if defined EF_USE_ASYNEQ
103 # include "events/worker-asyneq.h"
104 #endif
105
106 #include "emodules-ng.h"
107
108 #if defined USE_SXEMACS_CONFIG_H
109 /* clean up, if someone else wants to use autoheader,
110  * we shouldn't leave this stuff here */
111 # undef PACKAGE
112 # undef PACKAGE_VERSION
113 # undef PACKAGE_STRING
114 # undef PACKAGE_NAME
115 # undef PACKAGE_BUGREPORT
116 # undef PACKAGE_TARNAME
117 # undef VERSION
118 #endif  /* USE_SXEMACS_CONFIG_H */
119
120 #endif  /* INCLUDED_sxemacs_h_ */