130 lines
128 KiB
HTML
130 lines
128 KiB
HTML
|
<!doctype html>
|
|||
|
|
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-chap-9/j-c-dictionary/with-simple-restart_macro" data-has-hydrated="false">
|
|||
|
|
<head>
|
|||
|
|
<meta charset="UTF-8">
|
|||
|
|
<meta name="generator" content="Docusaurus v3.0.1">
|
|||
|
|
<title data-rh="true">with-simple-restart | Common Lisp (New) Language Reference</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://lisp-docs.github.io/cl-language-reference/img/1024px-Lisp_logo.svg.png"><meta data-rh="true" name="twitter:image" content="https://lisp-docs.github.io/cl-language-reference/img/1024px-Lisp_logo.svg.png"><meta data-rh="true" property="og:url" content="https://lisp-docs.github.io/cl-language-reference/chap-9/j-c-dictionary/with-simple-restart_macro"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="google-site-verification" content="Vzaw013_bfdKeUVG89Ch3W1zC9_vH9ID2dPB9Dz0vr0"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="with-simple-restart | Common Lisp (New) Language Reference"><meta data-rh="true" name="description" content="Expanded Reference: with-simple-restart"><meta data-rh="true" property="og:description" content="Expanded Reference: with-simple-restart"><link data-rh="true" rel="icon" href="../../img/favicon.ico"><link data-rh="true" rel="canonical" href="with-simple-restart_macro.html"><link data-rh="true" rel="alternate" href="with-simple-restart_macro.html" hreflang="en"><link data-rh="true" rel="alternate" href="with-simple-restart_macro.html" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://C1F2Q5VM6X-dsn.algolia.net" crossorigin="anonymous"><link rel="preconnect" href="https://www.google-analytics.com">
|
|||
|
|
<link rel="preconnect" href="https://www.googletagmanager.com">
|
|||
|
|
<script async src="https://www.googletagmanager.com/gtag/js?id=G-8TJCE4NSF8"></script>
|
|||
|
|
<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-8TJCE4NSF8",{})</script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="search" type="application/opensearchdescription+xml" title="Common Lisp (New) Language Reference" href="../../opensearch.xml"><link rel="stylesheet" href="../../assets/css/styles.f13b59fe.css">
|
|||
|
|
<script src="../../assets/js/runtime~main.02699c25.js" defer="defer"></script>
|
|||
|
|
<script src="../../assets/js/main.4f0a7a76.js" defer="defer"></script>
|
|||
|
|
</head>
|
|||
|
|
<body class="navigation-with-keyboard">
|
|||
|
|
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="with-simple-restart_macro.html#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a href="../../../index.html" target="_blank" rel="noopener noreferrer" class="navbar__brand"><div class="navbar__logo"><img src="../../img/logo.svg" alt="Lisp Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="../../img/logo.svg" alt="Lisp Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><b class="navbar__title text--truncate">Common Lisp Docs</b></a><a href="../../../docs/tutorial/index.html" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Tutorial</a><a href="../../index.html" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Technical Reference</a><a href="../../../docs/whylisp.html" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Why Lisp?</a><a href="../../../docs/howto.html" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Guides</a></div><div class="navbar__items navbar__items--right"><a href="../../../docs/contribute.html" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Contribute!</a><a href="../../../docs/help.html" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Getting Help</a><a href="../../../docs/about.html" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">About</a><a href="../../../blog.html" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Blog</a><a href="https://github.com/lisp-docs" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.3
|
|||
|
|
<!-- -->
|
|||
|
|
<!-- -->
|
|||
|
|
<p><strong>with-simple-restart</strong> <span><i>Macro</i></span></p>
|
|||
|
|
<p><strong>Syntax:</strong></p>
|
|||
|
|
<p><span><b>with-simple-restart</b></span> (<em>name format-control {format-argument}</em>*) <span><i>{form}</i></span>*</p>
|
|||
|
|
<p>→ {result}*</p>
|
|||
|
|
<p><strong>Arguments and Values:</strong></p>
|
|||
|
|
<p><span><i>name</i></span>—a <span><i>symbol</i></span>.</p>
|
|||
|
|
<p><em>format-control</em>—a <span><i>format control</i></span>.</p>
|
|||
|
|
<p><em>format-argument</em>—an <span><i>object</i></span> (<em>i.e.</em>, a <span><i>format argument</i></span>).</p>
|
|||
|
|
<p><span><i>forms</i></span>—an <span><i>implicit progn</i></span>.</p>
|
|||
|
|
<p><em>results</em>—in the normal situation, the <span><i>values</i></span> returned by the <span><i>forms</i></span>; in the exceptional situation where the <span><i>restart</i></span> named <span><i>name</i></span> is invoked, two values—<span><b>nil</b></span> and <span><b>t</b></span>.</p>
|
|||
|
|
<p><strong>Description:</strong></p>
|
|||
|
|
<p><span><b>with-simple-restart</b></span> establishes a restart.</p>
|
|||
|
|
<p>If the restart designated by <span><i>name</i></span> is not invoked while executing <span><i>forms</i></span>, all values returned by the last of <span><i>forms</i></span> are returned. If the restart designated by <span><i>name</i></span> is invoked, control is transferred to <span><b>with-simple-restart</b></span>, which returns two values, <span><b>nil</b></span> and <span><b>t</b></span>.</p>
|
|||
|
|
<p>If <span><i>name</i></span> is <span><b>nil</b></span>, an anonymous restart is established.</p>
|
|||
|
|
<p>The <em>format-control</em> and <em>format-arguments</em> are used report the <span><i>restart</i></span>.</p>
|
|||
|
|
<span><b>with-simple-restart</b></span>
|
|||
|
|
<p><strong>Examples:</strong></p>
|
|||
|
|
<div class="language-lisp codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-lisp codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token defun keyword" style="color:#00009f">defun</span><span class="token defun"> </span><span class="token defun function" style="color:#d73a49">read-eval-print-loop</span><span class="token defun"> </span><span class="token defun punctuation" style="color:#393A34">(</span><span class="token defun arguments argument variable" style="color:#36acaa">level</span><span class="token defun punctuation" style="color:#393A34">)</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">with-simple-restart</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">abort</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"Exit command level ~</span><span class="token string argument" style="color:#e3116c">D</span><span class="token string" style="color:#e3116c">."</span><span class="token plain"> level</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">loop</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">with-simple-restart</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">abort</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"Return to command level ~</span><span class="token string argument" style="color:#e3116c">D</span><span class="token string" style="color:#e3116c">."</span><span class="token plain"> level</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">let</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">form</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">prog2</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">fresh-line</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">read</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">fresh-line</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><br></span><span class="token-line" style="color:
|
|||
|
|
<p><strong>See Also:</strong></p>
|
|||
|
|
<span><b>restart-case</b></span>
|
|||
|
|
<p><strong>Notes:</strong></p>
|
|||
|
|
<p><span><b>with-simple-restart</b></span> is shorthand for one of the most common uses of <span><b>restart-case</b></span>.</p>
|
|||
|
|
<p><span><b>with-simple-restart</b></span> could be defined by:</p>
|
|||
|
|
<p>(defmacro with-simple-restart ((restart-name format-control</p>
|
|||
|
|
<p>&rest format-arguments)</p>
|
|||
|
|
<p>&body forms)</p>
|
|||
|
|
<p>‘(restart-case (progn ,@forms)</p>
|
|||
|
|
<p>(,restart-name ()</p>
|
|||
|
|
<p>:report<!-- --> (lambda (stream)</p>
|
|||
|
|
<p>(format stream ,format-control ,@format-arguments))</p>
|
|||
|
|
<p>(values nil t))))</p>
|
|||
|
|
<p>Because the second return value is <span><b>t</b></span> in the exceptional case, it is common (but not required) to arrange for the second return value in the normal case to be missing or <span><b>nil</b></span> so that the two situations can be distinguished.</p>
|
|||
|
|
<p><strong>abort</strong> <span><i>Restart</i></span></p>
|
|||
|
|
<p><strong>Data Arguments Required:</strong></p>
|
|||
|
|
<p>None.</p>
|
|||
|
|
<p><strong>Description:</strong></p>
|
|||
|
|
<p>The intent of the <strong>abort</strong> restart is to allow return to the innermost “command level.” Implementors are encouraged to make sure that there is always a restart named <strong>abort</strong> around any user code so that user code can call <strong>abort</strong> at any time and expect something reasonable to happen; exactly what the reasonable thing is may vary somewhat. Typically, in an interactive listener, the invocation of</p>
|
|||
|
|
<p><strong>abort</strong> returns to the <em>Lisp reader</em> phase of the <em>Lisp read-eval-print loop</em>, though in some batch or multi-processing situations there may be situations in which having it kill the running process is more appropriate.</p>
|
|||
|
|
<p><strong>See Also:</strong></p>
|
|||
|
|
<p>Section 9.1.4.2 (Restarts), Section 9.1.4.2.2 (Interfaces to Restarts), <span><b>invoke-restart</b></span>, <strong>abort</strong> (<span><i>function</i></span>)</p>
|
|||
|
|
<p><strong>continue</strong> <span><i>Restart</i></span></p>
|
|||
|
|
<p><strong>Data Arguments Required:</strong></p>
|
|||
|
|
<p>None.</p>
|
|||
|
|
<p><strong>Description:</strong></p>
|
|||
|
|
<p>The <strong>continue</strong> <span><i>restart</i></span> is generally part of protocols where there is a single “obvious” way to continue, such as in <span><b>break</b></span> and <span><b>cerror</b></span>. Some user-defined protocols may also wish to incorporate it for similar reasons. In general, however, it is more reliable to design a special purpose restart with a name that more directly suits the particular application.</p>
|
|||
|
|
<p><strong>Examples:</strong></p>
|
|||
|
|
<div class="language-lisp codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-lisp codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">let</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">x</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">3</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">handler-bind</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">error</span><span class="token plain"> #’</span><span class="token punctuation" style="color:#393A34">(</span><span class="token lambda keyword" style="color:#00009f">lambda</span><span class="token lambda"> </span><span class="token lambda punctuation" style="color:#393A34">(</span><span class="token lambda arguments argument variable" style="color:#36acaa">c</span><span class="token lambda punctuation" style="color:#393A34">)</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">let</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">r</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">find-restart</span><span class="token plain"> ’continue c</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">when</span><span class="token plain"> r </span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">invoke-restart</span><span class="token plain"> r</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">cond</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">not</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token ca
|
|||
|
|
<p><strong>See Also:</strong></p>
|
|||
|
|
<p>Section 9.1.4.2 (Restarts), Section 9.1.4.2.2 (Interfaces to Restarts), <span><b>invoke-restart</b></span>, <strong>continue</strong> (<span><i>function</i></span>), <span><b>assert</b></span>, <span><b>cerror</b></span></p>
|
|||
|
|
<p><strong>muffle-warning</strong> <span><i>Restart</i></span></p>
|
|||
|
|
<p><strong>Data Arguments Required:</strong></p>
|
|||
|
|
<p>None.</p>
|
|||
|
|
<p><strong>Description:</strong></p>
|
|||
|
|
<p>This <span><i>restart</i></span> is established by <span><b>warn</b></span> so that <span><i>handlers</i></span> of <span><b>warning</b></span> <span><i>conditions</i></span> have a way to tell <span><b>warn</b></span> that a warning has already been dealt with and that no further action is warranted.</p>
|
|||
|
|
<p><strong>Examples:</strong></p>
|
|||
|
|
<div class="language-lisp codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-lisp codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">defvar</span><span class="token plain"> \*all-quiet\* </span><span class="token boolean" style="color:#36acaa">nil</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> → \*ALL-QUIET\* </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">defvar</span><span class="token plain"> \*saved-warnings\* ’</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> → \*SAVED-WARNINGS\* </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token defun keyword" style="color:#00009f">defun</span><span class="token defun"> </span><span class="token defun function" style="color:#d73a49">quiet-warning-handler</span><span class="token defun"> </span><span class="token defun punctuation" style="color:#393A34">(</span><span class="token defun arguments argument variable" style="color:#36acaa">c</span><span class="token defun punctuation" style="color:#393A34">)</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">when</span><span class="token plain"> \*all-quiet\* </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">let</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">r</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">find-restart</span><span class="token plain"> ’muffle-warning c</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">when</span><span class="token plain"> r </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">push</span><span class="token plain"> c \*saved-warnings\*</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">invoke-restart</span><span class="token plain"> r</span><span class="token punctuation" style="color:#393A34">)</span><span class="
|
|||
|
|
<p><strong>See Also:</strong></p>
|
|||
|
|
<p>Section 9.1.4.2 (Restarts), Section 9.1.4.2.2 (Interfaces to Restarts), <span><b>invoke-restart</b></span>, <strong>muffle-warning</strong> (<span><i>function</i></span>), <span><b>warn</b></span></p>
|
|||
|
|
<p><strong>store-value</strong> <span><i>Restart</i></span></p>
|
|||
|
|
<p><strong>Data Arguments Required:</strong></p>
|
|||
|
|
<p>a value to use instead (on an ongoing basis).</p>
|
|||
|
|
<p><strong>Description:</strong></p>
|
|||
|
|
<p>The <strong>store-value</strong> <span><i>restart</i></span> is generally used by <span><i>handlers</i></span> trying to recover from errors of <span><i>types</i></span> such as <span><b>cell-error</b></span> or <span><b>type-error</b></span>, which may wish to supply a replacement datum to be stored permanently.</p>
|
|||
|
|
<p><strong>Examples:</strong></p>
|
|||
|
|
<div class="language-lisp codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-lisp codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token defun keyword" style="color:#00009f">defun</span><span class="token defun"> </span><span class="token defun function" style="color:#d73a49">type-error-auto-coerce</span><span class="token defun"> </span><span class="token defun punctuation" style="color:#393A34">(</span><span class="token defun arguments argument variable" style="color:#36acaa">c</span><span class="token defun punctuation" style="color:#393A34">)</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">when</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">typep</span><span class="token plain"> c ’type-error</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">let</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">r</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">find-restart</span><span class="token plain"> ’store-value c</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">handler-case</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">let</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">v</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">coerce</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">type-error-datum</span><span class="token plain"> c</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">type-error-expected-type</span><span class="token plain"> c</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span
|
|||
|
|
<p><strong>See Also:</strong></p>
|
|||
|
|
<p>Section 9.1.4.2 (Restarts), Section 9.1.4.2.2 (Interfaces to Restarts), <span><b>invoke-restart</b></span>, <strong>store-value</strong> (<span><i>function</i></span>), <span><b>ccase</b></span>, <span><b>check-type</b></span>, <span><b>ctypecase</b></span>, <strong>use-value</strong> (<span><i>function</i></span> and <span><i>restart</i></span>)</p>
|
|||
|
|
<p><strong>use-value</strong> <span><i>Restart</i></span></p>
|
|||
|
|
<p><strong>Data Arguments Required:</strong></p>
|
|||
|
|
<p>a value to use instead (once).</p>
|
|||
|
|
<p><strong>Description:</strong></p>
|
|||
|
|
<p>The <strong>use-value</strong> <span><i>restart</i></span> is generally used by <span><i>handlers</i></span> trying to recover from errors of <span><i>types</i></span> such as <span><b>cell-error</b></span>, where the handler may wish to supply a replacement datum for one-time use.</p>
|
|||
|
|
<p><strong>See Also:</strong></p>
|
|||
|
|
<p>Section 9.1.4.2 (Restarts), Section 9.1.4.2.2 (Interfaces to Restarts), <span><b>invoke-restart</b></span>, <strong>use-value</strong> (<span><i>function</i></span>), <strong>store-value</strong> (<span><i>function</i></span> and <span><i>restart</i></span>)</p>
|
|||
|
|
<b><sup>abort, continue, muffle-warning, store-value, use</sup> value</b>
|
|||
|
|
<i>Function</i>
|
|||
|
|
<p><strong>Syntax:</strong></p>
|
|||
|
|
<p><strong>abort</strong> &optional <em>condition →</em></p>
|
|||
|
|
<p><strong>continue</strong> &optional <em>condition →</em> <span><b>nil</b></span></p>
|
|||
|
|
<p><strong>muffle-warning</strong> &optional <em>condition →</em></p>
|
|||
|
|
<p><strong>store-value</strong> <span><i>value</i></span> &optional <em>condition →</em> <span><b>nil</b></span></p>
|
|||
|
|
<p><strong>use-value</strong> <span><i>value</i></span> &optional <em>condition →</em> <span><b>nil</b></span></p>
|
|||
|
|
<p><strong>abort, continue, muffle-warning, store-value, use-value</strong></p>
|
|||
|
|
<p><strong>Arguments and Values:</strong></p>
|
|||
|
|
<p><span><i>value</i></span>—an <span><i>object</i></span>.</p>
|
|||
|
|
<p><span><i>condition</i></span>—a <em>condition object</em>, or <span><b>nil</b></span>.</p>
|
|||
|
|
<p><strong>Description:</strong></p>
|
|||
|
|
<p>Transfers control to the most recently established <span><i>applicable restart</i></span> having the same name as the function. That is, the <span><i>function</i></span> <strong>abort</strong> searches for an <span><i>applicable</i></span> <strong>abort</strong> <span><i>restart</i></span>, the <span><i>function</i></span> <strong>continue</strong> searches for an <span><i>applicable</i></span> <strong>continue</strong> <span><i>restart</i></span>, and so on.</p>
|
|||
|
|
<p>If no such <span><i>restart</i></span> exists, the functions <strong>continue</strong>, <strong>store-value</strong>, and <strong>use-value</strong> return <span><b>nil</b></span>, and the functions <strong>abort</strong> and <strong>muffle-warning</strong> signal an error of <span><i>type</i></span> <span><b>control-error</b></span>.</p>
|
|||
|
|
<p>When <span><i>condition</i></span> is <span><i>non-nil</i></span>, only those <span><i>restarts</i></span> are considered that are either explicitly associated with that <span><i>condition</i></span>, or not associated with any <span><i>condition</i></span>; that is, the excluded <span><i>restarts</i></span> are those that are associated with a non-empty set of <span><i>conditions</i></span> of which the given <span><i>condition</i></span> is not an <span><i>element</i></span>. If <span><i>condition</i></span> is <span><b>nil</b></span>, all <span><i>restarts</i></span> are considered.</p>
|
|||
|
|
<p><strong>Examples:</strong></p>
|
|||
|
|
<div class="language-lisp codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-lisp codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token heading comment title" style="color:#999988;font-style:italic">;;; Example of the ABORT retart </span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token defun keyword" style="color:#00009f">defmacro</span><span class="token defun"> </span><span class="token defun function" style="color:#d73a49">abort-on-error</span><span class="token defun"> </span><span class="token defun punctuation" style="color:#393A34">(</span><span class="token defun arguments rest-vars lisp-marker">&body</span><span class="token defun arguments rest-vars"> </span><span class="token defun arguments rest-vars argument variable" style="color:#36acaa">forms</span><span class="token defun punctuation" style="color:#393A34">)</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> ‘</span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">handler-bind</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">error</span><span class="token plain"> #’abort</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token splice symbol variable" style="color:#36acaa">,@forms</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> → ABORT-ON-ERROR </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">abort-on-error</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">+</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">3</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">5</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> → </span><span class="token number" style="color:#36acaa">8</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">(</span><span class="token car">abort-on-error</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">(</span><span class="token keyword" style="color:#00009f">error</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"You lose."</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">▷ Returned to Lisp Top Level. </span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token heading comment title" style="color:#999988;font-style:italic">;;; Example of the CONTINUE restart </span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span clas
|
|||
|
|
<p><strong>Side Effects:</strong></p>
|
|||
|
|
<p>A transfer of control may occur if an appropriate <span><i>restart</i></span> is available, or (in the case of the <span><i>function</i></span> <strong>abort</strong> or the <span><i>function</i></span> <strong>muffle-warning</strong>) execution may be stopped.</p>
|
|||
|
|
<p><strong>Affected By:</strong></p>
|
|||
|
|
<p>Each of these functions can be affected by the presence of a <span><i>restart</i></span> having the same name.</p>
|
|||
|
|
<p><strong>abort, continue, muffle-warning, store-value, use-value</strong></p>
|
|||
|
|
<p><strong>Exceptional Situations:</strong></p>
|
|||
|
|
<p>If an appropriate <strong>abort</strong> <span><i>restart</i></span> is not available for the <span><i>function</i></span> <strong>abort</strong>, or an appropriate <strong>muffle-warning</strong> <span><i>restart</i></span> is not available for the <span><i>function</i></span> <strong>muffle-warning</strong>, an error of <span><i>type</i></span> <span><b>control-error</b></span> is signaled.</p>
|
|||
|
|
<p><strong>See Also:</strong></p>
|
|||
|
|
<p><span><b>invoke-restart</b></span>, Section 9.1.4.2 (Restarts), Section 9.1.4.2.2 (Interfaces to Restarts), <span><b>assert</b></span>, <span><b>ccase</b></span>, <span><b>cerror</b></span>, <span><b>check-type</b></span>, <span><b>ctypecase</b></span>, <strong>use-value</strong>, <span><b>warn</b></span></p>
|
|||
|
|
<p><strong>Notes:</strong></p>
|
|||
|
|
<p>(abort condition) <em>≡</em> (invoke-restart ’abort)</p>
|
|||
|
|
<p>(muffle-warning) <em>≡</em> (invoke-restart ’muffle-warning)</p>
|
|||
|
|
<p>(continue) <em>≡</em> (let ((r (find-restart ’continue))) (if r (invoke-restart r))) (use-value <em>x</em>) <em>≡</em> (let ((r (find-restart ’use-value))) (if r (invoke-restart r <em>x</em>))) (store-value x) <em>≡</em> (let ((r (find-restart ’store-value))) (if r (invoke-restart r <em>x</em>)))</p>
|
|||
|
|
<p>No functions defined in this specification are required to provide a <strong>use-value</strong> <span><i>restart</i></span>.</p>
|
|||
|
|
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="expanded-reference-with-simple-restart">Expanded Reference: with-simple-restart<a href="with-simple-restart_macro.html#expanded-reference-with-simple-restart" class="hash-link" aria-label="Direct link to Expanded Reference: with-simple-restart" title="Direct link to Expanded Reference: with-simple-restart"></a></h2>
|
|||
|
|
<div class="theme-admonition theme-admonition-tip admonition_xJq3 alert alert--success"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span>tip</div><div class="admonitionContent_BuS1"><p>TODO: Please contribute to this page by adding explanations and examples</p></div></div>
|
|||
|
|
<div class="language-lisp codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-lisp codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">(</span><span class="token car">with-simple-restart</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">)</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/lisp-docs/cl-language-reference/tree/main/docs/chap-9/j-c-dictionary/with-simple-restart_macro.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"><span class="theme-last-updated">Last updated<!-- --> by <b>daninus14</b></span></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="with-condition-restarts_macro.html"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">with-condition-restarts</div></a><a class="pagination-nav__link pagination-nav__link--next" href="../../chap-10/ba-b-symbol-concepts.html"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">10.1 Symbol Concepts</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="with-simple-restart_macro.html#expanded-reference-with-simple-restart" class="table-of-contents__link toc-highlight">Expanded Reference: with-simple-restart</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a href="../../../docs/tutorial.html" target="_blank" rel="noopener noreferrer" class="footer__link-item">Common Lisp Tutorial</a></li><li class="footer__item"><a href="../../index.html" target="_blank" rel="noopener noreferrer" class="footer__link-item">Common Lisp Technical Reference</a></li><li class="footer__item"><a href="../../../docs/help.html" target="_blank" rel="noopener noreferrer" class="footer__link-item">Help</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/common-lisp" target="_blank" rel="noopener noreferrer" class="footer__link-item">Stack Overflow<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><
|
|||
|
|
</body>
|
|||
|
|
</html>
|