check-errors

Argument checks & errors.

  1. check-errors
  2. Documentation
    1. Argument Conventions
    2. Type Checks
      1. Usage
      2. check-defined-value
      3. check-bound-value
      4. check-fixnum
      5. check-positive-fixnum
      6. check-natural-fixnum
      7. check-flonum
      8. check-integer
      9. check-positive-integer
      10. check-natural-integer
      11. check-number
      12. check-positive-number
      13. check-natural-number
      14. check-procedure
      15. check-input-port
      16. check-output-port
      17. check-list
      18. check-pair
      19. check-blob
      20. check-vector
      21. check-structure
      22. check-symbol
      23. check-keyword
      24. check-string
      25. check-char
      26. check-boolean
      27. check-alist
      28. check-minimum-argument-count
      29. check-argument-count
      30. check-open-interval
      31. check-closed-interval
      32. check-half-open-interval
      33. check-half-closed-interval
      34. define-check-type
      35. define-check+error-type
    3. Type Errors
      1. Argument Conventions
      2. Usage
      3. make-bad-argument-message
      4. make-type-name-message
      5. make-error-type-message
      6. signal-type-error
      7. error-argument-type
      8. warning-argument-type
      9. error-defined-value
      10. error-bound-value
      11. error-fixnum
      12. error-positive-fixnum
      13. error-natural-fixnum
      14. error-flonum
      15. error-integer
      16. error-positive-integer
      17. error-natural-integer
      18. error-number
      19. error-positive-number
      20. error-natural-number
      21. error-procedure
      22. error-input-port
      23. error-output-port
      24. error-list
      25. error-pair
      26. error-blob
      27. error-vector
      28. error-structure
      29. error-symbol
      30. error-keyword
      31. error-string
      32. error-char
      33. error-boolean
      34. error-alist
      35. error-minimum-argument-count
      36. error-argument-count
      37. error-open-interval
      38. error-closed-interval
      39. error-half-open-interval
      40. error-half-closed-interval
      41. error-interval
      42. define-error-type
    4. SRFI 4 Checks
      1. Usage
      2. check-s8vector
      3. check-u8vector
      4. check-s16vector
      5. check-u16vector
      6. check-s32vector
      7. check-u32vector
      8. check-s64vector
      9. check-u64vector
      10. check-f32vector
      11. check-f64vector
    5. SRFI 4 Errors
      1. Usage
      2. error-s8vector
      3. error-u8vector
      4. error-s16vector
      5. error-u16vector
      6. error-s32vector
      7. error-u32vector
      8. error-s64vector
      9. error-u64vector
      10. error-f32vector
      11. error-f64vector
  3. Notes
  4. Author
  5. Version history
  6. License

Documentation

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 a string or symbol 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 arugments, only the interval constraint.

When the unsafe feature is defined the check procedures are no-ops.

Note that the full-numeric-tower is not supported.

All check-... routines return the checked object; unless a type-error exception is raised, obviously.

Usage

(require-extension type-checks)

check-defined-value

[procedure] (check-defined-value LOC OBJ [ARGNAM]) => *

Ensures the OBJ is non-void, i.e. not an undefined-value.

check-bound-value

[procedure] (check-bound-value LOC OBJ [ARGNAM]) => *

Ensures the OBJ is the value of a bound variable.

Only for use in rather unsafe calling envrionments where some explicit checking is necessary.

check-fixnum

[procedure] (check-fixnum LOC OBJ [ARGNAM]) => *

check-positive-fixnum

[procedure] (check-positive-fixnum LOC OBJ [ARGNAM]) => *

check-natural-fixnum

[procedure] (check-natural-fixnum LOC OBJ [ARGNAM]) => *

check-flonum

[procedure] (check-flonum LOC OBJ [ARGNAM]) => *

check-integer

[procedure] (check-integer LOC OBJ [ARGNAM]) => *

check-positive-integer

[procedure] (check-positive-integer LOC OBJ [ARGNAM]) => *

check-natural-integer

[procedure] (check-natural-integer LOC OBJ [ARGNAM]) => *

check-number

[procedure] (check-number LOC OBJ [ARGNAM]) => *

check-positive-number

[procedure] (check-positive-number LOC OBJ [ARGNAM]) => *

check-natural-number

[procedure] (check-natural-number LOC OBJ [ARGNAM]) => *

check-procedure

[procedure] (check-procedure LOC OBJ [ARGNAM]) => *

check-input-port

[procedure] (check-input-port LOC OBJ [ARGNAM]) => *

check-output-port

[procedure] (check-output-port LOC OBJ [ARGNAM]) => *

check-list

[procedure] (check-list LOC OBJ [ARGNAM]) => *

check-pair

[procedure] (check-pair LOC OBJ [ARGNAM]) => *

check-blob

[procedure] (check-blob LOC OBJ [ARGNAM]) => *

check-vector

[procedure] (check-vector LOC OBJ [ARGNAM]) => *

check-structure

[procedure] (check-structure LOC OBJ TAG [ARGNAM]) => *
[procedure] (check-record LOC OBJ TAG [ARGNAM]) => *
[procedure] (check-record-type LOC OBJ TAG [ARGNAM]) => *

check-record and check-record-type are essentially synonyms.

check-symbol

[procedure] (check-symbol LOC OBJ [ARGNAM]) => *

check-keyword

[procedure] (check-keyword LOC OBJ [ARGNAM]) => *

check-string

[procedure] (check-string LOC OBJ [ARGNAM]) => *

check-char

[procedure] (check-char LOC OBJ [ARGNAM]) => *

check-boolean

[procedure] (check-boolean LOC OBJ [ARGNAM]) => *

check-alist

[procedure] (check-alist LOC OBJ [ARGNAM]) => *

check-minimum-argument-count

[procedure] (check-minimum-argument-count LOC ARGC MINARGC) => *

Does not verify the type of ARGC, or MINARGC.

check-argument-count

[procedure] (check-argument-count LOC ARGC MAXARGC) => *

Does not verify the type of ARGC, or MAXARGC.

check-open-interval

[procedure] (check-open-interval LOC NUM MINNUM MAXNUM [ARGNAM]) => *

NUM in ]MINNUM MAXNUM[.

Does not verify the type of NUM, MINNUM, or MAXNUM.

check-closed-interval

[procedure] (check-closed-interval LOC NUM MINNUM MAXNUM [ARGNAM]) => *

NUM in [MINNUM MAXNUM].

Does not verify the type of NUM, MINNUM, or MAXNUM.

check-half-open-interval

[procedure] (check-half-open-interval LOC NUM MINNUM MAXNUM [ARGNAM]) => *

NUM in ]MINNUM MAXNUM].

Does not verify the type of NUM, MINNUM, or MAXNUM.

check-half-closed-interval

[procedure] (check-half-closed-interval LOC NUM MINNUM MAXNUM [ARGNAM]) => *

NUM in [MINNUM MAXNUM[.

Does not verify the type of NUM, MINNUM, or MAXNUM.

define-check-type

[syntax] (define-check-type TYPNAM [TYPE-PRED])

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.

(define-check-type hash-table)
;=>
;(define (check-hash-table loc obj #!optional argnam)
;  (unless (hash-table? obj)
;    (error-hash-table loc obj argnam))
;  obj )

define-check+error-type

[syntax] (define-check+error-type TYPNAM [TYPE-PRED [TYPMSG]])

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.

(define-check+error-type hash-table)
;=>
;(define-error-type loc obj 'hash-table)
;(define (check-hash-table loc obj #!optional argnam)
;  (unless (hash-table? obj)
;    (error-hash-table loc obj argnam))
;  obj )

Type Errors

Argument Conventions

TYPNAM is a symbol or string, unless otherwise indicated.

ARGNAM is a symbol, string, or #f. Default is #f.

Usage

(require-extension type-errors)

make-bad-argument-message

[procedure] (make-bad-argument-message [ARGNAM]) => string

Returns an argument type error message for the, optional, ARGNAM.

Example:

(make-bad-argument-message "count") ;=> "bad `count' argument"
(make-bad-argument-message) ;=> "bad argument"

make-type-name-message

[procedure] (make-type-name-message TYPNAM) => string

Returns an argument type message for the TYPNAM.

Example:

(make-type-name-message integer) ;=> an integer"
(make-type-name-message "symbol in {foo bar baz}") ;=> "a symbol in {foo bar baz}"

Note that make-type-name-message is suitable only for English. It supplies a suitable article for the type-name.

make-error-type-message

[procedure] (make-error-type-message TYPNAM [ARGNAM]) => string

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:

(make-error-type-message 'integer "count") ;=> "bad `count' argument type - not an integer"

signal-type-error

[procedure] (signal-type-error LOC MSG OBJ...)

Raises a non-continuable type error - (({exn type)}}.

error-argument-type

[procedure] (error-argument-type LOC OBJ TYPNAM [ARGNAM])

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])

A warning is issued with a message similar to that of error-argument-type.

error-defined-value

[procedure] (error-defined-value LOC OBJ [ARGNAM])

error-bound-value

[procedure] (error-bound-value LOC OBJ [ARGNAM])

error-fixnum

[procedure] (error-fixnum LOC OBJ [ARGNAM])

error-positive-fixnum

[procedure] (error-positive-fixnum LOC OBJ [ARGNAM])

error-natural-fixnum

[procedure] (error-natural-fixnum LOC OBJ [ARGNAM])

error-flonum

[procedure] (error-flonum LOC OBJ [ARGNAM])

error-integer

[procedure] (error-integer LOC OBJ [ARGNAM])

error-positive-integer

[procedure] (error-positive-integer LOC OBJ [ARGNAM])

error-natural-integer

[procedure] (error-natural-integer LOC OBJ [ARGNAM])

error-number

[procedure] (error-number LOC OBJ [ARGNAM])

error-positive-number

[procedure] (error-positive-number LOC OBJ [ARGNAM])

error-natural-number

[procedure] (error-natural-number LOC OBJ [ARGNAM])

error-procedure

[procedure] (error-procedure LOC OBJ [ARGNAM])

error-input-port

[procedure] (error-input-port LOC OBJ [ARGNAM])

error-output-port

[procedure] (error-output-port LOC OBJ [ARGNAM])

error-list

[procedure] (error-list LOC OBJ [ARGNAM])

error-pair

[procedure] (error-pair LOC OBJ [ARGNAM])

error-blob

[procedure] (error-blob LOC OBJ [ARGNAM])

error-vector

[procedure] (error-vector LOC OBJ [ARGNAM])

error-structure

[procedure] (error-structure LOC OBJ TAG [ARGNAM])

error-record and error-record-type are essentially synonyms.

error-symbol

[procedure] (error-symbol LOC OBJ [ARGNAM])

error-keyword

[procedure] (error-keyword LOC OBJ [ARGNAM])

error-string

[procedure] (error-string LOC OBJ [ARGNAM])

error-char

[procedure] (error-char LOC OBJ [ARGNAM])

error-boolean

[procedure] (error-boolean LOC OBJ [ARGNAM])

error-alist

[procedure] (error-alist LOC OBJ [ARGNAM])

error-minimum-argument-count

[procedure] (error-minimum-argument-count LOC ARGC MINARGC)

error-argument-count

[procedure] (error-argument-count LOC ARGC MAXARGC)

error-open-interval

[procedure] (error-open-interval LOC NUM MINNUM MAXNUM [ARGNAM])

error-closed-interval

[procedure] (error-closed-interval LOC NUM MINNUM MAXNUM [ARGNAM])

error-half-open-interval

[procedure] (error-half-open-interval LOC NUM MINNUM MAXNUM [ARGNAM])

error-half-closed-interval

[procedure] (error-half-closed-interval LOC NUM MINNUM MAXNUM [ARGNAM])

error-interval

[procedure] (error-interval LOC NUM LEFT MINNUM MAXNUM RIGHT [ARGNAM])

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.

define-error-type

[syntax] (define-error-type TYPNAM [TYPMSG])

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".

(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) )

SRFI 4 Checks

Usage

(require-extension srfi-4-checks)

check-s8vector

[procedure] (check-s8vector LOC OBJ [ARGNAM]) => *

check-u8vector

[procedure] (check-u8vector LOC OBJ [ARGNAM]) => *

check-s16vector

[procedure] (check-s16vector LOC OBJ [ARGNAM]) => *

check-u16vector

[procedure] (check-u16vector LOC OBJ [ARGNAM]) => *

check-s32vector

[procedure] (check-s32vector LOC OBJ [ARGNAM]) => *

check-u32vector

[procedure] (check-u32vector LOC OBJ [ARGNAM]) => *

check-s64vector

[procedure] (check-s64vector LOC OBJ [ARGNAM]) => *

check-u64vector

[procedure] (check-u64vector LOC OBJ [ARGNAM]) => *

check-f32vector

[procedure] (check-f32vector LOC OBJ [ARGNAM]) => *

check-f64vector

[procedure] (check-f64vector LOC OBJ [ARGNAM]) => *

SRFI 4 Errors

Usage

(require-extension srfi-4-errors)

error-s8vector

[procedure] (error-s8vector LOC OBJ [ARGNAM])

error-u8vector

[procedure] (error-u8vector LOC OBJ [ARGNAM])

error-s16vector

[procedure] (error-s16vector LOC OBJ [ARGNAM])

error-u16vector

[procedure] (error-u16vector LOC OBJ [ARGNAM])

error-s32vector

[procedure] (error-s32vector LOC OBJ [ARGNAM])

error-u32vector

[procedure] (error-u32vector LOC OBJ [ARGNAM])

error-s64vector

[procedure] (error-s64vector LOC OBJ [ARGNAM])

error-u64vector

[procedure] (error-u64vector LOC OBJ [ARGNAM])

error-f32vector

[procedure] (error-f32vector LOC OBJ [ARGNAM])

error-f64vector

[procedure] (error-f64vector LOC OBJ [ARGNAM])

Notes

Author

Kon Lovett

Version history

1.13.0 ; Added egg module.
1.12.6 ; inline-type-checks.scm copied to Chicken Repository. Produces shared+static object files.
1.12.5 ; define-inline-check-type generates name with "%" prefix.
1.12.4 ; Moved optional argument name checks until after error detected.
1.12.3 ; Fix for error-minimum-argument-coun and error-argument-count.
1.12.2 ; Better no-install support.
1.12.1 ; Deprecated ...-cardinal-... in favor of ...-natural-....
1.12.0 ; Removed error-utils & conditions.
1.11.0 ; Added error-utils.
1.10.0 ; The check-... routines return the checked value.
1.8.0
Added srfi-4 support.
1.7.0
1.6.0
Added interval support.
1.5.0
Added alist and argument count support.
1.4.0
1.3.0
Added warning-argument-type.
1.2.0
Added make-error-type-message & fixed define-check+error-type.
1.1.0
Added make-condition+, condition-property-accessor* and make-condition-property-accessor.
1.0.0
Initial release.

License

Copyright (C) 2009-2010 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.