The with-shadowed-bindings Reference Manual

Table of Contents

Next: , Previous: , 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 2.4 patchlevel 1 "Will Decker" on Mon Apr 08 15:17:48 2019 GMT+0.


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

1 Introduction

Project's home: https://www.hexstreamsoft.com/libraries/with-shadowed-bindings/


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.


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


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 with-shadowed-bindings

Author

Jean-Philippe Paradis <hexstream@hexstreamsoft.com>

License

Public Domain

Description

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.

Version

1.0

Dependency

map-bind

Source

with-shadowed-bindings.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 with-shadowed-bindings.asd

Location

with-shadowed-bindings.asd

Systems

with-shadowed-bindings (system)


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

3.1.2 with-shadowed-bindings/package.lisp

Parent

with-shadowed-bindings (system)

Location

package.lisp

Packages

with-shadowed-bindings


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

3.1.3 with-shadowed-bindings/main.lisp

Dependency

package.lisp (file)

Parent

with-shadowed-bindings (system)

Location

main.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 with-shadowed-bindings

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 Macros

Macro: with-shadowed-bindings BINDINGS &body BODY
Package

with-shadowed-bindings

Source

main.lisp (file)


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

5.1.2 Functions

Function: invalid-access KIND NAME
Function: (setf invalid-access) NEW KIND NAME
Package

with-shadowed-bindings

Source

main.lisp (file)


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

5.1.3 Generic functions

Generic Function: kind CONDITION
Package

with-shadowed-bindings

Methods
Method: kind (CONDITION invalid-access)
Source

main.lisp (file)

Generic Function: name CONDITION
Package

with-shadowed-bindings

Methods
Method: name (CONDITION invalid-access)
Source

main.lisp (file)


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

5.1.4 Conditions

Condition: invalid-access ()
Package

with-shadowed-bindings

Source

main.lisp (file)

Direct superclasses

error (condition)

Direct methods
Direct slots
Slot: %kind
Initargs

:kind

Readers

kind (generic function)

Slot: %name
Initargs

:name

Readers

name (generic function)


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

5.2 Internal definitions


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

5.2.1 Functions

Function: %add-shadowing BODY KIND NAME
Package

with-shadowed-bindings

Source

main.lisp (file)

Function: %analyze BINDING &optional ENV
Package

with-shadowed-bindings

Source

main.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   W  
Index Entry  Section

F
File, Lisp, with-shadowed-bindings.asd: The with-shadowed-bindings<dot>asd file
File, Lisp, with-shadowed-bindings/main.lisp: The with-shadowed-bindings/main<dot>lisp file
File, Lisp, with-shadowed-bindings/package.lisp: The with-shadowed-bindings/package<dot>lisp file

L
Lisp File, with-shadowed-bindings.asd: The with-shadowed-bindings<dot>asd file
Lisp File, with-shadowed-bindings/main.lisp: The with-shadowed-bindings/main<dot>lisp file
Lisp File, with-shadowed-bindings/package.lisp: The with-shadowed-bindings/package<dot>lisp file

W
with-shadowed-bindings.asd: The with-shadowed-bindings<dot>asd file
with-shadowed-bindings/main.lisp: The with-shadowed-bindings/main<dot>lisp file
with-shadowed-bindings/package.lisp: The with-shadowed-bindings/package<dot>lisp file

Jump to:   F   L   W  

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

A.2 Functions

Jump to:   %   (  
F   G   I   K   M   N   W  
Index Entry  Section

%
%add-shadowing: Internal functions
%analyze: Internal functions

(
(setf invalid-access): Exported functions

F
Function, %add-shadowing: Internal functions
Function, %analyze: Internal functions
Function, (setf invalid-access): Exported functions
Function, invalid-access: Exported functions

G
Generic Function, kind: Exported generic functions
Generic Function, name: Exported generic functions

I
invalid-access: Exported functions

K
kind: Exported generic functions
kind: Exported generic functions

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

N
name: Exported generic functions
name: Exported generic functions

W
with-shadowed-bindings: Exported macros

Jump to:   %   (  
F   G   I   K   M   N   W  

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

A.3 Variables

Jump to:   %  
S  
Index Entry  Section

%
%kind: Exported conditions
%name: Exported conditions

S
Slot, %kind: Exported conditions
Slot, %name: Exported conditions

Jump to:   %  
S  

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

A.4 Data types

Jump to:   C   I   P   S   W  
Index Entry  Section

C
Condition, invalid-access: Exported conditions

I
invalid-access: Exported conditions

P
Package, with-shadowed-bindings: The with-shadowed-bindings package

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

Jump to:   C   I   P   S   W