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

The trivial-indent Reference Manual

This is the trivial-indent Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 18:07:43 2024 GMT+0.

Next: Systems, Previous: The trivial-indent Reference Manual, Up: The trivial-indent Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The trivial-indent Reference Manual [Contents][Index]

2 Systems

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

trivial-indent

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

2.1 `trivial-indent`

A very simple library to allow indentation hints for SWANK.

Maintainer: Yukari Hafner <shinmera@tymoon.eu>
Author: Yukari Hafner <shinmera@tymoon.eu>
Home Page: https://shinmera.github.io/trivial-indent/
Source Control: (GIT https://github.com/Shinmera/trivial-indent.git)
Bug Tracker: https://github.com/Shinmera/trivial-indent/issues
License: zlib
Version: 1.0.0
Source: trivial-indent.asd.
Child Component: indent.lisp (file).

Next: Packages, Previous: Systems, Up: The trivial-indent Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: trivial-indent/indent.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `trivial-indent/trivial-indent.asd`

Source: trivial-indent.asd.
Parent Component: trivial-indent (system).
ASDF Systems: trivial-indent.

Previous: trivial-indent/trivial-indent.asd, Up: Lisp [Contents][Index]

3.1.2 `trivial-indent/indent.lisp`

Source

trivial-indent.asd.

Parent Component

trivial-indent (system).

Packages

trivial-indent.

Public Interface

define-indentation (macro).
indentation (function).
(setf indentation) (function).
initialize-slime (function).
initialize-sly (function).
remove-indentation (function).

Internals

*indentation-hints* (special variable).
with-symbol (macro).

Next: Definitions, Previous: Files, Up: The trivial-indent Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

trivial-indent

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

4.1 `trivial-indent`

Source

indent.lisp.

Nicknames

org.tymoonnext.radiance.lib.trivial-indent
indent

Use List

common-lisp.

Public Interface

define-indentation (macro).
indentation (function).
(setf indentation) (function).
initialize-slime (function).
initialize-sly (function).
remove-indentation (function).

Internals

*indentation-hints* (special variable).
with-symbol (macro).

Next: Indexes, Previous: Packages, Up: The trivial-indent Reference Manual [Contents][Index]

5 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]

5.1 Public Interface

Macros
Ordinary functions

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

5.1.1 Macros

Macro: define-indentation (symbol rule-form) ¶

Define an indentation hint for a symbol.

See the SLIME/SWANK documentation for more information on the rules. Example: (define-indentation defmacro (4 &lambda &body))

Package: trivial-indent.
Source: indent.lisp.

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

5.1.2 Ordinary functions

Function: indentation (symbol) ¶

Returns the custom defined indentation of a symbol if there is any. SETF-able.

Package: trivial-indent.
Source: indent.lisp.

Function: (setf indentation) (symbol) ¶

Sets the indentation hint for a symbol.

Package: trivial-indent.
Source: indent.lisp.

Function: initialize-slime () ¶

Attempts to initialize slime with our indentation table. If SWANK-INDENTATION is not loaded, this does nothing.
It should be safe to call this function regardless of whether SWANK is loaded at all or not.

This is automatically called when TRIVIAL-INDENT is loaded.

Package: trivial-indent.
Source: indent.lisp.

Function: initialize-sly () ¶

Attempts to initialize sly with our indentation table.
If SLYNK/INDENTATION is not loaded, this does nothing.
It should be safe to call this function regardless of whether SLYNK is loaded at all or not.

This is automatically called when TRIVIAL-INDENT is loaded.

Package: trivial-indent.
Source: indent.lisp.

Function: remove-indentation (symbol) ¶

Remove the indentation hint for a symbol.

Package: trivial-indent.
Source: indent.lisp.

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

5.2 Internals

Special variables
Macros

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

5.2.1 Special variables

Special Variable: *indentation-hints* ¶

Package: trivial-indent.
Source: indent.lisp.

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

5.2.2 Macros

Macro: with-symbol ((name symbol package module) &body body) ¶

Check if SYMBOL exists in PACKAGE when MODULE is loaded and bind it to NAME.

Package: trivial-indent.
Source: indent.lisp.

Previous: Definitions, Up: The trivial-indent 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 I M R W

	Index Entry	Section

(
	`(setf indentation)`:	Public ordinary functions

D
	`define-indentation`:	Public macros

F
	`Function, (setf indentation)`:	Public ordinary functions
	`Function, indentation`:	Public ordinary functions
	`Function, initialize-slime`:	Public ordinary functions
	`Function, initialize-sly`:	Public ordinary functions
	`Function, remove-indentation`:	Public ordinary functions

I
	`indentation`:	Public ordinary functions
	`initialize-slime`:	Public ordinary functions
	`initialize-sly`:	Public ordinary functions

M
	`Macro, define-indentation`:	Public macros
	`Macro, with-symbol`:	Private macros

R
	`remove-indentation`:	Public ordinary functions

W
	`with-symbol`:	Private macros

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

A.3 Variables

Jump to:	* S

	Index Entry	Section

*
	`indentation-hints`:	Private special variables

S
	`Special Variable, indentation-hints`:	Private special variables

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

A.4 Data types

Jump to:	F I P S T

	Index Entry	Section

F
	`File, indent.lisp`:	The trivial-indent/indent․lisp file
	`File, trivial-indent.asd`:	The trivial-indent/trivial-indent․asd file

I
	`indent.lisp`:	The trivial-indent/indent․lisp file

P
	`Package, trivial-indent`:	The trivial-indent package

S
	`System, trivial-indent`:	The trivial-indent system

T
	`trivial-indent`:	The trivial-indent system
	`trivial-indent`:	The trivial-indent package
	`trivial-indent.asd`:	The trivial-indent/trivial-indent․asd file