The hu.dwim.syntax-sugar Reference Manual

Table of Contents

The hu.dwim.syntax-sugar Reference Manual

This is the hu.dwim.syntax-sugar Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Apr 28 12:02:48 2020 GMT+0.

1 Introduction

http://dwim.hu/project/hu.dwim.syntax-sugar

2 Systems

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

2.1 hu.dwim.syntax-sugar

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

Various syntax extensions.

Defsystem Dependency

hu.dwim.asdf

Dependency

hu.dwim.common

Source

hu.dwim.syntax-sugar.asd (file)

Component

source (module)

3 Modules

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

3.1 hu.dwim.syntax-sugar/source

Parent

hu.dwim.syntax-sugar (system)

Location

source/

Components

• duplicates.lisp (file)
• feature-cond.lisp (file)
• case-preserving.lisp (file)
• number.lisp (file)
• one-liners.lisp (file)
• package.lisp (file)
• quasi-quote.lisp (file)
• readtime-wrapper.lisp (file)
• string-quote.lisp (file)
• syntax-sugar.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.syntax-sugar.asd

Location

hu.dwim.syntax-sugar.asd

Systems

hu.dwim.syntax-sugar (system)

4.1.2 hu.dwim.syntax-sugar/source/duplicates.lisp

Dependency

package.lisp (file)

Parent

source (module)

Location

source/duplicates.lisp

Internal Definitions

• illegal-lambda-list (function)
• illegal-lambda-list (condition)
• lambda-list-of (method)
• (setf lambda-list-of) (method)
• lambda-list-to-funcall-list (function)
• lambda-list-to-lambda-list-with-quoted-defaults (function)
• parse-lambda-list (function)

4.1.3 hu.dwim.syntax-sugar/source/feature-cond.lisp

Dependency

one-liners.lisp (file)

Parent

source (module)

Location

source/feature-cond.lisp

Exported Definitions

• enable-feature-cond-syntax (macro)
• set-feature-cond-syntax-in-readtable (function)
• with-feature-cond-syntax (function)

Internal Definitions

• %read-feture-cond (function)
• process-feature-cond-condition (function)

4.1.4 hu.dwim.syntax-sugar/source/case-preserving.lisp

Dependency

syntax-sugar.lisp (file)

Parent

source (module)

Location

source/case-preserving.lisp

Exported Definitions

• enable-case-preserving-syntax (macro)
• set-case-preserving-syntax-in-readtable (function)
• with-case-preserving-syntax (function)

Internal Definitions

%case-preserving-reader (function)

4.1.5 hu.dwim.syntax-sugar/source/number.lisp

Dependency

syntax-sugar.lisp (file)

Parent

source (module)

Location

source/number.lisp

Exported Definitions

• enable-sharp-number-syntax (macro)
• set-sharp-number-syntax-in-readtable (function)
• with-sharp-number-syntax (function)

Internal Definitions

• *digits* (special variable)
• read-rational (function)
• sharp-number-reader (function)

4.1.6 hu.dwim.syntax-sugar/source/one-liners.lisp

Dependency

syntax-sugar.lisp (file)

Parent

source (module)

Location

source/one-liners.lisp

Exported Definitions

• enable-sharp-boolean-syntax (macro)
• enable-sharp-comment-syntax (macro)
• get-macro-character* (function)
• set-sharp-boolean-syntax-in-readtable (function)
• set-sharp-comment-syntax-in-readtable (function)
• with-sharp-boolean-syntax (function)
• with-sharp-comment-syntax (function)

Internal Definitions

sharp-comment-reader (function)

4.1.7 hu.dwim.syntax-sugar/source/package.lisp

Parent

source (module)

Location

source/package.lisp

Packages

hu.dwim.syntax-sugar

4.1.8 hu.dwim.syntax-sugar/source/quasi-quote.lisp

Dependency

one-liners.lisp (file)

Parent

source (module)

Location

source/quasi-quote.lisp

Exported Definitions

• *quasi-quote-lexical-depth* (special variable)
• *quasi-quote-nesting-level* (special variable)
• enable-quasi-quote-syntax (macro)
• set-quasi-quote-syntax-in-readtable (function)
• with-quasi-quote-syntax (function)

Internal Definitions

• *dispatched-quasi-quote-name* (special variable)
• make-quasi-quote-reader (function)

4.1.9 hu.dwim.syntax-sugar/source/readtime-wrapper.lisp

Dependency

one-liners.lisp (file)

Parent

source (module)

Location

source/readtime-wrapper.lisp

Exported Definitions

• enable-readtime-wrapper-syntax (macro)
• set-readtime-wrapper-syntax-in-readtable (function)
• with-package (function)
• with-preserved-readtable-case (function)
• with-readtable-case (function)
• with-readtime-wrapper-syntax (function)

Internal Definitions

make-readtime-wrapper-reader (function)

4.1.10 hu.dwim.syntax-sugar/source/string-quote.lisp

Dependency

one-liners.lisp (file)

Parent

source (module)

Location

source/string-quote.lisp

Exported Definitions

• enable-string-quote-syntax (macro)
• set-string-quote-syntax-in-readtable (function)
• with-string-quote-syntax (function)

Internal Definitions

%read-quoted-string (function)

4.1.11 hu.dwim.syntax-sugar/source/syntax-sugar.lisp

Dependency

duplicates.lisp (file)

Parent

source (module)

Location

source/syntax-sugar.lisp

Exported Definitions

• *toplevel-readtable* (special variable)
• define-syntax (macro)
• list-readers (function)
• with-local-readtable (macro)
• with-standard-readtable (macro)

5 Packages

Packages are listed by definition order.

5.1 hu.dwim.syntax-sugar

Source

package.lisp (file)

Use List

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

Exported Definitions

• *quasi-quote-lexical-depth* (special variable)
• *quasi-quote-nesting-level* (special variable)
• *toplevel-readtable* (special variable)
• define-syntax (macro)
• enable-case-preserving-syntax (macro)
• enable-feature-cond-syntax (macro)
• enable-quasi-quote-syntax (macro)
• enable-readtime-wrapper-syntax (macro)
• enable-sharp-boolean-syntax (macro)
• enable-sharp-comment-syntax (macro)
• enable-sharp-number-syntax (macro)
• enable-string-quote-syntax (macro)
• get-macro-character* (function)
• list-readers (function)
• set-case-preserving-syntax-in-readtable (function)
• set-feature-cond-syntax-in-readtable (function)
• set-quasi-quote-syntax-in-readtable (function)
• set-readtime-wrapper-syntax-in-readtable (function)
• set-sharp-boolean-syntax-in-readtable (function)
• set-sharp-comment-syntax-in-readtable (function)
• set-sharp-number-syntax-in-readtable (function)
• set-string-quote-syntax-in-readtable (function)
• with-case-preserving-syntax (function)
• with-feature-cond-syntax (function)
• with-local-readtable (macro)
• with-package (function)
• with-preserved-readtable-case (function)
• with-quasi-quote-syntax (function)
• with-readtable-case (function)
• with-readtime-wrapper-syntax (function)
• with-sharp-boolean-syntax (function)
• with-sharp-comment-syntax (function)
• with-sharp-number-syntax (function)
• with-standard-readtable (macro)
• with-string-quote-syntax (function)

Internal Definitions

• %case-preserving-reader (function)
• %read-feture-cond (function)
• %read-quoted-string (function)
• *digits* (special variable)
• *dispatched-quasi-quote-name* (special variable)
• illegal-lambda-list (function)
• illegal-lambda-list (condition)
• lambda-list-of (generic function)
• lambda-list-of (method)
• (setf lambda-list-of) (method)
• (setf lambda-list-of) (generic function)
• lambda-list-to-funcall-list (function)
• lambda-list-to-lambda-list-with-quoted-defaults (function)
• make-quasi-quote-reader (function)
• make-readtime-wrapper-reader (function)
• parse-lambda-list (function)
• process-feature-cond-condition (function)
• read-rational (function)
• sharp-comment-reader (function)
• sharp-number-reader (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: *quasi-quote-lexical-depth*

The absolute level of read-time (lexical) nesting of the quasi-quote readers. It does not decrease at unquotes.

Package

hu.dwim.syntax-sugar

Source

quasi-quote.lisp (file)

Special Variable: *quasi-quote-nesting-level*

The read-time (lexical) nesting level of the quasi-quote readers, decreases when going through unquotes.

Package

hu.dwim.syntax-sugar

Source

quasi-quote.lisp (file)

Special Variable: *toplevel-readtable*

This is bound to the toplevel *readtable* by all the readers in hu.dwim.syntax-sugar. This is useful for example to restore the original readtable-case at random point in the nested readers.

Package

hu.dwim.syntax-sugar

Source

syntax-sugar.lisp (file)

6.1.2 Macros

Macro: define-syntax NAME ARGS &body BODY

Package

hu.dwim.syntax-sugar

Source

syntax-sugar.lisp (file)

Macro: enable-case-preserving-syntax &key (START-CHARACTER START-CHARACTER) (DISPATCH-CHARACTER DISPATCH-CHARACTER) (READTABLE-CASE READTABLE-CASE) (PACKAGES PACKAGES)

Package

hu.dwim.syntax-sugar

Source

case-preserving.lisp (file)

Macro: enable-feature-cond-syntax &key (START-CHARACTER START-CHARACTER) (DISPATCH-CHARACTER DISPATCH-CHARACTER) (END-CHARACTER END-CHARACTER) (READTABLE-CASE READTABLE-CASE)

Just like CL:COND but at read-time, and in the current package (as opposed to the keyword package as with #+/-).

Package

hu.dwim.syntax-sugar

Source

feature-cond.lisp (file)

Macro: enable-quasi-quote-syntax QUASI-QUOTE-WRAPPER UNQUOTE-WRAPPER &key (NESTED-QUASI-QUOTE-WRAPPER NESTED-QUASI-QUOTE-WRAPPER) (START-CHARACTER START-CHARACTER) (DISPATCH-CHARACTER DISPATCH-CHARACTER) (END-CHARACTER END-CHARACTER) (UNQUOTE-CHARACTER UNQUOTE-CHARACTER) (SPLICE-CHARACTER SPLICE-CHARACTER) (DESTRUCTIVE-SPLICE-CHARACTER DESTRUCTIVE-SPLICE-CHARACTER) (DISPATCHED-QUASI-QUOTE-NAME DISPATCHED-QUASI-QUOTE-NAME) (TOPLEVEL-READER-WRAPPER TOPLEVEL-READER-WRAPPER) (UNQUOTE-READTABLE-CASE UNQUOTE-READTABLE-CASE) (BODY-READER BODY-READER) (READTABLE-CASE READTABLE-CASE)

Package

hu.dwim.syntax-sugar

Source

quasi-quote.lisp (file)

Macro: enable-readtime-wrapper-syntax &optional START-CHARACTER END-CHARACTER

A utility read macro for modifying the read table.

The syntax is:

{SPECIFIER ...}

Where SPECIFIER is either a symbol naming a function (available at read time) or a list (SPECIFIER &rest ARGUMENTS). SPECIFIER is applied to ARGUMENTS to produce a function, this is then called and passed another function which reads until the #} character. During the executen of the function *readtable* is bound to a copy of the current read table.

Package

hu.dwim.syntax-sugar

Source

readtime-wrapper.lisp (file)

Macro: enable-sharp-boolean-syntax ()

This syntax reads "#t" as COMMON-LISP:T and "#f" as COMMON-LISP:NIL

Package

hu.dwim.syntax-sugar

Source

one-liners.lisp (file)

Macro: enable-sharp-comment-syntax ()

This syntax allows "#;" to be used to uncomment a whole sexp.

Package

hu.dwim.syntax-sugar

Source

one-liners.lisp (file)

Macro: enable-sharp-number-syntax ()

Package

hu.dwim.syntax-sugar

Source

number.lisp (file)

Macro: enable-string-quote-syntax &key (START-CHARACTER START-CHARACTER) (END-CHARACTER END-CHARACTER) (TRANSFORMER TRANSFORMER)

A simple string quote that unconditionally reads all characters until END-CHARACTER into a string.

Package

hu.dwim.syntax-sugar

Source

string-quote.lisp (file)

Macro: with-local-readtable &body BODY

Rebind a copy of *readtable*.

Package

hu.dwim.syntax-sugar

Source

syntax-sugar.lisp (file)

Macro: with-standard-readtable &body BODY

Rebind a copy of the standard *readtable*.

Package

hu.dwim.syntax-sugar

Source

syntax-sugar.lisp (file)

6.1.3 Functions

Function: get-macro-character* CHAR &optional READTABLE

Just like CL:GET-MACRO-CHARACTER but its second value defaults to T even if there’s no macro fn installed on CHAR.

Package

hu.dwim.syntax-sugar

Source

one-liners.lisp (file)

Function: list-readers &optional *READTABLE*

A very slow utility for REPL use.

Package

hu.dwim.syntax-sugar

Source

syntax-sugar.lisp (file)

Function: set-case-preserving-syntax-in-readtable &key START-CHARACTER DISPATCH-CHARACTER READTABLE-CASE PACKAGES

Package

hu.dwim.syntax-sugar

Source

case-preserving.lisp (file)

Function: set-feature-cond-syntax-in-readtable &key START-CHARACTER DISPATCH-CHARACTER END-CHARACTER READTABLE-CASE

Package

hu.dwim.syntax-sugar

Source

feature-cond.lisp (file)

Function: set-quasi-quote-syntax-in-readtable QUASI-QUOTE-WRAPPER UNQUOTE-WRAPPER &key NESTED-QUASI-QUOTE-WRAPPER START-CHARACTER DISPATCH-CHARACTER END-CHARACTER UNQUOTE-CHARACTER SPLICE-CHARACTER DESTRUCTIVE-SPLICE-CHARACTER DISPATCHED-QUASI-QUOTE-NAME TOPLEVEL-READER-WRAPPER UNQUOTE-READTABLE-CASE BODY-READER READTABLE-CASE

Package

hu.dwim.syntax-sugar

Source

quasi-quote.lisp (file)

Function: set-readtime-wrapper-syntax-in-readtable &optional START-CHARACTER END-CHARACTER

Package

hu.dwim.syntax-sugar

Source

readtime-wrapper.lisp (file)

Function: set-sharp-boolean-syntax-in-readtable ()

Package

hu.dwim.syntax-sugar

Source

one-liners.lisp (file)

Function: set-sharp-comment-syntax-in-readtable ()

Package

hu.dwim.syntax-sugar

Source

one-liners.lisp (file)

Function: set-sharp-number-syntax-in-readtable ()

Package

hu.dwim.syntax-sugar

Source

number.lisp (file)

Function: set-string-quote-syntax-in-readtable &key START-CHARACTER END-CHARACTER TRANSFORMER

Package

hu.dwim.syntax-sugar

Source

string-quote.lisp (file)

Function: with-case-preserving-syntax &key START-CHARACTER DISPATCH-CHARACTER READTABLE-CASE PACKAGES

Package

hu.dwim.syntax-sugar

Source

case-preserving.lisp (file)

Function: with-feature-cond-syntax &key START-CHARACTER DISPATCH-CHARACTER END-CHARACTER READTABLE-CASE

Package

hu.dwim.syntax-sugar

Source

feature-cond.lisp (file)

Function: with-package PACKAGE-NAME

When used as a specifier for the READTIME-WRAPPER syntax, it locally rebinds at read time the current package to PACKAGE-NAME.

For example, this:

{(with-package :common-lisp) t}

Will always read COMMON-LISP:T, no matter what the current package actually is.

Package

hu.dwim.syntax-sugar

Source

readtime-wrapper.lisp (file)

Function: with-preserved-readtable-case ()

See WITH-READTABLE-CASE.

Package

hu.dwim.syntax-sugar

Source

readtime-wrapper.lisp (file)

Function: with-quasi-quote-syntax QUASI-QUOTE-WRAPPER UNQUOTE-WRAPPER &key NESTED-QUASI-QUOTE-WRAPPER START-CHARACTER DISPATCH-CHARACTER END-CHARACTER UNQUOTE-CHARACTER SPLICE-CHARACTER DESTRUCTIVE-SPLICE-CHARACTER DISPATCHED-QUASI-QUOTE-NAME TOPLEVEL-READER-WRAPPER UNQUOTE-READTABLE-CASE BODY-READER READTABLE-CASE

Package

hu.dwim.syntax-sugar

Source

quasi-quote.lisp (file)

Function: with-readtable-case CASE

When used as a specifier for the READTIME-WRAPPER syntax, it changes the readtable-case while reading its body. Behaves as an implicit progn.

Example: {(with-readtable-case :preserve) ’fOo} => |fOo|

Package

hu.dwim.syntax-sugar

Source

readtime-wrapper.lisp (file)

Function: with-readtime-wrapper-syntax &optional START-CHARACTER END-CHARACTER

Package

hu.dwim.syntax-sugar

Source

readtime-wrapper.lisp (file)

Function: with-sharp-boolean-syntax ()

Package

hu.dwim.syntax-sugar

Source

one-liners.lisp (file)

Function: with-sharp-comment-syntax ()

Package

hu.dwim.syntax-sugar

Source

one-liners.lisp (file)

Function: with-sharp-number-syntax ()

Package

hu.dwim.syntax-sugar

Source

number.lisp (file)

Function: with-string-quote-syntax &key START-CHARACTER END-CHARACTER TRANSFORMER

Package

hu.dwim.syntax-sugar

Source

string-quote.lisp (file)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *digits*

Package

hu.dwim.syntax-sugar

Source

number.lisp (file)

Special Variable: *dispatched-quasi-quote-name*

Package

hu.dwim.syntax-sugar

Source

quasi-quote.lisp (file)

6.2.2 Functions

Function: %case-preserving-reader STREAM READTABLE-CASE PACKAGES

Package

hu.dwim.syntax-sugar

Source

case-preserving.lisp (file)

Function: %read-feture-cond *STANDARD-INPUT* END-CHARACTER READTABLE-CASE

Package

hu.dwim.syntax-sugar

Source

feature-cond.lisp (file)

Function: %read-quoted-string STREAM END-CHARACTER TRANSFORMER

Package

hu.dwim.syntax-sugar

Source

string-quote.lisp (file)

Function: illegal-lambda-list LAMBDA-LIST

Package

hu.dwim.syntax-sugar

Source

duplicates.lisp (file)

Function: lambda-list-to-funcall-list ARGS

Package

hu.dwim.syntax-sugar

Source

duplicates.lisp (file)

Function: lambda-list-to-lambda-list-with-quoted-defaults ARGS

Package

hu.dwim.syntax-sugar

Source

duplicates.lisp (file)

Function: make-quasi-quote-reader DISPATCHED-QUASI-QUOTE-NAME PREVIOUS-READER-ON-BACKTICK START-CHARACTER END-CHARACTER QUASI-QUOTE-WRAPPER NESTED-QUASI-QUOTE-WRAPPER UNQUOTE-CHARACTER UNQUOTE-WRAPPER SPLICE-CHARACTER DESTRUCTIVE-SPLICE-CHARACTER TOPLEVEL-READER-WRAPPER BODY-READER READTABLE-CASE UNQUOTE-READTABLE-CASE

Package

hu.dwim.syntax-sugar

Source

quasi-quote.lisp (file)

Function: make-readtime-wrapper-reader END-CHARACTER

Package

hu.dwim.syntax-sugar

Source

readtime-wrapper.lisp (file)

Function: parse-lambda-list LAMBDA-LIST VISITOR &key MACRO

Package

hu.dwim.syntax-sugar

Source

duplicates.lisp (file)

Function: process-feature-cond-condition INPUT-FORM

Package

hu.dwim.syntax-sugar

Source

feature-cond.lisp (file)

Function: read-rational STREAM

read all decimals as rationals

Package

hu.dwim.syntax-sugar

Source

number.lisp (file)

Function: sharp-comment-reader S C N

Package

hu.dwim.syntax-sugar

Source

one-liners.lisp (file)

Function: sharp-number-reader STREAM C N

Package

hu.dwim.syntax-sugar

Source

number.lisp (file)

6.2.3 Generic functions

Generic Function: lambda-list-of CONDITION

Generic Function: (setf lambda-list-of) NEW-VALUE CONDITION

Package

hu.dwim.syntax-sugar

Methods

Method: lambda-list-of (CONDITION illegal-lambda-list)

Method: (setf lambda-list-of) NEW-VALUE (CONDITION illegal-lambda-list)

Source

duplicates.lisp (file)

6.2.4 Conditions

Condition: illegal-lambda-list ()

Package

hu.dwim.syntax-sugar

Source

duplicates.lisp (file)

Direct superclasses

error (condition)

Direct methods

• lambda-list-of (method)
• lambda-list-of (method)

Direct slots

Slot: lambda-list

Initargs

:lambda-list

Readers

lambda-list-of (generic function)

Writers

(setf lambda-list-of) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types