about summary refs log tree commit diff stats
path: root/editor/editor.md
blob: 65f2badb450932c9babd73067295fac4fd8d7f82 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
## Getting your editor set up

If you've read this far, it's time to set up your editor. Mu is really
intended to be read interactively rather than on a browser.

There is rudimentary syntax highlighting support for Mu and SubX files for
various editors. Look for your editor in `mu.*` and `subx.*`, and follow the
instructions within.

The Vim files are most developed. In particular, I recommend some optional
setup in subx.vim to use multiple colors for comments.

If you use [Exuberant Ctags](http://ctags.sourceforge.net) for jumping easily
from names to their definitions in your editor, copy the contents of `exuberant_ctags_rc`
into your `.ctags` file.

[Here](https://lobste.rs/s/qglfdp/subx_minimalist_assembly_language_for#c_o9ddqk)
are some tips on my setup for quickly finding the right opcode for any
situation from within Vim.
ghlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */ .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Mu - tangle.mu</title>
<meta name="Generator" content="Vim/7.4">
<meta name="plugin-version" content="vim7.4_v2">
<meta name="syntax" content="none">
<meta name="settings" content="number_lines,use_css,pre_wrap,no_foldcolumn,expand_tabs,line_ids,prevent_copy=">
<meta name="colorscheme" content="minimal">
<style type="text/css">
<!--
pre { white-space: pre-wrap; font-family: monospace; color: #aaaaaa; background-color: #080808; }
body { font-size: 12pt; font-family: monospace; color: #aaaaaa; background-color: #080808; }
a { color:#eeeeee; text-decoration: none; }
a:hover { text-decoration: underline; }
* { font-size: 12pt; font-size: 1em; }
.muControl { color: #c0a020; }
.muRecipe { color: #ff8700; }
.Special { color: #c00000; }
.Delimiter { color: #800080; }
.Comment { color: #9090ff; }
.Comment a { color:#0000ee; text-decoration:underline; }
.Constant { color: #00a0a0; }
.LineNr { color: #444444; }
-->
</style>

<script type='text/javascript'>
<!--

/* function to open any folds containing a jumped-to line before jumping to it */
function JumpToLine()
{
  var lineNum;
  lineNum = window.location.hash;
  lineNum = lineNum.substr(1); /* strip off '#' */

  if (lineNum.indexOf('L') == -1) {
    lineNum = 'L'+lineNum;
  }
  lineElem = document.getElementById(lineNum);
  /* Always jump to new location even if the line was hidden inside a fold, or
   * we corrected the raw number to a line ID.
   */
  if (lineElem) {
    lineElem.scrollIntoView(true);
  }
  return true;
}
if ('onhashchange' in window) {
  window.onhashchange = JumpToLine;
}

-->
</script>
</head>
<body onload='JumpToLine();'>
<pre id='vimCodeElement'>
<span id="L1" class="LineNr"> 1 </span><span class="Comment"># example program: constructing functions out of order</span>
<span id="L2" class="LineNr"> 2 </span><span class="Comment">#</span>
<span id="L3" class="LineNr"> 3 </span><span class="Comment"># We construct a factorial function with separate base and recursive cases.</span>
<span id="L4" class="LineNr"> 4 </span><span class="Comment"># Compare factorial.mu.</span>
<span id="L5" class="LineNr"> 5 </span><span class="Comment">#</span>
<span id="L6" class="LineNr"> 6 </span><span class="Comment"># This isn't a very tasteful example, just a basic demonstration of</span>
<span id="L7" class="LineNr"> 7 </span><span class="Comment"># possibilities.</span>
<span id="L8" class="LineNr"> 8 </span>
<span id="L9" class="LineNr"> 9 </span><span class="muRecipe">def</span> <a href='tangle.mu.html#L9'>factorial</a> n:num<span class="muRecipe"> -&gt; </span>result:num [
<span id="L10" class="LineNr">10 </span>  <span class="Constant">local-scope</span>
<span id="L11" class="LineNr">11 </span>  <span class="Constant">load-inputs</span>
<span id="L12" class="LineNr">12 </span><span class="Constant">  <a href='tangle.mu.html#L12'>&lt;factorial-cases&gt;</a></span>
<span id="L13" class="LineNr">13 </span>]
<span id="L14" class="LineNr">14 </span>
<span id="L15" class="LineNr">15 </span><span class="muRecipe">after</span> <span class="Constant"><a href='tangle.mu.html#L12'>&lt;factorial-cases&gt;</a></span> [
<span id="L16" class="LineNr">16 </span>  <span class="Comment"># if n=0 return 1</span>
<span id="L17" class="LineNr">17 </span>  <span class="muControl">return-unless</span> n,<span class="Constant"> 1</span>
<span id="L18" class="LineNr">18 </span>]
<span id="L19" class="LineNr">19 </span>
<span id="L20" class="LineNr">20 </span><span class="muRecipe">after</span> <span class="Constant"><a href='tangle.mu.html#L12'>&lt;factorial-cases&gt;</a></span> [
<span id="L21" class="LineNr">21 </span>  <span class="Comment"># return n * factorial(n - 1)</span>
<span id="L22" class="LineNr">22 </span>  <span class="Delimiter">{</span>
<span id="L23" class="LineNr">23 </span>    <span class="muControl">break-unless</span> n
<span id="L24" class="LineNr">24 </span>    x:num <span class="Special">&lt;-</span> subtract n,<span class="Constant"> 1</span>
<span id="L25" class="LineNr">25 </span>    subresult:num <span class="Special">&lt;-</span> <a href='tangle.mu.html#L9'>factorial</a> x
<span id="L26" class="LineNr">26 </span>    result <span class="Special">&lt;-</span> multiply subresult, n
<span id="L27" class="LineNr">27 </span>   <span class="muControl"> return</span> result
<span id="L28" class="LineNr">28 </span>  <span class="Delimiter">}</span>
<span id="L29" class="LineNr">29 </span>]
<span id="L30" class="LineNr">30 </span>
<span id="L31" class="LineNr">31 </span><span class="muRecipe">def</span> <a href='tangle.mu.html#L31'>main</a> [
<span id="L32" class="LineNr">32 </span>  1:num <span class="Special">&lt;-</span> <a href='tangle.mu.html#L9'>factorial</a><span class="Constant"> 5</span>
<span id="L33" class="LineNr">33 </span>  <span class="Comment"># trailing space in next line is to help with syntax highlighting</span>
<span id="L34" class="LineNr">34 </span>  $print <span class="Constant">[result: ]</span>, 1:num, <span class="Constant">[ </span>
<span id="L35" class="LineNr">35 </span><span class="Constant">]</span>
<span id="L36" class="LineNr">36 </span>]
</pre>
</body>
</html>
<!-- vim: set foldmethod=manual : -->