The trivial-ed-functions Reference Manual

Table of Contents

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

The trivial-ed-functions Reference Manual

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


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

1 Introduction

trivial-ed-functions

A compatibility layer for the ED hook extensions of various Common Lisp implementations.

Usage

The main export is trivial-ed-functions:*ed-functions* which is a list of hook functions. If supported by the current lisp implementation then functions from the list trivial-ed-functions:*ed-functions* are called in order by cl:ed with X as an argument until one of them returns non-nil; these functions are responsible for signalling a file-error to indicate failure to perform an operation on the file system.

If the current implementation supports *ed-functions* then :ed-functions will be present in *features*. If the current implementation does not support *ed-functions* then it is still safe to add a function to the list, but this function will never be invoked.

Supported Implementations

Recent versions of ABCL, ACL, CCL, CLASP, ECL, Mezzano, and SBCL all support *ed-functions* in some way. ABCL, CLASP, ECL, and SBCL include native support. ACL, CCL, and Mezzano support a single hook function, not a list of functions. In this case, a hook function is automatically installed that emulates the behavior of *ed-functions*.


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

2 Systems

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


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

2.1 trivial-ed-functions

Author

Tarn W. Burton

Home Page

https://yitzchak.github.io/trivial-ed-functions/

Bug Tracker

https://github.com/yitzchak/trivial-ed-functions/issues

License

MIT

Description

A simple compatibility layer for *ed-functions*

Version

0.1

Source

trivial-ed-functions.asd (file)

Component

lisp (module)


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

3 Modules

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


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

3.1 trivial-ed-functions/lisp

Parent

trivial-ed-functions (system)

Location

lisp/

Components

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

4 Files

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


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

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 trivial-ed-functions.asd

Location

trivial-ed-functions.asd

Systems

trivial-ed-functions (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 trivial-ed-functions/lisp/packages.lisp

Parent

lisp (module)

Location

lisp/packages.lisp

Packages

trivial-ed-functions


Previous: , Up: Lisp files   [Contents][Index]

4.1.3 trivial-ed-functions/lisp/interface.lisp

Dependency

packages.lisp (file)

Parent

lisp (module)

Location

lisp/interface.lisp

Internal Definitions

ed-hook (function)


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

5 Packages

Packages are listed by definition order.


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

5.1 trivial-ed-functions

A simple compatibility layer for *ed-functions*

Source

packages.lisp (file)

Nickname

tef

Use List

common-lisp

Internal Definitions

ed-hook (function)


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

6 Definitions

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


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

6.1 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

6.1.1 Functions

Function: ed-hook &optional X
Package

trivial-ed-functions

Source

interface.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M   T  
Index Entry  Section

F
File, Lisp, trivial-ed-functions.asd: The trivial-ed-functions․asd file
File, Lisp, trivial-ed-functions/lisp/interface.lisp: The trivial-ed-functions/lisp/interface․lisp file
File, Lisp, trivial-ed-functions/lisp/packages.lisp: The trivial-ed-functions/lisp/packages․lisp file

L
Lisp File, trivial-ed-functions.asd: The trivial-ed-functions․asd file
Lisp File, trivial-ed-functions/lisp/interface.lisp: The trivial-ed-functions/lisp/interface․lisp file
Lisp File, trivial-ed-functions/lisp/packages.lisp: The trivial-ed-functions/lisp/packages․lisp file

M
Module, trivial-ed-functions/lisp: The trivial-ed-functions/lisp module

T
trivial-ed-functions.asd: The trivial-ed-functions․asd file
trivial-ed-functions/lisp: The trivial-ed-functions/lisp module
trivial-ed-functions/lisp/interface.lisp: The trivial-ed-functions/lisp/interface․lisp file
trivial-ed-functions/lisp/packages.lisp: The trivial-ed-functions/lisp/packages․lisp file

Jump to:   F   L   M   T  

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

A.2 Functions

Jump to:   E   F  
Index Entry  Section

E
ed-hook: Internal functions

F
Function, ed-hook: Internal functions

Jump to:   E   F  

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

A.3 Variables


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

A.4 Data types

Jump to:   P   S   T  
Index Entry  Section

P
Package, trivial-ed-functions: The trivial-ed-functions package

S
System, trivial-ed-functions: The trivial-ed-functions system

T
trivial-ed-functions: The trivial-ed-functions system
trivial-ed-functions: The trivial-ed-functions package

Jump to:   P   S   T