1
0
Fork 0
cl-sites/HyperSpec-7-0/HyperSpec/Body/f_invoke.htm

66 lines
4.8 KiB
HTML
Raw Normal View History

2024-04-01 10:24:07 +02:00
<!-- Common Lisp HyperSpec (TM), version 7.0 generated by Kent M. Pitman on Mon, 11-Apr-2005 2:31am EDT -->
<HTML>
<HEAD>
<TITLE>CLHS: Function INVOKE-DEBUGGER</TITLE>
<LINK HREF="../Data/clhs.css" REL="stylesheet" TYPE="text/css" />
<META HTTP-EQUIV="Author" CONTENT="Kent M. Pitman">
<META HTTP-EQUIV="Organization" CONTENT="LispWorks Ltd.">
<LINK REL=TOP HREF="../Front/index.htm">
<LINK REL=COPYRIGHT HREF="../Front/Help.htm#Legal">
<LINK REL=DISCLAIMER HREF="../Front/Help.htm#Disclaimer">
<LINK REL=PREV HREF="e_smp_wa.htm">
<LINK REL=UP HREF="c_condit.htm">
<LINK REL=NEXT HREF="f_break.htm">
</HEAD>
<BODY>
<H1><A REV=MADE HREF="http://www.lispworks.com/"><IMG WIDTH=80 HEIGHT=65 ALT="[LISPWORKS]" SRC="../Graphics/LWSmall.gif" ALIGN=Bottom></A><A REL=TOP HREF="../Front/index.htm"><IMG WIDTH=237 HEIGHT=65 ALT="[Common Lisp HyperSpec (TM)]" SRC="../Graphics/CLHS_Sm.gif" ALIGN=Bottom></A> <A REL=PREV HREF="e_smp_wa.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Previous]" SRC="../Graphics/Prev.gif" ALIGN=Bottom></A><A REL=UP HREF="c_condit.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Up]" SRC="../Graphics/Up.gif" ALIGN=Bottom></A><A REL=NEXT HREF="f_break.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
<HR>
<A NAME="invoke-debugger"><I>Function</I> <B>INVOKE-DEBUGGER</B></A> <P>
<P><B>Syntax:</B><P>
<P>
<B>invoke-debugger</B> <I>condition</I> =&gt;| <P>
<P>
<P><B>Arguments and Values:</B><P>
<P>
<I>condition</I>---a <A REL=DEFINITION HREF="26_glo_c.htm#condition"><I>condition</I></A> <A REL=DEFINITION HREF="26_glo_o.htm#object"><I>object</I></A>. <P>
<P><B>Description:</B><P>
<P>
<A REL=DEFINITION HREF="#invoke-debugger"><B>invoke-debugger</B></A> attempts to enter the debugger with <I>condition</I>. <P>
If <A REL=DEFINITION HREF="v_debugg.htm#STdebugger-hookST"><B>*debugger-hook*</B></A> is not <A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A>, it should be a <A REL=DEFINITION HREF="26_glo_f.htm#function"><I>function</I></A> (or the name of a <A REL=DEFINITION HREF="26_glo_f.htm#function"><I>function</I></A>) to be called prior to entry to the standard debugger. The <A REL=DEFINITION HREF="26_glo_f.htm#function"><I>function</I></A> is called with <A REL=DEFINITION HREF="v_debugg.htm#STdebugger-hookST"><B>*debugger-hook*</B></A> bound to <A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A>, and the <A REL=DEFINITION HREF="26_glo_f.htm#function"><I>function</I></A> must accept two arguments: the <I>condition</I> and the <A REL=DEFINITION HREF="26_glo_v.htm#value"><I>value</I></A> of <A REL=DEFINITION HREF="v_debugg.htm#STdebugger-hookST"><B>*debugger-hook*</B></A> prior to binding it to <A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A>. If the <A REL=DEFINITION HREF="26_glo_f.htm#function"><I>function</I></A> returns normally, the standard debugger is entered. <P>
The standard debugger never directly returns. Return can occur only by a non-local transfer of control, such as the use of a restart function. <P>
<P><B>Examples:</B><P>
<P>
<PRE>
(ignore-errors ;Normally, this would suppress debugger entry
(handler-bind ((error #'invoke-debugger)) ;But this forces debugger entry
(error &quot;Foo.&quot;)))
Debug: Foo.
To continue, type :CONTINUE followed by an option number:
1: Return to Lisp Toplevel.
Debug&gt;
</PRE>
</TT> <P>
<P><B>Side Effects:</B><P>
<P>
<A REL=DEFINITION HREF="v_debugg.htm#STdebugger-hookST"><B>*debugger-hook*</B></A> is bound to <A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A>, program execution is discontinued, and the debugger is entered. <P>
<P><B>Affected By:</B><P>
<P>
<A REL=DEFINITION HREF="v_debug_.htm#STdebug-ioST"><B>*debug-io*</B></A> and <A REL=DEFINITION HREF="v_debugg.htm#STdebugger-hookST"><B>*debugger-hook*</B></A>. <P>
<P><B>Exceptional Situations:</B> None.
<P>
<P><B>See Also:</B><P>
<P>
<A REL=DEFINITION HREF="f_error.htm#error"><B>error</B></A>, <A REL=DEFINITION HREF="f_break.htm#break"><B>break</B></A> <P>
<P><B>Notes:</B> None.
<P>
<HR>
<A REL=NAVIGATOR HREF="../Front/StartPts.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Starting Points]" SRC="../Graphics/StartPts.gif" ALIGN=Bottom></A><A REL=TOC HREF="../Front/Contents.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Contents]" SRC="../Graphics/Contents.gif" ALIGN=Bottom></A><A REL=INDEX HREF="../Front/X_Master.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Index]" SRC="../Graphics/Index.gif" ALIGN=Bottom></A><A REL=INDEX HREF="../Front/X_Symbol.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Symbols]" SRC="../Graphics/Symbols.gif" ALIGN=Bottom></A><A REL=GLOSSARY HREF="../Body/26_a.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Glossary]" SRC="../Graphics/Glossary.gif" ALIGN=Bottom></A><A HREF="../Front/X3J13Iss.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Issues]" SRC="../Graphics/Issues.gif" ALIGN=Bottom></A><BR>
<A REL=COPYRIGHT HREF="../Front/Help.htm#Legal"><I>Copyright 1996-2005, LispWorks Ltd. All rights reserved.</I></A><P>
</BODY>
</HTML>