The autoexport Reference Manual

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

The autoexport Reference Manual

This is the autoexport Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 03:17:49 2022 GMT+0.

Table of Contents


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.


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

2.1 autoexport

A small library to automatically export definitions

Author

fami-com

License

BSD-3-Clause

Dependencies
  • closer-mop (system).
  • alexandria (system).
Source

autoexport.asd.

Child Component

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

Source

autoexport.asd.

Parent Component

autoexport (system).

ASDF Systems

autoexport.

Packages

autoexport-system.


3.1.2 autoexport/autoexport.lisp

Source

autoexport.asd.

Parent Component

autoexport (system).

Packages

autoexport.

Public Interface

pub (macro).


4 Packages

Packages are listed by definition order.


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

4.1 autoexport-system

Source

autoexport.asd.

Use List
  • asdf/interface.
  • common-lisp.

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

4.2 autoexport

Source

autoexport.lisp.

Use List

common-lisp.

Public Interface

pub (macro).


5 Definitions

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


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

5.1 Public Interface


5.1.1 Macros

Macro: pub (what name &body body)
Package

autoexport.

Source

autoexport.lisp.


Appendix A Indexes


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

A.1 Concepts


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

A.2 Functions

Jump to:   M   P  
Index Entry  Section

M
Macro, pub: Public macros

P
pub: Public macros

Jump to:   M   P  

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

A.3 Variables