docs/sphinx_docs/_build/html/_modules/joy/joy.html

   1
   2 <!DOCTYPE html>
   3
   4 <html>
   5   <head>
   6     <meta charset="utf-8" />
   7     <title>joy.joy &#8212; Thun 0.3.0 documentation</title>
   8     <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
   9     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  10     <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
  11     <script src="../../_static/jquery.js"></script>
  12     <script src="../../_static/underscore.js"></script>
  13     <script src="../../_static/doctools.js"></script>
  14     <script src="../../_static/language_data.js"></script>
  15     <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
  16     <link rel="index" title="Index" href="../../genindex.html" />
  17     <link rel="search" title="Search" href="../../search.html" />
  18
  19   <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  20
  21
  22   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  23
  24   </head><body>
  25
  26
  27     <div class="document">
  28       <div class="documentwrapper">
  29         <div class="bodywrapper">
  30
  31
  32           <div class="body" role="main">
  33
  34   <h1>Source code for joy.joy</h1><div class="highlight"><pre>
  35 <span></span><span class="c1"># -*- coding: utf-8 -*-</span>
  36 <span class="c1">#</span>
  37 <span class="c1">#    Copyright © 2014, 2015, 2017, 2018 Simon Forman</span>
  38 <span class="c1">#</span>
  39 <span class="c1">#    This file is part of Thun</span>
  40 <span class="c1">#</span>
  41 <span class="c1">#    Thun is free software: you can redistribute it and/or modify</span>
  42 <span class="c1">#    it under the terms of the GNU General Public License as published by</span>
  43 <span class="c1">#    the Free Software Foundation, either version 3 of the License, or</span>
  44 <span class="c1">#    (at your option) any later version.</span>
  45 <span class="c1">#</span>
  46 <span class="c1">#    Thun is distributed in the hope that it will be useful,</span>
  47 <span class="c1">#    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  48 <span class="c1">#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
  49 <span class="c1">#    GNU General Public License for more details.</span>
  50 <span class="c1">#</span>
  51 <span class="c1">#    You should have received a copy of the GNU General Public License</span>
  52 <span class="c1">#    along with Thun.  If not see &lt;http://www.gnu.org/licenses/&gt;.</span>
  53 <span class="c1">#</span>
  54 <span class="sd">&#39;&#39;&#39;</span>
  55 <span class="sd">This module implements an interpreter for a dialect of Joy that</span>
  56 <span class="sd">attempts to stay very close to the spirit of Joy but does not precisely</span>
  57 <span class="sd">match the behaviour of the original version(s) written in C.</span>
  58
  59 <span class="sd">&#39;&#39;&#39;</span>
  60 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">print_function</span>
  61 <span class="kn">from</span> <span class="nn">builtins</span> <span class="kn">import</span> <span class="nb">input</span>
  62 <span class="kn">from</span> <span class="nn">traceback</span> <span class="kn">import</span> <span class="n">print_exc</span><span class="p">,</span> <span class="n">format_exc</span>
  63 <span class="kn">from</span> <span class="nn">.parser</span> <span class="kn">import</span> <span class="n">text_to_expression</span><span class="p">,</span> <span class="n">ParseError</span><span class="p">,</span> <span class="n">Symbol</span>
  64 <span class="kn">from</span> <span class="nn">.utils.stack</span> <span class="kn">import</span> <span class="n">stack_to_string</span>
  65
  66
  67 <div class="viewcode-block" id="joy"><a class="viewcode-back" href="../../joy.html#joy.joy.joy">[docs]</a><span class="k">def</span> <span class="nf">joy</span><span class="p">(</span><span class="n">stack</span><span class="p">,</span> <span class="n">expression</span><span class="p">,</span> <span class="n">dictionary</span><span class="p">,</span> <span class="n">viewer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
  68         <span class="sd">&#39;&#39;&#39;Evaluate a Joy expression on a stack.</span>
  69
  70 <span class="sd">       This function iterates through a sequence of terms which are either</span>
  71 <span class="sd">       literals (strings, numbers, sequences of terms) or function symbols.</span>
  72 <span class="sd">       Literals are put onto the stack and functions are looked up in the</span>
  73 <span class="sd">       disctionary and executed.</span>
  74
  75 <span class="sd">       The viewer is a function that is called with the stack and expression</span>
  76 <span class="sd">       on every iteration, its return value is ignored.</span>
  77
  78 <span class="sd">       :param stack stack: The stack.</span>
  79 <span class="sd">       :param stack expression: The expression to evaluate.</span>
  80 <span class="sd">       :param dict dictionary: A ``dict`` mapping names to Joy functions.</span>
  81 <span class="sd">       :param function viewer: Optional viewer function.</span>
  82 <span class="sd">       :rtype: (stack, (), dictionary)</span>
  83
  84 <span class="sd">       &#39;&#39;&#39;</span>
  85         <span class="k">while</span> <span class="n">expression</span><span class="p">:</span>
  86
  87                 <span class="k">if</span> <span class="n">viewer</span><span class="p">:</span> <span class="n">viewer</span><span class="p">(</span><span class="n">stack</span><span class="p">,</span> <span class="n">expression</span><span class="p">)</span>
  88
  89                 <span class="n">term</span><span class="p">,</span> <span class="n">expression</span> <span class="o">=</span> <span class="n">expression</span>
  90                 <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">term</span><span class="p">,</span> <span class="n">Symbol</span><span class="p">):</span>
  91                         <span class="n">term</span> <span class="o">=</span> <span class="n">dictionary</span><span class="p">[</span><span class="n">term</span><span class="p">]</span>
  92                         <span class="n">stack</span><span class="p">,</span> <span class="n">expression</span><span class="p">,</span> <span class="n">dictionary</span> <span class="o">=</span> <span class="n">term</span><span class="p">(</span><span class="n">stack</span><span class="p">,</span> <span class="n">expression</span><span class="p">,</span> <span class="n">dictionary</span><span class="p">)</span>
  93                 <span class="k">else</span><span class="p">:</span>
  94                         <span class="n">stack</span> <span class="o">=</span> <span class="n">term</span><span class="p">,</span> <span class="n">stack</span>
  95
  96         <span class="k">if</span> <span class="n">viewer</span><span class="p">:</span> <span class="n">viewer</span><span class="p">(</span><span class="n">stack</span><span class="p">,</span> <span class="n">expression</span><span class="p">)</span>
  97         <span class="k">return</span> <span class="n">stack</span><span class="p">,</span> <span class="n">expression</span><span class="p">,</span> <span class="n">dictionary</span></div>
  98
  99
 100 <div class="viewcode-block" id="run"><a class="viewcode-back" href="../../joy.html#joy.joy.run">[docs]</a><span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">stack</span><span class="p">,</span> <span class="n">dictionary</span><span class="p">,</span> <span class="n">viewer</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 101         <span class="sd">&#39;&#39;&#39;</span>
 102 <span class="sd">       Return the stack resulting from running the Joy code text on the stack.</span>
 103
 104 <span class="sd">       :param str text: Joy code.</span>
 105 <span class="sd">       :param stack stack: The stack.</span>
 106 <span class="sd">       :param dict dictionary: A ``dict`` mapping names to Joy functions.</span>
 107 <span class="sd">       :param function viewer: Optional viewer function.</span>
 108 <span class="sd">       :rtype: (stack, (), dictionary)</span>
 109
 110 <span class="sd">       &#39;&#39;&#39;</span>
 111         <span class="n">expression</span> <span class="o">=</span> <span class="n">text_to_expression</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
 112         <span class="k">return</span> <span class="n">joy</span><span class="p">(</span><span class="n">stack</span><span class="p">,</span> <span class="n">expression</span><span class="p">,</span> <span class="n">dictionary</span><span class="p">,</span> <span class="n">viewer</span><span class="p">)</span></div>
 113
 114
 115 <div class="viewcode-block" id="repl"><a class="viewcode-back" href="../../joy.html#joy.joy.repl">[docs]</a><span class="k">def</span> <span class="nf">repl</span><span class="p">(</span><span class="n">stack</span><span class="o">=</span><span class="p">(),</span> <span class="n">dictionary</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 116         <span class="sd">&#39;&#39;&#39;</span>
 117 <span class="sd">       Read-Evaluate-Print Loop</span>
 118
 119 <span class="sd">       Accept input and run it on the stack, loop.</span>
 120
 121 <span class="sd">       :param stack stack: The stack.</span>
 122 <span class="sd">       :param dict dictionary: A ``dict`` mapping names to Joy functions.</span>
 123 <span class="sd">       :rtype: stack</span>
 124
 125 <span class="sd">       &#39;&#39;&#39;</span>
 126         <span class="k">if</span> <span class="n">dictionary</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
 127                 <span class="n">dictionary</span> <span class="o">=</span> <span class="p">{}</span>
 128         <span class="k">try</span><span class="p">:</span>
 129                 <span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
 130                         <span class="nb">print</span><span class="p">()</span>
 131                         <span class="nb">print</span><span class="p">(</span><span class="n">stack_to_string</span><span class="p">(</span><span class="n">stack</span><span class="p">),</span> <span class="s1">&#39;&lt;-top&#39;</span><span class="p">)</span>
 132                         <span class="nb">print</span><span class="p">()</span>
 133                         <span class="k">try</span><span class="p">:</span>
 134                                 <span class="n">text</span> <span class="o">=</span> <span class="nb">input</span><span class="p">(</span><span class="s1">&#39;joy? &#39;</span><span class="p">)</span>
 135                         <span class="k">except</span> <span class="p">(</span><span class="ne">EOFError</span><span class="p">,</span> <span class="ne">KeyboardInterrupt</span><span class="p">):</span>
 136                                 <span class="k">break</span>
 137                         <span class="k">try</span><span class="p">:</span>
 138                                 <span class="n">stack</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">dictionary</span> <span class="o">=</span> <span class="n">run</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">stack</span><span class="p">,</span> <span class="n">dictionary</span><span class="p">)</span>
 139                         <span class="k">except</span><span class="p">:</span>
 140                                 <span class="n">exc</span> <span class="o">=</span> <span class="n">format_exc</span><span class="p">()</span> <span class="c1"># Capture the exception.</span>
 141                                 <span class="nb">print</span><span class="p">(</span><span class="n">exc</span><span class="p">)</span> <span class="c1"># Print the original exception.</span>
 142         <span class="k">except</span><span class="p">:</span>
 143                 <span class="n">print_exc</span><span class="p">()</span>
 144         <span class="nb">print</span><span class="p">()</span>
 145         <span class="k">return</span> <span class="n">stack</span></div>
 146 </pre></div>
 147
 148           </div>
 149
 150         </div>
 151       </div>
 152       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 153         <div class="sphinxsidebarwrapper">
 154 <h1 class="logo"><a href="../../index.html">Thun</a></h1>
 155
 156
 157
 158
 159
 160
 161
 162
 163 <h3>Navigation</h3>
 164 <ul>
 165 <li class="toctree-l1"><a class="reference internal" href="../../notebooks/Intro.html">Thun: Joy in Python</a></li>
 166 <li class="toctree-l1"><a class="reference internal" href="../../joy.html">Joy Interpreter</a></li>
 167 <li class="toctree-l1"><a class="reference internal" href="../../stack.html">Stack or Quote or Sequence or List…</a></li>
 168 <li class="toctree-l1"><a class="reference internal" href="../../parser.html">Parsing Text into Joy Expressions</a></li>
 169 <li class="toctree-l1"><a class="reference internal" href="../../pretty.html">Tracing Joy Execution</a></li>
 170 <li class="toctree-l1"><a class="reference internal" href="../../library.html">Function Reference</a></li>
 171 <li class="toctree-l1"><a class="reference internal" href="../../lib.html">Functions Grouped by, er, Function with Examples</a></li>
 172 <li class="toctree-l1"><a class="reference internal" href="../../types.html">Type Inference of Joy Expressions</a></li>
 173 <li class="toctree-l1"><a class="reference internal" href="../../notebooks/index.html">Essays about Programming in Joy</a></li>
 174 </ul>
 175
 176 <div class="relations">
 177 <h3>Related Topics</h3>
 178 <ul>
 179   <li><a href="../../index.html">Documentation overview</a><ul>
 180   <li><a href="../index.html">Module code</a><ul>
 181   </ul></li>
 182   </ul></li>
 183 </ul>
 184 </div>
 185 <div id="searchbox" style="display: none" role="search">
 186   <h3 id="searchlabel">Quick search</h3>
 187     <div class="searchformwrapper">
 188     <form class="search" action="../../search.html" method="get">
 189       <input type="text" name="q" aria-labelledby="searchlabel" />
 190       <input type="submit" value="Go" />
 191     </form>
 192     </div>
 193 </div>
 194 <script>$('#searchbox').show(0);</script>
 195
 196
 197
 198
 199
 200
 201
 202
 203         </div>
 204       </div>
 205       <div class="clearer"></div>
 206     </div>
 207     <div class="footer" role="contentinfo">
 208 <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">
 209 <img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" />
 210 </a>
 211 <br />
 212 <span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">Thun Documentation</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="https://joypy.osdn.io/" property="cc:attributionName" rel="cc:attributionURL">Simon Forman</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.<br />Based on a work at <a xmlns:dct="http://purl.org/dc/terms/" href="https://osdn.net/projects/joypy/" rel="dct:source">https://osdn.net/projects/joypy/</a>.
 213       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.2.
 214     </div>
 215
 216   </body>
 217 </html>