The clos-diff Reference Manual

Table of Contents

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

The clos-diff Reference Manual

This is the clos-diff Reference Manual, version 1.0, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:34:49 2018 GMT+0.


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

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 .


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 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

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 clos-diff.asd

Location

clos-diff.asd

Systems

clos-diff (system)

Packages

clos-diff-system


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

3.1.2 clos-diff/package.lisp

Parent

clos-diff (system)

Location

package.lisp

Packages

clos-diff


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

3.1.3 clos-diff/diff.lisp

Dependency

package.lisp (file)

Parent

clos-diff (system)

Location

diff.lisp

Exported Definitions

diff (function)

Internal Definitions

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

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)


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

4 Packages

Packages are listed by definition order.


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

4.1 clos-diff-system

Source

clos-diff.asd

Use List

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

4.2 clos-diff

Source

package.lisp (file)

Nickname

cld

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

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)


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

5.2 Internal definitions


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

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)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
clos-diff.asd: The clos-diff<dot>asd file
clos-diff/apply.lisp: The clos-diff/apply<dot>lisp file
clos-diff/diff.lisp: The clos-diff/diff<dot>lisp file
clos-diff/package.lisp: The clos-diff/package<dot>lisp file

F
File, Lisp, clos-diff.asd: The clos-diff<dot>asd file
File, Lisp, clos-diff/apply.lisp: The clos-diff/apply<dot>lisp file
File, Lisp, clos-diff/diff.lisp: The clos-diff/diff<dot>lisp file
File, Lisp, clos-diff/package.lisp: The clos-diff/package<dot>lisp file

L
Lisp File, clos-diff.asd: The clos-diff<dot>asd file
Lisp File, clos-diff/apply.lisp: The clos-diff/apply<dot>lisp file
Lisp File, clos-diff/diff.lisp: The clos-diff/diff<dot>lisp file
Lisp File, clos-diff/package.lisp: The clos-diff/package<dot>lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   A   D   E   F   G  
Index Entry  Section

A
apply-diff: Exported functions

D
diff: Exported functions
diff-nil: Internal functions

E
eval-diff: Internal functions

F
Function, apply-diff: Exported functions
Function, diff: Exported functions
Function, diff-nil: Internal functions
Function, eval-diff: Internal functions
Function, get-slots: Internal functions

G
get-slots: Internal functions

Jump to:   A   D   E   F   G  

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

A.3 Variables


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

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
clos-diff: The clos-diff system
clos-diff: The clos-diff package
clos-diff-system: The clos-diff-system package

P
Package, clos-diff: The clos-diff package
Package, clos-diff-system: The clos-diff-system package

S
System, clos-diff: The clos-diff system

Jump to:   C   P   S