The trivial-indent Reference Manual

Next: , Previous: , 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 Wed Jun 15 06:01:18 2022 GMT+0.

Table of Contents


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.


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

2.1 trivial-indent

A very simple library to allow indentation hints for SWANK.

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

Version

1.0.0

Source

trivial-indent.asd.

Child Component

indent.lisp (file).


3 Files

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


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

3.1 Lisp


Next: , Previous: , 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.


3.1.2 trivial-indent/indent.lisp

Source

trivial-indent.asd.

Parent Component

trivial-indent (system).

Packages

trivial-indent.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


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

4.1 trivial-indent

Source

indent.lisp.

Nicknames
  • indent
  • org.tymoonnext.radiance.lib.trivial-indent
Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


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

5.1 Public Interface


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: , 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.


5.2 Internals


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

5.2.1 Special variables

Special Variable: *indentation-hints*
Package

trivial-indent.

Source

indent.lisp.


Previous: , 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.


Appendix A Indexes


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

A.1 Concepts


Next: , Previous: , 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

Jump to:   *  
S