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

The with-shadowed-bindings Reference Manual

This is the with-shadowed-bindings Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 08:06:26 2024 GMT+0.

Next: Systems, Previous: The with-shadowed-bindings Reference Manual, Up: The with-shadowed-bindings Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The with-shadowed-bindings Reference Manual [Contents][Index]

2 Systems

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

with-shadowed-bindings

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

2.1 `with-shadowed-bindings`

Establishes a new lexical context within which specified bindings are explicitly shadowed, making it clear that they are not referenced within, thereby reducing cognitive load.

Author

Jean-Philippe Paradis <hexstream@hexstreamsoft.com>

License

Public Domain

Version

1.0

Dependency

map-bind (system).

Source

with-shadowed-bindings.asd.

Child Components

package.lisp (file).
main.lisp (file).

Next: Packages, Previous: Systems, Up: The with-shadowed-bindings 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.3 `with-shadowed-bindings/main.lisp`

Dependency

package.lisp (file).

Source

with-shadowed-bindings.asd.

Parent Component

with-shadowed-bindings (system).

Public Interface

invalid-access (function).
(setf invalid-access) (function).
invalid-access (condition).
kind (reader method).
name (reader method).
with-shadowed-bindings (macro).

Internals

%add-shadowing (function).
%analyze (function).

Next: Definitions, Previous: Files, Up: The with-shadowed-bindings Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

with-shadowed-bindings

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

4.1 `with-shadowed-bindings`

Source

package.lisp.

Use List

common-lisp.

Public Interface

invalid-access (function).
(setf invalid-access) (function).
invalid-access (condition).
kind (generic reader).
name (generic reader).
with-shadowed-bindings (macro).

Internals

%add-shadowing (function).
%analyze (function).

Next: Indexes, Previous: Packages, Up: The with-shadowed-bindings 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]

Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Macros

Macro: with-shadowed-bindings (bindings &body body) ¶

Package: with-shadowed-bindings.
Source: main.lisp.

Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]

5.1.2 Ordinary functions

Function: invalid-access (kind name) ¶

Package: with-shadowed-bindings.
Source: main.lisp.

Function: (setf invalid-access) (kind name) ¶

Package: with-shadowed-bindings.
Source: main.lisp.

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

5.1.3 Generic functions

Generic Reader: kind (condition) ¶

Package

with-shadowed-bindings.

Methods

Reader Method: kind ((condition invalid-access)) ¶

Source: main.lisp.
Target Slot: %kind.

Generic Reader: name (condition) ¶

Package

with-shadowed-bindings.

Methods

Reader Method: name ((condition invalid-access)) ¶

Source: main.lisp.
Target Slot: %name.

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

5.1.4 Conditions

Condition: invalid-access ¶

Package

with-shadowed-bindings.

Source

main.lisp.

Direct superclasses

error.

Direct methods

kind.
name.

Direct slots

Slot: %kind ¶

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

Slot: %name ¶

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

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

5.2 Internals

Ordinary functions

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

5.2.1 Ordinary functions

Function: %add-shadowing (body kind name) ¶

Package: with-shadowed-bindings.
Source: main.lisp.

Function: %analyze (binding &optional env) ¶

Package: with-shadowed-bindings.
Source: main.lisp.

Previous: Definitions, Up: The with-shadowed-bindings 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:	% ( F G I K M N W

	Index Entry	Section

%
	`%add-shadowing`:	Private ordinary functions
	`%analyze`:	Private ordinary functions

(
	`(setf invalid-access)`:	Public ordinary functions

F
	`Function, %add-shadowing`:	Private ordinary functions
	`Function, %analyze`:	Private ordinary functions
	`Function, (setf invalid-access)`:	Public ordinary functions
	`Function, invalid-access`:	Public ordinary functions

G
	`Generic Function, kind`:	Public generic functions
	`Generic Function, name`:	Public generic functions

I
	`invalid-access`:	Public ordinary functions

K
	`kind`:	Public generic functions
	`kind`:	Public generic functions

M
	`Macro, with-shadowed-bindings`:	Public macros
	`Method, kind`:	Public generic functions
	`Method, name`:	Public generic functions

N
	`name`:	Public generic functions
	`name`:	Public generic functions

W
	`with-shadowed-bindings`:	Public macros

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

A.3 Variables

Jump to:	% S

	Index Entry	Section

%
	`%kind`:	Public conditions
	`%name`:	Public conditions

S
	`Slot, %kind`:	Public conditions
	`Slot, %name`:	Public conditions

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

A.4 Data types

Jump to:	C F I M P S W

	Index Entry	Section

C
	`Condition, invalid-access`:	Public conditions

F
	`File, main.lisp`:	The with-shadowed-bindings/main․lisp file
	`File, package.lisp`:	The with-shadowed-bindings/package․lisp file
	`File, with-shadowed-bindings.asd`:	The with-shadowed-bindings/with-shadowed-bindings․asd file

I
	`invalid-access`:	Public conditions

M
	`main.lisp`:	The with-shadowed-bindings/main․lisp file

P
	`Package, with-shadowed-bindings`:	The with-shadowed-bindings package
	`package.lisp`:	The with-shadowed-bindings/package․lisp file

S
	`System, with-shadowed-bindings`:	The with-shadowed-bindings system

W
	`with-shadowed-bindings`:	The with-shadowed-bindings system
	`with-shadowed-bindings`:	The with-shadowed-bindings package
	`with-shadowed-bindings.asd`:	The with-shadowed-bindings/with-shadowed-bindings․asd file

The with-shadowed-bindings Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 with-shadowed-bindings

3 Files

3.1 Lisp

3.1.1 with-shadowed-bindings/with-shadowed-bindings.asd

3.1.2 with-shadowed-bindings/package.lisp

3.1.3 with-shadowed-bindings/main.lisp

4 Packages

4.1 with-shadowed-bindings

5 Definitions

5.1 Public Interface

5.1.1 Macros

5.1.2 Ordinary functions

5.1.3 Generic functions

5.1.4 Conditions

5.2 Internals

5.2.1 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `with-shadowed-bindings`

3.1.1 `with-shadowed-bindings/with-shadowed-bindings.asd`

3.1.2 `with-shadowed-bindings/package.lisp`

3.1.3 `with-shadowed-bindings/main.lisp`

4.1 `with-shadowed-bindings`