48 lines
30 KiB
HTML
48 lines
30 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>17.3.5 Source-Handling Configuration</title><link rel="stylesheet" type="text/css" href="../scribble.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 Guide</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="intro.html" class="tocviewlink" data-pltdoc="x">Welcome to Racket</a></td></tr><tr><td align="right">2 </td><td><a href="to-scheme.html" class="tocviewlink" data-pltdoc="x">Racket Essentials</a></td></tr><tr><td align="right">3 </td><td><a href="datatypes.html" class="tocviewlink" data-pltdoc="x">Built-<wbr></wbr>In Datatypes</a></td></tr><tr><td align="right">4 </td><td><a href="scheme-forms.html" class="tocviewlink" data-pltdoc="x">Expressions and Definitions</a></td></tr><tr><td align="right">5 </td><td><a href="define-struct.html" class="tocviewlink" data-pltdoc="x">Programmer-<wbr></wbr>Defined Datatypes</a></td></tr><tr><td align="right">6 </td><td><a href="modules.html" class="tocviewlink" data-pltdoc="x">Modules</a></td></tr><tr><td align="right">7 </td><td><a href="contracts.html" class="tocviewlink" data-pltdoc="x">Contracts</a></td></tr><tr><td align="right">8 </td><td><a href="i_o.html" class="tocviewlink" data-pltdoc="x">Input and Output</a></td></tr><tr><td align="right">9 </td><td><a href="regexp.html" class="tocviewlink" data-pltdoc="x">Regular Expressions</a></td></tr><tr><td align="right">10 </td><td><a href="control.html" class="tocviewlink" data-pltdoc="x">Exceptions and Control</a></td></tr><tr><td align="right">11 </td><td><a href="for.html" class="tocviewlink" data-pltdoc="x">Iterations and Comprehensions</a></td></tr><tr><td align="right">12 </td><td><a href="match.html" class="tocviewlink" data-pltdoc="x">Pattern Matching</a></td></tr><tr><td align="right">13 </td><td><a href="classes.html" class="tocviewlink" data-pltdoc="x">Classes and Objects</a></td></tr><tr><td align="right">14 </td><td><a href="units.html" class="tocviewlink" data-pltdoc="x">Units</a></td></tr><tr><td align="right">15 </td><td><a href="reflection.html" class="tocviewlink" data-pltdoc="x">Reflection and Dynamic Evaluation</a></td></tr><tr><td align="right">16 </td><td><a href="macros.html" class="tocviewlink" data-pltdoc="x">Macros</a></td></tr><tr><td align="right">17 </td><td><a href="languages.html" class="tocviewselflink" data-pltdoc="x">Creating Languages</a></td></tr><tr><td align="right">18 </td><td><a href="concurrency.html"
|
||
|
|
documents, where Scribble extends the normal Racket to better support
|
||
|
|
text. Here is an example Scribble document:</p><p><table cellspacing="0" cellpadding="0" class="SVerbatim"><tr><td><p><span class="hspace"> </span><span class="stt">#lang scribble/base</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt"></span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">@(define (get-name) "Self-Describing Document")</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt"></span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">@title[(get-name)]</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt"></span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">The title of this document is ``@(get-name).''</span></p></td></tr></table></p><p>If you put that program in DrRacket’s <a href="intro.html#%28tech._definitions._area%29" class="techoutside" data-pltdoc="x"><span class="techinside">definitions area</span></a> and
|
||
|
|
click <span class="ssansserif">Run</span>, then nothing much appears to happen. The
|
||
|
|
<a href="https://download.racket-lang.org/releases/8.6/doc/local-redirect/index.html?doc=scribble&rel=base.html&version=8.6" class="RktModLink Sq" data-pltdoc="x"><span class="RktSym">scribble/base</span></a> language just binds and exports
|
||
|
|
<span class="RktSym">doc</span> as a description of a document, similar to the way
|
||
|
|
that <span class="stt">"literal.rkt"</span> exports a string as <span class="RktSym">data</span>.</p><p>Simply opening a module with the language
|
||
|
|
<a href="https://download.racket-lang.org/releases/8.6/doc/local-redirect/index.html?doc=scribble&rel=base.html&version=8.6" class="RktModLink Sq" data-pltdoc="x"><span class="RktSym">scribble/base</span></a> in DrRacket, however, causes a
|
||
|
|
<span class="ssansserif">Scribble HTML</span> button to appear. Furthermore, DrRacket knows
|
||
|
|
how to colorize Scribble syntax by coloring green those parts of the
|
||
|
|
document that correspond to literal text. The language name
|
||
|
|
<a href="https://download.racket-lang.org/releases/8.6/doc/local-redirect/index.html?doc=scribble&rel=base.html&version=8.6" class="RktModLink Sq" data-pltdoc="x"><span class="RktSym">scribble/base</span></a> is not hard-wired into
|
||
|
|
DrRacket. Instead, the implementation of the
|
||
|
|
<a href="https://download.racket-lang.org/releases/8.6/doc/local-redirect/index.html?doc=scribble&rel=base.html&version=8.6" class="RktModLink Sq" data-pltdoc="x"><span class="RktSym">scribble/base</span></a> language provides button and
|
||
|
|
syntax-coloring information in response to a query from DrRacket.</p><p>If you have installed the <span class="RktSym">literal</span> language as described in
|
||
|
|
<a href="language-collection.html" data-pltdoc="x">Installing a Language</a>, then you can adjust
|
||
|
|
<span class="stt">"literal/main.rkt"</span> so that DrRacket treats the content
|
||
|
|
of a module in the <span class="RktSym">literal</span> language as plain text instead of
|
||
|
|
(erroneously) as Racket syntax:</p><blockquote class="SCodeFlow"><blockquote class="Rfilebox"><p class="Rfiletitle"><span class="Rfilename"><span class="stt">"literal/main.rkt"</span></span></p><blockquote class="Rfilecontent"><table cellspacing="0" cellpadding="0" class="RktBlk"><tr><td><a href="Module_Syntax.html#%28part._hash-lang%29" class="RktModLink" data-pltdoc="x"><span class="RktMod">#lang</span></a><span class="hspace"> </span><a href="https://download.racket-lang.org/releases/8.6/doc/local-redirect/index.html?doc=reference&rel=index.html&version=8.6" class="RktModLink Sq" data-pltdoc="x"><span class="RktSym">racket</span></a></td></tr><tr><td><span class="hspace"> </span></td></tr><tr><td><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/releases/8.6/doc/local-redirect/index.html?doc=reference&rel=module.html%23%2528form._%2528%2528quote._%7E23%7E25kernel%2529._module%2529%2529&version=8.6" class="RktStxLink Sq" data-pltdoc="x">module</a></span><span class="hspace"> </span><span class="RktSym">reader</span><span class="hspace"> </span><span class="RktSym">racket</span></td></tr><tr><td><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/releases/8.6/doc/local-redirect/index.html?doc=reference&rel=require.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fbase..rkt%2529._require%2529%2529&version=8.6" class="RktStxLink Sq" data-pltdoc="x">require</a></span><span class="hspace"> </span><span class="RktSym">syntax/strip-context</span><span class="RktPn">)</span></td></tr><tr><td><span class="hspace"> </span></td></tr><tr><td><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/releases/8.6/doc/local-redirect/index.html?doc=reference&rel=require.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fbase..rkt%2529._provide%2529%2529&version=8.6" class="RktStxLink Sq" data-pltdoc="x">provide</a></span><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/releases/8.6/doc/local-redirect/index.html?doc=reference&rel=require.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fbase..rkt%2529._rename-out%2529%2529&version=8.6" class="RktStxLink Sq" data-pltdoc="x">rename-out</a></span><span class="hspace"> </span><span class="RktPn">[</span><span class="RktSym">literal-read</span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/releases/8.6/doc/local-redirect/index.html?doc=reference&rel=Reading.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._read%2529%2529&version=8.6" class="RktValLink Sq" data-pltdoc="x">read</a></span><span class="RktPn">]</span></td></tr><tr><td><span class="hspace"> </span><span class="RktPn">[</span><span class="RktSym">literal-read-syntax</span><span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/releases/8.6/doc/local-redirect/index.html?doc=reference&rel=Reading.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._read-syntax%2529%2529&version=8.6" class="RktValLink Sq" data-pltdoc="x">read-syntax</a></span><span class="RktPn">]</span><span class="RktPn">)</span></td></tr><tr><td><span class="hspace"> </span><span class="RktSym">get-info</span><span class="RktPn">)</span></td></tr><tr><td><span class="hspace"> </span></td></tr><tr><td><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/releases/8.6/doc/local-redirect/index.html?doc=reference&rel=define.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fbase..rkt%2529._define%2529%2529&am
|
||
|
|
<span class="RktSym">get-info</span> function. The <span class="RktSym">get-info</span> function
|
||
|
|
is called by <span class="RktSym"><a href="https://download.racket-lang.org/releases/8.6/doc/local-redirect/index.html?doc=reference&rel=Reading.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._read-language%2529%2529&version=8.6" class="RktValLink Sq" data-pltdoc="x">read-language</a></span> (which DrRacket calls) with the
|
||
|
|
source input stream and location information,
|
||
|
|
in case query results should depend on the content of the module after
|
||
|
|
the language name (which is not the case for <span class="RktSym">literal</span>). The
|
||
|
|
result of <span class="RktSym">get-info</span> is a function of two arguments. The
|
||
|
|
first argument is always a symbol, indicating the kind of information
|
||
|
|
that a tool requests from the language; the second argument is the
|
||
|
|
default result to be returned if the language does not recognize the
|
||
|
|
query or has no information for it.</p><p>After DrRacket obtains the result of <span class="RktSym">get-info</span> for a
|
||
|
|
language, it calls the function with a <span class="RktVal">'</span><span class="RktVal">color-lexer</span> query;
|
||
|
|
the result should be a function that implements syntax-coloring
|
||
|
|
parsing on an input stream. For <span class="RktSym">literal</span>, the
|
||
|
|
<a href="https://download.racket-lang.org/releases/8.6/doc/local-redirect/index.html?doc=syntax-color&rel=Default_Lexer.html&version=8.6" class="RktModLink Sq" data-pltdoc="x"><span class="RktSym">syntax-color/default-lexer</span></a> module provides a
|
||
|
|
<span class="RktSym"><a href="https://download.racket-lang.org/releases/8.6/doc/local-redirect/index.html?doc=syntax-color&rel=Default_Lexer.html%23%2528def._%2528%2528lib._syntax-color%252Fdefault-lexer..rkt%2529._default-lexer%2529%2529&version=8.6" class="RktValLink Sq" data-pltdoc="x">default-lexer</a></span> syntax-coloring parser that is suitable for
|
||
|
|
plain text, so <span class="RktSym">literal</span> loads and returns that parser in
|
||
|
|
response to a <span class="RktVal">'</span><span class="RktVal">color-lexer</span> query.</p><p>The set of symbols that a programming tool uses for queries
|
||
|
|
is entirely between the tool and the languages that choose to
|
||
|
|
cooperate with it. For example, in addition to <span class="RktVal">'</span><span class="RktVal">color-lexer</span>,
|
||
|
|
DrRacket uses a <span class="RktVal">'</span><span class="RktVal">drracket:toolbar-buttons</span> query to determine
|
||
|
|
which buttons should be available in the toolbar to operate on modules
|
||
|
|
using the language.</p><p>The <a href="https://download.racket-lang.org/releases/8.6/doc/local-redirect/index.html?doc=syntax&rel=reader-helpers.html%23%2528mod-path._syntax%252Fmodule-reader%2529&version=8.6" class="RktModLink Sq" data-pltdoc="x"><span class="RktSym">syntax/module-reader</span></a> language lets you specify
|
||
|
|
<span class="RktSym">get-info</span> handling through a <span class="RktPn">#:info</span> optional
|
||
|
|
specification. The protocol for an <span class="RktPn">#:info</span> function is
|
||
|
|
slightly different from the raw <span class="RktSym">get-info</span> protocol; the
|
||
|
|
revised protocol allows <a href="https://download.racket-lang.org/releases/8.6/doc/local-redirect/index.html?doc=syntax&rel=reader-helpers.html%23%2528mod-path._syntax%252Fmodule-reader%2529&version=8.6" class="RktModLink Sq" data-pltdoc="x"><span class="RktSym">syntax/module-reader</span></a> the
|
||
|
|
possibility of handling future language-information queries
|
||
|
|
automatically.</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://download.racket-lang.org/releases/8.6/doc/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="language-collection.html" title="backward to "17.3.4 Installing a Language"" data-pltdoc="x">← prev</a> <a href="hash-languages.html" title="up to "17.3 Defining new #lang Languages"" data-pltdoc="x">up</a> <a href="module-runtime-config.html" title="forward to "17.3.6 Module-Handling Configuration"" data-pltdoc="x">next →</a></span> </div></div></div><div id="contextindicator"> </div></body></html>
|