# Chessboard program: you type in moves in algebraic notation, and it'll # display the position after each move. # recipes are mu's names for functions recipe main [ open-console # take control of screen, keyboard and mouse # The chessboard recipe takes keyboard and screen objects as 'ingredients'. # # In mu it is good form (though not required) to explicitly show the # hardware you rely on. # # The chessboard also returns the same keyboard and screen objects. In mu it # is good form to not modify ingredients of a recipe unless they are also # results. Here we clearly modify both keyboard and screen, so we return # both. # # Here the console and screen are both 0, which usually indicates real # hardware rather than a fake for testing as you'll see below. 0:literal/screen, 0:literal/console <- chessboard 0:literal/screen, 0:literal/console close-console # cleanup screen, keyboard and mouse ] ## But enough about mu. Here's what it looks like to run the chessboard program. scenario print-board-and-read-move [ $close-trace # administrivia: most scenarios save and check traces, but this one gets too large/slow # we'll make the screen really wide because the program currently prints out a long line assume-screen 120:literal/width, 20:literal/height # initialize keyboard to type in a move assume-console [ type [a2-a4 ] ] run [ screen:address, console:address <- chessboard screen:address, console:address #? $browse-trace #? 1 #? $close-trace #? 1 # icon for the cursor screen:address <- print-character screen:address, 9251:literal # '␣' ] screen-should-contain [ # 1 2 3 4 5 6 7 8 9 10 11 # 012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789 .Stupid text-mode chessboard. White pieces in uppercase; black pieces in lowercase. No checking for legal moves. . . . .8 | r n b q k b n r . .7 | p p p p p p p p . .6 | . .5 | . .4 | P . .3 | . .2 | P P P P P P P . .1 | R N B Q K B N R . . +---------------- . . a b c d e f g h . . . .Type in your move as -. For example: 'a2-a4'. Then press . . . . .Hit 'q' to exit. . . . .move: ␣ . . . . . ] ] ## Here's how 'chessboard' is implemented. recipe chessboard [ #? $start-tracing [schedule] #? 2 #? $start-tracing #? 1 local-scope screen:address <- next-ingredient console:address <- next-ingredient #? $print [screen: ], screen:address, [, console: ], console:address, 10:literal/newline board:address:array:address:array:character <- initial-position # hook up stdin stdin:address:channel <- new-channel 10:literal/capacity start-running send-keys-to-channel:recipe, console:address, stdin:address:channel, screen:address # buffer lines in stdin buffered-stdin:address:channel <- new-channel 10:literal/capacity start-running buffer-lines:recipe, stdin:address:channel, buffered-stdin:address:channel { msg:address:array:character <- new [Stupid text-mode chessboard. White pieces in uppercase; black pieces in lowercase. No checking for legal moves. ] print-string screen:address, msg:address:array:character

Profanity
Copyright (C) 2012 - 2019 James Booth <boothj5@gmail.com>

Profanity is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Profanity is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with Profanity.  If not, see <http://www.gnu.org/licenses/>.

There is an additional exception from the author permitting linking
with OpenSSL:

As copyright holder, I give permission for profanity to be linked to
the OpenSSL libraries. This includes permission for profanity
binaries to be distributed linked against the OpenSSL libraries.
All other obligations under the GPL v3 remain intact.

l/blank, 32:literal/blank, 112:literal/p, 107:literal/k, #? 66:literal/B, 80:literal/P, 32:literal/blank, 32:literal/blank, 32:literal/blank, 32:literal/blank, 112:literal/p, 98:literal/b, #? 78:literal/N, 80:literal/P, 32:literal/blank, 32:literal/blank, 32:literal/blank, 32:literal/blank, 112:literal/p, 110:literal/n, #? 82:literal/R, 80:literal/P, 32:literal/blank, 32:literal/blank, 32:literal/blank, 32:literal/blank, 112:literal/p, 114:literal/r board:address:array:address:array:character <- new-board initial-position:address:array:number reply board:address:array:address:array:character ] scenario printing-the-board [ assume-screen 30:literal/width, 12:literal/height run [ 1:address:array:address:array:character/board <- initial-position screen:address <- print-board screen:address, 1:address:array:address:array:character/board #? $dump-screen #? 1 ] screen-should-contain [ # 012345678901234567890123456789 .8 | r n b q k b n r . .7 | p p p p p p p p . .6 | . .5 | . .4 | . .3 | . .2 | P P P P P P P P . .1 | R N B Q K B N R . . +---------------- . . a b c d e f g h . . . . . ] ] ## data structure: move container move [ # valid range: 0-7 from-file:number from-rank:number to-file:number to-rank:number ] # result:address:move, quit?:boolean, error?:boolean <- read-move stdin:address:channel, screen:address # prints only error messages to screen recipe read-move [ local-scope stdin:address:channel <- next-ingredient screen:address <- next-ingredient #? $print screen:address #? 1 from-file:number, quit?:boolean, error?:boolean <- read-file stdin:address:channel, screen:address reply-if quit?:boolean, 0:literal/dummy, quit?:boolean, error?:boolean reply-if error?:boolean, 0:literal/dummy, quit?:boolean, error?:boolean #? close-console #? 1 # construct the move object result:address:move <- new move:type x:address:number <- get-address result:address:move/deref, from-file:offset x:address:number/deref <- copy from-file:number x:address:number <- get-address result:address:move/deref, from-rank:offset x:address:number/deref, quit?:boolean, error?:boolean <- read-rank stdin:address:channel, screen:address reply-if quit?:boolean, 0:literal/dummy, quit?:boolean, error?:boolean reply-if error?:boolean, 0:literal/dummy, quit?:boolean, error?:boolean error?:boolean <- expect-from-channel stdin:address:channel, 45:literal/dash, screen:address reply-if error?:boolean, 0:literal/dummy, 0:literal/quit, error?:boolean x:address:number <- get-address result:address:move/deref, to-file:offset x:address:number/deref, quit?:boolean, error?:boolean <- read-file stdin:address:channel, screen:address reply-if quit?:boolean, 0:literal/dummy, quit?:boolean, error?:boolean reply-if error?:boolean, 0:literal/dummy, quit?:boolean, error?:boolean x:address:number <- get-address result:address:move/deref, to-rank:offset x:address:number/deref, quit?:boolean, error?:boolean <- read-rank stdin:address:channel, screen:address reply-if quit?:boolean, 0:literal/dummy, quit?:boolean, error?:boolean reply-if error?:boolean, 0:literal/dummy, quit?:boolean, error?:boolean #? $exit #? 1 error?:boolean <- expect-from-channel stdin:address:channel, 10:literal/newline, screen:address reply-if error?:boolean, 0:literal/dummy, 0:literal/quit, error?:boolean reply result:address:move, quit?:boolean, error?:boolean ] # file:number, quit:boolean, error:boolean <- read-file stdin:address:channel, screen:address # valid values for file: 0-7 recipe read-file [ local-scope stdin:address:channel <- next-ingredient screen:address <- next-ingredient c:character, stdin:address:channel <- read stdin:address:channel { q-pressed?:boolean <- equal c:character, 81:literal # 'Q' break-unless q-pressed?:boolean reply 0:literal/dummy, 1:literal/quit, 0:literal/error } { q-pressed?:boolean <- equal c:character, 113:literal # 'q' break-unless q-pressed?:boolean reply 0:literal/dummy, 1:literal/quit, 0:literal/error } { empty-fake-keyboard?:boolean <- equal c:character, 0:literal/eof break-unless empty-fake-keyboard?:boolean reply 0:literal/dummy, 1:literal/quit, 0:literal/error } { newline?:boolean <- equal c:character, 10:literal/newline break-unless newline?:boolean error-message:address:array:character <- new [that's not enough] print-string screen:address, error-message:address:array:character reply 0:literal/dummy, 0:literal/quit, 1:literal/error } file:number <- subtract c:character, 97:literal # 'a' #? $print file:number, 10:literal/newline # 'a' <= file <= 'h' { above-min:boolean <- greater-or-equal file:number, 0:literal break-if above-min:boolean error-message:address:array:character <- new [file too low: ] print-string screen:address, error-message:address:array:character print-character screen:address, c:character cursor-to-next-line screen:address reply 0:literal/dummy, 0:literal/quit, 1:literal/error } { below-max:boolean <- lesser-than file:number, 8:literal break-if below-max:boolean error-message:address:array:character <- new [file too high: ] print-string screen:address, error-message:address:array:character print-character screen:address, c:character reply 0:literal/dummy, 0:literal/quit, 1:literal/error } reply file:number, 0:literal/quit, 0:literal/error ] # rank:number <- read-rank stdin:address:channel, screen:address # valid values: 0-7, -1 (quit), -2 (error) recipe read-rank [ local-scope stdin:address:channel <- next-ingredient screen:address <- next-ingredient c:character, stdin:address:channel <- read stdin:address:channel { q-pressed?:boolean <- equal c:character, 81:literal # 'Q' break-unless q-pressed?:boolean reply 0:literal/dummy, 1:literal/quit, 0:literal/error } { q-pressed?:boolean <- equal c:character, 113:literal # 'q' break-unless q-pressed?:boolean reply 0:literal/dummy, 1:literal/quit, 0:literal/error } { newline?:boolean <- equal c:character, 10:literal # newline break-unless newline?:boolean error-message:address:array:character <- new [that's not enough] print-string screen:address, error-message:address:array:character reply 0:literal/dummy, 0:literal/quit, 1:literal/error } rank:number <- subtract c:character, 49:literal # '1' #? $print rank:number, 10:literal/newline # assert'1' <= rank <= '8' { above-min:boolean <- greater-or-equal rank:number, 0:literal break-if above-min:boolean error-message:address:array:character <- new [rank too low: ] print-string screen:address, error-message:address:array:character print-character screen:address, c:character reply 0:literal/dummy, 0:literal/quit, 1:literal/error } { below-max:boolean <- lesser-or-equal rank:number, 7:literal break-if below-max:boolean error-message:address:array:character <- new [rank too high: ] print-string screen:address, error-message:address:array:character print-character screen:address, c:character reply 0:literal/dummy, 0:literal/quit, 1:literal/error } reply rank:number, 0:literal/quit, 0:literal/error ] # read a character from the given channel and check that it's what we expect # return true on error recipe expect-from-channel [ local-scope stdin:address:channel <- next-ingredient expected:character <- next-ingredient screen:address <- next-ingredient c:character, stdin:address:channel <- read stdin:address:channel match?:boolean <- equal c:character, expected:character { break-if match?:boolean s:address:array:character <- new [expected character not found] print-string screen:address, s:address:array:character } result:boolean <- not match?:boolean reply result:boolean ] scenario read-move-blocking [ assume-screen 20:literal/width, 2:literal/height run [ #? $start-tracing #? 1 1:address:channel <- new-channel 2:literal #? $print [aaa channel address: ], 1:address:channel, 10:literal/newline 2:number/routine <- start-running read-move:recipe, 1:address:channel, screen:address # 'read-move' is waiting for input wait-for-routine 2:number #? $print [bbb channel address: ], 1:address:channel, 10:literal/newline 3:number <- routine-state 2:number/id #? $print [I: routine ], 2:number, [ state ], 3:number 10:literal/newline 4:boolean/waiting? <- equal 3:number/routine-state, 2:literal/waiting assert 4:boolean/waiting?, [ F read-move-blocking: routine failed to pause after coming up (before any keys were pressed)] # press 'a' #? $print [ccc channel address: ], 1:address:channel, 10:literal/newline #? $exit #? 1 1:address:channel <- write 1:address:channel, 97:literal # 'a' restart 2:number/routine # 'read-move' still waiting for input wait-for-routine 2:number 3:number <- routine-state 2:number/id #? $print [II: routine ], 2:number, [ state ], 3:number 10:literal/newline 4:boolean/waiting? <- equal 3:number/routine-state, 2:literal/waiting assert 4:boolean/waiting?, [ F read-move-blocking: routine failed to pause after rank 'a'] # press '2' 1:address:channel <- write 1:address:channel, 50:literal # '2' restart 2:number/routine # 'read-move' still waiting for input wait-for-routine 2:number 3:number <- routine-state 2:number/id #? $print [III: routine ], 2:number, [ state ], 3:number 10:literal/newline 4:boolean/waiting? <- equal 3:number/routine-state, 2:literal/waiting assert 4:boolean/waiting?, [ F read-move-blocking: routine failed to pause after file 'a2'] # press '-' 1:address:channel <- write 1:address:channel, 45:literal # '-' restart 2:number/routine # 'read-move' still waiting for input wait-for-routine 2:number 3:number <- routine-state 2:number #? $print [IV: routine ], 2:number, [ state ], 3:number 10:literal/newline 4:boolean/waiting? <- equal 3:number/routine-state, 2:literal/waiting assert 4:boolean/waiting?/routine-state, [ F read-move-blocking: routine failed to pause after hyphen 'a2-'] # press 'a' 1:address:channel <- write 1:address:channel, 97:literal # 'a' restart 2:number/routine # 'read-move' still waiting for input wait-for-routine 2:number 3:number <- routine-state 2:number #? $print [V: routine ], 2:number, [ state ], 3:number 10:literal/newline 4:boolean/waiting? <- equal 3:number/routine-state, 2:literal/waiting assert 4:boolean/waiting?/routine-state, [ F read-move-blocking: routine failed to pause after rank 'a2-a'] # press '4' 1:address:channel <- write 1:address:channel, 52:literal # '4' restart 2:number/routine # 'read-move' still waiting for input wait-for-routine 2:number 3:number <- routine-state 2:number #? $print [VI: routine ], 2:number, [ state ], 3:number 10:literal/newline 4:boolean/waiting? <- equal 3:number/routine-state, 2:literal/waiting assert 4:boolean/waiting?, [ F read-move-blocking: routine failed to pause after file 'a2-a4'] # press 'newline' 1:address:channel <- write 1:address:channel, 10:literal # newline restart 2:number/routine # 'read-move' now completes wait-for-routine 2:number 3:number <- routine-state 2:number #? $print [VII: routine ], 2:number, [ state ], 3:number 10:literal/newline 4:boolean/completed? <- equal 3:number/routine-state, 1:literal/completed assert 4:boolean/completed?, [ F read-move-blocking: routine failed to terminate on newline] trace [test], [reached end] ] trace-should-contain [ test: reached end ] ] scenario read-move-quit [ assume-screen 20:literal/width, 2:literal/height run [ 1:address:channel <- new-channel 2:literal 2:number/routine <- start-running read-move:recipe, 1:address:channel, screen:address # 'read-move' is waiting for input wait-for-routine 2:number 3:number <- routine-state 2:number/id 4:boolean/waiting? <- equal 3:number/routine-state, 2:literal/waiting assert 4:boolean/waiting?, [ F read-move-quit: routine failed to pause after coming up (before any keys were pressed)] # press 'q' 1:address:channel <- write 1:address:channel, 113:literal # 'q' restart 2:number/routine # 'read-move' completes wait-for-routine 2:number 3:number <- routine-state 2:number/id 4:boolean/completed? <- equal 3:number/routine-state, 1:literal/completed assert 4:boolean/completed?, [ F read-move-quit: routine failed to terminate on 'q'] trace [test], [reached end] ] trace-should-contain [ test: reached end ] ] scenario read-move-illegal-file [ assume-screen 20:literal/width, 2:literal/height run [ 1:address:channel <- new-channel 2:literal 2:number/routine <- start-running read-move:recipe, 1:address:channel, screen:address # 'read-move' is waiting for input wait-for-routine 2:number 3:number <- routine-state 2:number/id 4:boolean/waiting? <- equal 3:number/routine-state, 2:literal/waiting assert 4:boolean/waiting?, [ F read-move-file: routine failed to pause after coming up (before any keys were pressed)] 1:address:channel <- write 1:address:channel, 50:literal # '2' restart 2:number/routine wait-for-routine 2:number ] screen-should-contain [ .file too low: 2 . . . ] ] scenario read-move-illegal-rank [ assume-screen 20:literal/width, 2:literal/height run [ 1:address:channel <- new-channel 2:literal 2:number/routine <- start-running read-move:recipe, 1:address:channel, screen:address # 'read-move' is waiting for input wait-for-routine 2:number 3:number <- routine-state 2:number/id 4:boolean/waiting? <- equal 3:number/routine-state, 2:literal/waiting assert 4:boolean/waiting?, [ F read-move-file: routine failed to pause after coming up (before any keys were pressed)] 1:address:channel <- write 1:address:channel, 97:literal # 'a' 1:address:channel <- write 1:address:channel, 97:literal # 'a' restart 2:number/routine wait-for-routine 2:number ] screen-should-contain [ .rank too high: a . . . ] ] scenario read-move-empty [ assume-screen 20:literal/width, 2:literal/height run [ 1:address:channel <- new-channel 2:literal 2:number/routine <- start-running read-move:recipe, 1:address:channel, screen:address # 'read-move' is waiting for input wait-for-routine 2:number 3:number <- routine-state 2:number/id 4:boolean/waiting? <- equal 3:number/routine-state, 2:literal/waiting assert 4:boolean/waiting?, [ F read-move-file: routine failed to pause after coming up (before any keys were pressed)] 1:address:channel <- write 1:address:channel, 10:literal/newline 1:address:channel <- write 1:address:channel, 97:literal # 'a' restart 2:number/routine wait-for-routine 2:number ] screen-should-contain [ .that's not enough . . . ] ] recipe make-move [ local-scope b:address:array:address:array:character <- next-ingredient m:address:move <- next-ingredient from-file:number <- get m:address:move/deref, from-file:offset #? $print from-file:number, 10:literal/newline from-rank:number <- get m:address:move/deref, from-rank:offset #? $print from-rank:number, 10:literal/newline to-file:number <- get m:address:move/deref, to-file:offset #? $print to-file:number, 10:literal/newline to-rank:number <- get m:address:move/deref, to-rank:offset #? $print to-rank:number, 10:literal/newline f:address:array:character <- index b:address:array:address:array:character/deref, from-file:number src:address:character/square <- index-address f:address:array:character/deref, from-rank:number f:address:array:character <- index b:address:array:address:array:character/deref, to-file:number dest:address:character/square <- index-address f:address:array:character/deref, to-rank:number #? $print src:address:character/deref, 10:literal/newline dest:address:character/deref/square <- copy src:address:character/deref/square src:address:character/deref/square <- copy 32:literal # ' ' reply b:address:array:address:array:character/same-as-ingredient:0 ] scenario making-a-move [ assume-screen 30:literal/width, 12:literal/height run [ 2:address:array:address:array:character/board <- initial-position 3:address:move <- new move:type 4:address:number <- get-address 3:address:move/deref, from-file:offset 4:address:number/deref <- copy 6:literal/g 5:address:number <- get-address 3:address:move/deref, from-rank:offset 5:address:number/deref <- copy 1:literal/2 6:address:number <- get-address 3:address:move/deref, to-file:offset 6:address:number/deref <- copy 6:literal/g 7:address:number <- get-address 3:address:move/deref, to-rank:offset 7:address:number/deref <- copy 3:literal/4 2:address:array:address:array:character/board <- make-move 2:address:array:address:array:character/board, 3:address:move screen:address <- print-board screen:address, 2:address:array:address:array:character/board ] screen-should-contain [ # 012345678901234567890123456789 .8 | r n b q k b n r . .7 | p p p p p p p p . .6 | . .5 | . .4 | P . .3 | . .2 | P P P P P P P . .1 | R N B Q K B N R . . +---------------- . . a b c d e f g h . . . ] ]