The trivial-indent Reference Manual

Table of Contents

The trivial-indent Reference Manual

This is the trivial-indent Reference Manual, version 1.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Oct 13 12:49:39 2021 GMT+0.

1 Introduction

About Trivial-Indent

This allows you to define custom indentation hints for your macros if the one recognised by Slime automatically produces unwanted results.

How To

The only feature of this that you will really need to use is DEFINE-INDENTATION.

(define-indentation defmacro (4 &lambda &body))
(define-indentation something-more-complex (4 &rest (&whole 2 0 4 &body)))

For more information on how the indentation rule forms work, please refer to the Slime source and documentation. Otherwise just faffing about until it produces the indentation you need works well too.

2 Systems

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

2.1 trivial-indent

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas 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

Description

A very simple library to allow indentation hints for SWANK.

Version

1.0.0

Source

trivial-indent.asd (file)

Component

indent.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 trivial-indent.asd

Location

trivial-indent.asd

Systems

trivial-indent (system)

3.1.2 trivial-indent/indent.lisp

Parent

trivial-indent (system)

Location

indent.lisp

Packages

trivial-indent

Exported Definitions

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

Internal Definitions

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

4 Packages

Packages are listed by definition order.

4.1 trivial-indent

Source

indent.lisp (file)

Nicknames

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

Use List

common-lisp

Exported Definitions

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

Internal Definitions

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

5 Definitions

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

5.1 Exported definitions

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 (file)

5.1.2 Functions

Function: indentation SYMBOL

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

Package

trivial-indent

Source

indent.lisp (file)

Writer

(setf indentation) (function)

Function: (setf indentation) RULE-FORM SYMBOL

Sets the indentation hint for a symbol.

Package

trivial-indent

Source

indent.lisp (file)

Reader

indentation (function)

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 (file)

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 (file)

Function: remove-indentation SYMBOL

Remove the indentation hint for a symbol.

Package

trivial-indent

Source

indent.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *indentation-hints*

Package

trivial-indent

Source

indent.lisp (file)

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 (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types