Merge commit 'feccd2d3100fd2964d4c2df58ab3da7ce4949a66' into vm-check
[bpt/guile.git] / libguile / programs.h
1 /* Copyright (C) 2001 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 #ifndef _SCM_PROGRAMS_H_
43 #define _SCM_PROGRAMS_H_
44
45 #include <libguile.h>
46 #include <libguile/objcodes.h>
47
48 /*
49 * Programs
50 */
51
52 typedef unsigned char scm_byte_t;
53
54 extern scm_t_bits scm_tc16_program;
55
56 #define SCM_F_PROGRAM_IS_BOOT (1<<0)
57
58 #define SCM_PROGRAM_P(x) (SCM_SMOB_PREDICATE (scm_tc16_program, x))
59 #define SCM_PROGRAM_OBJCODE(x) (SCM_SMOB_OBJECT (x))
60 #define SCM_PROGRAM_OBJTABLE(x) (SCM_SMOB_OBJECT_2 (x))
61 #define SCM_PROGRAM_EXTERNALS(x) (SCM_SMOB_OBJECT_3 (x))
62 #define SCM_PROGRAM_DATA(x) (SCM_OBJCODE_DATA (SCM_PROGRAM_OBJCODE (x)))
63 #define SCM_VALIDATE_PROGRAM(p,x) SCM_MAKE_VALIDATE (p, x, PROGRAM_P)
64 #define SCM_PROGRAM_IS_BOOT(x) (SCM_SMOB_FLAGS (x) & SCM_F_PROGRAM_IS_BOOT)
65
66 extern SCM scm_make_program (SCM objcode, SCM objtable, SCM externals);
67
68 extern SCM scm_program_p (SCM obj);
69 extern SCM scm_program_base (SCM program);
70 extern SCM scm_program_arity (SCM program);
71 extern SCM scm_program_meta (SCM program);
72 extern SCM scm_program_bindings (SCM program);
73 extern SCM scm_program_sources (SCM program);
74 extern SCM scm_program_source (SCM program, SCM ip);
75 extern SCM scm_program_properties (SCM program);
76 extern SCM scm_program_name (SCM program);
77 extern SCM scm_program_objects (SCM program);
78 extern SCM scm_program_module (SCM program);
79 extern SCM scm_program_external (SCM program);
80 extern SCM scm_program_external_set_x (SCM program, SCM external);
81 extern SCM scm_program_objcode (SCM program);
82
83 extern SCM scm_c_program_source (SCM program, size_t ip);
84
85 extern void scm_bootstrap_programs (void);
86 extern void scm_init_programs (void);
87
88 #endif /* _SCM_PROGRAMS_H_ */
89
90 /*
91 Local Variables:
92 c-file-style: "gnu"
93 End:
94 */