1 /* Copyright (C) 1995,1996,1998,1999,2000,2001 Free Software Foundation, Inc.
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)
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.
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
18 * As a special exception, the Free Software Foundation gives permission
19 * for additional uses of the text contained in its release of GUILE.
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.
27 * This exception does not however invalidate any other reasons why
28 * the executable file might be covered by the GNU General Public License.
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.
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. */
42 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
43 gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
48 #include "libguile/_scm.h"
50 #include "libguile/eval.h"
51 #include "libguile/ports.h"
52 #include "libguile/procprop.h"
53 #include "libguile/root.h"
54 #include "libguile/smob.h"
55 #include "libguile/strings.h"
57 #include "libguile/validate.h"
58 #include "libguile/hooks.h"
63 * Currently, this implementation is separate from the Scheme level
64 * hooks. The possibility exists to implement the Scheme level hooks
65 * using C level hooks.
69 scm_c_hook_init (scm_t_c_hook
*hook
, void *hook_data
, scm_t_c_hookype_t type
)
73 hook
->data
= hook_data
;
77 scm_c_hook_add (scm_t_c_hook
*hook
,
78 scm_t_c_hook_function func
,
82 scm_t_c_hook_entry
*entry
= scm_must_malloc (sizeof (scm_t_c_hook_entry
),
83 "C level hook entry");
84 scm_t_c_hook_entry
**loc
= &hook
->first
;
90 entry
->data
= func_data
;
95 scm_c_hook_remove (scm_t_c_hook
*hook
,
96 scm_t_c_hook_function func
,
99 scm_t_c_hook_entry
**loc
= &hook
->first
;
102 if ((*loc
)->func
== func
&& (*loc
)->data
== func_data
)
104 scm_t_c_hook_entry
*entry
= *loc
;
106 scm_must_free (entry
);
111 fprintf (stderr
, "Attempt to remove non-existent hook function\n");
116 scm_c_hook_run (scm_t_c_hook
*hook
, void *data
)
118 scm_t_c_hook_entry
*entry
= hook
->first
;
119 scm_t_c_hookype_t type
= hook
->type
;
123 res
= (entry
->func
) (hook
->data
, entry
->data
, data
);
126 if (type
== SCM_C_HOOK_OR
)
131 if (type
== SCM_C_HOOK_AND
)
140 /* Scheme level hooks
142 * A hook is basically a list of procedures to be called at well defined
145 * Hook arity is not a full member of this type and therefore lacks an
146 * accessor. It exists to aid debugging and is not intended to be used in
150 scm_t_bits scm_tc16_hook
;
154 hook_print (SCM hook
, SCM port
, scm_print_state
*pstate
)
157 scm_puts ("#<hook ", port
);
158 scm_intprint (SCM_HOOK_ARITY (hook
), 10, port
);
159 scm_putc (' ', port
);
160 scm_intprint (SCM_UNPACK (hook
), 16, port
);
161 ls
= SCM_HOOK_PROCEDURES (hook
);
162 while (SCM_NIMP (ls
))
164 scm_putc (' ', port
);
165 name
= scm_procedure_name (SCM_CAR (ls
));
166 if (!SCM_FALSEP (name
))
167 scm_iprin1 (name
, port
, pstate
);
169 scm_putc ('?', port
);
172 scm_putc ('>', port
);
176 #if (SCM_DEBUG_DEPRECATED == 0)
179 scm_create_hook (const char *name
, int n_args
)
181 SCM hook
= scm_make_hook (SCM_MAKINUM (n_args
));
182 scm_c_define (name
, hook
);
183 return scm_permanent_object (hook
);
188 SCM_DEFINE (scm_make_hook
, "make-hook", 0, 1, 0,
190 "Create a hook for storing procedure of arity\n"
191 "@var{n_args}. @var{n_args} defaults to zero.")
192 #define FUNC_NAME s_scm_make_hook
196 if (SCM_UNBNDP (n_args
))
202 SCM_VALIDATE_INUM_COPY (SCM_ARG1
, n_args
, n
);
204 SCM_OUT_OF_RANGE (SCM_ARG1
, n_args
);
207 SCM_RETURN_NEWSMOB (scm_tc16_hook
+ (n
<< 16), SCM_UNPACK (SCM_EOL
));
212 SCM_DEFINE (scm_hook_p
, "hook?", 1, 0, 0,
214 "Return @code{#t} if @var{x} is a hook, @code{#f} otherwise.")
215 #define FUNC_NAME s_scm_hook_p
217 return SCM_BOOL (SCM_HOOKP (x
));
222 SCM_DEFINE (scm_hook_empty_p
, "hook-empty?", 1, 0, 0,
224 "Return @code{#t} if @var{hook} is an empty hook, @code{#f}\n"
226 #define FUNC_NAME s_scm_hook_empty_p
228 SCM_VALIDATE_HOOK (1, hook
);
229 return SCM_BOOL (SCM_NULLP (SCM_HOOK_PROCEDURES (hook
)));
234 SCM_DEFINE (scm_add_hook_x
, "add-hook!", 2, 1, 0,
235 (SCM hook
, SCM proc
, SCM append_p
),
236 "Add the procedure @var{proc} to the hook @var{hook}. The\n"
237 "procedure is added to the end if @var{append_p} is true,\n"
238 "otherwise it is added to the front.")
239 #define FUNC_NAME s_scm_add_hook_x
243 SCM_VALIDATE_HOOK (1,hook
);
244 SCM_ASSERT (!SCM_FALSEP (arity
= scm_i_procedure_arity (proc
)),
245 proc
, SCM_ARG2
, FUNC_NAME
);
246 n_args
= SCM_HOOK_ARITY (hook
);
247 if (SCM_INUM (SCM_CAR (arity
)) > n_args
248 || (SCM_FALSEP (SCM_CADDR (arity
))
249 && (SCM_INUM (SCM_CAR (arity
)) + SCM_INUM (SCM_CADR (arity
))
251 scm_wrong_type_arg (FUNC_NAME
, 2, proc
);
252 rest
= scm_delq_x (proc
, SCM_HOOK_PROCEDURES (hook
));
253 SCM_SET_HOOK_PROCEDURES (hook
,
254 (!SCM_UNBNDP (append_p
) && !SCM_FALSEP (append_p
)
255 ? scm_append_x (scm_list_2 (rest
, scm_list_1 (proc
)))
256 : scm_cons (proc
, rest
)));
257 return SCM_UNSPECIFIED
;
262 SCM_DEFINE (scm_remove_hook_x
, "remove-hook!", 2, 0, 0,
263 (SCM hook
, SCM proc
),
264 "Remove the procedure @var{proc} from the hook @var{hook}.")
265 #define FUNC_NAME s_scm_remove_hook_x
267 SCM_VALIDATE_HOOK (1, hook
);
268 SCM_SET_HOOK_PROCEDURES (hook
,
269 scm_delq_x (proc
, SCM_HOOK_PROCEDURES (hook
)));
270 return SCM_UNSPECIFIED
;
275 SCM_DEFINE (scm_reset_hook_x
, "reset-hook!", 1, 0, 0,
277 "Remove all procedures from the hook @var{hook}.")
278 #define FUNC_NAME s_scm_reset_hook_x
280 SCM_VALIDATE_HOOK (1,hook
);
281 SCM_SET_HOOK_PROCEDURES (hook
, SCM_EOL
);
282 return SCM_UNSPECIFIED
;
287 SCM_DEFINE (scm_run_hook
, "run-hook", 1, 0, 1,
288 (SCM hook
, SCM args
),
289 "Apply all procedures from the hook @var{hook} to the arguments\n"
290 "@var{args}. The order of the procedure application is first to\n"
292 #define FUNC_NAME s_scm_run_hook
294 SCM_VALIDATE_HOOK (1,hook
);
295 if (scm_ilength (args
) != SCM_HOOK_ARITY (hook
))
296 SCM_MISC_ERROR ("Hook ~S requires ~A arguments",
297 scm_list_2 (hook
, SCM_MAKINUM (SCM_HOOK_ARITY (hook
))));
298 scm_c_run_hook (hook
, args
);
299 return SCM_UNSPECIFIED
;
305 scm_c_run_hook (SCM hook
, SCM args
)
307 SCM procs
= SCM_HOOK_PROCEDURES (hook
);
308 while (SCM_NIMP (procs
))
310 scm_apply_0 (SCM_CAR (procs
), args
);
311 procs
= SCM_CDR (procs
);
316 SCM_DEFINE (scm_hook_to_list
, "hook->list", 1, 0, 0,
318 "Convert the procedure list of @var{hook} to a list.")
319 #define FUNC_NAME s_scm_hook_to_list
321 SCM_VALIDATE_HOOK (1, hook
);
322 return scm_list_copy (SCM_HOOK_PROCEDURES (hook
));
332 scm_tc16_hook
= scm_make_smob_type ("hook", 0);
333 scm_set_smob_mark (scm_tc16_hook
, scm_markcdr
);
334 scm_set_smob_print (scm_tc16_hook
, hook_print
);
335 #ifndef SCM_MAGIC_SNARFER
336 #include "libguile/hooks.x"