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

The arrow-macros Reference Manual

This is the arrow-macros Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon May 15 03:18:23 2023 GMT+0.

Table of Contents

Next: Systems, Previous: The arrow-macros Reference Manual, Up: The arrow-macros Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The arrow-macros Reference Manual [Contents][Index]

2 Systems

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

arrow-macros

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

2.1 `arrow-macros`

arrow-macros provides clojure-like arrow macros and diamond wands.

Author: hipeta
License: MIT
Dependency: alexandria (system).
Source: arrow-macros.asd.
Child Component: arrow-macros.lisp (file).

Next: Packages, Previous: Systems, Up: The arrow-macros Reference Manual [Contents][Index]

3 Files

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

Lisp

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

3.1 Lisp

arrow-macros/arrow-macros.asd
arrow-macros/arrow-macros.lisp

Next: arrow-macros/arrow-macros.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `arrow-macros/arrow-macros.asd`

Source: arrow-macros.asd.
Parent Component: arrow-macros (system).
ASDF Systems: arrow-macros.
Packages: arrow-macros-asd.

Previous: arrow-macros/arrow-macros.asd, Up: Lisp [Contents][Index]

3.1.2 `arrow-macros/arrow-macros.lisp`

Source

arrow-macros.asd.

Parent Component

arrow-macros (system).

Packages

arrow-macros.

Public Interface

-<> (macro).
-<>> (macro).
-> (macro).
->> (macro).
as-> (macro).
cond-> (macro).
cond->> (macro).
some-<> (macro).
some-<>> (macro).
some-> (macro).
some->> (macro).

Internals

*diamond-wands* (special variable).
arrow-macro (function).
cond-arrow-macro (function).
diamond-wand (function).
diamond-wand% (function).
diamond-wand-symbol-p (function).
has-diamond (function).
replace-diamond (function).

Next: Definitions, Previous: Files, Up: The arrow-macros Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

arrow-macros-asd
arrow-macros

Next: arrow-macros, Previous: Packages, Up: Packages [Contents][Index]

4.1 `arrow-macros-asd`

Source

arrow-macros.asd.

Use List

asdf/interface.
common-lisp.

Previous: arrow-macros-asd, Up: Packages [Contents][Index]

4.2 `arrow-macros`

Source

arrow-macros.lisp.

Use List

common-lisp.

Public Interface

-<> (macro).
-<>> (macro).
-> (macro).
->> (macro).
as-> (macro).
cond-> (macro).
cond->> (macro).
some-<> (macro).
some-<>> (macro).
some-> (macro).
some->> (macro).

Internals

*diamond-wands* (special variable).
arrow-macro (function).
cond-arrow-macro (function).
diamond-wand (function).
diamond-wand% (function).
diamond-wand-symbol-p (function).
has-diamond (function).
replace-diamond (function).

Next: Indexes, Previous: Packages, Up: The arrow-macros Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Macros

Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Macros

Macro: -<> (init &body exps) ¶

Package: arrow-macros.
Source: arrow-macros.lisp.

Macro: -<>> (init &body exps) ¶

Package: arrow-macros.
Source: arrow-macros.lisp.

Macro: -> (init &body exps) ¶

Package: arrow-macros.
Source: arrow-macros.lisp.

Macro: ->> (init &body exps) ¶

Package: arrow-macros.
Source: arrow-macros.lisp.

Macro: as-> (init var &body exps) ¶

Package: arrow-macros.
Source: arrow-macros.lisp.

Macro: cond-> (init &body exps) ¶

Package: arrow-macros.
Source: arrow-macros.lisp.

Macro: cond->> (init &body exps) ¶

Package: arrow-macros.
Source: arrow-macros.lisp.

Macro: some-<> (init &body exps) ¶

Package: arrow-macros.
Source: arrow-macros.lisp.

Macro: some-<>> (init &body exps) ¶

Package: arrow-macros.
Source: arrow-macros.lisp.

Macro: some-> (init &body exps) ¶

Package: arrow-macros.
Source: arrow-macros.lisp.

Macro: some->> (init &body exps) ¶

Package: arrow-macros.
Source: arrow-macros.lisp.

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

5.2 Internals

Special variables
Ordinary functions

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Special variables

Special Variable: *diamond-wands* ¶

Package: arrow-macros.
Source: arrow-macros.lisp.

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

5.2.2 Ordinary functions

Function: arrow-macro (init exps &optional >>-p some-p) ¶

Package: arrow-macros.
Source: arrow-macros.lisp.

Function: cond-arrow-macro (init exps &optional >>-p) ¶

Package: arrow-macros.
Source: arrow-macros.lisp.

Function: diamond-wand (init exps &optional >>-p some-p) ¶

Package: arrow-macros.
Source: arrow-macros.lisp.

Function: diamond-wand% (diamond-exp exps some-p) ¶

Package: arrow-macros.
Source: arrow-macros.lisp.

Function: diamond-wand-symbol-p (sym) ¶

Package: arrow-macros.
Source: arrow-macros.lisp.

Function: has-diamond (exp) ¶

Package: arrow-macros.
Source: arrow-macros.lisp.

Function: replace-diamond (exp diamond-exp) ¶

Package: arrow-macros.
Source: arrow-macros.lisp.

Previous: Definitions, Up: The arrow-macros Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	- A C D F H M R S

	Index Entry		Section

-
	`-<>`:		Public macros
	`-<>>`:		Public macros
	`->`:		Public macros
	`->>`:		Public macros

A
	`arrow-macro`:		Private ordinary functions
	`as->`:		Public macros

C
	`cond->`:		Public macros
	`cond->>`:		Public macros
	`cond-arrow-macro`:		Private ordinary functions

D
	`diamond-wand`:		Private ordinary functions
	`diamond-wand%`:		Private ordinary functions
	`diamond-wand-symbol-p`:		Private ordinary functions

F
	`Function, arrow-macro`:		Private ordinary functions
	`Function, cond-arrow-macro`:		Private ordinary functions
	`Function, diamond-wand`:		Private ordinary functions
	`Function, diamond-wand%`:		Private ordinary functions
	`Function, diamond-wand-symbol-p`:		Private ordinary functions
	`Function, has-diamond`:		Private ordinary functions
	`Function, replace-diamond`:		Private ordinary functions

H
	`has-diamond`:		Private ordinary functions

M
	`Macro, -<>`:		Public macros
	`Macro, -<>>`:		Public macros
	`Macro, ->`:		Public macros
	`Macro, ->>`:		Public macros
	`Macro, as->`:		Public macros
	`Macro, cond->`:		Public macros
	`Macro, cond->>`:		Public macros
	`Macro, some-<>`:		Public macros
	`Macro, some-<>>`:		Public macros
	`Macro, some->`:		Public macros
	`Macro, some->>`:		Public macros

R
	`replace-diamond`:		Private ordinary functions

S
	`some-<>`:		Public macros
	`some-<>>`:		Public macros
	`some->`:		Public macros
	`some->>`:		Public macros

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* S

	Index Entry		Section

*
	`diamond-wands`:		Private special variables

S
	`Special Variable, diamond-wands`:		Private special variables

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

A.4 Data types

Jump to:	A F P S

	Index Entry		Section

A
	`arrow-macros`:		The arrow-macros system
	`arrow-macros`:		The arrow-macros package
	`arrow-macros-asd`:		The arrow-macros-asd package
	`arrow-macros.asd`:		The arrow-macros/arrow-macros․asd file
	`arrow-macros.lisp`:		The arrow-macros/arrow-macros․lisp file

F
	`File, arrow-macros.asd`:		The arrow-macros/arrow-macros․asd file
	`File, arrow-macros.lisp`:		The arrow-macros/arrow-macros․lisp file

P
	`Package, arrow-macros`:		The arrow-macros package
	`Package, arrow-macros-asd`:		The arrow-macros-asd package

S
	`System, arrow-macros`:		The arrow-macros system