File: ER.html

package info (click to toggle)
acl2 3.1-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 36,712 kB
  • ctags: 38,396
  • sloc: lisp: 464,023; makefile: 5,470; sh: 86; csh: 47; cpp: 25; ansic: 22
file content (49 lines) | stat: -rw-r--r-- 2,014 bytes parent folder | download
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
<html>
<head><title>ER.html  --  ACL2 Version 3.1</title></head>
<body text=#000000 bgcolor="#FFFFFF">
<h2>ER</h2>print an error message and ``cause an error''
<pre>Major Section:  <a href="PROGRAMMING.html">PROGRAMMING</a>
</pre><p>


<pre>
Example Forms:
(er hard  'top-level "Illegal inputs, ~x0 and ~x1." a b)
(er hard? 'top-level "Illegal inputs, ~x0 and ~x1." a b)
(er soft  'top-level "Illegal inputs, ~x0 and ~x1." a b)
</pre>

The examples above all print an error message to standard output saying that
<code>a</code> and <code>b</code> are illegal inputs.  However, the first two abort evaluation
after printing an error message, while the third returns <code>(mv t nil state)</code>
after printing an error message.  The result in the third case can be
interpreted as an ``error'' when programming with the ACL2 <code><a href="STATE.html">state</a></code>,
something most ACL2 users will probably not want to do;
see <a href="LD-ERROR-TRIPLES.html">ld-error-triples</a> and see <a href="ER-PROGN.html">er-progn</a>.<p>

<code>Er</code> is a macro, and the above three examples expand to calls of ACL2
functions, as shown below.  See <a href="ILLEGAL.html">illegal</a>, see <a href="HARD-ERROR.html">hard-error</a>, and see <a href="ERROR1.html">error1</a>,
respectively.
<p>

<pre>
General forms:
(er hard  ctx fmt-string arg1 arg2 ... argk)
  ==&gt; {macroexpands, in essence, to:}
(ILLEGAL    CTX FMT-STRING
            (LIST (CONS #\0 ARG1) (CONS #\1 ARG2) ... (CONS #\k ARGk)))<p>

(er hard? ctx fmt-string arg1 arg2 ... argk)
  ==&gt; {macroexpands, in essence, to:}
(HARD-ERROR CTX FMT-STRING
            (LIST (CONS #\0 ARG1) (CONS #\1 ARG2) ... (CONS #\k ARGk)))<p>

(er soft  ctx fmt-string arg1 arg2 ... argk)
  ==&gt; {macroexpands, in essence, to:}
(ERROR1     CTX FMT-STRING
            (LIST (CONS #\0 ARG1) (CONS #\1 ARG2) ... (CONS #\k ARGk)))
</pre>

<br><br><br><a href="acl2-doc.html"><img src="llogo.gif"></a> <a href="acl2-doc-index.html"><img src="index.gif"></a>
</body>
</html>