*** empty log message ***
[bpt/guile.git] / libguile / hooks.c
index 712debd..e57aeb6 100644 (file)
@@ -1,4 +1,4 @@
-/*     Copyright (C) 1995, 1996, 1998, 1999, 2000 Free Software Foundation, Inc.
+/* Copyright (C) 1995,1996,1998,1999,2000,2001 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
@@ -49,7 +49,6 @@
 
 #include "libguile/eval.h"
 #include "libguile/ports.h"
-#include "libguile/objprop.h"
 #include "libguile/procprop.h"
 #include "libguile/root.h"
 #include "libguile/smob.h"
@@ -67,7 +66,7 @@
  */
 
 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_hookype_t type)
 {
   hook->first = 0;
   hook->type = type;
@@ -75,14 +74,14 @@ 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,
+scm_c_hook_add (scm_t_c_hook *hook,
+               scm_t_c_hook_function func,
                void *func_data, 
                int appendp)
 {
-  scm_c_hook_entry_t *entry = scm_must_malloc (sizeof (scm_c_hook_entry_t),
+  scm_t_c_hook_entry *entry = scm_must_malloc (sizeof (scm_t_c_hook_entry),
                                             "C level hook entry");
-  scm_c_hook_entry_t **loc = &hook->first;
+  scm_t_c_hook_entry **loc = &hook->first;
   if (appendp)
     while (*loc)
       *loc = (*loc)->next;
@@ -93,16 +92,16 @@ scm_c_hook_add (scm_c_hook_t *hook,
 }
 
 void
-scm_c_hook_remove (scm_c_hook_t *hook,
-                  scm_c_hook_function_t func,
+scm_c_hook_remove (scm_t_c_hook *hook,
+                  scm_t_c_hook_function func,
                   void *func_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)
        {
-         scm_c_hook_entry_t *entry = *loc;
+         scm_t_c_hook_entry *entry = *loc;
          *loc = (*loc)->next;
          scm_must_free (entry);
          return;
@@ -114,10 +113,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_hookype_t type = hook->type;
   void *res = 0;
   while (entry)
     {
@@ -148,31 +147,11 @@ scm_c_hook_run (scm_c_hook_t *hook, void *data)
  * programs.
  */
 
-long scm_tc16_hook;
-
-
-static SCM
-make_hook (SCM n_args, const char *subr)
-{
-  int n;
-
-  if (SCM_UNBNDP (n_args))
-    {
-      n = 0;
-    }
-  else
-    {
-      SCM_ASSERT (SCM_INUMP (n_args), n_args, SCM_ARGn, subr);
-      n = SCM_INUM (n_args);
-      if (n < 0 || n > 16)
-       scm_out_of_range (subr, n_args);
-    }
-  SCM_RETURN_NEWSMOB (scm_tc16_hook + (n << 16), SCM_EOL);
-}
+scm_t_bits scm_tc16_hook;
 
 
 static int
-print_hook (SCM hook, SCM port, scm_print_state *pstate)
+hook_print (SCM hook, SCM port, scm_print_state *pstate)
 {
   SCM ls, name;
   scm_puts ("#<hook ", port);
@@ -184,7 +163,7 @@ print_hook (SCM hook, SCM port, scm_print_state *pstate)
     {
       scm_putc (' ', port);
       name = scm_procedure_name (SCM_CAR (ls));
-      if (SCM_NFALSEP (name))
+      if (!SCM_FALSEP (name))
        scm_iprin1 (name, port, pstate);
       else
        scm_putc ('?', port);
@@ -194,50 +173,45 @@ print_hook (SCM hook, SCM port, scm_print_state *pstate)
   return 1;
 }
 
-
-SCM_SYMBOL (symbol_name, "name");
-
-SCM
-scm_create_hook (const char* name, int n_args)
-{
-  SCM vcell = scm_sysintern0 (name);
-  SCM hook = make_hook (SCM_MAKINUM (n_args), "scm_create_hook");
-  SCM_SETCDR (vcell, hook);
-  scm_set_object_property_x (hook, symbol_name, scm_makfrom0str (name));
-  scm_protect_object (hook);
-  return hook;
-}
-
-
 #if (SCM_DEBUG_DEPRECATED == 0)
 
-SCM_DEFINE (scm_make_hook_with_name, "make-hook-with-name", 1, 1, 0, 
-            (SCM name, SCM n_args),
-"")
-#define FUNC_NAME s_scm_make_hook_with_name
+SCM
+scm_create_hook (const char *name, int n_args)
 {
-  SCM hook = make_hook (n_args, FUNC_NAME);
-  scm_set_object_property_x (hook, scm_makfrom0str ("name"), name);
-  return hook;
+  SCM hook = scm_make_hook (SCM_MAKINUM (n_args));
+  scm_c_define (name, hook);
+  return scm_permanent_object (hook);
 }
-#undef FUNC_NAME
-
-#endif  /* SCM_DEBUG_DEPRECATED == 0 */
 
+#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.")
 #define FUNC_NAME s_scm_make_hook
 {
-  return make_hook (n_args, FUNC_NAME);
+  int n;
+
+  if (SCM_UNBNDP (n_args))
+    {
+      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);
+    }
+  
+  SCM_RETURN_NEWSMOB (scm_tc16_hook + (n << 16), SCM_UNPACK (SCM_EOL));
 }
 #undef FUNC_NAME
 
 
 SCM_DEFINE (scm_hook_p, "hook?", 1, 0, 0, 
             (SCM x),
-"")
+           "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));
@@ -247,7 +221,8 @@ SCM_DEFINE (scm_hook_p, "hook?", 1, 0, 0,
 
 SCM_DEFINE (scm_hook_empty_p, "hook-empty?", 1, 0, 0, 
             (SCM hook),
-"")
+           "Return @code{#t} if @var{hook} is an empty hook, @code{#f}\n"
+           "otherwise.")
 #define FUNC_NAME s_scm_hook_empty_p
 {
   SCM_VALIDATE_HOOK (1, hook);
@@ -258,13 +233,15 @@ SCM_DEFINE (scm_hook_empty_p, "hook-empty?", 1, 0, 0,
 
 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.")
 #define FUNC_NAME s_scm_add_hook_x
 {
   SCM arity, rest;
   int n_args;
   SCM_VALIDATE_HOOK (1,hook);
-  SCM_ASSERT (SCM_NFALSEP (arity = scm_i_procedure_arity (proc)),
+  SCM_ASSERT (!SCM_FALSEP (arity = scm_i_procedure_arity (proc)),
              proc, SCM_ARG2, FUNC_NAME);
   n_args = SCM_HOOK_ARITY (hook);
   if (SCM_INUM (SCM_CAR (arity)) > n_args
@@ -275,7 +252,7 @@ SCM_DEFINE (scm_add_hook_x, "add-hook!", 2, 1, 0,
   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_append_x (scm_list_2 (rest, scm_list_1 (proc)))
                            : scm_cons (proc, rest)));
   return SCM_UNSPECIFIED;
 }
@@ -284,7 +261,7 @@ 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}.")
 #define FUNC_NAME s_scm_remove_hook_x
 {
   SCM_VALIDATE_HOOK (1, hook);
@@ -297,7 +274,7 @@ 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}.")
 #define FUNC_NAME s_scm_reset_hook_x
 {
   SCM_VALIDATE_HOOK (1,hook);
@@ -309,13 +286,15 @@ SCM_DEFINE (scm_reset_hook_x, "reset-hook!", 1, 0, 0,
 
 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.")
 #define FUNC_NAME s_scm_run_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_MAKINUM (SCM_HOOK_ARITY (hook))));
   scm_c_run_hook (hook, args);
   return SCM_UNSPECIFIED;
 }
@@ -328,7 +307,7 @@ 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);
     }
 }
@@ -336,7 +315,7 @@ scm_c_run_hook (SCM hook, SCM args)
 
 SCM_DEFINE (scm_hook_to_list, "hook->list", 1, 0, 0, 
             (SCM hook),
-"")
+           "Convert the procedure list of @var{hook} to a list.")
 #define FUNC_NAME s_scm_hook_to_list
 {
   SCM_VALIDATE_HOOK (1, hook);
@@ -352,9 +331,10 @@ 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, print_hook);
-
+  scm_set_smob_print (scm_tc16_hook, hook_print);
+#ifndef SCM_MAGIC_SNARFER
 #include "libguile/hooks.x"
+#endif
 }
 
 /*