Commit | Line | Data |
---|---|---|
caeef9cb RB |
1 | |
2 | /********************************************************************** | |
3 | ||
4 | Description of Guile's public config header mechanics: | |
5 | ----------------------------------------------------- | |
6 | ||
7 | Guile has four core headers: | |
8 | ||
9 | config.h: Guile's private automatically generated configuration | |
10 | header -- generated by configure.in and autoheader. *NOT* | |
11 | installed during "make install" and so may not be referred to by | |
12 | any public headers. | |
13 | ||
14 | libguile/_scm.h: Guile's private core header. _scm.h is not | |
15 | installed. It's only visible to the libguile sources | |
16 | themselves, and it includes config.h, the private config header. | |
17 | Among other things this file provides a place to make decisions | |
18 | based on the information gathered in config.h. | |
19 | ||
20 | libguile/scmconfig.h: Guile's public automatically generated | |
21 | configuration header -- generated at build time by concatenating | |
22 | the contents of libguile/scmconfig.h.top with the output from | |
23 | libguile/gen-scmconfig. gen-scmconfig bases its output on the | |
24 | information in the private config.h header, the contents of | |
25 | gen-scmconfig.h (which is created by configure.in from | |
26 | gen-scmconfig.h.in), and the information provided in this file, | |
27 | gen-scmconfig.c. | |
28 | ||
29 | libguile/__scm.h: Guile's public core header. This file is | |
30 | installed and publically visible. It includes | |
31 | libguile/scmconfig.h, the public config header and provides a | |
32 | place to make decisions based on the information gathered in | |
33 | scmconfig.h to define things that other headers can depend on. | |
34 | ||
35 | Notes and guidelines: | |
36 | ||
005f04cd RB |
37 | - use 1 and 0 for public #defines instead of "def and undef", |
38 | i.e. use #define SCM_HAVE_FOO rather than just not defining | |
39 | SCM_HAVE_FOO whenever possible. See GNU Coding Guidelines for | |
40 | rationale. The only notable non-deprecated exceptions to this | |
41 | rule are GUILE_DEBUG and GUILE_DEBUG_FREELIST which do not follow | |
42 | this convention in order to retain backward compatibility. | |
43 | ||
caeef9cb RB |
44 | - in the code below, be *VERY* careful not to use or rely on any |
45 | runtime-dynamic information below. For example, you cannot use | |
46 | sizeof (FOO), but must use static information like SIZEOF_BAR | |
47 | (from config.h) or SCM_SIZEOF_BAZ (from scmconfig.h). This is | |
48 | because the gcc that is compiling gen-scmconfig.c and/or the | |
49 | machine that is running gen-scmconfig may not be the same | |
50 | compiler and/or hardware that will eventually be running Guile. | |
51 | (i.e. keep the cross-compilation case in mind). | |
52 | ||
53 | - try to avoid adding names to the public namespace when possible. | |
54 | Note in the code below, that in a number of cases, we detect a | |
55 | feature and based on that, we decide whether or not to print | |
56 | anything at all. This decreases the extraneous #defines and | |
57 | #ifdefery that we require in scmconfig.h | |
58 | ||
59 | - try to avoid adding any duplicate definitions to config.h and | |
60 | scmconfig.h. i.e. have just SCM_ENABLE_ELISP in scmconfig.h | |
61 | rather than ENABLE_ELISP in config.h and SCM_ENABLE_ELISP in | |
62 | scmconfig.h. | |
63 | ||
64 | - in cases where you need to communicate information from | |
65 | configure.in to gen-scmconfig.c, don't add an AC_DEFINE unless | |
66 | you need it for other purposes. Just add a suitable SCM_I_GSC_* | |
67 | variable to configure.in, set the value, AC_SUBST the value, and | |
68 | add an appropriate line to gen-scmconfig.h.in. All gen-scmconfig | |
69 | related AC_SUBST vars should be prefixed with SCM_I_GSC_. | |
70 | ||
71 | - make sure that anything that we explicitly typedef publically is | |
72 | prefixed with scm_t_. i.e. we used to typedef long to ptrdiff_t | |
73 | if we didn't detect ptrdiff_t, but this has been changed so that | |
74 | we typedef scm_t_ptrdiff instead so that we won't conflict with | |
75 | any non-guile header definitions of the same type. For types | |
76 | like intptr_t and uintptr_t which we just try to detect and don't | |
77 | actually define, it's fine not to have a corresponding scm_t_ | |
78 | type. | |
79 | ||
80 | - we now use SCM_SIZEOF_FOO != 0 rather than SCM_HAVE_FOO for any | |
4ca48269 | 81 | cases where the size might actually vary. |
caeef9cb RB |
82 | |
83 | Rationales (not finished): | |
84 | ||
85 | Why do we use a C program here rather than AC_OUTPUT_COMMANDS? | |
86 | -------------------------------------------------------------- | |
87 | ||
88 | The main reason is that there are some values we would need | |
89 | access to at AC_OUTPUT_COMMANDs that are determined by configure | |
90 | but are not available at AC_OUTPUT time. The values are *only* | |
91 | available via config.h. We use gen-scmconfig so we can see those | |
92 | values and make decisions based on their settings. | |
93 | ||
94 | Why have gen-scmconfig.h.in? | |
95 | ---------------------------- | |
96 | ||
97 | Without that header, we could end up needing multiple aliases for | |
98 | public settings like SCM_ENABLE_ELISP. We can't define | |
99 | SCM_ENABLE_ELISP in config.h since that header is private and any | |
100 | definition in scmconfig.h would conflict (#ifndef might be | |
101 | possible but runs the risk of conflicting directives), so a | |
102 | likely solution would be to AC_DEFINE([SCM_I_ENABLE_ELISP]), and | |
103 | then use SCM_I_ENABLE_ELISP in gen-scmconfig via config.h to | |
104 | determine whether or not to #define SCM_ENABLE_ELISP, but this | |
105 | leaves us with two #defined symbols for each public setting -- | |
106 | better to just have one value (public or private) that all code | |
107 | uses. | |
108 | ||
109 | Having this header means we can AC_SUBST a value like | |
110 | SCM_I_GSC_ENABLE_ELISP and then set it in here via AC_OUTPUT | |
111 | substitutions, and gen-scmconfig can use that definition to | |
112 | determine whether or not to #define SCM_ENABLE_ELISP when | |
113 | generating scmconfig.h, and we end up with nothing extraneous | |
114 | added to config.h. | |
115 | ||
116 | **********************************************************************/ | |
117 | ||
dbb605f5 | 118 | #ifdef HAVE_CONFIG_H |
caeef9cb RB |
119 | # include <config.h> |
120 | #endif | |
121 | ||
535b3592 | 122 | #include <libguile/gen-scmconfig.h> |
caeef9cb RB |
123 | |
124 | #include <stdio.h> | |
125 | #include <string.h> | |
eca29b02 | 126 | #include <uniconv.h> |
caeef9cb RB |
127 | |
128 | #define pf printf | |
129 | ||
130 | int | |
131 | main (int argc, char *argv[]) | |
132 | { | |
133 | pf ("/* This file is automatically generated --" | |
134 | " see configure.in for details */\n" | |
135 | "\n" | |
136 | "#ifndef SCM_SCMCONFIG_H\n" | |
137 | "#define SCM_SCMCONFIG_H\n"); | |
138 | ||
139 | /*** various important headers ***/ | |
140 | pf ("\n"); | |
141 | pf ("/* Important headers */\n"); | |
142 | if (SCM_I_GSC_NEEDS_STDINT_H) | |
143 | pf ("#include <stdint.h>\n"); | |
144 | if (SCM_I_GSC_NEEDS_INTTYPES_H) | |
145 | pf ("#include <inttypes.h>\n"); | |
146 | ||
147 | #ifdef HAVE_LIMITS_H | |
148 | pf ("#include <limits.h>\n"); | |
149 | #else | |
150 | pf ("/* limits.h not available */\n"); | |
151 | #endif | |
152 | ||
153 | # ifdef TIME_WITH_SYS_TIME | |
154 | pf ("#include <sys/time.h>\n"); | |
155 | pf ("#include <time.h>\n"); | |
156 | # else | |
157 | # ifdef HAVE_SYS_TIME_H | |
158 | pf ("#include <sys/time.h>\n"); | |
159 | # else | |
160 | # ifdef HAVE_TIME_H | |
161 | pf ("#include <time.h>\n"); | |
162 | # endif | |
163 | # endif | |
164 | # endif | |
165 | ||
166 | pf("\n"); | |
167 | #ifdef STDC_HEADERS | |
005f04cd | 168 | pf ("#define SCM_HAVE_STDC_HEADERS 1 /* 0 or 1 */\n"); |
caeef9cb | 169 | pf ("#include <stdlib.h>\n"); |
56a3dcd4 | 170 | # ifdef HAVE_SYS_TYPES_H |
caeef9cb RB |
171 | pf ("#include <sys/types.h>\n"); |
172 | # endif | |
56a3dcd4 | 173 | # ifdef HAVE_SYS_STDTYPES_H |
caeef9cb RB |
174 | pf ("#include <sys/stdtypes.h>\n"); |
175 | # endif | |
176 | pf ("#include <stddef.h>\n"); | |
177 | #else /* STDC_HEADERS */ | |
005f04cd | 178 | pf ("#define SCM_HAVE_STDC_HEADERS 0 /* 0 or 1 */"); |
caeef9cb RB |
179 | #endif /* def STDC_HEADERS */ |
180 | ||
181 | pf("\n"); | |
182 | #ifdef HAVE_SYS_SELECT_H | |
005f04cd | 183 | pf ("#define SCM_HAVE_SYS_SELECT_H 1 /* 0 or 1 */\n"); |
caeef9cb | 184 | #else |
005f04cd | 185 | pf ("#define SCM_HAVE_SYS_SELECT_H 0 /* 0 or 1 */\n"); |
caeef9cb RB |
186 | #endif |
187 | ||
caeef9cb | 188 | #ifdef HAVE_WINSOCK2_H |
005f04cd | 189 | pf ("#define SCM_HAVE_WINSOCK2_H 1 /* 0 or 1 */\n"); |
caeef9cb | 190 | #else |
005f04cd | 191 | pf ("#define SCM_HAVE_WINSOCK2_H 0 /* 0 or 1 */\n"); |
caeef9cb RB |
192 | #endif |
193 | ||
194 | ||
195 | /*** GUILE_DEBUG (defined or undefined) ***/ | |
196 | pf ("\n"); | |
197 | pf ("/* Define to include various undocumented debugging functions. */\n"); | |
198 | if (SCM_I_GSC_GUILE_DEBUG) | |
199 | pf ("#define GUILE_DEBUG 1 /* defined or undefined */\n"); | |
200 | else | |
201 | pf ("/* #undef GUILE_DEBUG */\n"); | |
dee91fb9 | 202 | |
caeef9cb RB |
203 | /*** SCM_ENABLE_DEPRECATED (0 or 1) ***/ |
204 | pf ("\n"); | |
205 | pf ("/* Set to 1 if you want to enable deprecated features. */\n"); | |
206 | pf ("/* (value will be 0 or 1). */\n"); | |
207 | pf ("#define SCM_ENABLE_DEPRECATED %d\n", SCM_I_GSC_ENABLE_DEPRECATED); | |
208 | ||
005f04cd | 209 | /*** SCM_STACK_GROWS_UP (0 or 1) ***/ |
caeef9cb | 210 | pf ("\n"); |
005f04cd RB |
211 | pf ("/* Set to 1 if the stack grows up, 0 otherwise. */\n"); |
212 | pf ("#define SCM_STACK_GROWS_UP %d /* 0 or 1 */\n", | |
213 | SCM_I_GSC_STACK_GROWS_UP); | |
caeef9cb RB |
214 | |
215 | /*** SCM_C_INLINE (defined to appropriate string or undefined) ***/ | |
216 | pf ("\n"); | |
217 | pf ("/* C compiler's syntax for inline functions if any,\n" | |
218 | " otherwise undefined. */\n"); | |
219 | if (SCM_I_GSC_C_INLINE) | |
220 | pf ("#define SCM_C_INLINE %s\n", SCM_I_GSC_C_INLINE); | |
221 | else | |
222 | pf ("/* #undef SCM_C_INLINE */\n"); | |
223 | ||
224 | pf ("\n"); | |
225 | pf ("/* Standard types. */\n"); | |
226 | ||
227 | pf ("/* These are always defined */\n"); | |
228 | pf ("#define SCM_SIZEOF_CHAR %d\n", SIZEOF_CHAR); | |
229 | pf ("#define SCM_SIZEOF_UNSIGNED_CHAR %d\n", SIZEOF_UNSIGNED_CHAR); | |
230 | pf ("#define SCM_SIZEOF_SHORT %d\n", SIZEOF_SHORT); | |
231 | pf ("#define SCM_SIZEOF_UNSIGNED_SHORT %d\n", SIZEOF_UNSIGNED_SHORT); | |
232 | pf ("#define SCM_SIZEOF_LONG %d\n", SIZEOF_LONG); | |
233 | pf ("#define SCM_SIZEOF_UNSIGNED_LONG %d\n", SIZEOF_UNSIGNED_LONG); | |
234 | pf ("#define SCM_SIZEOF_INT %d\n", SIZEOF_INT); | |
235 | pf ("#define SCM_SIZEOF_UNSIGNED_INT %d\n", SIZEOF_UNSIGNED_INT); | |
4627df5a | 236 | pf ("#define SCM_SIZEOF_SIZE_T %d\n", SIZEOF_SIZE_T); |
caeef9cb RB |
237 | |
238 | pf ("\n"); | |
239 | pf ("/* Size of (unsigned) long long or 0 if not available (scm_t_*64 may\n" | |
240 | " be more likely to be what you want */\n"); | |
241 | pf ("#define SCM_SIZEOF_LONG_LONG %d\n", SIZEOF_LONG_LONG); | |
242 | pf ("#define SCM_SIZEOF_UNSIGNED_LONG_LONG %d\n", SIZEOF_UNSIGNED_LONG_LONG); | |
9ca20a9c | 243 | |
caeef9cb RB |
244 | pf ("\n"); |
245 | pf ("/* These are always defined. */\n"); | |
246 | pf ("typedef %s scm_t_int8;\n", SCM_I_GSC_T_INT8); | |
247 | pf ("typedef %s scm_t_uint8;\n", SCM_I_GSC_T_UINT8); | |
248 | pf ("typedef %s scm_t_int16;\n", SCM_I_GSC_T_INT16); | |
249 | pf ("typedef %s scm_t_uint16;\n", SCM_I_GSC_T_UINT16); | |
250 | pf ("typedef %s scm_t_int32;\n", SCM_I_GSC_T_INT32); | |
251 | pf ("typedef %s scm_t_uint32;\n", SCM_I_GSC_T_UINT32); | |
fc54d937 MV |
252 | pf ("typedef %s scm_t_intmax;\n", SCM_I_GSC_T_INTMAX); |
253 | pf ("typedef %s scm_t_uintmax;\n", SCM_I_GSC_T_UINTMAX); | |
114bc68a LC |
254 | pf ("typedef %s scm_t_intptr;\n", SCM_I_GSC_T_INTPTR); |
255 | pf ("typedef %s scm_t_uintptr;\n", SCM_I_GSC_T_UINTPTR); | |
caeef9cb | 256 | |
4627df5a MV |
257 | if (0 == strcmp ("intmax_t", SCM_I_GSC_T_INTMAX)) |
258 | pf ("#define SCM_SIZEOF_INTMAX %d\n", SIZEOF_INTMAX_T); | |
259 | else if (0 == strcmp ("long long", SCM_I_GSC_T_INTMAX)) | |
260 | pf ("#define SCM_SIZEOF_INTMAX %d\n", SIZEOF_LONG_LONG); | |
261 | else if (0 == strcmp ("__int64", SCM_I_GSC_T_INTMAX)) | |
262 | pf ("#define SCM_SIZEOF_INTMAX %d\n", SIZEOF___INT64); | |
263 | else | |
264 | return 1; | |
265 | ||
caeef9cb | 266 | pf ("\n"); |
4ca48269 AW |
267 | pf ("#define SCM_HAVE_T_INT64 1 /* 0 or 1 */\n"); |
268 | pf ("typedef %s scm_t_int64;\n", SCM_I_GSC_T_INT64); | |
269 | pf ("#define SCM_HAVE_T_UINT64 1 /* 0 or 1 */\n"); | |
270 | pf ("typedef %s scm_t_uint64;\n", SCM_I_GSC_T_UINT64); | |
caeef9cb RB |
271 | |
272 | pf ("\n"); | |
273 | pf ("/* scm_t_ptrdiff_t and size, always defined -- defined to long if\n" | |
274 | " platform doesn't have ptrdiff_t. */\n"); | |
275 | pf ("typedef %s scm_t_ptrdiff;\n", SCM_I_GSC_T_PTRDIFF); | |
276 | if (0 == strcmp ("long", SCM_I_GSC_T_PTRDIFF)) | |
277 | pf ("#define SCM_SIZEOF_SCM_T_PTRDIFF %d\n", SIZEOF_LONG); | |
278 | else | |
279 | pf ("#define SCM_SIZEOF_SCM_T_PTRDIFF %d\n", SIZEOF_PTRDIFF_T); | |
280 | ||
281 | pf ("\n"); | |
282 | pf ("/* Size of intptr_t or 0 if not available */\n"); | |
283 | pf ("#define SCM_SIZEOF_INTPTR_T %d\n", SIZEOF_INTPTR_T); | |
284 | pf ("/* Size of uintptr_t or 0 if not available */\n"); | |
285 | pf ("#define SCM_SIZEOF_UINTPTR_T %d\n", SIZEOF_UINTPTR_T); | |
286 | ||
287 | pf ("\n"); | |
288 | pf ("/* same as POSIX \"struct timespec\" -- always defined */\n"); | |
289 | #ifdef HAVE_STRUCT_TIMESPEC | |
290 | pf ("typedef struct timespec scm_t_timespec;\n"); | |
291 | #else | |
292 | pf ("/* POSIX.4 structure for a time value. This is like a `struct timeval'" | |
293 | " but has nanoseconds instead of microseconds. */\n"); | |
294 | pf ("typedef struct\n" | |
295 | "{\n" | |
296 | " long int tv_sec; /* Seconds. */\n" | |
297 | " long int tv_nsec; /* Nanoseconds. */\n" | |
298 | "} scm_t_timespec;\n"); | |
299 | #endif | |
300 | ||
301 | pf ("\n"); | |
302 | pf ("/*** Threading model (scmconfig.h support not finished) ***/\n"); | |
303 | ||
005f04cd RB |
304 | pf ("/* Define to 1 if using pthread multithreading. */\n"); |
305 | pf ("#define SCM_USE_PTHREAD_THREADS %d /* 0 or 1 */\n", | |
306 | SCM_I_GSC_USE_PTHREAD_THREADS); | |
caeef9cb | 307 | |
005f04cd RB |
308 | pf ("/* Define to 1 if using one-thread 'multi'threading. */\n"); |
309 | pf ("#define SCM_USE_NULL_THREADS %d /* 0 or 1 */\n", | |
310 | SCM_I_GSC_USE_NULL_THREADS); | |
caeef9cb | 311 | |
8ab3d8a0 KR |
312 | pf ("/* Define to 1 if need braces around PTHREAD_ONCE_INIT (for Solaris). */\n"); |
313 | pf ("#define SCM_NEED_BRACES_ON_PTHREAD_ONCE_INIT %d /* 0 or 1 */\n", | |
314 | SCM_I_GSC_NEED_BRACES_ON_PTHREAD_ONCE_INIT); | |
315 | ||
66302618 LC |
316 | pf ("/* Define to 1 if need braces around PTHREAD_MUTEX_INITIALIZER\n" |
317 | " (for IRIX with GCC) */\n"); | |
318 | pf ("#define SCM_NEED_BRACES_ON_PTHREAD_MUTEX_INITIALIZER %d /* 0 or 1 */\n", | |
319 | SCM_I_GSC_NEED_BRACES_ON_PTHREAD_MUTEX_INITIALIZER); | |
320 | ||
450be18d LC |
321 | pf ("\n\n/*** File system access ***/\n"); |
322 | ||
323 | pf ("/* Define to 1 if `struct dirent64' is available. */\n"); | |
324 | pf ("#define SCM_HAVE_STRUCT_DIRENT64 %d /* 0 or 1 */\n", | |
325 | SCM_I_GSC_HAVE_STRUCT_DIRENT64); | |
326 | ||
327 | pf ("/* Define to 1 if `readdir64_r ()' is available. */\n"); | |
328 | #ifdef HAVE_READDIR64_R | |
329 | pf ("#define SCM_HAVE_READDIR64_R 1 /* 0 or 1 */\n"); | |
330 | #else | |
331 | pf ("#define SCM_HAVE_READDIR64_R 0 /* 0 or 1 */\n"); | |
332 | #endif | |
333 | ||
f1ce9199 LC |
334 | /* Arrange so that we have a file offset type that reflects the one |
335 | used when compiling Guile, regardless of what the application's | |
336 | `_FILE_OFFSET_BITS' says. See | |
337 | http://lists.gnu.org/archive/html/bug-guile/2009-06/msg00018.html | |
338 | for the original bug report. | |
339 | ||
340 | Note that we can't define `scm_t_off' in terms of `off_t' or | |
341 | `off64_t' because they may or may not be available depending on | |
342 | how the application that uses Guile is compiled. */ | |
343 | ||
344 | #if defined GUILE_USE_64_CALLS && defined HAVE_STAT64 | |
345 | pf ("typedef scm_t_int64 scm_t_off;\n"); | |
346 | #elif SIZEOF_OFF_T == SIZEOF_INT | |
347 | pf ("typedef int scm_t_off;\n"); | |
348 | #else | |
349 | pf ("typedef long int scm_t_off;\n"); | |
350 | #endif | |
351 | ||
705edb95 LC |
352 | pf ("/* Define to 1 if the compiler supports the " |
353 | "`__thread' storage class. */\n"); | |
354 | if (SCM_I_GSC_HAVE_THREAD_STORAGE_CLASS) | |
355 | pf ("#define SCM_HAVE_THREAD_STORAGE_CLASS\n"); | |
356 | else | |
357 | pf ("/* #undef SCM_HAVE_THREAD_STORAGE_CLASS */\n"); | |
358 | ||
56a3dcd4 | 359 | #ifdef USE_DLL_IMPORT |
caeef9cb RB |
360 | pf ("\n"); |
361 | pf ("/* Define some additional CPP macros on Win32 platforms. */\n"); | |
362 | pf ("# define __REGEX_IMPORT__ 1\n"); | |
363 | pf ("# define __CRYPT_IMPORT__ 1\n"); | |
364 | pf ("# define __READLINE_IMPORT__ 1\n"); | |
365 | pf ("# define QT_IMPORT 1\n"); | |
366 | #endif | |
367 | ||
368 | pf ("\n"); | |
369 | pf ("#if SCM_ENABLE_DEPRECATED == 1\n" | |
370 | "# define USE_THREADS 1 /* always true now */\n" | |
371 | "# define GUILE_ISELECT 1 /* always true now */\n" | |
372 | "# define READER_EXTENSIONS 1 /* always true now */\n" | |
373 | "# define DEBUG_EXTENSIONS 1 /* always true now */\n" | |
374 | "# define DYNAMIC_LINKING 1 /* always true now */\n" | |
375 | "#endif\n"); | |
376 | printf ("\n"); | |
377 | ||
0fb1d264 | 378 | pf ("#define SCM_HAVE_ARRAYS 1 /* always true now */\n"); |
9c6e33c6 | 379 | |
eca29b02 MG |
380 | pf ("\n"); |
381 | pf ("/* Constants from uniconv.h. */\n"); | |
382 | pf ("#define SCM_ICONVEH_ERROR %d\n", (int) iconveh_error); | |
383 | pf ("#define SCM_ICONVEH_QUESTION_MARK %d\n", | |
384 | (int) iconveh_question_mark); | |
385 | pf ("#define SCM_ICONVEH_ESCAPE_SEQUENCE %d\n", | |
386 | (int) iconveh_escape_sequence); | |
387 | ||
caeef9cb RB |
388 | printf ("#endif\n"); |
389 | ||
390 | return 0; | |
391 | } |