condition-utils

SRFI 12 Condition Utilities

  1. condition-utils
  2. Documentation
    1. Argument Conventions
    2. Condition Library
      1. Usage
      2. make-condition+
      3. make-condition-predicate
      4. condition-predicate*
      5. make-condition-property-accessor
      6. condition-property-accessor*
      7. condition-irritants
      8. write-condition
    3. EXN Condition Library
      1. Usage
      2. make-exn-condition
      3. make-exn-condition*
      4. make-exn-condition+
      5. write-exn-condition
        1. exn-condition?
        2. exn-location
        3. exn-message
        4. exn-arguments
        5. exn-call-chain
        6. exn-errno
    4. Standard Condition Library
      1. Usage
      2. Condition Predicates
        1. arity-condition?
        2. type-condition?
        3. arithmetic-condition?
        4. i/o-condition?
        5. file-condition?
        6. network-condition?
        7. network-timeout-condition?
        8. bounds-condition?
        9. runtime-condition?
        10. runtime-limit-condition?
        11. runtime-cycle-condition?
        12. match-condition?
        13. syntax-condition?
        14. process-condition?
        15. access-condition?
        16. domain-condition?
        17. memory-condition?
    5. HTTP Client Condition Library
      1. Usage
      2. Condition Predicates
        1. http-condition?
        2. client-error-condition?
        3. server-error-condition?
        4. unexpected-server-response-condition?
        5. redirect-depth-exceeded-condition?
        6. unsupported-uri-scheme-condition?
        7. unknown-authtype-condition?
      3. Condition Property Accessors
        1. client-error-response
        2. client-error-body
        3. server-error-response
        4. server-error-body
        5. unexpected-server-response-response
        6. unexpected-server-response-body
        7. redirect-depth-exceeded-uri
        8. formdata-error-condition?
        9. unsupported-uri-scheme-uri-scheme
        10. unsupported-uri-scheme-request-uri
        11. unknown-authtype-authtype
    6. Intarweb Condition Library
      1. Usage
      2. Condition Predicates
        1. http-condition?
        2. urlencoded-request-data-limit-exceeded?
        3. line-limit-exceeded?
        4. header-error?
        5. header-limit-exceeded?
        6. unknown-protocol-line?
        7. unknown-protocol?
        8. unknown-code?
        9. unknown-status?
        10. rfc1123-subparser?
        11. rfc850-subparser?
        12. asctime-subparser?
        13. http-date-subparser?
        14. unencoded-header?
        15. username-with-colon?
      3. Condition Property Accessors
        1. urlencoded-request-data-limit-exceeded-contents
        2. urlencoded-request-data-limit-exceeded-limit
        3. line-limit-exceeded-contents
        4. line-limit-exceeded-limit
        5. header-error-contents
        6. header-limit-exceeded-contents
        7. header-limit-exceeded-limit
        8. unknown-protocol-line-line
        9. unknown-protocol-major
        10. unknown-protocol-minor
        11. unknown-code-code
        12. unknown-status-status
        13. rfc1123-subparser-value?
        14. rfc850-subparser-value?
        15. asctime-subparser-value?
        16. http-date-subparser-value?
        17. unencoded-header-value?
        18. username-with-colon-value?
    7. Condition Libraries w/ Runtime Lookup
      1. Usage Example
  3. Bugs & Limitations
  4. Notes
  5. Author
  6. Repository
  7. Version history
  8. License

Documentation

Convenience API for constructing common Chicken exception conditions, predicates, and accessors.

Argument Conventions

LOC is a symbol, or #f.

MSG is a string, or #f.

ARGS is a list, or #f.

CALL-CHAIN is the result of (get-call-chain), or #f.

CONDITION is a property-condition.

KIND is usually a symbol but not #f.

PROP is usually a symbol but not #f.

CONDITION-SPEC is a:

CONDITION
a condition object
atom
(make-property-condition <atom>) ;see KIND
list
(apply make-property-condition <list>) ;(KIND PROP VALUE ...)

Condition Library

Usage

 
(import condition-utils)

make-condition+

[procedure] (make-condition+ CONDITION-SPEC...) -> property-condition

Returns a composite-condition CONDITION-SPEC....

make-condition-predicate

[syntax] (make-condition-predicate KIND...) -> (procedure (*) boolean)

Returns a condition-predicate for KIND....

KIND
symbol ;argument is quoted!

condition-predicate*

[procedure] (condition-predicate* KIND) -> (* -> boolean : condition)

Returns a "memoized" condition-predicate for KIND.

KIND
(not false) ;argument is evaluated

make-condition-property-accessor

[syntax] (make-condition-property-accessor KIND PROP [DEFAULT]) -> (procedure (*) boolean)

Returns a condition-property-accessor for KIND PROP. The default value of DEFAULT is #f.

KIND
symbol ;argument is quoted!
PROP
symbol ;argument is quoted!

condition-property-accessor*

[procedure] (condition-property-accessor* KIND PROP [DEFAULT #f]) -> (condition -> *)

Returns a "memoized" condition-property-accessor for KIND.

KIND
(not false) ;argument is evaluated
PROP
(not false) ;argument is evaluated

condition-irritants

[procedure] (condition-irritants CONDITION) -> list

Returns a list of the condition properties for the condition CONDITION. The form of the list, alist vs. plist, is dependent on the result of the system procedure condition->list.

CHICKEN 4
alist
CHICKEN 5
plist

The properties are without associated condition information.

write-condition

[procedure] (write-condition CONDITION [PORT (current-output-port) [HEADER "Error"]])

Produces on PORT the form:

Error: <condition-kind>: <condition-property> ...

   +: <condition-kind>: <condition-property> ...
      ... for a composite condition ...

EXN Condition Library

Usage

 
(import exn-condition)

make-exn-condition

[procedure] (make-exn-condition [LOC [MSG [ARGS [CALL-CHAIN [ERRNO]]]]]) -> property-condition

Returns an exn property-condition with optional location, arguments, call-chain, and errno property values.

Defaults:

LOC
missing
MSG
"unknown"
ARGS
missing
CALL-CHAIN
missing
ERRNO
missing

Will always include message property in the property-condition.

make-exn-condition*

[procedure] (make-exn-condition* [location:] [message:] [arguments:] [call-chain:] [errno:]) -> property-condition

Returns an exn property-condition with optional location, arguments, call-chain, and errno property values.

Defaults:

location
missing
message
"unknown"
arguments
missing
call-chain:
missing
errno
missing

Will always include message property in the property-condition.

make-exn-condition+

[procedure] (make-exn-condition+ LOC MSG ARGS [CALL-CHAIN] [ERRNO] [CONDITION-SPEC...]) -> property-condition

Returns a composite-condition exn CONDITION-SPEC....

When one-of LOC, MSG, or ARGS is without a useful value in the error context use #f as the actual argument. The optional CALL-CHAIN & ERRNO arguments are detected by type & structure.

When MSG is #f the value "unknown" is used.

write-exn-condition

[procedure] (write-exn-condition CONDITION [PORT (current-output-port) [HEADER "Error" [CHAIN-HEADER "\n\tCall history:\n"]]])

Produces on PORT the form:

Error: (<location - if any>) <message - if any>: <arguments - if any>

   +: <condition-kind>: <condition-property> ...
      ... for a composite condition ...
      Call history:
      <call-chain>

The call-chain may not be available.

exn-condition?
[procedure] (exn-condition? CONDITION) -> boolean
exn-location
[procedure] (exn-location CONDITION) -> *
exn-message
[procedure] (exn-message CONDITION) -> *
exn-arguments
[procedure] (exn-arguments CONDITION) -> *
exn-call-chain
[procedure] (exn-call-chain CONDITION) -> *
exn-errno
[procedure] (exn-errno CONDITION) -> *

Standard Condition Library

Usage

 
(import standard-conditions)

Condition Predicates
arity-condition?
[procedure] (arity-condition? CONDITION) -> boolean
type-condition?
[procedure] (type-condition? CONDITION) -> boolean
arithmetic-condition?
[procedure] (arithmetic-condition? CONDITION) -> boolean
i/o-condition?
[procedure] (i/o-condition? CONDITION) -> boolean
file-condition?
[procedure] (file-condition? CONDITION) -> boolean
network-condition?
[procedure] (network-condition? CONDITION) -> boolean
network-timeout-condition?
[procedure] (network-timeout-condition? CONDITION) -> boolean
bounds-condition?
[procedure] (bounds-condition? CONDITION) -> boolean
runtime-condition?
[procedure] (runtime-condition? CONDITION) -> boolean
runtime-limit-condition?
[procedure] (runtime-limit-condition? CONDITION) -> boolean
runtime-cycle-condition?
[procedure] (runtime-cycle-condition? CONDITION) -> boolean
match-condition?
[procedure] (match-condition? CONDITION) -> boolean
syntax-condition?
[procedure] (syntax-condition? CONDITION) -> boolean
process-condition?
[procedure] (process-condition? CONDITION) -> boolean
access-condition?
[procedure] (access-condition? CONDITION) -> boolean
domain-condition?
[procedure] (domain-condition? CONDITION) -> boolean
memory-condition?
[procedure] (memory-condition? CONDITION) -> boolean

HTTP Client Condition Library

Usage

 
(import http-client-conditions)

Condition Predicates
http-condition?
[procedure] (http-condition? CONDITION) -> boolean
client-error-condition?
[procedure] (client-error-condition? CONDITION) -> boolean
server-error-condition?
[procedure] (server-error-condition? CONDITION) -> boolean
unexpected-server-response-condition?
[procedure] (unexpected-server-response-condition? CONDITION) -> boolean
redirect-depth-exceeded-condition?
[procedure] (redirect-depth-exceeded-condition? CONDITION) -> boolean
unsupported-uri-scheme-condition?
[procedure] (unsupported-uri-scheme-condition? CONDITION) -> boolean
unknown-authtype-condition?
[procedure] (unknown-authtype-condition? CONDITION) -> boolean

Condition Property Accessors
client-error-response
[procedure] (client-error-response CONDITION) -> *
client-error-body
[procedure] (client-error-body CONDITION) -> *
server-error-response
[procedure] (server-error-response CONDITION) -> *
server-error-body
[procedure] (server-error-body CONDITION) -> *
unexpected-server-response-response
[procedure] (unexpected-server-response-response CONDITION) -> *
unexpected-server-response-body
[procedure] (unexpected-server-response-body CONDITION) -> *
redirect-depth-exceeded-uri
[procedure] (redirect-depth-exceeded-uri CONDITION) -> *
formdata-error-condition?
[procedure] (formdata-error-condition? CONDITION) -> boolean
unsupported-uri-scheme-uri-scheme
[procedure] (unsupported-uri-scheme-uri-scheme CONDITION) -> *
unsupported-uri-scheme-request-uri
[procedure] (unsupported-uri-scheme-request-uri CONDITION) -> *
unknown-authtype-authtype
[procedure] (unknown-authtype-authtype CONDITION) -> *

Intarweb Condition Library

Usage

 
(import intarweb-conditions)

Condition Predicates
http-condition?
[procedure] (http-condition? CONDITION) -> boolean
urlencoded-request-data-limit-exceeded?
[procedure] (urlencoded-request-data-limit-exceeded? CONDITION) -> boolean
line-limit-exceeded?
[procedure] (line-limit-exceeded? CONDITION) -> boolean
header-error?
[procedure] (header-error? CONDITION) -> boolean
header-limit-exceeded?
[procedure] (header-limit-exceeded? CONDITION) -> boolean
unknown-protocol-line?
[procedure] (unknown-protocol-line? CONDITION) -> boolean
unknown-protocol?
[procedure] (unknown-protocol? CONDITION) -> boolean
unknown-code?
[procedure] (unknown-code? CONDITION) -> boolean
unknown-status?
[procedure] (unknown-status? CONDITION) -> boolean
rfc1123-subparser?
[procedure] (rfc1123-subparser? CONDITION) -> boolean
rfc850-subparser?
[procedure] (rfc850-subparser? CONDITION) -> boolean
asctime-subparser?
[procedure] (asctime-subparser? CONDITION) -> boolean
http-date-subparser?
[procedure] (http-date-subparser? CONDITION) -> boolean
unencoded-header?
[procedure] (unencoded-header? CONDITION) -> boolean
username-with-colon?
[procedure] (username-with-colon? CONDITION) -> boolean

Condition Property Accessors
urlencoded-request-data-limit-exceeded-contents
[procedure] (urlencoded-request-data-limit-exceeded-contents CONDITION) -> *
urlencoded-request-data-limit-exceeded-limit
[procedure] (urlencoded-request-data-limit-exceeded-limit CONDITION) -> *
line-limit-exceeded-contents
[procedure] (line-limit-exceeded-contents CONDITION) -> *
line-limit-exceeded-limit
[procedure] (line-limit-exceeded-limit CONDITION) -> *
header-error-contents
[procedure] (header-error-contents CONDITION) -> *
header-limit-exceeded-contents
[procedure] (header-limit-exceeded-contents CONDITION) -> *
header-limit-exceeded-limit
[procedure] (header-limit-exceeded-limit CONDITION) -> *
unknown-protocol-line-line
[procedure] (unknown-protocol-line-line CONDITION) -> *
unknown-protocol-major
[procedure] (unknown-protocol-major CONDITION) -> *
unknown-protocol-minor
[procedure] (unknown-protocol-minor CONDITION) -> *
unknown-code-code
[procedure] (unknown-code-code CONDITION) -> *
unknown-status-status
[procedure] (unknown-status-status CONDITION) -> *
rfc1123-subparser-value?
[procedure] (rfc1123-subparser-value? CONDITION) -> boolean
rfc850-subparser-value?
[procedure] (rfc850-subparser-value? CONDITION) -> boolean
asctime-subparser-value?
[procedure] (asctime-subparser-value? CONDITION) -> boolean
http-date-subparser-value?
[procedure] (http-date-subparser-value? CONDITION) -> boolean
unencoded-header-value?
[procedure] (unencoded-header-value? CONDITION) -> boolean
username-with-colon-value?
[procedure] (username-with-colon-value? CONDITION) -> boolean

Condition Libraries w/ Runtime Lookup

Usage Example

 
(import (rename (standard-conditions memo) (get standard-conditions-get)))
(import (rename (intarweb-conditions memo) (get intarweb-conditions-get)))
(import (rename (http-client-conditions memo) (get http-client-conditions-get)))

(define unexpected-server-response-response (http-client-conditions-get 'unexpected-server-response-response)

Bugs & Limitations

Notes

Author

Kon Lovett

Repository

This egg is hosted on the CHICKEN Subversion repository:

https://anonymous@code.call-cc.org/svn/chicken-eggs/release/5/condition-utils

If you want to check out the source code repository of this egg and you are not familiar with Subversion, see this page.

Version history
2.3.1
Fix condition predicate & accessor caching.
2.3.0
Add errno & make-exn-condition*.
2.2.2
.
2.2.1
.
2.2.0
Add condition library runtime lookup get API.
2.1.4
.
2.1.3
.
2.1.2
.
2.1.1
.
2.1.0
CHICKEN 5 release.
1.5.1
Fix for empty call-chain.
1.5.0
Add types.
1.4.2
Fix #1378
1.4.1
Fix write-exn-condition call-chain header duplication.
1.4.0
Add HEADER to write-exn-condition & write-condition. Add CHAIN-HEADER to write-exn-condition. Follow error form more closely.
1.3.0
write-exn-condition now includes all elements of a composite-condition. Added write-condition.
1.2.0
amended write-exn-condition, add doc for condition libraries.
1.1.1
added write-exn-condition
1.1.0
added make-exn-condition
1.0.4
default exn msg
1.0.3
added call-chain argument & standard conditions
1.0.2
Fix for ticket #630
1.0.1
1.0.0
Hello (from "check-errors:1.11.0")

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.