The magic-ed Reference Manual

This is the magic-ed Reference Manual, version 0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:07:16 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 magic-ed

Edit your code from REPL.

Author

Sanel Zukan. https://github.com/sanel/magic-ed/

License

MIT

Version

0.2

Dependency

sb-introspect (system).

Source

magic-ed.asd.

Child Component

src/magic-ed.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 magic-ed/magic-ed.asd

Source

magic-ed.asd.

Parent Component

magic-ed (system).

ASDF Systems

magic-ed.


3.1.2 magic-ed/src/magic-ed.lisp

Source

magic-ed.asd.

Parent Component

magic-ed (system).

Packages

magic-ed.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 magic-ed

Source

src/magic-ed.lisp.

Use List
  • common-lisp.
  • sb-alien.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: ed-editor (thing)
Package

magic-ed.

Source

src/magic-ed.lisp.

Function: magic-ed (&optional file &key output eval)

Call editor from REPL and depending on options, return to REPL or evaluate the file content in REPL. This function will try to use implmentation specific (ed) function, which will in turn invoke editor set in EDITOR environment variable. Some Common Lisp implementations uses different strategy for setting external editor, so if unsure what they are, make sure to consult your implementation documentation first.

If called without file, this function will invoke editor without file argument.

Supported options are:

:eval (t or nil) - if :eval was set to nil, saved content will not be evaluated
:output (:file or :string) - by default, content will be saved to file; if you want the content to
be returned as escaped string, set ’:output :string’.

Package

magic-ed.

Source

src/magic-ed.lisp.


5.2 Internals


5.2.1 Ordinary functions

Function: namestring-for-editor (editor thing)
Package

magic-ed.

Source

src/magic-ed.lisp.

Function: slurp-file (path)

Slurp file from given path.

Package

magic-ed.

Source

src/magic-ed.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables