list <https://en.wikipedia.org/wiki/Cons#Lists>`__ made from Python
tuples.
-.. code:: ipython2
+.. code:: ipython3
import inspect
import joy.utils.stack
- print inspect.getdoc(joy.utils.stack)
+ print(inspect.getdoc(joy.utils.stack))
+
+
+.. parsed-literal::
+
+ When talking about Joy we use the terms "stack", "quote", "sequence",
+ "list", and others to mean the same thing: a simple linear datatype that
+ permits certain operations such as iterating and pushing and popping
+ values from (at least) one end.
+
+ There is no "Stack" Python class, instead we use the `cons list`_, a
+ venerable two-tuple recursive sequence datastructure, where the
+ empty tuple ``()`` is the empty stack and ``(head, rest)`` gives the
+ recursive form of a stack with one or more items on it::
+
+ stack := () | (item, stack)
+
+ Putting some numbers onto a stack::
+
+ ()
+ (1, ())
+ (2, (1, ()))
+ (3, (2, (1, ())))
+ ...
+
+ Python has very nice "tuple packing and unpacking" in its syntax which
+ means we can directly "unpack" the expected arguments to a Joy function.
+
+ For example::
+
+ def dup((head, tail)):
+ return head, (head, tail)
+
+ We replace the argument "stack" by the expected structure of the stack,
+ in this case "(head, tail)", and Python takes care of unpacking the
+ incoming tuple and assigning values to the names. (Note that Python
+ syntax doesn't require parentheses around tuples used in expressions
+ where they would be redundant.)
+
+ Unfortunately, the Sphinx documentation generator, which is used to generate this
+ web page, doesn't handle tuples in the function parameters. And in Python 3, this
+ syntax was removed entirely. Instead you would have to write::
+
+ def dup(stack):
+ head, tail = stack
+ return head, (head, tail)
+
+
+ We have two very simple functions, one to build up a stack from a Python
+ iterable and another to iterate through a stack and yield its items
+ one-by-one in order. There are also two functions to generate string representations
+ of stacks. They only differ in that one prints the terms in stack from left-to-right while the other prints from right-to-left. In both functions *internal stacks* are
+ printed left-to-right. These functions are written to support :doc:`../pretty`.
+
+ .. _cons list: https://en.wikipedia.org/wiki/Cons#Lists
+
The utility functions maintain order.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 0th item in the list will be on the top of the stack and *vise
versa*.
-.. code:: ipython2
+.. code:: ipython3
joy.utils.stack.list_to_stack([1, 2, 3])
-.. code:: ipython2
+
+
+
+.. parsed-literal::
+
+ (1, (2, (3, ())))
+
+
+
+.. code:: ipython3
list(joy.utils.stack.iter_stack((1, (2, (3, ())))))
+
+
+
+.. parsed-literal::
+
+ [1, 2, 3]
+
+
+
This requires reversing the sequence (or iterating backwards) otherwise:
-.. code:: ipython2
+.. code:: ipython3
stack = ()
for n in [1, 2, 3]:
stack = n, stack
- print stack
- print list(joy.utils.stack.iter_stack(stack))
+ print(stack)
+ print(list(joy.utils.stack.iter_stack(stack)))
+
+
+.. parsed-literal::
+
+ (3, (2, (1, ())))
+ [3, 2, 1]
+
Purely Functional Datastructures.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
runtime, which nothing does yet and may be a bad idea, and the ``help``
command.)
-.. code:: ipython2
+.. code:: ipython3
import joy.joy
- print inspect.getsource(joy.joy.joy)
+ print(inspect.getsource(joy.joy.joy))
+
+
+.. parsed-literal::
+
+ def joy(stack, expression, dictionary, viewer=None):
+ '''Evaluate a Joy expression on a stack.
+
+ This function iterates through a sequence of terms which are either
+ literals (strings, numbers, sequences of terms) or function symbols.
+ Literals are put onto the stack and functions are looked up in the
+ disctionary and executed.
+
+ The viewer is a function that is called with the stack and expression
+ on every iteration, its return value is ignored.
+
+ :param stack stack: The stack.
+ :param stack expression: The expression to evaluate.
+ :param dict dictionary: A ``dict`` mapping names to Joy functions.
+ :param function viewer: Optional viewer function.
+ :rtype: (stack, (), dictionary)
+
+ '''
+ while expression:
+
+ if viewer: viewer(stack, expression)
+
+ term, expression = expression
+ if isinstance(term, Symbol):
+ term = dictionary[term]
+ stack, expression, dictionary = term(stack, expression, dictionary)
+ else:
+ stack = term, stack
+
+ if viewer: viewer(stack, expression)
+ return stack, expression, dictionary
+
+
View function
~~~~~~~~~~~~~
Parser
======
-.. code:: ipython2
+.. code:: ipython3
import joy.parser
- print inspect.getdoc(joy.parser)
+ print(inspect.getdoc(joy.parser))
.. parsed-literal::
structure out of the tokens. There's no Abstract Syntax Tree or anything
like that.
-.. code:: ipython2
+.. code:: ipython3
- print inspect.getsource(joy.parser._parse)
+ print(inspect.getsource(joy.parser._parse))
.. parsed-literal::
That's pretty much all there is to it.
-.. code:: ipython2
+.. code:: ipython3
joy.parser.text_to_expression('1 2 3 4 5') # A simple sequence.
-.. code:: ipython2
+.. code:: ipython3
joy.parser.text_to_expression('[1 2 3] 4 5') # Three items, the first is a list with three items
-.. code:: ipython2
+.. code:: ipython3
joy.parser.text_to_expression('1 23 ["four" [-5.0] cons] 8888') # A mixed bag. cons is
# a Symbol, no lookup at
-.. code:: ipython2
+.. code:: ipython3
joy.parser.text_to_expression('[][][][][]') # Five empty lists.
-.. code:: ipython2
+.. code:: ipython3
joy.parser.text_to_expression('[[[[[]]]]]') # Five nested lists.
``+``, the library module supports aliases), and combinators which
provide control-flow and higher-order operations.
-.. code:: ipython2
+.. code:: ipython3
import joy.library
- print ' '.join(sorted(joy.library.initialize()))
+ print(' '.join(sorted(joy.library.initialize())))
.. parsed-literal::
- != % & * *fraction *fraction0 + ++ - -- / // /floor < << <= <> = > >= >> ? ^ _Tree_add_Ee _Tree_delete_R0 _Tree_delete_clear_stuff _Tree_get_E abs add anamorphism and app1 app2 app3 at average b binary bool branch ccons choice clear cleave cmp codireco concat cond cons dinfrirst dip dipd dipdd disenstacken divmod down_to_zero drop dup dupd dupdd dupdip dupdipd enstacken eq first first_two flatten floor floordiv fork fourth gcd ge genrec getitem gt help i id ifte ii infer infra inscribe le least_fraction loop lshift lt make_generator map max min mod modulus mul ne neg not nullary of or over pam parse pick pm pop popd popdd popop popopd popopdd pow pred primrec product quoted range range_to_zero rem remainder remove rest reverse roll< roll> rolldown rollup round rrest rshift run second select sharing shunt size sort sqr sqrt stack step step_zero stuncons stununcons sub succ sum swaack swap swoncat swons take ternary third times truediv truthy tuck unary uncons unique unit unquoted unstack unswons void warranty while words x xor zip •
+ != % & * *fraction *fraction0 + ++ - -- / // /floor < << <= <> = > >= >> ? ^ _Tree_add_Ee _Tree_delete_R0 _Tree_delete_clear_stuff _Tree_get_E abs add anamorphism and app1 app2 app3 at average b binary bool branch ccons choice clear cleave cmp codireco concat cond cons dinfrirst dip dipd dipdd disenstacken div divmod down_to_zero drop dup dupd dupdd dupdip dupdipd enstacken eq first first_two flatten floor floordiv fork fourth gcd ge genrec getitem gt help i id ifte ii infra inscribe le least_fraction loop lshift lt make_generator map max min mod modulus mul ne neg not nullary of or over pam parse pick pm pop popd popdd popop popopd popopdd pow pred primrec product quoted range range_to_zero rem remainder remove rest reverse roll< roll> rolldown rollup round rrest rshift run second select sharing shunt size sort sqr sqrt stack step step_zero stuncons stununcons sub succ sum swaack swap swoncat swons tailrec take ternary third times truediv truthy tuck unary uncons unique unit unquoted unstack unswons void warranty while words x xor zip •
Many of the functions are defined in Python, like ``dip``:
-.. code:: ipython2
+.. code:: ipython3
- print inspect.getsource(joy.library.dip)
+ print(inspect.getsource(joy.library.dip))
.. parsed-literal::
@inscribe
- @combinator_effect(_COMB_NUMS(), a1, s1)
@FunctionWrapper
def dip(stack, expression, dictionary):
'''
on the rest of the stack.
::
- ... x [Q] dip
+ ... x [Q] dip
-------------------
- ... Q x
+ ... Q x
'''
(quote, (x, stack)) = stack
pushes its body expression onto the pending expression (the
continuation) and returns control to the interpreter.
-.. code:: ipython2
+.. code:: ipython3
- print joy.library.definitions
+ print(joy.library.definitions)
.. parsed-literal::
- ? == dup truthy
- *fraction == [uncons] dip uncons [swap] dip concat [*] infra [*] dip cons
- *fraction0 == concat [[swap] dip * [*] dip] infra
- anamorphism == [pop []] swap [dip swons] genrec
- average == [sum 1.0 *] [size] cleave /
- binary == nullary [popop] dip
- cleave == fork [popd] dip
- codireco == cons dip rest cons
- dinfrirst == dip infra first
- unstack == ? [uncons ?] loop pop
- down_to_zero == [0 >] [dup --] while
- dupdipd == dup dipd
- enstacken == stack [clear] dip
- flatten == [] swap [concat] step
- fork == [i] app2
- gcd == 1 [tuck modulus dup 0 >] loop pop
- ifte == [nullary not] dipd branch
- ii == [dip] dupdip i
- least_fraction == dup [gcd] infra [div] concat map
- make_generator == [codireco] ccons
- nullary == [stack] dinfrirst
- of == swap at
- pam == [i] map
- primrec == [i] genrec
- product == 1 swap [*] step
- quoted == [unit] dip
- range == [0 <=] [1 - dup] anamorphism
- range_to_zero == unit [down_to_zero] infra
- run == [] swap infra
- size == 0 swap [pop ++] step
- sqr == dup mul
- step_zero == 0 roll> step
- swoncat == swap concat
- ternary == unary [popop] dip
- unary == nullary popd
- unquoted == [i] dip
- while == swap [nullary] cons dup dipd concat loop
+ ? dup truthy
+ *fraction [uncons] dip uncons [swap] dip concat [*] infra [*] dip cons
+ *fraction0 concat [[swap] dip * [*] dip] infra
+ anamorphism [pop []] swap [dip swons] genrec
+ average [sum 1.0 *] [size] cleave /
+ binary nullary [popop] dip
+ cleave fork [popd] dip
+ codireco cons dip rest cons
+ dinfrirst dip infra first
+ unstack ? [uncons ?] loop pop
+ down_to_zero [0 >] [dup --] while
+ dupdipd dup dipd
+ enstacken stack [clear] dip
+ flatten [] swap [concat] step
+ fork [i] app2
+ gcd 1 [tuck modulus dup 0 >] loop pop
+ ifte [nullary not] dipd branch
+ ii [dip] dupdip i
+ least_fraction dup [gcd] infra [div] concat map
+ make_generator [codireco] ccons
+ nullary [stack] dinfrirst
+ of swap at
+ pam [i] map
+ tailrec [i] genrec
+ product 1 swap [*] step
+ quoted [unit] dip
+ range [0 <=] [1 - dup] anamorphism
+ range_to_zero unit [down_to_zero] infra
+ run [] swap infra
+ size 0 swap [pop ++] step
+ sqr dup mul
+ step_zero 0 roll> step
+ swoncat swap concat
+ tailrec [i] genrec
+ ternary unary [popop] dip
+ unary nullary popd
+ unquoted [i] dip
+ while swap [nullary] cons dup dipd concat loop