* eq.c (s_scm_eqv_p): scm_i_bigcomp -> scm_i_bigcmp.
[bpt/guile.git] / libguile / debug.c
1 /* Debugging extensions for Guile
2 * Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002, 2003 Free Software Foundation
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2, or (at your option)
7 * any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this software; see the file COPYING. If not, write to
16 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
17 * Boston, MA 02111-1307 USA
18 *
19 * As a special exception, the Free Software Foundation gives permission
20 * for additional uses of the text contained in its release of GUILE.
21 *
22 * The exception is that, if you link the GUILE library with other files
23 * to produce an executable, this does not by itself cause the
24 * resulting executable to be covered by the GNU General Public License.
25 * Your use of that executable is in no way restricted on account of
26 * linking the GUILE library code into it.
27 *
28 * This exception does not however invalidate any other reasons why
29 * the executable file might be covered by the GNU General Public License.
30 *
31 * This exception applies only to the code released by the
32 * Free Software Foundation under the name GUILE. If you copy
33 * code from other Free Software Foundation releases into a copy of
34 * GUILE, as the General Public License permits, the exception does
35 * not apply to the code that you add in this way. To avoid misleading
36 * anyone as to the status of such modified files, you must delete
37 * this exception notice from them.
38 *
39 * If you write modifications of your own for GUILE, it is your choice
40 * whether to permit this exception to apply to your modifications.
41 * If you do not wish that, delete this exception notice.
42 *
43 * The author can be reached at djurfeldt@nada.kth.se
44 * Mikael Djurfeldt, SANS/NADA KTH, 10044 STOCKHOLM, SWEDEN */
45
46
47
48 #include "libguile/_scm.h"
49 #include "libguile/eval.h"
50 #include "libguile/list.h"
51 #include "libguile/stackchk.h"
52 #include "libguile/throw.h"
53 #include "libguile/macros.h"
54 #include "libguile/smob.h"
55 #include "libguile/procprop.h"
56 #include "libguile/srcprop.h"
57 #include "libguile/alist.h"
58 #include "libguile/continuations.h"
59 #include "libguile/strports.h"
60 #include "libguile/read.h"
61 #include "libguile/feature.h"
62 #include "libguile/dynwind.h"
63 #include "libguile/modules.h"
64 #include "libguile/ports.h"
65 #include "libguile/root.h"
66 #include "libguile/fluids.h"
67 #include "libguile/objects.h"
68
69 #include "libguile/validate.h"
70 #include "libguile/debug.h"
71 \f
72
73 /* {Run time control of the debugging evaluator}
74 */
75
76 SCM_DEFINE (scm_debug_options, "debug-options-interface", 0, 1, 0,
77 (SCM setting),
78 "Option interface for the debug options. Instead of using\n"
79 "this procedure directly, use the procedures @code{debug-enable},\n"
80 "@code{debug-disable}, @code{debug-set!} and @code{debug-options}.")
81 #define FUNC_NAME s_scm_debug_options
82 {
83 SCM ans;
84 SCM_DEFER_INTS;
85 ans = scm_options (setting, scm_debug_opts, SCM_N_DEBUG_OPTIONS, FUNC_NAME);
86 if (!(1 <= SCM_N_FRAMES && SCM_N_FRAMES <= SCM_MAX_FRAME_SIZE))
87 {
88 scm_options (ans, scm_debug_opts, SCM_N_DEBUG_OPTIONS, FUNC_NAME);
89 SCM_OUT_OF_RANGE (1, setting);
90 }
91 SCM_RESET_DEBUG_MODE;
92 scm_stack_checking_enabled_p = SCM_STACK_CHECKING_P;
93 scm_debug_eframe_size = 2 * SCM_N_FRAMES;
94 SCM_ALLOW_INTS;
95 return ans;
96 }
97 #undef FUNC_NAME
98
99 static void
100 with_traps_before (void *data)
101 {
102 int *trap_flag = data;
103 *trap_flag = SCM_TRAPS_P;
104 SCM_TRAPS_P = 1;
105 }
106
107 static void
108 with_traps_after (void *data)
109 {
110 int *trap_flag = data;
111 SCM_TRAPS_P = *trap_flag;
112 }
113
114 static SCM
115 with_traps_inner (void *data)
116 {
117 SCM thunk = SCM_PACK (data);
118 return scm_call_0 (thunk);
119 }
120
121 SCM_DEFINE (scm_with_traps, "with-traps", 1, 0, 0,
122 (SCM thunk),
123 "Call @var{thunk} with traps enabled.")
124 #define FUNC_NAME s_scm_with_traps
125 {
126 int trap_flag;
127 SCM_VALIDATE_THUNK (1, thunk);
128 return scm_internal_dynamic_wind (with_traps_before,
129 with_traps_inner,
130 with_traps_after,
131 (void *) SCM_UNPACK (thunk),
132 &trap_flag);
133 }
134 #undef FUNC_NAME
135
136 \f
137
138 SCM_SYMBOL (scm_sym_procname, "procname");
139 SCM_SYMBOL (scm_sym_dots, "...");
140 SCM_SYMBOL (scm_sym_source, "source");
141
142 /* {Memoized Source}
143 */
144
145 scm_t_bits scm_tc16_memoized;
146
147 static int
148 memoized_print (SCM obj, SCM port, scm_print_state *pstate)
149 {
150 int writingp = SCM_WRITINGP (pstate);
151 scm_puts ("#<memoized ", port);
152 SCM_SET_WRITINGP (pstate, 1);
153 #ifdef GUILE_DEBUG
154 scm_iprin1 (SCM_MEMOIZED_EXP (obj), port, pstate);
155 #else
156 scm_iprin1 (scm_unmemoize (obj), port, pstate);
157 #endif
158 SCM_SET_WRITINGP (pstate, writingp);
159 scm_putc ('>', port);
160 return 1;
161 }
162
163 SCM_DEFINE (scm_memoized_p, "memoized?", 1, 0, 0,
164 (SCM obj),
165 "Return @code{#t} if @var{obj} is memoized.")
166 #define FUNC_NAME s_scm_memoized_p
167 {
168 return SCM_BOOL(SCM_MEMOIZEDP (obj));
169 }
170 #undef FUNC_NAME
171
172 SCM
173 scm_make_memoized (SCM exp, SCM env)
174 {
175 /* *fixme* Check that env is a valid environment. */
176 register SCM z, ans;
177 SCM_ENTER_A_SECTION;
178 SCM_NEWSMOB (z, SCM_UNPACK (exp), SCM_UNPACK (env));
179 SCM_NEWSMOB (ans, scm_tc16_memoized, SCM_UNPACK (z));
180 SCM_EXIT_A_SECTION;
181 return ans;
182 }
183
184 #ifdef GUILE_DEBUG
185 /*
186 * Some primitives for construction of memoized code
187 *
188 * - procedure: memcons CAR CDR [ENV]
189 *
190 * Construct a pair, encapsulated in a memoized object.
191 *
192 * The CAR and CDR can be either normal or memoized. If ENV isn't
193 * specified, the top-level environment of the current module will
194 * be assumed. All environments must match.
195 *
196 * - procedure: make-iloc FRAME BINDING CDRP
197 *
198 * Return an iloc referring to frame no. FRAME, binding
199 * no. BINDING. If CDRP is non-#f, the iloc is referring to a
200 * frame consisting of a single pair, with the value stored in the
201 * CDR.
202 *
203 * - procedure: iloc? OBJECT
204 *
205 * Return #t if OBJECT is an iloc.
206 *
207 * - procedure: mem->proc MEMOIZED
208 *
209 * Construct a closure from the memoized lambda expression MEMOIZED
210 *
211 * WARNING! The code is not copied!
212 *
213 * - procedure: proc->mem CLOSURE
214 *
215 * Turn the closure CLOSURE into a memoized object.
216 *
217 * WARNING! The code is not copied!
218 *
219 * - constant: SCM_IM_AND
220 * - constant: SCM_IM_BEGIN
221 * - constant: SCM_IM_CASE
222 * - constant: SCM_IM_COND
223 * - constant: SCM_IM_DO
224 * - constant: SCM_IM_IF
225 * - constant: SCM_IM_LAMBDA
226 * - constant: SCM_IM_LET
227 * - constant: SCM_IM_LETSTAR
228 * - constant: SCM_IM_LETREC
229 * - constant: SCM_IM_OR
230 * - constant: SCM_IM_QUOTE
231 * - constant: SCM_IM_SET
232 * - constant: SCM_IM_DEFINE
233 * - constant: SCM_IM_APPLY
234 * - constant: SCM_IM_CONT
235 * - constant: SCM_IM_DISPATCH
236 */
237
238 #include "libguile/variable.h"
239 #include "libguile/procs.h"
240
241 SCM_DEFINE (scm_make_iloc, "make-iloc", 3, 0, 0,
242 (SCM frame, SCM binding, SCM cdrp),
243 "Return a new iloc with frame offset @var{frame}, binding\n"
244 "offset @var{binding} and the cdr flag @var{cdrp}.")
245 #define FUNC_NAME s_scm_make_iloc
246 {
247 SCM_VALIDATE_INUM (1, frame);
248 SCM_VALIDATE_INUM (2, binding);
249 return SCM_MAKE_ILOC (SCM_INUM (frame),
250 SCM_INUM (binding),
251 !SCM_FALSEP (cdrp));
252 }
253 #undef FUNC_NAME
254
255 SCM_DEFINE (scm_iloc_p, "iloc?", 1, 0, 0,
256 (SCM obj),
257 "Return @code{#t} if @var{obj} is an iloc.")
258 #define FUNC_NAME s_scm_iloc_p
259 {
260 return SCM_BOOL(SCM_ILOCP (obj));
261 }
262 #undef FUNC_NAME
263
264 SCM_DEFINE (scm_memcons, "memcons", 2, 1, 0,
265 (SCM car, SCM cdr, SCM env),
266 "Return a new memoized cons cell with @var{car} and @var{cdr}\n"
267 "as members and @var{env} as the environment.")
268 #define FUNC_NAME s_scm_memcons
269 {
270 if (SCM_MEMOIZEDP (car))
271 {
272 /*fixme* environments may be two different but equal top-level envs */
273 if (!SCM_UNBNDP (env) && SCM_MEMOIZED_ENV (car) != env)
274 SCM_MISC_ERROR ("environment mismatch arg1 <-> arg3",
275 scm_list_2 (car, env));
276 else
277 env = SCM_MEMOIZED_ENV (car);
278 car = SCM_MEMOIZED_EXP (car);
279 }
280 if (SCM_MEMOIZEDP (cdr))
281 {
282 if (!SCM_UNBNDP (env) && SCM_MEMOIZED_ENV (cdr) != env)
283 SCM_MISC_ERROR ("environment mismatch arg2 <-> arg3",
284 scm_list_2 (cdr, env));
285 else
286 env = SCM_MEMOIZED_ENV (cdr);
287 cdr = SCM_MEMOIZED_EXP (cdr);
288 }
289 if (SCM_UNBNDP (env))
290 env = scm_top_level_env (SCM_TOP_LEVEL_LOOKUP_CLOSURE);
291 else
292 SCM_VALIDATE_NULLORCONS (3, env);
293 return scm_make_memoized (scm_cons (car, cdr), env);
294 }
295 #undef FUNC_NAME
296
297 SCM_DEFINE (scm_mem_to_proc, "mem->proc", 1, 0, 0,
298 (SCM obj),
299 "Convert a memoized object (which must be a lambda expression)\n"
300 "to a procedure.")
301 #define FUNC_NAME s_scm_mem_to_proc
302 {
303 SCM env;
304 SCM_VALIDATE_MEMOIZED (1, obj);
305 env = SCM_MEMOIZED_ENV (obj);
306 obj = SCM_MEMOIZED_EXP (obj);
307 if (!SCM_CONSP (obj) || !SCM_EQ_P (SCM_CAR (obj), SCM_IM_LAMBDA))
308 SCM_MISC_ERROR ("expected lambda expression", scm_list_1 (obj));
309 return scm_closure (SCM_CDR (obj), env);
310 }
311 #undef FUNC_NAME
312
313 SCM_DEFINE (scm_proc_to_mem, "proc->mem", 1, 0, 0,
314 (SCM obj),
315 "Convert a procedure to a memoized object.")
316 #define FUNC_NAME s_scm_proc_to_mem
317 {
318 SCM_VALIDATE_CLOSURE (1, obj);
319 return scm_make_memoized (scm_cons (SCM_IM_LAMBDA, SCM_CODE (obj)),
320 SCM_ENV (obj));
321 }
322 #undef FUNC_NAME
323
324 #endif /* GUILE_DEBUG */
325
326 SCM_DEFINE (scm_unmemoize, "unmemoize", 1, 0, 0,
327 (SCM m),
328 "Unmemoize the memoized expression @var{m},")
329 #define FUNC_NAME s_scm_unmemoize
330 {
331 SCM_VALIDATE_MEMOIZED (1, m);
332 return scm_unmemocopy (SCM_MEMOIZED_EXP (m), SCM_MEMOIZED_ENV (m));
333 }
334 #undef FUNC_NAME
335
336 SCM_DEFINE (scm_memoized_environment, "memoized-environment", 1, 0, 0,
337 (SCM m),
338 "Return the environment of the memoized expression @var{m}.")
339 #define FUNC_NAME s_scm_memoized_environment
340 {
341 SCM_VALIDATE_MEMOIZED (1, m);
342 return SCM_MEMOIZED_ENV (m);
343 }
344 #undef FUNC_NAME
345
346 SCM_DEFINE (scm_procedure_name, "procedure-name", 1, 0, 0,
347 (SCM proc),
348 "Return the name of the procedure @var{proc}")
349 #define FUNC_NAME s_scm_procedure_name
350 {
351 SCM_VALIDATE_PROC (1, proc);
352 switch (SCM_TYP7 (proc)) {
353 case scm_tcs_subrs:
354 return SCM_SNAME (proc);
355 default:
356 {
357 SCM name = scm_procedure_property (proc, scm_sym_name);
358 #if 0
359 /* Source property scm_sym_procname not implemented yet... */
360 SCM name = scm_source_property (SCM_CAR (SCM_CLOSURE_BODY (proc)), scm_sym_procname);
361 if (SCM_FALSEP (name))
362 name = scm_procedure_property (proc, scm_sym_name);
363 #endif
364 if (SCM_FALSEP (name) && SCM_CLOSUREP (proc))
365 name = scm_reverse_lookup (SCM_ENV (proc), proc);
366 return name;
367 }
368 }
369 }
370 #undef FUNC_NAME
371
372 SCM_DEFINE (scm_procedure_source, "procedure-source", 1, 0, 0,
373 (SCM proc),
374 "Return the source of the procedure @var{proc}.")
375 #define FUNC_NAME s_scm_procedure_source
376 {
377 SCM_VALIDATE_NIM (1, proc);
378 again:
379 switch (SCM_TYP7 (proc)) {
380 case scm_tcs_closures:
381 {
382 SCM formals = SCM_CLOSURE_FORMALS (proc);
383 SCM src = scm_source_property (SCM_CLOSURE_BODY (proc), scm_sym_copy);
384 if (!SCM_FALSEP (src))
385 return scm_cons2 (scm_sym_lambda, formals, src);
386 return scm_cons (scm_sym_lambda,
387 scm_unmemocopy (SCM_CODE (proc),
388 SCM_EXTEND_ENV (formals,
389 SCM_EOL,
390 SCM_ENV (proc))));
391 }
392 case scm_tcs_struct:
393 if (!SCM_I_OPERATORP (proc))
394 break;
395 goto procprop;
396 case scm_tc7_smob:
397 if (!SCM_SMOB_DESCRIPTOR (proc).apply)
398 break;
399 case scm_tcs_subrs:
400 #ifdef CCLO
401 case scm_tc7_cclo:
402 #endif
403 procprop:
404 /* It would indeed be a nice thing if we supplied source even for
405 built in procedures! */
406 return scm_procedure_property (proc, scm_sym_source);
407 case scm_tc7_pws:
408 {
409 SCM src = scm_procedure_property (proc, scm_sym_source);
410 if (!SCM_FALSEP (src))
411 return src;
412 proc = SCM_PROCEDURE (proc);
413 goto again;
414 }
415 default:
416 ;
417 }
418 SCM_WRONG_TYPE_ARG (1, proc);
419 return SCM_BOOL_F; /* not reached */
420 }
421 #undef FUNC_NAME
422
423 SCM_DEFINE (scm_procedure_environment, "procedure-environment", 1, 0, 0,
424 (SCM proc),
425 "Return the environment of the procedure @var{proc}.")
426 #define FUNC_NAME s_scm_procedure_environment
427 {
428 SCM_VALIDATE_NIM (1, proc);
429 switch (SCM_TYP7 (proc)) {
430 case scm_tcs_closures:
431 return SCM_ENV (proc);
432 case scm_tcs_subrs:
433 #ifdef CCLO
434 case scm_tc7_cclo:
435 #endif
436 return SCM_EOL;
437 default:
438 SCM_WRONG_TYPE_ARG (1, proc);
439 /* not reached */
440 }
441 }
442 #undef FUNC_NAME
443
444 \f
445
446 /* Eval in a local environment. We would like to have the ability to
447 * evaluate in a specified local environment, but due to the
448 * memoization this isn't normally possible. We solve it by copying
449 * the code before evaluating. One solution would be to have eval.c
450 * generate yet another evaluator. They are not very big actually.
451 */
452 SCM_DEFINE (scm_local_eval, "local-eval", 1, 1, 0,
453 (SCM exp, SCM env),
454 "Evaluate @var{exp} in its environment. If @var{env} is supplied,\n"
455 "it is the environment in which to evaluate @var{exp}. Otherwise,\n"
456 "@var{exp} must be a memoized code object (in which case, its environment\n"
457 "is implicit).")
458 #define FUNC_NAME s_scm_local_eval
459 {
460 if (SCM_UNBNDP (env))
461 {
462 SCM_VALIDATE_MEMOIZED (1, exp);
463 return scm_i_eval_x (SCM_MEMOIZED_EXP (exp), SCM_MEMOIZED_ENV (exp));
464 }
465 return scm_i_eval (exp, env);
466 }
467 #undef FUNC_NAME
468
469 #if 0
470 SCM_REGISTER_PROC (s_reverse_lookup, "reverse-lookup", 2, 0, 0, scm_reverse_lookup);
471 #endif
472
473 SCM
474 scm_reverse_lookup (SCM env, SCM data)
475 {
476 while (SCM_CONSP (env) && SCM_CONSP (SCM_CAR (env)))
477 {
478 SCM names = SCM_CAAR (env);
479 SCM values = SCM_CDAR (env);
480 while (SCM_CONSP (names))
481 {
482 if (SCM_EQ_P (SCM_CAR (values), data))
483 return SCM_CAR (names);
484 names = SCM_CDR (names);
485 values = SCM_CDR (values);
486 }
487 if (!SCM_NULLP (names) && SCM_EQ_P (values, data))
488 return names;
489 env = SCM_CDR (env);
490 }
491 return SCM_BOOL_F;
492 }
493
494 SCM
495 scm_start_stack (SCM id, SCM exp, SCM env)
496 {
497 SCM answer;
498 scm_t_debug_frame vframe;
499 scm_t_debug_info vframe_vect_body;
500 vframe.prev = scm_last_debug_frame;
501 vframe.status = SCM_VOIDFRAME;
502 vframe.vect = &vframe_vect_body;
503 vframe.vect[0].id = id;
504 scm_last_debug_frame = &vframe;
505 answer = scm_i_eval (exp, env);
506 scm_last_debug_frame = vframe.prev;
507 return answer;
508 }
509
510 SCM_SYNTAX(s_start_stack, "start-stack", scm_makacro, scm_m_start_stack);
511
512 static SCM
513 scm_m_start_stack (SCM exp, SCM env)
514 #define FUNC_NAME s_start_stack
515 {
516 exp = SCM_CDR (exp);
517 if (!SCM_CONSP (exp)
518 || !SCM_CONSP (SCM_CDR (exp))
519 || !SCM_NULLP (SCM_CDDR (exp)))
520 SCM_WRONG_NUM_ARGS ();
521 return scm_start_stack (scm_eval_car (exp, env), SCM_CADR (exp), env);
522 }
523 #undef FUNC_NAME
524
525
526 /* {Debug Objects}
527 *
528 * The debugging evaluator throws these on frame traps.
529 */
530
531 scm_t_bits scm_tc16_debugobj;
532
533 static int
534 debugobj_print (SCM obj, SCM port, scm_print_state *pstate SCM_UNUSED)
535 {
536 scm_puts ("#<debug-object ", port);
537 scm_intprint ((long) SCM_DEBUGOBJ_FRAME (obj), 16, port);
538 scm_putc ('>', port);
539 return 1;
540 }
541
542 SCM_DEFINE (scm_debug_object_p, "debug-object?", 1, 0, 0,
543 (SCM obj),
544 "Return @code{#t} if @var{obj} is a debug object.")
545 #define FUNC_NAME s_scm_debug_object_p
546 {
547 return SCM_BOOL(SCM_DEBUGOBJP (obj));
548 }
549 #undef FUNC_NAME
550
551
552 SCM
553 scm_make_debugobj (scm_t_debug_frame *frame)
554 {
555 return scm_cell (scm_tc16_debugobj, (scm_t_bits) frame);
556 }
557
558 \f
559
560 /* Undocumented debugging procedure */
561 #ifdef GUILE_DEBUG
562 SCM_DEFINE (scm_debug_hang, "debug-hang", 0, 1, 0,
563 (SCM obj),
564 "Go into an endless loop, which can be only terminated with\n"
565 "a debugger.")
566 #define FUNC_NAME s_scm_debug_hang
567 {
568 int go = 0;
569 while (!go) ;
570 return SCM_UNSPECIFIED;
571 }
572 #undef FUNC_NAME
573 #endif
574
575 \f
576
577 void
578 scm_init_debug ()
579 {
580 scm_init_opts (scm_debug_options, scm_debug_opts, SCM_N_DEBUG_OPTIONS);
581
582 scm_tc16_memoized = scm_make_smob_type ("memoized", 0);
583 scm_set_smob_mark (scm_tc16_memoized, scm_markcdr);
584 scm_set_smob_print (scm_tc16_memoized, memoized_print);
585
586 scm_tc16_debugobj = scm_make_smob_type ("debug-object", 0);
587 scm_set_smob_print (scm_tc16_debugobj, debugobj_print);
588
589 #ifdef GUILE_DEBUG
590 scm_c_define ("SCM_IM_AND", SCM_IM_AND);
591 scm_c_define ("SCM_IM_BEGIN", SCM_IM_BEGIN);
592 scm_c_define ("SCM_IM_CASE", SCM_IM_CASE);
593 scm_c_define ("SCM_IM_COND", SCM_IM_COND);
594 scm_c_define ("SCM_IM_DO", SCM_IM_DO);
595 scm_c_define ("SCM_IM_IF", SCM_IM_IF);
596 scm_c_define ("SCM_IM_LAMBDA", SCM_IM_LAMBDA);
597 scm_c_define ("SCM_IM_LET", SCM_IM_LET);
598 scm_c_define ("SCM_IM_LETSTAR", SCM_IM_LETSTAR);
599 scm_c_define ("SCM_IM_LETREC", SCM_IM_LETREC);
600 scm_c_define ("SCM_IM_OR", SCM_IM_OR);
601 scm_c_define ("SCM_IM_QUOTE", SCM_IM_QUOTE);
602 scm_c_define ("SCM_IM_SET_X", SCM_IM_SET_X);
603 scm_c_define ("SCM_IM_DEFINE", SCM_IM_DEFINE);
604 scm_c_define ("SCM_IM_APPLY", SCM_IM_APPLY);
605 scm_c_define ("SCM_IM_CONT", SCM_IM_CONT);
606 scm_c_define ("SCM_IM_DISPATCH", SCM_IM_DISPATCH);
607 #endif
608 scm_add_feature ("debug-extensions");
609
610 #include "libguile/debug.x"
611 }
612
613 /*
614 Local Variables:
615 c-file-style: "gnu"
616 End:
617 */