The clavier Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The clavier Reference Manual

This is the clavier Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:44:06 2020 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

Clavier

Quicklisp MIT License

Clavier is a general purpose validation library for Common Lisp.

Install

Through Quicklisp:

(ql:quickload :clavier)

Getting started

Validators are class instances that validate the arguments passed to the validate function:

(let ((validator (make-instance 'equal-to-validator :object 22)))
    (validate validator 22 :error-p t))
    
;=> T

If the validator succeeds, the validate function returns T. If it fails, the validate function either signals a validation error, or returns NIL and a validation message depending on the value of the :error-p argument.

(let ((validator (make-instance 'equal-to-validator :object 22)))
    (validate validator 33 :error-p nil))
    
;=>
;NIL    
;"33 is not equal to 22"

Validators are implemented as funcallable classes. So, alternatively to using the validate function, it is possible to just funcall the validator, like this:

(let ((validator (make-instance 'equal-to-validator :object 22)))
    (funcall validator 22 :error-p t))
    
;=> T

Validation expressions

It is possible to create validators with a more convenient syntax. Each validator provides a builder function. For instance, and equal-to-validator can be built like this:

(funcall (== 100) 100) ;=> T
(funcall (== 100) 99) ;=> NIL

Validators composition

This allows to compose validators, using ==, ~=, &&, || as the composition operands:

(let ((validator (|| (&& (greater-than 20)
			   (less-than 30))
		       (|| (&& (greater-than 1)
			       (less-than 10))
			   (== 100)))))
    (funcall validator 5))

Validators messages

Validators messages to be used when validation fails can be customized passing an :message argument when building the validator

Catching and collecting validation errors

Validation errors can controlled globally by setting the dynamic variable *signal-validation-errors*, which is NIL by default (no validation errors are signaled by default).

There's also the with-signal-validation-errors macro to specify whether validation errors should be signaled or not in a dynamic extent. For instance, this code signals a validation error:

(let ((validator (make-instance 'equal-to-validator :object 22)))
	   (with-signal-validation-errors (t)
	     (validate validator 33)))

Use the collecting-validation-errors macro to collect validation errors happening in a dynamic extent:

(let ((validator (make-instance 'equal-to-validator :object 22)))
	   (collecting-validation-errors (errors found-p)
	       (progn
		 (funcall validator 33 :error-p t)
		 (funcall validator 44 :error-p t))
	     (print errors)
	     (print found-p)))
;=>
;(#<VALIDATION-ERROR 44: 44 is not equal to 22 {1008A48673}>
; #<VALIDATION-ERROR 33: 33 is not equal to 22 {1008A47EA3}>) 
;T 

Validators list:


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 clavier

Author

Mariano Montone

License

MIT

Description

Clavier: A Common Lisp validation library

Dependencies
Source

clavier.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 clavier.asd

Location

clavier.asd

Systems

clavier (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 clavier/package.lisp

Parent

clavier (system)

Location

package.lisp

Packages

clavier


Previous: , Up: Lisp files   [Contents][Index]

3.1.3 clavier/clavier.lisp

Dependency

package.lisp (file)

Parent

clavier (system)

Location

clavier.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 clavier

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *signal-validation-errors*
Package

clavier

Source

clavier.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Macros

Macro: collecting-validation-errors (ERRORS FOUND-P) EXPR &body BODY
Package

clavier

Source

clavier.lisp (file)

Macro: with-signal-validation-errors (&optional SIGNAL) &body BODY

Enables/disables validation errors in body

Args: - signal(boolean) : If **T**, errors are signaled. If **NIL**, they are not.

Package

clavier

Source

clavier.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Functions

Function: X Y &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: && X Y &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: == OBJECT &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: blank &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: call-with-signal-validation-errors FUNC &optional SIGNAL
Package

clavier

Source

clavier.lisp (file)

Function: fn FUNCTION MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: greater-than NUMBER &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: is-a TYPE &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: is-a-boolean &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: is-a-keyword &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: is-a-list &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: is-a-string &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: is-a-symbol &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: is-an-integer &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: is-false &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: is-true &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: len &key MIN MAX MIN-MESSAGE MAX-MESSAGE
Package

clavier

Source

clavier.lisp (file)

Function: less-than NUMBER &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: matches-regex REGEX &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: not-blank &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: one-of OPTIONS &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: valid-datetime &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: valid-email &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: valid-pathname &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: valid-url &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: validate VALIDATOR OBJECT &rest ARGS &key ERROR-P MESSAGE &allow-other-keys
Package

clavier

Source

clavier.lisp (file)

Function: validation-error TARGET ERROR-MSG &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: validator-message VALIDATOR OBJECT

Returns the validator message for the given object

Package

clavier

Source

clavier.lisp (file)

Function: ~ VALIDATOR &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Function: ~= OBJECT &optional MESSAGE &rest ARGS
Package

clavier

Source

clavier.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Generic functions

Generic Function: message OBJECT
Generic Function: (setf message) NEW-VALUE OBJECT
Package

clavier

Methods
Method: message (VALIDATOR validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf message) NEW-VALUE (VALIDATOR validator)

automatically generated writer method

Source

clavier.lisp (file)

Generic Function: validation-error-message CONDITION
Package

clavier

Methods
Method: validation-error-message (CONDITION validation-error)
Source

clavier.lisp (file)

Generic Function: validation-error-target CONDITION
Package

clavier

Methods
Method: validation-error-target (CONDITION validation-error)
Source

clavier.lisp (file)

Generic Function: validator OBJECT
Generic Function: (setf validator) NEW-VALUE OBJECT
Package

clavier

Methods
Method: validator (NOT-VALIDATOR not-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf validator) NEW-VALUE (NOT-VALIDATOR not-validator)

automatically generated writer method

Source

clavier.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.5 Conditions

Condition: validation-error ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

error (condition)

Direct methods
Direct slots
Slot: target
Initargs

:target

Initform

(quote (error "set up the target"))

Readers

validation-error-target (generic function)

Slot: error-msg
Initargs

:error-msg

Initform

(quote (error "provide the error message"))

Readers

validation-error-message (generic function)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.6 Classes

Class: and-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods
  • %validate (method)
  • y (method)
  • y (method)
  • x (method)
  • x (method)
Direct slots
Slot: x
Initargs

:x

Initform

(error "provide the first validator")

Readers

x (generic function)

Writers

(setf x) (generic function)

Slot: y
Initargs

:y

Initform

(error "provide the second validator")

Readers

y (generic function)

Writers

(setf y) (generic function)

Direct Default Initargs
InitargValue
:message(lambda (clavier:validator clavier::object) (format nil "~a or ~a" (let ((clavier::x-validator (clavier::x clavier:validator))) (clavier:validator-message clavier::x-validator clavier::object)) (let ((clavier::y-validator (clavier::y clavier:validator))) (clavier:validator-message clavier::y-validator clavier::object))))
Class: blank-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

%validate (method)

Direct Default Initargs
InitargValue
:message(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "should be blank"))
Class: boolean-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

type-validator (class)

Direct Default Initargs
InitargValue
:type(quote boolean)
:message(lambda (clavier:validator clavier::object) (format nil "~a is not a boolean" clavier::object))
Class: datetime-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

%validate (method)

Direct Default Initargs
InitargValue
:message(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "~a is not a valid timestamp" clavier::object))
Class: email-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

%validate (method)

Direct Default Initargs
InitargValue
:message(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "the email is invalid: ~a" clavier::object))
Class: equal-to-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods
Direct slots
Slot: object
Initargs

:object

Initform

(error "provide the object")

Readers

object (generic function)

Writers

(setf object) (generic function)

Direct Default Initargs
InitargValue
:message(lambda (clavier:validator clavier::object) (format nil "~a is not equal to ~a" clavier::object (clavier::object clavier:validator)))
Class: false-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

%validate (method)

Direct Default Initargs
InitargValue
:message(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "is not false"))
Class: function-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods
Direct slots
Slot: function
Initargs

:function

Initform

(error "provide the function")

Readers

validator-function (generic function)

Writers

(setf validator-function) (generic function)

Class: greater-than-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods
Direct slots
Slot: number
Initargs

:number

Initform

(error "provide the number")

Readers

validator-number (generic function)

Writers

(setf validator-number) (generic function)

Direct Default Initargs
InitargValue
:message(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "~a is not greater than ~a" clavier::object (clavier::validator-number clavier:validator)))
Class: integer-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

type-validator (class)

Direct Default Initargs
InitargValue
:type(quote integer)
:message(lambda (clavier:validator clavier::object) (format nil "~a is not an integer" clavier::object))
Class: keyword-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

type-validator (class)

Direct Default Initargs
InitargValue
:type(quote keyword)
:message(lambda (clavier:validator clavier::object) (format nil "~a is not a keyword" clavier::object))
Class: length-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods
Direct slots
Slot: min

Minimum length

Initargs

:min

Readers

validator-min (generic function)

Writers

(setf validator-min) (generic function)

Slot: max

Maximum length

Initargs

:max

Readers

validator-max (generic function)

Writers

(setf validator-max) (generic function)

Slot: min-message

Message for when length is below minimum

Initargs

:min-message

Readers

validator-min-message (generic function)

Writers

(setf validator-min-message) (generic function)

Slot: max-message

Message for when length is above maximum

Initargs

:max-message

Readers

validator-max-message (generic function)

Writers

(setf validator-max-message) (generic function)

Direct Default Initargs
InitargValue
:message"size is not correct"
Class: less-than-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods
Direct slots
Slot: number
Initargs

:number

Initform

(error "provide the number")

Readers

validator-number (generic function)

Writers

(setf validator-number) (generic function)

Direct Default Initargs
InitargValue
:message(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "~a is not lower than ~a" clavier::object (clavier::validator-number clavier:validator)))
Class: list-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

type-validator (class)

Direct Default Initargs
InitargValue
:type(quote list)
:message(lambda (clavier:validator clavier::object) (format nil "~a is not a list" clavier::object))
Class: not-blank-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

%validate (method)

Direct Default Initargs
InitargValue
:message(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "should not be blank"))
Class: not-equal-to-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods
Direct slots
Slot: object
Initargs

:object

Initform

(error "provide the object")

Readers

object (generic function)

Writers

(setf object) (generic function)

Direct Default Initargs
InitargValue
:message(lambda (clavier:validator clavier::object) (format nil "~a is equal to ~a" clavier::object (clavier::object clavier:validator)))
Class: not-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods
Direct slots
Slot: validator
Initargs

:validator

Initform

(error "provide the validator")

Readers

validator (generic function)

Writers

(setf validator) (generic function)

Direct Default Initargs
InitargValue
:message(lambda (clavier:validator clavier::object) (format nil "not ~a" (clavier:validator-message (clavier:validator clavier:validator) clavier::object)))
Class: one-of-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods
Direct slots
Slot: options
Initargs

:options

Initform

(error "provide the options")

Readers

options (generic function)

Writers

(setf options) (generic function)

Direct Default Initargs
InitargValue
:message(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "should be one of ~{~a~}" (clavier::options clavier:validator)))
Class: or-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods
  • %validate (method)
  • y (method)
  • y (method)
  • x (method)
  • x (method)
Direct slots
Slot: x
Initargs

:x

Initform

(error "provide the first validator")

Readers

x (generic function)

Writers

(setf x) (generic function)

Slot: y
Initargs

:y

Initform

(error "provide the second validator")

Readers

y (generic function)

Writers

(setf y) (generic function)

Direct Default Initargs
InitargValue
:message(lambda (clavier:validator clavier::object) (format nil "~a and ~a" (let ((clavier::x-validator (clavier::x clavier:validator))) (clavier:validator-message clavier::x-validator clavier::object)) (let ((clavier::y-validator (clavier::y clavier:validator))) (clavier:validator-message clavier::y-validator clavier::object))))
Class: pathname-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods
Direct slots
Slot: absolute-p

If the pathname should be absolute

Initargs

:absolute-p

Readers

absolute-p (generic function)

Writers

(setf absolute-p) (generic function)

Slot: probe-p

Probe existance of pathname

Initargs

:probe-p

Readers

probe-p (generic function)

Writers

(setf probe-p) (generic function)

Slot: pathname-type

The pathname type

Initargs

:pathname-type

Readers

pathname-type* (generic function)

Writers

(setf pathname-type*) (generic function)

Direct Default Initargs
InitargValue
:message(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "~a is not a valid pathname" clavier::object))
Class: regex-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods
Direct slots
Slot: regex
Initargs

:regex

Initform

(error "provide the regex")

Readers

validator-regex (generic function)

Writers

(setf validator-regex) (generic function)

Direct Default Initargs
InitargValue
:message(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "~a does not match the regex ~s" clavier::object (clavier::validator-regex clavier:validator)))
Class: string-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

type-validator (class)

Direct Default Initargs
InitargValue
:type(quote string)
:message(lambda (clavier:validator clavier::object) (declare (ignore clavier:validator)) (format nil "~s is not a string" clavier::object))
Class: symbol-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

type-validator (class)

Direct Default Initargs
InitargValue
:type(quote symbol)
:message(lambda (clavier:validator clavier::object) (format nil "~a is not a symbol" clavier::object))
Class: true-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

%validate (method)

Direct Default Initargs
InitargValue
:message(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "is not true"))
Class: type-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct subclasses
Direct methods
Direct slots
Slot: type
Initargs

:type

Initform

(error "provide the type")

Readers

validator-type (generic function)

Writers

(setf validator-type) (generic function)

Direct Default Initargs
InitargValue
:message(lambda (clavier:validator clavier::object) (format nil "~a is not of type ~a" clavier::object (clavier::validator-type clavier:validator)))
Class: url-validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods

%validate (method)

Direct Default Initargs
InitargValue
:message(lambda (clavier:validator clavier::object) (declare (ignorable clavier:validator clavier::object)) (format nil "~a is not a valid url" clavier::object))
Class: validator ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

funcallable-standard-object (class)

Direct subclasses
Direct methods
  • initialize-instance (method)
  • message (method)
  • message (method)
Direct slots
Slot: message
Initargs

:message

Initform

(error "provide the validation error message")

Readers

message (generic function)

Writers

(setf message) (generic function)

Class: validator-collection ()
Package

clavier

Source

clavier.lisp (file)

Direct superclasses

validator (class)

Direct methods
Direct slots
Slot: validators
Initargs

:validators

Readers

validators (generic function)

Writers

(setf validators) (generic function)

Direct Default Initargs
InitargValue
:message(lambda (&rest clavier::args) "")

Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Functions

Function: %collecting-validation-errors FUNC
Package

clavier

Source

clavier.lisp (file)

Function: valid-email-address-p STRING
Package

clavier

Source

clavier.lisp (file)

Function: valid-url-p STRING
Package

clavier

Source

clavier.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Generic functions

Generic Function: %validate VALIDATOR OBJECT &rest ARGS
Package

clavier

Source

clavier.lisp (file)

Methods
Method: %validate (VALIDATOR greater-than-validator) OBJECT &rest ARGS
Method: %validate (VALIDATOR less-than-validator) OBJECT &rest ARGS
Method: %validate (VALIDATOR one-of-validator) OBJECT &rest ARGS
Method: %validate (VALIDATOR or-validator) OBJECT &rest ARGS
Method: %validate (VALIDATOR and-validator) OBJECT &rest ARGS
Method: %validate (VALIDATOR not-validator) OBJECT &rest ARGS
Method: %validate (VALIDATOR pathname-validator) OBJECT &rest ARGS
Method: %validate (VALIDATOR datetime-validator) OBJECT &rest ARGS
Method: %validate (VALIDATOR regex-validator) OBJECT &rest ARGS
Method: %validate (VALIDATOR url-validator) OBJECT &rest ARGS
Method: %validate (VALIDATOR email-validator) OBJECT &rest ARGS
Method: %validate (VALIDATOR length-validator) OBJECT &rest ARGS
Method: %validate (VALIDATOR false-validator) OBJECT &rest ARGS
Method: %validate (VALIDATOR true-validator) OBJECT &rest ARGS
Method: %validate (VALIDATOR not-blank-validator) OBJECT &rest ARGS
Method: %validate (VALIDATOR blank-validator) OBJECT &rest ARGS
Method: %validate (VALIDATOR function-validator) OBJECT &rest ARGS
Method: %validate (VALIDATOR type-validator) OBJECT &rest ARGS
Method: %validate (VALIDATOR not-equal-to-validator) OBJECT &rest ARGS
Method: %validate (VALIDATOR equal-to-validator) OBJECT &rest ARGS
Method: %validate (VALIDATOR validator-collection) OBJECT &rest ARGS
Method: %validate VALIDATOR OBJECT &rest ARGS
Generic Function: absolute-p OBJECT
Generic Function: (setf absolute-p) NEW-VALUE OBJECT
Package

clavier

Methods
Method: absolute-p (PATHNAME-VALIDATOR pathname-validator)
Method: (setf absolute-p) NEW-VALUE (PATHNAME-VALIDATOR pathname-validator)

If the pathname should be absolute

Source

clavier.lisp (file)

Generic Function: object OBJECT
Generic Function: (setf object) NEW-VALUE OBJECT
Package

clavier

Methods
Method: object (NOT-EQUAL-TO-VALIDATOR not-equal-to-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf object) NEW-VALUE (NOT-EQUAL-TO-VALIDATOR not-equal-to-validator)

automatically generated writer method

Source

clavier.lisp (file)

Method: object (EQUAL-TO-VALIDATOR equal-to-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf object) NEW-VALUE (EQUAL-TO-VALIDATOR equal-to-validator)

automatically generated writer method

Source

clavier.lisp (file)

Generic Function: options OBJECT
Generic Function: (setf options) NEW-VALUE OBJECT
Package

clavier

Methods
Method: options (ONE-OF-VALIDATOR one-of-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf options) NEW-VALUE (ONE-OF-VALIDATOR one-of-validator)

automatically generated writer method

Source

clavier.lisp (file)

Generic Function: pathname-type* OBJECT
Generic Function: (setf pathname-type*) NEW-VALUE OBJECT
Package

clavier

Methods
Method: pathname-type* (PATHNAME-VALIDATOR pathname-validator)
Method: (setf pathname-type*) NEW-VALUE (PATHNAME-VALIDATOR pathname-validator)

The pathname type

Source

clavier.lisp (file)

Generic Function: probe-p OBJECT
Generic Function: (setf probe-p) NEW-VALUE OBJECT
Package

clavier

Methods
Method: probe-p (PATHNAME-VALIDATOR pathname-validator)
Method: (setf probe-p) NEW-VALUE (PATHNAME-VALIDATOR pathname-validator)

Probe existance of pathname

Source

clavier.lisp (file)

Generic Function: validator-function OBJECT
Generic Function: (setf validator-function) NEW-VALUE OBJECT
Package

clavier

Methods
Method: validator-function (FUNCTION-VALIDATOR function-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf validator-function) NEW-VALUE (FUNCTION-VALIDATOR function-validator)

automatically generated writer method

Source

clavier.lisp (file)

Generic Function: validator-max OBJECT
Generic Function: (setf validator-max) NEW-VALUE OBJECT
Package

clavier

Methods
Method: validator-max (LENGTH-VALIDATOR length-validator)
Method: (setf validator-max) NEW-VALUE (LENGTH-VALIDATOR length-validator)

Maximum length

Source

clavier.lisp (file)

Generic Function: validator-max-message OBJECT
Generic Function: (setf validator-max-message) NEW-VALUE OBJECT
Package

clavier

Methods
Method: validator-max-message (LENGTH-VALIDATOR length-validator)
Method: (setf validator-max-message) NEW-VALUE (LENGTH-VALIDATOR length-validator)

Message for when length is above maximum

Source

clavier.lisp (file)

Generic Function: validator-min OBJECT
Generic Function: (setf validator-min) NEW-VALUE OBJECT
Package

clavier

Methods
Method: validator-min (LENGTH-VALIDATOR length-validator)
Method: (setf validator-min) NEW-VALUE (LENGTH-VALIDATOR length-validator)

Minimum length

Source

clavier.lisp (file)

Generic Function: validator-min-message OBJECT
Generic Function: (setf validator-min-message) NEW-VALUE OBJECT
Package

clavier

Methods
Method: validator-min-message (LENGTH-VALIDATOR length-validator)
Method: (setf validator-min-message) NEW-VALUE (LENGTH-VALIDATOR length-validator)

Message for when length is below minimum

Source

clavier.lisp (file)

Generic Function: validator-number OBJECT
Generic Function: (setf validator-number) NEW-VALUE OBJECT
Package

clavier

Methods
Method: validator-number (GREATER-THAN-VALIDATOR greater-than-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf validator-number) NEW-VALUE (GREATER-THAN-VALIDATOR greater-than-validator)

automatically generated writer method

Source

clavier.lisp (file)

Method: validator-number (LESS-THAN-VALIDATOR less-than-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf validator-number) NEW-VALUE (LESS-THAN-VALIDATOR less-than-validator)

automatically generated writer method

Source

clavier.lisp (file)

Generic Function: validator-regex OBJECT
Generic Function: (setf validator-regex) NEW-VALUE OBJECT
Package

clavier

Methods
Method: validator-regex (REGEX-VALIDATOR regex-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf validator-regex) NEW-VALUE (REGEX-VALIDATOR regex-validator)

automatically generated writer method

Source

clavier.lisp (file)

Generic Function: validator-type OBJECT
Generic Function: (setf validator-type) NEW-VALUE OBJECT
Package

clavier

Methods
Method: validator-type (TYPE-VALIDATOR type-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf validator-type) NEW-VALUE (TYPE-VALIDATOR type-validator)

automatically generated writer method

Source

clavier.lisp (file)

Generic Function: validators OBJECT
Generic Function: (setf validators) NEW-VALUE OBJECT
Package

clavier

Methods
Method: validators (VALIDATOR-COLLECTION validator-collection)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf validators) NEW-VALUE (VALIDATOR-COLLECTION validator-collection)

automatically generated writer method

Source

clavier.lisp (file)

Generic Function: x OBJECT
Generic Function: (setf x) NEW-VALUE OBJECT
Package

clavier

Methods
Method: x (OR-VALIDATOR or-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf x) NEW-VALUE (OR-VALIDATOR or-validator)

automatically generated writer method

Source

clavier.lisp (file)

Method: x (AND-VALIDATOR and-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf x) NEW-VALUE (AND-VALIDATOR and-validator)

automatically generated writer method

Source

clavier.lisp (file)

Generic Function: y OBJECT
Generic Function: (setf y) NEW-VALUE OBJECT
Package

clavier

Methods
Method: y (OR-VALIDATOR or-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf y) NEW-VALUE (OR-VALIDATOR or-validator)

automatically generated writer method

Source

clavier.lisp (file)

Method: y (AND-VALIDATOR and-validator)

automatically generated reader method

Source

clavier.lisp (file)

Method: (setf y) NEW-VALUE (AND-VALIDATOR and-validator)

automatically generated writer method

Source

clavier.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
clavier.asd: The clavier․asd file
clavier/clavier.lisp: The clavier/clavier․lisp file
clavier/package.lisp: The clavier/package․lisp file

F
File, Lisp, clavier.asd: The clavier․asd file
File, Lisp, clavier/clavier.lisp: The clavier/clavier․lisp file
File, Lisp, clavier/package.lisp: The clavier/package․lisp file

L
Lisp File, clavier.asd: The clavier․asd file
Lisp File, clavier/clavier.lisp: The clavier/clavier․lisp file
Lisp File, clavier/package.lisp: The clavier/package․lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %   &   (   =   ~    
A   B   C   F   G   I   L   M   N   O   P   V   W   X   Y  
Index Entry  Section

%
%collecting-validation-errors: Internal functions
%validate: Internal generic functions
%validate: Internal generic functions
%validate: Internal generic functions
%validate: Internal generic functions
%validate: Internal generic functions
%validate: Internal generic functions
%validate: Internal generic functions
%validate: Internal generic functions
%validate: Internal generic functions
%validate: Internal generic functions
%validate: Internal generic functions
%validate: Internal generic functions
%validate: Internal generic functions
%validate: Internal generic functions
%validate: Internal generic functions
%validate: Internal generic functions
%validate: Internal generic functions
%validate: Internal generic functions
%validate: Internal generic functions
%validate: Internal generic functions
%validate: Internal generic functions
%validate: Internal generic functions
%validate: Internal generic functions

&
&&: Exported functions

(
(setf absolute-p): Internal generic functions
(setf absolute-p): Internal generic functions
(setf message): Exported generic functions
(setf message): Exported generic functions
(setf object): Internal generic functions
(setf object): Internal generic functions
(setf object): Internal generic functions
(setf options): Internal generic functions
(setf options): Internal generic functions
(setf pathname-type*): Internal generic functions
(setf pathname-type*): Internal generic functions
(setf probe-p): Internal generic functions
(setf probe-p): Internal generic functions
(setf validator): Exported generic functions
(setf validator): Exported generic functions
(setf validator-function): Internal generic functions
(setf validator-function): Internal generic functions
(setf validator-max): Internal generic functions
(setf validator-max): Internal generic functions
(setf validator-max-message): Internal generic functions
(setf validator-max-message): Internal generic functions
(setf validator-min): Internal generic functions
(setf validator-min): Internal generic functions
(setf validator-min-message): Internal generic functions
(setf validator-min-message): Internal generic functions
(setf validator-number): Internal generic functions
(setf validator-number): Internal generic functions
(setf validator-number): Internal generic functions
(setf validator-regex): Internal generic functions
(setf validator-regex): Internal generic functions
(setf validator-type): Internal generic functions
(setf validator-type): Internal generic functions
(setf validators): Internal generic functions
(setf validators): Internal generic functions
(setf x): Internal generic functions
(setf x): Internal generic functions
(setf x): Internal generic functions
(setf y): Internal generic functions
(setf y): Internal generic functions
(setf y): Internal generic functions

=
==: Exported functions

~
~: Exported functions
~=: Exported functions

: Exported functions

A
absolute-p: Internal generic functions
absolute-p: Internal generic functions

B
blank: Exported functions

C
call-with-signal-validation-errors: Exported functions
collecting-validation-errors: Exported macros

F
fn: Exported functions
Function, %collecting-validation-errors: Internal functions
Function, &&: Exported functions
Function, ==: Exported functions
Function, blank: Exported functions
Function, call-with-signal-validation-errors: Exported functions
Function, fn: Exported functions
Function, greater-than: Exported functions
Function, is-a: Exported functions
Function, is-a-boolean: Exported functions
Function, is-a-keyword: Exported functions
Function, is-a-list: Exported functions
Function, is-a-string: Exported functions
Function, is-a-symbol: Exported functions
Function, is-an-integer: Exported functions
Function, is-false: Exported functions
Function, is-true: Exported functions
Function, len: Exported functions
Function, less-than: Exported functions
Function, matches-regex: Exported functions
Function, not-blank: Exported functions
Function, one-of: Exported functions
Function, valid-datetime: Exported functions
Function, valid-email: Exported functions
Function, valid-email-address-p: Internal functions
Function, valid-pathname: Exported functions
Function, valid-url: Exported functions
Function, valid-url-p: Internal functions
Function, validate: Exported functions
Function, validation-error: Exported functions
Function, validator-message: Exported functions
Function, ~: Exported functions
Function, ~=: Exported functions
Function, : Exported functions

G
Generic Function, %validate: Internal generic functions
Generic Function, (setf absolute-p): Internal generic functions
Generic Function, (setf message): Exported generic functions
Generic Function, (setf object): Internal generic functions
Generic Function, (setf options): Internal generic functions
Generic Function, (setf pathname-type*): Internal generic functions
Generic Function, (setf probe-p): Internal generic functions
Generic Function, (setf validator): Exported generic functions
Generic Function, (setf validator-function): Internal generic functions
Generic Function, (setf validator-max): Internal generic functions
Generic Function, (setf validator-max-message): Internal generic functions
Generic Function, (setf validator-min): Internal generic functions
Generic Function, (setf validator-min-message): Internal generic functions
Generic Function, (setf validator-number): Internal generic functions
Generic Function, (setf validator-regex): Internal generic functions
Generic Function, (setf validator-type): Internal generic functions
Generic Function, (setf validators): Internal generic functions
Generic Function, (setf x): Internal generic functions
Generic Function, (setf y): Internal generic functions
Generic Function, absolute-p: Internal generic functions
Generic Function, message: Exported generic functions
Generic Function, object: Internal generic functions
Generic Function, options: Internal generic functions
Generic Function, pathname-type*: Internal generic functions
Generic Function, probe-p: Internal generic functions
Generic Function, validation-error-message: Exported generic functions
Generic Function, validation-error-target: Exported generic functions
Generic Function, validator: Exported generic functions
Generic Function, validator-function: Internal generic functions
Generic Function, validator-max: Internal generic functions
Generic Function, validator-max-message: Internal generic functions
Generic Function, validator-min: Internal generic functions
Generic Function, validator-min-message: Internal generic functions
Generic Function, validator-number: Internal generic functions
Generic Function, validator-regex: Internal generic functions
Generic Function, validator-type: Internal generic functions
Generic Function, validators: Internal generic functions
Generic Function, x: Internal generic functions
Generic Function, y: Internal generic functions
greater-than: Exported functions

I
is-a: Exported functions
is-a-boolean: Exported functions
is-a-keyword: Exported functions
is-a-list: Exported functions
is-a-string: Exported functions
is-a-symbol: Exported functions
is-an-integer: Exported functions
is-false: Exported functions
is-true: Exported functions

L
len: Exported functions
less-than: Exported functions

M
Macro, collecting-validation-errors: Exported macros
Macro, with-signal-validation-errors: Exported macros
matches-regex: Exported functions
message: Exported generic functions
message: Exported generic functions
Method, %validate: Internal generic functions
Method, %validate: Internal generic functions
Method, %validate: Internal generic functions
Method, %validate: Internal generic functions
Method, %validate: Internal generic functions
Method, %validate: Internal generic functions
Method, %validate: Internal generic functions
Method, %validate: Internal generic functions
Method, %validate: Internal generic functions
Method, %validate: Internal generic functions
Method, %validate: Internal generic functions
Method, %validate: Internal generic functions
Method, %validate: Internal generic functions
Method, %validate: Internal generic functions
Method, %validate: Internal generic functions
Method, %validate: Internal generic functions
Method, %validate: Internal generic functions
Method, %validate: Internal generic functions
Method, %validate: Internal generic functions
Method, %validate: Internal generic functions
Method, %validate: Internal generic functions
Method, %validate: Internal generic functions
Method, (setf absolute-p): Internal generic functions
Method, (setf message): Exported generic functions
Method, (setf object): Internal generic functions
Method, (setf object): Internal generic functions
Method, (setf options): Internal generic functions
Method, (setf pathname-type*): Internal generic functions
Method, (setf probe-p): Internal generic functions
Method, (setf validator): Exported generic functions
Method, (setf validator-function): Internal generic functions
Method, (setf validator-max): Internal generic functions
Method, (setf validator-max-message): Internal generic functions
Method, (setf validator-min): Internal generic functions
Method, (setf validator-min-message): Internal generic functions
Method, (setf validator-number): Internal generic functions
Method, (setf validator-number): Internal generic functions
Method, (setf validator-regex): Internal generic functions
Method, (setf validator-type): Internal generic functions
Method, (setf validators): Internal generic functions
Method, (setf x): Internal generic functions
Method, (setf x): Internal generic functions
Method, (setf y): Internal generic functions
Method, (setf y): Internal generic functions
Method, absolute-p: Internal generic functions
Method, message: Exported generic functions
Method, object: Internal generic functions
Method, object: Internal generic functions
Method, options: Internal generic functions
Method, pathname-type*: Internal generic functions
Method, probe-p: Internal generic functions
Method, validation-error-message: Exported generic functions
Method, validation-error-target: Exported generic functions
Method, validator: Exported generic functions
Method, validator-function: Internal generic functions
Method, validator-max: Internal generic functions
Method, validator-max-message: Internal generic functions
Method, validator-min: Internal generic functions
Method, validator-min-message: Internal generic functions
Method, validator-number: Internal generic functions
Method, validator-number: Internal generic functions
Method, validator-regex: Internal generic functions
Method, validator-type: Internal generic functions
Method, validators: Internal generic functions
Method, x: Internal generic functions
Method, x: Internal generic functions
Method, y: Internal generic functions
Method, y: Internal generic functions

N
not-blank: Exported functions

O
object: Internal generic functions
object: Internal generic functions
object: Internal generic functions
one-of: Exported functions
options: Internal generic functions
options: Internal generic functions

P
pathname-type*: Internal generic functions
pathname-type*: Internal generic functions
probe-p: Internal generic functions
probe-p: Internal generic functions

V
valid-datetime: Exported functions
valid-email: Exported functions
valid-email-address-p: Internal functions
valid-pathname: Exported functions
valid-url: Exported functions
valid-url-p: Internal functions
validate: Exported functions
validation-error: Exported functions
validation-error-message: Exported generic functions
validation-error-message: Exported generic functions
validation-error-target: Exported generic functions
validation-error-target: Exported generic functions
validator: Exported generic functions
validator: Exported generic functions
validator-function: Internal generic functions
validator-function: Internal generic functions
validator-max: Internal generic functions
validator-max: Internal generic functions
validator-max-message: Internal generic functions
validator-max-message: Internal generic functions
validator-message: Exported functions
validator-min: Internal generic functions
validator-min: Internal generic functions
validator-min-message: Internal generic functions
validator-min-message: Internal generic functions
validator-number: Internal generic functions
validator-number: Internal generic functions
validator-number: Internal generic functions
validator-regex: Internal generic functions
validator-regex: Internal generic functions
validator-type: Internal generic functions
validator-type: Internal generic functions
validators: Internal generic functions
validators: Internal generic functions

W
with-signal-validation-errors: Exported macros

X
x: Internal generic functions
x: Internal generic functions
x: Internal generic functions

Y
y: Internal generic functions
y: Internal generic functions
y: Internal generic functions

Jump to:   %   &   (   =   ~    
A   B   C   F   G   I   L   M   N   O   P   V   W   X   Y  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
A   E   F   M   N   O   P   R   S   T   V   X   Y  
Index Entry  Section

*
*signal-validation-errors*: Exported special variables

A
absolute-p: Exported classes

E
error-msg: Exported conditions

F
function: Exported classes

M
max: Exported classes
max-message: Exported classes
message: Exported classes
min: Exported classes
min-message: Exported classes

N
number: Exported classes
number: Exported classes

O
object: Exported classes
object: Exported classes
options: Exported classes

P
pathname-type: Exported classes
probe-p: Exported classes

R
regex: Exported classes

S
Slot, absolute-p: Exported classes
Slot, error-msg: Exported conditions
Slot, function: Exported classes
Slot, max: Exported classes
Slot, max-message: Exported classes
Slot, message: Exported classes
Slot, min: Exported classes
Slot, min-message: Exported classes
Slot, number: Exported classes
Slot, number: Exported classes
Slot, object: Exported classes
Slot, object: Exported classes
Slot, options: Exported classes
Slot, pathname-type: Exported classes
Slot, probe-p: Exported classes
Slot, regex: Exported classes
Slot, target: Exported conditions
Slot, type: Exported classes
Slot, validator: Exported classes
Slot, validators: Exported classes
Slot, x: Exported classes
Slot, x: Exported classes
Slot, y: Exported classes
Slot, y: Exported classes
Special Variable, *signal-validation-errors*: Exported special variables

T
target: Exported conditions
type: Exported classes

V
validator: Exported classes
validators: Exported classes

X
x: Exported classes
x: Exported classes

Y
y: Exported classes
y: Exported classes

Jump to:   *  
A   E   F   M   N   O   P   R   S   T   V   X   Y  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   A   B   C   D   E   F   G   I   K   L   N   O   P   R   S   T   U   V  
Index Entry  Section

A
and-validator: Exported classes

B
blank-validator: Exported classes
boolean-validator: Exported classes

C
Class, and-validator: Exported classes
Class, blank-validator: Exported classes
Class, boolean-validator: Exported classes
Class, datetime-validator: Exported classes
Class, email-validator: Exported classes
Class, equal-to-validator: Exported classes
Class, false-validator: Exported classes
Class, function-validator: Exported classes
Class, greater-than-validator: Exported classes
Class, integer-validator: Exported classes
Class, keyword-validator: Exported classes
Class, length-validator: Exported classes
Class, less-than-validator: Exported classes
Class, list-validator: Exported classes
Class, not-blank-validator: Exported classes
Class, not-equal-to-validator: Exported classes
Class, not-validator: Exported classes
Class, one-of-validator: Exported classes
Class, or-validator: Exported classes
Class, pathname-validator: Exported classes
Class, regex-validator: Exported classes
Class, string-validator: Exported classes
Class, symbol-validator: Exported classes
Class, true-validator: Exported classes
Class, type-validator: Exported classes
Class, url-validator: Exported classes
Class, validator: Exported classes
Class, validator-collection: Exported classes
clavier: The clavier system
clavier: The clavier package
Condition, validation-error: Exported conditions

D
datetime-validator: Exported classes

E
email-validator: Exported classes
equal-to-validator: Exported classes

F
false-validator: Exported classes
function-validator: Exported classes

G
greater-than-validator: Exported classes

I
integer-validator: Exported classes

K
keyword-validator: Exported classes

L
length-validator: Exported classes
less-than-validator: Exported classes
list-validator: Exported classes

N
not-blank-validator: Exported classes
not-equal-to-validator: Exported classes
not-validator: Exported classes

O
one-of-validator: Exported classes
or-validator: Exported classes

P
Package, clavier: The clavier package
pathname-validator: Exported classes

R
regex-validator: Exported classes

S
string-validator: Exported classes
symbol-validator: Exported classes
System, clavier: The clavier system

T
true-validator: Exported classes
type-validator: Exported classes

U
url-validator: Exported classes

V
validation-error: Exported conditions
validator: Exported classes
validator-collection: Exported classes

Jump to:   A   B   C   D   E   F   G   I   K   L   N   O   P   R   S   T   U   V