The enhanced-multiple-value-bind Reference Manual

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

The enhanced-multiple-value-bind Reference Manual

This is the enhanced-multiple-value-bind Reference Manual, version 1.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 04:30:00 2022 GMT+0.

Table of Contents


1 Introduction

Project's home: http://www.hexstreamsoft.com/projects/enhanced-multiple-value-bind/


enhanced-multiple-value-bind provides an enhanced MULTIPLE-VALUE-BIND
macro that adds support for lambda keywords by expanding to a
MULTIPLE-VALUE-CALL when necessary. This makes catching multiple-value
&rest and &key much more lightweight and convenient. A
MULTIPLE-VALUE-&BIND alias is supported.

Some problems with writing out MULTIPLE-VALUE-CALL with an inline
LAMBDA, especially with a big LAMBDA body and trivial form arguments
to m-v-c, compared to MULTIPLE-VALUE-BIND, are:

- "unnatural" order of evaluation (skip over LAMBDA, evaluate values
  forms, then "come back" for LAMBDA body);

- significant extra indentation for the body.

Multiple-value &rest and &key are currently not being used a lot, but
the awkwardness of using them up to now might have something to do
with this state of affairs. Their usefulness and convenience should
now be reassessed.


If enhanced-mvb:MULTIPLE-VALUE-BIND is invoked without apparent lambda
keywords (symbols beginning with "&"), then it simply expands to
cl:MULTIPLE-VALUE-BIND:

(enhanced-mvb:multiple-value-bind (a b c) (values 1 2 3)
  ...)
==
(multiple-value-bind (a b c) (values 1 2 3)
  ...)

Else, it simply expands to a MULTIPLE-VALUE-CALL with inline LAMBDA:

(enhanced-mvb:multiple-value-bind (a b &rest rest) (values 1 2 3)
  ...)
==
(multiple-value-call (lambda (a b &rest rest)
                       ...)
  (values 1 2 3))

An interesting consequence of this is that it's easy to accept an
exact number of return values (though I'm not sure why you'd want to):

(multiple-value-bind (a b c &optional) (values 1 2 3 4))
error --> "Invalid number of arguments: 4"

This follows the same principle as VALUES in FUNCTION type specifiers.
CLHS VALUES (type specifier):
http://www.lispworks.com/documentation/HyperSpec/Body/t_values.htm


To use enhanced-multiple-value-bind, either refer to the provided
MULTIPLE-VALUE-BIND directly:

;; A bit long...
(enhanced-multiple-value-bind:multiple-value-bind
      (x y &rest others)
    (values 1 2 3 4)
  (values (* x y) others))
=> 2, (3 4)

;; Much more managable package nickname.
(enhanced-mvb:multiple-value-bind (x y &rest others)
    (values 1 2 3 4)
  (values (* x y) others))
=> 2, (3 4)

Or (:shadowing-import-from #:enhanced-multiple-value-bind
#:multiple-value-bind) in your DEFPACKAGE (or with the package
nickname, again). Don't (:use)!

enhanced-multiple-value-bind also exports MULTIPLE-VALUE-&BIND, with
exactly the same functionality, so you can (:import-from
#:enhanced-multiple-value-bind #:multiple-value-&bind) in your
DEFPACKAGE instead if you want.


This library is in the Public Domain.
See the UNLICENSE file for details.


2 Systems

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


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

2.1 enhanced-multiple-value-bind

Provides an enhanced MULTIPLE-VALUE-BIND macro that adds support for lambda keywords by expanding to a MULTIPLE-VALUE-CALL when necessary. This makes catching multiple-value &rest and &key much more lightweight and convenient. A MULTIPLE-VALUE-&BIND alias is supported.

Author

Jean-Philippe Paradis <hexstream@gmail.com>

License

Public Domain

Version

1.0.1

Source

enhanced-multiple-value-bind.asd.

Child Components

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


3.1.1 enhanced-multiple-value-bind/enhanced-multiple-value-bind.asd

Source

enhanced-multiple-value-bind.asd.

Parent Component

enhanced-multiple-value-bind (system).

ASDF Systems

enhanced-multiple-value-bind.


3.1.3 enhanced-multiple-value-bind/main.lisp

Dependency

package.lisp (file).

Source

enhanced-multiple-value-bind.asd.

Parent Component

enhanced-multiple-value-bind (system).

Public Interface
Internals

%expand (function).


4 Packages

Packages are listed by definition order.


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

4.1 enhanced-multiple-value-bind

Source

package.lisp.

Nickname

enhanced-mvb

Use List

common-lisp.

Public Interface
Internals

%expand (function).


5 Definitions

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


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

5.1 Public Interface


5.1.1 Macros

Macro: multiple-value-&bind (lambda-list values-form &body body)
Package

enhanced-multiple-value-bind.

Source

main.lisp.

Macro: multiple-value-bind (lambda-list values-form &body body)
Package

enhanced-multiple-value-bind.

Source

main.lisp.


5.2 Internals


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

5.2.1 Ordinary functions

Function: %expand (lambda-list values-form body)
Package

enhanced-multiple-value-bind.

Source

main.lisp.


Appendix A Indexes


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

A.1 Concepts


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

A.3 Variables