Repository navigation
Expand file tree
/
Copy pathLanguage-Copilot-Interface.html
More file actions
27 lines (27 loc) · 18.1 KB
/
Copy pathLanguage-Copilot-Interface.html
File metadata and controls
27 lines (27 loc) · 18.1 KB
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Language.Copilot.Interface</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Language-Copilot-Interface.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="http://github.com/leepike/Copilot/Language.Copilot.Interface.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">copilot-0.28: A stream DSL for writing embedded C monitors.</p></div><div id="content"><div id="module-header"><p class="caption">Language.Copilot.Interface</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Used by the end-user to easily give its arguments to dispatch.
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:Options">Options</a> </li><li class="src short"><a href="#v:baseOpts">baseOpts</a> :: <a href="Language-Copilot-Interface.html#t:Options">Options</a></li><li class="src short"><a href="#v:test">test</a> :: <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t:Int">Int</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t:IO">IO</a> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:interpret">interpret</a> :: <a href="Language-Copilot-Core.html#t:Streams">Streams</a> -> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t:Int">Int</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t:IO">IO</a> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:compile">compile</a> :: <a href="Language-Copilot-Core.html#t:Streams">Streams</a> -> <a href="Language-Copilot-Core.html#t:Name">Name</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t:IO">IO</a> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:verify">verify</a> :: <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t:FilePath">FilePath</a> -> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t:Int">Int</a> -> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t:IO">IO</a> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:interface">interface</a> :: <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t:IO">IO</a> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:help">help</a> :: <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t:IO">IO</a> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:setE">setE</a> :: <a href="Language-Copilot-Core.html#t:Vars">Vars</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></li><li class="src short"><a href="#v:setC">setC</a> :: <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t:String">String</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></li><li class="src short"><a href="#v:setO">setO</a> :: <a href="Language-Copilot-Core.html#t:Name">Name</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></li><li class="src short"><a href="#v:setP">setP</a> :: <a href="Language-Copilot-Core.html#t:Period">Period</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></li><li class="src short"><a href="#v:setI">setI</a> :: <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></li><li class="src short"><a href="#v:setPP">setPP</a> :: (<a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t:String">String</a>, <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t:String">String</a>) -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></li><li class="src short"><a href="#v:setN">setN</a> :: <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t:Int">Int</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></li><li class="src short"><a href="#v:setV">setV</a> :: <a href="Language-Copilot-Dispatch.html#t:Verbose">Verbose</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></li><li class="src short"><a href="#v:setR">setR</a> :: <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t:Int">Int</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></li><li class="src short"><a href="#v:setDir">setDir</a> :: <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t:String">String</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></li><li class="src short"><a href="#v:setGCC">setGCC</a> :: <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t:String">String</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></li><li class="src short"><a href="#v:setArrs">setArrs</a> :: [(<a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t:String">String</a>, <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t:Int">Int</a>)] -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></li><li class="src short"><a href="#v:setClock">setClock</a> :: Clock -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></li><li class="src short">module <a href="Language-Copilot-Dispatch.html">Language.Copilot.Dispatch</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Options" class="def">Options</a> </p></div><div class="top"><p class="src"><a name="v:baseOpts" class="def">baseOpts</a> :: <a href="Language-Copilot-Interface.html#t:Options">Options</a></p></div><div class="top"><p class="src"><a name="v:test" class="def">test</a> :: <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t:Int">Int</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t:IO">IO</a> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></p></div><div class="top"><p class="src"><a name="v:interpret" class="def">interpret</a> :: <a href="Language-Copilot-Core.html#t:Streams">Streams</a> -> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t:Int">Int</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t:IO">IO</a> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></p></div><div class="top"><p class="src"><a name="v:compile" class="def">compile</a> :: <a href="Language-Copilot-Core.html#t:Streams">Streams</a> -> <a href="Language-Copilot-Core.html#t:Name">Name</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t:IO">IO</a> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></p></div><div class="top"><p class="src"><a name="v:verify" class="def">verify</a> :: <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t:FilePath">FilePath</a> -> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t:Int">Int</a> -> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t:IO">IO</a> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></p></div><div class="top"><p class="src"><a name="v:interface" class="def">interface</a> :: <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t:IO">IO</a> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></p><div class="doc"><p>The <a href="main.html">main</a> function that dispatches.
</p></div></div><div class="top"><p class="src"><a name="v:help" class="def">help</a> :: <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t:IO">IO</a> <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></p></div><div class="top"><p class="src"><a name="v:setE" class="def">setE</a> :: <a href="Language-Copilot-Core.html#t:Vars">Vars</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></p><div class="doc"><p>Sets the environment for simulation by giving a mapping of external
variables to lists of values. E.g.,
</p><pre> setE (emptySM {w32Map = fromList [("ext", [0,1..])]}) ...</pre><p>sets the external variable names <a href="ext.html">ext</a> to take the natural numbers, up to the limit of Word32.
</p></div></div><div class="top"><p class="src"><a name="v:setC" class="def">setC</a> :: <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t:String">String</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></p><div class="doc"><p>Sets the options for the compiler, e.g.,
</p><pre> setC "-O2" ...</pre><p>Sets gcc options.
</p></div></div><div class="top"><p class="src"><a name="v:setO" class="def">setO</a> :: <a href="Language-Copilot-Core.html#t:Name">Name</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></p></div><div class="top"><p class="src"><a name="v:setP" class="def">setP</a> :: <a href="Language-Copilot-Core.html#t:Period">Period</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></p><div class="doc"><p>Manually set the period for the program. Otherwise, the minimum required period is computed automatically. E.g.,
</p><p><code> setP 100 ... </code>
sets the period to be 100. The period must be at least 1.
</p></div></div><div class="top"><p class="src"><a name="v:setI" class="def">setI</a> :: <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></p></div><div class="top"><p class="src"><a name="v:setPP" class="def">setPP</a> :: (<a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t:String">String</a>, <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t:String">String</a>) -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></p><div class="doc"><p>Sets the code to precede and follow the copilot specification
If nothing, then code appropriate for communication with the interpreter is generated
</p></div></div><div class="top"><p class="src"><a name="v:setN" class="def">setN</a> :: <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t:Int">Int</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></p><div class="doc"><p>Sets the number of iterations of the program to simulation:
</p><p><code> setN 50 </code>
simulations the program for 50 steps.
</p></div></div><div class="top"><p class="src"><a name="v:setV" class="def">setV</a> :: <a href="Language-Copilot-Dispatch.html#t:Verbose">Verbose</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></p><div class="doc"><p>Set the verbosity level.
</p></div></div><div class="top"><p class="src"><a name="v:setR" class="def">setR</a> :: <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t:Int">Int</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></p></div><div class="top"><p class="src"><a name="v:setDir" class="def">setDir</a> :: <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t:String">String</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></p><div class="doc"><p>Sets the directory into which the output of compiled programs should be
placed. If the directory does not exist, it will be created.
</p></div></div><div class="top"><p class="src"><a name="v:setGCC" class="def">setGCC</a> :: <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t:String">String</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></p><div class="doc"><p>Sets the compiler to use, given as a path to the executable. The default
is "gcc".
</p></div></div><div class="top"><p class="src"><a name="v:setArrs" class="def">setArrs</a> :: [(<a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t:String">String</a>, <a href="/Library/Frameworks/GHC.framework/Versions/612/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Int.html#t:Int">Int</a>)] -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></p><div class="doc"><p>Set the external arrays.
</p></div></div><div class="top"><p class="src"><a name="v:setClock" class="def">setClock</a> :: Clock -> <a href="Language-Copilot-Interface.html#t:Options">Options</a> -> <a href="Language-Copilot-Interface.html#t:Options">Options</a></p><div class="doc"><p>Sets the hardware clock. See
http:<em></em>github.com<em>tomahawkins</em>atom<em>blob</em>master<em>Language</em>Atom/Code.hs.
</p></div></div><div class="top"><p class="src">module <a href="Language-Copilot-Dispatch.html">Language.Copilot.Dispatch</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.8.1</p></div></body></html>