The hu.dwim.defclass-star Reference Manual

This is the hu.dwim.defclass-star Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Mar 25 18:16:33 2020 GMT+0.

1 Introduction

http://dwim.hu/project/hu.dwim.defclass-star

2 Systems

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

2.1 `hu.dwim.defclass-star`

Authors: Tamás Borbély <tomi.borbely@gmail.com>
Attila Lendvai <attila.lendvai@gmail.com>
Levente Mészáros <levente.meszaros@gmail.com>
License: BSD or Bugroff
Description: Simplify class like definitions with defclass* and friends.
Defsystem Dependency: hu.dwim.asdf
Source: hu.dwim.defclass-star.asd (file)
Component: source (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 `hu.dwim.defclass-star/source`

Parent

hu.dwim.defclass-star (system)

Location

source/

Components

package.lisp (file)
duplicates.lisp (file)
defclass-star.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 `hu.dwim.defclass-star.asd`

Location: hu.dwim.defclass-star.asd
Systems: hu.dwim.defclass-star (system)

4.1.2 `hu.dwim.defclass-star/source/package.lisp`

Parent: source (module)
Location: source/package.lisp
Packages: hu.dwim.defclass-star

4.1.3 `hu.dwim.defclass-star/source/duplicates.lisp`

Dependency

package.lisp (file)

Parent

source (module)

Location

source/duplicates.lisp

Internal Definitions

%enable-sharp-boolean-syntax (function)
concatenate-symbol (function)
enable-sharp-boolean-syntax (macro)
fully-qualified-symbol-name (function)
integrated-export (function)
remf-keywords (macro)
remove-keywords (function)
strcat (function)

4.1.4 `hu.dwim.defclass-star/source/defclass-star.lisp`

Dependency

duplicates.lisp (file)

Parent

source (module)

Location

source/defclass-star.lisp

Exported Definitions

*accessor-name-transformer* (special variable)
*allowed-slot-definition-properties* (special variable)
*automatic-accessors-p* (special variable)
*automatic-initargs-p* (special variable)
*initarg-name-transformer* (special variable)
default-accessor-name-transformer (function)
default-initarg-name-transformer (function)
default-slot-definition-transformer (function)
defclass* (macro)
defcondition* (macro)
dwim-accessor-name-transformer (function)
make-name-transformer (macro)

Internal Definitions

*accessor-name-package* (special variable)
*accessor-names* (special variable)
*export-accessor-names-p* (special variable)
*export-class-name-p* (special variable)
*export-slot-names-p* (special variable)
*slot-definition-transformer* (special variable)
*slot-names* (special variable)
*symbols-to-export* (special variable)
build-defclass-like-expansion (function)
extract-options-into-bindings (function)
hu.dwim.defclass-star-style-warning (condition)
process-slot-definition (function)
slot-name-package (function)
style-warn (function)

5 Packages

Packages are listed by definition order.

5.1 `hu.dwim.defclass-star`

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

*accessor-name-transformer* (special variable)
*allowed-slot-definition-properties* (special variable)
*automatic-accessors-p* (special variable)
*automatic-initargs-p* (special variable)
*initarg-name-transformer* (special variable)
default-accessor-name-transformer (function)
default-initarg-name-transformer (function)
default-slot-definition-transformer (function)
defclass* (macro)
defcondition* (macro)
dwim-accessor-name-transformer (function)
make-name-transformer (macro)

Internal Definitions

%enable-sharp-boolean-syntax (function)
*accessor-name-package* (special variable)
*accessor-names* (special variable)
*export-accessor-names-p* (special variable)
*export-class-name-p* (special variable)
*export-slot-names-p* (special variable)
*slot-definition-transformer* (special variable)
*slot-names* (special variable)
*symbols-to-export* (special variable)
build-defclass-like-expansion (function)
concatenate-symbol (function)
enable-sharp-boolean-syntax (macro)
extract-options-into-bindings (function)
fully-qualified-symbol-name (function)
hu.dwim.defclass-star-style-warning (condition)
integrated-export (function)
process-slot-definition (function)
remf-keywords (macro)
remove-keywords (function)
slot-name-package (function)
strcat (function)
style-warn (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *accessor-name-transformer*

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

Special Variable: *allowed-slot-definition-properties*

Holds a list of keywords that are allowed in slot definitions (:accessor and :initarg are implicitly included).

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

Special Variable: *automatic-accessors-p*

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

Special Variable: *automatic-initargs-p*

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

Special Variable: *initarg-name-transformer*

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

6.1.2 Macros

Macro: defclass* NAME SUPERS SLOTS &rest OPTIONS

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

Macro: defcondition* NAME SUPERS SLOTS &rest OPTIONS

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

Macro: make-name-transformer &rest ELEMENTS

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

6.1.3 Functions

Function: default-accessor-name-transformer NAME DEFINITION

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

Function: default-initarg-name-transformer NAME DEFINITION

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

Function: default-slot-definition-transformer SLOT-DEF

Converts illegal (list foo) :type declarations into simple list declarations.

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

Function: dwim-accessor-name-transformer NAME DEFINITION

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *accessor-name-package*

A package, or :slot-name means the home-package of the slot-name symbol and nil means *package*

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

Special Variable: *accessor-names*

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

Special Variable: *export-accessor-names-p*

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

Special Variable: *export-class-name-p*

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

Special Variable: *export-slot-names-p*

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

Special Variable: *slot-definition-transformer*

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

Special Variable: *slot-names*

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

Special Variable: *symbols-to-export*

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

6.2.2 Macros

Macro: enable-sharp-boolean-syntax ()

Copies *readtable* and enables #t and #f readers for t and nil in the copy.

Package: hu.dwim.defclass-star
Source: duplicates.lisp (file)

Macro: remf-keywords PLACE &rest KEYWORDS

Removes the properties identified by KEYWORDS from PLACE.

Package: hu.dwim.defclass-star
Source: duplicates.lisp (file)

6.2.3 Functions

Function: %enable-sharp-boolean-syntax ()

Package: hu.dwim.defclass-star
Source: duplicates.lisp (file)

Function: build-defclass-like-expansion NAME SUPERS SLOTS OPTIONS EXPANSION-BUILDER &key EXPORT-CLASS-NAME EXPORT-ACCESSOR-NAMES EXPORT-SLOT-NAMES

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

Function: concatenate-symbol &rest ARGS

Args are processed as parts of the result symbol with two exceptions except when a package is encountered then it is stored as the target package at intern.

Package: hu.dwim.defclass-star
Source: duplicates.lisp (file)

Function: extract-options-into-bindings OPTIONS

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

Function: fully-qualified-symbol-name SYMBOL &key SEPARATOR

Package: hu.dwim.defclass-star
Source: duplicates.lisp (file)

Function: integrated-export SYMBOL OTHER-PACKAGE

Package: hu.dwim.defclass-star
Source: duplicates.lisp (file)

Function: process-slot-definition DEFINITION

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

Function: remove-keywords PLIST &rest KEYWORDS

Creates a copy of PLIST without the listed KEYWORDS.

Package: hu.dwim.defclass-star
Source: duplicates.lisp (file)

Function: slot-name-package NAME

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

Function: strcat &rest STRING-DESIGNATORS

Package: hu.dwim.defclass-star
Source: duplicates.lisp (file)

Function: style-warn DATUM &rest ARGS

Package: hu.dwim.defclass-star
Source: defclass-star.lisp (file)

6.2.4 Conditions

Condition: hu.dwim.defclass-star-style-warning ()

Package

hu.dwim.defclass-star

Source

defclass-star.lisp (file)

Direct superclasses

style-warning (condition)
simple-condition (condition)

Appendix A Indexes

A.1 Concepts

Jump to:	F H L M

	Index Entry	Section

F
	File, Lisp, `hu.dwim.defclass-star.asd`:	The hu․dwim․defclass-star․asd file
	File, Lisp, `hu.dwim.defclass-star/source/defclass-star.lisp`:	The hu․dwim․defclass-star/source/defclass-star․lisp file
	File, Lisp, `hu.dwim.defclass-star/source/duplicates.lisp`:	The hu․dwim․defclass-star/source/duplicates․lisp file
	File, Lisp, `hu.dwim.defclass-star/source/package.lisp`:	The hu․dwim․defclass-star/source/package․lisp file

H
	`hu.dwim.defclass-star.asd`:	The hu․dwim․defclass-star․asd file
	`hu.dwim.defclass-star/source`:	The hu․dwim․defclass-star/source module
	`hu.dwim.defclass-star/source/defclass-star.lisp`:	The hu․dwim․defclass-star/source/defclass-star․lisp file
	`hu.dwim.defclass-star/source/duplicates.lisp`:	The hu․dwim․defclass-star/source/duplicates․lisp file
	`hu.dwim.defclass-star/source/package.lisp`:	The hu․dwim․defclass-star/source/package․lisp file

L
	Lisp File, `hu.dwim.defclass-star.asd`:	The hu․dwim․defclass-star․asd file
	Lisp File, `hu.dwim.defclass-star/source/defclass-star.lisp`:	The hu․dwim․defclass-star/source/defclass-star․lisp file
	Lisp File, `hu.dwim.defclass-star/source/duplicates.lisp`:	The hu․dwim․defclass-star/source/duplicates․lisp file
	Lisp File, `hu.dwim.defclass-star/source/package.lisp`:	The hu․dwim․defclass-star/source/package․lisp file

M
	Module, `hu.dwim.defclass-star/source`:	The hu․dwim․defclass-star/source module

Jump to:	F H L M

A.2 Functions

Jump to:	% B C D E F I M P R S

	Index Entry	Section

%
	`%enable-sharp-boolean-syntax`:	Internal functions

B
	`build-defclass-like-expansion`:	Internal functions

C
	`concatenate-symbol`:	Internal functions

D
	`default-accessor-name-transformer`:	Exported functions
	`default-initarg-name-transformer`:	Exported functions
	`default-slot-definition-transformer`:	Exported functions
	`defclass*`:	Exported macros
	`defcondition*`:	Exported macros
	`dwim-accessor-name-transformer`:	Exported functions

E
	`enable-sharp-boolean-syntax`:	Internal macros
	`extract-options-into-bindings`:	Internal functions

F
	`fully-qualified-symbol-name`:	Internal functions
	`Function, %enable-sharp-boolean-syntax`:	Internal functions
	`Function, build-defclass-like-expansion`:	Internal functions
	`Function, concatenate-symbol`:	Internal functions
	`Function, default-accessor-name-transformer`:	Exported functions
	`Function, default-initarg-name-transformer`:	Exported functions
	`Function, default-slot-definition-transformer`:	Exported functions
	`Function, dwim-accessor-name-transformer`:	Exported functions
	`Function, extract-options-into-bindings`:	Internal functions
	`Function, fully-qualified-symbol-name`:	Internal functions
	`Function, integrated-export`:	Internal functions
	`Function, process-slot-definition`:	Internal functions
	`Function, remove-keywords`:	Internal functions
	`Function, slot-name-package`:	Internal functions
	`Function, strcat`:	Internal functions
	`Function, style-warn`:	Internal functions

I
	`integrated-export`:	Internal functions

M
	`Macro, defclass*`:	Exported macros
	`Macro, defcondition*`:	Exported macros
	`Macro, enable-sharp-boolean-syntax`:	Internal macros
	`Macro, make-name-transformer`:	Exported macros
	`Macro, remf-keywords`:	Internal macros
	`make-name-transformer`:	Exported macros

P
	`process-slot-definition`:	Internal functions

R
	`remf-keywords`:	Internal macros
	`remove-keywords`:	Internal functions

S
	`slot-name-package`:	Internal functions
	`strcat`:	Internal functions
	`style-warn`:	Internal functions

Jump to:	% B C D E F I M P R S

A.3 Variables

Jump to:	* S

	Index Entry	Section

*
	`accessor-name-package`:	Internal special variables
	`accessor-name-transformer`:	Exported special variables
	`accessor-names`:	Internal special variables
	`allowed-slot-definition-properties`:	Exported special variables
	`automatic-accessors-p`:	Exported special variables
	`automatic-initargs-p`:	Exported special variables
	`export-accessor-names-p`:	Internal special variables
	`export-class-name-p`:	Internal special variables
	`export-slot-names-p`:	Internal special variables
	`initarg-name-transformer`:	Exported special variables
	`slot-definition-transformer`:	Internal special variables
	`slot-names`:	Internal special variables
	`symbols-to-export`:	Internal special variables

S
	`Special Variable, accessor-name-package`:	Internal special variables
	`Special Variable, accessor-name-transformer`:	Exported special variables
	`Special Variable, accessor-names`:	Internal special variables
	`Special Variable, allowed-slot-definition-properties`:	Exported special variables
	`Special Variable, automatic-accessors-p`:	Exported special variables
	`Special Variable, automatic-initargs-p`:	Exported special variables
	`Special Variable, export-accessor-names-p`:	Internal special variables
	`Special Variable, export-class-name-p`:	Internal special variables
	`Special Variable, export-slot-names-p`:	Internal special variables
	`Special Variable, initarg-name-transformer`:	Exported special variables
	`Special Variable, slot-definition-transformer`:	Internal special variables
	`Special Variable, slot-names`:	Internal special variables
	`Special Variable, symbols-to-export`:	Internal special variables

Jump to:	* S

A.4 Data types

Jump to:	C H P S

	Index Entry	Section

C
	`Condition, hu.dwim.defclass-star-style-warning`:	Internal conditions

H
	`hu.dwim.defclass-star`:	The hu․dwim․defclass-star system
	`hu.dwim.defclass-star`:	The hu․dwim․defclass-star package
	`hu.dwim.defclass-star-style-warning`:	Internal conditions

P
	`Package, hu.dwim.defclass-star`:	The hu․dwim․defclass-star package

S
	`System, hu.dwim.defclass-star`:	The hu․dwim․defclass-star system

Jump to:	C H P S

• Introduction		What hu.dwim.defclass-star is all about
• Systems		The systems documentation
• Modules		The modules documentation
• Files		The files documentation
• Packages		The packages documentation
• Definitions		The symbols documentation
• Indexes		Concepts, functions, variables and data types

• The hu.dwim.defclass-star.asd file
• The hu.dwim.defclass-star/source/package.lisp file
• The hu.dwim.defclass-star/source/duplicates.lisp file
• The hu.dwim.defclass-star/source/defclass-star.lisp file

• Internal special variables
• Internal macros
• Internal functions
• Internal conditions

• Concept index
• Function index
• Variable index
• Data type index

• Exported special variables
• Exported macros
• Exported functions

The hu.dwim.defclass-star Reference Manual

Table of Contents

The hu.dwim.defclass-star Reference Manual

1 Introduction

2 Systems

2.1 hu.dwim.defclass-star

3 Modules

3.1 hu.dwim.defclass-star/source

4 Files

4.1 Lisp

4.1.1 hu.dwim.defclass-star.asd

4.1.2 hu.dwim.defclass-star/source/package.lisp

4.1.3 hu.dwim.defclass-star/source/duplicates.lisp

4.1.4 hu.dwim.defclass-star/source/defclass-star.lisp

5 Packages

5.1 hu.dwim.defclass-star

6 Definitions

6.1 Exported definitions

6.1.1 Special variables

6.1.2 Macros

6.1.3 Functions

6.2 Internal definitions

6.2.1 Special variables

6.2.2 Macros

6.2.3 Functions

6.2.4 Conditions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `hu.dwim.defclass-star`

3.1 `hu.dwim.defclass-star/source`

4.1.1 `hu.dwim.defclass-star.asd`

4.1.2 `hu.dwim.defclass-star/source/package.lisp`

4.1.3 `hu.dwim.defclass-star/source/duplicates.lisp`

4.1.4 `hu.dwim.defclass-star/source/defclass-star.lisp`

5.1 `hu.dwim.defclass-star`