The hu.dwim.def Reference Manual

Table of Contents

The hu.dwim.def Reference Manual

This is the hu.dwim.def Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Feb 19 20:41:59 2020 GMT+0.

1 Introduction

http://dwim.hu/project/hu.dwim.def

2 Systems

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

2.1 hu.dwim.def

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

General purpose, homogenous, extensible definer macro.

Defsystem Dependency

hu.dwim.asdf

Dependencies

• alexandria
• anaphora
• iterate
• metabang-bind

Source

hu.dwim.def.asd (file)

Component

source (module)

3 Modules

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

3.1 hu.dwim.def/source

Parent

hu.dwim.def (system)

Location

source/

Components

• infrastructure.lisp (file)
• definers.lisp (file)
• definers-early.lisp (file)
• duplicates.lisp (file)
• extended-package.lisp (file)
• iterator.lisp (file)
• namespace.lisp (file)
• package.lisp (file)
• with-macro.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.def.asd

Location

hu.dwim.def.asd

Systems

hu.dwim.def (system)

4.1.2 hu.dwim.def/source/infrastructure.lisp

Dependency

duplicates.lisp (file)

Parent

source (module)

Location

source/infrastructure.lisp

Exported Definitions

• def (macro)
• definer (class)
• find-definer (function)
• (setf find-definer) (function)
• with-standard-definer-options (macro)

Internal Definitions

• *definers* (special variable)
• available-flags-of (method)
• (setf available-flags-of) (method)
• defined-at-compile-time? (method)
• (setf defined-at-compile-time?) (method)
• definer-name (type)
• documentation-of (method)
• (setf documentation-of) (method)
• expander-of (method)
• (setf expander-of) (method)
• make-definer (function)
• name-of (method)
• (setf name-of) (method)
• parse-definer-name-and-options (function)
• warn-redefining-definer (function)

4.1.3 hu.dwim.def/source/definers.lisp

Dependency

definers-early.lisp (file)

Parent

source (module)

Location

source/definers.lisp

Internal Definitions

• %reevaluate-constant (function)
• with-class-definer-options (macro)

4.1.4 hu.dwim.def/source/definers-early.lisp

Dependency

infrastructure.lisp (file)

Parent

source (module)

Location

source/definers-early.lisp

Exported Definitions

function-like-definer-declarations (function)

Internal Definitions

• %defmethods-like-definer (function)
• %function-like-definer (function)
• defmethods-like-definer (macro)
• find-function-definer-option-transformer (function)
• function-like-definer (macro)
• normalize-debug-level (function)
• transform-function-definer-options (function)

4.1.5 hu.dwim.def/source/duplicates.lisp

Dependency

package.lisp (file)

Parent

source (module)

Location

source/duplicates.lisp

Internal Definitions

• defprint-object (macro)
• integrated-export (function)
• make-lock (function)
• print-symbol-with-prefix (function)
• with-lock (macro)

4.1.6 hu.dwim.def/source/extended-package.lisp

Dependency

namespace.lisp (file)

Parent

source (module)

Location

source/extended-package.lisp

Exported Definitions

• find-extended-package (function)
• (setf find-extended-package) (function)
• setup-readtable/same-as-package (function)

Internal Definitions

• %define-extended-package (function)
• *extended-package-definition-hooks* (special variable)
• call-extended-package-definition-hooks (function)
• ensure-global-package-nickname (function)
• extended-options-of (method)
• (setf extended-options-of) (method)
• extended-package (class)
• name-of (method)
• (setf name-of) (method)
• readtable-setup-form-of (method)
• (setf readtable-setup-form-of) (method)
• (setf readtable-setup-form-of) (method)
• standard-options-of (method)
• (setf standard-options-of) (method)
• supports-local-package-nicknames? (function)

4.1.7 hu.dwim.def/source/iterator.lisp

Dependencies

• definers.lisp (file)
• with-macro.lisp (file)

Parent

source (module)

Location

source/iterator.lisp

4.1.8 hu.dwim.def/source/namespace.lisp

Dependencies

• definers.lisp (file)
• with-macro.lisp (file)

Parent

source (module)

Location

source/namespace.lisp

Exported Definitions

• collect-namespace-names (function)
• collect-namespace-values (function)
• do-all-namespaces (macro)
• do-namespace (macro)
• find-namespace (function)
• (setf find-namespace) (function)
• iterate-namespace (function)
• namespace (class)

Internal Definitions

• %namespace-getter (function)
• %namespace-setter (function)
• call-with-lock-held-on-namespace (function)
• ensure-namespace (function)
• entries-of (method)
• (setf entries-of) (method)
• handle-otherwise/value (function)
• lock-of (method)
• (setf lock-of) (method)
• make-namespace-hash-table (function)
• make-namespace-lock (function)
• name-of (method)
• (setf name-of) (method)
• with-lock-held-on-namespace (macro)

4.1.9 hu.dwim.def/source/package.lisp

Parent

source (module)

Location

source/package.lisp

Packages

hu.dwim.def

4.1.10 hu.dwim.def/source/with-macro.lisp

Dependency

definers.lisp (file)

Parent

source (module)

Location

source/with-macro.lisp

Internal Definitions

• compute-arguments-for-function-bridge-macro (function)
• expand-with-macro (function)
• expand-with-macro/process-body (function)

5 Packages

Packages are listed by definition order.

5.1 hu.dwim.def

Source

package.lisp (file)

Use List

• metabang.bind
• iterate
• hu.dwim.asdf
• common-lisp
• anaphora
• alexandria.1.0.0

Exported Definitions

• collect-namespace-names (function)
• collect-namespace-values (function)
• def (macro)
• definer (class)
• do-all-namespaces (macro)
• do-namespace (macro)
• find-definer (function)
• (setf find-definer) (function)
• find-extended-package (function)
• (setf find-extended-package) (function)
• find-namespace (function)
• (setf find-namespace) (function)
• function-like-definer-declarations (function)
• iterate-namespace (function)
• namespace (class)
• setup-readtable/same-as-package (function)
• with-standard-definer-options (macro)

Internal Definitions

• %define-extended-package (function)
• %defmethods-like-definer (function)
• %function-like-definer (function)
• %namespace-getter (function)
• %namespace-setter (function)
• %reevaluate-constant (function)
• *definers* (special variable)
• *extended-package-definition-hooks* (special variable)
• available-flags-of (generic function)
• available-flags-of (method)
• (setf available-flags-of) (method)
• (setf available-flags-of) (generic function)
• call-extended-package-definition-hooks (function)
• call-with-lock-held-on-namespace (function)
• compute-arguments-for-function-bridge-macro (function)
• defined-at-compile-time? (generic function)
• defined-at-compile-time? (method)
• (setf defined-at-compile-time?) (method)
• (setf defined-at-compile-time?) (generic function)
• definer-name (type)
• defmethods-like-definer (macro)
• defprint-object (macro)
• documentation-of (generic function)
• documentation-of (method)
• (setf documentation-of) (method)
• (setf documentation-of) (generic function)
• ensure-global-package-nickname (function)
• ensure-namespace (function)
• entries-of (generic function)
• entries-of (method)
• (setf entries-of) (method)
• (setf entries-of) (generic function)
• expand-with-macro (function)
• expand-with-macro/process-body (function)
• expander-of (generic function)
• expander-of (method)
• (setf expander-of) (method)
• (setf expander-of) (generic function)
• extended-options-of (generic function)
• extended-options-of (method)
• (setf extended-options-of) (method)
• (setf extended-options-of) (generic function)
• extended-package (class)
• find-function-definer-option-transformer (function)
• function-like-definer (macro)
• handle-otherwise/value (function)
• integrated-export (function)
• lock-of (generic function)
• lock-of (method)
• (setf lock-of) (method)
• (setf lock-of) (generic function)
• make-definer (function)
• make-lock (function)
• make-namespace-hash-table (function)
• make-namespace-lock (function)
• name-of (generic function)
• name-of (method)
• (setf name-of) (method)
• name-of (method)
• (setf name-of) (method)
• name-of (method)
• (setf name-of) (method)
• (setf name-of) (generic function)
• normalize-debug-level (function)
• parse-definer-name-and-options (function)
• print-symbol-with-prefix (function)
• readtable-setup-form-of (generic function)
• readtable-setup-form-of (method)
• (setf readtable-setup-form-of) (method)
• (setf readtable-setup-form-of) (generic function)
• (setf readtable-setup-form-of) (method)
• standard-options-of (generic function)
• standard-options-of (method)
• (setf standard-options-of) (method)
• (setf standard-options-of) (generic function)
• supports-local-package-nicknames? (function)
• transform-function-definer-options (function)
• warn-redefining-definer (function)
• with-class-definer-options (macro)
• with-lock (macro)
• with-lock-held-on-namespace (macro)

6 Definitions

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

6.1 Exported definitions

6.1.1 Macros

Macro: def NAME &rest REST

Package

hu.dwim.def

Source

infrastructure.lisp (file)

Macro: do-all-namespaces (VALUE-VAR &optional RETURN-VALUE) &body BODY

Package

hu.dwim.def

Source

namespace.lisp (file)

Macro: do-namespace (NAMESPACE KEY-VAR &optional VALUE-VAR RETURN-VALUE) &body BODY

Package

hu.dwim.def

Source

namespace.lisp (file)

Macro: with-standard-definer-options NAME &body BODY

Package

hu.dwim.def

Source

infrastructure.lisp (file)

6.1.2 Functions

Function: collect-namespace-names NAMESPACE

Package

hu.dwim.def

Source

namespace.lisp (file)

Function: collect-namespace-values NAMESPACE

Package

hu.dwim.def

Source

namespace.lisp (file)

Function: find-definer NAME &optional ERRORP

Function: (setf find-definer) NEW-VALUE NAME &key IF-EXISTS

Package

hu.dwim.def

Source

infrastructure.lisp (file)

Function: find-extended-package NAME &key OTHERWISE

Function: (setf find-extended-package) VALUE NAME

Package

hu.dwim.def

Source

extended-package.lisp (file)

Function: find-namespace NAME &key OTHERWISE

Function: (setf find-namespace) VALUE NAME

Package

hu.dwim.def

Source

namespace.lisp (file)

Function: function-like-definer-declarations -OPTIONS-

Package

hu.dwim.def

Source

definers-early.lisp (file)

Function: iterate-namespace NAMESPACE VISITOR

Package

hu.dwim.def

Source

namespace.lisp (file)

Function: setup-readtable/same-as-package PACKAGE-NAME

Package

hu.dwim.def

Source

extended-package.lisp (file)

6.1.3 Classes

Class: definer ()

Package

hu.dwim.def

Source

infrastructure.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• initialize-instance (method)
• print-object (method)
• defined-at-compile-time? (method)
• defined-at-compile-time? (method)
• available-flags-of (method)
• available-flags-of (method)
• documentation-of (method)
• documentation-of (method)
• expander-of (method)
• expander-of (method)
• name-of (method)
• name-of (method)

Direct slots

Slot: name

Initargs

:name

Readers

name-of (generic function)

Writers

(setf name-of) (generic function)

Slot: expander

Initargs

:expander

Readers

expander-of (generic function)

Writers

(setf expander-of) (generic function)

Slot: documentation

Initargs

:documentation

Readers

documentation-of (generic function)

Writers

(setf documentation-of) (generic function)

Slot: available-flags

Initargs

:available-flags

Readers

available-flags-of (generic function)

Writers

(setf available-flags-of) (generic function)

Slot: defined-at-compile-time

Type

boolean

Readers

defined-at-compile-time? (generic function)

Writers

(setf defined-at-compile-time?) (generic function)

Class: namespace ()

Package

hu.dwim.def

Source

namespace.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• print-object (method)
• entries-of (method)
• entries-of (method)
• lock-of (method)
• lock-of (method)
• name-of (method)
• name-of (method)

Direct slots

Slot: name

Type

symbol

Initargs

:name

Readers

name-of (generic function)

Writers

(setf name-of) (generic function)

Slot: lock

Initargs

:lock

Readers

lock-of (generic function)

Writers

(setf lock-of) (generic function)

Slot: entries

Initargs

:entries

Readers

entries-of (generic function)

Writers

(setf entries-of) (generic function)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *definers*

Package

hu.dwim.def

Source

infrastructure.lisp (file)

Special Variable: *extended-package-definition-hooks*

Package

hu.dwim.def

Source

extended-package.lisp (file)

6.2.2 Macros

Macro: defmethods-like-definer DEFINER-MACRO-NAME

Package

hu.dwim.def

Source

definers-early.lisp (file)

Macro: defprint-object (SELF CLASS-NAME &key IDENTITY TYPE WITH-PACKAGE MUFFLE-ERRORS) &body BODY

Define a print-object method using print-unreadable-object. An example:
(defprint-object (self parenscript-dispatcher)
(when (cachep self)
(princ "cached")
(princ " "))
(princ (parenscript-file self)))

Package

hu.dwim.def

Source

duplicates.lisp (file)

Macro: function-like-definer DEFINER-MACRO-NAME &key ALLOW-COMPOUND-NAME METHOD? SIMPLE?

Package

hu.dwim.def

Source

definers-early.lisp (file)

Macro: with-class-definer-options NAME SLOTS &body BODY

Package

hu.dwim.def

Source

definers.lisp (file)

Macro: with-lock LOCK &body BODY

Package

hu.dwim.def

Source

duplicates.lisp (file)

Macro: with-lock-held-on-namespace NAMESPACE &body WITH-BODY1

Package

hu.dwim.def

Source

namespace.lisp (file)

6.2.3 Functions

Function: %define-extended-package NAME READTABLE-SETUP-FORM STANDARD-OPTIONS EXTENDED-OPTIONS

Package

hu.dwim.def

Source

extended-package.lisp (file)

Function: %defmethods-like-definer DEFINER-MACRO-NAME -WHOLE- -OPTIONS-

Package

hu.dwim.def

Source

definers-early.lisp (file)

Function: %function-like-definer DEFINER-MACRO-NAME &key WHOLE OPTIONS ALLOW-COMPOUND-NAME METHOD? SIMPLE?

Package

hu.dwim.def

Source

definers-early.lisp (file)

Function: %namespace-getter NAMESPACE-NAME NAME OTHERWISE OTHERWISE?

Package

hu.dwim.def

Source

namespace.lisp (file)

Function: %namespace-setter NAMESPACE-NAME NAME VALUE

Package

hu.dwim.def

Source

namespace.lisp (file)

Function: %reevaluate-constant NAME VALUE &key TEST

Package

hu.dwim.def

Source

definers.lisp (file)

Function: call-extended-package-definition-hooks EXTENDED-PACKAGE

Package

hu.dwim.def

Source

extended-package.lisp (file)

Function: call-with-lock-held-on-namespace FN0 NAMESPACE

Package

hu.dwim.def

Source

namespace.lisp (file)

Function: compute-arguments-for-function-bridge-macro ARGS &optional BODY-INVOCATION-ARGUMENTS MACRO-ONLY-ARGUMENTS

Package

hu.dwim.def

Source

with-macro.lisp (file)

Function: ensure-global-package-nickname NICKNAME PACKAGE

Package

hu.dwim.def

Source

extended-package.lisp (file)

Function: ensure-namespace NAMESPACE &key OTHERWISE

Package

hu.dwim.def

Source

namespace.lisp (file)

Function: expand-with-macro NAME ARGS BODY -OPTIONS- FLAT? MUST-HAVE-ARGS?

Package

hu.dwim.def

Source

with-macro.lisp (file)

Function: expand-with-macro/process-body BODY-FORM

Package

hu.dwim.def

Source

with-macro.lisp (file)

Function: find-function-definer-option-transformer NAME

Package

hu.dwim.def

Source

definers-early.lisp (file)

Function: handle-otherwise/value OTHERWISE &key DEFAULT-MESSAGE

Package

hu.dwim.def

Source

namespace.lisp (file)

Function: integrated-export SYMBOL OTHER-PACKAGE

Export SYMBOL from both its own package and OTHER-PACKAGE

Package

hu.dwim.def

Source

duplicates.lisp (file)

Function: make-definer NAME EXPANDER &rest INITARGS

Package

hu.dwim.def

Source

infrastructure.lisp (file)

Function: make-lock &key NAME

Package

hu.dwim.def

Source

duplicates.lisp (file)

Function: make-namespace-hash-table TEST-FUNCTION WEAKNESS

Package

hu.dwim.def

Source

namespace.lisp (file)

Function: make-namespace-lock NAMESPACE-NAME

Package

hu.dwim.def

Source

namespace.lisp (file)

Function: normalize-debug-level LEVEL

Package

hu.dwim.def

Source

definers-early.lisp (file)

Function: parse-definer-name-and-options WHOLE &optional DEFINER

Package

hu.dwim.def

Source

infrastructure.lisp (file)

Function: print-symbol-with-prefix STREAM SYMBOL &optional COLON AT

Package

hu.dwim.def

Source

duplicates.lisp (file)

Function: supports-local-package-nicknames? ()

Package

hu.dwim.def

Source

extended-package.lisp (file)

Function: transform-function-definer-options OPTIONS

Package

hu.dwim.def

Source

definers-early.lisp (file)

Function: warn-redefining-definer NAME

Package

hu.dwim.def

Source

infrastructure.lisp (file)

6.2.4 Generic functions

Generic Function: available-flags-of OBJECT

Generic Function: (setf available-flags-of) NEW-VALUE OBJECT

Package

hu.dwim.def

Methods

Method: available-flags-of (DEFINER definer)

automatically generated reader method

Source

infrastructure.lisp (file)

Method: (setf available-flags-of) NEW-VALUE (DEFINER definer)

automatically generated writer method

Source

infrastructure.lisp (file)

Generic Function: defined-at-compile-time? OBJECT

Generic Function: (setf defined-at-compile-time?) NEW-VALUE OBJECT

Package

hu.dwim.def

Methods

Method: defined-at-compile-time? (DEFINER definer)

automatically generated reader method

Source

infrastructure.lisp (file)

Method: (setf defined-at-compile-time?) NEW-VALUE (DEFINER definer)

automatically generated writer method

Source

infrastructure.lisp (file)

Generic Function: documentation-of OBJECT

Generic Function: (setf documentation-of) NEW-VALUE OBJECT

Package

hu.dwim.def

Methods

Method: documentation-of (DEFINER definer)

automatically generated reader method

Source

infrastructure.lisp (file)

Method: (setf documentation-of) NEW-VALUE (DEFINER definer)

automatically generated writer method

Source

infrastructure.lisp (file)

Generic Function: entries-of OBJECT

Generic Function: (setf entries-of) NEW-VALUE OBJECT

Package

hu.dwim.def

Methods

Method: entries-of (NAMESPACE namespace)

automatically generated reader method

Source

namespace.lisp (file)

Method: (setf entries-of) NEW-VALUE (NAMESPACE namespace)

automatically generated writer method

Source

namespace.lisp (file)

Generic Function: expander-of OBJECT

Generic Function: (setf expander-of) NEW-VALUE OBJECT

Package

hu.dwim.def

Methods

Method: expander-of (DEFINER definer)

automatically generated reader method

Source

infrastructure.lisp (file)

Method: (setf expander-of) NEW-VALUE (DEFINER definer)

automatically generated writer method

Source

infrastructure.lisp (file)

Generic Function: extended-options-of OBJECT

Generic Function: (setf extended-options-of) NEW-VALUE OBJECT

Package

hu.dwim.def

Methods

Method: extended-options-of (EXTENDED-PACKAGE extended-package)

automatically generated reader method

Source

extended-package.lisp (file)

Method: (setf extended-options-of) NEW-VALUE (EXTENDED-PACKAGE extended-package)

automatically generated writer method

Source

extended-package.lisp (file)

Generic Function: lock-of OBJECT

Generic Function: (setf lock-of) NEW-VALUE OBJECT

Package

hu.dwim.def

Methods

Method: lock-of (NAMESPACE namespace)

automatically generated reader method

Source

namespace.lisp (file)

Method: (setf lock-of) NEW-VALUE (NAMESPACE namespace)

automatically generated writer method

Source

namespace.lisp (file)

Generic Function: name-of OBJECT

Generic Function: (setf name-of) NEW-VALUE OBJECT

Package

hu.dwim.def

Methods

Method: name-of (EXTENDED-PACKAGE extended-package)

automatically generated reader method

Source

extended-package.lisp (file)

Method: (setf name-of) NEW-VALUE (EXTENDED-PACKAGE extended-package)

automatically generated writer method

Source

extended-package.lisp (file)

Method: name-of (NAMESPACE namespace)

automatically generated reader method

Source

namespace.lisp (file)

Method: (setf name-of) NEW-VALUE (NAMESPACE namespace)

automatically generated writer method

Source

namespace.lisp (file)

Method: name-of (DEFINER definer)

automatically generated reader method

Source

infrastructure.lisp (file)

Method: (setf name-of) NEW-VALUE (DEFINER definer)

automatically generated writer method

Source

infrastructure.lisp (file)

Generic Function: readtable-setup-form-of OBJECT

Generic Function: (setf readtable-setup-form-of) NEW-VALUE OBJECT

Package

hu.dwim.def

Methods

Method: readtable-setup-form-of (EXTENDED-PACKAGE extended-package)

automatically generated reader method

Source

extended-package.lisp (file)

Method: (setf readtable-setup-form-of) NEW-VALUE (EXTENDED-PACKAGE extended-package)

automatically generated writer method

Source

extended-package.lisp (file)

Method: (setf readtable-setup-form-of) NEW-VALUE (EXTENDED-PACKAGE extended-package) after

Source

extended-package.lisp (file)

Generic Function: standard-options-of OBJECT

Generic Function: (setf standard-options-of) NEW-VALUE OBJECT

Package

hu.dwim.def

Methods

Method: standard-options-of (EXTENDED-PACKAGE extended-package)

automatically generated reader method

Source

extended-package.lisp (file)

Method: (setf standard-options-of) NEW-VALUE (EXTENDED-PACKAGE extended-package)

automatically generated writer method

Source

extended-package.lisp (file)

6.2.5 Classes

Class: extended-package ()

Package

hu.dwim.def

Source

extended-package.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• (setf readtable-setup-form-of) (method)
• print-object (method)
• readtable-setup-form-of (method)
• readtable-setup-form-of (method)
• extended-options-of (method)
• extended-options-of (method)
• standard-options-of (method)
• standard-options-of (method)
• name-of (method)
• name-of (method)

Direct slots

Slot: name

Initargs

:name

Readers

name-of (generic function)

Writers

(setf name-of) (generic function)

Slot: standard-options

Initargs

:standard-options

Readers

standard-options-of (generic function)

Writers

(setf standard-options-of) (generic function)

Slot: extended-options

Initargs

:extended-options

Readers

extended-options-of (generic function)

Writers

(setf extended-options-of) (generic function)

Slot: readtable-setup-form

Initargs

:readtable-setup-form

Readers

readtable-setup-form-of (generic function)

Writers

(setf readtable-setup-form-of) (generic function)

6.2.6 Types

Type: definer-name ()

Package

hu.dwim.def

Source

infrastructure.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types