guile/libguile/debug.h

/* classes: h_files */

#ifndef SCM_DEBUG_H
#define SCM_DEBUG_H

/* Copyright (C) 1995,1996,1998,1999,2000,2001,2002,2004,2008,2009,2010,2011,2012,2013,2015
 * 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
 */


#include "libguile/__scm.h"

#include "libguile/options.h"


SCM_API SCM scm_local_eval (SCM exp, SCM env);

SCM_API SCM scm_reverse_lookup (SCM env, SCM data);
SCM_API SCM scm_debug_options (SCM setting);

SCM_INTERNAL void scm_init_debug (void);

#ifdef GUILE_DEBUG
SCM_API SCM scm_debug_hang (SCM obj);
#endif /*GUILE_DEBUG*/

#endif  /* SCM_DEBUG_H */

/*
  Local Variables:
  c-file-style: "gnu"
  End:
*/
-												* debug.h: New file: low-level debugging support.

* libguile.h: Conditionally include debug.h

											
										
										
											1996-08-20 17:08:53 +00:00
+								/* classes: h_files */
-												* Fix signedness plus some minor improvements.

											
										
										
											2001-06-25 11:06:33 +00:00
+								#ifndef SCM_DEBUG_H
 								#define SCM_DEBUG_H
-												* Remove deprecated macros and typenames.
* Rename header macros to SCM_<filename>_H.
* Prefer !SCM_<foo> over SCM_N<foo>.

											
										
										
											2001-08-31 11:17:06 +00:00
-												Remove unused union scm_t_debug_info

* libguile/debug.h (union scm_t_debug_info): Remove unused type
  declaration.

											
										
										
											2015-01-06 15:02:52 -05:00
+								/* Copyright (C) 1995,1996,1998,1999,2000,2001,2002,2004,2008,2009,2010,2011,2012,2013,2015
-													Introduce scm_debug_mode_p as a replacement for scm_debug_mode and
	SCM_DEBUGGINGP:

	* debug.h (scm_debug_mode_p, scm_debug_mode, SCM_DEBUGGINGP),
	eval.c (scm_debug_mode_p): Deprecated scm_debug_mode and
	SCM_DEBUGGINGP.  Provided scm_debug_mode_p instead, to have one
	single interface that also matches the naming conventions.
	Probably scm_debug_mode_p should be part of the private interface
	anyway.

	* debug.h (scm_debug_mode_p), backtrace.c (display_error_body),
	eval.c (SCM_APPLY, scm_trampoline_0, scm_trampoline_1,
	scm_trampoline_2): Change uses of scm_debug_mode or SCM_DEBUGGINGP
	to scm_debug_mode_p.


	Deprecate direct access to scm_ceval, scm_deval and scm_ceval_ptr:

	* eval.h (scm_ceval, scm_deval, scm_ceval_ptr), debug.h
	(scm_ceval_ptr): Deprecated.  Moved declaration of scm_ceval_ptr
	from debug.h to eval.h.

	* debug.h (SCM_RESET_DEBUG_MODE): Don't access scm_ceval_ptr any
	more, just leave it with setting scm_debug_mode_p, which is
	equivalent for practical purposes.

	* deprecated.h (SCM_XEVAL, SCM_XEVALCAR): Call scm_i_eval_x
	instead of *scm_ceval_ptr.  Leave all evaluating to scm_i_eval_x.

	* gdbint.c (gdb_eval): Call scm_i_eval_x instead of scm_ceval.

	* eval.c (ceval, deval, scm_ceval, scm_deval): Made scm_ceval
	static and renamed it to ceval throughout.  Provide a new exported
	but deprecated function scm_ceval as a wrapper for backwards
	compatibility.  The same is done for the deval/scm_deval pair of
	functions.

	* eval.c (CEVAL, SCM_CEVAL): Renamed SCM_CEVAL to CEVAL
	throughout.  Defined CEVAL to ceval or deval, based on compilation
	phase.

	* eval.c (SCM_XEVAL, SCM_XEVALCAR): Dispatch on scm_debug_mode_p
	to ceval and deval instead of calling *scm_ceval_ptr.

	* eval.c (dispatching_eval): New deprecated static function.

	* eval.c (scm_ceval_ptr): Initialized to dispatching_eval in order
	to emulate its old behaviour as closely as possible.


	Change the evaluator such that only expressions for which pair? is
	true are passed to CEVAL, and such that all other expressions are
	evaluated outside of CEVAL:

	* eval.c (EVAL): New, provided in analogy to EVALCAR.  Evaluate an
	expression that is assumed to be memoized already.  All but
	expressions of the form '(<form> <form> ...)' are evaluated inline
	without calling an evaluator.

	* eval.c (SCM_XEVAL, SCM_XEVALCAR, EVALCAR): Evaluate all but
	expressions of the form '(<form> <form> ...)' inline without
	calling an evaluator.

	* eval.c (scm_i_eval_x, scm_i_eval, scm_ceval, scm_deval): Handle
	the special case of unmemoized symbols passed on the top level.

	* eval.c (CEVAL): Change calls to CEVAL to EVAL, except where it
	is known that the expression passed to CEVAL is of the form
	'(<form> <form> ...)'.  Remove handling of the tc7-objects, since
	now it is known that the input expression of CEVAL is a pair.

											
										
										
											2004-03-29 19:59:43 +00:00
+								 * Free Software Foundation, Inc.
-												* Remove deprecated macros and typenames.
* Rename header macros to SCM_<filename>_H.
* Prefer !SCM_<foo> over SCM_N<foo>.

											
										
										
											2001-08-31 11:17:06 +00:00
+								 *
-												Changed license terms to the plain LGPL thru-out.

											
										
										
											2003-04-05 19:15:35 +00:00
+								 * This library is free software; you can redistribute it and/or
-												Change Guile license to LGPLv3+

(Not quite finished, the following will be done tomorrow.
   module/srfi/*.scm
   module/rnrs/*.scm
   module/scripts/*.scm
   testsuite/*.scm
   guile-readline/*
)

											
										
										
											2009-06-17 00:22:09 +01:00
+								 * 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.
-												* Remove deprecated macros and typenames.
* Rename header macros to SCM_<filename>_H.
* Prefer !SCM_<foo> over SCM_N<foo>.

											
										
										
											2001-08-31 11:17:06 +00:00
+								 *
-												Change Guile license to LGPLv3+

(Not quite finished, the following will be done tomorrow.
   module/srfi/*.scm
   module/rnrs/*.scm
   module/scripts/*.scm
   testsuite/*.scm
   guile-readline/*
)

											
										
										
											2009-06-17 00:22:09 +01:00
+								 * This library is distributed in the hope that it will be useful, but
 								 * WITHOUT ANY WARRANTY; without even the implied warranty of
-												Changed license terms to the plain LGPL thru-out.

											
										
										
											2003-04-05 19:15:35 +00:00
+								 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 								 * Lesser General Public License for more details.
-												* Remove deprecated macros and typenames.
* Rename header macros to SCM_<filename>_H.
* Prefer !SCM_<foo> over SCM_N<foo>.

											
										
										
											2001-08-31 11:17:06 +00:00
+								 *
-												Changed license terms to the plain LGPL thru-out.

											
										
										
											2003-04-05 19:15:35 +00:00
+								 * You should have received a copy of the GNU Lesser General Public
 								 * License along with this library; if not, write to the Free Software
-												Change Guile license to LGPLv3+

(Not quite finished, the following will be done tomorrow.
   module/srfi/*.scm
   module/rnrs/*.scm
   module/scripts/*.scm
   testsuite/*.scm
   guile-readline/*
)

											
										
										
											2009-06-17 00:22:09 +01:00
+								 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 								 * 02110-1301 USA
-												Changed license terms to the plain LGPL thru-out.

											
										
										
											2003-04-05 19:15:35 +00:00
+								 */
-												* *.h: Use SCM_NIMP(X) && in all the FOOP macros.

* *.[ch]: Use do { ... } while (0) idiom in macros that expanded
to a bare block.

											
										
										
											1999-12-16 03:46:42 +00:00
-												* debug.h: New file: low-level debugging support.

* libguile.h: Conditionally include debug.h

											
										
										
											1996-08-20 17:08:53 +00:00
-												* alist.h, append.h, arbiters.h, async.h, boolean.h, chars.h,
continuations.h, debug.h, dynwind.h, error.h, eval.h, fdsocket.h,
feature.h, filesys.h, fports.h, gc.h, gdbint.h, genio.h, gsubr.h,
hash.h, init.h, ioext.h, kw.h, list.h, markers.h, marksweep.h,
mbstrings.h, numbers.h, objprop.h, options.h, pairs.h, ports.h,
posix.h, print.h, procprop.h, procs.h, ramap.h, read.h, root.h,
sequences.h, smob.h, socket.h, srcprop.h, stackchk.h, stime.h,
strings.h, strop.h, strorder.h, strports.h, struct.h, symbols.h,
tag.h, throw.h, unif.h, variable.h, vectors.h, version.h,
vports.h, weaks.h: #include "libguile/__scm.h", not
<libguile/__scm.h>.  This allows 'gcc -MM' to determine which
dependencies are within libguile properly.

											
										
										
											1996-09-05 21:19:08 +00:00
+								#include "libguile/__scm.h"
-												* debug.h: New file: low-level debugging support.

* libguile.h: Conditionally include debug.h

											
										
										
											1996-08-20 17:08:53 +00:00
-												C files should #include only the header files they need, not
libguile.h (which #includes all the header files); the pointless
recompilation was wasting my time.
* Makefile.in (all .o dependency lists): Regenerated.
* libguile.h: Don't try to get a definition for size_t here...
* __scm.h: Do it here.
* _scm.h: Since this is the internal libguile header, put things
here that all (or a majority) of the libguile files will want.
Don't #include <libguile.h> here; that generates dependencies on
way too much.  Instead, get "__scm.h", "error.h", "pairs.h",
"list.h", "gc.h", "gsubr.h", "procs.h", "numbers.h", "symbols.h",
"boolean.h", "strings.h", "vectors.h", "root.h", "ports.h", and
"async.h".
* alist.c: Get "eq.h", "list.h", "alist.h".
* append.c: Get "append.h", "list.h".
* arbiters.c: Get "arbiters.h", "smob.h".
* async.c: Get "async.h", "smob.h", "throw.h", "eval.h".
* boolean.c: Get "boolean.h".
* chars.c: Get "chars.h".
* continuations.c: Get "continuations.h", "dynwind.h", "debug.h",
"stackchk.h".
* debug.c: Get "debug.h", "feature.h", "read.h", "strports.h",
"continuations.h", "alist.h", "srcprop.h", "procprop.h", "smob.h",
"genio.h", "throw.h", "eval.h".
* dynwind.c: Get "dynwind.h", "alist.h", "eval.h".
* eq.c: Get "eq.h", "unif.h", "smob.h", "strorder.h",
"stackchk.h".
* error.c: Get "error.h", "throw.h", "genio.h", "pairs.h".
* eval.c: Get "eval.h", "stackchk.h", "srcprop.h", "debug.h",
"hashtab.h", "procprop.h", "markers.h", "smob.h", "throw.h",
"continuations.h", "eq.h", "sequences.h", "alist.h", "append.h",
"debug.h".
* fdsocket.c: Get "fdsocket.h", "unif.h", "filesys.h".
* feature.c: Get "feature.h".
* files.c: Get "files.h".
* filesys.c: Get "filesys.h", "smob.h", "genio.h".
* fports.c: Get "fports.h", "markers.h".
* gc.c: Get "async.h", "unif.h", "smob.h", "weaks.h",
"genio.h", "struct.h", "stackchk.h", "stime.h".
* gdbint.c: Get "gdbint.h", "chars.h", "eval.h", "print.h",
"read.h", "strports.h", "tag.h".
* genio.c: Get "genio.h", "chars.h".
* gsubr.c: Get "gsubr.h", "genio.h".
* hash.c: Get "hash.h", "chars.h".
* hashtab.c: Get "hashtab.h", "eval.h", "hash.h", "alist.h".
* init.c: Get everyone who has an scm_init_mumble function:
"weaks.h", "vports.h", "version.h", "vectors.h", "variable.h",
"unif.h", "throw.h", "tag.h", "symbols.h", "struct.h",
"strports.h", "strorder.h", "strop.h", "strings.h", "stime.h",
"stackchk.h", "srcprop.h", "socket.h", "simpos.h", "sequences.h",
"scmsigs.h", "read.h", "ramap.h", "procs.h", "procprop.h",
"print.h", "posix.h", "ports.h", "pairs.h", "options.h",
"objprop.h", "numbers.h", "mbstrings.h", "mallocs.h", "load.h",
"list.h", "kw.h", "ioext.h", "hashtab.h", "hash.h", "gsubr.h",
"gdbint.h", "gc.h", "fports.h", "filesys.h", "files.h",
"feature.h", "fdsocket.h", "eval.h", "error.h", "eq.h",
"dynwind.h", "debug.h", "continuations.h", "chars.h", "boolean.h",
"async.h", "arbiters.h", "append.h", "alist.h".
* ioext.c: Get "ioext.h", "fports.h".
* kw.c: Get "kw.h", "smob.h", "mbstrings.h", "genio.h".
* list.c: Get "list.h", "eq.h".
* load.c: Get "load.h", "eval.h", "read.h", "fports.h".
* mallocs.c: Get "smob.h", "genio.h".
* markers.c: Get "markers.h".
* mbstrings.c: Get "mbstrings.h", "read.h", "genio.h", "unif.h",
"chars.h".
* numbers.c: Get "unif.h", "genio.h".
* objprop.c: Get "objprop.h", "weaks.h", "alist.h", "hashtab.h".
* options.c: Get "options.h".
* ports.c: Get "ports.h", "vports.h", "strports.h", "fports.h",
"markers.h", "chars.h", "genio.h".
* posix.c: Get "posix.h", "sequences.h", "feature.h", "unif.h",
"read.h", "scmsigs.h", "genio.h", "fports.h".
* print.c: Get "print.h",  "unif.h", "weaks.h", "read.h",
"procprop.h", "eval.h", "smob.h", "mbstrings.h", "genio.h",
"chars.h".
* procprop.c: Get "procprop.h", "eval.h", "alist.h".
* procs.c: Get "procs.h".
* ramap.c: Get "ramap.h", "feature.h", "eval.h", "eq.h",
"chars.h", "smob.h", "unif.h".
* read.c: Get "alist.h", "kw.h", "mbstrings.h", "unif.h",
"eval.h", "genio.h", "chars.h".
* root.c: Get "root.h", "stackchk.h".
* scmsigs.c: Get "scmsigs.h".
* sequences.c: Get "sequences.h".
* simpos.c: Get "simpos.h", "scmsigs.h".
* smob.c: Get "smob.h".
* socket.c: Get "socket.h", "feature.h".
* srcprop.c: Get "srcprop.h", "weaks.h", "hashtab.h", "debug.h",
"alist.h", "smob.h".
* stackchk.c: Get "stackchk.h", "genio.h".
* stime.c: Get "stime.h"."libguile/continuations.h".
* strings.c: Get "strings.h", "chars.h".
* strop.c: Get "strop.h", "chars.h".
* strorder.c: Get "strorder.h", "chars.h".
* strports.c: Get "strports.h", "print.h", "eval.h", "unif.h".
* struct.c: Get "struct.h", "chars.h".
* symbols.c: Get "symbols.h", "mbstrings.h", "alist.h",
"variable.h", "eval.h", "chars.h".
* tag.c: Get "tag.h", "struct.h", "chars.h".
* throw.c: Get "throw.h", "continuations.h", "debug.h",
"dynwind.h", "eval.h", "alist.h", "smob.h", "genio.h".
* unif.c: Get "unif.h", "feature.h", "strop.h", "sequences.h",
"smob.h", "genio.h", "eval.h", "chars.h".
* variable.c: Get "variable.h", "smob.h", "genio.h".
* vectors.c: Get "vectors.h", "eq.h".
* version.c: Get "version.h".
* vports.c: Get "vports.h", "fports.h", "chars.h", "eval.h".
* weaks.c: Get "weaks.h".

* stackchk.h: #include "libguile/debug.h",

* debug.h: Don't #include "options.h"; the compiler won't be able
to find that once the headers are installed; instead, #include
"libguile/options.h".
* gc.h: Same, with marksweep.h.
* mbstrings.h: Same, with symbols.h.
* scmhob.h: Same, with _scm.h.
* smob.h: Same, with params.h.

											
										
										
											1996-09-10 02:27:02 +00:00
+								#include "libguile/options.h"
-												* debug.h: New file: low-level debugging support.

* libguile.h: Conditionally include debug.h

											
										
										
											1996-08-20 17:08:53 +00:00
-												Implement `local-eval', `local-compile', and `the-environment'

* module/ice-9/local-eval.scm: New module (ice-9 local-eval) which
  exports `the-environment', `local-eval', and `local-compile'.

* libguile/debug.c (scm_local_eval): New C function that calls the
  Scheme implementation of `local-eval' in (ice-9 local-eval).

* libguile/debug.h (scm_local_eval): Add prototype.

* doc/ref/api-evaluation.texi (Local Evaluation): Add documentation.

* test-suite/tests/eval.test (local evaluation): Add tests.

* test-suite/standalone/test-loose-ends.c (test_scm_local_eval):
  Add test.

* module/Makefile.am: Add ice-9/local-eval.scm.

Based on a patch by Mark H Weaver <mhw@netris.org>.

											
										
										
											2012-01-03 04:02:08 -05:00
+								SCM_API SCM scm_local_eval (SCM exp, SCM env);
-												Prefixed each each exported symbol with SCM_API.

											
										
										
											2001-11-02 00:19:12 +00:00
+								SCM_API SCM scm_reverse_lookup (SCM env, SCM data);
 								SCM_API SCM scm_debug_options (SCM setting);
-													* backtrace.c (display_expression, display_frame): Call
	scm_i_unmemoize_expr for unmemoizing a memoized object holding a
	single memoized expression.

	* debug.c (memoized_print): Don't try to unmemoize the memoized
	object, since we can't know whether it holds a single expression
	or a body.

	(scm_mem_to_proc): Removed check for lambda expression, since it
	was moot anyway.  Whoever uses these functions for debugging
	purposes should know what they do: Creating invalid memoized code
	will cause crashes, independent of whether this check is present
	or not.

	(scm_proc_to_mem): Take the closure's code as it is and don't
	append a SCM_IM_LAMBDA isym.  To allow easier debugging, the
	memoized code should not be modified.

	* debug.[ch] (scm_unmemoize, scm_i_unmemoize_expr): Removed
	scm_unmemoize from public use, but made scm_i_unmemoize_expr
	available as a guile internal function instead.  However,
	scm_i_unmemoize_expr will only work on memoized objects that hold
	a single memoized expression.  It won't work with bodies.

	* debug.c (scm_procedure_source), macros.c (macro_print), print.c
	(scm_iprin1): Call scm_i_unmemocopy_body for unmemoizing a body,
	i. e. a list of expressions.

	* eval.c (unmemoize_exprs): Drop internal body markers from the
	output during unmemoization.

	* eval.[ch] (scm_unmemocopy, scm_i_unmemocopy_expr,
	scm_i_unmemocopy_body): Removed scm_unmemocopy from public use,
	but made scm_i_unmemocopy_expr and scm_i_unmemocopy_body available
	as guile internal functions instead.  scm_i_unmemoize_expr will
	only work on a single memoized expression, while
	scm_i_unmemocopy_body will only work on bodies.

											
										
										
											2004-06-27 12:34:54 +00:00
-												Add `SCM_INTERNAL' macro, use it.

											
										
										
											2008-05-14 05:20:47 +02:00
+								SCM_INTERNAL void scm_init_debug (void);
-												* debug.h: New file: low-level debugging support.

* libguile.h: Conditionally include debug.h

											
										
										
											1996-08-20 17:08:53 +00:00
-												Warning fixes from Greg Harvey:
* unif.c (scm_array_set_x): initializer for pos
* throw.c (scm_ithrow): added initializer for jmpbuf (SCM_UNDEFINED)
* struct.c (scm_struct_ref, scm_struct_set_x): Added
initializers for field_type, since EGCS so desparately wants to
play dumb
* debug.h (scm_make_gloc, scm_gloc_p, scm_make_iloc, scm_memcons,
scm_mem_to_proc, scm_proc_to_mem, scm_debug_hang): Added prototypes
when GUILE_DEBUG is defined.
* dynwind.h (scm_wind_chain): Same.
* ports.h (scm_pt_size, scm_pt_member): Same.
* print.h (scm_current_pstate): Same.
* procs.h (scm_make_cclo): Same.

											
										
										
											1998-10-15 14:35:35 +00:00
+								#ifdef GUILE_DEBUG
-												Prefixed each each exported symbol with SCM_API.

											
										
										
											2001-11-02 00:19:12 +00:00
+								SCM_API SCM scm_debug_hang (SCM obj);
-												Warning fixes from Greg Harvey:
* unif.c (scm_array_set_x): initializer for pos
* throw.c (scm_ithrow): added initializer for jmpbuf (SCM_UNDEFINED)
* struct.c (scm_struct_ref, scm_struct_set_x): Added
initializers for field_type, since EGCS so desparately wants to
play dumb
* debug.h (scm_make_gloc, scm_gloc_p, scm_make_iloc, scm_memcons,
scm_mem_to_proc, scm_proc_to_mem, scm_debug_hang): Added prototypes
when GUILE_DEBUG is defined.
* dynwind.h (scm_wind_chain): Same.
* ports.h (scm_pt_size, scm_pt_member): Same.
* print.h (scm_current_pstate): Same.
* procs.h (scm_make_cclo): Same.

											
										
										
											1998-10-15 14:35:35 +00:00
+								#endif /*GUILE_DEBUG*/
-												* Remove deprecated macros and typenames.
* Rename header macros to SCM_<filename>_H.
* Prefer !SCM_<foo> over SCM_N<foo>.

											
										
										
											2001-08-31 11:17:06 +00:00
+								#endif  /* SCM_DEBUG_H */
-													* *.[hc]: add Emacs magic at the end of file, to ensure GNU
 	indentation style.

											
										
										
											2000-03-19 19:01:16 +00:00
 								/*
 								  Local Variables:
 								  c-file-style: "gnu"
 								  End:
 								*/