The metacopy Reference Manual

Table of Contents

The metacopy Reference Manual

This is the metacopy Reference Manual, version 0.2, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:16:07 2018 GMT+0.

1 Systems

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

1.1 metacopy

Maintainer

Gary Warren King <gwking@metabang.com>

Author

Originally by BBN, modified by EKSL and by Gary Warren King <gwking@metabang.com>

License

MIT Style License

Description

Flexible Common Lisp shallow/deep copy mechanism.

Version

0.2

Dependency

moptilities

Source

metacopy.asd (file)

Components

• dev (module)
• website (module)

2 Modules

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

2.1 metacopy/dev

Parent

metacopy (system)

Location

dev/

Components

• notes.text (file)
• package.lisp (file)
• contextl-integration.lisp (file)
• api.lisp (file)
• copy.lisp (file)

2.2 metacopy/website

Parent

metacopy (system)

Location

website/

Component

source (module)

2.3 metacopy/website/source

Parent

website (module)

Location

website/source/

Component

index.lml (file)

3 Files

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

3.1 Lisp

3.1.1 metacopy.asd

Location

metacopy.asd

Systems

metacopy (system)

Packages

metacopy-system

Exported Definitions

• *load-with-contextl* (special variable)
• metacopy-package (function)
• metacopy-test-package (function)

3.1.2 metacopy/dev/package.lisp

Parent

dev (module)

Location

dev/package.lisp

Packages

metacopy

3.1.3 metacopy/dev/contextl-integration.lisp

Dependency

package.lisp (file)

Parent

dev (module)

Location

dev/contextl-integration.lisp

Exported Definitions

define-copy-method (macro)

Internal Definitions

define-copy-function (macro)

3.1.4 metacopy/dev/api.lisp

Dependencies

• contextl-integration.lisp (file)
• package.lisp (file)

Parent

dev (module)

Location

dev/api.lisp

Exported Definitions

• copy-inner (generic function)
• copy-inner-class (generic function)
• copy-one (generic function)
• copy-self (generic function)
• copy-slots-slots-to-initialize (generic function)
• copy-slots-slots-to-initialize (method)
• copy-thing (generic function)

Internal Definitions

• copy-final (generic function)
• copy-final-class (generic function)

3.1.5 metacopy/dev/copy.lisp

Dependencies

• api.lisp (file)
• package.lisp (file)

Parent

dev (module)

Location

dev/copy.lisp

Exported Definitions

• *copy-assume-no-circular-lists* (special variable)
• copy-inner (method)
• copy-inner (method)
• copy-inner (method)
• copy-inner (method)
• copy-inner (method)
• copy-inner (method)
• copy-inner-class (method)
• copy-one (method)
• copy-one (method)
• copy-one (method)
• copy-one (method)
• copy-one (method)
• copy-one (method)
• copy-self (method)
• copy-self (method)
• copy-self (method)
• copy-self (method)
• copy-self (method)
• copy-self (method)
• copy-thing (method)
• copy-thing (method)
• copy-thing (method)
• copy-thing (method)
• copy-thing (method)
• copyable-mixin (class)
• defcopy-methods (macro)
• duplicator-methods (macro)
• instance-made-for-copying-p (method)
• with-slot-copying (macro)

Internal Definitions

• *duplicate-class-forms-copy-forms?* (special variable)
• *instance-for-copy?* (special variable)
• *potential-duplicator-methods* (special variable)
• copy-final (method)
• copy-final (method)
• copy-final-class (method)
• copy-object (function)
• copy-set-slot-1 (function)
• copy-slot-1 (function)
• duplicate-class-forms-copy (function)
• duplicate-class-forms-final-duplicate (function)
• remove-duplicator-methods (function)

3.2 Other

3.2.1 metacopy/dev/notes.text

Parent

dev (module)

Location

dev/notes.text

3.2.2 metacopy/website/source/index.lml

Parent

source (module)

Location

website/source/index.lml

4 Packages

Packages are listed by definition order.

4.1 metacopy-system

Source

metacopy.asd

Use List

• asdf/interface
• common-lisp

Used By List

metacopy

Exported Definitions

• *load-with-contextl* (special variable)
• metacopy-package (function)
• metacopy-test-package (function)

4.2 metacopy

Source

package.lisp (file)

Use List

• metacopy-system
• metabang.moptilities
• common-lisp

Exported Definitions

• *copy-assume-no-circular-lists* (special variable)
• copy-inner (generic function)
• copy-inner (method)
• copy-inner (method)
• copy-inner (method)
• copy-inner (method)
• copy-inner (method)
• copy-inner (method)
• copy-inner-class (generic function)
• copy-inner-class (method)
• copy-one (generic function)
• copy-one (method)
• copy-one (method)
• copy-one (method)
• copy-one (method)
• copy-one (method)
• copy-one (method)
• copy-self (generic function)
• copy-self (method)
• copy-self (method)
• copy-self (method)
• copy-self (method)
• copy-self (method)
• copy-self (method)
• copy-slots-slots-to-initialize (generic function)
• copy-slots-slots-to-initialize (method)
• copy-thing (generic function)
• copy-thing (method)
• copy-thing (method)
• copy-thing (method)
• copy-thing (method)
• copy-thing (method)
• copyable-mixin (class)
• defcopy-methods (macro)
• define-copy-method (macro)
• duplicator-methods (macro)
• instance-made-for-copying-p (generic function)
• instance-made-for-copying-p (method)
• with-slot-copying (macro)

Internal Definitions

• *duplicate-class-forms-copy-forms?* (special variable)
• *instance-for-copy?* (special variable)
• *potential-duplicator-methods* (special variable)
• copy-final (generic function)
• copy-final (method)
• copy-final (method)
• copy-final-class (generic function)
• copy-final-class (method)
• copy-object (function)
• copy-set-slot-1 (function)
• copy-slot-1 (function)
• define-copy-function (macro)
• duplicate-class-forms-copy (function)
• duplicate-class-forms-final-duplicate (function)
• remove-duplicator-methods (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *copy-assume-no-circular-lists*

Package

metacopy

Source

copy.lisp (file)

Special Variable: *load-with-contextl*

This is t when loading with contextl. You can set this var at runtime to "switch" packages while working with slime (currently needs a pending slime patch).

Package

metacopy-system

Source

metacopy.asd

5.1.2 Macros

Macro: defcopy-methods CLASS &key COPY SET COPY-ALL SET-ALL

Put a different face on duplicator-methods’s syntax.

Package

metacopy

Source

copy.lisp (file)

Macro: define-copy-method NAME ARGS &rest OPTIONS

A defmethod, without contextl.

Package

metacopy

Source

contextl-integration.lisp (file)

Macro: duplicator-methods (CLASS-NAME &key SYMBOL COPY-FORMS?) ALL-SLOTS SLOT-FORMS &optional FINAL-DUPLICATE-FORMS

Package

metacopy

Source

copy.lisp (file)

Macro: with-slot-copying (COPY-OBJECT COPY-HTABLE &optional ORIGINAL-OBJECT) &body BODY

Package

metacopy

Source

copy.lisp (file)

5.1.3 Functions

Function: metacopy-package ()

This is the package in which the metacopy files are read in.

Package

metacopy-system

Source

metacopy.asd

Function: metacopy-test-package ()

See metacopy-package.

Package

metacopy-system

Source

metacopy.asd

5.1.4 Generic functions

Generic Function: copy-inner SELF COPY-OBJECT COPY-HTABLE

copy the relevant portions of self into copy-object. ok if it calls copy on sub-objects.

Package

metacopy

Source

api.lisp (file)

Methods

Method: copy-inner (ORIGINAL-OBJECT standard-object) COPY-LIST COPY-HTABLE

Source

copy.lisp (file)

Method: copy-inner (ORIGINAL-LIST list) COPY-LIST COPY-HTABLE

Source

copy.lisp (file)

Method: copy-inner (ORIGINAL-TABLE hash-table) NEW-TABLE COPY-HTABLE

Source

copy.lisp (file)

Method: copy-inner (ORIGINAL array) NEW-ARRAY COPY-HTABLE

Source

copy.lisp (file)

Method: copy-inner (ORIGINAL string) NEW-ARRAY COPY-HTABLE

Source

copy.lisp (file)

Method: copy-inner SELF COPY-OBJECT COPY-HTABLE

default is to do nothing.

Source

copy.lisp (file)

Generic Function: copy-inner-class SELF COPY-OBJECT COPY-HTABLE

Defined for each component class of an object with mixin COPYABLE-MIXIN. It should setup its slots as appropriate.
This needs to be a seperate method (from COPY-INNER) because it has to be done with a PROGN Method-Combination.

Package

metacopy

Source

api.lisp (file)

Method Combination

progn (short method combination)

Options: :most-specific-last

Methods

Method: copy-inner-class (ORIGINAL-OBJECT copyable-mixin) COPY-LIST COPY-HTABLE progn

Source

copy.lisp (file)

Generic Function: copy-one SELF COPY-HTABLE

returns a fullfledged copy of self, set-up and ready to go.

Package

metacopy

Source

api.lisp (file)

Methods

Method: copy-one ORIGINAL-THING (COPY-HTABLE (eql nil))

Source

copy.lisp (file)

Method: copy-one ORIGINAL-THING COPY-HTABLE

Source

copy.lisp (file)

Method: copy-one (ORIG character) COPY-HTABLE

Source

copy.lisp (file)

Method: copy-one (ORIGINAL-FUNCTION function) COPY-HTABLE

Source

copy.lisp (file)

Method: copy-one (ORIGINAL-NUMBER number) COPY-HTABLE

Source

copy.lisp (file)

Method: copy-one (ORIGINAL-SYMBOL symbol) COPY-HTABLE

Source

copy.lisp (file)

Generic Function: copy-self SELF

return a new, empty version of self

Package

metacopy

Source

api.lisp (file)

Methods

Method: copy-self (SELF copyable-mixin)

Source

copy.lisp (file)

Method: copy-self (ORIGINAL-LIST list)

Source

copy.lisp (file)

Method: copy-self (ORIGINAL hash-table)

Source

copy.lisp (file)

Method: copy-self (ORIGINAL array)

Source

copy.lisp (file)

Method: copy-self (ORIGINAL string)

Source

copy.lisp (file)

Method: copy-self SELF

Source

copy.lisp (file)

Generic Function: copy-slots-slots-to-initialize SELF

Package

metacopy

Source

api.lisp (file)

Method Combination

append (short method combination)

Options: :most-specific-last

Methods

Method: copy-slots-slots-to-initialize (SELF standard-object) append

Generic Function: copy-thing THING

Copy objects with aribtrarily complex substructure.
Objects are kept track of in a HashTable, so only one copy is made of each. Things which are EQ in the original (i.e. objects, sublists, etc.) come out EQ in the corresponding places in the copy.

Package

metacopy

Source

api.lisp (file)

Methods

Method: copy-thing (ORIGINAL-THING character)

Source

copy.lisp (file)

Method: copy-thing (ORIGINAL-THING function)

Source

copy.lisp (file)

Method: copy-thing (ORIGINAL-THING number)

Source

copy.lisp (file)

Method: copy-thing (ORIGINAL-THING symbol)

Source

copy.lisp (file)

Method: copy-thing ORIGINAL-THING

Source

copy.lisp (file)

Generic Function: instance-made-for-copying-p OBJECT

Package

metacopy

Methods

Method: instance-made-for-copying-p OBJECT

Source

copy.lisp (file)

5.1.5 Classes

Class: copyable-mixin ()

provides method for doing copy that creates a copy on an object. each mixin should provide an copy-inner-class method to copy its slots appropriately.

Package

metacopy

Source

copy.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• copy-final (method)
• copy-final-class (method)
• copy-inner-class (method)
• copy-self (method)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *duplicate-class-forms-copy-forms?*

Package

metacopy

Source

copy.lisp (file)

Special Variable: *instance-for-copy?*

Package

metacopy

Source

copy.lisp (file)

Special Variable: *potential-duplicator-methods*

Package

metacopy

Source

copy.lisp (file)

5.2.2 Macros

Macro: define-copy-function NAME ARGS &rest OPTIONS

A defgeneric, without contextl.

Package

metacopy

Source

contextl-integration.lisp (file)

5.2.3 Functions

Function: copy-object SELF

Package

metacopy

Source

copy.lisp (file)

Function: copy-set-slot-1 COPY-OBJECT SLOT-NAME VALUE

Package

metacopy

Source

copy.lisp (file)

Function: copy-slot-1 COPY-OBJECT SLOT-NAME ORIGINAL-OBJECT COPY-HTABLE

Package

metacopy

Source

copy.lisp (file)

Function: duplicate-class-forms-copy SYMBOL CLASS-NAME ALL-SLOTS SLOT-FORMS

Package

metacopy

Source

copy.lisp (file)

Function: duplicate-class-forms-final-duplicate SYMBOL CLASS-NAME FINAL-DUPLICATE-FORMS COPY-FORMS?

Package

metacopy

Source

copy.lisp (file)

Function: remove-duplicator-methods CLASS-NAME

Package

metacopy

Source

copy.lisp (file)

5.2.4 Generic functions

Generic Function: copy-final SELF COPY

Last pass to make sure everything is in place.

Package

metacopy

Source

api.lisp (file)

Methods

Method: copy-final (ORIGINAL-OBJECT copyable-mixin) COPY

Source

copy.lisp (file)

Method: copy-final SELF COPY

Default is to do nothing.

Source

copy.lisp (file)

Generic Function: copy-final-class SELF COPY

defined for each component class of an object with mixin copyable-mixin. it should setup its slots as appropriate.
this needs to be a seperate method (from copy-final) because it has to be done with a progn method-combination.

Package

metacopy

Source

api.lisp (file)

Method Combination

progn (short method combination)

Options: :most-specific-first

Methods

Method: copy-final-class (ORIGINAL-OBJECT copyable-mixin) COPY progn

Source

copy.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types