The assert-p Reference Manual

This is the assert-p Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jan 15 04:18:42 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 assert-p

A library of assertions written in Common Lisp.

Maintainer

noloop <>

Author

noloop <>

Home Page

https://github.com/noloop/assert-p

Source Control

(GIT git@github.com:noloop/assert-p.git)

Bug Tracker

https://github.com/noloop/assert-p/issues

License

GPLv3

Version

1.0.0

Dependency

assertion-error (system).

Source

assert-p.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 assert-p/src

Source

assert-p.asd.

Parent Component

assert-p (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 assert-p/assert-p.asd

Source

assert-p.asd.

Parent Component

assert-p (system).

ASDF Systems

assert-p.


4.1.2 assert-p/src/package.lisp

Source

assert-p.asd.

Parent Component

src (module).

Packages

noloop.assert-p.


4.1.3 assert-p/src/macros.lisp

Dependency

package.lisp (file).

Source

assert-p.asd.

Parent Component

src (module).

Internals

4.1.4 assert-p/src/assert-p.lisp

Dependency

macros.lisp (file).

Source

assert-p.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 noloop.assert-p

Source

package.lisp.

Nickname

assert-p

Use List

common-lisp.

Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Macros

Macro: condition-error-p (fn condition)

Check if fn throw an specified condition error.

Package

noloop.assert-p.

Source

assert-p.lisp.

Macro: not-condition-error-p (fn condition)

Check if fn not throw an specified condition error.

Package

noloop.assert-p.

Source

assert-p.lisp.


6.1.2 Ordinary functions

Function: custom-p (test-result actual expected operator)

Custom check for special cases. Where test-result is a form that returns t or nil, actual is value actual used in test-result, expected is value expected used in test-result, operator is operator used in test-result. Return t when test-result is t, and throw assertion-error when test-result is nil.

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: eq-p (actual expected)

Check actual eq expected

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: eql-p (actual expected)

Check actual eql expected

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: equal-p (actual expected)

Check actual equal expected

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: equalp-p (actual expected)

Check actual equalp expected

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: error-p (fn)

Check if fn throw an error.

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: nil-p (actual)

Check actual eq nil

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: not-eq-p (actual expected)

Check actual not eq expected

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: not-eql-p (actual expected)

Check actual not eql expected

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: not-equal-p (actual expected)

Check actual not equal expected

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: not-equalp-p (actual expected)

Check actual not equalp expected

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: not-error-p (fn)

Check if fn not throw an error.

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: not-nil-p (actual)

Check actual not eq nil

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: not-null-p (actual)

Check not null actual. Equivalent to (not (null actual))

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: not-t-p (actual)

Check actual not eq t

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: not-typep-p (actual expected)

Check actual not typep expected

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: not-values-p (predicate actual expected)

Check actual every not predicate expected. Predicate is a symbol of function, actual is a list, and expected an atom. Example: (values-p ’= ’(t t t) t) It’s similar to (every #’(lambda (i) (not (= t i))) ’(t t t))

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: not-zero-p (actual)

Check actual not eq 0

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: null-p (actual)

Check null actual. Equivalent to (null actual)

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: t-p (actual)

Check actual eq t

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: typep-p (actual expected)

Check actual typep expected

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: values-p (predicate actual expected)

Check actual every predicate expected. Predicate is a symbol of function, actual is a list, and expected an atom. Example: (values-p ’= ’(t t t) t) It’s similar to (every #’(lambda (i) (= t i)) ’(t t t))

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: zero-p (actual)

Check actual eq 0

Package

noloop.assert-p.

Source

assert-p.lisp.


6.2 Internals


6.2.1 Macros

Macro: assertion-error-check (test-form)
Package

noloop.assert-p.

Source

macros.lisp.

Macro: assertion-values (test-fn predicate actual expected operator)
Package

noloop.assert-p.

Source

macros.lisp.

Macro: condition-error-check (test-fn condition)
Package

noloop.assert-p.

Source

macros.lisp.

Macro: error-check (test-fn)
Package

noloop.assert-p.

Source

macros.lisp.

Macro: once-only ((&rest names) &body body)
Package

noloop.assert-p.

Source

macros.lisp.

Macro: with-gensyms (vars &body body)
Package

noloop.assert-p.

Source

macros.lisp.


6.2.2 Ordinary functions

Function: assertion (result actual expected operator)

When result is t return t. When result is nil throw assertion-error. One assertion need result (t or nil), one object actual, one object expected, and one operator (string or symbol). Assertion-error also loading one message of error (built with actual, expected and operator) and the stack trace of error throw moment.

Package

noloop.assert-p.

Source

assert-p.lisp.

Function: error-message (actual expected operator)
Package

noloop.assert-p.

Source

assert-p.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   A   C   E   F   M   N   O   T   V   W   Z  
Index Entry  Section

A
assertion: Private ordinary functions
assertion-error-check: Private macros
assertion-values: Private macros

C
condition-error-check: Private macros
condition-error-p: Public macros
custom-p: Public ordinary functions

E
eq-p: Public ordinary functions
eql-p: Public ordinary functions
equal-p: Public ordinary functions
equalp-p: Public ordinary functions
error-check: Private macros
error-message: Private ordinary functions
error-p: Public ordinary functions

F
Function, assertion: Private ordinary functions
Function, custom-p: Public ordinary functions
Function, eq-p: Public ordinary functions
Function, eql-p: Public ordinary functions
Function, equal-p: Public ordinary functions
Function, equalp-p: Public ordinary functions
Function, error-message: Private ordinary functions
Function, error-p: Public ordinary functions
Function, nil-p: Public ordinary functions
Function, not-eq-p: Public ordinary functions
Function, not-eql-p: Public ordinary functions
Function, not-equal-p: Public ordinary functions
Function, not-equalp-p: Public ordinary functions
Function, not-error-p: Public ordinary functions
Function, not-nil-p: Public ordinary functions
Function, not-null-p: Public ordinary functions
Function, not-t-p: Public ordinary functions
Function, not-typep-p: Public ordinary functions
Function, not-values-p: Public ordinary functions
Function, not-zero-p: Public ordinary functions
Function, null-p: Public ordinary functions
Function, t-p: Public ordinary functions
Function, typep-p: Public ordinary functions
Function, values-p: Public ordinary functions
Function, zero-p: Public ordinary functions

M
Macro, assertion-error-check: Private macros
Macro, assertion-values: Private macros
Macro, condition-error-check: Private macros
Macro, condition-error-p: Public macros
Macro, error-check: Private macros
Macro, not-condition-error-p: Public macros
Macro, once-only: Private macros
Macro, with-gensyms: Private macros

N
nil-p: Public ordinary functions
not-condition-error-p: Public macros
not-eq-p: Public ordinary functions
not-eql-p: Public ordinary functions
not-equal-p: Public ordinary functions
not-equalp-p: Public ordinary functions
not-error-p: Public ordinary functions
not-nil-p: Public ordinary functions
not-null-p: Public ordinary functions
not-t-p: Public ordinary functions
not-typep-p: Public ordinary functions
not-values-p: Public ordinary functions
not-zero-p: Public ordinary functions
null-p: Public ordinary functions

O
once-only: Private macros

T
t-p: Public ordinary functions
typep-p: Public ordinary functions

V
values-p: Public ordinary functions

W
with-gensyms: Private macros

Z
zero-p: Public ordinary functions


A.3 Variables