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

The easy-macros Reference Manual

This is the easy-macros Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:20:14 2024 GMT+0.

Table of Contents

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

1 Introduction

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

2 Systems

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

easy-macros

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

2.1 `easy-macros`

An easier way to write 90% of your macros

Author: Arnold Noronha <arnold@tdrhq.com>
License: Apache License, Version 2.0
Source: easy-macros.asd.
Child Component: macros.lisp (file).

Next: Packages, Previous: Systems, Up: The easy-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

easy-macros/easy-macros.asd
easy-macros/macros.lisp

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

3.1.1 `easy-macros/easy-macros.asd`

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

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

3.1.2 `easy-macros/macros.lisp`

Source

easy-macros.asd.

Parent Component

easy-macros (system).

Packages

Public Interface

def-easy-macro (macro).

Internals

binding-sym (class).
binding-sym-p (function).
build-funcall (function).
check-validity (function).
get-bindings (function).
get-non-bindings (function).
is-sym (function).
name (reader method).
remove-&fn (function).
remove-binding-syms (function).
unsupported-lambda-list (condition).

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

4 Packages

Packages are listed by definition order.

easy-macros

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

4.1 `easy-macros`

Source

Use List

common-lisp.

Public Interface

def-easy-macro (macro).

Internals

binding-sym (class).
binding-sym-p (function).
build-funcall (function).
check-validity (function).
get-bindings (function).
get-non-bindings (function).
is-sym (function).
name (generic reader).
remove-&fn (function).
remove-binding-syms (function).
unsupported-lambda-list (condition).

Next: Indexes, Previous: Packages, Up: The easy-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: def-easy-macro (name real-fn-args &body body) ¶

Package: easy-macros.
Source: macros.lisp.

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

5.2 Internals

Ordinary functions
Generic functions
Conditions
Classes

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

5.2.1 Ordinary functions

Function: binding-sym-p (x) ¶

Package: easy-macros.
Source: macros.lisp.

Function: build-funcall (fn-name real-fn-args fn-arg-values body) ¶

Package: easy-macros.
Source: macros.lisp.

Function: check-validity (args) ¶

Package: easy-macros.
Source: macros.lisp.

Function: get-bindings (real-fn-args fn-arg-values) ¶

Package: easy-macros.
Source: macros.lisp.

Function: get-non-bindings (real-fn-args fn-arg-values) ¶

Carefully remove all the fn-arg-values that correspond to bindings

Package: easy-macros.
Source: macros.lisp.

Function: is-sym (sym looking-for) ¶

Package: easy-macros.
Source: macros.lisp.

Function: remove-&fn (args) ¶

Package: easy-macros.
Source: macros.lisp.

Function: remove-binding-syms (args) ¶

Package: easy-macros.
Source: macros.lisp.

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

5.2.2 Generic functions

Generic Reader: name (object) ¶

Package

Methods

Reader Method: name ((binding-sym binding-sym)) ¶

automatically generated reader method

Source: macros.lisp.
Target Slot: name.

Next: Classes, Previous: Generic functions, Up: Internals [Contents][Index]

5.2.3 Conditions

Condition: unsupported-lambda-list ¶

Package

Source

Direct superclasses

error.

Direct slots

Slot: reason ¶

Initargs: :reason

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

5.2.4 Classes

Class: binding-sym ¶

Package

Source

Direct methods

Direct slots

Slot: name ¶

Initargs: :name
Readers: name.
Writers: This slot is read-only.

Previous: Definitions, Up: The easy-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:	B C D F G I M N R

	Index Entry		Section

B
	`binding-sym-p`:		Private ordinary functions
	`build-funcall`:		Private ordinary functions

C
	`check-validity`:		Private ordinary functions

D
	`def-easy-macro`:		Public macros

F
	`Function, binding-sym-p`:		Private ordinary functions
	`Function, build-funcall`:		Private ordinary functions
	`Function, check-validity`:		Private ordinary functions
	`Function, get-bindings`:		Private ordinary functions
	`Function, get-non-bindings`:		Private ordinary functions
	`Function, is-sym`:		Private ordinary functions
	`Function, remove-&fn`:		Private ordinary functions
	`Function, remove-binding-syms`:		Private ordinary functions

G
	`Generic Function, name`:		Private generic functions
	`get-bindings`:		Private ordinary functions
	`get-non-bindings`:		Private ordinary functions

I
	`is-sym`:		Private ordinary functions

M
	`Macro, def-easy-macro`:		Public macros
	`Method, name`:		Private generic functions

N
	`name`:		Private generic functions
	`name`:		Private generic functions

R
	`remove-&fn`:		Private ordinary functions
	`remove-binding-syms`:		Private ordinary functions

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

A.3 Variables

Jump to:	N R S

	Index Entry		Section

N
	`name`:		Private classes

R
	`reason`:		Private conditions

S
	`Slot, name`:		Private classes
	`Slot, reason`:		Private conditions

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

A.4 Data types

Jump to:	B C E F M P S U

	Index Entry		Section

B
	`binding-sym`:		Private classes

C
	`Class, binding-sym`:		Private classes
	`Condition, unsupported-lambda-list`:		Private conditions

E
	`easy-macros`:		The easy-macros system
	`easy-macros`:		The easy-macros package
	`easy-macros.asd`:		The easy-macros/easy-macros․asd file

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

M
	`macros.lisp`:		The easy-macros/macros․lisp file

P
	`Package, easy-macros`:		The easy-macros package

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

U
	`unsupported-lambda-list`:		Private conditions