The autoexport Reference Manual

Table of Contents

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

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.


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

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


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 autoexport

Author

fami-com

License

BSD-3-Clause

Description

A small library to automatically export definitions

Dependencies
Source

autoexport.asd (file)

Component

autoexport.lisp (file)


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

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 files   [Contents][Index]

3.1.1 autoexport.asd

Location

autoexport.asd

Systems

autoexport (system)

Packages

autoexport-system


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

3.1.2 autoexport/autoexport.lisp

Parent

autoexport (system)

Location

autoexport.lisp

Packages

autoexport

Exported Definitions

pub (macro)


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

4 Packages

Packages are listed by definition order.


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

4.1 autoexport-system

Source

autoexport.asd

Use List

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

4.2 autoexport

Source

autoexport.lisp (file)

Use List

common-lisp

Exported Definitions

pub (macro)


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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Macros

Macro: pub WHAT NAME &body BODY
Package

autoexport

Source

autoexport.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   A   F   L  
Index Entry  Section

A
autoexport.asd: The autoexport․asd file
autoexport/autoexport.lisp: The autoexport/autoexport․lisp file

F
File, Lisp, autoexport.asd: The autoexport․asd file
File, Lisp, autoexport/autoexport.lisp: The autoexport/autoexport․lisp file

L
Lisp File, autoexport.asd: The autoexport․asd file
Lisp File, autoexport/autoexport.lisp: The autoexport/autoexport․lisp file

Jump to:   A   F   L  

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

A.2 Functions

Jump to:   M   P  
Index Entry  Section

M
Macro, pub: Exported macros

P
pub: Exported macros

Jump to:   M   P  

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

A.3 Variables


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

A.4 Data types

Jump to:   A   P   S  
Index Entry  Section

A
autoexport: The autoexport system
autoexport: The autoexport package
autoexport-system: The autoexport-system package

P
Package, autoexport: The autoexport package
Package, autoexport-system: The autoexport-system package

S
System, autoexport: The autoexport system

Jump to:   A   P   S