simplify inline function infrastructure
[bpt/guile.git] / libguile / hooks.c
index 737e923..abba606 100644 (file)
@@ -1,48 +1,26 @@
-/* Copyright (C) 1995,1996,1998,1999,2000,2001 Free Software Foundation, Inc.
+/* Copyright (C) 1995,1996,1998,1999,2000,2001, 2003, 2006, 2008, 2009 Free Software Foundation, Inc.
  * 
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2, or (at your option)
- * any later version.
- * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * 
- * You should have received a copy of the GNU General Public License
- * along with this software; see the file COPYING.  If not, write to
- * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307 USA
- *
- * As a special exception, the Free Software Foundation gives permission
- * for additional uses of the text contained in its release of GUILE.
- *
- * The exception is that, if you link the GUILE library with other files
- * to produce an executable, this does not by itself cause the
- * resulting executable to be covered by the GNU General Public License.
- * Your use of that executable is in no way restricted on account of
- * linking the GUILE library code into it.
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 3 of
+ * the License, or (at your option) any later version.
  *
- * This exception does not however invalidate any other reasons why
- * the executable file might be covered by the GNU General Public License.
+ * This library is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  *
- * This exception applies only to the code released by the
- * Free Software Foundation under the name GUILE.  If you copy
- * code from other Free Software Foundation releases into a copy of
- * GUILE, as the General Public License permits, the exception does
- * not apply to the code that you add in this way.  To avoid misleading
- * anyone as to the status of such modified files, you must delete
- * this exception notice from them.
- *
- * If you write modifications of your own for GUILE, it is your choice
- * whether to permit this exception to apply to your modifications.
- * If you do not wish that, delete this exception notice.  */
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301 USA
+ */
 
-/* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
-   gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
 
 \f
+#ifdef HAVE_CONFIG_H
+# include <config.h>
+#endif
 
 #include <stdio.h>
 #include "libguile/_scm.h"
  * using C level hooks.
  */
 
+/* Hint for `scm_gc_malloc ()' and friends.  */
+static const char hook_entry_gc_hint[] = "hook entry";
+
 void
-scm_c_hook_init (scm_c_hook_t *hook, void *hook_data, scm_c_hook_type_t type)
+scm_c_hook_init (scm_t_c_hook *hook, void *hook_data, scm_t_c_hook_type type)
 {
   hook->first = 0;
   hook->type = type;
@@ -74,36 +55,35 @@ scm_c_hook_init (scm_c_hook_t *hook, void *hook_data, scm_c_hook_type_t type)
 }
 
 void
-scm_c_hook_add (scm_c_hook_t *hook,
-               scm_c_hook_function_t func,
-               void *func_data, 
+scm_c_hook_add (scm_t_c_hook *hook,
+               scm_t_c_hook_function func,
+               void *fn_data, 
                int appendp)
 {
-  scm_c_hook_entry_t *entry = scm_must_malloc (sizeof (scm_c_hook_entry_t),
-                                            "C level hook entry");
-  scm_c_hook_entry_t **loc = &hook->first;
+  scm_t_c_hook_entry *entry;
+  scm_t_c_hook_entry **loc = &hook->first;
+
+  entry = scm_gc_malloc (sizeof (scm_t_c_hook_entry), hook_entry_gc_hint);
   if (appendp)
     while (*loc)
-      *loc = (*loc)->next;
+      loc = &(*loc)->next;
   entry->next = *loc;
   entry->func = func;
-  entry->data = func_data;
+  entry->data = fn_data;
   *loc = entry;
 }
 
 void
-scm_c_hook_remove (scm_c_hook_t *hook,
-                  scm_c_hook_function_t func,
-                  void *func_data)
+scm_c_hook_remove (scm_t_c_hook *hook,
+                  scm_t_c_hook_function func,
+                  void *fn_data)
 {
-  scm_c_hook_entry_t **loc = &hook->first;
+  scm_t_c_hook_entry **loc = &hook->first;
   while (*loc)
     {
-      if ((*loc)->func == func && (*loc)->data == func_data)
+      if ((*loc)->func == func && (*loc)->data == fn_data)
        {
-         scm_c_hook_entry_t *entry = *loc;
          *loc = (*loc)->next;
-         scm_must_free (entry);
          return;
        }
       loc = &(*loc)->next;
@@ -113,10 +93,10 @@ scm_c_hook_remove (scm_c_hook_t *hook,
 }
 
 void *
-scm_c_hook_run (scm_c_hook_t *hook, void *data)
+scm_c_hook_run (scm_t_c_hook *hook, void *data)
 {
-  scm_c_hook_entry_t *entry = hook->first;
-  scm_c_hook_type_t type = hook->type;
+  scm_t_c_hook_entry *entry = hook->first;
+  scm_t_c_hook_type type = hook->type;
   void *res = 0;
   while (entry)
     {
@@ -147,7 +127,7 @@ scm_c_hook_run (scm_c_hook_t *hook, void *data)
  * programs.
  */
 
-scm_bits_t scm_tc16_hook;
+scm_t_bits scm_tc16_hook;
 
 
 static int
@@ -157,13 +137,13 @@ hook_print (SCM hook, SCM port, scm_print_state *pstate)
   scm_puts ("#<hook ", port);
   scm_intprint (SCM_HOOK_ARITY (hook), 10, port);
   scm_putc (' ', port);
-  scm_intprint (SCM_UNPACK (hook), 16, port);
+  scm_uintprint (SCM_UNPACK (hook), 16, port);
   ls = SCM_HOOK_PROCEDURES (hook);
   while (SCM_NIMP (ls))
     {
       scm_putc (' ', port);
       name = scm_procedure_name (SCM_CAR (ls));
-      if (!SCM_FALSEP (name))
+      if (scm_is_true (name))
        scm_iprin1 (name, port, pstate);
       else
        scm_putc ('?', port);
@@ -173,36 +153,20 @@ hook_print (SCM hook, SCM port, scm_print_state *pstate)
   return 1;
 }
 
-#if (SCM_DEBUG_DEPRECATED == 0)
-
-SCM
-scm_create_hook (const char *name, int n_args)
-{
-  SCM hook = scm_make_hook (SCM_MAKINUM (n_args));
-  scm_c_define (name, hook);
-  return scm_permanent_object (hook);
-}
-
-#endif
 
 SCM_DEFINE (scm_make_hook, "make-hook", 0, 1, 0, 
             (SCM n_args),
-           "Create a hook for storing procedure of arity\n"
-           "@var{n_args}.  @var{n_args} defaults to zero.")
+           "Create a hook for storing procedure of arity @var{n_args}.\n"
+           "@var{n_args} defaults to zero.  The returned value is a hook\n"
+           "object to be used with the other hook procedures.")
 #define FUNC_NAME s_scm_make_hook
 {
-  int n;
+  unsigned int n;
 
   if (SCM_UNBNDP (n_args))
-    {
-      n = 0;
-    }
+    n = 0;
   else
-    {
-      SCM_VALIDATE_INUM_COPY (SCM_ARG1, n_args, n);
-      if (n < 0 || n > 16)
-       SCM_OUT_OF_RANGE (SCM_ARG1, n_args);
-    }
+    n = scm_to_unsigned_integer (n_args, 0, 16);
   
   SCM_RETURN_NEWSMOB (scm_tc16_hook + (n << 16), SCM_UNPACK (SCM_EOL));
 }
@@ -214,7 +178,7 @@ SCM_DEFINE (scm_hook_p, "hook?", 1, 0, 0,
            "Return @code{#t} if @var{x} is a hook, @code{#f} otherwise.")
 #define FUNC_NAME s_scm_hook_p
 {
-  return SCM_BOOL (SCM_HOOKP (x));
+  return scm_from_bool (SCM_HOOKP (x));
 }
 #undef FUNC_NAME
 
@@ -226,7 +190,7 @@ SCM_DEFINE (scm_hook_empty_p, "hook-empty?", 1, 0, 0,
 #define FUNC_NAME s_scm_hook_empty_p
 {
   SCM_VALIDATE_HOOK (1, hook);
-  return SCM_BOOL (SCM_NULLP (SCM_HOOK_PROCEDURES (hook)));
+  return scm_from_bool (scm_is_null (SCM_HOOK_PROCEDURES (hook)));
 }
 #undef FUNC_NAME
 
@@ -235,24 +199,22 @@ SCM_DEFINE (scm_add_hook_x, "add-hook!", 2, 1, 0,
             (SCM hook, SCM proc, SCM append_p),
            "Add the procedure @var{proc} to the hook @var{hook}. The\n"
            "procedure is added to the end if @var{append_p} is true,\n"
-           "otherwise it is added to the front.")
+           "otherwise it is added to the front.  The return value of this\n"
+           "procedure is not specified.")
 #define FUNC_NAME s_scm_add_hook_x
 {
-  SCM arity, rest;
-  int n_args;
-  SCM_VALIDATE_HOOK (1,hook);
-  SCM_ASSERT (!SCM_FALSEP (arity = scm_i_procedure_arity (proc)),
+  SCM rest;
+  int n_args, p_req, p_opt, p_rest;
+  SCM_VALIDATE_HOOK (1, hook);
+  SCM_ASSERT (scm_i_procedure_arity (proc, &p_req, &p_opt, &p_rest),
              proc, SCM_ARG2, FUNC_NAME);
   n_args = SCM_HOOK_ARITY (hook);
-  if (SCM_INUM (SCM_CAR (arity)) > n_args
-      || (SCM_FALSEP (SCM_CADDR (arity))
-         && (SCM_INUM (SCM_CAR (arity)) + SCM_INUM (SCM_CADR (arity))
-             < n_args)))
+  if (p_req > n_args || (!p_rest && p_req + p_opt < n_args))
     scm_wrong_type_arg (FUNC_NAME, 2, proc);
   rest = scm_delq_x (proc, SCM_HOOK_PROCEDURES (hook));
   SCM_SET_HOOK_PROCEDURES (hook,
-                          (!SCM_UNBNDP (append_p) && !SCM_FALSEP (append_p)
-                           ? scm_append_x (SCM_LIST2 (rest, SCM_LIST1 (proc)))
+                          (!SCM_UNBNDP (append_p) && scm_is_true (append_p)
+                           ? scm_append_x (scm_list_2 (rest, scm_list_1 (proc)))
                            : scm_cons (proc, rest)));
   return SCM_UNSPECIFIED;
 }
@@ -261,7 +223,8 @@ SCM_DEFINE (scm_add_hook_x, "add-hook!", 2, 1, 0,
 
 SCM_DEFINE (scm_remove_hook_x, "remove-hook!", 2, 0, 0, 
             (SCM hook, SCM proc),
-           "Remove the procedure @var{proc} from the hook @var{hook}.")
+           "Remove the procedure @var{proc} from the hook @var{hook}.  The\n"
+           "return value of this procedure is not specified.")
 #define FUNC_NAME s_scm_remove_hook_x
 {
   SCM_VALIDATE_HOOK (1, hook);
@@ -274,10 +237,11 @@ SCM_DEFINE (scm_remove_hook_x, "remove-hook!", 2, 0, 0,
 
 SCM_DEFINE (scm_reset_hook_x, "reset-hook!", 1, 0, 0, 
             (SCM hook),
-           "Remove all procedures from the hook @var{hook}.")
+           "Remove all procedures from the hook @var{hook}.  The return\n"
+           "value of this procedure is not specified.")
 #define FUNC_NAME s_scm_reset_hook_x
 {
-  SCM_VALIDATE_HOOK (1,hook);
+  SCM_VALIDATE_HOOK (1, hook);
   SCM_SET_HOOK_PROCEDURES (hook, SCM_EOL);
   return SCM_UNSPECIFIED;
 }
@@ -288,13 +252,13 @@ SCM_DEFINE (scm_run_hook, "run-hook", 1, 0, 1,
             (SCM hook, SCM args),
            "Apply all procedures from the hook @var{hook} to the arguments\n"
            "@var{args}.  The order of the procedure application is first to\n"
-           "last.")
+           "last.  The return value of this procedure is not specified.")
 #define FUNC_NAME s_scm_run_hook
 {
-  SCM_VALIDATE_HOOK (1,hook);
+  SCM_VALIDATE_HOOK (1, hook);
   if (scm_ilength (args) != SCM_HOOK_ARITY (hook))
     SCM_MISC_ERROR ("Hook ~S requires ~A arguments",
-                   SCM_LIST2 (hook,SCM_MAKINUM (SCM_HOOK_ARITY (hook))));
+                   scm_list_2 (hook, scm_from_int (SCM_HOOK_ARITY (hook))));
   scm_c_run_hook (hook, args);
   return SCM_UNSPECIFIED;
 }
@@ -307,7 +271,18 @@ scm_c_run_hook (SCM hook, SCM args)
   SCM procs = SCM_HOOK_PROCEDURES (hook);
   while (SCM_NIMP (procs))
     {
-      scm_apply (SCM_CAR (procs), args, SCM_EOL);
+      scm_apply_0 (SCM_CAR (procs), args);
+      procs = SCM_CDR (procs);
+    }
+}
+
+void
+scm_c_run_hookn (SCM hook, SCM *argv, size_t nargs)
+{
+  SCM procs = SCM_HOOK_PROCEDURES (hook);
+  while (SCM_NIMP (procs))
+    {
+      scm_call_n (SCM_CAR (procs), argv, nargs);
       procs = SCM_CDR (procs);
     }
 }
@@ -330,11 +305,8 @@ void
 scm_init_hooks ()
 {
   scm_tc16_hook = scm_make_smob_type ("hook", 0);
-  scm_set_smob_mark (scm_tc16_hook, scm_markcdr);
   scm_set_smob_print (scm_tc16_hook, hook_print);
-#ifndef SCM_MAGIC_SNARFER
 #include "libguile/hooks.x"
-#endif
 }
 
 /*