/usr/share/doc/swi-prolog-doc/Manual/excepthook.html is in swi-prolog-doc 5.6.59-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<HTML>
<HEAD>
<TITLE>SWI-Prolog 5.6.59 Reference Manual: Section B.3</TITLE><LINK REL=home HREF="index.html">
<LINK REL=contents HREF="Contents.html">
<LINK REL=index HREF="DocIndex.html">
<LINK REL=previous HREF="tracehook.html">
<LINK REL=next HREF="exception3.html">
<STYLE type="text/css">
/* Style sheet for SWI-Prolog latex2html
*/
dd.defbody
{ margin-bottom: 1em;
}
dt.pubdef
{ background-color: #c5e1ff;
}
pre.code
{ margin-left: 1.5em;
margin-right: 1.5em;
border: 1px dotted;
padding-top: 5px;
padding-left: 5px;
padding-bottom: 5px;
background-color: #f8f8f8;
}
div.navigate
{ text-align: center;
background-color: #f0f0f0;
border: 1px dotted;
padding: 5px;
}
div.title
{ text-align: center;
padding-bottom: 1em;
font-size: 200%;
font-weight: bold;
}
div.author
{ text-align: center;
font-style: italic;
}
div.abstract
{ margin-top: 2em;
background-color: #f0f0f0;
border: 1px dotted;
padding: 5px;
margin-left: 10%; margin-right:10%;
}
div.abstract-title
{ text-align: center;
padding: 5px;
font-size: 120%;
font-weight: bold;
}
div.toc-h1
{ font-size: 200%;
font-weight: bold;
}
div.toc-h2
{ font-size: 120%;
font-weight: bold;
margin-left: 2em;
}
div.toc-h3
{ font-size: 100%;
font-weight: bold;
margin-left: 4em;
}
div.toc-h4
{ font-size: 100%;
margin-left: 6em;
}
span.sec-nr
{
}
span.sec-title
{
}
span.pred-ext
{ font-weight: bold;
}
span.pred-tag
{ float: right;
font-size: 80%;
font-style: italic;
color: #202020;
}
/* Footnotes */
sup.fn { color: blue; text-decoration: underline; }
span.fn-text { display: none; }
sup.fn span {display: none;}
sup:hover span
{ display: block !important;
position: absolute; top: auto; left: auto; width: 80%;
color: #000; background: white;
border: 2px solid;
padding: 5px; margin: 10px; z-index: 100;
font-size: smaller;
}
</STYLE>
</HEAD>
<BODY BGCOLOR="white">
<DIV class="navigate"><A class="nav" href="index.html"><IMG SRC="home.gif" BORDER=0 ALT="Home"></A>
<A class="nav" href="Contents.html"><IMG SRC="index.gif" BORDER=0 ALT="Contents"></A>
<A class="nav" href="DocIndex.html"><IMG SRC="yellow_pages.gif" BORDER=0 ALT="Index"></A>
<A class="nav" href="tracehook.html"><IMG SRC="prev.gif" BORDER=0 ALT="Previous"></A>
<A class="nav" href="exception3.html"><IMG SRC="next.gif" BORDER=0 ALT="Next"></A>
</DIV>
<H2><A NAME="sec:B.3"><SPAN class="sec-nr">B.3</SPAN> <SPAN class="sec-title">Adding
context to errors: prolog_exception_hook</SPAN></A></H2>
<A NAME="sec:excepthook"></A>
<P>The hook <A NAME="idx:prologexceptionhook4:1550"></A><A class="pred" href="excepthook.html#prolog_exception_hook/4">prolog_exception_hook/4</A>
has been introduced in SWI-Prolog 5.6.5 to provide dedicated exception
handling facilities for application frameworks. For example
non-interactive server applications that wish to provide extensive
context for exceptions for offline debugging.
<DL>
<DT class="pubdef"><A NAME="prolog_exception_hook/4"><STRONG>prolog_exception_hook</STRONG>(<VAR>+ExceptionIn,
-ExceptionOut, +Frame, +CatcherFrame</VAR>)</A></DT>
<DD class="defbody">
This hook predicate, if defined in the module <CODE>user</CODE>, is
between raising an exception and handling it. It is intended to allow a
program adding additional context to an exception to simplify diagnosing
the problem. <VAR>ExceptionIn</VAR> is the exception term as raised by <A NAME="idx:throw1:1551"></A><A class="pred" href="exception.html#throw/1">throw/1</A>
or one of the bullt-in predicates. The output argument <VAR>ExceptionOut</VAR>
describes the exception that is actually raised. <VAR>Frame</VAR> is the
innermost frame. See <A NAME="idx:prologframeattribute3:1552"></A><A class="pred" href="manipstack.html#prolog_frame_attribute/3">prolog_frame_attribute/3</A>
and the library
<CODE>library(prolog_stack)</CODE> for getting information from this.
<VAR>CatcherFrame</VAR> is a reference to the frame calling the matching
<A NAME="idx:catch3:1553"></A><A class="pred" href="exception.html#catch/3">catch/3</A>
or <CODE>none</CODE> of the exception is not caught.
<P>The hook is run in `nodebug' mode. If it succeeds <VAR>ExceptionOut</VAR>
is considered the current exception. If it fails, <VAR>ExceptionIn</VAR>
is used for further processing. The hook is <EM>never</EM> called
recursively. The hook is <EM>not</EM> allowed to modify <VAR>ExceptionOut</VAR>
in such as way that it no longer unifies with the catching frame.
<P>Typically, <A NAME="idx:prologexceptionhook4:1554"></A><A class="pred" href="excepthook.html#prolog_exception_hook/4">prolog_exception_hook/4</A>
is used to fill the second argument of <CODE>error(Formal, Context)</CODE>
exceptions. <VAR>Formal</VAR> is defined by the ISO standard, while
SWI-Prolog defines <VAR>Context</VAR> as a term <CODE>context(Location,
Message)</CODE>. <VAR>Location</VAR> is bound to a term <<VAR>name</VAR>>/<<VAR>arity</VAR>>
by the kernel. This hook can be used to add more information on the
calling context, such as a full stack trace.
<P>Applications that use exceptions as part of normal processing must do
a quick test of the environment before starting expensive gathering
information on the state of the program.
<P>The hook can call <A NAME="idx:trace0:1555"></A><A class="pred" href="debugger.html#trace/0">trace/0</A>
to enter trace mode immediately. For example imagine an application
performing an unwanted division by zero while all other errors are
expected and handled. We can force the debugger using the hook
definition below. Run the program in debug mode (see <A NAME="idx:debug0:1556"></A><A class="pred" href="debugger.html#debug/0">debug/0</A>)
to preserve as much as possible of the error context.
<PRE class="code">
user:prolog_exception_hook(error(evaluation_error(zero_divisor), _),
_, _, _) :-
trace, fail.
</PRE>
<P></DD>
</DL>
<P></BODY></HTML>
|