The autoexport Reference Manual

Table of Contents

The autoexport Reference Manual

This is the autoexport Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 03:20:46 2022 GMT+0.

1 Introduction

#+author: fami-com (Vladimir Ivanov)
#+title: autoexport

** Intro
   ~autoexport~ is a small macro to export your definitions without any need to add them to your package's ~:export~ section.
   It's especially useful with class definitions as it also automatically exports slots, readers, writers and accessors.

** Example

   #+begin_src lisp
   (ql:quickload :autoexport)
   (defpackage :my-package
     (:use :cl))
   
   (defpackage :other-package
     (:use :cl :autoexport))

   ;; Switch to a package
   (in-package :other-package)
   (pub defun some-func () (format t "Hello, World!"))
   (pub defclass some-class ()
     ((x
       :accessor x
       :initform :x)
      (y
       :accessor y
       :initform :y)))

   ;; Switch to a different package
   (in-package :my-package)
   (other-package:some-func) ; => Hello, World!
                             ; Note a single colon

   (defvar *test-var* (make-instance 'other-package:some-class :x 1 :y 1))

   (slot-value *test-var* 'other-package:x) ; => 1
   (other-package:y *test-var*) ; => 1
   (setf (other-package:y *test-var*) 100) ; => 100
   (other-package:y *test-var*) ; => 100
   #+end_src

2 Systems

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

2.1 autoexport

Author

fami-com

License

BSD-3-Clause

Description

A small library to automatically export definitions

Dependencies

• closer-mop
• alexandria

Source

autoexport.asd (file)

Component

autoexport.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 autoexport.asd

Location

autoexport.asd

Systems

autoexport (system)

Packages

autoexport-system

3.1.2 autoexport/autoexport.lisp

Parent

autoexport (system)

Location

autoexport.lisp

Packages

autoexport

Exported Definitions

pub (macro)

4 Packages

Packages are listed by definition order.

4.1 autoexport-system

Source

autoexport.asd

Use List

• asdf/interface
• common-lisp

4.2 autoexport

Source

autoexport.lisp (file)

Use List

common-lisp

Exported Definitions

pub (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: pub WHAT NAME &body BODY

Package

autoexport

Source

autoexport.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types