* __scm.h (SCM_ALLOW_INTS_ONLY): Removed.
[bpt/guile.git] / libguile / init.c
1 /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002 Free Software Foundation, Inc.
2 *
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2, or (at your option)
6 * any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this software; see the file COPYING. If not, write to
15 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
16 * Boston, MA 02111-1307 USA
17 *
18 * As a special exception, the Free Software Foundation gives permission
19 * for additional uses of the text contained in its release of GUILE.
20 *
21 * The exception is that, if you link the GUILE library with other files
22 * to produce an executable, this does not by itself cause the
23 * resulting executable to be covered by the GNU General Public License.
24 * Your use of that executable is in no way restricted on account of
25 * linking the GUILE library code into it.
26 *
27 * This exception does not however invalidate any other reasons why
28 * the executable file might be covered by the GNU General Public License.
29 *
30 * This exception applies only to the code released by the
31 * Free Software Foundation under the name GUILE. If you copy
32 * code from other Free Software Foundation releases into a copy of
33 * GUILE, as the General Public License permits, the exception does
34 * not apply to the code that you add in this way. To avoid misleading
35 * anyone as to the status of such modified files, you must delete
36 * this exception notice from them.
37 *
38 * If you write modifications of your own for GUILE, it is your choice
39 * whether to permit this exception to apply to your modifications.
40 * If you do not wish that, delete this exception notice. */
41
42
43 \f
44 /* Include the headers for just about everything.
45 We call all their initialization functions. */
46
47 #include <stdio.h>
48 #include <sys/stat.h>
49 #include <fcntl.h>
50
51 #include "libguile/_scm.h"
52
53 /* Everybody has an init function. */
54 #include "libguile/alist.h"
55 #include "libguile/arbiters.h"
56 #include "libguile/async.h"
57 #include "libguile/backtrace.h"
58 #include "libguile/boolean.h"
59 #include "libguile/chars.h"
60 #include "libguile/continuations.h"
61 #ifdef DEBUG_EXTENSIONS
62 #include "libguile/debug.h"
63 #endif
64 #ifdef GUILE_DEBUG_MALLOC
65 #include "libguile/debug-malloc.h"
66 #endif
67 #include "libguile/deprecation.h"
68 #include "libguile/dynl.h"
69 #include "libguile/dynwind.h"
70 #include "libguile/environments.h"
71 #include "libguile/eq.h"
72 #include "libguile/error.h"
73 #include "libguile/eval.h"
74 #include "libguile/evalext.h"
75 #include "libguile/feature.h"
76 #include "libguile/filesys.h"
77 #include "libguile/fluids.h"
78 #include "libguile/fports.h"
79 #include "libguile/gc.h"
80 #include "libguile/gdbint.h"
81 #include "libguile/goops.h"
82 #include "libguile/gsubr.h"
83 #include "libguile/hash.h"
84 #include "libguile/hashtab.h"
85 #include "libguile/hooks.h"
86 #include "libguile/iselect.h"
87 #include "libguile/ioext.h"
88 #include "libguile/keywords.h"
89 #include "libguile/lang.h"
90 #include "libguile/list.h"
91 #include "libguile/load.h"
92 #include "libguile/macros.h"
93 #include "libguile/mallocs.h"
94 #include "libguile/modules.h"
95 #include "libguile/net_db.h"
96 #include "libguile/numbers.h"
97 #include "libguile/objects.h"
98 #include "libguile/objprop.h"
99 #include "libguile/options.h"
100 #include "libguile/pairs.h"
101 #include "libguile/ports.h"
102 #include "libguile/posix.h"
103 #ifdef HAVE_REGCOMP
104 #include "libguile/regex-posix.h"
105 #endif
106 #include "libguile/print.h"
107 #include "libguile/procprop.h"
108 #include "libguile/procs.h"
109 #include "libguile/properties.h"
110 #include "libguile/ramap.h"
111 #include "libguile/random.h"
112 #include "libguile/rdelim.h"
113 #include "libguile/read.h"
114 #include "libguile/rw.h"
115 #include "libguile/scmsigs.h"
116 #include "libguile/script.h"
117 #include "libguile/simpos.h"
118 #include "libguile/smob.h"
119 #include "libguile/socket.h"
120 #include "libguile/sort.h"
121 #include "libguile/srcprop.h"
122 #include "libguile/stackchk.h"
123 #include "libguile/stacks.h"
124 #include "libguile/stime.h"
125 #include "libguile/strings.h"
126 #include "libguile/strop.h"
127 #include "libguile/strorder.h"
128 #include "libguile/strports.h"
129 #include "libguile/struct.h"
130 #include "libguile/symbols.h"
131 #include "libguile/throw.h"
132 #include "libguile/unif.h"
133 #include "libguile/values.h"
134 #include "libguile/variable.h"
135 #include "libguile/vectors.h"
136 #include "libguile/version.h"
137 #include "libguile/vports.h"
138 #include "libguile/weaks.h"
139 #include "libguile/guardians.h"
140 #include "libguile/extensions.h"
141
142 #include "libguile/init.h"
143
144 #ifdef HAVE_STRING_H
145 #include <string.h>
146 #endif
147 #ifdef HAVE_UNISTD_H
148 #include <unistd.h>
149 #endif
150 \f
151 /* Setting up the stack. */
152
153 static void
154 restart_stack (void *base)
155 {
156 scm_dynwinds = SCM_EOL;
157 SCM_DYNENV (scm_rootcont) = SCM_EOL;
158 SCM_THROW_VALUE (scm_rootcont) = SCM_EOL;
159 #ifdef DEBUG_EXTENSIONS
160 SCM_DFRAME (scm_rootcont) = scm_last_debug_frame = 0;
161 #endif
162 SCM_BASE (scm_rootcont) = base;
163 }
164
165 static void
166 start_stack (void *base)
167 {
168 SCM root;
169
170 root = scm_permanent_object (scm_make_root (SCM_UNDEFINED));
171 scm_set_root (SCM_ROOT_STATE (root));
172 scm_stack_base = base;
173
174 scm_exitval = SCM_BOOL_F; /* vestigial */
175
176 scm_root->fluids = scm_make_initial_fluids ();
177
178 /* Create an object to hold the root continuation.
179 */
180 {
181 scm_t_contregs *contregs = scm_gc_malloc (sizeof (scm_t_contregs),
182 "continuation");
183 contregs->num_stack_items = 0;
184 contregs->seq = 0;
185 SCM_NEWSMOB (scm_rootcont, scm_tc16_continuation, contregs);
186 }
187
188 /* The remainder of stack initialization is factored out to another
189 * function so that if this stack is ever exitted, it can be
190 * re-entered using restart_stack. */
191 restart_stack (base);
192 }
193
194
195 #if 0
196 static char remsg[] = "remove\n#define ", addmsg[] = "add\n#define ";
197
198
199 static void
200 fixconfig (char *s1, char *s2, int s)
201 {
202 fputs (s1, stderr);
203 fputs (s2, stderr);
204 fputs ("\nin ", stderr);
205 fputs (s ? "setjump" : "scmfig", stderr);
206 fputs (".h and recompile scm\n", stderr);
207 exit (1);
208 }
209
210
211 static void
212 check_config (void)
213 {
214 size_t j;
215
216 j = HEAP_SEG_SIZE;
217 if (HEAP_SEG_SIZE != j)
218 fixconfig ("reduce", "size of HEAP_SEG_SIZE", 0);
219
220 #ifdef SCM_BIGDIG
221 if (2 * SCM_BITSPERDIG / SCM_CHAR_BIT > sizeof (long))
222 fixconfig (remsg, "SCM_BIGDIG", 0);
223 #ifndef SCM_DIGSTOOBIG
224 if (SCM_DIGSPERLONG * sizeof (SCM_BIGDIG) > sizeof (long))
225 fixconfig (addmsg, "SCM_DIGSTOOBIG", 0);
226 #endif
227 #endif
228
229 #ifdef SCM_STACK_GROWS_UP
230 if (((SCM_STACKITEM *) & j - stack_start_ptr) < 0)
231 fixconfig (remsg, "SCM_STACK_GROWS_UP", 1);
232 #else
233 if ((stack_start_ptr - (SCM_STACKITEM *) & j) < 0)
234 fixconfig (addmsg, "SCM_STACK_GROWS_UP", 1);
235 #endif
236 }
237 #endif
238
239
240 \f
241 /* initializing standard and current I/O ports */
242
243 typedef struct
244 {
245 int fdes;
246 char *mode;
247 char *name;
248 } stream_body_data;
249
250 /* proc to be called in scope of exception handler stream_handler. */
251 static SCM
252 stream_body (void *data)
253 {
254 stream_body_data *body_data = (stream_body_data *) data;
255 SCM port = scm_fdes_to_port (body_data->fdes, body_data->mode,
256 scm_makfrom0str (body_data->name));
257
258 SCM_REVEALED (port) = 1;
259 return port;
260 }
261
262 /* exception handler for stream_body. */
263 static SCM
264 stream_handler (void *data SCM_UNUSED,
265 SCM tag SCM_UNUSED,
266 SCM throw_args SCM_UNUSED)
267 {
268 return SCM_BOOL_F;
269 }
270
271 /* Convert a file descriptor to a port, using scm_fdes_to_port.
272 - NAME is a C string, not a Guile string
273 - set the revealed count for FILE's file descriptor to 1, so
274 that fdes won't be closed when the port object is GC'd.
275 - catch exceptions: allow Guile to be able to start up even
276 if it has been handed bogus stdin/stdout/stderr. replace the
277 bad ports with void ports. */
278 static SCM
279 scm_standard_stream_to_port (int fdes, char *mode, char *name)
280 {
281 SCM port;
282 stream_body_data body_data;
283
284 body_data.fdes = fdes;
285 body_data.mode = mode;
286 body_data.name = name;
287 port = scm_internal_catch (SCM_BOOL_T, stream_body, &body_data,
288 stream_handler, NULL);
289 if (SCM_FALSEP (port))
290 port = scm_void_port (mode);
291 return port;
292 }
293
294 /* Create standard ports from stdin, stdout, and stderr. */
295 static void
296 scm_init_standard_ports ()
297 {
298 /* From the SCSH manual:
299
300 It can be useful to turn I/O buffering off in some cases, for
301 example when an I/O stream is to be shared by multiple
302 subprocesses. For this reason, scsh allocates an unbuffered port
303 for file descriptor 0 at start-up time.
304
305 Because shells frequently share stdin with subprocesses, if the
306 shell does buffered reads, it might ``steal'' input intended for
307 a subprocess. For this reason, all shells, including sh, csh,
308 and scsh, read stdin unbuffered. Applications that can tolerate
309 buffered input on stdin can reset \ex{(current-input-port)} to
310 block buffering for higher performance. */
311
312 scm_cur_inp
313 = scm_standard_stream_to_port (0,
314 isatty (0) ? "r0" : "r",
315 "standard input");
316 scm_cur_outp = scm_standard_stream_to_port (1,
317 isatty (1) ? "w0" : "w",
318 "standard output");
319 scm_cur_errp = scm_standard_stream_to_port (2,
320 isatty (2) ? "w0" : "w",
321 "standard error");
322
323 scm_cur_loadp = SCM_BOOL_F;
324 }
325
326
327 \f
328 /* Loading the startup Scheme files. */
329
330 /* The boot code "ice-9/boot-9" is only loaded by scm_boot_guile when
331 this is false. The unexec code uses this, to keep ice_9 from being
332 loaded into dumped guile executables. */
333 int scm_ice_9_already_loaded = 0;
334
335 void
336 scm_load_startup_files ()
337 {
338 /* We want a path only containing directories from GUILE_LOAD_PATH,
339 SCM_SITE_DIR and SCM_LIBRARY_DIR when searching for the site init
340 file, so we do this before loading Ice-9. */
341 SCM init_path = scm_sys_search_load_path (scm_makfrom0str ("init.scm"));
342
343 /* Load Ice-9. */
344 if (!scm_ice_9_already_loaded)
345 {
346 scm_primitive_load_path (scm_makfrom0str ("ice-9/boot-9.scm"));
347
348 /* Load the init.scm file. */
349 if (SCM_NFALSEP (init_path))
350 scm_primitive_load (init_path);
351 }
352 }
353
354 \f
355 /* The main init code. */
356
357 #ifdef _UNICOS
358 typedef int setjmp_type;
359 #else
360 typedef long setjmp_type;
361 #endif
362
363 /* All the data needed to invoke the main function. */
364 struct main_func_closure
365 {
366 /* the function to call */
367 void (*main_func)(void *closure, int argc, char **argv);
368 void *closure; /* dummy data to pass it */
369 int argc;
370 char **argv; /* the argument list it should receive */
371 };
372
373
374 static void scm_init_guile_1 (SCM_STACKITEM *base);
375 static void scm_boot_guile_1 (SCM_STACKITEM *base,
376 struct main_func_closure *closure);
377 static SCM invoke_main_func(void *body_data);
378
379
380 /* Fire up the Guile Scheme interpreter.
381
382 Call MAIN_FUNC, passing it CLOSURE, ARGC, and ARGV. MAIN_FUNC
383 should do all the work of the program (initializing other packages,
384 reading user input, etc.) before returning. When MAIN_FUNC
385 returns, call exit (0); this function never returns. If you want
386 some other exit value, MAIN_FUNC may call exit itself.
387
388 scm_boot_guile arranges for program-arguments to return the strings
389 given by ARGC and ARGV. If MAIN_FUNC modifies ARGC/ARGV, should
390 call scm_set_program_arguments with the final list, so Scheme code
391 will know which arguments have been processed.
392
393 scm_boot_guile establishes a catch-all catch handler which prints
394 an error message and exits the process. This means that Guile
395 exits in a coherent way when system errors occur and the user isn't
396 prepared to handle it. If the user doesn't like this behavior,
397 they can establish their own universal catcher to shadow this one.
398
399 Why must the caller do all the real work from MAIN_FUNC? The
400 garbage collector assumes that all local variables of type SCM will
401 be above scm_boot_guile's stack frame on the stack. If you try to
402 manipulate SCM values after this function returns, it's the luck of
403 the draw whether the GC will be able to find the objects you
404 allocate. So, scm_boot_guile function exits, rather than
405 returning, to discourage people from making that mistake. */
406
407
408 void
409 scm_boot_guile (int argc, char ** argv, void (*main_func) (), void *closure)
410 {
411 /* The garbage collector uses the address of this variable as one
412 end of the stack, and the address of one of its own local
413 variables as the other end. */
414 SCM_STACKITEM dummy;
415 struct main_func_closure c;
416
417 c.main_func = main_func;
418 c.closure = closure;
419 c.argc = argc;
420 c.argv = argv;
421
422 scm_boot_guile_1 (&dummy, &c);
423 }
424
425 void
426 scm_init_guile ()
427 {
428 scm_init_guile_1 ((SCM_STACKITEM *)scm_get_stack_base ());
429 }
430
431 int scm_initialized_p = 0;
432
433 static void
434 scm_init_guile_1 (SCM_STACKITEM *base)
435 {
436 if (scm_initialized_p)
437 return;
438
439 if (base == NULL)
440 {
441 fprintf (stderr, "cannot determine stack base!\n");
442 abort ();
443 }
444
445 scm_ints_disabled = 1;
446 scm_block_gc = 1;
447
448 scm_threads_prehistory ();
449 scm_ports_prehistory ();
450 scm_smob_prehistory ();
451 scm_tables_prehistory ();
452 #ifdef GUILE_DEBUG_MALLOC
453 scm_debug_malloc_prehistory ();
454 #endif
455 if (scm_init_storage ()) /* requires threads and smob_prehistory */
456 abort ();
457
458 scm_struct_prehistory (); /* requires storage */
459 scm_symbols_prehistory (); /* requires storage */
460 scm_weaks_prehistory (); /* requires storage */
461 scm_init_subr_table ();
462 scm_environments_prehistory (); /* requires storage */
463 scm_modules_prehistory (); /* requires storage */
464 scm_init_variable (); /* all bindings need variables */
465 scm_init_continuations ();
466 scm_init_root (); /* requires continuations */
467 scm_init_threads (base);
468 start_stack (base);
469 scm_init_gsubr ();
470 scm_init_thread_procs (); /* requires gsubrs */
471 scm_init_procprop ();
472 scm_init_environments ();
473 scm_init_feature ();
474 scm_init_alist ();
475 scm_init_arbiters ();
476 scm_init_async ();
477 scm_init_boolean ();
478 scm_init_chars ();
479 #ifdef GUILE_DEBUG_MALLOC
480 scm_init_debug_malloc ();
481 #endif
482 scm_init_dynwind ();
483 scm_init_eq ();
484 scm_init_error ();
485 scm_init_fluids ();
486 scm_init_backtrace (); /* Requires fluids */
487 scm_init_fports ();
488 scm_init_strports ();
489 scm_init_gdbint (); /* Requires strports */
490 scm_init_hash ();
491 scm_init_hashtab ();
492 scm_init_deprecation (); /* Requires hashtabs */
493 scm_init_objprop ();
494 scm_init_properties ();
495 scm_init_hooks (); /* Requires smob_prehistory */
496 scm_init_gc (); /* Requires hooks, async */
497 scm_init_ioext ();
498 scm_init_keywords ();
499 scm_init_list ();
500 scm_init_macros ();
501 scm_init_mallocs ();
502 scm_init_modules ();
503 scm_init_numbers ();
504 scm_init_options ();
505 scm_init_pairs ();
506 scm_init_ports ();
507 #ifdef HAVE_POSIX
508 scm_init_filesys ();
509 scm_init_posix ();
510 #endif
511 #ifdef HAVE_REGCOMP
512 scm_init_regex_posix ();
513 #endif
514 scm_init_procs ();
515 scm_init_scmsigs ();
516 #ifdef HAVE_NETWORKING
517 scm_init_net_db ();
518 scm_init_socket ();
519 #endif
520 scm_init_sort ();
521 #ifdef DEBUG_EXTENSIONS
522 scm_init_srcprop ();
523 #endif
524 scm_init_stackchk ();
525 scm_init_strings ();
526 scm_init_struct (); /* Requires strings */
527 scm_init_stacks (); /* Requires strings, struct */
528 scm_init_symbols ();
529 scm_init_values (); /* Requires struct */
530 scm_init_load (); /* Requires strings */
531 scm_init_objects (); /* Requires struct */
532 scm_init_print (); /* Requires strings, struct */
533 scm_init_read ();
534 scm_init_stime ();
535 scm_init_strorder ();
536 scm_init_strop ();
537 scm_init_throw ();
538 scm_init_vectors ();
539 scm_init_version ();
540 scm_init_weaks ();
541 scm_init_guardians ();
542 scm_init_vports ();
543 scm_init_eval ();
544 scm_init_evalext ();
545 #ifdef DEBUG_EXTENSIONS
546 scm_init_debug (); /* Requires macro smobs */
547 #endif
548 scm_init_random ();
549 #ifdef HAVE_ARRAYS
550 scm_init_ramap ();
551 scm_init_unif ();
552 #endif
553 scm_init_simpos ();
554 scm_init_load_path ();
555 scm_init_standard_ports (); /* Requires fports */
556 #ifdef DYNAMIC_LINKING
557 scm_init_dynamic_linking ();
558 #endif
559 #ifdef SCM_ENABLE_ELISP
560 scm_init_lang ();
561 #endif /* SCM_ENABLE_ELISP */
562 scm_init_script ();
563
564 scm_init_goops ();
565
566 scm_initialized_p = 1;
567
568 scm_block_gc = 0; /* permit the gc to run */
569 /* ints still disabled */
570
571 #ifdef STACK_CHECKING
572 scm_stack_checking_enabled_p = SCM_STACK_CHECKING_P;
573 #endif
574
575 scm_init_rdelim ();
576 scm_init_rw ();
577 scm_init_extensions ();
578
579 scm_load_startup_files ();
580 }
581
582 /* Record here whether SCM_BOOT_GUILE_1 has already been called. This
583 variable is now here and not inside SCM_BOOT_GUILE_1 so that one
584 can tweak it. This is necessary for unexec to work. (Hey, "1-live"
585 is the name of a local radiostation...) */
586
587 int scm_boot_guile_1_live = 0;
588
589 static void
590 scm_boot_guile_1 (SCM_STACKITEM *base, struct main_func_closure *closure)
591 {
592 scm_init_guile_1 (base);
593
594 /* This function is not re-entrant. */
595 if (scm_boot_guile_1_live)
596 abort ();
597
598 scm_boot_guile_1_live = 1;
599
600 scm_set_program_arguments (closure->argc, closure->argv, 0);
601 invoke_main_func (closure);
602
603 scm_restore_signals ();
604
605 /* This tick gives any pending
606 * asyncs a chance to run. This must be done after
607 * the call to scm_restore_signals.
608 */
609 SCM_ASYNC_TICK;
610
611 /* If the caller doesn't want this, they should return from
612 main_func themselves. */
613 exit (0);
614 }
615
616 static SCM
617 invoke_main_func (void *body_data)
618 {
619 struct main_func_closure *closure = (struct main_func_closure *) body_data;
620
621 (*closure->main_func) (closure->closure, closure->argc, closure->argv);
622
623 /* never reached */
624 return SCM_UNDEFINED;
625 }
626
627 /*
628 Local Variables:
629 c-file-style: "gnu"
630 End:
631 */