You can edit this page using wiki syntax for markup.

Article contents:[[tags: egg]] == check-errors Argument checks & errors. [[toc:]] == Documentation === Usage <enscript language=scheme> (import check-errors) </enscript> Everything. === Check Error Basic The {{type-checks-basic}} & {{type-errors-basic}} {{module}} {{reexports}}. ==== Usage <enscript language=scheme> (import (check-errors basic)) </enscript> The minimum. === Argument Conventions {{LOC}} is a {{symbol}}, or {{#f}}. The symbolic naming of the ''location'' detecting the problem. As in the {{error}} form. {{OBJ}} is any Scheme {{object}}. {{ARGNAM}} is an, optional, {{or string symbol keyword}} naming the argument list element corresponding to the {{OBJ}}. The default is the ''type-name''. === Type Checks Performs the minimal constraint check and raises an error condition upon failure. The ''mimimal constraint'' proviso is important for understanding the behavior of the checking routines. Unless otherwise specified no additional constraints are verified. So the {{check-...-interval}} routines, for example, do not verify the types of the arguments, only the interval constraint. When the {{unsafe}} feature is defined the check procedures are no-ops. All {{check-...}} routines return the checked object. ==== Usage <enscript language=scheme> (import type-checks) </enscript> ==== Type Checks Basic ===== Usage <enscript language=scheme> (import type-checks-basic) </enscript> ===== check-defined-value <procedure>(check-defined-value LOC OBJ [ARGNAM]) -> *</procedure> Ensures the {{OBJ}} is non-void, i.e. not an undefined-value. ===== check-bound-value <procedure>(check-bound-value LOC OBJ [ARGNAM]) -> *</procedure> Ensures the {{OBJ}} is the value of a bound variable. ''Only'' for use in rather unsafe calling environments where some explicit checking is necessary. ===== check-minimum-argument-count <procedure>(check-minimum-argument-count LOC ARGC MINARGC) -> fixnum</procedure> Does not verify the type of {{ARGC}}, and {{MINARGC}}. ===== check-argument-count <procedure>(check-argument-count LOC ARGC MAXARGC) -> fixnum</procedure> Does not verify the type of {{ARGC}}, and {{MAXARGC}}. ===== define-check-type <syntax>(define-check-type TYPNAM [TYPE-PRED])</syntax> Creates a procedure definition for {{check-TYPNAM}} with the signature of the above check procedures. The type-predicate is either {{TYPE-PRED}}, when present, or {{TYPNAM?}}. {{TYPNAM}} is an unquoted {{symbol}}. <enscript language=scheme> (define-check-type hash-table) ;=> ;(define (check-hash-table loc obj #!optional argnam) ; (unless (hash-table? obj) ; (error-hash-table loc obj argnam)) ; obj ) </enscript> ===== define-check+error-type <syntax>(define-check+error-type TYPNAM [TYPE-PRED [TYPMSG]])</syntax> Creates a procedure definition for {{check-TYPNAM}} with the signature of the above check procedures. The type-predicate is either {{TYPE-PRED}}, when present, or {{TYPE?}}. The error message type-name is either the {{TYPMSG}}, when present, or {{"TYPNAM"}}. {{TYPNAM}} is an unquoted {{symbol}}. <enscript language=scheme> (define-check+error-type hash-table) ;=> ;(begin ; (define-error-type hash-table) ; (define (check-hash-table loc obj #!optional argnam) ; (unless (hash-table? obj) ; (error-hash-table loc obj argnam)) ; obj)) </enscript> ==== Type Checks Numbers Omnibus module vovering the individual {{type-checks-numbers}} modules below. ===== Usage <enscript language=scheme> (import type-checks-numbers) </enscript> ===== check-real ===== check-complex ===== check-rational ===== check-exact ===== check-inexact <enscript language=scheme> (import (type-checks-numbers scheme)) </enscript> <procedure>(check-real LOC OBJ [ARGNAM]) -> number</procedure> <procedure>(check-complex LOC OBJ [ARGNAM]) -> number</procedure> <procedure>(check-rational LOC OBJ [ARGNAM]) -> number</procedure> <procedure>(check-exact LOC OBJ [ARGNAM]) -> number</procedure> <procedure>(check-inexact LOC OBJ [ARGNAM]) -> number</procedure> ===== check-number ===== check-positive-number ===== check-non-negative-number ===== check-natural-number ===== check-negative-number ===== check-non-positive-number <enscript language=scheme> (import (type-checks-numbers number)) </enscript> <procedure>(check-number LOC OBJ [ARGNAM]) -> number</procedure> <procedure>(check-positive-number LOC OBJ [ARGNAM]) -> number</procedure> <procedure>(check-non-negative-number LOC OBJ [ARGNAM]) -> number</procedure> <procedure>(check-natural-number LOC OBJ [ARGNAM]) -> number</procedure> <procedure>(check-negative-number LOC OBJ [ARGNAM]) -> number</procedure> <procedure>(check-non-positive-number LOC OBJ [ARGNAM]) -> number</procedure> ===== check-integer ===== check-positive-integer ===== check-non-negative-integer ===== check-natural-integer ===== check-negative-integer ===== check-non-positive-integer <enscript language=scheme> (import (type-checks-numbers integer)) </enscript> <procedure>(check-integer LOC OBJ [ARGNAM]) -> integer</procedure> <procedure>(check-positive-integer LOC OBJ [ARGNAM]) -> integer</procedure> <procedure>(check-non-negative-integer LOC OBJ [ARGNAM]) -> integer</procedure> <procedure>(check-natural-integer LOC OBJ [ARGNAM]) -> integer</procedure> <procedure>(check-negative-integer LOC OBJ [ARGNAM]) -> integer</procedure> <procedure>(check-non-positive-integer LOC OBJ [ARGNAM]) -> integer</procedure> ===== check-fixnum ===== check-positive-fixnum ===== check-non-negative-fixnum ===== check-natural-fixnum ===== check-negative-fixnum ===== check-non-positive-fixnum <enscript language=scheme> (import (type-checks-numbers fixnum)) </enscript> <procedure>(check-fixnum LOC OBJ [ARGNAM]) -> fixnum</procedure> <procedure>(check-positive-fixnum LOC OBJ [ARGNAM]) -> fixnum</procedure> <procedure>(check-non-negative-fixnum LOC OBJ [ARGNAM]) -> fixnum</procedure> <procedure>(check-natural-fixnum LOC OBJ [ARGNAM]) -> fixnum</procedure> <procedure>(check-negative-fixnum LOC OBJ [ARGNAM]) -> fixnum</procedure> <procedure>(check-non-positive-fixnum LOC OBJ [ARGNAM]) -> fixnum</procedure> ===== check-bignum ===== check-positive-bignum ===== check-non-negative-bignum ===== check-negative-bignum ===== check-non-positive-bignum <enscript language=scheme> (import (type-checks-numbers bignum)) </enscript> <procedure>(check-bignum LOC OBJ [ARGNAM]) -> bignum</procedure> <procedure>(check-positive-bignum LOC OBJ [ARGNAM]) -> bignum</procedure> <procedure>(check-non-negative-bignum LOC OBJ [ARGNAM]) -> bignum</procedure> <procedure>(check-negative-bignum LOC OBJ [ARGNAM]) -> bignum</procedure> <procedure>(check-non-positive-bignum LOC OBJ [ARGNAM]) -> bignum</procedure> ===== check-ratnum ===== check-positive-ratnum ===== check-non-positive-bignum ===== check-negative-ratnum ===== check-non-positive-ratnum <enscript language=scheme> (import (type-checks-numbers ratnum)) </enscript> <procedure>(check-ratnum LOC OBJ [ARGNAM]) -> ratnum</procedure> <procedure>(check-positive-ratnum LOC OBJ [ARGNAM]) -> ratnum</procedure> <procedure>(check-non-negative-ratnum LOC OBJ [ARGNAM]) -> ratnum</procedure> <procedure>(check-negative-ratnum LOC OBJ [ARGNAM]) -> ratnum</procedure> <procedure>(check-non-positive-ratnum LOC OBJ [ARGNAM]) -> ratnum</procedure> ===== check-flonum ===== check-float ===== check-positive-flonum ===== check-non-positive-flonum ===== check-negative-flonum ===== check-non-positive-flonum <enscript language=scheme> (import (type-checks-numbers flonum)) </enscript> <procedure>(check-flonum LOC OBJ [ARGNAM]) -> flonum</procedure> <procedure>(check-float LOC OBJ [ARGNAM]) -> flonum</procedure> <procedure>(check-positive-flonum LOC OBJ [ARGNAM]) -> flonum</procedure> <procedure>(check-non-negative-flonum LOC OBJ [ARGNAM]) -> flonum</procedure> <procedure>(check-negative-flonum LOC OBJ [ARGNAM]) -> flonum</procedure> <procedure>(check-non-positive-flonum LOC OBJ [ARGNAM]) -> flonum</procedure> ===== check-cplxnum <enscript language=scheme> (import (type-checks-numbers cplxnum)) </enscript> <procedure>(check-cplxnum LOC OBJ [ARGNAM]) -> cplxnum</procedure> ==== Type Checks Numbers Interval ===== Usage <enscript language=scheme> (import (type-checks-numbers interval)) </enscript> ===== check-range <procedure>(check-range LOC START END [ARGNAM]) -> number number</procedure> Verify {{(<= START END)}} & return {{(values START END)}}. Does not verify the type of {{START}} and {{END}}. ===== check-open-interval <procedure>(check-open-interval LOC NUM MINNUM MAXNUM [ARGNAM]) -> number</procedure> {{NUM}} in {{]MINNUM MAXNUM[}}. Does not verify the type of {{NUM}}, {{MINNUM}}, and {{MAXNUM}}. ===== check-closed-interval <procedure>(check-closed-interval LOC NUM MINNUM MAXNUM [ARGNAM]) -> number</procedure> {{NUM}} in {{[MINNUM MAXNUM]}}. Does not verify the type of {{NUM}}, {{MINNUM}}, and {{MAXNUM}}. ===== check-half-open-interval <procedure>(check-half-open-interval LOC NUM MINNUM MAXNUM [ARGNAM]) -> number</procedure> {{NUM}} in {{]MINNUM MAXNUM]}}. Does not verify the type of {{NUM}}, {{MINNUM}}, and {{MAXNUM}}. ===== check-half-closed-interval <procedure>(check-half-closed-interval LOC NUM MINNUM MAXNUM [ARGNAM]) -> number</procedure> {{NUM}} in {{[MINNUM MAXNUM[}}. Does not verify the type of {{NUM}}, {{MINNUM}}, and {{MAXNUM}}. ==== Type Checks Structured ===== Usage <enscript language=scheme> (import type-checks-structured) </enscript> ===== check-procedure <procedure>(check-procedure LOC OBJ [ARGNAM]) -> procedure</procedure> ===== check-input-port <procedure>(check-input-port LOC OBJ [ARGNAM]) -> input-port</procedure> ===== check-output-port <procedure>(check-output-port LOC OBJ [ARGNAM]) -> output-port</procedure> ===== check-list <procedure>(check-list LOC OBJ [ARGNAM]) -> list</procedure> ===== check-alist <procedure>(check-alist LOC OBJ [ARGNAM]) -> alist</procedure> ===== check-plist <procedure>(check-plist LOC OBJ [ARGNAM]) -> plist</procedure> ===== check-pair <procedure>(check-pair LOC OBJ [ARGNAM]) -> pair</procedure> ===== check-blob <procedure>(check-blob LOC OBJ [ARGNAM]) -> blob</procedure> ===== check-vector <procedure>(check-vector LOC OBJ [ARGNAM]) -> vector</procedure> ===== check-structure <procedure>(check-structure LOC OBJ TAG [ARGNAM]) -> structure</procedure> <procedure>(check-record LOC OBJ TAG [ARGNAM]) -> structure</procedure> <procedure>(check-record-type LOC OBJ TAG [ARGNAM]) -> structure</procedure> Essentially synonyms. ===== define-check-structure <syntax>(define-check-structure TAG)</syntax> Creates a procedure definition for {{check-TAG}} with the signature of the above check procedures, and the body of {{(check-structure LOC OBJ TAG [ARGNAM])}}. ===== check-string <procedure>(check-string LOC OBJ [ARGNAM]) -> string</procedure> ==== Type Checks Atoms ===== Usage <enscript language=scheme> (import type-checks-atoms) </enscript> ===== check-symbol <procedure>(check-symbol LOC OBJ [ARGNAM]) -> symbol</procedure> ===== check-keyword <procedure>(check-keyword LOC OBJ [ARGNAM]) -> keyword</procedure> ===== check-char <procedure>(check-char LOC OBJ [ARGNAM]) -> char</procedure> ===== check-boolean <procedure>(check-boolean LOC OBJ [ARGNAM]) -> boolean</procedure> === Type Errors ==== Argument Conventions {{TYPNAM}} is a {{symbol}} or {{string}}, unless otherwise indicated. {{ARGNAM}} is a {{symbol}}, {{string}}, or {{#f}}. Default is {{#f}}. ==== Usage <enscript language=scheme> (import type-errors) </enscript> ==== Type Errors Basic ===== Usage <enscript language=scheme> (import type-errors-basic) </enscript> ===== make-bad-argument-message <procedure>(make-bad-argument-message [ARGNAM]) --> string</procedure> Returns an argument type error message for the, optional, {{ARGNAM}}. Example: <enscript language=scheme> (make-bad-argument-message "count") ;=> "bad `count' argument" (make-bad-argument-message) ;=> "bad argument" </enscript> ===== make-type-name-message <procedure>(make-type-name-message TYPNAM) --> string</procedure> Returns an argument type message for the {{TYPNAM}} by supplying an article. Example: <enscript language=scheme> (make-type-name-message integer) ;=> an integer" (make-type-name-message "symbol in {foo bar baz}") ;=> "a symbol in {foo bar baz}" </enscript> ===== make-error-type-message <procedure>(make-error-type-message TYPNAM [ARGNAM]) --> string</procedure> Returns a type error message from the {{TYPNAM}} and optional {{ARGNAM}}. Uses {{make-bad-argument-message}} and {{make-type-name-message}} to build the message components. Example: <enscript language=scheme> (make-error-type-message 'integer "count") ;=> "bad `count' argument type - not an integer" </enscript> ===== make-location-message <procedure>(make-location-message LOC) --> string</procedure> ===== make-warning-type-message <procedure>(make-warning-type-message LOC OBJ TYPNAM [ARGNAM]) --> string</procedure> ===== make-error-interval-message <procedure>(make-error-interval-message LFT MIN MAX RGT [ARGNAM]) --> string</procedure> ===== signal-bounds-error <procedure>(signal-bounds-error LOC MSG OBJ...)</procedure> Raises a non-continuable type error - (({exn bounds)}}. ===== signal-type-error <procedure>(signal-type-error LOC MSG OBJ...)</procedure> Raises a non-continuable type error - (({exn type)}}. ===== error-argument-type <procedure>(error-argument-type LOC OBJ TYPNAM [ARGNAM])</procedure> Raises a {{type-error}} where is message is constructed from the {{TYPNAM}} and {{ARGNAM}}. Uses {{signal-type-error}} and {{make-error-type-message}}. ===== warning-argument-type <procedure>(warning-argument-type LOC OBJ TYPNAM [ARGNAM])</procedure> A warning is issued with a message similar to that of {{error-argument-type}}. ===== error-defined-value <procedure>(error-defined-value LOC OBJ [ARGNAM])</procedure> ===== error-bound-value <procedure>(error-bound-value LOC OBJ [ARGNAM])</procedure> ===== error-minimum-argument-count <procedure>(error-minimum-argument-count LOC ARGC MINARGC)</procedure> ===== error-argument-count <procedure>(error-argument-count LOC ARGC MAXARGC)</procedure> ===== define-error-type <syntax>(define-error-type TYPNAM [TYPMSG])</syntax> {{TYPNAM}} is a {{symbol}}. {{TYPMSG}} is a {{symbol}} or {{string}}. Creates a procedure definition for {{error-TYPNAM}} with the signature of the above error procedures. The type-name is either {{TYPMSG}}, when present, or {{"TYPNAM"}}. <enscript language=scheme> (define-error-type hash-table) ;=> ;(define (error-hash-table loc obj #!optional argnam) ; (error-argument-type loc obj 'hash-table argnam) ) (define-error-type byte-order "symbol in {big-endian little-endian}") ;=> ;(define (error-byte-order loc obj #!optional argnam) ; (error-argument-type loc obj "symbol in {big-endian little-endian}" argnam) ) </enscript> ==== Type Errors Numbers Omnibus module vovering the individual {{type-errors-numbers}} modules below. ===== Usage <enscript language=scheme> (import type-errors-numbers) </enscript> ===== error-real ===== error-complex ===== error-rational ===== error-exact ===== error-inexact <enscript language=scheme> (import (type-errors-numbers scheme)) </enscript> <procedure>(error-real LOC OBJ [ARGNAM])</procedure> <procedure>(error-complex LOC OBJ [ARGNAM])</procedure> <procedure>(error-rational LOC OBJ [ARGNAM])</procedure> <procedure>(error-exact LOC OBJ [ARGNAM])</procedure> <procedure>(error-inexact LOC OBJ [ARGNAM])</procedure> ===== error-number ===== error-positive-number ===== error-non-positive-number ===== error-natural-number ===== error-negative-number ===== error-non-positive-number <enscript language=scheme> (import (type-errors-numbers number)) </enscript> <procedure>(error-number LOC OBJ [ARGNAM])</procedure> <procedure>(error-positive-number LOC OBJ [ARGNAM])</procedure> <procedure>(error-non-positive-number LOC OBJ [ARGNAM])</procedure> <procedure>(error-natural-number LOC OBJ [ARGNAM])</procedure> <procedure>(error-negative-number LOC OBJ [ARGNAM])</procedure> <procedure>(error-non-positive-number LOC OBJ [ARGNAM])</procedure> ===== error-integer ===== error-positive-integer ===== error-non-positive-integer ===== error-natural-integer ===== error-negative-integer ===== error-non-positive-integer <enscript language=scheme> (import (type-errors-numbers integer)) </enscript> <procedure>(error-integer LOC OBJ [ARGNAM])</procedure> <procedure>(error-positive-integer LOC OBJ [ARGNAM])</procedure> <procedure>(error-non-positive-integer LOC OBJ [ARGNAM])</procedure> <procedure>(error-natural-integer LOC OBJ [ARGNAM])</procedure> <procedure>(error-negative-integer LOC OBJ [ARGNAM])</procedure> <procedure>(error-non-positive-integer LOC OBJ [ARGNAM])</procedure> ===== error-fixnum ===== error-positive-fixnum ===== error-non-positive-fixnum ===== error-natural-fixnum ===== error-negative-fixnum ===== error-non-positive-fixnum <enscript language=scheme> (import (type-errors-numbers fixnum)) </enscript> <procedure>(error-fixnum LOC OBJ [ARGNAM])</procedure> <procedure>(error-positive-fixnum LOC OBJ [ARGNAM])</procedure> <procedure>(error-non-positive-fixnum LOC OBJ [ARGNAM])</procedure> <procedure>(error-natural-fixnum LOC OBJ [ARGNAM])</procedure> <procedure>(error-negative-fixnum LOC OBJ [ARGNAM])</procedure> <procedure>(error-non-positive-fixnum LOC OBJ [ARGNAM])</procedure> ===== error-bignum ===== error-positive-bignum ===== error-non-positive-bignum ===== error-negative-bignum ===== error-non-positive-bignum <enscript language=scheme> (import (type-errors-numbers bignum)) </enscript> <procedure>(error-bignum LOC OBJ [ARGNAM])</procedure> <procedure>(error-non-positive-bignum LOC OBJ [ARGNAM])</procedure> <procedure>(error-natural-bignum LOC OBJ [ARGNAM])</procedure> <procedure>(error-negative-bignum LOC OBJ [ARGNAM])</procedure> <procedure>(error-non-positive-bignum LOC OBJ [ARGNAM])</procedure> ===== error-ratnum ===== error-positive-ratnum ===== error-non-positive-ratnum ===== error-negative-ratnum ===== error-non-positive-ratnum <enscript language=scheme> (import (type-errors-numbers ratnum)) </enscript> <procedure>(error-ratnum LOC OBJ [ARGNAM])</procedure> <procedure>(error-non-positive-ratnum LOC OBJ [ARGNAM])</procedure> <procedure>(error-positive-ratnum LOC OBJ [ARGNAM])</procedure> <procedure>(error-negative-ratnum LOC OBJ [ARGNAM])</procedure> <procedure>(error-non-positive-ratnum LOC OBJ [ARGNAM])</procedure> ===== error-float ===== error-flonum ===== error-positive-flonum ===== error-non-positive-flonum ===== error-negative-flonum ===== error-non-positive-flonum <enscript language=scheme> (import (type-errors-numbers flonum)) </enscript> <procedure>(error-flonum LOC OBJ [ARGNAM])</procedure> <procedure>(error-float LOC OBJ [ARGNAM])</procedure> <procedure>(error-non-positive-flonum LOC OBJ [ARGNAM])</procedure> <procedure>(error-positive-flonum LOC OBJ [ARGNAM])</procedure> <procedure>(error-negative-flonum LOC OBJ [ARGNAM])</procedure> <procedure>(error-non-positive-flonum LOC OBJ [ARGNAM])</procedure> ===== error-cplxnum <enscript language=scheme> (import (type-errors-numbers cplxnum)) </enscript> <procedure>(error-cplxnum LOC OBJ [ARGNAM])</procedure> ==== Type Errors Numbers Interval ===== Usage <enscript language=scheme> (import (type-errors-numbers interval)) </enscript> ===== error-range <procedure>(error-range LOC START END [ARGNAM])</procedure> ===== error-open-interval <procedure>(error-open-interval LOC NUM MINNUM MAXNUM [ARGNAM])</procedure> ===== error-closed-interval <procedure>(error-closed-interval LOC NUM MINNUM MAXNUM [ARGNAM])</procedure> ===== error-half-open-interval <procedure>(error-half-open-interval LOC NUM MINNUM MAXNUM [ARGNAM])</procedure> ===== error-half-closed-interval <procedure>(error-half-closed-interval LOC NUM MINNUM MAXNUM [ARGNAM])</procedure> ===== error-interval <procedure>(error-interval LOC NUM LEFT MINNUM MAXNUM RIGHT [ARGNAM])</procedure> {{LEFT}} is a {{character}}, {{symbol}}, or {{string}} that denotes the symbolic opening of an interval. {{RIGHT}} is a {{character}}, {{symbol}}, or {{string}} that denotes the symbolic closing of an interval. ==== Type Errors Structured ===== Usage <enscript language=scheme> (import type-errors-structured) </enscript> ===== error-procedure <procedure>(error-procedure LOC OBJ [ARGNAM])</procedure> ===== error-input-port <procedure>(error-input-port LOC OBJ [ARGNAM])</procedure> ===== error-output-port <procedure>(error-output-port LOC OBJ [ARGNAM])</procedure> ===== error-list <procedure>(error-list LOC OBJ [ARGNAM])</procedure> ===== error-alist <procedure>(error-alist LOC OBJ [ARGNAM])</procedure> ===== error-plist <procedure>(error-plist LOC OBJ [ARGNAM])</procedure> ===== error-pair <procedure>(error-pair LOC OBJ [ARGNAM])</procedure> ===== error-blob <procedure>(error-blob LOC OBJ [ARGNAM])</procedure> ===== error-vector <procedure>(error-vector LOC OBJ [ARGNAM])</procedure> ===== error-structure <procedure>(error-structure LOC OBJ TAG [ARGNAM])</procedure> {{error-record}} and {{error-record-type}} are essentially synonyms. ===== error-string <procedure>(error-string LOC OBJ [ARGNAM])</procedure> ==== Type Errors Atoms ===== Usage <enscript language=scheme> (import type-errors-atoms) </enscript> ===== error-symbol <procedure>(error-symbol LOC OBJ [ARGNAM])</procedure> ===== error-keyword <procedure>(error-keyword LOC OBJ [ARGNAM])</procedure> ===== error-char <procedure>(error-char LOC OBJ [ARGNAM])</procedure> ===== error-boolean <procedure>(error-boolean LOC OBJ [ARGNAM])</procedure> === SRFI 4 Checks ==== Usage <enscript language=scheme> (import srfi-4-checks) </enscript> ==== check-s8vector ==== check-u8vector ==== check-s16vector ==== check-u16vector ==== check-s32vector ==== check-u32vector ==== check-s64vector ==== check-u64vector ==== check-f32vector ==== check-f64vector <procedure>(check-s8vector LOC OBJ [ARGNAM]) -> *</procedure> <procedure>(check-u8vector LOC OBJ [ARGNAM]) -> *</procedure> <procedure>(check-s16vector LOC OBJ [ARGNAM]) -> *</procedure> <procedure>(check-u16vector LOC OBJ [ARGNAM]) -> *</procedure> <procedure>(check-s32vector LOC OBJ [ARGNAM]) -> *</procedure> <procedure>(check-u32vector LOC OBJ [ARGNAM]) -> *</procedure> <procedure>(check-s64vector LOC OBJ [ARGNAM]) -> *</procedure> <procedure>(check-u64vector LOC OBJ [ARGNAM]) -> *</procedure> <procedure>(check-f32vector LOC OBJ [ARGNAM]) -> *</procedure> <procedure>(check-f64vector LOC OBJ [ARGNAM]) -> *</procedure> === SRFI 4 Errors ==== Usage <enscript language=scheme> (import srfi-4-errors) </enscript> ==== error-s8vector ==== error-u8vector ==== error-s16vector ==== error-u16vector ==== error-s32vector ==== error-u32vector ==== error-s64vector ==== error-u64vector ==== error-f32vector ==== error-f64vector <procedure>(error-s8vector LOC OBJ [ARGNAM])</procedure> <procedure>(error-u8vector LOC OBJ [ARGNAM])</procedure> <procedure>(error-s16vector LOC OBJ [ARGNAM])</procedure> <procedure>(error-u16vector LOC OBJ [ARGNAM])</procedure> <procedure>(error-s32vector LOC OBJ [ARGNAM])</procedure> <procedure>(error-u32vector LOC OBJ [ARGNAM])</procedure> <procedure>(error-s64vector LOC OBJ [ARGNAM])</procedure> <procedure>(error-u64vector LOC OBJ [ARGNAM])</procedure> <procedure>(error-f32vector LOC OBJ [ARGNAM])</procedure> <procedure>(error-f64vector LOC OBJ [ARGNAM])</procedure> === Type Checks System Does not allow invalid argument name specification. ===== Usage <enscript language=scheme> (import (check-errors sys)) </enscript> '''Note''' that the extension is provided as an ''inline''. An {{-unsafe}} compile can remove the checks! ==== check-list ==== check-pair ==== check-vector ==== check-boolean ==== check-char ==== check-exact ==== check-inexact ==== check-number ==== check-integer ==== check-real ==== check-fixnum ==== check-string ==== check-symbol ==== check-keyword ==== check-output-port ==== check-input-port ==== check-locative ==== check-closure ==== check-procedure ==== check-byte-vector ==== check-blob ==== check-structure ==== check-exact-integer ==== check-exact-unsigned-integer ==== check-fixnum-in-range <procedure>(check-list LOC OBJ) -> list</procedure> <procedure>(check-pair LOC OBJ) -> pair</procedure> <procedure>(check-vector LOC OBJ) -> vector</procedure> <procedure>(check-boolean LOC OBJ) -> boolean</procedure> <procedure>(check-char LOC OBJ) -> char</procedure> <procedure>(check-exact LOC OBJ) -> number</procedure> <procedure>(check-inexact LOC OBJ) -> number</procedure> <procedure>(check-number LOC OBJ) -> number</procedure> <procedure>(check-integer LOC OBJ) -> integer</procedure> <procedure>(check-real LOC OBJ) -> (or integer ratnum float)</procedure> <procedure>(check-fixnum LOC OBJ) -> fixnum</procedure> <procedure>(check-string LOC OBJ) -> string</procedure> <procedure>(check-symbol LOC OBJ) -> symbol</procedure> <procedure>(check-keyword LOC OBJ) -> keyword</procedure> <procedure>(check-output-port LOC OBJ) -> output-port</procedure> <procedure>(check-input-port LOC OBJ) -> input-port</procedure> <procedure>(check-locative LOC OBJ) -> locative</procedure> <procedure>(check-closure LOC OBJ) -> procedure</procedure> <procedure>(check-procedure LOC OBJ) -> procedure</procedure> <procedure>(check-byte-vector LOC OBJ) -> blob</procedure> <procedure>(check-blob LOC OBJ) -> blob</procedure> <procedure>(check-structure LOC OBJ TAG) -> (struct TAG)</procedure> <procedure>(check-exact-integer LOC OBJ) -> integer</procedure> <procedure>(check-exact-unsigned-integer LOC OBJ) -> integer</procedure> <procedure>(check-fixnum-in-range LOC OBJ LOW HIGH)-> fixnum)</procedure> == Notes * While a {{LOC}} is often enough to distinguish arguments of different expected types, an {{ARGNAM}} should be supplied otherwise. <enscript language=scheme> ;describes a #!key argument (check-symbol 'v-op oper #:operation) ;more descriptive (and specific) (check-integer 'v-op x "x coordinate") (check-integer 'v-op y "y coordinate") </enscript> * Assuming predicates are available for all used ''types'' then checks can be made using only {{define-check+error-type}}, reducing the runtime dependencies. <enscript language=scheme> (import (check-errors basic)) (define-check+error-type my-type) </enscript> * If a module/library only uses system types & doesn't need (having disjoint types), or want, argument disambiguation by name then {{(import (check-errors sys))}}. <enscript language=scheme> (define (func x a y b) (baz (check-exact 'func x) (check-inexact 'func y)) (bar (check-symbol 'func a) (check-string 'func b)) ...) </enscript> * Note that {{check-float}} is not {{check-inexact}}, unless: <enscript language=scheme> (import (check-errors sys) miscmacros) (define-syntax-rule (check-float . ?args) (check-inexact . ?args)) </enscript> However the error message will not mention a {{float}}. * If "-strict-types" are important for you then be sure to {{import}} from the libraries with a compiled types annotation file. CHICKEN doesn't "roll-up" the type annotations so the compiler will miss them unless the actual exporting module is specified, and not an omnibus module. * The {{(check-...)}} procedure will return the checked object so replacing the 1st argument variable reference with the check form will save a fetch. <enscript language=scheme> (define (func x y) (foo (bar (baz (check-Tx 'func x 'x) (check-Ty 'func y 'y)))) ) (define (func x y) (let* ((bazle (baz (check-Tx 'func x 'x) (check-Ty 'func y 'y))) (...uses bazle, x, y...) ) ...) ) </enscript> - Any reliance on execution order is undefined! <enscript language=scheme> (func (check-Tx 'func x 'x) 42 (op x)) ;<loud buzzer sound> ;* missing? (let ((a (foo (check-Tx 'func x 'x))) ;<loud buzzer sound> (b (op x)) ) ...) </enscript> == Bugs & Limitations * The {{make-*-message}} functions are '''English''' only; but ''pluggable'', given the source. See {{"type-errors-en.incl.scm" }} & {{"type-errors-basic.scm"}}. == Author [[/users/kon-lovett|Kon Lovett]] == Repository This egg is hosted on the CHICKEN Subversion repository: [[https://anonymous@code.call-cc.org/svn/chicken-eggs/release/5/check-errors|https://anonymous@code.call-cc.org/svn/chicken-eggs/release/5/check-errors]] If you want to check out the source code repository of this egg and you are not familiar with Subversion, see [[/egg-svn-checkout|this page]]. == Version history ; 3.8.1 : Stop variable injection in {{define-...}} forms. ; 3.8.0 : Add {{define-check-structure}}. ; 3.7.1 : Fix inline file issue. ; 3.7.0 : Test improvements. ; 3.6.1 : . ; 3.6.0 : Add {{(type-checks/errors-numbers scheme/number/fixnum/integer/bignum/ratnum/cplxnum)}} modules. ; 3.5.1 : Fix {{check-structure}} return type. Inlining module {{(check-errors sys)}}. ; 3.5.0 ; Add {{(check-errors sys)}} module. ; 3.4.0 ; Add {{(type-checks/errors-numbers interval)}} module. ; 3.3.1 ; Add {{(check-errors basic)}} {{module}}. ; 3.3.0 ; Add {{bignum}}/{{ratnum}}/{{cplxnum}}/{{float}}. Fix {{complex}}/{{rational}}. ; 3.2.6 ; . ; 3.2.5 ; Test improvements. ; 3.2.4 ; Add {{make-error-interval-message}}, {{make-warning-type-message}}, & {{make-location-message}}. The {{make-*-message}} API is ''pure''. Fix {{check-*}} routines unbound checking. ; 3.2.3 ; . ; 3.2.2 ; . ; 3.2.1 ; . ; 3.2.0 ; . ; 3.1.2 ; . ; 3.1.1 ; . ; 3.1.0 ; Add {{type-errors/checks-basic/numbers/atoms/structured}} modules. ; 3.0.0 ; CHICKEN 5 release. == License Copyright (C) 2009-2024 Kon Lovett. All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the Software), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED ASIS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Description of your changes:

I would like to authenticate

Spam control

What do you get when you add 14 to 11?