The cl-syntax Reference Manual

This is the cl-syntax Reference Manual, version 0.3, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:32:28 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-syntax

Reader Syntax Coventions for Common Lisp and SLIME

Author

Tomohiro Matsuyama

License

LLGPL

Version

0.3

Dependencies
  • trivial-types (system).
  • named-readtables (system).
Source

cl-syntax.asd.

Child Component

src (module).


3 Modules

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


3.1 cl-syntax/src

Source

cl-syntax.asd.

Parent Component

cl-syntax (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 cl-syntax/cl-syntax.asd

Source

cl-syntax.asd.

Parent Component

cl-syntax (system).

ASDF Systems

cl-syntax.

Packages

cl-syntax-asd.


4.1.2 cl-syntax/src/packages.lisp

Source

cl-syntax.asd.

Parent Component

src (module).

Packages

cl-syntax.


4.1.3 cl-syntax/src/specials.lisp

Dependency

packages.lisp (file).

Source

cl-syntax.asd.

Parent Component

src (module).

Internals

*standard-package-syntax-name* (special variable).


4.1.4 cl-syntax/src/types.lisp

Dependency

specials.lisp (file).

Source

cl-syntax.asd.

Parent Component

src (module).

Public Interface

4.1.5 cl-syntax/src/operators.lisp

Dependency

types.lisp (file).

Source

cl-syntax.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 cl-syntax-asd

Source

cl-syntax.asd.

Use List
  • asdf/interface.
  • common-lisp.

5.2 cl-syntax

Source

packages.lisp.

Nickname

syntax

Use List
  • common-lisp.
  • editor-hints.named-readtables.
Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Macros

Macro: define-package-syntax (&body package)
Package

cl-syntax.

Source

operators.lisp.

Macro: defsyntax (name &body options)
Package

cl-syntax.

Source

operators.lisp.

Macro: use-syntax (name)
Package

cl-syntax.

Source

operators.lisp.


6.1.2 Ordinary functions

Function: find-syntax (name)
Package

cl-syntax.

Source

operators.lisp.


6.1.3 Types

Type: syntax ()
Package

cl-syntax.

Source

types.lisp.

Type: syntax-designator ()
Package

cl-syntax.

Source

types.lisp.


6.2 Internals


6.2.1 Special variables

Special Variable: *standard-package-syntax-name*
Package

cl-syntax.

Source

specials.lisp.


6.2.2 Ordinary functions

Function: %use-syntax (names)
Package

cl-syntax.

Source

operators.lisp.

Function: get-options (name)

Get the options list for name, if it is available.

Package

cl-syntax.

Source

operators.lisp.

Function: package-syntax-name (package)
Package

cl-syntax.

Source

operators.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables