1 # -*- coding: utf-8 -*-
3 # Copyright © 2014, 2015, 2017, 2018 Simon Forman
5 # This file is part of Thun
7 # Thun is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # Thun is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Thun. If not see <http://www.gnu.org/licenses/>.
21 This module contains the Joy function infrastructure and a library of
22 functions. Its main export is a Python function initialize() that
23 returns a dictionary of Joy functions suitable for use with the joy()
26 from logging import getLogger
28 _log = getLogger(__name__)
29 _log.info('Loading library.')
31 from inspect import getdoc
32 from functools import wraps
33 from itertools import count
34 from inspect import getmembers, isfunction
37 from .parser import text_to_expression, Symbol
38 from .utils.stack import expression_to_string, list_to_stack, iter_stack, pick, concat
39 from .utils.brutal_hackery import rename_code_object
41 from .utils import generated_library as genlib
42 from .utils.types import (
64 poly_combinator_effect,
65 doc_from_stack_effect,
69 _SYM_NUMS = count().next
70 _COMB_NUMS = count().next
74 A = a0, a1, a2, a3, a4, a5, a6, a7, a8, a9 = map(AnyJoyType, _R)
75 B = b0, b1, b2, b3, b4, b5, b6, b7, b8, b9 = map(BooleanJoyType, _R)
76 N = n0, n1, n2, n3, n4, n5, n6, n7, n8, n9 = map(NumberJoyType, _R)
77 S = s0, s1, s2, s3, s4, s5, s6, s7, s8, s9 = map(StackJoyType, _R)
78 F = f0, f1, f2, f3, f4, f5, f6, f7, f8, f9 = map(FloatJoyType, _R)
79 I = i0, i1, i2, i3, i4, i5, i6, i7, i8, i9 = map(IntJoyType, _R)
80 T = t0, t1, t2, t3, t4, t5, t6, t7, t8, t9 = map(TextJoyType, _R)
84 As = map(AnyStarJoyType, _R)
85 Ns = map(NumberStarJoyType, _R)
86 Ss = map(StackStarJoyType, _R)
89 sec0 = stack_effect(t1)()
90 sec1 = stack_effect(s0, i1)(s1)
91 sec2 = stack_effect(s0, i1)(a1)
92 sec_binary_cmp = stack_effect(n1, n2)(b1)
93 sec_binary_ints = stack_effect(i1, i2)(i3)
94 sec_binary_logic = stack_effect(b1, b2)(b3)
95 sec_binary_math = stack_effect(n1, n2)(n3)
96 sec_unary_logic = stack_effect(a1)(b1)
97 sec_unary_math = stack_effect(n1)(n2)
98 sec_Ns_math = stack_effect((Ns[1], s1),)(n0)
103 def inscribe(function):
104 '''A decorator to inscribe functions into the default dictionary.'''
105 _dictionary[function.name] = function
110 '''Return a dictionary of Joy functions for use with joy().'''
111 return _dictionary.copy()
117 ('bool', ['truthy']),
119 ('floordiv', ['/floor', '//']),
120 ('floor', ['round']),
122 ('mod', ['%', 'rem', 'remainder', 'modulus']),
125 ('getitem', ['pick', 'at']),
130 ('ne', ['<>', '!=']),
136 ('rolldown', ['roll<']),
137 ('rollup', ['roll>']),
143 def add_aliases(D, A):
145 Given a dict and a iterable of (name, [alias, ...]) pairs, create
146 additional entries in the dict mapping each alias to the named function
147 if it's in the dict. Aliases for functions not in the dict are ignored.
149 for name, aliases in A:
154 for alias in aliases:
160 Return a dict of named stack effects.
162 "Yin" functions are those that only rearrange items in stacks and
163 can be defined completely by their stack effects. This means they
164 can be auto-compiled.
166 # pylint: disable=unused-variable
167 cons = ef(a1, s0)((a1, s0))
168 ccons = compose(cons, cons)
170 dupd = ef(a2, a1)(a2, a2, a1)
171 dupdd = ef(a3, a2, a1)(a3, a3, a2, a1)
172 first = ef((a1, s1),)(a1,)
173 over = ef(a2, a1)(a2, a1, a2)
175 popd = ef(a2, a1,)(a1)
176 popdd = ef(a3, a2, a1,)(a2, a1,)
177 popop = ef(a2, a1,)()
178 popopd = ef(a3, a2, a1,)(a1)
179 popopdd = ef(a4, a3, a2, a1,)(a2, a1)
180 rest = ef((a1, s0),)(s0,)
181 rolldown = ef(a1, a2, a3)(a2, a3, a1)
182 rollup = ef(a1, a2, a3)(a3, a1, a2)
183 rrest = compose(rest, rest)
184 second = compose(rest, first)
186 swaack = (s1, s0), (s0, s1)
187 swap = ef(a1, a2)(a2, a1)
188 swons = compose(swap, cons)
189 third = compose(rest, second)
190 tuck = ef(a2, a1)(a1, a2, a1)
191 uncons = ef((a1, s0),)(a1, s0)
192 unswons = compose(uncons, swap)
193 stuncons = compose(stack, uncons)
194 stununcons = compose(stack, uncons, uncons)
195 unit = ef(a1)((a1, ()))
197 first_two = compose(uncons, uncons, pop)
198 fourth = compose(rest, third)
200 _Tree_add_Ee = compose(pop, swap, rolldown, rrest, ccons)
201 _Tree_get_E = compose(popop, second)
202 _Tree_delete_clear_stuff = compose(rollup, popop, rest)
203 _Tree_delete_R0 = compose(over, first, swap, dup)
211 product == 1 swap [*] step
212 flatten == [] swap [concat] step
215 enstacken == stack [clear] dip
217 disenstacken == ? [uncons ?] loop pop
218 dinfrirst == dip infra first
219 nullary == [stack] dinfrirst
220 unary == nullary popd
221 binary == nullary [popop] dip
222 ternary == unary [popop] dip
226 size == 0 swap [pop ++] step
228 cleave == fork [popd] dip
229 average == [sum 1.0 *] [size] cleave /
230 gcd == 1 [tuck modulus dup 0 >] loop pop
231 least_fraction == dup [gcd] infra [div] concat map
232 *fraction == [uncons] dip uncons [swap] dip concat [*] infra [*] dip cons
233 *fraction0 == concat [[swap] dip * [*] dip] infra
234 down_to_zero == [0 >] [dup --] while
235 range_to_zero == unit [down_to_zero] infra
236 anamorphism == [pop []] swap [dip swons] genrec
237 range == [0 <=] [1 - dup] anamorphism
238 while == swap [nullary] cons dup dipd concat loop
240 primrec == [i] genrec
241 step_zero == 0 roll> step
242 codireco == cons dip rest cons
243 make_generator == [codireco] ccons
244 ifte == [nullary not] dipd branch
248 # ifte == [nullary] dipd swap branch
249 # genrec == [[genrec] cons cons cons cons] nullary swons concat ifte
251 # Another definition for while. FWIW
252 # while == over [[i] dip nullary] ccons [nullary] dip loop
256 ##second == rest first
257 ##third == rest rest first
259 ##swoncat == swap concat
262 ##z-down == [] swap uncons swap
263 ##z-up == swons swap shunt
264 ##z-right == [swons] cons dip uncons swap
265 ##z-left == swons [uncons swap] dip swap
268 ##divisor == popop 2 *
270 ##radical == swap dup * rollup * 4 * - sqrt
273 ##q0 == [[divisor] [minusb] [radical]] pam
274 ##q1 == [[root1] [root2]] pam
275 ##quadratic == [q0] ternary i [q1] ternary
279 ##PE1.1 == + dup [+] dip
280 ##PE1.2 == dup [3 & PE1.1] dip 2 >>
281 ##PE1.3 == 14811 swap [PE1.2] times pop
282 ##PE1 == 0 0 66 [7 PE1.3] times 4 PE1.3 pop
284 #PE1.2 == [PE1.1] step
285 #PE1 == 0 0 66 [[3 2 1 3 1 2 3] PE1.2] times [3 2 1 3] PE1.2 pop
289 def FunctionWrapper(f):
290 '''Set name attribute.'''
292 raise ValueError('Function %s must have doc string.' % f.__name__)
293 f.name = f.__name__.rstrip('_') # Don't shadow builtins.
297 def SimpleFunctionWrapper(f):
299 Wrap functions that take and return just a stack.
303 @rename_code_object(f.__name__)
304 def inner(stack, expression, dictionary):
305 return f(stack), expression, dictionary
309 def BinaryBuiltinWrapper(f):
311 Wrap functions that take two arguments and return a single result.
315 @rename_code_object(f.__name__)
316 def inner(stack, expression, dictionary):
317 (a, (b, stack)) = stack
319 return (result, stack), expression, dictionary
323 def UnaryBuiltinWrapper(f):
325 Wrap functions that take one argument and return a single result.
329 @rename_code_object(f.__name__)
330 def inner(stack, expression, dictionary):
333 return (result, stack), expression, dictionary
337 class DefinitionWrapper(object):
339 Provide implementation of defined functions, and some helper methods.
342 def __init__(self, name, body_text, doc=None):
343 self.name = self.__name__ = name
344 self.body = text_to_expression(body_text)
345 self._body = tuple(iter_stack(self.body))
346 self.__doc__ = doc or body_text
347 self._compiled = None
349 def __call__(self, stack, expression, dictionary):
351 return self._compiled(stack, expression, dictionary) # pylint: disable=E1102
352 expression = list_to_stack(self._body, expression)
353 return stack, expression, dictionary
356 def parse_definition(class_, defi):
358 Given some text describing a Joy function definition parse it and
359 return a DefinitionWrapper.
361 name, proper, body_text = (n.strip() for n in defi.partition('=='))
363 raise ValueError('Definition %r failed' % (defi,))
364 return class_(name, body_text)
367 def add_definitions(class_, defs, dictionary):
369 Scan multi-line string defs for definitions and add them to the
372 for definition in _text_to_defs(defs):
373 class_.add_def(definition, dictionary)
376 def add_def(class_, definition, dictionary, fail_fails=False):
378 Add the definition to the dictionary.
380 F = class_.parse_definition(definition)
381 _log.info('Adding definition %s := %s', F.name, expression_to_string(F.body))
382 dictionary[F.name] = F
385 def load_definitions(class_, filename, dictionary):
386 with open(filename) as f:
387 lines = [line for line in f if '==' in line]
389 class_.add_def(line, dictionary)
392 def _text_to_defs(text):
393 return (line.strip() for line in text.splitlines() if '==' in line)
404 def inscribe_(stack, expression, dictionary):
406 Create a new Joy function definition in the Joy dictionary. A
407 definition is given as a string with a name followed by a double
408 equal sign then one or more Joy functions, the body. for example:
412 If you want the definition to persist over restarts, enter it into
413 the definitions.txt resource.
415 definition, stack = stack
416 DefinitionWrapper.add_def(definition, dictionary, fail_fails=True)
417 return stack, expression, dictionary
421 @SimpleFunctionWrapper
423 '''Parse the string on the stack to a Joy expression.'''
425 expression = text_to_expression(text)
426 return expression, stack
430 @SimpleFunctionWrapper
432 '''Attempt to infer the stack effect of a Joy expression.'''
434 effects = infer_expression(E)
435 e = list_to_stack([(fi, (fo, ())) for fi, fo in effects])
441 @SimpleFunctionWrapper
446 getitem == drop first
448 Expects an integer and a quote on the stack and returns the item at the
449 nth position in the quote counting from 0.
453 -------------------------
457 n, (Q, stack) = stack
458 return pick(Q, n), stack
463 @SimpleFunctionWrapper
470 Expects an integer and a quote on the stack and returns the quote with
471 n items removed off the top.
475 ----------------------
479 n, (Q, stack) = stack
491 @SimpleFunctionWrapper
494 Expects an integer and a quote on the stack and returns the quote with
495 just the top n items in reverse order (because that's easier and you can
496 use reverse if needed.)
500 ----------------------
504 n, (Q, stack) = stack
517 @SimpleFunctionWrapper
520 Use a Boolean value to select one of two items.
524 ----------------------
529 ---------------------
532 Currently Python semantics are used to evaluate the "truthiness" of the
533 Boolean value (so empty string, zero, etc. are counted as false, etc.)
535 (if_, (then, (else_, stack))) = stack
536 return then if if_ else else_, stack
540 @SimpleFunctionWrapper
543 Use a Boolean value to select one of two items from a sequence.
547 ------------------------
552 -----------------------
555 The sequence can contain more than two items but not fewer.
556 Currently Python semantics are used to evaluate the "truthiness" of the
557 Boolean value (so empty string, zero, etc. are counted as false, etc.)
559 (flag, (choices, stack)) = stack
560 (else_, (then, _)) = choices
561 return then if flag else else_, stack
566 @SimpleFunctionWrapper
568 '''Given a list find the maximum.'''
570 return max(iter_stack(tos)), stack
575 @SimpleFunctionWrapper
577 '''Given a list find the minimum.'''
579 return min(iter_stack(tos)), stack
584 @SimpleFunctionWrapper
586 '''Given a quoted sequence of numbers return the sum.
588 sum == 0 swap [+] step
591 return sum(iter_stack(tos)), stack
595 @SimpleFunctionWrapper
598 Expects an item on the stack and a quote under it and removes that item
599 from the the quote. The item is only removed once.
603 ------------------------
607 (tos, (second, stack)) = S
608 l = list(iter_stack(second))
610 return list_to_stack(l), stack
614 @SimpleFunctionWrapper
616 '''Given a list remove duplicate items.'''
618 I = list(iter_stack(tos))
619 list_to_stack(sorted(set(I), key=I.index))
620 return list_to_stack(sorted(set(I), key=I.index)), stack
624 @SimpleFunctionWrapper
626 '''Given a list return it sorted.'''
628 return list_to_stack(sorted(iter_stack(tos))), stack
631 _functions['clear'] = s0, s1
633 @SimpleFunctionWrapper
635 '''Clear everything from the stack.
638 clear == stack [pop stack] loop
648 @SimpleFunctionWrapper
651 The unstack operator expects a list on top of the stack and makes that
652 the stack discarding the rest of the stack.
658 @SimpleFunctionWrapper
660 '''Reverse the list on the top of the stack.
663 reverse == [] swap shunt
667 for term in iter_stack(tos):
673 @combinator_effect(_COMB_NUMS(), s7, s6)
674 @SimpleFunctionWrapper
676 '''Concatinate the two lists on the top of the stack.
679 [a b c] [d e f] concat
680 ----------------------------
684 (tos, (second, stack)) = S
685 return concat(second, tos), stack
689 @SimpleFunctionWrapper
691 '''Like concat but reverses the top list into the second.
694 shunt == [swons] step == reverse swap concat
696 [a b c] [d e f] shunt
697 ---------------------------
701 (tos, (second, stack)) = stack
704 second = term, second
709 @SimpleFunctionWrapper
712 Replace the two lists on the top of the stack with a list of the pairs
713 from each list. The smallest list sets the length of the result list.
715 (tos, (second, stack)) = S
718 for a, b in zip(iter_stack(tos), iter_stack(second))
720 return list_to_stack(accumulator), stack
725 @SimpleFunctionWrapper
729 return tos + 1, stack
734 @SimpleFunctionWrapper
738 return tos - 1, stack
742 @SimpleFunctionWrapper
753 a, (b, stack) = stack
759 return int(math.floor(n))
761 floor.__doc__ = math.floor.__doc__
765 @SimpleFunctionWrapper
768 divmod(x, y) -> (quotient, remainder)
770 Return the tuple (x//y, x%y). Invariant: div*y + mod == x.
779 Return the square root of the number a.
780 Negative numbers return complex roots.
785 assert a < 0, repr(a)
786 r = math.sqrt(-a) * 1j
792 # if isinstance(text, str):
793 # return run(text, stack)
798 @SimpleFunctionWrapper
800 '''The identity function.'''
805 @SimpleFunctionWrapper
807 '''True if the form on TOS is void otherwise False.'''
809 return _void(form), stack
813 return any(not _void(i) for i in iter_stack(form))
824 def words(stack, expression, dictionary):
825 '''Print all the words in alphabetical order.'''
826 print(' '.join(sorted(dictionary)))
827 return stack, expression, dictionary
832 def sharing(stack, expression, dictionary):
833 '''Print redistribution information.'''
834 print("You may convey verbatim copies of the Program's source code as"
835 ' you receive it, in any medium, provided that you conspicuously'
836 ' and appropriately publish on each copy an appropriate copyright'
837 ' notice; keep intact all notices stating that this License and'
838 ' any non-permissive terms added in accord with section 7 apply'
839 ' to the code; keep intact all notices of the absence of any'
840 ' warranty; and give all recipients a copy of this License along'
842 ' You should have received a copy of the GNU General Public License'
843 ' along with Thun. If not see <http://www.gnu.org/licenses/>.')
844 return stack, expression, dictionary
849 def warranty(stack, expression, dictionary):
850 '''Print warranty information.'''
851 print('THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY'
852 ' APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE'
853 ' COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM'
854 ' "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR'
855 ' IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES'
856 ' OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE'
857 ' ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS'
858 ' WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE'
859 ' COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.')
860 return stack, expression, dictionary
863 # def simple_manual(stack):
865 # Print words and help for each word.
867 # for name, f in sorted(FUNCTIONS.items()):
869 # boxline = '+%s+' % ('-' * (len(name) + 2))
872 # '| %s |' % (name,),
874 # d if d else ' ...',
884 def help_(S, expression, dictionary):
885 '''Accepts a quoted symbol on the top of the stack and prints its docs.'''
886 ((symbol, _), stack) = S
887 word = dictionary[symbol]
889 return stack, expression, dictionary
897 # Several combinators depend on other words in their definitions,
898 # we use symbols to prevent hard-coding these, so in theory, you
899 # could change the word in the dictionary to use different semantics.
900 S_choice = Symbol('choice')
901 S_first = Symbol('first')
902 S_getitem = Symbol('getitem')
903 S_genrec = Symbol('genrec')
904 S_loop = Symbol('loop')
906 S_ifte = Symbol('ifte')
907 S_infra = Symbol('infra')
908 S_pop = Symbol('pop')
909 S_step = Symbol('step')
910 S_times = Symbol('times')
911 S_swaack = Symbol('swaack')
915 @combinator_effect(_COMB_NUMS(), s1)
917 def i(stack, expression, dictionary):
919 The i combinator expects a quoted program on the stack and unpacks it
920 onto the pending expression for evaluation.
929 return stack, concat(quote, expression), dictionary
933 @combinator_effect(_COMB_NUMS(), s1)
935 def x(stack, expression, dictionary):
941 ... [Q] x = ... [Q] dup i
942 ... [Q] x = ... [Q] [Q] i
943 ... [Q] x = ... [Q] Q
947 return stack, concat(quote, expression), dictionary
951 @combinator_effect(_COMB_NUMS(), s7, s6)
953 def b(stack, expression, dictionary):
959 ... [P] [Q] b == ... [P] i [Q] i
960 ... [P] [Q] b == ... P Q
963 q, (p, (stack)) = stack
964 return stack, concat(p, concat(q, expression)), dictionary
968 @combinator_effect(_COMB_NUMS(), a1, s1)
970 def dupdip(stack, expression, dictionary):
974 [F] dupdip == dup [F] dip
984 return stack, concat(F, (a, expression)), dictionary
988 @combinator_effect(_COMB_NUMS(), s7, s6)
990 def infra(stack, expression, dictionary):
992 Accept a quoted program and a list on the stack and run the program
993 with the list as its stack. Does not affect the rest of the stack.
996 ... [a b c] [Q] . infra
997 -----------------------------
998 c b a . Q [...] swaack
1001 (quote, (aggregate, stack)) = stack
1002 return aggregate, concat(quote, (stack, (S_swaack, expression))), dictionary
1006 #@combinator_effect(_COMB_NUMS(), s7, s6, s5, s4)
1008 def genrec(stack, expression, dictionary):
1010 General Recursion Combinator.
1013 [if] [then] [rec1] [rec2] genrec
1014 ---------------------------------------------------------------------
1015 [if] [then] [rec1 [[if] [then] [rec1] [rec2] genrec] rec2] ifte
1017 From "Recursion Theory and Joy" (j05cmp.html) by Manfred von Thun:
1018 "The genrec combinator takes four program parameters in addition to
1019 whatever data parameters it needs. Fourth from the top is an if-part,
1020 followed by a then-part. If the if-part yields true, then the then-part
1021 is executed and the combinator terminates. The other two parameters are
1022 the rec1-part and the rec2-part. If the if-part yields false, the
1023 rec1-part is executed. Following that the four program parameters and
1024 the combinator are again pushed onto the stack bundled up in a quoted
1025 form. Then the rec2-part is executed, where it will find the bundled
1026 form. Typically it will then execute the bundled form, either with i or
1027 with app2, or some other combinator."
1029 The way to design one of these is to fix your base case [then] and the
1030 test [if], and then treat rec1 and rec2 as an else-part "sandwiching"
1031 a quotation of the whole function.
1033 For example, given a (general recursive) function 'F':
1036 F == [I] [T] [R1] [R2] genrec
1038 If the [I] if-part fails you must derive R1 and R2 from:
1043 Just set the stack arguments in front, and figure out what R1 and R2
1044 have to do to apply the quoted [F] in the proper way. In effect, the
1045 genrec combinator turns into an ifte combinator with a quoted copy of
1046 the original definition in the else-part:
1049 F == [I] [T] [R1] [R2] genrec
1050 == [I] [T] [R1 [F] R2] ifte
1052 Primitive recursive functions are those where R2 == i.
1055 P == [I] [T] [R] primrec
1056 == [I] [T] [R [P] i] ifte
1057 == [I] [T] [R P] ifte
1060 (rec2, (rec1, stack)) = stack
1061 (then, (if_, _)) = stack
1062 F = (if_, (then, (rec1, (rec2, (S_genrec, ())))))
1063 else_ = concat(rec1, (F, rec2))
1064 return (else_, stack), (S_ifte, expression), dictionary
1068 @combinator_effect(_COMB_NUMS(), s7, s6)
1070 def map_(S, expression, dictionary):
1072 Run the quoted program on TOS on the items in the list under it, push a
1073 new list with the results in place of the program and original list.
1075 # (quote, (aggregate, stack)) = S
1076 # results = list_to_stack([
1077 # joy((term, stack), quote, dictionary)[0][0]
1078 # for term in iter_stack(aggregate)
1080 # return (results, stack), expression, dictionary
1081 (quote, (aggregate, stack)) = S
1083 return (aggregate, stack), expression, dictionary
1085 for term in iter_stack(aggregate):
1087 batch = (s, (quote, (S_infra, (S_first, batch))))
1088 stack = (batch, ((), stack))
1089 return stack, (S_infra, expression), dictionary
1092 #def cleave(S, expression, dictionary):
1094 # The cleave combinator expects two quotations, and below that an item X.
1095 # It first executes [P], with X on top, and saves the top result element.
1096 # Then it executes [Q], again with X, and saves the top result.
1097 # Finally it restores the stack to what it was below X and pushes the two
1098 # results P(X) and Q(X).
1100 # (Q, (P, (x, stack))) = S
1101 # p = joy((x, stack), P, dictionary)[0][0]
1102 # q = joy((x, stack), Q, dictionary)[0][0]
1103 # return (q, (p, stack)), expression, dictionary
1106 def branch_true(stack, expression, dictionary):
1107 # pylint: disable=unused-variable
1108 (then, (else_, (flag, stack))) = stack
1109 return stack, concat(then, expression), dictionary
1112 def branch_false(stack, expression, dictionary):
1113 # pylint: disable=unused-variable
1114 (then, (else_, (flag, stack))) = stack
1115 return stack, concat(else_, expression), dictionary
1119 @poly_combinator_effect(_COMB_NUMS(), [branch_true, branch_false], b1, s7, s6)
1121 def branch(stack, expression, dictionary):
1123 Use a Boolean value to select one of two quoted programs to run.
1127 branch == roll< choice i
1131 False [F] [T] branch
1132 --------------------------
1136 -------------------------
1140 (then, (else_, (flag, stack))) = stack
1141 return stack, concat(then if flag else else_, expression), dictionary
1144 #FUNCTIONS['branch'] = CombinatorJoyType('branch', [branch_true, branch_false], 100)
1149 ##def ifte(stack, expression, dictionary):
1151 ## If-Then-Else Combinator
1154 ## ... [if] [then] [else] ifte
1155 ## ---------------------------------------------------
1156 ## ... [[else] [then]] [...] [if] infra select i
1161 ## ... [if] [then] [else] ifte
1162 ## -------------------------------------------------------
1163 ## ... [else] [then] [...] [if] infra first choice i
1166 ## Has the effect of grabbing a copy of the stack on which to run the
1167 ## if-part using infra.
1169 ## (else_, (then, (if_, stack))) = stack
1170 ## expression = (S_infra, (S_first, (S_choice, (S_i, expression))))
1171 ## stack = (if_, (stack, (then, (else_, stack))))
1172 ## return stack, expression, dictionary
1177 def cond(stack, expression, dictionary):
1179 This combinator works like a case statement. It expects a single quote
1180 on the stack that must contain zero or more condition quotes and a
1181 default quote. Each condition clause should contain a quoted predicate
1182 followed by the function expression to run if that predicate returns
1183 true. If no predicates return true the default function runs.
1185 It works by rewriting into a chain of nested `ifte` expressions, e.g.::
1187 [[[B0] T0] [[B1] T1] [D]] cond
1188 -----------------------------------------
1189 [B0] [T0] [[B1] [T1] [D] ifte] ifte
1192 conditions, stack = stack
1194 expression = _cond(conditions, expression)
1196 # Attempt to preload the args to first ifte.
1197 (P, (T, (E, expression))) = expression
1199 # If, for any reason, the argument to cond should happen to contain
1200 # only the default clause then this optimization will fail.
1203 stack = (E, (T, (P, stack)))
1204 return stack, expression, dictionary
1207 def _cond(conditions, expression):
1208 (clause, rest) = conditions
1209 if not rest: # clause is [D]
1212 return (P, (T, (_cond(rest, ()), (S_ifte, expression))))
1216 @combinator_effect(_COMB_NUMS(), a1, s1)
1218 def dip(stack, expression, dictionary):
1220 The dip combinator expects a quoted program on the stack and below it
1221 some item, it hoists the item into the expression and runs the program
1222 on the rest of the stack.
1230 (quote, (x, stack)) = stack
1231 expression = (x, expression)
1232 return stack, concat(quote, expression), dictionary
1236 @combinator_effect(_COMB_NUMS(), a2, a1, s1)
1238 def dipd(S, expression, dictionary):
1240 Like dip but expects two items.
1244 ---------------------
1248 (quote, (x, (y, stack))) = S
1249 expression = (y, (x, expression))
1250 return stack, concat(quote, expression), dictionary
1254 @combinator_effect(_COMB_NUMS(), a3, a2, a1, s1)
1256 def dipdd(S, expression, dictionary):
1258 Like dip but expects three items.
1262 -----------------------
1266 (quote, (x, (y, (z, stack)))) = S
1267 expression = (z, (y, (x, expression)))
1268 return stack, concat(quote, expression), dictionary
1272 @combinator_effect(_COMB_NUMS(), a1, s1)
1274 def app1(S, expression, dictionary):
1276 Given a quoted program on TOS and anything as the second stack item run
1277 the program and replace the two args with the first result of the
1282 -----------------------------------
1283 ... [x ...] [Q] . infra first
1285 (quote, (x, stack)) = S
1286 stack = (quote, ((x, stack), stack))
1287 expression = (S_infra, (S_first, expression))
1288 return stack, expression, dictionary
1292 @combinator_effect(_COMB_NUMS(), a2, a1, s1)
1294 def app2(S, expression, dictionary):
1295 '''Like app1 with two items.
1299 -----------------------------------
1300 ... [y ...] [Q] . infra first
1301 [x ...] [Q] infra first
1304 (quote, (x, (y, stack))) = S
1305 expression = (S_infra, (S_first,
1306 ((x, stack), (quote, (S_infra, (S_first,
1308 stack = (quote, ((y, stack), stack))
1309 return stack, expression, dictionary
1313 @combinator_effect(_COMB_NUMS(), a3, a2, a1, s1)
1315 def app3(S, expression, dictionary):
1316 '''Like app1 with three items.
1319 ... z y x [Q] . app3
1320 -----------------------------------
1321 ... [z ...] [Q] . infra first
1322 [y ...] [Q] infra first
1323 [x ...] [Q] infra first
1326 (quote, (x, (y, (z, stack)))) = S
1327 expression = (S_infra, (S_first,
1328 ((y, stack), (quote, (S_infra, (S_first,
1329 ((x, stack), (quote, (S_infra, (S_first,
1330 expression))))))))))
1331 stack = (quote, ((z, stack), stack))
1332 return stack, expression, dictionary
1336 @combinator_effect(_COMB_NUMS(), s7, s6)
1338 def step(S, expression, dictionary):
1340 Run a quoted program on each item in a sequence.
1344 -----------------------
1349 ------------------------
1353 ... [a b c] [Q] . step
1354 ----------------------------------------
1355 ... a . Q [b c] [Q] step
1357 The step combinator executes the quotation on each member of the list
1358 on top of the stack.
1360 (quote, (aggregate, stack)) = S
1362 return stack, expression, dictionary
1363 head, tail = aggregate
1364 stack = quote, (head, stack)
1366 expression = tail, (quote, (S_step, expression))
1367 expression = S_i, expression
1368 return stack, expression, dictionary
1372 @combinator_effect(_COMB_NUMS(), i1, s6)
1374 def times(stack, expression, dictionary):
1376 times == [-- dip] cons [swap] infra [0 >] swap while pop
1380 --------------------- w/ n <= 0
1385 ---------------------------------
1390 --------------------------------- w/ n > 1
1391 ... . Q (n - 1) [Q] times
1394 # times == [-- dip] cons [swap] infra [0 >] swap while pop
1395 (quote, (n, stack)) = stack
1397 return stack, expression, dictionary
1400 expression = n, (quote, (S_times, expression))
1401 expression = concat(quote, expression)
1402 return stack, expression, dictionary
1405 # The current definition above works like this:
1408 # --------------------------------------
1409 # [P] nullary [Q [P] nullary] loop
1411 # while == [pop i not] [popop] [dudipd] primrec
1413 #def while_(S, expression, dictionary):
1414 # '''[if] [body] while'''
1415 # (body, (if_, stack)) = S
1416 # while joy(stack, if_, dictionary)[0][0]:
1417 # stack = joy(stack, body, dictionary)[0]
1418 # return stack, expression, dictionary
1421 def loop_true(stack, expression, dictionary):
1422 quote, (flag, stack) = stack # pylint: disable=unused-variable
1423 return stack, concat(quote, (S_pop, expression)), dictionary
1425 def loop_two_true(stack, expression, dictionary):
1426 quote, (flag, stack) = stack # pylint: disable=unused-variable
1427 return stack, concat(quote, (S_pop, concat(quote, (S_pop, expression)))), dictionary
1429 def loop_false(stack, expression, dictionary):
1430 quote, (flag, stack) = stack # pylint: disable=unused-variable
1431 return stack, expression, dictionary
1435 @poly_combinator_effect(_COMB_NUMS(), [loop_two_true, loop_true, loop_false], b1, s6)
1437 def loop(stack, expression, dictionary):
1439 Basic loop combinator.
1443 -----------------------
1447 ------------------------
1451 quote, (flag, stack) = stack
1453 expression = concat(quote, (quote, (S_loop, expression)))
1454 return stack, expression, dictionary
1458 @combinator_effect(_COMB_NUMS(), a1, a2, s6, s7, s8)
1460 def cmp_(stack, expression, dictionary):
1462 cmp takes two values and three quoted programs on the stack and runs
1463 one of the three depending on the results of comparing the two values:
1467 ------------------------- a > b
1471 ------------------------- a = b
1475 ------------------------- a < b
1478 L, (E, (G, (b, (a, stack)))) = stack
1479 expression = concat(G if a > b else L if a < b else E, expression)
1480 return stack, expression, dictionary
1483 # FunctionWrapper(cleave),
1484 # FunctionWrapper(while_),
1489 #divmod_ = pm = __(n2, n1), __(n4, n3)
1491 sec_binary_cmp(BinaryBuiltinWrapper(operator.eq)),
1492 sec_binary_cmp(BinaryBuiltinWrapper(operator.ge)),
1493 sec_binary_cmp(BinaryBuiltinWrapper(operator.gt)),
1494 sec_binary_cmp(BinaryBuiltinWrapper(operator.le)),
1495 sec_binary_cmp(BinaryBuiltinWrapper(operator.lt)),
1496 sec_binary_cmp(BinaryBuiltinWrapper(operator.ne)),
1498 sec_binary_ints(BinaryBuiltinWrapper(operator.xor)),
1499 sec_binary_ints(BinaryBuiltinWrapper(operator.lshift)),
1500 sec_binary_ints(BinaryBuiltinWrapper(operator.rshift)),
1502 sec_binary_logic(BinaryBuiltinWrapper(operator.and_)),
1503 sec_binary_logic(BinaryBuiltinWrapper(operator.or_)),
1505 sec_binary_math(BinaryBuiltinWrapper(operator.add)),
1506 sec_binary_math(BinaryBuiltinWrapper(operator.floordiv)),
1507 sec_binary_math(BinaryBuiltinWrapper(operator.mod)),
1508 sec_binary_math(BinaryBuiltinWrapper(operator.mul)),
1509 sec_binary_math(BinaryBuiltinWrapper(operator.pow)),
1510 sec_binary_math(BinaryBuiltinWrapper(operator.sub)),
1511 sec_binary_math(BinaryBuiltinWrapper(operator.truediv)),
1513 sec_unary_logic(UnaryBuiltinWrapper(bool)),
1514 sec_unary_logic(UnaryBuiltinWrapper(operator.not_)),
1516 sec_unary_math(UnaryBuiltinWrapper(abs)),
1517 sec_unary_math(UnaryBuiltinWrapper(operator.neg)),
1518 sec_unary_math(UnaryBuiltinWrapper(sqrt)),
1520 stack_effect(n1)(i1)(UnaryBuiltinWrapper(floor)),
1523 del F # Otherwise Sphinx autodoc will pick it up.
1526 YIN_STACK_EFFECTS = yin_functions()
1527 add_aliases(YIN_STACK_EFFECTS, ALIASES)
1529 # Load the auto-generated primitives into the dictionary.
1530 _functions.update(YIN_STACK_EFFECTS)
1533 # eh = compose(dup, bool)
1534 # sqr = compose(dup, mul)
1535 # of = compose(swap, at)
1537 # ''' in dict(compose=compose), _functions
1538 for name in sorted(_functions):
1539 sec = _functions[name]
1540 F = FUNCTIONS[name] = SymbolJoyType(name, [sec], _SYM_NUMS())
1541 if name in YIN_STACK_EFFECTS:
1542 _log.info('Setting stack effect for Yin function %s := %s', F.name, doc_from_stack_effect(*sec))
1544 for name, primitive in getmembers(genlib, isfunction):
1545 inscribe(SimpleFunctionWrapper(primitive))
1548 add_aliases(_dictionary, ALIASES)
1549 add_aliases(_functions, ALIASES)
1550 add_aliases(FUNCTIONS, ALIASES)
1553 DefinitionWrapper.add_definitions(definitions, _dictionary)
1556 EXPECTATIONS = dict(
1557 ifte=(s7, (s6, (s5, s4))),
1561 EXPECTATIONS['while'] = (s7, (s6, s5))
1572 C = _dictionary[name]
1573 expect = EXPECTATIONS.get(name)
1575 sec = doc_from_stack_effect(expect)
1576 _log.info('Setting stack EXPECT for combinator %s := %s', C.name, sec)
1578 _log.info('combinator %s', C.name)
1579 FUNCTIONS[name] = CombinatorJoyType(name, [C], _COMB_NUMS(), expect)
1583 of quoted enstacken ?
1584 unary binary ternary
1587 of_ = _dictionary[name]
1588 secs = infer_expression(of_.body)
1589 assert len(secs) == 1, repr(secs)
1591 'Setting stack effect for definition %s := %s',
1593 doc_from_stack_effect(*secs[0]),
1595 FUNCTIONS[name] = SymbolJoyType(name, infer_expression(of_.body), _SYM_NUMS())
1598 #sec_Ns_math(_dictionary['product'])
1600 ## product == 1 swap [*] step
1601 ## flatten == [] swap [concat] step
1602 ## disenstacken == ? [uncons ?] loop pop
1604 ## size == 0 swap [pop ++] step
1606 ## cleave == fork [popd] dip
1607 ## average == [sum 1.0 *] [size] cleave /
1608 ## gcd == 1 [tuck modulus dup 0 >] loop pop
1609 ## least_fraction == dup [gcd] infra [div] concat map
1610 ## *fraction == [uncons] dip uncons [swap] dip concat [*] infra [*] dip cons
1611 ## *fraction0 == concat [[swap] dip * [*] dip] infra
1612 ## down_to_zero == [0 >] [dup --] while
1613 ## range_to_zero == unit [down_to_zero] infra
1614 ## anamorphism == [pop []] swap [dip swons] genrec
1615 ## range == [0 <=] [1 - dup] anamorphism
1616 ## while == swap [nullary] cons dup dipd concat loop
1617 ## dupdipd == dup dipd
1618 ## primrec == [i] genrec
1619 ## step_zero == 0 roll> step
1620 ## codireco == cons dip rest cons
1621 ## make_generator == [codireco] ccons
1622 ## ifte == [nullary not] dipd branch