/usr/share/doc/racket/reference/stxcerts.html is in racket-doc 6.1-4.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"/><title>12.8 Syntax Taints</title><link rel="stylesheet" type="text/css" href="../scribble.css" title="default"/><link rel="stylesheet" type="text/css" href="extras.css" title="default"/><link rel="stylesheet" type="text/css" href="icons.css" title="default"/><link rel="stylesheet" type="text/css" href="../racket.css" title="default"/><link rel="stylesheet" type="text/css" href="../manual-style.css" title="default"/><link rel="stylesheet" type="text/css" href="../manual-racket.css" title="default"/><link rel="stylesheet" type="text/css" href="../manual-racket.css" title="default"/><link rel="stylesheet" type="text/css" href="../doc-site.css" title="default"/><script type="text/javascript" src="../scribble-common.js"></script><script type="text/javascript" src="../manual-racket.js"></script><script type="text/javascript" src="../manual-racket.js"></script><script type="text/javascript" src="../doc-site.js"></script><script type="text/javascript" src="../local-redirect/local-redirect.js"></script><script type="text/javascript" src="../local-redirect/local-user-redirect.js"></script><!--[if IE 6]><style type="text/css">.SIEHidden { overflow: hidden; }</style><![endif]--></head><body id="doc-racket-lang-org"><div class="tocset"><div class="tocview"><div class="tocviewlist tocviewlisttopspace"><div class="tocviewtitle"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,"tocview_0");">►</a></td><td></td><td><a href="index.html" class="tocviewlink" data-pltdoc="x"><span style="font-weight: bold">The Racket Reference</span></a></td></tr></table></div><div class="tocviewsublisttop" style="display: none;" id="tocview_0"><table cellspacing="0" cellpadding="0"><tr><td align="right">1 </td><td><a href="model.html" class="tocviewlink" data-pltdoc="x">Language Model</a></td></tr><tr><td align="right">2 </td><td><a href="notation.html" class="tocviewlink" data-pltdoc="x">Notation for Documentation</a></td></tr><tr><td align="right">3 </td><td><a href="syntax.html" class="tocviewlink" data-pltdoc="x">Syntactic Forms</a></td></tr><tr><td align="right">4 </td><td><a href="data.html" class="tocviewlink" data-pltdoc="x">Datatypes</a></td></tr><tr><td align="right">5 </td><td><a href="structures.html" class="tocviewlink" data-pltdoc="x">Structures</a></td></tr><tr><td align="right">6 </td><td><a href="mzlib_class.html" class="tocviewlink" data-pltdoc="x">Classes and Objects</a></td></tr><tr><td align="right">7 </td><td><a href="mzlib_unit.html" class="tocviewlink" data-pltdoc="x">Units</a></td></tr><tr><td align="right">8 </td><td><a href="contracts.html" class="tocviewlink" data-pltdoc="x">Contracts</a></td></tr><tr><td align="right">9 </td><td><a href="match.html" class="tocviewlink" data-pltdoc="x">Pattern Matching</a></td></tr><tr><td align="right">10 </td><td><a href="control.html" class="tocviewlink" data-pltdoc="x">Control Flow</a></td></tr><tr><td align="right">11 </td><td><a href="concurrency.html" class="tocviewlink" data-pltdoc="x">Concurrency and Parallelism</a></td></tr><tr><td align="right">12 </td><td><a href="Macros.html" class="tocviewselflink" data-pltdoc="x">Macros</a></td></tr><tr><td align="right">13 </td><td><a href="input-and-output.html" class="tocviewlink" data-pltdoc="x">Input and Output</a></td></tr><tr><td align="right">14 </td><td><a href="security.html" class="tocviewlink" data-pltdoc="x">Reflection and Security</a></td></tr><tr><td align="right">15 </td><td><a href="os.html" class="tocviewlink" data-pltdoc="x">Operating System</a></td></tr><tr><td align="right">16 </td><td><a href="memory.html" class="tocviewlink" data-pltdoc="x">Memory Management</a></td></tr><tr><td align="right">17 </td><td><a href="unsafe.html" class="tocviewlink" data-pltdoc="x">Unsafe Operations</a></td></tr><tr><td align="right">18 </td><td><a href="running.html" class="tocviewlink" data-pltdoc="x">Running Racket</a></td></tr><tr><td align="right"></td><td><a href="doc-bibliography.html" class="tocviewlink" data-pltdoc="x">Bibliography</a></td></tr><tr><td align="right"></td><td><a href="doc-index.html" class="tocviewlink" data-pltdoc="x">Index</a></td></tr></table></div></div><div class="tocviewlist"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,"tocview_1");">▼</a></td><td>12 </td><td><a href="Macros.html" class="tocviewlink" data-pltdoc="x">Macros</a></td></tr></table><div class="tocviewsublistbottom" style="display: block;" id="tocview_1"><table cellspacing="0" cellpadding="0"><tr><td align="right">12.1 </td><td><a href="stx-patterns.html" class="tocviewlink" data-pltdoc="x">Pattern-<wbr></wbr>Based Syntax Matching</a></td></tr><tr><td align="right">12.2 </td><td><a href="stxops.html" class="tocviewlink" data-pltdoc="x">Syntax Object Content</a></td></tr><tr><td align="right">12.3 </td><td><a href="stxcmp.html" class="tocviewlink" data-pltdoc="x">Syntax Object Bindings</a></td></tr><tr><td align="right">12.4 </td><td><a href="stxtrans.html" class="tocviewlink" data-pltdoc="x">Syntax Transformers</a></td></tr><tr><td align="right">12.5 </td><td><a href="stxparam.html" class="tocviewlink" data-pltdoc="x">Syntax Parameters</a></td></tr><tr><td align="right">12.6 </td><td><a href="splicing.html" class="tocviewlink" data-pltdoc="x">Local Binding with Splicing Body</a></td></tr><tr><td align="right">12.7 </td><td><a href="stxprops.html" class="tocviewlink" data-pltdoc="x">Syntax Object Properties</a></td></tr><tr><td align="right">12.8 </td><td><a href="" class="tocviewselflink" data-pltdoc="x">Syntax Taints</a></td></tr><tr><td align="right">12.9 </td><td><a href="Expanding_Top-Level_Forms.html" class="tocviewlink" data-pltdoc="x">Expanding Top-<wbr></wbr>Level Forms</a></td></tr><tr><td align="right">12.10 </td><td><a href="include.html" class="tocviewlink" data-pltdoc="x">File Inclusion</a></td></tr><tr><td align="right">12.11 </td><td><a href="syntax-util.html" class="tocviewlink" data-pltdoc="x">Syntax Utilities</a></td></tr></table></div></div></div><div class="tocsub"><div class="tocsubtitle">On this page:</div><table class="tocsublist" cellspacing="0"><tr><td><a href="#%28def._%28%28quote._~23~25kernel%29._syntax-tainted~3f%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">syntax-<wbr></wbr>tainted?</span></span></a></td></tr><tr><td><a href="#%28def._%28%28quote._~23~25kernel%29._syntax-arm%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">syntax-<wbr></wbr>arm</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._racket%2Fprivate%2Fstxcase-scheme..rkt%29._syntax-protect%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">syntax-<wbr></wbr>protect</span></span></a></td></tr><tr><td><a href="#%28def._%28%28quote._~23~25kernel%29._syntax-disarm%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">syntax-<wbr></wbr>disarm</span></span></a></td></tr><tr><td><a href="#%28def._%28%28quote._~23~25kernel%29._syntax-rearm%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">syntax-<wbr></wbr>rearm</span></span></a></td></tr><tr><td><a href="#%28def._%28%28quote._~23~25kernel%29._syntax-taint%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">syntax-<wbr></wbr>taint</span></span></a></td></tr></table></div></div><div class="maincolumn"><div class="main"><div class="navsettop"><span class="navleft"><form class="searchform"><input class="searchbox" style="color: #888;" type="text" value="...search manuals..." title="Enter a search string to search the manuals" onkeypress="return DoSearchKey(event, this, "6.1", "../");" onfocus="this.style.color="black"; this.style.textAlign="left"; if (this.value == "...search manuals...") this.value="";" onblur="if (this.value.match(/^ *$/)) { this.style.color="#888"; this.style.textAlign="center"; this.value="...search manuals..."; }"/></form> <a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("6.1");">top</a></span><span class="navright"> <a href="stxprops.html" title="backward to "12.7 Syntax Object Properties"" data-pltdoc="x">← prev</a> <a href="Macros.html" title="up to "12 Macros"" data-pltdoc="x">up</a> <a href="Expanding_Top-Level_Forms.html" title="forward to "12.9 Expanding Top-Level Forms"" data-pltdoc="x">next →</a></span> </div><h4 x-source-module="(lib "scribblings/reference/reference.scrbl")" x-part-tag=""stxcerts"">12.8<tt> </tt><a name="(part._stxcerts)"></a>Syntax Taints</h4><blockquote class="refpara"><blockquote class="refcolumn"><blockquote class="refcontent"><p><span class="imageleft"><img src="finger.png" alt="+" width="24" height="24"/></span><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=guide&rel=stx-certs.html&version=6.1" class="Sq" data-pltdoc="x">Syntax Taints</a> in <a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=guide&rel=index.html&version=6.1" class="Sq" data-pltdoc="x"><span style="font-weight: bold">The Racket Guide</span></a> introduces syntax taints.</p></blockquote></blockquote></blockquote><p>The <a name="(tech._tamper._statu)"></a><span style="font-style: italic">tamper status</span> of a syntax object is either
<a href="#%28tech._tainted%29" class="techoutside" data-pltdoc="x"><span class="techinside">tainted</span></a>, <a href="#%28tech._armed%29" class="techoutside" data-pltdoc="x"><span class="techinside">armed</span></a>, or clean:</p><ul><li><p>A <a name="(tech._tainted)"></a><span style="font-style: italic">tainted</span> identifier is rejected by the macro expander
for use as either a binding or expression. If a syntax object
is <a href="#%28tech._tainted%29" class="techoutside" data-pltdoc="x"><span class="techinside">tainted</span></a>, then any syntax object in the result of
<span class="RktPn">(</span><span class="RktSym"><a href="stxops.html#%28def._%28%28quote._~23~25kernel%29._syntax-e%29%29" class="RktValLink" data-pltdoc="x">syntax-e</a></span><span class="stt"> </span><span class="RktVar">stx</span><span class="RktPn">)</span> is <a href="#%28tech._tainted%29" class="techoutside" data-pltdoc="x"><span class="techinside">tainted</span></a>, and
<span class="RktSym"><a href="stxops.html#%28def._%28%28quote._~23~25kernel%29._datum-~3esyntax%29%29" class="RktValLink" data-pltdoc="x">datum->syntax</a></span> with <span class="RktVar">stx</span> as its first argument
produces a <a href="#%28tech._tainted%29" class="techoutside" data-pltdoc="x"><span class="techinside">tainted</span></a> syntax object.</p><p>Other derived operations, such as pattern matching in
<span class="RktSym"><a href="stx-patterns.html#%28form._%28%28lib._racket%2Fprivate%2Fstxcase-scheme..rkt%29._syntax-case%29%29" class="RktStxLink" data-pltdoc="x">syntax-case</a></span>, also taint syntax objects when extracting
them from a <a href="#%28tech._tainted%29" class="techoutside" data-pltdoc="x"><span class="techinside">tainted</span></a> syntax object.</p></li><li><p>An <a name="(tech._armed)"></a><span style="font-style: italic">armed</span> syntax object has a set of <a name="(tech._dye._pack)"></a><span style="font-style: italic">dye packs</span>,
which creates taints if the armed syntax object is used without
first <a href="#%28tech._disarm%29" class="techoutside" data-pltdoc="x"><span class="techinside">disarm</span></a>ing the dye packs. In particular, if a
syntax object is <a href="#%28tech._armed%29" class="techoutside" data-pltdoc="x"><span class="techinside">armed</span></a>, <span class="RktSym"><a href="stxops.html#%28def._%28%28quote._~23~25kernel%29._syntax-e%29%29" class="RktValLink" data-pltdoc="x">syntax-e</a></span>,
<span class="RktSym"><a href="stxops.html#%28def._%28%28quote._~23~25kernel%29._datum-~3esyntax%29%29" class="RktValLink" data-pltdoc="x">datum->syntax</a></span>, <span class="RktSym"><a href="Syntax_Quoting__quote-syntax.html#%28form._%28%28quote._~23~25kernel%29._quote-syntax%29%29" class="RktStxLink" data-pltdoc="x">quote-syntax</a></span>, and derived
operations effectively treat the syntax object as
<a href="#%28tech._tainted%29" class="techoutside" data-pltdoc="x"><span class="techinside">tainted</span></a>. The macro expander, in contrast,
<a href="#%28tech._disarm%29" class="techoutside" data-pltdoc="x"><span class="techinside">disarms</span></a> dye packs before pulling apart syntax
objects.</p><p>Each <a href="#%28tech._dye._pack%29" class="techoutside" data-pltdoc="x"><span class="techinside">dye pack</span></a>, which is added to a syntax object with
the <span class="RktSym"><a href="#%28def._%28%28quote._~23~25kernel%29._syntax-arm%29%29" class="RktValLink" data-pltdoc="x">syntax-arm</a></span> function, is keyed by an
<a href="inspectors.html#%28tech._inspector%29" class="techoutside" data-pltdoc="x"><span class="techinside">inspector</span></a>. A dye pack can be <a name="(tech._disarm)"></a><span style="font-style: italic">disarm</span>ed using
<span class="RktSym"><a href="#%28def._%28%28quote._~23~25kernel%29._syntax-disarm%29%29" class="RktValLink" data-pltdoc="x">syntax-disarm</a></span> with an inspector that is the same as or
a superior of the dye pack’s inspector.</p></li><li><p>A <span style="font-style: italic">clean</span> syntax object has no immediate taints or dye
packs, although it may contain syntax objects that are
<a href="#%28tech._tainted%29" class="techoutside" data-pltdoc="x"><span class="techinside">tainted</span></a> or <a href="#%28tech._armed%29" class="techoutside" data-pltdoc="x"><span class="techinside">armed</span></a>.</p></li></ul><p>Taints cannot be removed, and attempting to arm a syntax object that
is already tainted has no effect on the resulting syntax object.</p><p>The macro expander <a href="#%28tech._disarm%29" class="techoutside" data-pltdoc="x"><span class="techinside">disarm</span></a>s any syntax object that it encounters
in an expression position or as a module body. A syntax object is
therefore disarmed when it is provided to a <a href="syntax-model.html#%28tech._syntax._transformer%29" class="techoutside" data-pltdoc="x"><span class="techinside">syntax
transformer</span></a>. The transformer’s result, however, is <a name="(tech._rearm)"></a><span style="font-style: italic">rearm</span>ed
by copying to it any <a href="#%28tech._dye._pack%29" class="techoutside" data-pltdoc="x"><span class="techinside">dye packs</span></a> that were originally attached to
the transformer’s input. The <a href="#%28tech._rearm%29" class="techoutside" data-pltdoc="x"><span class="techinside">rearm</span></a>ing process
<a name="(elem._(explain._taint-mode))"></a>obeys the following rules:</p><ul><li><p>If the result has a <a name="(idx._(gentag._190._(lib._scribblings/reference/reference..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">taint-mode</span> property (see
<a href="stxprops.html" data-pltdoc="x">Syntax Object Properties</a>) that is <a name="(idx._(gentag._191._(lib._scribblings/reference/reference..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">opaque</span>, then
dye packs are attached to the immediate syntax object.</p></li><li><p>If the result has a <a name="(idx._(gentag._192._(lib._scribblings/reference/reference..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">taint-mode</span> property that
is <a name="(idx._(gentag._193._(lib._scribblings/reference/reference..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">none</span>, then no dye pack is attached to
the syntax object. The <span class="RktVal">'</span><span class="RktVal">none</span> mode is rarely
appropriate.</p></li><li><p>If the result has a <span class="RktVal">'</span><span class="RktVal">taint-mode</span> property that is
<a name="(idx._(gentag._194._(lib._scribblings/reference/reference..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">transparent</span>, then the dye packs are
propagated recursively to syntax object that corresponds to
elements of the syntax object’s datum as a list (or, more
precisely, to the <span class="RktSym"><a href="pairs.html#%28def._%28%28quote._~23~25kernel%29._car%29%29" class="RktValLink" data-pltdoc="x">car</a></span>s of the datum as reached by
any number of <span class="RktSym"><a href="pairs.html#%28def._%28%28quote._~23~25kernel%29._cdr%29%29" class="RktValLink" data-pltdoc="x">cdr</a></span>s), and the immediate syntax
object loses its lexical context; If the immediate syntax
object is already <a href="#%28tech._armed%29" class="techoutside" data-pltdoc="x"><span class="techinside">armed</span></a>, then recursive propagation
taints the elements. Recursive propagation uses syntax
properties and shapes, as for the immediate
<a href="#%28tech._rearm%29" class="techoutside" data-pltdoc="x"><span class="techinside">rearm</span></a>ing.</p></li><li><p>If the result has a <span class="RktVal">'</span><span class="RktVal">taint-mode</span> property that is
<a name="(idx._(gentag._195._(lib._scribblings/reference/reference..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">transparent-binding</span>, then dye packs are
attached in a way similar to <span class="RktVal">'</span><span class="RktVal">transparent</span>, but
further treating the syntax object corresponding to the
second list element as having a <span class="RktVal">'</span><span class="RktVal">transparent</span> value
for the <span class="RktVal">'</span><span class="RktVal">taint-mode</span> property if it does not already
have a <span class="RktVal">'</span><span class="RktVal">taint-mode</span> property value.</p></li><li><p>If the result has no <span class="RktVal">'</span><span class="RktVal">taint-mode</span> property value, but
its datum is a pair, and if the syntax object corresponding
to the <span class="RktSym"><a href="pairs.html#%28def._%28%28quote._~23~25kernel%29._car%29%29" class="RktValLink" data-pltdoc="x">car</a></span> of the pair is an identifier bound to
<span class="RktSym"><a href="begin.html#%28form._%28%28quote._~23~25kernel%29._begin%29%29" class="RktStxLink" data-pltdoc="x">begin</a></span>, <span class="RktSym"><a href="module.html#%28form._%28%28quote._~23~25kernel%29._module%29%29" class="RktStxLink" data-pltdoc="x">module</a></span>, or
<span class="RktSym"><a href="module.html#%28form._%28%28lib._racket%2Fprivate%2Fbase..rkt%29._~23~25plain-module-begin%29%29" class="RktStxLink" data-pltdoc="x">#%plain-module-begin</a></span>, then dye packs are propagated
as if the syntax object had the <span class="RktVal">'</span><span class="RktVal">transparent</span>
property value.</p></li><li><p>If the result has no <span class="RktVal">'</span><span class="RktVal">taint-mode</span> property value, but
its datum is a pair, and if the syntax object corresponding
to the <span class="RktSym"><a href="pairs.html#%28def._%28%28quote._~23~25kernel%29._car%29%29" class="RktValLink" data-pltdoc="x">car</a></span> of the pair is an identifier bound to
<span class="RktSym"><a href="define.html#%28form._%28%28quote._~23~25kernel%29._define-values%29%29" class="RktStxLink" data-pltdoc="x">define-values</a></span> or <span class="RktSym"><a href="define.html#%28form._%28%28quote._~23~25kernel%29._define-syntaxes%29%29" class="RktStxLink" data-pltdoc="x">define-syntaxes</a></span>, then dye
packs are propagated as if the syntax object had the
<span class="RktVal">'</span><span class="RktVal">transparent-binding</span> property value.</p></li></ul><p>For backward compatibility, a <a name="(idx._(gentag._196._(lib._scribblings/reference/reference..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">certify-mode</span> property
is treated the same as a <span class="RktVal">'</span><span class="RktVal">taint-mode</span> property if the former
is not attached. To avoid accidental transfer of a
<span class="RktVal">'</span><span class="RktVal">taint-mode</span> or <span class="RktVal">'</span><span class="RktVal">certify-mode</span> property value, the
expander always removes any <span class="RktVal">'</span><span class="RktVal">taint-mode</span> and
<span class="RktVal">'</span><span class="RktVal">certify-mode</span> property on a syntax object that is passed to a
<a href="syntax-model.html#%28tech._syntax._transformer%29" class="techoutside" data-pltdoc="x"><span class="techinside">syntax transformer</span></a>.</p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((quote._~23~25kernel)._syntax-tainted~3f))"></a><span title="Provided from: racket/base, racket | Package: base"><span class="RktSym"><a href="#%28def._%28%28quote._~23~25kernel%29._syntax-tainted~3f%29%29" class="RktValDef RktValLink" data-pltdoc="x">syntax-tainted?</a></span></span><span class="hspace"> </span><span class="RktVar">stx</span><span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktSym"><a href="booleans.html#%28def._%28%28quote._~23~25kernel%29._boolean~3f%29%29" class="RktValLink" data-pltdoc="x">boolean?</a></span></p></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">stx</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="stxops.html#%28def._%28%28quote._~23~25kernel%29._syntax~3f%29%29" class="RktValLink" data-pltdoc="x">syntax?</a></span></td></tr></table></blockquote></div><div class="SIntrapara">Returns <span class="RktVal">#t</span> if <span class="RktVar">stx</span> is <a href="#%28tech._tainted%29" class="techoutside" data-pltdoc="x"><span class="techinside">tainted</span></a>, <span class="RktVal">#f</span>
otherwise.</div></p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((quote._~23~25kernel)._syntax-arm))"></a><span title="Provided from: racket/base, racket | Package: base"><span class="RktSym"><a href="#%28def._%28%28quote._~23~25kernel%29._syntax-arm%29%29" class="RktValDef RktValLink" data-pltdoc="x">syntax-arm</a></span></span><span class="hspace"> </span><span class="RktVar">stx</span><span class="hspace"> </span>[<span class="RktVar">inspector</span><span class="hspace"> </span><span class="RktVar">use-mode?</span>]<span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktSym"><a href="stxops.html#%28def._%28%28quote._~23~25kernel%29._syntax~3f%29%29" class="RktValLink" data-pltdoc="x">syntax?</a></span></p></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">stx</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="stxops.html#%28def._%28%28quote._~23~25kernel%29._syntax~3f%29%29" class="RktValLink" data-pltdoc="x">syntax?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">inspector</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="data-structure-contracts.html#%28def._%28%28lib._racket%2Fcontract%2Fbase..rkt%29._or%2Fc%29%29" class="RktValLink" data-pltdoc="x">or/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="inspectors.html#%28def._%28%28quote._~23~25kernel%29._inspector~3f%29%29" class="RktValLink" data-pltdoc="x">inspector?</a></span><span class="hspace"> </span><span class="RktVal">#f</span><span class="RktPn">)</span><span class="hspace"> </span>=<span class="hspace"> </span><span class="RktVal">#f</span></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">use-mode?</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="data-structure-contracts.html#%28def._%28%28lib._racket%2Fcontract%2Fprivate%2Fmisc..rkt%29._any%2Fc%29%29" class="RktValLink" data-pltdoc="x">any/c</a></span><span class="hspace"> </span>=<span class="hspace"> </span><span class="RktVal">#f</span></td></tr></table></blockquote></div><div class="SIntrapara">Produces a syntax object like <span class="RktVar">stx</span>, but <a href="#%28tech._armed%29" class="techoutside" data-pltdoc="x"><span class="techinside">armed</span></a> with a
<a href="#%28tech._dye._pack%29" class="techoutside" data-pltdoc="x"><span class="techinside">dye pack</span></a> that is keyed by <span class="RktVar">inspector</span>.</div></p><p>A <span class="RktVal">#f</span> value for <span class="RktVar">inspector</span> is equivalent to an
inspector that depends on the current dynamic context:</p><ul><li><p>when applying a syntax transformer is being applied, the
declaration-time code inspector of the module in which a syntax
transformer was bound;</p></li><li><p>when a module is being visited, the module’s declaration-time
code inspector;</p></li><li><p><span class="RktPn">(</span><span class="RktSym"><a href="modprotect.html#%28def._%28%28quote._~23~25kernel%29._current-code-inspector%29%29" class="RktValLink" data-pltdoc="x">current-code-inspector</a></span><span class="RktPn">)</span>, otherwise.</p></li></ul><p>If <span class="RktVar">use-mode?</span> is <span class="RktVal">#f</span>, then if <span class="RktVar">stx</span> is
<a href="#%28tech._tainted%29" class="techoutside" data-pltdoc="x"><span class="techinside">tainted</span></a> or already armed with the key <span class="RktVar">inspector</span>, the
result is <span class="RktVar">stx</span>.</p><p>If <span class="RktVar">use-mode?</span> is a true value, then a <a href="#%28tech._dye._pack%29" class="techoutside" data-pltdoc="x"><span class="techinside">dye pack</span></a> is
not necessarily added directly to <span class="RktVar">stx</span>. Instead, the <a href="#%28tech._dye._pack%29" class="techoutside" data-pltdoc="x"><span class="techinside">dye pack</span></a>
is pushed to interior syntax objects in the same way that the
expander pushes armings into a syntax transformer’s results when
<a href="#%28tech._rearm%29" class="techoutside" data-pltdoc="x"><span class="techinside">rearm</span></a>ing (based on a <span class="RktVal">'</span><span class="RktVal">taint-mode</span> <a href="stxprops.html#%28tech._syntax._property%29" class="techoutside" data-pltdoc="x"><span class="techinside">syntax
property</span></a> or identifier bindings); see <a href="#%28elem._%28explain._taint-mode%29%29" data-pltdoc="x">the expander’s rearming rules</a> for more information. To
the degree that pushing dye packs into a syntax object must destructure
<span class="RktVar">stx</span>, existing taints or dye packs can lead to <a href="#%28tech._tainted%29" class="techoutside" data-pltdoc="x"><span class="techinside">tainted</span></a>
results rather than <a href="#%28tech._armed%29" class="techoutside" data-pltdoc="x"><span class="techinside">armed</span></a> results.</p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((lib._racket/private/stxcase-scheme..rkt)._syntax-protect))"></a><span title="Provided from: racket/base, racket | Package: base"><span class="RktSym"><a href="#%28def._%28%28lib._racket%2Fprivate%2Fstxcase-scheme..rkt%29._syntax-protect%29%29" class="RktValDef RktValLink" data-pltdoc="x">syntax-protect</a></span></span><span class="hspace"> </span><span class="RktVar">stx</span><span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktSym"><a href="stxops.html#%28def._%28%28quote._~23~25kernel%29._syntax~3f%29%29" class="RktValLink" data-pltdoc="x">syntax?</a></span></p></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">stx</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="stxops.html#%28def._%28%28quote._~23~25kernel%29._syntax~3f%29%29" class="RktValLink" data-pltdoc="x">syntax?</a></span></td></tr></table></blockquote></div><div class="SIntrapara">Equivalent to <span class="RktPn">(</span><span class="RktSym"><a href="#%28def._%28%28quote._~23~25kernel%29._syntax-arm%29%29" class="RktValLink" data-pltdoc="x">syntax-arm</a></span><span class="stt"> </span><span class="RktVar">stx</span><span class="stt"> </span><span class="RktVal">#f</span><span class="stt"> </span><span class="RktVal">#t</span><span class="RktPn">)</span>.</div></p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((quote._~23~25kernel)._syntax-disarm))"></a><span title="Provided from: racket/base, racket | Package: base"><span class="RktSym"><a href="#%28def._%28%28quote._~23~25kernel%29._syntax-disarm%29%29" class="RktValDef RktValLink" data-pltdoc="x">syntax-disarm</a></span></span><span class="hspace"> </span><span class="RktVar">stx</span><span class="hspace"> </span><span class="RktVar">inspector</span><span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktSym"><a href="stxops.html#%28def._%28%28quote._~23~25kernel%29._syntax~3f%29%29" class="RktValLink" data-pltdoc="x">syntax?</a></span></p></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">stx</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="stxops.html#%28def._%28%28quote._~23~25kernel%29._syntax~3f%29%29" class="RktValLink" data-pltdoc="x">syntax?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">inspector</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="data-structure-contracts.html#%28def._%28%28lib._racket%2Fcontract%2Fbase..rkt%29._or%2Fc%29%29" class="RktValLink" data-pltdoc="x">or/c</a></span><span class="hspace"> </span><span class="RktSym"><a href="inspectors.html#%28def._%28%28quote._~23~25kernel%29._inspector~3f%29%29" class="RktValLink" data-pltdoc="x">inspector?</a></span><span class="hspace"> </span><span class="RktVal">#f</span><span class="RktPn">)</span></td></tr></table></blockquote></div><div class="SIntrapara">Produces a <a href="#%28tech._disarm%29" class="techoutside" data-pltdoc="x"><span class="techinside">disarm</span></a>ed version of <span class="RktVar">stx</span>, removing any
immediate <a href="#%28tech._dye._pack%29" class="techoutside" data-pltdoc="x"><span class="techinside">dye packs</span></a> that match <span class="RktVar">inspector</span>. An inspector
matches when it is either the same as or a super-inspector of the dye
pack’s inspector. A <span class="RktVal">#f</span> value for <span class="RktVar">inspector</span> is
replaced by a specific inspector in the same way as for
<span class="RktSym"><a href="#%28def._%28%28quote._~23~25kernel%29._syntax-arm%29%29" class="RktValLink" data-pltdoc="x">syntax-arm</a></span>.</div></p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((quote._~23~25kernel)._syntax-rearm))"></a><span title="Provided from: racket/base, racket | Package: base"><span class="RktSym"><a href="#%28def._%28%28quote._~23~25kernel%29._syntax-rearm%29%29" class="RktValDef RktValLink" data-pltdoc="x">syntax-rearm</a></span></span><span class="hspace"> </span><span class="RktVar">stx</span><span class="hspace"> </span><span class="RktVar">from-stx</span><span class="hspace"> </span>[<span class="RktVar">use-mode?</span>]<span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktSym"><a href="stxops.html#%28def._%28%28quote._~23~25kernel%29._syntax~3f%29%29" class="RktValLink" data-pltdoc="x">syntax?</a></span></p></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">stx</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="stxops.html#%28def._%28%28quote._~23~25kernel%29._syntax~3f%29%29" class="RktValLink" data-pltdoc="x">syntax?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">from-stx</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="stxops.html#%28def._%28%28quote._~23~25kernel%29._syntax~3f%29%29" class="RktValLink" data-pltdoc="x">syntax?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">use-mode?</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="data-structure-contracts.html#%28def._%28%28lib._racket%2Fcontract%2Fprivate%2Fmisc..rkt%29._any%2Fc%29%29" class="RktValLink" data-pltdoc="x">any/c</a></span><span class="hspace"> </span>=<span class="hspace"> </span><span class="RktVal">#f</span></td></tr></table></blockquote></div><div class="SIntrapara">Produces a <a href="#%28tech._rearm%29" class="techoutside" data-pltdoc="x"><span class="techinside">rearm</span></a>ed or <a href="#%28tech._tainted%29" class="techoutside" data-pltdoc="x"><span class="techinside">tainted</span></a> version of <span class="RktVar">stx</span> by
adding all immediate taints and <a href="#%28tech._dye._pack%29" class="techoutside" data-pltdoc="x"><span class="techinside">dye packs</span></a> of <span class="RktVar">from-stx</span>.</div></p><p>If <span class="RktVar">use-mode?</span> is a true value, <span class="RktVar">stx</span> is not necessarily
<a href="#%28tech._tainted%29" class="techoutside" data-pltdoc="x"><span class="techinside">tainted</span></a> or <a href="#%28tech._armed%29" class="techoutside" data-pltdoc="x"><span class="techinside">armed</span></a> directly. Instead, taints or <a href="#%28tech._dye._pack%29" class="techoutside" data-pltdoc="x"><span class="techinside">dye
packs</span></a> are pushed to interior syntax objects in the same way as for
<span class="RktSym"><a href="#%28def._%28%28quote._~23~25kernel%29._syntax-arm%29%29" class="RktValLink" data-pltdoc="x">syntax-arm</a></span> or <a href="#%28elem._%28explain._taint-mode%29%29" data-pltdoc="x">rearming by
the expander</a>.</p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((quote._~23~25kernel)._syntax-taint))"></a><span title="Provided from: racket/base, racket | Package: base"><span class="RktSym"><a href="#%28def._%28%28quote._~23~25kernel%29._syntax-taint%29%29" class="RktValDef RktValLink" data-pltdoc="x">syntax-taint</a></span></span><span class="hspace"> </span><span class="RktVar">stx</span><span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktSym"><a href="stxops.html#%28def._%28%28quote._~23~25kernel%29._syntax~3f%29%29" class="RktValLink" data-pltdoc="x">syntax?</a></span></p></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">stx</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="stxops.html#%28def._%28%28quote._~23~25kernel%29._syntax~3f%29%29" class="RktValLink" data-pltdoc="x">syntax?</a></span></td></tr></table></blockquote></div><div class="SIntrapara">Returns <a href="#%28tech._tainted%29" class="techoutside" data-pltdoc="x"><span class="techinside">tainted</span></a> version of <span class="RktVar">stx</span>—<wbr></wbr>equivalent to
<span class="RktPn">(</span><span class="RktSym"><a href="stxops.html#%28def._%28%28quote._~23~25kernel%29._datum-~3esyntax%29%29" class="RktValLink" data-pltdoc="x">datum->syntax</a></span><span class="stt"> </span><span class="RktPn">(</span><span class="RktSym"><a href="#%28def._%28%28quote._~23~25kernel%29._syntax-arm%29%29" class="RktValLink" data-pltdoc="x">syntax-arm</a></span><span class="stt"> </span><span class="RktVar">stx</span><span class="RktPn">)</span><span class="stt"> </span><span class="RktPn">(</span><span class="RktSym"><a href="stxops.html#%28def._%28%28quote._~23~25kernel%29._syntax-e%29%29" class="RktValLink" data-pltdoc="x">syntax-e</a></span><span class="stt"> </span><span class="RktVar">stx</span><span class="RktPn">)</span><span class="stt"> </span><span class="RktVar">stx</span><span class="stt"> </span><span class="RktVar">stx</span><span class="RktPn">)</span>—<wbr></wbr>or
<span class="RktVar">stx</span> if it is already tainted.</div></p><div class="navsetbottom"><span class="navleft"><form class="searchform"><input class="searchbox" style="color: #888;" type="text" value="...search manuals..." title="Enter a search string to search the manuals" onkeypress="return DoSearchKey(event, this, "6.1", "../");" onfocus="this.style.color="black"; this.style.textAlign="left"; if (this.value == "...search manuals...") this.value="";" onblur="if (this.value.match(/^ *$/)) { this.style.color="#888"; this.style.textAlign="center"; this.value="...search manuals..."; }"/></form> <a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("6.1");">top</a></span><span class="navright"> <a href="stxprops.html" title="backward to "12.7 Syntax Object Properties"" data-pltdoc="x">← prev</a> <a href="Macros.html" title="up to "12 Macros"" data-pltdoc="x">up</a> <a href="Expanding_Top-Level_Forms.html" title="forward to "12.9 Expanding Top-Level Forms"" data-pltdoc="x">next →</a></span> </div></div></div><div id="contextindicator"> </div></body></html>
|