| 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, 2008, 2009 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 License |
| 10 | * as published by the Free Software Foundation; either version 3 of |
| 11 | * the License, or (at your option) any later version. |
| 12 | * |
| 13 | * This library is distributed in the hope that it will be useful, but |
| 14 | * 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 |
| 21 | * 02110-1301 USA |
| 22 | */ |
| 23 | |
| 24 | \f |
| 25 | |
| 26 | #include "libguile/__scm.h" |
| 27 | |
| 28 | /* |
| 29 | * C level hooks |
| 30 | */ |
| 31 | |
| 32 | /* |
| 33 | * The interface is designed for and- and or-type hooks which |
| 34 | * both may want to indicate success/failure and return a result. |
| 35 | */ |
| 36 | |
| 37 | typedef enum scm_t_c_hook_type { |
| 38 | SCM_C_HOOK_NORMAL, |
| 39 | SCM_C_HOOK_OR, |
| 40 | SCM_C_HOOK_AND |
| 41 | } scm_t_c_hook_type; |
| 42 | |
| 43 | typedef void *(*scm_t_c_hook_function) (void *hook_data, |
| 44 | void *fn_data, |
| 45 | void *data); |
| 46 | |
| 47 | typedef struct scm_t_c_hook_entry { |
| 48 | struct scm_t_c_hook_entry *next; |
| 49 | scm_t_c_hook_function func; |
| 50 | void *data; |
| 51 | } scm_t_c_hook_entry; |
| 52 | |
| 53 | typedef struct scm_t_c_hook { |
| 54 | scm_t_c_hook_entry *first; |
| 55 | scm_t_c_hook_type type; |
| 56 | void *data; |
| 57 | } scm_t_c_hook; |
| 58 | |
| 59 | SCM_API void scm_c_hook_init (scm_t_c_hook *hook, |
| 60 | void *hook_data, |
| 61 | scm_t_c_hook_type type); |
| 62 | SCM_API void scm_c_hook_add (scm_t_c_hook *hook, |
| 63 | scm_t_c_hook_function func, |
| 64 | void *fn_data, |
| 65 | int appendp); |
| 66 | SCM_API void scm_c_hook_remove (scm_t_c_hook *hook, |
| 67 | scm_t_c_hook_function func, |
| 68 | void *fn_data); |
| 69 | SCM_API void *scm_c_hook_run (scm_t_c_hook *hook, void *data); |
| 70 | |
| 71 | /* |
| 72 | * Scheme level hooks |
| 73 | */ |
| 74 | |
| 75 | SCM_API scm_t_bits scm_tc16_hook; |
| 76 | |
| 77 | #define SCM_HOOKP(x) SCM_SMOB_PREDICATE (scm_tc16_hook, x) |
| 78 | #define SCM_HOOK_ARITY(hook) SCM_SMOB_FLAGS (hook) |
| 79 | #define SCM_HOOK_PROCEDURES(hook) SCM_SMOB_OBJECT (hook) |
| 80 | #define SCM_SET_HOOK_PROCEDURES(hook, procs) SCM_SET_SMOB_OBJECT ((hook), (procs)) |
| 81 | |
| 82 | SCM_API SCM scm_make_hook (SCM n_args); |
| 83 | SCM_API SCM scm_hook_p (SCM x); |
| 84 | SCM_API SCM scm_hook_empty_p (SCM hook); |
| 85 | SCM_API SCM scm_add_hook_x (SCM hook, SCM thunk, SCM appendp); |
| 86 | SCM_API SCM scm_remove_hook_x (SCM hook, SCM thunk); |
| 87 | SCM_API SCM scm_reset_hook_x (SCM hook); |
| 88 | SCM_API SCM scm_run_hook (SCM hook, SCM args); |
| 89 | SCM_API void scm_c_run_hook (SCM hook, SCM args); |
| 90 | SCM_API void scm_c_run_hookn (SCM hook, SCM *argv, size_t nargs); |
| 91 | SCM_API SCM scm_hook_to_list (SCM hook); |
| 92 | SCM_INTERNAL void scm_init_hooks (void); |
| 93 | |
| 94 | #endif /* SCM_HOOKS_H */ |
| 95 | |
| 96 | /* |
| 97 | Local Variables: |
| 98 | c-file-style: "gnu" |
| 99 | End: |
| 100 | */ |