* Eliminated use of SCM_ASSERT to check for range errors.
[bpt/guile.git] / libguile / hooks.c
CommitLineData
abd95148
MD
1/* Copyright (C) 1995, 1996, 1998, 1999, 2000 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/* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
43 gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
44
45\f
46
47#include <stdio.h>
48#include "libguile/_scm.h"
49
50#include "libguile/eval.h"
51#include "libguile/ports.h"
e11f8b42 52#include "libguile/objprop.h"
abd95148
MD
53#include "libguile/procprop.h"
54#include "libguile/root.h"
55#include "libguile/smob.h"
56#include "libguile/strings.h"
57
58#include "libguile/validate.h"
59#include "libguile/hooks.h"
60
61\f
62/* C level hooks
63 *
64 * Currently, this implementation is separate from the Scheme level
65 * hooks. The possibility exists to implement the Scheme level hooks
66 * using C level hooks.
67 */
68
69void
70scm_c_hook_init (scm_c_hook_t *hook, void *hook_data, scm_c_hook_type_t type)
71{
72 hook->first = 0;
73 hook->type = type;
74 hook->data = hook_data;
75}
76
77void
78scm_c_hook_add (scm_c_hook_t *hook,
79 scm_c_hook_function_t func,
80 void *func_data,
81 int appendp)
82{
83 scm_c_hook_entry_t *entry = scm_must_malloc (sizeof (scm_c_hook_entry_t),
84 "C level hook entry");
85 scm_c_hook_entry_t **loc = &hook->first;
86 if (appendp)
87 while (*loc)
88 *loc = (*loc)->next;
89 entry->next = *loc;
90 entry->func = func;
91 entry->data = func_data;
92 *loc = entry;
93}
94
95void
96scm_c_hook_remove (scm_c_hook_t *hook,
97 scm_c_hook_function_t func,
98 void *func_data)
99{
100 scm_c_hook_entry_t **loc = &hook->first;
101 while (*loc)
102 {
103 if ((*loc)->func == func && (*loc)->data == func_data)
104 {
105 scm_c_hook_entry_t *entry = *loc;
106 *loc = (*loc)->next;
107 scm_must_free (entry);
108 return;
109 }
110 loc = &(*loc)->next;
111 }
112 fprintf (stderr, "Attempt to remove non-existent hook function\n");
113 abort ();
114}
115
116void *
117scm_c_hook_run (scm_c_hook_t *hook, void *data)
118{
119 scm_c_hook_entry_t *entry = hook->first;
120 scm_c_hook_type_t type = hook->type;
121 void *res = 0;
122 while (entry)
123 {
124 res = (entry->func) (hook->data, entry->data, data);
125 if (res)
126 {
127 if (type == SCM_C_HOOK_OR)
128 break;
129 }
130 else
131 {
132 if (type == SCM_C_HOOK_AND)
133 break;
134 }
135 entry = entry->next;
136 }
137 return res;
138}
139
140\f
141/* Scheme level hooks
142 *
143 * A hook is basically a list of procedures to be called at well defined
144 * points in time.
145 *
e11f8b42
DH
146 * Hook arity is not a full member of this type and therefore lacks an
147 * accessor. It exists to aid debugging and is not intended to be used in
148 * programs.
abd95148
MD
149 */
150
151long scm_tc16_hook;
152
153
154static SCM
e11f8b42 155make_hook (SCM n_args, const char *subr)
abd95148
MD
156{
157 int n;
e11f8b42 158
abd95148 159 if (SCM_UNBNDP (n_args))
e11f8b42
DH
160 {
161 n = 0;
162 }
abd95148
MD
163 else
164 {
165 SCM_ASSERT (SCM_INUMP (n_args), n_args, SCM_ARGn, subr);
166 n = SCM_INUM (n_args);
685c0d71
DH
167 if (n < 0 || n > 16)
168 scm_out_of_range (subr, n_args);
abd95148 169 }
e11f8b42 170 SCM_RETURN_NEWSMOB (scm_tc16_hook + (n << 16), SCM_EOL);
abd95148
MD
171}
172
173
174static int
175print_hook (SCM hook, SCM port, scm_print_state *pstate)
176{
177 SCM ls, name;
178 scm_puts ("#<hook ", port);
abd95148
MD
179 scm_intprint (SCM_HOOK_ARITY (hook), 10, port);
180 scm_putc (' ', port);
181 scm_intprint (SCM_UNPACK (hook), 16, port);
182 ls = SCM_HOOK_PROCEDURES (hook);
183 while (SCM_NIMP (ls))
184 {
185 scm_putc (' ', port);
186 name = scm_procedure_name (SCM_CAR (ls));
187 if (SCM_NFALSEP (name))
188 scm_iprin1 (name, port, pstate);
189 else
190 scm_putc ('?', port);
191 ls = SCM_CDR (ls);
192 }
193 scm_putc ('>', port);
194 return 1;
195}
196
197
f8eaf8b9
DH
198SCM_SYMBOL (symbol_name, "name");
199
abd95148
MD
200SCM
201scm_create_hook (const char* name, int n_args)
202{
203 SCM vcell = scm_sysintern0 (name);
e11f8b42 204 SCM hook = make_hook (SCM_MAKINUM (n_args), "scm_create_hook");
abd95148 205 SCM_SETCDR (vcell, hook);
f8eaf8b9
DH
206 scm_set_object_property_x (hook, symbol_name, scm_makfrom0str (name));
207 scm_protect_object (hook);
abd95148
MD
208 return hook;
209}
210
211
e11f8b42
DH
212#if (SCM_DEBUG_DEPRECATED == 0)
213
abd95148
MD
214SCM_DEFINE (scm_make_hook_with_name, "make-hook-with-name", 1, 1, 0,
215 (SCM name, SCM n_args),
216"")
217#define FUNC_NAME s_scm_make_hook_with_name
218{
e11f8b42
DH
219 SCM hook = make_hook (n_args, FUNC_NAME);
220 scm_set_object_property_x (hook, scm_makfrom0str ("name"), name);
221 return hook;
abd95148
MD
222}
223#undef FUNC_NAME
224
e11f8b42
DH
225#endif /* SCM_DEBUG_DEPRECATED == 0 */
226
abd95148
MD
227
228SCM_DEFINE (scm_make_hook, "make-hook", 0, 1, 0,
229 (SCM n_args),
230"")
231#define FUNC_NAME s_scm_make_hook
232{
e11f8b42 233 return make_hook (n_args, FUNC_NAME);
abd95148
MD
234}
235#undef FUNC_NAME
236
237
238SCM_DEFINE (scm_hook_p, "hook?", 1, 0, 0,
239 (SCM x),
240"")
241#define FUNC_NAME s_scm_hook_p
242{
243 return SCM_BOOL (SCM_HOOKP (x));
244}
245#undef FUNC_NAME
246
247
248SCM_DEFINE (scm_hook_empty_p, "hook-empty?", 1, 0, 0,
249 (SCM hook),
250"")
251#define FUNC_NAME s_scm_hook_empty_p
252{
253 SCM_VALIDATE_HOOK (1, hook);
254 return SCM_BOOL (SCM_NULLP (SCM_HOOK_PROCEDURES (hook)));
255}
256#undef FUNC_NAME
257
258
259SCM_DEFINE (scm_add_hook_x, "add-hook!", 2, 1, 0,
260 (SCM hook, SCM proc, SCM append_p),
261"")
262#define FUNC_NAME s_scm_add_hook_x
263{
264 SCM arity, rest;
265 int n_args;
266 SCM_VALIDATE_HOOK (1,hook);
267 SCM_ASSERT (SCM_NFALSEP (arity = scm_i_procedure_arity (proc)),
268 proc, SCM_ARG2, FUNC_NAME);
269 n_args = SCM_HOOK_ARITY (hook);
270 if (SCM_INUM (SCM_CAR (arity)) > n_args
271 || (SCM_FALSEP (SCM_CADDR (arity))
272 && (SCM_INUM (SCM_CAR (arity)) + SCM_INUM (SCM_CADR (arity))
273 < n_args)))
274 scm_wrong_type_arg (FUNC_NAME, 2, proc);
275 rest = scm_delq_x (proc, SCM_HOOK_PROCEDURES (hook));
276 SCM_SET_HOOK_PROCEDURES (hook,
e11f8b42 277 (!SCM_UNBNDP (append_p) && !SCM_FALSEP (append_p)
abd95148
MD
278 ? scm_append_x (SCM_LIST2 (rest, SCM_LIST1 (proc)))
279 : scm_cons (proc, rest)));
280 return SCM_UNSPECIFIED;
281}
282#undef FUNC_NAME
283
284
285SCM_DEFINE (scm_remove_hook_x, "remove-hook!", 2, 0, 0,
286 (SCM hook, SCM proc),
287"")
288#define FUNC_NAME s_scm_remove_hook_x
289{
290 SCM_VALIDATE_HOOK (1, hook);
291 SCM_SET_HOOK_PROCEDURES (hook,
292 scm_delq_x (proc, SCM_HOOK_PROCEDURES (hook)));
293 return SCM_UNSPECIFIED;
294}
295#undef FUNC_NAME
296
297
298SCM_DEFINE (scm_reset_hook_x, "reset-hook!", 1, 0, 0,
299 (SCM hook),
300"")
301#define FUNC_NAME s_scm_reset_hook_x
302{
303 SCM_VALIDATE_HOOK (1,hook);
304 SCM_SET_HOOK_PROCEDURES (hook, SCM_EOL);
305 return SCM_UNSPECIFIED;
306}
307#undef FUNC_NAME
308
309
310SCM_DEFINE (scm_run_hook, "run-hook", 1, 0, 1,
311 (SCM hook, SCM args),
312"")
313#define FUNC_NAME s_scm_run_hook
314{
315 SCM_VALIDATE_HOOK (1,hook);
abd95148
MD
316 if (scm_ilength (args) != SCM_HOOK_ARITY (hook))
317 SCM_MISC_ERROR ("Hook ~S requires ~A arguments",
318 SCM_LIST2 (hook,SCM_MAKINUM (SCM_HOOK_ARITY (hook))));
319 scm_c_run_hook (hook, args);
320 return SCM_UNSPECIFIED;
321}
322#undef FUNC_NAME
323
324
325void
326scm_c_run_hook (SCM hook, SCM args)
327{
328 SCM procs = SCM_HOOK_PROCEDURES (hook);
329 while (SCM_NIMP (procs))
330 {
331 scm_apply (SCM_CAR (procs), args, SCM_EOL);
332 procs = SCM_CDR (procs);
333 }
334}
335
336
337SCM_DEFINE (scm_hook_to_list, "hook->list", 1, 0, 0,
338 (SCM hook),
339"")
340#define FUNC_NAME s_scm_hook_to_list
341{
342 SCM_VALIDATE_HOOK (1, hook);
343 return scm_list_copy (SCM_HOOK_PROCEDURES (hook));
344}
345#undef FUNC_NAME
346
347
348\f
349
350void
351scm_init_hooks ()
352{
353 scm_tc16_hook = scm_make_smob_type ("hook", 0);
354 scm_set_smob_mark (scm_tc16_hook, scm_markcdr);
355 scm_set_smob_print (scm_tc16_hook, print_hook);
356
357#include "libguile/hooks.x"
358}
359
360/*
361 Local Variables:
362 c-file-style: "gnu"
363 End:
364*/