#lang scribble/doc @(require "mz.ss" (for-label scheme/struct-info)) @(define struct-eval (make-base-eval)) @title[#:tag "structures" #:style 'toc]{Structures} @guideintro["define-struct"]{structure types via @scheme[define-struct]} @local-table-of-contents[] A @deftech{structure type} is a record datatype composing a number of @idefterm{fields}. A @deftech{structure}, an instance of a structure type, is a first-class value that contains a value for each field of the structure type. A structure instance is created with a type-specific @tech{constructor} procedure, and its field values are accessed and changed with type-specific @tech{accessor} and @tech{mutator} procedures. In addition, each structure type has a @tech{predicate} procedure that answers @scheme[#t] for instances of the structure type and @scheme[#f] for any other value. A structure type's fields are essentially unnamed, though names are supported for error-reporting purposes. The constructor procedure takes one value for each field of the structure type, except that some of the fields of a structure type can be @deftech{automatic fields}; the @tech{automatic fields} are initialized to a constant that is associated with the structure type, and the corresponding arguments are omitted for the constructor procedure. All automatic fields in a structure type follow the non-automatic fields. A structure type can be created as a @pidefterm{structure subtype} of an existing base structure type. An instance of a structure subtype can always be used as an instance of the base structure type, but the subtype gets its own predicate procedure, and it may have its own fields in addition to the fields of the base type. A structure subtype ``inherits'' the fields of its base type. If the base type has @math{m} fields, and if @math{n} fields are specified for the new structure subtype, then the resulting structure type has @math{m+n} fields. The value for automatic fields can be different in a subtype than in its base type. If @math{m'} of the original @math{m} fields are non-automatic (where @math{m'vector] to the structs are @scheme[equal?]. (Consequently, @scheme[equal?] testing for structures depends on the current inspector.) @;------------------------------------------------------------------------ @include-section["define-struct.scrbl"] @;------------------------------------------------------------------------ @section[#:tag "creatingmorestructs"]{Creating Structure Types} @defproc[(make-struct-type [name symbol?] [super-type (or/c struct-type? false/c)] [init-field-cnt exact-nonnegative-integer?] [auto-field-cnt exact-nonnegative-integer?] [auto-v any/c #f] [props (listof (cons/c struct-type-property? any/c)) null] [inspector (or/c inspector? false/c (one-of/c 'prefab)) (current-inspector)] [proc-spec (or/c procedure? exact-nonnegative-integer? false/c) #f] [immutables (listof exact-nonnegative-integer?) null] [guard (or/c procedure? false/c) #f]) (values struct-type? struct-constructor-procedure? struct-predicate-procedure? struct-accessor-procedure? struct-mutator-procedure?)]{ Creates a new structure type, unless @scheme[inspector] is @scheme['prefab], in which case @scheme[make-struct-type] accesses a @techlink{prefab} structre type. The @scheme[name] argument is used as the type name. If @scheme[super-type] is not @scheme[#f], the resulting type is a subtype of the corresponding structure type. The resulting structure type has @math{@scheme[init-field-cnt]+@scheme[auto-field-cnt]} fields (in addition to any fields from @scheme[super-type]), but only @scheme[init-field-cnt] constructor arguments (in addition to any constructor arguments from @scheme[super-type]). The remaining fields are initialized with @scheme[auto-v]. The total field count (including @scheme[super-type] fields) must be no more than 32768. The @scheme[props] argument is a list of pairs, where the @scheme[car] of each pair is a structure type property descriptor, and the @scheme[cdr] is an arbitrary value. A property can be specified multiple times in in @scheme[props] (including properties that are automatically added by properties that are directly included in @scheme[props]) only if the associated values are @scheme[eq?], otherwise the @exnraise[exn:fail:contract]. See @secref["structprops"] for more information about properties. When @scheme[inspector] is @scheme['prefab], then @scheme[props] must be @scheme[null]. The @scheme[inspector] argument normally controls access to reflective information about the structure type and its instances; see @secref["inspectors"] for more information. If @scheme[inspector] is @scheme['prefab], then the resulting @tech{prefab} structure type and its instances are always transparent. If @scheme[proc-spec] is an integer or procedure, instances of the structure type act as procedures. See @scheme[prop:procedure] for further information. Providing a non-@scheme[#f] value for @scheme[proc-spec] is the same as pairing the value with @scheme[prop:procedure] at the end of @scheme[props], plus including @scheme[proc-spec] in @scheme[immutables] when @scheme[proc-spec] is an integer. The @scheme[immutables] argument provides a list of field positions. Each element in the list must be unique, otherwise @exnraise[exn:fail:contract]. Each element must also fall in the range @scheme[0] (inclusive) to @scheme[init-field-cnt] (exclusive), otherwise @exnraise[exn:fail:contract]. The @scheme[guard] argument is either a procedure of @math{n} arguments or @scheme[#f], where @math{n} is the number of arguments for the new structure type's constructor (i.e., @scheme[init-field-cnt] plus constructor arguments implied by @scheme[super-type], if any). If @scheme[guard] is a procedure, then the procedure is called whenever an instance of the type is constructed, or whenever an instance of a subtype is created. The arguments to @scheme[guard] are the values provided for the structure's first @math{n} fields, followed by the name of the instantiated structure type (which is @scheme[name], unless a subtype is instantiated). The @scheme[guard] result must be @math{n} values, which become the actual values for the structure's fields. The @scheme[guard] can raise an exception to prevent creation of a structure with the given field values. If a structure subtype has its own guard, the subtype guard is applied first, and the first @math{n} values produced by the subtype's guard procedure become the first @math{n} arguments to @scheme[guard]. When @scheme[inspector] is @scheme['prefab], then @scheme[guard] must be @scheme[#f]. The result of @scheme[make-struct-type] is five values: @itemize{ @item{a @tech{structure type descriptor},} @item{a @tech{constructor} procedure,} @item{a @tech{predicate} procedure,} @item{an @tech{accessor} procedure, which consumes a structure and a field index between @math{0} (inclusive) and @math{@scheme[init-field-cnt]+@scheme[auto-field-cnt]} (exclusive), and} @item{a @tech{mutator} procedure, which consumes a structure, a field index, and a field value.} } @examples[ #:eval struct-eval (define-values (struct:a make-a a? a-ref a-set!) (make-struct-type 'a #f 2 1 'uninitialized)) (define an-a (make-a 'x 'y)) (a-ref an-a 1) (a-ref an-a 2) (define a-first (make-struct-field-accessor a-ref 0)) (a-first an-a) ] @interaction[ #:eval struct-eval (define-values (struct:b make-b b? b-ref b-set!) (make-struct-type 'b struct:a 1 2 'b-uninitialized)) (define a-b (make-b 'x 'y 'z)) (a-ref a-b 1) (a-ref a-b 2) (b-ref a-b 0) (b-ref a-b 1) (b-ref a-b 2) ] @interaction[ #:eval struct-eval (define-values (struct:c make-c c? c-ref c-set!) (make-struct-type 'c struct:b 0 0 #f null (make-inspector) #f null (code:comment #,(t "guard checks for a number, and makes it inexact")) (lambda (a1 a2 b1 name) (unless (number? a2) (error (string->symbol (format "make-~a" name)) "second field must be a number")) (values a1 (exact->inexact a2) b1)))) (make-c 'x 'y 'z) (define a-c (make-c 'x 2 'z)) (a-ref a-c 1) ]} @interaction[ #:eval struct-eval (define p1 #s(p a b c)) (define-values (struct:p make-p p? p-ref p-set!) (make-struct-type 'p #f 3 0 #f null 'prefab #f '(0 1 2))) (p? p1) (p-ref p1 0) (make-p 'x 'y 'z) ] @defproc[(make-struct-field-accessor [accessor-proc struct-accessot-procedure?] [field-pos exact-nonnegative-integer?] [field-name symbol?]) procedure?]{ Returns a field accessor that is equivalent to @scheme[(lambda (s) (accessor-proc s field-pos))]. The @scheme[accessor-proc] must be an @tech{accessor} returned by @scheme[make-struct-type]. The name of the resulting procedure for debugging purposes is derived from @scheme[field-name] and the name of @scheme[accessor-proc]'s structure type. For examples, see @scheme[make-struct-type].} @defproc[(make-struct-field-mutator [mutator-proc struct-mutator-procedure?] [field-pos exact-nonnegative-integer?] [field-name symbol?]) procedure?]{ Returns a field mutator that is equivalent to @scheme[(lambda (s v) (mutator-proc s field-pos v))]. The @scheme[mutator-proc] must be a @tech{mutator} returned by @scheme[make-struct-type]. The name of the resulting procedure for debugging purposes is derived from @scheme[field-name] and the name of @scheme[mutator-proc]'s structure type. For examples, see @scheme[make-struct-type].} @;------------------------------------------------------------------------ @section[#:tag "structprops"]{Structure Type Properties} A @deftech{structure type property} allows per-type information to be associated with a structure type (as opposed to per-instance information associated with a structure value). A property value is associated with a structure type through the @scheme[make-struct-type] procedure (see @secref["creatingmorestructs"]) or through the @scheme[#:property] option of @scheme[define-struct]. Subtypes inherit the property values of their parent types, and subtypes can override an inherited property value with a new value. @defproc[(make-struct-type-property [name symbol?] [guard (or/c procedure? false/c) #f] [supers (listof (cons/c struct-type-property? (any/c . -> . any/c))) null]) (values struct-type-property? procedure? procedure?)]{ Creates a new structure type property and returns three values: @itemize{ @item{a @deftech{structure type property descriptor}, for use with @scheme[make-struct-type] and @scheme[define-struct];} @item{a @deftech{property predicate} procedure, which takes an arbitrary value and returns @scheme[#t] if the value is a descriptor or instance of a structure type that has a value for the property, @scheme[#f] otherwise;} @item{an @deftech{property accessor} procedure, which returns the value associated with structure type given its descriptor or one of its instances; if the structure type does not have a value for the property, or if any other kind of value is provided, the @exnraise[exn:fail:contract].} } If the optional @scheme[guard] is supplied as a procedure, it is called by @scheme[make-struct-type] before attaching the property to a new structure type. The @scheme[guard-proc] must accept two arguments: a value for the property supplied to @scheme[make-struct-type], and a list containing information about the new structure type. The list contains the values that @scheme[struct-type-info] would return for the new structure type if it skipped the immediate current-inspector control check (but not the check for exposing an ancestor structure type, if any; see @secref["inspectors"]). The result of calling @scheme[guard] is associated with the property in the target structure type, instead of the value supplied to @scheme[make-struct-type]. To reject a property association (e.g., because the value supplied to @scheme[make-struct-type] is inappropriate for the property), the @scheme[guard] can raise an exception. Such an exception prevents @scheme[make-struct-type] from returning a structure type descriptor. The optional @scheme[supers] argument is a list of properties that are automatically associated with some structure type when the newly created property is associated to the structure type. Each property in @scheme[supers] is paired with a procedure that receives the value supplied for the new property (after it is processed by @scheme[guard]) and returns a value for the associated property (which is then sent to that property's guard, of any). @examples[ #:eval struct-eval (define-values (prop:p p? p-ref) (make-struct-type-property 'p)) (define-values (struct:a make-a a? a-ref a-set!) (make-struct-type 'a #f 2 1 'uninitialized (list (cons prop:p 8)))) (p? struct:a) (p? 13) (define an-a (make-a 'x 'y)) (p? an-a) (p-ref an-a) (define-values (struct:b make-b b? b-ref b-set!) (make-struct-type 'b #f 0 0 #f)) (p? struct:b) (define-values (prop:q q? q-ref) (make-struct-type-property 'q (lambda (v si) (add1 v)) (list (cons prop:p sqrt)))) (define-values (struct:c make-c c? c-ref c-set!) (make-struct-type 'c #f 0 0 'uninit (list (cons prop:q 8)))) (q-ref struct:c) (p-ref struct:c) ]} @defproc[(struct-type-property? [v any/c]) boolean?]{ Returns @scheme[#t] if @scheme[v] is a @tech{structure type property descriptor} value, @scheme[#f] otherwise. } @;------------------------------------------------------------------------ @section[#:tag "struct-copy"]{Copying and Updating Structures} @defform[(struct-copy id struct-expr [field-id expr] ...)]{ Creates a new instance of the structure type @scheme[id] with the same field values as the structure produced by @scheme[struct-expr], except that the value of each supplied @scheme[field-id] is instead determined by the corresponding @scheme[expr]. The @scheme[id] must have a @tech{transformer binding} that encapsulates information about a structure type (i.e., like the initial identifier bound by @scheme[define-struct]), and the binding must supply a constructor, a predicate, and all field accessors. Each @scheme[field-id] is combined with @scheme[id] to form @scheme[id]@schemeidfont{-}@scheme[field-id] (using the lexical context of @scheme[field-id]), which must be one of the accessor bindings in @scheme[id]. The accessor bindings determined by different @scheme[field-id]s must be distinct. The order of the @scheme[field-id]s need not match the order of the corresponding fields in the structure type. The @scheme[struct-expr] is evaluated first. The result must be an instance of the @scheme[id] structure type, otherwise the @exnraise[exn:fail:contract]. Next, the field @scheme[expr]s are evaluated in order (even if the fields that correspond to the @scheme[field-id]s are in a different order). Finally, the new structure instance is created. The result of @scheme[struct-expr] can be an instance of a sub-type of @scheme[id], but the resulting copy is an immediate instance of @scheme[id] (not the sub-type).} @;------------------------------------------------------------------------ @section[#:tag "structutils"]{Structure Utilities} @defproc[(struct->vector [v any/c] [opaque-v any/c '...]) vector?]{ Creates a vector representing @scheme[v]. The first slot of the result vector contains a symbol whose printed name has the form @schemeidfont{struct:}@scheme[_id]. Each remaining slot contains either the value of a field in @scheme[v], if it is accessible via the current inspector, or @scheme[opaque-v] for a field that is not accessible. A single @scheme[opaque-v] value is used in the vector for contiguous inaccessible fields. (Consequently, the size of the vector does not match the size of the @scheme[struct] if more than one field is inaccessible.)} @defproc[(struct? [v any/c]) any]{ Returns @scheme[#t] if @scheme[struct->vector] exposes any fields of @scheme[v] with the current inspector, @scheme[#f] otherwise.} @defproc[(struct-type? [v any/c]) boolean?]{Returns @scheme[#t] if @scheme[v] is a structure type descriptor value, @scheme[#f] otherwise.} @defproc[(struct-constructor-procedure? [v any/c]) boolean?]{Returns @scheme[#t] if @scheme[v] is a constructor procedure generated by @scheme[define-struct] or @scheme[make-struct-type], @scheme[#f] otherwise.} @defproc[(struct-predicate-procedure? [v any/c]) boolean?]{Returns @scheme[#t] if @scheme[v] is a predicate procedure generated by @scheme[define-struct] or @scheme[make-struct-type], @scheme[#f] otherwise.} @defproc[(struct-accessor-procedure? [v any/c]) boolean?]{Returns @scheme[#t] if @scheme[v] is an accessor procedure generated by @scheme[define-struct], @scheme[make-struct-type], or @scheme[make-struct-field-accessor], @scheme[#f] otherwise.} @defproc[(struct-mutator-procedure? [v any/c]) boolean?]{Returns @scheme[#t] if @scheme[v] is a mutator procedure generated by @scheme[define-struct], @scheme[make-struct-type], or @scheme[make-struct-field-mutator], @scheme[#f] otherwise.} @defproc[(prefab-struct-key [v any/c]) (or/c false/c symbol? list?)]{ Returns @scheme[#f] if @scheme[v] is not an instance of a @tech{prefab} structure type. Otherwise, the result is the shorted key that could be used with @scheme[make-prefab-struct] to create an instance of the structure type. @examples[ (prefab-struct-key #s(cat "Garfield")) (define-struct cat (name) #:prefab) (define-struct (cute-cat cat) (shipping-dest) #:prefab) (make-cute-cat "Nermel" "Abu Dhabi") (prefab-struct-key (make-cute-cat "Nermel" "Abu Dhabi")) ]} @defproc[(make-prefab-struct [key (or/c symbol? list?)] [v any/c] ...) struct?]{ Creates an instance of a @tech{prefab} structure type, using the @scheme[v]s as field values. The @scheme[key] and the number of @scheme[v]s determine the @tech{prefab} structure type. A @scheme[key] identifies a structure type based on a list with the following items: @itemize{ @item{A symbol for the structure type's name.} @item{An exact, nonnegative integer representing the number of non-automatic fields in the structure type, not counting fields from the supertype (if any).} @item{A list of two items, where the first is an exact, nonnegative integer for the number of automatic fields in the structure type that are not from the supertype (if any), and the second element is an arbitrary value that is the value for the automatic fields.} @item{A vector of exact, nonnegative integers that indicate mutable non-automatic fields in the structure type, counting from @scheme[0] and not including fields from the supertype (if any).} @item{Nothing else, if the structure type has no supertype. Otherwise, the rest of the list matches is the key for the supertype.} } An empty vector and an auto-field list that starts with @scheme[0] can be omitted. Furthermore, the first integer (which indicates the number of non-automatic fields) can be omitted, since it can be inferred from the number of supplied @scheme[v]s. Finally, a single symbol can be used instead of a list that contains only a symbol (in the case that the structure type has no supertype, no automatic fields, and no mutable fields). The total field count must be no more than 32768. If the number of fields indicated by @scheme[key] is inconsistent with the number of supplied @scheme[v]s, the @exnraise[exn:fail:contract]. @examples[ (make-prefab-struct 'clown "Binky" "pie") (make-prefab-struct '(clown 2) "Binky" "pie") (make-prefab-struct '(clown 2 (0 #f) #()) "Binky" "pie") (make-prefab-struct '(clown 1 (1 #f) #()) "Binky" "pie") (make-prefab-struct '(clown 1 (1 #f) #(0)) "Binky" "pie") ]} @defproc[(prefab-key->struct-type [key (or/c symbol? list?)] [field-count (integer-in 0 32768)]) struct-type?]{ Returns a @tech{structure type descriptor} for the @tech{prefab} structure type specified by the combination of @scheme[key] and @scheme[field-count].} @;------------------------------------------------------------------------ @section[#:tag "structinfo"]{Structure Type Transformer Binding} The @scheme[define-struct] form binds the name of a structure type as a @tech{transformer binding} that records the other identifiers bound to the structure type, the constructor procedure, the predicate procedure, and the field accessor and mutator procedures. This information can be used during the expansion of other expressions via @scheme[syntax-local-value]. For example, the @scheme[define-struct] variant for subtypes uses the base type name @scheme[_t] to find the variable @schemeidfont{struct:}@scheme[_t] containing the base type's descriptor; it also folds the field accessor and mutator information for the base type into the information for the subtype. As another example, the @scheme[match] form uses a type name to find the predicates and field accessors for the structure type. The @scheme[struct] form in an imported signature for @scheme[unit] causes the @scheme[unit] transformer to generate information about imported structure types, so that @scheme[match] and subtyping @scheme[define-struct] forms work within the unit. The expansion-time information for a structure type is represented either as a structure that encapsulates a procedure that takes no arguments and returns a list of six element, or it can be represented directly as a list of six elements (of the same sort that the encapsulated procedure must return): @itemize{ @item{an identifier that is bound to the structure type's descriptor, or @scheme[#f] it none is known;} @item{an identifier that is bound to the structure type's constructor, or @scheme[#f] it none is known;} @item{an identifier that is bound to the structure type's predicate, or @scheme[#f] it none is known;} @item{a list of identifiers bound to the field accessors of the structure type, optionally with @scheme[#f] as the list's last element. A @scheme[#f] as the last element indicates that the structure type may have additional fields, otherwise the list is a reliable indicator of the number of fields in the structure type. Furthermore, the accessors are listed in reverse order for the corresponding constructor arguments. (The reverse order enables sharing in the lists for a subtype and its base type.)} @item{a list of identifiers bound to the field mutators of the structure type, or @scheme[#f] for each field that has no known mutator, and optionally with an extra @scheme[#f] as the list's last element (if the accessor list has such a @scheme[#f]). The list's order and the meaning of a final @scheme[#f] are the same as for the accessor identifiers, and the length of the mutator list is the same as the accessor list's length.} @item{an identifier that determines a super-type for the structure type, @scheme[#f] if the super-type (if any) is unknown, or @scheme[#t] if there is no super-type. If a super-type is specified, the identifier is also bound to structure-type expansion-time information.} } Use @scheme[struct-info?] to recognize both forms of information, and use @scheme[extract-struct-info] to obtain a list from either representation. Use @scheme[make-struct-info] to encapsulate a procedure that represents structure type information. The implementor of a syntactic form can expect users of the form to know what kind of information is available about a structure type. For example, the @scheme[match] implementation works with structure information containing an incomplete set of accessor bindings, because the user is assumed to know what information is available in the context of the @scheme[match] expression. In particular, the @scheme[match] expression can appear in a @scheme[unit] form with an imported structure type, in which case the user is expected to know the set of fields that are listed in the signature for the structure type. @note-lib-only[scheme/struct-info] @defproc[(struct-info? [v any/c]) boolean?]{ Returns @scheme[#t] if @scheme[v] is either a six-element list with the correct shape for representing structure-type information, or a procedure encapsulated by @scheme[make-struct-info].} @defproc[(checked-struct-info? [v any/c]) boolean?]{ Returns @scheme[#t] if @scheme[v] is a procedure encapsulated by @scheme[make-struct-info] and produced by @scheme[define-struct], but only when no parent type is specified or the parent type is also specified through a transformer binding to such a value).} @defproc[(make-struct-info [thunk (-> (and/c struct-info? list?))]) struct-info?]{ Encapsulates a thunk that returns structure-type information in list form.} @defproc[(extract-struct-info [v struct-info?]) (and/c struct-info? list?)]{ Extracts the list form of the structure type information represented by @scheme[v].} @defthing[struct:struct-info struct-type?]{ The @tech{structure type descriptor} for the structure type returned by @scheme[make-struct-info]. This @tech{structure type descriptor} is mostly useful for creating structure subtypes. The structure type includes a guard that checks an instance's first field in the same way as @scheme[make-struct-info].} @; ---------------------------------------------------------------------- @close-eval[struct-eval]