chickadee » cooperative

Outdated egg!

This is an egg for CHICKEN 4, the unsupported old release. You're almost certainly looking for the CHICKEN 5 version of this egg, if it exists.

If it does not exist, there may be equivalent functionality provided by another egg; have a look at the egg index. Otherwise, please consider porting this egg to the current version of CHICKEN.

cooperative

Coroutines and Finite State Machines for Chicken Scheme

Repository

https://github.com/yarnoiser/cooperative

Installing

 
chicken-install cooperative

Usage

(use cooperative)

make-coroutine

make-coroutine proc #!rest argsprocedure

Returns a new coroutine. The resulting procedure is a thunk (it takes no arguments). When the coroutine is called, it is equivalent to applying args to proc, except that any calls to yield! will return control to the calling procedure. When the coroutine is called again after yield!, it will continue where it left off before yielding An error is signalled if the coroutine is called after it completes without calling yield!.

Example
(define (from-x-to-y x y)
  (let loop ()
    (if (< x y)
      (begin (yield! x)
             (set! x (add1 x))
             (loop))
      y)))

(define from-1-to-3 (make-coroutine from-x-to-y 1 3))

(from-1-to-3)
1
(from-1-to-3)
2
(from-1-to-3)
3
(from-1-to-3)
error "coroutine has finished"

in-coroutine?

in-coroutine?procedure

Returns true if it is called within a coroutine created with a call to make-coroutine. Else returns false.

Example
(define (maybe-coroutine)
  (let loop ((x 0))
    (if (in-coroutine?)
      (yield! 'yielded))
    (if (= x 3)
      x
      (loop (add1 x)))))
  
  (maybe-coroutine)
  3
  
  (define coroutine (make-coroutine maybe-coroutine))
  (coroutine)
  yielded
  (coroutine)
  yielded
  (coroutine)
  yielded
  (coroutine)
  yielded
  (coroutine)
  3

yield!

yield! #!optional valprocedure

Exits the current coroutine returning control to the calling procedure. Returns the optional value val, which defaults to (void). An error is singled if yield! is called outside of a coroutine procedure.

Example

See make-coroutine

fsm

(fsm input: (input ...) vars: vars start: initial-state state ...)syntax

Creates a finite state machine. The resulting machine is a procedure which behaves differently with subsequent calls depending on what state it is in.

The machine parameters consist of literals followed by a relevant expression. these parameters must be outlined in the order they are shown above.

input: (input ...) A list of input values. These are received as arguments to the finite state machine when it is called, and can be referenced as variables within the state machine.

vars: vars A list of variable assignments equivalent to those found in a let expression. These variables are internal to the state machine and persist between calls to it, unless specifically changed.

start: initial-state The name of the initial state. This is the state in which the finite state machine will be in when it is first called. The name of the initial state is not evaluated, and does not need to be quoted.

The remaining parameters are state definitions, which also consist of literals followed by relevant expressions. Like the above parameters, they must be written in the order shown:

(state: state-name act: act output: (output ...) trans: ((condition next-state) ...))

state: state-name The state name. This is the name of the state being defined and is used to refer to this state during transitions. This name is not evaluated, and does not need to be quoted.

act: act The state's action expression. This consists of a single scheme expression. Forms such as let or begin should be used to perform multiple actions here.

output: (output ...) Followed by a list of output values. A list containing all values specified here will be returned to the calling procedure. The list should not be quoted, quasiquoted or created with the list procedure, simply specified with parentheses, although individual elements will be evaluated.

trans: ((condition next-state) ...) The state transitions list. This is an association list containing boolean expressions paired with states to transition to. The next time the finite state machine is called, it will be in the state paired with the first predicate to return true. The state names are not evaluated and do not need to be quoted.

  1. Example
(define docking-control
  (fsm
    input: (use-case)
    vars: ((ports 3) (ships 0) (status #f))
    start: empty

    (state: empty
      act: (case use-case
             ((arrival) (begin (set! ships (add1 ships))
                               (set! status 'approved)))
             ((departure) (set! status 'denied))
             (else (error "invalid use case")))
      output: (status)
      trans: (((< 0 ships) else)))

    (state: full
      act: (case use-case
             ((arrival) (set! status 'denied))
             ((departure) (begin (set! ships (sub1 ships))
                                 (set! status 'approved)))
             (else (error "invalid use case")))
      output: (status)
      trans: (((< ships ports) else)))

    (state: else
      act: (begin (set! status 'approved)
                  (case use-case
                    ((arrival) (set! ships (add1 ships)))
                    ((departure) (set! ships (sub1 ships)))
                    (else (error "invalid use case"))))
      output: (status)
      trans: (((= ports ships) full)
              ((= ships 0) empty))) ))


(docking-control 'departure)
(denied)

(docking-control 'arrival)
(approved)

(docking-control 'arrival)
(approved)

(docking-control 'arrival)
(approved)

(docking-control 'arrival)
(denied)

(docking-control 'departure)
(approved)

About the Author

Robert Smiley, the author of this egg can be reached at yarnoiserdev@gmail.com.

Contents »