The clos-diff Reference Manual

Table of Contents

The clos-diff Reference Manual

This is the clos-diff Reference Manual, version 1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:47:58 2020 GMT+0.

1 Introduction

clos-diff is a GPL licensed library which will be able to create and
apply diffs of CLOS objects in a compact representation that will not
use too much bandwidth or disk space. The library also preforms the
diffs recursively, so that (theoretically) infinite layers of objects
can be diffed. The only dependency is closer-mop.

The API is simple, and documented below:

function: clos-diff:diff (old new &key (test #'equalp))
  This function will create a diff that represents the modification
  that need to be applied to object old to create the object new. The
  test parameter will control the test used for equality. As a special
  case is the old parameter is nil, a diff from an object with no
  bound slots will be created.

function: clos-diff:apply-diff (diff &optional object)
  This function will apply the diff given in the parameter diff to the
  object contained in object. If object is nil, a fresh object of the
  appropriate type (with all slots unbound) will be created, and the
  diff will be applied to that (See the documentation for diff for
  more information).

This project is hosted on github. Submit bug reports there. Also, you
may contact the author at krzysdrewniak AT gmail DOT com .

2 Systems

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

2.1 clos-diff

Author

Krzysztof Drewniak <krzysdrewniak@gmail.com>

License

GNU GPL version 3 or any later version

Description

A library for creating diffs of CLOS objects

Version

1.0

Dependency

closer-mop

Source

clos-diff.asd (file)

Components

• package.lisp (file)
• diff.lisp (file)
• apply.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 clos-diff.asd

Location

clos-diff.asd

Systems

clos-diff (system)

Packages

clos-diff-system

3.1.2 clos-diff/package.lisp

Parent

clos-diff (system)

Location

package.lisp

Packages

clos-diff

3.1.3 clos-diff/diff.lisp

Dependency

package.lisp (file)

Parent

clos-diff (system)

Location

diff.lisp

Exported Definitions

diff (function)

Internal Definitions

• diff-nil (function)
• get-slots (function)

3.1.4 clos-diff/apply.lisp

Dependency

diff.lisp (file)

Parent

clos-diff (system)

Location

apply.lisp

Exported Definitions

apply-diff (function)

Internal Definitions

eval-diff (function)

4 Packages

Packages are listed by definition order.

4.1 clos-diff-system

Source

clos-diff.asd

Use List

• asdf/interface
• common-lisp

4.2 clos-diff

Source

package.lisp (file)

Nickname

cld

Use List

common-lisp

Exported Definitions

• apply-diff (function)
• diff (function)

Internal Definitions

• diff-nil (function)
• eval-diff (function)
• get-slots (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: apply-diff DIFF &optional OBJ

Package

clos-diff

Source

apply.lisp (file)

Function: diff OLD NEW &key TEST CIRC-LIST

Package

clos-diff

Source

diff.lisp (file)

5.2 Internal definitions

5.2.1 Functions

Function: diff-nil OBJ &optional TYPE CIRC-LIST

Package

clos-diff

Source

diff.lisp (file)

Function: eval-diff OBJ PHRASE

Package

clos-diff

Source

apply.lisp (file)

Function: get-slots OBJECT

Package

clos-diff

Source

diff.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types