41 lines
23 KiB
HTML
41 lines
23 KiB
HTML
|
<!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"/><meta name="viewport" content="width=device-width, initial-scale=0.8"/><title>12.10 Serializing Syntax</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="../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">The Racket Reference</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" clas
|
||
|
|
with <span class="RktSym"><a href="fasl.html#%28def._%28%28lib._racket%2Ffasl..rkt%29._s-exp-~3efasl%29%29" class="RktValLink" data-pltdoc="x">s-exp->fasl</a></span> or <span class="RktSym"><a href="serialization.html#%28def._%28%28lib._racket%2Fprivate%2Fserialize..rkt%29._serialize%29%29" class="RktValLink" data-pltdoc="x">serialize</a></span>. Although <span class="RktVar">stx</span>
|
||
|
|
could be serialized with <span class="RktPn">(</span><span class="RktSym"><a href="eval.html#%28def._%28%28quote._~23~25kernel%29._compile%29%29" class="RktValLink" data-pltdoc="x">compile</a></span><span class="stt"> </span><span class="RktVal">`</span><span class="RktVal">(</span><span class="RktVal">quote-syntax</span><span class="stt"> </span><span class="RktRdr">,</span><span class="RktVar">stx</span><span class="RktVal">)</span><span class="RktPn">)</span> and
|
||
|
|
then writing the compiled form, <span class="RktSym"><a href="Serializing_Syntax.html#%28def._%28%28lib._racket%2Fprivate%2Fbase..rkt%29._syntax-serialize%29%29" class="RktValLink" data-pltdoc="x">syntax-serialize</a></span> provides
|
||
|
|
more control over serialization:</div></p><ul><li><p>The <span class="RktVar">preserve-property-keys</span> lists syntax-property keys
|
||
|
|
to whose values should be preserved in serialization, even if
|
||
|
|
the property value was not added as preserved with
|
||
|
|
<span class="RktSym"><a href="stxprops.html#%28def._%28%28quote._~23~25kernel%29._syntax-property%29%29" class="RktValLink" data-pltdoc="x">syntax-property</a></span> (so it would be discarded in compiled
|
||
|
|
form). The values associated with the properties to preserve
|
||
|
|
must be serializable in the sense required by
|
||
|
|
<span class="RktSym"><a href="stxprops.html#%28def._%28%28quote._~23~25kernel%29._syntax-property%29%29" class="RktValLink" data-pltdoc="x">syntax-property</a></span> for a preserved property.</p></li><li><p>The <span class="RktVar">provides-namespace</span> argument constrains how much
|
||
|
|
the serialized syntax object can rely on <a name="(tech._bulk._binding)"></a><span style="font-style: italic">bulk
|
||
|
|
bindings</span>, which are shared binding tables provided by
|
||
|
|
exporting modules. If <span class="RktVar">provides-namespace</span> is
|
||
|
|
<span class="RktVal">#f</span>, then complete binding information is recorded in
|
||
|
|
the syntax object’s serialized form, and no bulk bindings will
|
||
|
|
be needed from the namespace at deserialization. Otherwise,
|
||
|
|
bulk bindings will be used only for modules declared in
|
||
|
|
<span class="RktVar">provides-namespace</span> (i.e., the deserialize-time
|
||
|
|
namespace will have the same module declarations as
|
||
|
|
<span class="RktVar">provides-namespace</span>); note that supplying a namespace
|
||
|
|
with no module bindings is equivalent to supplying
|
||
|
|
<span class="RktVal">#f</span>.</p></li><li><p>The <span class="RktVar">base-module-path-index</span> argument specifies a
|
||
|
|
<a href="Module_Names_and_Loading.html#%28tech._module._path._index%29" class="techoutside" data-pltdoc="x"><span class="techinside">module path index</span></a> to which binding information in
|
||
|
|
<span class="RktVar">stx</span> is relative. For example, if a syntax object
|
||
|
|
originates from <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> in the body of a module,
|
||
|
|
then <span class="RktVar">base-module-path-index</span> could usefully be the
|
||
|
|
enclosing module’s module path index as produced by
|
||
|
|
<span class="RktPn">(</span><span class="RktSym"><a href="Namespaces.html#%28def._%28%28quote._~23~25kernel%29._variable-reference-~3emodule-path-index%29%29" class="RktValLink" data-pltdoc="x">variable-reference->module-path-index</a></span><span class="stt"> </span><span class="RktPn">(</span><span class="RktSym"><a href="Locations____variable-reference.html#%28form._%28%28quote._~23~25kernel%29._~23~25variable-reference%29%29" class="RktStxLink" data-pltdoc="x">#%variable-reference</a></span><span class="RktPn">)</span><span class="RktPn">)</span> within the module. On deserialization,
|
||
|
|
a different module path index can be supplied to substitute in
|
||
|
|
place of <span class="RktVar">base-module-path-index</span>, which shifts any
|
||
|
|
binding that is relative to the serialize-time module’s
|
||
|
|
identity to be relative to the module identity supplied at
|
||
|
|
deserialize time. If <span class="RktVar">base-module-path-index</span> is
|
||
|
|
<span class="RktVal">#f</span>, then no shifting is supported at deserialize time,
|
||
|
|
and any <span class="RktVar">base-module-path-index</span> supplied at that time
|
||
|
|
is ignored.</p></li></ul><p>A serialized syntax object is otherwise similar to compiled code: it
|
||
|
|
is version-specific, and deserialization will require a sufficiently
|
||
|
|
powerful <a href="modprotect.html#%28tech._code._inspector%29" class="techoutside" data-pltdoc="x"><span class="techinside">code inspector</span></a>.</p><p class="SHistory">Added in version 8.0.0.13 of package <span class="stt">base</span>.</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><table cellspacing="0" cellpadding="0" class="prototype RForeground"><tr><td valign="top" colspan="3"><span class="RktPn">(</span><a name="(def._((lib._racket/private/base..rkt)._syntax-deserialize))"></a><span title="Provided from: racket/base, racket | Package: base"><span class="RktSym"><a href="Serializing_Syntax.html#%28def._%28%28lib._racket%2Fprivate%2Fbase..rkt%29._syntax-deserialize%29%29" class="RktValDef RktValLink" data-pltdoc="x">syntax-deserialize</a></span></span></td><td valign="top"><span class="hspace"> </span></td></tr><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="RktVar">v</span></td><td valign="top"><span class="hspace"> </span></td></tr><tr><td valign="top"><span class="hspace"> </span></td><td valign="top"><span class="hspace"> </span><span class="RktOpt">[</span></td><td valign="top"><span class="RktPn">#:base-module-path-index</span><span class="hspace"> </span><span class="RktVar">base-module-path-index</span><span class="RktOpt">]</span><span class="RktPn">)</span></td><td valign="top"><span class="hspace"> </span></td></tr></table></blockquote></td></tr><tr><td><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">v</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></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">base-module-path-index</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="Module_Names_and_Loading.html#%28def._%28%28quote._~23~25kernel%29._module-path-index~3f%29%29" class="RktValLink" data-pltdoc="x">module-path-index?</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></table></blockquote></div><div class="SIntrapara">Converts the result of <span class="RktSym"><a href="Serializing_Syntax.html#%28def._%28%28lib._racket%2Fprivate%2Fbase..rkt%29._syntax-serialize%29%29" class="RktValLink" data-pltdoc="x">syntax-serialize</a></span> back to a syntax
|
||
|
|
object. See <span class="RktSym"><a href="Serializing_Syntax.html#%28def._%28%28lib._racket%2Fprivate%2Fbase..rkt%29._syntax-serialize%29%29" class="RktValLink" data-pltdoc="x">syntax-serialize</a></span> for more information.</div></p><p class="SHistory">Added in version 8.0.0.13 of package <span class="stt">base</span>.</p><div class="navsetbottom"><span class="navleft"><form class="searchform"><input class="searchbox" id="searchbox" type="text" tabindex="1" placeholder="...search manuals..." title="Enter a search string to search the manuals" onkeypress="return DoSearchKey(event, this, "8.6", "../");"/></form> <a href="https://docs.racket-lang.org/index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("8.6");">top</a><span class="tocsettoggle"> <a href="javascript:void(0);" title="show/hide table of contents" onclick="TocsetToggle();">contents</a></span></span><span class="navright"> <a href="Expanding_Top-Level_Forms.html" title="backward to "12.9 Expanding Top-Level Forms"" data-pltdoc="x">← prev</a> <a href="Macros.html" title="up to "12 Macros"" data-pltdoc="x">up</a> <a href="include.html" title="forward to "12.11 File Inclusion"" data-pltdoc="x">next →</a></span> </div></div></div><div id="contextindicator"> </div></body></html>
|