The strict-function Reference Manual

Table of Contents

The strict-function Reference Manual

This is the strict-function Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 06:10:59 2022 GMT+0.

1 Introduction

strict-function

Utility of function definition

The original implementation can be found at http://common-lisp.net/project/qitab/archives/quux-2013-09-24.tar.bz2 (quux/lisp/quux/strict-functions.lisp)

Example

(define-strict-function func-ordinary-1 (:inputs ((a fixnum) (b fixnum)))
  (+ a b))

(define-strict-function func-rest-1 (:inputs ((a fixnum "a is fixnum")
                                              (b fixnum "b is fixnum")
                                              &rest (numbers list
                                                             "proper-list of fixnum")))
  (+ a b (apply #'+ numbers)))

(define-strict-function func-outputs-1 (:inputs ((arg integer))
                                        :outputs (integer 0 *))
  arg)

(define-strict-function func-outputs-2 (:inputs ((values list))
                                        :outputs (values (integer 0 *)
                                                         boolean))
  (apply #'values values))

(define-strict-function func-optional-1 (:inputs (&optional (a integer)))
  a)

(define-strict-function func-optional-2 (:inputs (&optional ((a 100) integer)))
  a)

(define-strict-function func-optional-3 (:inputs (&optional ((a "test") integer)))
  a)

(define-strict-function func-optional-4 (:inputs (&optional ((a #\a) character))
                                         :use-supplied-vars t)
  (list a a-supplied-p))

(define-strict-function func-optional-5 (:inputs (&optional ((a 1 a-p) integer)))
  (list a a-p))

(define-strict-function func-key-1 (:inputs (&key (a string)))
  a)

(define-strict-function func-key-2 (:inputs (&key ((a "default") string)))
  a)

(define-strict-function func-key-3 (:inputs (&key ((a 1 a-p) integer)))
  (list a a-p))

(define-strict-function func-key-4 (:inputs (&key ((a "default") integer)))
  a)

(define-strict-function func-key-5 (:inputs (&key (x integer) (y integer))
                                    :use-supplied-vars t)
  (list x x-supplied-p
        y y-supplied-p))

(define-strict-function func-key-6 (:inputs (&key (x integer) &allow-other-keys))
  x)

(define-strict-function func-aux-1 (:inputs (&aux (x string)))
  x)

(define-strict-function func-aux-2 (:inputs (&aux ((x "foo") string)))
  x)

(define-strict-function func-aux-3 (:inputs (&aux ((x "foo") string)
                                                  ((y 12) number)))
  (list x y))

LICENSE

MIT

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 strict-function

Author

cxxxr

License

MIT

Description

Utility of function definition

Dependencies

• alexandria
• trivia

Source

strict-function.asd (file)

Component

strict-function.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 strict-function.asd

Location

strict-function.asd

Systems

strict-function (system)

3.1.2 strict-function/strict-function.lisp

Parent

strict-function (system)

Location

strict-function.lisp

Packages

strict-function

Exported Definitions

• clear-unexpected-conditions (function)
• collect-unexpected-conditions (function)
• define-strict-function (macro)
• strict-function-error (condition)
• strict-invalid-input (condition)
• strict-invalid-multivalued-number (condition)
• strict-invalid-output (condition)
• strict-unexpected-condition-error-actual-condition (method)
• strict-unexpected-condition-error-expected-conditions (method)
• strict-unexpected-condition-error-expected-function-name (method)

Internal Definitions

• *unexpected-condition-error-occurred-functions* (special variable)
• concreate-check-types (function)
• construct-body (function)
• construct-check-conditions-form (function)
• construct-check-outputs (function)
• construct-rebind-parameters (function)
• lambda-list-keyword-p (function)
• make-nth-functions (function)
• mapping-lambda-list-parameters-to-types (function)
• parse-inputs (function)
• parse-param (function)
• reform-lambda-list (function)
• strict-invalid-input-var (method)
• strict-invalid-multivalued-number-actual-values (method)
• strict-invalid-multivalued-number-expected-nth-values (method)
• strict-type-error (condition)
• strict-type-error-expected-type (method)
• strict-type-error-value (method)
• strict-unexpected-condition-error (condition)
• validate-conditions (function)
• validate-input (function)
• validate-multiple-outputs (macro)
• validate-number-of-outputs (function)
• validate-outputs (function)

4 Packages

Packages are listed by definition order.

4.1 strict-function

Source

strict-function.lisp (file)

Use List

• alexandria
• common-lisp

Exported Definitions

• clear-unexpected-conditions (function)
• collect-unexpected-conditions (function)
• define-strict-function (macro)
• strict-function-error (condition)
• strict-invalid-input (condition)
• strict-invalid-multivalued-number (condition)
• strict-invalid-output (condition)
• strict-unexpected-condition-error-actual-condition (generic function)
• strict-unexpected-condition-error-actual-condition (method)
• strict-unexpected-condition-error-expected-conditions (generic function)
• strict-unexpected-condition-error-expected-conditions (method)
• strict-unexpected-condition-error-expected-function-name (generic function)
• strict-unexpected-condition-error-expected-function-name (method)

Internal Definitions

• *unexpected-condition-error-occurred-functions* (special variable)
• concreate-check-types (function)
• construct-body (function)
• construct-check-conditions-form (function)
• construct-check-outputs (function)
• construct-rebind-parameters (function)
• lambda-list-keyword-p (function)
• make-nth-functions (function)
• mapping-lambda-list-parameters-to-types (function)
• parse-inputs (function)
• parse-param (function)
• reform-lambda-list (function)
• strict-invalid-input-var (generic function)
• strict-invalid-input-var (method)
• strict-invalid-multivalued-number-actual-values (generic function)
• strict-invalid-multivalued-number-actual-values (method)
• strict-invalid-multivalued-number-expected-nth-values (generic function)
• strict-invalid-multivalued-number-expected-nth-values (method)
• strict-type-error (condition)
• strict-type-error-expected-type (generic function)
• strict-type-error-expected-type (method)
• strict-type-error-value (generic function)
• strict-type-error-value (method)
• strict-unexpected-condition-error (condition)
• validate-conditions (function)
• validate-input (function)
• validate-multiple-outputs (macro)
• validate-number-of-outputs (function)
• validate-outputs (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Macros

Macro: define-strict-function FUNCTION-NAME (&key INPUTS OUTPUTS CONDITIONS USE-SUPPLIED-VARS) &body BODY

Package

strict-function

Source

strict-function.lisp (file)

5.1.2 Functions

Function: clear-unexpected-conditions ()

Package

strict-function

Source

strict-function.lisp (file)

Function: collect-unexpected-conditions &optional FUNCTION-NAME

Package

strict-function

Source

strict-function.lisp (file)

5.1.3 Generic functions

Generic Function: strict-unexpected-condition-error-actual-condition CONDITION

Package

strict-function

Methods

Method: strict-unexpected-condition-error-actual-condition (CONDITION strict-unexpected-condition-error)

Source

strict-function.lisp (file)

Generic Function: strict-unexpected-condition-error-expected-conditions CONDITION

Package

strict-function

Methods

Method: strict-unexpected-condition-error-expected-conditions (CONDITION strict-unexpected-condition-error)

Source

strict-function.lisp (file)

Generic Function: strict-unexpected-condition-error-expected-function-name CONDITION

Package

strict-function

Methods

Method: strict-unexpected-condition-error-expected-function-name (CONDITION strict-unexpected-condition-error)

Source

strict-function.lisp (file)

5.1.4 Conditions

Condition: strict-function-error ()

Package

strict-function

Source

strict-function.lisp (file)

Direct superclasses

simple-error (condition)

Direct subclasses

• strict-type-error (condition)
• strict-invalid-multivalued-number (condition)
• strict-unexpected-condition-error (condition)

Condition: strict-invalid-input ()

Package

strict-function

Source

strict-function.lisp (file)

Direct superclasses

strict-type-error (condition)

Direct methods

strict-invalid-input-var (method)

Direct slots

Slot: var

Initargs

:var

Readers

strict-invalid-input-var (generic function)

Condition: strict-invalid-multivalued-number ()

Package

strict-function

Source

strict-function.lisp (file)

Direct superclasses

strict-function-error (condition)

Direct methods

• strict-invalid-multivalued-number-actual-values (method)
• strict-invalid-multivalued-number-expected-nth-values (method)

Direct slots

Slot: expected-nth-values

Initargs

:expected-nth-values

Readers

strict-invalid-multivalued-number-expected-nth-values (generic function)

Slot: actual-values

Initargs

:actual-values

Readers

strict-invalid-multivalued-number-actual-values (generic function)

Condition: strict-invalid-output ()

Package

strict-function

Source

strict-function.lisp (file)

Direct superclasses

strict-type-error (condition)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *unexpected-condition-error-occurred-functions*

Package

strict-function

Source

strict-function.lisp (file)

5.2.2 Macros

Macro: validate-multiple-outputs BODY TYPES

Package

strict-function

Source

strict-function.lisp (file)

5.2.3 Functions

Function: concreate-check-types PARAM-TYPE-PAIRS SUPPLIED-PAIRS

Package

strict-function

Source

strict-function.lisp (file)

Function: construct-body FUNCTION-NAME PARAM-TYPE-PAIRS BODY-DECLS BODY OUTPUTS OUTPUTS-SPECIFIED-P CONDITIONS

Package

strict-function

Source

strict-function.lisp (file)

Function: construct-check-conditions-form CONDITIONS BODY FUNCTION-NAME

Package

strict-function

Source

strict-function.lisp (file)

Function: construct-check-outputs BODY OUTPUTS OUTPUTS-SPECIFIED-P

Package

strict-function

Source

strict-function.lisp (file)

Function: construct-rebind-parameters PARAM-TYPE-PAIRS BODY-DECLS BODY

Package

strict-function

Source

strict-function.lisp (file)

Function: lambda-list-keyword-p X

Package

strict-function

Source

strict-function.lisp (file)

Function: make-nth-functions N

Package

strict-function

Source

strict-function.lisp (file)

Function: mapping-lambda-list-parameters-to-types LAMBDA-LIST PARAM-TYPES

Package

strict-function

Source

strict-function.lisp (file)

Function: parse-inputs INPUTS

Package

strict-function

Source

strict-function.lisp (file)

Function: parse-param PARAM

Package

strict-function

Source

strict-function.lisp (file)

Function: reform-lambda-list LAMBDA-LIST USE-SUPPLIED-VARS

Package

strict-function

Source

strict-function.lisp (file)

Function: validate-conditions ACTUAL-CONDITION EXPECTED-CONDITIONS FUNCTION-NAME

Package

strict-function

Source

strict-function.lisp (file)

Function: validate-input VAR VALUE TYPE

Package

strict-function

Source

strict-function.lisp (file)

Function: validate-number-of-outputs VALUES N

Package

strict-function

Source

strict-function.lisp (file)

Function: validate-outputs RESULT OUTPUTS

Package

strict-function

Source

strict-function.lisp (file)

5.2.4 Generic functions

Generic Function: strict-invalid-input-var CONDITION

Package

strict-function

Methods

Method: strict-invalid-input-var (CONDITION strict-invalid-input)

Source

strict-function.lisp (file)

Generic Function: strict-invalid-multivalued-number-actual-values CONDITION

Package

strict-function

Methods

Method: strict-invalid-multivalued-number-actual-values (CONDITION strict-invalid-multivalued-number)

Source

strict-function.lisp (file)

Generic Function: strict-invalid-multivalued-number-expected-nth-values CONDITION

Package

strict-function

Methods

Method: strict-invalid-multivalued-number-expected-nth-values (CONDITION strict-invalid-multivalued-number)

Source

strict-function.lisp (file)

Generic Function: strict-type-error-expected-type CONDITION

Package

strict-function

Methods

Method: strict-type-error-expected-type (CONDITION strict-type-error)

Source

strict-function.lisp (file)

Generic Function: strict-type-error-value CONDITION

Package

strict-function

Methods

Method: strict-type-error-value (CONDITION strict-type-error)

Source

strict-function.lisp (file)

5.2.5 Conditions

Condition: strict-type-error ()

Package

strict-function

Source

strict-function.lisp (file)

Direct superclasses

strict-function-error (condition)

Direct subclasses

• strict-invalid-input (condition)
• strict-invalid-output (condition)

Direct methods

• strict-type-error-value (method)
• strict-type-error-expected-type (method)

Direct slots

Slot: expected-type

Initargs

:expected-type

Readers

strict-type-error-expected-type (generic function)

Slot: value

Initargs

:value

Readers

strict-type-error-value (generic function)

Condition: strict-unexpected-condition-error ()

Package

strict-function

Source

strict-function.lisp (file)

Direct superclasses

strict-function-error (condition)

Direct methods

• strict-unexpected-condition-error-actual-condition (method)
• strict-unexpected-condition-error-expected-conditions (method)
• strict-unexpected-condition-error-expected-function-name (method)

Direct slots

Slot: function-name

Initargs

:function-name

Readers

strict-unexpected-condition-error-expected-function-name (generic function)

Slot: expected-conditions

Initargs

:expected-conditions

Readers

strict-unexpected-condition-error-expected-conditions (generic function)

Slot: actual-condition

Initargs

:actual-condition

Readers

strict-unexpected-condition-error-actual-condition (generic function)

Slot: backtrace

Initargs

:backtrace

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types