Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

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 Sun Dec 15 05:26:06 2024 GMT+0.

Next: Systems, Previous: The cl-syntax Reference Manual, Up: The cl-syntax Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The cl-syntax Reference Manual [Contents][Index]

2 Systems

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

cl-syntax

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

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).

Next: Files, Previous: Systems, Up: The cl-syntax Reference Manual [Contents][Index]

3 Modules

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

cl-syntax/src

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

3.1 `cl-syntax/src`

Source

cl-syntax.asd.

Parent Component

cl-syntax (system).

Child Components

packages.lisp (file).
specials.lisp (file).
types.lisp (file).
operators.lisp (file).

Next: Packages, Previous: Modules, Up: The cl-syntax Reference Manual [Contents][Index]

4 Files

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

Lisp

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

Next: cl-syntax/src/packages.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

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.

Next: cl-syntax/src/specials.lisp, Previous: cl-syntax/cl-syntax.asd, Up: Lisp [Contents][Index]

4.1.2 `cl-syntax/src/packages.lisp`

Source: cl-syntax.asd.
Parent Component: src (module).
Packages: cl-syntax.

Next: cl-syntax/src/types.lisp, Previous: cl-syntax/src/packages.lisp, Up: Lisp [Contents][Index]

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).

Next: cl-syntax/src/operators.lisp, Previous: cl-syntax/src/specials.lisp, Up: Lisp [Contents][Index]

4.1.4 `cl-syntax/src/types.lisp`

Dependency

specials.lisp (file).

Source

cl-syntax.asd.

Parent Component

src (module).

Public Interface

syntax (type).
syntax-designator (type).

Previous: cl-syntax/src/types.lisp, Up: Lisp [Contents][Index]

4.1.5 `cl-syntax/src/operators.lisp`

Dependency

types.lisp (file).

Source

cl-syntax.asd.

Parent Component

src (module).

Public Interface

define-package-syntax (macro).
defsyntax (macro).
find-syntax (function).
use-syntax (macro).

Internals

%use-syntax (function).
get-options (function).
package-syntax-name (function).

Next: Definitions, Previous: Files, Up: The cl-syntax Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

cl-syntax-asd
cl-syntax

Next: cl-syntax, Previous: Packages, Up: Packages [Contents][Index]

5.1 `cl-syntax-asd`

Source

cl-syntax.asd.

Use List

asdf/interface.
common-lisp.

Previous: cl-syntax-asd, Up: Packages [Contents][Index]

5.2 `cl-syntax`

Source

packages.lisp.

Nickname

syntax

Use List

common-lisp.
editor-hints.named-readtables.

Public Interface

define-package-syntax (macro).
defsyntax (macro).
find-syntax (function).
syntax (type).
syntax-designator (type).
use-syntax (macro).

Internals

%use-syntax (function).
*standard-package-syntax-name* (special variable).
get-options (function).
package-syntax-name (function).

Next: Indexes, Previous: Packages, Up: The cl-syntax Reference Manual [Contents][Index]

6 Definitions

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

Public Interface
Internals

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

6.1 Public Interface

Macros
Ordinary functions
Types

Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]

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.

Next: Types, Previous: Macros, Up: Public Interface [Contents][Index]

6.1.2 Ordinary functions

Function: find-syntax (name) ¶

Package: cl-syntax.
Source: operators.lisp.

Previous: Ordinary functions, Up: Public Interface [Contents][Index]

6.1.3 Types

Type: syntax () ¶

Package: cl-syntax.
Source: types.lisp.

Type: syntax-designator () ¶

Package: cl-syntax.
Source: types.lisp.

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

6.2 Internals

Special variables
Ordinary functions

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

6.2.1 Special variables

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

Package: cl-syntax.
Source: specials.lisp.

Previous: Special variables, Up: Internals [Contents][Index]

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.

Previous: Definitions, Up: The cl-syntax Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	% D F G M P U

	Index Entry	Section

%
	`%use-syntax`:	Private ordinary functions

D
	`define-package-syntax`:	Public macros
	`defsyntax`:	Public macros

F
	`find-syntax`:	Public ordinary functions
	`Function, %use-syntax`:	Private ordinary functions
	`Function, find-syntax`:	Public ordinary functions
	`Function, get-options`:	Private ordinary functions
	`Function, package-syntax-name`:	Private ordinary functions

G
	`get-options`:	Private ordinary functions

M
	`Macro, define-package-syntax`:	Public macros
	`Macro, defsyntax`:	Public macros
	`Macro, use-syntax`:	Public macros

P
	`package-syntax-name`:	Private ordinary functions

U
	`use-syntax`:	Public macros

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* S

	Index Entry	Section

*
	`standard-package-syntax-name`:	Private special variables

S
	`Special Variable, standard-package-syntax-name`:	Private special variables

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

A.4 Data types

Jump to:	C F M O P S T

	Index Entry	Section

C
	`cl-syntax`:	The cl-syntax system
	`cl-syntax`:	The cl-syntax package
	`cl-syntax-asd`:	The cl-syntax-asd package
	`cl-syntax.asd`:	The cl-syntax/cl-syntax․asd file

F
	`File, cl-syntax.asd`:	The cl-syntax/cl-syntax․asd file
	`File, operators.lisp`:	The cl-syntax/src/operators․lisp file
	`File, packages.lisp`:	The cl-syntax/src/packages․lisp file
	`File, specials.lisp`:	The cl-syntax/src/specials․lisp file
	`File, types.lisp`:	The cl-syntax/src/types․lisp file

M
	`Module, src`:	The cl-syntax/src module

O
	`operators.lisp`:	The cl-syntax/src/operators․lisp file

P
	`Package, cl-syntax`:	The cl-syntax package
	`Package, cl-syntax-asd`:	The cl-syntax-asd package
	`packages.lisp`:	The cl-syntax/src/packages․lisp file

S
	`specials.lisp`:	The cl-syntax/src/specials․lisp file
	`src`:	The cl-syntax/src module
	`syntax`:	Public types
	`syntax-designator`:	Public types
	`System, cl-syntax`:	The cl-syntax system

T
	`Type, syntax`:	Public types
	`Type, syntax-designator`:	Public types
	`types.lisp`:	The cl-syntax/src/types․lisp file

The cl-syntax Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-syntax

3 Modules

3.1 cl-syntax/src

4 Files

4.1 Lisp

4.1.1 cl-syntax/cl-syntax.asd

4.1.2 cl-syntax/src/packages.lisp

4.1.3 cl-syntax/src/specials.lisp

4.1.4 cl-syntax/src/types.lisp

4.1.5 cl-syntax/src/operators.lisp

5 Packages

5.1 cl-syntax-asd

5.2 cl-syntax

6 Definitions

6.1 Public Interface

6.1.1 Macros

6.1.2 Ordinary functions

6.1.3 Types

6.2 Internals

6.2.1 Special variables

6.2.2 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-syntax`

3.1 `cl-syntax/src`

4.1.1 `cl-syntax/cl-syntax.asd`

4.1.2 `cl-syntax/src/packages.lisp`

4.1.3 `cl-syntax/src/specials.lisp`

4.1.4 `cl-syntax/src/types.lisp`

4.1.5 `cl-syntax/src/operators.lisp`

5.1 `cl-syntax-asd`

5.2 `cl-syntax`