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 inspect import getdoc
27 from functools import wraps
28 from itertools import count
29 from inspect import getmembers, isfunction
32 from .parser import text_to_expression, Symbol
33 from .utils.stack import expression_to_string, list_to_stack, iter_stack, pick, concat
34 from .utils.brutal_hackery import rename_code_object
36 from .utils import generated_library as genlib
37 from .utils.types import (
57 poly_combinator_effect,
61 _SYM_NUMS = count().next
62 _COMB_NUMS = count().next
66 A = a0, a1, a2, a3, a4, a5, a6, a7, a8, a9 = map(AnyJoyType, _R)
67 B = b0, b1, b2, b3, b4, b5, b6, b7, b8, b9 = map(BooleanJoyType, _R)
68 N = n0, n1, n2, n3, n4, n5, n6, n7, n8, n9 = map(NumberJoyType, _R)
69 S = s0, s1, s2, s3, s4, s5, s6, s7, s8, s9 = map(StackJoyType, _R)
70 F = f0, f1, f2, f3, f4, f5, f6, f7, f8, f9 = map(FloatJoyType, _R)
71 I = i0, i1, i2, i3, i4, i5, i6, i7, i8, i9 = map(IntJoyType, _R)
72 T = t0, t1, t2, t3, t4, t5, t6, t7, t8, t9 = map(TextJoyType, _R)
76 As = map(AnyStarJoyType, _R)
77 Ns = map(NumberStarJoyType, _R)
78 Ss = map(StackStarJoyType, _R)
81 sec0 = stack_effect(t1)()
82 sec1 = stack_effect(s0, i1)(s1)
83 sec2 = stack_effect(s0, i1)(a1)
84 sec_binary_cmp = stack_effect(n1, n2)(b1)
85 sec_binary_ints = stack_effect(i1, i2)(i3)
86 sec_binary_logic = stack_effect(b1, b2)(b3)
87 sec_binary_math = stack_effect(n1, n2)(n3)
88 sec_unary_logic = stack_effect(a1)(b1)
89 sec_unary_math = stack_effect(n1)(n2)
90 sec_Ns_math = stack_effect((Ns[1], s1),)(n0)
95 def inscribe(function):
96 '''A decorator to inscribe functions into the default dictionary.'''
97 _dictionary[function.name] = function
102 '''Return a dictionary of Joy functions for use with joy().'''
103 return _dictionary.copy()
109 ('bool', ['truthy']),
111 ('floordiv', ['/floor', '//']),
112 ('floor', ['round']),
114 ('mod', ['%', 'rem', 'remainder', 'modulus']),
117 ('getitem', ['pick', 'at']),
122 ('ne', ['<>', '!=']),
128 ('rolldown', ['roll<']),
129 ('rollup', ['roll>']),
135 def add_aliases(D, A):
137 Given a dict and a iterable of (name, [alias, ...]) pairs, create
138 additional entries in the dict mapping each alias to the named function
139 if it's in the dict. Aliases for functions not in the dict are ignored.
141 for name, aliases in A:
146 for alias in aliases:
152 Return a dict of named stack effects.
154 "Yin" functions are those that only rearrange items in stacks and
155 can be defined completely by their stack effects. This means they
156 can be auto-compiled.
158 # pylint: disable=unused-variable
159 cons = ef(a1, s0)((a1, s0))
160 ccons = compose(cons, cons)
162 dupd = ef(a2, a1)(a2, a2, a1)
163 dupdd = ef(a3, a2, a1)(a3, a3, a2, a1)
164 first = ef((a1, s1),)(a1,)
165 over = ef(a2, a1)(a2, a1, a2)
167 popd = ef(a2, a1,)(a1)
168 popdd = ef(a3, a2, a1,)(a2, a1,)
169 popop = ef(a2, a1,)()
170 popopd = ef(a3, a2, a1,)(a1)
171 popopdd = ef(a4, a3, a2, a1,)(a2, a1)
172 rest = ef((a1, s0),)(s0,)
173 rolldown = ef(a1, a2, a3)(a2, a3, a1)
174 rollup = ef(a1, a2, a3)(a3, a1, a2)
175 rrest = compose(rest, rest)
176 second = compose(rest, first)
178 swaack = (s1, s0), (s0, s1)
179 swap = ef(a1, a2)(a2, a1)
180 swons = compose(swap, cons)
181 third = compose(rest, second)
182 tuck = ef(a2, a1)(a1, a2, a1)
183 uncons = ef((a1, s0),)(a1, s0)
184 unswons = compose(uncons, swap)
185 stuncons = compose(stack, uncons)
186 stununcons = compose(stack, uncons, uncons)
187 unit = ef(a1)((a1, ()))
189 first_two = compose(uncons, uncons, pop)
190 fourth = compose(rest, third)
192 _Tree_add_Ee = compose(pop, swap, rolldown, rrest, ccons)
193 _Tree_get_E = compose(popop, second)
194 _Tree_delete_clear_stuff = compose(rollup, popop, rest)
195 _Tree_delete_R0 = compose(over, first, swap, dup)
198 name.rstrip('_'): stack_effect
199 for name, stack_effect in locals().iteritems()
205 product == 1 swap [*] step
206 flatten == [] swap [concat] step
209 enstacken == stack [clear] dip
210 disenstacken == ? [uncons ?] loop pop
212 dinfrirst == dip infra first
213 nullary == [stack] dinfrirst
214 unary == nullary popd
215 binary == nullary [popop] dip
216 ternary == unary [popop] dip
220 size == 0 swap [pop ++] step
222 cleave == fork [popd] dip
223 average == [sum 1.0 *] [size] cleave /
224 gcd == 1 [tuck modulus dup 0 >] loop pop
225 least_fraction == dup [gcd] infra [div] concat map
226 *fraction == [uncons] dip uncons [swap] dip concat [*] infra [*] dip cons
227 *fraction0 == concat [[swap] dip * [*] dip] infra
228 down_to_zero == [0 >] [dup --] while
229 range_to_zero == unit [down_to_zero] infra
230 anamorphism == [pop []] swap [dip swons] genrec
231 range == [0 <=] [1 - dup] anamorphism
232 while == swap [nullary] cons dup dipd concat loop
234 primrec == [i] genrec
235 step_zero == 0 roll> step
236 codireco == cons dip rest cons
237 make_generator == [codireco] ccons
238 ifte == [nullary not] dipd branch
242 # ifte == [nullary] dipd swap branch
243 # genrec == [[genrec] cons cons cons cons] nullary swons concat ifte
245 # Another definition for while. FWIW
246 # while == over [[i] dip nullary] ccons [nullary] dip loop
250 ##second == rest first
251 ##third == rest rest first
253 ##swoncat == swap concat
256 ##z-down == [] swap uncons swap
257 ##z-up == swons swap shunt
258 ##z-right == [swons] cons dip uncons swap
259 ##z-left == swons [uncons swap] dip swap
262 ##divisor == popop 2 *
264 ##radical == swap dup * rollup * 4 * - sqrt
267 ##q0 == [[divisor] [minusb] [radical]] pam
268 ##q1 == [[root1] [root2]] pam
269 ##quadratic == [q0] ternary i [q1] ternary
273 ##PE1.1 == + dup [+] dip
274 ##PE1.2 == dup [3 & PE1.1] dip 2 >>
275 ##PE1.3 == 14811 swap [PE1.2] times pop
276 ##PE1 == 0 0 66 [7 PE1.3] times 4 PE1.3 pop
278 #PE1.2 == [PE1.1] step
279 #PE1 == 0 0 66 [[3 2 1 3 1 2 3] PE1.2] times [3 2 1 3] PE1.2 pop
283 def FunctionWrapper(f):
284 '''Set name attribute.'''
286 raise ValueError('Function %s must have doc string.' % f.__name__)
287 f.name = f.__name__.rstrip('_') # Don't shadow builtins.
291 def SimpleFunctionWrapper(f):
293 Wrap functions that take and return just a stack.
297 @rename_code_object(f.__name__)
298 def inner(stack, expression, dictionary):
299 return f(stack), expression, dictionary
303 def BinaryBuiltinWrapper(f):
305 Wrap functions that take two arguments and return a single result.
309 @rename_code_object(f.__name__)
310 def inner(stack, expression, dictionary):
311 (a, (b, stack)) = stack
313 return (result, stack), expression, dictionary
317 def UnaryBuiltinWrapper(f):
319 Wrap functions that take one argument and return a single result.
323 @rename_code_object(f.__name__)
324 def inner(stack, expression, dictionary):
327 return (result, stack), expression, dictionary
331 class DefinitionWrapper(object):
333 Provide implementation of defined functions, and some helper methods.
336 def __init__(self, name, body_text, doc=None):
337 self.name = self.__name__ = name
338 self.body = text_to_expression(body_text)
339 self._body = tuple(iter_stack(self.body))
340 self.__doc__ = doc or body_text
341 self._compiled = None
343 def __call__(self, stack, expression, dictionary):
345 return self._compiled(stack, expression, dictionary) # pylint: disable=E1102
346 expression = list_to_stack(self._body, expression)
347 return stack, expression, dictionary
350 def parse_definition(class_, defi):
352 Given some text describing a Joy function definition parse it and
353 return a DefinitionWrapper.
355 name, proper, body_text = (n.strip() for n in defi.partition('=='))
357 raise ValueError('Definition %r failed' % (defi,))
358 return class_(name, body_text)
361 def add_definitions(class_, defs, dictionary):
363 Scan multi-line string defs for definitions and add them to the
366 for definition in _text_to_defs(defs):
367 class_.add_def(definition, dictionary)
370 def add_def(class_, definition, dictionary, fail_fails=False):
372 Add the definition to the dictionary.
374 F = class_.parse_definition(definition)
376 # print F.name, F._body
377 secs = infer(*F._body)
380 print F.name, '==', expression_to_string(F.body), ' --failed to infer stack effect.'
382 print 'Function not inscribed.'
385 FUNCTIONS[F.name] = SymbolJoyType(F.name, secs, _SYM_NUMS())
386 dictionary[F.name] = F
389 def _text_to_defs(text):
390 return (line.strip() for line in text.splitlines() if '==' in line)
401 def inscribe_(stack, expression, dictionary):
403 Create a new Joy function definition in the Joy dictionary. A
404 definition is given as a string with a name followed by a double
405 equal sign then one or more Joy functions, the body. for example:
409 If you want the definition to persist over restarts, enter it into
410 the definitions.txt resource.
412 definition, stack = stack
413 DefinitionWrapper.add_def(definition, dictionary, fail_fails=True)
414 return stack, expression, dictionary
418 @SimpleFunctionWrapper
420 '''Parse the string on the stack to a Joy expression.'''
422 expression = text_to_expression(text)
423 return expression, stack
428 @SimpleFunctionWrapper
433 getitem == drop first
435 Expects an integer and a quote on the stack and returns the item at the
436 nth position in the quote counting from 0.
440 -------------------------
444 n, (Q, stack) = stack
445 return pick(Q, n), stack
450 @SimpleFunctionWrapper
457 Expects an integer and a quote on the stack and returns the quote with
458 n items removed off the top.
462 ----------------------
466 n, (Q, stack) = stack
478 @SimpleFunctionWrapper
481 Expects an integer and a quote on the stack and returns the quote with
482 just the top n items in reverse order (because that's easier and you can
483 use reverse if needed.)
487 ----------------------
491 n, (Q, stack) = stack
504 @SimpleFunctionWrapper
507 Use a Boolean value to select one of two items.
511 ----------------------
516 ---------------------
519 Currently Python semantics are used to evaluate the "truthiness" of the
520 Boolean value (so empty string, zero, etc. are counted as false, etc.)
522 (if_, (then, (else_, stack))) = stack
523 return then if if_ else else_, stack
527 @SimpleFunctionWrapper
530 Use a Boolean value to select one of two items from a sequence.
534 ------------------------
539 -----------------------
542 The sequence can contain more than two items but not fewer.
543 Currently Python semantics are used to evaluate the "truthiness" of the
544 Boolean value (so empty string, zero, etc. are counted as false, etc.)
546 (flag, (choices, stack)) = stack
547 (else_, (then, _)) = choices
548 return then if flag else else_, stack
553 @SimpleFunctionWrapper
555 '''Given a list find the maximum.'''
557 return max(iter_stack(tos)), stack
562 @SimpleFunctionWrapper
564 '''Given a list find the minimum.'''
566 return min(iter_stack(tos)), stack
571 @SimpleFunctionWrapper
573 '''Given a quoted sequence of numbers return the sum.
575 sum == 0 swap [+] step
578 return sum(iter_stack(tos)), stack
582 @SimpleFunctionWrapper
585 Expects an item on the stack and a quote under it and removes that item
586 from the the quote. The item is only removed once.
590 ------------------------
594 (tos, (second, stack)) = S
595 l = list(iter_stack(second))
597 return list_to_stack(l), stack
601 @SimpleFunctionWrapper
603 '''Given a list remove duplicate items.'''
605 I = list(iter_stack(tos))
606 list_to_stack(sorted(set(I), key=I.index))
607 return list_to_stack(sorted(set(I), key=I.index)), stack
611 @SimpleFunctionWrapper
613 '''Given a list return it sorted.'''
615 return list_to_stack(sorted(iter_stack(tos))), stack
618 _functions['clear'] = s0, s1
620 @SimpleFunctionWrapper
622 '''Clear everything from the stack.
625 clear == stack [pop stack] loop
635 @SimpleFunctionWrapper
638 The unstack operator expects a list on top of the stack and makes that
639 the stack discarding the rest of the stack.
645 @SimpleFunctionWrapper
647 '''Reverse the list on the top of the stack.
650 reverse == [] swap shunt
654 for term in iter_stack(tos):
660 @combinator_effect(_COMB_NUMS(), s7, s6)
661 @SimpleFunctionWrapper
663 '''Concatinate the two lists on the top of the stack.
666 [a b c] [d e f] concat
667 ----------------------------
671 (tos, (second, stack)) = S
672 return concat(second, tos), stack
676 @SimpleFunctionWrapper
678 '''Like concat but reverses the top list into the second.
681 shunt == [swons] step == reverse swap concat
683 [a b c] [d e f] shunt
684 ---------------------------
688 (tos, (second, stack)) = stack
691 second = term, second
696 @SimpleFunctionWrapper
699 Replace the two lists on the top of the stack with a list of the pairs
700 from each list. The smallest list sets the length of the result list.
702 (tos, (second, stack)) = S
705 for a, b in zip(iter_stack(tos), iter_stack(second))
707 return list_to_stack(accumulator), stack
711 @SimpleFunctionWrapper
715 return tos + 1, stack
719 @SimpleFunctionWrapper
723 return tos - 1, stack
727 @SimpleFunctionWrapper
738 a, (b, stack) = stack
744 return int(math.floor(n))
746 floor.__doc__ = math.floor.__doc__
750 @SimpleFunctionWrapper
753 divmod(x, y) -> (quotient, remainder)
755 Return the tuple (x//y, x%y). Invariant: div*y + mod == x.
764 Return the square root of the number a.
765 Negative numbers return complex roots.
770 assert a < 0, repr(a)
771 r = math.sqrt(-a) * 1j
777 # if isinstance(text, str):
778 # return run(text, stack)
783 @SimpleFunctionWrapper
785 '''The identity function.'''
790 @SimpleFunctionWrapper
792 '''True if the form on TOS is void otherwise False.'''
794 return _void(form), stack
798 return any(not _void(i) for i in iter_stack(form))
809 def words(stack, expression, dictionary):
810 '''Print all the words in alphabetical order.'''
811 print(' '.join(sorted(dictionary)))
812 return stack, expression, dictionary
817 def sharing(stack, expression, dictionary):
818 '''Print redistribution information.'''
819 print("You may convey verbatim copies of the Program's source code as"
820 ' you receive it, in any medium, provided that you conspicuously'
821 ' and appropriately publish on each copy an appropriate copyright'
822 ' notice; keep intact all notices stating that this License and'
823 ' any non-permissive terms added in accord with section 7 apply'
824 ' to the code; keep intact all notices of the absence of any'
825 ' warranty; and give all recipients a copy of this License along'
827 ' You should have received a copy of the GNU General Public License'
828 ' along with Thun. If not see <http://www.gnu.org/licenses/>.')
829 return stack, expression, dictionary
834 def warranty(stack, expression, dictionary):
835 '''Print warranty information.'''
836 print('THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY'
837 ' APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE'
838 ' COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM'
839 ' "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR'
840 ' IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES'
841 ' OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE'
842 ' ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS'
843 ' WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE'
844 ' COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.')
845 return stack, expression, dictionary
848 # def simple_manual(stack):
850 # Print words and help for each word.
852 # for name, f in sorted(FUNCTIONS.items()):
854 # boxline = '+%s+' % ('-' * (len(name) + 2))
857 # '| %s |' % (name,),
859 # d if d else ' ...',
869 def help_(S, expression, dictionary):
870 '''Accepts a quoted symbol on the top of the stack and prints its docs.'''
871 ((symbol, _), stack) = S
872 word = dictionary[symbol]
874 return stack, expression, dictionary
882 # Several combinators depend on other words in their definitions,
883 # we use symbols to prevent hard-coding these, so in theory, you
884 # could change the word in the dictionary to use different semantics.
885 S_choice = Symbol('choice')
886 S_first = Symbol('first')
887 S_getitem = Symbol('getitem')
888 S_genrec = Symbol('genrec')
889 S_loop = Symbol('loop')
891 S_ifte = Symbol('ifte')
892 S_infra = Symbol('infra')
893 S_step = Symbol('step')
894 S_times = Symbol('times')
895 S_swaack = Symbol('swaack')
896 S_truthy = Symbol('truthy')
900 @combinator_effect(_COMB_NUMS(), s1)
902 def i(stack, expression, dictionary):
904 The i combinator expects a quoted program on the stack and unpacks it
905 onto the pending expression for evaluation.
914 return stack, concat(quote, expression), dictionary
918 @combinator_effect(_COMB_NUMS(), s1)
920 def x(stack, expression, dictionary):
926 ... [Q] x = ... [Q] dup i
927 ... [Q] x = ... [Q] [Q] i
928 ... [Q] x = ... [Q] Q
932 return stack, concat(quote, expression), dictionary
936 @combinator_effect(_COMB_NUMS(), s7, s6)
938 def b(stack, expression, dictionary):
944 ... [P] [Q] b == ... [P] i [Q] i
945 ... [P] [Q] b == ... P Q
948 q, (p, (stack)) = stack
949 return stack, concat(p, concat(q, expression)), dictionary
953 @combinator_effect(_COMB_NUMS(), a1, s1)
955 def dupdip(stack, expression, dictionary):
959 [F] dupdip == dup [F] dip
969 return stack, concat(F, (a, expression)), dictionary
973 @combinator_effect(_COMB_NUMS(), s7, s6)
975 def infra(stack, expression, dictionary):
977 Accept a quoted program and a list on the stack and run the program
978 with the list as its stack.
981 ... [a b c] [Q] . infra
982 -----------------------------
983 c b a . Q [...] swaack
986 (quote, (aggregate, stack)) = stack
987 return aggregate, concat(quote, (stack, (S_swaack, expression))), dictionary
991 #@combinator_effect(_COMB_NUMS(), s7, s6, s5, s4)
993 def genrec(stack, expression, dictionary):
995 General Recursion Combinator.
998 [if] [then] [rec1] [rec2] genrec
999 ---------------------------------------------------------------------
1000 [if] [then] [rec1 [[if] [then] [rec1] [rec2] genrec] rec2] ifte
1002 From "Recursion Theory and Joy" (j05cmp.html) by Manfred von Thun:
1003 "The genrec combinator takes four program parameters in addition to
1004 whatever data parameters it needs. Fourth from the top is an if-part,
1005 followed by a then-part. If the if-part yields true, then the then-part
1006 is executed and the combinator terminates. The other two parameters are
1007 the rec1-part and the rec2-part. If the if-part yields false, the
1008 rec1-part is executed. Following that the four program parameters and
1009 the combinator are again pushed onto the stack bundled up in a quoted
1010 form. Then the rec2-part is executed, where it will find the bundled
1011 form. Typically it will then execute the bundled form, either with i or
1012 with app2, or some other combinator."
1014 The way to design one of these is to fix your base case [then] and the
1015 test [if], and then treat rec1 and rec2 as an else-part "sandwiching"
1016 a quotation of the whole function.
1018 For example, given a (general recursive) function 'F':
1021 F == [I] [T] [R1] [R2] genrec
1023 If the [I] if-part fails you must derive R1 and R2 from:
1028 Just set the stack arguments in front, and figure out what R1 and R2
1029 have to do to apply the quoted [F] in the proper way. In effect, the
1030 genrec combinator turns into an ifte combinator with a quoted copy of
1031 the original definition in the else-part:
1034 F == [I] [T] [R1] [R2] genrec
1035 == [I] [T] [R1 [F] R2] ifte
1037 Primitive recursive functions are those where R2 == i.
1040 P == [I] [T] [R] primrec
1041 == [I] [T] [R [P] i] ifte
1042 == [I] [T] [R P] ifte
1045 (rec2, (rec1, stack)) = stack
1046 (then, (if_, _)) = stack
1047 F = (if_, (then, (rec1, (rec2, (S_genrec, ())))))
1048 else_ = concat(rec1, (F, rec2))
1049 return (else_, stack), (S_ifte, expression), dictionary
1053 @combinator_effect(_COMB_NUMS(), s7, s6)
1055 def map_(S, expression, dictionary):
1057 Run the quoted program on TOS on the items in the list under it, push a
1058 new list with the results (in place of the program and original list.
1060 # (quote, (aggregate, stack)) = S
1061 # results = list_to_stack([
1062 # joy((term, stack), quote, dictionary)[0][0]
1063 # for term in iter_stack(aggregate)
1065 # return (results, stack), expression, dictionary
1066 (quote, (aggregate, stack)) = S
1068 return (aggregate, stack), expression, dictionary
1070 for term in iter_stack(aggregate):
1072 batch = (s, (quote, (S_infra, (S_first, batch))))
1073 stack = (batch, ((), stack))
1074 return stack, (S_infra, expression), dictionary
1077 #def cleave(S, expression, dictionary):
1079 # The cleave combinator expects two quotations, and below that an item X.
1080 # It first executes [P], with X on top, and saves the top result element.
1081 # Then it executes [Q], again with X, and saves the top result.
1082 # Finally it restores the stack to what it was below X and pushes the two
1083 # results P(X) and Q(X).
1085 # (Q, (P, (x, stack))) = S
1086 # p = joy((x, stack), P, dictionary)[0][0]
1087 # q = joy((x, stack), Q, dictionary)[0][0]
1088 # return (q, (p, stack)), expression, dictionary
1091 def branch_true(stack, expression, dictionary):
1092 # pylint: disable=unused-variable
1093 (then, (else_, (flag, stack))) = stack
1094 return stack, concat(then, expression), dictionary
1097 def branch_false(stack, expression, dictionary):
1098 # pylint: disable=unused-variable
1099 (then, (else_, (flag, stack))) = stack
1100 return stack, concat(else_, expression), dictionary
1104 @poly_combinator_effect(_COMB_NUMS(), [branch_true, branch_false], b1, s7, s6)
1106 def branch(stack, expression, dictionary):
1108 Use a Boolean value to select one of two quoted programs to run.
1112 branch == roll< choice i
1116 False [F] [T] branch
1117 --------------------------
1121 -------------------------
1125 (then, (else_, (flag, stack))) = stack
1126 return stack, concat(then if flag else else_, expression), dictionary
1129 #FUNCTIONS['branch'] = CombinatorJoyType('branch', [branch_true, branch_false], 100)
1134 ##def ifte(stack, expression, dictionary):
1136 ## If-Then-Else Combinator
1139 ## ... [if] [then] [else] ifte
1140 ## ---------------------------------------------------
1141 ## ... [[else] [then]] [...] [if] infra select i
1146 ## ... [if] [then] [else] ifte
1147 ## -------------------------------------------------------
1148 ## ... [else] [then] [...] [if] infra first choice i
1151 ## Has the effect of grabbing a copy of the stack on which to run the
1152 ## if-part using infra.
1154 ## (else_, (then, (if_, stack))) = stack
1155 ## expression = (S_infra, (S_first, (S_choice, (S_i, expression))))
1156 ## stack = (if_, (stack, (then, (else_, stack))))
1157 ## return stack, expression, dictionary
1162 def cond(stack, expression, dictionary):
1164 This combinator works like a case statement. It expects a single quote
1165 on the stack that must contain zero or more condition quotes and a
1166 default quote. Each condition clause should contain a quoted predicate
1167 followed by the function expression to run if that predicate returns
1168 true. If no predicates return true the default function runs.
1170 It works by rewriting into a chain of nested `ifte` expressions, e.g.::
1172 [[[B0] T0] [[B1] T1] [D]] cond
1173 -----------------------------------------
1174 [B0] [T0] [[B1] [T1] [D] ifte] ifte
1177 conditions, stack = stack
1179 expression = _cond(conditions, expression)
1181 # Attempt to preload the args to first ifte.
1182 (P, (T, (E, expression))) = expression
1184 # If, for any reason, the argument to cond should happen to contain
1185 # only the default clause then this optimization will fail.
1188 stack = (E, (T, (P, stack)))
1189 return stack, expression, dictionary
1192 def _cond(conditions, expression):
1193 (clause, rest) = conditions
1194 if not rest: # clause is [D]
1197 return (P, (T, (_cond(rest, ()), (S_ifte, expression))))
1201 @combinator_effect(_COMB_NUMS(), a1, s1)
1203 def dip(stack, expression, dictionary):
1205 The dip combinator expects a quoted program on the stack and below it
1206 some item, it hoists the item into the expression and runs the program
1207 on the rest of the stack.
1215 (quote, (x, stack)) = stack
1216 expression = (x, expression)
1217 return stack, concat(quote, expression), dictionary
1221 @combinator_effect(_COMB_NUMS(), a2, a1, s1)
1223 def dipd(S, expression, dictionary):
1225 Like dip but expects two items.
1229 ---------------------
1233 (quote, (x, (y, stack))) = S
1234 expression = (y, (x, expression))
1235 return stack, concat(quote, expression), dictionary
1239 @combinator_effect(_COMB_NUMS(), a3, a2, a1, s1)
1241 def dipdd(S, expression, dictionary):
1243 Like dip but expects three items.
1247 -----------------------
1251 (quote, (x, (y, (z, stack)))) = S
1252 expression = (z, (y, (x, expression)))
1253 return stack, concat(quote, expression), dictionary
1257 @combinator_effect(_COMB_NUMS(), a1, s1)
1259 def app1(S, expression, dictionary):
1261 Given a quoted program on TOS and anything as the second stack item run
1262 the program and replace the two args with the first result of the
1267 -----------------------------------
1268 ... [x ...] [Q] . infra first
1270 (quote, (x, stack)) = S
1271 stack = (quote, ((x, stack), stack))
1272 expression = (S_infra, (S_first, expression))
1273 return stack, expression, dictionary
1277 @combinator_effect(_COMB_NUMS(), a2, a1, s1)
1279 def app2(S, expression, dictionary):
1280 '''Like app1 with two items.
1284 -----------------------------------
1285 ... [y ...] [Q] . infra first
1286 [x ...] [Q] infra first
1289 (quote, (x, (y, stack))) = S
1290 expression = (S_infra, (S_first,
1291 ((x, stack), (quote, (S_infra, (S_first,
1293 stack = (quote, ((y, stack), stack))
1294 return stack, expression, dictionary
1298 @combinator_effect(_COMB_NUMS(), a3, a2, a1, s1)
1300 def app3(S, expression, dictionary):
1301 '''Like app1 with three items.
1304 ... z y x [Q] . app3
1305 -----------------------------------
1306 ... [z ...] [Q] . infra first
1307 [y ...] [Q] infra first
1308 [x ...] [Q] infra first
1311 (quote, (x, (y, (z, stack)))) = S
1312 expression = (S_infra, (S_first,
1313 ((y, stack), (quote, (S_infra, (S_first,
1314 ((x, stack), (quote, (S_infra, (S_first,
1315 expression))))))))))
1316 stack = (quote, ((z, stack), stack))
1317 return stack, expression, dictionary
1321 @combinator_effect(_COMB_NUMS(), s7, s6)
1323 def step(S, expression, dictionary):
1325 Run a quoted program on each item in a sequence.
1329 -----------------------
1334 ------------------------
1338 ... [a b c] [Q] . step
1339 ----------------------------------------
1340 ... a . Q [b c] [Q] step
1342 The step combinator executes the quotation on each member of the list
1343 on top of the stack.
1345 (quote, (aggregate, stack)) = S
1347 return stack, expression, dictionary
1348 head, tail = aggregate
1349 stack = quote, (head, stack)
1351 expression = tail, (quote, (S_step, expression))
1352 expression = S_i, expression
1353 return stack, expression, dictionary
1357 @combinator_effect(_COMB_NUMS(), i1, s6)
1359 def times(stack, expression, dictionary):
1361 times == [-- dip] cons [swap] infra [0 >] swap while pop
1365 --------------------- w/ n <= 0
1370 ---------------------------------
1375 --------------------------------- w/ n > 1
1376 ... . Q (n - 1) [Q] times
1379 # times == [-- dip] cons [swap] infra [0 >] swap while pop
1380 (quote, (n, stack)) = stack
1382 return stack, expression, dictionary
1385 expression = n, (quote, (S_times, expression))
1386 expression = concat(quote, expression)
1387 return stack, expression, dictionary
1390 # The current definition above works like this:
1393 # --------------------------------------
1394 # [P] nullary [Q [P] nullary] loop
1396 # while == [pop i not] [popop] [dudipd] primrec
1398 #def while_(S, expression, dictionary):
1399 # '''[if] [body] while'''
1400 # (body, (if_, stack)) = S
1401 # while joy(stack, if_, dictionary)[0][0]:
1402 # stack = joy(stack, body, dictionary)[0]
1403 # return stack, expression, dictionary
1407 #@combinator_effect(_COMB_NUMS(), b1, s6)
1409 def loop(stack, expression, dictionary):
1411 Basic loop combinator.
1415 -----------------------
1419 ------------------------
1423 quote, (flag, stack) = stack
1425 expression = concat(quote, (quote, (S_loop, expression)))
1426 return stack, expression, dictionary
1430 @combinator_effect(_COMB_NUMS(), a1, a2, s6, s7, s8)
1432 def cmp_(stack, expression, dictionary):
1434 cmp takes two values and three quoted programs on the stack and runs
1435 one of the three depending on the results of comparing the two values:
1439 ------------------------- a > b
1443 ------------------------- a = b
1447 ------------------------- a < b
1450 L, (E, (G, (b, (a, stack)))) = stack
1451 expression = concat(G if a > b else L if a < b else E, expression)
1452 return stack, expression, dictionary
1455 # FunctionWrapper(cleave),
1456 # FunctionWrapper(while_),
1461 #divmod_ = pm = __(n2, n1), __(n4, n3)
1463 sec_binary_cmp(BinaryBuiltinWrapper(operator.eq)),
1464 sec_binary_cmp(BinaryBuiltinWrapper(operator.ge)),
1465 sec_binary_cmp(BinaryBuiltinWrapper(operator.gt)),
1466 sec_binary_cmp(BinaryBuiltinWrapper(operator.le)),
1467 sec_binary_cmp(BinaryBuiltinWrapper(operator.lt)),
1468 sec_binary_cmp(BinaryBuiltinWrapper(operator.ne)),
1470 sec_binary_ints(BinaryBuiltinWrapper(operator.xor)),
1471 sec_binary_ints(BinaryBuiltinWrapper(operator.lshift)),
1472 sec_binary_ints(BinaryBuiltinWrapper(operator.rshift)),
1474 sec_binary_logic(BinaryBuiltinWrapper(operator.and_)),
1475 sec_binary_logic(BinaryBuiltinWrapper(operator.or_)),
1477 sec_binary_math(BinaryBuiltinWrapper(operator.add)),
1478 sec_binary_math(BinaryBuiltinWrapper(operator.floordiv)),
1479 sec_binary_math(BinaryBuiltinWrapper(operator.mod)),
1480 sec_binary_math(BinaryBuiltinWrapper(operator.mul)),
1481 sec_binary_math(BinaryBuiltinWrapper(operator.pow)),
1482 sec_binary_math(BinaryBuiltinWrapper(operator.sub)),
1483 sec_binary_math(BinaryBuiltinWrapper(operator.truediv)),
1485 sec_unary_logic(UnaryBuiltinWrapper(bool)),
1486 sec_unary_logic(UnaryBuiltinWrapper(operator.not_)),
1488 sec_unary_math(UnaryBuiltinWrapper(abs)),
1489 sec_unary_math(UnaryBuiltinWrapper(operator.neg)),
1490 sec_unary_math(UnaryBuiltinWrapper(sqrt)),
1492 stack_effect(n1)(i1)(UnaryBuiltinWrapper(floor)),
1495 del F # Otherwise Sphinx autodoc will pick it up.
1498 YIN_STACK_EFFECTS = yin_functions()
1500 # Load the auto-generated primitives into the dictionary.
1501 _functions.update(YIN_STACK_EFFECTS)
1504 # eh = compose(dup, bool)
1505 # sqr = compose(dup, mul)
1506 # of = compose(swap, at)
1508 # ''' in dict(compose=compose), _functions
1511 (name, SymbolJoyType(name, [_functions[name]], _SYM_NUMS()))
1512 for name in sorted(_functions)
1514 for name, primitive in getmembers(genlib, isfunction):
1515 inscribe(SimpleFunctionWrapper(primitive))
1518 add_aliases(_dictionary, ALIASES)
1519 add_aliases(_functions, ALIASES)
1520 add_aliases(FUNCTIONS, ALIASES)
1523 DefinitionWrapper.add_definitions(definitions, _dictionary)
1525 #sec_Ns_math(_dictionary['product'])