chickadee » typed-records

typed-records

Introduction

Alernative record-definition forms that allow specifying slot types, giving more opportunities for type-analysis and type-based optimization. Specifying slot types also is useful for documentation.

The record-definition forms define-record and define-record-type from the core system, and defstruct from the egg of the same name are shadowed and provide the extended type-specification syntax.

Requirements

defstruct

This extension requires CHICKEN 4.7.5 or later.

Usage

(require-extension typed-records)

Documentation

define-record

(define-record NAME SLOT ...) syntax

Equivalent to define-record where SLOT slot may optionally be of the form

 (SLOTNAME : TYPE)

or

 ((setter SLOTNAME) : TYPE)

define-record adds the following type-declarations:

(: make-NAME (TYPE1 ... -> (struct NAME)))
(: NAME? (* -> boolean : (struct NAME)))
(: NAME-SLOTNAME ((struct NAME) -> TYPE))
(: NAME-SLOTNAME-set! ((struct NAME) TYPE -> undefined))

Additionally, specializations are enabled that rewrite slot-accessors to very efficient code, if the compiler can prove that the arguments are of the correct type.

define-record-type

(define-record-type NAME (CTOR FIELDNAME ...) PRED FIELD ...) syntax

Defines a SRFI-9 record type. FIELD may be any of

 (FIELDNAME GETTER)
 (FIELDNAME GETTER : TYPE)
 (FIELDNAME GETTER SETTER)
 (FIELDNAME GETTER SETTER : TYPE)

Declares:

(: CTOR (TYPE1 ... -> (struct NAME)))
(: PRED (* -> boolean : (struct NAME)))
(: GETTER ((struct NAME) -> TYPE))
(: SETTER ((struct NAME) TYPE -> undefined))

Specializations are added here as well.

defstruct-typed

(defstruct NAME SLOT ...) syntax

Alternative form of defstruct. SLOT may be any of

 SLOTNAME 
 (SLOTNAME DEFAULT)
 (SLOTNAME : TYPE)
 ((SLOTNAME DEFAULT) : TYPE)

Declares:

(: make-NAME (#!rest * -> (struct NAME)))
(: NAME? (* -> boolean : (struct NAME)))
(: NAME-SLOTNAME ((struct NAME) -> TYPE))
(: NAME-SLOTNAME-set! ((struct NAME) TYPE -> undefined))
(: set-NAME! ((struct name) #!rest * -> (struct name)))
(: update-NAME ((struct name) #!rest * -> (struct name)))

Adds specializations as appropriate.

Author

Felix Winkelmann

License

 Copyright (c) 2011, Felix L. Winkelmann
 All rights reserved.
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
 3. The name of the authors may not be used to endorse or promote products
    derived from this software without specific prior written permission.
 THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Version History

0.1
initial release
0.2
shadow original definition forms
0.5
various bugfixes

Contents »