← Back to branch summary

~peter-pearse/ubuntu/natty/guile-1.8/prop001

« back to all changes in this revision

Viewing changes to libguile/hooks.h

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Schepler
  • Date: 2006-11-09 03:11:16 UTC
  • Revision ID: james.westby@ubuntu.com-20061109031116-hu0q1jxqg12y6yeg
Tags: upstream-1.8.1+1
Import upstream version 1.8.1+1

Show diffs side-by-side

added added

removed removed

Lines of Context:
libguile/hooks.h
 
1
/* classes: h_files */
 
2
 
 
3
#ifndef SCM_HOOKS_H
 
4
#define SCM_HOOKS_H
 
5
 
 
6
/* Copyright (C) 1995,1996,1999,2000,2001, 2006 Free Software Foundation, Inc.
 
7
 *
 
8
 * This library is free software; you can redistribute it and/or
 
9
 * modify it under the terms of the GNU Lesser General Public
 
10
 * License as published by the Free Software Foundation; either
 
11
 * version 2.1 of the License, or (at your option) any later version.
 
12
 *
 
13
 * This library is distributed in the hope that it will be useful,
 
14
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
15
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
16
 * Lesser General Public License for more details.
 
17
 *
 
18
 * You should have received a copy of the GNU Lesser General Public
 
19
 * License along with this library; if not, write to the Free Software
 
20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
21
 */
 
22
 
 
23
 
 
24
 
 
25
#include "libguile/__scm.h"
 
26
 
 
27
/*
 
28
 * C level hooks
 
29
 */
 
30
 
 
31
/*
 
32
 * The interface is designed for and- and or-type hooks which
 
33
 * both may want to indicate success/failure and return a result.
 
34
 */
 
35
 
 
36
typedef enum scm_t_c_hook_type {
 
37
  SCM_C_HOOK_NORMAL,
 
38
  SCM_C_HOOK_OR,
 
39
  SCM_C_HOOK_AND
 
40
} scm_t_c_hook_type;
 
41
 
 
42
typedef void  *(*scm_t_c_hook_function) (void *hook_data,
 
43
                                         void *func_data,
 
44
                                         void *data);
 
45
 
 
46
typedef struct scm_t_c_hook_entry {
 
47
  struct scm_t_c_hook_entry *next;
 
48
  scm_t_c_hook_function func;
 
49
  void *data;
 
50
} scm_t_c_hook_entry;
 
51
 
 
52
typedef struct scm_t_c_hook {
 
53
  scm_t_c_hook_entry *first;
 
54
  scm_t_c_hook_type type;
 
55
  void *data;
 
56
} scm_t_c_hook;
 
57
 
 
58
SCM_API void scm_c_hook_init (scm_t_c_hook *hook,
 
59
                              void *hook_data,
 
60
                              scm_t_c_hook_type type);
 
61
SCM_API void scm_c_hook_add (scm_t_c_hook *hook,
 
62
                             scm_t_c_hook_function func,
 
63
                             void *func_data, 
 
64
                             int appendp);
 
65
SCM_API void scm_c_hook_remove (scm_t_c_hook *hook,
 
66
                                scm_t_c_hook_function func,
 
67
                                void *func_data);
 
68
SCM_API void *scm_c_hook_run (scm_t_c_hook *hook, void *data);
 
69
 
 
70
/*
 
71
 * Scheme level hooks
 
72
 */
 
73
 
 
74
SCM_API scm_t_bits scm_tc16_hook;
 
75
 
 
76
#define SCM_HOOKP(x)                    SCM_SMOB_PREDICATE (scm_tc16_hook, x)
 
77
#define SCM_HOOK_ARITY(hook)            SCM_SMOB_FLAGS (hook)
 
78
#define SCM_HOOK_PROCEDURES(hook)       SCM_SMOB_OBJECT (hook)
 
79
#define SCM_SET_HOOK_PROCEDURES(hook, procs) SCM_SET_SMOB_OBJECT ((hook), (procs))
 
80
 
 
81
SCM_API SCM scm_make_hook (SCM n_args);
 
82
SCM_API SCM scm_hook_p (SCM x);
 
83
SCM_API SCM scm_hook_empty_p (SCM hook);
 
84
SCM_API SCM scm_add_hook_x (SCM hook, SCM thunk, SCM appendp);
 
85
SCM_API SCM scm_remove_hook_x (SCM hook, SCM thunk);
 
86
SCM_API SCM scm_reset_hook_x (SCM hook);
 
87
SCM_API SCM scm_run_hook (SCM hook, SCM args);
 
88
SCM_API void scm_c_run_hook (SCM hook, SCM args);
 
89
SCM_API SCM scm_hook_to_list (SCM hook);
 
90
SCM_API void scm_init_hooks (void);
 
91
 
 
92
#endif  /* SCM_HOOKS_H */
 
93
 
 
94
/*
 
95
  Local Variables:
 
96
  c-file-style: "gnu"
 
97
  End:
 
98
*/