Merge remote-tracking branch 'origin/stable-2.0'
[bpt/guile.git] / libguile / procs.h
dissimilarity index 97%
index 12511d9..a4dfaff 100644 (file)
-/* classes: h_files */
-
-#ifndef PROCSH
-#define PROCSH
-/*     Copyright (C) 1995,1996,1998 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 exception does not however invalidate any other reasons why
- * the executable file might be covered by the GNU General Public License.
- *
- * 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.  */
-\f
-
-#include "libguile/__scm.h"
-
-\f
-
-
-/* Subrs 
- */
-
-typedef struct scm_subr
-{
-  long sname;
-  SCM (*cproc) ();
-} scm_subr;
-
-typedef struct scm_iproc
-{
-  char *scm_string;
-  SCM (*cproc) ();
-} scm_iproc;
-
-typedef struct scm_dsubr
-{
-  long sname;
-  double (*dproc) ();
-} scm_dsubr;
-
-#define SCM_SNAME(x) ((SCM_CAR(x)>>8)?(SCM)(scm_heap_org+(SCM_CAR(x)>>8)):scm_nullstr)
-#define SCM_SUBRF(x) (((scm_subr *)(SCM2PTR(x)))->cproc)
-#define SCM_DSUBRF(x) (((scm_dsubr *)(SCM2PTR(x)))->dproc)
-#define SCM_CCLO_SUBR(x) (SCM_VELTS(x)[0])
-
-/* Closures
- */
-
-#define SCM_CLOSUREP(x) (SCM_TYP3(x)==scm_tc3_closure)
-#define SCM_CLOSCAR(x) (SCM_CAR(x)-scm_tc3_closure)
-#define SCM_CODE(x) SCM_CAR(SCM_CLOSCAR (x))
-#define SCM_PROCPROPS(x) SCM_CDR(SCM_CLOSCAR (x))
-#define SCM_SETPROCPROPS(x, p) SCM_SETCDR(SCM_CLOSCAR (x), p)
-#define SCM_SETCODE(x, e) (SCM_SETCAR (x, scm_cons ((e), SCM_EOL) + scm_tc3_closure))
-#define SCM_ENV(x) SCM_CDR(x)
-#define SCM_SETENV(x, e) SCM_SETCDR (x, e)
-#define SCM_TOP_LEVEL(SCM_ENV)  (SCM_NULLP(SCM_ENV) || (SCM_BOOL_T == scm_procedure_p (SCM_CAR (SCM_ENV))))
-
-/* Procedure-with-setter
-
-   Four representations for procedure-with-setters were
-   considered before selecting this one:
-
-   1. A closure where the CODE and ENV slots are used to represent
-   the getter and a new SETTER slot is used for the setter.  The
-   original getter is stored as a `getter' procedure property.  For
-   closure getters, the CODE and ENV slots contains a copy of the
-   getter's CODE and ENV slots.  For subr getters, the CODE contains
-   a call to the subr.
-
-   2. A compiled closure with a call to the getter in the cclo
-   procedure.  The getter and setter are stored in slots 1 and 2.
-
-   3. An entity (i.e. a struct with an associated procedure) with a
-   call to the getter in the entity procedure and the setter stored
-   in slot 0.  The original getter is stored in slot 1.
-
-   4. A new primitive procedure type supported in the evaluator.  The
-   getter and setter are stored in a GETTER and SETTER slot.  A call
-   to this procedure type results in a retrieval of the getter and a
-   jump back to the correct eval dispatcher.
-
-   Representation 4 was selected because of efficiency and
-   simplicity.
-
-   Rep 1 has the advantage that there is zero penalty for closure
-   getters, but primitive getters will get considerable overhead
-   because the procedure-with-getter will be a closure which calls
-   the getter.
-
-   Rep 3 has the advantage that a GOOPS accessor can be a subclass of
-   <procedure-with-setter>, but together with rep 2 it suffers from a
-   three level dispatch for non-GOOPS getters:
-
-     cclo/struct --> dispatch proc --> getter
-
-   This is because the dispatch procedure must take an extra initial
-   argument (cclo for rep 2, struct for rep 3).
-
-   Rep 4 has the single disadvantage that it uses up one tc7 type
-   code, but the plan for uniform vectors will very likely free tc7
-   codes, so this is probably no big problem.  Also note that the
-   GETTER and SETTER slots can live directly on the heap, using the
-   new four-word cells.  */
-
-#define SCM_PROCEDURE_WITH_SETTER_P(obj) (SCM_TYP7 (obj) == scm_tc7_pws)
-#define SCM_PROCEDURE(obj) SCM_CADR (obj)
-#define SCM_SETTER(obj) SCM_CDDR (obj)
-
-\f
-
-extern SCM scm_make_subr SCM_P ((const char *name, int type, SCM (*fcn) ()));
-extern SCM scm_make_subr_opt SCM_P ((const char *name, 
-                                    int type, 
-                                    SCM (*fcn) (),
-                                    int set));
-extern SCM scm_makcclo SCM_P ((SCM proc, long len));
-extern SCM scm_procedure_p SCM_P ((SCM obj));
-extern SCM scm_closure_p SCM_P ((SCM obj));
-extern SCM scm_thunk_p SCM_P ((SCM obj));
-extern SCM scm_procedure_documentation SCM_P ((SCM proc));
-extern SCM scm_procedure_with_setter_p SCM_P ((SCM obj));
-extern SCM scm_make_procedure_with_setter SCM_P ((SCM procedure, SCM setter));
-extern SCM scm_procedure SCM_P ((SCM proc));
-extern SCM scm_setter SCM_P ((SCM proc));
-extern void scm_init_iprocs SCM_P ((const scm_iproc *subra, int type));
-extern void scm_init_procs SCM_P ((void));
-
-#ifdef GUILE_DEBUG
-extern SCM scm_make_cclo SCM_P ((SCM proc, SCM len));
-#endif /*GUILE_DEBUG*/
-
-\f
-#endif  /* PROCSH */
+/* classes: h_files */
+
+#ifndef SCM_PROCS_H
+#define SCM_PROCS_H
+
+/* Copyright (C) 1995,1996,1998,1999,2000,2001, 2006, 2008, 2009 Free Software Foundation, Inc.
+ *
+ * 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 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.
+ *
+ * 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
+ */
+
+\f
+
+#include "libguile/__scm.h"
+
+\f
+
+SCM_API SCM scm_procedure_p (SCM obj);
+SCM_API SCM scm_thunk_p (SCM obj);
+SCM_API SCM scm_procedure_documentation (SCM proc);
+SCM_API SCM scm_procedure_with_setter_p (SCM obj);
+SCM_API SCM scm_make_procedure_with_setter (SCM procedure, SCM setter);
+SCM_API SCM scm_procedure (SCM proc);
+SCM_API SCM scm_setter (SCM proc);
+SCM_INTERNAL void scm_init_procs (void);
+
+#endif  /* SCM_PROCS_H */
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/