The cl-zipper Reference Manual

Table of Contents

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

The cl-zipper Reference Manual

This is the cl-zipper Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:42:56 2020 GMT+0.


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

1 Introduction

cl-zipper

inaimathi leo.zovic@gmail.com

Build Status

This project is an implementation of the zipper datastructure. It's based primarily on the Huet paper, but also takes some pointers from the clojure implementation of the same API.

License

The MIT Expat license, included in the LICENSE.txt file.


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

Author

inaimathi <leo.zovic@gmail.com>

License

MIT Expat

Description

An implementation of functional zippers for Common Lisp

Version

0.0.1

Source

cl-zipper.asd (file)

Component

src (module)


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

3 Modules

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


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

3.1 cl-zipper/src

Parent

cl-zipper (system)

Location

src/

Components

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

4 Files

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


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

4.1 Lisp


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

4.1.1 cl-zipper.asd

Location

cl-zipper.asd

Systems

cl-zipper (system)


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

4.1.2 cl-zipper/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

cl-zipper


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

4.1.3 cl-zipper/src/util.lisp

Parent

src (module)

Location

src/util.lisp

Internal Definitions

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

4.1.4 cl-zipper/src/cl-zipper.lisp

Parent

src (module)

Location

src/cl-zipper.lisp

Exported Definitions
Internal Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 cl-zipper

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


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

6.1.1 Functions

Function: append-child ZIPPER NODE
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: branch? ZIPPER
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: children ZIPPER
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: delete ZIPPER
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: down ZIPPER
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: edit ZIPPER F &rest ARGS
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: find ZIPPER F
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: insert-child ZIPPER NODE
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: insert-left ZIPPER NODE
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: insert-right ZIPPER NODE
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: left ZIPPER
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: leftmost ZIPPER
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: lefts ZIPPER
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: make-node ZIPPER CHILDREN
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: next ZIPPER
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: node ZIPPER
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: path ZIPPER
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: prev ZIPPER
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: remove ZIPPER
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: replace ZIPPER NODE
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: right ZIPPER
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: rightmost ZIPPER
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: rights ZIPPER
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: root ZIPPER
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: splice-left ZIPPER NODE-LIST
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: splice-right ZIPPER NODE-LIST
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: up ZIPPER
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: zipper BRANCH? CHILDREN MAKE-NODE ROOT
Package

cl-zipper

Source

cl-zipper.lisp (file)


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

6.1.2 Generic functions

Generic Function: make-zipper THING
Package

cl-zipper

Methods
Method: make-zipper (THING list)
Source

cl-zipper.lisp (file)


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

6.1.3 Structures

Structure: path ()
Package

cl-zipper

Source

cl-zipper.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: left
Readers

path-left (function)

Writers

(setf path-left) (function)

Slot: path
Readers

path-path (function)

Writers

(setf path-path) (function)

Slot: right
Readers

path-right (function)

Writers

(setf path-right) (function)


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

6.2 Internal definitions


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

6.2.1 Macros

Macro: -> EXP &rest OPS
Package

cl-zipper

Source

util.lisp (file)

Macro: if-let (NAME TEST) THEN &optional ELSE
Package

cl-zipper

Source

util.lisp (file)


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

6.2.2 Functions

Function: api-fn-branch? INSTANCE
Function: (setf api-fn-branch?) VALUE INSTANCE
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: api-fn-children INSTANCE
Function: (setf api-fn-children) VALUE INSTANCE
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: api-fn-make-node INSTANCE
Function: (setf api-fn-make-node) VALUE INSTANCE
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: api-p OBJECT
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: bf-next ZIPPER
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: copy-api INSTANCE
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: copy-loc INSTANCE
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: copy-path INSTANCE
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: loc-api INSTANCE
Function: (setf loc-api) VALUE INSTANCE
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: loc-node INSTANCE
Function: (setf loc-node) VALUE INSTANCE
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: loc-p OBJECT
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: loc-path INSTANCE
Function: (setf loc-path) VALUE INSTANCE
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: make-api &key (FN-BRANCH? FN-BRANCH?) (FN-CHILDREN FN-CHILDREN) (FN-MAKE-NODE FN-MAKE-NODE)
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: make-loc &key (NODE NODE) (PATH PATH) (API API)
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: make-path &key (LEFT LEFT) (PATH PATH) (RIGHT RIGHT)
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: path-left INSTANCE
Function: (setf path-left) VALUE INSTANCE
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: path-p OBJECT
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: path-path INSTANCE
Function: (setf path-path) VALUE INSTANCE
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: path-right INSTANCE
Function: (setf path-right) VALUE INSTANCE
Package

cl-zipper

Source

cl-zipper.lisp (file)

Function: while ZIPPER F
Package

cl-zipper

Source

util.lisp (file)


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

6.2.3 Structures

Structure: api ()
Package

cl-zipper

Source

cl-zipper.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: fn-branch?
Readers

api-fn-branch? (function)

Writers

(setf api-fn-branch?) (function)

Slot: fn-children
Readers

api-fn-children (function)

Writers

(setf api-fn-children) (function)

Slot: fn-make-node
Readers

api-fn-make-node (function)

Writers

(setf api-fn-make-node) (function)

Structure: loc ()
Package

cl-zipper

Source

cl-zipper.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: node
Readers

loc-node (function)

Writers

(setf loc-node) (function)

Slot: path
Readers

loc-path (function)

Writers

(setf loc-path) (function)

Slot: api
Readers

loc-api (function)

Writers

(setf loc-api) (function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
cl-zipper.asd: The cl-zipper․asd file
cl-zipper/src: The cl-zipper/src module
cl-zipper/src/cl-zipper.lisp: The cl-zipper/src/cl-zipper․lisp file
cl-zipper/src/package.lisp: The cl-zipper/src/package․lisp file
cl-zipper/src/util.lisp: The cl-zipper/src/util․lisp file

F
File, Lisp, cl-zipper.asd: The cl-zipper․asd file
File, Lisp, cl-zipper/src/cl-zipper.lisp: The cl-zipper/src/cl-zipper․lisp file
File, Lisp, cl-zipper/src/package.lisp: The cl-zipper/src/package․lisp file
File, Lisp, cl-zipper/src/util.lisp: The cl-zipper/src/util․lisp file

L
Lisp File, cl-zipper.asd: The cl-zipper․asd file
Lisp File, cl-zipper/src/cl-zipper.lisp: The cl-zipper/src/cl-zipper․lisp file
Lisp File, cl-zipper/src/package.lisp: The cl-zipper/src/package․lisp file
Lisp File, cl-zipper/src/util.lisp: The cl-zipper/src/util․lisp file

M
Module, cl-zipper/src: The cl-zipper/src module

Jump to:   C   F   L   M  

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

A.2 Functions

Jump to:   (   -  
A   B   C   D   E   F   G   I   L   M   N   P   R   S   U   W   Z  
Index Entry  Section

(
(setf api-fn-branch?): Internal functions
(setf api-fn-children): Internal functions
(setf api-fn-make-node): Internal functions
(setf loc-api): Internal functions
(setf loc-node): Internal functions
(setf loc-path): Internal functions
(setf path-left): Internal functions
(setf path-path): Internal functions
(setf path-right): Internal functions

-
->: Internal macros

A
api-fn-branch?: Internal functions
api-fn-children: Internal functions
api-fn-make-node: Internal functions
api-p: Internal functions
append-child: Exported functions

B
bf-next: Internal functions
branch?: Exported functions

C
children: Exported functions
copy-api: Internal functions
copy-loc: Internal functions
copy-path: Internal functions

D
delete: Exported functions
down: Exported functions

E
edit: Exported functions

F
find: Exported functions
Function, (setf api-fn-branch?): Internal functions
Function, (setf api-fn-children): Internal functions
Function, (setf api-fn-make-node): Internal functions
Function, (setf loc-api): Internal functions
Function, (setf loc-node): Internal functions
Function, (setf loc-path): Internal functions
Function, (setf path-left): Internal functions
Function, (setf path-path): Internal functions
Function, (setf path-right): Internal functions
Function, api-fn-branch?: Internal functions
Function, api-fn-children: Internal functions
Function, api-fn-make-node: Internal functions
Function, api-p: Internal functions
Function, append-child: Exported functions
Function, bf-next: Internal functions
Function, branch?: Exported functions
Function, children: Exported functions
Function, copy-api: Internal functions
Function, copy-loc: Internal functions
Function, copy-path: Internal functions
Function, delete: Exported functions
Function, down: Exported functions
Function, edit: Exported functions
Function, find: Exported functions
Function, insert-child: Exported functions
Function, insert-left: Exported functions
Function, insert-right: Exported functions
Function, left: Exported functions
Function, leftmost: Exported functions
Function, lefts: Exported functions
Function, loc-api: Internal functions
Function, loc-node: Internal functions
Function, loc-p: Internal functions
Function, loc-path: Internal functions
Function, make-api: Internal functions
Function, make-loc: Internal functions
Function, make-node: Exported functions
Function, make-path: Internal functions
Function, next: Exported functions
Function, node: Exported functions
Function, path: Exported functions
Function, path-left: Internal functions
Function, path-p: Internal functions
Function, path-path: Internal functions
Function, path-right: Internal functions
Function, prev: Exported functions
Function, remove: Exported functions
Function, replace: Exported functions
Function, right: Exported functions
Function, rightmost: Exported functions
Function, rights: Exported functions
Function, root: Exported functions
Function, splice-left: Exported functions
Function, splice-right: Exported functions
Function, up: Exported functions
Function, while: Internal functions
Function, zipper: Exported functions

G
Generic Function, make-zipper: Exported generic functions

I
if-let: Internal macros
insert-child: Exported functions
insert-left: Exported functions
insert-right: Exported functions

L
left: Exported functions
leftmost: Exported functions
lefts: Exported functions
loc-api: Internal functions
loc-node: Internal functions
loc-p: Internal functions
loc-path: Internal functions

M
Macro, ->: Internal macros
Macro, if-let: Internal macros
make-api: Internal functions
make-loc: Internal functions
make-node: Exported functions
make-path: Internal functions
make-zipper: Exported generic functions
make-zipper: Exported generic functions
Method, make-zipper: Exported generic functions

N
next: Exported functions
node: Exported functions

P
path: Exported functions
path-left: Internal functions
path-p: Internal functions
path-path: Internal functions
path-right: Internal functions
prev: Exported functions

R
remove: Exported functions
replace: Exported functions
right: Exported functions
rightmost: Exported functions
rights: Exported functions
root: Exported functions

S
splice-left: Exported functions
splice-right: Exported functions

U
up: Exported functions

W
while: Internal functions

Z
zipper: Exported functions

Jump to:   (   -  
A   B   C   D   E   F   G   I   L   M   N   P   R   S   U   W   Z  

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

A.3 Variables

Jump to:   A   F   L   N   P   R   S  
Index Entry  Section

A
api: Internal structures

F
fn-branch?: Internal structures
fn-children: Internal structures
fn-make-node: Internal structures

L
left: Exported structures

N
node: Internal structures

P
path: Exported structures
path: Internal structures

R
right: Exported structures

S
Slot, api: Internal structures
Slot, fn-branch?: Internal structures
Slot, fn-children: Internal structures
Slot, fn-make-node: Internal structures
Slot, left: Exported structures
Slot, node: Internal structures
Slot, path: Exported structures
Slot, path: Internal structures
Slot, right: Exported structures

Jump to:   A   F   L   N   P   R   S  

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

A.4 Data types

Jump to:   A   C   L   P   S  
Index Entry  Section

A
api: Internal structures

C
cl-zipper: The cl-zipper system
cl-zipper: The cl-zipper package

L
loc: Internal structures

P
Package, cl-zipper: The cl-zipper package
path: Exported structures

S
Structure, api: Internal structures
Structure, loc: Internal structures
Structure, path: Exported structures
System, cl-zipper: The cl-zipper system

Jump to:   A   C   L   P   S